@docx-editor.dev/core 2.9.2 → 2.11.0

package/dist/{tree-session-ZuBFOhIh.d.ts → tree-session-contract-BF2FVBOM.d.cts}

@@ -1,12 +1,11 @@
-import { S as SupportedImageMime, b as ImageDecodePort } from './image-resources-BgA9EQxY.js';
-import { S as StoryScope, a as StoryTargetRejection, D as DocumentTrackingSettings, I as InsertCustomNodeWrite, C as CustomNodeWriteResult, b as CustomNodeSweepOutcome, E as EmbeddedFont, B as BookmarkIndex, L as ListKind, c as InsertImageInput, d as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput } from './custom-node-writes-D6SGwebL.js';
+import { S as StoryScope, a as StoryTargetRejection, b as HeaderFooterParts, c as HeaderFooterSectionResolution, I as InsertImageInput, d as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput, F as FragmentPasteInput, e as FragmentPasteResult } from './tree-package-fragment-BjZ3RWAS.cjs';
+import { T as TreeDocOp, O as OoxmlPart, a as OoxmlNode, b as OoxmlPackage, g as OoxmlElement, y as SupportedImageMime, C as ImageDecodePort, E as RevisionAttributionInput } from './tree-op-types-BPyXNxyL.cjs';
+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-CwkYRw3V.cjs';
+import { D as DocumentProperties } from './document-properties-D6Ahr8D6.cjs';
+import { S as SelectionMark, b as TransactOptions, T as TreeModelChange } from './tree-store-DfZi7FqY.cjs';
+import { a as ReviewItem } from './review-items-BdeLNRi2.cjs';
 import { Node } from 'prosemirror-model';
