docx 9.3.0 → 9.4.0

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 
+import { default as default_2 } from 'jszip';
 import { Element as Element_2 } from 'xml-js';
 import { Stream } from 'stream';
 
@@ -190,7 +191,7 @@ declare class Break extends XmlComponent {
     constructor();
 }
 
-export declare class BuilderElement<T extends AttributeData> extends XmlComponent {
+export declare class BuilderElement<T extends AttributeData = {}> extends XmlComponent {
     constructor({ name, attributes, children, }: {
         readonly name: string;
         readonly attributes?: AttributePayload<T>;
@@ -202,6 +203,11 @@ export declare class CarriageReturn extends EmptyElement {
     constructor();
 }
 
+declare const CellSpacingType: {
+    readonly DXA: "dxa";
+    readonly NIL: "nil";
+};
+
 export declare const CharacterSet: {
     readonly ANSI: "00";
     readonly DEFAULT: "01";
@@ -272,7 +278,9 @@ export declare class CommentReference extends XmlComponent {
 }
 
 export declare class Comments extends XmlComponent {
+    private readonly relationships;
     constructor({ children }: ICommentsOptions);
+    get Relationships(): Relationships;
 }
 
 declare const CompoundLine: {
@@ -330,12 +338,42 @@ declare class CoreProperties extends XmlComponent {
     constructor(options: Omit<IPropertiesOptions, "sections">);
 }
 
+export declare const createDocumentGrid: ({ type, linePitch, charSpace }: IDocGridAttributesProperties) => XmlComponent;
+
 export declare const createFrameProperties: (options: IFrameOptions) => XmlComponent;
 
+export declare const createHorizontalPosition: ({ relative, align, offset }: IHorizontalPositionOptions) => XmlComponent;
+
 export declare const createLineNumberType: ({ countBy, start, restart, distance }: ILineNumberAttributes) => XmlComponent;
 
+export declare const createMathAccentCharacter: ({ accent }: MathAccentCharacterOptions) => XmlComponent;
+
+export declare const createMathBase: ({ children }: MathBaseOptions) => XmlComponent;
+
+export declare const createMathLimitLocation: ({ value }: MathLimitLocationOptions) => XmlComponent;
+
+export declare const createMathNAryProperties: ({ accent, hasSuperScript, hasSubScript, limitLocationVal, }: MathNAryPropertiesOptions) => XmlComponent;
+
+export declare const createMathPreSubSuperScriptProperties: () => XmlComponent;
+
+export declare const createMathSubScriptElement: ({ children }: MathSubScriptElementOptions) => XmlComponent;
+
+export declare const createMathSubScriptProperties: () => XmlComponent;
+
+export declare const createMathSubSuperScriptProperties: () => XmlComponent;
+
+export declare const createMathSuperScriptElement: ({ children }: MathSuperScriptElementOptions) => XmlComponent;
+
+export declare const createMathSuperScriptProperties: () => XmlComponent;
+
+export declare const createPageSize: ({ width, height, orientation, code }: IPageSizeAttributes) => XmlComponent;
+
+export declare const createSimplePos: () => XmlComponent;
+
 export declare const createStringElement: (name: string, value: string) => XmlComponent;
 
+export declare const createVerticalPosition: ({ relative, align, offset }: IVerticalPositionOptions) => XmlComponent;
+
 declare class CustomProperties extends XmlComponent {
     private nextId;
     private readonly properties;
@@ -365,14 +403,6 @@ declare class DeletedTextRunWrapper extends XmlComponent {
     constructor(options: IRunOptions);
 }
 
-export declare class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
-    protected readonly xmlKeys: {
-        type: string;
-        linePitch: string;
-        charSpace: string;
-    };
-}
-
 declare type DocPropertiesOptions = {
     readonly name: string;
     readonly description: string;
@@ -459,10 +489,6 @@ export declare class DocumentDefaults extends XmlComponent {
     constructor(options: IDocumentDefaultsOptions);
 }
 
-export declare class DocumentGrid extends XmlComponent {
-    constructor(linePitch: number, charSpace?: number, type?: (typeof DocumentGridType)[keyof typeof DocumentGridType]);
-}
-
 export declare const DocumentGridType: {
     readonly DEFAULT: "default";
     readonly LINES: "lines";
@@ -758,10 +784,6 @@ export declare const HighlightColor: {
     readonly YELLOW: "yellow";
 };
 
-export declare class HorizontalPosition extends XmlComponent {
-    constructor(horizontalPosition: IHorizontalPositionOptions);
-}
-
 export declare const HorizontalPositionAlign: {
     readonly CENTER: "center";
     readonly INSIDE: "inside";
@@ -1004,7 +1026,7 @@ export declare type IDistance = {
 
 export declare type IDocGridAttributesProperties = {
     readonly type?: (typeof DocumentGridType)[keyof typeof DocumentGridType];
-    readonly linePitch?: number;
+    readonly linePitch: number;
     readonly charSpace?: number;
 };
 
@@ -1280,7 +1302,7 @@ export declare abstract class InitializableXmlComponent extends XmlComponent {
     constructor(rootKey: string, initComponent?: InitializableXmlComponent);
 }
 
-export declare type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream;
+export declare type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream | default_2;
 
 export declare class InsertedTextRun extends XmlComponent {
     constructor(options: IInsertedRunOptions);
@@ -1341,9 +1363,10 @@ export declare type IPageReferenceOptions = {
 };
 
 export declare type IPageSizeAttributes = {
-    readonly width?: number | PositiveUniversalMeasure;
-    readonly height?: number | PositiveUniversalMeasure;
+    readonly width: number | PositiveUniversalMeasure;
+    readonly height: number | PositiveUniversalMeasure;
     readonly orientation?: (typeof PageOrientation)[keyof typeof PageOrientation];
+    readonly code?: number;
 };
 
 export declare type IParagraphOptions = {
@@ -1489,13 +1512,13 @@ export declare type ISectionOptions = {
 
 export declare type ISectionPropertiesOptions = {
     readonly page?: {
-        readonly size?: IPageSizeAttributes;
+        readonly size?: Partial<IPageSizeAttributes>;
         readonly margin?: IPageMarginAttributes;
         readonly pageNumbers?: IPageNumberTypeAttributes;
         readonly borders?: IPageBordersOptions;
         readonly textDirection?: (typeof PageTextDirectionType)[keyof typeof PageTextDirectionType];
     };
-    readonly grid?: IDocGridAttributesProperties;
+    readonly grid?: Partial<IDocGridAttributesProperties>;
     readonly headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
     readonly footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
     readonly lineNumbers?: ILineNumberAttributes;
@@ -1603,6 +1626,11 @@ declare type ITableCellPropertiesOptions = {
     readonly borders?: ITableCellBorders;
 };
 
+declare type ITableCellSpacingProperties = {
+    readonly value: number | Percentage | UniversalMeasure;
+    readonly type?: (typeof CellSpacingType)[keyof typeof CellSpacingType];
+};
+
 export declare type ITableFloatOptions = {
     readonly horizontalAnchor?: (typeof TableAnchorType)[keyof typeof TableAnchorType];
     readonly absoluteHorizontalPosition?: number | UniversalMeasure;
@@ -1648,6 +1676,7 @@ export declare type ITableOptions = {
     readonly borders?: ITableBordersOptions;
     readonly alignment?: (typeof AlignmentType)[keyof typeof AlignmentType];
     readonly visuallyRightToLeft?: boolean;
+    readonly cellSpacing?: ITableCellSpacingProperties;
 };
 
 export declare type ITablePropertiesOptions = {
@@ -1661,6 +1690,7 @@ export declare type ITablePropertiesOptions = {
     readonly alignment?: (typeof AlignmentType)[keyof typeof AlignmentType];
     readonly cellMargin?: ITableCellMarginOptions;
     readonly visuallyRightToLeft?: boolean;
+    readonly cellSpacing?: ITableCellSpacingProperties;
 };
 
 export declare type ITableRowOptions = {
@@ -1674,6 +1704,7 @@ export declare type ITableRowPropertiesOptions = {
         readonly value: number | PositiveUniversalMeasure;
         readonly rule: (typeof HeightRule)[keyof typeof HeightRule];
     };
+    readonly cellSpacing?: ITableCellSpacingProperties;
 };
 
 export declare type ITableWidthProperties = {
@@ -1849,19 +1880,21 @@ declare class Math_2 extends XmlComponent {
 }
 export { Math_2 as Math }
 
-export declare class MathAccentCharacter extends XmlComponent {
-    constructor(accent: string);
-}
+declare type MathAccentCharacterOptions = {
+    readonly accent: string;
+};
 
 export declare class MathAngledBrackets extends XmlComponent {
-    constructor(options: {
-        readonly children: readonly MathComponent[];
-    });
+    constructor(options: MathAngledBracketsOptions);
 }
 
-export declare class MathBase extends XmlComponent {
-    constructor(children: readonly MathComponent[]);
-}
+declare type MathAngledBracketsOptions = {
+    readonly children: readonly MathComponent[];
+};
+
+declare type MathBaseOptions = {
+    readonly children: readonly MathComponent[];
+};
 
 export declare type MathComponent = MathRun | MathFraction | MathSum | MathIntegral | MathSuperScript | MathSubScript | MathSubSuperScript | MathRadical | MathFunction | MathRoundBrackets | MathCurlyBrackets | MathAngledBrackets | MathSquareBrackets;
 
@@ -1903,9 +1936,9 @@ export declare class MathLimit extends XmlComponent {
     constructor(children: readonly MathComponent[]);
 }
 
-export declare class MathLimitLocation extends XmlComponent {
-    constructor(value?: string);
-}
+declare type MathLimitLocationOptions = {
+    readonly value?: string;
+};
 
 export declare class MathLimitLower extends XmlComponent {
     constructor(options: IMathLimitLowerOptions);
@@ -1915,20 +1948,19 @@ export declare class MathLimitUpper extends XmlComponent {
     constructor(options: IMathLimitUpperOptions);
 }
 
-export declare class MathNAryProperties extends XmlComponent {
-    constructor(accent: string, hasSuperScript: boolean, hasSubScript: boolean, limitLocationVal?: string);
-}
+declare type MathNAryPropertiesOptions = {
+    readonly accent: string;
+    readonly hasSuperScript: boolean;
+    readonly hasSubScript: boolean;
+    readonly limitLocationVal?: string;
+};
 
 export declare class MathNumerator extends XmlComponent {
     constructor(children: readonly MathComponent[]);
 }
 
-export declare class MathPreSubSuperScript extends XmlComponent {
-    constructor(options: IMathPreSubSuperScriptOptions);
-}
-
-export declare class MathPreSubSuperScriptProperties extends XmlComponent {
-    constructor();
+export declare class MathPreSubSuperScript extends BuilderElement {
+    constructor({ children, subScript, superScript }: IMathPreSubSuperScriptOptions);
 }
 
 export declare class MathRadical extends XmlComponent {
@@ -1959,22 +1991,14 @@ export declare class MathSubScript extends XmlComponent {
     constructor(options: IMathSubScriptOptions);
 }
 
-export declare class MathSubScriptElement extends XmlComponent {
-    constructor(children: readonly MathComponent[]);
-}
-
-export declare class MathSubScriptProperties extends XmlComponent {
-    constructor();
-}
+declare type MathSubScriptElementOptions = {
+    readonly children: readonly MathComponent[];
+};
 
 export declare class MathSubSuperScript extends XmlComponent {
     constructor(options: IMathSubSuperScriptOptions);
 }
 
-export declare class MathSubSuperScriptProperties extends XmlComponent {
-    constructor();
-}
-
 export declare class MathSum extends XmlComponent {
     constructor(options: IMathSumOptions);
 }
@@ -1983,13 +2007,9 @@ export declare class MathSuperScript extends XmlComponent {
     constructor(options: IMathSuperScriptOptions);
 }
 
-export declare class MathSuperScriptElement extends XmlComponent {
-    constructor(children: readonly MathComponent[]);
-}
-
-export declare class MathSuperScriptProperties extends XmlComponent {
-    constructor();
-}
+declare type MathSuperScriptElementOptions = {
+    readonly children: readonly MathComponent[];
+};
 
 export declare const measurementOrPercentValue: (val: number | Percentage | UniversalMeasure) => number | UniversalMeasure | Percentage;
 
@@ -2244,10 +2264,6 @@ export declare class PageReference extends Run {
     constructor(bookmarkId: string, options?: IPageReferenceOptions);
 }
 
-export declare class PageSize extends XmlComponent {
-    constructor(width: number | PositiveUniversalMeasure, height: number | PositiveUniversalMeasure, orientation: (typeof PageOrientation)[keyof typeof PageOrientation]);
-}
-
 export declare class PageTextDirection extends XmlComponent {
     constructor(value: (typeof PageTextDirectionType)[keyof typeof PageTextDirectionType]);
 }
@@ -2288,13 +2304,18 @@ declare type PatchDetectorOptions = {
     readonly data: InputDataType;
 };
 
-export declare const patchDocument: <T extends keyof OutputByType = keyof OutputByType>({ outputType, data, patches, keepOriginalStyles, }: PatchDocumentOptions<T>) => Promise<OutputByType[T]>;
+export declare const patchDocument: <T extends keyof OutputByType = keyof OutputByType>({ outputType, data, patches, keepOriginalStyles, placeholderDelimiters, recursive, }: PatchDocumentOptions<T>) => Promise<OutputByType[T]>;
 
 export declare type PatchDocumentOptions<T extends PatchDocumentOutputType = PatchDocumentOutputType> = {
     readonly outputType: T;
     readonly data: InputDataType;
     readonly patches: Readonly<Record<string, IPatch>>;
     readonly keepOriginalStyles?: boolean;
+    readonly placeholderDelimiters?: Readonly<{
+        readonly start: string;
+        readonly end: string;
+    }>;
+    readonly recursive?: boolean;
 };
 
 export declare type PatchDocumentOutputType = OutputType;
@@ -2551,10 +2572,6 @@ export declare class SimpleMailMergeField extends SimpleField {
     constructor(fieldName: string);
 }
 
-export declare class SimplePos extends XmlComponent {
-    constructor();
-}
-
 export declare class SoftHyphen extends EmptyElement {
     constructor();
 }
@@ -2641,7 +2658,7 @@ export declare class TabAttributes extends XmlAttributeComponent<{
 }
 
 export declare class Table extends FileChild {
-    constructor({ rows, width, columnWidths, margins, indent, float, layout, style, borders, alignment, visuallyRightToLeft, }: ITableOptions);
+    constructor({ rows, width, columnWidths, margins, indent, float, layout, style, borders, alignment, visuallyRightToLeft, cellSpacing, }: ITableOptions);
 }
 
 export declare const TableAnchorType: {
@@ -2904,10 +2921,6 @@ export declare const VerticalMergeType: {
     readonly RESTART: "restart";
 };
 
-export declare class VerticalPosition extends XmlComponent {
-    constructor(verticalPosition: IVerticalPositionOptions);
-}
-
 export declare const VerticalPositionAlign: {
     readonly BOTTOM: "bottom";
     readonly CENTER: "center";