@hydranium/core 1.0.0-next.10

package/lib/documents/ast-document-manager.js

@@ -0,0 +1,302 @@
+/********************************************************************************
+ * Copyright (c) 2023-2026 CrossBreeze, 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 { DocumentState, UriUtils } from '@hydranium/langium';
+import { Disposable } from 'vscode-languageserver';
+import { TextDocumentIdentifier } from 'vscode-languageserver-protocol';
+import { URI } from '@hydranium/langium';
+import { labelPhaseListener } from '../langium/document-builder/index.js';
+import { UNKNOWN_CLIENT_ID } from './client-ids.js';
+export var AstDocument;
+(function (AstDocument) {
+    /**
+     * Construct an {@link AstDocument} envelope. `diagnostics` defaults
+     * to `[]` so test fixtures and the in-process pre-validated paths
+     * don't need to repeat the empty array at every call site. Mirrors
+     * `TransferDocument.create` on the wire side.
+     */
+    function create(uri, version, root, diagnostics = []) {
+        return { uri, version, root, diagnostics };
+    }
+    AstDocument.create = create;
+    /**
+     * Project a {@link LangiumDocument} into its {@link AstDocument}
+     * envelope — the single place that reads `root` / `diagnostics` /
+     * `version` / `uri` off a built document. Both the event path
+     * ({@link AstDocumentManager.onUpdate} / `onSave`) and the read path
+     * (`ModelService`'s snapshot accessors) go through here so the
+     * field mapping lives once.
+     *
+     * The emitted `uri` is always the document's own `textDocument.uri` — the
+     * canonical document-identity form (see {@link DocumentUriPolicy}). Events
+     * carry that identity, not the subscriber's (possibly non-canonical) URI:
+     * a subscriber already knows the URI it subscribed with, so the useful
+     * thing to surface is the canonical one every other layer keys by.
+     */
+    function from(document) {
+        return create(document.textDocument.uri, document.textDocument.version, document.parseResult.value, (document.diagnostics ?? []));
+    }
+    AstDocument.from = from;
+})(AstDocument || (AstDocument = {}));
+/**
+ * Higher-level facade over {@link HydraniumTextDocuments} that speaks the
+ * model-server protocol (open/close/update/save with the transfer-model event
+ * shapes). Hides the LSP plumbing from the model server and the integrity
+ * service.
+ *
+ * Generic over `<TAst extends AstNode, TDiagnostic>` so each consumer
+ * projects its own AST root type and diagnostic shape into the emitted
+ * `AstDocument` envelopes. `TDiagnostic` defaults to `unknown`; consumers
+ * that care about the diagnostic shape name a concrete one.
+ *
+ * **URI contract.** Every URI-accepting method takes a URI in *any* spelling
+ * (canonical, symlinked, `..`/case-divergent) and canonicalizes internally
+ * through the {@link DocumentUriPolicy} before keying any store — callers never
+ * have to canonicalize first. The facade re-exposes only the {@link isOpen}
+ * open-state predicate; the finer multi-client predicates
+ * (`isOpenInLanguageClient` / `isOpenInAnyClient`) and the language-client address
+ * resolution (the egress `applyEditToLanguageClient`) stay on
+ * {@link HydraniumTextDocuments}, their owner.
+ */
+export class AstDocumentManager {
+    services;
+    lastUpdate;
+    textDocuments;
+    fileSystemProvider;
+    langiumDocs;
+    documentBuilder;
+    uriPolicy;
+    tracer;
+    constructor(services, options = {}) {
+        this.services = services;
+        this.textDocuments = services.workspace.TextDocuments;
+        this.fileSystemProvider = services.workspace.FileSystemProvider;
+        this.langiumDocs = services.workspace.LangiumDocuments;
+        this.documentBuilder = services.workspace.DocumentBuilder;
+        this.uriPolicy = services.workspace.DocumentUriPolicy;
+        this.tracer = services.Tracer.for(options.logName ?? 'AstDocumentManager').trace('instantiated');
+        this.textDocuments.onDidOpen(event => this.open({ clientId: event.clientId, uri: event.document.uri, languageId: event.document.languageId }));
+        this.textDocuments.onDidClose(event => this.close({ clientId: event.clientId, uri: event.document.uri }));
+        this.documentBuilder.onUpdate((changed, deleted) => {
+            this.lastUpdate = { changed, deleted };
+        });
+        // Content transitions for CLOSED documents bypass the text store: the
+        // last-close revert and watched-file changes rebuild from disk into a
+        // factory-fresh text document carrying the factory's own version. At the
+        // Parsed transition (the earliest phase with text, and one only re-read
+        // documents pass through — cascade relinks re-enter later), reconcile the
+        // store's persisted version sequence with the rebuilt content and
+        // re-stamp the document so every downstream envelope (revert broadcast,
+        // snapshot reads) carries the continued sequence. An empty-changes
+        // update only re-stamps the version. Previously-untracked URIs exit on a
+        // map lookup, so workspace-wide builds don't hash untouched documents.
+        this.documentBuilder.onDocumentPhase(DocumentState.Parsed, labelPhaseListener(document => {
+            const sequenceVersion = this.textDocuments.reconcileExternalContent(document.textDocument.uri, document.textDocument.getText());
+            if (sequenceVersion !== undefined && document.textDocument.version !== sequenceVersion) {
+                this.textDocuments.update(document.textDocument, [], sequenceVersion);
+            }
+        }, 'AstDocumentManager.reconcileExternalContent'));
+    }
+    /**
+     * Resolve a `languageId` for a URI by delegating to the
+     * `ServiceRegistry`. Multi-grammar workspaces route per-URI
+     * correctly. Never throws.
+     *
+     * For a URI that matches no registered language the answer depends on how
+     * many languages there are, because only one of the two cases has a
+     * defensible guess:
+     * - **one** registered language — its id. An extensionless or untitled URI
+     *   in a single-language workspace is that language by construction.
+     * - **more than one** — `'plaintext'`. Naming a real language here would
+     *   mean picking by registration order and reporting a document as a
+     *   language it demonstrably is not; `'plaintext'` says "unknown", which
+     *   is the truth and is what a client can sensibly act on.
+     *
+     * Adopters needing dispatch on something other than file extension (URI
+     * scheme, path prefix, embedded MIME) subclass `AstDocumentManager` and
+     * override this method.
+     */
+    resolveLanguageId(uri) {
+        const parsed = URI.parse(uri);
+        if (this.services.ServiceRegistry.hasServices(parsed)) {
+            return this.services.ServiceRegistry.getServices(parsed).LanguageMetaData.languageId;
+        }
+        const languages = this.services.ServiceRegistry.all;
+        return languages.length === 1 ? languages[0].LanguageMetaData.languageId : 'plaintext';
+    }
+    /**
+     * Subscribe to the save event of the document at `uri`. The callback fires only when the
+     * URI of the saved document matches `uri` (compared by canonical form).
+     */
+    onSave(uri, listener) {
+        const target = this.uriPolicy.canonicalUri(uri);
+        return this.textDocuments.onDidSave(async (event) => {
+            if (this.uriPolicy.canonicalUri(event.document.uri) !== target) {
+                return undefined;
+            }
+            // Look the document up by its canonical URI: the adopter's
+            // `LangiumDocuments` keys by the canonical form, while the saved
+            // event carries the (possibly symlinked) client-facing URI.
+            const documentURI = UriUtils.toUri(target);
+            if (documentURI !== undefined && this.langiumDocs.hasDocument(documentURI)) {
+                const document = await this.langiumDocs.getOrCreateDocument(documentURI);
+                return listener({
+                    document: this.toAstDocument(document),
+                    sourceClientId: event.clientId
+                });
+            }
+            return undefined;
+        });
+    }
+    /** Fires when `clientId` detaches from the document at `uri` (matched by canonical form). */
+    onClientClosed(uri, clientId, listener) {
+        const target = this.uriPolicy.canonicalUri(uri);
+        return this.textDocuments.onDidClose(event => {
+            if (event.clientId === clientId && this.uriPolicy.canonicalUri(event.document.uri) === target) {
+                listener();
+            }
+        });
+    }
+    /** Fires when the document at `uri` reaches `Validated` after each rebuild. */
+    onUpdate(uri, listener) {
+        const target = this.uriPolicy.canonicalUri(uri);
+        const emitUpdate = (document) => {
+            if (this.uriPolicy.canonicalUri(document.uri) !== target) {
+                return;
+            }
+            // Presentation boundary: the event field is a concrete `string`, so an
+            // unauthored (framework-rebuilt) document surfaces the readable default
+            // rather than `undefined` to subscribers and logs.
+            const sourceClientId = this.getAuthor(document) ?? UNKNOWN_CLIENT_ID;
+            const event = {
+                document: this.toAstDocument(document),
+                sourceClientId,
+                reason: this.lastUpdate?.changed.find(changed => UriUtils.equals(changed, document.uri))
+                    ? 'changed'
+                    : this.lastUpdate?.deleted.find(deleted => UriUtils.equals(deleted, document.uri))
+                        ? 'deleted'
+                        : 'rebuilt'
+            };
+            this.tracer.with(uri).trace(`emitUpdate start: source=${sourceClientId}, reason=${event.reason}`);
+            listener(event);
+            this.tracer.with(uri).trace('emitUpdate listener returned');
+        };
+        return this.documentBuilder.onDocumentPhase(DocumentState.Validated, labelPhaseListener(emitUpdate, 'AstDocumentManager.onUpdate'));
+    }
+    /**
+     * The client that authored `document`'s current version, or `undefined` when
+     * no client wrote it — a framework-internal rebuild (workspace startup, a
+     * cascade relink, a `didClose`-reload) or a genuine author gap. Honest about
+     * absence so routing consumers (`ModelService.isNonLanguageClientEdit`)
+     * test `undefined` directly rather than against a sentinel; the presentation
+     * default ({@link UNKNOWN_CLIENT_ID}) is applied at the boundary that needs a
+     * concrete value (the `onUpdate` event's `sourceClientId`, the data-server's
+     * `resolveSourceClientId`).
+     */
+    getAuthor(document) {
+        return this.textDocuments.getAuthor(document.textDocument.uri, document.textDocument.version);
+    }
+    async open(args) {
+        // `open()` is the RPC-level "ensure this document is loaded" call. It is issued
+        // by a view attaching, but also internally by `update()` / `save()` and by every
+        // additional client attaching to the same URI, including the several sub-editors
+        // a composite view opens. When the document is already loaded there is nothing to
+        // do here but hand back the close-disposable — callers that want the current
+        // state read it from this method's surrounding RPC response, not from a re-build.
+        //
+        // Re-rendering an already-built document to a newly-attached *textual* view is
+        // driven by the real `textDocument/didOpen` notification, which
+        // `HydraniumTextDocuments.notifyDidOpenTextDocument` handles through its
+        // additional-client attach branch (firing `refreshContent` there). Firing
+        // `refreshContent` here as well would turn every ensure-loaded call into a full
+        // Langium rebuild + dependent relink cascade: redundant work that also
+        // transiently breaks cross-document linking mid-rebuild (a dependent briefly
+        // seeing an `extends`/`type` reference unresolved). And because the constructor
+        // wires `onDidOpen -> this.open`, it would fire a second, identical rebuild on
+        // every first open. So an already-open `open()` is a no-op.
+        if (!this.isOpen(args.uri)) {
+            const textDocument = await this.createDocumentFromTextOrFileSystem(args.uri, args.languageId, args.version, args.text);
+            this.textDocuments.notifyDidOpenTextDocument({ textDocument }, args.clientId);
+        }
+        return Disposable.create(() => this.close(args));
+    }
+    async close(args) {
+        this.textDocuments.notifyDidCloseTextDocument({ textDocument: TextDocumentIdentifier.create(args.uri) }, args.clientId);
+    }
+    /**
+     * Apply a textual update for `uri`. The shared version is assigned by the
+     * text store itself ({@link HydraniumTextDocuments.applyContentChange}):
+     * one step when `text` differs from the current synced content, unchanged
+     * when it is identical — so callers never fabricate version numbers and
+     * the shared sequence keeps its "advances iff content changes" invariant.
+     *
+     * Returns the resulting shared version so callers that want to log or
+     * correlate the change against subsequent build events can. Throws if the
+     * document isn't open.
+     */
+    async update(uri, text, clientId) {
+        if (!this.isOpen(uri)) {
+            throw new Error(`Document ${uri} hasn't been opened for updating yet`);
+        }
+        this.tracer.with(uri).trace(`Notify document change (${text.length} bytes, from ${clientId})`);
+        return this.textDocuments.applyContentChange(uri, text, clientId);
+    }
+    /**
+     * Persist the current text-document content for `uri` to disk and emit
+     * the `didSaveTextDocument` notification. The text is read from the
+     * multi-client text store (same source of truth `update` writes to), so
+     * callers don't need to pass it — the manager owns content and version
+     * sequencing.
+     *
+     * Throws if no document is open for `uri`.
+     */
+    async save(uri, clientId) {
+        const document = this.textDocuments.get(uri);
+        if (!document) {
+            throw new Error(`Document ${uri} hasn't been opened for saving yet`);
+        }
+        const text = document.getText();
+        await this.tracer.with(uri).time(`Write file (${text.length} bytes, from ${clientId})`, 
+        // Async write so a slow disk does not block the event loop for the duration of the fs call.
+        () => this.fileSystemProvider.writeFile(UriUtils.toUri(uri), text), 'debug');
+        this.textDocuments.notifyDidSaveTextDocument({ textDocument: TextDocumentIdentifier.create(uri), text }, clientId);
+    }
+    isOpen(uri) {
+        return !!this.textDocuments.get(uri);
+    }
+    /** True if the URI was in the directly-changed set of the most recent build (not just affected). */
+    isDirectChange(uri) {
+        const canonical = this.uriPolicy.canonicalUri(uri);
+        return this.lastUpdate?.changed.some(changed => this.uriPolicy.canonicalUri(changed) === canonical) ?? false;
+    }
+    /**
+     * The `LangiumDocument` for an externally-supplied URI, looked up by its
+     * canonical identity. Folds the `getDocument(toUri(canonicalUri(uri)))` idiom
+     * into one place so a client-facing URI (e.g. a symlink) always resolves to
+     * the document `LangiumDocuments` keys by its real path — a caller cannot
+     * forget the `canonicalUri` step and silently miss the document.
+     */
+    getDocument(uri) {
+        return this.langiumDocs.getDocument(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)));
+    }
+    async createDocumentFromTextOrFileSystem(uri, languageId = this.resolveLanguageId(uri), version = 0, text) {
+        return { uri, languageId, version, text: text ?? (await this.readFile(uri)) };
+    }
+    async readFile(uri) {
+        return this.fileSystemProvider.readFile(UriUtils.toUri(uri));
+    }
+    /**
+     * Hook for subclasses that want to re-shape the emitted document (e.g. inject
+     * a custom-typed `diagnostics` field). The default delegates to
+     * {@link AstDocument.from}, the shared LangiumDocument→envelope projection.
+     */
+    toAstDocument(document) {
+        return AstDocument.from(document);
+    }
+}
+//# sourceMappingURL=ast-document-manager.js.map

