docx 9.6.0 → 9.7.0

package/dist/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/dist/patcher/content-types-manager.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,32 @@
+import { default as JSZip } from 'jszip';
+import { FileChild } from '../file/file-child';
+import { ParagraphChild } from '../file/paragraph';
+import { OutputByType, OutputType } from '../util/output-type';
+export type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream | JSZip;
+export declare const PatchType: {
+    readonly DOCUMENT: "file";
+    readonly PARAGRAPH: "paragraph";
+};
+type ParagraphPatch = {
+    readonly type: typeof PatchType.PARAGRAPH;
+    readonly children: readonly ParagraphChild[];
+};
+type FilePatch = {
+    readonly type: typeof PatchType.DOCUMENT;
+    readonly children: readonly FileChild[];
+};
+export type IPatch = ParagraphPatch | FilePatch;
+export type PatchDocumentOutputType = OutputType;
+export type PatchDocumentOptions<T extends PatchDocumentOutputType = PatchDocumentOutputType> = {
+    readonly outputType: T;
+    readonly data: InputDataType;
+    readonly patches: Readonly<Record<string, IPatch>>;
+    readonly keepOriginalStyles?: boolean;
+    readonly placeholderDelimiters?: Readonly<{
+        readonly start: string;
+        readonly end: string;
+    }>;
+    readonly recursive?: boolean;
+};
+export declare const patchDocument: <T extends PatchDocumentOutputType = PatchDocumentOutputType>({ outputType, data, patches, keepOriginalStyles, placeholderDelimiters, recursive, }: PatchDocumentOptions<T>) => Promise<OutputByType[T]>;
+export {};

package/dist/patcher/from-docx.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/patcher/index.d.ts

@@ -0,0 +1,2 @@
+export * from './from-docx';
+export * from './patch-detector';

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

@@ -0,0 +1,9 @@
+import { Element } from 'xml-js';
+export declare class TokenNotFoundError extends Error {
+    constructor(token: string);
+}
+export declare const findRunElementIndexWithToken: (paragraphElement: Element, token: string) => number;
+export declare const splitRunElement: (runElement: Element, token: string) => {
+    readonly left: Element;
+    readonly right: Element;
+};

package/dist/patcher/paragraph-split-inject.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/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/dist/patcher/paragraph-token-replacer.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/patcher/patch-detector.d.ts

@@ -0,0 +1,6 @@
+import { InputDataType } from './from-docx';
+type PatchDetectorOptions = {
+    readonly data: InputDataType;
+};
+export declare const patchDetector: ({ data }: PatchDetectorOptions) => Promise<readonly string[]>;
+export {};

package/dist/patcher/patch-detector.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/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?: (typeof TargetModeType)[keyof typeof TargetModeType]) => readonly Element[];

package/dist/patcher/relationship-manager.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/patcher/replacer.d.ts

@@ -0,0 +1,15 @@
+import { Element } from 'xml-js';
+import { IContext } from '../file/xml-components';
+import { IPatch } from './from-docx';
+type IReplacerResult = {
+    readonly element: Element;
+    readonly didFindOccurrence: boolean;
+};
+export declare const replacer: ({ json, patch, patchText, context, keepOriginalStyles, }: {
+    readonly json: Element;
+    readonly patch: IPatch;
+    readonly patchText: string;
+    readonly context: IContext;
+    readonly keepOriginalStyles?: boolean;
+}) => IReplacerResult;
+export {};

package/dist/patcher/replacer.spec.d.ts

@@ -0,0 +1,84 @@
+export declare const MOCK_JSON: {
+    elements: {
+        type: string;
+        name: string;
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                "w14:paraId": string;
+                "w14:textId": string;
+                "w:rsidR": string;
+                "w:rsidRDefault": string;
+            };
+            elements: ({
+                type: string;
+                name: string;
+                elements: {
+                    type: string;
+                    name: string;
+                    attributes: {
+                        "w:val": string;
+                    };
+                }[];
+                attributes?: undefined;
+            } | {
+                type: string;
+                name: string;
+                elements: {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        text: string;
+                    }[];
+                }[];
+                attributes?: undefined;
+            } | {
+                type: string;
+                name: string;
+                attributes: {
+                    "w:rsidR": string;
+                };
+                elements: {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        text: string;
+                    }[];
+                }[];
+            })[];
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                elements: ({
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            "w:val": string;
+                        };
+                    }[];
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        text: string;
+                    }[];
+                } | {
+                    type: string;
+                    name: string;
+                    elements?: undefined;
+                })[];
+            }[];
+            attributes?: undefined;
+        })[];
+    }[];
+};

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

