@docx-editor.dev/core 2.26.0 → 2.28.0

package/dist/{tree-package-fragment-YPyYC1aD.d.ts → tree-package-fragment-BeeKxDw8.d.ts}

@@ -1,5 +1,16 @@
-import { S as SupportedImageMime, a as ImageDecodePort } from './image-resources-DfagDguq.js';
-import { Q as OoxmlPackage, O as OoxmlPart, N as OoxmlNode, Z as OoxmlElement, at as OoxmlParagraphNode, au as OoxmlNoteNode, av as OoxmlContinuationSeparatorNode, aw as OoxmlEndnotesNode, ax as OoxmlFootnotesNode, ay as OoxmlNoteRefNode, az as OoxmlNoteReferenceNode, aA as OoxmlSeparatorNode, a7 as RevisionAttributionInput, aB as DrawingTreeDocOp, aC as ImpactClass, W as TreeDocOp, a5 as TreeOpRejection } from './types-barrel-BO73JqHG.js';
+import { S as SupportedImageMime, a as ImageDecodePort } from './image-resources-BN-hUgCn.js';
+import { Q as OoxmlPackage, O as OoxmlPart, N as OoxmlNode, Z as OoxmlElement, ab as OoxmlParagraphNode, ac as OoxmlNoteNode, ad as OoxmlContinuationSeparatorNode, ae as OoxmlEndnotesNode, af as OoxmlFootnotesNode, ag as OoxmlNoteRefNode, ah as OoxmlNoteReferenceNode, ai as OoxmlSeparatorNode, aa as RevisionAttributionInput, aj as DrawingTreeDocOp, ak as ImpactClass, W as TreeDocOp, a8 as TreeOpRejection } from './types-barrel-D3xCgQX6.js';
+
+/**
+ * How saved field results are addressed.
+ *
+ * - `atomic`: every closed field is one offset unit.
+ * - `editable`: the results of CREATEDATE, DATE, FILENAME, FILLIN, HYPERLINK, MERGEFIELD,
+ *   PRINTDATE, QUOTE, SAVEDATE, SEQ, and TIME fields are text when their results are unnested.
+ *   Simple fields inside complex field results are not supported in this mode. Other nested
+ *   results, other field types, and legacy FORMTEXT inputs keep their existing addressing.
+ */
+type FieldResultsMode = 'atomic' | 'editable';
 
 /** A freshly allocated drawing property id, or the reason one could not be minted. */
 type DrawingPropertyIdResult = {
@@ -580,6 +591,63 @@ type HistoryCaptureReason = 'package-unit' | 'composition';
 declare function observeHistoryGroup<T>(group: HistoryGroup, report: (kind: HistoryCaptureKind, reason?: HistoryCaptureReason) => void, run: () => T): T;
 declare function reportHistoryGroup(group: HistoryGroup | undefined, kind: HistoryCaptureKind, reason?: HistoryCaptureReason): void;
 
+/** How one transaction behaves: its story scope, its attribution, and its selection marks. */
+interface TransactOptions {
+    readonly origin?: string;
+    /** Stable actor attribution for collaboration and audit correlation. */
+    readonly actorId?: string;
+    /** Stable constituent identity for collaboration duplicate correlation. */
+    readonly operationId?: string;
+    /**
+     * Whether this transaction enters the legacy snapshot undo stack.
+     *
+     * Collaboration commits set this to false because their actor-local undo authority is the
+     * CRDT undo manager. Omitted preserves the ordinary non-collaborative history behavior.
+     */
+    readonly recordsHistory?: boolean;
+    /**
+     * A COMMAND is one user intent that may need several ops (a toolbar click applying a
+     * property across a multi-run selection). It is still exactly one history entry, which is
+     * the same rule a plain transaction follows — the option exists to say so explicitly at
+     * the call site rather than leaving it implied.
+     */
+    readonly scope?: 'transaction' | 'command';
+    /**
+     * Floor on the published impact. Header/footer story edits use `global` so every page
+     * sharing the part invalidates rather than keeping stale furniture.
+     */
+    readonly minimumImpact?: ImpactClass;
+    /** Story identity stamped onto the published ModelChange (package-aware targeting). */
+    readonly story?: TreeStoryRef;
+    /**
+     * The gesture this transaction belongs to: consecutive transactions carrying the SAME
+     * token extend one history entry (package from before the first, selection after the
+     * latest). Another token, none, undo or redo closes the group. See {@link HistoryGroup}.
+     */
+    readonly historyGroup?: HistoryGroup;
+    /**
+     * How the transaction's ops address saved field results. `atomic` (the default) keeps
+     * every field one offset unit; `editable` addresses saved results as text. See
+     * `field-result-mode.ts`.
+     */
+    readonly fieldResults?: FieldResultsMode;
+}
+/** How a store is constructed: its limits, its history depth, and its identity source. */
+interface TreeDocumentStoreOptions {
+    /** Bound on retained history entries. Oldest entries drop first. */
+    readonly historyLimit?: number;
+    /**
+     * The document's `settings.xml`, for a store built from a PART rather than a package.
+     *
+     * Forms protection lives one part up from the op, and a store built from a part gets a
+     * synthetic one-part package that cannot see it — so `w:documentProtection w:edit="forms"`
+     * was enforced in the body and nowhere else, and a header, a footer or a note accepted every
+     * write a protected document is supposed to refuse. Read through a getter, not captured: a
+     * document can gain or lose protection while its stories stay open.
+     */
+    readonly settingsPart?: () => OoxmlPart | null | undefined;
+}
+
 /** A selection the caller wants restored when an entry is undone or redone. */
 /** A selection captured with a transaction, so undo restores where the caret was. */
 interface SelectionMark {
@@ -685,41 +753,6 @@ interface TransactionContext {
     /** The selection to restore when this entry is redone. */
     selectionAfter(selection: SelectionMark | null): void;
 }
-/** How one transaction behaves: its story scope, its attribution, and its selection marks. */
-interface TransactOptions {
-    readonly origin?: string;
-    /** Stable actor attribution for collaboration and audit correlation. */
-    readonly actorId?: string;
-    /** Stable constituent identity for collaboration duplicate correlation. */
-    readonly operationId?: string;
-    /**
-     * Whether this transaction enters the legacy snapshot undo stack.
-     *
-     * Collaboration commits set this to false because their actor-local undo authority is the
-     * CRDT undo manager. Omitted preserves the ordinary non-collaborative history behavior.
-     */
-    readonly recordsHistory?: boolean;
-    /**
-     * A COMMAND is one user intent that may need several ops (a toolbar click applying a
-     * property across a multi-run selection). It is still exactly one history entry, which is
-     * the same rule a plain transaction follows — the option exists to say so explicitly at
-     * the call site rather than leaving it implied.
-     */
-    readonly scope?: 'transaction' | 'command';
-    /**
-     * Floor on the published impact. Header/footer story edits use `global` so every page
-     * sharing the part invalidates rather than keeping stale furniture.
-     */
-    readonly minimumImpact?: ImpactClass;
-    /** Story identity stamped onto the published ModelChange (package-aware targeting). */
-    readonly story?: TreeStoryRef;
-    /**
-     * The gesture this transaction belongs to: consecutive transactions carrying the SAME
-     * token extend one history entry (package from before the first, selection after the
-     * latest). Another token, none, undo or redo closes the group. See {@link HistoryGroup}.
-     */
-    readonly historyGroup?: HistoryGroup;
-}
 interface HistoryEntry {
     /**
      * The whole package as it was, not just the story part.
@@ -740,21 +773,6 @@ interface HistoryEntry {
      */
     readonly group?: HistoryGroup;
 }
-/** How a store is constructed: its limits, its history depth, and its identity source. */
-interface TreeDocumentStoreOptions {
-    /** Bound on retained history entries. Oldest entries drop first. */
-    readonly historyLimit?: number;
-    /**
-     * The document's `settings.xml`, for a store built from a PART rather than a package.
-     *
-     * Forms protection lives one part up from the op, and a store built from a part gets a
-     * synthetic one-part package that cannot see it — so `w:documentProtection w:edit="forms"`
-     * was enforced in the body and nowhere else, and a header, a footer or a note accepted every
-     * write a protected document is supposed to refuse. Read through a getter, not captured: a
-     * document can gain or lose protection while its stories stay open.
-     */
-    readonly settingsPart?: () => OoxmlPart | null | undefined;
-}
 /**
  * Opaque document+history checkpoint for package-coordinator rollback.
  * Used when a story mutation may promote to a package undo unit (note-ref cascade).
@@ -1043,10 +1061,12 @@ declare class TreePackageStore {
     endComposition(): void;
     cancelComposition(): void;
     /**
-     * Commit one furniture or note lifecycle op as a single ModelChange / undo unit that
-     * restores the entire package atomically (parts, rels, content-types, settings).
+     * Commit one furniture or note lifecycle op as one ModelChange / undo unit that restores the
+     * whole package atomically. `actorId` scopes the ids it mints, as `transact` does.
      */
-    applyLifecycleOp(op: HeaderFooterLifecycleOp | NoteLifecycleOp | TreeDocOp): PackageTransactResult;
+    applyLifecycleOp(op: HeaderFooterLifecycleOp | NoteLifecycleOp | TreeDocOp, options?: {
+        readonly actorId?: string;
+    }): PackageTransactResult;
     private commitLifecycleOp;
     undo(): TreeModelChange | null;
     redo(): TreeModelChange | null;
@@ -1177,5 +1197,5 @@ type FragmentPasteResult = (Extract<PackageTransactResult, {
  */
 declare function applyFragmentPaste(store: TreePackageStore, scope: StoryScope, input: FragmentPasteInput): FragmentPasteResult;
 
-export { NOTE_ID_MIN as B, DEFAULT_MAX_EDITABLE_STORY_PARTS as D, NOTE_SEPARATOR_ID as E, MAX_FRAGMENT_DECODED_BYTES as M, TreePackageStore as T, allocateDrawingPropertyId as a3, allocateNoteId as a4, applyFragmentPaste as a5, applyHeaderFooterLifecycleOp as a6, applyNoteLifecycleOp as a7, atomicNoteSpansOf as a8, cascadeDeletedNoteReferences as a9, notesOf as aA, notesPartHasId as aB, observeHistoryGroup as aC, parseNoteId as aD, parseNoteScopeId as aE, resolveHeaderFooterParts as aF, resolveHeaderFooterPartsBySection as aG, resolveHeaderFooterResolutionBySection as aH, resolveNotesPart as aI, withBinaryPart as aJ, withEmbeddedImage as aK, withoutUnreferencedImagePart as aL, collectNoteReferences as aa, collectPackageNoteReferences as ab, collectSectionPropertyNodes as ac, createNoteReferenceScanBudget as ad, customMarkFollows as ae, diagnoseNoteReferences as af, findNoteById as ag, formatNoteScopeId as ah, isContinuationSeparatorNode as ai, isEndnotesNode as aj, isFootnotesNode as ak, isHeaderFooterLifecycleOp as al, isNormalNote as am, isNoteAtomNode as an, isNoteLifecycleOp as ao, isNoteNode as ap, isNoteRefNode as aq, isNoteReferenceNode as ar, isSeparatorNode as as, normalNoteIds as at, noteAtomText as au, noteIdOf as av, noteKindOf as aw, noteRefKindOf as ax, noteReferenceKindOf as ay, noteTypeOf as az, TreeDocumentStore as f, reportHistoryGroup as r, MAX_NOTES_PER_PART as u, MAX_NOTE_REFERENCE_PARTS as v, MAX_NOTE_REFERENCE_SCAN as w, NOTE_ATOM_CHAR as x, NOTE_CONTINUATION_SEPARATOR_ID as y, NOTE_ID_MAX as z };
-export type { TreePackageStoreOptions as $, ApplyImagePropertiesInput as A, CascadeDeletedNoteReferencesOptions as C, FragmentPasteInput as F, NoteDiagnostic as G, HistoryGroup as H, InsertImageInput as I, NoteDiagnosticCode as J, NoteLifecycleImpact as K, NoteLifecycleOp as L, NoteKind as N, NoteLifecycleOptions as O, NoteLifecycleRejection as P, NoteLifecycleResult as Q, ReplaceImageOptions as R, StoryScope as S, NoteReferenceHit as U, NoteReferenceScanBudget as V, NoteType as W, PackageTransactResult as X, RemotePackageAttribution as Y, StoryResolveResult as Z, TreeDocumentStoreOptions as _, StoryTargetRejection as a, TreeStoryRef as a0, TransactResult as a1, TransactionContext as a2, TreeModelChange as b, HeaderFooterParts as c, HeaderFooterSectionResolution as d, HeaderFooterVariant as e, SelectionMark as g, TransactOptions as h, ImageIntentResult as i, FragmentPasteResult as j, AtomicNoteSpan as k, DrawingPropertyIdResult as l, HeaderFooterKind as m, HeaderFooterLifecycleImpact as n, HeaderFooterLifecycleOp as o, HeaderFooterLifecycleRejection as p, HeaderFooterLifecycleResult as q, HeaderFooterSlotMeta as s, HistoryCaptureKind as t };
+export { NOTE_ID_MAX as B, DEFAULT_MAX_EDITABLE_STORY_PARTS as D, NOTE_ID_MIN as E, NOTE_SEPARATOR_ID as G, MAX_FRAGMENT_DECODED_BYTES as M, TreePackageStore as T, allocateDrawingPropertyId as a4, allocateNoteId as a5, applyFragmentPaste as a6, applyHeaderFooterLifecycleOp as a7, applyNoteLifecycleOp as a8, atomicNoteSpansOf as a9, noteTypeOf as aA, notesOf as aB, notesPartHasId as aC, observeHistoryGroup as aD, parseNoteId as aE, parseNoteScopeId as aF, resolveHeaderFooterParts as aG, resolveHeaderFooterPartsBySection as aH, resolveHeaderFooterResolutionBySection as aI, resolveNotesPart as aJ, withBinaryPart as aK, withEmbeddedImage as aL, withoutUnreferencedImagePart as aM, cascadeDeletedNoteReferences as aa, collectNoteReferences as ab, collectPackageNoteReferences as ac, collectSectionPropertyNodes as ad, createNoteReferenceScanBudget as ae, customMarkFollows as af, diagnoseNoteReferences as ag, findNoteById as ah, formatNoteScopeId as ai, isContinuationSeparatorNode as aj, isEndnotesNode as ak, isFootnotesNode as al, isHeaderFooterLifecycleOp as am, isNormalNote as an, isNoteAtomNode as ao, isNoteLifecycleOp as ap, isNoteNode as aq, isNoteRefNode as ar, isNoteReferenceNode as as, isSeparatorNode as at, normalNoteIds as au, noteAtomText as av, noteIdOf as aw, noteKindOf as ax, noteRefKindOf as ay, noteReferenceKindOf as az, TreeDocumentStore as f, reportHistoryGroup as r, MAX_NOTES_PER_PART as v, MAX_NOTE_REFERENCE_PARTS as w, MAX_NOTE_REFERENCE_SCAN as x, NOTE_ATOM_CHAR as y, NOTE_CONTINUATION_SEPARATOR_ID as z };
+export type { TreeDocumentStoreOptions as $, ApplyImagePropertiesInput as A, CascadeDeletedNoteReferencesOptions as C, FragmentPasteInput as F, HeaderFooterParts as H, InsertImageInput as I, NoteDiagnostic as J, NoteDiagnosticCode as K, NoteLifecycleImpact as L, NoteKind as N, NoteLifecycleOp as O, NoteLifecycleOptions as P, NoteLifecycleRejection as Q, ReplaceImageOptions as R, StoryScope as S, NoteLifecycleResult as U, NoteReferenceHit as V, NoteReferenceScanBudget as W, NoteType as X, PackageTransactResult as Y, RemotePackageAttribution as Z, StoryResolveResult as _, StoryTargetRejection as a, TreePackageStoreOptions as a0, TreeStoryRef as a1, TransactResult as a2, TransactionContext as a3, HeaderFooterSectionResolution as b, HeaderFooterVariant as c, HistoryGroup as d, TreeModelChange as e, SelectionMark as g, TransactOptions as h, ImageIntentResult as i, FragmentPasteResult as j, FieldResultsMode as k, AtomicNoteSpan as l, DrawingPropertyIdResult as m, HeaderFooterKind as n, HeaderFooterLifecycleImpact as o, HeaderFooterLifecycleOp as p, HeaderFooterLifecycleRejection as q, HeaderFooterLifecycleResult as s, HeaderFooterSlotMeta as t, HistoryCaptureKind as u };

package/dist/{tree-session-contract-AeY2v0x9.d.ts → tree-session-contract-CVbmlMlq.d.ts}

@@ -1,8 +1,8 @@
-import { S as StoryScope, g as SelectionMark, h as TransactOptions, a as StoryTargetRejection, b as TreeModelChange, c as HeaderFooterParts, d as HeaderFooterSectionResolution, I as InsertImageInput, i as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput, F as FragmentPasteInput, j as FragmentPasteResult } from './tree-package-fragment-YPyYC1aD.js';
-import { W as TreeDocOp, O as OoxmlPart, N as OoxmlNode, Q as OoxmlPackage, Z as OoxmlElement, a as ReviewItem, a7 as RevisionAttributionInput } from './types-barrel-BO73JqHG.js';
-import { S as SupportedImageMime, a as ImageDecodePort } from './image-resources-DfagDguq.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-Cy9imOjA.js';
-import { H as HeadlessDocumentView, D as DocumentProperties } from './headless-document-view-R9bzzepb.js';
+import { S as StoryScope, g as SelectionMark, h as TransactOptions, a as StoryTargetRejection, e as TreeModelChange, H as HeaderFooterParts, b as HeaderFooterSectionResolution, I as InsertImageInput, i as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput, F as FragmentPasteInput, j as FragmentPasteResult } from './tree-package-fragment-BeeKxDw8.js';
+import { W as TreeDocOp, O as OoxmlPart, N as OoxmlNode, Q as OoxmlPackage, Z as OoxmlElement, a as ReviewItem, aa as RevisionAttributionInput } from './types-barrel-D3xCgQX6.js';
+import { S as SupportedImageMime, a as ImageDecodePort } from './image-resources-BN-hUgCn.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-cvL5rhcD.js';
+import { H as HeadlessDocumentView, D as DocumentProperties } from './headless-document-view-qH331moE.js';
 import { Node } from 'prosemirror-model';
 import { CollaborationDocumentPort } from './collaboration/replication.js';
 import { V as ViewScope } from './editor-scope-OHPwVQ5l.js';
@@ -88,6 +88,8 @@ interface ThemeSchemeFaces {
     /** Language-specific theme faces, keyed by ISO 15924 script. */
     readonly majorSupplemental?: Readonly<Record<string, string>>;
     readonly minorSupplemental?: Readonly<Record<string, string>>;
+    /** Lower-cased font table names that declare a Chinese character set. */
+    readonly chineseFontTableFaces?: readonly string[];
 }
 /** The theme's font slots, fully resolved, for resolving `w:rFonts` theme attributes. */
 interface DocumentThemeFonts extends ThemeSchemeFaces {