docx 7.8.1 → 8.0.0

package/build/file/paragraph/run/positional-tab.d.ts

@@ -0,0 +1,25 @@
+import { XmlComponent } from "../../../file/xml-components";
+export declare enum PositionalTabAlignment {
+    LEFT = "left",
+    CENTER = "center",
+    RIGHT = "right"
+}
+export declare enum PositionalTabRelativeTo {
+    MARGIN = "margin",
+    INDENT = "indent"
+}
+export declare enum PositionalTabLeader {
+    NONE = "none",
+    DOT = "dot",
+    HYPHEN = "hyphen",
+    UNDERSCORE = "underscore",
+    MIDDLE_DOT = "middleDot"
+}
+export interface PositionalTabOptions {
+    readonly alignment: PositionalTabAlignment;
+    readonly relativeTo: PositionalTabRelativeTo;
+    readonly leader: PositionalTabLeader;
+}
+export declare class PositionalTab extends XmlComponent {
+    constructor(options: PositionalTabOptions);
+}

package/build/file/paragraph/run/properties.d.ts

@@ -1,59 +1,76 @@
-import { IBorderOptions } from "../../../file/border";
-import { IShadingAttributesProperties } from "../../../file/shading";
-import { IChangedAttributesProperties } from "../../../file/track-revision/track-revision";
-import { IgnoreIfEmptyXmlComponent, XmlComponent } from "../../../file/xml-components";
-import { EmphasisMarkType } from "./emphasis-mark";
-import { IFontAttributesProperties } from "./run-fonts";
-import { UnderlineType } from "./underline";
-interface IFontOptions {
-    readonly name: string;
-    readonly hint?: string;
-}
-export interface IRunStylePropertiesOptions {
-    readonly bold?: boolean;
-    readonly boldComplexScript?: boolean;
-    readonly italics?: boolean;
-    readonly italicsComplexScript?: boolean;
-    readonly underline?: {
-        readonly color?: string;
-        readonly type?: UnderlineType;
-    };
-    readonly emphasisMark?: {
-        readonly type?: EmphasisMarkType;
-    };
-    readonly color?: string;
-    readonly size?: number | string;
-    readonly sizeComplexScript?: boolean | number | string;
-    readonly rightToLeft?: boolean;
-    readonly smallCaps?: boolean;
-    readonly allCaps?: boolean;
-    readonly strike?: boolean;
-    readonly doubleStrike?: boolean;
-    readonly subScript?: boolean;
-    readonly superScript?: boolean;
-    readonly font?: string | IFontOptions | IFontAttributesProperties;
-    readonly highlight?: string;
-    readonly highlightComplexScript?: boolean | string;
-    readonly characterSpacing?: number;
-    readonly shading?: IShadingAttributesProperties;
-    readonly emboss?: boolean;
-    readonly imprint?: boolean;
-    readonly revision?: IRunPropertiesChangeOptions;
-    readonly border?: IBorderOptions;
-    readonly vanish?: boolean;
-    readonly specVanish?: boolean;
-    readonly scale?: number;
-}
-export interface IRunPropertiesOptions extends IRunStylePropertiesOptions {
-    readonly style?: string;
-}
-export interface IRunPropertiesChangeOptions extends IRunPropertiesOptions, IChangedAttributesProperties {
-}
-export declare class RunProperties extends IgnoreIfEmptyXmlComponent {
-    constructor(options?: IRunPropertiesOptions);
-    push(item: XmlComponent): void;
-}
-export declare class RunPropertiesChange extends XmlComponent {
-    constructor(options: IRunPropertiesChangeOptions);
-}
-export {};
+import { IBorderOptions } from "../../../file/border";
+import { IShadingAttributesProperties } from "../../../file/shading";
+import { IChangedAttributesProperties } from "../../../file/track-revision/track-revision";
+import { IgnoreIfEmptyXmlComponent, XmlComponent } from "../../../file/xml-components";
+import { PositiveUniversalMeasure, UniversalMeasure } from "../../../util/values";
+import { EmphasisMarkType } from "./emphasis-mark";
+import { ILanguageOptions } from "./language";
+import { IFontAttributesProperties } from "./run-fonts";
+import { UnderlineType } from "./underline";
+interface IFontOptions {
+    readonly name: string;
+    readonly hint?: string;
+}
+export declare enum TextEffect {
+    BLINK_BACKGROUND = "blinkBackground",
+    LIGHTS = "lights",
+    ANTS_BLACK = "antsBlack",
+    ANTS_RED = "antsRed",
+    SHIMMER = "shimmer",
+    SPARKLE = "sparkle",
+    NONE = "none"
+}
+export interface IRunStylePropertiesOptions {
+    readonly bold?: boolean;
+    readonly boldComplexScript?: boolean;
+    readonly italics?: boolean;
+    readonly italicsComplexScript?: boolean;
+    readonly underline?: {
+        readonly color?: string;
+        readonly type?: UnderlineType;
+    };
+    readonly effect?: TextEffect;
+    readonly emphasisMark?: {
+        readonly type?: EmphasisMarkType;
+    };
+    readonly color?: string;
+    readonly kern?: number | PositiveUniversalMeasure;
+    readonly position?: UniversalMeasure;
+    readonly size?: number | PositiveUniversalMeasure;
+    readonly sizeComplexScript?: boolean | number | PositiveUniversalMeasure;
+    readonly rightToLeft?: boolean;
+    readonly smallCaps?: boolean;
+    readonly allCaps?: boolean;
+    readonly strike?: boolean;
+    readonly doubleStrike?: boolean;
+    readonly subScript?: boolean;
+    readonly superScript?: boolean;
+    readonly font?: string | IFontOptions | IFontAttributesProperties;
+    readonly highlight?: string;
+    readonly highlightComplexScript?: boolean | string;
+    readonly characterSpacing?: number;
+    readonly shading?: IShadingAttributesProperties;
+    readonly emboss?: boolean;
+    readonly imprint?: boolean;
+    readonly revision?: IRunPropertiesChangeOptions;
+    readonly language?: ILanguageOptions;
+    readonly border?: IBorderOptions;
+    readonly snapToGrid?: boolean;
+    readonly vanish?: boolean;
+    readonly specVanish?: boolean;
+    readonly scale?: number;
+    readonly math?: boolean;
+}
+export interface IRunPropertiesOptions extends IRunStylePropertiesOptions {
+    readonly style?: string;
+}
+export interface IRunPropertiesChangeOptions extends IRunPropertiesOptions, IChangedAttributesProperties {
+}
+export declare class RunProperties extends IgnoreIfEmptyXmlComponent {
+    constructor(options?: IRunPropertiesOptions);
+    push(item: XmlComponent): void;
+}
+export declare class RunPropertiesChange extends XmlComponent {
+    constructor(options: IRunPropertiesChangeOptions);
+}
+export {};

