@hydranium/core 1.0.0-next.30 → 1.0.0-next.300

package/lib/documents/version-sync-service.d.ts

@@ -0,0 +1,138 @@
+/********************************************************************************
+ * 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 LangiumDocument, type URI } from '@hydranium/langium';
+import { type Tracer } from '@hydranium/protocol';
+import { Disposable, Emitter, type Event } from 'vscode-languageserver-protocol';
+import { type LogNameOptions } from '../langium/diagnostics/logger.js';
+import { type ServerSharedServices } from '../langium/module.js';
+/** A build {@link VersionSyncService.requestRecoveryBuild} schedules. */
+export interface RecoveryBuildRequest {
+    /** Remove the document instead of building it. */
+    readonly deleted?: boolean;
+    /** Staged for the build, as `HydraniumDocumentBuilder.scheduleUpdate` takes it. */
+    readonly reason?: string;
+    /** Asked again inside the lock, where a build that ran meanwhile may have made the request moot. */
+    readonly stillNeeded: () => boolean;
+    /** Build even while a {@link VersionSyncService.registerDeferredBuilds} check holds the URI back. */
+    readonly ignoreDeferred?: boolean;
+}
+/**
+ * Keeps each workspace root's `ModelLedger` record in step with the
+ * text store, and owns every build that syncs a root to its text or recovers
+ * one a build left behind.
+ */
+export interface VersionSyncService {
+    /**
+     * Report a root a factory, registry, integrity repair or other producer
+     * made. Below `Parsed` it is marked a placeholder. Otherwise `origin.version`,
+     * the store's version read before the parse, is recorded; a registered
+     * document is then reconciled with the store, re-versioned and recorded at
+     * the store's version of its text, built if behind, and announced on
+     * {@link onDidRecordModel}. `origin.text` stands for a root whose CST is not
+     * the text it describes.
+     */
+    modelProduced(document: LangiumDocument, origin?: {
+        version?: number;
+        text?: string;
+    }): void;
+    /**
+     * Build `uri` from a `WorkspaceLock` read, so the build queues behind a
+     * running one rather than cancelling it. Requests made while one for `uri`
+     * is pending share its next build. Resolves once a build that carried this
+     * request completed, or once a check before a build found it no longer
+     * needed or deferred. A build a later write cancelled does not count: the
+     * request rides the next one. Rejects with the last build's error once builds
+     * carrying this request have failed more often than it may retry, so a
+     * caller waiting on the build can stop; the caller ends that failure, and
+     * logs it if nothing else reports it.
+     */
+    requestRecoveryBuild(uri: URI, request: RecoveryBuildRequest): Promise<void>;
+    /**
+     * Build `uri` unless it is {@link isSyncedTo synced to} `textVersion`, asked
+     * again inside the lock. `undefined` when no build is needed, else the
+     * {@link requestRecoveryBuild} promise.
+     */
+    syncTo(uri: URI, textVersion: number): Promise<void> | undefined;
+    /**
+     * Whether `uri`'s root was parsed from text at `textVersion` or later; requests
+     * nothing. A root with no recorded version or a placeholder counts as synced,
+     * since no build records a version for it, and so does a URI with no document.
+     */
+    isSyncedTo(uri: URI, textVersion: number): boolean;
+    /**
+     * Register `isDeferred`, which answers whether its caller holds back a build
+     * of a URI it will request later, as the update handler does for a debounced
+     * editor change. A caller that drops a held change has to leave the URI to
+     * another build.
+     */
+    registerDeferredBuilds(isDeferred: (uri: URI) => boolean): Disposable;
+    /**
+     * Fires for every reconciled root. A cancel cannot skip it, unlike a
+     * `Parsed` phase listener. It can fire inside a build's write lock, so a
+     * listener that requests a build must not await it.
+     */
+    readonly onDidRecordModel: Event<LangiumDocument>;
+}
+/** A request waiting in {@link PendingRecoveryBuilds}, with the failed builds that carried it. */
+export interface QueuedRecoveryBuild {
+    readonly request: RecoveryBuildRequest;
+    failures: number;
+    /** Settles the request once a build carried it or it was no longer needed. */
+    readonly resolve: () => void;
+    /** Settles the request once it has used its retries, with the last build's error. */
+    readonly reject: (error: unknown) => void;
+}
+/** The requests waiting on one URI's builds in {@link DefaultVersionSyncService}. */
+export interface PendingRecoveryBuilds {
+    readonly queued: QueuedRecoveryBuild[];
+}
+/**
+ * Collaborators are resolved per call: the registry and its document factory,
+ * which construct each other, report roots to this service.
+ */
+export declare class DefaultVersionSyncService implements VersionSyncService {
+    protected readonly services: ServerSharedServices;
+    protected readonly tracer: Tracer;
+    protected readonly recordedEmitter: Emitter<LangiumDocument<import("@hydranium/langium").AstNode>>;
+    protected readonly deferredBuildChecks: Set<(uri: URI) => boolean>;
+    protected readonly pendingBuilds: Map<string, PendingRecoveryBuilds>;
+    /** Retries of each request after a failed build before it is rejected. */
+    protected readonly maxBuildRetries: number;
+    constructor(services: ServerSharedServices, options?: LogNameOptions);
+    get onDidRecordModel(): Event<LangiumDocument>;
+    modelProduced(document: LangiumDocument, origin?: {
+        version?: number;
+        text?: string;
+    }): void;
+    syncTo(uri: URI, textVersion: number): Promise<void> | undefined;
+    requestRecoveryBuild(uri: URI, request: RecoveryBuildRequest): Promise<void>;
+    registerDeferredBuilds(isDeferred: (uri: URI) => boolean): Disposable;
+    isSyncedTo(uri: URI, textVersion: number): boolean;
+    /** The text `document`'s root was parsed from, or for a root built without either record or CST, the document's own. */
+    protected parsedText(document: LangiumDocument): string;
+    /**
+     * Run `entry`'s requests, one build per batch, until none is queued, and
+     * settle each. A request a failed build carried is queued again
+     * {@link maxBuildRetries} times, then rejected; one a cancelled
+     * build carried is queued again without counting. The entry is dropped
+     * in the same tick as the last check of the queue, so no request lands in
+     * an entry nothing runs any more.
+     */
+    protected runBuilds(key: string, uri: URI, entry: PendingRecoveryBuilds): Promise<void>;
+    /** Whether `request` still needs its build, and no deferral it heeds holds it back. Runs inside the lock read. */
+    protected isStillNeeded(uri: URI, request: RecoveryBuildRequest): boolean;
+    /**
+     * One build for every request of `batch`, removing the document when the
+     * latest of them asks to, as `HydraniumDocumentBuilder.scheduleUpdate`
+     * merges a change and a deletion. Runs inside the lock read.
+     */
+    protected scheduleBatch(uri: URI, batch: readonly RecoveryBuildRequest[]): Promise<void>;
+    protected isDeferred(uri: URI): boolean;
+}
+//# sourceMappingURL=version-sync-service.d.ts.map

