@rdfc/js-runner 3.0.0 → 3.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rdfc/js-runner",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "main": "lib/index.js",
   "type": "module",
   "scripts": {
@@ -29,38 +29,38 @@
   "license": "ISC",
   "description": "",
   "devDependencies": {
-    "@eslint/js": "^9.21.0",
+    "@eslint/js": "^9.39.2",
     "@rdfjs/types": "^2.0.1",
-    "@grpc/grpc-js": "^1.12.6",
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^30.0.0",
     "@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.2.4",
+    "@types/n3": "^1.26.1",
+    "@types/node": "^24.10.9",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "@vitest/coverage-v8": "^4.0.18",
     "eslint": "^9.21.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "globals": "^16.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^17.3.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.2.4"
+    "jest": "^30.2.0",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.8.1",
+    "ts-jest": "^29.4.6",
+    "tsc-alias": "^1.8.16",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
+    "@grpc/grpc-js": "^1.14.3",
     "@rdfc/proto": "^0.1.2",
     "@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",
+    "jsonld": "^9.0.0",
+    "jsonld-streaming-parser": "^5.0.1",
+    "n3": "^2.0.1",
+    "rdf-lens": "^1.3.6",
+    "winston": "^3.19.0",
     "winston-transport": "^4.9.0"
   }
 }

package/src/reader.ts

