docx 9.6.1 → 9.7.1

package/dist/index.d.cts

@@ -238,10 +238,14 @@ export declare class ColumnBreak extends Run {
 }
 
 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);
 }
@@ -256,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: {
@@ -284,6 +294,7 @@ export declare const concreteNumUniqueNumericIdGen: () => UniqueNumericIdCreator
 
 declare class ContentTypes extends XmlComponent {
     constructor();
+    addCommentsExtended(): void;
     addFooter(index: number): void;
     addHeader(index: number): void;
 }
@@ -311,6 +322,8 @@ declare type CoreImageOptions = {
     readonly altText?: DocPropertiesOptions;
     readonly outline?: OutlineOptions;
     readonly solidFill?: SolidFillOptions;
+    readonly insertion?: IChangedAttributesProperties;
+    readonly deletion?: IChangedAttributesProperties;
 };
 
 declare type CoreMediaData = {
@@ -351,7 +364,7 @@ export declare const createHeaderFooterReference: (type: (typeof HeaderFooterTyp
 
 export declare const createHorizontalPosition: ({ relative, align, offset }: IHorizontalPositionOptions) => XmlComponent;
 
-export declare const createIndent: ({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) => XmlComponent;
+export declare const createIndent: ({ start, end, left, right, hanging, firstLine, firstLineChars }: IIndentAttributesProperties) => XmlComponent;
 
 export declare const createLineNumberType: ({ countBy, start, restart, distance }: ILineNumberAttributes) => XmlComponent;
 
@@ -649,6 +662,7 @@ declare class File_2 {
     private readonly appProperties;
     private readonly styles;
     private readonly comments;
+    private readonly commentsExtended?;
     private readonly fontWrapper;
     constructor(options: IPropertiesOptions);
     private addSection;
@@ -672,6 +686,7 @@ declare class File_2 {
     get Endnotes(): EndnotesWrapper;
     get Settings(): Settings;
     get Comments(): Comments;
+    get CommentsExtended(): CommentsExtended | undefined;
     get FontTable(): FontWrapper;
 }
 export { File_2 as Document }
@@ -1000,12 +1015,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;
@@ -1245,6 +1268,7 @@ export declare type IIndentAttributesProperties = {
     readonly right?: number | UniversalMeasure;
     readonly hanging?: number | PositiveUniversalMeasure;
     readonly firstLine?: number | PositiveUniversalMeasure;
+    readonly firstLineChars?: number;
 };
 
 declare type IInsertedRunOptions = IChangedAttributesProperties & IRunOptions;
@@ -1284,6 +1308,7 @@ export declare type ILevelsOptions = {
     readonly style?: {
         readonly run?: IRunStylePropertiesOptions;
         readonly paragraph?: ILevelParagraphStylePropertiesOptions;
+        readonly style?: string;
     };
 };
 
@@ -1294,7 +1319,7 @@ export declare type ILineNumberAttributes = {
     readonly distance?: number | PositiveUniversalMeasure;
 };
 
-export declare class ImageRun extends Run {
+export declare class ImageRun extends XmlComponent {
     private readonly imageData;
     constructor(options: IImageOptions);
     prepForXml(context: IContext): IXmlableObject | undefined;
@@ -2608,7 +2633,7 @@ declare class Relationships extends XmlComponent {
     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/endnotes" | "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";
@@ -2694,7 +2719,7 @@ export declare const sectionPageSizeDefaults: {
 };
 
 export declare class SectionProperties extends XmlComponent {
-    constructor({ page: { size: { width, height, orientation, }, margin: { top, right, bottom, left, header, footer, gutter, }, pageNumbers, borders, textDirection, }, grid: { linePitch, charSpace, type: gridType }, headerWrapperGroup, footerWrapperGroup, lineNumbers, titlePage, verticalAlign, column, type, revision, }?: ISectionPropertiesOptions);
+    constructor({ page: { size: { width, height, orientation, code, }, margin: { top, right, bottom, left, header, footer, gutter, }, pageNumbers, borders, textDirection, }, grid: { linePitch, charSpace, type: gridType }, headerWrapperGroup, footerWrapperGroup, lineNumbers, titlePage, verticalAlign, column, type, revision, }?: ISectionPropertiesOptions);
     private addHeaderFooterGroup;
 }
 

package/dist/index.d.ts

@@ -238,10 +238,14 @@ export declare class ColumnBreak extends Run {
 }
 
 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);
 }
@@ -256,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: {
@@ -284,6 +294,7 @@ export declare const concreteNumUniqueNumericIdGen: () => UniqueNumericIdCreator
 
 declare class ContentTypes extends XmlComponent {
     constructor();
+    addCommentsExtended(): void;
     addFooter(index: number): void;
     addHeader(index: number): void;
 }
@@ -311,6 +322,8 @@ declare type CoreImageOptions = {
     readonly altText?: DocPropertiesOptions;
     readonly outline?: OutlineOptions;
     readonly solidFill?: SolidFillOptions;
+    readonly insertion?: IChangedAttributesProperties;
+    readonly deletion?: IChangedAttributesProperties;
 };
 
 declare type CoreMediaData = {
@@ -351,7 +364,7 @@ export declare const createHeaderFooterReference: (type: (typeof HeaderFooterTyp
 
 export declare const createHorizontalPosition: ({ relative, align, offset }: IHorizontalPositionOptions) => XmlComponent;
 
-export declare const createIndent: ({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) => XmlComponent;
+export declare const createIndent: ({ start, end, left, right, hanging, firstLine, firstLineChars }: IIndentAttributesProperties) => XmlComponent;
 
 export declare const createLineNumberType: ({ countBy, start, restart, distance }: ILineNumberAttributes) => XmlComponent;
 
@@ -649,6 +662,7 @@ declare class File_2 {
     private readonly appProperties;
     private readonly styles;
     private readonly comments;
+    private readonly commentsExtended?;
     private readonly fontWrapper;
     constructor(options: IPropertiesOptions);
     private addSection;
@@ -672,6 +686,7 @@ declare class File_2 {
     get Endnotes(): EndnotesWrapper;
     get Settings(): Settings;
     get Comments(): Comments;
+    get CommentsExtended(): CommentsExtended | undefined;
     get FontTable(): FontWrapper;
 }
 export { File_2 as Document }
@@ -1000,12 +1015,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;
@@ -1245,6 +1268,7 @@ export declare type IIndentAttributesProperties = {
     readonly right?: number | UniversalMeasure;
     readonly hanging?: number | PositiveUniversalMeasure;
     readonly firstLine?: number | PositiveUniversalMeasure;
+    readonly firstLineChars?: number;
 };
 
 declare type IInsertedRunOptions = IChangedAttributesProperties & IRunOptions;
@@ -1284,6 +1308,7 @@ export declare type ILevelsOptions = {
     readonly style?: {
         readonly run?: IRunStylePropertiesOptions;
         readonly paragraph?: ILevelParagraphStylePropertiesOptions;
+        readonly style?: string;
     };
 };
 
@@ -1294,7 +1319,7 @@ export declare type ILineNumberAttributes = {
     readonly distance?: number | PositiveUniversalMeasure;
 };
 
-export declare class ImageRun extends Run {
+export declare class ImageRun extends XmlComponent {
     private readonly imageData;
     constructor(options: IImageOptions);
     prepForXml(context: IContext): IXmlableObject | undefined;
@@ -2608,7 +2633,7 @@ declare class Relationships extends XmlComponent {
     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/endnotes" | "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";
@@ -2694,7 +2719,7 @@ export declare const sectionPageSizeDefaults: {
 };
 
 export declare class SectionProperties extends XmlComponent {
-    constructor({ page: { size: { width, height, orientation, }, margin: { top, right, bottom, left, header, footer, gutter, }, pageNumbers, borders, textDirection, }, grid: { linePitch, charSpace, type: gridType }, headerWrapperGroup, footerWrapperGroup, lineNumbers, titlePage, verticalAlign, column, type, revision, }?: ISectionPropertiesOptions);
+    constructor({ page: { size: { width, height, orientation, code, }, margin: { top, right, bottom, left, header, footer, gutter, }, pageNumbers, borders, textDirection, }, grid: { linePitch, charSpace, type: gridType }, headerWrapperGroup, footerWrapperGroup, lineNumbers, titlePage, verticalAlign, column, type, revision, }?: ISectionPropertiesOptions);
     private addHeaderFooterGroup;
 }