@hydranium/core 1.0.0-next.34 → 1.0.0-next.340

package/lib/documents/ast-document-manager.d.ts

@@ -6,126 +6,171 @@
  *
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
-import { type CloseModelArgs, type Tracer, type TransferSavedEvent, type TransferUpdatedEvent, type OpenModelArgs } from '@hydranium/protocol';
-import { type AstNode, type DocumentBuilder, type FileSystemProvider, type LangiumDocument, type LangiumDocuments } from '@hydranium/langium';
+import { type CanonicalUri, type CloseModelArgs, type Tracer, type TransferSavedEvent, type TransferUpdatedEvent, type OpenModelArgs, type ModelVersion, type TextVersion } from '@hydranium/protocol';
+import { type AstNode, type LangiumDocument, type LangiumDocuments, URI } from '@hydranium/langium';
 import { type LogNameOptions } from '../langium/diagnostics/logger.js';
-/**
- * File-system provider extension that supports writes. Langium's standard
- * {@link FileSystemProvider} is read-only; the manager needs to persist saves,
- * so consumers wire in a provider that implements this superset.
- *
- * Implementations may optionally hold a reference to a
- * {@link SelfSaveRegistry} so they can record their own write mtimes and
- * help downstream file-watchers suppress echo events for those writes.
- * The framework's `DefaultFileSystemProvider` takes the registry as
- * a constructor parameter; alternative implementations can either follow
- * the same pattern or leave the field unset.
- */
-export interface WritableFileSystemProvider extends FileSystemProvider {
-    writeFile(uri: URI, content: string): Promise<void>;
-    /**
-     * Last-modified time (ms) of the file at `uri`, or `undefined` if it can't
-     * be determined (missing file, or a provider with no disk — in-memory /
-     * browser). Optional: the only consumer is self-save echo suppression
-     * (`didChangeWatchedFiles`), which simply lets a change through when the
-     * mtime is unavailable. Distinct from Langium's `stat` (whose
-     * `FileSystemNode` carries no mtime). Keeping disk access on the provider
-     * seam is what lets the LSP update handler avoid a direct `node:fs` import.
-     */
-    mtimeMs?(uri: URI): Promise<number | undefined>;
-    /**
-     * Resolve `uri` to its real on-disk identity (symlinks collapsed, `..`/`.`
-     * walked, case-folded on case-insensitive filesystems), or `undefined` *iff
-     * the filesystem knows the path is absent*. The single source of the
-     * "nothing loadable here" signal `RealpathDocumentUriPolicy` turns into
-     * the synthetic-placeholder branch of `getOrCreateDocument`.
-     *
-     * Contract for implementers:
-     * - A `file:`-backed provider returns the resolved URI when the file exists,
-     *   and `undefined` when it cannot resolve the path (missing / unreadable).
-     * - A non-`file:` URI (or any URI the provider cannot stat) passes through
-     *   **unchanged** — it is treated as present, never reported absent.
-     * - A provider with no disk to check (in-memory / browser / empty) simply
-     *   omits this method; `RealpathDocumentUriPolicy` then degrades to the
-     *   syntactic `DefaultDocumentUriPolicy` behaviour automatically.
-     *
-     * Synchronous (a `realpath` is a kernel-cached syscall) and optional — the
-     * only consumers are the document-identity policy's `canonicalUri`/`loadUri`.
-     * Keeping the syscall on the provider seam is what lets the policy stay
-     * browser-neutral (no `node:fs` import).
-     */
-    realpath?(uri: URI): URI | undefined;
-    /** Registry the provider records its own writes against. Optional — providers without watcher integration may omit. */
-    readonly selfSaveRegistry?: SelfSaveRegistry;
-}
+import { type AstDiagnostic } from '../langium/validation/document-validator.js';
+import { type WritableFileSystemProvider } from '../langium/workspace/file-system-provider.js';
 import { Disposable } from 'vscode-languageserver';
 import { type TextDocumentItem } from 'vscode-languageserver-protocol';
 import { type TextDocument } from 'vscode-languageserver-textdocument';
-import { URI } from '@hydranium/langium';
 import { type ServerSharedServices } from '../langium/module.js';
+import { type HydraniumDocumentBuilder } from '../langium/document-builder/index.js';
 import { type HydraniumTextDocuments } from './hydranium-text-documents.js';
