@stll/folio-core 0.55.0 → 0.57.0

package/dist/controller/canonicalSession.d.ts

@@ -1,4 +1,7 @@
 import { document_d_exports } from "../types/document.js";
+import { CanonicalGap } from "../types/canonicalCapabilities.js";
+import { CanonicalSaveSnapshot } from "../types/canonicalSave.js";
+import { CanonicalInlineGap } from "./canonicalInlineProjection.js";
 import { Node } from "prosemirror-model";
 import { EditorState, Transaction } from "prosemirror-state";
 import { Result } from "better-result";
@@ -7,9 +10,11 @@ import { DocumentOp, EditorIntent, OpStory, TextPosition, TouchedBlocks } from "
 declare const CanonicalSessionError_base: import("better-result").TaggedErrorClass<"CanonicalSessionError">;
 declare class CanonicalSessionError extends CanonicalSessionError_base<{
   message: string;
+  gap: CanonicalGap;
   reason: "refused" | "noChange";
 }> {}
 type CanonicalSelection = {
+  type: "text" | "all";
   anchor: TextPosition;
   head: TextPosition;
 };
@@ -25,7 +30,7 @@ type ParagraphAddress = {
   blockId: string;
   start: number;
   text: string;
-  boundaries: readonly (readonly number[])[];
+  boundaries: readonly (readonly CanonicalInlineGap[])[];
   node: Node;
   source: document_d_exports.Paragraph;
 };
@@ -34,7 +39,7 @@ type CanonicalProjectionOptions = {
   paragraphs: readonly ParagraphAddress[];
   story: OpStory;
 };
-/** Paragraph gaps map logical UTF-16 units and zero-width note marks to PM positions. */
+/** Paragraph gaps bind logical units and source zero-width ordinals to PM positions. */
 declare class CanonicalProjection {
   readonly doc: Node;
   readonly story: OpStory;
@@ -54,6 +59,7 @@ type CanonicalCommit = {
   document: document_d_exports.Document;
   projection: CanonicalProjection;
   bodyProjection: CanonicalProjection;
+  selection: CanonicalSelection;
   touched: TouchedBlocks;
   version: number;
   origin: CanonicalOrigin;
@@ -82,14 +88,22 @@ type CanonicalReplaceTextInput = {
   to: number;
   text: string;
   story?: OpStory;
-  semantic?: CanonicalInputSemantic;
   time?: number;
-};
+} & ({
+  semantic: "composition";
+  compositionPhase?: "correction";
+} | {
+  semantic?: Exclude<CanonicalInputSemantic, "composition">;
+  compositionPhase?: never;
+});
 /** Immutable model authority with a journal staged independently of the PM view. */
 declare class CanonicalSession {
   private currentDocument;
   private currentProjection;
+  private readonly sourceBlockIds;
   private currentVersion;
+  private readonly saveTouched;
+  private saveStructure;
   private readonly allocateIntentIds;
   private mode;
   private readonly allocatedBlockIds;
@@ -103,6 +117,8 @@ declare class CanonicalSession {
   private readonly undone;
   private readonly styles;
   constructor({ document, projection, styles }: CanonicalSessionSeedOptions);
+  /** Render only the committed comment projection while provisional IME blocks document snapshots. */
+  getCommittedComments(): import("@stll/docx-core/model").Comment[];
   setMode(mode: CanonicalSessionMode): void;
   hasStyle(styleId: string): boolean;
   private advanceBlockId;
@@ -111,6 +127,7 @@ declare class CanonicalSession {
   private intentNeedsIdentityIds;
   private rememberSources;
   get document(): document_d_exports.Document;
+  captureSaveSnapshot(): CanonicalSaveSnapshot;
   get projection(): CanonicalProjection;
   get selection(): CanonicalSelection | null;
   get version(): number;
@@ -121,9 +138,13 @@ declare class CanonicalSession {
   beginComposition(): Result<void, CanonicalSessionError>;
   endComposition(): void;
   private checkState;
-  prepareReplace(state: EditorState, { from, to, text, story, semantic, time }: CanonicalReplaceTextInput): Result<CanonicalCommit, CanonicalSessionError>;
+  prepareReplace(state: EditorState, { from, to, text, story, semantic, compositionPhase, time }: CanonicalReplaceTextInput): Result<CanonicalCommit, CanonicalSessionError>;
   prepareIntent(state: EditorState, intent: EditorIntent): Result<CanonicalCommit, CanonicalSessionError>;
-  prepareIntents(state: EditorState, intents: readonly EditorIntent[]): Result<CanonicalCommit, CanonicalSessionError>;
+  prepareIntents(state: EditorState, { intents, resourceOps, semantic }: {
+    intents: readonly EditorIntent[];
+    resourceOps?: readonly DocumentOp[];
+    semantic?: CanonicalInputSemantic;
+  }): Result<CanonicalCommit, CanonicalSessionError>;
   prepareOps(state: EditorState, ops: readonly DocumentOp[], postSelection: CanonicalSelection): Result<CanonicalCommit, CanonicalSessionError>;
   private prepareJournalledOps;
   prepareSplit(state: EditorState): Result<CanonicalCommit, CanonicalSessionError>;