-import { O as OoxmlPart, a as OoxmlNode, c as OoxmlPackage, b as OoxmlElement, o as OoxmlPackageRejection } from './ooxml-package-CdEy9ufK.js';
-import { a as HeaderFooterParts, b as HeaderFooterSectionResolution } from './hf-references-z5Y4N1ab.js';
-import { T as TreeDocOp } from './tree-op-types-CnRb7AYo.js';
-import { S as SelectionMark, T as TreeModelChange, D as DocumentProperties } from './tree-store-DgETo6Mf.js';
-import { a as ReviewItem } from './review-items-bdGxFWNA.js';
-import { ReviewModuleContribution } from './contracts/modules.js';
+import { CollaborationDocumentPort } from './collaboration/replication.cjs';
 
 /**
  * Why an edited projection could not be mapped back into tree ops.
@@ -91,6 +90,27 @@ interface DocumentStyleEntry {
     readonly preview: DocumentStylePreview;
 }
 
+/**
+ * The scheme slots the picker shows, in Word's column order.
+ *
+ * Assumes the default `w:clrSchemeMapping` (bg1→lt1, t1→dk1, ...); a settings part
+ * that remaps them is rare and a follow-up.
+ */
+declare const PICKER_SLOTS: readonly ["lt1", "dk1", "lt2", "dk2", "accent1", "accent2", "accent3", "accent4", "accent5", "accent6"];
+type ThemeColorSlot = (typeof PICKER_SLOTS)[number];
+/** One theme colour: the scheme slot and its resolved six-digit hex (no '#'). */
+interface DocumentThemeColorEntry {
+    readonly slot: ThemeColorSlot;
+    readonly hex: string;
+}
+/** The theme's two font slots, for resolving `w:rFonts` theme attributes. */
+interface DocumentThemeFonts {
+    /** `a:majorFont` latin typeface — headings. */
+    readonly major: string | null;
+    /** `a:minorFont` latin typeface — body text. */
+    readonly minor: string | null;
+}
+
 /** One heading of the outline, in document order. `level` is 0-based (Heading 1 = 0). */
 interface DocumentOutlineEntry {
     /** The paragraph's text, control characters flattened, bounded to 200 characters. */
@@ -142,38 +162,6 @@ interface DocumentSearchResult {
     readonly truncated: boolean;
 }
 
-/**
- * The scheme slots the picker shows, in Word's column order.
- *
- * Assumes the default `w:clrSchemeMapping` (bg1→lt1, t1→dk1, ...); a settings part
- * that remaps them is rare and a follow-up.
- */
-declare const PICKER_SLOTS: readonly ["lt1", "dk1", "lt2", "dk2", "accent1", "accent2", "accent3", "accent4", "accent5", "accent6"];
-type ThemeColorSlot = (typeof PICKER_SLOTS)[number];
-/** One theme colour: the scheme slot and its resolved six-digit hex (no '#'). */
-interface DocumentThemeColorEntry {
-    readonly slot: ThemeColorSlot;
-    readonly hex: string;
-}
-/** The theme's two font slots, for resolving `w:rFonts` theme attributes. */
-interface DocumentThemeFonts {
-    /** `a:majorFont` latin typeface — headings. */
-    readonly major: string | null;
-    /** `a:minorFont` latin typeface — body text. */
-    readonly minor: string | null;
-}
-
-/** What a run inherits at one point of the chain — null means "nothing authored". */
-interface StyleRunDefaults {
-    readonly fontFamily: string | null;
-    readonly fontSizeHalfPoints: number | null;
-}
-/** One run property as the layout records carry it (structurally SurfaceProperty). */
-interface RunPropertyLike {
-    readonly localName: string;
-    readonly attributes?: Record<string, string>;
-}
-
 interface ParagraphAnchorIndex {
     /** nodeId → `w14:paraId`, verbatim as authored/minted. Paragraphs without one are absent. */
     readonly paraIdByNode: ReadonlyMap<string, string>;
@@ -209,6 +197,17 @@ interface ParagraphAnchorIndex {
     readonly claimantsByParaId: ReadonlyMap<string, readonly string[]>;
 }
 
+/** What a run inherits at one point of the chain — null means "nothing authored". */
+interface StyleRunDefaults {
+    readonly fontFamily: string | null;
+    readonly fontSizeHalfPoints: number | null;
+}
+/** One run property as the layout records carry it (structurally SurfaceProperty). */
+interface RunPropertyLike {
+    readonly localName: string;
+    readonly attributes?: Record<string, string>;
+}
+
 /**
  * What applying ops produced: whether it committed, and why not when it did not.
  *
@@ -222,6 +221,8 @@ interface TreeApplyResult {
     /** Present when the edit was refused, so a host can report WHY rather than a silent no-op. */
     readonly reason?: TreeBindingRejection | StoryTargetRejection | string;
 }
+/** Optional collaboration attribution for a direct tree-op transaction. */
+type TreeApplyOptions = Pick<TransactOptions, 'origin' | 'actorId' | 'operationId' | 'recordsHistory'>;
 /**
  * One open document: the canonical tree, and the only write path into it.
  *
@@ -262,7 +263,7 @@ interface TreeDocxSessionView {
      * header/footer part; the transaction publishes one ModelChange (HF → `global` impact)
      * and one undo unit without swapping the body store.
      */
-    applyTreeOps(ops: readonly TreeDocOp[], selectionBefore?: SelectionMark | null, selectionAfter?: SelectionMark | null, scope?: StoryScope): TreeApplyResult;
+    applyTreeOps(ops: readonly TreeDocOp[], selectionBefore?: SelectionMark | null, selectionAfter?: SelectionMark | null, scope?: StoryScope, options?: TreeApplyOptions): TreeApplyResult;
     /**
      * Every part that holds a story, body first, then headers, footers and note parts.
      *
@@ -297,6 +298,8 @@ interface TreeDocxSessionView {
     beginComposition(scope?: StoryScope): void;
     endComposition(): void;
     subscribe(onChange: (change: TreeModelChange) => void): () => void;
+    /** Narrow provider-neutral attachment over this session's canonical package store. */
+    collaborationPort(documentId: string): CollaborationDocumentPort;
     /** Serialize the whole package back to DOCX bytes. */
     save(): Uint8Array;
     /**
@@ -423,7 +426,9 @@ interface TreeDocxSessionView {
         endParagraphId?: string;
     }, text: string, author: string, 
     /** ISO-8601. Omitted writes no `@w:date`, because inventing one is a content change. */
-    date?: string, scope?: StoryScope): string | null;
+    date?: string, scope?: StoryScope, 
+    /** Binds id allocation to one actor, so two peers cannot mint the same comment id. */
+    actorId?: string): string | null;
     /**
      * Resolve a comment thread, or reopen it. False when the document holds no such comment.
      *
@@ -570,71 +575,12 @@ interface TreeDocxSessionView {
     replaceImage(scope: StoryScope, drawingNodeId: string, bytes: Uint8Array, mime: SupportedImageMime, decodePort: ImageDecodePort, options: ReplaceImageOptions): Promise<ImageIntentResult>;
     /** Delete a picture drawing and collect orphaned media in one package undo unit. */
     deleteImage(scope: StoryScope, drawingNodeId: string): ImageIntentResult;
+    /** Propose the drawing's deletion as a tracked change (`w:del`); media stays untouched. */
+    deleteImageTracked(scope: StoryScope, drawingNodeId: string, revision: RevisionAttributionInput): ImageIntentResult;
     /** Apply image property tree ops plus hyperlink relationship wiring atomically. */
     applyImageProperties(scope: StoryScope, input: ApplyImagePropertiesInput): ImageIntentResult;
+    /** Land a clipboard fragment (resource merge + blocks) as one package undo unit. */
+    applyFragmentPaste(scope: StoryScope, input: FragmentPasteInput): FragmentPasteResult;
 }
