@playfast/reform-remote-node 0.0.2

package/README.md

@@ -0,0 +1,34 @@
+<div align="center">
+
+# `@playfast/reform-remote-node`
+
+**Serve a reform scene's UI over WebSocket from Node, using the `ws` package.**
+
+</div>
+
+---
+
+A concrete WebSocket server adapter for
+[`@playfast/reform-remote`](https://www.npmjs.com/package/@playfast/reform-remote). Each
+connection gets its own `serve({ scene, transport })` — its own isolated runtime — wrapped around the
+socket with JSON framing. The wire messages are already `_tag`-discriminated and serializable, so
+there is no envelope to write.
+
+```ts
+import { serveNodeWebSocket } from '@playfast/reform-remote-node'
+import { myScene } from './scene'
+
+const host = serveNodeWebSocket({ scene: myScene, port: 8080 })
+// …later
+await host.stop()
+```
+
+Pass `server` to attach to an existing HTTP server instead of opening a port, and `path` to
+restrict upgrades. Connect from the browser (or Node/Bun) with
+[`@playfast/reform-remote-web`](https://www.npmjs.com/package/@playfast/reform-remote-web); the
+Bun-native server equivalent is
+[`@playfast/reform-remote-bun`](https://www.npmjs.com/package/@playfast/reform-remote-bun).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import type { Server } from 'node:http';
+import { WebSocketServer } from 'ws';
+import type { Scene } from '@playfast/reform';
+/**
+ * @playfast/reform-remote-node — serve a reform scene's UI over WebSocket from a
+ * Node process, using the `ws` package. Each connection gets its own
+ * `serve({ scene, transport })` — its own isolated runtime — wrapped around the
+ * socket with JSON framing: the already-`_tag`-discriminated wire messages need
+ * no envelope. The Bun-native equivalent is `@playfast/reform-remote-bun`; the
+ * browser/web client is `@playfast/reform-remote-web`.
+ */
+export interface NodeWebSocketOptions {
+    /** The scene to run — a fresh runtime per connection. */
+    readonly scene: Scene;
+    /** Listen on this port (use `0` for an ephemeral port; read it back from `wss.address()`). */
+    readonly port?: number;
+    /** Attach to an existing HTTP server instead of opening a port. */
+    readonly server?: Server;
+    /** Restrict upgrades to this path. */
+    readonly path?: string;
+}
+export interface NodeWebSocketServer {
+    /** The underlying `ws` server — for reading the bound address, or further config. */
+    readonly wss: WebSocketServer;
+    /** Dispose every live connection's runtime and close the server. */
+    readonly stop: () => Promise<void>;
+}
+export declare const serveNodeWebSocket: (options: NodeWebSocketOptions) => NodeWebSocketServer;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAgB,eAAe,EAAE,MAAM,IAAI,CAAA;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAS7C;;;;;;;GAOG;AAEH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,8FAA8F;IAC9F,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB,mEAAmE;IACnE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,sCAAsC;IACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,qFAAqF;IACrF,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAA;IAC7B,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC;AAID,eAAO,MAAM,kBAAkB,GAAI,SAAS,oBAAoB,KAAG,mBA8ClE,CAAA"}

package/dist/index.js

@@ -0,0 +1,46 @@
+import { WebSocketServer } from 'ws';
+import { serve, } from '@playfast/reform-remote';
+const parseInvoke = (data) => JSON.parse(data.toString());
+export const serveNodeWebSocket = (options) => {
+    const wss = options.server !== undefined
+        ? new WebSocketServer({ server: options.server, path: options.path })
+        : new WebSocketServer({ port: options.port ?? 0, path: options.path });
+    // Every open connection's binding, so `stop` can tear them all down.
+    const bindings = new Set();
+    wss.on('connection', (socket) => {
+        const handlers = new Set();
+        const transport = {
+            send: (message) => socket.send(JSON.stringify(message)),
+            onMessage: (handler) => {
+                handlers.add(handler);
+                return () => void handlers.delete(handler);
+            },
+        };
+        socket.on('message', (data) => {
+            const message = parseInvoke(data);
+            for (const handler of handlers)
+                handler(message);
+        });
+        const binding = serve({ scene: options.scene, transport });
+        bindings.add(binding);
+        socket.on('close', () => {
+            bindings.delete(binding);
+            void binding.dispose();
+        });
+        // Push the first snapshot once the socket is live.
+        void binding.start();
+    });
+    return {
+        wss,
+        stop: async () => {
+            await Promise.all([...bindings].map((binding) => binding.dispose()));
+            bindings.clear();
+            // Terminate live sockets so `wss.close` doesn't block waiting for them to
+            // drain on their own — `close` only fires its callback once all are gone.
+            for (const client of wss.clients)
+                client.terminate();
+            await new Promise((resolve, reject) => wss.close((error) => (error === undefined ? resolve() : reject(error))));
+        },
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,eAAe,EAAE,MAAM,IAAI,CAAA;AAElD,OAAO,EAKL,KAAK,GACN,MAAM,yBAAyB,CAAA;AA6BhC,MAAM,WAAW,GAAG,CAAC,IAAa,EAAiB,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAkB,CAAA;AAElG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAA6B,EAAuB,EAAE;IACvF,MAAM,GAAG,GACP,OAAO,CAAC,MAAM,KAAK,SAAS;QAC1B,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QACrE,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IAE1E,qEAAqE;IACrE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAiB,CAAA;IAEzC,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoC,CAAA;QAC5D,MAAM,SAAS,GAAkD;YAC/D,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACvD,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBACrB,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBACrB,OAAO,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC5C,CAAC;SACF,CAAA;QACD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;YACjC,KAAK,MAAM,OAAO,IAAI,QAAQ;gBAAE,OAAO,CAAC,OAAO,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QAC1D,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACrB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACxB,KAAK,OAAO,CAAC,OAAO,EAAE,CAAA;QACxB,CAAC,CAAC,CAAA;QACF,mDAAmD;QACnD,KAAK,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,GAAG;QACH,IAAI,EAAE,KAAK,IAAmB,EAAE;YAC9B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;YACpE,QAAQ,CAAC,KAAK,EAAE,CAAA;YAChB,0EAA0E;YAC1E,0EAA0E;YAC1E,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO;gBAAE,MAAM,CAAC,SAAS,EAAE,CAAA;YACpD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAC1C,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CACxE,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@playfast/reform-remote-node",
+  "playbook": "./playbook",
+  "version": "0.0.2",
+  "type": "module",
+  "description": "Node WebSocket server adapter for reform-remote — serves a reform scene's UI over the `ws` package, one isolated runtime per connection.",
+  "keywords": [
+    "reform",
+    "effect",
+    "websocket",
+    "remote",
+    "node",
+    "server"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/playfast/reform.git",
+    "directory": "packages/reform-remote-node"
+  },
+  "bugs": {
+    "url": "https://github.com/playfast/reform/issues"
+  },
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./src/index.ts",
+    "./*": "./src/*.ts"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist .tsbuildinfo",
+    "check": "tsc --noEmit",
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint": "oxlint src",
+    "lint:fix": "oxlint --fix src"
+  },
+  "dependencies": {
+    "ws": "^8.18.0"
+  },
+  "peerDependencies": {
+    "effect": "*",
+    "react": "^19.0.0",
+    "@playfast/reform": "*",
+    "@playfast/reform-remote": "*"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.13"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}