@hydranium/protocol 1.0.0-next.36 → 1.0.0-next.361

package/lib/errors.js

@@ -8,48 +8,91 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConflictError = exports.CONFLICT_ERROR_CODE = exports.STALE_BASED_UPDATE = void 0;
+exports.ReservedClientIdError = exports.DuplicateClientIdError = exports.DUPLICATE_CLIENT_ID = exports.DocumentNotOpenError = exports.DOCUMENT_NOT_OPEN = exports.SessionClosedError = exports.SESSION_CLOSED = exports.RESERVED_CLIENT_ID_ERROR_CODE = exports.DUPLICATE_CLIENT_ID_ERROR_CODE = exports.DOCUMENT_NOT_OPEN_ERROR_CODE = exports.SESSION_CLOSED_ERROR_CODE = exports.ConflictError = exports.CONFLICT_ERROR_CODE = exports.HYDRANIUM_ERROR_CODES = exports.STALE_BASE_VERSION_SAVE = exports.STALE_BASE_VERSION_UPDATE = void 0;
+exports.isResponseError = isResponseError;
+exports.reviveProtocolError = reviveProtocolError;
+exports.isSessionClosedError = isSessionClosedError;
+exports.isDocumentNotOpenError = isDocumentNotOpenError;
+exports.isDuplicateClientIdError = isDuplicateClientIdError;
+exports.isReservedClientIdError = isReservedClientIdError;
 exports.isConflictError = isConflictError;
 const vscode_jsonrpc_1 = require("vscode-jsonrpc");
 const primitives_1 = require("./messages/primitives");
+const base_version_1 = require("./model-service/base-version");
+/*
+ * Every error here is a typed error: a caller reacts to it, so it has a class,
+ * a JSON-RPC code and an `is*` guard, and an English message. A typed error
+ * also carries a message identity where the framework can write an end-user
+ * sentence that needs no context. A URI may stay in that sentence; a client id
+ * or a raw version stays out of it, worded or left to `data`.
+ *
+ * An error nothing reacts to does not belong here: it stays a plain `Error`, or
+ * a named subclass without a code, at its throw site, since a code and a guard
+ * are public API that no caller would use.
+ */
 /**
- * The catalogue declaration behind {@link ConflictError}'s sentence.
+ * The catalogue declaration behind {@link ConflictError}'s sentence. It words
+ * the version mismatch rather than stating it: the two numbers mean nothing to
+ * an end user, and they stay in {@link ConflictErrorData}.
  *
  * Its English must keep containing {@link CONFLICT_ERROR_MESSAGE_MARKER}: the
  * marker is tier 3 of {@link isConflictError}'s ladder, and it matches on text.
  * That tier only ever works untranslated, which is why it is the last resort
  * behind the numeric code rather than the primary check.
  */
-exports.STALE_BASED_UPDATE = (0, primitives_1.defineMessage)('hydranium/protocol/stale-based-update', 'Stale-based update for {uri}: expected v{expected}, server is at v{actual}');
+exports.STALE_BASE_VERSION_UPDATE = (0, primitives_1.defineMessage)('hydranium/protocol/stale-base-version-update', 'The edit to {uri} was not applied: it was made to an older version of the document.');
+/**
+ * {@link STALE_BASE_VERSION_UPDATE}'s counterpart for an editor's save the
+ * server refused, since the editor's buffer is not the text it holds. Its
+ * English keeps the same marker.
+ */
+exports.STALE_BASE_VERSION_SAVE = (0, primitives_1.defineMessage)('hydranium/protocol/stale-base-version-save', 'The save of {uri} was not applied: it was made to an older version of the document.');
+/**
+ * Every JSON-RPC error code the framework raises, from any package, keyed by
+ * the error it identifies.
+ *
+ * The framework reserves the block 42000 to 42999 for these, and an adopter's
+ * own codes stay outside it: after an RPC a guard matches on the code alone, so
+ * an adopter's error carrying one of these reads as the framework's. A new code
+ * takes the next unused number in the block, whichever package raises it, and
+ * is declared here, where tests hold every code distinct and inside the block.
+ * The block sits clear of the range JSON-RPC 2.0 reserves for itself, -32768
+ * to -32000.
+ */
+exports.HYDRANIUM_ERROR_CODES = {
+    conflict: 42001,
+    noActiveProfile: 42002,
+    referenceSettleTimeout: 42003,
+    sessionClosed: 42004,
+    documentNotOpen: 42005,
+    duplicateClientId: 42006,
+    reservedClientId: 42007
+};
 /**
- * Application-specific JSON-RPC error code for {@link ConflictError}.
- * Outside the reserved range (-32768 .. -32000) per JSON-RPC 2.0.
+ * JSON-RPC error code for {@link ConflictError}.
  *
  * The code is the load-bearing identifier across realm boundaries —
  * `code` is a first-class field on the JSON-RPC error envelope and
  * survives wire reconstruction; the custom `Error` subclass name does
  * not.
  */
