docx 7.8.2 → 8.0.1

package/src/file/table-of-contents/sdt-properties.ts

@@ -1,9 +0,0 @@
-// http://www.datypic.com/sc/ooxml/e-w_sdtPr-1.html
-import { StringValueElement, XmlComponent } from "@file/xml-components";
-
-export class StructuredDocumentTagProperties extends XmlComponent {
-    public constructor(alias: string) {
-        super("w:sdtPr");
-        this.root.push(new StringValueElement("w:alias", alias));
-    }
-}

package/src/file/table-of-contents/table-of-contents-properties.ts

@@ -1,122 +0,0 @@
-export class StyleLevel {
-    public readonly styleName: string;
-    public readonly level: number;
-
-    public constructor(styleName: string, level: number) {
-        this.styleName = styleName;
-        this.level = level;
-    }
-}
-
-/**
- * Options according to this docs:
- * https://www.ecma-international.org/publications/standards/Ecma-376.htm
- * Part 1 - Page 1251
- *
- * Short Guide:
- * http://officeopenxml.com/WPtableOfContents.php
- */
-export interface ITableOfContentsOptions {
-    /**
-     * \a option - Includes captioned items, but omits caption labels and numbers.
-     * The identifier designated by text in this switch's field-argument corresponds to the caption label.
-     * Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.
-     */
-    readonly captionLabel?: string;
-
-    /**
-     * \b option - Includes entries only from the portion of the document marked by
-     * the bookmark named by text in this switch's field-argument.
-     */
-    readonly entriesFromBookmark?: string;
-
-    /**
-     * \c option -  Includes figures, tables, charts, and other items that are numbered
-     * by a SEQ field (§17.16.5.56). The sequence identifier designated by text in this switch's
-     * field-argument, which corresponds to the caption label, shall match the identifier in the
-     * corresponding SEQ field.
-     */
-    readonly captionLabelIncludingNumbers?: string;
-
-    /**
-     * \d option - When used with \s, the text in this switch's field-argument defines
-     * the separator between sequence and page numbers. The default separator is a hyphen (-).
-     */
-    readonly sequenceAndPageNumbersSeparator?: string;
-
-    /**
-     * \f option - Includes only those TC fields whose identifier exactly matches the
-     * text in this switch's field-argument (which is typically a letter).
-     */
-    readonly tcFieldIdentifier?: string;
-
-    /**
-     * \h option - Makes the table of contents entries hyperlinks.
-     */
-    readonly hyperlink?: boolean;
-
-    /**
-     * \l option - Includes TC fields that assign entries to one of the levels specified
-     * by text in this switch's field-argument as a range having the form startLevel-endLevel,
-     * where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel.
-     * TC fields that assign entries to lower levels are skipped.
-     */
-    readonly tcFieldLevelRange?: string;
-
-    /**
-     * \n option - Without field-argument, omits page numbers from the table of contents.
-     * Page numbers are omitted from all levels unless a range of entry levels is specified by
-     * text in this switch's field-argument. A range is specified as for \l.
-     */
-    readonly pageNumbersEntryLevelsRange?: string;
-
-    /**
-     * \o option -  Uses paragraphs formatted with all or the specified range of builtin
-     * heading styles. Headings in a style range are specified by text in this switch's
-     * field-argument using the notation specified as for \l, where each integer corresponds
-     * to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1).
-     * If no heading range is specified, all heading levels used in the document are listed.
-     */
-    readonly headingStyleRange?: string;
-
-    /**
-     * \p option - Text in this switch's field-argument specifies a sequence of characters
-     * that separate an entry and its page number. The default is a tab with leader dots.
-     */
-    readonly entryAndPageNumberSeparator?: string;
-
-    /**
-     * \s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number.
-     * The prefix depends on the type of entry. text in this switch's field-argument shall match the
-     * identifier in the SEQ field.
-     */
-    readonly seqFieldIdentifierForPrefix?: string;
-
-    /**
-     * \t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
-     * Text in this switch's field-argument specifies those styles as a set of comma-separated doublets,
-     * with each doublet being a comma-separated set of style name and table of content level.
-     * \t can be combined with \o.
-     */
-    readonly stylesWithLevels?: readonly StyleLevel[];
-
-    /**
-     * \u Uses the applied paragraph outline level.
-     */
-    readonly useAppliedParagraphOutlineLevel?: boolean;
-
-    /**
-     * \w Preserves tab entries within table entries.
-     */
-    readonly preserveTabInEntries?: boolean;
-
-    /**
-     * \x Preserves newline characters within table entries.
-     */
-    readonly preserveNewLineInEntries?: boolean;
-
-    /**
-     * \z Hides tab leader and page numbers in web page view (§17.18.102).
-     */
-    readonly hideTabAndPageNumbersInWebView?: boolean;
-}

