docx 7.8.2 → 8.0.1

package/build/file/document/body/section-properties/properties/doc-grid.d.ts

@@ -1,22 +1,22 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export declare enum DocumentGridType {
-    DEFAULT = "default",
-    LINES = "lines",
-    LINES_AND_CHARS = "linesAndChars",
-    SNAP_TO_CHARS = "snapToChars"
-}
-export interface IDocGridAttributesProperties {
-    readonly type?: DocumentGridType;
-    readonly linePitch?: number;
-    readonly charSpace?: number;
-}
-export declare class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
-    protected readonly xmlKeys: {
-        type: string;
-        linePitch: string;
-        charSpace: string;
-    };
-}
-export declare class DocumentGrid extends XmlComponent {
-    constructor(linePitch: number, charSpace?: number, type?: DocumentGridType);
-}
+import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
+export declare enum DocumentGridType {
+    DEFAULT = "default",
+    LINES = "lines",
+    LINES_AND_CHARS = "linesAndChars",
+    SNAP_TO_CHARS = "snapToChars"
+}
+export interface IDocGridAttributesProperties {
+    readonly type?: DocumentGridType;
+    readonly linePitch?: number;
+    readonly charSpace?: number;
+}
+export declare class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
+    protected readonly xmlKeys: {
+        type: string;
+        linePitch: string;
+        charSpace: string;
+    };
+}
+export declare class DocumentGrid extends XmlComponent {
+    constructor(linePitch: number, charSpace?: number, type?: DocumentGridType);
+}

package/build/file/document/body/section-properties/properties/header-footer-reference.d.ts

@@ -1,17 +1,17 @@
-import { XmlComponent } from "../../../../../file/xml-components";
-export declare enum HeaderFooterReferenceType {
-    DEFAULT = "default",
-    FIRST = "first",
-    EVEN = "even"
-}
-export interface IHeaderFooterOptions {
-    readonly type?: HeaderFooterReferenceType;
-    readonly id?: number;
-}
-export declare enum HeaderFooterType {
-    HEADER = "w:headerReference",
-    FOOTER = "w:footerReference"
-}
-export declare class HeaderFooterReference extends XmlComponent {
-    constructor(type: HeaderFooterType, options: IHeaderFooterOptions);
-}
+import { XmlComponent } from "../../../../../file/xml-components";
+export declare enum HeaderFooterReferenceType {
+    DEFAULT = "default",
+    FIRST = "first",
+    EVEN = "even"
+}
+export interface IHeaderFooterOptions {
+    readonly type?: HeaderFooterReferenceType;
+    readonly id?: number;
+}
+export declare enum HeaderFooterType {
+    HEADER = "w:headerReference",
+    FOOTER = "w:footerReference"
+}
+export declare class HeaderFooterReference extends XmlComponent {
+    constructor(type: HeaderFooterType, options: IHeaderFooterOptions);
+}

package/build/file/document/body/section-properties/properties/index.d.ts

@@ -1,12 +1,12 @@
-export * from "./column";
-export * from "./columns";
-export * from "./doc-grid";
-export * from "./page-size";
-export * from "./page-number";
-export * from "./page-borders";
-export * from "./page-margin";
-export * from "./page-borders";
-export * from "./page-text-direction";
-export * from "./line-number";
-export * from "./section-type";
-export * from "./header-footer-reference";
+export * from "./column";
+export * from "./columns";
+export * from "./doc-grid";
+export * from "./page-size";
+export * from "./page-number";
+export * from "./page-borders";
+export * from "./page-margin";
+export * from "./page-borders";
+export * from "./page-text-direction";
+export * from "./line-number";
+export * from "./section-type";
+export * from "./header-footer-reference";

package/build/file/document/body/section-properties/properties/line-number.d.ts

