@rdfc/js-runner 1.0.0 → 2.0.0-alpha.10

package/.husky/pre-commit

@@ -0,0 +1,6 @@
+echo Husky format!
+npm run format
+echo Husky Lint!
+npm run lint
+echo Husky Test!
+npm test

package/.idea/LNKD.tech Editor.xml

@@ -0,0 +1,194 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="http://lnkd.tech/editor#BuiltinGlobalGraphs">
+    <option name="disabled">
+      <set>
+        <option value="DC_AM" />
+        <option value="DC_E" />
+        <option value="DC_T" />
+        <option value="DC_TYPE" />
+        <option value="FOAF" />
+        <option value="FOAF_ORG" />
+        <option value="ML_XS" />
+        <option value="OWL2" />
+        <option value="RDF" />
+        <option value="RDFS" />
+        <option value="SHACL" />
+        <option value="SHACL_SHACL" />
+        <option value="SKOS" />
+        <option value="SKOS_ORG" />
+        <option value="SPIN_MODELING" />
+        <option value="SPIN_MODELING_ORG" />
+        <option value="SPIN_SPARQL" />
+        <option value="SPIN_SPARQL_ORG" />
+        <option value="SPIN_STD" />
+        <option value="SPIN_STD_ORG" />
+        <option value="VANN" />
+        <option value="VOAF" />
+        <option value="schemaorg_all_http" />
+        <option value="schemaorg_all_https" />
+      </set>
+    </option>
+  </component>
+  <component name="http://lnkd.tech/editor#GlobalGraphsAssignments">
+    <option name="assignments">
+      <map>
+        <entry key="urn:tag:lnslr.eu,2018:java:eu.lunisolar.lava.rdfvocab.get.lava.LavaCatalog">
+          <value>
+            <map>
+              <entry key="http://purl.org/dc/dcam">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/58ABCE836B2D0022BF4C4C921A8C34C6E2F4B4AB015C4649FCAFD9572ED4DB47" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://purl.org/dc/dcmitype">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/F987B11D556E556FEF95D7E9410C1C561FC1B7AC05CCD457128DC8962641B01E" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://purl.org/dc/elements/1.1">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/FFB46B7A21E40344B93BC4AD2E6808B24DD53E261995EC3A926DF6BCD87BBFA5" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://purl.org/dc/terms">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/13DF401072DD7015BF9D75162F3E41C8138075304B7B9CC1AA1E9C16DB976797" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://purl.org/vocab/vann">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/96DE3675A0EAE0C2979D58A21FB808417E0C75DA18EFB9FEB050135BBAC790CA" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://purl.org/vocommons/voaf">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/8FF39E5D8A3A8DBE88C790E499F2DAA0FC520CD825EBBE59E79A388361839150" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://schema.org">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/62854C817CF24454C9FC1D9DDB605C7B6A4FDE0FF574960D40B0E150166997B6" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://spinrdf.org/sp">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/FD2A599D1CE5D78A65896D5CE0A34553533715EE61388AD5F6E2AC75CF36FE94" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://spinrdf.org/spin">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/CC3E56C1F2BC6D4213BAF662C0A1FEB97ED968FA21D6C0ED7E44887747C74BC3" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://spinrdf.org/spl">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/EAD726323D0CC38A6FD1D332E1781E2601C32537102E82A0995E7FBA87BEF306" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://www.w3.org/1999/02/22-rdf-syntax-ns">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/93D52B1A5824C7DD6504CA79C16205C0B740A0BA68B7A14952780F52561186A2" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://www.w3.org/2000/01/rdf-schema">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/164A70B28D9AC4B828EEC7D9E4B548A9465A5E2C154D53A142CC5E18566E04EC" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://www.w3.org/2002/07/owl">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/718FA1DB7840D3315BFCE94398543F91437EF6FE933054FD93F5471D19262FC5" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://www.w3.org/2004/02/skos/core">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/2D0AC9174D7C53393C546802A19669534B44590EA00D807F4C149C6FFB4CF6BB" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://www.w3.org/ns/shacl">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/0E5D8AEA0EAB98A072D4A02FAAEE1EE914EC99EAB2CA473429726FAED4A13F69" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://www.w3.org/ns/shacl-shacl">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/250D6274CADC8FA5359D5DBC28BC943F1DE01ADB7FFC3369681216B583122E4A" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="http://xmlns.com/foaf/0.1">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/630DAF410F3C34ED9FE7302E4A8A5439488B68375789E7CF5DD137892DAC6789" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="https://schema.org">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/24D9BBA4119AA8C8708767B12B3BCACBC8BB8750CDB111F573996899AA29F089" />
+                  </set>
+                </value>
+              </entry>
+              <entry key="urn:tag:lnkd.tech,2020:MissingLink:XMLDataTypes">
+                <value>
+                  <set>
+                    <option value="urn:tag:lnkd.tech,2023:digest:sha-256/E7430AD6C9345DEC6A8C7E0665607B34D1F6B6FDC47A30FAC3FB146179213174" />
+                  </set>
+                </value>
+              </entry>
+            </map>
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+  <component name="http://lnkd.tech/editor#GraphVisibilityConfig">
+    <option name="visibility">
+      <map>
+        <entry key="DOCUMENTATION">
+          <value>
+            <Visibility />
+          </value>
+        </entry>
+        <entry key="GENERAL">
+          <value>
+            <Visibility />
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+</project>

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,52 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
+    </HTMLCodeStyleSettings>
+    <JSCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </TypeScriptCodeStyleSettings>
+    <VueCodeStyleSettings>
+      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
+      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
+    </VueCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="4" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="INDENT_CASE_FROM_SWITCH" value="false" />
+      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+      <option name="ALIGN_MULTILINE_FOR" value="false" />
+      <option name="SOFT_MARGINS" value="80" />
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="INDENT_CASE_FROM_SWITCH" value="false" />
+      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+      <option name="ALIGN_MULTILINE_FOR" value="false" />
+      <option name="SOFT_MARGINS" value="80" />
+    </codeStyleSettings>
+    <codeStyleSettings language="Vue">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="4" />
+        <option name="TAB_SIZE" value="4" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/js-runner.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.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/js-runner.iml" filepath="$PROJECT_DIR$/.idea/js-runner.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "semi": false
+}

