docx 7.8.2 → 8.0.1

package/src/file/styles/external-styles-factory.spec.ts

@@ -1,251 +0,0 @@
-import { expect } from "chai";
-
-import { ExternalStylesFactory } from "./external-styles-factory";
-
-describe("External styles factory", () => {
-    let externalStyles;
-
-    beforeEach(() => {
-        externalStyles = `
-        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-        <w:styles xmlns:mc="first" xmlns:r="second">
-            <w:docDefaults>
-            <w:rPrDefault>
-                <w:rPr>
-                    <w:rFonts w:ascii="Arial" w:eastAsiaTheme="minorHAnsi" w:hAnsi="Arial" w:cstheme="minorHAnsi"/>
-                    <w:lang w:val="en-US" w:eastAsia="en-US" w:bidi="ar-SA"/>
-                </w:rPr>
-            </w:rPrDefault>
-            <w:pPrDefault>
-                <w:pPr>
-                    <w:spacing w:after="160" w:line="259" w:lineRule="auto"/>
-                </w:pPr>
-            </w:pPrDefault>
-            </w:docDefaults>
-
-            <w:latentStyles w:defLockedState="1" w:defUIPriority="99">
-            </w:latentStyles>
-
-            <w:style w:type="paragraph" w:default="1" w:styleId="Normal">
-                <w:name w:val="Normal"/>
-                <w:qFormat/>
-            </w:style>
-
-            <w:style w:type="paragraph" w:styleId="Heading1">
-                <w:name w:val="heading 1"/>
-                <w:basedOn w:val="Normal"/>
-                <w:pPr>
-                    <w:keepNext/>
-                    <w:keepLines/>
-
-                    <w:pBdr>
-                        <w:bottom w:val="single" w:sz="4" w:space="1" w:color="auto"/>
-                  </w:pBdr>
-                </w:pPr>
-            </w:style>
-        </w:styles>`;
-    });
-
-    describe("#parse", () => {
-        it("should parse w:styles attributes", () => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const importedStyle = new ExternalStylesFactory().newInstance(externalStyles) as any;
-
-            expect(importedStyle.rootKey).to.equal("w:styles");
-            expect(importedStyle.root[0]._attr).to.deep.equal({
-                "xmlns:mc": "first",
-                "xmlns:r": "second",
-            });
-        });
-
-        it("should parse other child elements of w:styles", () => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const importedStyle = new ExternalStylesFactory().newInstance(externalStyles) as any;
-            expect(importedStyle.root[1]).to.deep.equal({
-                root: [
-                    {
-                        root: [
-                            {
-                                root: [
-                                    {
-                                        root: [
-                                            {
-                                                root: {
-                                                    "w:ascii": "Arial",
-                                                    "w:cstheme": "minorHAnsi",
-                                                    "w:eastAsiaTheme": "minorHAnsi",
-                                                    "w:hAnsi": "Arial",
-                                                },
-                                                rootKey: "_attr",
-                                            },
-                                        ],
-                                        rootKey: "w:rFonts",
-                                    },
-                                    {
-                                        root: [
-                                            {
-                                                root: {
-                                                    "w:bidi": "ar-SA",
-                                                    "w:eastAsia": "en-US",
-                                                    "w:val": "en-US",
-                                                },
-                                                rootKey: "_attr",
-                                            },
-                                        ],
-                                        rootKey: "w:lang",
-                                    },
-                                ],
-                                rootKey: "w:rPr",
-                            },
-                        ],
-                        rootKey: "w:rPrDefault",
-                    },
-                    {
-                        root: [
-                            {
-                                root: [
-                                    {
-                                        root: [
-                                            {
-                                                root: {
-                                                    "w:after": "160",
-                                                    "w:line": "259",
-                                                    "w:lineRule": "auto",
-                                                },
-                                                rootKey: "_attr",
-                                            },
-                                        ],
-                                        rootKey: "w:spacing",
-                                    },
-                                ],
-                                rootKey: "w:pPr",
-                            },
-                        ],
-                        rootKey: "w:pPrDefault",
-                    },
-                ],
-                rootKey: "w:docDefaults",
-            });
-            expect(importedStyle.root[2]).to.deep.equal({
-                root: [
-                    {
-                        root: {
-                            "w:defLockedState": "1",
-                            "w:defUIPriority": "99",
-                        },
-                        rootKey: "_attr",
-                    },
-                ],
-                rootKey: "w:latentStyles",
-            });
-        });
-
-        it("should throw when style element isn't found", () => {
-            expect(() => new ExternalStylesFactory().newInstance(`<?xml version="1.0" encoding="UTF-8" standalone="yes"?><foo/>`)).to.throw(
-                "can not find styles element",
-            );
-        });
-
-        it("should parse styles elements", () => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const importedStyle = new ExternalStylesFactory().newInstance(externalStyles) as any;
-
-            expect(importedStyle.root.length).to.equal(5);
-            expect(importedStyle.root[3]).to.deep.equal({
-                root: [
-                    {
-                        root: {
-                            "w:default": "1",
-                            "w:styleId": "Normal",
-                            "w:type": "paragraph",
-                        },
-                        rootKey: "_attr",
-                    },
-                    {
-                        root: [
-                            {
-                                root: {
-                                    "w:val": "Normal",
-                                },
-                                rootKey: "_attr",
-                            },
-                        ],
-                        rootKey: "w:name",
-                    },
-                    {
-                        root: [],
-                        rootKey: "w:qFormat",
-                    },
-                ],
-                rootKey: "w:style",
-            });
-
-            expect(importedStyle.root[4]).to.deep.equal({
-                root: [
-                    {
-                        root: {
-                            "w:styleId": "Heading1",
-                            "w:type": "paragraph",
-                        },
-                        rootKey: "_attr",
-                    },
-                    {
-                        root: [
-                            {
-                                root: {
-                                    "w:val": "heading 1",
-                                },
-                                rootKey: "_attr",
-                            },
-                        ],
-                        rootKey: "w:name",
-                    },
-                    {
-                        root: [
-                            {
-                                root: {
-                                    "w:val": "Normal",
-                                },
-                                rootKey: "_attr",
-                            },
-                        ],
-                        rootKey: "w:basedOn",
-                    },
-                    {
-                        root: [
-                            {
-                                root: [],
-                                rootKey: "w:keepNext",
-                            },
-                            {
-                                root: [],
-                                rootKey: "w:keepLines",
-                            },
-                            {
-                                root: [
-                                    {
-                                        root: [
-                                            {
-                                                root: {
-                                                    "w:color": "auto",
-                                                    "w:space": "1",
-                                                    "w:sz": "4",
-                                                    "w:val": "single",
-                                                },
-                                                rootKey: "_attr",
-                                            },
-                                        ],
-                                        rootKey: "w:bottom",
-                                    },
-                                ],
-                                rootKey: "w:pBdr",
-                            },
-                        ],
-                        rootKey: "w:pPr",
-                    },
-                ],
-                rootKey: "w:style",
-            });
-        });
-    });
-});