package/src/file/table-of-contents/table-of-contents.spec.ts

@@ -1,179 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { TableOfContents } from "./table-of-contents";
-import { StyleLevel } from "./table-of-contents-properties";
-
-describe("Table of Contents", () => {
-    describe("#constructor", () => {
-        it("should construct a TOC without options", () => {
-            const toc = new TableOfContents();
-            const tree = new Formatter().format(toc);
-            expect(tree).to.be.deep.equal(DEFAULT_TOC);
-        });
-
-        it("should construct a TOC with all the options and alias", () => {
-            const styles = [new StyleLevel("SL", 1), new StyleLevel("SL", 2)];
-
-            const props = {
-                captionLabel: "A",
-                entriesFromBookmark: "B",
-                captionLabelIncludingNumbers: "C",
-                sequenceAndPageNumbersSeparator: "D",
-                tcFieldIdentifier: "F",
-                hyperlink: true,
-                tcFieldLevelRange: "L",
-                pageNumbersEntryLevelsRange: "N",
-                headingStyleRange: "O",
-                entryAndPageNumberSeparator: "P",
-                seqFieldIdentifierForPrefix: "S",
-                stylesWithLevels: styles,
-                useAppliedParagraphOutlineLevel: true,
-                preserveTabInEntries: true,
-                preserveNewLineInEntries: true,
-                hideTabAndPageNumbersInWebView: true,
-            };
-
-            const toc = new TableOfContents("Summary", props);
-            const tree = new Formatter().format(toc);
-            expect(tree).to.be.deep.equal(COMPLETE_TOC);
-        });
-    });
-});
-
-const DEFAULT_TOC = {
-    "w:sdt": [
-        {
-            "w:sdtPr": [
-                {
-                    "w:alias": {
-                        _attr: {
-                            "w:val": "Table of Contents",
-                        },
-                    },
-                },
-            ],
-        },
-        {
-            "w:sdtContent": [
-                {
-                    "w:p": [
-                        {
-                            "w:r": [
-                                {
-                                    "w:fldChar": {
-                                        _attr: {
-                                            "w:fldCharType": "begin",
-                                            "w:dirty": true,
-                                        },
-                                    },
-                                },
-                                {
-                                    "w:instrText": [
-                                        {
-                                            _attr: {
-                                                "xml:space": "preserve",
-                                            },
-                                        },
-                                        "TOC",
-                                    ],
-                                },
-                                {
-                                    "w:fldChar": {
-                                        _attr: {
-                                            "w:fldCharType": "separate",
-                                        },
-                                    },
-                                },
-                            ],
-                        },
-                    ],
-                },
-                {
-                    "w:p": [
-                        {
-                            "w:r": [
-                                {
-                                    "w:fldChar": {
-                                        _attr: {
-                                            "w:fldCharType": "end",
-                                        },
-                                    },
-                                },
-                            ],
-                        },
-                    ],
-                },
-            ],
-        },
-    ],
-};
-
-const COMPLETE_TOC = {
-    "w:sdt": [
-        {
-            "w:sdtPr": [
-                {
-                    "w:alias": {
-                        _attr: {
-                            "w:val": "Summary",
-                        },
-                    },
-                },
-            ],
-        },
-        {
-            "w:sdtContent": [
-                {
-                    "w:p": [
-                        {
-                            "w:r": [
-                                {
-                                    "w:fldChar": {
-                                        _attr: {
-                                            "w:fldCharType": "begin",
-                                            "w:dirty": true,
-                                        },
-                                    },
-                                },
-                                {
-                                    "w:instrText": [
-                                        {
-                                            _attr: {
-                                                "xml:space": "preserve",
-                                            },
-                                        },
-                                        'TOC \\a "A" \\b "B" \\c "C" \\d "D" \\f "F" \\h \\l "L" \\n "N" \\o "O" \\p "P" \\s "S" \\t "SL,1,SL,2" \\u \\w \\x \\z',
-                                    ],
-                                },
-                                {
-                                    "w:fldChar": {
-                                        _attr: {
-                                            "w:fldCharType": "separate",
-                                        },
-                                    },
-                                },
-                            ],
-                        },
-                    ],
-                },
-                {
-                    "w:p": [
-                        {
-                            "w:r": [
-                                {
-                                    "w:fldChar": {
-                                        _attr: {
-                                            "w:fldCharType": "end",
-                                        },
-                                    },
-                                },
-                            ],
-                        },
-                    ],
-                },
-            ],
-        },
-    ],
-};