package/lib/documents/ast-document-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-document-manager.js","sourceRoot":"","sources":["../../src/documents/ast-document-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AASlF,OAAO,EAGJ,aAAa,EAIb,QAAQ,EACV,MAAM,oBAAoB,CAAC;AAoD5B,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAyB,MAAM,gCAAgC,CAAC;AAE/F,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAEzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAqCpD,MAAM,KAAW,WAAW,CAsC3B;AAtCD,WAAiB,WAAW;IACzB;;;;;OAKG;IACH,SAAgB,MAAM,CACnB,GAAW,EACX,OAAe,EACf,IAAU,EACV,cAA6B,EAAE;QAE/B,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC9C,CAAC;IAPe,kBAAM,SAOrB,CAAA;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,IAAI,CAA8C,QAAyB;QACxF,OAAO,MAAM,CACV,QAAQ,CAAC,YAAY,CAAC,GAAG,EACzB,QAAQ,CAAC,YAAY,CAAC,OAAO,EAC7B,QAAQ,CAAC,WAAW,CAAC,KAAa,EAClC,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAA6B,CAC1D,CAAC;IACL,CAAC;IAPe,gBAAI,OAOnB,CAAA;AACJ,CAAC,EAtCgB,WAAW,KAAX,WAAW,QAsC3B;AAWD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,kBAAkB;IAWN;IAVZ,UAAU,CAAc;IAEf,aAAa,CAAuC;IACpD,kBAAkB,CAA6B;IAC/C,WAAW,CAAmB;IAC9B,eAAe,CAAkB;IACjC,SAAS,CAAoB;IAC7B,MAAM,CAAS;IAElC,YACsB,QAA8B,EACjD,UAAqC,EAAE;QADpB,aAAQ,GAAR,QAAQ,CAAsB;QAGjD,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC;QACtD,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAAC;QAChE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC;QACvD,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAClC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CACzG,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC1G,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YAChD,IAAI,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,sEAAsE;QACtE,sEAAsE;QACtE,yEAAyE;QACzE,wEAAwE;QACxE,0EAA0E;QAC1E,kEAAkE;QAClE,wEAAwE;QACxE,mEAAmE;QACnE,yEAAyE;QACzE,uEAAuE;QACvE,IAAI,CAAC,eAAe,CAAC,eAAe,CACjC,aAAa,CAAC,MAAM,EACpB,kBAAkB,CAAC,QAAQ,CAAC,EAAE;YAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,wBAAwB,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;YAChI,IAAI,eAAe,KAAK,SAAS,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;gBACtF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,EAAE,eAAe,CAAC,CAAC;YACzE,CAAC;QACJ,CAAC,EAAE,6CAA6C,CAAC,CACnD,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACO,iBAAiB,CAAC,GAAW;QACpC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC;QACxF,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC;QACpD,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,GAAW,EAAE,QAA6F;QAC9G,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;YAC/C,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,MAAM,EAAE,CAAC;gBAC9D,OAAO,SAAS,CAAC;YACpB,CAAC;YACD,2DAA2D;YAC3D,iEAAiE;YACjE,4DAA4D;YAC5D,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3C,IAAI,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC1E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;gBACzE,OAAO,QAAQ,CAAC;oBACb,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;oBACtC,cAAc,EAAE,KAAK,CAAC,QAAQ;iBAChC,CAAC,CAAC;YACN,CAAC;YACD,OAAO,SAAS,CAAC;QACpB,CAAC,CAAC,CAAC;IACN,CAAC;IAED,6FAA6F;IAC7F,cAAc,CAAC,GAAW,EAAE,QAAgB,EAAE,QAAoB;QAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YAC1C,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,MAAM,EAAE,CAAC;gBAC7F,QAAQ,EAAE,CAAC;YACd,CAAC;QACJ,CAAC,CAAC,CAAC;IACN,CAAC;IAED,+EAA+E;IAC/E,QAAQ,CAAC,GAAW,EAAE,QAA+E;QAClG,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,CAAC,QAAyB,EAAQ,EAAE;YACpD,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,MAAM,EAAE,CAAC;gBACxD,OAAO;YACV,CAAC;YACD,uEAAuE;YACvE,wEAAwE;YACxE,mDAAmD;YACnD,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,iBAAiB,CAAC;YACrE,MAAM,KAAK,GAAyD;gBACjE,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;gBACtC,cAAc;gBACd,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;oBACrF,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAChF,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,SAAS;aAClB,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,4BAA4B,cAAc,YAAY,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAClG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC/D,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,aAAa,CAAC,SAAS,EAAE,kBAAkB,CAAC,UAAU,EAAE,6BAA6B,CAAC,CAAC,CAAC;IACvI,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,QAAkC;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACjG,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAmB;QAC3B,gFAAgF;QAChF,iFAAiF;QACjF,iFAAiF;QACjF,kFAAkF;QAClF,6EAA6E;QAC7E,kFAAkF;QAClF,EAAE;QACF,+EAA+E;QAC/E,gEAAgE;QAChE,yEAAyE;QACzE,0EAA0E;QAC1E,gFAAgF;QAChF,uEAAuE;QACvE,6EAA6E;QAC7E,gFAAgF;QAChF,+EAA+E;QAC/E,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,kCAAkC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACvH,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE,YAAY,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAoB;QAC7B,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAC,EAAE,YAAY,EAAE,sBAAsB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3H,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,IAAY,EAAE,QAAgB;QACrD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,sCAAsC,CAAC,CAAC;QAC1E,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,2BAA2B,IAAI,CAAC,MAAM,gBAAgB,QAAQ,GAAG,CAAC,CAAC;QAC/F,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,QAAgB;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,oCAAoC,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAC7B,eAAe,IAAI,CAAC,MAAM,gBAAgB,QAAQ,GAAG;QACrD,4FAA4F;QAC5F,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,EAClE,OAAO,CACT,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE,YAAY,EAAE,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;IACtH,CAAC;IAED,MAAM,CAAC,GAAW;QACf,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC;IAED,oGAAoG;IACpG,cAAc,CAAC,GAAW;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,IAAI,KAAK,CAAC;IAChH,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC;IAES,KAAK,CAAC,kCAAkC,CAC/C,GAAW,EACX,aAAqB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAChD,OAAO,GAAG,CAAC,EACX,IAAa;QAEb,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,QAAyB;QAC9C,OAAO,WAAW,CAAC,IAAI,CAAoB,QAAQ,CAAC,CAAC;IACxD,CAAC;CACH"}

