@comunica/actor-query-operation-wrap-stream 4.1.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,42 @@
+# Comunica Wrap Stream Query Operation Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-query-operation-wrap-stream.svg)](https://www.npmjs.com/package/@comunica/actor-query-operation-wrap-stream)
+
+A comunica Wrap Stream Query Operation Actor. This actor calls the `bus-iterator-transform` for all iterators produced by `query-operation` actors.
+This actor should only be included if you require the functionality of `bus-iterator-transform` as it may slow down query execution.
+
+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-operation-wrap-stream
+```
+
+## 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-operation-wrap-stream/^1.0.0/components/context.jsonld"
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:query-operation/actors#wrap-stream",
+      "@type": "ActorQueryOperationWrapStream",
+      "mediatorQueryOperation": { "@id": "urn:comunica:default:query-operation/mediators#main" },
+      "mediatorIteratorTransform": { "@id": "urn:comunica:default:iterator-transform/mediators#main" }
+    }
+  ]
+}
+```
+
+### Config Parameters
+* `mediatorIteratorTransform`: Mediator that will run all actors subscribed to the `bus-iterator-transform` in sequence.
+* `mediatorQueryOperation`: Mediator that runs the query operation that will be wrapped.

package/components/ActorQueryOperationWrapStream.jsonld

@@ -0,0 +1,230 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-wrap-stream/^4.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^4.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^4.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-operation-wrap-stream",
+  "components": [
+    {
+      "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream",
+      "@type": "Class",
+      "requireElement": "ActorQueryOperationWrapStream",
+      "extends": [
+        "cbqo:components/ActorQueryOperation.jsonld#ActorQueryOperation"
+      ],
+      "comment": "A comunica Wrap Stream Query Operation Actor.",
+      "parameters": [
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorIteratorTransform",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "Mediator that runs all transforms defined by user over the output stream of the query operation"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorQueryOperation",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "Mediator that runs the next query operation"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_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/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbqo:components/ActorQueryOperation.jsonld#ActorQueryOperation_default_bus",
+            "@type": "cbqo:components/BusQueryOperation.jsonld#BusQueryOperation"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_busFailMessage",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": "Query operation processing failed: none of the configured actors were able to handle the operation type ${action.operation.type}",
+          "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": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_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/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^4.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_TS"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream__member_mediatorIteratorTransform",
+          "memberFieldName": "mediatorIteratorTransform",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream__member_mediatorQueryOperation",
+          "memberFieldName": "mediatorQueryOperation",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream__member_run",
+          "memberFieldName": "run"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream__member_setContextWrapped",
+          "memberFieldName": "setContextWrapped"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "mediatorIteratorTransform",
+              "value": {
+                "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorIteratorTransform"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryOperation",
+              "value": {
+                "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorQueryOperation"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_bus"
+              }
+            },
+            {
+              "keyRaw": "busFailMessage",
+              "value": {
+                "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_busFailMessage"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#IActorQueryOperationWrapStreamArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorQueryOperationWrapStreamArgs",
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#IActorQueryOperationWrapStreamArgs__member_mediatorIteratorTransform",
+          "memberFieldName": "mediatorIteratorTransform"
+        },
+        {
+          "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#IActorQueryOperationWrapStreamArgs__member_mediatorQueryOperation",
+          "memberFieldName": "mediatorQueryOperation"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-wrap-stream/^4.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-operation-wrap-stream",
+  "@type": "Module",
+  "requireName": "@comunica/actor-query-operation-wrap-stream",
+  "import": [
+    "caqows:components/ActorQueryOperationWrapStream.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,58 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "caqows": "npmd:@comunica/actor-query-operation-wrap-stream/^4.0.0/",
+      "ActorQueryOperationWrapStream": {
+        "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream",
+        "@prefix": true,
+        "@context": {
+          "args_mediatorIteratorTransform": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorIteratorTransform"
+          },
+          "args_mediatorQueryOperation": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorQueryOperation"
+          },
+          "args_name": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_name"
+          },
+          "args_bus": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_bus"
+          },
+          "args_busFailMessage": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_busFailMessage"
+          },
+          "args_beforeActors": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_beforeActors",
+            "@container": "@list"
+          },
+          "mediatorIteratorTransform": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorIteratorTransform"
+          },
+          "mediatorQueryOperation": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_mediatorQueryOperation"
+          },
+          "name": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_name"
+          },
+          "bus": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_bus"
+          },
+          "busFailMessage": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_busFailMessage"
+          },
+          "beforeActors": {
+            "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#ActorQueryOperationWrapStream_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorQueryOperationWrapStreamArgs": {
+        "@id": "caqows:components/ActorQueryOperationWrapStream.jsonld#IActorQueryOperationWrapStreamArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorQueryOperationWrapStream.d.ts

@@ -0,0 +1,38 @@
+import type { MediatorIteratorTransform } from '@comunica/bus-iterator-transform';
+import type { IActionQueryOperation, IActorQueryOperationArgs, MediatorQueryOperation } from '@comunica/bus-query-operation';
+import { ActorQueryOperation } from '@comunica/bus-query-operation';
+import { ActionContextKey } from '@comunica/core';
+import type { TestResult, IActorTest } from '@comunica/core';
+import type { IActionContext, IQueryOperationResult } from '@comunica/types';
+import type { Algebra } from 'sparqlalgebrajs';
+/**
+ * A comunica Wrap Stream Query Operation Actor.
+ */
+export declare class ActorQueryOperationWrapStream extends ActorQueryOperation {
+    readonly mediatorIteratorTransform: MediatorIteratorTransform;
+    readonly mediatorQueryOperation: MediatorQueryOperation;
+    constructor(args: IActorQueryOperationWrapStreamArgs);
+    test(action: IActionQueryOperation): Promise<TestResult<IActorTest>>;
+    run(action: IActionQueryOperation): Promise<IQueryOperationResult>;
+    /**
+     * Sets KEY_CONTEXT_WRAPPED_QUERY_OPERATION to the operation being executed.
+     * @param operation The query operation.
+     * @param context The current action context.
+     * @returns A new action context with the operation marked as wrapped.
+     */
+    setContextWrapped(operation: Algebra.Operation, context: IActionContext): IActionContext;
+}
+export interface IActorQueryOperationWrapStreamArgs extends IActorQueryOperationArgs {
+    /**
+     * Mediator that runs all transforms defined by user over the output stream of the query operation
+     */
+    mediatorIteratorTransform: MediatorIteratorTransform;
+    /**
+     * Mediator that runs the next query operation
+     */
+    mediatorQueryOperation: MediatorQueryOperation;
+}
+/**
+ * Key that that stores the last executed operation
+ */
+export declare const KEY_CONTEXT_WRAPPED_QUERY_OPERATION: ActionContextKey<Algebra.Operation>;

package/lib/ActorQueryOperationWrapStream.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KEY_CONTEXT_WRAPPED_QUERY_OPERATION = exports.ActorQueryOperationWrapStream = void 0;
+const bus_query_operation_1 = require("@comunica/bus-query-operation");
+const core_1 = require("@comunica/core");
+/**
+ * A comunica Wrap Stream Query Operation Actor.
+ */
+class ActorQueryOperationWrapStream extends bus_query_operation_1.ActorQueryOperation {
+    constructor(args) {
+        super(args);
+    }
+    async test(action) {
+        if (action.context.get(exports.KEY_CONTEXT_WRAPPED_QUERY_OPERATION) === action.operation) {
+            return (0, core_1.failTest)('Unable to wrap query source multiple times');
+        }
+        // Ensure this is always run if not already wrapped
+        return (0, core_1.passTest)({ httpRequests: Number.NEGATIVE_INFINITY });
+    }
+    async run(action) {
+        // Prevent infinite recursion. In consequent query operation calls this key should be set to false
+        // To allow the operation to wrap ALL query operation runs
+        action.context = this.setContextWrapped(action.operation, action.context);
+        const output = await this.mediatorQueryOperation.mediate(action);
+        switch (output.type) {
+            case 'bindings': {
+                const bindingIteratorTransformed = await this.mediatorIteratorTransform.mediate({
+                    type: 'bindings',
+                    operation: action.operation.type,
+                    stream: output.bindingsStream,
+                    metadata: output.metadata,
+                    originalAction: action,
+                    context: action.context,
+                });
+                output.bindingsStream =
+                    bindingIteratorTransformed.stream;
+                output.metadata =
+                    bindingIteratorTransformed.metadata;
+                break;
+            }
+            case 'quads': {
+                const iteratorTransformed = await this.mediatorIteratorTransform.mediate({
+                    type: 'quads',
+                    operation: action.operation.type,
+                    stream: output.quadStream,
+                    metadata: output.metadata,
+                    context: action.context,
+                    originalAction: action,
+                });
+                output.quadStream = iteratorTransformed.stream;
+                output.metadata = iteratorTransformed.metadata;
+                break;
+            }
+            default: {
+                break;
+            }
+        }
+        return output;
+    }
+    /**
+     * Sets KEY_CONTEXT_WRAPPED_QUERY_OPERATION to the operation being executed.
+     * @param operation The query operation.
+     * @param context The current action context.
+     * @returns A new action context with the operation marked as wrapped.
+     */
+    setContextWrapped(operation, context) {
+        return context.set(exports.KEY_CONTEXT_WRAPPED_QUERY_OPERATION, operation);
+    }
+}
+exports.ActorQueryOperationWrapStream = ActorQueryOperationWrapStream;
+/**
+ * Key that that stores the last executed operation
+ */
+exports.KEY_CONTEXT_WRAPPED_QUERY_OPERATION = new core_1.ActionContextKey('@comunica/actor-query-operation:wrapped');
+//# sourceMappingURL=ActorQueryOperationWrapStream.js.map

package/lib/ActorQueryOperationWrapStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorQueryOperationWrapStream.js","sourceRoot":"","sources":["ActorQueryOperationWrapStream.ts"],"names":[],"mappings":";;;AAMA,uEAAoE;AACpE,yCAAsE;AAOtE;;GAEG;AACH,MAAa,6BAA8B,SAAQ,yCAAmB;IAIpE,YAAmB,IAAwC;QACzD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAA6B;QAC7C,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,2CAAmC,CAAC,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC;YACjF,OAAO,IAAA,eAAQ,EAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QACD,mDAAmD;QACnD,OAAO,IAAA,eAAQ,EAAC,EAAE,YAAY,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAA6B;QAC5C,kGAAkG;QAClG,0DAA0D;QAC1D,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1E,MAAM,MAAM,GAA0B,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACxF,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,0BAA0B,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAC7E;oBACE,IAAI,EAAE,UAAU;oBAChB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI;oBAChC,MAAM,EAAE,MAAM,CAAC,cAAc;oBAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,cAAc,EAAE,MAAM;oBACtB,OAAO,EAAE,MAAM,CAAC,OAAO;iBACxB,CACF,CAAC;gBACF,MAAM,CAAC,cAAc;oBACW,0BAA0B,CAAC,MAAM,CAAC;gBAClE,MAAM,CAAC,QAAQ;oBACqB,0BAA0B,CAAC,QAAQ,CAAC;gBACxE,MAAM;YACR,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,OAAO,CACtE;oBACE,IAAI,EAAE,OAAO;oBACb,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI;oBAChC,MAAM,EAAE,MAAM,CAAC,UAAU;oBACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,cAAc,EAAE,MAAM;iBACvB,CACF,CAAC;gBACF,MAAM,CAAC,UAAU,GAA6B,mBAAmB,CAAC,MAAM,CAAC;gBACzE,MAAM,CAAC,QAAQ,GAAkC,mBAAmB,CAAC,QAAQ,CAAC;gBAC9E,MAAM;YACR,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM;YACR,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,SAA4B,EAAE,OAAuB;QAC5E,OAAO,OAAO,CAAC,GAAG,CAAC,2CAAmC,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC;CACF;AAtED,sEAsEC;AAaD;;GAEG;AACU,QAAA,mCAAmC,GAAG,IAAI,uBAAgB,CACrE,yCAAyC,CAC1C,CAAC","sourcesContent":["import type { MediatorIteratorTransform } from '@comunica/bus-iterator-transform';\nimport type {\n  IActionQueryOperation,\n  IActorQueryOperationArgs,\n  MediatorQueryOperation,\n} from '@comunica/bus-query-operation';\nimport { ActorQueryOperation } from '@comunica/bus-query-operation';\nimport { ActionContextKey, failTest, passTest } from '@comunica/core';\nimport type { TestResult, IActorTest } from '@comunica/core';\nimport type { IActionContext, IQueryOperationResult, MetadataBindings, MetadataQuads } from '@comunica/types';\nimport type * as RDF from '@rdfjs/types';\nimport type { AsyncIterator } from 'asynciterator';\nimport type { Algebra } from 'sparqlalgebrajs';\n\n/**\n * A comunica Wrap Stream Query Operation Actor.\n */\nexport class ActorQueryOperationWrapStream extends ActorQueryOperation {\n  public readonly mediatorIteratorTransform: MediatorIteratorTransform;\n  public readonly mediatorQueryOperation: MediatorQueryOperation;\n\n  public constructor(args: IActorQueryOperationWrapStreamArgs) {\n    super(args);\n  }\n\n  public async test(action: IActionQueryOperation): Promise<TestResult<IActorTest>> {\n    if (action.context.get(KEY_CONTEXT_WRAPPED_QUERY_OPERATION) === action.operation) {\n      return failTest('Unable to wrap query source multiple times');\n    }\n    // Ensure this is always run if not already wrapped\n    return passTest({ httpRequests: Number.NEGATIVE_INFINITY });\n  }\n\n  public async run(action: IActionQueryOperation): Promise<IQueryOperationResult> {\n    // Prevent infinite recursion. In consequent query operation calls this key should be set to false\n    // To allow the operation to wrap ALL query operation runs\n    action.context = this.setContextWrapped(action.operation, action.context);\n    const output: IQueryOperationResult = await this.mediatorQueryOperation.mediate(action);\n    switch (output.type) {\n      case 'bindings': {\n        const bindingIteratorTransformed = await this.mediatorIteratorTransform.mediate(\n          {\n            type: 'bindings',\n            operation: action.operation.type,\n            stream: output.bindingsStream,\n            metadata: output.metadata,\n            originalAction: action,\n            context: action.context,\n          },\n        );\n        output.bindingsStream =\n          <AsyncIterator<RDF.Bindings>> bindingIteratorTransformed.stream;\n        output.metadata =\n          <() => Promise<MetadataBindings>> bindingIteratorTransformed.metadata;\n        break;\n      }\n      case 'quads': {\n        const iteratorTransformed = await this.mediatorIteratorTransform.mediate(\n          {\n            type: 'quads',\n            operation: action.operation.type,\n            stream: output.quadStream,\n            metadata: output.metadata,\n            context: action.context,\n            originalAction: action,\n          },\n        );\n        output.quadStream = <AsyncIterator<RDF.Quad>> iteratorTransformed.stream;\n        output.metadata = <() => Promise<MetadataQuads>> iteratorTransformed.metadata;\n        break;\n      }\n      default: {\n        break;\n      }\n    }\n    return output;\n  }\n\n  /**\n   * Sets KEY_CONTEXT_WRAPPED_QUERY_OPERATION to the operation being executed.\n   * @param operation The query operation.\n   * @param context The current action context.\n   * @returns A new action context with the operation marked as wrapped.\n   */\n  public setContextWrapped(operation: Algebra.Operation, context: IActionContext): IActionContext {\n    return context.set(KEY_CONTEXT_WRAPPED_QUERY_OPERATION, operation);\n  }\n}\n\nexport interface IActorQueryOperationWrapStreamArgs extends IActorQueryOperationArgs {\n  /**\n   * Mediator that runs all transforms defined by user over the output stream of the query operation\n   */\n  mediatorIteratorTransform: MediatorIteratorTransform;\n  /**\n   * Mediator that runs the next query operation\n   */\n  mediatorQueryOperation: MediatorQueryOperation;\n}\n\n/**\n * Key that that stores the last executed operation\n */\nexport const KEY_CONTEXT_WRAPPED_QUERY_OPERATION = new ActionContextKey<Algebra.Operation>(\n  '@comunica/actor-query-operation:wrapped',\n);\n"]}

package/lib/index.d.ts

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

package/lib/index.js

@@ -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("./ActorQueryOperationWrapStream"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

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

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@comunica/actor-query-operation-wrap-stream",
+  "version": "4.1.0",
+  "description": "A wrap-stream query-operation 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-operation-wrap-stream"
+  },
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "keywords": [
+    "comunica",
+    "actor",
+    "query-operation",
+    "wrap-stream"
+  ],
+  "sideEffects": false,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js",
+    "lib/**/*.js.map"
+  ],
+  "scripts": {
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "dependencies": {
+    "@comunica/bus-iterator-transform": "^4.1.0",
+    "@comunica/bus-query-operation": "^4.1.0",
+    "@comunica/core": "^4.1.0",
+    "@comunica/types": "^4.1.0",
+    "sparqlalgebrajs": "^4.3.8"
+  },
+  "gitHead": "711446473d18f5fd47aa1a67e6c23582234221ec"
+}