@sourceacademy/runner-cse-machine 1.0.0

package/dist/__tests__/runner.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";class s{constructor(s,[e]){if(this.id="__runner_cse",!e)throw new Error("CSE channel is required but was not provided.");this.__cseChannel=e}sendSnapshots(s){this.__cseChannel.send({type:"snapshots",snapshots:s,totalSteps:s.length})}}s.channelAttach=["__cse"],exports.CseMachinePlugin=s;

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { type CseSnapshot } from "@sourceacademy/common-cse-machine";
+import type { IPlugin, IChannel, IConduit } from "@sourceacademy/conductor/conduit";
+/**
+ * Runner-side CSE machine plugin.
+ *
+ * An evaluator (js-slang, py-slang, ...) registers this plugin and feeds it a batch of
+ * language-agnostic {@link CseSnapshot}s via {@link CseMachinePlugin.sendSnapshots}; the
+ * plugin forwards them over the {@link CSE_CHANNEL} to the web/host plugin, which renders
+ * the CSE machine visualization.
+ *
+ * The serialization of a language's control/stash/environment into {@link CseSnapshot}s is
+ * the evaluator's responsibility and stays in the evaluator repo — this plugin only owns the
+ * transport, so it can be reused by every language.
+ */
+export declare class CseMachinePlugin implements IPlugin {
+    readonly id: string;
+    static readonly channelAttach: string[];
+    private readonly __cseChannel;
+    constructor(_conduit: IConduit, [cseChannel]: IChannel<any>[]);
+    /**
+     * Send a full run's worth of snapshots to the host plugin.
+     * @param snapshots The serialized evaluation snapshots, in step order.
+     */
+    sendSnapshots(snapshots: CseSnapshot[]): void;
+}

package/dist/index.mjs

@@ -0,0 +1 @@
+class s{constructor(s,[e]){if(this.id="__runner_cse",!e)throw new Error("CSE channel is required but was not provided.");this.__cseChannel=e}sendSnapshots(s){this.__cseChannel.send({type:"snapshots",snapshots:s,totalSteps:s.length})}}s.channelAttach=["__cse"];export{s as CseMachinePlugin};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@sourceacademy/runner-cse-machine",
+  "version": "1.0.0",
+  "packageManager": "yarn@4.6.0",
+  "description": "The runner-side CSE machine plugin: sends evaluation snapshots to the host",
+  "scripts": {
+    "build": "rollup -c",
+    "prepack": "yarn build"
+  },
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "@sourceacademy/common-cse-machine": ">=0.1.0",
+    "@sourceacademy/conductor": ">=0.3.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@sourceacademy/common-cse-machine": "workspace:*",
+    "@sourceacademy/conductor": ">=0.3.0",
+    "@vitest/coverage-istanbul": "^4.1.9",
+    "rollup": "^4.60.2",
+    "tslib": "^2.8.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.9"
+  }
+}