@@ -1,23 +1,16 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export declare enum LineNumberRestartFormat {
-    NEW_PAGE = "newPage",
-    NEW_SECTION = "newSection",
-    CONTINUOUS = "continuous"
-}
-export interface ILineNumberAttributes {
-    readonly countBy?: number;
-    readonly start?: number;
-    readonly restart?: LineNumberRestartFormat;
-    readonly distance?: number | string;
-}
-export declare class LineNumberAttributes extends XmlAttributeComponent<ILineNumberAttributes> {
-    protected readonly xmlKeys: {
-        countBy: string;
-        start: string;
-        restart: string;
-        distance: string;
-    };
-}
-export declare class LineNumberType extends XmlComponent {
-    constructor({ countBy, start, restart, distance }: ILineNumberAttributes);
-}
+import { XmlComponent } from "../../../../../file/xml-components";
+import { PositiveUniversalMeasure } from "../../../../../util/values";
+export declare enum LineNumberRestartFormat {
+    NEW_PAGE = "newPage",
+    NEW_SECTION = "newSection",
+    CONTINUOUS = "continuous"
+}
+export interface ILineNumberAttributes {
+    readonly countBy?: number;
+    readonly start?: number;
+    readonly restart?: LineNumberRestartFormat;
+    readonly distance?: number | PositiveUniversalMeasure;
+}
+export declare class LineNumberType extends XmlComponent {
+    constructor({ countBy, start, restart, distance }: ILineNumberAttributes);
+}

package/build/file/document/body/section-properties/properties/page-borders.d.ts

@@ -1,30 +1,30 @@
-import { IBorderOptions } from "../../../../../file/border";
-import { IgnoreIfEmptyXmlComponent } from "../../../../../file/xml-components";
-export declare enum PageBorderDisplay {
-    ALL_PAGES = "allPages",
-    FIRST_PAGE = "firstPage",
-    NOT_FIRST_PAGE = "notFirstPage"
-}
-export declare enum PageBorderOffsetFrom {
-    PAGE = "page",
-    TEXT = "text"
-}
-export declare enum PageBorderZOrder {
-    BACK = "back",
-    FRONT = "front"
-}
-export interface IPageBorderAttributes {
-    readonly display?: PageBorderDisplay;
-    readonly offsetFrom?: PageBorderOffsetFrom;
-    readonly zOrder?: PageBorderZOrder;
-}
-export interface IPageBordersOptions {
-    readonly pageBorders?: IPageBorderAttributes;
-    readonly pageBorderTop?: IBorderOptions;
-    readonly pageBorderRight?: IBorderOptions;
-    readonly pageBorderBottom?: IBorderOptions;
-    readonly pageBorderLeft?: IBorderOptions;
-}
-export declare class PageBorders extends IgnoreIfEmptyXmlComponent {
-    constructor(options?: IPageBordersOptions);
-}
+import { IBorderOptions } from "../../../../../file/border";
+import { IgnoreIfEmptyXmlComponent } from "../../../../../file/xml-components";
+export declare enum PageBorderDisplay {
+    ALL_PAGES = "allPages",
+    FIRST_PAGE = "firstPage",
+    NOT_FIRST_PAGE = "notFirstPage"
+}
+export declare enum PageBorderOffsetFrom {
+    PAGE = "page",
+    TEXT = "text"
+}
+export declare enum PageBorderZOrder {
+    BACK = "back",
+    FRONT = "front"
+}
+export interface IPageBorderAttributes {
+    readonly display?: PageBorderDisplay;
+    readonly offsetFrom?: PageBorderOffsetFrom;
+    readonly zOrder?: PageBorderZOrder;
+}
+export interface IPageBordersOptions {
+    readonly pageBorders?: IPageBorderAttributes;
+    readonly pageBorderTop?: IBorderOptions;
+    readonly pageBorderRight?: IBorderOptions;
+    readonly pageBorderBottom?: IBorderOptions;
+    readonly pageBorderLeft?: IBorderOptions;
+}
+export declare class PageBorders extends IgnoreIfEmptyXmlComponent {
+    constructor(options?: IPageBordersOptions);
+}

package/build/file/document/body/section-properties/properties/page-margin.d.ts