package/lib/documents/version-sync-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-sync-service.d.ts","sourceRoot":"","sources":["../../src/documents/version-sync-service.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAiB,KAAK,eAAe,EAAE,KAAK,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,KAAK,MAAM,EAA6D,MAAM,qBAAqB,CAAC;AAC7G,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAIjE,yEAAyE;AACzE,MAAM,WAAW,oBAAoB;IAClC,kDAAkD;IAClD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,mFAAmF;IACnF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,oGAAoG;IACpG,QAAQ,CAAC,WAAW,EAAE,MAAM,OAAO,CAAC;IACpC,qGAAqG;IACrG,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAChC;;;;;;;;OAQG;IACH,aAAa,CAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC7F;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IACjE;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;IACnD;;;;;OAKG;IACH,sBAAsB,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,GAAG,UAAU,CAAC;IACtE;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,kGAAkG;AAClG,MAAM,WAAW,mBAAmB;IACjC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,8EAA8E;IAC9E,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,qFAAqF;IACrF,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CAC5C;AAED,qFAAqF;AACrF,MAAM,WAAW,qBAAqB;IACnC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,qBAAa,yBAA0B,YAAW,kBAAkB;IAS9D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB;IARpD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,QAAQ,CAAC,eAAe,iEAAkC;IACpE,SAAS,CAAC,QAAQ,CAAC,mBAAmB,YAAiB,GAAG,KAAK,OAAO,EAAI;IAC1E,SAAS,CAAC,QAAQ,CAAC,aAAa,qCAA4C;IAC5E,0EAA0E;IAC1E,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAK;IAE/C,YACsB,QAAQ,EAAE,oBAAoB,EACjD,OAAO,GAAE,cAAmB,EAG9B;IAED,IAAI,gBAAgB,IAAI,KAAK,CAAC,eAAe,CAAC,CAE7C;IAED,aAAa,CAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,IAAI,CA+B/F;IAED,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAG/D;IAED,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAc3E;IAED,sBAAsB,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,GAAG,UAAU,CAGpE;IAED,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAQjD;IAED,wHAAwH;IACxH,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAEtD;IAED;;;;;;;OAOG;IACH,UAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAiD5F;IAED,kHAAkH;IAClH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAExE;IAED;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,oBAAoB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAIvF;IAED,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEtC;CACH"}

