@docx-editor.dev/core 2.17.0 → 2.19.0

package/dist/{tree-op-types-C71G7rIv.d.ts → tree-op-types-DbdM7fJV.d.ts}

@@ -1800,6 +1800,40 @@ declare function writeOoxmlPackage(pkg: OoxmlPackage): Uint8Array;
 /** Replace one part's tree, returning a new package. Pure, like the tree edits themselves. */
 declare function withPart(pkg: OoxmlPackage, part: OoxmlPart): OoxmlPackage;
 
+type AutomationTableMutation = {
+    readonly kind: 'values';
+    readonly values: readonly (readonly string[])[];
+} | {
+    readonly kind: 'addRows' | 'addColumns';
+    readonly location: 'start' | 'end';
+    readonly count: number;
+    readonly values?: readonly (readonly string[])[];
+} | {
+    readonly kind: 'deleteRows' | 'deleteColumns';
+    readonly index: number;
+    readonly count: number;
+} | {
+    readonly kind: 'delete';
+} | {
+    readonly kind: 'properties';
+    readonly styleId?: string;
+    readonly headerRowCount?: number;
+} | {
+    readonly kind: 'cell';
+    readonly cellId: string;
+    readonly value?: string;
+    readonly columnWidth?: number;
+    readonly shadingColor?: string;
+    readonly verticalAlignment?: 'Top' | 'Center' | 'Bottom';
+};
+
+interface SetFieldCodeOp {
+    readonly op: 'setFieldCode';
+    readonly paragraphId: string;
+    readonly fieldNodeId: string;
+    readonly code: string;
+}
+
 type InsertTextOp = {
     readonly op: 'insertText';
     readonly paragraphId: string;
@@ -1857,6 +1891,12 @@ interface TextFormFieldOptions {
     readonly format: string;
     readonly enabled: boolean;
 }
+/** Supported format choices for legacy text input fields. @public */
+declare const TEXT_FORM_FORMATS: {
+    readonly regular: readonly ["", "Uppercase", "Lowercase", "First capital", "Title case"];
+    readonly number: readonly ["", "0", "0.00", "#,##0", "#,##0.00", "0%", "0.00%"];
+    readonly date: readonly ["", "M/d/yyyy", "MM/dd/yyyy", "d/M/yyyy", "dd/MM/yyyy", "yyyy-MM-dd", "d MMMM yyyy", "MMMM d, yyyy"];
+};
 
 /** A legacy text input in the shared paragraph offset space. */
 interface TextFormFieldRange {
@@ -2248,7 +2288,7 @@ interface OoxmlProperty {
  * level. Declarative and serializable, so the same op crosses a worker or transport boundary
  * unchanged.
  */
-type TreeDocOp = {
+type TreeDocOp = SetFieldCodeOp | {
     /**
      * Replace one story's complete block structure with fresh plain paragraphs.
      *
@@ -2581,6 +2621,11 @@ type TreeDocOp = {
      */
     readonly op: 'setHyperlinkTarget';
     readonly linkId: string;
+    /** Optional exact paragraph offsets for an ordinary text subrange of this link. */
+    readonly range?: {
+        readonly start: number;
+        readonly end: number;
+    };
     readonly relationshipId?: string;
     readonly anchor?: string;
     readonly tooltip?: string;
@@ -2595,6 +2640,11 @@ type TreeDocOp = {
      */
     readonly op: 'removeHyperlink';
     readonly linkId: string;
+    /** Optional exact paragraph offsets for an ordinary text subrange of this link. */
+    readonly range?: {
+        readonly start: number;
+        readonly end: number;
+    };
 } | {
     /**
      * Replace one preserved `m:oMath` atom from bounded linear-math input.
@@ -2745,6 +2795,28 @@ type TreeDocOp = {
     readonly gridColumnId: string;
     readonly columnWidthTwips: number;
     readonly tableWidthTwips: number;
+} | {
+    /** Atomic semantic table authoring. Newly created nodes never need caller-supplied IDs. */
+    readonly op: 'authorTable';
+    readonly action: {
+        readonly kind: 'existing';
+        readonly tableId: string;
+        readonly mutation: AutomationTableMutation;
+    } | {
+        readonly kind: 'insert';
+        readonly paragraphId: string;
+        readonly offset: number;
+        readonly rowCount: number;
+        readonly columnCount: number;
+        readonly values?: readonly (readonly string[])[];
+    };
+} | {
+    /** Lossless direct table properties; widths are one value per rectangular grid column. */
+    readonly op: 'setTableProperties';
+    readonly tableId: string;
+    readonly styleId?: string;
+    readonly headerRowCount?: number;
+    readonly columnWidthsTwips?: readonly number[];
 } | {
     /** Set one authored table row to an exact height in twips. */
     readonly op: 'setTableRowHeight';
@@ -2816,6 +2888,15 @@ type TreeDocOp = {
     readonly evenAndOddHeaders?: boolean;
     readonly headerDistanceTwips?: number;
     readonly footerDistanceTwips?: number;
+} | {
+    /**
+     * Word's Protect Document: enforce or lift `w:documentProtection` in `settings.xml`.
+     * Enforcing writes `w:edit="forms"` (filling in forms, the one restriction the store
+     * applies); lifting keeps the recorded mode and clears `w:enforcement`, as Word's Stop
+     * Protection does. A password-protected file refuses to lift. Package-level.
+     */
+    readonly op: 'setDocumentProtection';
+    readonly enforce: boolean;
 } | {
     /**
      * Insert a footnote or endnote: body reference + notes-part body (+ create the
@@ -3037,8 +3118,7 @@ type DrawingTreeDocOp = Extract<TreeDocOp, {
 }>;
 /** Just the `op` discriminants, for dispatch tables and validation. */
 type TreeDocOpKind = TreeDocOp['op'];
-/** Every {@link TreeDocOpKind}, for validation and exhaustiveness checks. */
-declare const TREE_DOC_OP_KINDS: readonly ["replaceStoryBlocks", "insertText", "deleteText", "setParagraphMarkRevision", "proposeParagraphMerge", "insertCommentMarker", "acceptRevision", "rejectRevision", "acceptAllRevisions", "rejectAllRevisions", "insertTab", "insertHardBreak", "insertPageBreak", "insertPageField", "setListLevel", "setListNumbering", "setParagraphTabStops", "setParagraphMarkProperties", "splitParagraph", "splitParagraphMany", "joinParagraphs", "setRunProperties", "setParagraphProperties", "setSectionProperties", "setSectionMark", "insertHyperlink", "setHyperlinkTarget", "removeHyperlink", "setMathEquation", "removeMathEquation", "setContentControlValue", "removeContentControl", "insertInlineContentControl", "addRepeatingSectionItem", "removeRepeatingSectionItem", "deleteBlock", "insertTable", "insertTableRow", "deleteTableRow", "insertTableColumn", "deleteTableColumn", "setTableColumnWidths", "setTableRightEdgeWidth", "setTableRowHeight", "setTableCellBorders", "setTableCellFill", "setTableCellVerticalAlignment", "createHeaderFooter", "deleteHeaderFooter", "linkToPrevious", "unlinkFromPrevious", "setSectionFurnitureOptions", "insertNote", "deleteNote", "convertNote", "convertAllNotes", "setNoteProperties", "setContentControlProperties", "insertContentControl", "insertFragment", "insertDrawing", "replaceDrawingResource", "deleteDrawing", "resizeDrawing", "cropDrawing", "positionDrawing", "setDrawingWrap", "setDrawingMetadata", "setDrawingLocks", "transformDrawing", "insertToc", "replaceTocResult", "rewriteTocPageNumbers", "refreshFieldResults", "setTextFormFieldDefault", "commitTextFormField"];
+
 /**
  * How far a committed op can reach, so layout can scope its work (task 5.2).
  *
@@ -3182,4 +3262,4 @@ type TreeOpResult = {
     readonly detail?: string;
 };
 
-export { type OoxmlDrawingNode as $, type DrawingVerticalReferenceFrame as A, type VectorImageMime as B, type RevisionAttributionInput as C, type DrawingKind as D, type ImageDecodePort as E, type DrawingTreeDocOp as F, type ImageResourceLimits as G, type TreeDocColorValue as H, type ImpactClass as I, DEFAULT_IMAGE_RESOURCE_LIMITS as J, IMAGE_WRAP_TARGETS as K, resolveImageResourceLimits as L, resolveSvgIntrinsicSize as M, sniffImageMime as N, type OoxmlPart as O, type PreservedImageMime as P, validateRasterHeader as Q, type RevisionAddress as R, type SourceCrop as S, type TreeDocOp as T, type TableBorderStyle as U, type ValidatedImageBytesHandle as V, type DrawingAccessibility as W, type DrawingImageEffects as X, type DrawingTransform as Y, type VectorShapeProjection as Z, type DrawingProjection as _, type OoxmlNode as a, type OoxmlContentControlEndPropertiesNode as a$, type ResourceLimits as a0, type OoxmlInvariantResult as a1, type RelationshipRecord as a2, type OoxmlInvariantIssue as a3, type OoxmlHardBreakNode as a4, type OoxmlFldCharNode as a5, type OoxmlFldSimpleNode as a6, type OoxmlInstrTextNode as a7, type OoxmlAttribute as a8, type TreeOpResult as a9, type HyperlinkKind as aA, type HyperlinkTarget as aB, IMAGE_RELATIONSHIP_TYPE as aC, IMAGE_RESOURCE_HARD_CEILINGS as aD, type ImageRelationshipResolution as aE, type ImageResourceLookup as aF, type IndexResult as aG, type InsertTextOp as aH, MAX_CONTENT_CONTROLS_PER_PART as aI, MAX_CONTENT_CONTROL_NESTING as aJ, MAX_SVG_SNIFF_BYTES as aK, type NameRejection as aL, type NameResult as aM, OFFICE_RELATIONSHIP_NAMESPACE_URI as aN, OOXML_NODE_IDENTITY_RULES as aO, type OoxmlBodyNode as aP, type OoxmlBookmarkEndNode as aQ, type OoxmlBookmarkStartNode as aR, type OoxmlContentControlCalendarNode as aS, type OoxmlContentControlCheckboxNode as aT, type OoxmlContentControlCheckedNode as aU, type OoxmlContentControlCheckedStateNode as aV, type OoxmlContentControlComboBoxNode as aW, type OoxmlContentControlDataBindingNode as aX, type OoxmlContentControlDateFormatNode as aY, type OoxmlContentControlDateNode as aZ, type OoxmlContentControlDropDownListNode as a_, ACCEPTED_PARAGRAPH_PROPERTIES as aa, ACCEPTED_RUN_PROPERTIES as ab, CONTENT_CONTROL_ID_MAX as ac, CONTENT_CONTROL_PROPERTY_ORDER as ad, type CommitTextFormFieldOp as ae, type ContentControlCheckbox as af, type ContentControlCheckboxState as ag, type ContentControlDataBinding as ah, type ContentControlDateFormat as ai, type ContentControlEntry as aj, type ContentControlKind as ak, type ContentControlLevel as al, type ContentControlListItem as am, type ContentControlLock as an, type ContentControlProperties as ao, type ContentTypeError as ap, type ContentTypeIndex as aq, type ContentTypeRecords as ar, type CreateImageResourceCacheOptions as as, DEFAULT_LIMITS as at, DEFAULT_OOXML_PACKAGE_LIMITS as au, DEFAULT_ZIP_LIMITS as av, type DefaultRecord as aw, type DeleteTextOp as ax, HARD_CEILINGS as ay, HYPERLINK_RELATIONSHIP_TYPE as az, type OoxmlPackage as b, contentControlPropertiesOf as b$, type OoxmlContentControlLidNode as b0, type OoxmlContentControlListItemNode as b1, type OoxmlContentControlPropertiesNode as b2, type OoxmlContentControlStoreMappedDataAsNode as b3, type OoxmlContentControlTextNode as b4, type OoxmlContentControlUncheckedStateNode as b5, type OoxmlDocumentNode as b6, type OoxmlExternalTarget as b7, type OoxmlGenericExtensionAttribute as b8, type OoxmlHyperlinkNode as b9, type TargetMode as bA, type TextFormFieldOptions as bB, type TextFormFieldRange as bC, type TextFormFieldType as bD, type TreeDocOpKind as bE, type TreeOpEffect as bF, type ValidatedRasterHeader as bG, WML_NAMESPACE_URI as bH, XMLNS_NAMESPACE_URI as bI, XML_NAMESPACE_URI as bJ, type XmlLimits as bK, type XmlNode as bL, type XmlRejection as bM, type XmlResult as bN, type ZipLimits as bO, type ZipReadResult as bP, type ZipRejection as bQ, allocateContentControlId as bR, asciiFold as bS, buildContentTypeIndex as bT, buildRelationshipSet as bU, childElements as bV, contentControlContentChildren as bW, contentControlContentNodeOf as bX, contentControlEndPropertiesNodeOf as bY, contentControlLevelOf as bZ, contentControlPropertiesNodeOf as b_, type OoxmlInvariantIssueCode as ba, type OoxmlKnownNodeAttribute as bb, type OoxmlNamespaceBinding as bc, type OoxmlNodeIdentityRules as bd, type OoxmlPackageResult as be, type OoxmlParagraphPropertiesNode as bf, type OoxmlPartMetadata as bg, type OoxmlReadRejection as bh, type OoxmlReadResult as bi, type OoxmlRunNode as bj, type OoxmlRunPropertiesNode as bk, type OoxmlTabNode as bl, type OoxmlTextElementNode as bm, type OoxmlTextNode as bn, type OoxmlWmlValAttribute as bo, type OoxmlXmlSpaceAttribute as bp, type OverrideRecord as bq, type RelationshipError as br, type RelationshipSetResult as bs, type RelationshipTargetResolver as bt, type ResolveResult as bu, type ResolvedRelationship as bv, type SetTextFormFieldDefaultOp as bw, TABLE_BORDER_STYLES as bx, TREE_DOC_OP_KINDS as by, type TabStopWrite as bz, type OoxmlElement as c, contentControlTextOf as c0, contentControlsIn as c1, createImageResourceCache as c2, detectDuplicateNames as c3, extensionKey as c4, findContentControl as c5, findElement as c6, flattenContentControls as c7, hasBoundedSvgRoot as c8, hyperlinkAnchorOf as c9, resolveInternalTarget as cA, resolveLimits as cB, resolveRelationship as cC, textContent as cD, textFormFieldsOf as cE, validateExternalTarget as cF, validateGifHeader as cG, validateJpegHeader as cH, validatePngHeader as cI, withPart as cJ, writeOoxmlPackage as cK, writeZip as cL, type VectorShapeComponent as cM, hyperlinkRelationshipIdOf as ca, hyperlinkTargetOf as cb, imageResourceLookupFor as cc, isContentControlContentNode as cd, isContentControlNode as ce, isContentControlWrapper as cf, isContentRevisionKind as cg, isHyperlinkNode as ch, isRangeMarkerKind as ci, isValidMime as cj, liveDrawingReferenceCount as ck, lockForbidsEdit as cl, lockForbidsRemoval as cm, normalizePartName as cn, orderedContentControlProperties as co, parseContentControlId as cp, partNameKey as cq, projectDrawing as cr, readOnOffChild as cs, readOoxmlPackage as ct, readOoxmlPart as cu, readXml as cv, readZip as cw, resolveContentControlLock as cx, resolveContentType as cy, resolveImageRelationship as cz, type OoxmlNodeId as d, type OoxmlGenericElementNode as e, type OoxmlPackageLimits as f, type OoxmlPackageRejection as g, type OoxmlParagraphNode as h, type OoxmlNoteNode as i, type OoxmlContinuationSeparatorNode as j, type OoxmlEndnotesNode as k, type OoxmlFootnotesNode as l, type OoxmlNoteRefNode as m, type OoxmlNoteReferenceNode as n, type OoxmlSeparatorNode as o, type TreeOpRejection as p, type OoxmlProperty as q, type OoxmlContentControlNode as r, type OoxmlContentControlContentNode as s, type RenderableImageMime as t, type ImageWrapTarget as u, type DrawingPositionInput as v, type DrawingLocks as w, type ImageResourceState as x, type SupportedImageMime as y, type DrawingHorizontalReferenceFrame as z };
+export { type VectorShapeProjection as $, type AutomationTableMutation as A, type OoxmlFootnotesNode as B, type OoxmlNoteRefNode as C, type DrawingKind as D, type OoxmlNoteReferenceNode as E, type OoxmlSeparatorNode as F, type DrawingTreeDocOp as G, type ImpactClass as H, type ImageWrapTarget as I, type TreeDocColorValue as J, DEFAULT_IMAGE_RESOURCE_LIMITS as K, IMAGE_WRAP_TARGETS as L, TEXT_FORM_FORMATS as M, resolveImageResourceLimits as N, type OoxmlPart as O, type PreservedImageMime as P, resolveSvgIntrinsicSize as Q, type RevisionAddress as R, type SourceCrop as S, type TreeDocOp as T, sniffImageMime as U, type ValidatedImageBytesHandle as V, validateRasterHeader as W, type TableBorderStyle as X, type DrawingAccessibility as Y, type DrawingImageEffects as Z, type DrawingTransform as _, type OoxmlNode as a, type OoxmlContentControlDateFormatNode as a$, type DrawingProjection as a0, type OoxmlDrawingNode as a1, type ContentControlKind as a2, type ContentControlLevel as a3, type ContentControlLock as a4, type ContentControlDataBinding as a5, type VectorShapeComponent as a6, type ResourceLimits as a7, type OoxmlInvariantResult as a8, type RelationshipRecord as a9, type DeleteTextOp as aA, HARD_CEILINGS as aB, HYPERLINK_RELATIONSHIP_TYPE as aC, type HyperlinkKind as aD, type HyperlinkTarget as aE, IMAGE_RELATIONSHIP_TYPE as aF, IMAGE_RESOURCE_HARD_CEILINGS as aG, type ImageRelationshipResolution as aH, type ImageResourceLookup as aI, type IndexResult as aJ, type InsertTextOp as aK, MAX_CONTENT_CONTROLS_PER_PART as aL, MAX_CONTENT_CONTROL_NESTING as aM, MAX_SVG_SNIFF_BYTES as aN, type NameRejection as aO, type NameResult as aP, OFFICE_RELATIONSHIP_NAMESPACE_URI as aQ, OOXML_NODE_IDENTITY_RULES as aR, type OoxmlBodyNode as aS, type OoxmlBookmarkEndNode as aT, type OoxmlBookmarkStartNode as aU, type OoxmlContentControlCalendarNode as aV, type OoxmlContentControlCheckboxNode as aW, type OoxmlContentControlCheckedNode as aX, type OoxmlContentControlCheckedStateNode as aY, type OoxmlContentControlComboBoxNode as aZ, type OoxmlContentControlDataBindingNode as a_, type OoxmlInvariantIssue as aa, type OoxmlHardBreakNode as ab, type OoxmlFldCharNode as ac, type OoxmlFldSimpleNode as ad, type OoxmlInstrTextNode as ae, type OoxmlAttribute as af, type TreeOpResult as ag, ACCEPTED_PARAGRAPH_PROPERTIES as ah, ACCEPTED_RUN_PROPERTIES as ai, CONTENT_CONTROL_ID_MAX as aj, CONTENT_CONTROL_PROPERTY_ORDER as ak, type CommitTextFormFieldOp as al, type ContentControlCheckbox as am, type ContentControlCheckboxState as an, type ContentControlDateFormat as ao, type ContentControlEntry as ap, type ContentControlListItem as aq, type ContentControlProperties as ar, type ContentTypeError as as, type ContentTypeIndex as at, type ContentTypeRecords as au, type CreateImageResourceCacheOptions as av, DEFAULT_LIMITS as aw, DEFAULT_OOXML_PACKAGE_LIMITS as ax, DEFAULT_ZIP_LIMITS as ay, type DefaultRecord as az, type OoxmlPackage as b, contentControlLevelOf as b$, type OoxmlContentControlDateNode as b0, type OoxmlContentControlDropDownListNode as b1, type OoxmlContentControlEndPropertiesNode as b2, type OoxmlContentControlLidNode as b3, type OoxmlContentControlListItemNode as b4, type OoxmlContentControlPropertiesNode as b5, type OoxmlContentControlStoreMappedDataAsNode as b6, type OoxmlContentControlTextNode as b7, type OoxmlContentControlUncheckedStateNode as b8, type OoxmlDocumentNode as b9, TABLE_BORDER_STYLES as bA, type TabStopWrite as bB, type TargetMode as bC, type TextFormFieldOptions as bD, type TextFormFieldRange as bE, type TextFormFieldType as bF, type TreeDocOpKind as bG, type TreeOpEffect as bH, type ValidatedRasterHeader as bI, WML_NAMESPACE_URI as bJ, XMLNS_NAMESPACE_URI as bK, XML_NAMESPACE_URI as bL, type XmlLimits as bM, type XmlNode as bN, type XmlRejection as bO, type XmlResult as bP, type ZipLimits as bQ, type ZipReadResult as bR, type ZipRejection as bS, allocateContentControlId as bT, asciiFold as bU, buildContentTypeIndex as bV, buildRelationshipSet as bW, childElements as bX, contentControlContentChildren as bY, contentControlContentNodeOf as bZ, contentControlEndPropertiesNodeOf as b_, type OoxmlExternalTarget as ba, type OoxmlGenericExtensionAttribute as bb, type OoxmlHyperlinkNode as bc, type OoxmlInvariantIssueCode as bd, type OoxmlKnownNodeAttribute as be, type OoxmlNamespaceBinding as bf, type OoxmlNodeIdentityRules as bg, type OoxmlPackageResult as bh, type OoxmlParagraphPropertiesNode as bi, type OoxmlPartMetadata as bj, type OoxmlReadRejection as bk, type OoxmlReadResult as bl, type OoxmlRunNode as bm, type OoxmlRunPropertiesNode as bn, type OoxmlTabNode as bo, type OoxmlTextElementNode as bp, type OoxmlTextNode as bq, type OoxmlWmlValAttribute as br, type OoxmlXmlSpaceAttribute as bs, type OverrideRecord as bt, type RelationshipError as bu, type RelationshipSetResult as bv, type RelationshipTargetResolver as bw, type ResolveResult as bx, type ResolvedRelationship as by, type SetTextFormFieldDefaultOp as bz, type OoxmlNodeId as c, contentControlPropertiesNodeOf as c0, contentControlPropertiesOf as c1, contentControlTextOf as c2, contentControlsIn as c3, createImageResourceCache as c4, detectDuplicateNames as c5, extensionKey as c6, findContentControl as c7, findElement as c8, flattenContentControls as c9, resolveContentType as cA, resolveImageRelationship as cB, resolveInternalTarget as cC, resolveLimits as cD, resolveRelationship as cE, textContent as cF, textFormFieldsOf as cG, validateExternalTarget as cH, validateGifHeader as cI, validateJpegHeader as cJ, validatePngHeader as cK, withPart as cL, writeOoxmlPackage as cM, writeZip as cN, hasBoundedSvgRoot as ca, hyperlinkAnchorOf as cb, hyperlinkRelationshipIdOf as cc, hyperlinkTargetOf as cd, imageResourceLookupFor as ce, isContentControlContentNode as cf, isContentControlNode as cg, isContentControlWrapper as ch, isContentRevisionKind as ci, isHyperlinkNode as cj, isRangeMarkerKind as ck, isValidMime as cl, liveDrawingReferenceCount as cm, lockForbidsEdit as cn, lockForbidsRemoval as co, normalizePartName as cp, orderedContentControlProperties as cq, parseContentControlId as cr, partNameKey as cs, projectDrawing as ct, readOnOffChild as cu, readOoxmlPackage as cv, readOoxmlPart as cw, readXml as cx, readZip as cy, resolveContentControlLock as cz, type OoxmlGenericElementNode as d, type OoxmlElement as e, type OoxmlPackageLimits as f, type OoxmlPackageRejection as g, type OoxmlProperty as h, type OoxmlContentControlNode as i, type OoxmlContentControlContentNode as j, type RenderableImageMime as k, type TreeOpRejection as l, type DrawingPositionInput as m, type DrawingLocks as n, type ImageResourceState as o, type SupportedImageMime as p, type DrawingHorizontalReferenceFrame as q, type DrawingVerticalReferenceFrame as r, type VectorImageMime as s, type ImageDecodePort as t, type RevisionAttributionInput as u, type ImageResourceLimits as v, type OoxmlParagraphNode as w, type OoxmlNoteNode as x, type OoxmlContinuationSeparatorNode as y, type OoxmlEndnotesNode as z };