@comunica/actor-query-operation-slice 1.22.0 → 2.0.1-alpha.5.0

package/LICENSE.txt

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright © 2017–2018 Ruben Taelman, Joachim Van Herwegen
-Ghent University – imec, Belgium
+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

package/README.md

@@ -22,14 +22,14 @@ After installing, this package can be added to your engine's configuration as fo
 {
   "@context": [
     ...
-    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-slice/^1.0.0/components/context.jsonld"  
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-slice/^2.0.0/components/context.jsonld"  
   ],
   "actors": [
     ...
     {
-      "@id": "config-sets:sparql-queryoperators.json#mySliceQueryOperator",
+      "@id": "urn:comunica:default:query-operation/actors#slice",
       "@type": "ActorQueryOperationSlice",
-      "cbqo:mediatorQueryOperation": { "@id": "config-sets:sparql-queryoperators.json#mediatorQueryOperation" }
+      "mediatorQueryOperation": { "@id": "urn:comunica:default:query-operation/mediators#main" }
     }
   ]
 }
@@ -37,4 +37,4 @@ After installing, this package can be added to your engine's configuration as fo
 
 ### Config Parameters
 
-* `cbqo:mediatorQueryOperation`: A mediator over the [Query Operation bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-operation).
+* `mediatorQueryOperation`: A mediator over the [Query Operation bus](https://github.com/comunica/comunica/tree/master/packages/bus-query-operation).

package/components/ActorQueryOperationSlice.jsonld

@@ -0,0 +1,169 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-slice/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-query-operation-slice",
+  "components": [
+    {
+      "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice",
+      "@type": "Class",
+      "requireElement": "ActorQueryOperationSlice",
+      "extends": [
+        {
+          "@type": "GenericComponentExtension",
+          "component": "cbqo:components/ActorQueryOperationTypedMediated.jsonld#ActorQueryOperationTypedMediated",
+          "genericTypeInstances": [
+            "urn:npm:sparqlalgebrajs:Slice"
+          ]
+        }
+      ],
+      "comment": "A comunica Slice Query Operation Actor.",
+      "parameters": [
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_mediatorQueryOperation",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_bus",
+          "range": {
+            "@type": "ParameterRangeGenericComponent",
+            "component": "cc:components/Bus.jsonld#Bus",
+            "genericTypeInstances": [
+              {
+                "@type": "ParameterRangeGenericComponent",
+                "component": "cc:components/Actor.jsonld#Actor",
+                "genericTypeInstances": [
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbqo:components/ActorQueryOperation.jsonld#ActorQueryOperation_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_beforeActors",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeArray",
+                "parameterRangeValue": {
+                  "@type": "ParameterRangeGenericComponent",
+                  "component": "cc:components/Actor.jsonld#Actor",
+                  "genericTypeInstances": [
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice__member_testOperation",
+          "memberFieldName": "testOperation"
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice__member_runOperation",
+          "memberFieldName": "runOperation"
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice__member_sliceStream",
+          "memberFieldName": "sliceStream"
+        },
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice__member_sliceMetadata",
+          "memberFieldName": "sliceMetadata"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "mediatorQueryOperation",
+              "value": {
+                "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_mediatorQueryOperation"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/components/components.jsonld

@@ -1,9 +1,11 @@
 {
-  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-slice/^1.0.0/components/context.jsonld",
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-slice/^2.0.0/components/context.jsonld"
+  ],
   "@id": "npmd:@comunica/actor-query-operation-slice",
   "@type": "Module",
   "requireName": "@comunica/actor-query-operation-slice",
   "import": [
-    "files-caqos:components/Actor/QueryOperation/Slice.jsonld"
+    "caqos:components/ActorQueryOperationSlice.jsonld"
   ]
-}
+}

package/components/context.jsonld

@@ -3,10 +3,39 @@
     "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
     {
       "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
-      "caqos": "npmd:@comunica/actor-query-operation-slice/",
-      "files-caqos": "caqos:^1.0.0/",
-
-      "ActorQueryOperationSlice": "caqos:Actor/QueryOperation/Slice"
+      "caqos": "npmd:@comunica/actor-query-operation-slice/^2.0.0/",
+      "ActorQueryOperationSlice": {
+        "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice",
+        "@prefix": true,
+        "@context": {
+          "args_mediatorQueryOperation": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_mediatorQueryOperation"
+          },
+          "args_name": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_name"
+          },
+          "args_bus": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_beforeActors",
+            "@container": "@list"
+          },
+          "mediatorQueryOperation": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_mediatorQueryOperation"
+          },
+          "name": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_name"
+          },
+          "bus": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_bus"
+          },
+          "beforeActors": {
+            "@id": "caqos:components/ActorQueryOperationSlice.jsonld#ActorQueryOperationSlice_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      }
     }
   ]
-}
+}

package/lib/ActorQueryOperationSlice.d.ts

@@ -1,15 +1,15 @@
 import type { IActorQueryOperationTypedMediatedArgs } from '@comunica/bus-query-operation';
 import { ActorQueryOperationTypedMediated } from '@comunica/bus-query-operation';
-import type { ActionContext, IActorTest } from '@comunica/core';
-import type { IActorQueryOperationOutputStream } from '@comunica/types';
+import type { IActorTest } from '@comunica/core';
+import type { IQueryOperationResult, IActionContext } from '@comunica/types';
 import type { Algebra } from 'sparqlalgebrajs';
 /**
  * A comunica Slice Query Operation Actor.
  */
 export declare class ActorQueryOperationSlice extends ActorQueryOperationTypedMediated<Algebra.Slice> {
     constructor(args: IActorQueryOperationTypedMediatedArgs);
-    testOperation(pattern: Algebra.Slice, context: ActionContext): Promise<IActorTest>;
-    runOperation(pattern: Algebra.Slice, context: ActionContext): Promise<IActorQueryOperationOutputStream>;
+    testOperation(operation: Algebra.Slice, context: IActionContext): Promise<IActorTest>;
+    runOperation(operation: Algebra.Slice, context: IActionContext): Promise<IQueryOperationResult>;
     private sliceStream;
     private sliceMetadata;
 }

package/lib/ActorQueryOperationSlice.js

@@ -9,29 +9,28 @@ class ActorQueryOperationSlice extends bus_query_operation_1.ActorQueryOperation
     constructor(args) {
         super(args, 'slice');
     }
-    async testOperation(pattern, context) {
+    async testOperation(operation, context) {
         return true;
     }
-    async runOperation(pattern, context) {
+    async runOperation(operation, context) {
         // Resolve the input
         const output = await this.mediatorQueryOperation
-            .mediate({ operation: pattern.input, context });
-        const metadata = this.sliceMetadata(output, pattern);
+            .mediate({ operation: operation.input, context });
         if (output.type === 'bindings') {
-            const bindingsOutput = output;
-            const bindingsStream = this.sliceStream(bindingsOutput.bindingsStream, pattern);
+            const bindingsStream = this.sliceStream(output.bindingsStream, operation);
             return {
                 type: 'bindings',
                 bindingsStream,
-                metadata,
-                variables: bindingsOutput.variables,
-                canContainUndefs: bindingsOutput.canContainUndefs,
+                metadata: this.sliceMetadata(output, operation),
             };
         }
         if (output.type === 'quads') {
-            const quadOutput = output;
-            const quadStream = this.sliceStream(quadOutput.quadStream, pattern);
-            return { type: 'quads', quadStream, metadata };
+            const quadStream = this.sliceStream(output.quadStream, operation);
+            return {
+                type: 'quads',
+                quadStream,
+                metadata: this.sliceMetadata(output, operation),
+            };
         }
         throw new Error(`Invalid query output type: Expected 'bindings' or 'quads' but got '${output.type}'`);
     }
@@ -47,19 +46,17 @@ class ActorQueryOperationSlice extends bus_query_operation_1.ActorQueryOperation
     sliceMetadata(output, pattern) {
         // eslint-disable-next-line unicorn/explicit-length-check
         const hasLength = Boolean(pattern.length) || pattern.length === 0;
-        return !output.metadata ?
-            undefined :
-            () => output.metadata()
-                .then(subMetadata => {
-                let { totalItems } = subMetadata;
-                if (Number.isFinite(totalItems)) {
-                    totalItems = Math.max(0, totalItems - pattern.start);
-                    if (hasLength) {
-                        totalItems = Math.min(totalItems, pattern.length);
-                    }
+        return () => output.metadata()
+            .then(subMetadata => {
+            const cardinality = { ...subMetadata.cardinality };
+            if (Number.isFinite(cardinality.value)) {
+                cardinality.value = Math.max(0, cardinality.value - pattern.start);
+                if (hasLength) {
+                    cardinality.value = Math.min(cardinality.value, pattern.length);
                 }
-                return Object.assign(Object.assign({}, subMetadata), { totalItems });
-            });
+            }
+            return { ...subMetadata, cardinality };
+        });
     }
 }
 exports.ActorQueryOperationSlice = ActorQueryOperationSlice;

package/lib/index.d.ts

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

package/{index.js → lib/index.js}

@@ -10,5 +10,5 @@ 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("./lib/ActorQueryOperationSlice"), exports);
+__exportStar(require("./ActorQueryOperationSlice"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@comunica/actor-query-operation-slice",
-  "version": "1.22.0",
+  "version": "2.0.1-alpha.5.0",
   "description": "A slice query-operation actor",
   "lsd:module": true,
-  "main": "index.js",
-  "typings": "index",
+  "main": "lib/index.js",
+  "typings": "lib/index",
   "repository": {
     "type": "git",
     "url": "https://github.com/comunica/comunica.git",
@@ -27,44 +27,19 @@
   "files": [
     "components",
     "lib/**/*.d.ts",
-    "lib/**/*.js",
-    "index.d.ts",
-    "index.js"
+    "lib/**/*.js"
   ],
   "dependencies": {
-    "@comunica/types": "^1.22.0",
-    "asynciterator": "^3.2.0",
-    "sparqlalgebrajs": "^3.0.0"
-  },
-  "peerDependencies": {
-    "@comunica/bus-query-operation": "^1.0.0",
-    "@comunica/core": "^1.0.0"
-  },
-  "devDependencies": {
-    "@comunica/bus-query-operation": "^1.22.0",
-    "@comunica/core": "^1.22.0"
-  },
-  "jest": {
-    "globals": {
-      "ts-jest": {
-        "tsConfig": "../../tsconfig.json"
-      }
-    },
-    "transform": {
-      "^.+\\.ts$": "ts-jest"
-    },
-    "testRegex": "(/test/.*|(\\.|/)(test|spec))\\.ts$",
-    "moduleFileExtensions": [
-      "ts",
-      "js"
-    ],
-    "collectCoverage": true
+    "@comunica/bus-query-operation": "2.0.1-alpha.5.0",
+    "@comunica/core": "2.0.1-alpha.5.0",
+    "@comunica/types": "2.0.1-alpha.5.0",
+    "asynciterator": "^3.2.1",
+    "sparqlalgebrajs": "^4.0.0"
   },
   "scripts": {
-    "test": "node \"../../node_modules/jest/bin/jest.js\" ${1}",
-    "test-watch": "node \"../../node_modules/jest/bin/jest.js\" ${1} --watch",
-    "build": "node \"../../node_modules/typescript/bin/tsc\"",
-    "validate": "npm ls"
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
   },
-  "gitHead": "0a249ba341022eb2f1b9922fcf549a9564671d9f"
+  "gitHead": "e2ae2e9e924bf0656df60cc99774f7e560d47695"
 }

package/components/Actor/QueryOperation/Slice.jsonld

@@ -1,21 +0,0 @@
-{
-  "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-query-operation-slice/^1.0.0/components/context.jsonld",
-    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-query-operation/^1.0.0/components/context.jsonld"
-  ],
-  "@id": "npmd:@comunica/actor-query-operation-slice",
-  "components": [
-    {
-      "@id": "caqos:Actor/QueryOperation/Slice",
-      "@type": "Class",
-      "extends": "cbqo:Actor/QueryOperationTypedMediated",
-      "requireElement": "ActorQueryOperationSlice",
-      "comment": "A comunica Slice Query Operation Actor.",
-      "constructorArguments": [
-        {
-          "extends": "cbqo:Actor/QueryOperationTypedMediated/constructorArgumentsObject"
-        }
-      ]
-    }
-  ]
-}

package/index.d.ts

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