docx 8.5.0 → 9.0.0

package/build/file/xml-components/base.d.ts

@@ -1,13 +0,0 @@
-import { IViewWrapper } from "../document-wrapper";
-import { File } from "../file";
-import { IXmlableObject } from "./xmlable-object";
-export interface IContext {
-    readonly file: File;
-    readonly viewWrapper: IViewWrapper;
-    readonly stack: IXmlableObject[];
-}
-export declare abstract class BaseXmlComponent {
-    protected readonly rootKey: string;
-    constructor(rootKey: string);
-    abstract prepForXml(context: IContext): IXmlableObject | undefined;
-}

package/build/file/xml-components/default-attributes.d.ts

@@ -1,25 +0,0 @@
-import { BaseXmlComponent, IContext } from "./base";
-import { IXmlableObject } from "./xmlable-object";
-export type AttributeMap<T> = {
-    readonly [P in keyof T]: string;
-};
-export type AttributeData = {
-    readonly [key: string]: boolean | number | string;
-};
-export type AttributePayload<T> = {
-    readonly [P in keyof T]: {
-        readonly key: string;
-        readonly value: T[P];
-    };
-};
-export declare abstract class XmlAttributeComponent<T extends object> extends BaseXmlComponent {
-    private readonly root;
-    protected readonly xmlKeys?: AttributeMap<T>;
-    constructor(root: T);
-    prepForXml(_: IContext): IXmlableObject;
-}
-export declare class NextAttributeComponent<T extends AttributeData> extends BaseXmlComponent {
-    private readonly root;
-    constructor(root: AttributePayload<T>);
-    prepForXml(_: IContext): IXmlableObject;
-}

package/build/file/xml-components/imported-xml-component.d.ts

@@ -1,14 +0,0 @@
-import { Element as XmlElement } from "xml-js";
-import { IXmlableObject, XmlComponent } from '.';
-import { IContext } from "./base";
-export declare const convertToXmlComponent: (element: XmlElement) => ImportedXmlComponent | string | undefined;
-export declare class ImportedXmlComponent extends XmlComponent {
-    static fromXmlString(importedContent: string): ImportedXmlComponent;
-    constructor(rootKey: string, _attr?: any);
-    push(xmlComponent: XmlComponent | string): void;
-}
-export declare class ImportedRootElementAttributes extends XmlComponent {
-    private readonly _attr;
-    constructor(_attr: any);
-    prepForXml(_: IContext): IXmlableObject;
-}

package/build/file/xml-components/imported-xml-component.spec.d.ts

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

package/build/file/xml-components/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./xml-component";
-export * from "./attributes";
-export * from "./default-attributes";
-export * from "./imported-xml-component";
-export * from "./xmlable-object";
-export * from "./initializable-xml-component";
-export * from "./simple-elements";
-export * from "./base";

package/build/file/xml-components/initializable-xml-component.d.ts

@@ -1,4 +0,0 @@
-import { XmlComponent } from '.';
-export declare abstract class InitializableXmlComponent extends XmlComponent {
-    constructor(rootKey: string, initComponent?: InitializableXmlComponent);
-}

package/build/file/xml-components/simple-elements.d.ts

@@ -1,30 +0,0 @@
-import { AttributeData, AttributePayload, XmlComponent } from '.';
-import { PositiveUniversalMeasure } from '../../util/values';
-export declare class OnOffElement extends XmlComponent {
-    constructor(name: string, val?: boolean | undefined);
-}
-export declare class HpsMeasureElement extends XmlComponent {
-    constructor(name: string, val: number | PositiveUniversalMeasure);
-}
-export declare class EmptyElement extends XmlComponent {
-}
-export declare class StringValueElement extends XmlComponent {
-    constructor(name: string, val: string);
-}
-export declare const createStringElement: (name: string, value: string) => XmlComponent;
-export declare class NumberValueElement extends XmlComponent {
-    constructor(name: string, val: number);
-}
-export declare class StringEnumValueElement<T extends string> extends XmlComponent {
-    constructor(name: string, val: T);
-}
-export declare class StringContainer extends XmlComponent {
-    constructor(name: string, val: string);
-}
-export declare class BuilderElement<T extends AttributeData> extends XmlComponent {
-    constructor({ name, attributes, children, }: {
-        readonly name: string;
-        readonly attributes?: AttributePayload<T>;
-        readonly children?: readonly XmlComponent[];
-    });
-}

package/build/file/xml-components/simple-elements.spec.d.ts

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

package/build/file/xml-components/xml-component.d.ts

@@ -1,12 +0,0 @@
-import { BaseXmlComponent, IContext } from "./base";
-import { IXmlableObject } from "./xmlable-object";
-export declare const EMPTY_OBJECT: {};
-export declare abstract class XmlComponent extends BaseXmlComponent {
-    protected root: (BaseXmlComponent | string | any)[];
-    constructor(rootKey: string);
-    prepForXml(context: IContext): IXmlableObject | undefined;
-    addChildElement(child: XmlComponent | string): XmlComponent;
-}
-export declare abstract class IgnoreIfEmptyXmlComponent extends XmlComponent {
-    prepForXml(context: IContext): IXmlableObject | undefined;
-}

package/build/file/xml-components/xml-component.spec.d.ts

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

package/build/file/xml-components/xmlable-object.d.ts

@@ -1,7 +0,0 @@
-export interface IXmlAttribute {
-    readonly [key: string]: string | number | boolean;
-}
-export interface IXmlableObject extends Record<string, unknown> {
-    readonly [key: string]: any;
-}
-export declare const WORKAROUND3 = "";

package/build/index.spec.d.ts

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

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

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

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

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

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

@@ -1,26 +0,0 @@
-/// <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 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 interface PatchDocumentOptions {
-    readonly patches: {
-        readonly [key: string]: IPatch;
-    };
-    readonly keepOriginalStyles?: boolean;
-}
-export declare const patchDocument: (data: InputDataType, options: PatchDocumentOptions) => Promise<Uint8Array>;
-export {};

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

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

package/build/patcher/index.d.ts

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

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

@@ -1,6 +0,0 @@
-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-split-inject.spec.d.ts

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

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

@@ -1,8 +0,0 @@
-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/paragraph-token-replacer.spec.d.ts

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

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

@@ -1,4 +0,0 @@
-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/build/patcher/relationship-manager.spec.d.ts

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

package/build/patcher/replacer.d.ts

@@ -1,5 +0,0 @@
-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, keepOriginalStyles?: boolean) => Element;

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

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

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

@@ -1,22 +0,0 @@
-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/run-renderer.spec.d.ts

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

package/build/patcher/traverser.d.ts

@@ -1,8 +0,0 @@
-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/traverser.spec.d.ts

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

package/build/patcher/util.d.ts

@@ -1,5 +0,0 @@
-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/patcher/util.spec.d.ts

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

package/build/tests/utility.d.ts

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

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

@@ -1,10 +0,0 @@
-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 uniqueUuid: () => string;

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

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

package/build/util/index.d.ts

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

package/build/util/values.d.ts

@@ -1,20 +0,0 @@
-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/build/util/values.spec.d.ts

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