package/src/file/table-of-contents/table-of-contents.ts

@@ -1,41 +0,0 @@
-// http://officeopenxml.com/WPtableOfContents.php
-// http://www.datypic.com/sc/ooxml/e-w_sdt-1.html
-import { Paragraph } from "@file/paragraph";
-import { Run } from "@file/paragraph/run";
-import { Begin, End, Separate } from "@file/paragraph/run/field";
-import { XmlComponent } from "@file/xml-components";
-import { FieldInstruction } from "./field-instruction";
-import { StructuredDocumentTagContent } from "./sdt-content";
-import { StructuredDocumentTagProperties } from "./sdt-properties";
-import { ITableOfContentsOptions } from "./table-of-contents-properties";
-
-export class TableOfContents extends XmlComponent {
-    public constructor(alias: string = "Table of Contents", properties?: ITableOfContentsOptions) {
-        super("w:sdt");
-        this.root.push(new StructuredDocumentTagProperties(alias));
-
-        const content = new StructuredDocumentTagContent();
-
-        const beginParagraph = new Paragraph({
-            children: [
-                new Run({
-                    children: [new Begin(true), new FieldInstruction(properties), new Separate()],
-                }),
-            ],
-        });
-
-        content.addChildElement(beginParagraph);
-
-        const endParagraph = new Paragraph({
-            children: [
-                new Run({
-                    children: [new End()],
-                }),
-            ],
-        });
-
-        content.addChildElement(endParagraph);
-
-        this.root.push(content);
-    }
-}

package/src/file/track-revision/index.ts

@@ -1,2 +0,0 @@
-export * from "./track-revision-components/inserted-text-run";
-export * from "./track-revision-components/deleted-text-run";

package/src/file/track-revision/track-revision-components/deleted-page-number.spec.ts

@@ -1,32 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { DeletedNumberOfPages, DeletedNumberOfPagesSection, DeletedPage } from "./deleted-page-number";
-
-describe("Deleted Page", () => {
-    describe("#constructor()", () => {
-        it("uses the font name for both ascii and hAnsi", () => {
-            const tree = new Formatter().format(new DeletedPage());
-            expect(tree).to.deep.equal({ "w:delInstrText": [{ _attr: { "xml:space": "preserve" } }, "PAGE"] });
-        });
-    });
-});
-
-describe("Deleted NumberOfPages", () => {
-    describe("#constructor()", () => {
-        it("uses the font name for both ascii and hAnsi", () => {
-            const tree = new Formatter().format(new DeletedNumberOfPages());
-            expect(tree).to.deep.equal({ "w:delInstrText": [{ _attr: { "xml:space": "preserve" } }, "NUMPAGES"] });
-        });
-    });
-});
-
-describe("Deleted NumberOfPagesSection", () => {
-    describe("#constructor()", () => {
-        it("uses the font name for both ascii and hAnsi", () => {
-            const tree = new Formatter().format(new DeletedNumberOfPagesSection());
-            expect(tree).to.deep.equal({ "w:delInstrText": [{ _attr: { "xml:space": "preserve" } }, "SECTIONPAGES"] });
-        });
-    });
-});

package/src/file/track-revision/track-revision-components/deleted-page-number.ts

@@ -1,27 +0,0 @@
-import { TextAttributes } from "@file/paragraph/run/text-attributes";
-import { SpaceType } from "@file/shared";
-import { XmlComponent } from "@file/xml-components";
-
-export class DeletedPage extends XmlComponent {
-    public constructor() {
-        super("w:delInstrText");
-        this.root.push(new TextAttributes({ space: SpaceType.PRESERVE }));
-        this.root.push("PAGE");
-    }
-}
-
-export class DeletedNumberOfPages extends XmlComponent {
-    public constructor() {
-        super("w:delInstrText");
-        this.root.push(new TextAttributes({ space: SpaceType.PRESERVE }));
-        this.root.push("NUMPAGES");
-    }
-}
-
-export class DeletedNumberOfPagesSection extends XmlComponent {
-    public constructor() {
-        super("w:delInstrText");
-        this.root.push(new TextAttributes({ space: SpaceType.PRESERVE }));
-        this.root.push("SECTIONPAGES");
-    }
-}