package/README.md

@@ -1,40 +1,5 @@
-# Js-runner
+# RDFC-2 Javascript runner
 
-[![Build and tests with Node.js](https://github.com/rdf-connect/js-runner/actions/workflows/build-test.yml/badge.svg)](https://github.com/rdf-connect/js-runner/actions/workflows/build-test.yml) [![npm](https://img.shields.io/npm/v/@rdfc/js-runner.svg?style=popout)](https://npmjs.com/package/@rdfc/js-runner)
+Communitcates with the rdfc orchestrator though grpc.
 
-Typescript/Javascript executor for an [RDF-Connect](https://rdf-connect.github.io/rdfc.github.io/) pipeline. Starting from a declarative RDF file describing the pipeline.
-
-## Process definition
-
-Each js process must have `js:file`, `js:function` and `js:mapping` objects.
-
-- `js:file` points to the location of the main javascript file, containing the function.
-- `js:location` points to the starting location for `js:file` relative from the current file.
-- `js:function` points to the function name in the file.
-- `js:mapping` is a `fno:Mapping` object that links properties to function arguments.
-
-When you declare a new js process, it is required to add a SHACL shape.
-Each `sh:property` is accounted for, noting the type `sh:class` or `sh:datatype`.
-
-Example definitions are available in `processor/configs/*.ttl`.
-
-## Pipeline configuration
-
-In a js pipeline you can use all declared js processes, as defined in their SHACL shapes.
-
-An example can be found in `input.ttl`, here a `js:Send` process and a `js:Resc` process are defined.
-`js:Send` takes in a message to send, and a channel to send it to.
-`js:Resc` only takes a channel to read from.
-
-(implementation can be found in `procossor/test.js`)
-
-Note: currently Websockets are configured, but changing the configuration to use the JsReaderChannel and JsWriterChannel will work too, even without a serialization step.
-
-You can execute this pipeline with
-
-```bash
-tsc
-npx bin/js-runner.js input.ttl 
-```
-
-This example input configuration file uses `owl:imports` to specify additional configuration files.
+Take a look at the example pipeline at `./examples/echo/` for example processors and an example pipeline.

package/__tests__/channels.test.ts

@@ -0,0 +1,96 @@
+import { describe, expect, test } from 'vitest'
+import { ReaderInstance } from '../src/reader'
+import { one, uri, client, logger } from '../src/testUtils'
+
+const encoder = new TextEncoder()
+
+describe('Reader', async () => {
+  test('handles string', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const promise = one(reader.strings())
+    reader.handleMsg({ data: encoder.encode('Hello world'), channel: uri })
+    const out = await promise
+
+    expect(out).toEqual('Hello world')
+  })
+
+  test('handles closed string', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const promise = one(reader.strings())
+    reader.close()
+    const out = await promise
+
+    expect(out).toEqual(undefined)
+  })
+
+  test('handles strings', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const msgsPromise = (async () => {
+      const msgs: string[] = []
+      for await (const msg of reader.strings()) {
+        msgs.push(msg)
+      }
+      return msgs
+    })()
+    reader.handleMsg({ data: encoder.encode('Hello'), channel: uri })
+    reader.handleMsg({ data: encoder.encode('World'), channel: uri })
+    reader.close()
+
+    const msgs = await msgsPromise
+
+    expect(msgs).toEqual(['Hello', 'World'])
+  })
+
+  test('handles buffer', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const data = encoder.encode('Hello world')
+    const promise = one(reader.buffers())
+    reader.handleMsg({ data, channel: uri })
+    const out = await promise
+
+    expect(out).toEqual(data)
+  })
+
+  test('handles buffers', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const data = encoder.encode('Hello world')
+    const promise = one(reader.buffers())
+    reader.handleMsg({ data, channel: uri })
+    const out = await promise
+
+    expect(out).toEqual(data)
+  })
+
+  test('handles stream', async () => {
+    const reader = new ReaderInstance(uri, client, logger)
+
+    const nextStream = client.nextStream()
+    const promise = one(reader.streams())
+    reader.handleStreamingMessage({ id: { id: 5 }, channel: uri })
+    const stream = await nextStream
+
+    stream.push('Hello')
+    stream.push('World')
+    console.log(stream.eventNames())
+
+    const out = await promise
+    const msgsPromise = (async () => {
+      const msgs: Uint8Array[] = []
+      for await (const msg of out!) {
+        msgs.push(msg)
+      }
+      return msgs
+    })()
+
+    stream.emit('end')
+    stream.emit('close')
+
+    const msgs = await msgsPromise
+    console.log(msgs)
+  })
+})

