@comunica/bus-query-operation 3.3.0 → 4.0.1

package/lib/ActorQueryOperation.d.ts

@@ -1,7 +1,6 @@
-import type { BindingsFactory } from '@comunica/bindings-factory';
 import type { IActorArgs, IActorTest, IAction, Mediate } from '@comunica/core';
 import { Actor } from '@comunica/core';
-import type { IQueryOperationResult, IQueryOperationResultBindings, IQueryOperationResultBoolean, IQueryOperationResultQuads, IQueryOperationResultVoid, Bindings, IActionContext, FunctionArgumentsCache, IQuerySourceWrapper, FragmentSelectorShape } from '@comunica/types';
+import type { IQueryOperationResult, Bindings, IActionContext, FunctionArgumentsCache } from '@comunica/types';
 import type * as RDF from '@rdfjs/types';
 import type { Algebra } from 'sparqlalgebrajs';
 /**
@@ -15,102 +14,13 @@ import type { Algebra } from 'sparqlalgebrajs';
  * @see IActionQueryOperation
  * @see IQueryOperationResult
  */
-export declare abstract class ActorQueryOperation extends Actor<IActionQueryOperation, IActorTest, IQueryOperationResult> {
+export declare abstract class ActorQueryOperation<TS = undefined> extends Actor<IActionQueryOperation, IActorTest, IQueryOperationResult, TS> {
     /**
-     * @param args - @defaultNested {<default_bus> a <cbqo:components/BusQueryOperation.jsonld#BusQueryOperation>} bus
+     * @param args -
+     *   \ @defaultNested {<default_bus> a <cbqo:components/BusQueryOperation.jsonld#BusQueryOperation>} bus
+     *   \ @defaultNested {Query operation processing failed: none of the configured actors were able to handle the operation type ${action.operation.type}} busFailMessage
      */
-    protected constructor(args: IActorQueryOperationArgs);
-    /**
-     * Safely cast a query operation output to a bindings output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultBindings} A bindings query operation output.
-     */
-    static getSafeBindings(output: IQueryOperationResult): IQueryOperationResultBindings;
-    /**
-     * Safely cast a query operation output to a quads output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultQuads} A quads query operation output.
-     */
-    static getSafeQuads(output: IQueryOperationResult): IQueryOperationResultQuads;
-    /**
-     * Safely cast a query operation output to a boolean output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultBoolean} A boolean query operation output.
-     */
-    static getSafeBoolean(output: IQueryOperationResult): IQueryOperationResultBoolean;
-    /**
-     * Safely cast a query operation output to a void output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultVoid} A void query operation output.
-     */
-    static getSafeVoid(output: IQueryOperationResult): IQueryOperationResultVoid;
-    /**
-     * Throw an error if the output type does not match the expected type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @param {string} expectedType The expected output type.
-     */
-    static validateQueryOutput(output: IQueryOperationResult, expectedType: IQueryOperationResult['type']): void;
-    protected static getBaseExpressionContext(context: IActionContext): IBaseExpressionContext;
-    /**
-     * Create an options object that can be used to construct a expression-evaluator synchronous evaluator.
-     * @param context An action context.
-     * @param _mediatorQueryOperation An optional query query operation mediator.
-     *                                If defined, the existence resolver will be defined as `exists`.
-     */
-    static getExpressionContext(context: IActionContext, _mediatorQueryOperation?: MediatorQueryOperation): ISyncExpressionContext;
-    /**
-     * Create an options object that can be used to construct a expression-evaluator asynchronous evaluator.
-     * @param context An action context.
-     * @param mediatorQueryOperation A query query operation mediator for resolving `exists`.
-     * @param bindingsFactory The bindings factory.
-     */
-    static getAsyncExpressionContext(context: IActionContext, mediatorQueryOperation: MediatorQueryOperation, bindingsFactory: BindingsFactory): IAsyncExpressionContext;
-    /**
-     * Create an existence resolver for usage within an expression context.
-     * @param context An action context.
-     * @param mediatorQueryOperation A query operation mediator.
-     * @param bindingsFactory The bindings factory.
-     */
-    static createExistenceResolver(context: IActionContext, mediatorQueryOperation: MediatorQueryOperation, bindingsFactory: BindingsFactory): (expr: Algebra.ExistenceExpression, bindings: Bindings) => Promise<boolean>;
-    /**
-     * Throw an error if the context contains the readOnly flag.
-     * @param context An action context.
-     */
-    static throwOnReadOnly(context: IActionContext): void;
-    /**
-     * Obtain the query source attached to the given operation.
-     * @param operation An algebra operation.
-     */
-    static getOperationSource(operation: Algebra.Operation): IQuerySourceWrapper | undefined;
-    /**
-     * Assign a source wrapper to the given operation.
-     * The operation is copied and returned.
-     * @param operation An operation.
-     * @param source A source wrapper.
-     */
-    static assignOperationSource<O extends Algebra.Operation>(operation: O, source: IQuerySourceWrapper): O;
-    /**
-     * Remove the source wrapper from the given operation.
-     * The operation is mutated.
-     * @param operation An operation.
-     */
-    static removeOperationSource(operation: Algebra.Operation): void;
-    /**
-     * Check if the given shape accepts the given query operation.
-     * @param shape A shape to test the query operation against.
-     * @param operation A query operation to test.
-     * @param options Additional options to consider.
-     * @param options.joinBindings If additional bindings will be pushed down to the source for joining.
-     * @param options.filterBindings If additional bindings will be pushed down to the source for filtering.
-     */
-    static doesShapeAcceptOperation(shape: FragmentSelectorShape, operation: Algebra.Operation, options?: {
-        joinBindings?: boolean;
-        filterBindings?: boolean;
-    }): boolean;
+    protected constructor(args: IActorQueryOperationArgs<TS>);
 }
 export interface IActionQueryOperation extends IAction {
     /**
@@ -118,13 +28,14 @@ export interface IActionQueryOperation extends IAction {
      */
     operation: Algebra.Operation;
 }
-export type IActorQueryOperationArgs = IActorArgs<IActionQueryOperation, IActorTest, IQueryOperationResult>;
+export type IActorQueryOperationArgs<TS = undefined> = IActorArgs<IActionQueryOperation, IActorTest, IQueryOperationResult, TS>;
 export type MediatorQueryOperation = Mediate<IActionQueryOperation, IQueryOperationResult>;
 export interface IBaseExpressionContext {
     now?: Date;
     baseIRI?: string;
     extensionFunctionCreator?: (functionNamedNode: RDF.NamedNode) => ((args: RDF.Term[]) => Promise<RDF.Term>) | undefined;
     functionArgumentsCache?: FunctionArgumentsCache;
+    actionContext: IActionContext;
 }
 export interface ISyncExpressionContext extends IBaseExpressionContext {
     bnode: (input?: string | undefined) => RDF.BlankNode;
@@ -133,3 +44,7 @@ export interface IAsyncExpressionContext extends IBaseExpressionContext {
     bnode: (input?: string | undefined) => Promise<RDF.BlankNode>;
     exists?: (expr: Algebra.ExistenceExpression, bindings: Bindings) => Promise<boolean>;
 }
+export type FragmentSelectorShapeTestFlags = {
+    joinBindings?: boolean;
+    filterBindings?: boolean;
+};

package/lib/ActorQueryOperation.js

@@ -1,17 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorQueryOperation = void 0;
-const context_entries_1 = require("@comunica/context-entries");
 const core_1 = require("@comunica/core");
-const data_factory_1 = require("@comunica/data-factory");
-const Bindings_1 = require("./Bindings");
-/**
- * A counter that keeps track blank node generated through BNODE() SPARQL
- * expressions.
- *
- * @type {number}
- */
-let bnodeCounter = 0;
 /**
  * A comunica actor for query-operation events.
  *
@@ -24,184 +14,16 @@ let bnodeCounter = 0;
  * @see IQueryOperationResult
  */
 class ActorQueryOperation extends core_1.Actor {
+    /* eslint-disable max-len */
     /**
-     * @param args - @defaultNested {<default_bus> a <cbqo:components/BusQueryOperation.jsonld#BusQueryOperation>} bus
+     * @param args -
+     *   \ @defaultNested {<default_bus> a <cbqo:components/BusQueryOperation.jsonld#BusQueryOperation>} bus
+     *   \ @defaultNested {Query operation processing failed: none of the configured actors were able to handle the operation type ${action.operation.type}} busFailMessage
      */
+    /* eslint-enable max-len */
     constructor(args) {
         super(args);
     }
-    /**
-     * Safely cast a query operation output to a bindings output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultBindings} A bindings query operation output.
-     */
-    static getSafeBindings(output) {
-        ActorQueryOperation.validateQueryOutput(output, 'bindings');
-        return output;
-    }
-    /**
-     * Safely cast a query operation output to a quads output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultQuads} A quads query operation output.
-     */
-    static getSafeQuads(output) {
-        ActorQueryOperation.validateQueryOutput(output, 'quads');
-        return output;
-    }
-    /**
-     * Safely cast a query operation output to a boolean output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultBoolean} A boolean query operation output.
-     */
-    static getSafeBoolean(output) {
-        ActorQueryOperation.validateQueryOutput(output, 'boolean');
-        return output;
-    }
-    /**
-     * Safely cast a query operation output to a void output.
-     * This will throw a runtime error if the output is of the incorrect type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @return {IQueryOperationResultVoid} A void query operation output.
-     */
-    static getSafeVoid(output) {
-        ActorQueryOperation.validateQueryOutput(output, 'void');
-        return output;
-    }
-    /**
-     * Throw an error if the output type does not match the expected type.
-     * @param {IQueryOperationResult} output A query operation output.
-     * @param {string} expectedType The expected output type.
-     */
-    static validateQueryOutput(output, expectedType) {
-        if (output.type !== expectedType) {
-            throw new Error(`Invalid query output type: Expected '${expectedType}' but got '${output.type}'`);
-        }
-    }
-    static getBaseExpressionContext(context) {
-        const now = context.get(context_entries_1.KeysInitQuery.queryTimestamp);
-        const baseIRI = context.get(context_entries_1.KeysInitQuery.baseIRI);
-        const functionArgumentsCache = context.get(context_entries_1.KeysInitQuery.functionArgumentsCache) ?? {};
-        // Handle two variants of providing extension functions
-        if (context.has(context_entries_1.KeysInitQuery.extensionFunctionCreator) && context.has(context_entries_1.KeysInitQuery.extensionFunctions)) {
-            throw new Error('Illegal simultaneous usage of extensionFunctionCreator and extensionFunctions in context');
-        }
-        let extensionFunctionCreator = context
-            .get(context_entries_1.KeysInitQuery.extensionFunctionCreator);
-        // Convert dictionary-based variant to callback
-        const extensionFunctions = context
-            .get(context_entries_1.KeysInitQuery.extensionFunctions);
-        if (extensionFunctions) {
-            extensionFunctionCreator = functionNamedNode => extensionFunctions[functionNamedNode.value];
-        }
-        return { now, baseIRI, extensionFunctionCreator, functionArgumentsCache };
-    }
-    /**
-     * Create an options object that can be used to construct a expression-evaluator synchronous evaluator.
-     * @param context An action context.
-     * @param _mediatorQueryOperation An optional query query operation mediator.
-     *                                If defined, the existence resolver will be defined as `exists`.
-     */
-    static getExpressionContext(context, _mediatorQueryOperation) {
-        return {
-            ...this.getBaseExpressionContext(context),
-            bnode: (input) => new data_factory_1.BlankNodeBindingsScoped(input ?? `BNODE_${bnodeCounter++}`),
-        };
-    }
-    /**
-     * Create an options object that can be used to construct a expression-evaluator asynchronous evaluator.
-     * @param context An action context.
-     * @param mediatorQueryOperation A query query operation mediator for resolving `exists`.
-     * @param bindingsFactory The bindings factory.
-     */
-    static getAsyncExpressionContext(context, mediatorQueryOperation, bindingsFactory) {
-        return {
-            ...this.getBaseExpressionContext(context),
-            bnode: (input) => Promise.resolve(new data_factory_1.BlankNodeBindingsScoped(input ?? `BNODE_${bnodeCounter++}`)),
-            exists: ActorQueryOperation.createExistenceResolver(context, mediatorQueryOperation, bindingsFactory),
-        };
-    }
-    /**
-     * Create an existence resolver for usage within an expression context.
-     * @param context An action context.
-     * @param mediatorQueryOperation A query operation mediator.
-     * @param bindingsFactory The bindings factory.
-     */
-    static createExistenceResolver(context, mediatorQueryOperation, bindingsFactory) {
-        return async (expr, bindings) => {
-            const operation = (0, Bindings_1.materializeOperation)(expr.input, bindings, bindingsFactory);
-            const outputRaw = await mediatorQueryOperation.mediate({ operation, context });
-            const output = ActorQueryOperation.getSafeBindings(outputRaw);
-            return expr.not !== ((await output.bindingsStream.take(1).toArray()).length === 1);
-        };
-    }
-    /**
-     * Throw an error if the context contains the readOnly flag.
-     * @param context An action context.
-     */
-    static throwOnReadOnly(context) {
-        if (context.get(context_entries_1.KeysQueryOperation.readOnly)) {
-            throw new Error(`Attempted a write operation in read-only mode`);
-        }
-    }
-    /**
-     * Obtain the query source attached to the given operation.
-     * @param operation An algebra operation.
-     */
-    static getOperationSource(operation) {
-        return operation.metadata?.scopedSource;
-    }
-    /**
-     * Assign a source wrapper to the given operation.
-     * The operation is copied and returned.
-     * @param operation An operation.
-     * @param source A source wrapper.
-     */
-    static assignOperationSource(operation, source) {
-        operation = { ...operation };
-        operation.metadata = operation.metadata ? { ...operation.metadata } : {};
-        operation.metadata.scopedSource = source;
-        return operation;
-    }
-    /**
-     * Remove the source wrapper from the given operation.
-     * The operation is mutated.
-     * @param operation An operation.
-     */
-    static removeOperationSource(operation) {
-        delete operation.metadata?.scopedSource;
-        if (operation.metadata && Object.keys(operation.metadata).length === 0) {
-            delete operation.metadata;
-        }
-    }
-    /**
-     * Check if the given shape accepts the given query operation.
-     * @param shape A shape to test the query operation against.
-     * @param operation A query operation to test.
-     * @param options Additional options to consider.
-     * @param options.joinBindings If additional bindings will be pushed down to the source for joining.
-     * @param options.filterBindings If additional bindings will be pushed down to the source for filtering.
-     */
-    static doesShapeAcceptOperation(shape, operation, options) {
-        if (shape.type === 'conjunction') {
-            return shape.children.every(child => ActorQueryOperation.doesShapeAcceptOperation(child, operation, options));
-        }
-        if (shape.type === 'disjunction') {
-            return shape.children.some(child => ActorQueryOperation.doesShapeAcceptOperation(child, operation, options));
-        }
-        if (shape.type === 'arity') {
-            return ActorQueryOperation.doesShapeAcceptOperation(shape.child, operation, options);
-        }
-        if ((options?.joinBindings && !shape.joinBindings) ?? (options?.filterBindings && !shape.filterBindings)) {
-            return false;
-        }
-        if (shape.operation.operationType === 'type') {
-            return shape.operation.type === 'project' || shape.operation.type === operation.type;
-        }
-        return shape.operation.pattern.type === operation.type;
-    }
 }
 exports.ActorQueryOperation = ActorQueryOperation;
 //# sourceMappingURL=ActorQueryOperation.js.map

package/lib/ActorQueryOperation.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActorQueryOperation.js","sourceRoot":"","sources":["ActorQueryOperation.ts"],"names":[],"mappings":";;;AACA,+DAA8E;AAE9E,yCAAuC;AACvC,yDAAiE;AAejE,yCAAkD;AAElD;;;;;GAKG;AACH,IAAI,YAAY,GAAG,CAAC,CAAC;AAErB;;;;;;;;;;GAUG;AACH,MAAsB,mBAAoB,SAAQ,YAA+D;IAC/G;;OAEG;IACH,YAAsB,IAA8B;QAClD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,MAA6B;QACzD,mBAAmB,CAAC,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC5D,OAAuC,MAAM,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,MAA6B;QACtD,mBAAmB,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzD,OAAoC,MAAM,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,MAA6B;QACxD,mBAAmB,CAAC,mBAAmB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC3D,OAAsC,MAAM,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,MAA6B;QACrD,mBAAmB,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,OAAmC,MAAM,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAA6B,EAAE,YAA2C;QAC1G,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,wCAAwC,YAAY,cAAc,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC;QACpG,CAAC;IACH,CAAC;IAES,MAAM,CAAC,wBAAwB,CAAC,OAAuB;QAC/D,MAAM,GAAG,GAAqB,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,cAAc,CAAC,CAAC;QACxE,MAAM,OAAO,GAAuB,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,OAAO,CAAC,CAAC;QACvE,MAAM,sBAAsB,GAA2B,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QAE/G,uDAAuD;QACvD,IAAI,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,wBAAwB,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACzG,MAAM,IAAI,KAAK,CAAC,0FAA0F,CAAC,CAAC;QAC9G,CAAC;QACD,IAAI,wBAAwB,GACyC,OAAO;aACzE,GAAG,CAAC,+BAAa,CAAC,wBAAwB,CAAC,CAAC;QAC/C,+CAA+C;QAC/C,MAAM,kBAAkB,GAA0E,OAAO;aACtG,GAAG,CAAC,+BAAa,CAAC,kBAAkB,CAAC,CAAC;QACzC,IAAI,kBAAkB,EAAE,CAAC;YACvB,wBAAwB,GAAG,iBAAiB,CAAC,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAC9F,CAAC;QAED,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,oBAAoB,CAAC,OAAuB,EAAE,uBAAgD;QAE1G,OAAO;YACL,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC;YACzC,KAAK,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,sCAAuB,CAAC,KAAK,IAAI,SAAS,YAAY,EAAE,EAAE,CAAC;SAC3F,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,yBAAyB,CACrC,OAAuB,EACvB,sBAA8C,EAC9C,eAAgC;QAGhC,OAAO;YACL,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC;YACzC,KAAK,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,sCAAuB,CAAC,KAAK,IAAI,SAAS,YAAY,EAAE,EAAE,CAAC,CAAC;YAC3G,MAAM,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,OAAO,EAAE,sBAAsB,EAAE,eAAe,CAAC;SACtG,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,uBAAuB,CACnC,OAAuB,EACvB,sBAA8C,EAC9C,eAAgC;QAGhC,OAAO,KAAK,EAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAA,+BAAoB,EAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;YAE9E,MAAM,SAAS,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/E,MAAM,MAAM,GAAG,mBAAmB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,OAAuB;QACnD,IAAI,OAAO,CAAC,GAAG,CAAC,oCAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,SAA4B;QAC3D,OAA6B,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAA8B,SAAY,EAAE,MAA2B;QACxG,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;QAC7B,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,SAAS,CAAC,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC;QACzC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,SAA4B;QAC9D,OAAO,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC;QACxC,IAAI,SAAS,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvE,OAAO,SAAS,CAAC,QAAQ,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,wBAAwB,CACpC,KAA4B,EAC5B,SAA4B,EAC5B,OAGC;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,wBAAwB,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAChH,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,wBAAwB,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/G,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC3B,OAAO,mBAAmB,CAAC,wBAAwB,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,YAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;YACzG,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,SAAS,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC;QACvF,CAAC;QACD,OAAO,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC;IACzD,CAAC;CACF;AAzND,kDAyNC","sourcesContent":["import type { BindingsFactory } from '@comunica/bindings-factory';\nimport { KeysInitQuery, KeysQueryOperation } from '@comunica/context-entries';\nimport type { IActorArgs, IActorTest, IAction, Mediate } from '@comunica/core';\nimport { Actor } from '@comunica/core';\nimport { BlankNodeBindingsScoped } from '@comunica/data-factory';\nimport type {\n  IQueryOperationResult,\n  IQueryOperationResultBindings,\n  IQueryOperationResultBoolean,\n  IQueryOperationResultQuads,\n  IQueryOperationResultVoid,\n  Bindings,\n  IActionContext,\n  FunctionArgumentsCache,\n  IQuerySourceWrapper,\n  FragmentSelectorShape,\n} from '@comunica/types';\nimport type * as RDF from '@rdfjs/types';\nimport type { Algebra } from 'sparqlalgebrajs';\nimport { materializeOperation } from './Bindings';\n\n/**\n * A counter that keeps track blank node generated through BNODE() SPARQL\n * expressions.\n *\n * @type {number}\n */\nlet bnodeCounter = 0;\n\n/**\n * A comunica actor for query-operation events.\n *\n * Actor types:\n * * Input:  IActionQueryOperation:      A SPARQL Algebra operation.\n * * Test:   <none>\n * * Output: IActorQueryOperationOutput: A bindings stream.\n *\n * @see IActionQueryOperation\n * @see IQueryOperationResult\n */\nexport abstract class ActorQueryOperation extends Actor<IActionQueryOperation, IActorTest, IQueryOperationResult> {\n  /**\n   * @param args - @defaultNested {<default_bus> a <cbqo:components/BusQueryOperation.jsonld#BusQueryOperation>} bus\n   */\n  protected constructor(args: IActorQueryOperationArgs) {\n    super(args);\n  }\n\n  /**\n   * Safely cast a query operation output to a bindings output.\n   * This will throw a runtime error if the output is of the incorrect type.\n   * @param {IQueryOperationResult} output A query operation output.\n   * @return {IQueryOperationResultBindings} A bindings query operation output.\n   */\n  public static getSafeBindings(output: IQueryOperationResult): IQueryOperationResultBindings {\n    ActorQueryOperation.validateQueryOutput(output, 'bindings');\n    return <IQueryOperationResultBindings> output;\n  }\n\n  /**\n   * Safely cast a query operation output to a quads output.\n   * This will throw a runtime error if the output is of the incorrect type.\n   * @param {IQueryOperationResult} output A query operation output.\n   * @return {IQueryOperationResultQuads} A quads query operation output.\n   */\n  public static getSafeQuads(output: IQueryOperationResult): IQueryOperationResultQuads {\n    ActorQueryOperation.validateQueryOutput(output, 'quads');\n    return <IQueryOperationResultQuads> output;\n  }\n\n  /**\n   * Safely cast a query operation output to a boolean output.\n   * This will throw a runtime error if the output is of the incorrect type.\n   * @param {IQueryOperationResult} output A query operation output.\n   * @return {IQueryOperationResultBoolean} A boolean query operation output.\n   */\n  public static getSafeBoolean(output: IQueryOperationResult): IQueryOperationResultBoolean {\n    ActorQueryOperation.validateQueryOutput(output, 'boolean');\n    return <IQueryOperationResultBoolean> output;\n  }\n\n  /**\n   * Safely cast a query operation output to a void output.\n   * This will throw a runtime error if the output is of the incorrect type.\n   * @param {IQueryOperationResult} output A query operation output.\n   * @return {IQueryOperationResultVoid} A void query operation output.\n   */\n  public static getSafeVoid(output: IQueryOperationResult): IQueryOperationResultVoid {\n    ActorQueryOperation.validateQueryOutput(output, 'void');\n    return <IQueryOperationResultVoid> output;\n  }\n\n  /**\n   * Throw an error if the output type does not match the expected type.\n   * @param {IQueryOperationResult} output A query operation output.\n   * @param {string} expectedType The expected output type.\n   */\n  public static validateQueryOutput(output: IQueryOperationResult, expectedType: IQueryOperationResult['type']): void {\n    if (output.type !== expectedType) {\n      throw new Error(`Invalid query output type: Expected '${expectedType}' but got '${output.type}'`);\n    }\n  }\n\n  protected static getBaseExpressionContext(context: IActionContext): IBaseExpressionContext {\n    const now: Date | undefined = context.get(KeysInitQuery.queryTimestamp);\n    const baseIRI: string | undefined = context.get(KeysInitQuery.baseIRI);\n    const functionArgumentsCache: FunctionArgumentsCache = context.get(KeysInitQuery.functionArgumentsCache) ?? {};\n\n    // Handle two variants of providing extension functions\n    if (context.has(KeysInitQuery.extensionFunctionCreator) && context.has(KeysInitQuery.extensionFunctions)) {\n      throw new Error('Illegal simultaneous usage of extensionFunctionCreator and extensionFunctions in context');\n    }\n    let extensionFunctionCreator: ((functionNamedNode: RDF.NamedNode) =>\n    ((args: RDF.Term[]) => Promise<RDF.Term>) | undefined) | undefined = context\n      .get(KeysInitQuery.extensionFunctionCreator);\n    // Convert dictionary-based variant to callback\n    const extensionFunctions: (Record<string, (args: RDF.Term[]) => Promise<RDF.Term>>) | undefined = context\n      .get(KeysInitQuery.extensionFunctions);\n    if (extensionFunctions) {\n      extensionFunctionCreator = functionNamedNode => extensionFunctions[functionNamedNode.value];\n    }\n\n    return { now, baseIRI, extensionFunctionCreator, functionArgumentsCache };\n  }\n\n  /**\n   * Create an options object that can be used to construct a expression-evaluator synchronous evaluator.\n   * @param context An action context.\n   * @param _mediatorQueryOperation An optional query query operation mediator.\n   *                                If defined, the existence resolver will be defined as `exists`.\n   */\n  public static getExpressionContext(context: IActionContext, _mediatorQueryOperation?: MediatorQueryOperation):\n  ISyncExpressionContext {\n    return {\n      ...this.getBaseExpressionContext(context),\n      bnode: (input?: string) => new BlankNodeBindingsScoped(input ?? `BNODE_${bnodeCounter++}`),\n    };\n  }\n\n  /**\n   * Create an options object that can be used to construct a expression-evaluator asynchronous evaluator.\n   * @param context An action context.\n   * @param mediatorQueryOperation A query query operation mediator for resolving `exists`.\n   * @param bindingsFactory The bindings factory.\n   */\n  public static getAsyncExpressionContext(\n    context: IActionContext,\n    mediatorQueryOperation: MediatorQueryOperation,\n    bindingsFactory: BindingsFactory,\n  ):\n    IAsyncExpressionContext {\n    return {\n      ...this.getBaseExpressionContext(context),\n      bnode: (input?: string) => Promise.resolve(new BlankNodeBindingsScoped(input ?? `BNODE_${bnodeCounter++}`)),\n      exists: ActorQueryOperation.createExistenceResolver(context, mediatorQueryOperation, bindingsFactory),\n    };\n  }\n\n  /**\n   * Create an existence resolver for usage within an expression context.\n   * @param context An action context.\n   * @param mediatorQueryOperation A query operation mediator.\n   * @param bindingsFactory The bindings factory.\n   */\n  public static createExistenceResolver(\n    context: IActionContext,\n    mediatorQueryOperation: MediatorQueryOperation,\n    bindingsFactory: BindingsFactory,\n  ):\n    (expr: Algebra.ExistenceExpression, bindings: Bindings) => Promise<boolean> {\n    return async(expr, bindings) => {\n      const operation = materializeOperation(expr.input, bindings, bindingsFactory);\n\n      const outputRaw = await mediatorQueryOperation.mediate({ operation, context });\n      const output = ActorQueryOperation.getSafeBindings(outputRaw);\n      return expr.not !== ((await output.bindingsStream.take(1).toArray()).length === 1);\n    };\n  }\n\n  /**\n   * Throw an error if the context contains the readOnly flag.\n   * @param context An action context.\n   */\n  public static throwOnReadOnly(context: IActionContext): void {\n    if (context.get(KeysQueryOperation.readOnly)) {\n      throw new Error(`Attempted a write operation in read-only mode`);\n    }\n  }\n\n  /**\n   * Obtain the query source attached to the given operation.\n   * @param operation An algebra operation.\n   */\n  public static getOperationSource(operation: Algebra.Operation): IQuerySourceWrapper | undefined {\n    return <IQuerySourceWrapper> operation.metadata?.scopedSource;\n  }\n\n  /**\n   * Assign a source wrapper to the given operation.\n   * The operation is copied and returned.\n   * @param operation An operation.\n   * @param source A source wrapper.\n   */\n  public static assignOperationSource<O extends Algebra.Operation>(operation: O, source: IQuerySourceWrapper): O {\n    operation = { ...operation };\n    operation.metadata = operation.metadata ? { ...operation.metadata } : {};\n    operation.metadata.scopedSource = source;\n    return operation;\n  }\n\n  /**\n   * Remove the source wrapper from the given operation.\n   * The operation is mutated.\n   * @param operation An operation.\n   */\n  public static removeOperationSource(operation: Algebra.Operation): void {\n    delete operation.metadata?.scopedSource;\n    if (operation.metadata && Object.keys(operation.metadata).length === 0) {\n      delete operation.metadata;\n    }\n  }\n\n  /**\n   * Check if the given shape accepts the given query operation.\n   * @param shape A shape to test the query operation against.\n   * @param operation A query operation to test.\n   * @param options Additional options to consider.\n   * @param options.joinBindings If additional bindings will be pushed down to the source for joining.\n   * @param options.filterBindings If additional bindings will be pushed down to the source for filtering.\n   */\n  public static doesShapeAcceptOperation(\n    shape: FragmentSelectorShape,\n    operation: Algebra.Operation,\n    options?: {\n      joinBindings?: boolean;\n      filterBindings?: boolean;\n    },\n  ): boolean {\n    if (shape.type === 'conjunction') {\n      return shape.children.every(child => ActorQueryOperation.doesShapeAcceptOperation(child, operation, options));\n    }\n    if (shape.type === 'disjunction') {\n      return shape.children.some(child => ActorQueryOperation.doesShapeAcceptOperation(child, operation, options));\n    }\n    if (shape.type === 'arity') {\n      return ActorQueryOperation.doesShapeAcceptOperation(shape.child, operation, options);\n    }\n\n    if ((options?.joinBindings && !shape.joinBindings) ?? (options?.filterBindings && !shape.filterBindings)) {\n      return false;\n    }\n\n    if (shape.operation.operationType === 'type') {\n      return shape.operation.type === 'project' || shape.operation.type === operation.type;\n    }\n    return shape.operation.pattern.type === operation.type;\n  }\n}\n\nexport interface IActionQueryOperation extends IAction {\n  /**\n   * The query operation to handle.\n   */\n  operation: Algebra.Operation;\n}\n\nexport type IActorQueryOperationArgs = IActorArgs<IActionQueryOperation, IActorTest, IQueryOperationResult>;\n\nexport type MediatorQueryOperation = Mediate<IActionQueryOperation, IQueryOperationResult>;\n\nexport interface IBaseExpressionContext {\n  now?: Date;\n  baseIRI?: string;\n  extensionFunctionCreator?: (functionNamedNode: RDF.NamedNode) =>\n  ((args: RDF.Term[]) => Promise<RDF.Term>) | undefined;\n  functionArgumentsCache?: FunctionArgumentsCache;\n}\n\nexport interface ISyncExpressionContext extends IBaseExpressionContext {\n  bnode: (input?: string | undefined) => RDF.BlankNode;\n}\n\nexport interface IAsyncExpressionContext extends IBaseExpressionContext {\n  bnode: (input?: string | undefined) => Promise<RDF.BlankNode>;\n  exists?: (expr: Algebra.ExistenceExpression, bindings: Bindings) => Promise<boolean>;\n}\n"]}
+{"version":3,"file":"ActorQueryOperation.js","sourceRoot":"","sources":["ActorQueryOperation.ts"],"names":[],"mappings":";;;AACA,yCAAuC;AAUvC;;;;;;;;;;GAUG;AACH,MAAsB,mBACpB,SAAQ,YAAmE;IAC3E,4BAA4B;IAC5B;;;;OAIG;IACH,2BAA2B;IAC3B,YAAsB,IAAkC;QACtD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;CACF;AAZD,kDAYC","sourcesContent":["import type { IActorArgs, IActorTest, IAction, Mediate } from '@comunica/core';\nimport { Actor } from '@comunica/core';\nimport type {\n  IQueryOperationResult,\n  Bindings,\n  IActionContext,\n  FunctionArgumentsCache,\n} from '@comunica/types';\nimport type * as RDF from '@rdfjs/types';\nimport type { Algebra } from 'sparqlalgebrajs';\n\n/**\n * A comunica actor for query-operation events.\n *\n * Actor types:\n * * Input:  IActionQueryOperation:      A SPARQL Algebra operation.\n * * Test:   <none>\n * * Output: IActorQueryOperationOutput: A bindings stream.\n *\n * @see IActionQueryOperation\n * @see IQueryOperationResult\n */\nexport abstract class ActorQueryOperation<TS = undefined>\n  extends Actor<IActionQueryOperation, IActorTest, IQueryOperationResult, TS> {\n  /* eslint-disable max-len */\n  /**\n   * @param args -\n   *   \\ @defaultNested {<default_bus> a <cbqo:components/BusQueryOperation.jsonld#BusQueryOperation>} bus\n   *   \\ @defaultNested {Query operation processing failed: none of the configured actors were able to handle the operation type ${action.operation.type}} busFailMessage\n   */\n  /* eslint-enable max-len */\n  protected constructor(args: IActorQueryOperationArgs<TS>) {\n    super(args);\n  }\n}\n\nexport interface IActionQueryOperation extends IAction {\n  /**\n   * The query operation to handle.\n   */\n  operation: Algebra.Operation;\n}\n\nexport type IActorQueryOperationArgs<TS = undefined> = IActorArgs<\n  IActionQueryOperation,\nIActorTest,\nIQueryOperationResult,\nTS\n>;\n\nexport type MediatorQueryOperation = Mediate<IActionQueryOperation, IQueryOperationResult>;\n\nexport interface IBaseExpressionContext {\n  now?: Date;\n  baseIRI?: string;\n  extensionFunctionCreator?: (functionNamedNode: RDF.NamedNode) =>\n  ((args: RDF.Term[]) => Promise<RDF.Term>) | undefined;\n  functionArgumentsCache?: FunctionArgumentsCache;\n  actionContext: IActionContext;\n}\n\nexport interface ISyncExpressionContext extends IBaseExpressionContext {\n  bnode: (input?: string | undefined) => RDF.BlankNode;\n}\n\nexport interface IAsyncExpressionContext extends IBaseExpressionContext {\n  bnode: (input?: string | undefined) => Promise<RDF.BlankNode>;\n  exists?: (expr: Algebra.ExistenceExpression, bindings: Bindings) => Promise<boolean>;\n}\n\nexport type FragmentSelectorShapeTestFlags = {\n  joinBindings?: boolean;\n  filterBindings?: boolean;\n};\n"]}

package/lib/ActorQueryOperationTyped.d.ts

@@ -1,4 +1,4 @@
-import type { IActorTest } from '@comunica/core';
+import type { IActorTest, TestResult } from '@comunica/core';
 import type { IQueryOperationResult, IActionContext } from '@comunica/types';
 import type { Algebra } from 'sparqlalgebrajs';
 import type { IActionQueryOperation, IActorQueryOperationArgs } from './ActorQueryOperation';
@@ -6,11 +6,11 @@ import { ActorQueryOperation } from './ActorQueryOperation';
 /**
  * A base implementation for query operation actors for a specific operation type.
  */
-export declare abstract class ActorQueryOperationTyped<O extends Algebra.Operation> extends ActorQueryOperation {
+export declare abstract class ActorQueryOperationTyped<O extends Algebra.Operation, TS = undefined> extends ActorQueryOperation<TS> {
     readonly operationName: string;
-    protected constructor(args: IActorQueryOperationArgs, operationName: string);
-    test(action: IActionQueryOperation): Promise<IActorTest>;
-    run(action: IActionQueryOperation): Promise<IQueryOperationResult>;
-    protected abstract testOperation(operation: O, context: IActionContext): Promise<IActorTest>;
-    protected abstract runOperation(operation: O, context: IActionContext): Promise<IQueryOperationResult>;
+    protected constructor(args: IActorQueryOperationArgs<TS>, operationName: string);
+    test(action: IActionQueryOperation): Promise<TestResult<IActorTest, TS>>;
+    run(action: IActionQueryOperation, sideData: TS): Promise<IQueryOperationResult>;
+    protected abstract testOperation(operation: O, context: IActionContext): Promise<TestResult<IActorTest, TS>>;
+    protected abstract runOperation(operation: O, context: IActionContext, sideData: TS): Promise<IQueryOperationResult>;
 }

package/lib/ActorQueryOperationTyped.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorQueryOperationTyped = void 0;
 const context_entries_1 = require("@comunica/context-entries");
-const metadata_1 = require("@comunica/metadata");
+const core_1 = require("@comunica/core");
+const utils_metadata_1 = require("@comunica/utils-metadata");
 const ActorQueryOperation_1 = require("./ActorQueryOperation");
 /**
  * A base implementation for query operation actors for a specific operation type.
@@ -16,15 +17,15 @@ class ActorQueryOperationTyped extends ActorQueryOperation_1.ActorQueryOperation
     }
     async test(action) {
         if (!action.operation) {
-            throw new Error('Missing field \'operation\' in a query operation action.');
+            return (0, core_1.failTest)('Missing field \'operation\' in a query operation action.');
         }
         if (action.operation.type !== this.operationName) {
-            throw new Error(`Actor ${this.name} only supports ${this.operationName} operations, but got ${action.operation.type}`);
+            return (0, core_1.failTest)(`Actor ${this.name} only supports ${this.operationName} operations, but got ${action.operation.type}`);
         }
         const operation = action.operation;
         return this.testOperation(operation, action.context);
     }
-    async run(action) {
+    async run(action, sideData) {
         // Log to physical plan
         const physicalQueryPlanLogger = action.context
             .get(context_entries_1.KeysInitQuery.physicalQueryPlanLogger);
@@ -34,9 +35,9 @@ class ActorQueryOperationTyped extends ActorQueryOperation_1.ActorQueryOperation
         }
         const operation = action.operation;
         const subContext = action.context.set(context_entries_1.KeysQueryOperation.operation, operation);
-        const output = await this.runOperation(operation, subContext);
+        const output = await this.runOperation(operation, subContext, sideData);
         if ('metadata' in output) {
-            output.metadata = (0, metadata_1.cachifyMetadata)(output.metadata);
+            output.metadata = (0, utils_metadata_1.cachifyMetadata)(output.metadata);
         }
         return output;
     }

package/lib/ActorQueryOperationTyped.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActorQueryOperationTyped.js","sourceRoot":"","sources":["ActorQueryOperationTyped.ts"],"names":[],"mappings":";;;AAAA,+DAA8E;AAE9E,iDAAqD;AAUrD,+DAA4D;AAE5D;;GAEG;AACH,MAAsB,wBAAsD,SAAQ,yCAAmB;IAGrG,YAAsB,IAA8B,EAAE,aAAqB;QACzE,KAAK,CAAO,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAA6B;QAC7C,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC9E,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,kBAAkB,IAAI,CAAC,aAAa,wBACpE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,SAAS,GAAU,MAAM,CAAC,SAAS,CAAC;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAA6B;QAC5C,uBAAuB;QACvB,MAAM,uBAAuB,GAAyC,MAAM,CAAC,OAAO;aACjF,GAAG,CAAC,+BAAa,CAAC,uBAAuB,CAAC,CAAC;QAC9C,IAAI,uBAAuB,EAAE,CAAC;YAC5B,uBAAuB,CAAC,YAAY,CAClC,MAAM,CAAC,SAAS,CAAC,IAAI,EACrB,SAAS,EACT,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,qBAAqB,CAAC,EACvD,IAAI,CAAC,IAAI,EACT,EAAE,CACH,CAAC;YACF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,qBAAqB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAU,MAAM,CAAC,SAAS,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAkB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC/E,MAAM,MAAM,GAA0B,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACrF,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,QAAQ,GACb,IAAA,0BAAe,EAA8E,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CAMF;AApDD,4DAoDC","sourcesContent":["import { KeysInitQuery, KeysQueryOperation } from '@comunica/context-entries';\nimport type { IActorTest } from '@comunica/core';\nimport { cachifyMetadata } from '@comunica/metadata';\nimport type {\n  IQueryOperationResult,\n  IPhysicalQueryPlanLogger,\n  IActionContext,\n  IMetadata,\n} from '@comunica/types';\nimport type * as RDF from '@rdfjs/types';\nimport type { Algebra } from 'sparqlalgebrajs';\nimport type { IActionQueryOperation, IActorQueryOperationArgs } from './ActorQueryOperation';\nimport { ActorQueryOperation } from './ActorQueryOperation';\n\n/**\n * A base implementation for query operation actors for a specific operation type.\n */\nexport abstract class ActorQueryOperationTyped<O extends Algebra.Operation> extends ActorQueryOperation {\n  public readonly operationName: string;\n\n  protected constructor(args: IActorQueryOperationArgs, operationName: string) {\n    super(<any> { ...args, operationName });\n    if (!this.operationName) {\n      throw new Error('A valid \"operationName\" argument must be provided.');\n    }\n  }\n\n  public async test(action: IActionQueryOperation): Promise<IActorTest> {\n    if (!action.operation) {\n      throw new Error('Missing field \\'operation\\' in a query operation action.');\n    }\n    if (action.operation.type !== this.operationName) {\n      throw new Error(`Actor ${this.name} only supports ${this.operationName} operations, but got ${\n        action.operation.type}`);\n    }\n    const operation: O = <O> action.operation;\n    return this.testOperation(operation, action.context);\n  }\n\n  public async run(action: IActionQueryOperation): Promise<IQueryOperationResult> {\n    // Log to physical plan\n    const physicalQueryPlanLogger: IPhysicalQueryPlanLogger | undefined = action.context\n      .get(KeysInitQuery.physicalQueryPlanLogger);\n    if (physicalQueryPlanLogger) {\n      physicalQueryPlanLogger.logOperation(\n        action.operation.type,\n        undefined,\n        action.operation,\n        action.context.get(KeysInitQuery.physicalQueryPlanNode),\n        this.name,\n        {},\n      );\n      action.context = action.context.set(KeysInitQuery.physicalQueryPlanNode, action.operation);\n    }\n\n    const operation: O = <O> action.operation;\n    const subContext = action.context.set(KeysQueryOperation.operation, operation);\n    const output: IQueryOperationResult = await this.runOperation(operation, subContext);\n    if ('metadata' in output) {\n      output.metadata = <any>\n        cachifyMetadata<IMetadata<RDF.QuadTermName | RDF.Variable>, RDF.QuadTermName | RDF.Variable>(output.metadata);\n    }\n    return output;\n  }\n\n  protected abstract testOperation(operation: O, context: IActionContext): Promise<IActorTest>;\n\n  protected abstract runOperation(operation: O, context: IActionContext):\n  Promise<IQueryOperationResult>;\n}\n"]}
+{"version":3,"file":"ActorQueryOperationTyped.js","sourceRoot":"","sources":["ActorQueryOperationTyped.ts"],"names":[],"mappings":";;;AAAA,+DAA8E;AAE9E,yCAA0C;AAO1C,6DAA2D;AAI3D,+DAA4D;AAE5D;;GAEG;AACH,MAAsB,wBAGpB,SAAQ,yCAAuB;IAG/B,YAAsB,IAAkC,EAAE,aAAqB;QAC7E,KAAK,CAAO,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAA6B;QAC7C,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,OAAO,IAAA,eAAQ,EAAC,0DAA0D,CAAC,CAAC;QAC9E,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACjD,OAAO,IAAA,eAAQ,EAAC,SAAS,IAAI,CAAC,IAAI,kBAAkB,IAAI,CAAC,aAAa,wBAClE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/B,CAAC;QACD,MAAM,SAAS,GAAU,MAAM,CAAC,SAAS,CAAC;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAA6B,EAAE,QAAY;QAC1D,uBAAuB;QACvB,MAAM,uBAAuB,GAAyC,MAAM,CAAC,OAAO;aACjF,GAAG,CAAC,+BAAa,CAAC,uBAAuB,CAAC,CAAC;QAC9C,IAAI,uBAAuB,EAAE,CAAC;YAC5B,uBAAuB,CAAC,YAAY,CAClC,MAAM,CAAC,SAAS,CAAC,IAAI,EACrB,SAAS,EACT,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,qBAAqB,CAAC,EACvD,IAAI,CAAC,IAAI,EACT,EAAE,CACH,CAAC;YACF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,qBAAqB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAU,MAAM,CAAC,SAAS,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAkB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC/E,MAAM,MAAM,GAA0B,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC/F,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,QAAQ,GACb,IAAA,gCAAe,EAA8E,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CAMF;AAvDD,4DAuDC","sourcesContent":["import { KeysInitQuery, KeysQueryOperation } from '@comunica/context-entries';\nimport type { IActorTest, TestResult } from '@comunica/core';\nimport { failTest } from '@comunica/core';\nimport type {\n  IQueryOperationResult,\n  IPhysicalQueryPlanLogger,\n  IActionContext,\n  IMetadata,\n} from '@comunica/types';\nimport { cachifyMetadata } from '@comunica/utils-metadata';\nimport type * as RDF from '@rdfjs/types';\nimport type { Algebra } from 'sparqlalgebrajs';\nimport type { IActionQueryOperation, IActorQueryOperationArgs } from './ActorQueryOperation';\nimport { ActorQueryOperation } from './ActorQueryOperation';\n\n/**\n * A base implementation for query operation actors for a specific operation type.\n */\nexport abstract class ActorQueryOperationTyped<\n  O extends Algebra.Operation,\nTS = undefined,\n> extends ActorQueryOperation<TS> {\n  public readonly operationName: string;\n\n  protected constructor(args: IActorQueryOperationArgs<TS>, operationName: string) {\n    super(<any> { ...args, operationName });\n    if (!this.operationName) {\n      throw new Error('A valid \"operationName\" argument must be provided.');\n    }\n  }\n\n  public async test(action: IActionQueryOperation): Promise<TestResult<IActorTest, TS>> {\n    if (!action.operation) {\n      return failTest('Missing field \\'operation\\' in a query operation action.');\n    }\n    if (action.operation.type !== this.operationName) {\n      return failTest(`Actor ${this.name} only supports ${this.operationName} operations, but got ${\n          action.operation.type}`);\n    }\n    const operation: O = <O> action.operation;\n    return this.testOperation(operation, action.context);\n  }\n\n  public async run(action: IActionQueryOperation, sideData: TS): Promise<IQueryOperationResult> {\n    // Log to physical plan\n    const physicalQueryPlanLogger: IPhysicalQueryPlanLogger | undefined = action.context\n      .get(KeysInitQuery.physicalQueryPlanLogger);\n    if (physicalQueryPlanLogger) {\n      physicalQueryPlanLogger.logOperation(\n        action.operation.type,\n        undefined,\n        action.operation,\n        action.context.get(KeysInitQuery.physicalQueryPlanNode),\n        this.name,\n        {},\n      );\n      action.context = action.context.set(KeysInitQuery.physicalQueryPlanNode, action.operation);\n    }\n\n    const operation: O = <O> action.operation;\n    const subContext = action.context.set(KeysQueryOperation.operation, operation);\n    const output: IQueryOperationResult = await this.runOperation(operation, subContext, sideData);\n    if ('metadata' in output) {\n      output.metadata = <any>\n        cachifyMetadata<IMetadata<RDF.QuadTermName | RDF.Variable>, RDF.QuadTermName | RDF.Variable>(output.metadata);\n    }\n    return output;\n  }\n\n  protected abstract testOperation(operation: O, context: IActionContext): Promise<TestResult<IActorTest, TS>>;\n\n  protected abstract runOperation(operation: O, context: IActionContext, sideData: TS):\n  Promise<IQueryOperationResult>;\n}\n"]}

package/lib/ActorQueryOperationTypedMediated.d.ts

@@ -4,10 +4,10 @@ import { ActorQueryOperationTyped } from './ActorQueryOperationTyped';
 /**
  * A base implementation for query operation actors for a specific operation type that have a query operation mediator.
  */
-export declare abstract class ActorQueryOperationTypedMediated<O extends Algebra.Operation> extends ActorQueryOperationTyped<O> implements IActorQueryOperationTypedMediatedArgs {
+export declare abstract class ActorQueryOperationTypedMediated<O extends Algebra.Operation, TS = undefined> extends ActorQueryOperationTyped<O, TS> implements IActorQueryOperationTypedMediatedArgs<TS> {
     readonly mediatorQueryOperation: MediatorQueryOperation;
-    constructor(args: IActorQueryOperationTypedMediatedArgs, operationName: string);
+    constructor(args: IActorQueryOperationTypedMediatedArgs<TS>, operationName: string);
 }
-export interface IActorQueryOperationTypedMediatedArgs extends IActorQueryOperationArgs {
+export interface IActorQueryOperationTypedMediatedArgs<TS = undefined> extends IActorQueryOperationArgs<TS> {
     mediatorQueryOperation: MediatorQueryOperation;
 }

package/lib/ActorQueryOperationTypedMediated.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActorQueryOperationTypedMediated.js","sourceRoot":"","sources":["ActorQueryOperationTypedMediated.ts"],"names":[],"mappings":";;;AAEA,yEAAsE;AAEtE;;GAEG;AACH,MAAsB,gCAA8D,SAAQ,mDAA2B;IAIrH,YAAmB,IAA2C,EAAE,aAAqB;QACnF,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7B,CAAC;CACF;AAPD,4EAOC","sourcesContent":["import type { Algebra } from 'sparqlalgebrajs';\nimport type { IActorQueryOperationArgs, MediatorQueryOperation } from './ActorQueryOperation';\nimport { ActorQueryOperationTyped } from './ActorQueryOperationTyped';\n\n/**\n * A base implementation for query operation actors for a specific operation type that have a query operation mediator.\n */\nexport abstract class ActorQueryOperationTypedMediated<O extends Algebra.Operation> extends ActorQueryOperationTyped<O>\n  implements IActorQueryOperationTypedMediatedArgs {\n  public readonly mediatorQueryOperation: MediatorQueryOperation;\n\n  public constructor(args: IActorQueryOperationTypedMediatedArgs, operationName: string) {\n    super(args, operationName);\n  }\n}\n\nexport interface IActorQueryOperationTypedMediatedArgs extends IActorQueryOperationArgs {\n  mediatorQueryOperation: MediatorQueryOperation;\n}\n"]}
+{"version":3,"file":"ActorQueryOperationTypedMediated.js","sourceRoot":"","sources":["ActorQueryOperationTypedMediated.ts"],"names":[],"mappings":";;;AAEA,yEAAsE;AAEtE;;GAEG;AACH,MAAsB,gCAGpB,SAAQ,mDAA+B;IAIvC,YAAmB,IAA+C,EAAE,aAAqB;QACvF,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7B,CAAC;CACF;AAVD,4EAUC","sourcesContent":["import type { Algebra } from 'sparqlalgebrajs';\nimport type { IActorQueryOperationArgs, MediatorQueryOperation } from './ActorQueryOperation';\nimport { ActorQueryOperationTyped } from './ActorQueryOperationTyped';\n\n/**\n * A base implementation for query operation actors for a specific operation type that have a query operation mediator.\n */\nexport abstract class ActorQueryOperationTypedMediated<\n  O extends Algebra.Operation,\nTS = undefined,\n> extends ActorQueryOperationTyped<O, TS>\n  implements IActorQueryOperationTypedMediatedArgs<TS> {\n  public readonly mediatorQueryOperation: MediatorQueryOperation;\n\n  public constructor(args: IActorQueryOperationTypedMediatedArgs<TS>, operationName: string) {\n    super(args, operationName);\n  }\n}\n\nexport interface IActorQueryOperationTypedMediatedArgs<TS = undefined> extends IActorQueryOperationArgs<TS> {\n  mediatorQueryOperation: MediatorQueryOperation;\n}\n"]}

package/lib/index.d.ts

@@ -1,7 +1,4 @@
 export * from './ActorQueryOperation';
 export * from './ActorQueryOperationTyped';
 export * from './ActorQueryOperationTypedMediated';
-export * from './Bindings';
 export * from './BusQueryOperation';
-export * from './ClosableIterator';
-export * from './ClosableTransformIterator';

package/lib/index.js

@@ -17,8 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ActorQueryOperation"), exports);
 __exportStar(require("./ActorQueryOperationTyped"), exports);
 __exportStar(require("./ActorQueryOperationTypedMediated"), exports);
-__exportStar(require("./Bindings"), exports);
 __exportStar(require("./BusQueryOperation"), exports);
-__exportStar(require("./ClosableIterator"), exports);
-__exportStar(require("./ClosableTransformIterator"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,6DAA2C;AAC3C,qEAAmD;AACnD,6CAA2B;AAC3B,sDAAoC;AACpC,qDAAmC;AACnC,8DAA4C","sourcesContent":["export * from './ActorQueryOperation';\nexport * from './ActorQueryOperationTyped';\nexport * from './ActorQueryOperationTypedMediated';\nexport * from './Bindings';\nexport * from './BusQueryOperation';\nexport * from './ClosableIterator';\nexport * from './ClosableTransformIterator';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,6DAA2C;AAC3C,qEAAmD;AACnD,sDAAoC","sourcesContent":["export * from './ActorQueryOperation';\nexport * from './ActorQueryOperationTyped';\nexport * from './ActorQueryOperationTypedMediated';\nexport * from './BusQueryOperation';\n"]}

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@comunica/bus-query-operation",
-  "version": "3.3.0",
+  "version": "4.0.1",
   "description": "A comunica bus for query-operation events.",
   "lsd:module": true,
   "license": "MIT",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/comunica-association"
+  },
   "homepage": "https://comunica.dev/",
   "repository": {
     "type": "git",
@@ -36,18 +40,12 @@
     "build:components": "componentsjs-generator"
   },
   "dependencies": {
-    "@comunica/bindings-factory": "^3.3.0",
-    "@comunica/context-entries": "^3.3.0",
-    "@comunica/core": "^3.3.0",
-    "@comunica/data-factory": "^3.1.0",
-    "@comunica/metadata": "^3.3.0",
-    "@comunica/types": "^3.3.0",
+    "@comunica/context-entries": "^4.0.1",
+    "@comunica/core": "^4.0.1",
+    "@comunica/types": "^4.0.1",
+    "@comunica/utils-metadata": "^4.0.1",
     "@rdfjs/types": "*",
-    "asynciterator": "^3.9.0",
-    "rdf-data-factory": "^1.1.2",
-    "rdf-string": "^1.6.1",
-    "rdf-terms": "^1.11.0",
-    "sparqlalgebrajs": "^4.3.7"
+    "sparqlalgebrajs": "^4.3.8"
   },
-  "gitHead": "02bde397d206f1f5a523643a6a604c89e792e2f9"
+  "gitHead": "67831ba79e45ea1ced41fe3f83c5d6e8802dbeaa"
 }

package/lib/Bindings.d.ts

@@ -1,38 +0,0 @@
-import type { BindingsFactory } from '@comunica/bindings-factory';
-import type { Bindings } from '@comunica/types';
-import type * as RDF from '@rdfjs/types';
-import type { Algebra } from 'sparqlalgebrajs';
-/**
- * Materialize a term with the given binding.
- *
- * If the given term is a variable,
- * and that variable exist in the given bindings object,
- * the value of that binding is returned.
- * In all other cases, the term itself is returned.
- *
- * @param {RDF.Term} term A term.
- * @param {Bindings} bindings A bindings object.
- * @return {RDF.Term} The materialized term.
- */
-export declare function materializeTerm(term: RDF.Term, bindings: Bindings): RDF.Term;
-/**
- * Materialize the given operation (recursively) with the given bindings.
- * Essentially, the variables in the given operation
- * which don't appear in the projection operation will be replaced
- * by the terms bound to the variables in the given bindings.
- * @param {Algebra.Operation} operation SPARQL algebra operation.
- * And the variables that appear in the projection operation
- * will be added to a new values operation.
- * @param {Bindings} bindings A bindings object.
- * @param bindingsFactory The bindings factory.
- * @param options Options for materializations.
- * @param options.strictTargetVariables If target variable bindings (such as on SELECT or BIND) should not be allowed.
- * @param options.bindFilter If filter expressions should be materialized.
- * @param options.originalBindings The bindings object as it was at the top level call of materializeOperation.
- * @return Algebra.Operation A new operation materialized with the given bindings.
- */
-export declare function materializeOperation(operation: Algebra.Operation, bindings: Bindings, bindingsFactory: BindingsFactory, options?: {
-    strictTargetVariables?: boolean;
-    bindFilter?: boolean;
-    originalBindings?: Bindings;
-}): Algebra.Operation;