@stll/folio-core 0.54.2 → 0.56.0

package/dist/controller/canonicalSession.d.ts

@@ -0,0 +1,167 @@
+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";
+import { DocumentOp, EditorIntent, OpStory, TextPosition, TouchedBlocks } from "@stll/docx-core/ops";
+//#region src/controller/canonicalSession.d.ts
+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;
+};
+type CanonicalOrigin = "input" | "undo" | "redo";
+type CanonicalSessionMode = {
+  type: "editing";
+} | {
+  type: "suggesting";
+  author: string;
+};
+declare const CANONICAL_PROJECTION_META = "folioCanonicalProjection";
+type ParagraphAddress = {
+  blockId: string;
+  start: number;
+  text: string;
+  boundaries: readonly (readonly CanonicalInlineGap[])[];
+  node: Node;
+  source: document_d_exports.Paragraph;
+};
+type CanonicalProjectionOptions = {
+  doc: Node;
+  paragraphs: readonly ParagraphAddress[];
+  story: OpStory;
+};
+/** Paragraph gaps bind logical units and source zero-width ordinals to PM positions. */
+declare class CanonicalProjection {
+  readonly doc: Node;
+  readonly story: OpStory;
+  private readonly paragraphs;
+  private readonly paragraphsById;
+  constructor({ doc, paragraphs, story }: CanonicalProjectionOptions);
+  addressAt(position: number): Result<TextPosition, CanonicalSessionError>;
+  inputAddressAt(position: number): Result<TextPosition, CanonicalSessionError>;
+  positionAt(address: TextPosition): Result<number, CanonicalSessionError>;
+  selectionAt(state: EditorState): Result<CanonicalSelection, CanonicalSessionError>;
+  paragraph(blockId: string): ParagraphAddress | undefined;
+}
+/** Input intent, never projection-step adjacency, determines the journal partition. */
+type CanonicalInputSemantic = "typing" | "deleteBackward" | "deleteForward" | "paste" | "composition" | "replacement" | "structure";
+type CanonicalCommit = {
+  transaction: Transaction;
+  document: document_d_exports.Document;
+  projection: CanonicalProjection;
+  bodyProjection: CanonicalProjection;
+  touched: TouchedBlocks;
+  version: number;
+  origin: CanonicalOrigin;
+  /** Publish only after every projection/plugin transaction has been accepted. */
+  publish: () => Result<void, CanonicalSessionError>;
+};
+/** Metadata is descriptive; transaction identity and session version authorize mutations. */
+declare const isCanonicalProjectionTransaction: (transaction: Transaction, session: CanonicalSession) => boolean;
+type PublishCanonicalProjectionOptions = {
+  state: EditorState;
+  commit: CanonicalCommit;
+  session: CanonicalSession;
+};
+/** The model publishes only after PM and every plugin accept its exact projection. */
+declare const publishCanonicalProjection: ({ state, commit, session }: PublishCanonicalProjectionOptions) => import("better-result").Err<never, CanonicalSessionError> | import("better-result").Ok<{
+  state: EditorState;
+  transactions: readonly Transaction[];
+}, never>;
+type CanonicalSessionSeedOptions = {
+  document: document_d_exports.Document;
+  projection: CanonicalProjection;
+  styles: document_d_exports.StyleDefinitions | null | undefined;
+};
+type CanonicalReplaceTextInput = {
+  from: number;
+  to: number;
+  text: string;
+  story?: OpStory;
+  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;
+  private nextBlockId;
+  private readonly sourceOwners;
+  private readonly storyProjections;
+  private currentSelection;
+  private readonly applied;
+  private groupingBoundary;
+  private lifecycle;
+  private readonly undone;
+  private readonly styles;
+  constructor({ document, projection, styles }: CanonicalSessionSeedOptions);
+  setMode(mode: CanonicalSessionMode): void;
+  hasStyle(styleId: string): boolean;
+  private advanceBlockId;
+  private freshBlockId;
+  private intentMode;
+  private intentNeedsIdentityIds;
+  private rememberSources;
+  get document(): document_d_exports.Document;
+  captureSaveSnapshot(): CanonicalSaveSnapshot;
+  get projection(): CanonicalProjection;
+  get selection(): CanonicalSelection | null;
+  get version(): number;
+  get canUndo(): boolean;
+  get canRedo(): boolean;
+  get isComposing(): boolean;
+  breakUndoGroup(): void;
+  beginComposition(): Result<void, CanonicalSessionError>;
+  endComposition(): void;
+  private checkState;
+  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, 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>;
+  prepareJoin(state: EditorState, direction: "backward" | "forward"): Result<CanonicalCommit, CanonicalSessionError>;
+  prepareResolve(state: EditorState, { revisionIds, resolution }: {
+    revisionIds: readonly number[];
+    resolution: "accept" | "reject";
+  }): Result<CanonicalCommit, CanonicalSessionError>;
+  projectStory(story: OpStory): Result<CanonicalProjection, CanonicalSessionError>;
+  prepareOperations(state: EditorState, ops: readonly DocumentOp[]): Result<CanonicalCommit, CanonicalSessionError>;
+  prepareUndo(state: EditorState, story?: OpStory): Result<CanonicalCommit, CanonicalSessionError>;
+  prepareRedo(state: EditorState, story?: OpStory): Result<CanonicalCommit, CanonicalSessionError>;
+  private stage;
+}
+declare const createCanonicalSession: (document: document_d_exports.Document, styles?: document_d_exports.StyleDefinitions | null) => Result<CanonicalSession, CanonicalSessionError>;
+declare const isCanonicalJoinBoundary: (state: EditorState, direction: "backward" | "forward") => boolean;
+/** Native character deletion consumes one whole visible grapheme. */
+declare const deletionRange: (state: EditorState, direction: "backward" | "forward") => Result<{
+  from: number;
+  to: number;
+}, CanonicalSessionError>;
+//#endregion
+export { CANONICAL_PROJECTION_META, CanonicalCommit, CanonicalInputSemantic, CanonicalOrigin, type CanonicalProjection, CanonicalSelection, type CanonicalSession, CanonicalSessionError, CanonicalSessionMode, createCanonicalSession, deletionRange, isCanonicalJoinBoundary, isCanonicalProjectionTransaction, publishCanonicalProjection };