@hydranium/data-server 1.0.0-next.298 → 1.0.0-next.299

package/README.md

@@ -41,6 +41,8 @@ with `@hydranium/core`.
    `startStdioServer` for a data head alone.
 2. In its connection callback, create `new DataServer(connection, shared)`. It
    cleans up when the connection closes.
+3. In a web worker, start it with `startDataServerInWorker` from `./browser`
+   on the port the page transferred for it; its callback creates the server.
 
 See *Add a data-server method* and *Connect a data client* in
 [Adopting Hydranium](https://github.com/eclipse-emfcloud/hydranium/blob/main/docs/ADOPTING.md).
@@ -51,6 +53,7 @@ See *Add a data-server method* and *Connect a data client* in
 | ------------ | ---------------------------------------------------------- | --------------- |
 | `.`          | `DataServer`, its options, and the diagnostics seam        | browser-neutral |
 | `./node`     | The Node implementation of the diagnostics seam            | Node-only       |
+| `./browser`  | Starting the head in a web worker                          | browser-only    |
 | `./messages` | The codes of the messages this package raises              | browser-neutral |
 | `./testing`  | A harness that drives a real data head in-process          | Node-only       |
 

package/lib/browser/index.d.ts

@@ -0,0 +1,10 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+export * from './start-data-server-in-worker.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/browser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAOlF,cAAc,kCAAkC,CAAC"}

package/lib/browser/index.js

@@ -0,0 +1,15 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+// Browser-only entry (`@hydranium/data-server/browser`). Holds the worker
+// starter, whose connection comes from `vscode-jsonrpc/browser`. The portable
+// `.` entry stays free of that import for the same reason it stays free of the
+// node one: it must resolve under both platforms, and a build that names one
+// has picked.
+export * from './start-data-server-in-worker.js';
+//# sourceMappingURL=index.js.map

package/lib/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,0EAA0E;AAC1E,8EAA8E;AAC9E,+EAA+E;AAC/E,6EAA6E;AAC7E,cAAc;AACd,cAAc,kCAAkC,CAAC"}

package/lib/browser/start-data-server-in-worker.d.ts

@@ -0,0 +1,23 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+import { type TransferredMessagePort } from '@hydranium/protocol';
+import type { ServerSharedServicesMinimal } from '@hydranium/core';
+import { type MessageConnection } from 'vscode-jsonrpc/browser';
+/**
+ * Start the data head on the port the page transferred for it, on the same
+ * shared tier the LSP head runs on, and return the server `create` built.
+ *
+ * `create` constructs the adopter's `DataServer`, or a subclass of it, around
+ * the connection, as a Node host's socket callback does, and the connection
+ * listens once it has returned, in the order the Node launcher uses. The
+ * page's end of the port closing disposes the server, which ends every
+ * session this connection registered.
+ */
+export declare function startDataServerInWorker<TServer>(port: TransferredMessagePort, shared: Pick<ServerSharedServicesMinimal, 'Logger'>, create: (connection: MessageConnection) => TServer): TServer;
+//# sourceMappingURL=start-data-server-in-worker.d.ts.map

package/lib/browser/start-data-server-in-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-data-server-in-worker.d.ts","sourceRoot":"","sources":["../../src/browser/start-data-server-in-worker.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAA8B,KAAK,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC9F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAA2B,KAAK,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEzF;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAC5C,IAAI,EAAE,sBAAsB,EAC5B,MAAM,EAAE,IAAI,CAAC,2BAA2B,EAAE,QAAQ,CAAC,EACnD,MAAM,EAAE,CAAC,UAAU,EAAE,iBAAiB,KAAK,OAAO,GAClD,OAAO,CAOT"}

package/lib/browser/start-data-server-in-worker.js

@@ -0,0 +1,29 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+import { createMessagePortTransport } from '@hydranium/protocol';
+import { createMessageConnection } from 'vscode-jsonrpc/browser';
+/**
+ * Start the data head on the port the page transferred for it, on the same
+ * shared tier the LSP head runs on, and return the server `create` built.
+ *
+ * `create` constructs the adopter's `DataServer`, or a subclass of it, around
+ * the connection, as a Node host's socket callback does, and the connection
+ * listens once it has returned, in the order the Node launcher uses. The
+ * page's end of the port closing disposes the server, which ends every
+ * session this connection registered.
+ */
+export function startDataServerInWorker(port, shared, create) {
+    // Both ends use `createMessagePortTransport`; see it for why.
+    const transport = createMessagePortTransport(port);
+    const connection = createMessageConnection(transport.reader, transport.writer, shared.Logger.with('ModelServer'));
+    const server = create(connection);
+    connection.listen();
+    return server;
+}
+//# sourceMappingURL=start-data-server-in-worker.js.map

package/lib/browser/start-data-server-in-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-data-server-in-worker.js","sourceRoot":"","sources":["../../src/browser/start-data-server-in-worker.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,0BAA0B,EAA+B,MAAM,qBAAqB,CAAC;AAE9F,OAAO,EAAE,uBAAuB,EAA0B,MAAM,wBAAwB,CAAC;AAEzF;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CACpC,IAA4B,EAC5B,MAAmD,EACnD,MAAkD;IAElD,8DAA8D;IAC9D,MAAM,SAAS,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,uBAAuB,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAClH,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IAClC,UAAU,CAAC,MAAM,EAAE,CAAC;IACpB,OAAO,MAAM,CAAC;AACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hydranium/data-server",
-  "version": "1.0.0-next.298",
+  "version": "1.0.0-next.299",
   "description": "Typed-RPC protocol head for the hydranium framework. Peer of @hydranium/core/lsp and @hydranium/glsp-server; built on @hydranium/core.",
   "keywords": [
     "data-server",
@@ -44,6 +44,10 @@
       "types": "./lib/node/index.d.ts",
       "default": "./lib/node/index.js"
     },
+    "./browser": {
+      "types": "./lib/browser/index.d.ts",
+      "default": "./lib/browser/index.js"
+    },
     "./messages": {
       "types": "./lib/messages/index.d.ts",
       "default": "./lib/messages/index.js"
@@ -66,18 +70,18 @@
     "watch": "tsc -b -w --preserveWatchOutput"
   },
   "devDependencies": {
-    "@hydranium/core": "1.0.0-next.298",
-    "@hydranium/langium": "1.0.0-next.298",
-    "@hydranium/protocol": "1.0.0-next.298",
+    "@hydranium/core": "1.0.0-next.299",
+    "@hydranium/langium": "1.0.0-next.299",
+    "@hydranium/protocol": "1.0.0-next.299",
     "rimraf": "^5.0.0",
     "typescript": "^7.0.2",
     "vscode-jsonrpc": "9.0.0",
     "vscode-languageserver-textdocument": "^1.0.12"
   },
   "peerDependencies": {
-    "@hydranium/core": "1.0.0-next.298",
-    "@hydranium/langium": "1.0.0-next.298",
-    "@hydranium/protocol": "1.0.0-next.298",
+    "@hydranium/core": "1.0.0-next.299",
+    "@hydranium/langium": "1.0.0-next.299",
+    "@hydranium/protocol": "1.0.0-next.299",
     "vscode-jsonrpc": "^9.0.0",
     "vscode-languageserver-textdocument": "^1.0.12"
   },

package/src/browser/index.ts

@@ -0,0 +1,15 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+
+// Browser-only entry (`@hydranium/data-server/browser`). Holds the worker
+// starter, whose connection comes from `vscode-jsonrpc/browser`. The portable
+// `.` entry stays free of that import for the same reason it stays free of the
+// node one: it must resolve under both platforms, and a build that names one
+// has picked.
+export * from './start-data-server-in-worker.js';

package/src/browser/start-data-server-in-worker.ts

@@ -0,0 +1,35 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+
+import { createMessagePortTransport, type TransferredMessagePort } from '@hydranium/protocol';
+import type { ServerSharedServicesMinimal } from '@hydranium/core';
+import { createMessageConnection, type MessageConnection } from 'vscode-jsonrpc/browser';
+
+/**
+ * Start the data head on the port the page transferred for it, on the same
+ * shared tier the LSP head runs on, and return the server `create` built.
+ *
+ * `create` constructs the adopter's `DataServer`, or a subclass of it, around
+ * the connection, as a Node host's socket callback does, and the connection
+ * listens once it has returned, in the order the Node launcher uses. The
+ * page's end of the port closing disposes the server, which ends every
+ * session this connection registered.
+ */
+export function startDataServerInWorker<TServer>(
+   port: TransferredMessagePort,
+   shared: Pick<ServerSharedServicesMinimal, 'Logger'>,
+   create: (connection: MessageConnection) => TServer
+): TServer {
+   // Both ends use `createMessagePortTransport`; see it for why.
+   const transport = createMessagePortTransport(port);
+   const connection = createMessageConnection(transport.reader, transport.writer, shared.Logger.with('ModelServer'));
+   const server = create(connection);
+   connection.listen();
+   return server;
+}