-/**
- * Binding-only session methods that exchange ProseMirror projections.
- *
- * Editor surfaces expose {@link TreeDocxSessionView}. Only the binding lane sees this extension.
- */
-interface TreeDocxSession extends TreeDocxSessionView {
-    /** Project the current BODY revision into a ProseMirror doc. */
-    projectDoc(): Node;
-    /** Re-project incrementally from the last committed change, reusing untouched paragraphs. */
-    reconcile(previousDoc: Node): Node;
-    /**
-     * Whether the last commit changed the BLOCK SEQUENCE (a split, join, insert or delete).
-     *
-     * A host needs this to decide whether the view must be re-projected at all. After a pure
-     * text edit, the view already holds what the model holds. Re-projecting wastes work and
-     * races the next keystroke.
-     */
-    lastCommitWasStructural(): boolean;
-    /** Map an edited BODY doc to tree ops and commit them as one transaction. */
-    applyPmDoc(doc: Node): TreeApplyResult;
-}
-
-/**
- * Why bytes could not be opened: any bounded-reader rejection, plus the package that parsed but
- * carried no main document tree.
- */
-type TreeSessionRejection = OoxmlPackageRejection | 'no-main-document-tree';
-/**
- * An open session, or a typed refusal.
- *
- * A result rather than a throw: every failure here is a property of the FILE, and a host needs to
- * tell "this is not a package" from "this package is malicious" from "this document has no body".
- */
-type OpenTreeSessionResult = {
-    readonly ok: true;
-    readonly session: TreeDocxSession;
-} | {
-    readonly ok: false;
-    readonly reason: TreeSessionRejection;
-    readonly detail?: string;
-};
-interface OpenTreeSessionOptions {
-    /**
-     * The review module's derivation hooks, contributed through the editor's
-     * `EditorModule` seam. Absent — the free engine — the session's
-     * `reviewItems()` reports the typed empty queue; parse, preservation, and
-     * `hasReviewContent` are unaffected.
-     */
-    readonly reviewModel?: ReviewModuleContribution;
-}
-/**
- * Open DOCX bytes into a tree-backed session.
- *
- * Returns a typed rejection rather than throwing: every failure here is a property of the FILE,
- * and a host needs to tell "this is not a package" from "this package is malicious" from "this
- * document has no body".
- *
- * The read is BOUNDED — decompression ratio, part count, XML depth and element counts are all
- * capped — because the bytes are untrusted by definition.
- */
-declare function openTreeSession(bytes: Uint8Array, options?: OpenTreeSessionOptions): OpenTreeSessionResult;
-/** The origin a host should use when committing a reconciliation rather than a user edit. */
-declare const PROJECTION_ORIGIN: "dev.docx-editor.core.origin.projection";
 
-export { type DocumentStyleEntry as D, type MapResult as M, type OpenTreeSessionResult as O, PROJECTION_ORIGIN as P, type TreeDocxSession as T, type TreeApplyResult as a, type TreeBindingRejection as b, type TreeDocxSessionView as c, type TreeSessionRejection as d, bodyParagraphs as e, docToTreeOps as f, type DocumentThemeColorEntry as g, openTreeSession as o, partHasNode as p, reconcileDoc as r, treeToDoc as t };
+export { type DocumentStyleEntry as D, type MapResult as M, type TreeDocxSessionView as T, type TreeApplyResult as a, type TreeApplyOptions as b, type TreeBindingRejection as c, bodyParagraphs as d, docToTreeOps as e, type DocumentThemeColorEntry as f, partHasNode as p, reconcileDoc as r, treeToDoc as t };

package/dist/{tree-session-Df02ajqc.d.cts → tree-session-contract-DhdsFT_z.d.ts}

@@ -1,12 +1,11 @@
-import { S as SupportedImageMime, b as ImageDecodePort } from './image-resources-BiA-IXgo.cjs';
-import { S as StoryScope, a as StoryTargetRejection, D as DocumentTrackingSettings, I as InsertCustomNodeWrite, C as CustomNodeWriteResult, b as CustomNodeSweepOutcome, E as EmbeddedFont, B as BookmarkIndex, L as ListKind, c as InsertImageInput, d as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput } from './custom-node-writes-Dy3b20PS.cjs';
+import { S as StoryScope, a as StoryTargetRejection, b as HeaderFooterParts, c as HeaderFooterSectionResolution, I as InsertImageInput, d as ImageIntentResult, R as ReplaceImageOptions, A as ApplyImagePropertiesInput, F as FragmentPasteInput, e as FragmentPasteResult } from './tree-package-fragment-CDER0G3B.js';
+import { T as TreeDocOp, O as OoxmlPart, a as OoxmlNode, b as OoxmlPackage, g as OoxmlElement, y as SupportedImageMime, C as ImageDecodePort, E as RevisionAttributionInput } from './tree-op-types-DnzAOnc9.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-JfTn-Sy6.js';
+import { D as DocumentProperties } from './document-properties-D6Ahr8D6.js';
+import { S as SelectionMark, b as TransactOptions, T as TreeModelChange } from './tree-store-CNZ3O83s.js';
+import { a as ReviewItem } from './review-items-CkYyXhXM.js';
 import { Node } from 'prosemirror-model';