package/lib/documents/version-sync-service.js

@@ -0,0 +1,173 @@
+/********************************************************************************
+ * 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 { DocumentState } from '@hydranium/langium';
+import { UNRECORDED_VERSION, describeError, describeErrorWithStack } from '@hydranium/protocol';
+import { Disposable, Emitter } from 'vscode-languageserver-protocol';
+import { HydraniumWorkspaceLock } from '../langium/workspace/hydranium-workspace-lock.js';
+import { HydraniumTextDocuments } from './hydranium-text-documents.js';
+/**
+ * Collaborators are resolved per call: the registry and its document factory,
+ * which construct each other, report roots to this service.
+ */
+export class DefaultVersionSyncService {
+    services;
+    tracer;
+    recordedEmitter = new Emitter();
+    deferredBuildChecks = new Set();
+    pendingBuilds = new Map();
+    /** Retries of each request after a failed build before it is rejected. */
+    maxBuildRetries = 1;
+    constructor(services, options = {}) {
+        this.services = services;
+        this.tracer = services.Tracer.for(options.logName ?? 'VersionSyncService').trace('instantiated');
+    }
+    get onDidRecordModel() {
+        return this.recordedEmitter.event;
+    }
+    modelProduced(document, origin = {}) {
+        const workspace = this.services.workspace;
+        const ledger = workspace.ModelLedger;
+        const root = document.parseResult.value;
+        if (document.state < DocumentState.Parsed) {
+            ledger.markPlaceholder(root);
+            return;
+        }
+        if (origin.version !== undefined) {
+            ledger.record(root, origin.version, origin.text);
+        }
+        const store = workspace.TextDocuments;
+        // Unregistered, it is a probe or a load whose registration reports it again.
+        if (!(store instanceof HydraniumTextDocuments) || workspace.LangiumDocuments.getDocument(document.uri) !== document) {
+            return;
+        }
+        const uri = document.uri.toString();
+        // Against the parsed text: the text document may already hold a newer edit.
+        const version = store.reconcileExternalContent(uri, origin.text ?? this.parsedText(document));
+        if (version !== undefined) {
+            if (document.textDocument.version !== version) {
+                // An empty-changes update only re-stamps the version.
+                store.update(document.textDocument, [], version);
+            }
+            ledger.record(root, version, origin.text);
+        }
+        // Nothing waits on this build, so its failure ends here.
+        this.syncTo(document.uri, store.version(uri))?.catch((error) => this.tracer.withUri(uri).error(`The build that would sync the root to its text failed. ${describeErrorWithStack(error)}`));
+        this.recordedEmitter.fire(document);
+    }
+    syncTo(uri, textVersion) {
+        const behind = () => !this.isSyncedTo(uri, textVersion);
+        return behind() ? this.requestRecoveryBuild(uri, { stillNeeded: behind }) : undefined;
+    }
+    requestRecoveryBuild(uri, request) {
+        return new Promise((resolve, reject) => {
+            const key = uri.toString();
+            const queued = { request, failures: 0, resolve, reject };
+            const pending = this.pendingBuilds.get(key);
+            if (pending) {
+                // Not dropped: the pending build may have read the text before this request's change.
+                pending.queued.push(queued);
+                return;
+            }
+            const entry = { queued: [queued] };
+            this.pendingBuilds.set(key, entry);
+            void this.runBuilds(key, uri, entry);
+        });
+    }
+    registerDeferredBuilds(isDeferred) {
+        this.deferredBuildChecks.add(isDeferred);
+        return Disposable.create(() => this.deferredBuildChecks.delete(isDeferred));
+    }
+    isSyncedTo(uri, textVersion) {
+        const root = this.services.workspace.LangiumDocuments.getDocument(uri)?.parseResult.value;
+        if (root === undefined) {
+            return true;
+        }
+        const ledger = this.services.workspace.ModelLedger;
+        const recorded = ledger.versionOf(root);
+        return recorded === UNRECORDED_VERSION || ledger.isPlaceholder(root) || recorded >= textVersion;
+    }
+    /** The text `document`'s root was parsed from, or for a root built without either record or CST, the document's own. */
+    parsedText(document) {
+        return this.services.workspace.ModelLedger.textOf(document.parseResult.value) ?? document.textDocument.getText();
+    }
+    /**
+     * Run `entry`'s requests, one build per batch, until none is queued, and
+     * settle each. A request a failed build carried is queued again
+     * {@link maxBuildRetries} times, then rejected; one a cancelled
+     * build carried is queued again without counting. The entry is dropped
+     * in the same tick as the last check of the queue, so no request lands in
+     * an entry nothing runs any more.
+     */
+    async runBuilds(key, uri, entry) {
+        const tracer = this.tracer.withUri(key);
+        const lock = this.services.workspace.WorkspaceLock;
+        // Any other lock resolves a cancelled write as if it had completed, unnoticed.
+        const counting = lock instanceof HydraniumWorkspaceLock ? lock : undefined;
+        while (entry.queued.length > 0) {
+            let carried = [];
+            let build;
+            let cancellations;
+            try {
+                // The read waits until no write runs or is queued. It must not await
+                // the build, a write that queues behind it.
+                await lock.read(() => {
+                    carried = entry.queued.splice(0);
+                    const needed = carried.filter(queued => this.isStillNeeded(uri, queued.request));
+                    carried.filter(queued => !needed.includes(queued)).forEach(queued => queued.resolve());
+                    carried = needed;
+                    if (needed.length > 0) {
+                        build = this.scheduleBatch(uri, needed.map(queued => queued.request));
+                        // Read after the build is queued, which cancels the write before it.
+                        cancellations = counting?.writeCancellations;
+                    }
+                });
+                await build;
+                // A write cancelled the build, before it ran or while it did.
+                if (cancellations !== undefined && counting?.writeCancellations !== cancellations) {
+                    entry.queued.unshift(...carried);
+                    continue;
+                }
+                carried.forEach(queued => queued.resolve());
+            }
+            catch (err) {
+                const retried = carried.filter(queued => queued.failures++ < this.maxBuildRetries);
+                const givenUp = carried.filter(queued => !retried.includes(queued));
+                if (retried.length > 0) {
+                    // The only line about this failure when the retry succeeds.
+                    tracer.warn(`Requested build failed; retrying. ${describeErrorWithStack(err)}`);
+                    entry.queued.unshift(...retried);
+                }
+                if (givenUp.length > 0) {
+                    // Each requester ends the failure, so the log line is theirs.
+                    tracer.debug(`Requested build failed again; giving up. ${describeError(err)}`);
+                    givenUp.forEach(queued => queued.reject(err));
+                }
+            }
+        }
+        this.pendingBuilds.delete(key);
+    }
+    /** Whether `request` still needs its build, and no deferral it heeds holds it back. Runs inside the lock read. */
+    isStillNeeded(uri, request) {
+        return request.stillNeeded() && (request.ignoreDeferred === true || !this.isDeferred(uri));
+    }
+    /**
+     * One build for every request of `batch`, removing the document when the
+     * latest of them asks to, as `HydraniumDocumentBuilder.scheduleUpdate`
+     * merges a change and a deletion. Runs inside the lock read.
+     */
+    scheduleBatch(uri, batch) {
+        const deleted = batch.at(-1)?.deleted === true;
+        const reason = batch.find(request => request.reason !== undefined)?.reason;
+        return this.services.workspace.DocumentBuilder.scheduleUpdate(deleted ? [] : [uri], deleted ? [uri] : [], reason);
+    }
+    isDeferred(uri) {
+        return [...this.deferredBuildChecks].some(isDeferred => isDeferred(uri));
+    }
+}
+//# sourceMappingURL=version-sync-service.js.map

