Skip to content

Commit

Permalink
Update config references to comunica v3
Browse files Browse the repository at this point in the history
  • Loading branch information
@rubensworks
rubensworks committed Apr 25, 2024
1 parent 462c1b4 commit b413c93
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 48 deletions.
26 changes: 16 additions & 10 deletions pages/docs/2_modify/1_getting_started/1_custom_config_cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ A **Comunica config is written in JSON**, and typically looks something like thi
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^3.0.0/components/context.jsonld"
],
"@id": "urn:comunica:my",
"@type": "Runner",
Expand Down Expand Up @@ -75,7 +75,7 @@ For example, the imported config file `ccqs:config/query-operation/actors.json`
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^3.0.0/components/context.jsonld"
],
"import": [
"ccqs:config/query-operation/actors/query/ask.json",
Expand Down Expand Up @@ -111,8 +111,8 @@ For example, the `ccqs:config/query-operation/actors/query/ask.json` file could
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-ask/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-ask/^3.0.0/components/context.jsonld"
],
"@id": "urn:comunica:default:Runner",
"@type": "Runner",
Expand Down Expand Up @@ -161,7 +161,7 @@ Let's **copy its contents entirely into our `config.json`**:
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^3.0.0/components/context.jsonld"
],
"import": [
"ccqs:config/context-preprocess/actors.json",
Expand All @@ -173,14 +173,22 @@ Let's **copy its contents entirely into our `config.json`**:
"ccqs:config/http-invalidate/actors.json",
"ccqs:config/http-invalidate/mediators.json",
"ccqs:config/init/actors.json",
"ccqs:config/merge-bindings-context/actors.json",
"ccqs:config/merge-bindings-context/mediators.json",
"ccqs:config/optimize-query-operation/actors.json",
"ccqs:config/optimize-query-operation/mediators.json",
"ccqs:config/query-operation/actors.json",
"ccqs:config/query-operation/mediators.json",
"ccqs:config/query-parse/actors.json",
"ccqs:config/query-parse/mediators.json",
"ccqs:config/query-process/actors.json",
"ccqs:config/query-process/mediators.json",
"ccqs:config/query-result-serialize/actors.json",
"ccqs:config/query-result-serialize/mediators.json",
"ccqs:config/query-source-identify/actors.json",
"ccqs:config/query-source-identify/mediators.json",
"ccqs:config/query-source-identify-hypermedia/actors.json",
"ccqs:config/query-source-identify-hypermedia/mediators.json",
"ccqs:config/dereference/actors.json",
"ccqs:config/dereference/mediators.json",
"ccqs:config/dereference-rdf/actors.json",
Expand All @@ -193,19 +201,17 @@ Let's **copy its contents entirely into our `config.json`**:
"ccqs:config/rdf-join-selectivity/mediators.json",
"ccqs:config/rdf-metadata/actors.json",
"ccqs:config/rdf-metadata/mediators.json",
"ccqs:config/rdf-metadata-accumulate/actors.json",
"ccqs:config/rdf-metadata-accumulate/mediators.json",
"ccqs:config/rdf-metadata-extract/actors.json",
"ccqs:config/rdf-metadata-extract/mediators.json",
"ccqs:config/rdf-parse/actors.json",
"ccqs:config/rdf-parse/mediators.json",
"ccqs:config/rdf-parse-html/actors.json",
"ccqs:config/rdf-resolve-hypermedia/actors.json",
"ccqs:config/rdf-resolve-hypermedia/mediators.json",
"ccqs:config/rdf-resolve-hypermedia-links/actors.json",
"ccqs:config/rdf-resolve-hypermedia-links/mediators.json",
"ccqs:config/rdf-resolve-hypermedia-links-queue/actors.json",
"ccqs:config/rdf-resolve-hypermedia-links-queue/mediators.json",
"ccqs:config/rdf-resolve-quad-pattern/actors.json",
"ccqs:config/rdf-resolve-quad-pattern/mediators.json",
"ccqs:config/rdf-serialize/actors.json",
"ccqs:config/rdf-serialize/mediators.json",
"ccqs:config/rdf-update-hypermedia/actors.json",
Expand Down Expand Up @@ -328,7 +334,7 @@ Your `config.json` file should have the following structure now:
```text
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^3.0.0/components/context.jsonld"
],
"import": [
"ccqs:config/context-preprocess/actors.json",
Expand Down
18 changes: 12 additions & 6 deletions pages/docs/2_modify/1_getting_started/2_custom_config_app.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Let's **copy its contents entirely into our `config.json`**:
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^3.0.0/components/context.jsonld"
],
"import": [
"ccqs:config/context-preprocess/actors.json",
Expand All @@ -66,14 +66,22 @@ Let's **copy its contents entirely into our `config.json`**:
"ccqs:config/http-invalidate/actors.json",
"ccqs:config/http-invalidate/mediators.json",
"ccqs:config/init/actors.json",
"ccqs:config/merge-bindings-context/actors.json",
"ccqs:config/merge-bindings-context/mediators.json",
"ccqs:config/optimize-query-operation/actors.json",
"ccqs:config/optimize-query-operation/mediators.json",
"ccqs:config/query-operation/actors.json",
"ccqs:config/query-operation/mediators.json",
"ccqs:config/query-parse/actors.json",
"ccqs:config/query-parse/mediators.json",
"ccqs:config/query-process/actors.json",
"ccqs:config/query-process/mediators.json",
"ccqs:config/query-result-serialize/actors.json",
"ccqs:config/query-result-serialize/mediators.json",
"ccqs:config/query-source-identify/actors.json",
"ccqs:config/query-source-identify/mediators.json",
"ccqs:config/query-source-identify-hypermedia/actors.json",
"ccqs:config/query-source-identify-hypermedia/mediators.json",
"ccqs:config/dereference/actors.json",
"ccqs:config/dereference/mediators.json",
"ccqs:config/dereference-rdf/actors.json",
Expand All @@ -86,19 +94,17 @@ Let's **copy its contents entirely into our `config.json`**:
"ccqs:config/rdf-join-selectivity/mediators.json",
"ccqs:config/rdf-metadata/actors.json",
"ccqs:config/rdf-metadata/mediators.json",
"ccqs:config/rdf-metadata-accumulate/actors.json",
"ccqs:config/rdf-metadata-accumulate/mediators.json",
"ccqs:config/rdf-metadata-extract/actors.json",
"ccqs:config/rdf-metadata-extract/mediators.json",
"ccqs:config/rdf-parse/actors.json",
"ccqs:config/rdf-parse/mediators.json",
"ccqs:config/rdf-parse-html/actors.json",
"ccqs:config/rdf-resolve-hypermedia/actors.json",
"ccqs:config/rdf-resolve-hypermedia/mediators.json",
"ccqs:config/rdf-resolve-hypermedia-links/actors.json",
"ccqs:config/rdf-resolve-hypermedia-links/mediators.json",
"ccqs:config/rdf-resolve-hypermedia-links-queue/actors.json",
"ccqs:config/rdf-resolve-hypermedia-links-queue/mediators.json",
"ccqs:config/rdf-resolve-quad-pattern/actors.json",
"ccqs:config/rdf-resolve-quad-pattern/mediators.json",
"ccqs:config/rdf-serialize/actors.json",
"ccqs:config/rdf-serialize/mediators.json",
"ccqs:config/rdf-update-hypermedia/actors.json",
Expand Down Expand Up @@ -224,7 +230,7 @@ Also add the newly created config to the contexts of the config file (again repl
```diff
"@context": [
+ "https://linkedsoftwaredependencies.org/bundles/npm/my-package/^1.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/config-query-sparql/^3.0.0/components/context.jsonld"
],
```

Expand Down
33 changes: 18 additions & 15 deletions pages/docs/2_modify/1_getting_started/3_custom_init.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,34 +41,37 @@ Add a `tsconfig.json` file with the following contents:
{
"compileOnSave": true,
"compilerOptions": {
"module": "commonjs",
"target": "es2021",
"lib": [
"es2020",
"es2021",
"dom"
],
"target": "es2020",
"removeComments": false,
"preserveConstEnums": true,
"sourceMap": true,
"inlineSources": true,
"declaration": true,
"module": "commonjs",
"resolveJsonModule": true,
"downlevelIteration": true,
"strict": true,
"strictFunctionTypes": false,
"strictPropertyInitialization": false
"strictFunctionTypes": true,
"strictPropertyInitialization": false,
"noImplicitOverride": true,
"declaration": true,
"downlevelIteration": true,
"inlineSources": true,
"preserveConstEnums": true,
"removeComments": false,
"sourceMap": true
},
"include": [
"lib/**/*",
"bin/**/*"
"engines/*/bin/**/*",
"engines/*/lib/**/*",
"packages/*/bin/**/*",
"packages/*/lib/**/*",
"packages/*/benchmarks/**/*"
],
"exclude": [
"**/node_modules",
"**/test/*"
"**/node_modules"
]
}
```


Expand Down
4 changes: 2 additions & 2 deletions pages/docs/2_modify/1_getting_started/5_contribute_actor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,9 @@ Next, we have to **configure the actor** by replacing the existing `REDUCED` act
```text
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-my/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-my/^3.0.0/components/context.jsonld"
],
"@id": "urn:comunica:default:Runner",
"@type": "Runner",
Expand Down
4 changes: 2 additions & 2 deletions pages/docs/2_modify/1_getting_started/6_actor_parameter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ As such, we can **modify our declaration of our actor in `engines/config-query-s
```text
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-my/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-my/^3.0.0/components/context.jsonld"
],
"@id": "urn:comunica:default:Runner",
"@type": "Runner",
Expand Down
18 changes: 9 additions & 9 deletions pages/docs/2_modify/advanced/componentsjs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ some examples below are shown to explain their most important parts.
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-hash/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-hash/^3.0.0/components/context.jsonld"
],
"@id": "npmd:@comunica/actor-query-operation-reduced-hash",
"@type": "Module",
Expand All @@ -65,9 +65,9 @@ some examples below are shown to explain their most important parts.
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-hash/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-hash/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^3.0.0/components/context.jsonld"
],
"@id": "npmd:@comunica/actor-query-operation-reduced-hash",
"components": [
Expand Down Expand Up @@ -121,7 +121,7 @@ The prefix `caqorh:` identifies the scope of this package.
Internally, this gives all files a unique URL
that makes all modules and components _semantic_ and fully dereferenceable.
For example, `"caqorh:components/ActorQueryOperationReducedHash.jsonld"`
expands to the URL https://linkedsoftwaredependencies.org/bundles/npm/%40comunica%2Factor-query-operation-reduced-hash/^2.0.0/components/ActorQueryOperationReducedHash.jsonld.
expands to the URL https://linkedsoftwaredependencies.org/bundles/npm/%40comunica%2Factor-query-operation-reduced-hash/^3.0.0/components/ActorQueryOperationReducedHash.jsonld.

<div class="note">
<a href="https://linkedsoftwaredependencies.org/">Linked Software Dependencies</a> is a service
Expand Down Expand Up @@ -186,10 +186,10 @@ The instantiation of a Comunica engine could look like this:
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-init-query/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-hash/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-construct/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/runner/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-init-query/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-reduced-hash/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-construct/^3.0.0/components/context.jsonld"
],
"@id": "urn:comunica:my",
"@type": "Runner",
Expand Down
8 changes: 4 additions & 4 deletions pages/docs/2_modify/advanced/mediators.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ The following components file shows how a `mediatorJoin` parameter is added to [
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-join/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-join/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^3.0.0/components/context.jsonld"
],
"@id": "npmd:@comunica/actor-query-operation-join",
"components": [
Expand Down Expand Up @@ -87,8 +87,8 @@ The following config file shows how we instantiate an actor with a race mediator
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-join/^2.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/mediator-race/^2.0.0/components/context.jsonld"
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-join/^3.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/mediator-race/^3.0.0/components/context.jsonld"
],
"@id": "urn:comunica:my",
"actors": [
Expand Down

0 comments on commit b413c93

Please sign in to comment.