@office-open/docx 0.6.3 → 0.6.5

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as _$_office_open_core0 from "@office-open/core";
-import { AppProperties, AttributeData, AttributeMap, AttributePayload, BaseXmlComponent, BuilderElement, Context as Context$1, EMPTY_OBJECT, EmptyElement, IXmlableObject, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, NextAttributeComponent, OutputByType, OutputByType as OutputByType$1, OutputType, OutputType as OutputType$1, ParsedDocument, PrettifyType, Relationships, UniqueNumericIdCreator, XmlAttributeComponent, XmlAttributeComponent as XmlAttributeComponent$1, XmlComponent, XmlComponent as XmlComponent$1, attrObj, chartAttr, convertInchesToTwip, convertMillimetersToTwip, convertToXmlComponent, hashedId, hpsMeasureObj, numberValObj, onOffObj, parseArchive, stringContainerObj, stringEnumValObj, stringValObj, uniqueId, uniqueNumericIdCreator, uniqueUuid, wrapEl } from "@office-open/core";
+import { AppProperties, AttributeData, AttributeMap, AttributePayload, BaseXmlComponent, BuilderElement, Context as Context$1, EMPTY_OBJECT, EmptyElement, IXmlableObject, IgnoreIfEmptyXmlComponent, ImportedRootElementAttributes, ImportedXmlComponent, InitializableXmlComponent, NextAttributeComponent, OutputByType, OutputByType as OutputByType$1, OutputType, OutputType as OutputType$1, ParsedArchive, PrettifyType, Relationships, UniqueNumericIdCreator, XmlAttributeComponent, XmlAttributeComponent as XmlAttributeComponent$1, XmlComponent, XmlComponent as XmlComponent$1, attrObj, chartAttr, convertInchesToTwip, convertMillimetersToTwip, convertToXmlComponent, hashedId, hpsMeasureObj, numberValObj, onOffObj, parseArchive, stringContainerObj, stringEnumValObj, stringValObj, uniqueId, uniqueNumericIdCreator, uniqueUuid, wrapEl } from "@office-open/core";
 import { DataType } from "undio";
 import { BlipEffectsOptions, CustomGeometryOptions, EffectDagOptions, EffectListOptions, FillOptions, OutlineOptions, Scene3DOptions, Shape3DOptions, SourceRectangleOptions, TileOptions } from "@office-open/core/drawingml";
 import { ChartCollection, ChartData, ChartSeriesData, ChartSpace, ChartSpaceOptions } from "@office-open/core/chart";