@@ -1,24 +1,14 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export interface IPageMarginAttributes {
-    readonly top?: number | string;
-    readonly right?: number | string;
-    readonly bottom?: number | string;
-    readonly left?: number | string;
-    readonly header?: number | string;
-    readonly footer?: number | string;
-    readonly gutter?: number | string;
-}
-export declare class PageMarginAttributes extends XmlAttributeComponent<IPageMarginAttributes> {
-    protected readonly xmlKeys: {
-        top: string;
-        right: string;
-        bottom: string;
-        left: string;
-        header: string;
-        footer: string;
-        gutter: string;
-    };
-}
-export declare class PageMargin extends XmlComponent {
-    constructor(top: number | string, right: number | string, bottom: number | string, left: number | string, header: number | string, footer: number | string, gutter: number | string);
-}
+import { XmlComponent } from "../../../../../file/xml-components";
+import { PositiveUniversalMeasure, UniversalMeasure } from "../../../../../util/values";
+export type IPageMarginAttributes = {
+    readonly top?: number | UniversalMeasure;
+    readonly right?: number | PositiveUniversalMeasure;
+    readonly bottom?: number | UniversalMeasure;
+    readonly left?: number | PositiveUniversalMeasure;
+    readonly header?: number | PositiveUniversalMeasure;
+    readonly footer?: number | PositiveUniversalMeasure;
+    readonly gutter?: number | PositiveUniversalMeasure;
+};
+export declare class PageMargin extends XmlComponent {
+    constructor(top: number | UniversalMeasure, right: number | PositiveUniversalMeasure, bottom: number | UniversalMeasure, left: number | PositiveUniversalMeasure, header: number | PositiveUniversalMeasure, footer: number | PositiveUniversalMeasure, gutter: number | PositiveUniversalMeasure);
+}

package/build/file/document/body/section-properties/properties/page-number.d.ts

@@ -1,24 +1,24 @@
-import { NumberFormat } from "../../../../../file/shared/number-format";
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export declare enum PageNumberSeparator {
-    HYPHEN = "hyphen",
-    PERIOD = "period",
-    COLON = "colon",
-    EM_DASH = "emDash",
-    EN_DASH = "endash"
-}
-export interface IPageNumberTypeAttributes {
-    readonly start?: number;
-    readonly formatType?: NumberFormat;
-    readonly separator?: PageNumberSeparator;
-}
-export declare class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
-    protected readonly xmlKeys: {
-        start: string;
-        formatType: string;
-        separator: string;
-    };
-}
-export declare class PageNumberType extends XmlComponent {
-    constructor({ start, formatType, separator }: IPageNumberTypeAttributes);
-}
+import { NumberFormat } from "../../../../../file/shared/number-format";
+import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
+export declare enum PageNumberSeparator {
+    HYPHEN = "hyphen",
+    PERIOD = "period",
+    COLON = "colon",
+    EM_DASH = "emDash",
+    EN_DASH = "endash"
+}
+export interface IPageNumberTypeAttributes {
+    readonly start?: number;
+    readonly formatType?: NumberFormat;
+    readonly separator?: PageNumberSeparator;
+}
+export declare class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
+    protected readonly xmlKeys: {
+        start: string;
+        formatType: string;
+        separator: string;
+    };
+}
+export declare class PageNumberType extends XmlComponent {
+    constructor({ start, formatType, separator }: IPageNumberTypeAttributes);
+}

package/build/file/document/body/section-properties/properties/page-size.d.ts

@@ -1,20 +1,14 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export declare enum PageOrientation {
-    PORTRAIT = "portrait",
-    LANDSCAPE = "landscape"
-}
-export interface IPageSizeAttributes {
-    readonly width?: number | string;
-    readonly height?: number | string;
-    readonly orientation?: PageOrientation;
-}
-export declare class PageSizeAttributes extends XmlAttributeComponent<IPageSizeAttributes> {
-    protected readonly xmlKeys: {
-        width: string;
-        height: string;
-        orientation: string;
-    };
-}
-export declare class PageSize extends XmlComponent {
-    constructor(width: number | string, height: number | string, orientation: PageOrientation);
-}
+import { XmlComponent } from "../../../../../file/xml-components";
+import { PositiveUniversalMeasure } from "../../../../../util/values";
+export declare enum PageOrientation {
+    PORTRAIT = "portrait",
+    LANDSCAPE = "landscape"
+}
+export type IPageSizeAttributes = {
+    readonly width?: number | PositiveUniversalMeasure;
+    readonly height?: number | PositiveUniversalMeasure;
+    readonly orientation?: PageOrientation;
+};
+export declare class PageSize extends XmlComponent {
+    constructor(width: number | PositiveUniversalMeasure, height: number | PositiveUniversalMeasure, orientation: PageOrientation);
+}

