@comunica/actor-init-query 2.0.1-alpha.5.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © 2017–now Ruben Taelman, Joachim Van Herwegen
+Comunica Association and Ghent University – imec, Belgium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# Comunica Query Init Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-init-query.svg)](https://www.npmjs.com/package/@comunica/actor-init-query)
+
+An [Init](https://github.com/comunica/comunica/tree/master/packages/bus-init) actor that can initialize a query engine.
+
+This module is part of the [Comunica framework](https://github.com/comunica/comunica),
+and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).
+
+[Click here if you just want to query with Comunica](https://comunica.dev/docs/query/).
+
+## Install
+
+```bash
+$ yarn add @comunica/actor-init-query
+```
+
+## Configure
+
+After installing, this package can be added to your engine's configuration as follows:
+```text
+{
+  "@context": [
+    ...
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-init-query/^2.0.0/components/context.jsonld"  
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:init/actors#query",
+      "@type": "ActorInitQuery",
+      "mediatorOptimizeQueryOperation": { "@id": "urn:comunica:default:optimize-query-operation/mediators#main" },
+      "mediatorQueryOperation": { "@id": "urn:comunica:default:query-operation/mediators#main" },
+      "mediatorQueryParse": { "@id": "urn:comunica:default:query-parse/mediators#main" },
+      "mediatorQueryResultSerialize": { "@id": "urn:comunica:default:query-result-serialize/mediators#serialize" },
+      "mediatorQueryResultSerializeMediaTypeCombiner": { "@id": "urn:comunica:default:query-result-serialize/mediators#mediaType" },
+      "mediatorQueryResultSerializeMediaTypeFormatCombiner": { "@id": "urn:comunica:default:query-result-serialize/mediators#mediaTypeFormat" },
+      "mediatorContextPreprocess": { "@id": "urn:comunica:default:context-preprocess/mediators#main" },
+      "mediatorHttpInvalidate": { "@id": "urn:comunica:default:http-invalidate/mediators#main" }
+    }
+  ]
+}
+```
+
+### Config Parameters
+
+* `mediatorOptimizeQueryOperation`: A mediator over the [optimize query operation bus](https://github.com/comunica/comunica/tree/master/packages/bus-optimize-query-operation).
+* `mediatorQueryOperation`: A mediator over the [query operation bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-operation).
+* `mediatorSparqlParse`: A mediator over the [query parse bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-parse).
+* `mediatorSparqlSerialize`: A mediator over the [query result serialize bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-result-serialize).
+* `mediatorSparqlSerializeMediaTypeCombiner`: A mediator over the [query result serialize bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-result-serialize).
+* `mediatorSparqlSerializeMediaTypeFormatCombiner`: A mediator over the [query result serialize bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-result-serialize).
+* `mediatorContextPreprocess`: A mediator over the [context preprocess bus](https://github.com/comunica/comunica/tree/master/packages/bus-context-preprocess).
+* `mediatorHttpInvalidate`: A mediator over the [HTTP invalidate bus](https://github.com/comunica/comunica/tree/master/packages/bus-http-invalidate).

package/components/ActorInitQuery.jsonld

@@ -0,0 +1,335 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-init-query/^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-init/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-init-query",
+  "components": [
+    {
+      "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery",
+      "@type": "Class",
+      "requireElement": "ActorInitQuery",
+      "extends": [
+        "caiq:components/ActorInitQueryBase.jsonld#ActorInitQueryBase"
+      ],
+      "comment": "A comunica Query Init Actor.",
+      "parameters": [
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorOptimizeQueryOperation",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The query operation optimize mediator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryOperation",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The query operation mediator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryParse",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The query parse mediator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryResultSerialize",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The query serialize mediator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryResultSerializeMediaTypeCombiner",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The query serialize media type combinator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryResultSerializeMediaTypeFormatCombiner",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The query serialize media type format combinator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorContextPreprocess",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The context processing combinator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorHttpInvalidate",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "The HTTP cache invalidation mediator"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_logger",
+          "range": "cc:components/Logger.jsonld#Logger",
+          "default": {
+            "@type": "npmd:@comunica/logger-void/^2.0.0/components/LoggerVoid.jsonld#LoggerVoid"
+          },
+          "comment": "The logger of this actor"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_queryString",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "A SPARQL query string"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_defaultQueryInputFormat",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": "sparql",
+          "comment": "The default query input format"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_context",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "A JSON string of a query operation context"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_contextKeyShortcuts",
+          "range": "rdf:JSON",
+          "default": {
+            "@type": "@json",
+            "@value": {
+              "source": "@comunica/bus-rdf-resolve-quad-pattern:source",
+              "sources": "@comunica/bus-rdf-resolve-quad-pattern:sources",
+              "destination": "@comunica/bus-rdf-update-quads:destination",
+              "initialBindings": "@comunica/actor-init-query:initialBindings",
+              "queryFormat": "@comunica/actor-init-query:queryFormat",
+              "baseIRI": "@comunica/actor-init-query:baseIRI",
+              "log": "@comunica/core:log",
+              "datetime": "@comunica/actor-http-memento:datetime",
+              "queryTimestamp": "@comunica/actor-init-query:queryTimestamp",
+              "httpProxyHandler": "@comunica/actor-http-proxy:httpProxyHandler",
+              "lenient": "@comunica/actor-init-query:lenient",
+              "httpIncludeCredentials": "@comunica/bus-http:include-credentials",
+              "httpAuth": "@comunica/bus-http:auth",
+              "fetch": "@comunica/bus-http:fetch",
+              "readOnly": "@comunica/bus-query-operation:readOnly",
+              "extensionFunctions": "@comunica/actor-init-query:extensionFunctions",
+              "extensionFunctionCreator": "@comunica/actor-init-query:extensionFunctionCreator",
+              "explain": "@comunica/actor-init-query:explain"
+            }
+          },
+          "comment": "A record of context shortcuts to full context keys (as defined in @comunica/context-entries)."
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_bus",
+          "range": {
+            "@type": "ParameterRangeGenericComponent",
+            "component": "cc:components/Bus.jsonld#Bus",
+            "genericTypeInstances": [
+              {
+                "@type": "ParameterRangeGenericComponent",
+                "component": "cc:components/Actor.jsonld#Actor",
+                "genericTypeInstances": [
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbi:components/ActorInit.jsonld#ActorInit_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_beforeActors",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeArray",
+                "parameterRangeValue": {
+                  "@type": "ParameterRangeGenericComponent",
+                  "component": "cc:components/Actor.jsonld#Actor",
+                  "genericTypeInstances": [
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery__member_run",
+          "memberFieldName": "run"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "mediatorOptimizeQueryOperation",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorOptimizeQueryOperation"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryOperation",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryOperation"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryParse",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryParse"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryResultSerialize",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryResultSerialize"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryResultSerializeMediaTypeCombiner",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryResultSerializeMediaTypeCombiner"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryResultSerializeMediaTypeFormatCombiner",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorQueryResultSerializeMediaTypeFormatCombiner"
+              }
+            },
+            {
+              "keyRaw": "mediatorContextPreprocess",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorContextPreprocess"
+              }
+            },
+            {
+              "keyRaw": "mediatorHttpInvalidate",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_mediatorHttpInvalidate"
+              }
+            },
+            {
+              "keyRaw": "logger",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_logger"
+              }
+            },
+            {
+              "keyRaw": "queryString",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_queryString"
+              }
+            },
+            {
+              "keyRaw": "defaultQueryInputFormat",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_defaultQueryInputFormat"
+              }
+            },
+            {
+              "keyRaw": "context",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_context"
+              }
+            },
+            {
+              "keyRaw": "contextKeyShortcuts",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_contextKeyShortcuts"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caiq:components/ActorInitQuery.jsonld#ActorInitQuery_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}