@@ -0,0 +1,22 @@
+import { ElementWrapper } from './traverser';
+export type IRenderedParagraphNode = {
+    readonly text: string;
+    readonly runs: readonly IRenderedRunNode[];
+    readonly index: number;
+    readonly pathToParagraph: readonly number[];
+};
+type 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/dist/patcher/run-renderer.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/patcher/traverser.d.ts

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

package/dist/patcher/traverser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/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/dist/patcher/util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/utility.d.ts

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

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

@@ -0,0 +1,12 @@
+export declare const convertMillimetersToTwip: (millimeters: number) => number;
+export declare const convertInchesToTwip: (inches: number) => number;
+export type UniqueNumericIdCreator = () => number;
+export declare const uniqueNumericIdCreator: (initial?: number) => UniqueNumericIdCreator;
+export declare const abstractNumUniqueNumericIdGen: () => UniqueNumericIdCreator;
+export declare const concreteNumUniqueNumericIdGen: () => UniqueNumericIdCreator;
+export declare const docPropertiesUniqueNumericIdGen: () => UniqueNumericIdCreator;
+export declare const bookmarkUniqueNumericIdGen: () => UniqueNumericIdCreator;
+export declare const uniqueId: () => string;
+export declare const hashedId: (data: Buffer | string | Uint8Array | ArrayBuffer) => string;
+export declare const uniqueUuid: () => string;
+export declare const encodeUtf8: (str: string) => Uint8Array;

package/dist/util/convenience-functions.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util/index.d.ts

@@ -0,0 +1,3 @@
+export * from './convenience-functions';
+export * from './values';
+export type * from './output-type';

package/dist/util/output-type.d.ts

@@ -0,0 +1,12 @@
+export type OutputByType = {
+    readonly base64: string;
+    readonly string: string;
+    readonly text: string;
+    readonly binarystring: string;
+    readonly array: readonly number[];
+    readonly uint8array: Uint8Array;
+    readonly arraybuffer: ArrayBuffer;
+    readonly blob: Blob;
+    readonly nodebuffer: Buffer;
+};
+export type OutputType = keyof OutputByType;

package/dist/util/types.d.ts

@@ -0,0 +1 @@
+export type InsetMode = "auto" | "custom";

package/dist/util/values.d.ts

@@ -0,0 +1,22 @@
+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 type PositivePercentage = `${number}%`;
+export type RelativeMeasure = `${"-" | ""}${number}${"em" | "ex"}`;
+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/dist/util/values.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "docx",
-    "version": "9.6.0",
+    "version": "9.7.0",
     "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
     "type": "module",
     "main": "dist/index.umd.cjs",
@@ -77,8 +77,8 @@
         "@types/xml": "^1.0.8",
         "@typescript-eslint/eslint-plugin": "^8.8.1",
         "@typescript-eslint/parser": "^8.8.1",
-        "@vitest/coverage-v8": "^4.0.18",
-        "@vitest/ui": "^4.0.18",
+        "@vitest/coverage-v8": "^4.1.7",
+        "@vitest/ui": "^4.1.7",
         "cspell": "^9.0.0",
         "docsify-cli": "^4.3.0",
         "eslint": "^9.13.0",
@@ -93,7 +93,7 @@
         "glob": "^13.0.3",
         "inquirer": "^13.2.2",
         "jiti": "^2.3.3",
-        "jsdom": "^28.0.0",
+        "jsdom": "^29.0.0",
         "pre-commit": "^1.2.2",
         "prettier": "^3.1.1",
         "tsconfig-paths": "^4.0.0",
@@ -102,11 +102,10 @@
         "typescript": "5.9.3",
         "typescript-eslint": "^8.10.0",
         "unzipper": "^0.12.3",
-        "vite": "^7.3.1",
-        "vite-plugin-dts": "^4.2.4",
-        "vite-plugin-node-polyfills": "^0.25.0",
-        "vite-tsconfig-paths": "^6.1.1",
-        "vitest": "^4.0.18"
+        "vite": "^8.0.0",
+        "vite-plugin-dts": "^5.0.1",
+        "vite-plugin-node-polyfills": "^0.28.0",
+        "vitest": "^4.1.7"
     },
     "engines": {
         "node": ">=10"