@@ -18,14 +18,14 @@ import { promisify } from 'util'
 
 export type Any =
   | {
-      string: string
-    }
+    string: string
+  }
   | {
-      stream: AsyncGenerator<Uint8Array>
-    }
+    stream: AsyncGenerator<Uint8Array>
+  }
   | {
-      buffer: Uint8Array
-    }
+    buffer: Uint8Array
+  }
 
 export interface Reader {
   readonly uri: string
@@ -68,7 +68,7 @@ class MyIter<T> implements AsyncIterable<T> {
 
   async pushStream(chunks: AsyncIterable<DataChunk>, onComplete: () => void) {
     // This is an async generator that transforms DataChunks to Buffers
-    const stream = (async function* (stream) {
+    const stream = (async function*(stream) {
       for await (const chunk of stream) {
         yield chunk.data
       }
@@ -165,7 +165,7 @@ export class ReaderInstance implements Reader {
 
   close() {
     for (const iter of this.consumers) {
-      iter.close(() => {})
+      iter.close(() => { })
     }
   }
 

package/src/runner.ts

@@ -47,8 +47,7 @@ type ProcessorConfig = {
   clazz?: string
 }
 
-export type FullProc<C extends Proc<unknown>> =
-  C extends Proc<infer T> ? T & C : unknown
+export type FullProc<C> = C extends Proc<infer T> ? T & C : never
 export class Runner {
   private readonly readers: { [uri: string]: ReaderInstance } = {}
   private readonly writers: { [uri: string]: WriterInstance } = {}
@@ -75,7 +74,7 @@ export class Runner {
     this.logger = logger
   }
 
-  async addProcessor<P extends Proc<unknown>>(
+  async createProcessor<P extends Proc<unknown>>(
     proc: Processor,
   ): Promise<FullProc<P>> {
     const procLogger = createLogger({
@@ -94,7 +93,7 @@ export class Runner {
       )
       .map((x) => x.object.value)
 
-    this.logger.info('parsing ' + proc.uri + ' type ' + ty)
+    this.logger.info(`Parsing processor '${proc.uri}' of type(s) [${ty.join(', ')}]`)
     const args = this.shapes.lenses[RDFL.TypedExtract].execute({
       id: new NamedNode(proc.uri),
       quads: this.quads,
@@ -104,9 +103,18 @@ export class Runner {
     const jsProgram = await import(config.file)
     const clazz = jsProgram[config.clazz || 'default']
     const instance: Proc<unknown> = new clazz(args, procLogger)
+
+    return <FullProc<P>>instance
+  }
+
+  async addProcessor<P extends Proc<unknown>>(
+    proc: Processor,
+  ): Promise<FullProc<P>> {
+    const instance = await this.createProcessor<P>(proc)
+
     await instance.init()
 
-    this.logger.info('inited ' + proc.uri + ' type ' + ty)
+    this.logger.info(`Initiated processor '${proc.uri}'`)
 
     this.processors.push(instance)
     this.processorTransforms.push(instance.transform())

package/src/testUtils/duplex.ts

@@ -1,7 +1,7 @@
 import { Duplex } from 'stream'
 import type {
   ClientDuplexStream,
-  InterceptingCallInterface,
+  InterceptingCall,
 } from '@grpc/grpc-js'
 import { AuthContext } from '@grpc/grpc-js/build/src/auth-context'
 
@@ -23,7 +23,7 @@ export class MockClientDuplexStream<Req, Res>
 
   public readonly id: number
 
-  call?: InterceptingCallInterface | undefined
+  call?: InterceptingCall | undefined
   constructor() {
     super({ objectMode: true })
     this.id = count++

package/src/testUtils/index.ts

@@ -1,29 +1,22 @@
-import {
-  DataChunk,
-  FromRunner,
-  LogMessage,
-  Processor as ProcConfig,
-  ToRunner,
-} from '@rdfc/proto'
-import {} from '../reexports'
-import { extractShapes } from 'rdf-lens'
-import { NamedNode, Parser, Writer as N3Writer } from 'n3'
-import { readFile } from 'fs/promises'
-import winston, { createLogger } from 'winston'
-import { Processor } from '../processor'
-import { FullProc, Runner, Writable } from '../runner'
-import { Quad } from '@rdfjs/types'
-import { createTermNamespace } from '@treecg/types'
+import { DataChunk, FromRunner, LogMessage, Processor as ProcConfig, ToRunner } from "@rdfc/proto";
+import { extractShapes } from "rdf-lens";
+import { NamedNode, Parser, Writer as N3Writer } from "n3";
+import { readFile } from "fs/promises";
+import winston, { createLogger } from "winston";
+import { Processor } from "../processor";
+import { FullProc, Runner, Writable } from "../runner";
+import { Quad } from "@rdfjs/types";
+import { createTermNamespace } from "@treecg/types";
 import {
   ReceivingStreamControl,
   SendingStreamControl,
   StreamChunk,
   StreamIdentify,
-} from '@rdfc/proto/lib/generated/common'
-import { MockClientDuplexStream } from './duplex'
-import { promisify } from 'util'
-import { Reader } from '../reader'
-import { Writer } from '../writer'
+} from "@rdfc/proto/lib/generated/common";
+import { MockClientDuplexStream } from "./duplex";
+import { promisify } from "util";
+import { Reader } from "../reader";
+import { Writer } from "../writer";
 
 export function channel(runner: Runner, name: string): [Writer, Reader] {
   const n = new NamedNode(name)
@@ -359,12 +352,13 @@ export class ProcHelper<T extends Processor<unknown>> {
       pipeline: new N3Writer().quadsToString(this.quads),
     })
 
-    const proc = await this.runner.addProcessor<T>({
-      config: JSON.stringify(this.config),
-      arguments: '',
-      uri,
-    })
-    return proc
+    return await this.runner.createProcessor<T>(
+      {
+        config: JSON.stringify(this.config),
+        arguments: '',
+        uri,
+      },
+    )
   }
 }
 

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

@@ -1,9 +0,0 @@
-<?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

@@ -1,6 +0,0 @@
-<?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/vcs.xml

@@ -1,7 +0,0 @@
-<?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

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

package/examples/echo/index.ttl

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

package/examples/echo/minimal.ttl

@@ -1,90 +0,0 @@
-@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/shacl.ttl

@@ -1,9 +0,0 @@
-
-@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;
-  ].