package/src/file/styles/external-styles-factory.ts

@@ -1,51 +0,0 @@
-import { convertToXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent } from "@file/xml-components";
-import { Element as XMLElement, xml2js } from "xml-js";
-import { Styles } from "./";
-
-export class ExternalStylesFactory {
-    /**
-     * Creates new Style based on the given styles.
-     * Parses the styles and convert them to XmlComponent.
-     * Example content from styles.xml:
-     * <?xml version="1.0">
-     * <w:styles xmlns:mc="some schema" ...>
-     *
-     *   <w:style w:type="paragraph" w:styleId="Heading1">
-     *           <w:name w:val="heading 1"/>
-     *           .....
-     *   </w:style>
-     *
-     *   <w:style w:type="paragraph" w:styleId="Heading2">
-     *           <w:name w:val="heading 2"/>
-     *           .....
-     *   </w:style>
-     *
-     *   <w:docDefaults>Or any other element will be parsed to</w:docDefaults>
-     *
-     * </w:styles>
-     *
-     * @param externalStyles context from styles.xml
-     */
-    public newInstance(xmlData: string): Styles {
-        const xmlObj = xml2js(xmlData, { compact: false }) as XMLElement;
-
-        let stylesXmlElement: XMLElement | undefined;
-        for (const xmlElm of xmlObj.elements || []) {
-            if (xmlElm.name === "w:styles") {
-                stylesXmlElement = xmlElm;
-            }
-        }
-        if (stylesXmlElement === undefined) {
-            throw new Error("can not find styles element");
-        }
-
-        const stylesElements = stylesXmlElement.elements || [];
-
-        const importedStyle = new Styles({
-            initialStyles: new ImportedRootElementAttributes(stylesXmlElement.attributes),
-            importedStyles: stylesElements.map((childElm) => convertToXmlComponent(childElm) as ImportedXmlComponent),
-        });
-
-        return importedStyle;
-    }
-}

