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

package/dist/index.d.ts

@@ -1,33 +1,42 @@
-import { Quad, Term } from "@rdfjs/types";
-import { Shapes } from "rdf-lens";
-export * from "./connectors.js";
+import { Quad, Term } from '@rdfjs/types'
+import { Shapes } from 'rdf-lens'
+export * from './connectors.js'
 type Processor = {
-    ty: Term;
-    file: string;
-    location: string;
-    func: string;
-    mapping: {
-        parameters: {
-            parameter: string;
-            position: number;
-        }[];
-    };
-};
-export type Source = {
-    type: "remote";
-    location: string;
-} | {
-    type: "memory";
-    value: string;
-    baseIRI: string;
-};
+  ty: Term
+  file: string
+  location: string
+  func: string
+  mapping: {
+    parameters: {
+      parameter: string
+      position: number
+    }[]
+  }
+}
+export type Source =
+  | {
+      type: 'remote'
+      location: string
+    }
+  | {
+      type: 'memory'
+      value: string
+      baseIRI: string
+    }
 export type Extracted = {
-    processors: Processor[];
-    quads: Quad[];
-    shapes: Shapes;
-};
-export declare function extractProcessors(source: Source, apply?: {
-    [label: string]: (item: any) => any;
-}): Promise<Extracted>;
-export declare function extractSteps(proc: Processor, quads: Quad[], config: Shapes): any[][];
-export declare function jsRunner(): Promise<void>;
+  processors: Processor[]
+  quads: Quad[]
+  shapes: Shapes
+}
+export declare function extractProcessors(
+  source: Source,
+  apply?: {
+    [label: string]: (item: any) => any
+  },
+): Promise<Extracted>
+export declare function extractSteps(
+  proc: Processor,
+  quads: Quad[],
+  config: Shapes,
+): any[][]
+export declare function jsRunner(): Promise<void>

package/dist/index.js