package/lib/documents/version-sync-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-sync-service.js","sourceRoot":"","sources":["../../src/documents/version-sync-service.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,aAAa,EAAkC,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAe,kBAAkB,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7G,OAAO,EAAE,UAAU,EAAE,OAAO,EAAc,MAAM,gCAAgC,CAAC;AAGjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,kDAAkD,CAAC;AAC1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAoFvE;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IASb,QAAQ;IARX,MAAM,CAAS;IACf,eAAe,GAAG,IAAI,OAAO,EAAmB,CAAC;IACjD,mBAAmB,GAAG,IAAI,GAAG,EAAyB,CAAC;IACvD,aAAa,GAAG,IAAI,GAAG,EAAiC,CAAC;IAC5E,0EAA0E;IACvD,eAAe,GAAW,CAAC,CAAC;IAE/C,YACsB,QAA8B,EACjD,OAAO,GAAmB,EAAE;wBADT,QAAQ;QAG3B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,oBAAoB,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACpG,CAAC;IAED,IAAI,gBAAgB;QACjB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;IACrC,CAAC;IAED,aAAa,CAAC,QAAyB,EAAE,MAAM,GAAwC,EAAE;QACtF,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC1C,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC;QACrC,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC;QACxC,IAAI,QAAQ,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC;YACzC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,OAAO;QACV,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,aAAa,CAAC;QACtC,6EAA6E;QAC7E,IAAI,CAAC,CAAC,KAAK,YAAY,sBAAsB,CAAC,IAAI,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnH,OAAO;QACV,CAAC;QACD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACpC,4EAA4E;QAC5E,MAAM,OAAO,GAAG,KAAK,CAAC,wBAAwB,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9F,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;gBAC7C,sDAAsD;gBACtD,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QACD,yDAAyD;QACzD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CACrE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,0DAA0D,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC,CAC3H,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,GAAQ,EAAE,WAAmB;QACjC,MAAM,MAAM,GAAG,GAAY,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACjE,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzF,CAAC;IAED,oBAAoB,CAAC,GAAQ,EAAE,OAA6B;QACzD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAwB,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;YAC9E,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5C,IAAI,OAAO,EAAE,CAAC;gBACX,sFAAsF;gBACtF,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC5B,OAAO;YACV,CAAC;YACD,MAAM,KAAK,GAA0B,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnC,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACN,CAAC;IAED,sBAAsB,CAAC,UAAiC;QACrD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACzC,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED,UAAU,CAAC,GAAQ,EAAE,WAAmB;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC;QAC1F,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACf,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC;QACnD,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,QAAQ,KAAK,kBAAkB,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,QAAQ,IAAI,WAAW,CAAC;IACnG,CAAC;IAED,wHAAwH;IAC9G,UAAU,CAAC,QAAyB;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IACpH,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,GAAQ,EAAE,KAA4B;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC;QACnD,+EAA+E;QAC/E,MAAM,QAAQ,GAAG,IAAI,YAAY,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,IAAI,OAAO,GAA0B,EAAE,CAAC;YACxC,IAAI,KAAgC,CAAC;YACrC,IAAI,aAAiC,CAAC;YACtC,IAAI,CAAC;gBACF,qEAAqE;gBACrE,4CAA4C;gBAC5C,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;oBAClB,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBACjC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;oBACjF,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;oBACvF,OAAO,GAAG,MAAM,CAAC;oBACjB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACrB,KAAK,GAAG,IAAI,CAAC,aAAa,CACvB,GAAG,EACH,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CACtC,CAAC;wBACF,qEAAqE;wBACrE,aAAa,GAAG,QAAQ,EAAE,kBAAkB,CAAC;oBAChD,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;gBACZ,8DAA8D;gBAC9D,IAAI,aAAa,KAAK,SAAS,IAAI,QAAQ,EAAE,kBAAkB,KAAK,aAAa,EAAE,CAAC;oBACjF,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;oBACjC,SAAS;gBACZ,CAAC;gBACD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;YAC/C,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACrB,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;gBACnF,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBACpE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,4DAA4D;oBAC5D,MAAM,CAAC,IAAI,CAAC,qCAAqC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAChF,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;gBACpC,CAAC;gBACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,8DAA8D;oBAC9D,MAAM,CAAC,KAAK,CAAC,4CAA4C,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC/E,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBACjD,CAAC;YACJ,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,kHAAkH;IACxG,aAAa,CAAC,GAAQ,EAAE,OAA6B;QAC5D,OAAO,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,GAAQ,EAAE,KAAsC;QACrE,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;QAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,EAAE,MAAM,CAAC;QAC3E,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACrH,CAAC;IAES,UAAU,CAAC,GAAQ;QAC1B,OAAO,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5E,CAAC;CACH"}