-import { O as OoxmlPart, a as OoxmlNode, c as OoxmlPackage, b as OoxmlElement, o as OoxmlPackageRejection } from './ooxml-package-CdEy9ufK.cjs';
-import { a as HeaderFooterParts, b as HeaderFooterSectionResolution } from './hf-references-Dvk6De4Q.cjs';
-import { T as TreeDocOp } from './tree-op-types-D1vNJ7XC.cjs';
-import { S as SelectionMark, T as TreeModelChange, D as DocumentProperties } from './tree-store-B_sJBMIS.cjs';
-import { a as ReviewItem } from './review-items-B8tffIXj.cjs';
-import { ReviewModuleContribution } from './contracts/modules.cjs';
+import { CollaborationDocumentPort } from './collaboration/replication.js';
 
 /**
  * Why an edited projection could not be mapped back into tree ops.
@@ -91,6 +90,27 @@ interface DocumentStyleEntry {
     readonly preview: DocumentStylePreview;
 }
 
+/**
+ * The scheme slots the picker shows, in Word's column order.
+ *
+ * Assumes the default `w:clrSchemeMapping` (bg1→lt1, t1→dk1, ...); a settings part
+ * that remaps them is rare and a follow-up.
+ */
+declare const PICKER_SLOTS: readonly ["lt1", "dk1", "lt2", "dk2", "accent1", "accent2", "accent3", "accent4", "accent5", "accent6"];
+type ThemeColorSlot = (typeof PICKER_SLOTS)[number];
+/** One theme colour: the scheme slot and its resolved six-digit hex (no '#'). */
+interface DocumentThemeColorEntry {
+    readonly slot: ThemeColorSlot;
+    readonly hex: string;
+}
+/** The theme's two font slots, for resolving `w:rFonts` theme attributes. */
+interface DocumentThemeFonts {
+    /** `a:majorFont` latin typeface — headings. */
+    readonly major: string | null;
+    /** `a:minorFont` latin typeface — body text. */
+    readonly minor: string | null;
+}
+
 /** One heading of the outline, in document order. `level` is 0-based (Heading 1 = 0). */
 interface DocumentOutlineEntry {
     /** The paragraph's text, control characters flattened, bounded to 200 characters. */
@@ -142,38 +162,6 @@ interface DocumentSearchResult {
     readonly truncated: boolean;
 }
 
-/**
- * The scheme slots the picker shows, in Word's column order.
- *
- * Assumes the default `w:clrSchemeMapping` (bg1→lt1, t1→dk1, ...); a settings part
- * that remaps them is rare and a follow-up.
- */
-declare const PICKER_SLOTS: readonly ["lt1", "dk1", "lt2", "dk2", "accent1", "accent2", "accent3", "accent4", "accent5", "accent6"];
-type ThemeColorSlot = (typeof PICKER_SLOTS)[number];
-/** One theme colour: the scheme slot and its resolved six-digit hex (no '#'). */
-interface DocumentThemeColorEntry {
-    readonly slot: ThemeColorSlot;
-    readonly hex: string;
-}
-/** The theme's two font slots, for resolving `w:rFonts` theme attributes. */
-interface DocumentThemeFonts {
-    /** `a:majorFont` latin typeface — headings. */
-    readonly major: string | null;
-    /** `a:minorFont` latin typeface — body text. */
-    readonly minor: string | null;
-}
-
-/** What a run inherits at one point of the chain — null means "nothing authored". */
-interface StyleRunDefaults {
-    readonly fontFamily: string | null;
-    readonly fontSizeHalfPoints: number | null;
-}
-/** One run property as the layout records carry it (structurally SurfaceProperty). */
-interface RunPropertyLike {
-    readonly localName: string;
-    readonly attributes?: Record<string, string>;
-}
-
 interface ParagraphAnchorIndex {
     /** nodeId → `w14:paraId`, verbatim as authored/minted. Paragraphs without one are absent. */
     readonly paraIdByNode: ReadonlyMap<string, string>;
@@ -209,6 +197,17 @@ interface ParagraphAnchorIndex {
     readonly claimantsByParaId: ReadonlyMap<string, readonly string[]>;
 }
 
+/** What a run inherits at one point of the chain — null means "nothing authored". */
+interface StyleRunDefaults {
+    readonly fontFamily: string | null;
+    readonly fontSizeHalfPoints: number | null;
+}
+/** One run property as the layout records carry it (structurally SurfaceProperty). */
+interface RunPropertyLike {
+    readonly localName: string;
+    readonly attributes?: Record<string, string>;
+}
+
 /**
  * What applying ops produced: whether it committed, and why not when it did not.
  *
@@ -222,6 +221,8 @@ interface TreeApplyResult {
     /** Present when the edit was refused, so a host can report WHY rather than a silent no-op. */
     readonly reason?: TreeBindingRejection | StoryTargetRejection | string;
 }
+/** Optional collaboration attribution for a direct tree-op transaction. */
+type TreeApplyOptions = Pick<TransactOptions, 'origin' | 'actorId' | 'operationId' | 'recordsHistory'>;
 /**
  * One open document: the canonical tree, and the only write path into it.
  *
@@ -262,7 +263,7 @@ interface TreeDocxSessionView {
      * header/footer part; the transaction publishes one ModelChange (HF → `global` impact)
      * and one undo unit without swapping the body store.
      */
-    applyTreeOps(ops: readonly TreeDocOp[], selectionBefore?: SelectionMark | null, selectionAfter?: SelectionMark | null, scope?: StoryScope): TreeApplyResult;
+    applyTreeOps(ops: readonly TreeDocOp[], selectionBefore?: SelectionMark | null, selectionAfter?: SelectionMark | null, scope?: StoryScope, options?: TreeApplyOptions): TreeApplyResult;
     /**
      * Every part that holds a story, body first, then headers, footers and note parts.
      *
@@ -297,6 +298,8 @@ interface TreeDocxSessionView {
     beginComposition(scope?: StoryScope): void;
     endComposition(): void;
     subscribe(onChange: (change: TreeModelChange) => void): () => void;
+    /** Narrow provider-neutral attachment over this session's canonical package store. */
+    collaborationPort(documentId: string): CollaborationDocumentPort;
     /** Serialize the whole package back to DOCX bytes. */
     save(): Uint8Array;
     /**
@@ -423,7 +426,9 @@ interface TreeDocxSessionView {
         endParagraphId?: string;
     }, text: string, author: string, 
     /** ISO-8601. Omitted writes no `@w:date`, because inventing one is a content change. */
-    date?: string, scope?: StoryScope): string | null;
+    date?: string, scope?: StoryScope, 
+    /** Binds id allocation to one actor, so two peers cannot mint the same comment id. */
+    actorId?: string): string | null;
     /**
      * Resolve a comment thread, or reopen it. False when the document holds no such comment.
      *
@@ -570,71 +575,12 @@ interface TreeDocxSessionView {
     replaceImage(scope: StoryScope, drawingNodeId: string, bytes: Uint8Array, mime: SupportedImageMime, decodePort: ImageDecodePort, options: ReplaceImageOptions): Promise<ImageIntentResult>;
     /** Delete a picture drawing and collect orphaned media in one package undo unit. */
     deleteImage(scope: StoryScope, drawingNodeId: string): ImageIntentResult;