@@ -1,74 +1,83 @@
-import { Store } from "n3";
-import { getArgs } from "./args.js";
-import { load_store, LOG } from "./util.js";
-import path from "path";
-import { RDF } from "@treecg/types";
-import { ChannelFactory, Conn, JsOntology } from "./connectors.js";
-import { envReplace, extractShapes } from "rdf-lens";
-export * from "./connectors.js";
+import { Store } from 'n3'
+import { getArgs } from './args.js'
+import { load_store, LOG } from './util.js'
+import path from 'path'
+import { RDF } from '@treecg/types'
+import { ChannelFactory, Conn, JsOntology } from './connectors.js'
+import { envReplace, extractShapes } from 'rdf-lens'
+export * from './connectors.js'
 function safeJoin(a, b) {
-    if (b.startsWith("/")) {
-        return b;
-    }
-    return path.join(a, b);
+  if (b.startsWith('/')) {
+    return b
+  }
+  return path.join(a, b)
 }
 export async function extractProcessors(source, apply) {
-    const store = new Store();
-    await load_store(source, store);
-    const quads = store.getQuads(null, null, null, null);
-    const config = extractShapes(quads, apply);
-    const subjects = quads
-        .filter((x) => x.predicate.equals(RDF.terms.type) &&
-        x.object.equals(JsOntology.JsProcess))
-        .map((x) => x.subject);
-    const processorLens = config.lenses[JsOntology.JsProcess.value];
-    const processors = subjects.map((id) => processorLens.execute({ id, quads }));
-    const newQuads = envReplace().execute(quads);
-    return { processors, quads: newQuads, shapes: config };
+  const store = new Store()
+  await load_store(source, store)
+  const quads = store.getQuads(null, null, null, null)
+  const config = extractShapes(quads, apply)
+  const subjects = quads
+    .filter(
+      (x) =>
+        x.predicate.equals(RDF.terms.type) &&
+        x.object.equals(JsOntology.JsProcess),
+    )
+    .map((x) => x.subject)
+  const processorLens = config.lenses[JsOntology.JsProcess.value]
+  const processors = subjects.map((id) => processorLens.execute({ id, quads }))
+  const newQuads = envReplace().execute(quads)
+  return { processors, quads: newQuads, shapes: config }
 }
 export function extractSteps(proc, quads, config) {
-    const out = [];
-    const subjects = quads
-        .filter((x) => x.predicate.equals(RDF.terms.type) && x.object.equals(proc.ty))
-        .map((x) => x.subject);
-    const processorLens = config.lenses[proc.ty.value];
-    const fields = proc.mapping.parameters;
-    for (const id of subjects) {
-        const obj = processorLens.execute({ id, quads });
-        const functionArgs = new Array(fields.length);
-        for (const field of fields) {
-            functionArgs[field.position] = obj[field.parameter];
-        }
-        out.push(functionArgs);
+  const out = []
+  const subjects = quads
+    .filter(
+      (x) => x.predicate.equals(RDF.terms.type) && x.object.equals(proc.ty),
+    )
+    .map((x) => x.subject)
+  const processorLens = config.lenses[proc.ty.value]
+  const fields = proc.mapping.parameters
+  for (const id of subjects) {
+    const obj = processorLens.execute({ id, quads })
+    const functionArgs = new Array(fields.length)
+    for (const field of fields) {
+      functionArgs[field.position] = obj[field.parameter]
     }
-    return out;
+    out.push(functionArgs)
+  }
+  return out
 }
 export async function jsRunner() {
-    const args = getArgs();
-    const cwd = process.cwd();
-    const source = {
-        location: safeJoin(cwd, args.input).replaceAll("\\", "/"),
-        type: "remote",
-    };
-    const factory = new ChannelFactory();
-    const apply = {};
-    apply[Conn.ReaderChannel.value] = factory.createReader.bind(factory);
-    apply[Conn.WriterChannel.value] = factory.createWriter.bind(factory);
-    const { processors, quads, shapes: config, } = await extractProcessors(source, apply);
-    LOG.main("Found %d processors", processors.length);
-    const starts = [];
-    for (const proc of processors) {
-        const argss = extractSteps(proc, quads, config);
-        const jsProgram = await import("file://" + proc.file);
-        process.chdir(proc.location);
-        for (const args of argss) {
-            starts.push(await jsProgram[proc.func](...args));
-        }
+  const args = getArgs()
+  const cwd = process.cwd()
+  const source = {
+    location: safeJoin(cwd, args.input).replaceAll('\\', '/'),
+    type: 'remote',
+  }
+  const factory = new ChannelFactory()
+  const apply = {}
+  apply[Conn.ReaderChannel.value] = factory.createReader.bind(factory)
+  apply[Conn.WriterChannel.value] = factory.createWriter.bind(factory)
+  const {
+    processors,
+    quads,
+    shapes: config,
+  } = await extractProcessors(source, apply)
+  LOG.main('Found %d processors', processors.length)
+  const starts = []
+  for (const proc of processors) {
+    const argss = extractSteps(proc, quads, config)
+    const jsProgram = await import('file://' + proc.file)
+    process.chdir(proc.location)
+    for (const args of argss) {
+      starts.push(await jsProgram[proc.func](...args))
     }
-    await factory.init();
-    for (const s of starts) {
-        if (s && typeof s === "function") {
-            s();
-        }
+  }
+  await factory.init()
+  for (const s of starts) {
+    if (s && typeof s === 'function') {
+      s()
     }
+  }
 }

package/dist/util.d.ts

@@ -1,43 +1,71 @@
-import stream from "stream";
-import { Store } from "n3";
-import { Source } from "./index.js";
-import { Quad, Term } from "@rdfjs/types";
-import debug from "debug";
+import stream from 'stream'
+import { Store } from 'n3'
+import { Source } from './index.js'
+import { Quad, Term } from '@rdfjs/types'
+import debug from 'debug'
 export declare const LOG: {
-    main: debug.Debugger;
-    channel: debug.Debugger;
-    util: debug.Debugger;
-};
-export declare function toArray<T>(stream: stream.Readable): Promise<T[]>;
+  main: debug.Debugger
+  channel: debug.Debugger
+  util: debug.Debugger
+}
+export declare function toArray<T>(stream: stream.Readable): Promise<T[]>
 export declare const OWL: {
-    namespace: string;
-    custom: (input: string) => string;
+  namespace: string
+  custom: (input: string) => string
 } & {
-    imports: string;
+  imports: string
 } & {
-    terms: import("@treecg/types").Namespace<"imports"[], import("@rdfjs/types").NamedNode<string>, string>;
-};
+  terms: import('@treecg/types').Namespace<
+    'imports'[],
+    import('@rdfjs/types').NamedNode<string>,
+    string
+  >
+}
 export declare const CONN2: {
-    namespace: string;
-    custom: (input: string) => string;
+  namespace: string
+  custom: (input: string) => string
 } & {
-    install: string;
-    build: string;
-    GitInstall: string;
-    LocalInstall: string;
-    url: string;
-    procFile: string;
-    path: string;
-    EnvVariable: string;
-    envKey: string;
-    envDefault: string;
+  install: string
+  build: string
+  GitInstall: string
+  LocalInstall: string
+  url: string
+  procFile: string
+  path: string
+  EnvVariable: string
+  envKey: string
+  envDefault: string
 } & {
-    terms: import("@treecg/types").Namespace<("install" | "build" | "GitInstall" | "LocalInstall" | "url" | "procFile" | "path" | "EnvVariable" | "envKey" | "envDefault")[], import("@rdfjs/types").NamedNode<string>, string>;
-};
-export declare const namedNode: <Iri extends string = string>(value: Iri) => import("n3").NamedNode<Iri>;
+  terms: import('@treecg/types').Namespace<
+    (
+      | 'install'
+      | 'build'
+      | 'GitInstall'
+      | 'LocalInstall'
+      | 'url'
+      | 'procFile'
+      | 'path'
+      | 'EnvVariable'
+      | 'envKey'
+      | 'envDefault'
+    )[],
+    import('@rdfjs/types').NamedNode<string>,
+    string
+  >
+}
+export declare const namedNode: <Iri extends string = string>(
+  value: Iri,
+) => import('n3').NamedNode<Iri>
 export type Keyed<T> = {
-    [Key in keyof T]: Term | undefined;
-};
-export type Map<V, K, T, O> = (value: V, key: K, item: T) => O;
-export declare function load_quads(location: string, baseIRI?: string): Promise<Quad[]>;
-export declare function load_store(location: Source, store: Store, recursive?: boolean): Promise<void>;
+  [Key in keyof T]: Term | undefined
+}
+export type Map<V, K, T, O> = (value: V, key: K, item: T) => O
+export declare function load_quads(
+  location: string,
+  baseIRI?: string,
+): Promise<Quad[]>
+export declare function load_store(
+  location: Source,
+  store: Store,
+  recursive?: boolean,
+): Promise<void>

