docx 9.0.3 → 9.1.1

package/{build → dist}/index.d.ts

@@ -48,7 +48,7 @@ declare class AppProperties extends XmlComponent {
 
 export declare type AttributeData = Record<string, boolean | number | string>;
 
-declare type AttributeMap<T> = Record<keyof T, string>;
+export declare type AttributeMap<T> = Record<keyof T, string>;
 
 export declare type AttributePayload<T> = {
     readonly [P in keyof T]: {
@@ -388,48 +388,51 @@ declare class Document_2 extends XmlComponent {
     get Body(): Body_2;
 }
 
+export declare type DocumentAttributeNamespace = keyof typeof DocumentAttributeNamespaces;
+
+export declare const DocumentAttributeNamespaces: {
+    wpc: string;
+    mc: string;
+    o: string;
+    r: string;
+    m: string;
+    v: string;
+    wp14: string;
+    wp: string;
+    w10: string;
+    w: string;
+    w14: string;
+    w15: string;
+    wpg: string;
+    wpi: string;
+    wne: string;
+    wps: string;
+    cp: string;
+    dc: string;
+    dcterms: string;
+    dcmitype: string;
+    xsi: string;
+    cx: string;
+    cx1: string;
+    cx2: string;
+    cx3: string;
+    cx4: string;
+    cx5: string;
+    cx6: string;
+    cx7: string;
+    cx8: string;
+    aink: string;
+    am3d: string;
+    w16cex: string;
+    w16cid: string;
+    w16: string;
+    w16sdtdh: string;
+    w16se: string;
+};
+
 export declare class DocumentAttributes extends XmlAttributeComponent<IDocumentAttributesProperties> {
-    protected readonly xmlKeys: {
-        wpc: string;
-        mc: string;
-        o: string;
-        r: string;
-        m: string;
-        v: string;
-        wp14: string;
-        wp: string;
-        w10: string;
-        w: string;
-        w14: string;
-        w15: string;
-        wpg: string;
-        wpi: string;
-        wne: string;
-        wps: string;
-        Ignorable: string;
-        cp: string;
-        dc: string;
-        dcterms: string;
-        dcmitype: string;
-        xsi: string;
-        type: string;
-        cx: string;
-        cx1: string;
-        cx2: string;
-        cx3: string;
-        cx4: string;
-        cx5: string;
-        cx6: string;
-        cx7: string;
-        cx8: string;
-        aink: string;
-        am3d: string;
-        w16cex: string;
-        w16cid: string;
-        w16: string;
-        w16sdtdh: string;
-        w16se: string;
-    };
+    protected readonly xmlKeys: AttributeMap<IDocumentAttributesProperties>;
+    constructor(ns: readonly DocumentAttributeNamespace[], Ignorable?: string);
 }
 
 export declare class DocumentBackground extends XmlComponent {
@@ -1005,46 +1008,8 @@ export declare type IDocGridAttributesProperties = {
     readonly charSpace?: number;
 };
 
-export declare type IDocumentAttributesProperties = {
-    readonly wpc?: string;
-    readonly mc?: string;
-    readonly o?: string;
-    readonly r?: string;
-    readonly m?: string;
-    readonly v?: string;
-    readonly wp14?: string;
-    readonly wp?: string;
-    readonly w10?: string;
-    readonly w?: string;
-    readonly w14?: string;
-    readonly w15?: string;
-    readonly wpg?: string;
-    readonly wpi?: string;
-    readonly wne?: string;
-    readonly wps?: string;
+export declare type IDocumentAttributesProperties = Partial<Record<DocumentAttributeNamespace, string>> & {
     readonly Ignorable?: string;
-    readonly cp?: string;
-    readonly dc?: string;
-    readonly dcterms?: string;
-    readonly dcmitype?: string;
-    readonly xsi?: string;
-    readonly type?: string;
-    readonly cx?: string;
-    readonly cx1?: string;
-    readonly cx2?: string;
-    readonly cx3?: string;
-    readonly cx4?: string;
-    readonly cx5?: string;
-    readonly cx6?: string;
-    readonly cx7?: string;
-    readonly cx8?: string;
-    readonly aink?: string;
-    readonly am3d?: string;
-    readonly w16cex?: string;
-    readonly w16cid?: string;
-    readonly w16?: string;
-    readonly w16sdtdh?: string;
-    readonly w16se?: string;
 };
 
 export declare type IDocumentBackgroundOptions = {
@@ -1131,6 +1096,13 @@ export declare type IHorizontalPositionOptions = {
     readonly offset?: number;
 };
 
+declare type IHyphenationOptions = {
+    readonly autoHyphenation?: boolean;
+    readonly hyphenationZone?: number;
+    readonly consecutiveHyphenLimit?: number;
+    readonly doNotHyphenateCaps?: boolean;
+};
+
 export declare type IImageOptions = (RegularImageOptions | SvgMediaOptions) & CoreImageOptions;
 
 export declare type IIndentAttributesProperties = {
@@ -1442,6 +1414,7 @@ declare type IPropertiesOptions = {
     readonly evenAndOddHeaderAndFooters?: boolean;
     readonly defaultTabStop?: number;
     readonly fonts?: readonly FontOptions[];
+    readonly hyphenation?: IHyphenationOptions;
 };
 
 export declare type IRunOptions = {
@@ -1539,6 +1512,7 @@ declare type ISettingsOptions = {
     readonly updateFields?: boolean;
     readonly compatibility?: ICompatibilityOptions;
     readonly defaultTabStop?: number;
+    readonly hyphenation?: IHyphenationOptions;
 };
 
 export declare type IShadingAttributesProperties = {
@@ -1707,6 +1681,10 @@ export declare type ITableWidthProperties = {
     readonly type?: (typeof WidthType)[keyof typeof WidthType];
 };
 
+declare type ITextboxOptions = Omit<IParagraphOptions, "style"> & {
+    readonly style?: VmlShapeStyle;
+};
+
 export declare type ITextWrapping = {
     readonly type: (typeof TextWrappingType)[keyof typeof TextWrappingType];
     readonly side?: (typeof TextWrappingSide)[keyof typeof TextWrappingSide];
@@ -1750,6 +1728,8 @@ export declare const LeaderType: {
     readonly UNDERSCORE: "underscore";
 };
 
+declare type LengthUnit = "auto" | number | Percentage | UniversalMeasure | RelativeMeasure;
+
 export declare class Level extends LevelBase {
 }
 
@@ -2355,6 +2335,8 @@ export declare const PositionalTabRelativeTo: {
     readonly INDENT: "indent";
 };
 
+export declare type PositivePercentage = `${number}%`;
+
 export declare type PositiveUniversalMeasure = `${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`;
 
 export declare const positiveUniversalMeasureValue: (val: PositiveUniversalMeasure) => PositiveUniversalMeasure;
@@ -2395,6 +2377,8 @@ export declare const RelativeHorizontalPosition: {
     readonly RIGHT: "right";
 };
 
+export declare type RelativeMeasure = `${"-" | ""}${number}${"em" | "ex"}`;
+
 export declare const RelativeVerticalPosition: {
     readonly CENTER: "center";
     readonly INSIDE: "inside";
@@ -2795,6 +2779,10 @@ export declare class TDirection extends XmlComponent {
     constructor(value: (typeof TextDirection)[keyof typeof TextDirection]);
 }
 
+export declare class Textbox extends FileChild {
+    constructor({ style, children, ...rest }: ITextboxOptions);
+}
+
 export declare const TextDirection: {
     readonly BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
     readonly LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
@@ -2930,6 +2918,32 @@ export declare const VerticalPositionRelativeFrom: {
     readonly TOP_MARGIN: "topMargin";
 };
 
+declare type VmlShapeStyle = {
+    readonly flip?: "x" | "y" | "xy" | "yx";
+    readonly height?: LengthUnit;
+    readonly left?: LengthUnit;
+    readonly marginBottom?: LengthUnit;
+    readonly marginLeft?: LengthUnit;
+    readonly marginRight?: LengthUnit;
+    readonly marginTop?: LengthUnit;
+    readonly positionHorizontal?: "absolute" | "left" | "center" | "right" | "inside" | "outside";
+    readonly positionHorizontalRelative?: "margin" | "page" | "text" | "char";
+    readonly positionVertical?: "absolute" | "left" | "center" | "right" | "inside" | "outside";
+    readonly positionVerticalRelative?: "margin" | "page" | "text" | "char";
+    readonly wrapDistanceBottom?: number;
+    readonly wrapDistanceLeft?: number;
+    readonly wrapDistanceRight?: number;
+    readonly wrapDistanceTop?: number;
+    readonly wrapEdited?: boolean;
+    readonly wrapStyle?: "square" | "none";
+    readonly position?: "static" | "absolute" | "relative";
+    readonly rotation?: number;
+    readonly top?: LengthUnit;
+    readonly visibility?: "hidden" | "inherit";
+    readonly width: LengthUnit;
+    readonly zIndex?: "auto" | number;
+};
+
 export declare const WidthType: {
     readonly AUTO: "auto";
     readonly DXA: "dxa";