@comunica/actor-dereference-file 2.0.1-alpha.5.0

package/LICENSE.txt

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

package/README.md

@@ -0,0 +1,35 @@
+# Comunica File Dereference Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-dereference-file.svg)](https://www.npmjs.com/package/@comunica/actor-dereference-file)
+
+A comunica File Dereference Actor.
+
+An [Dereference](https://github.com/comunica/comunica/tree/master/packages/bus-dereference) actor that
+resolves an URL to a local file (optionally starting with `file://`).
+
+[Click here if you just want to query with Comunica](https://comunica.dev/docs/query/).
+
+## Install
+
+```bash
+$ yarn add @comunica/actor-dereference-file
+```
+
+## Configure
+
+After installing, this package can be added to your engine's configuration as follows:
+```text
+{
+  "@context": [
+    ...
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-dereference-file/^2.0.0/components/context.jsonld"  
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:dereference/actors#file",
+      "@type": "ActorRdfDereferenceFile"
+    }
+  ]
+}
+```

package/components/ActorDereferenceFile.jsonld

@@ -0,0 +1,145 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-dereference-file/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-dereference/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-dereference-file",
+  "components": [
+    {
+      "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile",
+      "@type": "Class",
+      "requireElement": "ActorDereferenceFile",
+      "extends": [
+        "cbd:components/ActorDereference.jsonld#ActorDereference"
+      ],
+      "comment": "A comunica File Dereference Actor.",
+      "parameters": [
+        {
+          "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_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": "cbd:components/ActorDereference.jsonld#ActorDereference_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_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": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile__member_run",
+          "memberFieldName": "run"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-dereference-file/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-dereference-file",
+  "@type": "Module",
+  "requireName": "@comunica/actor-dereference-file",
+  "import": [
+    "cadf:components/ActorDereferenceFile.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,35 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "cadf": "npmd:@comunica/actor-dereference-file/^2.0.0/",
+      "ActorDereferenceFile": {
+        "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile",
+        "@prefix": true,
+        "@context": {
+          "args_name": {
+            "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_name"
+          },
+          "args_bus": {
+            "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_beforeActors",
+            "@container": "@list"
+          },
+          "name": {
+            "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_name"
+          },
+          "bus": {
+            "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_bus"
+          },
+          "beforeActors": {
+            "@id": "cadf:components/ActorDereferenceFile.jsonld#ActorDereferenceFile_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      }
+    }
+  ]
+}

package/lib/ActorDereferenceFile.d.ts

@@ -0,0 +1,11 @@
+import type { IActionDereference, IActorDereferenceArgs, IActorDereferenceOutput } from '@comunica/bus-dereference';
+import { ActorDereference } from '@comunica/bus-dereference';
+import type { IActorTest } from '@comunica/core';
+/**
+ * A comunica File Dereference Actor.
+ */
+export declare class ActorDereferenceFile extends ActorDereference {
+    constructor(args: IActorDereferenceArgs);
+    test({ url }: IActionDereference): Promise<IActorTest>;
+    run({ url }: IActionDereference): Promise<IActorDereferenceOutput>;
+}

package/lib/ActorDereferenceFile.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorDereferenceFile = void 0;
+const fs_1 = require("fs");
+const url_1 = require("url");
+const bus_dereference_1 = require("@comunica/bus-dereference");
+/**
+ * A comunica File Dereference Actor.
+ */
+class ActorDereferenceFile extends bus_dereference_1.ActorDereference {
+    constructor(args) {
+        super(args);
+    }
+    async test({ url }) {
+        try {
+            (0, fs_1.accessSync)(getPath(url), fs_1.constants.F_OK);
+        }
+        catch (error) {
+            throw new Error(`This actor only works on existing local files. (${error})`);
+        }
+        return true;
+    }
+    async run({ url }) {
+        const requestTimeStart = Date.now();
+        return {
+            data: (0, fs_1.createReadStream)(getPath(url)),
+            // This should always be after the creation of the read stream
+            requestTime: Date.now() - requestTimeStart,
+            exists: true,
+            url,
+        };
+    }
+}
+exports.ActorDereferenceFile = ActorDereferenceFile;
+const getPath = (url) => url.startsWith('file://') ? (0, url_1.fileURLToPath)(url) : url;
+//# sourceMappingURL=ActorDereferenceFile.js.map

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActorDereferenceFile"), exports);
+//# sourceMappingURL=index.js.map

package/package.json

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