package/dist/util.js

@@ -1,75 +1,92 @@
-import { createReadStream } from "fs";
-import http from "http";
-import https from "https";
-import { DataFactory, Parser, StreamParser } from "n3";
-import { createUriAndTermNamespace } from "@treecg/types";
-import debug from "debug";
+import { createReadStream } from 'fs'
+import http from 'http'
+import https from 'https'
+import { DataFactory, Parser, StreamParser } from 'n3'
+import { createUriAndTermNamespace } from '@treecg/types'
+import debug from 'debug'
 export const LOG = (function () {
-    const main = debug("js-runner");
-    const channel = main.extend("channel");
-    const util = main.extend("util");
-    return { main, channel, util };
-})();
+  const main = debug('js-runner')
+  const channel = main.extend('channel')
+  const util = main.extend('util')
+  return { main, channel, util }
+})()
 export function toArray(stream) {
-    const output = [];
-    return new Promise((res, rej) => {
-        stream.on("data", (x) => output.push(x));
-        stream.on("end", () => res(output));
-        stream.on("close", () => res(output));
-        stream.on("error", rej);
-    });
+  const output = []
+  return new Promise((res, rej) => {
+    stream.on('data', (x) => output.push(x))
+    stream.on('end', () => res(output))
+    stream.on('close', () => res(output))
+    stream.on('error', rej)
+  })
 }
