docx 7.8.2 → 8.0.1

package/build/patcher/content-types-manager.d.ts

@@ -0,0 +1,2 @@
+import { Element } from "xml-js";
+export declare const appendContentType: (element: Element, contentType: string, extension: string) => void;

package/build/patcher/from-docx.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { ParagraphChild } from "../file/paragraph";
+import { FileChild } from "../file/file-child";
+type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream;
+export declare enum PatchType {
+    DOCUMENT = "file",
+    PARAGRAPH = "paragraph"
+}
+type ParagraphPatch = {
+    readonly type: PatchType.PARAGRAPH;
+    readonly children: readonly ParagraphChild[];
+};
+type FilePatch = {
+    readonly type: PatchType.DOCUMENT;
+    readonly children: readonly FileChild[];
+};
+export type IPatch = ParagraphPatch | FilePatch;
+export interface PatchDocumentOptions {
+    readonly patches: {
+        readonly [key: string]: IPatch;
+    };
+}
+export declare const patchDocument: (data: InputDataType, options: PatchDocumentOptions) => Promise<Buffer>;
+export {};

package/build/patcher/index.d.ts

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

package/build/patcher/paragraph-split-inject.d.ts

@@ -0,0 +1,6 @@
+import { Element } from "xml-js";
+export declare const findRunElementIndexWithToken: (paragraphElement: Element, token: string) => number;
+export declare const splitRunElement: (runElement: Element, token: string) => {
+    readonly left: Element;
+    readonly right: Element;
+};

package/build/patcher/paragraph-token-replacer.d.ts

@@ -0,0 +1,8 @@
+import { Element } from "xml-js";
+import { IRenderedParagraphNode } from "./run-renderer";
+export declare const replaceTokenInParagraphElement: ({ paragraphElement, renderedParagraph, originalText, replacementText, }: {
+    readonly paragraphElement: Element;
+    readonly renderedParagraph: IRenderedParagraphNode;
+    readonly originalText: string;
+    readonly replacementText: string;
+}) => Element;

package/build/patcher/relationship-manager.d.ts

@@ -0,0 +1,4 @@
+import { Element } from "xml-js";
+import { RelationshipType, TargetModeType } from "../file/relationships/relationship/relationship";
+export declare const getNextRelationshipIndex: (relationships: Element) => number;
+export declare const appendRelationship: (relationships: Element, id: number | string, type: RelationshipType, target: string, targetMode?: TargetModeType) => readonly Element[];

package/build/patcher/replacer.d.ts

@@ -0,0 +1,5 @@
+import { Element } from "xml-js";
+import { IContext } from "../file/xml-components";
+import { IPatch } from "./from-docx";
+import { IRenderedParagraphNode } from "./run-renderer";
+export declare const replacer: (json: Element, patch: IPatch, patchText: string, renderedParagraphs: readonly IRenderedParagraphNode[], context: IContext) => Element;

package/build/patcher/run-renderer.d.ts

@@ -0,0 +1,22 @@
+import { ElementWrapper } from "./traverser";
+export interface IRenderedParagraphNode {
+    readonly text: string;
+    readonly runs: readonly IRenderedRunNode[];
+    readonly index: number;
+    readonly path: readonly number[];
+}
+interface StartAndEnd {
+    readonly start: number;
+    readonly end: number;
+}
+type IParts = {
+    readonly text: string;
+    readonly index: number;
+} & StartAndEnd;
+export type IRenderedRunNode = {
+    readonly text: string;
+    readonly parts: readonly IParts[];
+    readonly index: number;
+} & StartAndEnd;
+export declare const renderParagraphNode: (node: ElementWrapper) => IRenderedParagraphNode;
+export {};

package/build/patcher/traverser.d.ts

@@ -0,0 +1,8 @@
+import { Element } from "xml-js";
+import { IRenderedParagraphNode } from "./run-renderer";
+export interface ElementWrapper {
+    readonly element: Element;
+    readonly index: number;
+    readonly parent: ElementWrapper | undefined;
+}
+export declare const findLocationOfText: (node: Element, text: string) => readonly IRenderedParagraphNode[];

package/build/patcher/util.d.ts

@@ -0,0 +1,5 @@
+import { Element } from "xml-js";
+export declare const toJson: (xmlData: string) => Element;
+export declare const createTextElementContents: (text: string) => Element[];
+export declare const patchSpaceAttribute: (element: Element) => Element;
+export declare const getFirstLevelElements: (relationships: Element, id: string) => Element[];

