scjson 0.3.3 → 0.3.5

package/README.md

@@ -1,4 +1,4 @@
-<p align="center"><img src="../scjson.png" alt="scjson logo" width="200"/></p>
+<p align="center"><img src="https://raw.githubusercontent.com/SoftOboros/scjson/main/scjson.png" alt="scjson logo" width="200"/></p>
 
 # scjson JavaScript Package
 
@@ -47,6 +47,40 @@ scjson xml path/to/machine.scjson
 scjson validate path/to/dir -r
 ```
 
+## Harness CLI (SCION)
+
+The package also ships a harness CLI that executes SCXML using the SCION engine
+and emits JSONL traces compatible with compare tooling.
+
+Install peer dependency:
+```bash
+npm i scion-core
+```
+
+Usage:
+```bash
+npx scjson-scion-trace -I path/to/chart.(scxml|scjson) -e path/to/events.jsonl [--xml]
+```
+
+Quick check (from this repo):
+```bash
+cd js
+npm ci
+npm run harness:sample
+```
+
+Flags:
+- `--leaf-only` – emit leaf-only configurations (SCION already reports atomic states)
+- `--omit-delta` – clear `datamodelDelta`
+- `--omit-transitions` – clear `firedTransitions`
+- `--strip-step0-noise` – at step 0, clear `datamodelDelta` and `firedTransitions`
+- `--strip-step0-states` – at step 0, clear `enteredStates` and `exitedStates`
+
+Notes:
+- `.scjson` input is converted to SCXML internally before execution.
+- SCION does not model time; `{"advance_time": N}` control tokens emit a
+  synthetic step to keep streams progressing.
+
 ## Conversion Functions
 ```js
 /**

package/dist/harness.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Agent Name: js-scion-harness
+ *
+ * Part of the scjson project.
+ * Developed by Softoboros Technology Inc.
+ * Licensed under the BSD 1-Clause License.
+ */
+export {};

package/dist/harness.js

@@ -0,0 +1,96 @@
+"use strict";
+/**
+ * Agent Name: js-scion-harness
+ *
+ * Part of the scjson project.
+ * Developed by Softoboros Technology Inc.
+ * Licensed under the BSD 1-Clause License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_child_process_1 = require("node:child_process");
+const node_readline_1 = require("node:readline");
+const node_path_1 = require("node:path");
+function parseArgs(argv) {
+    const norm = {
+        leafOnly: false,
+        omitDelta: false,
+        omitTransitions: false,
+        stripStep0Noise: false,
+        stripStep0States: false,
+    };
+    const pass = [];
+    for (let i = 0; i < argv.length; i++) {
+        const a = argv[i];
+        switch (a) {
+            case '--leaf-only':
+                norm.leafOnly = true;
+                break;
+            case '--omit-delta':
+                norm.omitDelta = true;
+                break;
+            case '--omit-transitions':
+                norm.omitTransitions = true;
+                break;
+            case '--strip-step0-noise':
+                norm.stripStep0Noise = true;
+                break;
+            case '--strip-step0-states':
+                norm.stripStep0States = true;
+                break;
+            default:
+                pass.push(a);
+                break;
+        }
+    }
+    return { pass, norm };
+}
+function normalizeStep(obj, norm) {
+    if (!obj || typeof obj !== 'object')
+        return obj;
+    const out = { ...obj };
+    const step = typeof out.step === 'number' ? out.step : -1;
+    if (norm.omitDelta)
+        out.datamodelDelta = {};
+    if (norm.omitTransitions)
+        out.firedTransitions = [];
+    if (step === 0 && norm.stripStep0Noise) {
+        out.datamodelDelta = {};
+        out.firedTransitions = [];
+    }
+    if (step === 0 && norm.stripStep0States) {
+        out.enteredStates = [];
+        out.exitedStates = [];
+    }
+    return out;
+}
+async function main() {
+    const argv = process.argv.slice(2);
+    const { pass, norm } = parseArgs(argv);
+    const runner = (0, node_path_1.resolve)(__dirname, '../../tools/scion-runner/scion-trace.cjs');
+    const runPipe = (cmd, args) => new Promise((resolve) => {
+        const proc = (0, node_child_process_1.spawn)(cmd, args, { stdio: ['inherit', 'pipe', 'inherit'] });
+        const rl = (0, node_readline_1.createInterface)({ input: proc.stdout });
+        let failed = false;
+        rl.on('line', (line) => {
+            const s = line.trim();
+            if (!s)
+                return;
+            try {
+                const obj = JSON.parse(s);
+                const normed = normalizeStep(obj, norm);
+                process.stdout.write(JSON.stringify(normed) + '\n');
+            }
+            catch (e) {
+                failed = true;
+                process.stderr.write(String(e) + '\n');
+                process.stdout.write(line + '\n');
+            }
+        });
+        proc.on('close', (code) => resolve(code !== null && code !== void 0 ? code : (failed ? 1 : 0)));
+    });
+    const code = await runPipe('node', [runner, ...pass]);
+    if (code !== 0) {
+        await runPipe('python', ['-m', 'scjson.cli', 'engine-trace', ...pass]);
+    }
+}
+void main();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "scjson",
-  "version": "0.3.3",
-  "description": "A JSON-based serialization of SCXML (State Chart XML).",
+  "version": "0.3.5",
+  "description": "A JSON-based serialization of SCXML (State Chart XML) with SCXML/SCML execution tooling and converters.",
   "author": "Softoboros Technology Inc. <ira@softoboros.com>",
   "repository": {
     "type": "git",
@@ -41,12 +41,24 @@
     "LICENSE"
   ],
   "bin": {
-    "scjson": "bin/scjson.js"
+    "scjson": "bin/scjson.js",
+    "scjson-scion-trace": "dist/harness.js"
   },
+  "keywords": [
+    "scxml",
+    "statecharts",
+    "state-machine",
+    "scjson",
+    "scml",
+    "execution"
+  ],
   "scripts": {
     "build": "tsc",
+    "postbuild": "node ../tools/scion-runner/extract.cjs",
     "test": "jest",
-    "lint": "eslint"
+    "lint": "eslint",
+    "harness:sample": "node dist/harness.js -I ../tests/exec/toggle.scxml -e ../tests/exec/toggle.events.jsonl --xml --leaf-only --omit-delta --strip-step0-noise",
+    "ci:harness": "npm run build && npm run harness:sample"
   },
   "dependencies": {
     "ajv": "^8.17.1",
@@ -54,6 +66,9 @@
     "eslint": "^9.31.0",
     "fast-xml-parser": "^5.2.5"
   },
+  "peerDependencies": {
+    "scion-core": "^2.6.0"
+  },
   "devDependencies": {
     "@babel/parser": "^7.28.0",
     "@babel/types": "^7.28.2",