package/lib/index.d.ts

@@ -26,13 +26,18 @@ export * from './langium/project/index.js';
 export * from './langium/residency/index.js';
 export * from './langium/scope/index.js';
 export * from './langium/serialization/index.js';
+export * from './langium/trivia/index.js';
 export * from './langium/transfer/index.js';
 export * from './langium/update-rewrite/index.js';
 export * from './langium/validation/index.js';
 export * from './langium/workspace/index.js';
 export * from './langium/service-registry.js';
 export * from './langium/language-types.js';
+export * from './langium/composite-ast-reflection.js';
+export * from './langium/single-langium-copy.js';
 export * from './launcher/index.js';
+export * from './locale/index.js';
+export * from './messages/renderer.js';
 export * from './documents/index.js';
 export * from './util/index.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAGlF,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAGlF,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAIlC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC"}

package/lib/index.js

@@ -27,13 +27,21 @@ export * from './langium/project/index.js';
 export * from './langium/residency/index.js';
 export * from './langium/scope/index.js';
 export * from './langium/serialization/index.js';
+export * from './langium/trivia/index.js';
 export * from './langium/transfer/index.js';
 export * from './langium/update-rewrite/index.js';
 export * from './langium/validation/index.js';
 export * from './langium/workspace/index.js';
 export * from './langium/service-registry.js';
 export * from './langium/language-types.js';