@@ -61,7 +61,7 @@ declare function buildDocumentAttributes(ns: readonly DocumentAttributeNamespace
 declare abstract class HeaderFooterBase extends InitializableXmlComponent {
   private readonly refId;
   protected constructor(tagName: string, referenceNumber: number, namespaces: readonly DocumentAttributeNamespace[], initContent?: XmlComponent);
-  get ReferenceId(): number;
+  get referenceId(): number;
   add(item: FileChild): void;
 }
 //#endregion
@@ -271,7 +271,7 @@ declare class Media {
   private readonly map;
   constructor();
   addImage(key: string, mediaData: IMediaData): void;
-  get Array(): readonly IMediaData[];
+  get array(): readonly IMediaData[];
 }
 //#endregion
 //#region src/file/footer-wrapper.d.ts
@@ -280,15 +280,13 @@ interface DocumentFooter {
   readonly type: (typeof HeaderFooterReferenceType)[keyof typeof HeaderFooterReferenceType];
 }
 declare class FooterWrapper implements ViewWrapper {
-  private readonly media;
   private readonly footer;
-  private readonly relationships;
+  readonly relationships: Relationships;
+  readonly media: Media;
   constructor(media: Media, referenceId: number, initContent?: XmlComponent);
   add(item: FileChild): void;
   addChildElement(childElement: XmlComponent): void;
-  get View(): Footer$1;
-  get Relationships(): Relationships;
-  get Media(): Media;
+  get view(): Footer$1;
 }
 //#endregion
 //#region src/file/header/header.d.ts
@@ -302,15 +300,13 @@ interface DocumentHeader {
   readonly type: (typeof HeaderFooterReferenceType)[keyof typeof HeaderFooterReferenceType];
 }
 declare class HeaderWrapper implements ViewWrapper {
-  private readonly media;
   private readonly header;
-  private readonly relationships;
+  readonly relationships: Relationships;
+  readonly media: Media;
   constructor(media: Media, referenceId: number, initContent?: XmlComponent);
   add(item: FileChild): HeaderWrapper;
   addChildElement(childElement: XmlComponent | string): void;
-  get View(): Header$1;
-  get Relationships(): Relationships;
-  get Media(): Media;
+  get view(): Header$1;
 }
 //#endregion
 //#region src/file/track-revision/track-revision.d.ts
@@ -805,10 +801,9 @@ interface DocumentOptions {
   readonly background?: DocumentBackgroundOptions;
 }
 declare class Document extends XmlComponent {
-  private readonly body;
+  readonly body: Body;
   constructor(options: DocumentOptions);
   add(item: FileChild | ConcreteHyperlink): Document;
-  get Body(): Body;
 }
 //#endregion
 //#region src/file/endnotes/endnotes.d.ts
@@ -1511,7 +1506,7 @@ declare class AltChunkCollection {
   private readonly map;
   constructor();
   addAltChunk(key: string, data: AltChunkData): void;
-  get Array(): readonly AltChunkData[];
+  get array(): readonly AltChunkData[];
 }
 //#endregion
 //#region src/file/checkbox/checkbox-util.d.ts
@@ -2003,8 +1998,8 @@ declare class DeletedTableCell extends XmlComponent {
 //#endregion
 //#region src/file/track-revision/track-revision-components/cell-merge.d.ts
 declare const VerticalMergeRevisionType: {
-  readonly CONTINUE: "cont";
-  readonly RESTART: "rest";
+  readonly CONTINUE: "continue";
+  readonly RESTART: "restart";
 };
 type ICellMergeAttributes = ChangedAttributesProperties & {
   readonly verticalMerge?: (typeof VerticalMergeRevisionType)[keyof typeof VerticalMergeRevisionType];
@@ -2143,7 +2138,7 @@ declare class TableRow extends BaseXmlComponent {
   private extraCells;
   private readonly coercedChildren;
   constructor(options: TableRowOptions);
-  get CellCount(): number;
+  get cellCount(): number;
   get cells(): readonly TableCell[];
   addCellToColumnIndex(cell: TableCell, columnIndex: number): void;
   rootIndexToColumnIndex(rootIndex: number): number;
@@ -2201,7 +2196,7 @@ interface SdtRowOptions {
 declare class StructuredDocumentTagRow extends XmlComponent {
   private readonly rows;
   constructor(options: SdtRowOptions);
-  get CellCount(): number;
+  get cellCount(): number;
   get cells(): readonly TableCell[];
   addCellToColumnIndex(cell: TableCell, columnIndex: number): void;
 }
@@ -2215,7 +2210,7 @@ declare class SubDocCollection {
   private readonly map;
   constructor();
   addSubDoc(key: string, data: SubDocData): void;
-  get Array(): readonly SubDocData[];
+  get array(): readonly SubDocData[];
 }
 //#endregion
 //#region src/file/paragraph/formatting/break.d.ts
@@ -2435,7 +2430,7 @@ declare const FractionType: {
   readonly NO_BAR: "noBar";
 };
 interface MathFractionPropertiesOptions {
-  readonly fractionType?: keyof typeof FractionType;
+  readonly fractionType?: (typeof FractionType)[keyof typeof FractionType];
 }
 declare const createMathFractionProperties: (options: MathFractionPropertiesOptions) => XmlComponent;
 //#endregion
@@ -2800,7 +2795,7 @@ type MathJson = MathComponent | string | {
   readonly fraction: {
     readonly numerator: readonly MathJson[];
     readonly denominator: readonly MathJson[];
-    readonly fractionType?: keyof typeof FractionType;
+    readonly fractionType?: (typeof FractionType)[keyof typeof FractionType];
   };
 } | {
   readonly superScript: {
@@ -3365,11 +3360,10 @@ declare class Comment extends XmlComponent {
   }: CommentOptions);
 }
 declare class Comments extends XmlComponent {
-  private readonly relationships;
+  readonly relationships: Relationships;
   constructor({
     children
   }: CommentsOptions);
-  get Relationships(): Relationships;
 }
 //#endregion
 //#region src/file/paragraph/run/positional-tab.d.ts
@@ -3410,7 +3404,7 @@ declare const RubyAlign: {
 interface RubyOptions {
   readonly text: string;
   readonly base: string;
-  readonly alignment?: keyof typeof RubyAlign;
+  readonly alignment?: (typeof RubyAlign)[keyof typeof RubyAlign];
   readonly fontSize?: number;
   readonly raise?: number;
   readonly baseFontSize?: number;
@@ -3482,15 +3476,14 @@ declare class EndnoteReferenceRun extends Run {
 //#endregion
 //#region src/file/document-wrapper.d.ts
 interface ViewWrapper {
-  readonly View: Document | Footer$1 | Header$1 | FootNotes | Endnotes | XmlComponent;
-  readonly Relationships: Relationships;
+  readonly view: Document | Footer$1 | Header$1 | FootNotes | Endnotes | XmlComponent;
+  readonly relationships: Relationships;
 }
 declare class DocumentWrapper implements ViewWrapper {
   private readonly document;
-  private readonly relationships;
+  readonly relationships: Relationships;
   constructor(options: DocumentOptions);
-  get View(): Document;
-  get Relationships(): Relationships;
+  get view(): Document;
 }
 //#endregion
 //#region src/file/bibliography/bibliography.d.ts
@@ -3517,9 +3510,8 @@ interface BibliographyOptions {
   readonly styleName?: string;
 }
 declare class Bibliography extends XmlComponent {
-  private readonly relationships;
+  readonly relationships: Relationships;
   constructor(options: BibliographyOptions);
-  get Relationships(): Relationships;
 }
 //#endregion
 //#region src/file/content-types/content-types.d.ts
@@ -3568,11 +3560,10 @@ type EmbeddedFontOptionsWithKey = EmbeddedFontOptions & {
 declare class FontWrapper implements ViewWrapper {
   readonly options: readonly EmbeddedFontOptions[];
   private readonly fontTable;
-  private readonly relationships;
+  readonly relationships: Relationships;
   readonly fontOptionsWithKey: readonly EmbeddedFontOptionsWithKey[];
   constructor(options: readonly EmbeddedFontOptions[]);
-  get View(): XmlComponent;
-  get Relationships(): Relationships;
+  get view(): XmlComponent;
 }
 //#endregion
 //#region src/file/fonts/font-table.d.ts
@@ -3874,8 +3865,8 @@ declare class Numbering extends XmlComponent {
   constructor(options: NumberingOptions);
   prepForXml(context: Context): IXmlableObject | undefined;
   createConcreteNumberingInstance(reference: string, instance: number): void;
-  get ConcreteNumbering(): readonly ConcreteNumbering[];
-  get ReferenceConfig(): readonly Record<string, any>[];
+  get concreteNumbering(): readonly ConcreteNumbering[];
+  get referenceConfig(): readonly Record<string, any>[];
 }
 //#endregion
 //#region src/file/numbering/abstract-numbering.d.ts
@@ -4069,19 +4060,17 @@ declare class CoreProperties extends XmlComponent {
 //#region src/file/endnotes-wrapper.d.ts
 declare class EndnotesWrapper implements ViewWrapper {
   private readonly endnotes;
-  private readonly relationships;
+  readonly relationships: Relationships;
   constructor();
-  get View(): Endnotes;
-  get Relationships(): Relationships;
+  get view(): Endnotes;
 }
 //#endregion
 //#region src/file/footnotes-wrapper.d.ts
 declare class FootnotesWrapper implements ViewWrapper {
-  private readonly footnotess;
-  private readonly relationships;
+  private readonly footnotes;
+  readonly relationships: Relationships;
   constructor();
-  get View(): FootNotes;
-  get Relationships(): Relationships;
+  get view(): FootNotes;
 }
 //#endregion
 //#region src/file/header.d.ts
@@ -4113,28 +4102,28 @@ interface SectionOptions {
   readonly children: readonly SectionChild[];
 }
 declare class File {
-  private currentRelationshipId;
-  private readonly documentWrapper;
-  private readonly headers;
-  private readonly footers;
-  private readonly coreProperties;
-  private readonly numbering;
-  private readonly media;
-  private readonly charts;
-  private readonly smartArts;
-  private readonly altChunks;
-  private readonly subDocs;
-  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 bibliography;
-  private readonly fontWrapper;
+  private _currentRelationshipId;
+  readonly document: DocumentWrapper;
+  private readonly _headers;
+  private readonly _footers;
+  readonly coreProperties: CoreProperties;
+  readonly numbering: Numbering;
+  readonly media: Media;
+  readonly charts: ChartCollection;
+  readonly smartArts: SmartArtCollection;
+  readonly altChunks: AltChunkCollection;
+  readonly subDocs: SubDocCollection;
+  readonly fileRelationships: Relationships;
+  readonly footNotes: FootnotesWrapper;
+  readonly endnotes: EndnotesWrapper;
+  readonly settings: Settings;
+  readonly contentTypes: ContentTypes;
+  readonly customProperties: CustomProperties;
+  readonly appProperties: AppProperties;
+  readonly styles: Styles;
+  readonly comments: Comments;
+  readonly bibliography: Bibliography | undefined;
+  readonly fontTable: FontWrapper;
   constructor(options: PropertiesOptions);
   private addSection;
   private createHeader;
@@ -4142,27 +4131,8 @@ declare class File {
   private addHeaderToDocument;
   private addFooterToDocument;
   private addDefaultRelationships;
-  get Document(): DocumentWrapper;
-  get Styles(): Styles;
-  get CoreProperties(): CoreProperties;
-  get Numbering(): Numbering;
-  get Media(): Media;
-  get Charts(): ChartCollection;
-  get SmartArts(): SmartArtCollection;
-  get AltChunks(): AltChunkCollection;
-  get SubDocs(): SubDocCollection;
-  get FileRelationships(): Relationships;
-  get Headers(): readonly HeaderWrapper[];
-  get Footers(): readonly FooterWrapper[];
-  get ContentTypes(): ContentTypes;
-  get CustomProperties(): CustomProperties;
-  get AppProperties(): AppProperties;
-  get FootNotes(): FootnotesWrapper;
-  get Endnotes(): EndnotesWrapper;
-  get Settings(): Settings;
-  get Comments(): Comments;
-  get Bibliography(): Bibliography | undefined;
-  get FontTable(): FontWrapper;
+  get headers(): readonly HeaderWrapper[];
+  get footers(): readonly FooterWrapper[];
 }
 //#endregion
 //#region src/file/xml-components/base.d.ts
@@ -4354,8 +4324,9 @@ interface DocxPartRefs {
   subDocs: Map<string, string>;
 }
 interface DocxDocument {
-  doc: ParsedDocument;
+  doc: ParsedArchive;
   body: Element;
+  background?: Element;
   styles?: Element;
   numbering?: Element;
   settings?: Element;