+    /** Propose the drawing's deletion as a tracked change (`w:del`); media stays untouched. */
+    deleteImageTracked(scope: StoryScope, drawingNodeId: string, revision: RevisionAttributionInput): ImageIntentResult;
     /** Apply image property tree ops plus hyperlink relationship wiring atomically. */
     applyImageProperties(scope: StoryScope, input: ApplyImagePropertiesInput): ImageIntentResult;
+    /** Land a clipboard fragment (resource merge + blocks) as one package undo unit. */
+    applyFragmentPaste(scope: StoryScope, input: FragmentPasteInput): FragmentPasteResult;
 }
-/**
- * Binding-only session methods that exchange ProseMirror projections.
- *
- * Editor surfaces expose {@link TreeDocxSessionView}. Only the binding lane sees this extension.
- */
-interface TreeDocxSession extends TreeDocxSessionView {
-    /** Project the current BODY revision into a ProseMirror doc. */
-    projectDoc(): Node;
-    /** Re-project incrementally from the last committed change, reusing untouched paragraphs. */
-    reconcile(previousDoc: Node): Node;
-    /**
-     * Whether the last commit changed the BLOCK SEQUENCE (a split, join, insert or delete).
-     *
-     * A host needs this to decide whether the view must be re-projected at all. After a pure
-     * text edit, the view already holds what the model holds. Re-projecting wastes work and
-     * races the next keystroke.
-     */
-    lastCommitWasStructural(): boolean;
-    /** Map an edited BODY doc to tree ops and commit them as one transaction. */
-    applyPmDoc(doc: Node): TreeApplyResult;
-}
-
-/**
- * Why bytes could not be opened: any bounded-reader rejection, plus the package that parsed but
- * carried no main document tree.
- */
-type TreeSessionRejection = OoxmlPackageRejection | 'no-main-document-tree';
-/**
- * An open session, or a typed refusal.
- *
- * A result rather than a throw: every failure here is a property of the FILE, and a host needs to
- * tell "this is not a package" from "this package is malicious" from "this document has no body".
- */
-type OpenTreeSessionResult = {
-    readonly ok: true;
-    readonly session: TreeDocxSession;
-} | {
-    readonly ok: false;
-    readonly reason: TreeSessionRejection;
-    readonly detail?: string;
-};
-interface OpenTreeSessionOptions {
-    /**
-     * The review module's derivation hooks, contributed through the editor's
-     * `EditorModule` seam. Absent — the free engine — the session's
-     * `reviewItems()` reports the typed empty queue; parse, preservation, and
-     * `hasReviewContent` are unaffected.
-     */
-    readonly reviewModel?: ReviewModuleContribution;
-}
-/**
- * Open DOCX bytes into a tree-backed session.
- *
- * Returns a typed rejection rather than throwing: every failure here is a property of the FILE,
- * and a host needs to tell "this is not a package" from "this package is malicious" from "this
- * document has no body".
- *
- * The read is BOUNDED — decompression ratio, part count, XML depth and element counts are all
- * capped — because the bytes are untrusted by definition.
- */
-declare function openTreeSession(bytes: Uint8Array, options?: OpenTreeSessionOptions): OpenTreeSessionResult;
-/** The origin a host should use when committing a reconciliation rather than a user edit. */
-declare const PROJECTION_ORIGIN: "dev.docx-editor.core.origin.projection";
 
