@stll/folio-core 0.37.5 → 0.38.0

package/dist/ai-edits/headless.d.ts

@@ -2,6 +2,9 @@ import { document_d_exports } from "../types/document.js";
 import { FolioTableTemplates } from "./table-template.js";
 import { FolioAIBlock, FolioAIEditApplyMode, FolioAIEditApplyResult, FolioAIEditOperation, FolioAIEditSnapshot } from "./types.js";
 import { FolioRevisionStamp, FolioWordDiffOptions } from "./apply.js";
+import { ImportReferencedStyleDefinitionsResult } from "../compare/style-resources.js";
+import { InlineProvenanceTargetOptions } from "../compare/inline-provenance.js";
+import { MatchInlineAtomsOptions } from "../compare/inline-atoms.js";
 import { FolioDocumentOperationBatch, FolioDocumentOperationResult, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult } from "../document-operations.js";
 import { FolioReviewChange, FolioReviewChangeKind } from "./read.js";
 import { FolioStoryTable } from "./snapshot.js";
@@ -122,6 +125,9 @@ type FolioApplyDocumentOperationsToStoryOptions = FolioApplyDocumentOperationsOp
    */
   tableTemplates?: FolioTableTemplates;
 };
+type FolioHeaderFooterStoryHandle = Extract<FolioEditableDocumentStoryHandle, {
+  type: "header" | "footer";
+}>;
 type FolioDocxComparisonProjectionMode = "with-revision-census" | "without-revision-census";
 type FolioDocxComparisonStoryProjection = {
   handle: FolioDocumentStoryHandle;
@@ -134,9 +140,86 @@ type FolioDocxComparisonProjection = {
     present: boolean;
   };
 };
+type MatchStoryInlineProvenanceOptions = InlineProvenanceTargetOptions & {
+  story: FolioEditableDocumentStoryHandle;
+};
+type StoryInlineProvenanceResult = {
+  status: "matched";
+  nextRevisionId: number;
+  changedTargetBlockIds: readonly string[];
+  rangeCount: number;
+  documentChanged: boolean;
+} | {
+  status: "unalignable";
+} | {
+  status: "budget-exceeded";
+};
+type MatchStoryInlineAtomsOptions = Omit<MatchInlineAtomsOptions, "state" | "author"> & {
+  story: FolioEditableDocumentStoryHandle;
+};
+type StoryInlineAtomsResult = {
+  status: "matched";
+  nextRevisionId: number;
+  changedTargetBlockIds: readonly string[];
+  rangeCount: number;
+  documentChanged: boolean;
+} | {
+  status: "unalignable";
+} | {
+  status: "budget-exceeded";
+};
+type StageTargetNumberingResult = "unchanged" | "staged" | "conflict";
 type FolioDocxComparisonAccess = {
+  stageTerminalTableReviewCarrier: (target: Node) => boolean;
+  stageTargetStyles: (source: FolioDocxReviewer, snapshots: readonly FolioAIEditSnapshot[], importedHeaderFooterSnapshots: readonly FolioAIEditSnapshot[]) => ImportReferencedStyleDefinitionsResult;
+  createComparisonHeaderFooter: (source: FolioDocxReviewer, story: FolioHeaderFooterStoryHandle) => Promise<FolioHeaderFooterStoryHandle | null>;
+  matchInlineAtoms: (options: MatchStoryInlineAtomsOptions) => StoryInlineAtomsResult;
+  matchInlineProvenance: (options: MatchStoryInlineProvenanceOptions) => StoryInlineProvenanceResult;
   projectStories: (mode: FolioDocxComparisonProjectionMode) => FolioDocxComparisonProjection;
   snapshotReviewedStory: (options?: FolioReadReviewedStoryOptions) => FolioAIEditSnapshot | null;
+  numberingDefinitions: () => document_d_exports.NumberingDefinitions | null | undefined;
+  planTargetNumberingReferences: (target: document_d_exports.NumberingDefinitions | null | undefined, references: readonly {
+    numId: number;
+    level: number;
+  }[]) => ReadonlyMap<number, number> | null;
+  stageTargetNumbering: (target: document_d_exports.NumberingDefinitions | null | undefined, references: readonly {
+    numId: number;
+    level: number;
+  }[], remappedNumIds: ReadonlyMap<number, number>) => StageTargetNumberingResult;
+  finalSectionProperties: () => document_d_exports.SectionProperties | undefined;
+  stageFinalSectionProperties: (options: {
+    target: document_d_exports.SectionProperties;
+    previous: document_d_exports.SectionProperties;
+    revision: FolioRevisionStamp;
+  }) => boolean;
+  stageMappedSectionBoundaries: (options: {
+    target: Node;
+    originalRevisionIdSeed: number;
+    maxRanges: number;
+    revision: FolioRevisionStamp;
+    mapTargetProperties: (args: {
+      kind: "inserted" | "retained";
+      current: document_d_exports.SectionProperties | undefined;
+      target: document_d_exports.SectionProperties;
+    }) => {
+      kind: "inserted";
+      target: document_d_exports.SectionProperties;
+    } | {
+      kind: "retained";
+      previous: document_d_exports.SectionProperties;
+      target: document_d_exports.SectionProperties;
+    } | null;
+  }) => {
+    status: "matched";
+    rangeCount: number;
+    nextRevisionId: number;
+    documentChanged: boolean;
+  } | {
+    status: "unalignable";
+    detail: string;
+  } | {
+    status: "budget-exceeded";
+  };
 };
 declare const isFolioReviewedView: (value: unknown) => value is FolioReviewedView;
 declare const isFolioResolvedReviewedView: (value: unknown) => value is FolioResolvedReviewedView;