package/src/file/styles/factory.ts

@@ -1,114 +0,0 @@
-import { DocumentAttributes } from "../document/document-attributes";
-import { IStylesOptions } from "./styles";
-
-import { DocumentDefaults, IDocumentDefaultsOptions } from "./defaults";
-import {
-    FootnoteReferenceStyle,
-    FootnoteText,
-    FootnoteTextChar,
-    Heading1Style,
-    Heading2Style,
-    Heading3Style,
-    Heading4Style,
-    Heading5Style,
-    Heading6Style,
-    HyperlinkStyle,
-    IBaseCharacterStyleOptions,
-    IBaseParagraphStyleOptions,
-    ListParagraph,
-    StrongStyle,
-    TitleStyle,
-} from "./style";
-
-export interface IDefaultStylesOptions {
-    readonly document?: IDocumentDefaultsOptions;
-    readonly title?: IBaseParagraphStyleOptions;
-    readonly heading1?: IBaseParagraphStyleOptions;
-    readonly heading2?: IBaseParagraphStyleOptions;
-    readonly heading3?: IBaseParagraphStyleOptions;
-    readonly heading4?: IBaseParagraphStyleOptions;
-    readonly heading5?: IBaseParagraphStyleOptions;
-    readonly heading6?: IBaseParagraphStyleOptions;
-    readonly strong?: IBaseParagraphStyleOptions;
-    readonly listParagraph?: IBaseParagraphStyleOptions;
-    readonly hyperlink?: IBaseCharacterStyleOptions;
-    readonly footnoteReference?: IBaseCharacterStyleOptions;
-    readonly footnoteText?: IBaseParagraphStyleOptions;
-    readonly footnoteTextChar?: IBaseCharacterStyleOptions;
-}
-
-export class DefaultStylesFactory {
-    public newInstance(options: IDefaultStylesOptions = {}): IStylesOptions {
-        const documentAttributes = new DocumentAttributes({
-            mc: "http://schemas.openxmlformats.org/markup-compatibility/2006",
-            r: "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
-            w: "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
-            w14: "http://schemas.microsoft.com/office/word/2010/wordml",
-            w15: "http://schemas.microsoft.com/office/word/2012/wordml",
-            Ignorable: "w14 w15",
-        });
-        return {
-            initialStyles: documentAttributes,
-            importedStyles: [
-                new DocumentDefaults(options.document ?? {}),
-                new TitleStyle({
-                    run: {
-                        size: 56,
-                    },
-                    ...options.title,
-                }),
-                new Heading1Style({
-                    run: {
-                        color: "2E74B5",
-                        size: 32,
-                    },
-                    ...options.heading1,
-                }),
-                new Heading2Style({
-                    run: {
-                        color: "2E74B5",
-                        size: 26,
-                    },
-                    ...options.heading2,
-                }),
-                new Heading3Style({
-                    run: {
-                        color: "1F4D78",
-                        size: 24,
-                    },
-                    ...options.heading3,
-                }),
-                new Heading4Style({
-                    run: {
-                        color: "2E74B5",
-                        italics: true,
-                    },
-                    ...options.heading4,
-                }),
-                new Heading5Style({
-                    run: {
-                        color: "2E74B5",
-                    },
-                    ...options.heading5,
-                }),
-                new Heading6Style({
-                    run: {
-                        color: "1F4D78",
-                    },
-                    ...options.heading6,
-                }),
-                new StrongStyle({
-                    run: {
-                        bold: true,
-                    },
-                    ...options.strong,
-                }),
-                new ListParagraph(options.listParagraph || {}),
-                new HyperlinkStyle(options.hyperlink || {}),
-                new FootnoteReferenceStyle(options.footnoteReference || {}),
-                new FootnoteText(options.footnoteText || {}),
-                new FootnoteTextChar(options.footnoteTextChar || {}),
-            ],
-        };
-    }
-}

