@alineco/docx 9.5.1 → 9.6.1

package/dist/index.d.cts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-
 import { default as default_2 } from 'jszip';
 import { Element as Element_2 } from 'xml-js';
 import { Stream } from 'stream';
@@ -11,18 +9,6 @@ export declare class AbstractNumbering extends XmlComponent {
 
 export declare const abstractNumUniqueNumericIdGen: () => UniqueNumericIdCreator;
 
-export declare class Alignment extends XmlComponent {
-    constructor(type: (typeof AlignmentType)[keyof typeof AlignmentType]);
-}
-
-export declare class AlignmentAttributes extends XmlAttributeComponent<{
-    readonly val: (typeof AlignmentType)[keyof typeof AlignmentType];
-}> {
-    protected readonly xmlKeys: {
-        val: string;
-    };
-}
-
 export declare const AlignmentType: {
     readonly START: "start";
     readonly CENTER: "center";
@@ -104,20 +90,12 @@ export declare class Attributes extends XmlAttributeComponent<{
     };
 }
 
-export declare abstract class BaseEmphasisMark extends XmlComponent {
-    protected constructor(emphasisMarkType: (typeof EmphasisMarkType)[keyof typeof EmphasisMarkType]);
-}
-
 export declare abstract class BaseXmlComponent {
     protected readonly rootKey: string;
     constructor(rootKey: string);
     abstract prepForXml(context: IContext): IXmlableObject | undefined;
 }
 
-declare class Begin extends XmlComponent {
-    constructor(dirty?: boolean);
-}
-
 declare class Body_2 extends XmlComponent {
     private readonly sections;
     constructor();
@@ -133,10 +111,7 @@ export declare class Bookmark {
     readonly start: BookmarkStart;
     readonly children: readonly ParagraphChild[];
     readonly end: BookmarkEnd;
-    constructor(options: {
-        readonly id: string;
-        readonly children: readonly ParagraphChild[];
-    });
+    constructor(options: IBookmarkOptions);
 }
 
 export declare class BookmarkEnd extends XmlComponent {
@@ -153,10 +128,6 @@ export declare class Border extends IgnoreIfEmptyXmlComponent {
     constructor(options: IBordersOptions);
 }
 
-export declare class BorderElement extends XmlComponent {
-    constructor(elementName: string, { color, size, space, style }: IBorderOptions);
-}
-
 export declare const BorderStyle: {
     readonly SINGLE: "single";
     readonly DASH_DOT_STROKED: "dashDotStroked";
@@ -187,10 +158,6 @@ export declare const BorderStyle: {
     readonly WAVE: "wave";
 };
 
-declare class Break extends XmlComponent {
-    constructor();
-}
-
 export declare class BuilderElement<T extends AttributeData = {}> extends XmlComponent {
     constructor({ name, attributes, children, }: {
         readonly name: string;
@@ -263,22 +230,22 @@ export declare class CheckBoxUtil extends XmlComponent {
 }
 
 export declare class Column extends XmlComponent {
-    constructor({ width, space }: IColumnAttributes);
+    constructor(options: IColumnAttributes);
 }
 
 export declare class ColumnBreak extends Run {
     constructor();
 }
 
-export declare class Columns extends XmlComponent {
-    constructor({ space, count, separate, equalWidth, children }: IColumnsAttributes);
-}
-
 declare class Comment_2 extends XmlComponent {
-    constructor({ id, initials, author, date, children }: ICommentOptions);
+    private readonly paraId?;
+    constructor({ id, initials, author, date, children }: ICommentOptions, paraId?: string);
+    prepForXml(context: IContext): IXmlableObject | undefined;
 }
 export { Comment_2 as Comment }
 
+export declare const commentIdToParaId: (id: number) => string;
+
 export declare class CommentRangeEnd extends XmlComponent {
     constructor(id: number);
 }
@@ -293,8 +260,14 @@ export declare class CommentReference extends XmlComponent {
 
 export declare class Comments extends XmlComponent {
     private readonly relationships;
+    private readonly threadData?;
     constructor({ children }: ICommentsOptions);
     get Relationships(): Relationships;
+    get ThreadData(): readonly ICommentThreadData[] | undefined;
+}
+
+export declare class CommentsExtended extends XmlComponent {
+    constructor(threadData: readonly ICommentThreadData[]);
 }
 
 declare const CompoundLine: {
@@ -321,6 +294,7 @@ export declare const concreteNumUniqueNumericIdGen: () => UniqueNumericIdCreator
 
 declare class ContentTypes extends XmlComponent {
     constructor();
+    addCommentsExtended(): void;
     addFooter(index: number): void;
     addHeader(index: number): void;
 }
@@ -335,11 +309,19 @@ export declare const convertMillimetersToTwip: (millimeters: number) => number;
 
 export declare const convertToXmlComponent: (element: Element_2) => ImportedXmlComponent | string | undefined;
 
+declare type CoreGroupOptions = {
+    readonly children: readonly IGroupChildMediaData[];
+    readonly transformation: IMediaTransformation;
+    readonly floating?: IFloating;
+    readonly altText?: DocPropertiesOptions;
+};
+
 declare type CoreImageOptions = {
     readonly transformation: IMediaTransformation;
     readonly floating?: IFloating;
     readonly altText?: DocPropertiesOptions;
     readonly outline?: OutlineOptions;
+    readonly solidFill?: SolidFillOptions;
 };
 
 declare type CoreMediaData = {
@@ -352,12 +334,36 @@ declare class CoreProperties extends XmlComponent {
     constructor(options: Omit<IPropertiesOptions, "sections">);
 }
 
+declare type CoreShapeOptions = {
+    readonly transformation: IMediaTransformation;
+    readonly floating?: IFloating;
+    readonly altText?: DocPropertiesOptions;
+    readonly outline?: OutlineOptions;
+    readonly solidFill?: SolidFillOptions;
+};
+
+export declare const createAlignment: (type: (typeof AlignmentType)[keyof typeof AlignmentType]) => XmlComponent;
+
+export declare const createBodyProperties: (options?: IBodyPropertiesOptions) => XmlComponent;
+
+export declare const createBorderElement: (elementName: string, { color, size, space, style }: IBorderOptions) => XmlComponent;
+
+export declare const createColumns: ({ space, count, separate, equalWidth, children }: IColumnsAttributes) => XmlComponent;
+
 export declare const createDocumentGrid: ({ type, linePitch, charSpace }: IDocGridAttributesProperties) => XmlComponent;
 
+export declare const createDotEmphasisMark: () => XmlComponent;
+
+export declare const createEmphasisMark: (emphasisMarkType?: (typeof EmphasisMarkType)[keyof typeof EmphasisMarkType]) => XmlComponent;
+
 export declare const createFrameProperties: (options: IFrameOptions) => XmlComponent;
 
+export declare const createHeaderFooterReference: (type: (typeof HeaderFooterType)[keyof typeof HeaderFooterType], options: IHeaderFooterOptions) => XmlComponent;
+
 export declare const createHorizontalPosition: ({ relative, align, offset }: IHorizontalPositionOptions) => XmlComponent;
 
+export declare const createIndent: ({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) => XmlComponent;
+
 export declare const createLineNumberType: ({ countBy, start, restart, distance }: ILineNumberAttributes) => XmlComponent;
 
 export declare const createMathAccentCharacter: ({ accent }: MathAccentCharacterOptions) => XmlComponent;
@@ -380,14 +386,58 @@ export declare const createMathSuperScriptElement: ({ children }: MathSuperScrip
 
 export declare const createMathSuperScriptProperties: () => XmlComponent;
 
+export declare const createOutlineLevel: (level: number) => XmlComponent;
+
+export declare const createPageMargin: (top: number | UniversalMeasure, right: number | PositiveUniversalMeasure, bottom: number | UniversalMeasure, left: number | PositiveUniversalMeasure, header: number | PositiveUniversalMeasure, footer: number | PositiveUniversalMeasure, gutter: number | PositiveUniversalMeasure) => XmlComponent;
+
+export declare const createPageNumberType: ({ start, formatType, separator }: IPageNumberTypeAttributes) => XmlComponent;
+
 export declare const createPageSize: ({ width, height, orientation, code }: IPageSizeAttributes) => XmlComponent;
 
+export declare const createParagraphStyle: (styleId: string) => XmlComponent;
+
+export declare const createRunFonts: (nameOrAttrs: string | IFontAttributesProperties, hint?: string) => XmlComponent;
+
+export declare const createSectionType: (value: (typeof SectionType)[keyof typeof SectionType]) => XmlComponent;
+
+export declare const createShading: ({ fill, color, type }: IShadingAttributesProperties) => XmlComponent;
+
 export declare const createSimplePos: () => XmlComponent;
 
+export declare const createSpacing: ({ after, before, line, lineRule, beforeAutoSpacing, afterAutoSpacing }: ISpacingProperties) => XmlComponent;
+
 export declare const createStringElement: (name: string, value: string) => XmlComponent;
 
+export declare const createTableFloatProperties: ({ horizontalAnchor, verticalAnchor, absoluteHorizontalPosition, relativeHorizontalPosition, absoluteVerticalPosition, relativeVerticalPosition, bottomFromText, topFromText, leftFromText, rightFromText, overlap, }: ITableFloatOptions) => XmlComponent;
+
+export declare const createTableLayout: (type: (typeof TableLayoutType)[keyof typeof TableLayoutType]) => XmlComponent;
+
+export declare const createTableLook: ({ firstRow, lastRow, firstColumn, lastColumn, noHBand, noVBand }: ITableLookOptions) => XmlComponent;
+
+export declare const createTableRowHeight: (value: number | PositiveUniversalMeasure, rule: (typeof HeightRule)[keyof typeof HeightRule]) => XmlComponent;
+
+export declare const createTableWidthElement: (name: string, { type, size }: ITableWidthProperties) => XmlComponent;
+
+export declare const createTabStop: (tabDefinitions: readonly TabStopDefinition[]) => XmlComponent;
+
+export declare const createTabStopItem: ({ type, position, leader }: TabStopDefinition) => XmlComponent;
+
+export declare const createTransformation: (options: IMediaTransformation) => IMediaDataTransformation;
+
+export declare const createUnderline: (underlineType?: (typeof UnderlineType)[keyof typeof UnderlineType], color?: string) => XmlComponent;
+
+export declare const createVerticalAlign: (value: (typeof VerticalAlign)[keyof typeof VerticalAlign]) => XmlComponent;
+
 export declare const createVerticalPosition: ({ relative, align, offset }: IVerticalPositionOptions) => XmlComponent;
 
+export declare const createWrapNone: () => XmlComponent;
+
+export declare const createWrapSquare: (textWrapping: ITextWrapping, margins?: IMargins) => XmlComponent;
+
+export declare const createWrapTight: (margins?: IMargins) => XmlComponent;
+
+export declare const createWrapTopAndBottom: (margins?: IMargins) => XmlComponent;
+
 declare class CustomProperties extends XmlComponent {
     private nextId;
     private readonly properties;
@@ -429,6 +479,7 @@ declare type DocPropertiesOptions = {
     readonly name: string;
     readonly description?: string;
     readonly title?: string;
+    readonly id?: string;
 };
 
 export declare const docPropertiesUniqueNumericIdGen: () => UniqueNumericIdCreator;
@@ -526,12 +577,8 @@ declare class DocumentWrapper implements IViewWrapper {
     get Relationships(): Relationships;
 }
 
-export declare class DotEmphasisMark extends BaseEmphasisMark {
-    constructor();
-}
-
 export declare class Drawing extends XmlComponent {
-    constructor(imageData: IMediaData, drawingOptions?: IDrawingOptions);
+    constructor(imageData: IExtendedMediaData, drawingOptions?: IDrawingOptions);
 }
 
 export declare const DropCapType: {
@@ -542,10 +589,6 @@ export declare const DropCapType: {
 
 export declare const eighthPointMeasureValue: (val: number) => number;
 
-export declare class EmphasisMark extends BaseEmphasisMark {
-    constructor(emphasisMarkType?: (typeof EmphasisMarkType)[keyof typeof EmphasisMarkType]);
-}
-
 export declare const EmphasisMarkType: {
     readonly DOT: "dot";
 };
@@ -555,23 +598,44 @@ export declare const EMPTY_OBJECT: {};
 export declare class EmptyElement extends XmlComponent {
 }
 
-declare class End extends XmlComponent {
-    constructor(dirty?: boolean);
+export declare const encodeUtf8: (str: string) => Uint8Array;
+
+export declare class EndnoteIdReference extends XmlComponent {
+    constructor(id: number);
 }
 
 export declare class EndnoteReference extends EmptyElement {
     constructor();
 }
 
-export declare class ExternalHyperlink extends XmlComponent {
-    readonly options: {
-        readonly children: readonly ParagraphChild[];
-        readonly link: string;
+export declare class EndnoteReferenceRun extends Run {
+    constructor(id: number);
+}
+
+export declare class EndnoteReferenceRunAttributes extends XmlAttributeComponent<{
+    readonly id: number;
+}> {
+    protected readonly xmlKeys: {
+        id: string;
     };
-    constructor(options: {
-        readonly children: readonly ParagraphChild[];
-        readonly link: string;
-    });
+}
+
+export declare class Endnotes extends XmlComponent {
+    constructor();
+    createEndnote(id: number, paragraph: readonly Paragraph[]): void;
+}
+
+declare class EndnotesWrapper implements IViewWrapper {
+    private readonly endnotes;
+    private readonly relationships;
+    constructor();
+    get View(): Endnotes;
+    get Relationships(): Relationships;
+}
+
+export declare class ExternalHyperlink extends XmlComponent {
+    readonly options: IExternalHyperlinkOptions;
+    constructor(options: IExternalHyperlinkOptions);
 }
 
 declare class FieldInstruction extends XmlComponent {
@@ -589,12 +653,14 @@ declare class File_2 {
     private readonly media;
     private readonly fileRelationships;
     private readonly footnotesWrapper;
+    private readonly endnotesWrapper;
     private readonly settings;
     private readonly contentTypes;
     private readonly customProperties;
     private readonly appProperties;
     private readonly styles;
     private readonly comments;
+    private readonly commentsExtended?;
     private readonly fontWrapper;
     constructor(options: IPropertiesOptions);
     private addSection;
@@ -615,8 +681,10 @@ declare class File_2 {
     get CustomProperties(): CustomProperties;
     get AppProperties(): AppProperties;
     get FootNotes(): FootnotesWrapper;
+    get Endnotes(): EndnotesWrapper;
     get Settings(): Settings;
     get Comments(): Comments;
+    get CommentsExtended(): CommentsExtended | undefined;
     get FontTable(): FontWrapper;
 }
 export { File_2 as Document }
@@ -741,10 +809,6 @@ declare class Header_2 extends InitializableXmlComponent {
     add(item: Paragraph | Table): void;
 }
 
-export declare class HeaderFooterReference extends XmlComponent {
-    constructor(type: (typeof HeaderFooterType)[keyof typeof HeaderFooterType], options: IHeaderFooterOptions);
-}
-
 export declare const HeaderFooterReferenceType: {
     readonly DEFAULT: "default";
     readonly FIRST: "first";
@@ -871,6 +935,23 @@ export declare type IBaseParagraphStyleOptions = {
     readonly run?: IRunStylePropertiesOptions;
 } & IStyleOptions;
 
+export declare type IBodyPropertiesOptions = {
+    readonly wrap?: (typeof TextWrappingType)[keyof typeof TextWrappingType];
+    readonly verticalAnchor?: VerticalAnchor;
+    readonly margins?: {
+        readonly top?: number;
+        readonly bottom?: number;
+        readonly left?: number;
+        readonly right?: number;
+    };
+    readonly noAutoFit?: boolean;
+};
+
+export declare type IBookmarkOptions = {
+    readonly id: string;
+    readonly children: readonly ParagraphChild[];
+};
+
 export declare type IBorderOptions = {
     readonly style: (typeof BorderStyle)[keyof typeof BorderStyle];
     readonly color?: string;
@@ -886,10 +967,7 @@ export declare type IBordersOptions = {
     readonly between?: IBorderOptions;
 };
 
-export declare type ICellMergeAttributes = {
-    readonly id: number;
-    readonly author: string;
-    readonly date: string;
+export declare type ICellMergeAttributes = IChangedAttributesProperties & {
     readonly verticalMerge?: (typeof VerticalMergeRevisionType)[keyof typeof VerticalMergeRevisionType];
     readonly verticalMergeOriginal?: (typeof VerticalMergeRevisionType)[keyof typeof VerticalMergeRevisionType];
 };
@@ -916,7 +994,7 @@ export declare type ICheckboxSymbolProperties = {
     readonly font?: string;
 };
 
-declare type IColumnAttributes = {
+export declare type IColumnAttributes = {
     readonly width: number | PositiveUniversalMeasure;
     readonly space?: number | PositiveUniversalMeasure;
 };
@@ -935,12 +1013,20 @@ export declare type ICommentOptions = {
     readonly initials?: string;
     readonly author?: string;
     readonly date?: Date;
+    readonly parentId?: number;
+    readonly resolved?: boolean;
 };
 
 export declare type ICommentsOptions = {
     readonly children: readonly ICommentOptions[];
 };
 
+export declare type ICommentThreadData = {
+    readonly paraId: string;
+    readonly parentParaId?: string;
+    readonly done?: boolean;
+};
+
 declare type ICompatibilityOptions = {
     readonly version?: number;
     readonly useSingleBorderforContiguousCells?: boolean;
@@ -1044,6 +1130,9 @@ declare type IDefaultStylesOptions = {
     readonly footnoteReference?: IBaseCharacterStyleOptions;
     readonly footnoteText?: IBaseParagraphStyleOptions;
     readonly footnoteTextChar?: IBaseCharacterStyleOptions;
+    readonly endnoteReference?: IBaseCharacterStyleOptions;
+    readonly endnoteText?: IBaseParagraphStyleOptions;
+    readonly endnoteTextChar?: IBaseCharacterStyleOptions;
 };
 
 declare type IDeletedRunOptions = IRunOptions & IChangedAttributesProperties;
@@ -1095,6 +1184,14 @@ export declare type IDrawingOptions = {
     readonly floating?: IFloating;
     readonly docProperties?: DocPropertiesOptions;
     readonly outline?: OutlineOptions;
+    readonly solidFill?: SolidFillOptions;
+};
+
+export declare type IExtendedMediaData = IMediaData | WpsMediaData | WpgMediaData;
+
+export declare type IExternalHyperlinkOptions = {
+    readonly children: readonly ParagraphChild[];
+    readonly link: string;
 };
 
 export declare type IFloating = {
@@ -1130,6 +1227,8 @@ export declare abstract class IgnoreIfEmptyXmlComponent extends XmlComponent {
     prepForXml(context: IContext): IXmlableObject | undefined;
 }
 
+export declare type IGroupChildMediaData = (WpsMediaData | IMediaData) & WpgCommonMediaData;
+
 export declare type IHeaderFooterGroup<T> = {
     readonly default?: T;
     readonly first?: T;
@@ -1171,6 +1270,11 @@ export declare type IIndentAttributesProperties = {
 
 declare type IInsertedRunOptions = IChangedAttributesProperties & IRunOptions;
 
+export declare type IInternalHyperlinkOptions = {
+    readonly children: readonly ParagraphChild[];
+    readonly anchor: string;
+};
+
 declare type ILanguageOptions = {
     readonly value?: string;
     readonly eastAsia?: string;
@@ -1290,6 +1394,16 @@ export declare type IMathSuperScriptOptions = {
 export declare type IMediaData = (RegularMediaData | SvgMediaData) & CoreMediaData;
 
 export declare type IMediaDataTransformation = {
+    readonly offset?: {
+        readonly pixels: {
+            readonly x: number;
+            readonly y: number;
+        };
+        readonly emus?: {
+            readonly x: number;
+            readonly y: number;
+        };
+    };
     readonly pixels: {
         readonly x: number;
         readonly y: number;
@@ -1306,6 +1420,10 @@ export declare type IMediaDataTransformation = {
 };
 
 export declare type IMediaTransformation = {
+    readonly offset?: {
+        readonly top?: number;
+        readonly left?: number;
+    };
     readonly width: number;
     readonly height: number;
     readonly flip?: {
@@ -1327,14 +1445,14 @@ export declare class ImportedXmlComponent extends XmlComponent {
     push(xmlComponent: XmlComponent | string): void;
 }
 
-export declare class Indent extends XmlComponent {
-    constructor({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties);
-}
-
 export declare abstract class InitializableXmlComponent extends XmlComponent {
     constructor(rootKey: string, initComponent?: InitializableXmlComponent);
 }
 
+declare type INonVisualShapePropertiesOptions = {
+    readonly txBox: string;
+};
+
 export declare type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream | default_2;
 
 export declare class InsertedTableCell extends XmlComponent {
@@ -1350,10 +1468,7 @@ export declare class InsertedTextRun extends XmlComponent {
 }
 
 export declare class InternalHyperlink extends ConcreteHyperlink {
-    constructor(options: {
-        readonly children: readonly ParagraphChild[];
-        readonly anchor: string;
-    });
+    constructor(options: IInternalHyperlinkOptions);
 }
 
 export declare type INumberedItemReferenceOptions = {
@@ -1486,6 +1601,9 @@ export declare type IPropertiesOptions = {
     readonly footnotes?: Readonly<Record<string, {
         readonly children: readonly Paragraph[];
     }>>;
+    readonly endnotes?: Readonly<Record<string, {
+        readonly children: readonly Paragraph[];
+    }>>;
     readonly background?: IDocumentBackgroundOptions;
     readonly features?: {
         readonly trackRevisions?: boolean;
@@ -1503,7 +1621,7 @@ export declare type IPropertiesOptions = {
 export declare type IRunOptions = IRunOptionsBase & IRunPropertiesOptions;
 
 declare type IRunOptionsBase = {
-    readonly children?: readonly (Begin | FieldInstruction | Separate | End | (typeof PageNumber)[keyof typeof PageNumber] | FootnoteReferenceRun | Break | AnnotationReference | CarriageReturn | ContinuationSeparator | DayLong | DayShort | EndnoteReference | FootnoteReferenceElement | LastRenderedPageBreak | MonthLong | MonthShort | NoBreakHyphen | PageNumberElement | Separator | SoftHyphen | Tab | YearLong | YearShort | PositionalTab | string)[];
+    readonly children?: readonly (FieldInstruction | (typeof PageNumber)[keyof typeof PageNumber] | FootnoteReferenceRun | AnnotationReference | CarriageReturn | ContinuationSeparator | DayLong | DayShort | EndnoteReference | FootnoteReferenceElement | LastRenderedPageBreak | MonthLong | MonthShort | NoBreakHyphen | PageNumberElement | Separator | SoftHyphen | Tab | YearLong | YearShort | XmlComponent | string)[];
     readonly break?: number;
     readonly text?: string;
 };
@@ -1728,6 +1846,15 @@ declare type ITableGridChangeOptions = {
     readonly columnWidths: readonly number[] | readonly PositiveUniversalMeasure[];
 };
 
+export declare type ITableLookOptions = {
+    readonly firstRow?: boolean;
+    readonly lastRow?: boolean;
+    readonly firstColumn?: boolean;
+    readonly lastColumn?: boolean;
+    readonly noHBand?: boolean;
+    readonly noVBand?: boolean;
+};
+
 export declare type ITableOfContentsOptions = {
     readonly captionLabel?: string;
     readonly entriesFromBookmark?: string;
@@ -1760,6 +1887,7 @@ export declare type ITableOptions = {
     readonly borders?: ITableBordersOptions;
     readonly alignment?: (typeof AlignmentType)[keyof typeof AlignmentType];
     readonly visuallyRightToLeft?: boolean;
+    readonly tableLook?: ITableLookOptions;
     readonly cellSpacing?: ITableCellSpacingProperties;
     readonly revision?: ITablePropertiesChangeOptions;
 };
@@ -1782,6 +1910,7 @@ export declare type ITablePropertiesOptionsBase = {
     readonly alignment?: (typeof AlignmentType)[keyof typeof AlignmentType];
     readonly cellMargin?: ITableCellMarginOptions;
     readonly visuallyRightToLeft?: boolean;
+    readonly tableLook?: ITableLookOptions;
     readonly cellSpacing?: ITableCellSpacingProperties;
 };
 
@@ -1830,10 +1959,18 @@ export declare type IVerticalPositionOptions = {
 };
 
 declare type IViewWrapper = {
-    readonly View: Document_2 | Footer_2 | Header_2 | FootNotes | XmlComponent;
+    readonly View: Document_2 | Footer_2 | Header_2 | FootNotes | Endnotes | XmlComponent;
     readonly Relationships: Relationships;
 };
 
+export declare type IWpgGroupOptions = {
+    readonly type: "wpg";
+} & CoreGroupOptions;
+
+export declare type IWpsShapeOptions = WpsShapeCoreOptions & {
+    readonly type: "wps";
+} & CoreShapeOptions;
+
 export declare interface IXmlableObject extends Record<string, unknown> {
     readonly [key: string]: any;
 }
@@ -2249,11 +2386,6 @@ declare type OutlineAttributes = {
 
 declare type OutlineFillProperties = OutlineNoFill | OutlineSolidFill;
 
-export declare class OutlineLevel extends XmlComponent {
-    readonly level: number;
-    constructor(level: number);
-}
-
 declare type OutlineNoFill = {
     readonly type: "noFill";
 };
@@ -2332,10 +2464,6 @@ export declare class PageBreakBefore extends XmlComponent {
     constructor();
 }
 
-export declare class PageMargin extends XmlComponent {
-    constructor(top: number | UniversalMeasure, right: number | PositiveUniversalMeasure, bottom: number | UniversalMeasure, left: number | PositiveUniversalMeasure, header: number | PositiveUniversalMeasure, footer: number | PositiveUniversalMeasure, gutter: number | PositiveUniversalMeasure);
-}
-
 export declare const PageNumber: {
     readonly CURRENT: "CURRENT";
     readonly TOTAL_PAGES: "TOTAL_PAGES";
@@ -2355,18 +2483,6 @@ export declare const PageNumberSeparator: {
     readonly EN_DASH: "endash";
 };
 
-export declare class PageNumberType extends XmlComponent {
-    constructor({ start, formatType, separator }: IPageNumberTypeAttributes);
-}
-
-export declare class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
-    protected readonly xmlKeys: {
-        start: string;
-        formatType: string;
-        separator: string;
-    };
-}
-
 export declare const PageOrientation: {
     readonly PORTRAIT: "portrait";
     readonly LANDSCAPE: "landscape";
@@ -2424,7 +2540,7 @@ declare type PatchDetectorOptions = {
     readonly data: InputDataType;
 };
 
-export declare const patchDocument: <T extends keyof OutputByType = keyof OutputByType>({ outputType, data, patches, keepOriginalStyles, placeholderDelimiters, recursive, }: PatchDocumentOptions<T>) => Promise<OutputByType[T]>;
+export declare const patchDocument: <T extends PatchDocumentOutputType = PatchDocumentOutputType>({ outputType, data, patches, keepOriginalStyles, placeholderDelimiters, recursive, }: PatchDocumentOptions<T>) => Promise<OutputByType[T]>;
 
 export declare type PatchDocumentOptions<T extends PatchDocumentOutputType = PatchDocumentOutputType> = {
     readonly outputType: T;
@@ -2507,17 +2623,13 @@ declare type RegularMediaData = {
     readonly type: "jpg" | "png" | "gif" | "bmp";
 };
 
-declare class Relationship extends XmlComponent {
-    constructor(id: string, type: RelationshipType, target: string, targetMode?: (typeof TargetModeType)[keyof typeof TargetModeType]);
-}
-
 declare class Relationships extends XmlComponent {
     constructor();
-    createRelationship(id: number | string, type: RelationshipType, target: string, targetMode?: (typeof TargetModeType)[keyof typeof TargetModeType]): Relationship;
+    addRelationship(id: number | string, type: RelationshipType, target: string, targetMode?: (typeof TargetModeType)[keyof typeof TargetModeType]): void;
     get RelationshipCount(): number;
 }
 
-declare type RelationshipType = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font";
+declare type RelationshipType = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/endnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments" | "http://schemas.microsoft.com/office/2011/relationships/commentsExtended" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font";
 
 export declare const RelativeHorizontalPosition: {
     readonly CENTER: "center";
@@ -2538,16 +2650,16 @@ export declare const RelativeVerticalPosition: {
     readonly TOP: "top";
 };
 
+declare type RgbColorOptions = {
+    readonly type: "rgb";
+    readonly value: string;
+};
+
 export declare class Run extends XmlComponent {
     protected readonly properties: RunProperties;
     constructor(options: IRunOptions);
 }
 
-export declare class RunFonts extends XmlComponent {
-    constructor(name: string, hint?: string);
-    constructor(attrs: string | IFontAttributesProperties);
-}
-
 export declare class RunProperties extends IgnoreIfEmptyXmlComponent {
     constructor(options?: IRunPropertiesOptions);
     push(item: XmlComponent): void;
@@ -2581,6 +2693,11 @@ declare const SchemeColor: {
     readonly PHCLR: "phClr";
 };
 
+declare type SchemeColorOptions = {
+    readonly type: "scheme";
+    readonly value: (typeof SchemeColor)[keyof typeof SchemeColor];
+};
+
 export declare const sectionMarginDefaults: {
     TOP: number;
     RIGHT: number;
@@ -2614,20 +2731,8 @@ export declare const SectionType: {
     readonly ODD_PAGE: "oddPage";
 };
 
-export declare class SectionTypeAttributes extends XmlAttributeComponent<{
-    readonly val: (typeof SectionType)[keyof typeof SectionType];
-}> {
-    protected readonly xmlKeys: {
-        val: string;
-    };
-}
-
 export declare type SectionVerticalAlign = (typeof VerticalAlignSection)[keyof typeof VerticalAlignSection];
 
-declare class Separate extends XmlComponent {
-    constructor(dirty?: boolean);
-}
-
 export declare class Separator extends EmptyElement {
     constructor();
 }
@@ -2640,10 +2745,6 @@ declare class Settings extends XmlComponent {
     constructor(options: ISettingsOptions);
 }
 
-export declare class Shading extends XmlComponent {
-    constructor({ fill, color, type }: IShadingAttributesProperties);
-}
-
 export declare const ShadingType: {
     readonly CLEAR: "clear";
     readonly DIAGONAL_CROSS: "diagCross";
@@ -2702,14 +2803,14 @@ export declare class SoftHyphen extends EmptyElement {
     constructor();
 }
 
+declare type SolidFillOptions = RgbColorOptions | SchemeColorOptions;
+
 export declare const SpaceType: {
     readonly DEFAULT: "default";
     readonly PRESERVE: "preserve";
 };
 
-export declare class Spacing extends XmlComponent {
-    constructor(options: ISpacingProperties);
-}
+export declare const standardizeData: (data: string | Buffer | Uint8Array | ArrayBuffer) => Buffer | Uint8Array | ArrayBuffer;
 
 export declare class StringContainer extends XmlComponent {
     constructor(name: string, val: string);
@@ -2723,20 +2824,16 @@ export declare class StringValueElement extends XmlComponent {
     constructor(name: string, val: string);
 }
 
-export declare class Style extends XmlComponent {
-    constructor(styleId: string);
-}
-
-declare class Style_2 extends XmlComponent {
+declare class Style extends XmlComponent {
     constructor(attributes: IStyleAttributes, options: IStyleOptions);
 }
 
-export declare class StyleForCharacter extends Style_2 {
+export declare class StyleForCharacter extends Style {
     private readonly runProperties;
     constructor(options: ICharacterStyleOptions);
 }
 
-export declare class StyleForParagraph extends Style_2 {
+export declare class StyleForParagraph extends Style {
     private readonly paragraphProperties;
     private readonly runProperties;
     constructor(options: IParagraphStyleOptions);
@@ -2771,20 +2868,8 @@ export declare class Tab extends EmptyElement {
     constructor();
 }
 
-export declare class TabAttributes extends XmlAttributeComponent<{
-    readonly val: (typeof TabStopType)[keyof typeof TabStopType];
-    readonly pos: string | number;
-    readonly leader?: (typeof LeaderType)[keyof typeof LeaderType];
-}> {
-    protected readonly xmlKeys: {
-        val: string;
-        pos: string;
-        leader: string;
-    };
-}
-
 export declare class Table extends FileChild {
-    constructor({ rows, width, columnWidths, columnWidthsRevision, margins, indent, float, layout, style, borders, alignment, visuallyRightToLeft, cellSpacing, revision, }: ITableOptions);
+    constructor({ rows, width, columnWidths, columnWidthsRevision, margins, indent, float, layout, style, borders, alignment, visuallyRightToLeft, tableLook, cellSpacing, revision, }: ITableOptions);
 }
 
 export declare const TableAnchorType: {
@@ -2794,38 +2879,7 @@ export declare const TableAnchorType: {
 };
 
 export declare class TableBorders extends XmlComponent {
-    static readonly NONE: {
-        top: {
-            style: "none";
-            size: number;
-            color: string;
-        };
-        bottom: {
-            style: "none";
-            size: number;
-            color: string;
-        };
-        left: {
-            style: "none";
-            size: number;
-            color: string;
-        };
-        right: {
-            style: "none";
-            size: number;
-            color: string;
-        };
-        insideHorizontal: {
-            style: "none";
-            size: number;
-            color: string;
-        };
-        insideVertical: {
-            style: "none";
-            size: number;
-            color: string;
-        };
-    };
+    static readonly NONE: ITableBordersOptions;
     constructor(options: ITableBordersOptions);
 }
 
@@ -2839,24 +2893,20 @@ export declare class TableCellBorders extends IgnoreIfEmptyXmlComponent {
     constructor(options: ITableCellBorders);
 }
 
-export declare class TableFloatProperties extends XmlComponent {
-    constructor({ horizontalAnchor, verticalAnchor, absoluteHorizontalPosition, relativeHorizontalPosition, absoluteVerticalPosition, relativeVerticalPosition, bottomFromText, topFromText, leftFromText, rightFromText, overlap, }: ITableFloatOptions);
-}
-
-export declare class TableLayout extends XmlComponent {
-    constructor(type: (typeof TableLayoutType)[keyof typeof TableLayoutType]);
-}
-
 export declare const TableLayoutType: {
     readonly AUTOFIT: "autofit";
     readonly FIXED: "fixed";
 };
 
 export declare class TableOfContents extends FileChild {
-    constructor(alias?: string, { contentChildren, beginDirty, ...properties }?: ITableOfContentsOptions & {
+    constructor(alias?: string, { contentChildren, cachedEntries, beginDirty, ...properties }?: ITableOfContentsOptions & {
         readonly contentChildren?: readonly (XmlComponent | string)[];
+        readonly cachedEntries?: readonly ToCEntry[];
         readonly beginDirty?: boolean;
     });
+    private getTabStopsForLevel;
+    private buildCachedContentRun;
+    private buildCachedContentParagraphChild;
 }
 
 export declare class TableProperties extends IgnoreIfEmptyXmlComponent {
@@ -2874,20 +2924,6 @@ export declare class TableRow extends XmlComponent {
     columnIndexToRootIndex(columnIndex: number, allowEndNewCell?: boolean): number;
 }
 
-export declare class TableRowHeight extends XmlComponent {
-    constructor(value: number | PositiveUniversalMeasure, rule: (typeof HeightRule)[keyof typeof HeightRule]);
-}
-
-export declare class TableRowHeightAttributes extends XmlAttributeComponent<{
-    readonly value: number | string;
-    readonly rule: (typeof HeightRule)[keyof typeof HeightRule];
-}> {
-    protected readonly xmlKeys: {
-        value: string;
-        rule: string;
-    };
-}
-
 export declare class TableRowProperties extends IgnoreIfEmptyXmlComponent {
     constructor(options: ITableRowPropertiesOptions);
 }
@@ -2898,24 +2934,12 @@ export declare class TableRowPropertiesChange extends XmlComponent {
 
 export declare type TableVerticalAlign = (typeof VerticalAlignTable)[keyof typeof VerticalAlignTable];
 
-export declare class TableWidthElement extends XmlComponent {
-    constructor(name: string, { type, size }: ITableWidthProperties);
-}
-
-export declare class TabStop extends XmlComponent {
-    constructor(tabDefinitions: readonly TabStopDefinition[]);
-}
-
 export declare type TabStopDefinition = {
     readonly type: (typeof TabStopType)[keyof typeof TabStopType];
     readonly position: number | (typeof TabStopPosition)[keyof typeof TabStopPosition];
     readonly leader?: (typeof LeaderType)[keyof typeof LeaderType];
 };
 
-export declare class TabStopItem extends XmlComponent {
-    constructor({ type, position, leader }: TabStopDefinition);
-}
-
 export declare const TabStopPosition: {
     readonly MAX: 9026;
 };
@@ -2982,18 +3006,17 @@ export declare class ThematicBreak extends XmlComponent {
     constructor();
 }
 
-export declare const twipsMeasureValue: (val: PositiveUniversalMeasure | number) => PositiveUniversalMeasure | number;
+declare type ToCEntry = {
+    readonly title: string;
+    readonly level: number;
+    readonly page?: number;
+    readonly href?: string;
+};
 
-export declare class Type extends XmlComponent {
-    constructor(value: (typeof SectionType)[keyof typeof SectionType]);
-}
+export declare const twipsMeasureValue: (val: PositiveUniversalMeasure | number) => PositiveUniversalMeasure | number;
 
 export declare const uCharHexNumber: (val: string) => string;
 
-export declare class Underline extends XmlComponent {
-    constructor(underlineType?: (typeof UnderlineType)[keyof typeof UnderlineType], color?: string);
-}
-
 export declare const UnderlineType: {
     readonly SINGLE: "single";
     readonly WORDS: "words";
@@ -3036,18 +3059,6 @@ export declare const VerticalAlign: {
     readonly BOTTOM: "bottom";
 };
 
-export declare class VerticalAlignAttributes extends XmlAttributeComponent<{
-    readonly verticalAlign?: (typeof VerticalAlign)[keyof typeof VerticalAlign];
-}> {
-    protected readonly xmlKeys: {
-        verticalAlign: string;
-    };
-}
-
-export declare class VerticalAlignElement extends XmlComponent {
-    constructor(value: (typeof VerticalAlign)[keyof typeof VerticalAlign]);
-}
-
 export declare const VerticalAlignSection: {
     readonly BOTH: "both";
     readonly TOP: "top";
@@ -3061,6 +3072,12 @@ export declare const VerticalAlignTable: {
     readonly BOTTOM: "bottom";
 };
 
+export declare enum VerticalAnchor {
+    CENTER = "ctr",
+    TOP = "t",
+    BOTTOM = "b"
+}
+
 export declare class VerticalMerge extends XmlComponent {
     constructor(value: (typeof VerticalMergeType)[keyof typeof VerticalMergeType]);
 }
@@ -3133,20 +3150,39 @@ export declare const WORKAROUND3 = "";
 
 export declare const WORKAROUND4 = "";
 
-export declare class WrapNone extends XmlComponent {
-    constructor();
-}
+export declare type WpgCommonMediaData = {
+    readonly outline?: OutlineOptions;
+    readonly solidFill?: SolidFillOptions;
+};
 
-export declare class WrapSquare extends XmlComponent {
-    constructor(textWrapping: ITextWrapping, margins?: IMargins);
+export declare class WpgGroupRun extends Run {
+    private readonly wpgGroupData;
+    private readonly mediaDatas;
+    constructor(options: IWpgGroupOptions);
+    prepForXml(context: IContext): IXmlableObject | undefined;
 }
 
-export declare class WrapTight extends XmlComponent {
-    constructor(margins?: IMargins);
-}
+export declare type WpgMediaData = {
+    readonly type: "wpg";
+    readonly transformation: IMediaDataTransformation;
+    readonly children: readonly IGroupChildMediaData[];
+};
+
+export declare type WpsMediaData = {
+    readonly type: "wps";
+    readonly transformation: IMediaDataTransformation;
+    readonly data: WpsShapeCoreOptions;
+};
+
+declare type WpsShapeCoreOptions = {
+    readonly children: readonly Paragraph[];
+    readonly nonVisualProperties?: INonVisualShapePropertiesOptions;
+    readonly bodyProperties?: IBodyPropertiesOptions;
+};
 
-export declare class WrapTopAndBottom extends XmlComponent {
-    constructor(margins?: IMargins);
+export declare class WpsShapeRun extends Run {
+    private readonly wpsShapeData;
+    constructor(options: IWpsShapeOptions);
 }
 
 export declare abstract class XmlAttributeComponent<T extends Record<string, any>> extends BaseXmlComponent {