package/build/tests/utility.d.ts

@@ -1,3 +1,3 @@
-export declare class Utility {
-    static jsonify(obj: object): any;
-}
+export declare class Utility {
+    static jsonify(obj: object): any;
+}

package/build/util/convenience-functions.d.ts

@@ -1,4 +1,4 @@
-export declare const convertMillimetersToTwip: (millimeters: number) => number;
-export declare const convertInchesToTwip: (inches: number) => number;
-export declare const uniqueNumericId: () => number;
-export declare const uniqueId: () => string;
+export declare const convertMillimetersToTwip: (millimeters: number) => number;
+export declare const convertInchesToTwip: (inches: number) => number;
+export declare const uniqueNumericId: () => number;
+export declare const uniqueId: () => string;

package/build/util/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./convenience-functions";
-export * from "./values";
+export * from "./convenience-functions";
+export * from "./values";

package/build/util/values.d.ts

@@ -1,17 +1,20 @@
-export declare const decimalNumber: (val: number) => number;
-export declare const unsignedDecimalNumber: (val: number) => number;
-export declare const longHexNumber: (val: string) => string;
-export declare const shortHexNumber: (val: string) => string;
-export declare const uCharHexNumber: (val: string) => string;
-export declare const universalMeasureValue: (val: string) => string;
-export declare const positiveUniversalMeasureValue: (val: string) => string;
-export declare const hexColorValue: (val: string) => string;
-export declare const signedTwipsMeasureValue: (val: string | number) => string | number;
-export declare const hpsMeasureValue: (val: string | number) => string | number;
-export declare const signedHpsMeasureValue: (val: string | number) => string | number;
-export declare const twipsMeasureValue: (val: string | number) => string | number;
-export declare const percentageValue: (val: string) => string;
-export declare const measurementOrPercentValue: (val: number | string) => number | string;
-export declare const eighthPointMeasureValue: (val: number) => number;
-export declare const pointMeasureValue: (val: number) => number;
-export declare const dateTimeValue: (val: Date) => string;
+export type UniversalMeasure = `${"-" | ""}${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`;
+export type PositiveUniversalMeasure = `${number}${"mm" | "cm" | "in" | "pt" | "pc" | "pi"}`;
+export type Percentage = `${"-" | ""}${number}%`;
+export declare const decimalNumber: (val: number) => number;
+export declare const unsignedDecimalNumber: (val: number) => number;
+export declare const longHexNumber: (val: string) => string;
+export declare const shortHexNumber: (val: string) => string;
+export declare const uCharHexNumber: (val: string) => string;
+export declare const universalMeasureValue: (val: UniversalMeasure) => UniversalMeasure;
+export declare const positiveUniversalMeasureValue: (val: PositiveUniversalMeasure) => PositiveUniversalMeasure;
+export declare const hexColorValue: (val: string) => string;
+export declare const signedTwipsMeasureValue: (val: UniversalMeasure | number) => UniversalMeasure | number;
+export declare const hpsMeasureValue: (val: PositiveUniversalMeasure | number) => string | number;
+export declare const signedHpsMeasureValue: (val: UniversalMeasure | number) => string | number;
+export declare const twipsMeasureValue: (val: PositiveUniversalMeasure | number) => PositiveUniversalMeasure | number;
+export declare const percentageValue: (val: Percentage) => Percentage;
+export declare const measurementOrPercentValue: (val: number | Percentage | UniversalMeasure) => number | UniversalMeasure | Percentage;
+export declare const eighthPointMeasureValue: (val: number) => number;
+export declare const pointMeasureValue: (val: number) => number;
+export declare const dateTimeValue: (val: Date) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx",
-  "version": "7.8.2",
+  "version": "8.0.1",
   "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
   "main": "build/index.js",
   "scripts": {
@@ -28,9 +28,7 @@
     "lint"
   ],
   "files": [
-    "src",
-    "build",
-    "template"
+    "build"
   ],
   "repository": {
     "type": "git",
@@ -52,7 +50,7 @@
   "dependencies": {
     "@types/node": "^18.0.0",
     "jszip": "^3.1.5",
-    "nanoid": "^3.1.20",
+    "nanoid": "^3.3.4",
     "xml": "^1.0.1",
     "xml-js": "^1.6.8"
   },
@@ -61,14 +59,14 @@
   "bugs": {
     "url": "https://github.com/dolanmiu/docx/issues"
   },
-  "homepage": "https://github.com/dolanmiu/docx#readme",
+  "homepage": "https://docx.js.org",
   "devDependencies": {
     "@types/chai": "^4.2.15",
-    "@types/glob": "^8.0.0",
+    "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.0",
     "@types/prompt": "^1.1.1",
     "@types/request-promise": "^4.1.42",
-    "@types/shelljs": "^0.8.9",
+    "@types/shelljs": "^0.8.11",
     "@types/sinon": "^10.0.0",
     "@types/unzipper": "^0.10.4",
     "@types/webpack": "^5.0.0",
@@ -76,16 +74,17 @@
     "@typescript-eslint/parser": "^5.36.1",
     "buffer": "^6.0.3",
     "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
     "cspell": "^6.2.2",
     "docsify-cli": "^4.3.0",
     "eslint": "^8.23.0",
-    "eslint-plugin-functional": "^4.3.1",
+    "eslint-plugin-functional": "^5.0.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.6",
+    "eslint-plugin-jsdoc": "^40.0.0",
     "eslint-plugin-no-null": "^1.0.2",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-unicorn": "^45.0.0",
-    "glob": "^8.0.1",
+    "eslint-plugin-unicorn": "^46.0.0",
+    "glob": "^9.3.0",
     "jszip": "^3.1.5",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",
@@ -96,7 +95,7 @@
     "replace-in-file": "^6.2.0",
     "request": "^2.88.0",
     "request-promise": "^4.2.2",
-    "rimraf": "^3.0.2",
+    "rimraf": "^4.0.4",
     "shelljs": "^0.8.4",
     "sinon": "^15.0.0",
     "stream-browserify": "^3.0.0",
@@ -105,7 +104,7 @@
     "tsconfig-paths": "^4.0.0",
     "tsconfig-paths-webpack-plugin": "^4.0.0",
     "typedoc": "^0.23.2",
-    "typescript": "4.9.4",
+    "typescript": "5.0.2",
     "unzipper": "^0.10.11",
     "webpack": "^5.28.0",
     "webpack-cli": "^5.0.0"

package/build/file/file-properties.d.ts

@@ -1,5 +0,0 @@
-import { IDocumentTemplate } from "../import-dotx";
-export interface IFileProperties {
-    readonly template?: IDocumentTemplate;
-}
-export declare const WORKAROUND = "";

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

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

package/build/import-dotx/import-dotx.d.ts

@@ -1,23 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IDocumentFooter } from "../file/footer-wrapper";
-import { IDocumentHeader } from "../file/header-wrapper";
-import { Media } from "../file/media";
-export interface IDocumentTemplate {
-    readonly currentRelationshipId: number;
-    readonly headers: IDocumentHeader[];
-    readonly footers: IDocumentFooter[];
-    readonly styles: string;
-    readonly titlePageIsDefined: boolean;
-    readonly media: Media;
-}
-export declare class ImportDotx {
-    extract(data: Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream): Promise<IDocumentTemplate>;
-    private createFooters;
-    private createHeaders;
-    private addRelationshipToWrapper;
-    private findReferenceFiles;
-    private extractDocumentRefs;
-    private checkIfTitlePageIsDefined;
-    private parseRefId;
-}

package/build/import-dotx/index.d.ts

@@ -1 +0,0 @@
-export * from "./import-dotx";

package/src/export/formatter.spec.ts

@@ -1,118 +0,0 @@
-import { assert, expect } from "chai";
-import * as sinon from "sinon";
-
-import { Formatter } from "@export/formatter";
-import { CoreProperties } from "@file/core-properties";
-import { Paragraph, TextRun } from "@file/paragraph";
-import { Attributes } from "@file/xml-components";
-
-describe("Formatter", () => {
-    let formatter: Formatter;
-
-    beforeEach(() => {
-        formatter = new Formatter();
-    });
-
-    describe("#format()", () => {
-        it("should format simple paragraph", () => {
-            const paragraph = new Paragraph("");
-            const newJson = formatter.format(paragraph);
-            assert.isDefined(newJson["w:p"]);
-        });
-
-        it("should remove xmlKeys", () => {
-            const paragraph = new Paragraph("");
-            const newJson = formatter.format(paragraph);
-            const stringifiedJson = JSON.stringify(newJson);
-            assert(stringifiedJson.indexOf("xmlKeys") < 0);
-        });
-
-        it("should format simple paragraph with bold text", () => {
-            const paragraph = new Paragraph({
-                children: [
-                    new TextRun({
-                        text: "test",
-                        bold: true,
-                    }),
-                ],
-            });
-
-            const tree = formatter.format(paragraph);
-            expect(tree).to.deep.equal({
-                "w:p": [
-                    {
-                        "w:r": [
-                            {
-                                "w:rPr": [
-                                    {
-                                        "w:b": {},
-                                    },
-                                    {
-                                        "w:bCs": {},
-                                    },
-                                ],
-                            },
-                            {
-                                "w:t": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "test",
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-
-        it("should format attributes (rsidSect)", () => {
-            const attributes = new Attributes({
-                rsidSect: "test2",
-            });
-            const tree = formatter.format(attributes);
-            expect(tree).to.deep.equal({
-                _attr: {
-                    "w:rsidSect": "test2",
-                },
-            });
-        });
-
-        it("should format attributes (val)", () => {
-            const attributes = new Attributes({
-                val: "test",
-            });
-            const tree = formatter.format(attributes);
-            expect(tree).to.deep.equal({
-                _attr: {
-                    "w:val": "test",
-                },
-            });
-        });
-
-        it("should should change 'p' tag into 'w:p' tag", () => {
-            const paragraph = new Paragraph("");
-            const newJson = formatter.format(paragraph);
-            assert.isDefined(newJson["w:p"]);
-        });
-
-        it("should format Properties object correctly", () => {
-            const properties = new CoreProperties({
-                title: "test document",
-                creator: "Dolan",
-            });
-            const newJson = formatter.format(properties);
-            assert.isDefined(newJson["cp:coreProperties"]);
-        });
-
-        it("should call the prep method only once", () => {
-            const paragraph = new Paragraph("");
-            const spy = sinon.spy(paragraph, "prepForXml");
-
-            formatter.format(paragraph);
-            expect(spy.calledOnce).to.equal(true);
-        });
-    });
-});

package/src/export/formatter.ts

@@ -1,14 +0,0 @@
-import { BaseXmlComponent, IContext, IXmlableObject } from "@file/xml-components";
-
-export class Formatter {
-    // tslint:disable-next-line: no-object-literal-type-assertion
-    public format(input: BaseXmlComponent, context: IContext = {} as IContext): IXmlableObject {
-        const output = input.prepForXml(context);
-
-        if (output) {
-            return output;
-        } else {
-            throw Error("XMLComponent did not format correctly");
-        }
-    }
-}

package/src/export/index.ts

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

package/src/export/packer/image-replacer.spec.ts

@@ -1,61 +0,0 @@
-import { expect } from "chai";
-
-import { Media } from "@file/media";
-
-import { ImageReplacer } from "./image-replacer";
-
-describe("ImageReplacer", () => {
-    describe("#replace()", () => {
-        it("should replace properly", () => {
-            const imageReplacer = new ImageReplacer();
-            const result = imageReplacer.replace(
-                "test {test-image.png} test",
-                [
-                    {
-                        stream: Buffer.from(""),
-                        fileName: "test-image.png",
-                        transformation: {
-                            pixels: {
-                                x: 100,
-                                y: 100,
-                            },
-                            emus: {
-                                x: 100,
-                                y: 100,
-                            },
-                        },
-                    },
-                ],
-                0,
-            );
-
-            expect(result).to.equal("test 0 test");
-        });
-    });
-
-    describe("#getMediaData()", () => {
-        it("should get media data", () => {
-            const imageReplacer = new ImageReplacer();
-            const result = imageReplacer.getMediaData("test {test-image} test", {
-                Array: [
-                    {
-                        stream: Buffer.from(""),
-                        fileName: "test-image",
-                        dimensions: {
-                            pixels: {
-                                x: 100,
-                                y: 100,
-                            },
-                            emus: {
-                                x: 100,
-                                y: 100,
-                            },
-                        },
-                    },
-                ],
-            } as unknown as Media);
-
-            expect(result).to.have.length(1);
-        });
-    });
-});

package/src/export/packer/image-replacer.ts

@@ -1,17 +0,0 @@
-import { IMediaData, Media } from "@file/media";
-
-export class ImageReplacer {
-    public replace(xmlData: string, mediaData: readonly IMediaData[], offset: number): string {
-        let currentXmlData = xmlData;
-
-        mediaData.forEach((image, i) => {
-            currentXmlData = currentXmlData.replace(new RegExp(`{${image.fileName}}`, "g"), (offset + i).toString());
-        });
-
-        return currentXmlData;
-    }
-
-    public getMediaData(xmlData: string, media: Media): readonly IMediaData[] {
-        return media.Array.filter((image) => xmlData.search(`{${image.fileName}}`) > 0);
-    }
-}