-exports.CONFLICT_ERROR_CODE = 1001;
+exports.CONFLICT_ERROR_CODE = exports.HYDRANIUM_ERROR_CODES.conflict;
 /**
- * Thrown by `ModelService.update` / `ModelService.save` when the caller-
- * supplied based-on version no longer matches the server's current text-
+ * Thrown by a client session's `update` / `save` when the caller-
+ * supplied base version no longer matches the server's current text-
  * document version for the same URI — i.e. the snapshot the caller
  * authored against has been superseded by an intervening edit.
  *
  * Extends vscode-jsonrpc's {@link ResponseError} so the typed
  * {@link ConflictErrorData} payload rides on the standard JSON-RPC
  * error envelope (`code`, `message`, `data`) — all three fields are
- * preserved by RPC reconstruction. Adopters that catch the error on
- * the receiving side of an RPC call read the version mismatch from
- * `err.data` (the instance is reconstructed as a generic
- * `ResponseError`, so subclass getters / fields do not survive).
+ * preserved by RPC reconstruction. `createRpcProxy` revives it into
+ * this class on the receiving side; a path that does not leaves a
+ * plain `ResponseError`, readable through `err.data` only.
  *
- * Detection is opt-in via the optional `baseVersion` field on
- * `TransferUpdateArgs` / `TransferSaveArgs`; callers that omit the field get
- * no gating. This mirrors LSP's `OptionalVersionedTextDocumentIdentifier`
- * posture, so headless / CLI / batch tooling with no meaningful based-on
- * version can opt out explicitly.
+ * Detection is driven by the required `baseVersion` field of every write
+ * request; a caller with no meaningful base version passes
+ * `'any'` and gets no gating.
  *
  * Three reasonable adopter recovery strategies:
  *
@@ -63,35 +106,227 @@ exports.CONFLICT_ERROR_CODE = 1001;
  * No auto-retry or auto-merge ships by default.
  */
 class ConflictError extends vscode_jsonrpc_1.ResponseError {
-    constructor(uri, expected, actual) {
-        const params = { uri, expected, actual };
+    /** `message` words what was refused: an edit, or with {@link STALE_BASE_VERSION_SAVE} a save. */
+    constructor(uri, baseVersion, actualVersion, message = exports.STALE_BASE_VERSION_UPDATE) {
         // The identity rides alongside the typed payload rather than replacing
-        // it: this class's getters and `isConflictError`'s name check are surface
-        // an adopter may bind, so the payload widens rather than changing shape.
-        super(exports.CONFLICT_ERROR_CODE, exports.STALE_BASED_UPDATE.format(params), { ...params, ...(0, primitives_1.messageData)(exports.STALE_BASED_UPDATE, params) });
+        // it: `isConflictError`'s name check is surface an adopter may bind, so
+        // adding the identity widens the payload rather than reshaping it.
+        super(exports.CONFLICT_ERROR_CODE, message.format({ uri }), {
+            uri,
+            baseVersion,
+            actualVersion,
+            ...(0, primitives_1.messageData)(message, { uri })
+        });
         this.name = 'ConflictError';
         // ResponseError's constructor calls `Object.setPrototypeOf(this,
         // ResponseError.prototype)` to keep its own prototype chain intact across
         // transpilation targets; that resets us to ResponseError, hiding the
         // ConflictError-specific getters. Restore the prototype here so
-        // `err.uri` / `.expected` / `.actual` resolve through this class.
+        // `err.uri` / `.baseVersion` / `.actualVersion` resolve through this
+        // class.
         Object.setPrototypeOf(this, ConflictError.prototype);
     }
+    /** The document whose version moved, see {@link ConflictErrorData.uri}. */
     get uri() {
         return this.data.uri;
     }
-    get expected() {
-        return this.data.expected;
+    /**
+     * The base version the caller authored against. Not `expected`, and its
+     * sibling not `actual`: a test reporter reads that pair as an assertion
+     * failure and reports nothing of the real one.
+     */
+    get baseVersion() {
+        return this.data.baseVersion;
     }
-    get actual() {
-        return this.data.actual;
+    /** The server's version at the time of the throw. Not `actual`, see {@link baseVersion}. */
+    get actualVersion() {
+        return this.data.actualVersion;
     }
 }
 exports.ConflictError = ConflictError;
+/**
+ * JSON-RPC code for {@link SessionClosedError}, beside {@link CONFLICT_ERROR_CODE}
+ * and for the same reason: the code survives reconstruction, the class does not.
+ */
+exports.SESSION_CLOSED_ERROR_CODE = exports.HYDRANIUM_ERROR_CODES.sessionClosed;
+/** JSON-RPC code for {@link DocumentNotOpenError}. */
+exports.DOCUMENT_NOT_OPEN_ERROR_CODE = exports.HYDRANIUM_ERROR_CODES.documentNotOpen;
+/** JSON-RPC code for {@link DuplicateClientIdError}. */
+exports.DUPLICATE_CLIENT_ID_ERROR_CODE = exports.HYDRANIUM_ERROR_CODES.duplicateClientId;
+/** JSON-RPC code for {@link ReservedClientIdError}. */
+exports.RESERVED_CLIENT_ID_ERROR_CODE = exports.HYDRANIUM_ERROR_CODES.reservedClientId;
+/**
+ * The catalogue declaration behind {@link SessionClosedError}'s default
+ * sentence. It names no client id: the sentence can reach an end user, and the
+ * id stays in {@link SessionClosedErrorData.clientId} for whoever needs it.
+ */
+exports.SESSION_CLOSED = (0, primitives_1.defineMessage)('hydranium/protocol/session-closed', 'The editing session has ended.');
+/**
+ * Thrown by every call on a client session after it ended, and by an open that
+ * was still in flight when its session ended: by the server for its sessions,
+ * and by a client-side `DataSession` once disposed, so a caller handles both
+ * the same way. A caller recognises it with {@link isSessionClosedError}, never
+ * by its sentence.
+ */
+class SessionClosedError extends vscode_jsonrpc_1.ResponseError {
+    /**
+     * `message` replaces the default English, for a caller that knows more than
+     * that the session is gone. The identity stays {@link SESSION_CLOSED}'s, so a
+     * translating renderer renders the catalogue sentence in its place.
+     */
+    constructor(clientId, message = exports.SESSION_CLOSED.format()) {
+        super(exports.SESSION_CLOSED_ERROR_CODE, message, { clientId, ...(0, primitives_1.messageData)(exports.SESSION_CLOSED) });
+        this.name = 'SessionClosedError';
+        // `ResponseError` resets the prototype to its own; see `ConflictError`.
+        Object.setPrototypeOf(this, SessionClosedError.prototype);
+    }
+    get clientId() {
+        return this.data.clientId;
+    }
+}
+exports.SessionClosedError = SessionClosedError;
+/**
+ * The catalogue declaration behind {@link DocumentNotOpenError}'s sentence. The
+ * client id stays in {@link DocumentNotOpenErrorData.clientId}.
+ */
+exports.DOCUMENT_NOT_OPEN = (0, primitives_1.defineMessage)('hydranium/protocol/document-not-open', 'The document {uri} is not open in this editing session.');
+/**
+ * Thrown when a client session writes a document it does not have open.
+ *
+ * A session writes only what it has open, so this is the answer both to a write
+ * that never opened and to one whose open was closed underneath it — by the
+ * session itself, or by the document being deleted.
+ */
+class DocumentNotOpenError extends vscode_jsonrpc_1.ResponseError {
+    constructor(uri, clientId) {
+        super(exports.DOCUMENT_NOT_OPEN_ERROR_CODE, exports.DOCUMENT_NOT_OPEN.format({ uri }), {
+            uri,
+            clientId,
+            ...(0, primitives_1.messageData)(exports.DOCUMENT_NOT_OPEN, { uri })
+        });
+        this.name = 'DocumentNotOpenError';
+        Object.setPrototypeOf(this, DocumentNotOpenError.prototype);
+    }
+    get uri() {
+        return this.data.uri;
+    }
+    get clientId() {
+        return this.data.clientId;
+    }
+}
+exports.DocumentNotOpenError = DocumentNotOpenError;
+/**
+ * The catalogue declaration behind {@link DuplicateClientIdError}'s sentence.
+ * The client id stays in {@link DuplicateClientIdErrorData.clientId}.
+ */
+exports.DUPLICATE_CLIENT_ID = (0, primitives_1.defineMessage)('hydranium/protocol/duplicate-client-id', 'Could not start an editing session: its identifier is still in use by another editor.');
+/**
+ * Thrown when a client session is started under an id that is already live in
+ * the process. The id frees up once its holder ends or closes its last
+ * document, so a caller may retry.
+ *
+ * Ids are unique process-wide because the id is also the author label on every
+ * version and the key a client recognises its own echoes by; two participants
+ * sharing one would each take the other's writes for their own.
+ */
+class DuplicateClientIdError extends vscode_jsonrpc_1.ResponseError {
+    constructor(clientId) {
+        super(exports.DUPLICATE_CLIENT_ID_ERROR_CODE, exports.DUPLICATE_CLIENT_ID.format(), { clientId, ...(0, primitives_1.messageData)(exports.DUPLICATE_CLIENT_ID) });
+        this.name = 'DuplicateClientIdError';
+        Object.setPrototypeOf(this, DuplicateClientIdError.prototype);
+    }
+    get clientId() {
+        return this.data.clientId;
+    }
+}
+exports.DuplicateClientIdError = DuplicateClientIdError;
+/**
+ * Thrown when a client session is started under an id the framework reserves
+ * for one of its own participants. A reserved id never frees up, so a caller
+ * that retries on {@link DuplicateClientIdError} stops on this one.
+ *
+ * It carries no message identity: a host that picks a reserved id has a bug,
+ * and no sentence addressed to an end user is true for it.
+ */
+class ReservedClientIdError extends vscode_jsonrpc_1.ResponseError {
+    constructor(clientId) {
+        super(exports.RESERVED_CLIENT_ID_ERROR_CODE, `Client id ${clientId} is reserved for a framework participant`, { clientId });
+        this.name = 'ReservedClientIdError';
+        Object.setPrototypeOf(this, ReservedClientIdError.prototype);
+    }
+    get clientId() {
+        return this.data.clientId;
+    }
+}
+exports.ReservedClientIdError = ReservedClientIdError;
+/** One entry per typed error class, keyed by its code; a class without one reaches a caller as a plain `ResponseError`. */
+const PROTOCOL_ERROR_REVIVERS = new Map([
+    [
+        exports.CONFLICT_ERROR_CODE,
+        ({ uri, baseVersion, actualVersion }) => typeof uri === 'string' && typeof baseVersion === 'number' && typeof actualVersion === 'number'
+            ? new ConflictError(uri, (0, base_version_1.asModelVersion)(baseVersion), actualVersion)
+            : undefined
+    ],
+    [exports.SESSION_CLOSED_ERROR_CODE, ({ clientId }) => (typeof clientId === 'string' ? new SessionClosedError(clientId) : undefined)],
+    [
+        exports.DOCUMENT_NOT_OPEN_ERROR_CODE,
+        ({ uri, clientId }) => (typeof uri === 'string' && typeof clientId === 'string' ? new DocumentNotOpenError(uri, clientId) : undefined)
+    ],
+    [exports.DUPLICATE_CLIENT_ID_ERROR_CODE, ({ clientId }) => (typeof clientId === 'string' ? new DuplicateClientIdError(clientId) : undefined)],
+    [exports.RESERVED_CLIENT_ID_ERROR_CODE, ({ clientId }) => (typeof clientId === 'string' ? new ReservedClientIdError(clientId) : undefined)]
+]);
+/**
+ * Whether `error` is a `ResponseError` from any copy of `vscode-jsonrpc`. An
+ * install holds several copies, and `instanceof` recognises only its own. An
+ * error that merely carries an integer `code` has no `toJson`, and is not one.
+ */
+function isResponseError(error) {
+    return (error instanceof Error && 'code' in error && Number.isInteger(error.code) && 'toJson' in error && typeof error.toJson === 'function');
+}
+/**
+ * `error` as an instance of the typed error class its code names, with its
+ * message, data and stack kept, or `error` itself when its code names none or
+ * its data lacks the fields that class reads.
+ * An RPC reconstructs every rejection as a plain `ResponseError`, which has
+ * none of the class getters.
+ */
+function reviveProtocolError(error) {
+    if (!isResponseError(error) || error.data === null || typeof error.data !== 'object') {
+        return error;
+    }
+    const revived = PROTOCOL_ERROR_REVIVERS.get(error.code)?.({ ...error.data });
+    if (!revived) {
+        return error;
+    }
+    return Object.assign(revived, { message: error.message, data: error.data, stack: error.stack });
+}
+/**
+ * Whether `error` is a {@link SessionClosedError}: by name in-process, by code
+ * when it arrives as a plain `ResponseError`, through a path that does not
+ * {@link reviveProtocolError revive} it.
+ */
+function isSessionClosedError(error) {
+    return hasErrorIdentity(error, 'SessionClosedError', exports.SESSION_CLOSED_ERROR_CODE);
+}
+/** Whether `error` is a {@link DocumentNotOpenError}; see {@link isSessionClosedError}. */
+function isDocumentNotOpenError(error) {
+    return hasErrorIdentity(error, 'DocumentNotOpenError', exports.DOCUMENT_NOT_OPEN_ERROR_CODE);
+}
+/** Whether `error` is a {@link DuplicateClientIdError}; see {@link isSessionClosedError}. */
+function isDuplicateClientIdError(error) {
+    return hasErrorIdentity(error, 'DuplicateClientIdError', exports.DUPLICATE_CLIENT_ID_ERROR_CODE);
+}
+/** Whether `error` is a {@link ReservedClientIdError}; see {@link isSessionClosedError}. */
+function isReservedClientIdError(error) {
+    return hasErrorIdentity(error, 'ReservedClientIdError', exports.RESERVED_CLIENT_ID_ERROR_CODE);
+}
+function hasErrorIdentity(error, name, code) {
+    return error instanceof Error && (error.name === name || error.code === code);
+}
 /** Marker substring present in every {@link ConflictError} message, used by
  *  {@link isConflictError} as a fallback when a transport re-wraps the error
  *  and drops the JSON-RPC code. */
-const CONFLICT_ERROR_MESSAGE_MARKER = 'Stale-based update for ';
+const CONFLICT_ERROR_MESSAGE_MARKER = ': it was made to an older version of the document';
 /**
  * Type guard for {@link ConflictError}. Detection ladder:
  *
@@ -101,11 +336,13 @@ const CONFLICT_ERROR_MESSAGE_MARKER = 'Stale-based update for ';
  *     canonical wire-side check; the JSON-RPC `code` field is preserved
  *     across reconstruction, so any adopter catching after an RPC call
  *     hits this branch.
- *  3. `error.message.includes('Stale-based update for ')` — fallback
- *     for transports that re-wrap the message and drop the code (rare).
+ *  3. `error.message` contains the marker the English of
+ *     {@link STALE_BASE_VERSION_UPDATE} and
+ *     {@link STALE_BASE_VERSION_SAVE} carries — fallback for transports
+ *     that re-wrap the message and drop the code (rare).
  *
- * `instanceof ConflictError` alone would silently return `false` on the
- * reconstructed shape, so callers do not use it.
+ * `instanceof ConflictError` alone returns `false` on a rejection that was
+ * not {@link reviveProtocolError revived}, so callers do not use it.
  */
 function isConflictError(error) {
     if (!(error instanceof Error)) {

package/lib/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAyHlF,0CAYC;AAnID,mDAA+C;AAC/C,sDAA8F;AAE9F;;;;;;;GAOG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAa,EAC5C,uCAAuC,EACvC,4EAA4E,CAC9E,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAcxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,aAAc,SAAQ,8BAAgC;IAChE,YAAY,GAAW,EAAE,QAAgB,EAAE,MAAc;QACtD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QACzC,uEAAuE;QACvE,0EAA0E;QAC1E,yEAAyE;QACzE,KAAK,CAAC,2BAAmB,EAAE,0BAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,IAAA,wBAAW,EAAC,0BAAkB,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACzH,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,iEAAiE;QACjE,0EAA0E;QAC1E,qEAAqE;QACrE,gEAAgE;QAChE,kEAAkE;QAClE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,GAAG;QACJ,OAAO,IAAI,CAAC,IAAK,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACT,OAAO,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACP,OAAO,IAAI,CAAC,IAAK,CAAC,MAAM,CAAC;IAC5B,CAAC;CACH;AA3BD,sCA2BC;AAED;;mCAEmC;AACnC,MAAM,6BAA6B,GAAG,yBAAyB,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC3C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAI,KAAyC,CAAC,IAAI,CAAC;IAC7D,IAAI,IAAI,KAAK,2BAAmB,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC;AACrG,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;;;;;;AAElF,mDAA+C;AAC/C,sDAA8F;AAC9F,+DAAmG;AAEnG;;;;;;;;;;GAUG;AAEH;;;;;;;;;GASG;AACU,QAAA,yBAAyB,GAAG,IAAA,0BAAa,EACnD,8CAA8C,EAC9C,qFAAqF,CACvF,CAAC;AAEF;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,IAAA,0BAAa,EACjD,4CAA4C,EAC5C,qFAAqF,CACvF,CAAC;AAEF;;;;;;;;;;;GAWG;AACU,QAAA,qBAAqB,GAAG;IAClC,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,sBAAsB,EAAE,KAAK;IAC7B,aAAa,EAAE,KAAK;IACpB,eAAe,EAAE,KAAK;IACtB,iBAAiB,EAAE,KAAK;IACxB,gBAAgB,EAAE,KAAK;CAChB,CAAC;AAEX;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,QAAA,qBAAqB,CAAC,QAAQ,CAAC;AAelE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,mBAA2B,SAAQ,8BAAgC;IAChE,iGAAiG;IACjG,YACG,GAAW,EACX,WAAyB,EACzB,aAA0B,EAC1B,OAAO,GAAsE,QAAA,yBAAyB;QAEtG,uEAAuE;QACvE,wEAAwE;QACxE,mEAAmE;QACnE,KAAK,CAAC,QAAA,mBAAmB,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;YACjD,GAAG;YACH,WAAW;YACX,aAAa;YACb,GAAG,IAAA,wBAAW,EAAC,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,iEAAiE;QACjE,0EAA0E;QAC1E,qEAAqE;QACrE,gEAAgE;QAChE,qEAAqE;QACrE,SAAS;QACT,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,2EAA2E;IAC3E,IAAI,GAAG;QACJ,OAAO,IAAI,CAAC,IAAK,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACZ,OAAO,IAAI,CAAC,IAAK,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,4FAA4F;IAC5F,IAAI,aAAa;QACd,OAAO,IAAI,CAAC,IAAK,CAAC,aAAa,CAAC;IACnC,CAAC;CACH;;AAED;;;GAGG;AACU,QAAA,yBAAyB,GAAG,QAAA,qBAAqB,CAAC,aAAa,CAAC;AAC7E,sDAAsD;AACzC,QAAA,4BAA4B,GAAG,QAAA,qBAAqB,CAAC,eAAe,CAAC;AAClF,wDAAwD;AAC3C,QAAA,8BAA8B,GAAG,QAAA,qBAAqB,CAAC,iBAAiB,CAAC;AACtF,uDAAuD;AAC1C,QAAA,6BAA6B,GAAG,QAAA,qBAAqB,CAAC,gBAAgB,CAAC;AAEpF;;;;GAIG;AACU,QAAA,cAAc,GAAG,IAAA,0BAAa,EAAC,mCAAmC,EAAE,gCAAgC,CAAC,CAAC;AAOnH;;;;;;GAMG;AACH,wBAAgC,SAAQ,8BAAqC;IAC1E;;;;OAIG;IACH,YAAY,QAAgB,EAAE,OAAO,GAAG,QAAA,cAAc,CAAC,MAAM,EAAE;QAC5D,KAAK,CAAC,QAAA,yBAAyB,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,GAAG,IAAA,wBAAW,EAAC,QAAA,cAAc,CAAC,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,wEAAwE;QACxE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,QAAQ;QACT,OAAO,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC;CACH;;AAED;;;GAGG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAa,EAC3C,sCAAsC,EACtC,yDAAyD,CAC3D,CAAC;AAQF;;;;;;GAMG;AACH,0BAAkC,SAAQ,8BAAuC;IAC9E,YAAY,GAAW,EAAE,QAAgB;QACtC,KAAK,CAAC,QAAA,4BAA4B,EAAE,QAAA,iBAAiB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;YACpE,GAAG;YACH,QAAQ;YACR,GAAG,IAAA,wBAAW,EAAC,QAAA,iBAAiB,EAAE,EAAE,GAAG,EAAE,CAAC;SAC5C,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,GAAG;QACJ,OAAO,IAAI,CAAC,IAAK,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACT,OAAO,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC;CACH;;AAED;;;GAGG;AACU,QAAA,mBAAmB,GAAG,IAAA,0BAAa,EAC7C,wCAAwC,EACxC,uFAAuF,CACzF,CAAC;AAOF;;;;;;;;GAQG;AACH,4BAAoC,SAAQ,8BAAyC;IAClF,YAAY,QAAgB;QACzB,KAAK,CAAC,QAAA,8BAA8B,EAAE,QAAA,mBAAmB,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,IAAA,wBAAW,EAAC,QAAA,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACvH,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,QAAQ;QACT,OAAO,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC;CACH;;AAED;;;;;;;GAOG;AACH,2BAAmC,SAAQ,8BAA4C;IACpF,YAAY,QAAgB;QACzB,KAAK,CAAC,QAAA,6BAA6B,EAAE,aAAa,QAAQ,0CAA0C,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpH,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,QAAQ;QACT,OAAO,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC;CACH;;AAQD,2HAA2H;AAC3H,MAAM,uBAAuB,GAA8C,IAAI,GAAG,CAA+B;IAC9G;QACG,QAAA,mBAAmB;QACnB,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,EAAE,EAAE,CACrC,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,aAAa,KAAK,QAAQ;YAC5F,CAAC,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,IAAA,6BAAc,EAAC,WAAW,CAAC,EAAE,aAAa,CAAC;YACpE,CAAC,CAAC,SAAS;KACnB;IACD,CAAC,QAAA,yBAAyB,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC5H;QACG,QAAA,4BAA4B;QAC5B,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;KACxI;IACD,CAAC,QAAA,8BAA8B,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACrI,CAAC,QAAA,6BAA6B,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;CACrI,CAAC,CAAC;AAEH;;;;GAIG;AACH,yBAAgC,KAAc;IAC3C,OAAO,CACJ,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,CACtI,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,6BAAoC,KAAc;IAC/C,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpF,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,IAAI,CAAC,OAAO,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;AACnG,CAAC;AAED;;;;GAIG;AACH,8BAAqC,KAAc;IAChD,OAAO,gBAAgB,CAAC,KAAK,EAAE,oBAAoB,EAAE,QAAA,yBAAyB,CAAC,CAAC;AACnF,CAAC;AAED,2FAA2F;AAC3F,gCAAuC,KAAc;IAClD,OAAO,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,EAAE,QAAA,4BAA4B,CAAC,CAAC;AACxF,CAAC;AAED,6FAA6F;AAC7F,kCAAyC,KAAc;IACpD,OAAO,gBAAgB,CAAC,KAAK,EAAE,wBAAwB,EAAE,QAAA,8BAA8B,CAAC,CAAC;AAC5F,CAAC;AAED,4FAA4F;AAC5F,iCAAwC,KAAc;IACnD,OAAO,gBAAgB,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAA,6BAA6B,CAAC,CAAC;AAC1F,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc,EAAE,IAAY,EAAE,IAAY;IACjE,OAAO,KAAK,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,IAAK,KAAyC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACtH,CAAC;AAED;;mCAEmC;AACnC,MAAM,6BAA6B,GAAG,mDAAmD,CAAC;AAE1F;;;;;;;;;;;;;;;;GAgBG;AACH,yBAAgC,KAAc;IAC3C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAI,KAAyC,CAAC,IAAI,CAAC;IAC7D,IAAI,IAAI,KAAK,QAAA,mBAAmB,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC;AACrG,CAAC"}

package/lib/format-log-arg.d.ts

@@ -0,0 +1,33 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+/** Options of {@link formatLogArg}. An object, so that a `map` index cannot be passed as one. */
+export interface FormatLogArgOptions {
+    /** The `space` argument of `JSON.stringify`; compact where omitted. */
+    readonly indent?: number;
+}
+/**
+ * Render a log argument as text for a log line:
+ * - a string as it is;
+ * - an error by its stack and causes;
+ * - another object as JSON, cut to a bounded size;
+ * - anything else by its description, as is an object JSON renders as nothing
+ *   or cannot render.
+ *
+ * The cut is needed because the log call serialises synchronously and every
+ * Langium AST node is cyclic. The JSON stops at `LOG_ARG_DEPTH` levels,
+ * `LOG_ARG_ITEMS` items or keys and `LOG_ARG_STRING_LENGTH` characters per
+ * string or key, and at about `LOG_ARG_LENGTH` in all. A reference back to an
+ * object that contains it reads `[Circular]`, and a BigInt its digits; the
+ * markers are JSON strings. `util.inspect` would cut too, but is Node-only.
+ *
+ * Never throws, since a log call that throws loses the line and interrupts its
+ * caller. A `%s`-style specifier is not substituted.
+ */
+export declare function formatLogArg(value: unknown, options?: FormatLogArgOptions): string;
+//# sourceMappingURL=format-log-arg.d.ts.map

package/lib/format-log-arg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-log-arg.d.ts","sourceRoot":"","sources":["../src/format-log-arg.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAgBlF,iGAAiG;AACjG,MAAM,WAAW,mBAAmB;IACjC,uEAAuE;IACvE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,GAAE,mBAAwB,GAAG,MAAM,CAiBtF"}

package/lib/format-log-arg.js

@@ -0,0 +1,158 @@
+"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
+ ********************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatLogArg = formatLogArg;
+const primitives_1 = require("./messages/primitives");
+/** How deep an object argument is rendered; a deeper object reads `[Object]` or `[Array]`. */
+const LOG_ARG_DEPTH = 2;
+/** How many items or keys of one array or object are rendered. */
+const LOG_ARG_ITEMS = 100;
+/** How many characters of one string or key inside an object argument are rendered. */
+const LOG_ARG_STRING_LENGTH = 10_000;
+/**
+ * About how many characters one argument renders, since the limits above
+ * multiply. The entry that would pass it reads `...`; later ones are left out.
+ */
+const LOG_ARG_LENGTH = 100_000;
+/**
+ * Render a log argument as text for a log line:
+ * - a string as it is;
+ * - an error by its stack and causes;
+ * - another object as JSON, cut to a bounded size;
+ * - anything else by its description, as is an object JSON renders as nothing
+ *   or cannot render.
+ *
+ * The cut is needed because the log call serialises synchronously and every
+ * Langium AST node is cyclic. The JSON stops at `LOG_ARG_DEPTH` levels,
+ * `LOG_ARG_ITEMS` items or keys and `LOG_ARG_STRING_LENGTH` characters per
+ * string or key, and at about `LOG_ARG_LENGTH` in all. A reference back to an
+ * object that contains it reads `[Circular]`, and a BigInt its digits; the
+ * markers are JSON strings. `util.inspect` would cut too, but is Node-only.
+ *
+ * Never throws, since a log call that throws loses the line and interrupts its
+ * caller. A `%s`-style specifier is not substituted.
+ */
+function formatLogArg(value, options = {}) {
+    if (typeof value === 'string') {
+        return value;
+    }
+    if (typeof value === 'object' && value !== null) {
+        try {
+            // `undefined` where `toJSON` returns nothing.
+            const json = value instanceof Error ? undefined : JSON.stringify(value, boundedReplacer(options.indent), options.indent);
+            if (json !== undefined) {
+                return json;
+            }
+        }
+        catch {
+            // A throwing getter or `toJSON`, or a revoked proxy; described below instead.
+        }
+    }
+    return (0, primitives_1.describeErrorWithStack)(value);
+}
+function boundedReplacer(indent) {
+    // Keyed by the object last entered; JSON is written depth first, so its entry is on the path being written.
+    const visits = new Map();
+    const isOnPath = (value, holder) => holder !== undefined && ((visits.get(holder)?.source ?? holder) === value || isOnPath(value, visits.get(holder)?.parent));
+    // As `JSON.stringify` clamps its `space`.
+    const space = Math.min(10, Math.max(0, Math.floor(indent ?? 0)));
+    let remaining = LOG_ARG_LENGTH;
+    let exhausted = false;
+    return function (key, raw) {
+        if (exhausted) {
+            // In an object the entry is left out; in an array it reads `null`.
+            return undefined;
+        }
+        // A boxed primitive is written as its value, so it is cut as one.
+        const value = raw instanceof String || raw instanceof Number || raw instanceof Boolean || raw instanceof BigInt ? raw.valueOf() : raw;
+        const depth = (visits.get(this)?.depth ?? -1) + 1;
+        const rendered = render(value, depth, this);
+        const isObject = typeof rendered === 'object' && rendered !== null;
+        // What this entry writes: its value, its key unless it is an item, and the punctuation and indent around them.
+        const written = isObject ? undefined : JSON.stringify(rendered);
+        // A value JSON cannot write is left out of an object, key and all, and written as `null` in an array.
+        const leftOut = !isObject && written === undefined && !Array.isArray(this);
+        const valueLength = isObject ? 2 : (written?.length ?? 4);
+        const keyLength = depth === 0 || Array.isArray(this) ? 0 : JSON.stringify(key).length + 1 + (space > 0 ? 1 : 0);
+        const layoutLength = 1 + (space > 0 ? (1 + space * depth) * (isObject ? 2 : 1) : 0);
+        const length = leftOut ? 0 : valueLength + keyLength + layoutLength;
+        if (length > remaining) {
+            exhausted = true;
+            return '...';
+        }
+        remaining -= length;
+        if (isObject) {
+            visits.set(rendered, { parent: this, depth, source: value });
+        }
+        return rendered;
+    };
+    function render(value, depth, holder) {
+        if (typeof value === 'string') {
+            return cutString(value);
+        }
+        if (typeof value === 'bigint') {
+            return String(value);
+        }
+        if (typeof value !== 'object' || value === null) {
+            return value;
+        }
+        if (isOnPath(value, holder)) {
+            return '[Circular]';
+        }
+        if (depth > LOG_ARG_DEPTH) {
+            return Array.isArray(value) || isTypedArray(value) ? '[Array]' : '[Object]';
+        }
+        return cut(value);
+    }
+}
+function cutString(value) {
+    const more = value.length - LOG_ARG_STRING_LENGTH;
+    return more > 0 ? `${value.slice(0, LOG_ARG_STRING_LENGTH)}... ${more} more characters` : value;
+}
+function isTypedArray(value) {
+    return ArrayBuffer.isView(value) && !(value instanceof DataView);
+}
+/**
+ * `value`, or a copy of its first {@link LOG_ARG_ITEMS} items or keys, keys cut
+ * as strings are, with a note of how many more there are. A typed array is
+ * copied to an array, which reads its items without listing its keys.
+ */
+function cut(value) {
+    if (Array.isArray(value) || isTypedArray(value)) {
+        const more = value.length - LOG_ARG_ITEMS;
+        const items = Array.from({ length: Math.min(value.length, LOG_ARG_ITEMS) }, (_, i) => value[i]);
+        return more > 0 ? [...items, `... ${more} more items`] : Array.isArray(value) ? value : items;
+    }
+    // Linear in the keys: no API lists the first few alone, and `JSON.stringify` would list them all too.
+    const keys = Object.keys(value);
+    const more = keys.length - LOG_ARG_ITEMS;
+    const kept = keys.slice(0, LOG_ARG_ITEMS);
+    if (more <= 0 && kept.every(key => key.length <= LOG_ARG_STRING_LENGTH)) {
+        return value;
+    }
+    // No prototype, so a `__proto__` key is an entry like any other.
+    const copy = Object.create(null);
+    // A cut key or the note can equal a key already written; numbered, so neither entry is lost.
+    const add = (key, entry) => {
+        let unique = key;
+        for (let i = 2; unique in copy; i++) {
+            unique = `${key} (${i})`;
+        }
+        copy[unique] = entry;
+    };
+    for (const key of kept) {
+        add(cutString(key), value[key]);
+    }
+    if (more > 0) {
+        add(`... ${more} more keys`, '...');
+    }
+    return copy;
+}
+//# sourceMappingURL=format-log-arg.js.map

package/lib/format-log-arg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-log-arg.js","sourceRoot":"","sources":["../src/format-log-arg.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,sDAA+D;AAE/D,8FAA8F;AAC9F,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,kEAAkE;AAClE,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,uFAAuF;AACvF,MAAM,qBAAqB,GAAG,MAAM,CAAC;AACrC;;;GAGG;AACH,MAAM,cAAc,GAAG,OAAO,CAAC;AAQ/B;;;;;;;;;;;;;;;;;GAiBG;AACH,sBAA6B,KAAc,EAAE,OAAO,GAAwB,EAAE;IAC3E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC/C,IAAI,CAAC;YACF,8CAA8C;YAC9C,MAAM,IAAI,GACP,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YAC/G,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACtB,OAAO,IAAI,CAAC;YACf,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACN,8EAA8E;QACjF,CAAC;IACJ,CAAC;IACD,OAAO,IAAA,mCAAsB,EAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AASD,SAAS,eAAe,CAAC,MAA0B;IAChD,4GAA4G;IAC5G,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiB,CAAC;IACxC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,MAA0B,EAAW,EAAE,CACrE,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7H,0CAA0C;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE,IAAI,SAAS,GAAG,cAAc,CAAC;IAC/B,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,OAAO,UAAwB,GAAW,EAAE,GAAY;QACrD,IAAI,SAAS,EAAE,CAAC;YACb,mEAAmE;YACnE,OAAO,SAAS,CAAC;QACpB,CAAC;QACD,kEAAkE;QAClE,MAAM,KAAK,GAAG,GAAG,YAAY,MAAM,IAAI,GAAG,YAAY,MAAM,IAAI,GAAG,YAAY,OAAO,IAAI,GAAG,YAAY,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QACtI,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC;QACnE,+GAA+G;QAC/G,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAChE,sGAAsG;QACtG,MAAM,OAAO,GAAG,CAAC,QAAQ,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChH,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpF,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,SAAS,GAAG,YAAY,CAAC;QACpE,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;YACtB,SAAS,GAAG,IAAI,CAAC;YACjB,OAAO,KAAK,CAAC;QAChB,CAAC;QACD,SAAS,IAAI,MAAM,CAAC;QACpB,IAAI,QAAQ,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAe,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,QAAQ,CAAC;IACnB,CAAC,CAAC;IAEF,SAAS,MAAM,CAAC,KAAc,EAAE,KAAa,EAAE,MAAc;QAC1D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC/C,OAAO,KAAK,CAAC;QAChB,CAAC;QACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;YAC3B,OAAO,YAAY,CAAC;QACvB,CAAC;QACD,IAAI,KAAK,GAAG,aAAa,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QAC/E,CAAC;QACD,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC;IAClD,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC,OAAO,IAAI,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC;AACnG,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IAChC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,YAAY,QAAQ,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,SAAS,GAAG,CAAC,KAAa;IACvB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC;QAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAChG,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACjG,CAAC;IACD,sGAAsG;IACtG,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;IAC1C,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,qBAAqB,CAAC,EAAE,CAAC;QACvE,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,iEAAiE;IACjE,MAAM,IAAI,GAA4B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1D,6FAA6F;IAC7F,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,KAAc,EAAQ,EAAE;QAC/C,IAAI,MAAM,GAAG,GAAG,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;IACxB,CAAC,CAAC;IACF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACtB,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,EAAG,KAAiC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACZ,GAAG,CAAC,OAAO,IAAI,YAAY,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,IAAI,CAAC;AACf,CAAC"}

package/lib/glsp-edits-settled-actions.d.ts

@@ -0,0 +1,54 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+/**
+ * A request the server answers, with an {@link EditsSettledAction}, once every
+ * edit the client sent before it has been handled and its text has reached
+ * the language client, so the client knows those edits are answered.
+ *
+ * An operation has no answer of its own: the server replies with a model
+ * update and a dirty state, with a message, or with nothing at all when the
+ * operation changed nothing. The server handles a client's actions one at a
+ * time, so a request sent after the edits is answered after them, whatever
+ * each one answered. A server that fails it answers with a GLSP
+ * `RejectAction`, which ends the wait too.
+ */
+export interface RequestEditsSettledAction {
+    /** Answered only by a server that advertises this kind. The framework's dispatcher sends none to a server that does not. */
+    kind: typeof RequestEditsSettledAction.KIND;
+    /** The id the response echoes as its `responseId`. Empty until the dispatcher assigns one. */
+    requestId: string;
+    /**
+     * How long the server waits before it rejects the request, as it does any
+     * request; a rejection then means not settled, and the answer that follows
+     * is dropped. GLSP's `requestUntil` sets one; `request` leaves it unset.
+     */
+    timeout?: number;
+    /** GLSP's typing marker for the response. Never set. */
+    readonly _?: EditsSettledAction;
+}
+export declare namespace RequestEditsSettledAction {
+    const KIND = "hydraniumRequestEditsSettled";
+    function create(options?: {
+        requestId?: string;
+    }): RequestEditsSettledAction;
+}
+/** The server's answer to a {@link RequestEditsSettledAction}. */
+export interface EditsSettledAction {
+    /** No client handler takes this kind: the dispatcher settles the request by {@link responseId} instead. */
+    kind: typeof EditsSettledAction.KIND;
+    /** The `requestId` of the request this answers. The server's dispatcher sets it. */
+    responseId: string;
+}
+export declare namespace EditsSettledAction {
+    const KIND = "hydraniumEditsSettled";
+    function create(options?: {
+        responseId?: string;
+    }): EditsSettledAction;
+}
+//# sourceMappingURL=glsp-edits-settled-actions.d.ts.map