@hydranium/client-browser 1.0.0-next.303 → 1.0.0-next.304

package/README.md

@@ -3,7 +3,8 @@
 The page side of a [Hydranium](https://github.com/eclipse-emfcloud/hydranium)
 host that runs its heads in a web worker, with no backend. Install it when
 your language runs in a plain web page: it hands each head its own
-`MessagePort`, runs the page's LSP handshake, and gives the data head its port.
+`MessagePort`, runs the page's LSP handshake, makes a Monaco editor the LSP
+head's client, and gives the data head its port.
 
 ## What it gives you
 
@@ -12,6 +13,10 @@ your language runs in a plain web page: it hands each head its own
 - The LSP head's connection with the server's own requests answered: the
   capability registrations and the configuration section it reads while the
   workspace comes up.
+- A Monaco editor as the LSP head's client, from `./monaco`: the languages and
+  providers registered, `workspace/applyEdit` answered, `didOpen`, `didChange`
+  and `didClose` sent for the documents you open, and a save of the unsaved
+  ones through the data head.
 - A `DataPort` over the data head's port, for the connection and sessions from
   `@hydranium/protocol`.
 - The GLSP head's connection, for GLSP's own client.
@@ -25,11 +30,14 @@ your language runs in a plain web page: it hands each head its own
 npm install @hydranium/client-browser
 ```
 
-| Peer                             | Range         |
-| -------------------------------- | ------------- |
-| `@hydranium/protocol`            | `^1.0.0-next` |
-| `vscode-jsonrpc`                 | `^9.0.0`      |
-| `vscode-languageserver-protocol` | `~3.18.1`     |
+| Peer                             | Range             |
+| -------------------------------- | ----------------- |
+| `@hydranium/protocol`            | `^1.0.0-next`     |
+| `monaco-editor-core`             | `>=0.56.0 <1.0.0` |
+| `vscode-jsonrpc`                 | `^9.0.0`          |
+| `vscode-languageserver-protocol` | `~3.18.1`         |
+
+`monaco-editor-core` is optional; only `./monaco` needs it.
 
 ## Wiring
 
@@ -75,21 +83,62 @@ The data port reports a data-head failure to the console. A host with a
 surface of its own subclasses `WorkerDataPort` and passes it as
 `createDataPort`.
 
-The default capabilities declare `workspace.applyEdit`, which the handshake
-does not answer: register a `workspace/applyEdit` handler on the connection
-before you open a document, as any LSP client does, or the server's writes
-to that document are lost.
+Build the Monaco client, from `./monaco`, in `beforeInitialized` too, from the
+server's capabilities and your language table, and hand it each diagnostics
+notification. Open a document on the text the worker holds, never on a copy
+in your bundle, and create editors through the client, which keeps the
+settings a server-driven language needs under your own. Save through a data
+session: the server already holds every edit, so the save persists and
+authors nothing.
+
+<!-- snippet-preamble
+import { connectWorkerHeads } from '@hydranium/client-browser';
+import { DataConnectionWithEvents } from '@hydranium/protocol';
+declare const worker: Parameters<typeof connectWorkerHeads>[0];
+declare const container: HTMLElement;
+declare const textFromTheWorker: string;
+const heads = connectWorkerHeads(worker);
+const data = new DataConnectionWithEvents(heads.data);
+-->
+
+```ts
+import { initializeLanguageClient } from '@hydranium/client-browser';
+import { MONACO_CLIENT_CAPABILITIES, MonacoLspClient, saveDirtyDocuments } from '@hydranium/client-browser/monaco';
+import { PublishDiagnosticsNotification } from 'vscode-languageserver-protocol';
+
+let client!: MonacoLspClient;
+await initializeLanguageClient(heads.lsp, {
+   rootUri: 'file:///workspace',
+   capabilities: MONACO_CLIENT_CAPABILITIES,
+   beforeInitialized: result => {
+      client = new MonacoLspClient(heads.lsp, result.capabilities, {
+         languages: [{ id: 'my-language', extensions: ['.my'] }]
+      });
+      heads.lsp.onNotification(PublishDiagnosticsNotification.type, params => client.applyDiagnostics(params));
+   }
+});
+const model = client.openDocument('file:///workspace/a.my', textFromTheWorker);
+client.createEditor(container, model, { theme: 'vs' });
+await saveDirtyDocuments(client, data.createSession('editors'));
+```
+
+`MONACO_CLIENT_CAPABILITIES` declares `workspace.applyEdit`, which the Monaco
+client answers, and every form it renders, so a server that gates a form on
+its capability sends it. A host with another editor declares its own, and
+registers its own `workspace/applyEdit` handler before it opens a document,
+as any LSP client does, or the server's writes to that document are lost.
 
 For the whole setup, see *Host in a browser* in
 [Adopting Hydranium](https://github.com/eclipse-emfcloud/hydranium/blob/main/docs/ADOPTING.md).
 
 ## Entry points
 
-| Subpath | Use it for                                                | Runs in    |
-| ------- | --------------------------------------------------------- | ---------- |
-| `.`     | The worker bootstrap, the LSP handshake and the data port | a web page |
+| Subpath    | Use it for                                                | Runs in    |
+| ---------- | --------------------------------------------------------- | ---------- |
+| `.`        | The worker bootstrap, the LSP handshake and the data port | a web page |
+| `./monaco` | The Monaco editor as the LSP head's client, and its save  | a web page |
 
-The package needs a TypeScript `moduleResolution` that reads `exports`
+The subpaths need a TypeScript `moduleResolution` that reads `exports`
 (`NodeNext` or `Bundler`); see *Requirements* in
 [Adopting Hydranium](https://github.com/eclipse-emfcloud/hydranium/blob/main/docs/ADOPTING.md).
 

package/lib/language-client.d.ts

@@ -6,7 +6,7 @@
  *
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
-import type { Locale } from '@hydranium/protocol';
+import { type Locale } from '@hydranium/protocol';
 import type { MessageConnection } from 'vscode-jsonrpc/browser';
 import { type ClientCapabilities, type InitializeResult, type LogMessageParams } from 'vscode-languageserver-protocol';
 /** The one configuration section the server reads, and what it reads there. */

package/lib/language-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"language-client.d.ts","sourceRoot":"","sources":["../src/language-client.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAOJ,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACvB,MAAM,gCAAgC,CAAC;AAExC,+EAA+E;AAC/E,MAAM,WAAW,2BAA2B;IACzC,kHAAkH;IAClH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,oJAAoJ;IACpJ,QAAQ,IAAI,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACnC,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,kEAAkE;IAClE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,oGAAoG;IACpG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAC3C,uFAAuF;IACvF,QAAQ,CAAC,aAAa,CAAC,EAAE,2BAA2B,CAAC;IACrD,8IAA8I;IAC9I,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC3D;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAClE;AAKD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,wBAAwB,CAAC,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAyBvI"}
+{"version":3,"file":"language-client.d.ts","sourceRoot":"","sources":["../src/language-client.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,KAAK,MAAM,EAAoB,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAOJ,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACvB,MAAM,gCAAgC,CAAC;AAExC,+EAA+E;AAC/E,MAAM,WAAW,2BAA2B;IACzC,kHAAkH;IAClH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,oJAAoJ;IACpJ,QAAQ,IAAI,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACnC,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,kEAAkE;IAClE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,oGAAoG;IACpG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;;;OASG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAC3C,uFAAuF;IACvF,QAAQ,CAAC,aAAa,CAAC,EAAE,2BAA2B,CAAC;IACrD,8IAA8I;IAC9I,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC3D;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAClE;AAKD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,wBAAwB,CAAC,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA4BvI"}

package/lib/language-client.js

@@ -9,6 +9,7 @@
  ********************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initializeLanguageClient = initializeLanguageClient;
+const protocol_1 = require("@hydranium/protocol");
 const vscode_languageserver_protocol_1 = require("vscode-languageserver-protocol");
 /** The capabilities the server's inbound requests rely on, declared unless the host declares its own. */
 const DEFAULT_CAPABILITIES = { workspace: { applyEdit: true, configuration: true } };
@@ -38,7 +39,10 @@ async function initializeLanguageClient(connection, options) {
         connection.onNotification(vscode_languageserver_protocol_1.LogMessageNotification.type, options.onLogMessage);
     }
     connection.listen();
-    const result = await connection.sendRequest(vscode_languageserver_protocol_1.InitializeRequest.type, {
+    // By method name: these types come from `vscode-languageserver-protocol`'s
+    // copy of `vscode-jsonrpc`, which need not be the connection's.
+    const sender = (0, protocol_1.sendByMethodName)(connection);
+    const result = await sender.sendRequest(vscode_languageserver_protocol_1.InitializeRequest.type, {
         processId: null,
         rootUri: options.rootUri,
         locale: options.locale,
@@ -46,7 +50,7 @@ async function initializeLanguageClient(connection, options) {
         workspaceFolders: [{ uri: options.rootUri, name: workspaceName }]
     });
     options.beforeInitialized?.(result);
-    await connection.sendNotification(vscode_languageserver_protocol_1.InitializedNotification.type, {});
+    await sender.sendNotification(vscode_languageserver_protocol_1.InitializedNotification.type, {});
     return result;
 }
 /** The root's last path segment, decoded, or the root itself for one with no path. */

package/lib/language-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"language-client.js","sourceRoot":"","sources":["../src/language-client.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAIlF,mFAUwC;AAyCxC,yGAAyG;AACzG,MAAM,oBAAoB,GAAuB,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;AAEzG;;;;;;;;;;;;;GAaG;AACI,KAAK,mCAAmC,UAA6B,EAAE,OAA8B;IACzG,4EAA4E;IAC5E,0EAA0E;IAC1E,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChF,UAAU,CAAC,SAAS,CAAC,oDAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAChE,UAAU,CAAC,SAAS,CAAC,sDAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAC5C,UAAU,CAAC,SAAS,CAAC,qDAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CACtD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CACrI,CAAC;IACF,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACxB,UAAU,CAAC,cAAc,CAAC,uDAAsB,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChF,CAAC;IACD,UAAU,CAAC,MAAM,EAAE,CAAC;IAEpB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,kDAAiB,CAAC,IAAI,EAAE;QACjE,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,oBAAoB;QAC1D,gBAAgB,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;KACnE,CAAC,CAAC;IACH,OAAO,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,UAAU,CAAC,gBAAgB,CAAC,wDAAuB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC;AACjB,CAAC;AAED,sFAAsF;AACtF,SAAS,eAAe,CAAC,OAAe;IACrC,OAAO,kBAAkB,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,IAAI,OAAO,CAAC;AAC9G,CAAC"}
+{"version":3,"file":"language-client.js","sourceRoot":"","sources":["../src/language-client.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,kDAAoE;AAEpE,mFAUwC;AAyCxC,yGAAyG;AACzG,MAAM,oBAAoB,GAAuB,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;AAEzG;;;;;;;;;;;;;GAaG;AACI,KAAK,mCAAmC,UAA6B,EAAE,OAA8B;IACzG,4EAA4E;IAC5E,0EAA0E;IAC1E,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChF,UAAU,CAAC,SAAS,CAAC,oDAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAChE,UAAU,CAAC,SAAS,CAAC,sDAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAC5C,UAAU,CAAC,SAAS,CAAC,qDAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CACtD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CACrI,CAAC;IACF,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACxB,UAAU,CAAC,cAAc,CAAC,uDAAsB,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChF,CAAC;IACD,UAAU,CAAC,MAAM,EAAE,CAAC;IAEpB,2EAA2E;IAC3E,gEAAgE;IAChE,MAAM,MAAM,GAAG,IAAA,2BAAgB,EAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,kDAAiB,CAAC,IAAI,EAAE;QAC7D,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,oBAAoB;QAC1D,gBAAgB,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;KACnE,CAAC,CAAC;IACH,OAAO,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,MAAM,CAAC,gBAAgB,CAAC,wDAAuB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC;AACjB,CAAC;AAED,sFAAsF;AACtF,SAAS,eAAe,CAAC,OAAe;IACrC,OAAO,kBAAkB,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,IAAI,OAAO,CAAC;AAC9G,CAAC"}

package/lib/monaco/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 './monaco-lsp-client';
+//# sourceMappingURL=index.d.ts.map

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

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

package/lib/monaco/index.js

@@ -0,0 +1,29 @@
+"use strict";
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// The Monaco entry (`@hydranium/client-browser/monaco`). Behind a subpath because
+// `monaco-editor-core` touches the DOM at load and has no Node entry, so the `.`
+// barrel stays loadable by a host's Node tests and a page without Monaco.
+__exportStar(require("./monaco-lsp-client"), exports);
+//# sourceMappingURL=index.js.map

package/lib/monaco/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/monaco/index.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;;;;;;;;;;;;AAElF,kFAAkF;AAClF,iFAAiF;AACjF,0EAA0E;AAC1E,sDAAoC"}