npm - @comunica/actor-rdf-join-wrap-stream - Versions diffs - 4.1.0 - Mend

@comunica/actor-rdf-join-wrap-stream 4.1.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 (12) hide show

package/LICENSE.txt +22 -0
package/README.md +40 -0
package/components/ActorRdfJoinWrapStream.jsonld +247 -0
package/components/components.jsonld +11 -0
package/components/context.jsonld +64 -0
package/lib/ActorRdfJoinWrapStream.d.ts +39 -0
package/lib/ActorRdfJoinWrapStream.js +67 -0
package/lib/ActorRdfJoinWrapStream.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 +51 -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,40 @@
+# Comunica Wrap Stream RDF Join Actor
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-rdf-join-wrap-stream.svg)](https://www.npmjs.com/package/@comunica/actor-rdf-join-wrap-stream)
+A comunica Wrap Stream RDF Join 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-rdf-join-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-rdf-join-wrap-stream/^1.0.0/components/context.jsonld"
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:rdf-join/actors#wrap-stream",
+      "@type": "ActorRdfJoinWrapStream"
+    }
+  ]
+}
+```
+### Config Parameters
+* `mediatorIteratorTransform`: Mediator that will run all actors subscribed to the `bus-iterator-transform` in sequence.
+* `mediatorJoin`: Mediator that runs the join operation that will be wrapped.

package/components/ActorRdfJoinWrapStream.jsonld ADDED Viewed

@@ -0,0 +1,247 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-rdf-join-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-rdf-join/^4.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-rdf-join-wrap-stream",
+  "components": [
+    {
+      "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream",
+      "@type": "Class",
+      "requireElement": "ActorRdfJoinWrapStream",
+      "extends": [
+        "cbrj:components/ActorRdfJoin.jsonld#ActorRdfJoin"
+      ],
+      "comment": "A comunica Wrap Stream RDF Join Actor.",
+      "parameters": [
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_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": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoin",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "Mediator that calls next join to be wrapped"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoinSelectivity",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_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": "cbrj:components/ActorRdfJoin.jsonld#ActorRdfJoin_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_busFailMessage",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "xsd:string",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": "RDF joining failed: none of the configured actors were able to handle the join type ${action.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": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_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": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_mediatorJoin",
+          "memberFieldName": "mediatorJoin",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_mediatorIteratorTransform",
+          "memberFieldName": "mediatorIteratorTransform",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_getOutput",
+          "memberFieldName": "getOutput"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_getJoinCoefficients",
+          "memberFieldName": "getJoinCoefficients"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream__member_setContextWrapped",
+          "memberFieldName": "setContextWrapped"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "mediatorIteratorTransform",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorIteratorTransform"
+              }
+            },
+            {
+              "keyRaw": "mediatorJoin",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoin"
+              }
+            },
+            {
+              "keyRaw": "mediatorJoinSelectivity",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoinSelectivity"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_bus"
+              }
+            },
+            {
+              "keyRaw": "busFailMessage",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_busFailMessage"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#IActorRdfJoinWrapStreamArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorRdfJoinWrapStreamArgs",
+      "extends": [
+        "cbrj:components/ActorRdfJoin.jsonld#IActorRdfJoinArgs"
+      ],
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#IActorRdfJoinWrapStreamArgs__member_mediatorIteratorTransform",
+          "memberFieldName": "mediatorIteratorTransform"
+        },
+        {
+          "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#IActorRdfJoinWrapStreamArgs__member_mediatorJoin",
+          "memberFieldName": "mediatorJoin"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld ADDED Viewed

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

package/components/context.jsonld ADDED Viewed

@@ -0,0 +1,64 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "carjws": "npmd:@comunica/actor-rdf-join-wrap-stream/^4.0.0/",
+      "ActorRdfJoinWrapStream": {
+        "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream",
+        "@prefix": true,
+        "@context": {
+          "args_mediatorIteratorTransform": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorIteratorTransform"
+          },
+          "args_mediatorJoin": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoin"
+          },
+          "args_mediatorJoinSelectivity": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoinSelectivity"
+          },
+          "args_name": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_name"
+          },
+          "args_bus": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_bus"
+          },
+          "args_busFailMessage": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_busFailMessage"
+          },
+          "args_beforeActors": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_beforeActors",
+            "@container": "@list"
+          },
+          "mediatorIteratorTransform": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorIteratorTransform"
+          },
+          "mediatorJoin": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoin"
+          },
+          "mediatorJoinSelectivity": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_mediatorJoinSelectivity"
+          },
+          "name": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_name"
+          },
+          "bus": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_bus"
+          },
+          "busFailMessage": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_busFailMessage"
+          },
+          "beforeActors": {
+            "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#ActorRdfJoinWrapStream_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorRdfJoinWrapStreamArgs": {
+        "@id": "carjws:components/ActorRdfJoinWrapStream.jsonld#IActorRdfJoinWrapStreamArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorRdfJoinWrapStream.d.ts ADDED Viewed

@@ -0,0 +1,39 @@
+import type { MediatorIteratorTransform } from '@comunica/bus-iterator-transform';
+import type { IActionRdfJoin, IActorRdfJoinOutputInner, IActorRdfJoinArgs, MediatorRdfJoin, IActorRdfJoinTestSideData } from '@comunica/bus-rdf-join';
+import { ActorRdfJoin } from '@comunica/bus-rdf-join';
+import type { TestResult } from '@comunica/core';
+import { ActionContextKey } from '@comunica/core';
+import type { IMediatorTypeJoinCoefficients } from '@comunica/mediatortype-join-coefficients';
+import type { IActionContext, IJoinEntry } from '@comunica/types';
+/**
+ * A comunica Wrap Stream RDF Join Actor.
+ */
+export declare class ActorRdfJoinWrapStream extends ActorRdfJoin {
+    readonly mediatorJoin: MediatorRdfJoin;
+    readonly mediatorIteratorTransform: MediatorIteratorTransform;
+    constructor(args: IActorRdfJoinWrapStreamArgs);
+    test(action: IActionRdfJoin): Promise<TestResult<IMediatorTypeJoinCoefficients, IActorRdfJoinTestSideData>>;
+    getOutput(action: IActionRdfJoin): Promise<IActorRdfJoinOutputInner>;
+    protected getJoinCoefficients(_action: IActionRdfJoin, sideData: IActorRdfJoinTestSideData): Promise<TestResult<IMediatorTypeJoinCoefficients, IActorRdfJoinTestSideData>>;
+    /**
+     * Sets KEY_CONTEXT_WRAPPED_RDF_JOIN key in the context to the entries being joined.
+     * @param action The join action being executed
+     * @param context The ActionContext
+     * @returns The updated ActionContext
+     */
+    setContextWrapped(action: IActionRdfJoin, context: IActionContext): IActionContext;
+}
+export interface IActorRdfJoinWrapStreamArgs extends IActorRdfJoinArgs {
+    /**
+     * Mediator that runs all transforms defined by user over the output stream of the query operation
+     */
+    mediatorIteratorTransform: MediatorIteratorTransform;
+    /**
+     * Mediator that calls next join to be wrapped
+     */
+    mediatorJoin: MediatorRdfJoin;
+}
+/**
+ * Key that shows if the query operation has already been wrapped by a process iterator call
+ */
+export declare const KEY_CONTEXT_WRAPPED_RDF_JOIN: ActionContextKey<IJoinEntry[]>;

package/lib/ActorRdfJoinWrapStream.js ADDED Viewed

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KEY_CONTEXT_WRAPPED_RDF_JOIN = exports.ActorRdfJoinWrapStream = void 0;
+const bus_rdf_join_1 = require("@comunica/bus-rdf-join");
+const core_1 = require("@comunica/core");
+/**
+ * A comunica Wrap Stream RDF Join Actor.
+ */
+class ActorRdfJoinWrapStream extends bus_rdf_join_1.ActorRdfJoin {
+    constructor(args) {
+        super(args, {
+            logicalType: 'inner',
+            physicalName: 'wrap-stream',
+            limitEntries: 0,
+            limitEntriesMin: true,
+            canHandleUndefs: true,
+            isLeaf: false,
+        });
+    }
+    async test(action) {
+        if (action.context.get(exports.KEY_CONTEXT_WRAPPED_RDF_JOIN) === action.entries) {
+            return (0, core_1.failTest)('Unable to wrap join operation multiple times');
+        }
+        const metadatas = await bus_rdf_join_1.ActorRdfJoin.getMetadatas(action.entries);
+        return await this.getJoinCoefficients(action, { metadatas });
+    }
+    async getOutput(action) {
+        // Prevent infinite recursion. In consequent query operation calls this key is set to false
+        // To allow the operation to wrap ALL rdf-join runs
+        action.context = this.setContextWrapped(action, action.context);
+        const result = await this.mediatorJoin.mediate(action);
+        const { stream, metadata } = (await this.mediatorIteratorTransform.mediate({
+            type: result.type,
+            operation: action.type,
+            stream: result.bindingsStream,
+            metadata: result.metadata,
+            context: action.context,
+            originalAction: action,
+        }));
+        result.bindingsStream = stream;
+        result.metadata = metadata;
+        return { result };
+    }
+    async getJoinCoefficients(_action, sideData) {
+        return (0, core_1.passTestWithSideData)({
+            iterations: -1,
+            persistedItems: -1,
+            blockingItems: -1,
+            requestTime: -1,
+        }, sideData);
+    }
+    /**
+     * Sets KEY_CONTEXT_WRAPPED_RDF_JOIN key in the context to the entries being joined.
+     * @param action The join action being executed
+     * @param context The ActionContext
+     * @returns The updated ActionContext
+     */
+    setContextWrapped(action, context) {
+        return context.set(exports.KEY_CONTEXT_WRAPPED_RDF_JOIN, action.entries);
+    }
+}
+exports.ActorRdfJoinWrapStream = ActorRdfJoinWrapStream;
+/**
+ * Key that shows if the query operation has already been wrapped by a process iterator call
+ */
+exports.KEY_CONTEXT_WRAPPED_RDF_JOIN = new core_1.ActionContextKey('@comunica/actor-rdf-join:wrapped');
+//# sourceMappingURL=ActorRdfJoinWrapStream.js.map

package/lib/ActorRdfJoinWrapStream.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"ActorRdfJoinWrapStream.js","sourceRoot":"","sources":["ActorRdfJoinWrapStream.ts"],"names":[],"mappings":";;;AAQA,yDAAsD;AAEtD,yCAAkF;AAMlF;;GAEG;AACH,MAAa,sBAAuB,SAAQ,2BAAY;IAItD,YAAmB,IAAiC;QAClD,KAAK,CAAC,IAAI,EAAE;YACV,WAAW,EAAE,OAAO;YACpB,YAAY,EAAE,aAAa;YAC3B,YAAY,EAAE,CAAC;YACf,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,IAAI;YACrB,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAEe,KAAK,CAAC,IAAI,CAAC,MAAsB;QAE/C,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,oCAA4B,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;YACxE,OAAO,IAAA,eAAQ,EAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,2BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAClE,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEe,KAAK,CAAC,SAAS,CAAC,MAAsB;QACpD,2FAA2F;QAC3F,mDAAmD;QACnD,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAChE,MAAM,MAAM,GAAkC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEtF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,OAAO,CACxE;YACE,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,IAAI;YACtB,MAAM,EAAE,MAAM,CAAC,cAAc;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,cAAc,EAAE,MAAM;SACvB,CACF,CAAC,CAAC;QAEH,MAAM,CAAC,cAAc,GAAiC,MAAM,CAAC;QAC7D,MAAM,CAAC,QAAQ,GAAqC,QAAQ,CAAC;QAE7D,OAAO,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC;IAES,KAAK,CAAC,mBAAmB,CACjC,OAAuB,EACvB,QAAmC;QAEnC,OAAO,IAAA,2BAAoB,EAAC;YAC1B,UAAU,EAAE,CAAC,CAAC;YACd,cAAc,EAAE,CAAC,CAAC;YAClB,aAAa,EAAE,CAAC,CAAC;YACjB,WAAW,EAAE,CAAC,CAAC;SAChB,EAAE,QAAQ,CAAC,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,MAAsB,EAAE,OAAuB;QACtE,OAAO,OAAO,CAAC,GAAG,CAAC,oCAA4B,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AArED,wDAqEC;AAaD;;GAEG;AACU,QAAA,4BAA4B,GAAG,IAAI,uBAAgB,CAC9D,kCAAkC,CACnC,CAAC","sourcesContent":["import type { MediatorIteratorTransform } from '@comunica/bus-iterator-transform';\nimport type {\n IActionRdfJoin,\n IActorRdfJoinOutputInner,\n IActorRdfJoinArgs,\n MediatorRdfJoin,\n IActorRdfJoinTestSideData }\n from '@comunica/bus-rdf-join';\nimport { ActorRdfJoin } from '@comunica/bus-rdf-join';\nimport type { TestResult } from '@comunica/core';\nimport { ActionContextKey, failTest, passTestWithSideData } from '@comunica/core';\nimport type { IMediatorTypeJoinCoefficients } from '@comunica/mediatortype-join-coefficients';\nimport type { IActionContext, IJoinEntry, IQueryOperationResultBindings, MetadataBindings } from '@comunica/types';\nimport type * as RDF from '@rdfjs/types';\nimport type { AsyncIterator } from 'asynciterator';\n\n/**\n * A comunica Wrap Stream RDF Join Actor.\n */\nexport class ActorRdfJoinWrapStream extends ActorRdfJoin {\n public readonly mediatorJoin: MediatorRdfJoin;\n public readonly mediatorIteratorTransform: MediatorIteratorTransform;\n\n public constructor(args: IActorRdfJoinWrapStreamArgs) {\n super(args, {\n logicalType: 'inner',\n physicalName: 'wrap-stream',\n limitEntries: 0,\n limitEntriesMin: true,\n canHandleUndefs: true,\n isLeaf: false,\n });\n }\n\n public override async test(action: IActionRdfJoin):\n Promise<TestResult<IMediatorTypeJoinCoefficients, IActorRdfJoinTestSideData>> {\n if (action.context.get(KEY_CONTEXT_WRAPPED_RDF_JOIN) === action.entries) {\n return failTest('Unable to wrap join operation multiple times');\n }\n\n const metadatas = await ActorRdfJoin.getMetadatas(action.entries);\n return await this.getJoinCoefficients(action, { metadatas });\n }\n\n public override async getOutput(action: IActionRdfJoin): Promise<IActorRdfJoinOutputInner> {\n // Prevent infinite recursion. In consequent query operation calls this key is set to false\n // To allow the operation to wrap ALL rdf-join runs\n action.context = this.setContextWrapped(action, action.context);\n const result: IQueryOperationResultBindings = await this.mediatorJoin.mediate(action);\n\n const { stream, metadata } = (await this.mediatorIteratorTransform.mediate(\n {\n type: result.type,\n operation: action.type,\n stream: result.bindingsStream,\n metadata: result.metadata,\n context: action.context,\n originalAction: action,\n },\n ));\n\n result.bindingsStream = <AsyncIterator<RDF.Bindings>> stream;\n result.metadata = <() => Promise<MetadataBindings>> metadata;\n\n return { result };\n }\n\n protected async getJoinCoefficients(\n _action: IActionRdfJoin,\n sideData: IActorRdfJoinTestSideData,\n ): Promise<TestResult<IMediatorTypeJoinCoefficients, IActorRdfJoinTestSideData>> {\n return passTestWithSideData({\n iterations: -1,\n persistedItems: -1,\n blockingItems: -1,\n requestTime: -1,\n }, sideData);\n }\n\n /**\n * Sets KEY_CONTEXT_WRAPPED_RDF_JOIN key in the context to the entries being joined.\n * @param action The join action being executed\n * @param context The ActionContext\n * @returns The updated ActionContext\n */\n public setContextWrapped(action: IActionRdfJoin, context: IActionContext): IActionContext {\n return context.set(KEY_CONTEXT_WRAPPED_RDF_JOIN, action.entries);\n }\n}\n\nexport interface IActorRdfJoinWrapStreamArgs extends IActorRdfJoinArgs {\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 calls next join to be wrapped\n */\n mediatorJoin: MediatorRdfJoin;\n}\n\n/**\n * Key that shows if the query operation has already been wrapped by a process iterator call\n */\nexport const KEY_CONTEXT_WRAPPED_RDF_JOIN = new ActionContextKey<IJoinEntry[]>(\n '@comunica/actor-rdf-join:wrapped',\n);\n"]}

package/lib/index.d.ts ADDED Viewed

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

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("./ActorRdfJoinWrapStream"), 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,2DAAyC","sourcesContent":["export * from './ActorRdfJoinWrapStream';\n"]}

package/package.json ADDED Viewed

@@ -0,0 +1,51 @@
+{
+  "name": "@comunica/actor-rdf-join-wrap-stream",
+  "version": "4.1.0",
+  "description": "A wrap-stream rdf-join 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-rdf-join-wrap-stream"
+  },
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "keywords": [
+    "comunica",
+    "actor",
+    "rdf-join",
+    "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-rdf-join": "^4.1.0",
+    "@comunica/core": "^4.1.0",
+    "@comunica/mediatortype-join-coefficients": "^4.1.0",
+    "@comunica/types": "^4.1.0"
+  },
+  "gitHead": "711446473d18f5fd47aa1a67e6c23582234221ec"
+}