@docx4j/core-ts 0.1.0 → 0.1.1

package/dist/parts/wml/defaultNumbering.mjs

@@ -0,0 +1,216 @@
+// docx4j's default numbering: the resource
+// docx4j-core/src/main/resources/org/docx4j/openpackaging/parts/WordprocessingML/numbering.xml,
+// which `NumberingDefinitionsPart.unmarshalDefaultNumbering()` reads.  Taken from docx4j
+// VERSION_17_1_1 at 546b18b56, where the file itself is unchanged since 752e200eb (2019-02-09).
+//
+// abstractNum 0 is Word's bullet set and abstractNum 1 its decimal set; `w:num` 1 names the
+// decimal one and `w:num` 2 the bullet one.  Generated from that resource - UTF-16 there, UTF-8
+// here, CRLF normalised to LF, nothing else changed.  Do not edit.
+export const DEFAULT_NUMBERING_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:numbering xmlns:ve="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml">
+  <w:abstractNum w:abstractNumId="0">
+    <w:nsid w:val="16892FB7"/>
+    <w:multiLevelType w:val="hybridMultilevel"/>
+    <w:tmpl w:val="5A4EB96A"/>
+    <w:lvl w:ilvl="0" w:tplc="0C090001">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val=""/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="720" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Symbol" w:hAnsi="Symbol" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="1" w:tplc="0C090003" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val="o"/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="1440" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Courier New" w:hAnsi="Courier New" w:cs="Courier New" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="2" w:tplc="0C090005" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val=""/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="2160" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Wingdings" w:hAnsi="Wingdings" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="3" w:tplc="0C090001" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val=""/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="2880" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Symbol" w:hAnsi="Symbol" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="4" w:tplc="0C090003" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val="o"/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="3600" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Courier New" w:hAnsi="Courier New" w:cs="Courier New" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="5" w:tplc="0C090005" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val=""/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="4320" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Wingdings" w:hAnsi="Wingdings" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="6" w:tplc="0C090001" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val=""/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="5040" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Symbol" w:hAnsi="Symbol" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="7" w:tplc="0C090003" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val="o"/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="5760" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Courier New" w:hAnsi="Courier New" w:cs="Courier New" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+    <w:lvl w:ilvl="8" w:tplc="0C090005" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="bullet"/>
+      <w:lvlText w:val=""/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="6480" w:hanging="360"/>
+      </w:pPr>
+      <w:rPr>
+        <w:rFonts w:ascii="Wingdings" w:hAnsi="Wingdings" w:hint="default"/>
+      </w:rPr>
+    </w:lvl>
+  </w:abstractNum>
+  <w:abstractNum w:abstractNumId="1">
+    <w:nsid w:val="7E706046"/>
+    <w:multiLevelType w:val="hybridMultilevel"/>
+    <w:tmpl w:val="336E8F2C"/>
+    <w:lvl w:ilvl="0" w:tplc="0C09000F">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="decimal"/>
+      <w:lvlText w:val="%1."/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="720" w:hanging="360"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="1" w:tplc="0C090019" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="lowerLetter"/>
+      <w:lvlText w:val="%2."/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="1440" w:hanging="360"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="2" w:tplc="0C09001B" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="lowerRoman"/>
+      <w:lvlText w:val="%3."/>
+      <w:lvlJc w:val="right"/>
+      <w:pPr>
+        <w:ind w:left="2160" w:hanging="180"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="3" w:tplc="0C09000F" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="decimal"/>
+      <w:lvlText w:val="%4."/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="2880" w:hanging="360"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="4" w:tplc="0C090019" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="lowerLetter"/>
+      <w:lvlText w:val="%5."/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="3600" w:hanging="360"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="5" w:tplc="0C09001B" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="lowerRoman"/>
+      <w:lvlText w:val="%6."/>
+      <w:lvlJc w:val="right"/>
+      <w:pPr>
+        <w:ind w:left="4320" w:hanging="180"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="6" w:tplc="0C09000F" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="decimal"/>
+      <w:lvlText w:val="%7."/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="5040" w:hanging="360"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="7" w:tplc="0C090019" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="lowerLetter"/>
+      <w:lvlText w:val="%8."/>
+      <w:lvlJc w:val="left"/>
+      <w:pPr>
+        <w:ind w:left="5760" w:hanging="360"/>
+      </w:pPr>
+    </w:lvl>
+    <w:lvl w:ilvl="8" w:tplc="0C09001B" w:tentative="1">
+      <w:start w:val="1"/>
+      <w:numFmt w:val="lowerRoman"/>
+      <w:lvlText w:val="%9."/>
+      <w:lvlJc w:val="right"/>
+      <w:pPr>
+        <w:ind w:left="6480" w:hanging="180"/>
+      </w:pPr>
+    </w:lvl>
+  </w:abstractNum>
+  <w:num w:numId="1">
+    <w:abstractNumId w:val="1"/>
+  </w:num>
+  <w:num w:numId="2">
+    <w:abstractNumId w:val="0"/>
+  </w:num>
+</w:numbering>`;

package/dist/parts/wml/index.d.mts

@@ -1,6 +1,7 @@
 import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
 import type * as w15 from '@docx4j/generated-objects-ts/modules/org_docx4j_w15';
 import type * as w16cid from '@docx4j/generated-objects-ts/modules/org_docx4j_w16cid';
+import type * as w16cex from '@docx4j/generated-objects-ts/modules/org_docx4j_w16cex';
 import type * as wne from '@docx4j/generated-objects-ts/modules/org_docx4j_com_microsoft_schemas_office_word_x2006_wordml';
 import { XmlPart } from '../XmlPart.mjs';
 import { Part } from '../Part.mjs';
@@ -8,6 +9,12 @@ import { PartName } from '../../opc/PartName.mjs';
 import { DefaultXmlPart } from '../DefaultXmlPart.mjs';
 import { ThemePart } from '../dml/index.mjs';
 import { Body } from '../../model/content/Body.mjs';
+import type { AbstractListDefinition, ListDefinition } from '../../model/listnumbering/definitions.mjs';
+import { NumberingDefinitions } from '../../model/listnumbering/definitions.mjs';
+import { Emulator } from '../../model/listnumbering/Emulator.mjs';
+import type { NumberingState } from '../../model/listnumbering/state.mjs';
+import { RunFontSelector } from '../../model/fonts/RunFontSelector.mjs';
+import type { Mapper } from '../../model/fonts/Mapper.mjs';
 /**
  * Shared by the main document and the glossary document (docx4j DocumentPart): the shortcuts
  * to styles, numbering, fonts, settings, theme, comments and notes.
@@ -22,6 +29,7 @@ export declare abstract class DocumentPart<T> extends XmlPart<T> {
     commentsPart: CommentsPart | undefined;
     commentsExtendedPart: CommentsExtendedPart | undefined;
     commentsIdsPart: CommentsIdsPart | undefined;
+    commentsExtensiblePart: CommentsExtensiblePart | undefined;
     footnotesPart: FootnotesPart | undefined;
     endnotesPart: EndnotesPart | undefined;
     peoplePart: PeoplePart | undefined;
@@ -39,6 +47,49 @@ export declare class MainDocumentPart extends DocumentPart<wml.Document> {
     /** The Office JS-shaped view of `w:body`; the part must be unmarshalled (`getBody()` does that). */
     get body(): Body;
     getBody(): Promise<Body>;
+    private fontSelector;
+    private fontSelectorPending;
+    private fontMapper;
+    /**
+     * The package's `RunFontSelector`, built once: the property resolver, the theme part's font
+     * scheme, the settings part's `w:themeFontLang` and the package's `fonts.defaultTheme`.
+     *
+     * Asynchronous because it reads the theme and settings parts; `runFontSelector` is the
+     * synchronous accessor afterwards. Both parts are read with `readContents()`, so a document
+     * whose theme and settings nobody has edited still saves byte for byte.
+     */
+    getRunFontSelector(): Promise<RunFontSelector>;
+    private buildRunFontSelector;
+    /** The selector, which must already have been built (`await getRunFontSelector()`). */
+    get runFontSelector(): RunFontSelector;
+    /** The selector if it has been built, without throwing (what a read with a fallback wants). */
+    get runFontSelectorOrUndefined(): RunFontSelector | undefined;
+    /**
+     * The package's font mapper, populated from {@link fontsInUse} and the font table part
+     * (docx4j `WordprocessingMLPackage.getFontMapper` / `setFontMapper`): an
+     * `IdentityPlusMapper` over the default font registry unless one is given.
+     *
+     * @param mapper a mapper of the caller's own, which is then populated and kept
+     */
+    getFontMapper(mapper?: Mapper): Promise<Mapper>;
+    /** Discard the selector and the mapper: the styles, theme or settings changed under us. */
+    refreshFonts(): void;
+    /**
+     * The document font names, as docx4j's `fontsInUse()`: the four slots of every `w:rFonts` on
+     * the runs, paragraph marks and content controls of the body, headers, footers, footnotes,
+     * endnotes and comments; the styles in use with their `w:basedOn` chains; the numbering
+     * levels; the document defaults; and the default font. Theme references are resolved, and a
+     * CJK font name is collected by its English name.
+     */
+    fontsInUse(): Promise<Set<string>>;
+    /** The style ids used directly in the document (docx4j `getStylesInUse()`); not those that
+     *  others are merely based on. */
+    getStylesInUse(): Promise<Set<string>>;
+    /** The block-level content of each story, in docx4j's order: the body, then the headers and
+     *  footers, the endnotes, the footnotes and the comments. */
+    private stories;
+    /** The styles part and its `w:default="1"` style ids, read without costing it its round trip. */
+    private styleSource;
 }
 /** `/word/glossary/document.xml` (docx4j GlossaryDocumentPart). */
 export declare class GlossaryDocumentPart extends DocumentPart<wml.GlossaryDocument> {
@@ -47,8 +98,74 @@ export declare class GlossaryDocumentPart extends DocumentPart<wml.GlossaryDocum
 export declare class StyleDefinitionsPart extends XmlPart<wml.Styles> {
     constructor(partName?: PartName | string);
 }
+/**
+ * `/word/numbering.xml` (docx4j NumberingDefinitionsPart): the list definitions, the indent a
+ * level contributes, and the `Emulator` that turns a paragraph into a label.
+ *
+ * The definitions are read **privately** (`readContents()`), as the `PropertyResolver` reads the
+ * styles, so that a document whose labels are only read still saves byte for byte; where the
+ * package already has a resolver the definitions it built are reused, since it needs them for
+ * `getInd`. A change to the part is picked up by `WordprocessingMLPackage.refresh()`.
+ */
 export declare class NumberingDefinitionsPart extends XmlPart<wml.Numbering> {
     constructor(partName?: PartName | string);
+    /** The tree `readContents()` gave, kept so the definitions can be rebuilt without re-reading. */
+    private privateTree;
+    private ownDefinitions;
+    private ownDefinitionsFrom;
+    private emulator;
+    /** The resolver of the package this part belongs to, if it has one built. */
+    private get resolver();
+    /** The `w:numbering` the definitions are built over: the live tree, or the private read. */
+    private get tree();
+    /**
+     * docx4j `initialiseMaps` and the two maps it fills: every `w:abstractNum` and every `w:num`,
+     * with `w:numStyleLink` resolved. Synchronous, so the part's tree must have been read - by
+     * {@link getDefinitions}, or by the package's `getPropertyResolver()`.
+     */
+    get definitions(): NumberingDefinitions;
+    /** {@link definitions}, reading the part first where nothing has. */
+    getDefinitions(): Promise<NumberingDefinitions>;
+    /** `w:abstractNumId` -> the definition. docx4j `getAbstractListDefinitions()`. */
+    get abstractListDefinitions(): ReadonlyMap<string, AbstractListDefinition>;
+    /** `w:numId` -> the definition. docx4j `getInstanceListDefinitions()`. */
+    get instanceListDefinitions(): ReadonlyMap<string, ListDefinition>;
+    /** The indent a `w:numPr`'s level contributes. docx4j `getInd(NumPr)`. */
+    getInd(numPr: wml.PPrBase.NumPr): wml.PPrBase.Ind | undefined;
+    /** The indent a level contributes. docx4j `getInd(String, String)`. */
+    getIndOf(numId: string, ilvl: string | undefined): wml.PPrBase.Ind | undefined;
+    /** The paragraph style a level is linked to (ECMA-376 17.9.24), or undefined. */
+    getLinkedStyleId(numId: string, ilvl: string | undefined): string | undefined;
+    /**
+     * docx4j `getEmulator([reset])`: the numbering emulator over this part, built once. `reset`
+     * gives it a fresh default {@link NumberingState} and re-reads the definitions, as docx4j's
+     * does - every list starts again.
+     */
+    getEmulator(reset?: boolean): Emulator;
+    /** The counters the state-less `Emulator` calls use. docx4j `getNumberingState()`. */
+    get numberingState(): NumberingState;
+    /**
+     * Replaces this part's contents with docx4j's default numbering (`numbering.xml` from its
+     * resources): abstractNum 0 is Word's bullet set and abstractNum 1 its decimal set, with
+     * `w:num` 1 naming the decimal one and `w:num` 2 the bullet one.
+     * docx4j `unmarshalDefaultNumbering()`.
+     */
+    unmarshalDefaultNumbering(): Promise<wml.Numbering>;
+    /**
+     * Makes the tree the definitions were built over this part's **live** contents, so that an
+     * edit to a `w:num` or a `w:lvl` is marshalled on save (CR-002 phase H).
+     *
+     * The definitions are read privately (`readContents()`), which keeps a document whose labels
+     * are only read byte for byte; a write has to give that up. Promoting the tree that is
+     * already in hand - rather than unmarshalling the part a second time - is what keeps the
+     * `List` views valid across the change: they hold objects of that very tree.
+     *
+     * Synchronous, since the tree has been read; the part must have been read
+     * (`getDefinitions()`, or the package's `getPropertyResolver()`) or unmarshalled first.
+     */
+    makeLive(): wml.Numbering;
+    /** Forgets the definitions and the emulator: the tree has changed under us. */
+    refreshDefinitions(): void;
 }
 export declare class FontTablePart extends XmlPart<wml.Fonts> {
     constructor(partName?: PartName | string);
@@ -86,6 +203,10 @@ export declare class CommentsExtendedPart extends XmlPart<w15.CTCommentsEx> {
 export declare class CommentsIdsPart extends XmlPart<w16cid.CTCommentsIds> {
     constructor(partName?: PartName | string);
 }
+/** `/word/commentsExtensible.xml` (w16cex, Word 2018): a durable id and a UTC date per comment. Typed since objects 0.1.3. */
+export declare class CommentsExtensiblePart extends XmlPart<w16cex.CTCommentsExtensible> {
+    constructor(partName?: PartName | string);
+}
 export declare class PeoplePart extends XmlPart<w15.CTPeople> {
     constructor(partName?: PartName | string);
 }