@comunica/bus-query-source-identify 3.0.1-alpha.43.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,27 @@
+# Comunica Bus Query Source Identify
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Fbus-query-source-identify.svg)](https://www.npmjs.com/package/@comunica/bus-query-source-identify)
+
+A comunica bus for identifying the types of query sources.
+
+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/bus-query-source-identify
+```
+
+## Usage
+
+## Bus usage
+
+* **Context**: `"https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-source-identify/^1.0.0/components/context.jsonld"`
+* **Bus name**: `ActorQuerySourceIdentify:_default_bus`
+
+## Creating actors on this bus
+
+Actors extending [`ActorQuerySourceIdentify`](https://comunica.github.io/comunica/classes/bus_query_source_identify.actorquerysourceidentify.html) are automatically subscribed to this bus.

package/components/ActorQuerySourceIdentify.jsonld

@@ -0,0 +1,176 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-source-identify/^3.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^3.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/bus-query-source-identify",
+  "components": [
+    {
+      "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify",
+      "@type": "AbstractClass",
+      "requireElement": "ActorQuerySourceIdentify",
+      "extends": [
+        {
+          "@type": "GenericComponentExtension",
+          "component": "cc:components/Actor.jsonld#Actor",
+          "genericTypeInstances": [
+            "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActionQuerySourceIdentify",
+            "cc:components/Actor.jsonld#IActorTest",
+            "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActorQuerySourceIdentifyOutput"
+          ]
+        }
+      ],
+      "comment": "A comunica actor for query-source-identify events.  Actor types: * Input:  IActionQuerySourceIdentify:      An unidentified query source. * Test:   <none> * Output: IActorQuerySourceIdentifyOutput: An identified query source.",
+      "parameters": [
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_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/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_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/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify__member_constructor",
+          "memberFieldName": "constructor"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActionQuerySourceIdentify",
+      "@type": "AbstractClass",
+      "requireElement": "IActionQuerySourceIdentify",
+      "extends": [
+        "cc:components/Actor.jsonld#IAction"
+      ],
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActionQuerySourceIdentify__member_querySourceUnidentified",
+          "memberFieldName": "querySourceUnidentified"
+        }
+      ],
+      "constructorArguments": []
+    },
+    {
+      "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActorQuerySourceIdentifyOutput",
+      "@type": "AbstractClass",
+      "requireElement": "IActorQuerySourceIdentifyOutput",
+      "extends": [
+        "cc:components/Actor.jsonld#IActorOutput"
+      ],
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActorQuerySourceIdentifyOutput__member_querySource",
+          "memberFieldName": "querySource"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-source-identify/^3.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/bus-query-source-identify",
+  "@type": "Module",
+  "requireName": "@comunica/bus-query-source-identify",
+  "import": [
+    "cbqsi:components/ActorQuerySourceIdentify.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,45 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "cbqsi": "npmd:@comunica/bus-query-source-identify/^3.0.0/",
+      "ActorQuerySourceIdentify": {
+        "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify",
+        "@prefix": true,
+        "@context": {
+          "args_name": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_name"
+          },
+          "args_bus": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_beforeActors",
+            "@container": "@list"
+          },
+          "name": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_name"
+          },
+          "bus": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_bus"
+          },
+          "beforeActors": {
+            "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#ActorQuerySourceIdentify_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActionQuerySourceIdentify": {
+        "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActionQuerySourceIdentify",
+        "@prefix": true,
+        "@context": {}
+      },
+      "IActorQuerySourceIdentifyOutput": {
+        "@id": "cbqsi:components/ActorQuerySourceIdentify.jsonld#IActorQuerySourceIdentifyOutput",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorQuerySourceIdentify.d.ts

@@ -0,0 +1,34 @@
+import type { IAction, IActorArgs, IActorOutput, IActorTest, Mediate } from '@comunica/core';
+import { Actor } from '@comunica/core';
+import type { IQuerySourceWrapper, QuerySourceUnidentifiedExpanded } from '@comunica/types';
+/**
+ * A comunica actor for query-source-identify events.
+ *
+ * Actor types:
+ * * Input:  IActionQuerySourceIdentify:      An unidentified query source.
+ * * Test:   <none>
+ * * Output: IActorQuerySourceIdentifyOutput: An identified query source.
+ *
+ * @see IActionQuerySourceIdentify
+ * @see IActorQuerySourceIdentifyOutput
+ */
+export declare abstract class ActorQuerySourceIdentify extends Actor<IActionQuerySourceIdentify, IActorTest, IActorQuerySourceIdentifyOutput> {
+    /**
+    * @param args - @defaultNested {<default_bus> a <cc:components/Bus.jsonld#Bus>} bus
+    */
+    constructor(args: IActorQuerySourceIdentifyArgs);
+}
+export interface IActionQuerySourceIdentify extends IAction {
+    /**
+     * An unidentified query source.
+     */
+    querySourceUnidentified: QuerySourceUnidentifiedExpanded;
+}
+export interface IActorQuerySourceIdentifyOutput extends IActorOutput {
+    /**
+     * An identified query source.
+     */
+    querySource: IQuerySourceWrapper;
+}
+export type IActorQuerySourceIdentifyArgs = IActorArgs<IActionQuerySourceIdentify, IActorTest, IActorQuerySourceIdentifyOutput>;
+export type MediatorQuerySourceIdentify = Mediate<IActionQuerySourceIdentify, IActorQuerySourceIdentifyOutput>;

package/lib/ActorQuerySourceIdentify.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorQuerySourceIdentify = void 0;
+const core_1 = require("@comunica/core");
+/**
+ * A comunica actor for query-source-identify events.
+ *
+ * Actor types:
+ * * Input:  IActionQuerySourceIdentify:      An unidentified query source.
+ * * Test:   <none>
+ * * Output: IActorQuerySourceIdentifyOutput: An identified query source.
+ *
+ * @see IActionQuerySourceIdentify
+ * @see IActorQuerySourceIdentifyOutput
+ */
+class ActorQuerySourceIdentify extends core_1.Actor {
+    /**
+    * @param args - @defaultNested {<default_bus> a <cc:components/Bus.jsonld#Bus>} bus
+    */
+    constructor(args) {
+        super(args);
+    }
+}
+exports.ActorQuerySourceIdentify = ActorQuerySourceIdentify;
+//# sourceMappingURL=ActorQuerySourceIdentify.js.map

package/lib/ActorQuerySourceIdentify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorQuerySourceIdentify.js","sourceRoot":"","sources":["ActorQuerySourceIdentify.ts"],"names":[],"mappings":";;;AACA,yCAAuC;AAGvC;;;;;;;;;;GAUG;AACH,MAAsB,wBACpB,SAAQ,YAA8E;IACtF;;MAEE;IACF,YAAmB,IAAmC;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;CACF;AARD,4DAQC","sourcesContent":["import type { IAction, IActorArgs, IActorOutput, IActorTest, Mediate } from '@comunica/core';\nimport { Actor } from '@comunica/core';\nimport type { IQuerySourceWrapper, QuerySourceUnidentifiedExpanded } from '@comunica/types';\n\n/**\n * A comunica actor for query-source-identify events.\n *\n * Actor types:\n * * Input:  IActionQuerySourceIdentify:      An unidentified query source.\n * * Test:   <none>\n * * Output: IActorQuerySourceIdentifyOutput: An identified query source.\n *\n * @see IActionQuerySourceIdentify\n * @see IActorQuerySourceIdentifyOutput\n */\nexport abstract class ActorQuerySourceIdentify\n  extends Actor<IActionQuerySourceIdentify, IActorTest, IActorQuerySourceIdentifyOutput> {\n  /**\n  * @param args - @defaultNested {<default_bus> a <cc:components/Bus.jsonld#Bus>} bus\n  */\n  public constructor(args: IActorQuerySourceIdentifyArgs) {\n    super(args);\n  }\n}\n\nexport interface IActionQuerySourceIdentify extends IAction {\n  /**\n   * An unidentified query source.\n   */\n  querySourceUnidentified: QuerySourceUnidentifiedExpanded;\n}\n\nexport interface IActorQuerySourceIdentifyOutput extends IActorOutput {\n  /**\n   * An identified query source.\n   */\n  querySource: IQuerySourceWrapper;\n}\n\nexport type IActorQuerySourceIdentifyArgs = IActorArgs<\nIActionQuerySourceIdentify, IActorTest, IActorQuerySourceIdentifyOutput>;\n\nexport type MediatorQuerySourceIdentify = Mediate<\nIActionQuerySourceIdentify, IActorQuerySourceIdentifyOutput>;\n"]}

package/lib/Utils.d.ts

@@ -0,0 +1,83 @@
+import type { BindingsFactory } from '@comunica/bindings-factory';
+import type { BindingsStream, MetadataBindings, MetadataQuads, TermsOrder } from '@comunica/types';
+import type * as RDF from '@rdfjs/types';
+import type { AsyncIterator } from 'asynciterator';
+import type { QuadTermName } from 'rdf-terms';
+import type { Algebra } from 'sparqlalgebrajs';
+/**
+ * Convert an iterator of quads to an iterator of bindings.
+ * @param quads The quads to convert.
+ * @param pattern The pattern to get variables from to determine bindings.
+ *                All quads are also assumed to match the pattern.
+ * @param bindingsFactory The factory for creating bindings.
+ * @param unionDefaultGraph If union default graph mode is enabled.
+ *                          If true, variable graphs will match all graphs, including the default graph.
+ *                          If false, variable graphs will only match named graphs, and not the default graph.
+ */
+export declare function quadsToBindings(quads: AsyncIterator<RDF.Quad>, pattern: Algebra.Pattern, bindingsFactory: BindingsFactory, unionDefaultGraph: boolean): BindingsStream;
+/**
+ * Check if a term is a variable.
+ * @param {RDF.Term} term An RDF term.
+ * @return {any} If the term is a variable or blank node.
+ */
+export declare function isTermVariable(term: RDF.Term): term is RDF.Variable;
+/**
+ * Get all variables in the given pattern.
+ * No duplicates are returned.
+ * @param {RDF.BaseQuad} pattern A quad pattern.
+ */
+export declare function getVariables(pattern: RDF.BaseQuad): RDF.Variable[];
+/**
+ * A helper function to find a hash with quad elements that have duplicate variables.
+ *
+ * @param {RDF.Quad} pattern A quad pattern.
+ *
+ * @return {{[p: string]: string[]}} If no equal variable names are present in the four terms, this returns undefined.
+ *                                   Otherwise, this maps quad elements paths (['subject'], ['predicate'], ['object'],
+ *                                   ['graph'])
+ *                                   to the list of quad elements it shares a variable name with.
+ *                                   For quoted triples, paths such as ['subject', 'object'] may occur.
+ *                                   If no links for a certain element exist, this element will
+ *                                   not be included in the hash.
+ *                                   Note 1: Quad elements will never have a link to themselves.
+ *                                           So this can never occur: { subject: [[ 'subject']] },
+ *                                           instead 'null' would be returned.
+ *                                   Note 2: Links only exist in one direction,
+ *                                           this means that { subject: [[ 'predicate']], predicate: [[ 'subject' ]] }
+ *                                           will not occur, instead only { subject: [[ 'predicate']] }
+ *                                           will be returned.
+ *                                   Note 3: Keys can also be paths, but they are delimited by '_', such as:
+ *                                           { subject_object_subject: [[ 'predicate']] }
+ */
+export declare function getDuplicateElementLinks(pattern: RDF.BaseQuad): Record<string, QuadTermName[][]> | undefined;
+/**
+ * Set the metadata of the bindings stream derived from the metadata of the quads stream.
+ *
+ * @param {BindingsStream} bindings The bindings stream that will receive the metadata property.
+ * @param {AsyncIterator<Quad>} quads The quads stream that is guaranteed to emit the metadata property.
+ * @param elementVariables Mapping of quad term name to variable name.
+ * @param variables Variables to include in the metadata
+ * @param forceEstimateCardinality Set the cardinality to estimate
+ * @return {() => Promise<{[p: string]: any}>} A lazy promise behind a callback resolving to a metadata object.
+ */
+export declare function setMetadata(bindings: BindingsStream, quads: AsyncIterator<RDF.Quad>, elementVariables: Record<string, string>, variables: RDF.Variable[], forceEstimateCardinality: boolean): void;
+/**
+ * Convert the metadata of quads to the metadata of bindings.
+ * @param metadataQuads Quads metadata.
+ * @param elementVariables A mapping from quad elements to variables.
+ * @param variables The variables in the bindings.
+ */
+export declare function quadsMetadataToBindingsMetadata(metadataQuads: MetadataQuads, elementVariables: Record<string, string>, variables: RDF.Variable[]): MetadataBindings;
+/**
+ * Convert the quads order metadata element to a bindings order metadata element.
+ * @param quadsOrder Quads order.
+ * @param elementVariables A mapping from quad elements to variables.
+ */
+export declare function quadsOrderToBindingsOrder(quadsOrder: TermsOrder<RDF.QuadTermName>, elementVariables: Record<string, string>): TermsOrder<RDF.Variable>;
+/**
+ * Perform post-match-filtering if the source does not support quoted triple filtering,
+ * but we have a variable inside a quoted triple.
+ * @param pattern The current quad pattern operation.
+ * @param it The iterator to filter.
+ */
+export declare function filterMatchingQuotedQuads(pattern: RDF.BaseQuad, it: AsyncIterator<RDF.Quad>): AsyncIterator<RDF.Quad>;

package/lib/Utils.js

@@ -0,0 +1,242 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterMatchingQuotedQuads = exports.quadsOrderToBindingsOrder = exports.quadsMetadataToBindingsMetadata = exports.setMetadata = exports.getDuplicateElementLinks = exports.getVariables = exports.isTermVariable = exports.quadsToBindings = void 0;
+const bus_query_operation_1 = require("@comunica/bus-query-operation");
+const metadata_1 = require("@comunica/metadata");
+const rdf_data_factory_1 = require("rdf-data-factory");
+const rdf_string_1 = require("rdf-string");
+const rdf_terms_1 = require("rdf-terms");
+const QuadTermUtil_1 = require("rdf-terms/lib/QuadTermUtil");
+const DF = new rdf_data_factory_1.DataFactory();
+/**
+ * Convert an iterator of quads to an iterator of bindings.
+ * @param quads The quads to convert.
+ * @param pattern The pattern to get variables from to determine bindings.
+ *                All quads are also assumed to match the pattern.
+ * @param bindingsFactory The factory for creating bindings.
+ * @param unionDefaultGraph If union default graph mode is enabled.
+ *                          If true, variable graphs will match all graphs, including the default graph.
+ *                          If false, variable graphs will only match named graphs, and not the default graph.
+ */
+function quadsToBindings(quads, pattern, bindingsFactory, unionDefaultGraph) {
+    const variables = getVariables(pattern);
+    // If non-default-graph triples need to be filtered out
+    const filterNonDefaultQuads = pattern.graph.termType === 'Variable' && !unionDefaultGraph;
+    // Detect duplicate variables in the pattern
+    const duplicateElementLinks = getDuplicateElementLinks(pattern);
+    // Convenience datastructure for mapping quad elements to variables
+    const elementVariables = (0, rdf_terms_1.reduceTermsNested)(pattern, (acc, term, keys) => {
+        if (term.termType === 'Variable') {
+            acc[keys.join('_')] = term.value;
+        }
+        return acc;
+    }, {});
+    // Optionally filter, and construct bindings
+    const it = new bus_query_operation_1.ClosableTransformIterator(async () => {
+        let filteredOutput = quads;
+        // SPARQL query semantics allow graph variables to only match with named graphs, excluding the default graph
+        // But this is not the case when using union default graph semantics
+        if (filterNonDefaultQuads) {
+            filteredOutput = filteredOutput.filter(quad => quad.graph.termType !== 'DefaultGraph');
+        }
+        // If there are duplicate variables in the search pattern,
+        // make sure that we filter out the triples that don't have equal values for those triple elements,
+        // as the rdf-resolve-quad-pattern bus ignores variable names.
+        if (duplicateElementLinks) {
+            filteredOutput = filteredOutput.filter(quad => {
+                for (const keyLeft in duplicateElementLinks) {
+                    const keysLeft = keyLeft.split('_');
+                    const valueLeft = (0, rdf_terms_1.getValueNestedPath)(quad, keysLeft);
+                    for (const keysRight of duplicateElementLinks[keyLeft]) {
+                        if (!valueLeft.equals((0, rdf_terms_1.getValueNestedPath)(quad, keysRight))) {
+                            return false;
+                        }
+                    }
+                }
+                return true;
+            });
+        }
+        return filteredOutput.map(quad => bindingsFactory.bindings(Object.keys(elementVariables).map(key => {
+            const keys = key.split('_');
+            const variable = elementVariables[key];
+            const term = (0, rdf_terms_1.getValueNestedPath)(quad, keys);
+            return [DF.variable(variable), term];
+        })));
+    }, {
+        autoStart: false,
+        onClose: () => quads.destroy(),
+    });
+    // Set the metadata property
+    setMetadata(it, quads, elementVariables, variables, filterNonDefaultQuads || Boolean(duplicateElementLinks));
+    return it;
+}
+exports.quadsToBindings = quadsToBindings;
+/**
+ * Check if a term is a variable.
+ * @param {RDF.Term} term An RDF term.
+ * @return {any} If the term is a variable or blank node.
+ */
+function isTermVariable(term) {
+    return term.termType === 'Variable';
+}
+exports.isTermVariable = isTermVariable;
+/**
+ * Get all variables in the given pattern.
+ * No duplicates are returned.
+ * @param {RDF.BaseQuad} pattern A quad pattern.
+ */
+function getVariables(pattern) {
+    return (0, rdf_terms_1.uniqTerms)((0, rdf_terms_1.getTermsNested)(pattern).filter(isTermVariable));
+}
+exports.getVariables = getVariables;
+/**
+ * A helper function to find a hash with quad elements that have duplicate variables.
+ *
+ * @param {RDF.Quad} pattern A quad pattern.
+ *
+ * @return {{[p: string]: string[]}} If no equal variable names are present in the four terms, this returns undefined.
+ *                                   Otherwise, this maps quad elements paths (['subject'], ['predicate'], ['object'],
+ *                                   ['graph'])
+ *                                   to the list of quad elements it shares a variable name with.
+ *                                   For quoted triples, paths such as ['subject', 'object'] may occur.
+ *                                   If no links for a certain element exist, this element will
+ *                                   not be included in the hash.
+ *                                   Note 1: Quad elements will never have a link to themselves.
+ *                                           So this can never occur: { subject: [[ 'subject']] },
+ *                                           instead 'null' would be returned.
+ *                                   Note 2: Links only exist in one direction,
+ *                                           this means that { subject: [[ 'predicate']], predicate: [[ 'subject' ]] }
+ *                                           will not occur, instead only { subject: [[ 'predicate']] }
+ *                                           will be returned.
+ *                                   Note 3: Keys can also be paths, but they are delimited by '_', such as:
+ *                                           { subject_object_subject: [[ 'predicate']] }
+ */
+function getDuplicateElementLinks(pattern) {
+    // Collect a variable to quad elements mapping.
+    const variableElements = {};
+    let duplicateVariables = false;
+    (0, rdf_terms_1.forEachTermsNested)(pattern, (value, keys) => {
+        if (value.termType === 'Variable') {
+            const val = (0, rdf_string_1.termToString)(value);
+            const length = (variableElements[val] || (variableElements[val] = [])).push(keys);
+            duplicateVariables = duplicateVariables || length > 1;
+        }
+    });
+    if (!duplicateVariables) {
+        return;
+    }
+    // Collect quad element to elements with equal variables mapping.
+    const duplicateElementLinks = {};
+    for (const variable in variableElements) {
+        const elements = variableElements[variable];
+        const remainingElements = elements.slice(1);
+        // Only store the elements that have at least one equal element.
+        if (remainingElements.length > 0) {
+            duplicateElementLinks[elements[0].join('_')] = remainingElements;
+        }
+    }
+    return duplicateElementLinks;
+}
+exports.getDuplicateElementLinks = getDuplicateElementLinks;
+/**
+ * Set the metadata of the bindings stream derived from the metadata of the quads stream.
+ *
+ * @param {BindingsStream} bindings The bindings stream that will receive the metadata property.
+ * @param {AsyncIterator<Quad>} quads The quads stream that is guaranteed to emit the metadata property.
+ * @param elementVariables Mapping of quad term name to variable name.
+ * @param variables Variables to include in the metadata
+ * @param forceEstimateCardinality Set the cardinality to estimate
+ * @return {() => Promise<{[p: string]: any}>} A lazy promise behind a callback resolving to a metadata object.
+ */
+function setMetadata(bindings, quads, elementVariables, variables, forceEstimateCardinality) {
+    const getMetadataCb = (metadataRaw) => {
+        if (!('canContainUndefs' in metadataRaw)) {
+            metadataRaw.canContainUndefs = false;
+        }
+        if (forceEstimateCardinality) {
+            metadataRaw.cardinality.type = 'estimate';
+        }
+        bindings.setProperty('metadata', quadsMetadataToBindingsMetadata((0, metadata_1.validateMetadataQuads)(metadataRaw), elementVariables, variables));
+        // Propagate metadata invalidations
+        if (metadataRaw.state) {
+            metadataRaw.state.addInvalidateListener(() => {
+                setMetadata(bindings, quads, elementVariables, variables, forceEstimateCardinality);
+            });
+        }
+    };
+    const metadata = quads.getProperty('metadata');
+    if (metadata) {
+        // This is to enforce sync metadata setting, because AsyncIterator will always call it async,
+        // even if the property was already defined.
+        getMetadataCb(metadata);
+    }
+    else {
+        quads.getProperty('metadata', getMetadataCb);
+    }
+}
+exports.setMetadata = setMetadata;
+/**
+ * Convert the metadata of quads to the metadata of bindings.
+ * @param metadataQuads Quads metadata.
+ * @param elementVariables A mapping from quad elements to variables.
+ * @param variables The variables in the bindings.
+ */
+function quadsMetadataToBindingsMetadata(metadataQuads, elementVariables, variables) {
+    return {
+        ...metadataQuads,
+        canContainUndefs: false,
+        order: metadataQuads.order ?
+            quadsOrderToBindingsOrder(metadataQuads.order, elementVariables) :
+            undefined,
+        availableOrders: metadataQuads.availableOrders ?
+            metadataQuads.availableOrders.map(orderDef => ({
+                cost: orderDef.cost,
+                terms: quadsOrderToBindingsOrder(orderDef.terms, elementVariables),
+            })) :
+            undefined,
+        variables,
+    };
+}
+exports.quadsMetadataToBindingsMetadata = quadsMetadataToBindingsMetadata;
+/**
+ * Convert the quads order metadata element to a bindings order metadata element.
+ * @param quadsOrder Quads order.
+ * @param elementVariables A mapping from quad elements to variables.
+ */
+function quadsOrderToBindingsOrder(quadsOrder, elementVariables) {
+    const mappedVariables = {};
+    return quadsOrder.map(entry => {
+        // Omit entries that do not map to a variable
+        const variableName = elementVariables[entry.term];
+        if (!variableName) {
+            return;
+        }
+        // Omit entries that have been mapped already
+        if (mappedVariables[variableName]) {
+            return;
+        }
+        mappedVariables[variableName] = true;
+        return {
+            term: DF.variable(variableName),
+            direction: entry.direction,
+        };
+    }).filter(entry => Boolean(entry));
+}
+exports.quadsOrderToBindingsOrder = quadsOrderToBindingsOrder;
+/**
+ * Perform post-match-filtering if the source does not support quoted triple filtering,
+ * but we have a variable inside a quoted triple.
+ * @param pattern The current quad pattern operation.
+ * @param it The iterator to filter.
+ */
+function filterMatchingQuotedQuads(pattern, it) {
+    if ((0, rdf_terms_1.someTerms)(pattern, term => term.termType === 'Quad')) {
+        it = it.transform({
+            filter: quad => (0, QuadTermUtil_1.matchPatternMappings)(quad, pattern),
+            autoStart: false,
+        });
+    }
+    return it;
+}
+exports.filterMatchingQuotedQuads = filterMatchingQuotedQuads;
+//# sourceMappingURL=Utils.js.map

package/lib/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["Utils.ts"],"names":[],"mappings":";;;AACA,uEAA0E;AAC1E,iDAA2D;AAI3D,uDAA+C;AAC/C,2CAA0C;AAE1C,yCAOmB;AACnB,6DAAkE;AAGlE,MAAM,EAAE,GAAG,IAAI,8BAAW,EAAE,CAAC;AAE7B;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC7B,KAA8B,EAC9B,OAAwB,EACxB,eAAgC,EAChC,iBAA0B;IAE1B,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAExC,uDAAuD;IACvD,MAAM,qBAAqB,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,KAAK,UAAU,IAAI,CAAC,iBAAiB,CAAC;IAE1F,4CAA4C;IAC5C,MAAM,qBAAqB,GAAiD,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE9G,mEAAmE;IACnE,MAAM,gBAAgB,GAA2B,IAAA,6BAAiB,EAAC,OAAO,EACxE,CAAC,GAA2B,EAAE,IAAc,EAAE,IAAoB,EAAE,EAAE;QACpE,IAAI,IAAI,CAAC,QAAQ,KAAK,UAAU,EAAE;YAChC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;SAClC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CAAC,CAAC;IAEN,4CAA4C;IAC5C,MAAM,EAAE,GAAG,IAAI,+CAAyB,CAAC,KAAK,IAAG,EAAE;QACjD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,4GAA4G;QAC5G,oEAAoE;QACpE,IAAI,qBAAqB,EAAE;YACzB,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,cAAc,CAAC,CAAC;SACxF;QAED,0DAA0D;QAC1D,mGAAmG;QACnG,8DAA8D;QAC9D,IAAI,qBAAqB,EAAE;YACzB,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBAC5C,KAAK,MAAM,OAAO,IAAI,qBAAqB,EAAE;oBAC3C,MAAM,QAAQ,GAAoC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACrE,MAAM,SAAS,GAAG,IAAA,8BAAkB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;oBACrD,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE;wBACtD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAA,8BAAkB,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE;4BAC1D,OAAO,KAAK,CAAC;yBACd;qBACF;iBACF;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACjG,MAAM,IAAI,GAAwB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,IAAA,8BAAkB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC5C,OAAO,CAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAE,CAAC;QACzC,CAAC,CAAC,CAAC,CAAC,CAAC;IACP,CAAC,EAAE;QACD,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE;KAC/B,CAAC,CAAC;IAEH,4BAA4B;IAC5B,WAAW,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,qBAAqB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAE7G,OAAO,EAAE,CAAC;AACZ,CAAC;AAnED,0CAmEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAc;IAC3C,OAAO,IAAI,CAAC,QAAQ,KAAK,UAAU,CAAC;AACtC,CAAC;AAFD,wCAEC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,OAAqB;IAChD,OAAO,IAAA,qBAAS,EAAC,IAAA,0BAAc,EAAC,OAAO,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;AACnE,CAAC;AAFD,oCAEC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,wBAAwB,CAAC,OAAqB;IAC5D,+CAA+C;IAC/C,MAAM,gBAAgB,GAAqC,EAAE,CAAC;IAC9D,IAAI,kBAAkB,GAAG,KAAK,CAAC;IAC/B,IAAA,8BAAkB,EAAC,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC1C,IAAI,KAAK,CAAC,QAAQ,KAAK,UAAU,EAAE;YACjC,MAAM,GAAG,GAAG,IAAA,yBAAY,EAAC,KAAK,CAAC,CAAC;YAChC,MAAM,MAAM,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClF,kBAAkB,GAAG,kBAAkB,IAAI,MAAM,GAAG,CAAC,CAAC;SACvD;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kBAAkB,EAAE;QACvB,OAAO;KACR;IAED,iEAAiE;IACjE,MAAM,qBAAqB,GAAqC,EAAE,CAAC;IACnE,KAAK,MAAM,QAAQ,IAAI,gBAAgB,EAAE;QACvC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,iBAAiB,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,gEAAgE;QAChE,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,iBAAiB,CAAC;SAClE;KACF;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA5BD,4DA4BC;AAED;;;;;;;;;GASG;AACH,SAAgB,WAAW,CACzB,QAAwB,EACxB,KAA8B,EAC9B,gBAAwC,EACxC,SAAyB,EACzB,wBAAiC;IAEjC,MAAM,aAAa,GAAG,CAAC,WAAgC,EAAQ,EAAE;QAC/D,IAAI,CAAC,CAAC,kBAAkB,IAAI,WAAW,CAAC,EAAE;YACxC,WAAW,CAAC,gBAAgB,GAAG,KAAK,CAAC;SACtC;QACD,IAAI,wBAAwB,EAAE;YAC5B,WAAW,CAAC,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC;SAC3C;QACD,QAAQ,CAAC,WAAW,CAAC,UAAU,EAC7B,+BAA+B,CAAC,IAAA,gCAAqB,EAAC,WAAW,CAAC,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC;QAEpG,mCAAmC;QACnC,IAAI,WAAW,CAAC,KAAK,EAAE;YACrB,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAAG,EAAE;gBAC3C,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,wBAAwB,CAAC,CAAC;YACtF,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,QAAQ,EAAE;QACZ,6FAA6F;QAC7F,4CAA4C;QAC5C,aAAa,CAAC,QAAQ,CAAC,CAAC;KACzB;SAAM;QACL,KAAK,CAAC,WAAW,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;KAC9C;AACH,CAAC;AAjCD,kCAiCC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAC7C,aAA4B,EAC5B,gBAAwC,EACxC,SAAyB;IAEzB,OAAO;QACL,GAAG,aAAa;QAChB,gBAAgB,EAAE,KAAK;QACvB,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;YAC1B,yBAAyB,CAAC,aAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;YAClE,SAAS;QACX,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;YAC9C,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC7C,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,KAAK,EAAE,yBAAyB,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC;aACnE,CAAC,CAAC,CAAC,CAAC;YACL,SAAS;QACX,SAAS;KACV,CAAC;AACJ,CAAC;AAnBD,0EAmBC;AAED;;;;GAIG;AACH,SAAgB,yBAAyB,CACvC,UAAwC,EACxC,gBAAwC;IAExC,MAAM,eAAe,GAA4B,EAAE,CAAC;IACpD,OAAkC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACvD,6CAA6C;QAC7C,MAAM,YAAY,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,6CAA6C;QAC7C,IAAI,eAAe,CAAC,YAAY,CAAC,EAAE;YACjC,OAAO;SACR;QAED,eAAe,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;QACrC,OAAO;YACL,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC/B,SAAS,EAAE,KAAK,CAAC,SAAS;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AACrC,CAAC;AAvBD,8DAuBC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,OAAqB,EAAE,EAA2B;IAC1F,IAAI,IAAA,qBAAS,EAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,MAAM,CAAC,EAAE;QACxD,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC;YAChB,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,IAAA,mCAAoB,EAAC,IAAI,EAAE,OAAO,CAAC;YACnD,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;KACJ;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AARD,8DAQC","sourcesContent":["import type { BindingsFactory } from '@comunica/bindings-factory';\nimport { ClosableTransformIterator } from '@comunica/bus-query-operation';\nimport { validateMetadataQuads } from '@comunica/metadata';\nimport type { BindingsStream, MetadataBindings, MetadataQuads, TermsOrder } from '@comunica/types';\nimport type * as RDF from '@rdfjs/types';\nimport type { AsyncIterator } from 'asynciterator';\nimport { DataFactory } from 'rdf-data-factory';\nimport { termToString } from 'rdf-string';\nimport type { QuadTermName } from 'rdf-terms';\nimport {\n  forEachTermsNested,\n  getTermsNested,\n  getValueNestedPath,\n  reduceTermsNested,\n  someTerms,\n  uniqTerms,\n} from 'rdf-terms';\nimport { matchPatternMappings } from 'rdf-terms/lib/QuadTermUtil';\nimport type { Algebra } from 'sparqlalgebrajs';\n\nconst DF = new DataFactory();\n\n/**\n * Convert an iterator of quads to an iterator of bindings.\n * @param quads The quads to convert.\n * @param pattern The pattern to get variables from to determine bindings.\n *                All quads are also assumed to match the pattern.\n * @param bindingsFactory The factory for creating bindings.\n * @param unionDefaultGraph If union default graph mode is enabled.\n *                          If true, variable graphs will match all graphs, including the default graph.\n *                          If false, variable graphs will only match named graphs, and not the default graph.\n */\nexport function quadsToBindings(\n  quads: AsyncIterator<RDF.Quad>,\n  pattern: Algebra.Pattern,\n  bindingsFactory: BindingsFactory,\n  unionDefaultGraph: boolean,\n): BindingsStream {\n  const variables = getVariables(pattern);\n\n  // If non-default-graph triples need to be filtered out\n  const filterNonDefaultQuads = pattern.graph.termType === 'Variable' && !unionDefaultGraph;\n\n  // Detect duplicate variables in the pattern\n  const duplicateElementLinks: Record<string, QuadTermName[][]> | undefined = getDuplicateElementLinks(pattern);\n\n  // Convenience datastructure for mapping quad elements to variables\n  const elementVariables: Record<string, string> = reduceTermsNested(pattern,\n    (acc: Record<string, string>, term: RDF.Term, keys: QuadTermName[]) => {\n      if (term.termType === 'Variable') {\n        acc[keys.join('_')] = term.value;\n      }\n      return acc;\n    },\n    {});\n\n  // Optionally filter, and construct bindings\n  const it = new ClosableTransformIterator(async() => {\n    let filteredOutput = quads;\n\n    // SPARQL query semantics allow graph variables to only match with named graphs, excluding the default graph\n    // But this is not the case when using union default graph semantics\n    if (filterNonDefaultQuads) {\n      filteredOutput = filteredOutput.filter(quad => quad.graph.termType !== 'DefaultGraph');\n    }\n\n    // If there are duplicate variables in the search pattern,\n    // make sure that we filter out the triples that don't have equal values for those triple elements,\n    // as the rdf-resolve-quad-pattern bus ignores variable names.\n    if (duplicateElementLinks) {\n      filteredOutput = filteredOutput.filter(quad => {\n        for (const keyLeft in duplicateElementLinks) {\n          const keysLeft: QuadTermName[] = <QuadTermName[]> keyLeft.split('_');\n          const valueLeft = getValueNestedPath(quad, keysLeft);\n          for (const keysRight of duplicateElementLinks[keyLeft]) {\n            if (!valueLeft.equals(getValueNestedPath(quad, keysRight))) {\n              return false;\n            }\n          }\n        }\n        return true;\n      });\n    }\n\n    return filteredOutput.map(quad => bindingsFactory.bindings(Object.keys(elementVariables).map(key => {\n      const keys: QuadTermName[] = <any>key.split('_');\n      const variable = elementVariables[key];\n      const term = getValueNestedPath(quad, keys);\n      return [ DF.variable(variable), term ];\n    })));\n  }, {\n    autoStart: false,\n    onClose: () => quads.destroy(),\n  });\n\n  // Set the metadata property\n  setMetadata(it, quads, elementVariables, variables, filterNonDefaultQuads || Boolean(duplicateElementLinks));\n\n  return it;\n}\n\n/**\n * Check if a term is a variable.\n * @param {RDF.Term} term An RDF term.\n * @return {any} If the term is a variable or blank node.\n */\nexport function isTermVariable(term: RDF.Term): term is RDF.Variable {\n  return term.termType === 'Variable';\n}\n\n/**\n * Get all variables in the given pattern.\n * No duplicates are returned.\n * @param {RDF.BaseQuad} pattern A quad pattern.\n */\nexport function getVariables(pattern: RDF.BaseQuad): RDF.Variable[] {\n  return uniqTerms(getTermsNested(pattern).filter(isTermVariable));\n}\n\n/**\n * A helper function to find a hash with quad elements that have duplicate variables.\n *\n * @param {RDF.Quad} pattern A quad pattern.\n *\n * @return {{[p: string]: string[]}} If no equal variable names are present in the four terms, this returns undefined.\n *                                   Otherwise, this maps quad elements paths (['subject'], ['predicate'], ['object'],\n *                                   ['graph'])\n *                                   to the list of quad elements it shares a variable name with.\n *                                   For quoted triples, paths such as ['subject', 'object'] may occur.\n *                                   If no links for a certain element exist, this element will\n *                                   not be included in the hash.\n *                                   Note 1: Quad elements will never have a link to themselves.\n *                                           So this can never occur: { subject: [[ 'subject']] },\n *                                           instead 'null' would be returned.\n *                                   Note 2: Links only exist in one direction,\n *                                           this means that { subject: [[ 'predicate']], predicate: [[ 'subject' ]] }\n *                                           will not occur, instead only { subject: [[ 'predicate']] }\n *                                           will be returned.\n *                                   Note 3: Keys can also be paths, but they are delimited by '_', such as:\n *                                           { subject_object_subject: [[ 'predicate']] }\n */\nexport function getDuplicateElementLinks(pattern: RDF.BaseQuad): Record<string, QuadTermName[][]> | undefined {\n  // Collect a variable to quad elements mapping.\n  const variableElements: Record<string, QuadTermName[][]> = {};\n  let duplicateVariables = false;\n  forEachTermsNested(pattern, (value, keys) => {\n    if (value.termType === 'Variable') {\n      const val = termToString(value);\n      const length = (variableElements[val] || (variableElements[val] = [])).push(keys);\n      duplicateVariables = duplicateVariables || length > 1;\n    }\n  });\n\n  if (!duplicateVariables) {\n    return;\n  }\n\n  // Collect quad element to elements with equal variables mapping.\n  const duplicateElementLinks: Record<string, QuadTermName[][]> = {};\n  for (const variable in variableElements) {\n    const elements = variableElements[variable];\n    const remainingElements = elements.slice(1);\n    // Only store the elements that have at least one equal element.\n    if (remainingElements.length > 0) {\n      duplicateElementLinks[elements[0].join('_')] = remainingElements;\n    }\n  }\n\n  return duplicateElementLinks;\n}\n\n/**\n * Set the metadata of the bindings stream derived from the metadata of the quads stream.\n *\n * @param {BindingsStream} bindings The bindings stream that will receive the metadata property.\n * @param {AsyncIterator<Quad>} quads The quads stream that is guaranteed to emit the metadata property.\n * @param elementVariables Mapping of quad term name to variable name.\n * @param variables Variables to include in the metadata\n * @param forceEstimateCardinality Set the cardinality to estimate\n * @return {() => Promise<{[p: string]: any}>} A lazy promise behind a callback resolving to a metadata object.\n */\nexport function setMetadata(\n  bindings: BindingsStream,\n  quads: AsyncIterator<RDF.Quad>,\n  elementVariables: Record<string, string>,\n  variables: RDF.Variable[],\n  forceEstimateCardinality: boolean,\n): void {\n  const getMetadataCb = (metadataRaw: Record<string, any>): void => {\n    if (!('canContainUndefs' in metadataRaw)) {\n      metadataRaw.canContainUndefs = false;\n    }\n    if (forceEstimateCardinality) {\n      metadataRaw.cardinality.type = 'estimate';\n    }\n    bindings.setProperty('metadata',\n      quadsMetadataToBindingsMetadata(validateMetadataQuads(metadataRaw), elementVariables, variables));\n\n    // Propagate metadata invalidations\n    if (metadataRaw.state) {\n      metadataRaw.state.addInvalidateListener(() => {\n        setMetadata(bindings, quads, elementVariables, variables, forceEstimateCardinality);\n      });\n    }\n  };\n\n  const metadata = quads.getProperty('metadata');\n  if (metadata) {\n    // This is to enforce sync metadata setting, because AsyncIterator will always call it async,\n    // even if the property was already defined.\n    getMetadataCb(metadata);\n  } else {\n    quads.getProperty('metadata', getMetadataCb);\n  }\n}\n\n/**\n * Convert the metadata of quads to the metadata of bindings.\n * @param metadataQuads Quads metadata.\n * @param elementVariables A mapping from quad elements to variables.\n * @param variables The variables in the bindings.\n */\nexport function quadsMetadataToBindingsMetadata(\n  metadataQuads: MetadataQuads,\n  elementVariables: Record<string, string>,\n  variables: RDF.Variable[],\n): MetadataBindings {\n  return {\n    ...metadataQuads,\n    canContainUndefs: false,\n    order: metadataQuads.order ?\n      quadsOrderToBindingsOrder(metadataQuads.order, elementVariables) :\n      undefined,\n    availableOrders: metadataQuads.availableOrders ?\n      metadataQuads.availableOrders.map(orderDef => ({\n        cost: orderDef.cost,\n        terms: quadsOrderToBindingsOrder(orderDef.terms, elementVariables),\n      })) :\n      undefined,\n    variables,\n  };\n}\n\n/**\n * Convert the quads order metadata element to a bindings order metadata element.\n * @param quadsOrder Quads order.\n * @param elementVariables A mapping from quad elements to variables.\n */\nexport function quadsOrderToBindingsOrder(\n  quadsOrder: TermsOrder<RDF.QuadTermName>,\n  elementVariables: Record<string, string>,\n): TermsOrder<RDF.Variable> {\n  const mappedVariables: Record<string, boolean> = {};\n  return <TermsOrder<RDF.Variable>> quadsOrder.map(entry => {\n    // Omit entries that do not map to a variable\n    const variableName = elementVariables[entry.term];\n    if (!variableName) {\n      return;\n    }\n\n    // Omit entries that have been mapped already\n    if (mappedVariables[variableName]) {\n      return;\n    }\n\n    mappedVariables[variableName] = true;\n    return {\n      term: DF.variable(variableName),\n      direction: entry.direction,\n    };\n  }).filter(entry => Boolean(entry));\n}\n\n/**\n * Perform post-match-filtering if the source does not support quoted triple filtering,\n * but we have a variable inside a quoted triple.\n * @param pattern The current quad pattern operation.\n * @param it The iterator to filter.\n */\nexport function filterMatchingQuotedQuads(pattern: RDF.BaseQuad, it: AsyncIterator<RDF.Quad>): AsyncIterator<RDF.Quad> {\n  if (someTerms(pattern, term => term.termType === 'Quad')) {\n    it = it.transform({\n      filter: quad => matchPatternMappings(quad, pattern),\n      autoStart: false,\n    });\n  }\n  return it;\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ActorQuerySourceIdentify';
+export * from './Utils';

package/lib/index.js

@@ -0,0 +1,19 @@
+"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("./ActorQuerySourceIdentify"), exports);
+__exportStar(require("./Utils"), 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,6DAA2C;AAC3C,0CAAwB","sourcesContent":["export * from './ActorQuerySourceIdentify';\nexport * from './Utils';\n"]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@comunica/bus-query-source-identify",
+  "version": "3.0.1-alpha.43.0",
+  "description": "A comunica bus for query-source-identify events.",
+  "lsd:module": true,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/bus-query-source-identify"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "comunica",
+    "bus",
+    "query-source-identify"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "homepage": "https://comunica.dev/",
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js",
+    "lib/**/*.js.map"
+  ],
+  "dependencies": {
+    "@comunica/bindings-factory": "3.0.1-alpha.43.0",
+    "@comunica/bus-query-operation": "3.0.1-alpha.43.0",
+    "@comunica/core": "3.0.1-alpha.43.0",
+    "@comunica/metadata": "3.0.1-alpha.43.0",
+    "@comunica/types": "3.0.1-alpha.43.0",
+    "@rdfjs/types": "*",
+    "asynciterator": "^3.8.1",
+    "rdf-data-factory": "^1.1.2",
+    "rdf-string": "^1.6.3",
+    "rdf-terms": "^1.11.0",
+    "sparqlalgebrajs": "^4.3.0"
+  },
+  "scripts": {
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "gitHead": "d11e44cf07d4699f9d2c51d5851b5ed443de1997"
+}