@docx-editor.dev/core 2.30.0 → 2.31.0

package/dist/{tree-session-contract-CwnTEVLF.d.ts → tree-session-contract-DeLRqohz.d.ts}

@@ -1,11 +1,10 @@
-import { S as StoryScope, g as SelectionMark, h as TransactOptions, b as StoryTargetRejection, e as TreeModelChange, H as HeaderFooterParts, a as HeaderFooterSectionResolution, I as InsertImageInput, i as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput, j as FragmentPasteInput, k as FragmentPasteResult } from './tree-package-store-DKhdEVym.js';
-import { ag as TreeDocOp, O as OoxmlPart, N as OoxmlNode, Q as OoxmlPackage, ah as OoxmlElement, a as ReviewItem, ax as RevisionAttributionInput } from './types-barrel-CA0xB8kH.js';
-import { S as SupportedImageMime, c as ImageDecodePort } from './image-resources-Bipz8toD.js';
-import { D as DocumentTrackingSettings, I as InsertCustomNodeWrite, C as CustomNodeWriteResult, a as CustomNodeSweepOutcome, E as EmbeddedFont, B as BookmarkIndex, L as ListKind } from './custom-node-writes-0v0Kgw1T.js';
-import { H as HeadlessDocumentView, D as DocumentProperties } from './headless-document-view-DZQN8Bnx.js';
+import { S as StoryScope, g as SelectionMark, h as TransactOptions, d as HistoryGroup, b as StoryTargetRejection, e as TreeModelChange, H as HeaderFooterParts, a as HeaderFooterSectionResolution, I as InsertImageInput, i as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput, j as FragmentPasteInput, k as FragmentPasteResult } from './tree-package-store-B8l8DX3Z.js';
+import { ao as TreeDocOp, O as OoxmlPart, N as OoxmlNode, Q as OoxmlPackage, ap as OoxmlElement, a as ReviewItem, af as SupportedImageMime, aE as ImageDecodePort, aG as RevisionAttributionInput } from './types-barrel-CkF2JbU4.js';
+import { D as DocumentTrackingSettings, I as InsertCustomNodeWrite, C as CustomNodeWriteResult, a as CustomNodeSweepOutcome, E as EmbeddedFont, B as BookmarkIndex, L as ListKind } from './custom-node-writes-TeUvMP13.js';
+import { H as HeadlessDocumentView, D as DocumentProperties } from './headless-document-view-qOpaCF82.js';
 import { Node } from 'prosemirror-model';
 import { CollaborationDocumentPort } from './collaboration/replication.js';
-import { V as ViewScope } from './editor-scope-7o9xweiJ.js';
+import { V as ViewScope } from './editor-scope-C7ke1KJG.js';
 
 /**
  * Why an edited projection could not be mapped back into tree ops.
@@ -259,7 +258,11 @@ interface TreeApplyResult {
     readonly reason?: TreeBindingRejection | StoryTargetRejection | string;
 }
 /** Optional collaboration attribution and history grouping for a direct tree-op transaction. */
-type TreeApplyOptions = Pick<TransactOptions, 'origin' | 'actorId' | 'operationId' | 'recordsHistory' | 'historyGroup'> & {
+type TreeApplyOptions = Pick<TransactOptions, 'origin' | 'actorId' | 'operationId' | 'recordsHistory'> & {
+    /** The store token of the commit's history group, as `commitReviewOps` hands it over. */
+    readonly historyToken?: HistoryGroup;
+    /** @deprecated Use `historyToken`, the same store token under its one name. */
+    readonly historyGroup?: HistoryGroup;
     /** Package resources committed in the same transaction as the tree operations. */
     readonly packageEdits?: readonly ((pkg: OoxmlPackage) => OoxmlPackage)[];
     /** Canonical operations on related package parts, committed in the same undo unit. */
@@ -268,6 +271,11 @@ type TreeApplyOptions = Pick<TransactOptions, 'origin' | 'actorId' | 'operationI
         readonly ops: readonly TreeDocOp[];
     }[];
 };