-import { type SelfSaveRegistry } from './self-save-registry.js';
 import { type DocumentUriPolicy } from '../langium/workspace/document-uri-policy.js';
 export interface UpdateInfo {
     changed: URI[];
     deleted: URI[];
 }
 /**
- * Server-internal document envelope at the AST layer. Emitted by
- * {@link AstDocumentManager.onUpdate} / {@link AstDocumentManager.onSave}
- * for in-process subscribers (`ModelService`, integrity service, etc.).
+ * Server-internal document envelope at the AST layer, which `ModelService`
+ * reads and events hand to in-process callers.
  *
- * Carries an AST-typed root (`TAst extends AstNode`) — distinct from
- * `TransferDocument<TTransfer extends TransferElement, …>` in
- * `@hydranium/protocol`, which carries the wire-transfer shape (no
- * `$container` cycles, references as strings). The two are structural
- * twins; the type-system distinction is the generic constraint, and the
- * conversion seam between them is the framework `TransferEncoder`.
+ * `root` is the live AST the build holds, not an encoded copy like
+ * `TransferDocument.model`, so mutating it changes the model every reader sees.
  */
-export interface AstDocument<TAst extends AstNode, TDiagnostic> {
+export interface AstDocument<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> {
     root: TAst;
-    diagnostics: TDiagnostic[];
+    /** Absent until the document is validated, and on any `ModelService` read below `Validated`; `[]` means validated and clean. */
+    diagnostics?: TDiagnostic[];
     uri: string;
     /**
-     * Text-document version this snapshot was taken at — read from
-     * `LangiumDocument.textDocument.version`. Symmetric with
-     * `TransferDocument.version` on the wire side: in-process callers
-     * that hold an `AstDocument` and mutate it pass this value back as
-     * `TransferUpdateArgs.baseVersion` / `TransferSaveArgs.baseVersion` to opt
-     * into the conflict gate.
+     * The version of the text `root` was parsed from (`ModelLedger.versionOf`).
+     * A caller that mutates the document sends it back as the `baseVersion` of
+     * its session's write, and the conflict gate arms on it.
      */
-    version: number;
+    version: ModelVersion;
 }
+/**
+ * What a session's save or persist resolves to: the document, and in
+ * `persisted` the version of the text it wrote to the file. That can differ
+ * from `version` either way, since writes land between the build and the
+ * take.
+ */
+export type SavedAstDocument<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> = AstDocument<TAst, TDiagnostic> & {
+    persisted: {
+        version: TextVersion;
+    };
+};
 export declare namespace 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.
+     * Construct an {@link AstDocument} envelope, its version marked as coming
+     * from a read. `diagnostics` absent means not validated.
+     */
+    function create<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic>(uri: string, version: number, root: TAst, diagnostics?: TDiagnostic[]): AstDocument<TAst, TDiagnostic>;
+}
+/** The update event a document's build delivers, typed over the generic event wrapper. */
+export type AstDocumentUpdatedEvent<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> = TransferUpdatedEvent<AstDocument<TAst, TDiagnostic>>;
+/** The event a save delivers, typed over the generic event wrapper. */
+export type AstDocumentSavedEvent<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> = TransferSavedEvent<AstDocument<TAst, TDiagnostic>>;
+/**
+ * Why an update event fired and whose write it echoes, as
+ * {@link AstDocumentManager.attributeUpdate} answers for a document. The
+ * fields mean what they mean on `TransferUpdatedEvent`.
+ */
+export interface UpdateAttribution {
+    reason: 'changed' | 'rebuilt';
+    sourceClientId: string;
+    causedBy: string;
+}
+/** Construction options for {@link AstDocumentManager}. */
+export interface AstDocumentManagerOptions extends LogNameOptions {
+    /**
+     * Skip a queued save of a URI when a newer save of it is queued behind. The
+     * newer save took its text later, so disk ends the same with fewer writes.
+     * A skipped save announces nothing and takes the newer save's outcome: it
+     * resolves when that one lands and rejects with its error when it fails,
+     * since disk then holds neither text. Defaults to `false`: every save
+     * writes. The framework binds the manager without options, so turning this
+     * on means rebinding `AstDocumentManager` with them.
      */
-    function create<TAst extends AstNode, TDiagnostic = unknown>(uri: string, version: number, root: TAst, diagnostics?: TDiagnostic[]): AstDocument<TAst, TDiagnostic>;
+    readonly coalesceSaves?: boolean;
+}
+/**
+ * The document slot the model server and the integrity service talk to:
+ * open/close/update/save and the attribution of update events, with the LSP
+ * plumbing hidden. Events are `ModelService`'s, which builds them from here.
+ *
+ * Generic over `<TAst extends AstNode, TDiagnostic>` so each consumer projects
+ * its own AST root type and diagnostic shape into the emitted
+ * {@link AstDocument} envelopes. A diagnostic shape narrower than
+ * `AstDiagnostic` is asserted unchecked; see {@link toAstDocument}.
+ *
+ * **URI contract.** Every URI-accepting member takes a URI in *any* spelling
+ * (canonical, symlinked, `..`/case-divergent) and canonicalizes internally
+ * through the {@link DocumentUriPolicy}, so a caller never has to canonicalize
+ * first and an implementation may not require it.
+ */
+export interface AstDocumentManager<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> {
+    open(args: OpenModelArgs): Promise<Disposable>;
+    close(args: CloseModelArgs): Promise<void>;
+    isOpen(uri: string): boolean;
+    /** Apply `text` as `clientId`'s edit. Resolves to the resulting text-document version. */
+    update(uri: string, text: string, clientId: string): Promise<TextVersion>;
+    /**
+     * Write the document's current text to disk through `FileSystemTaskQueue`.
+     * The text is taken when this is called, so saves of one file land in the
+     * order they were called.
+     *
+     * Resolves to the version of the text on disk once it lands: the version
+     * taken, or under `coalesceSaves` the version of the newer save that wrote
+     * in its place. A caller reporting what it persisted takes it from here,
+     * since a version read beside the call names text a coalesced save never
+     * wrote.
+     */
+    save(uri: string, clientId: string): Promise<TextVersion>;
     /**
-     * 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.
+     * Remove the document's file through `FileSystemTaskQueue`, then the
+     * document, in a build that closes every open of it but the editor's.
+     * Resolves once that build has run, also when it fails after removing the
+     * document; rejects, having changed nothing, when the file cannot be
+     * removed.
      *
-     * 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.
+     * From the call until it settles, {@link isDeleting} answers `true`, which
+     * refuses every session's write of the document: one landing before the
+     * build would be lost with it, or, as a save, write the file back. Marked
+     * before the first await, so checks a caller runs in the same step as the
+     * call hold up to the removal. A second delete of the document while one is
+     * under way is refused, and so is a delete from inside a holder of the write
+     * lock, with `ReentrantWriteLockError`, since its builds take that lock.
+     *
+     * A change requested before the build starts merges over the deletion, and
+     * the document lives on with every open but `clientId`'s, which is closed.
+     */
+    delete(uri: string, clientId: string): Promise<void>;
+    /** Whether a {@link delete} of `uri` is under way. */
+    isDeleting(uri: string): boolean;
+    /**
+     * The client a deletion event for `uri` names: the one whose {@link delete}
+     * of it is under way, or the unknown-client id for a file removed outside
+     * any, as a file watcher reports one.
      */
-    function from<TAst extends AstNode, TDiagnostic = unknown>(document: LangiumDocument): AstDocument<TAst, TDiagnostic>;
+    attributeDeletion(uri: string): string;
+    getDocument(uri: string): LangiumDocument | undefined;
+    /**
+     * `document` as the envelope every event and snapshot read hands out, its
+     * `version` the one `ModelLedger` recorded for its root.
+     *
+     * The `uri` is the document's own canonical one, not a subscriber's
+     * spelling, so it matches the key every other layer uses. The diagnostics
+     * are asserted to be `TDiagnostic` unchecked: a lexer error or another
+     * validator's diagnostic satisfies the declared type and not a narrower one.
+     */
+    toAstDocument(document: LangiumDocument): AstDocument<TAst, TDiagnostic>;
+    /** Client id that authored the document's current version, or `undefined` for a framework-internal build. */
+    getAuthor(document: LangiumDocument): string | undefined;
+    /**
+     * The reason, source and cause of an update event for `document` emitted
+     * now, from a phase listener of the build that carries it. `ModelService`
+     * takes its update events' attribution from here, once per document and
+     * phase, so every subscriber names the same client for one build. For a
+     * document a client opened, while rebuilds validate, the answer changes
+     * once its `Validated` listeners have all run: a later event at that
+     * version is `'rebuilt'`. `TransferDocumentUpdateReason` names the cases
+     * that fall back to the last update.
+     */
+    attributeUpdate(document: LangiumDocument): UpdateAttribution;
 }
