@rdfc/js-runner 2.0.0-alpha.6 → 2.0.0-alpha.8

package/.editorconfig

@@ -0,0 +1,9 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

package/__tests__/channels.test.js

@@ -0,0 +1,117 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const reader_1 = require("../src/reader");
+const testUtils_1 = require("../src/testUtils");
+const encoder = new TextEncoder();
+(0, vitest_1.describe)('Reader', () => __awaiter(void 0, void 0, void 0, function* () {
+    (0, vitest_1.test)('handles string', () => __awaiter(void 0, void 0, void 0, function* () {
+        const reader = new reader_1.ReaderInstance(testUtils_1.uri, testUtils_1.client, testUtils_1.logger);
+        const promise = (0, testUtils_1.one)(reader.strings());
+        reader.handleMsg({ data: encoder.encode('Hello world'), channel: testUtils_1.uri });
+        const out = yield promise;
+        (0, vitest_1.expect)(out).toEqual('Hello world');
+    }));
+    (0, vitest_1.test)('handles closed string', () => __awaiter(void 0, void 0, void 0, function* () {
+        const reader = new reader_1.ReaderInstance(testUtils_1.uri, testUtils_1.client, testUtils_1.logger);
+        const promise = (0, testUtils_1.one)(reader.strings());
+        reader.close();
+        const out = yield promise;
+        (0, vitest_1.expect)(out).toEqual(undefined);
+    }));
+    (0, vitest_1.test)('handles strings', () => __awaiter(void 0, void 0, void 0, function* () {
+        const reader = new reader_1.ReaderInstance(testUtils_1.uri, testUtils_1.client, testUtils_1.logger);
+        const msgsPromise = (() => __awaiter(void 0, void 0, void 0, function* () {
+            var _a, e_1, _b, _c;
+            const msgs = [];
+            try {
+                for (var _d = true, _e = __asyncValues(reader.strings()), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                    _c = _f.value;
+                    _d = false;
+                    const msg = _c;
+                    msgs.push(msg);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            return msgs;
+        }))();
+        reader.handleMsg({ data: encoder.encode('Hello'), channel: testUtils_1.uri });
+        reader.handleMsg({ data: encoder.encode('World'), channel: testUtils_1.uri });
+        reader.close();
+        const msgs = yield msgsPromise;
+        (0, vitest_1.expect)(msgs).toEqual(['Hello', 'World']);
+    }));
+    (0, vitest_1.test)('handles buffer', () => __awaiter(void 0, void 0, void 0, function* () {
+        const reader = new reader_1.ReaderInstance(testUtils_1.uri, testUtils_1.client, testUtils_1.logger);
+        const data = encoder.encode('Hello world');
+        const promise = (0, testUtils_1.one)(reader.buffers());
+        reader.handleMsg({ data, channel: testUtils_1.uri });
+        const out = yield promise;
+        (0, vitest_1.expect)(out).toEqual(data);
+    }));
+    (0, vitest_1.test)('handles buffers', () => __awaiter(void 0, void 0, void 0, function* () {
+        const reader = new reader_1.ReaderInstance(testUtils_1.uri, testUtils_1.client, testUtils_1.logger);
+        const data = encoder.encode('Hello world');
+        const promise = (0, testUtils_1.one)(reader.buffers());
+        reader.handleMsg({ data, channel: testUtils_1.uri });
+        const out = yield promise;
+        (0, vitest_1.expect)(out).toEqual(data);
+    }));
+    (0, vitest_1.test)('handles stream', () => __awaiter(void 0, void 0, void 0, function* () {
+        const reader = new reader_1.ReaderInstance(testUtils_1.uri, testUtils_1.client, testUtils_1.logger);
+        const nextStream = testUtils_1.client.nextStream();
+        const promise = (0, testUtils_1.one)(reader.streams());
+        reader.handleStreamingMessage({ id: { id: 5 }, channel: testUtils_1.uri });
+        const stream = yield nextStream;
+        stream.push('Hello');
+        stream.push('World');
+        console.log(stream.eventNames());
+        const out = yield promise;
+        const msgsPromise = (() => __awaiter(void 0, void 0, void 0, function* () {
+            var _a, e_2, _b, _c;
+            const msgs = [];
+            try {
+                for (var _d = true, _e = __asyncValues(out), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                    _c = _f.value;
+                    _d = false;
+                    const msg = _c;
+                    msgs.push(msg);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+            return msgs;
+        }))();
+        stream.emit('end');
+        stream.emit('close');
+        const msgs = yield msgsPromise;
+        console.log(msgs);
+    }));
+}));

package/examples/echo/.idea/echo.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/examples/echo/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_23" project-jdk-name="24" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/examples/echo/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/echo.iml" filepath="$PROJECT_DIR$/.idea/echo.iml" />
+    </modules>
+  </component>
+</project>

package/examples/echo/.idea/vcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/../.." vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/node_modules/@rdfc/js-runner" vcs="Git" />
+  </component>
+</project>

package/examples/echo/.swls/config.json

@@ -0,0 +1 @@
+{ "disabled": ["shapes"] }

package/examples/echo/index.ttl

@@ -0,0 +1,3 @@
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+<#me> a foaf:Person;
+    foaf:name "".

package/examples/echo/minimal.ttl

@@ -0,0 +1,90 @@
+@prefix rdfc: <https://w3id.org/rdf-connect#>.
+@prefix prov: <http://www.w3.org/ns/prov#>.
+@prefix sds: <https://w3id.org/sds#>.
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
+@prefix owl: <http://www.w3.org/2002/07/owl#>.
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix sh: <http://www.w3.org/ns/shacl#>.
+
+############################################################
+#                    General statements                    #
+############################################################
+# sds:Activity is a prov:Activity
+sds:Activity rdfs:subClassOf prov:Activity.
+
+# rdfc:Processor too
+rdfc:Processor rdfs:subClassOf sds:Activity.
+
+# sds:implementationOf is subClassOf
+sds:implementationOf rdfs:subPropertyOf rdfs:subClassOf.
+
+############################################################
+#                   Javascript statements                  #
+############################################################
+# specialized for js too
+rdfc:jsImplementationOf rdfs:subPropertyOf sds:implementationOf.
+
+# A node runner, runs things that are rdfc:jsImplementationOf rdfc:Processor  (aka, rdfs:subClassOf prov:Activity)
+rdfc:NodeRunner a rdfc:Runner;
+  rdfc:handlesSubjectsOf rdfc:jsImplementationOf;
+  rdfc:command "npx js-runner".
+
+# Shape that a Js Processor should fulfil;
+[ ] a sh:NodeShape;
+  # We target it with jsImplementationOf
+  sh:targetSubjectsOf rdfc:jsImplementationOf;
+  sh:property [
+    sh:path rdfc:entrypoint;
+    sh:name "location";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:datatype xsd:string;
+  ], [
+    sh:path rdfc:file;
+    sh:name "file";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:datatype xsd:string;
+  ], [
+    sh:path rdfc:class;
+    sh:name "clazz";
+    sh:maxCount 1;
+    sh:datatype xsd:string;
+  ].
+
+############################################################
+#                   Processor statements                   #
+############################################################
+rdfc:FooBarProcessor a owl:Class, rdfs:Class;
+  rdfc:jsImplementationOf rdfc:Processor;
+  rdfs:label "My Epic FooBar Processor";
+  rdfs:description "FooBars everything!";
+  rdfc:entrypoint <./>;
+  rdfc:file <./lib/processors.js>;
+  rdfc:class "FooBarProcessor".
+
+[ ] a sh:NodeShape;
+  sh:targetClass rdfc:FooBarProcessor;
+  sh:property [
+    sh:path rdfc:reader;
+    sh:name "reader";
+    sh:minCount 1;
+    sh:maxCount 1;
+    sh:class rdfc:Reader;
+  ].
+
+############################################################
+#                    Pipeline statements                   #
+############################################################
+<> a rdfc:Pipeline;
+  rdfc:consistsOf [
+    rdfc:instantiates rdfc:NodeRunner;
+    rdfc:processor <foobar>;
+  ].
+
+# <incomingMessages> a rdfc:Reader.
+<incomingMessages> a rdfc:Reader.
+
+<fooBar> a rdfc:FooBarProcessor;
+  rdfc:reader <incomingMessages>.
+

package/examples/echo/pipeline.ttl

@@ -1,14 +1,32 @@
 @prefix owl: <http://www.w3.org/2002/07/owl#>.
-@prefix rdfc: <https://w3id.org/rdf-connect/ontology#>.
+@prefix rdfc: <https://w3id.org/rdf-connect#>.
 
 <> owl:imports <./processors.ttl>.
 <> a rdfc:Pipeline;
-  rdfc:dependency <>;
-  rdfc:processor <sender>, <echo>, <log>, <test>;
-  rdfc:runner rdfc:JsRunner.
+  rdfc:consistsOf [
+    rdfc:instantiates rdfc:NodeRunner;
+    rdfc:processor <sender>, <echo>, <log>;
+  ].
 
+# <> a rdfc:Pipeline;
+#   rdfc:dependency <>;
+#   rdfc:processor <sender>, <echo>, <log>;
+#   rdfc:runner rdfc:JsRunner;
+#   rdfc:consistsOf [
+#     rdfc:instantiates rdfc:BunRunner;
+#     rdfc:processor <log>;
+#   ], [
+#     rdfc:instantiates rdfc:AnyRunner;
+#     rdfc:processor <echo>, <test>;
+#     rdfc:via [
+#       a rdfc:HttpEndpoint;
+#       rdfc:url "http://myRemote:5000/";
+#     ];
+#   ].
 <1> a rdfc:Writer, rdfc:Reader.
+
 <2> a rdfc:Writer, rdfc:Reader.
+#
 <sender> a rdfc:SendProcessor;
   rdfc:writer <1>;
   rdfc:msg "hallo", "world".

package/examples/echo/processors.ttl

@@ -5,11 +5,10 @@
 @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
 @prefix sh: <http://www.w3.org/ns/shacl#>.
-@prefix rdfc: <https://w3id.org/rdf-connect/ontology#>.
+@prefix rdfc: <https://w3id.org/rdf-connect#>.
 
 <> owl:imports <../../index.ttl>.
-
-rdfc:Test a rdfc:JsProcessor;
+rdfc:Test rdfc:jsImplementationOf rdfc:Processor;
   rdfc:entrypoint <./>;
   rdfc:file <./lib/processors.js>;
   rdfc:class "TestProcessor".
@@ -26,8 +25,7 @@ rdfc:Test a rdfc:JsProcessor;
     sh:class rdfl:CBD;
   ].
 
-
-rdfc:EchoProcessor a rdfc:JsProcessor, owl:Class;
+rdfc:EchoProcessor rdfc:jsImplementationOf rdfc:Processor;
   rdfc:entrypoint <./>;
   rdfc:file <./lib/processors.js>;
   rdfc:class "EchoProcessor".
@@ -48,7 +46,7 @@ rdfc:EchoProcessor a rdfc:JsProcessor, owl:Class;
     sh:class rdfc:Writer;
   ].
 
-rdfc:LogProcessor a rdfc:JsProcessor;
+rdfc:LogProcessor rdfc:jsImplementationOf rdfc:Processor;
   rdfc:entrypoint <./>;
   rdfc:file <./lib/processors.js>;
   rdfc:class "LogProcessor".
@@ -63,7 +61,7 @@ rdfc:LogProcessor a rdfc:JsProcessor;
     sh:class rdfc:Reader;
   ].
 
-rdfc:SendProcessor a rdfc:JsProcessor;
+rdfc:SendProcessor rdfc:jsImplementationOf rdfc:Processor;
   rdfc:entrypoint <./>;
   rdfc:file <./lib/processors.js>;
   rdfc:class "SendProcessor".

package/examples/echo/shacl.ttl

@@ -0,0 +1,9 @@
+
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+@prefix sh: <http://www.w3.org/ns/shacl#>.
+[] a sh:NodeShape;
+  sh:targetClass foaf:Person;
+  sh:property [
+    sh:path foaf:name;
+    sh:minCount 1;
+  ].