package/build/file/document/body/section-properties/properties/page-text-direction.d.ts

@@ -1,8 +1,8 @@
-import { XmlComponent } from "../../../../../file/xml-components";
-export declare enum PageTextDirectionType {
-    LEFT_TO_RIGHT_TOP_TO_BOTTOM = "lrTb",
-    TOP_TO_BOTTOM_RIGHT_TO_LEFT = "tbRl"
-}
-export declare class PageTextDirection extends XmlComponent {
-    constructor(value: PageTextDirectionType);
-}
+import { XmlComponent } from "../../../../../file/xml-components";
+export declare enum PageTextDirectionType {
+    LEFT_TO_RIGHT_TOP_TO_BOTTOM = "lrTb",
+    TOP_TO_BOTTOM_RIGHT_TO_LEFT = "tbRl"
+}
+export declare class PageTextDirection extends XmlComponent {
+    constructor(value: PageTextDirectionType);
+}

package/build/file/document/body/section-properties/properties/section-type.d.ts

@@ -1,18 +1,18 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export declare enum SectionType {
-    NEXT_PAGE = "nextPage",
-    NEXT_COLUMN = "nextColumn",
-    CONTINUOUS = "continuous",
-    EVEN_PAGE = "evenPage",
-    ODD_PAGE = "oddPage"
-}
-export declare class SectionTypeAttributes extends XmlAttributeComponent<{
-    readonly val: SectionType;
-}> {
-    protected readonly xmlKeys: {
-        val: string;
-    };
-}
-export declare class Type extends XmlComponent {
-    constructor(value: SectionType);
-}
+import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
+export declare enum SectionType {
+    NEXT_PAGE = "nextPage",
+    NEXT_COLUMN = "nextColumn",
+    CONTINUOUS = "continuous",
+    EVEN_PAGE = "evenPage",
+    ODD_PAGE = "oddPage"
+}
+export declare class SectionTypeAttributes extends XmlAttributeComponent<{
+    readonly val: SectionType;
+}> {
+    protected readonly xmlKeys: {
+        val: string;
+    };
+}
+export declare class Type extends XmlComponent {
+    constructor(value: SectionType);
+}

package/build/file/document/body/section-properties/section-properties.d.ts

