From b413c93dcb4422b209826186f36b26b7f2a99b53 Mon Sep 17 00:00:00 2001 From: Ruben Taelman Date: Thu, 25 Apr 2024 08:39:03 +0200 Subject: [PATCH] Update config references to comunica v3 --- .../1_getting_started/1_custom_config_cli.md | 26 +++++++++------ .../1_getting_started/2_custom_config_app.md | 18 ++++++---- .../1_getting_started/3_custom_init.md | 33 ++++++++++--------- .../1_getting_started/5_contribute_actor.md | 4 +-- .../1_getting_started/6_actor_parameter.md | 4 +-- pages/docs/2_modify/advanced/componentsjs.md | 18 +++++----- pages/docs/2_modify/advanced/mediators.md | 8 ++--- 7 files changed, 63 insertions(+), 48 deletions(-) diff --git a/pages/docs/2_modify/1_getting_started/1_custom_config_cli.md b/pages/docs/2_modify/1_getting_started/1_custom_config_cli.md index 4019e3d94..4e3e8bdc1 100644 --- a/pages/docs/2_modify/1_getting_started/1_custom_config_cli.md +++ b/pages/docs/2_modify/1_getting_started/1_custom_config_cli.md @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/pages/docs/2_modify/1_getting_started/2_custom_config_app.md b/pages/docs/2_modify/1_getting_started/2_custom_config_app.md index dcb3ffba2..944e8f82f 100644 --- a/pages/docs/2_modify/1_getting_started/2_custom_config_app.md +++ b/pages/docs/2_modify/1_getting_started/2_custom_config_app.md @@ -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", @@ -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", @@ -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", @@ -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" ], ``` diff --git a/pages/docs/2_modify/1_getting_started/3_custom_init.md b/pages/docs/2_modify/1_getting_started/3_custom_init.md index 92cc6a6b8..c5a71bbb2 100644 --- a/pages/docs/2_modify/1_getting_started/3_custom_init.md +++ b/pages/docs/2_modify/1_getting_started/3_custom_init.md @@ -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" ] } + ``` diff --git a/pages/docs/2_modify/1_getting_started/5_contribute_actor.md b/pages/docs/2_modify/1_getting_started/5_contribute_actor.md index 0ca37940e..c02aa59a4 100644 --- a/pages/docs/2_modify/1_getting_started/5_contribute_actor.md +++ b/pages/docs/2_modify/1_getting_started/5_contribute_actor.md @@ -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", diff --git a/pages/docs/2_modify/1_getting_started/6_actor_parameter.md b/pages/docs/2_modify/1_getting_started/6_actor_parameter.md index 11956a6a0..a86276363 100644 --- a/pages/docs/2_modify/1_getting_started/6_actor_parameter.md +++ b/pages/docs/2_modify/1_getting_started/6_actor_parameter.md @@ -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", diff --git a/pages/docs/2_modify/advanced/componentsjs.md b/pages/docs/2_modify/advanced/componentsjs.md index 0be7276bc..4ac26738c 100644 --- a/pages/docs/2_modify/advanced/componentsjs.md +++ b/pages/docs/2_modify/advanced/componentsjs.md @@ -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", @@ -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": [ @@ -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.
Linked Software Dependencies is a service @@ -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", diff --git a/pages/docs/2_modify/advanced/mediators.md b/pages/docs/2_modify/advanced/mediators.md index 13aa57702..e71f95881 100644 --- a/pages/docs/2_modify/advanced/mediators.md +++ b/pages/docs/2_modify/advanced/mediators.md @@ -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": [ @@ -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": [