package/build/file/paragraph/run/run-components/symbol.d.ts

@@ -1,4 +1,4 @@
-import { XmlComponent } from "../../../../file/xml-components";
-export declare class Symbol extends XmlComponent {
-    constructor(char?: string, symbolfont?: string);
-}
+import { XmlComponent } from "../../../../file/xml-components";
+export declare class Symbol extends XmlComponent {
+    constructor(char?: string, symbolfont?: string);
+}

package/build/file/paragraph/run/run-components/text.d.ts

@@ -1,10 +1,10 @@
-import { SpaceType } from "../../../../file/shared";
-import { XmlComponent } from "../../../../file/xml-components";
-interface ITextOptions {
-    readonly space?: SpaceType;
-    readonly text?: string;
-}
-export declare class Text extends XmlComponent {
-    constructor(options: string | ITextOptions);
-}
-export {};
+import { SpaceType } from "../../../../file/shared";
+import { XmlComponent } from "../../../../file/xml-components";
+interface ITextOptions {
+    readonly space?: SpaceType;
+    readonly text?: string;
+}
+export declare class Text extends XmlComponent {
+    constructor(options: string | ITextOptions);
+}
+export {};

package/build/file/paragraph/run/run-fonts.d.ts

@@ -1,12 +1,12 @@
-import { XmlComponent } from "../../../file/xml-components";
-export interface IFontAttributesProperties {
-    readonly ascii?: string;
-    readonly cs?: string;
-    readonly eastAsia?: string;
-    readonly hAnsi?: string;
-    readonly hint?: string;
-}
-export declare class RunFonts extends XmlComponent {
-    constructor(name: string, hint?: string);
-    constructor(attrs: string | IFontAttributesProperties);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export interface IFontAttributesProperties {
+    readonly ascii?: string;
+    readonly cs?: string;
+    readonly eastAsia?: string;
+    readonly hAnsi?: string;
+    readonly hint?: string;
+}
+export declare class RunFonts extends XmlComponent {
+    constructor(name: string, hint?: string);
+    constructor(attrs: string | IFontAttributesProperties);
+}

package/build/file/paragraph/run/run.d.ts

@@ -1,20 +1,22 @@
-import { XmlComponent } from "../../../file/xml-components";
-import { FootnoteReferenceRun } from "../../../file/footnotes/footnote/run/reference-run";
-import { FieldInstruction } from "../../../file/table-of-contents/field-instruction";
-import { Begin, End, Separate } from "./field";
-import { IRunPropertiesOptions, RunProperties } from "./properties";
-import { Tab } from "./tab";
-export interface IRunOptions extends IRunPropertiesOptions {
-    readonly children?: readonly (Begin | FieldInstruction | Separate | End | PageNumber | FootnoteReferenceRun | Tab | string)[];
-    readonly break?: number;
-    readonly text?: string;
-}
-export declare enum PageNumber {
-    CURRENT = "CURRENT",
-    TOTAL_PAGES = "TOTAL_PAGES",
-    TOTAL_PAGES_IN_SECTION = "TOTAL_PAGES_IN_SECTION"
-}
-export declare class Run extends XmlComponent {
-    protected readonly properties: RunProperties;
-    constructor(options: IRunOptions);
-}
+import { XmlComponent } from "../../../file/xml-components";
+import { FootnoteReferenceRun } from "../../../file/footnotes/footnote/run/reference-run";
+import { FieldInstruction } from "../../../file/table-of-contents/field-instruction";
+import { Break } from "./break";
+import { Begin, End, Separate } from "./field";
+import { IRunPropertiesOptions, RunProperties } from "./properties";
+import { AnnotationReference, CarriageReturn, ContinuationSeparator, DayLong, DayShort, EndnoteReference, FootnoteReferenceElement, LastRenderedPageBreak, MonthLong, MonthShort, NoBreakHyphen, PageNumberElement, Separator, SoftHyphen, Tab, YearLong, YearShort } from "./empty-children";
+import { PositionalTab } from "./positional-tab";
+export interface IRunOptions extends IRunPropertiesOptions {
+    readonly children?: readonly (Begin | FieldInstruction | Separate | End | PageNumber | FootnoteReferenceRun | Break | AnnotationReference | CarriageReturn | ContinuationSeparator | DayLong | DayShort | EndnoteReference | FootnoteReferenceElement | LastRenderedPageBreak | MonthLong | MonthShort | NoBreakHyphen | PageNumberElement | Separator | SoftHyphen | Tab | YearLong | YearShort | PositionalTab | string)[];
+    readonly break?: number;
+    readonly text?: string;
+}
+export declare enum PageNumber {
+    CURRENT = "CURRENT",
+    TOTAL_PAGES = "TOTAL_PAGES",
+    TOTAL_PAGES_IN_SECTION = "TOTAL_PAGES_IN_SECTION"
+}
+export declare class Run extends XmlComponent {
+    protected readonly properties: RunProperties;
+    constructor(options: IRunOptions);
+}

package/build/file/paragraph/run/script.d.ts

@@ -1,10 +1,10 @@
-import { XmlComponent } from "../../../file/xml-components";
-export declare abstract class VerticalAlign extends XmlComponent {
-    constructor(type: string);
-}
-export declare class SuperScript extends VerticalAlign {
-    constructor();
-}
-export declare class SubScript extends VerticalAlign {
-    constructor();
-}
+import { XmlComponent } from "../../../file/xml-components";
+export declare abstract class VerticalAlign extends XmlComponent {
+    constructor(type: string);
+}
+export declare class SuperScript extends VerticalAlign {
+    constructor();
+}
+export declare class SubScript extends VerticalAlign {
+    constructor();
+}

package/build/file/paragraph/run/sequential-identifier-instruction.d.ts

@@ -1,4 +1,4 @@
-import { XmlComponent } from "../../../file/xml-components";
-export declare class SequentialIdentifierInstruction extends XmlComponent {
-    constructor(identifier: string);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export declare class SequentialIdentifierInstruction extends XmlComponent {
+    constructor(identifier: string);
+}

package/build/file/paragraph/run/sequential-identifier.d.ts

@@ -1,4 +1,4 @@
-import { Run } from "../../../file/paragraph/run";
-export declare class SequentialIdentifier extends Run {
-    constructor(identifier: string);
-}
+import { Run } from "../../../file/paragraph/run";
+export declare class SequentialIdentifier extends Run {
+    constructor(identifier: string);
+}

package/build/file/paragraph/run/simple-field.d.ts

@@ -1,7 +1,7 @@
-import { XmlComponent } from "../../../file/xml-components";
-export declare class SimpleField extends XmlComponent {
-    constructor(instruction: string, cachedValue?: string);
-}
-export declare class SimpleMailMergeField extends SimpleField {
-    constructor(fieldName: string);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export declare class SimpleField extends XmlComponent {
+    constructor(instruction: string, cachedValue?: string);
+}
+export declare class SimpleMailMergeField extends SimpleField {
+    constructor(fieldName: string);
+}

package/build/file/paragraph/run/symbol-run.d.ts

@@ -1,8 +1,8 @@
-import { IRunOptions, Run } from "./run";
-export interface ISymbolRunOptions extends IRunOptions {
-    readonly char: string;
-    readonly symbolfont?: string;
-}
-export declare class SymbolRun extends Run {
-    constructor(options: ISymbolRunOptions | string);
-}
+import { IRunOptions, Run } from "./run";
+export interface ISymbolRunOptions extends IRunOptions {
+    readonly char: string;
+    readonly symbolfont?: string;
+}
+export declare class SymbolRun extends Run {
+    constructor(options: ISymbolRunOptions | string);
+}

package/build/file/paragraph/run/text-attributes.d.ts

@@ -1,9 +1,9 @@
-import { SpaceType } from "../../../file/shared";
-import { XmlAttributeComponent } from "../../../file/xml-components";
-export declare class TextAttributes extends XmlAttributeComponent<{
-    readonly space: SpaceType;
-}> {
-    protected readonly xmlKeys: {
-        space: string;
-    };
-}
+import { SpaceType } from "../../../file/shared";
+import { XmlAttributeComponent } from "../../../file/xml-components";
+export declare class TextAttributes extends XmlAttributeComponent<{
+    readonly space: SpaceType;
+}> {
+    protected readonly xmlKeys: {
+        space: string;
+    };
+}

package/build/file/paragraph/run/text-run.d.ts

@@ -1,4 +1,4 @@
-import { IRunOptions, Run } from "./run";
-export declare class TextRun extends Run {
-    constructor(options: IRunOptions | string);
-}
+import { IRunOptions, Run } from "./run";
+export declare class TextRun extends Run {
+    constructor(options: IRunOptions | string);
+}

package/build/file/paragraph/run/underline.d.ts

@@ -1,24 +1,24 @@
-import { XmlComponent } from "../../../file/xml-components";
-export declare enum UnderlineType {
-    SINGLE = "single",
-    WORDS = "words",
-    DOUBLE = "double",
-    THICK = "thick",
-    DOTTED = "dotted",
-    DOTTEDHEAVY = "dottedHeavy",
-    DASH = "dash",
-    DASHEDHEAVY = "dashedHeavy",
-    DASHLONG = "dashLong",
-    DASHLONGHEAVY = "dashLongHeavy",
-    DOTDASH = "dotDash",
-    DASHDOTHEAVY = "dashDotHeavy",
-    DOTDOTDASH = "dotDotDash",
-    DASHDOTDOTHEAVY = "dashDotDotHeavy",
-    WAVE = "wave",
-    WAVYHEAVY = "wavyHeavy",
-    WAVYDOUBLE = "wavyDouble",
-    NONE = "none"
-}
-export declare class Underline extends XmlComponent {
-    constructor(underlineType?: UnderlineType, color?: string);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export declare enum UnderlineType {
+    SINGLE = "single",
+    WORDS = "words",
+    DOUBLE = "double",
+    THICK = "thick",
+    DOTTED = "dotted",
+    DOTTEDHEAVY = "dottedHeavy",
+    DASH = "dash",
+    DASHEDHEAVY = "dashedHeavy",
+    DASHLONG = "dashLong",
+    DASHLONGHEAVY = "dashLongHeavy",
+    DOTDASH = "dotDash",
+    DASHDOTHEAVY = "dashDotHeavy",
+    DOTDOTDASH = "dotDotDash",
+    DASHDOTDOTHEAVY = "dashDotDotHeavy",
+    WAVE = "wave",
+    WAVYHEAVY = "wavyHeavy",
+    WAVYDOUBLE = "wavyDouble",
+    NONE = "none"
+}
+export declare class Underline extends XmlComponent {
+    constructor(underlineType?: UnderlineType, color?: string);
+}

package/build/file/relationships/attributes.d.ts

@@ -1,8 +1,8 @@
-import { XmlAttributeComponent } from "../../file/xml-components";
-export declare class RelationshipsAttributes extends XmlAttributeComponent<{
-    readonly xmlns: string;
-}> {
-    protected readonly xmlKeys: {
-        xmlns: string;
-    };
-}
+import { XmlAttributeComponent } from "../../file/xml-components";
+export declare class RelationshipsAttributes extends XmlAttributeComponent<{
+    readonly xmlns: string;
+}> {
+    protected readonly xmlKeys: {
+        xmlns: string;
+    };
+}

package/build/file/relationships/index.d.ts

@@ -1 +1 @@
-export * from "./relationships";
+export * from "./relationships";

package/build/file/relationships/relationship/relationship-attributes.d.ts

@@ -1,14 +1,14 @@
-import { XmlAttributeComponent } from "../../../file/xml-components";
-export declare class RelationshipAttributes extends XmlAttributeComponent<{
-    readonly id: string;
-    readonly type: string;
-    readonly target: string;
-    readonly targetMode?: string;
-}> {
-    protected readonly xmlKeys: {
-        id: string;
-        type: string;
-        target: string;
-        targetMode: string;
-    };
-}
+import { XmlAttributeComponent } from "../../../file/xml-components";
+export declare class RelationshipAttributes extends XmlAttributeComponent<{
+    readonly id: string;
+    readonly type: string;
+    readonly target: string;
+    readonly targetMode?: string;
+}> {
+    protected readonly xmlKeys: {
+        id: string;
+        type: string;
+        target: string;
+        targetMode: string;
+    };
+}

package/build/file/relationships/relationship/relationship.d.ts

@@ -1,8 +1,8 @@
-import { XmlComponent } from "../../../file/xml-components";
-export type RelationshipType = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments";
-export declare enum TargetModeType {
-    EXTERNAL = "External"
-}
-export declare class Relationship extends XmlComponent {
-    constructor(id: string, type: RelationshipType, target: string, targetMode?: TargetModeType);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export type RelationshipType = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments";
+export declare enum TargetModeType {
+    EXTERNAL = "External"
+}
+export declare class Relationship extends XmlComponent {
+    constructor(id: string, type: RelationshipType, target: string, targetMode?: TargetModeType);
+}

package/build/file/relationships/relationships.d.ts

@@ -1,8 +1,7 @@
-import { XmlComponent } from "../../file/xml-components";
-import { Relationship, RelationshipType, TargetModeType } from "./relationship/relationship";
-export declare class Relationships extends XmlComponent {
-    constructor();
-    addRelationship(relationship: Relationship): void;
-    createRelationship(id: number | string, type: RelationshipType, target: string, targetMode?: TargetModeType): Relationship;
-    get RelationshipCount(): number;
-}
+import { XmlComponent } from "../../file/xml-components";
+import { Relationship, RelationshipType, TargetModeType } from "./relationship/relationship";
+export declare class Relationships extends XmlComponent {
+    constructor();
+    createRelationship(id: number | string, type: RelationshipType, target: string, targetMode?: TargetModeType): Relationship;
+    get RelationshipCount(): number;
+}

package/build/file/settings/compatibility-setting/compatibility-setting.d.ts

@@ -1,15 +1,15 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../file/xml-components";
-export declare class CompatibilitySettingAttributes extends XmlAttributeComponent<{
-    readonly version: number;
-    readonly name: string;
-    readonly uri: string;
-}> {
-    protected readonly xmlKeys: {
-        version: string;
-        name: string;
-        uri: string;
-    };
-}
-export declare class CompatibilitySetting extends XmlComponent {
-    constructor(version: number);
-}
+import { XmlAttributeComponent, XmlComponent } from "../../../file/xml-components";
+export declare class CompatibilitySettingAttributes extends XmlAttributeComponent<{
+    readonly version: number;
+    readonly name: string;
+    readonly uri: string;
+}> {
+    protected readonly xmlKeys: {
+        version: string;
+        name: string;
+        uri: string;
+    };
+}
+export declare class CompatibilitySetting extends XmlComponent {
+    constructor(version: number);
+}