-/** Update event delivered by {@link AstDocumentManager.onUpdate} — typed alias over the generic event wrapper. */
-export type AstDocumentUpdatedEvent<TAst extends AstNode, TDiagnostic> = TransferUpdatedEvent<AstDocument<TAst, TDiagnostic>>;
-/** Save event delivered by {@link AstDocumentManager.onSave} — typed alias over the generic event wrapper. */
-export type AstDocumentSavedEvent<TAst extends AstNode, TDiagnostic> = TransferSavedEvent<AstDocument<TAst, TDiagnostic>>;
-/** Construction options for {@link AstDocumentManager}. */
-export type AstDocumentManagerOptions = LogNameOptions;
 /**
  * Higher-level facade over {@link HydraniumTextDocuments} that speaks the
  * model-server protocol (open/close/update/save with the transfer-model event
@@ -134,8 +179,9 @@ export type AstDocumentManagerOptions = LogNameOptions;
  *
  * 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.
+ * `AstDocument` envelopes. `TDiagnostic` defaults to `AstDiagnostic`; a
+ * narrower one is asserted unchecked, as
+ * {@link AstDocumentManager.toAstDocument} says.
  *
  * **URI contract.** Every URI-accepting method takes a URI in *any* spelling
  * (canonical, symlinked, `..`/case-divergent) and canonicalizes internally
@@ -146,13 +192,52 @@ export type AstDocumentManagerOptions = LogNameOptions;
  * resolution (the egress `applyEditToLanguageClient`) stay on
  * {@link HydraniumTextDocuments}, their owner.
  */