+/** History grouping for a comment or custom-node write: frames of one group share one undo step. */
+interface PackageWriteOptions {
+    /** The store token of the commit's history group, as `commitReviewOps` hands it over. */
+    readonly historyToken?: HistoryGroup;
+}
 /**
  * One open document: the canonical tree, and the only write path into it.
  *
@@ -359,6 +367,11 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
     collaborationPort(documentId: string): CollaborationDocumentPort;
     /** Serialize the whole package back to DOCX bytes. */
     save(): Uint8Array;
+    /**
+     * {@link save} in steps a caller can pause between. The package is captured at the call, so
+     * the bytes describe the document as it was then, whatever happens between steps.
+     */
+    saveSteps(): Generator<void, Uint8Array>;
     /**
      * The resolved header/footer parts of the section, by variant (phase 2).
      *
@@ -506,7 +519,7 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
     /** ISO-8601. Omitted writes no `@w:date`, because inventing one is a content change. */
     date?: string, scope?: StoryScope, 
     /** Binds id allocation to one actor, so two peers cannot mint the same comment id. */
-    actorId?: string): string | null;
+    actorId?: string, options?: PackageWriteOptions): string | null;
     /**
      * Resolve a comment thread, or reopen it. False when the document holds no such comment.
      *
@@ -514,7 +527,7 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
      * `commentsExtended.xml`, a part a document with no thread does not have, so the state and the
      * part that records it commit together.
      */
-    setCommentResolved(commentId: string, resolved: boolean): boolean;
+    setCommentResolved(commentId: string, resolved: boolean, options?: PackageWriteOptions): boolean;
     /**
      * Delete a comment thread outright — body, thread state and story markers.
      *
@@ -523,7 +536,7 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
      * shared notes part. False when the document holds no such comment, or when the removal was
      * refused.
      */
-    deleteComment(commentId: string, scope?: StoryScope, noteId?: number): boolean;
+    deleteComment(commentId: string, scope?: StoryScope, noteId?: number, options?: PackageWriteOptions): boolean;
     /**
      * Delete several comment objects as one package transaction and one undo unit.
      *
@@ -533,7 +546,7 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
     deleteComments(comments: readonly {
         readonly commentId: string;
         readonly parentCommentId?: string;
-    }[], scope?: StoryScope, noteId?: number): boolean;
+    }[], scope?: StoryScope, noteId?: number, options?: PackageWriteOptions): boolean;
     /**
      * Insert a custom node, with the payload it carries, as ONE transaction.
      *
@@ -545,7 +558,7 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
      * to live in its `w:tag` needs.
      */
     /** `scope` names the story the paragraph is in, and defaults to the body. */
-    insertCustomNode(write: InsertCustomNodeWrite, scope?: StoryScope): CustomNodeWriteResult;
+    insertCustomNode(write: InsertCustomNodeWrite, scope?: StoryScope, options?: PackageWriteOptions): CustomNodeWriteResult;
     /**
      * Remove a custom node and, in the same transaction, the payload it bound.
      *
@@ -663,4 +676,4 @@ interface TreeDocxSessionView extends HeadlessDocumentView {
 }
 
 export { bodyParagraphs as d, docToTreeOps as e, partHasNode as p, reconcileDoc as r, treeToDoc as t };
-export type { DocumentStyleEntry as D, MapResult as M, TreeDocxSessionView as T, TreeApplyResult as a, TreeApplyOptions as b, TreeBindingRejection as c, DocumentThemeColorEntry as f };
+export type { DocumentStyleEntry as D, MapResult as M, PackageWriteOptions as P, TreeDocxSessionView as T, TreeApplyResult as a, TreeApplyOptions as b, TreeBindingRejection as c, DocumentThemeColorEntry as f };