package/bin/runner.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { start } from '../lib/client.js'
+
+const host = process.argv[2]
+const uri = process.argv[3]
+
+start(host, uri)

package/dist/args.d.ts

@@ -1,4 +1,4 @@
 export type Args = {
-    input: string;
-};
-export declare function getArgs(): Args;
+  input: string
+}
+export declare function getArgs(): Args

package/dist/args.js

@@ -1,59 +1,58 @@
-import commandLineArgs from "command-line-args";
-import commandLineUsage from "command-line-usage";
+import commandLineArgs from 'command-line-args'
+import commandLineUsage from 'command-line-usage'
 const optionDefinitions = [
-    {
-        name: "input",
-        type: String,
-        defaultOption: true,
-        summary: "Specify what input file to start up",
-    },
-    {
-        name: "help",
-        alias: "h",
-        type: Boolean,
-        description: "Display this help message",
-    },
-];
+  {
+    name: 'input',
+    type: String,
+    defaultOption: true,
+    summary: 'Specify what input file to start up',
+  },
+  {
+    name: 'help',
+    alias: 'h',
+    type: Boolean,
+    description: 'Display this help message',
+  },
+]
 const sections = [
-    {
-        header: "Js-runner",
-        content: "JS-runner is part of the {italic connector architecture}. Starting from an input file start up all JsProcessors that are defined. Please do not use blank nodes, skolemize your data somewhere else!",
-    },
-    {
-        header: "Synopsis",
-        content: "$ js-runner <input>",
-    },
-    {
-        header: "Command List",
-        content: [
-            { name: "input", summary: "Specify what input file to start up" },
-        ],
-    },
-    {
-        optionList: [optionDefinitions[1]],
-    },
-];
+  {
+    header: 'Js-runner',
+    content:
+      'JS-runner is part of the {italic connector architecture}. Starting from an input file start up all JsProcessors that are defined. Please do not use blank nodes, skolemize your data somewhere else!',
+  },
+  {
+    header: 'Synopsis',
+    content: '$ js-runner <input>',
+  },
+  {
+    header: 'Command List',
+    content: [
+      { name: 'input', summary: 'Specify what input file to start up' },
+    ],
+  },
+  {
+    optionList: [optionDefinitions[1]],
+  },
+]
 function validArgs(args) {
-    if (!args.input)
-        return false;
-    return true;
+  if (!args.input) return false
+  return true
 }
 function printUsage() {
-    const usage = commandLineUsage(sections);
-    console.log(usage);
-    process.exit(0);
+  const usage = commandLineUsage(sections)
+  console.log(usage)
+  process.exit(0)
 }
 export function getArgs() {
-    let args;
-    try {
-        args = commandLineArgs(optionDefinitions);
-    }
-    catch (e) {
-        console.error(e);
-        printUsage();
-    }
-    if (args.help || !validArgs(args)) {
-        printUsage();
-    }
-    return args;
+  let args
+  try {
+    args = commandLineArgs(optionDefinitions)
+  } catch (e) {
+    console.error(e)
+    printUsage()
+  }
+  if (args.help || !validArgs(args)) {
+    printUsage()
+  }
+  return args
 }

package/dist/connectors/file.d.ts

@@ -1,15 +1,15 @@
-import { ReaderConstructor, WriterConstructor } from "../connectors.js";
+import { ReaderConstructor, WriterConstructor } from '../connectors.js'
 export interface FileReaderConfig {
-    path: string;
-    onReplace: boolean;
-    readFirstContent?: boolean;
-    encoding?: string;
+  path: string
+  onReplace: boolean
+  readFirstContent?: boolean
+  encoding?: string
 }
 export interface FileWriterConfig {
-    path: string;
-    onReplace: boolean;
-    readFirstContent?: boolean;
-    encoding?: string;
+  path: string
+  onReplace: boolean
+  readFirstContent?: boolean
+  encoding?: string
 }
-export declare const startFileStreamReader: ReaderConstructor<FileReaderConfig>;
-export declare const startFileStreamWriter: WriterConstructor<FileWriterConfig>;
+export declare const startFileStreamReader: ReaderConstructor<FileReaderConfig>
+export declare const startFileStreamWriter: WriterConstructor<FileWriterConfig>