@cj-tech-master/excelts 9.5.4 → 9.5.5

package/dist/types/modules/word/types.d.ts

@@ -81,8 +81,8 @@ export interface SectionColumns {
 }
 /** Section break type. */
 export type SectionBreakType = "nextPage" | "continuous" | "evenPage" | "oddPage" | "nextColumn";
-/** Page number format. */
-export type PageNumberFormat = "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter";
+/** Page number format (ST_NumberFormat subset used for page numbering). */
+export type PageNumberFormat = "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "bullet" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "none" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText" | "custom";
 /** Header/footer reference type. */
 export type HeaderFooterType = "default" | "first" | "even";
 /** Reference to a header or footer part. */
@@ -96,8 +96,6 @@ export interface HeaderFooterRef {
 export type PageVerticalAlign = "top" | "center" | "both" | "bottom";
 /** Document grid type. */
 export type DocumentGridType = "default" | "lines" | "linesAndChars" | "snapToChars";
-/** Page text direction. */
-export type PageTextDirection = "lrTb" | "tbRl" | "btLr" | "lrTbV" | "tbRlV" | "tbLrV";
 /** A single border definition. */
 export interface Border {
     /** Border style. */
@@ -171,7 +169,7 @@ export interface SectionProperties {
     /** Page vertical alignment. */
     readonly verticalAlign?: PageVerticalAlign;
     /** Page text direction. */
-    readonly textDirection?: PageTextDirection;
+    readonly textDirection?: TextDirection;
     /** Footnote properties for this section. */
     readonly footnoteProperties?: FootnoteProperties;
     /** Endnote properties for this section. */
@@ -185,8 +183,8 @@ export interface SectionProperties {
     /** Register (w:rtlGutter for right-to-left). */
     readonly rtlGutter?: boolean;
 }
-/** Underline styles. */
-export type UnderlineStyle = "single" | "double" | "thick" | "dotted" | "dash" | "dotDash" | "dotDotDash" | "wave" | "wavyHeavy" | "wavyDouble" | "dashLong" | "dashLongHeavy" | "words" | "none";
+/** Underline styles (ST_Underline). */
+export type UnderlineStyle = "single" | "words" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "none";
 /** Vertical alignment for superscript/subscript. */
 export type VerticalAlign = "superscript" | "subscript" | "baseline";
 /** Highlight colors. */
@@ -232,6 +230,31 @@ export interface UnderlineSpec {
 export type TextEffect = "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle" | "none";
 /** Emphasis mark type. */
 export type EmphasisMarkType = "dot" | "comma" | "circle" | "underDot" | "none";
+/** Bracket style used when combining East Asian characters into a composite cell. */
+export type EastAsianCombineBrackets = "none" | "round" | "square" | "angle" | "curly";
+/**
+ * East Asian typographic layout overrides for a run (ECMA-376 §17.3.2.10
+ * `<w:eastAsianLayout>`). Used for Japanese/Korean classical layout to
+ * combine consecutive characters into a single display cell, render
+ * vertically, or compress vertical glyphs.
+ *
+ * The layout/render-page modules render runs carrying this property in
+ * standard horizontal direction (vert/vertCompress are not visualised);
+ * reader and writer round-trip the property losslessly so the source
+ * intent is preserved across edits.
+ */
+export interface EastAsianLayoutSpec {
+    /** Tracking id; pairs with `rPrChange` revisions. */
+    readonly id?: number;
+    /** Combine consecutive characters into one composite display cell. */
+    readonly combine?: boolean;
+    /** Bracket style used when combining (defaults to `none`). */
+    readonly combineBrackets?: EastAsianCombineBrackets;
+    /** Render the run vertically (top-to-bottom). */
+    readonly vert?: boolean;
+    /** Compress vertical glyphs into half-width cells. */
+    readonly vertCompress?: boolean;
+}
 /** Color specification with optional theme support. */
 export interface ColorSpec {
     /** Hex RGB color value (e.g. "FF0000") or "auto". */
@@ -315,6 +338,8 @@ export interface RunProperties {
     readonly effect?: TextEffect;
     /** Emphasis mark (East Asian typography). */
     readonly emphasisMark?: EmphasisMarkType;
+    /** East Asian layout overrides (combine, vertical, etc.). ECMA-376 §17.3.2.10. */
+    readonly eastAsianLayout?: EastAsianLayoutSpec;
     /** Character border (border around individual run). */
     readonly border?: Border;
     /** Fit text: force text to fit a specific width (in twips). */
@@ -480,9 +505,20 @@ export interface DateFieldContent {
     readonly format?: string;
     /** Language tag. */
     readonly language?: string;
+    /** Pre-computed cached value to display. If omitted, the field shows empty until updated by Word. */
+    readonly cachedValue?: string;
 }
 /** Content that can appear inside a run. */
-export type RunContent = TextContent | BreakContent | TabContent | PositionalTabContent | RubyContent | SymbolContent | FootnoteRefContent | EndnoteRefContent | FieldContent | InlineImageContent | CarriageReturnContent | NoBreakHyphenContent | SoftHyphenContent | LastRenderedPageBreakContent | AnnotationReferenceContent | DateFieldContent;
+export type RunContent = TextContent | BreakContent | TabContent | PositionalTabContent | RubyContent | SymbolContent | FootnoteRefContent | EndnoteRefContent | FieldContent | InlineImageContent | CarriageReturnContent | NoBreakHyphenContent | SoftHyphenContent | LastRenderedPageBreakContent | AnnotationReferenceContent | DateFieldContent | OpaqueRunContent;
+/**
+ * Opaque run content: preserves unknown XML elements found inside a run
+ * for round-trip fidelity. The writer will emit the raw XML verbatim.
+ */
+export interface OpaqueRunContent {
+    readonly type: "opaqueRun";
+    /** Raw XML string of the unrecognized run child element. */
+    readonly rawXml: string;
+}
 /** A run of text with uniform formatting. */
 export interface Run {
     /** Run properties (formatting). */
@@ -629,8 +665,8 @@ export interface CommentReference {
     readonly type: "commentReference";
     readonly id: number;
 }
-/** Horizontal alignment. */
-export type Alignment = "start" | "center" | "end" | "both" | "distribute" | "left" | "right";
+/** Horizontal alignment (ST_Jc). */
+export type Alignment = "start" | "center" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute" | "left" | "right";
 /** Line spacing rule. */
 export type LineSpacingRule = "auto" | "exact" | "atLeast";
 /** Line spacing. */
@@ -661,8 +697,8 @@ export interface Indentation {
     /** End indent (logical direction, for BiDi). */
     readonly end?: Twips;
 }
-/** Tab stop alignment. */
-export type TabStopType = "left" | "center" | "right" | "decimal" | "bar" | "clear";
+/** Tab stop alignment (ST_TabJc). */
+export type TabStopType = "left" | "center" | "right" | "decimal" | "bar" | "clear" | "start" | "end" | "num";
 /** Tab stop leader character. */
 export type TabStopLeader = "dot" | "hyphen" | "underscore" | "none" | "heavy" | "middleDot";
 /** Tab stop definition. */
@@ -798,7 +834,7 @@ export interface ParagraphProperties {
     /** Snap to grid. */
     readonly snapToGrid?: boolean;
     /** Text direction for paragraph. */
-    readonly textDirection?: PageTextDirection;
+    readonly textDirection?: TextDirection;
 }
 /** A paragraph. */
 export interface Paragraph {
@@ -850,7 +886,16 @@ export interface BookmarkEnd {
     readonly id: number;
 }
 /** Items that can appear as children of a paragraph. */
-export type ParagraphChild = Run | Hyperlink | BookmarkStart | BookmarkEnd | CommentRangeStart | CommentRangeEnd | CommentReference | InsertedRun | DeletedRun | MovedFromRun | MovedToRun | MoveRangeMarker | CustomXmlTrackingMarker;
+export type ParagraphChild = Run | Hyperlink | BookmarkStart | BookmarkEnd | CommentRangeStart | CommentRangeEnd | CommentReference | InsertedRun | DeletedRun | MovedFromRun | MovedToRun | MoveRangeMarker | CustomXmlTrackingMarker | OpaqueParagraphChild;
+/**
+ * Opaque paragraph child: preserves unknown XML elements found at paragraph level
+ * for round-trip fidelity. The writer will emit the raw XML verbatim.
+ */
+export interface OpaqueParagraphChild {
+    readonly type: "opaqueParagraphChild";
+    /** Raw XML string of the unrecognized paragraph child element. */
+    readonly rawXml: string;
+}
 /** Table width specification. */
 export interface TableWidth {
     /** Width value. */
@@ -1432,6 +1477,18 @@ export interface DrawingShape {
     readonly rotation?: number;
     /** Raw XML string (for preserving unrecognized shape details on round-trip). */
     readonly rawXml?: string;
+    /**
+     * Advanced fill XML (gradient/pattern) — must be inserted in the spPr
+     * "fill" slot (after prstGeom, before a:ln) for OOXML schema validity.
+     * Internal: populated by createShape().
+     */
+    readonly _advancedFillXml?: string;
+    /**
+     * Advanced effects/3D XML (a:effectLst, a:scene3d, a:sp3d) — must be
+     * inserted in the spPr after a:ln to satisfy the OOXML schema order.
+     * Internal: populated by createShape().
+     */
+    readonly _advancedEffectsXml?: string;
 }
 /** Checkbox state. */
 export interface CheckBox {
@@ -1494,8 +1551,6 @@ export interface SdtProperties {
      * shows placeholder text; cleared automatically on first edit.
      */
     readonly showingPlaceholder?: boolean;
-    /** @deprecated Use `appearance` instead. Mapped to w:appearance for backwards compatibility. */
-    readonly showAs?: "boundingBox" | "startEnd" | "none";
     /** Placeholder text doc part reference. */
     readonly placeholder?: string;
     /** Data binding to Custom XML part. */
@@ -1557,8 +1612,15 @@ export interface StructuredDocumentTag {
     readonly type: "sdt";
     /** SDT properties. */
     readonly properties?: SdtProperties;
-    /** Content (paragraphs, runs, etc.). */
-    readonly content: readonly (Paragraph | Run | Table)[];
+    /**
+     * Content (paragraphs, runs, tables, or nested SDTs).
+     *
+     * Nested SDTs are valid OOXML — repeating sections, for instance, wrap
+     * each repeated item in its own inner `<w:sdt>`. The reader preserves
+     * the outer/inner structure verbatim and the writer recursively renders
+     * children of type `"sdt"`.
+     */
+    readonly content: readonly (Paragraph | Run | Table | StructuredDocumentTag)[];
 }
 /** Legacy form field type. */
 export type FormFieldType = "text" | "checkBox" | "dropDown";
@@ -1639,7 +1701,7 @@ export interface ImageWatermark {
 /** Watermark (text or image). */
 export type Watermark = TextWatermark | ImageWatermark;
 /** Block-level content that can appear in the document body. */
-export type BodyContent = Paragraph | Table | FloatingImage | TableOfContents | MathBlock | TextBox | CheckBox | DrawingShape | OpaqueDrawing | ChartContent | AltChunk | StructuredDocumentTag;
+export type BodyContent = Paragraph | Table | FloatingImage | TableOfContents | MathBlock | TextBox | CheckBox | DrawingShape | OpaqueDrawing | ChartContent | ChartExContent | AltChunk | StructuredDocumentTag;
 /** Alternate content chunk (w:altChunk) — embedded HTML/RTF/TXT/etc. in DOCX. */
 export interface AltChunk {
     readonly type: "altChunk";
@@ -1653,7 +1715,27 @@ export interface AltChunk {
     readonly fileName?: string;
 }
 /** Chart type. */
-export type ChartType = "bar" | "barStacked" | "barPercentStacked" | "column" | "columnStacked" | "columnPercentStacked" | "line" | "lineStacked" | "lineMarked" | "pie" | "pie3D" | "doughnut" | "area" | "areaStacked" | "scatter" | "scatterSmooth" | "radar";
+export type ChartType = "bar" | "barStacked" | "barPercentStacked" | "column" | "columnStacked" | "columnPercentStacked" | "line" | "lineStacked" | "lineMarked" | "pie" | "pie3D" | "doughnut" | "area" | "areaStacked" | "scatter" | "scatterSmooth" | "radar" | "radarFilled" | "bubble" | "stock" | "surface" | "surface3D" | "surfaceWireframe" | "surfaceWireframe3D";
+/** Trendline type for chart series. */
+export type ChartTrendlineType = "linear" | "exponential" | "logarithmic" | "polynomial" | "power" | "movingAvg";
+/** Trendline options for a chart series. */
+export interface ChartTrendline {
+    readonly type: ChartTrendlineType;
+    readonly order?: number;
+    readonly period?: number;
+    readonly displayEquation?: boolean;
+    readonly displayRSquared?: boolean;
+}
+/** Error bar direction. */
+export type ChartErrorBarDirection = "x" | "y" | "both";
+/** Error bar type. */
+export type ChartErrorBarType = "fixedVal" | "percentage" | "stdDev" | "stdErr" | "custom";
+/** Error bars options for a chart series. */
+export interface ChartErrorBars {
+    readonly direction: ChartErrorBarDirection;
+    readonly type: ChartErrorBarType;
+    readonly value?: number;
+}
 /** A data series in a chart. */
 export interface ChartSeries {
     readonly name: string;
@@ -1662,9 +1744,25 @@ export interface ChartSeries {
     readonly color?: HexColor;
     readonly pointColors?: readonly HexColor[];
     readonly showDataLabels?: boolean;
+    readonly trendline?: ChartTrendline;
+    readonly errorBars?: ChartErrorBars;
+    /** Per-series chart type override (for combo charts). */
+    readonly chartType?: ChartType;
+    /** Plot on secondary axis (for combo charts). */
+    readonly plotOnSecondaryAxis?: boolean;
 }
 /** Chart legend position. */
 export type ChartLegendPosition = "b" | "l" | "r" | "t" | "tr" | "none";
+/** Data label position. */
+export type ChartDataLabelPosition = "outsideEnd" | "center" | "insideEnd" | "bestFit";
+/** Data labels options for a chart. */
+export interface ChartDataLabels {
+    readonly showValue?: boolean;
+    readonly showCategory?: boolean;
+    readonly showSerName?: boolean;
+    readonly showPercent?: boolean;
+    readonly position?: ChartDataLabelPosition;
+}
 /** Chart axis configuration. */
 export interface ChartAxis {
     readonly title?: string;
@@ -1680,6 +1778,7 @@ export interface Chart {
     readonly title?: string;
     readonly series: readonly ChartSeries[];
     readonly legend?: ChartLegendPosition;
+    readonly dataLabels?: ChartDataLabels;
     readonly categoryAxis?: ChartAxis;
     readonly valueAxis?: ChartAxis;
     readonly secondaryValueAxis?: ChartAxis;
@@ -1689,6 +1788,12 @@ export interface Chart {
     readonly style?: number;
     readonly width?: Emu;
     readonly height?: Emu;
+    /** Secondary chart type for combo charts (legacy approach). */
+    readonly secondaryType?: ChartType;
+    /** Secondary series for combo chart (plotted on secondary axis). */
+    readonly secondarySeries?: readonly ChartSeries[];
+    /** Whether to embed chart data as an xlsx workbook (for full editing in Word). */
+    readonly embedWorkbook?: boolean;
 }
 /** Chart content placed in a document. */
 export interface ChartContent {
@@ -1697,6 +1802,43 @@ export interface ChartContent {
     readonly altText?: string;
     readonly name?: string;
 }
+/**
+ * ChartEx content block (cx: namespace, Office 2016+ chart types).
+ * Supports: sunburst, treemap, waterfall, funnel, histogram, pareto, boxWhisker, regionMap.
+ */
+export interface ChartExContent {
+    readonly type: "chartEx";
+    /** Pre-rendered ChartEx XML (cx:chartSpace). Generated via excel-bridge. */
+    readonly chartExXml: string;
+    /** Parsed structured data extracted from the ChartEx XML. */
+    readonly data?: ChartExData;
+    /** Alt text for accessibility. */
+    readonly altText?: string;
+    /** Drawing name. */
+    readonly name?: string;
+    /** Width in EMU. Default: 5486400 (6 inches). */
+    readonly width?: Emu;
+    /** Height in EMU. Default: 3657600 (4 inches). */
+    readonly height?: Emu;
+}
+/** Structured data extracted from a ChartEx (cx: namespace) XML. */
+export interface ChartExData {
+    /** Chart type (sunburst, treemap, waterfall, funnel, histogram, pareto, boxWhisker, regionMap). */
+    readonly chartType: string;
+    /** Chart title. */
+    readonly title?: string;
+    /** Series data. */
+    readonly series: readonly ChartExSeriesData[];
+}
+/** A single data series within a ChartEx chart. */
+export interface ChartExSeriesData {
+    /** Series name/label. */
+    readonly name?: string;
+    /** String categories. */
+    readonly categories?: readonly string[];
+    /** Numeric values. */
+    readonly values?: readonly number[];
+}
 /** Style type. */
 export type StyleType = "paragraph" | "character" | "table" | "numbering";
 /** Table style conditional format type. */
@@ -1766,8 +1908,8 @@ export interface DocDefaults {
     /** Default paragraph properties. */
     readonly paragraphProperties?: ParagraphProperties;
 }
-/** Number format type. */
-export type NumberFormat = "decimal" | "lowerLetter" | "upperLetter" | "lowerRoman" | "upperRoman" | "bullet" | "none" | "chineseCounting" | "ordinal" | "cardinalText" | "ordinalText" | "ideographDigital" | "ideographTraditional" | "japaneseCounting" | "decimalZero" | "decimalEnclosedCircle";
+/** Number format type (ST_NumberFormat). */
+export type NumberFormat = "decimal" | "upperRoman" | "lowerRoman" | "upperLetter" | "lowerLetter" | "ordinal" | "cardinalText" | "ordinalText" | "hex" | "chicago" | "ideographDigital" | "japaneseCounting" | "aiueo" | "iroha" | "decimalFullWidth" | "decimalHalfWidth" | "japaneseLegal" | "japaneseDigitalTenThousand" | "decimalEnclosedCircle" | "decimalFullWidth2" | "aiueoFullWidth" | "irohaFullWidth" | "decimalZero" | "bullet" | "ganada" | "chosung" | "decimalEnclosedFullstop" | "decimalEnclosedParen" | "decimalEnclosedCircleChinese" | "ideographEnclosedCircle" | "ideographTraditional" | "ideographZodiac" | "ideographZodiacTraditional" | "taiwaneseCounting" | "ideographLegalTraditional" | "taiwaneseCountingThousand" | "taiwaneseDigital" | "chineseCounting" | "chineseLegalSimplified" | "chineseCountingThousand" | "koreanDigital" | "koreanCounting" | "koreanLegal" | "koreanDigital2" | "vietnameseCounting" | "russianLower" | "russianUpper" | "none" | "numberInDash" | "hebrew1" | "hebrew2" | "arabicAlpha" | "arabicAbjad" | "hindiVowels" | "hindiConsonants" | "hindiNumbers" | "hindiCounting" | "thaiLetters" | "thaiNumbers" | "thaiCounting" | "bahtText" | "dollarText" | "custom";
 /** Level justification. */
 export type LevelJustification = "left" | "center" | "right";
 /** Level suffix (character after number). */
@@ -1920,6 +2062,14 @@ export interface ImageDef {
     readonly fileName: string;
     /** Relationship ID (assigned during packaging). */
     rId?: string;
+    /**
+     * Additional relationship IDs under which this same media file is referenced
+     * by other parts (typically header/footer .rels using their own local id
+     * space). Populated by the reader so that the packager can rebuild each
+     * part's local .rels even when callers and parts use different rIds for the
+     * same physical media file.
+     */
+    readonly aliasRIds?: readonly string[];
     /** SVG fallback image data (PNG). Required for SVG images in Word. */
     readonly fallbackData?: Uint8Array;
 }
@@ -2000,8 +2150,18 @@ export interface DocumentSettings {
     readonly trackRevisions?: boolean;
     /** Document protection. */
     readonly documentProtection?: {
-        readonly type: ProtectionType;
+        readonly type?: ProtectionType;
+        readonly edit?: string;
         readonly enforcement?: boolean;
+        readonly formatting?: boolean;
+        /** Hash algorithm (e.g. "SHA-256"). */
+        readonly hashAlgorithm?: string;
+        /** Base64-encoded hash value. */
+        readonly hashValue?: string;
+        /** Base64-encoded salt value. */
+        readonly saltValue?: string;
+        /** Number of hash iterations. */
+        readonly spinCount?: number;
     };
     /** Hyphenation settings. */
     readonly hyphenation?: HyphenationSettings;
@@ -2218,7 +2378,20 @@ export interface PersonInfo {
         readonly userId?: string;
     };
 }
+/**
+ * Document type discriminator.
+ * - "document" — standard .docx
+ * - "template" — .dotx (Word template)
+ * - "macroEnabledDocument" — .docm (macro-enabled)
+ * - "macroEnabledTemplate" — .dotm (macro-enabled template)
+ */
+export type DocxDocumentType = "document" | "template" | "macroEnabledDocument" | "macroEnabledTemplate";
 export interface DocxDocument {
+    /**
+     * Document type. Determines the content type used in the package.
+     * Default: "document" (standard .docx).
+     */
+    readonly docType?: DocxDocumentType;
     /** Document body content. */
     readonly body: readonly BodyContent[];
     /** Final section properties (for the last section). */
@@ -2276,6 +2449,8 @@ export interface DocxDocument {
     readonly theme?: DocumentTheme;
     /** Opaque (unrecognized) ZIP parts preserved for round-trip fidelity. */
     readonly opaqueParts?: readonly OpaquePart[];
+    /** VBA project binary (word/vbaProject.bin) for .docm/.dotm round-trip. */
+    readonly vbaProject?: Uint8Array;
 }
 /** A relationship entry preserved for round-trip. */
 export interface OpaqueRelationship {
@@ -2285,8 +2460,14 @@ export interface OpaqueRelationship {
     readonly type: string;
     /** Target path (relative to source part). */
     readonly target: string;
-    /** External target mode. */
-    readonly targetMode?: "External";
+    /**
+     * Target mode for the relationship. Standard OPC values are `"External"`
+     * and `"Internal"` (with `"Internal"` typically omitted on the wire). The
+     * field is typed as `string` rather than a union so that round-trip
+     * preserves any non-standard value present in the source document — the
+     * writer surfaces this verbatim into the output `.rels` file.
+     */
+    readonly targetMode?: string;
 }
 /** Custom XML part (for data binding). Stored in word/customXml/. */
 export interface CustomXmlPart {
@@ -2323,3 +2504,21 @@ export interface DocxOptions {
     /** Compression level (0-9). Default: 6. */
     readonly compressionLevel?: number;
 }
+/** A reference to a media asset (image, chart, etc.) by logical ID. */
+export interface AssetRef {
+    /** Logical asset ID (assigned by builder, resolved to rId at package time). */
+    readonly assetId: string;
+    /** Asset type hint. */
+    readonly type: "image" | "chart" | "oleObject" | "font" | "xlsx";
+}
+/** A media asset registered in the document. */
+export interface MediaAsset {
+    /** Logical ID for referencing. */
+    readonly id: string;
+    /** MIME content type. */
+    readonly contentType: string;
+    /** Raw binary data. */
+    readonly data: Uint8Array;
+    /** Suggested file name (without path). */
+    readonly fileName: string;
+}

package/dist/types/modules/word/units.d.ts

@@ -3,6 +3,32 @@
  *
  * Conversion functions between common measurement units used in OOXML.
  */
+/** Twips per inch (OOXML page measurements). */
+export declare const TWIPS_PER_INCH = 1440;
+/** Twips per point. */
+export declare const TWIPS_PER_POINT = 20;
+/** Twips per centimeter (approximate). */
+export declare const TWIPS_PER_CM = 567;
+/** Twips per millimeter (approximate). */
+export declare const TWIPS_PER_MM = 56.7;
+/** EMU (English Metric Units) per inch — DrawingML coordinate space. */
+export declare const EMU_PER_INCH = 914400;
+/** EMU per centimeter. */
+export declare const EMU_PER_CM = 360000;
+/** EMU per point. */
+export declare const EMU_PER_POINT = 12700;
+/** EMU per pixel at 96 DPI (CSS pixel). */
+export declare const EMU_PER_PX = 9525;
+/** Default chart width in EMU (6 inches). */
+export declare const DEFAULT_CHART_WIDTH_EMU: number;
+/** Default chart height in EMU (3.5 inches for c:chart). */
+export declare const DEFAULT_CHART_HEIGHT_EMU: number;
+/** Default ChartEx height in EMU (4 inches). */
+export declare const DEFAULT_CHART_EX_HEIGHT_EMU: number;
+/** Default wrap margin for inline drawings in EMU (≈0.125 inch). */
+export declare const DEFAULT_WRAP_MARGIN_EMU = 114300;
+/** Default `wp:anchor` `relativeHeight` (z-order) when not specified. */
+export declare const DEFAULT_RELATIVE_HEIGHT = 251658240;
 /** Convert inches to twips. */
 export declare function inchesToTwips(inches: number): number;
 /** Convert twips to inches. */

package/dist/types/modules/word/writer/checkbox-writer.d.ts

@@ -0,0 +1,17 @@
+/**
+ * DOCX Writers - CheckBox
+ *
+ * Renders checkbox as a structured document tag (SDT) with w14:checkbox.
+ *
+ * Per ECMA-376 Part 4 §17.5.2.41 the `w14:checkedState/@w14:val` attribute
+ * holds a 4-digit hexadecimal Unicode code point. We persist that hex form
+ * verbatim into the `w14:val` attribute, but the displayed glyph is rendered
+ * by converting to the actual character. To stay forgiving we accept both
+ * the canonical hex form (e.g. `"2612"`) and a literal glyph form (e.g.
+ * `"☒"`) on the input side, normalising both to a hex string for the
+ * attribute and the actual glyph for the displayed run.
+ */
+import type { XmlSink } from "../../xml/types.js";
+import type { CheckBox } from "../types.js";
+/** Render a checkbox as a paragraph with SDT. */
+export declare function renderCheckBox(xml: XmlSink, cb: CheckBox): void;

package/dist/{browser/modules/word/writers → types/modules/word/writer}/comment-writer.d.ts

@@ -5,8 +5,9 @@
  */
 import type { XmlSink } from "../../xml/types.js";
 import type { CommentDef } from "../types.js";
+import type { RenderHelpers } from "./render-context.js";
 /** Render word/comments.xml. */
-export declare function renderComments(xml: XmlSink, comments: readonly CommentDef[]): void;
+export declare function renderComments(xml: XmlSink, comments: readonly CommentDef[], helpers?: RenderHelpers): void;
 /**
  * Render word/commentsExtended.xml — extended comment metadata (done/parentId).
  * Only includes comments that have either `done` or `parentId` set.

package/dist/types/modules/word/writer/common-parts.d.ts

@@ -0,0 +1,57 @@
+/**
+ * DOCX Module - Common Auxiliary Parts Builder
+ *
+ * Shared logic for generating auxiliary XML parts (styles, settings, numbering,
+ * fontTable, theme, core properties, app properties, custom properties).
+ *
+ * Both the buffered packager and streaming writer use this to avoid duplicating
+ * the same rendering logic.
+ */
+import type { AbstractNumbering, AppProperties, CoreProperties, CustomProperty, DocDefaults, DocumentSettings, DocumentTheme, EndnoteDef, FontDef, FootnoteDef, NumPicBullet, NumberingInstance, StyleDef } from "../types.js";
+import type { RenderHelpers } from "./render-context.js";
+/** Input options for building common auxiliary parts. */
+export interface AuxiliaryPartsInput {
+    readonly docDefaults?: DocDefaults;
+    readonly styles?: readonly StyleDef[];
+    readonly settings?: DocumentSettings;
+    readonly fonts?: readonly FontDef[];
+    readonly theme?: DocumentTheme;
+    readonly abstractNumberings?: readonly AbstractNumbering[];
+    readonly numberingInstances?: readonly NumberingInstance[];
+    readonly numPicBullets?: readonly NumPicBullet[];
+    readonly coreProperties?: CoreProperties;
+    readonly appProperties?: AppProperties;
+    readonly customProperties?: readonly CustomProperty[];
+    readonly footnotes?: readonly FootnoteDef[];
+    readonly endnotes?: readonly EndnoteDef[];
+    /**
+     * Optional render helpers passed to footnote/endnote rendering so in-note
+     * hyperlinks/images resolve to the rIds the caller has registered against
+     * the per-part .rels. Defaults to `{}`, meaning no remap and no
+     * hyperlink rIds — sufficient for documents without notes that contain
+     * external links or remapped images.
+     */
+    readonly notesHelpers?: RenderHelpers;
+    /**
+     * Raw XML output policy. When `"strip"` or `"reject"`, opaque rawXml
+     * fields on settings/theme/numbering are skipped or cause an error
+     * respectively. Defaults to `"preserve"`.
+     */
+    readonly rawXmlPolicy?: "preserve" | "strip" | "reject";
+}
+/** A rendered XML part ready to be written to ZIP. */
+export interface RenderedPart {
+    readonly path: string;
+    readonly content: string;
+}
+/**
+ * Build all common auxiliary XML parts that are shared between
+ * the buffered packager and streaming writer.
+ *
+ * Returns an array of rendered parts (path + XML string).
+ * Does NOT include: document.xml, images, headers/footers, comments,
+ * charts, custom XML, embedded fonts, opaque parts, watermarks.
+ * Those are handled by the respective packager/streaming-writer because
+ * they require relationship ID coordination.
+ */
+export declare function buildCommonAuxiliaryParts(input: AuxiliaryPartsInput): RenderedPart[];

package/dist/{browser/modules/word → types/modules/word/writer}/content-types.d.ts

@@ -4,7 +4,7 @@
  * Generates [Content_Types].xml for the DOCX package.
  * Uses a plain data record + free functions for tree-shakeability.
  */
-import type { XmlSink } from "../xml/types.js";
+import type { XmlSink } from "../../xml/types.js";
 /** Content type override entry. */
 export interface ContentTypeOverride {
     readonly partName: string;
@@ -19,7 +19,7 @@ export interface ContentTypesState {
 export declare function createContentTypes(): ContentTypesState;
 /** Add a default content type for a file extension. */
 export declare function addContentTypeDefault(state: ContentTypesState, extension: string, contentType: string): void;
-/** Add an override content type for a specific part. */
+/** Add an override content type for a specific part. Deduplicates by partName. */
 export declare function addContentTypeOverride(state: ContentTypesState, partName: string, contentType: string): void;
 /** Add image extension defaults from a set of used extensions. */
 export declare function addImageContentTypeDefaults(state: ContentTypesState, extensions: Iterable<string>): void;

package/dist/types/modules/word/writer/document-writer.d.ts

@@ -0,0 +1,24 @@
+/**
+ * DOCX Writers - Document Body
+ *
+ * Renders the main word/document.xml part including all block-level
+ * content types: paragraphs, tables, floating images, TOC, math,
+ * text boxes, and structured document tags.
+ */
+import type { XmlSink } from "../../xml/types.js";
+import type { DocxDocument, BodyContent, StructuredDocumentTag } from "../types.js";
+import { type RenderHelpers, type WordRenderContext } from "./render-context.js";
+/**
+ * Render a structured document tag.
+ *
+ * `ctx` may be `undefined` when called from a sub-renderer that only knows
+ * about `RenderHelpers` (e.g. table cell, header/footer). In that case we
+ * still emit a syntactically valid `<w:sdt>`, but we cannot auto-assign an
+ * id from the document-wide id generator — callers that care about
+ * uniqueness should provide `properties.id` explicitly.
+ */
+export declare function renderSdt(xml: XmlSink, sdt: StructuredDocumentTag, ctx: WordRenderContext | undefined, helpers?: RenderHelpers): void;
+/** Render a single body content element (paragraph, table, image, etc.). */
+export declare function renderBodyContent(xml: XmlSink, content: BodyContent, ctx?: WordRenderContext): void;
+/** Render the complete word/document.xml. */
+export declare function renderDocument(xml: XmlSink, doc: DocxDocument, ctx?: WordRenderContext): void;

package/dist/types/modules/word/writer/docx-packager.d.ts

@@ -0,0 +1,35 @@
+/**
+ * DOCX Module - Packager
+ *
+ * Assembles a DocxDocument model into a DOCX ZIP package using the
+ * archive and XML modules. Supports all parts including comments,
+ * custom properties, document background, hyperlink relationships,
+ * and per-header/footer relationship files.
+ */
+import { type WordSecurityPolicy } from "../security/policy.js";
+import type { DocxDocument } from "../types.js";
+/**
+ * Options accepted by `packageDocx`.
+ *
+ * For backwards compatibility the second positional argument may also be a
+ * raw number, in which case it is interpreted as `compressionLevel` with the
+ * default security policy.
+ */
+export interface PackageDocxOptions {
+    /** ZIP compression level (0-9). Default: backend-specific (typically 6). */
+    readonly compressionLevel?: number;
+    /**
+     * Security policy controlling rawXmlPolicy, OLE/signature handling, etc.
+     * Defaults to {@link DEFAULT_SECURITY_POLICY}.
+     */
+    readonly securityPolicy?: WordSecurityPolicy;
+}
+/**
+ * Package a DocxDocument model into a DOCX ZIP file.
+ * Returns the ZIP bytes as Uint8Array.
+ *
+ * This function does NOT modify the input `doc` object. Internally it creates
+ * shallow copies of mutable structures (images, headers, footers, etc.) to
+ * assign relationship IDs without polluting the caller's model.
+ */
+export declare function packageDocx(doc: DocxDocument, optionsOrCompressionLevel?: PackageDocxOptions | number): Promise<Uint8Array>;

package/dist/{browser/modules/word/writers → types/modules/word/writer}/footnote-writer.d.ts

@@ -5,7 +5,8 @@
  */
 import type { XmlSink } from "../../xml/types.js";
 import type { FootnoteDef, EndnoteDef } from "../types.js";
+import type { RenderHelpers } from "./render-context.js";
 /** Render word/footnotes.xml. */
-export declare function renderFootnotes(xml: XmlSink, footnotes: readonly FootnoteDef[]): void;
+export declare function renderFootnotes(xml: XmlSink, footnotes: readonly FootnoteDef[], helpers?: RenderHelpers): void;
 /** Render word/endnotes.xml. */
-export declare function renderEndnotes(xml: XmlSink, endnotes: readonly EndnoteDef[]): void;
+export declare function renderEndnotes(xml: XmlSink, endnotes: readonly EndnoteDef[], helpers?: RenderHelpers): void;