+export * from './langium/composite-ast-reflection.js';
+export * from './langium/single-langium-copy.js';
 export * from './launcher/index.js';
+export * from './locale/index.js';
+// The renderer only. The `./messages` subpath additionally enumerates this
+// package's own declarations, which the root barrel already re-exports through
+// the modules that raise them.
+export * from './messages/renderer.js';
 export * from './documents/index.js';
 export * from './util/index.js';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,0DAA0D;AAC1D,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,0DAA0D;AAC1D,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,2EAA2E;AAC3E,+EAA+E;AAC/E,+BAA+B;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC"}

package/lib/langium/ast-extension/ast-extension-service.d.ts

@@ -13,6 +13,20 @@ import { type LogNameOptions } from '../diagnostics/logger.js';
 import { type ServerLanguageServices } from '../language-module.js';
 import { Registry, type RegistryItem } from '../../util/registry.js';
 import { type AstExtensionRegistry } from './ast-extension-contribution.js';
+/**
+ * The document-build phases an {@link AstExtension} may fire at. `Changed` has
+ * no AST yet, and `IndexedContent` carries the same per-document information
+ * as `Parsed`, so neither is one.
+ */
+export type AstExtensionPhase = DocumentState.Parsed | DocumentState.ComputedScopes | DocumentState.Linked | DocumentState.IndexedReferences | DocumentState.Validated;
+export declare namespace AstExtensionPhase {
+    /**
+     * Every {@link AstExtensionPhase}, in build order. `BuildPipelineIntegration`
+     * wires one `onDocumentPhase` listener per entry and `register` refuses a
+     * phase outside it, so the two cannot drift apart. A fresh array each call.
+     */
+    function all(): readonly AstExtensionPhase[];
+}
 /**
  * A registration that derives data from an AST node and attaches it to the
  * node at a declared document-build phase.
@@ -27,20 +41,23 @@ import { type AstExtensionRegistry } from './ast-extension-contribution.js';
  * are stored as non-enumerable own properties. Otherwise symbol providers,
  * folding, semantic tokens, and validators will treat them as real children.
  *
- * **Phase semantics:** {@link state} declares the single phase at which
+ * **Phase semantics:** {@link phase} declares the single phase at which
  * {@link compute} fires. The framework wires one `onDocumentPhase` listener per
- * useful state unconditionally, rather than deriving the set from the states
- * registrations declare — so a registration's state must be one of those, and
- * adding one is a framework change, not a registration-time choice.
+ * {@link AstExtensionPhase} unconditionally, rather than deriving the set from
+ * the phases registrations declare — so `register` refuses any other phase,
+ * and adding one is a framework change, not a registration-time choice.
  *
- * **`.ref`-dependent derivations: declare `state: ComputedScopes`, not `Linked`.**
+ * **`.ref`-dependent derivations: declare `phase: ComputedScopes`, not `Linked`.**
  * Lazy reference resolution is available from `ComputedScopes` onward — the
  * global scope is built by `IndexedContent` (which runs before
  * `ComputedScopes`), so reading a reference's `.ref` inside a `ComputedScopes`
  * callback triggers Langium's lazy lookup and returns the resolved target node.
+ * A cascade rebuild does not re-run such a derivation unless
+ * {@link DocumentBuilderOptions.refreshCrossDocumentComputedScopes} is set, so
+ * one that reads another document's node goes stale when that node changes.
  *
- * **DO NOT** stage a `state: ComputedScopes` placeholder hoping to refine it
- * via a separate `state: Linked` registration when a downstream consumer
+ * **DO NOT** stage a `phase: ComputedScopes` placeholder hoping to refine it
+ * via a separate `phase: Linked` registration when a downstream consumer
  * (typically a `ScopeExtension.addDescriptions` firing during link)
  * iterates the derived value to build a scope: `onDocumentPhase(Linked)` fires
  * AFTER Langium's `Linker.link()` has already walked the document, by which
@@ -58,32 +75,26 @@ export interface AstExtension<T extends AstNode = AstNode> extends RegistryItem
     /**
      * Per-document early-out. When set, the framework only invokes the
      * registration's callback for documents the filter accepts. If every
-     * registration at a given state rejects the document, the framework skips
+     * registration at a given phase rejects the document, the framework skips
      * the `streamAllContents` walk entirely — important for large workspaces
      * where most documents carry none of the AST shapes a given extension
      * targets.
      *
-     * Default: no filter (registration applies to every document at its state).
+     * Default: no filter (registration applies to every document at its phase).
      */
     documentFilter?: (document: LangiumDocument) => boolean;
     /**
-     * The single document-build state at which {@link compute} fires.
+     * The single document-build phase at which {@link compute} fires.
      *
-     * Useful values:
      * - `Parsed` — derivations from AST shape only, no `.ref` reads.
-     * - `ComputedScopes` — lazy `.ref` resolution available; the most common state.
+     * - `ComputedScopes` — lazy `.ref` resolution available; the most common.
      * - `Linked` — derivations needing fully resolved cross-references.
      * - `IndexedReferences` — cross-document reverse-lookup derivations.
      * - `Validated` — derivations depending on diagnostics (rare).
-     *
-     * Any other state type-checks but never fires: the framework wires a
-     * listener only for the states above. `Changed` has no AST yet, and
-     * `IndexedContent` carries the same per-document information as `Parsed`,
-     * so neither is wired.
      */