-export declare class AstDocumentManager<TAst extends AstNode = AstNode, TDiagnostic = unknown> {
+export declare class DefaultAstDocumentManager<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> implements AstDocumentManager<TAst, TDiagnostic> {
     protected readonly services: ServerSharedServices;
+    /** The last `DocumentBuilder.update`'s URIs; the reason for a document the store does not track. */
     protected lastUpdate?: UpdateInfo;
+    /**
+     * Canonical URIs a client has opened since the file was last deleted,
+     * whose versions the store keeps. One no client has opened keeps Langium's
+     * version `0` through every change of its content, so its version says
+     * nothing. Kept past the last close, since the store continues the version
+     * sequence on the next open; a delivery can land after that close.
+     */
+    protected readonly trackedUris: Set<CanonicalUri>;
+    /**
+     * Per tracked URI, the version whose `Validated` listeners last all ran,
+     * which is the version an update event was delivered for. Dropped on
+     * deletion, so a file created again with the same text is changed again.
+     */
+    protected readonly deliveredVersions: Map<CanonicalUri, number>;
+    /**
+     * Whose writes the build under way carries, set when it starts: the author
+     * of every open document's undelivered version, and the unknown-client id
+     * for a change no write explains, such as a deletion no session's delete
+     * made, a document no client has open, or a write that changed nothing.
+     * An undelivered version is one whose build has not validated it yet, so a
+     * write whose build was cancelled stays a cause of the build that takes
+     * over.
+     *
+     * Errs toward more than one cause, and so toward the unknown client, which
+     * a reader treats as foreign: an answer it repeats, never one it misses.
+     * A change no write explains counts for its own build only, so a build
+     * that takes over from a cancelled one loses it. One field for every build:
+     * a build started outside the workspace lock, such as a re-queue of an
+     * orphaned document, reads the causes of whichever build started last.
+     * An open document no build delivers, one a `shouldValidate` override
+     * skips, stays undelivered, so it is a cause of every build while open.
+     */
+    protected readonly buildCauses: Set<string>;
+    /** Per canonical URI, the client whose {@link delete} of it is under way. */
+    protected readonly deletions: Map<CanonicalUri, string>;
+    /** Per canonical URI, the newest save queued for it, which {@link coalesceSaves} lets older queued saves defer to. */
+    protected readonly newestSaves: Map<CanonicalUri, Promise<number>>;
+    protected readonly coalesceSaves: boolean;
     protected readonly textDocuments: HydraniumTextDocuments<TextDocument>;
     protected readonly fileSystemProvider: WritableFileSystemProvider;
     protected readonly langiumDocs: LangiumDocuments;
-    protected readonly documentBuilder: DocumentBuilder;
+    protected readonly documentBuilder: HydraniumDocumentBuilder;
     protected readonly uriPolicy: DocumentUriPolicy;
     protected readonly tracer: Tracer;
     constructor(services: ServerSharedServices, options?: AstDocumentManagerOptions);
@@ -177,25 +262,49 @@ export declare class AstDocumentManager<TAst extends AstNode = AstNode, TDiagnos
      */
     protected resolveLanguageId(uri: string): string;
     /**
-     * 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).
+     * The client that authored `document`'s current version, or `undefined` when
+     * no client wrote it: a document no client has open. A rebuild that keeps
+     * the version keeps its author, so this does not say who caused a build;
+     * {@link attributeUpdate} does.
+     * Honest about absence so a routing consumer tests `undefined` directly
+     * rather than against a sentinel; the presentation default
+     * ({@link UNKNOWN_CLIENT_ID}) is applied where an event needs a value.
      */
-    onSave(uri: string, listener: (event: TransferSavedEvent<AstDocument<TAst, TDiagnostic>>) => void | Promise<void>): Disposable;
-    /** Fires when `clientId` detaches from the document at `uri` (matched by canonical form). */
-    onClientClosed(uri: string, clientId: string, listener: () => void): Disposable;
-    /** Fires when the document at `uri` reaches `Validated` after each rebuild. */
-    onUpdate(uri: string, listener: (event: TransferUpdatedEvent<AstDocument<TAst, TDiagnostic>>) => void): Disposable;
+    getAuthor(document: LangiumDocument): string | undefined;
     /**
-     * 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: LangiumDocument<AstNode>): string | undefined;
+     * `'changed'` for the first delivery of the document's version, crediting
+     * its author; `'rebuilt'` for a later one, crediting nobody, since it echoes
+     * no write, and naming the build's single cause if it has one.
+     *
+     * A document the rule does not apply to (see {@link isTracked}) falls back
+     * to the last update: it is `'changed'` when its URI was passed to
+     * `DocumentBuilder.update`. An open document that a validating build skips,
+     * through a `shouldValidate` override, is never delivered, so each of its
+     * events is its author's change.
+     */
+    attributeUpdate(document: LangiumDocument): UpdateAttribution;
+    /**
+     * Whether the version rule applies to `uri`: the store keeps its version,
+     * and rebuilds validate. With `updateBuildOptions.validation` off no version
+     * is ever delivered, and the rule would report every event of an open
+     * document as its author's change.
+     */
+    protected isTracked(uri: CanonicalUri): boolean;
+    /**
+     * Whether the store keeps `uri`'s version: a client opened it since its
+     * file was last deleted, or has it open still, as an editor keeps a
+     * deleted file's buffer.
+     */
+    protected keepsVersion(uri: CanonicalUri): boolean;
+    /**
+     * Record that `version` of `document` was delivered, when the store tracks
+     * it. The version the listeners saw, not the document's current one: a
+     * write during them has moved that on, and marking it would report the
+     * write's own build as rebuilt.
+     */
+    protected markDelivered(document: LangiumDocument, version: number): void;
+    /** Whether `version` of `uri` was delivered. */
+    protected isDelivered(uri: string, version: number): boolean;
     open(args: OpenModelArgs): Promise<Disposable>;
     close(args: CloseModelArgs): Promise<void>;
     /**
@@ -209,7 +318,7 @@ export declare class AstDocumentManager<TAst extends AstNode = AstNode, TDiagnos
      * correlate the change against subsequent build events can. Throws if the
      * document isn't open.
      */
-    update(uri: string, text: string, clientId: string): Promise<number>;
+    update(uri: string, text: string, clientId: string): Promise<TextVersion>;
     /**
      * Persist the current text-document content for `uri` to disk and emit
      * the `didSaveTextDocument` notification. The text is read from the
@@ -217,12 +326,37 @@ export declare class AstDocumentManager<TAst extends AstNode = AstNode, TDiagnos
      * callers don't need to pass it — the manager owns content and version
      * sequencing.
      *
+     * The text is taken synchronously, before the save waits in the file's task
+     * queue; the compare and the write run in the queue. Taken later, a save
+     * that waits behind another writes whatever the store holds when its turn
+     * comes, edits made after the call included, and announces that text under
+     * its own client id.
+     *
+     * **The write is skipped when the file already holds that text; the
+     * notification is not.** A save announces that the content is on disk, which
+     * is true either way — so a subscriber clearing a dirty marker or reacting to
+     * a persist behaves the same, while an mtime is not moved for byte-identical
+     * content that a downstream mtime-keyed build would then read as new work.
+     *
      * Throws if no document is open for `uri`.
      */
-    save(uri: string, clientId: string): Promise<void>;
+    save(uri: string, clientId: string): Promise<TextVersion>;
+    delete(uri: string, clientId: string): Promise<void>;
+    isDeleting(uri: string): boolean;
+    attributeDeletion(uri: string): string;
+    /** Write `text` to `uri` unless the file already holds it, then announce the save. Runs inside the file's task queue. */
+    protected writeSave(uri: CanonicalUri, text: string, clientId: string): Promise<void>;
+    /**
+     * Whether the file at `uri` already holds `text`.
+     *
+     * Compared by CONTENT rather than against a remembered version, so a write
+     * from outside this server is still corrected: a version this manager already
+     * saved says nothing about what is on disk now. `false` when the file cannot
+     * be read at all, which is the answer that writes — a document whose file does
+     * not exist yet is exactly the one a first save has to create.
+     */
+    protected matchesDisk(uri: string, text: string): Promise<boolean>;
     isOpen(uri: string): boolean;
-    /** True if the URI was in the directly-changed set of the most recent build (not just affected). */
-    isDirectChange(uri: string): boolean;
     /**
      * The `LangiumDocument` for an externally-supplied URI, looked up by its
      * canonical identity. Folds the `getDocument(toUri(canonicalUri(uri)))` idiom
@@ -232,12 +366,10 @@ export declare class AstDocumentManager<TAst extends AstNode = AstNode, TDiagnos
      */
     getDocument(uri: string): LangiumDocument | undefined;
     protected createDocumentFromTextOrFileSystem(uri: string, languageId?: string, version?: number, text?: string): Promise<TextDocumentItem>;
-    readFile(uri: string): Promise<string>;
     /**
-     * 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.
+     * Events and the model service's snapshot reads both come through here, so
+     * an override that re-shapes the document re-shapes both.
      */
-    protected toAstDocument(document: LangiumDocument): AstDocument<TAst, TDiagnostic>;
+    toAstDocument(document: LangiumDocument): AstDocument<TAst, TDiagnostic>;
 }
 //# sourceMappingURL=ast-document-manager.d.ts.map

package/lib/documents/ast-document-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ast-document-manager.d.ts","sourceRoot":"","sources":["../../src/documents/ast-document-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EACJ,KAAK,cAAc,EACnB,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACJ,KAAK,OAAO,EACZ,KAAK,eAAe,EAEpB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EAEvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAEvE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACnE,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD;;;;;;;;OAQG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAChD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;IACrC,uHAAuH;IACvH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAC/C;AACD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGjE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAErF,MAAM,WAAW,UAAU;IACxB,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,OAAO,EAAE,GAAG,EAAE,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW;IAC3D,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,WAAW,CAAC;IAC1B;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,GAAG,OAAO,EAC/D,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,EACV,WAAW,GAAE,WAAW,EAAO,GAC/B,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAEhC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,IAAI,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,GAAG,OAAO,EAAE,QAAQ,EAAE,eAAe,GAAG,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAO3H;CACH;AAED,kHAAkH;AAClH,MAAM,MAAM,uBAAuB,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,IAAI,oBAAoB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;AAE9H,8GAA8G;AAC9G,MAAM,MAAM,qBAAqB,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;AAE1H,2DAA2D;AAC3D,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,kBAAkB,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO,EAAE,WAAW,GAAG,OAAO;IAW/E,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB;IAVpD,SAAS,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IAElC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;IACvE,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,0BAA0B,CAAC;IAClE,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IACpD,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IAChD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGZ,QAAQ,EAAE,oBAAoB,EACjD,OAAO,GAAE,yBAA8B;IAoC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAShD;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU;IAqB9H,6FAA6F;IAC7F,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,UAAU;IAS/E,+EAA+E;IAC/E,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,KAAK,IAAI,GAAG,UAAU;IA0BlH;;;;;;;;;OASG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,SAAS;IAI3D,IAAI,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IAyB9C,KAAK,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD;;;;;;;;;;OAUG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ1E;;;;;;;;OAQG;IACG,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAexD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAI5B,oGAAoG;IACpG,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAKpC;;;;;;OAMG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;cAIrC,kCAAkC,CAC/C,GAAG,EAAE,MAAM,EACX,UAAU,GAAE,MAAoC,EAChD,OAAO,SAAI,EACX,IAAI,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,gBAAgB,CAAC;IAItB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI5C;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC;CAGpF"}
+{"version":3,"file":"ast-document-manager.d.ts","sourceRoot":"","sources":["../../src/documents/ast-document-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EACJ,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAElB,KAAK,YAAY,EACjB,KAAK,WAAW,EAGlB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,OAAO,EAAiB,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE,GAAG,EAAY,MAAM,oBAAoB,CAAC;AAC7H,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAE/F,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAErF,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAErF,MAAM,WAAW,UAAU;IACxB,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,OAAO,EAAE,GAAG,EAAE,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,SAAS,aAAa,GAAG,aAAa;IACjG,IAAI,EAAE,IAAI,CAAC;IACX,gIAAgI;IAChI,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,OAAO,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,SAAS,aAAa,GAAG,aAAa,IAAI,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG;IACtI,SAAS,EAAE;QAAE,OAAO,EAAE,WAAW,CAAA;KAAE,CAAC;CACtC,CAAC;AAEF,yBAAiB,WAAW,CAAC;IAC1B;;;OAGG;IACH,SAAgB,MAAM,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,SAAS,aAAa,GAAG,aAAa,EAC3F,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,EACV,WAAW,CAAC,EAAE,WAAW,EAAE,GAC3B,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAEhC;CACH;AAED,0FAA0F;AAC1F,MAAM,MAAM,uBAAuB,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,SAAS,aAAa,GAAG,aAAa,IAAI,oBAAoB,CAChI,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAChC,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,SAAS,aAAa,GAAG,aAAa,IAAI,kBAAkB,CAC5H,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAChC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC/B,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CACnB;AAED,2DAA2D;AAC3D,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC9D;;;;;;;;OAQG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,kBAAkB,CAAC,IAAI,SAAS,OAAO,EAAE,WAAW,SAAS,aAAa,GAAG,aAAa;IACxG,IAAI,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/C,KAAK,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7B,0FAA0F;IAC1F,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC1E;;;;;;;;;;OAUG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC1D;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,sDAAsD;IACtD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC;;;;OAIG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;IAEtD;;;;;;;;OAQG;IACH,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEzE,6GAA6G;IAC7G,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;OASG;IACH,eAAe,CAAC,QAAQ,EAAE,eAAe,GAAG,iBAAiB,CAAC;CAChE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,yBAAyB,CACnC,IAAI,SAAS,OAAO,EACpB,WAAW,SAAS,aAAa,GAAG,aAAa,CAClD,YAAW,kBAAkB,CAAC,IAAI,EAAE,WAAW,CAAC;IAoD5C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB;IAnDpD,oGAAoG;IACpG,SAAS,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IAClC;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,oBAA2B;IACzD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,iBAAiB,4BAAmC;IACvE;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,cAAqB;IAEnD,6EAA6E;IAC7E,SAAS,CAAC,QAAQ,CAAC,SAAS,4BAAmC;IAE/D,sHAAsH;IACtH,SAAS,CAAC,QAAQ,CAAC,WAAW,qCAAiD;IAC/E,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAE1C,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;IACvE,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,0BAA0B,CAAC;IAClE,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACjD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,wBAAwB,CAAC;IAC7D,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IAChD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAElC,YACsB,QAAQ,EAAE,oBAAoB,EACjD,OAAO,GAAE,yBAA8B,EA4CzC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/C;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS,CAEvD;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,QAAQ,EAAE,eAAe,GAAG,iBAAiB,CAc5D;IAED;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAE9C;IAED;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAEjD;IAED;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAKxE;IAED,gDAAgD;IAChD,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAE3D;IAEK,IAAI,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,CAiDnD;IAEK,KAAK,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;IAED;;;;;;;;;;OAUG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAM9E;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CA4B9D;IAEK,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAqCzD;IAED,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE/B;IAED,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAErC;IAED,yHAAyH;IACzH,UAAgB,SAAS,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAU1F;IAED;;;;;;;;OAQG;IACH,UAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAKvE;IAED,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE3B;IAED;;;;;;OAMG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAEpD;IAED,UAAgB,kCAAkC,CAC/C,GAAG,EAAE,MAAM,EACX,UAAU,GAAE,MAAoC,EAChD,OAAO,SAAI,EACX,IAAI,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,gBAAgB,CAAC,CAW3B;IAED;;;OAGG;IACH,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CASvE;CACH"}