docx 7.8.2 → 8.0.1

package/src/file/paragraph/paragraph.ts

@@ -1,101 +0,0 @@
-// http://officeopenxml.com/WPparagraph.php
-import { FootnoteReferenceRun } from "@file/footnotes";
-import { IContext, IXmlableObject, XmlComponent } from "@file/xml-components";
-import { uniqueId } from "@util/convenience-functions";
-
-import { TargetModeType } from "../relationships/relationship/relationship";
-import { DeletedTextRun, InsertedTextRun } from "../track-revision";
-import { ColumnBreak, PageBreak } from "./formatting/break";
-import { Bookmark, ConcreteHyperlink, ExternalHyperlink, InternalHyperlink } from "./links";
-import { Math } from "./math";
-import { IParagraphPropertiesOptions, ParagraphProperties } from "./properties";
-import { ImageRun, Run, SequentialIdentifier, SimpleField, SimpleMailMergeField, SymbolRun, TextRun } from "./run";
-import { Comment, CommentRangeEnd, CommentRangeStart, CommentReference, Comments } from "./run/comment-run";
-
-export type ParagraphChild =
-    | TextRun
-    | ImageRun
-    | SymbolRun
-    | Bookmark
-    | PageBreak
-    | ColumnBreak
-    | SequentialIdentifier
-    | FootnoteReferenceRun
-    | InternalHyperlink
-    | ExternalHyperlink
-    | InsertedTextRun
-    | DeletedTextRun
-    | Math
-    | SimpleField
-    | SimpleMailMergeField
-    | Comments
-    | Comment
-    | CommentRangeStart
-    | CommentRangeEnd
-    | CommentReference;
-
-export interface IParagraphOptions extends IParagraphPropertiesOptions {
-    readonly text?: string;
-    readonly children?: readonly ParagraphChild[];
-}
-
-export class Paragraph extends XmlComponent {
-    private readonly properties: ParagraphProperties;
-
-    public constructor(options: string | IParagraphOptions) {
-        super("w:p");
-
-        if (typeof options === "string") {
-            this.properties = new ParagraphProperties({});
-            this.root.push(this.properties);
-            this.root.push(new TextRun(options));
-            return this;
-        }
-
-        this.properties = new ParagraphProperties(options);
-
-        this.root.push(this.properties);
-
-        if (options.text) {
-            this.root.push(new TextRun(options.text));
-        }
-
-        if (options.children) {
-            for (const child of options.children) {
-                if (child instanceof Bookmark) {
-                    this.root.push(child.start);
-                    for (const textRun of child.children) {
-                        this.root.push(textRun);
-                    }
-                    this.root.push(child.end);
-                    continue;
-                }
-
-                this.root.push(child);
-            }
-        }
-    }
-
-    public prepForXml(context: IContext): IXmlableObject | undefined {
-        for (const element of this.root) {
-            if (element instanceof ExternalHyperlink) {
-                const index = this.root.indexOf(element);
-                const concreteHyperlink = new ConcreteHyperlink(element.options.children, uniqueId());
-                context.viewWrapper.Relationships.createRelationship(
-                    concreteHyperlink.linkId,
-                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
-                    element.options.link,
-                    TargetModeType.EXTERNAL,
-                );
-                this.root[index] = concreteHyperlink;
-            }
-        }
-
-        return super.prepForXml(context);
-    }
-
-    public addRunToFront(run: Run): Paragraph {
-        this.root.splice(1, 0, run);
-        return this;
-    }
-}

package/src/file/paragraph/properties.spec.ts

