@comunica/actor-query-operation-leftjoin 2.0.1-alpha.5.0

package/LICENSE.txt

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

package/README.md

@@ -0,0 +1,43 @@
+# Comunica LeftJoin Query Operation Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-query-operation-leftjoin.svg)](https://www.npmjs.com/package/@comunica/actor-query-operation-leftjoin)
+
+A [Query Operation](https://github.com/comunica/comunica/tree/master/packages/bus-query-operation) actor that handles [SPARQL `OPTIONAL`](https://www.w3.org/TR/sparql11-query/#optionals) operations
+by delegating to the [RDF Join bus](https://github.com/comunica/comunica/tree/master/packages/bus-rdf-join) bus.
+
+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-leftjoin
+```
+
+## 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-leftjoin/^2.0.0/components/context.jsonld"  
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:query-operation/actors#leftjoin",
+      "@type": "ActorQueryOperationLeftJoin",
+      "mediatorQueryOperation": { "@id": "urn:comunica:default:query-operation/mediators#main" },
+      "mediatorJoin": { "@id": "urn:comunica:default:rdf-join/mediators#main" }
+    }
+  ]
+}
+```
+
+### Config Parameters
+
+* `mediatorQueryOperation`: A mediator over the [Query Operation bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-operation).
+* `mediatorJoin`: A mediator over the [RDF Join bus](https://github.com/comunica/comunica/tree/master/packages/bus-rdf-join).

package/components/ActorQueryOperationLeftJoin.jsonld

@@ -0,0 +1,193 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-leftjoin/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-operation-leftjoin",
+  "components": [
+    {
+      "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin",
+      "@type": "Class",
+      "requireElement": "ActorQueryOperationLeftJoin",
+      "extends": [
+        {
+          "@type": "GenericComponentExtension",
+          "component": "cbqo:components/ActorQueryOperationTypedMediated.jsonld#ActorQueryOperationTypedMediated",
+          "genericTypeInstances": [
+            "urn:npm:sparqlalgebrajs:LeftJoin"
+          ]
+        }
+      ],
+      "comment": "A comunica LeftJoin Query Operation Actor.",
+      "parameters": [
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorJoin",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "A mediator for joining Bindings streams"
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorQueryOperation",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_bus",
+          "range": {
+            "@type": "ParameterRangeGenericComponent",
+            "component": "cc:components/Bus.jsonld#Bus",
+            "genericTypeInstances": [
+              {
+                "@type": "ParameterRangeGenericComponent",
+                "component": "cc:components/Actor.jsonld#Actor",
+                "genericTypeInstances": [
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbqo:components/ActorQueryOperation.jsonld#ActorQueryOperation_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_beforeActors",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeArray",
+                "parameterRangeValue": {
+                  "@type": "ParameterRangeGenericComponent",
+                  "component": "cc:components/Actor.jsonld#Actor",
+                  "genericTypeInstances": [
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin__member_mediatorJoin",
+          "memberFieldName": "mediatorJoin",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin__member_testOperation",
+          "memberFieldName": "testOperation"
+        },
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin__member_runOperation",
+          "memberFieldName": "runOperation"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "mediatorJoin",
+              "value": {
+                "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorJoin"
+              }
+            },
+            {
+              "keyRaw": "mediatorQueryOperation",
+              "value": {
+                "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorQueryOperation"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#IActorQueryOperationLeftJoinArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorQueryOperationLeftJoinArgs",
+      "extends": [
+        "cbqo:components/ActorQueryOperationTypedMediated.jsonld#IActorQueryOperationTypedMediatedArgs"
+      ],
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#IActorQueryOperationLeftJoinArgs__member_mediatorJoin",
+          "memberFieldName": "mediatorJoin"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-leftjoin/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-operation-leftjoin",
+  "@type": "Module",
+  "requireName": "@comunica/actor-query-operation-leftjoin",
+  "import": [
+    "caqol:components/ActorQueryOperationLeftJoin.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,52 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "caqol": "npmd:@comunica/actor-query-operation-leftjoin/^2.0.0/",
+      "ActorQueryOperationLeftJoin": {
+        "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin",
+        "@prefix": true,
+        "@context": {
+          "args_mediatorJoin": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorJoin"
+          },
+          "args_mediatorQueryOperation": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorQueryOperation"
+          },
+          "args_name": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_name"
+          },
+          "args_bus": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_beforeActors",
+            "@container": "@list"
+          },
+          "mediatorJoin": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorJoin"
+          },
+          "mediatorQueryOperation": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_mediatorQueryOperation"
+          },
+          "name": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_name"
+          },
+          "bus": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_bus"
+          },
+          "beforeActors": {
+            "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#ActorQueryOperationLeftJoin_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorQueryOperationLeftJoinArgs": {
+        "@id": "caqol:components/ActorQueryOperationLeftJoin.jsonld#IActorQueryOperationLeftJoinArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorQueryOperationLeftJoin.d.ts

@@ -0,0 +1,21 @@
+import type { IActorQueryOperationTypedMediatedArgs } from '@comunica/bus-query-operation';
+import { ActorQueryOperationTypedMediated } from '@comunica/bus-query-operation';
+import type { MediatorRdfJoin } from '@comunica/bus-rdf-join';
+import type { IActorTest } from '@comunica/core';
+import type { IQueryOperationResult, IActionContext } from '@comunica/types';
+import type { Algebra } from 'sparqlalgebrajs';
+/**
+ * A comunica LeftJoin Query Operation Actor.
+ */
+export declare class ActorQueryOperationLeftJoin extends ActorQueryOperationTypedMediated<Algebra.LeftJoin> {
+    readonly mediatorJoin: MediatorRdfJoin;
+    constructor(args: IActorQueryOperationLeftJoinArgs);
+    testOperation(operation: Algebra.LeftJoin, context: IActionContext): Promise<IActorTest>;
+    runOperation(operationOriginal: Algebra.LeftJoin, context: IActionContext): Promise<IQueryOperationResult>;
+}
+export interface IActorQueryOperationLeftJoinArgs extends IActorQueryOperationTypedMediatedArgs {
+    /**
+     * A mediator for joining Bindings streams
+     */
+    mediatorJoin: MediatorRdfJoin;
+}

package/lib/ActorQueryOperationLeftJoin.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorQueryOperationLeftJoin = void 0;
+const bus_query_operation_1 = require("@comunica/bus-query-operation");
+const sparqlee_1 = require("sparqlee");
+/**
+ * A comunica LeftJoin Query Operation Actor.
+ */
+class ActorQueryOperationLeftJoin extends bus_query_operation_1.ActorQueryOperationTypedMediated {
+    constructor(args) {
+        super(args, 'leftjoin');
+    }
+    async testOperation(operation, context) {
+        return true;
+    }
+    async runOperation(operationOriginal, context) {
+        // Delegate to join bus
+        const entries = (await Promise.all(operationOriginal.input
+            .map(async (subOperation) => ({
+            output: await this.mediatorQueryOperation.mediate({ operation: subOperation, context }),
+            operation: subOperation,
+        }))))
+            .map(({ output, operation }) => ({
+            output: bus_query_operation_1.ActorQueryOperation.getSafeBindings(output),
+            operation,
+        }));
+        const joined = await this.mediatorJoin.mediate({ type: 'optional', entries, context });
+        // If the pattern contains an expression, filter the resulting stream
+        if (operationOriginal.expression) {
+            const config = { ...bus_query_operation_1.ActorQueryOperation.getAsyncExpressionContext(context) };
+            const evaluator = new sparqlee_1.AsyncEvaluator(operationOriginal.expression, config);
+            const bindingsStream = joined.bindingsStream
+                .transform({
+                autoStart: false,
+                transform: async (bindings, done, push) => {
+                    try {
+                        const result = await evaluator.evaluateAsEBV(bindings);
+                        if (result) {
+                            push(bindings);
+                        }
+                    }
+                    catch (error) {
+                        // We ignore all Expression errors.
+                        // Other errors (likely programming mistakes) are still propagated.
+                        // Left Join is defined in terms of Filter (https://www.w3.org/TR/sparql11-query/#defn_algJoin),
+                        // and Filter requires this (https://www.w3.org/TR/sparql11-query/#expressions).
+                        if ((0, sparqlee_1.isExpressionError)(error)) {
+                            // In many cases, this is a user error, where the user should manually cast the variable to a string.
+                            // In order to help users debug this, we should report these errors via the logger as warnings.
+                            this.logWarn(context, 'Error occurred while filtering.', () => ({ error, bindings }));
+                        }
+                        else {
+                            bindingsStream.emit('error', error);
+                        }
+                    }
+                    done();
+                },
+            });
+            joined.bindingsStream = bindingsStream;
+        }
+        return joined;
+    }
+}
+exports.ActorQueryOperationLeftJoin = ActorQueryOperationLeftJoin;
+//# sourceMappingURL=ActorQueryOperationLeftJoin.js.map

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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("./ActorQueryOperationLeftJoin"), exports);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@comunica/actor-query-operation-leftjoin",
+  "version": "2.0.1-alpha.5.0",
+  "description": "A leftjoin query-operation actor",
+  "lsd:module": true,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/actor-query-operation-leftjoin"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "comunica",
+    "actor",
+    "query-operation",
+    "leftjoin"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "homepage": "https://comunica.dev/",
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js"
+  ],
+  "dependencies": {
+    "@comunica/bus-query-operation": "2.0.1-alpha.5.0",
+    "@comunica/bus-rdf-join": "2.0.1-alpha.5.0",
+    "@comunica/core": "2.0.1-alpha.5.0",
+    "@comunica/mediatortype-join-coefficients": "2.0.1-alpha.5.0",
+    "sparqlalgebrajs": "^4.0.0",
+    "sparqlee": "2.0.0-beta.0"
+  },
+  "scripts": {
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "gitHead": "e2ae2e9e924bf0656df60cc99774f7e560d47695"
+}