npm - @comunica/actor-query-process-explain-query - Versions diffs - 4.5.0 - Mend

@comunica/actor-query-process-explain-query 4.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/LICENSE.txt +22 -0
package/README.md +42 -0
package/components/ActorQueryProcessExplainQuery.jsonld +229 -0
package/components/ActorQueryProcessExplainService.jsonld +218 -0
package/components/components.jsonld +11 -0
package/components/context.jsonld +58 -0
package/lib/ActorQueryProcessExplainQuery.d.ts +24 -0
package/lib/ActorQueryProcessExplainQuery.js +72 -0
package/lib/ActorQueryProcessExplainQuery.js.map +1 -0
package/lib/index.d.ts +1 -0
package/lib/index.js +18 -0
package/lib/index.js.map +1 -0
package/package.json +53 -0

package/LICENSE.txt ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,42 @@
+# Comunica Explain Query Query Process Actor
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-query-process-explain-query.svg)](https://www.npmjs.com/package/@comunica/actor-query-process-explain-query)
+An [Query Process](https://github.com/comunica/comunica/tree/master/packages/bus-query-process) actor
+that explains the logical query plan as a query string after parsing and optimizing.
+If source selection took place, source assignment on operators will be serialized as `SERVICE` clauses.
+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-query-process-explain-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-query-process-explain-query/^1.0.0/components/context.jsonld"
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:query-process/actors#explain-query",
+      "@type": "ActorQueryProcessExplainService",
+      "mediatorQuerySerialize": { "@id": "urn:comunica:default:query-serialize/mediators#main" }
+    }
+  ]
+}
+```
+### Config Parameters
+* `mediatorQuerySerialize`: A mediator over the [Query Serialize bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-serialize).

package/components/ActorQueryProcessExplainQuery.jsonld ADDED Viewed

@@ -0,0 +1,229 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-process-explain-query/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-process/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^5.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-process-explain-query",
+  "components": [
+    {
+      "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery",
+      "@type": "Class",
+      "requireElement": "ActorQueryProcessExplainQuery",
+      "extends": [
+        "cbqp:components/ActorQueryProcess.jsonld#ActorQueryProcess"
+      ],
+      "comment": "A comunica Explain Query Query Process Actor.",
+      "parameters": [
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_queryProcessor",
+          "range": "cbqp:components/ActorQueryProcess.jsonld#IQueryProcessSequential"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_mediatorQuerySerialize",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "Mediator for serializing queries."
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_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/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbqp:components/ActorQueryProcess.jsonld#ActorQueryProcess_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_busFailMessage",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": "Query processing failed: none of the configured actor were process to the query \"${action.query}\"",
+          "comment": "The message that will be configured in the bus for reporting failures.  This message may be a template string that contains references to the executed `action`. For example, the following templated string is allowed: \"RDF dereferencing failed: no actors could handle ${action.handle.mediaType}\""
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_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/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery__member_queryProcessor",
+          "memberFieldName": "queryProcessor",
+          "range": "cbqp:components/ActorQueryProcess.jsonld#IQueryProcessSequential"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery__member_mediatorQuerySerialize",
+          "memberFieldName": "mediatorQuerySerialize",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery__member_run",
+          "memberFieldName": "run"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery__member_sourceAnnotationToServices",
+          "memberFieldName": "sourceAnnotationToServices"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "queryProcessor",
+              "value": {
+                "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_queryProcessor"
+              }
+            },
+            {
+              "keyRaw": "mediatorQuerySerialize",
+              "value": {
+                "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_mediatorQuerySerialize"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_bus"
+              }
+            },
+            {
+              "keyRaw": "busFailMessage",
+              "value": {
+                "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_busFailMessage"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#IActorQueryProcessExplainServiceArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorQueryProcessExplainServiceArgs",
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#IActorQueryProcessExplainServiceArgs__member_queryProcessor",
+          "memberFieldName": "queryProcessor"
+        },
+        {
+          "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#IActorQueryProcessExplainServiceArgs__member_mediatorQuerySerialize",
+          "memberFieldName": "mediatorQuerySerialize"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/ActorQueryProcessExplainService.jsonld ADDED Viewed

@@ -0,0 +1,218 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-process-explain-query/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-process/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^5.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-process-explain-query",
+  "components": [
+    {
+      "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService",
+      "@type": "Class",
+      "requireElement": "ActorQueryProcessExplainService",
+      "extends": [
+        "cbqp:components/ActorQueryProcess.jsonld#ActorQueryProcess"
+      ],
+      "comment": "A comunica Explain Query Query Process Actor.",
+      "parameters": [
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_queryProcessor",
+          "range": "cbqp:components/ActorQueryProcess.jsonld#IQueryProcessSequential"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_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/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbqp:components/ActorQueryProcess.jsonld#ActorQueryProcess_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_busFailMessage",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": "Query processing failed: none of the configured actor were process to the query \"${action.query}\"",
+          "comment": "The message that will be configured in the bus for reporting failures.  This message may be a template string that contains references to the executed `action`. For example, the following templated string is allowed: \"RDF dereferencing failed: no actors could handle ${action.handle.mediaType}\""
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_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/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^5.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_queryStringGenerator",
+          "memberFieldName": "queryStringGenerator",
+          "range": "urn:npm:@traqula/generator-sparql-1-2:Generator"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_queryProcessor",
+          "memberFieldName": "queryProcessor",
+          "range": "cbqp:components/ActorQueryProcess.jsonld#IQueryProcessSequential"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_run",
+          "memberFieldName": "run"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_sourceAnnotationToServices",
+          "memberFieldName": "sourceAnnotationToServices"
+        },
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService__member_operationToQuery",
+          "memberFieldName": "operationToQuery"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "queryProcessor",
+              "value": {
+                "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_queryProcessor"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_bus"
+              }
+            },
+            {
+              "keyRaw": "busFailMessage",
+              "value": {
+                "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_busFailMessage"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#ActorQueryProcessExplainService_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#IActorQueryProcessExplainServiceArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorQueryProcessExplainServiceArgs",
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "caqpes:components/ActorQueryProcessExplainService.jsonld#IActorQueryProcessExplainServiceArgs__member_queryProcessor",
+          "memberFieldName": "queryProcessor"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-process-explain-query/^5.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-process-explain-query",
+  "@type": "Module",
+  "requireName": "@comunica/actor-query-process-explain-query",
+  "import": [
+    "caqpeq:components/ActorQueryProcessExplainQuery.jsonld"
+  ]
+}

package/components/context.jsonld ADDED Viewed

@@ -0,0 +1,58 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "caqpeq": "npmd:@comunica/actor-query-process-explain-query/^5.0.0/",
+      "ActorQueryProcessExplainQuery": {
+        "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery",
+        "@prefix": true,
+        "@context": {
+          "args_queryProcessor": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_queryProcessor"
+          },
+          "args_mediatorQuerySerialize": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_mediatorQuerySerialize"
+          },
+          "args_name": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_name"
+          },
+          "args_bus": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_bus"
+          },
+          "args_busFailMessage": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_busFailMessage"
+          },
+          "args_beforeActors": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_beforeActors",
+            "@container": "@list"
+          },
+          "queryProcessor": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_queryProcessor"
+          },
+          "mediatorQuerySerialize": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_mediatorQuerySerialize"
+          },
+          "name": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_name"
+          },
+          "bus": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_bus"
+          },
+          "busFailMessage": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_busFailMessage"
+          },
+          "beforeActors": {
+            "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#ActorQueryProcessExplainQuery_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorQueryProcessExplainServiceArgs": {
+        "@id": "caqpeq:components/ActorQueryProcessExplainQuery.jsonld#IActorQueryProcessExplainServiceArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorQueryProcessExplainQuery.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+import { ActorQueryProcess } from '@comunica/bus-query-process';
+import type { IActionQueryProcess, IActorQueryProcessOutput, IActorQueryProcessArgs, IQueryProcessSequential } from '@comunica/bus-query-process';
+import type { MediatorQuerySerialize } from '@comunica/bus-query-serialize';
+import type { TestResult, IActorTest } from '@comunica/core';
+import { Algebra, AlgebraFactory } from '@comunica/utils-algebra';
+import type * as RDF from '@rdfjs/types';
+/**
+ * A comunica Explain Query Query Process Actor.
+ */
+export declare class ActorQueryProcessExplainQuery extends ActorQueryProcess {
+    readonly queryProcessor: IQueryProcessSequential;
+    readonly mediatorQuerySerialize: MediatorQuerySerialize;
+    constructor(args: IActorQueryProcessExplainServiceArgs);
+    test(action: IActionQueryProcess): Promise<TestResult<IActorTest>>;
+    run(action: IActionQueryProcess): Promise<IActorQueryProcessOutput>;
+    static sourceAnnotationToServices(algebraFactory: AlgebraFactory, dataFactory: RDF.DataFactory, operation: Algebra.Operation): Algebra.Operation;
+}
+export interface IActorQueryProcessExplainServiceArgs extends IActorQueryProcessArgs {
+    queryProcessor: IQueryProcessSequential;
+    /**
+     * Mediator for serializing queries.
+     */
+    mediatorQuerySerialize: MediatorQuerySerialize;
+}

package/lib/ActorQueryProcessExplainQuery.js ADDED Viewed

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorQueryProcessExplainQuery = void 0;
+const bus_query_process_1 = require("@comunica/bus-query-process");
+const context_entries_1 = require("@comunica/context-entries");
+const core_1 = require("@comunica/core");
+const utils_algebra_1 = require("@comunica/utils-algebra");
+const utils_query_operation_1 = require("@comunica/utils-query-operation");
+/**
+ * A comunica Explain Query Query Process Actor.
+ */
+class ActorQueryProcessExplainQuery extends bus_query_process_1.ActorQueryProcess {
+    queryProcessor;
+    mediatorQuerySerialize;
+    constructor(args) {
+        super(args);
+        this.queryProcessor = args.queryProcessor;
+        this.mediatorQuerySerialize = args.mediatorQuerySerialize;
+    }
+    async test(action) {
+        if ((action.context.get(context_entries_1.KeysInitQuery.explain) ??
+            action.context.get(new core_1.ActionContextKey('explain'))) !== 'query') {
+            return (0, core_1.failTest)(`${this.name} can only explain in 'query' mode.`);
+        }
+        return (0, core_1.passTestVoid)();
+    }
+    async run(action) {
+        // Parse and optimize the query
+        let { operation, context } = await this.queryProcessor.parse(action.query, action.context);
+        ({ operation, context } = await this.queryProcessor.optimize(operation, context));
+        // Convert source annotations to SERVICE clauses
+        const AF = new utils_algebra_1.AlgebraFactory();
+        operation = ActorQueryProcessExplainQuery.sourceAnnotationToServices(AF, context.getSafe(context_entries_1.KeysInitQuery.dataFactory), operation);
+        // Serialize the operation to a SPARQL query
+        let data;
+        if (operation.type === utils_algebra_1.Algebra.Types.UNION) {
+            // This can happen if it was determined during optimization that the query has zero results.
+            data = 'SELECT * WHERE { FILTER(false) }';
+        }
+        else {
+            data = (await this.mediatorQuerySerialize.mediate({
+                queryFormat: { language: 'sparql', version: '1.1' },
+                operation,
+                newlines: true,
+                indentWidth: 2,
+                context,
+            })).query;
+        }
+        return {
+            result: {
+                explain: true,
+                type: 'query',
+                data,
+            },
+        };
+    }
+    static sourceAnnotationToServices(algebraFactory, dataFactory, operation) {
+        // TODO: The casts below should not be necessary.
+        return utils_algebra_1.transformer.transformObject(operation, (subOperationUntyped) => {
+            const subOperation = subOperationUntyped;
+            const source = (0, utils_query_operation_1.getOperationSource)(subOperation);
+            if (source) {
+                return algebraFactory.createService(subOperation, typeof source.source.referenceValue === 'string' ?
+                    dataFactory.namedNode(source.source.referenceValue) :
+                    dataFactory.namedNode(`comunica:${source.source.referenceValue.constructor.name}`), source.context?.get(context_entries_1.KeysInitQuery.lenient));
+            }
+            return subOperation;
+        });
+    }
+}
+exports.ActorQueryProcessExplainQuery = ActorQueryProcessExplainQuery;
+//# sourceMappingURL=ActorQueryProcessExplainQuery.js.map

package/lib/ActorQueryProcessExplainQuery.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"ActorQueryProcessExplainQuery.js","sourceRoot":"","sources":["ActorQueryProcessExplainQuery.ts"],"names":[],"mappings":";;;AAAA,mEAAgE;AAQhE,+DAA0D;AAE1D,yCAA0E;AAC1E,2DAA+E;AAC/E,2EAAqE;AAGrE;;GAEG;AACH,MAAa,6BAA8B,SAAQ,qCAAiB;IAClD,cAAc,CAA0B;IACxC,sBAAsB,CAAyB;IAE/D,YAAmB,IAA0C;QAC3D,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAA2B;QAC3C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,OAAO,CAAC;YAC5C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,uBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;YACnE,OAAO,IAAA,eAAQ,EAAC,GAAG,IAAI,CAAC,IAAI,oCAAoC,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,IAAA,mBAAY,GAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAA2B;QAC1C,+BAA+B;QAC/B,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3F,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAElF,gDAAgD;QAChD,MAAM,EAAE,GAAG,IAAI,8BAAc,EAAE,CAAC;QAChC,SAAS,GAAG,6BAA6B,CAAC,0BAA0B,CAClE,EAAE,EACF,OAAO,CAAC,OAAO,CAAC,+BAAa,CAAC,WAAW,CAAC,EAC1C,SAAS,CACV,CAAC;QAEF,4CAA4C;QAC5C,IAAI,IAAY,CAAC;QACjB,IAAI,SAAS,CAAC,IAAI,KAAK,uBAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC3C,4FAA4F;YAC5F,IAAI,GAAG,kCAAkC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC;gBAChD,WAAW,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE;gBACnD,SAAS;gBACT,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,CAAC;gBACd,OAAO;aACR,CAAC,CAAC,CAAC,KAAK,CAAC;QACZ,CAAC;QAED,OAAO;YACL,MAAM,EAAE;gBACN,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,OAAO;gBACb,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,0BAA0B,CACtC,cAA8B,EAC9B,WAA4B,EAC5B,SAA4B;QAE5B,iDAAiD;QACjD,OAA2B,2BAAW,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,mBAA2B,EAAE,EAAE;YAChG,MAAM,YAAY,GAAuB,mBAAmB,CAAC;YAC7D,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,YAAY,CAAC,CAAC;YAChD,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,cAAc,CAAC,aAAa,CACjC,YAAY,EACZ,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC;oBAChD,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;oBACrD,WAAW,CAAC,SAAS,CAAC,YAAY,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,EACpF,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,+BAAa,CAAC,OAAO,CAAC,CAC3C,CAAC;YACJ,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5ED,sEA4EC","sourcesContent":["import { ActorQueryProcess } from '@comunica/bus-query-process';\nimport type {\n IActionQueryProcess,\n IActorQueryProcessOutput,\n IActorQueryProcessArgs,\n IQueryProcessSequential,\n} from '@comunica/bus-query-process';\nimport type { MediatorQuerySerialize } from '@comunica/bus-query-serialize';\nimport { KeysInitQuery } from '@comunica/context-entries';\nimport type { TestResult, IActorTest } from '@comunica/core';\nimport { ActionContextKey, failTest, passTestVoid } from '@comunica/core';\nimport { Algebra, AlgebraFactory, transformer } from '@comunica/utils-algebra';\nimport { getOperationSource } from '@comunica/utils-query-operation';\nimport type * as RDF from '@rdfjs/types';\n\n/**\n * A comunica Explain Query Query Process Actor.\n */\nexport class ActorQueryProcessExplainQuery extends ActorQueryProcess {\n public readonly queryProcessor: IQueryProcessSequential;\n public readonly mediatorQuerySerialize: MediatorQuerySerialize;\n\n public constructor(args: IActorQueryProcessExplainServiceArgs) {\n super(args);\n this.queryProcessor = args.queryProcessor;\n this.mediatorQuerySerialize = args.mediatorQuerySerialize;\n }\n\n public async test(action: IActionQueryProcess): Promise<TestResult<IActorTest>> {\n if ((action.context.get(KeysInitQuery.explain) ??\n action.context.get(new ActionContextKey('explain'))) !== 'query') {\n return failTest(`${this.name} can only explain in 'query' mode.`);\n }\n return passTestVoid();\n }\n\n public async run(action: IActionQueryProcess): Promise<IActorQueryProcessOutput> {\n // Parse and optimize the query\n let { operation, context } = await this.queryProcessor.parse(action.query, action.context);\n ({ operation, context } = await this.queryProcessor.optimize(operation, context));\n\n // Convert source annotations to SERVICE clauses\n const AF = new AlgebraFactory();\n operation = ActorQueryProcessExplainQuery.sourceAnnotationToServices(\n AF,\n context.getSafe(KeysInitQuery.dataFactory),\n operation,\n );\n\n // Serialize the operation to a SPARQL query\n let data: string;\n if (operation.type === Algebra.Types.UNION) {\n // This can happen if it was determined during optimization that the query has zero results.\n data = 'SELECT * WHERE { FILTER(false) }';\n } else {\n data = (await this.mediatorQuerySerialize.mediate({\n queryFormat: { language: 'sparql', version: '1.1' },\n operation,\n newlines: true,\n indentWidth: 2,\n context,\n })).query;\n }\n\n return {\n result: {\n explain: true,\n type: 'query',\n data,\n },\n };\n }\n\n public static sourceAnnotationToServices(\n algebraFactory: AlgebraFactory,\n dataFactory: RDF.DataFactory,\n operation: Algebra.Operation,\n ): Algebra.Operation {\n // TODO: The casts below should not be necessary.\n return <Algebra.Operation> transformer.transformObject(operation, (subOperationUntyped: object) => {\n const subOperation = <Algebra.Operation> subOperationUntyped;\n const source = getOperationSource(subOperation);\n if (source) {\n return algebraFactory.createService(\n subOperation,\n typeof source.source.referenceValue === 'string' ?\n dataFactory.namedNode(source.source.referenceValue) :\n dataFactory.namedNode(`comunica:${source.source.referenceValue.constructor.name}`),\n source.context?.get(KeysInitQuery.lenient),\n );\n }\n return subOperation;\n });\n }\n}\n\nexport interface IActorQueryProcessExplainServiceArgs extends IActorQueryProcessArgs {\n queryProcessor: IQueryProcessSequential;\n /**\n * Mediator for serializing queries.\n */\n mediatorQuerySerialize: MediatorQuerySerialize;\n}\n"]}

package/lib/index.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export * from './ActorQueryProcessExplainQuery';

package/lib/index.js ADDED Viewed

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActorQueryProcessExplainQuery"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAAgD","sourcesContent":["export * from './ActorQueryProcessExplainQuery';\n"]}

package/package.json ADDED Viewed

@@ -0,0 +1,53 @@
+{
+  "name": "@comunica/actor-query-process-explain-query",
+  "version": "4.5.0",
+  "description": "A explain-query query-process actor",
+  "lsd:module": true,
+  "license": "MIT",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/comunica-association"
+  },
+  "homepage": "https://comunica.dev/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/actor-query-process-explain-query"
+  },
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "keywords": [
+    "comunica",
+    "actor",
+    "query-process",
+    "explain-query"
+  ],
+  "sideEffects": false,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js",
+    "lib/**/*.js.map"
+  ],
+  "scripts": {
+    "build": "yarn run build:ts && yarn run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "dependencies": {
+    "@comunica/bus-query-process": "^4.5.0",
+    "@comunica/bus-query-serialize": "^4.5.0",
+    "@comunica/context-entries": "^4.5.0",
+    "@comunica/core": "^4.5.0",
+    "@comunica/utils-algebra": "^4.0.2",
+    "@comunica/utils-query-operation": "^4.5.0",
+    "@rdfjs/types": "*"
+  },
+  "gitHead": "fb01ead4dc1f68c06bfa1d34ecbf48380b8ea3a3"
+}