-export const OWL = createUriAndTermNamespace("http://www.w3.org/2002/07/owl#", "imports");
-export const CONN2 = createUriAndTermNamespace("https://w3id.org/conn#", "install", "build", "GitInstall", "LocalInstall", "url", "procFile", "path", "EnvVariable", "envKey", "envDefault");
-export const { namedNode } = DataFactory;
+export const OWL = createUriAndTermNamespace(
+  'http://www.w3.org/2002/07/owl#',
+  'imports',
+)
+export const CONN2 = createUriAndTermNamespace(
+  'https://w3id.org/conn#',
+  'install',
+  'build',
+  'GitInstall',
+  'LocalInstall',
+  'url',
+  'procFile',
+  'path',
+  'EnvVariable',
+  'envKey',
+  'envDefault',
+)
+export const { namedNode } = DataFactory
 async function get_readstream(location) {
-    if (location.startsWith("https")) {
-        return new Promise((res) => {
-            https.get(location, res);
-        });
-    }
-    else if (location.startsWith("http")) {
-        return new Promise((res) => {
-            http.get(location, res);
-        });
-    }
-    else {
-        return createReadStream(location);
-    }
+  if (location.startsWith('https')) {
+    return new Promise((res) => {
+      https.get(location, res)
+    })
+  } else if (location.startsWith('http')) {
+    return new Promise((res) => {
+      http.get(location, res)
+    })
+  } else {
+    return createReadStream(location)
+  }
 }
 export async function load_quads(location, baseIRI) {
-    try {
-        LOG.util("Loading quads %s", location);
-        const parser = new StreamParser({ baseIRI: baseIRI || location });
-        const rdfStream = await get_readstream(location);
-        rdfStream.pipe(parser);
-        const quads = await toArray(parser);
-        return quads;
-    }
-    catch (ex) {
-        console.error("Failed to load_quads", location, baseIRI);
-        console.error(ex);
-        return [];
-    }
+  try {
+    LOG.util('Loading quads %s', location)
+    const parser = new StreamParser({ baseIRI: baseIRI || location })
+    const rdfStream = await get_readstream(location)
+    rdfStream.pipe(parser)
+    const quads = await toArray(parser)
+    return quads
+  } catch (ex) {
+    console.error('Failed to load_quads', location, baseIRI)
+    console.error(ex)
+    return []
+  }
 }
 function load_memory_quads(value, baseIRI) {
-    const parser = new Parser({ baseIRI });
-    return parser.parse(value);
+  const parser = new Parser({ baseIRI })
+  return parser.parse(value)
 }
-const loaded = new Set();
+const loaded = new Set()
 export async function load_store(location, store, recursive = true) {
-    if (loaded.has(location))
-        return;
-    loaded.add(location);
-    const quads = location.type === "remote"
-        ? await load_quads(location.location)
-        : load_memory_quads(location.value, location.baseIRI);
-    store.addQuads(quads);
-    if (recursive) {
-        const loc = location.type === "remote" ? location.location : location.baseIRI;
-        const other_imports = store.getObjects(namedNode(loc), OWL.terms.imports, null);
-        for (const other of other_imports) {
-            await load_store({ location: other.value, type: "remote" }, store, true);
-        }
+  if (loaded.has(location)) return
+  loaded.add(location)
+  const quads =
+    location.type === 'remote'
+      ? await load_quads(location.location)
+      : load_memory_quads(location.value, location.baseIRI)
+  store.addQuads(quads)
+  if (recursive) {
+    const loc =
+      location.type === 'remote' ? location.location : location.baseIRI
+    const other_imports = store.getObjects(
+      namedNode(loc),
+      OWL.terms.imports,
+      null,
+    )
+    for (const other of other_imports) {
+      await load_store({ location: other.value, type: 'remote' }, store, true)
     }
+  }
 }

package/eslint.config.mjs

@@ -0,0 +1,21 @@
+import globals from 'globals'
+import pluginJs from '@eslint/js'
+import tseslint from 'typescript-eslint'
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    files: ['src/**/*.{js,mjs,cjs,ts}'],
+  },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    ignores: ['src/generated/', '**/lib/', 'coverage/'],
+  },
+  {
+    languageOptions: {
+      globals: { process: 'readable' },
+    },
+  },
+]