@@ -198,9 +281,16 @@ declare class FolioDocxReviewer {
   /** Default author for tracked changes and comments. */
   readonly author: string;
   private readonly baseDocument;
+  private finalSectionPropertiesOverride;
   private readonly originalBuffer;
   private state;
   private readonly secondaryStoryStates;
+  private readonly removedHeaderFooterStories;
+  private readonly sectionReferenceRemovals;
+  private importedStyles;
+  private readonly importedMedia;
+  private readonly importedHeaders;
+  private readonly importedFooters;
   private readonly resolvedStoryExpectations;
   private readonly createdComments;
   private readonly usedCommentIds;
@@ -215,6 +305,16 @@ declare class FolioDocxReviewer {
    */
   private readonly resolvedOverrides;
   private constructor();
+  private stageTargetStyles;
+  /**
+   * A raw final table has no paragraph mark after it for Word to merge into
+   * when the target ends in a paragraph. Folio-exact comparison adds this
+   * untracked receiver before planning; its private marker makes resolving in
+   * Folio restore the raw source view.
+   */
+  private stageTerminalTableReviewCarrier;
+  private stageTargetNumbering;
+  private planTargetNumberingReferences;
   /** Parse a `.docx` buffer into a reviewer. */
   static fromBuffer(buffer: ArrayBuffer, options?: FolioDocxReviewerOptions): Promise<FolioDocxReviewer>;
   /**
@@ -354,6 +454,10 @@ declare class FolioDocxReviewer {
   resolveComment(commentId: string, options?: {
     resolved?: boolean;
   }): boolean;
+  private currentFinalSectionProperties;
+  private stageFinalSectionProperties;
+  private stageMappedSectionBoundaries;
+  private resolveFinalSectionProperties;
   /**
    * Accept an existing tracked change, keeping its text and dropping the
    * redline. Pass a {@link FolioReviewChange} from {@link getChanges} or its
@@ -362,11 +466,13 @@ declare class FolioDocxReviewer {
    * revision is no longer present (already resolved, or never existed).
    */
   acceptChange(target: FolioReviewChange | number): boolean;
+  private acceptChangeInternal;
   /**
    * Reject an existing tracked change: an insertion's text is removed, a
    * deletion's text is restored. See {@link acceptChange} for targeting.
    */
   rejectChange(target: FolioReviewChange | number): boolean;
+  private rejectChangeInternal;
   /**
    * Accept every tracked change in the package. Returns the number of changes
    * present before the sweep.
@@ -378,6 +484,8 @@ declare class FolioDocxReviewer {
   acceptAll(): number;
   /** Reject every tracked change in the package. See {@link acceptAll}. */
   rejectAll(): number;
+  private resolveWithSectionReferenceHistory;
+  private resolveEveryFinalSectionChange;
   private resolveEveryStory;
   /** The current document model with edits merged back in. */
   toDocument(): document_d_exports.Document;
@@ -403,6 +511,8 @@ declare class FolioDocxReviewer {
   private requireEditableStoryState;
   private setEditableStoryState;
   private getHeaderFooterStory;
+  private createComparisonHeaderFooter;
+  private canImportHeaderFooterContent;
   private getNoteStory;
   private getHeaderFooterStoryText;
   private getNoteStoryText;