@@ -1,53 +1,53 @@
-import { FooterWrapper } from "../../../../file/footer-wrapper";
-import { HeaderWrapper } from "../../../../file/header-wrapper";
-import { VerticalAlign } from "../../../../file/vertical-align";
-import { XmlComponent } from "../../../../file/xml-components";
-import { IColumnsAttributes } from "./properties/columns";
-import { IDocGridAttributesProperties } from "./properties/doc-grid";
-import { ILineNumberAttributes } from "./properties/line-number";
-import { IPageBordersOptions } from "./properties/page-borders";
-import { IPageMarginAttributes } from "./properties/page-margin";
-import { IPageNumberTypeAttributes } from "./properties/page-number";
-import { IPageSizeAttributes, PageOrientation } from "./properties/page-size";
-import { PageTextDirectionType } from "./properties/page-text-direction";
-import { SectionType } from "./properties/section-type";
-export interface IHeaderFooterGroup<T> {
-    readonly default?: T;
-    readonly first?: T;
-    readonly even?: T;
-}
-export interface ISectionPropertiesOptions {
-    readonly page?: {
-        readonly size?: IPageSizeAttributes;
-        readonly margin?: IPageMarginAttributes;
-        readonly pageNumbers?: IPageNumberTypeAttributes;
-        readonly borders?: IPageBordersOptions;
-        readonly textDirection?: PageTextDirectionType;
-    };
-    readonly grid?: IDocGridAttributesProperties;
-    readonly headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
-    readonly footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
-    readonly lineNumbers?: ILineNumberAttributes;
-    readonly titlePage?: boolean;
-    readonly verticalAlign?: VerticalAlign;
-    readonly column?: IColumnsAttributes;
-    readonly type?: SectionType;
-}
-export declare const sectionMarginDefaults: {
-    TOP: string;
-    RIGHT: string;
-    BOTTOM: string;
-    LEFT: string;
-    HEADER: number;
-    FOOTER: number;
-    GUTTER: number;
-};
-export declare const sectionPageSizeDefaults: {
-    WIDTH: number;
-    HEIGHT: number;
-    ORIENTATION: PageOrientation;
-};
-export declare class SectionProperties extends XmlComponent {
-    constructor({ page: { size: { width, height, orientation, }, margin: { top, right, bottom, left, header, footer, gutter, }, pageNumbers, borders, textDirection, }, grid: { linePitch, charSpace, type: gridType }, headerWrapperGroup, footerWrapperGroup, lineNumbers, titlePage, verticalAlign, column, type, }?: ISectionPropertiesOptions);
-    private addHeaderFooterGroup;
-}
+import { FooterWrapper } from "../../../../file/footer-wrapper";
+import { HeaderWrapper } from "../../../../file/header-wrapper";
+import { VerticalAlign } from "../../../../file/vertical-align";
+import { XmlComponent } from "../../../../file/xml-components";
+import { IColumnsAttributes } from "./properties/columns";
+import { IDocGridAttributesProperties } from "./properties/doc-grid";
+import { ILineNumberAttributes } from "./properties/line-number";
+import { IPageBordersOptions } from "./properties/page-borders";
+import { IPageMarginAttributes } from "./properties/page-margin";
+import { IPageNumberTypeAttributes } from "./properties/page-number";
+import { IPageSizeAttributes, PageOrientation } from "./properties/page-size";
+import { PageTextDirectionType } from "./properties/page-text-direction";
+import { SectionType } from "./properties/section-type";
+export interface IHeaderFooterGroup<T> {
+    readonly default?: T;
+    readonly first?: T;
+    readonly even?: T;
+}
+export interface ISectionPropertiesOptions {
+    readonly page?: {
+        readonly size?: IPageSizeAttributes;
+        readonly margin?: IPageMarginAttributes;
+        readonly pageNumbers?: IPageNumberTypeAttributes;
+        readonly borders?: IPageBordersOptions;
+        readonly textDirection?: PageTextDirectionType;
+    };
+    readonly grid?: IDocGridAttributesProperties;
+    readonly headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
+    readonly footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
+    readonly lineNumbers?: ILineNumberAttributes;
+    readonly titlePage?: boolean;
+    readonly verticalAlign?: VerticalAlign;
+    readonly column?: IColumnsAttributes;
+    readonly type?: SectionType;
+}
+export declare const sectionMarginDefaults: {
+    TOP: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
+    RIGHT: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
+    BOTTOM: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
+    LEFT: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
+    HEADER: number;
+    FOOTER: number;
+    GUTTER: number;
+};
+export declare const sectionPageSizeDefaults: {
+    WIDTH: number;
+    HEIGHT: number;
+    ORIENTATION: PageOrientation;
+};
+export declare class SectionProperties extends XmlComponent {
+    constructor({ page: { size: { width, height, orientation, }, margin: { top, right, bottom, left, header, footer, gutter, }, pageNumbers, borders, textDirection, }, grid: { linePitch, charSpace, type: gridType }, headerWrapperGroup, footerWrapperGroup, lineNumbers, titlePage, verticalAlign, column, type, }?: ISectionPropertiesOptions);
+    private addHeaderFooterGroup;
+}