package/examples/echo/package-lock.json

@@ -0,0 +1,80 @@
+{
+  "name": "echo",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "echo",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "@rdfc/js-runner": "file:../.."
+      },
+      "devDependencies": {
+        "typescript": "^5.8.2"
+      }
+    },
+    "../..": {
+      "name": "@rdfc/js-runner",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "@grpc/grpc-js": "^1.12.6",
+        "@rdfc/proto": "^0.1.1",
+        "@treecg/types": "^0.4.6",
+        "jsonld": "^8.3.3",
+        "jsonld-streaming-parser": "^5.0.0",
+        "n3": "^1.23.1",
+        "rdf-lens": "^1.3.5",
+        "winston": "^3.17.0",
+        "winston-transport": "^4.9.0"
+      },
+      "bin": {
+        "js-runner": "bin/runner.js"
+      },
+      "devDependencies": {
+        "@eslint/js": "^9.21.0",
+        "@rdfjs/types": "^2.0.1",
+        "@types/jest": "^29.5.14",
+        "@types/jsonld": "^1.5.15",
+        "@types/n3": "^1.21.1",
+        "@types/node": "^22.13.5",
+        "@typescript-eslint/eslint-plugin": "^8.25.0",
+        "@typescript-eslint/parser": "^8.25.0",
+        "@vitest/coverage-v8": "^3.0.7",
+        "eslint": "^9.21.0",
+        "eslint-config-prettier": "^10.0.1",
+        "eslint-plugin-prettier": "^5.2.3",
+        "globals": "^16.0.0",
+        "husky": "^9.1.7",
+        "jest": "^29.7.0",
+        "lint-staged": "^15.4.3",
+        "prettier": "^3.5.2",
+        "ts-jest": "^29.2.6",
+        "tsc-alias": "^1.8.10",
+        "typescript": "^5.7.3",
+        "typescript-eslint": "^8.25.0",
+        "vitest": "^3.0.7"
+      }
+    },
+    "node_modules/@rdfc/js-runner": {
+      "resolved": "../..",
+      "link": true
+    },
+    "node_modules/typescript": {
+      "version": "5.8.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.2.tgz",
+      "integrity": "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    }
+  }
+}

package/examples/echo/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "echo",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "@rdfc/js-runner": "file:../.."
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2"
+  }
+}

package/examples/echo/pipeline.ttl

@@ -0,0 +1,48 @@
+@prefix owl: <http://www.w3.org/2002/07/owl#>.
+@prefix rdfc: <https://w3id.org/rdf-connect#>.
+
+<> owl:imports <./processors.ttl>.
+<> a rdfc:Pipeline;
+  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".
+
+<echo> a rdfc:EchoProcessor;
+  rdfc:reader <1>;
+  rdfc:writer <2>.
+
+<log> a rdfc:LogProcessor;
+  rdfc:reader <2>.
+
+<test> a rdfc:Test;
+  rdfc:path ( <a> <b> );
+  rdfc:path "help";
+  rdfc:cbd [
+    a rdfc:Something;
+    rdfc:else [ a rdfc:SomethingElse ];
+  ].
+