-export { type DocumentStyleEntry as D, type MapResult as M, type OpenTreeSessionResult as O, PROJECTION_ORIGIN as P, type TreeDocxSession as T, type TreeApplyResult as a, type TreeBindingRejection as b, type TreeDocxSessionView as c, type TreeSessionRejection as d, bodyParagraphs as e, docToTreeOps as f, type DocumentThemeColorEntry as g, openTreeSession as o, partHasNode as p, reconcileDoc as r, treeToDoc as t };
+export { type DocumentStyleEntry as D, type MapResult as M, type TreeDocxSessionView as T, type TreeApplyResult as a, type TreeApplyOptions as b, type TreeBindingRejection as c, bodyParagraphs as d, docToTreeOps as e, type DocumentThemeColorEntry as f, partHasNode as p, reconcileDoc as r, treeToDoc as t };

package/dist/{tree-store-B_sJBMIS.d.cts → tree-store-CNZ3O83s.d.ts}

@@ -1,32 +1,121 @@
-import { O as OoxmlPart, c as OoxmlPackage } from './ooxml-package-CdEy9ufK.cjs';
-import { I as ImpactClass, T as TreeDocOp, a as TreeOpRejection } from './tree-op-types-D1vNJ7XC.cjs';
+import { a as OoxmlNode, j as OoxmlParagraphNode, k as OoxmlNoteNode, l as OoxmlContinuationSeparatorNode, m as OoxmlEndnotesNode, n as OoxmlFootnotesNode, o as OoxmlNoteRefNode, p as OoxmlNoteReferenceNode, q as OoxmlSeparatorNode, I as ImpactClass, O as OoxmlPart, b as OoxmlPackage, T as TreeDocOp, r as TreeOpRejection } from './tree-op-types-DnzAOnc9.js';
 
+/** UTF-16 placeholder for one atomic note unit in `paragraphTextOf` / segments. */
+declare const NOTE_ATOM_CHAR = "\uFFFC";
+/** Signed 32-bit Word-compatible note id range (positive allocation only). */
+declare const NOTE_ID_MIN = 1;
+/** Largest note id Word accepts — signed 32-bit. */
+declare const NOTE_ID_MAX = 2147483647;
+/** Reserved separator / continuation ids — never allocated for normal notes. */
+declare const NOTE_SEPARATOR_ID = -1;
+/** Reserved id of the continuation-separator entry. Never allocated to a real note. */
+declare const NOTE_CONTINUATION_SEPARATOR_ID = 0;
+/** Which notes part a note lives in. Decides both placement and numbering rules. */
+type NoteKind = 'footnote' | 'endnote';
+/** Authored `ST_FtnEdn` including explicit `normal`. Absent means Word default (normal). */
 /**
- * The document metadata Word's document-property fields render.
+ * What a note entry IS.
  *
- * Every member is optional: an absent part, an absent element, or an empty value all read as
- * `undefined`, and a field over a missing property paints nothing. Keys are engine-internal
- * names; the field → property mapping (`TITLE` → `title`, `AUTHOR` → `creator`, …) lives in
- * `layout/field-doc-property.ts`.
+ * Only `normal` is a note a reader sees. The others are the furniture Word stores in the same
+ * part — the rules and notices drawn around the note area — reached by reserved ids.
  */