@@ -1,146 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-import { DocumentWrapper } from "../document-wrapper";
-import { File } from "../file";
-
-import { ParagraphProperties } from "./properties";
-
-describe("ParagraphProperties", () => {
-    describe("#constructor()", () => {
-        it("creates an initially empty property object", () => {
-            const properties = new ParagraphProperties();
-
-            expect(() => new Formatter().format(properties)).to.throw("XMLComponent did not format correctly");
-        });
-
-        it("should create with numbering", () => {
-            const properties = new ParagraphProperties({
-                numbering: {
-                    reference: "test-reference",
-                    level: 0,
-                    instance: 0,
-                },
-            });
-            const tree = new Formatter().format(properties, {
-                // tslint:disable-next-line: no-object-literal-type-assertion
-                file: {
-                    Numbering: {
-                        createConcreteNumberingInstance: (_: string, __: number) => undefined,
-                    },
-                } as File,
-                // tslint:disable-next-line: no-object-literal-type-assertion
-                viewWrapper: new DocumentWrapper({ background: {} }),
-            });
-
-            expect(tree).to.deep.equal({
-                "w:pPr": [
-                    {
-                        "w:pStyle": {
-                            _attr: {
-                                "w:val": "ListParagraph",
-                            },
-                        },
-                    },
-                    {
-                        "w:numPr": [
-                            {
-                                "w:ilvl": {
-                                    _attr: {
-                                        "w:val": 0,
-                                    },
-                                },
-                            },
-                            {
-                                "w:numId": {
-                                    _attr: {
-                                        "w:val": "{test-reference-0}",
-                                    },
-                                },
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-
-        it("should create with widowControl", () => {
-            const properties = new ParagraphProperties({
-                widowControl: true,
-            });
-            const tree = new Formatter().format(properties);
-
-            expect(tree).to.deep.equal({
-                "w:pPr": [
-                    {
-                        "w:widowControl": {},
-                    },
-                ],
-            });
-        });
-
-        it("should create with the bidirectional property", () => {
-            const properties = new ParagraphProperties({
-                bidirectional: true,
-            });
-            const tree = new Formatter().format(properties);
-
-            expect(tree).to.deep.equal({
-                "w:pPr": [
-                    {
-                        "w:bidi": {},
-                    },
-                ],
-            });
-        });
-
-        it("should create with the contextualSpacing property", () => {
-            const properties = new ParagraphProperties({
-                contextualSpacing: true,
-            });
-            const tree = new Formatter().format(properties);
-
-            expect(tree).to.deep.equal({
-                "w:pPr": [
-                    {
-                        "w:contextualSpacing": {},
-                    },
-                ],
-            });
-        });
-
-        it("should create with the suppressLineNumbers property", () => {
-            const properties = new ParagraphProperties({
-                suppressLineNumbers: true,
-            });
-            const tree = new Formatter().format(properties);
-
-            expect(tree).to.deep.equal({
-                "w:pPr": [
-                    {
-                        "w:suppressLineNumbers": {},
-                    },
-                ],
-            });
-        });
-
-        it("should create with the wordWrap property", () => {
-            const properties = new ParagraphProperties({
-                wordWrap: true,
-            });
-            const tree = new Formatter().format(properties);
-
-            expect(tree).to.deep.equal({
-                "w:pPr": [
-                    {
-                        "w:wordWrap": {
-                            _attr: {
-                                "w:val": 0,
-                            },
-                        },
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/paragraph/properties.ts

@@ -1,197 +0,0 @@
-// http://officeopenxml.com/WPparagraphProperties.php
-// https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_suppressLineNumbers_topic_ID0ECJAO.html
-import { IContext, IgnoreIfEmptyXmlComponent, IXmlableObject, OnOffElement, XmlComponent } from "@file/xml-components";
-import { DocumentWrapper } from "../document-wrapper";
-import { IShadingAttributesProperties, Shading } from "../shading";
-import { Alignment, AlignmentType } from "./formatting/alignment";
-import { Border, IBordersOptions, ThematicBreak } from "./formatting/border";
-import { PageBreakBefore } from "./formatting/break";
-import { IIndentAttributesProperties, Indent } from "./formatting/indent";
-import { ISpacingProperties, Spacing } from "./formatting/spacing";
-import { HeadingLevel, Style } from "./formatting/style";
-import { TabStop, TabStopDefinition, TabStopType } from "./formatting/tab-stop";
-import { NumberProperties } from "./formatting/unordered-list";
-import { WordWrap } from "./formatting/word-wrap";
-import { FrameProperties, IFrameOptions } from "./frame/frame-properties";
-import { OutlineLevel } from "./links";
-
-export interface ILevelParagraphStylePropertiesOptions {
-    readonly alignment?: AlignmentType;
-    readonly thematicBreak?: boolean;
-    readonly contextualSpacing?: boolean;
-    readonly rightTabStop?: number;
-    readonly leftTabStop?: number;
-    readonly indent?: IIndentAttributesProperties;
-    readonly spacing?: ISpacingProperties;
-    readonly keepNext?: boolean;
-    readonly keepLines?: boolean;
-    readonly outlineLevel?: number;
-}
-
-export interface IParagraphStylePropertiesOptions extends ILevelParagraphStylePropertiesOptions {
-    readonly numbering?: {
-        readonly reference: string;
-        readonly level: number;
-        readonly instance?: number;
-        readonly custom?: boolean;
-    };
-}
-
-export interface IParagraphPropertiesOptions extends IParagraphStylePropertiesOptions {
-    readonly border?: IBordersOptions;
-    readonly heading?: HeadingLevel;
-    readonly bidirectional?: boolean;
-    readonly pageBreakBefore?: boolean;
-    readonly tabStops?: readonly TabStopDefinition[];
-    readonly style?: string;
-    readonly bullet?: {
-        readonly level: number;
-    };
-    readonly shading?: IShadingAttributesProperties;
-    readonly widowControl?: boolean;
-    readonly frame?: IFrameOptions;
-    readonly suppressLineNumbers?: boolean;
-    readonly wordWrap?: boolean;
-    readonly scale?: number;
-}
-
-export class ParagraphProperties extends IgnoreIfEmptyXmlComponent {
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private readonly numberingReferences: { readonly reference: string; readonly instance: number }[] = [];
-
-    public constructor(options?: IParagraphPropertiesOptions) {
-        super("w:pPr");
-
-        if (!options) {
-            return this;
-        }
-
-        if (options.heading) {
-            this.push(new Style(options.heading));
-        }
-
-        if (options.bullet) {
-            this.push(new Style("ListParagraph"));
-        }
-
-        if (options.numbering) {
-            if (!options.style && !options.heading) {
-                if (!options.numbering.custom) {
-                    this.push(new Style("ListParagraph"));
-                }
-            }
-        }
-
-        if (options.style) {
-            this.push(new Style(options.style));
-        }
-
-        if (options.keepNext !== undefined) {
-            this.push(new OnOffElement("w:keepNext", options.keepNext));
-        }
-
-        if (options.keepLines !== undefined) {
-            this.push(new OnOffElement("w:keepLines", options.keepLines));
-        }
-
-        if (options.pageBreakBefore) {
-            this.push(new PageBreakBefore());
-        }
-
-        if (options.frame) {
-            this.push(new FrameProperties(options.frame));
-        }
-
-        if (options.widowControl !== undefined) {
-            this.push(new OnOffElement("w:widowControl", options.widowControl));
-        }
-
-        if (options.bullet) {
-            this.push(new NumberProperties(1, options.bullet.level));
-        }
-
-        if (options.numbering) {
-            this.numberingReferences.push({
-                reference: options.numbering.reference,
-                instance: options.numbering.instance ?? 0,
-            });
-
-            this.push(new NumberProperties(`${options.numbering.reference}-${options.numbering.instance ?? 0}`, options.numbering.level));
-        }
-
-        if (options.border) {
-            this.push(new Border(options.border));
-        }
-
-        if (options.thematicBreak) {
-            this.push(new ThematicBreak());
-        }
-
-        if (options.shading) {
-            this.push(new Shading(options.shading));
-        }
-
-        if (options.wordWrap) {
-            this.push(new WordWrap());
-        }
-
-        /**
-         * FIX: Multitab support for Libre Writer
-         * Ensure there is only one w:tabs tag with multiple w:tab
-         */
-        const tabDefinitions: readonly TabStopDefinition[] = [
-            ...(options.rightTabStop ? [{ type: TabStopType.RIGHT, position: options.rightTabStop }] : []),
-            ...(options.tabStops ? options.tabStops : []),
-            ...(options.leftTabStop ? [{ type: TabStopType.LEFT, position: options.leftTabStop }] : []),
-        ];
-
-        if (tabDefinitions.length > 0) {
-            this.push(new TabStop(tabDefinitions));
-        }
-        /**
-         *  FIX - END
-         */
-
-        if (options.bidirectional !== undefined) {
-            this.push(new OnOffElement("w:bidi", options.bidirectional));
-        }
-
-        if (options.spacing) {
-            this.push(new Spacing(options.spacing));
-        }
-
-        if (options.indent) {
-            this.push(new Indent(options.indent));
-        }
-
-        if (options.contextualSpacing !== undefined) {
-            this.push(new OnOffElement("w:contextualSpacing", options.contextualSpacing));
-        }
-
-        if (options.alignment) {
-            this.push(new Alignment(options.alignment));
-        }
-
-        if (options.outlineLevel !== undefined) {
-            this.push(new OutlineLevel(options.outlineLevel));
-        }
-
-        if (options.suppressLineNumbers !== undefined) {
-            this.push(new OnOffElement("w:suppressLineNumbers", options.suppressLineNumbers));
-        }
-    }
-
-    public push(item: XmlComponent): void {
-        this.root.push(item);
-    }
-
-    public prepForXml(context: IContext): IXmlableObject | undefined {
-        if (context.viewWrapper instanceof DocumentWrapper) {
-            for (const reference of this.numberingReferences) {
-                context.file.Numbering.createConcreteNumberingInstance(reference.reference, reference.instance);
-            }
-        }
-
-        return super.prepForXml(context);
-    }
-}

package/src/file/paragraph/run/break.spec.ts

@@ -1,22 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Break } from "./break";
-
-describe("Break", () => {
-    let currentBreak: Break;
-
-    beforeEach(() => {
-        currentBreak = new Break();
-    });
-
-    describe("#constructor()", () => {
-        it("should create a Break with correct root key", () => {
-            const tree = new Formatter().format(currentBreak);
-            expect(tree).to.deep.equal({
-                "w:br": {},
-            });
-        });
-    });
-});

package/src/file/paragraph/run/break.ts

@@ -1,32 +0,0 @@
-// http://officeopenxml.com/WPtextSpecialContent-break.php
-import { XmlComponent } from "@file/xml-components";
-
-// <xsd:group name="EG_RunInnerContent">
-//   ...
-//   <xsd:element name="br" type="CT_Br"/>
-
-// <xsd:complexType name="CT_Br">
-//     <xsd:attribute name="type" type="ST_BrType" use="optional"/>
-//     <xsd:attribute name="clear" type="ST_BrClear" use="optional"/>
-// </xsd:complexType>
-
-// <xsd:simpleType name="ST_BrType">
-// <xsd:restriction base="xsd:string">
-//   <xsd:enumeration value="page"/>
-//   <xsd:enumeration value="column"/>
-//   <xsd:enumeration value="textWrapping"/>
-// </xsd:restriction>
-// </xsd:simpleType>
-// <xsd:simpleType name="ST_BrClear">
-// <xsd:restriction base="xsd:string">
-//   <xsd:enumeration value="none"/>
-//   <xsd:enumeration value="left"/>
-//   <xsd:enumeration value="right"/>
-//   <xsd:enumeration value="all"/>
-// </xsd:restriction>
-// </xsd:simpleType>
-export class Break extends XmlComponent {
-    public constructor() {
-        super("w:br");
-    }
-}