package/lib/documents/client-ids.d.ts

@@ -0,0 +1,30 @@
+/********************************************************************************
+ * Copyright (c) 2026 CrossBreeze, 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
+ ********************************************************************************/
+/**
+ * Well-known client-kind identifiers used across the multi-client framework.
+ *
+ * The framework tracks each document as belonging to one or more "clients"
+ * — typically an LSP-text-client (Monaco, VS Code, etc.), a GLSP diagram
+ * client, and/or a structured-form client. Each kind carries a stable id so
+ * the server can route outbound corrections, edits, and notifications to the
+ * right transport.
+ */
+/** Identifier for an LSP-text client (Monaco, VS Code, …). */
+export declare const LANGUAGE_CLIENT_ID = "language-client";
+/** Fallback identifier when a document's author is unknown (e.g. cold workspace-init load). */
+export declare const UNKNOWN_CLIENT_ID = "unknown";
+/**
+ * Synthetic author id on the `onDocumentUpdated` broadcast a data-server
+ * emits after the LAST client closed a document and the framework rebuilt it
+ * from its disk content (discarding unsaved in-session edits). Not a real
+ * client: it lets consumers distinguish the revert broadcast from
+ * client-authored updates.
+ */
+export declare const REVERT_ON_CLOSE_CLIENT_ID = "revert-on-close";
+//# sourceMappingURL=client-ids.d.ts.map