-interface DocumentProperties {
-    /** `dc:title` — TITLE. */
-    readonly title?: string;
-    /** `dc:creator` — AUTHOR. */
-    readonly creator?: string;
-    /** `dc:subject` — SUBJECT. */
-    readonly subject?: string;
-    /** `cp:keywords` — KEYWORDS. */
-    readonly keywords?: string;
-    /** `cp:lastModifiedBy` — LASTSAVEDBY. */
-    readonly lastModifiedBy?: string;
-    /** `dc:description` — COMMENTS. */
-    readonly description?: string;
-    /** `Company` from `docProps/app.xml`. No field maps to it yet; carried for completeness. */
-    readonly company?: string;
-    /** `Manager` from `docProps/app.xml`. No field maps to it yet; carried for completeness. */
-    readonly manager?: string;
+type NoteType = 'normal' | 'separator' | 'continuationSeparator' | 'continuationNotice';
+/** Parse a signed decimal note id; reject non-integers and out-of-int32 values. */
+declare function parseNoteId(raw: string | undefined): number | null;
+/**
+ * Canonical `EditorScope { kind: 'note'; id }` encoding.
+ *
+ * Footnote id `1` and endnote id `1` coexist, so the kind is part of the string:
+ * `footnote:2` / `endnote:-1`. Do not invent a parallel scope union arm.
+ */
+declare function formatNoteScopeId(noteKind: NoteKind, noteId: number): string;
+/**
+ * Parse {@link formatNoteScopeId}. Returns `null` for malformed / out-of-range ids.
+ */
+declare function parseNoteScopeId(id: string): {
+    readonly noteKind: NoteKind;
+    readonly noteId: number;
+} | null;
+/** Whether a node is a `w:footnotes` part root. */
+declare function isFootnotesNode(node: OoxmlNode): node is OoxmlFootnotesNode;
+/** Whether a node is a `w:endnotes` part root. */
+declare function isEndnotesNode(node: OoxmlNode): node is OoxmlEndnotesNode;
+/** Whether a node is a `w:footnote` or `w:endnote` body. */
+declare function isNoteNode(node: OoxmlNode): node is OoxmlNoteNode;
+/** Whether a node is a body-side `w:footnoteReference` / `w:endnoteReference`. */
+declare function isNoteReferenceNode(node: OoxmlNode): node is OoxmlNoteReferenceNode;
+/** Whether a node is the `w:footnoteRef` / `w:endnoteRef` mark inside a note's own body. */
+declare function isNoteRefNode(node: OoxmlNode): node is OoxmlNoteRefNode;
+/** Whether a node is the `w:separator` rule drawn above the note area. */
+declare function isSeparatorNode(node: OoxmlNode): node is OoxmlSeparatorNode;
+/** Whether a node is the `w:continuationSeparator` rule used on continuation pages. */
+declare function isContinuationSeparatorNode(node: OoxmlNode): node is OoxmlContinuationSeparatorNode;
+/** Typed or generic `w:footnote` / `w:endnote`. */
+declare function noteKindOf(node: OoxmlNode): NoteKind | null;
+/** Authored `@w:id` on a note or noteReference when parseable. */
+declare function noteIdOf(node: OoxmlNode): number | null;
+/** Authored `@w:type` (`ST_FtnEdn`) when present and schema-legal; else `undefined`. */
+declare function noteTypeOf(node: OoxmlNode): NoteType | undefined;
+/** Whether a note is a normal (body) note — absent type and explicit `normal` both count. */
+declare function isNormalNote(node: OoxmlNode): boolean;
+/** Typed or generic footnote/endnote reference kind. */
+declare function noteReferenceKindOf(node: OoxmlNode): NoteKind | null;
+/** Typed or generic `w:footnoteRef` / `w:endnoteRef`. */
+declare function noteRefKindOf(node: OoxmlNode): NoteKind | null;
+/**
+ * Read `@w:customMarkFollows` on a note reference.
+ * Returns `undefined` when absent; otherwise the OOXML on/off interpretation.
+ */
+declare function customMarkFollows(node: OoxmlNode): boolean | undefined;
+/** Model text contributed by one atomic note unit. */
+declare function noteAtomText(): typeof NOTE_ATOM_CHAR;
+/**
+ * True when a run-inner node is a typed note atom that contributes one UTF-16 unit.
+ * Demoted/malformed known locals stay generic and contribute nothing.
+ */
+declare function isNoteAtomNode(node: OoxmlNode): boolean;
+/**
+ * One atomic note span inside a paragraph for caret / delete / selection.
+ *
+ * Each typed note atom is a single-node span (`removeNodeIds` = that node).
+ */
+interface AtomicNoteSpan {
+    readonly kind: 'noteReference' | 'noteRef' | 'separator' | 'continuationSeparator';
+    readonly node: OoxmlNode;
+    readonly runId: string;
+    readonly removeNodeIds: readonly string[];
 }
+/**
+ * Collect typed note atoms in document order (one segment each).
+ *
+ * Walks the same paragraph-inline surface as `segmentsOf` / `walkParagraphInline`:
+ * hyperlinks and content controls flatten; only direct run children contribute atoms.
+ * A demoted run-inner SDT husk stays opaque — no phantom addressable hit.
+ */
+declare function atomicNoteSpansOf(paragraph: OoxmlParagraphNode): readonly AtomicNoteSpan[];
+/** Cap on notes scanned when allocating / indexing a notes part. */
+declare const MAX_NOTES_PER_PART = 10000;
+/**
+ * Allocate the next positive signed 32-bit note id for a notes-part root.
+ *
+ * Solo: `max(existing)+1`, the dense sequence Word writes. `null` on exhaustion, so the
+ * caller refuses rather than wrapping onto an id a note already holds.
+ *
+ * With a collaboration actor bound — explicit argument, or the open store transaction — the
+ * id is the next unused value in that actor's stripe. Two peers each adding their first
+ * footnote from one snapshot otherwise both mint `w:id="1"`: the merge keeps both bodies
+ * under one id, both `w:footnoteReference` marks resolve to the first, and one author's note
+ * becomes unreachable.
+ *
+ * The reserved ids stay reserved either way. `0` (continuation separator) is seeded as used,
+ * so a residue of 0 advances one class instead of taking Word's furniture, and a stripe walk
+ * only ever climbs from a non-negative residue, so `-1` (separator) is unreachable.
+ */
+declare function allocateNoteId(notesRoot: OoxmlNode, actorId?: string): number | null;
+/** Collect note bodies from a footnotes/endnotes root, bounded. */
+declare function notesOf(root: OoxmlNode): readonly OoxmlNoteNode[];
+/** Find a typed note by id inside a notes-part root. */
+declare function findNoteById(root: OoxmlNode, noteId: number): OoxmlNoteNode | 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. */
@@ -67,6 +156,10 @@ interface TreeModelChange {
     readonly toRevision: number;
     readonly commitId: string;
     readonly origin: string;
+    /** Stable collaboration actor attribution, when the caller supplied it. */
+    readonly actorId?: string;
+    /** Stable collaboration operation identity, when the caller supplied it. */
+    readonly operationId?: string;
     readonly dirty: readonly string[];
     readonly created: readonly string[];
     readonly deleted: readonly string[];
@@ -132,6 +225,17 @@ interface TransactionContext {
 /** 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
@@ -284,6 +388,7 @@ declare class TreeDocumentStore {
      * is open, in which case the entry already exists and this transaction joins it.
      */
     transact(build: (ctx: TransactionContext) => void, options?: TransactOptions): TransactResult;
+    private commitTransaction;
     /**
      * Open one history entry for an IME composition.
      *
@@ -308,4 +413,4 @@ declare class TreeDocumentStore {
     private publish;
 }
 
-export { type DocumentProperties as D, type SelectionMark as S, type TreeModelChange as T, type TreeStoryRef as a, TreeDocumentStore as b, type TransactionContext as c, type TransactOptions as d, type TreeDocumentCheckpoint as e, type TreeDocumentStoreOptions as f, type TransactResult as g };
+export { type AtomicNoteSpan as A, isNoteReferenceNode as B, isSeparatorNode as C, noteAtomText as D, noteIdOf as E, noteKindOf as F, noteRefKindOf as G, noteReferenceKindOf as H, notesOf as I, parseNoteId as J, parseNoteScopeId as K, MAX_NOTES_PER_PART as M, type NoteKind as N, type SelectionMark as S, type TreeModelChange as T, TreeDocumentStore as a, type TransactOptions as b, type TreeStoryRef as c, type TransactionContext as d, type TreeDocumentCheckpoint as e, NOTE_ATOM_CHAR as f, NOTE_CONTINUATION_SEPARATOR_ID as g, NOTE_ID_MAX as h, NOTE_ID_MIN as i, NOTE_SEPARATOR_ID as j, type NoteType as k, type TreeDocumentStoreOptions as l, type TransactResult as m, noteTypeOf as n, allocateNoteId as o, atomicNoteSpansOf as p, customMarkFollows as q, findNoteById as r, formatNoteScopeId as s, isContinuationSeparatorNode as t, isEndnotesNode as u, isFootnotesNode as v, isNormalNote as w, isNoteAtomNode as x, isNoteNode as y, isNoteRefNode as z };