package/src/file/styles/index.ts

@@ -1,4 +0,0 @@
-export * from "./styles";
-export * from "./style/character-style";
-export * from "./style/paragraph-style";
-export * from "./defaults";

package/src/file/styles/latent-styles/exceptions.spec.ts

@@ -1,32 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { LatentStyleException } from "./exceptions";
-
-describe("LatentStyleException", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const currentLatentStyleException = new LatentStyleException({
-                name: "test-name",
-                uiPriority: "test-uiPriority",
-                qFormat: "test-qFormat",
-                semiHidden: "test-semiHidden",
-                unhideWhenUsed: "test-unhideWhenUsed",
-            });
-
-            const tree = new Formatter().format(currentLatentStyleException);
-            expect(tree).to.deep.equal({
-                "w:lsdException": {
-                    _attr: {
-                        "w:name": "test-name",
-                        "w:qFormat": "test-qFormat",
-                        "w:semiHidden": "test-semiHidden",
-                        "w:uiPriority": "test-uiPriority",
-                        "w:unhideWhenUsed": "test-unhideWhenUsed",
-                    },
-                },
-            });
-        });
-    });
-});

package/src/file/styles/latent-styles/exceptions.ts

@@ -1,26 +0,0 @@
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-export interface ILatentStyleExceptionAttributesProperties {
-    readonly name?: string;
-    readonly uiPriority?: string;
-    readonly qFormat?: string;
-    readonly semiHidden?: string;
-    readonly unhideWhenUsed?: string;
-}
-
-export class LatentStyleExceptionAttributes extends XmlAttributeComponent<ILatentStyleExceptionAttributesProperties> {
-    protected readonly xmlKeys = {
-        name: "w:name",
-        uiPriority: "w:uiPriority",
-        qFormat: "w:qFormat",
-        semiHidden: "w:semiHidden",
-        unhideWhenUsed: "w:unhideWhenUsed",
-    };
-}
-
-export class LatentStyleException extends XmlComponent {
-    public constructor(attributes: ILatentStyleExceptionAttributesProperties) {
-        super("w:lsdException");
-        this.root.push(new LatentStyleExceptionAttributes(attributes));
-    }
-}

package/src/file/styles/latent-styles/index.ts

@@ -1 +0,0 @@
-export * from "./latent-styles";

package/src/file/styles/latent-styles/latent-styles.spec.ts

@@ -1,34 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { LatentStyleException } from "./exceptions";
-import { LatentStyles } from "./latent-styles";
-
-describe("LatentStyles", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const currentLatentStyles = new LatentStyles();
-
-            const tree = new Formatter().format(currentLatentStyles);
-            expect(tree).to.deep.equal({
-                "w:latentStyles": {},
-            });
-        });
-
-        it("should create with exception", () => {
-            const currentLatentStyles = new LatentStyles(new LatentStyleException({}));
-
-            const tree = new Formatter().format(currentLatentStyles);
-            expect(tree).to.deep.equal({
-                "w:latentStyles": [
-                    {
-                        "w:lsdException": {
-                            _attr: {},
-                        },
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/styles/latent-styles/latent-styles.ts

@@ -1,12 +0,0 @@
-import { XmlComponent } from "@file/xml-components";
-import { LatentStyleException } from "./exceptions";
-
-export class LatentStyles extends XmlComponent {
-    public constructor(latentException?: LatentStyleException) {
-        super("w:latentStyles");
-
-        if (latentException) {
-            this.root.push(latentException);
-        }
-    }
-}

package/src/file/styles/sample/default-style.spec.ts

@@ -1,12 +0,0 @@
-import { expect } from "chai";
-
-import { DefaultStyle } from "./default-style";
-
-describe("DefaultStyle", () => {
-    it("creates an initially empty property object", () => {
-        const style = DefaultStyle();
-        expect(style).to.have.property("w:styles");
-        expect(style["w:styles"].length).to.be.greaterThan(1);
-        expect(style["w:styles"][1]).to.have.property("w:docDefaults");
-    });
-});