package/lib/documents/client-ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-ids.d.ts","sourceRoot":"","sources":["../../src/documents/client-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;GAQG;AAEH,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD,+FAA+F;AAC/F,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,oBAAoB,CAAC"}

package/lib/documents/client-ids.js

@@ -0,0 +1,30 @@
+/********************************************************************************
+ * Copyright (c) 2026 CrossBreeze, 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
+ ********************************************************************************/
+/**
+ * Well-known client-kind identifiers used across the multi-client framework.
+ *
+ * The framework tracks each document as belonging to one or more "clients"
+ * — typically an LSP-text-client (Monaco, VS Code, etc.), a GLSP diagram
+ * client, and/or a structured-form client. Each kind carries a stable id so
+ * the server can route outbound corrections, edits, and notifications to the
+ * right transport.
+ */
+/** Identifier for an LSP-text client (Monaco, VS Code, …). */
+export const LANGUAGE_CLIENT_ID = 'language-client';
+/** Fallback identifier when a document's author is unknown (e.g. cold workspace-init load). */
+export const UNKNOWN_CLIENT_ID = 'unknown';
+/**
+ * Synthetic author id on the `onDocumentUpdated` broadcast a data-server
+ * emits after the LAST client closed a document and the framework rebuilt it
+ * from its disk content (discarding unsaved in-session edits). Not a real
+ * client: it lets consumers distinguish the revert broadcast from
+ * client-authored updates.
+ */
+export const REVERT_ON_CLOSE_CLIENT_ID = 'revert-on-close';
+//# sourceMappingURL=client-ids.js.map

package/lib/documents/client-ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-ids.js","sourceRoot":"","sources":["../../src/documents/client-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;GAQG;AAEH,8DAA8D;AAC9D,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;AAEpD,+FAA+F;AAC/F,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC"}