-    state: DocumentState;
+    phase: AstExtensionPhase;
     /**
-     * Mutate `node` for this registration at {@link state}. The framework hands
+     * Mutate `node` for this registration at {@link phase}. The framework hands
      * `node` typed as {@link Mutable} so computed / synthetic property
      * assignments (`node._foo = ...`) compile without per-callback
      * `asMutable(...)` casts.
@@ -106,18 +117,18 @@ export interface AstExtension<T extends AstNode = AstNode> extends RegistryItem
  *
  * Adopter overrides go through {@link DefaultAstExtensionService}; the
  * interface keeps the public API stable while internals (the bucket-
- * by-state cache) stay `protected` on the default class.
+ * by-phase cache) stay `protected` on the default class.
  */
 export interface AstExtensionService extends AstExtensionRegistry {
     /**
      * Run a single AST node through every registration declaring
-     * `phase` as its state. Honours `documentFilter` and `nodeFilter`.
+     * `phase`. Honours `documentFilter` and `nodeFilter`.
      * Primarily for tests that need to invoke an extension callback without
      * driving Langium's full document-build pipeline.
      */
     extendNode(node: AstNode, document: LangiumDocument, phase: DocumentState): void;
     /**
-     * Re-run all `compute` callbacks declaring `phase` as their state against
+     * Re-run all `compute` callbacks declaring `phase` against
      * every node in the document. Single-pass. Called by
      * `BuildPipelineIntegration` from an `onDocumentPhase` listener;
      * not for general adopter use.
@@ -140,19 +151,19 @@ export type AstExtensionServiceOptions = LogNameOptions;
  * owns the registry + per-node logic, not the listener lifecycle.
  *
  * **Performance:** `extendDocument` shares a single `streamAllContents` walk
- * per document per wired phase; cost is O(registrations-for-state × nodes),
- * and it early-outs when no registration targets the state or the document.
+ * per document per wired phase; cost is O(registrations-for-phase × nodes),
+ * and it early-outs when no registration targets the phase or the document.
  */
 export declare class DefaultAstExtensionService implements AstExtensionService {
     protected readonly services: ServerLanguageServices;
     protected readonly extensions: Registry<AstExtension<AstNode>>;
     /**
-     * Per-state bucket of registrations targeting each state. Rebuilt lazily
+     * Per-phase bucket of registrations targeting each phase. Rebuilt lazily
      * on the first refresh after a registry mutation — staleness is detected
      * via reference identity of the registry's cached array (see {@link Registry.all}).
      */
-    protected stateBuckets: Map<DocumentState, readonly AstExtension<AstNode>[]>;
-    protected stateBucketsFor: readonly AstExtension[] | undefined;
+    protected phaseBuckets: Map<DocumentState, readonly AstExtension<AstNode>[]>;
+    protected phaseBucketsFor: readonly AstExtension[] | undefined;
     protected readonly tracer: Tracer;
     constructor(services: ServerLanguageServices, options?: AstExtensionServiceOptions);
     /**
@@ -167,7 +178,7 @@ export declare class DefaultAstExtensionService implements AstExtensionService {
     register<T extends AstNode>(extension: AstExtension<T>): Disposable;
     /**
      * Production code goes through {@link extendDocument} via the
-     * `onDocumentPhase(state)` listener wired by `BuildPipelineIntegration`.
+     * `onDocumentPhase(phase)` listener wired by `BuildPipelineIntegration`.
      */
     extendNode(node: AstNode, document: LangiumDocument, phase: DocumentState): void;
     /**
@@ -185,13 +196,13 @@ export declare class DefaultAstExtensionService implements AstExtensionService {
      */
     extendDocument(document: LangiumDocument, phase: DocumentState, cancelToken?: CancellationToken): void;
     /**
-     * Bucket-by-state view of {@link extensions}, rebuilt lazily when the
+     * Bucket-by-phase view of {@link extensions}, rebuilt lazily when the
      * registry's cached `all()` reference changes. Replaces per-call allocation
      * on the per-node hot path — for a workspace with many documents at the
-     * same state, the bucket is computed once and reused until the next
+     * same phase, the bucket is computed once and reused until the next
      * register / unregister.
      */
-    protected getStateBucket(phase: DocumentState): readonly AstExtension[];
+    protected getPhaseBucket(phase: DocumentState): readonly AstExtension[];
 }
 /**
  * Assign a non-enumerable own property — for synthetic children that must NOT

package/lib/langium/ast-extension/ast-extension-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ast-extension-service.d.ts","sourceRoot":"","sources":["../../../src/langium/ast-extension/ast-extension-service.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,KAAK,OAAO,EAAY,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACjG,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAE,SAAQ,YAAY;IAC5E,yFAAyF;IACzF,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC;IACzC;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC;IACxD;;;;;;;;;;;;;;OAcG;IACH,KAAK,EAAE,aAAa,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;CAC7D;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC9D;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IACjF;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACzG;AAED,mEAAmE;AACnE,MAAM,MAAM,0BAA0B,GAAG,cAAc,CAAC;AAExD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,0BAA2B,YAAW,mBAAmB;IAahE,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB;IAZtD,SAAS,CAAC,QAAQ,CAAC,UAAU,kCAAgC;IAC7D;;;;OAIG;IACH,SAAS,CAAC,YAAY,uDAAqD;IAC3E,SAAS,CAAC,eAAe,EAAE,SAAS,YAAY,EAAE,GAAG,SAAS,CAAC;IAE/D,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGZ,QAAQ,EAAE,sBAAsB,EACnD,OAAO,GAAE,0BAA+B;IAc3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,UAAU;IAMnE;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI;IAahF;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,IAAI;IAoCtG;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,YAAY,EAAE;CAiBzE;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAOnF"}
+{"version":3,"file":"ast-extension-service.d.ts","sourceRoot":"","sources":["../../../src/langium/ast-extension/ast-extension-service.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,KAAK,OAAO,EAAY,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACjG,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GACxB,aAAa,CAAC,MAAM,GACpB,aAAa,CAAC,cAAc,GAC5B,aAAa,CAAC,MAAM,GACpB,aAAa,CAAC,iBAAiB,GAC/B,aAAa,CAAC,SAAS,CAAC;AAE7B,yBAAiB,iBAAiB,CAAC;IAChC;;;;OAIG;IACH,SAAgB,GAAG,IAAI,SAAS,iBAAiB,EAAE,CAQlD;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAE,SAAQ,YAAY;IAC5E,yFAAyF;IACzF,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC;IACzC;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC;IACxD;;;;;;;;OAQG;IACH,KAAK,EAAE,iBAAiB,CAAC;IACzB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;CAC7D;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC9D;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IACjF;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACzG;AAED,mEAAmE;AACnE,MAAM,MAAM,0BAA0B,GAAG,cAAc,CAAC;AAExD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,0BAA2B,YAAW,mBAAmB;IAahE,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB;IAZtD,SAAS,CAAC,QAAQ,CAAC,UAAU,kCAAgC;IAC7D;;;;OAIG;IACH,SAAS,CAAC,YAAY,uDAAqD;IAC3E,SAAS,CAAC,eAAe,EAAE,SAAS,YAAY,EAAE,GAAG,SAAS,CAAC;IAE/D,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAElC,YACsB,QAAQ,EAAE,sBAAsB,EACnD,OAAO,GAAE,0BAA+B,EAY1C;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,UAAU,CAclE;IAED;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI,CAW/E;IAED;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAkCrG;IAED;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,YAAY,EAAE,CAgBtE;CACH;AAKD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAOnF"}