@docx4j/core-ts 0.1.0 → 0.1.2

package/dist/office-js/document.mjs

@@ -0,0 +1,267 @@
+// `context.document` and its properties (CR-002 section 3.10): Office JS's Document over a
+// WordprocessingMLPackage. The class names are Office JS's, since `Word.run` callbacks are what
+// this serves; the parts behind them keep docx4j's (DocPropsCorePart, DocumentSettingsPart).
+import * as elDc from '@docx4j/generated-objects-ts/el/org_docx4j_docProps_core_dc_elements';
+import { Docx4JException } from '../opc/exceptions.mjs';
+import { NotSupportedError } from './errors.mjs';
+function literalText(value) {
+    var _a, _b;
+    return (_b = (_a = value === null || value === void 0 ? void 0 : value.content) === null || _a === void 0 ? void 0 : _a.join('')) !== null && _b !== void 0 ? _b : '';
+}
+function literal(text) {
+    return { content: [text] };
+}
+/** dcterms:W3CDTF, as docx4j writes dcterms:created and dcterms:modified. */
+function w3cdtf(date) {
+    return { TYPE_NAME: 'org_docx4j_docProps_core_dc_terms.W3CDTF', content: [date.toISOString().replace(/\.\d{3}Z$/, 'Z')] };
+}
+function dateOf(value) {
+    const text = literalText(value);
+    if (text === '')
+        return undefined;
+    const date = new Date(text);
+    return Number.isNaN(date.getTime()) ? undefined : date;
+}
+function dateOfCalendar(value) {
+    var _a, _b, _c, _d, _e, _f;
+    if (!value || value.year === undefined)
+        return undefined;
+    const ms = Date.UTC(value.year, ((_a = value.month) !== null && _a !== void 0 ? _a : 1) - 1, (_b = value.day) !== null && _b !== void 0 ? _b : 1, (_c = value.hour) !== null && _c !== void 0 ? _c : 0, (_d = value.minute) !== null && _d !== void 0 ? _d : 0, (_e = value.second) !== null && _e !== void 0 ? _e : 0);
+    return new Date(ms - ((_f = value.timezone) !== null && _f !== void 0 ? _f : 0) * 60000);
+}
+function calendarOf(date) {
+    return {
+        year: date.getUTCFullYear(), month: date.getUTCMonth() + 1, day: date.getUTCDate(),
+        hour: date.getUTCHours(), minute: date.getUTCMinutes(), second: date.getUTCSeconds(), timezone: 0,
+    };
+}
+/**
+ * A subset of Office JS `Word.DocumentProperties` over `docProps/core.xml` (docx4j
+ * DocPropsCorePart) and `docProps/app.xml` (DocPropsExtendedPart). Reads report '' or undefined
+ * when a property is absent; a write creates the part when the package has none.
+ */
+export class DocumentProperties {
+    constructor(pkg) {
+        this.pkg = pkg;
+    }
+    coreProps(create) {
+        const part = create ? this.pkg.addDocPropsCorePart() : this.pkg.docPropsCorePart;
+        if (!part)
+            return undefined;
+        if (!part.isUnmarshalled) {
+            if (!create)
+                return undefined;
+            throw new Docx4JException(`${part.partName} is not unmarshalled; await its getContents() first (Word.run does that unless unmarshalSideParts is false)`);
+        }
+        return part.contents;
+    }
+    extendedProps(create) {
+        const part = create ? this.pkg.addDocPropsExtendedPart() : this.pkg.docPropsExtendedPart;
+        if (!part)
+            return undefined;
+        if (!part.isUnmarshalled) {
+            if (!create)
+                return undefined;
+            throw new Docx4JException(`${part.partName} is not unmarshalled; await its getContents() first (Word.run does that unless unmarshalSideParts is false)`);
+        }
+        return part.contents;
+    }
+    /** dc:title. */
+    get title() {
+        var _a, _b;
+        return literalText((_b = (_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.title) === null || _b === void 0 ? void 0 : _b.value);
+    }
+    set title(value) {
+        this.coreProps(true).title = elDc.title(literal(value));
+    }
+    /** dc:subject. */
+    get subject() {
+        var _a;
+        return literalText((_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.subject);
+    }
+    set subject(value) {
+        this.coreProps(true).subject = literal(value);
+    }
+    /** dc:creator (Office JS calls it the author). */
+    get author() {
+        var _a;
+        return literalText((_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.creator);
+    }
+    set author(value) {
+        this.coreProps(true).creator = literal(value);
+    }
+    /** dc:description (Office JS calls it comments). */
+    get comments() {
+        var _a, _b;
+        return literalText((_b = (_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.description) === null || _b === void 0 ? void 0 : _b.value);
+    }
+    set comments(value) {
+        this.coreProps(true).description = elDc.description(literal(value));
+    }
+    /** cp:keywords. */
+    get keywords() {
+        var _a, _b;
+        return (_b = (_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.keywords) !== null && _b !== void 0 ? _b : '';
+    }
+    set keywords(value) {
+        this.coreProps(true).keywords = value;
+    }
+    /** cp:category. */
+    get category() {
+        var _a, _b;
+        return (_b = (_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.category) !== null && _b !== void 0 ? _b : '';
+    }
+    set category(value) {
+        this.coreProps(true).category = value;
+    }
+    /** cp:lastModifiedBy. */
+    get lastAuthor() {
+        var _a, _b;
+        return (_b = (_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.lastModifiedBy) !== null && _b !== void 0 ? _b : '';
+    }
+    set lastAuthor(value) {
+        this.coreProps(true).lastModifiedBy = value;
+    }
+    /** cp:revision. */
+    get revisionNumber() {
+        var _a, _b;
+        return (_b = (_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.revision) !== null && _b !== void 0 ? _b : '';
+    }
+    set revisionNumber(value) {
+        this.coreProps(true).revision = value;
+    }
+    /** dcterms:created. */
+    get creationDate() {
+        var _a;
+        return dateOf((_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.created);
+    }
+    set creationDate(value) {
+        const props = this.coreProps(true);
+        if (value === undefined)
+            delete props.created;
+        else
+            props.created = w3cdtf(value);
+    }
+    /** dcterms:modified. */
+    get lastSaveTime() {
+        var _a;
+        return dateOf((_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.modified);
+    }
+    set lastSaveTime(value) {
+        const props = this.coreProps(true);
+        if (value === undefined)
+            delete props.modified;
+        else
+            props.modified = w3cdtf(value);
+    }
+    /** cp:lastPrinted. */
+    get lastPrintDate() {
+        var _a;
+        return dateOfCalendar((_a = this.coreProps(false)) === null || _a === void 0 ? void 0 : _a.lastPrinted);
+    }
+    set lastPrintDate(value) {
+        const props = this.coreProps(true);
+        if (value === undefined)
+            delete props.lastPrinted;
+        else
+            props.lastPrinted = calendarOf(value);
+    }
+    /** Manager (extended properties). */
+    get manager() {
+        var _a, _b;
+        return (_b = (_a = this.extendedProps(false)) === null || _a === void 0 ? void 0 : _a.manager) !== null && _b !== void 0 ? _b : '';
+    }
+    set manager(value) {
+        this.extendedProps(true).manager = value;
+    }
+    /** Company (extended properties). */
+    get company() {
+        var _a, _b;
+        return (_b = (_a = this.extendedProps(false)) === null || _a === void 0 ? void 0 : _a.company) !== null && _b !== void 0 ? _b : '';
+    }
+    set company(value) {
+        this.extendedProps(true).company = value;
+    }
+    /** Application (extended properties). */
+    get applicationName() {
+        var _a, _b;
+        return (_b = (_a = this.extendedProps(false)) === null || _a === void 0 ? void 0 : _a.application) !== null && _b !== void 0 ? _b : '';
+    }
+    set applicationName(value) {
+        this.extendedProps(true).application = value;
+    }
+    /** Template (extended properties). */
+    get template() {
+        var _a, _b;
+        return (_b = (_a = this.extendedProps(false)) === null || _a === void 0 ? void 0 : _a.template) !== null && _b !== void 0 ? _b : '';
+    }
+    set template(value) {
+        this.extendedProps(true).template = value;
+    }
+    /** DocSecurity (extended properties); read only, as Office JS. */
+    get security() {
+        var _a, _b;
+        return (_b = (_a = this.extendedProps(false)) === null || _a === void 0 ? void 0 : _a.docSecurity) !== null && _b !== void 0 ? _b : 0;
+    }
+}
+/**
+ * A subset of Office JS `Word.Document` over a package. `body` is the main document part's body;
+ * everything else is the document-level surface add-in code reaches for first.
+ */
+export class Document {
+    constructor(
+    /** The package this document is (extension: Office JS has no package). */
+    package_, options = {}) {
+        this.package_ = package_;
+        this.options = options;
+        this.properties = new DocumentProperties(package_);
+    }
+    /** The main document part's body; `Word.run` unmarshalled the part before the callback. */
+    get body() {
+        return this.package_.body;
+    }
+    /** The caller's selection (`Word.run(pkg, fn, { selection })`); there is none in Node. */
+    getSelection() {
+        const selection = this.options.selection;
+        if (!selection) {
+            throw new NotSupportedError('Document', 'getSelection', 'there is no host selection; pass one as Word.run(pkg, fn, { selection })');
+        }
+        return selection;
+    }
+    /**
+     * Office JS `document.changeTrackingMode`: the package's, which is `w:trackRevisions` in the
+     * settings part and, while it is on, makes every edit through the content API write revision
+     * markup (CR-002 phase F). The shim adds nothing of its own; `Word.run` has unmarshalled the
+     * settings part, so both directions are synchronous here.
+     */
+    get changeTrackingMode() {
+        return this.package_.changeTrackingMode;
+    }
+    set changeTrackingMode(mode) {
+        const settings = this.package_.getMainDocumentPart().documentSettingsPart;
+        if (settings && !settings.isUnmarshalled) {
+            throw new Docx4JException(`${settings.partName} is not unmarshalled; await its getContents() first (Word.run does that unless unmarshalSideParts is false)`);
+        }
+        this.package_.changeTrackingMode = mode;
+    }
+    /** Office JS `document.getTrackedChanges()`: the body's, in document order (CR-002 phase F). */
+    getTrackedChanges() {
+        return this.body.getTrackedChanges();
+    }
+    /**
+     * The comments of the document. CR-002 phase G puts `getComments()` on `Body`; until it lands
+     * this reports none, so add-in code that lists comments runs either way.
+     */
+    getComments() {
+        const body = this.body;
+        return typeof body.getComments === 'function' ? body.getComments() : [];
+    }
+    /** The whole document as a flat OPC `pkg:package` string, as Office JS's `body.getOoxml()`. */
+    getOoxml() {
+        return this.package_.saveFlatOpc();
+    }
+    /** The document as a docx (extension; Office JS's `save()` saves in the host). */
+    save() {
+        return this.package_.save();
+    }
+}

package/dist/office-js/enums.d.mts

@@ -0,0 +1,187 @@
+import type { Alignment as AlignmentValue } from '../model/content/Paragraph.mjs';
+import type { UnderlineType as UnderlineTypeValue } from '../model/content/Font.mjs';
+export type { AlignmentValue, UnderlineTypeValue };
+/** Where an insertion goes, as Office JS Word.InsertLocation; a member takes the subset it supports. */
+export declare const InsertLocation: Readonly<{
+    readonly before: "Before";
+    readonly after: "After";
+    readonly start: "Start";
+    readonly end: "End";
+    readonly replace: "Replace";
+}>;
+export type InsertLocationValue = (typeof InsertLocation)[keyof typeof InsertLocation];
+/** Word.Alignment; 'Unknown' is what a paragraph without w:jc reports. */
+export declare const Alignment: Readonly<{
+    readonly unknown: "Unknown";
+    readonly left: "Left";
+    readonly centered: "Centered";
+    readonly right: "Right";
+    readonly justified: "Justified";
+}>;
+/** Word.UnderlineType, the subset w:u expresses (the objects package's UNDERLINE_TO_WML). */
+export declare const UnderlineType: Readonly<{
+    readonly mixed: "Mixed";
+    readonly none: "None";
+    readonly single: "Single";
+    readonly word: "Word";
+    readonly double: "Double";
+    readonly thick: "Thick";
+    readonly dotted: "Dotted";
+    readonly dottedHeavy: "DottedHeavy";
+    readonly dashLine: "DashLine";
+    readonly dashLineHeavy: "DashLineHeavy";
+    readonly dashLineLong: "DashLineLong";
+    readonly dashLineLongHeavy: "DashLineLongHeavy";
+    readonly dotDashLine: "DotDashLine";
+    readonly dotDashLineHeavy: "DotDashLineHeavy";
+    readonly twoDotDashLine: "TwoDotDashLine";
+    readonly twoDotDashLineHeavy: "TwoDotDashLineHeavy";
+    readonly wave: "Wave";
+    readonly waveHeavy: "WaveHeavy";
+    readonly waveDouble: "WaveDouble";
+}>;
+/** Word.ChangeTrackingMode; the tracking itself is CR-002 phase F, the setting is read and written here. */
+export declare const ChangeTrackingMode: Readonly<{
+    readonly off: "Off";
+    readonly trackAll: "TrackAll";
+    readonly trackMineOnly: "TrackMineOnly";
+}>;
+export type ChangeTrackingModeValue = (typeof ChangeTrackingMode)[keyof typeof ChangeTrackingMode];
+/** Word.BreakType; `insertBreak` here takes 'Page' and 'Line' (CR-002 phase B). */
+export declare const BreakType: Readonly<{
+    readonly page: "Page";
+    readonly next: "Next";
+    readonly sectionNext: "SectionNext";
+    readonly sectionContinuous: "SectionContinuous";
+    readonly sectionEven: "SectionEven";
+    readonly sectionOdd: "SectionOdd";
+    readonly line: "Line";
+}>;
+export type BreakTypeValue = (typeof BreakType)[keyof typeof BreakType];
+/** Word.ListLevelType: what a list level paints in front of its paragraphs (CR-002 phase H). */
+export declare const ListLevelType: Readonly<{
+    readonly bullet: "Bullet";
+    readonly number: "Number";
+    readonly picture: "Picture";
+}>;
+export type ListLevelTypeValue = (typeof ListLevelType)[keyof typeof ListLevelType];
+/** Word.ListNumbering: the number formats `list.setLevelNumbering` takes. */
+export declare const ListNumbering: Readonly<{
+    readonly none: "None";
+    readonly arabic: "Arabic";
+    readonly upperRoman: "UpperRoman";
+    readonly lowerRoman: "LowerRoman";
+    readonly upperLetter: "UpperLetter";
+    readonly lowerLetter: "LowerLetter";
+}>;
+export type ListNumberingValue = (typeof ListNumbering)[keyof typeof ListNumbering];
+/** Word.ListBullet: the bullets `list.setLevelBullet` takes. */
+export declare const ListBullet: Readonly<{
+    readonly custom: "Custom";
+    readonly solid: "Solid";
+    readonly hollow: "Hollow";
+    readonly square: "Square";
+    readonly diamonds: "Diamonds";
+    readonly arrow: "Arrow";
+    readonly checkmark: "Checkmark";
+}>;
+export type ListBulletValue = (typeof ListBullet)[keyof typeof ListBullet];
+/** Word.ContentControlType: the kinds w:sdtPr types (CR-002 section 3.5; the views are phase C/E). */
+export declare const ContentControlType: Readonly<{
+    readonly unknown: "Unknown";
+    readonly richText: "RichText";
+    readonly plainText: "PlainText";
+    readonly picture: "Picture";
+    readonly datePicker: "DatePicker";
+    readonly comboBox: "ComboBox";
+    readonly dropDownList: "DropDownList";
+    readonly checkBox: "CheckBox";
+    readonly repeatingSection: "RepeatingSection";
+    readonly repeatingSectionItem: "RepeatingSectionItem";
+    readonly group: "Group";
+    readonly buildingBlockGallery: "BuildingBlockGallery";
+    readonly citation: "Citation";
+    readonly bibliography: "Bibliography";
+    readonly equation: "Equation";
+}>;
+export type ContentControlTypeValue = (typeof ContentControlType)[keyof typeof ContentControlType];
+/**
+ * Word.Style: the values `styleBuiltIn` reads and accepts ('Heading1'; 'Other' is read for a style
+ * that is not built in and cannot be set). `style` is the display name ('Heading 1'); the id is the
+ * views' `styleId` extension. The list agrees with the content API's `BUILT_IN_STYLES` (tested).
+ */
+export declare const Style: Readonly<{
+    readonly other: "Other";
+    readonly normal: "Normal";
+    readonly heading1: "Heading1";
+    readonly heading2: "Heading2";
+    readonly heading3: "Heading3";
+    readonly heading4: "Heading4";
+    readonly heading5: "Heading5";
+    readonly heading6: "Heading6";
+    readonly heading7: "Heading7";
+    readonly heading8: "Heading8";
+    readonly heading9: "Heading9";
+    readonly toc1: "Toc1";
+    readonly toc2: "Toc2";
+    readonly toc3: "Toc3";
+    readonly toc4: "Toc4";
+    readonly toc5: "Toc5";
+    readonly toc6: "Toc6";
+    readonly toc7: "Toc7";
+    readonly toc8: "Toc8";
+    readonly toc9: "Toc9";
+    readonly footnoteText: "FootnoteText";
+    readonly header: "Header";
+    readonly footer: "Footer";
+    readonly caption: "Caption";
+    readonly footnoteReference: "FootnoteReference";
+    readonly endnoteReference: "EndnoteReference";
+    readonly endnoteText: "EndnoteText";
+    readonly title: "Title";
+    readonly subtitle: "Subtitle";
+    readonly hyperlink: "Hyperlink";
+    readonly strong: "Strong";
+    readonly emphasis: "Emphasis";
+    readonly noSpacing: "NoSpacing";
+    readonly listParagraph: "ListParagraph";
+    readonly quote: "Quote";
+    readonly intenseQuote: "IntenseQuote";
+    readonly subtleEmphasis: "SubtleEmphasis";
+    readonly intenseEmphasis: "IntenseEmphasis";
+    readonly subtleReference: "SubtleReference";
+    readonly intenseReference: "IntenseReference";
+    readonly bookTitle: "BookTitle";
+    readonly bibliography: "Bibliography";
+    readonly tocHeading: "TocHeading";
+    readonly tableGrid: "TableGrid";
+    readonly plainTable1: "PlainTable1";
+    readonly plainTable2: "PlainTable2";
+    readonly plainTable3: "PlainTable3";
+    readonly plainTable4: "PlainTable4";
+    readonly plainTable5: "PlainTable5";
+    readonly gridTable1Light: "GridTable1Light";
+    readonly listTable1Light: "ListTable1Light";
+}>;
+export type StyleValue = (typeof Style)[keyof typeof Style];
+/** Word.ErrorCodes, the `code` an error carries. */
+export declare const ErrorCodes: Readonly<{
+    readonly accessDenied: "AccessDenied";
+    readonly generalException: "GeneralException";
+    readonly invalidArgument: "InvalidArgument";
+    readonly itemNotFound: "ItemNotFound";
+    readonly notAllowed: "NotAllowed";
+    readonly notImplemented: "NotImplemented";
+    readonly searchDialogIsOpen: "SearchDialogIsOpen";
+    readonly searchStringInvalidOrTooLong: "SearchStringInvalidOrTooLong";
+}>;
+/** Word.SearchOptions: the options `search` takes (the content API's `SearchOptions`). */
+export interface SearchOptions {
+    matchCase?: boolean;
+    matchWholeWord?: boolean;
+    matchWildcards?: boolean;
+}
+/** Word.SearchOptions.newObject(): a fresh options bag, as add-in code builds one. */
+export declare const SearchOptions: Readonly<{
+    newObject(): SearchOptions;
+}>;

package/dist/office-js/enums.mjs

@@ -0,0 +1,176 @@
+// The Word enums as objects of the string values this API accepts (CR-002 section 3.10), so that
+// add-in code written as `paragraph.alignment = Word.Alignment.centered` runs unchanged. Office JS
+// declares them as TypeScript enums whose values are the strings; a frozen object of the same
+// keys and values is the JavaScript half of that, and the value types below are the API's.
+/** Where an insertion goes, as Office JS Word.InsertLocation; a member takes the subset it supports. */
+export const InsertLocation = Object.freeze({
+    before: 'Before',
+    after: 'After',
+    start: 'Start',
+    end: 'End',
+    replace: 'Replace',
+});
+/** Word.Alignment; 'Unknown' is what a paragraph without w:jc reports. */
+export const Alignment = Object.freeze({
+    unknown: 'Unknown',
+    left: 'Left',
+    centered: 'Centered',
+    right: 'Right',
+    justified: 'Justified',
+});
+/** Word.UnderlineType, the subset w:u expresses (the objects package's UNDERLINE_TO_WML). */
+export const UnderlineType = Object.freeze({
+    mixed: 'Mixed',
+    none: 'None',
+    single: 'Single',
+    word: 'Word',
+    double: 'Double',
+    thick: 'Thick',
+    dotted: 'Dotted',
+    dottedHeavy: 'DottedHeavy',
+    dashLine: 'DashLine',
+    dashLineHeavy: 'DashLineHeavy',
+    dashLineLong: 'DashLineLong',
+    dashLineLongHeavy: 'DashLineLongHeavy',
+    dotDashLine: 'DotDashLine',
+    dotDashLineHeavy: 'DotDashLineHeavy',
+    twoDotDashLine: 'TwoDotDashLine',
+    twoDotDashLineHeavy: 'TwoDotDashLineHeavy',
+    wave: 'Wave',
+    waveHeavy: 'WaveHeavy',
+    waveDouble: 'WaveDouble',
+});
+/** Word.ChangeTrackingMode; the tracking itself is CR-002 phase F, the setting is read and written here. */
+export const ChangeTrackingMode = Object.freeze({
+    off: 'Off',
+    trackAll: 'TrackAll',
+    trackMineOnly: 'TrackMineOnly',
+});
+/** Word.BreakType; `insertBreak` here takes 'Page' and 'Line' (CR-002 phase B). */
+export const BreakType = Object.freeze({
+    page: 'Page',
+    next: 'Next',
+    sectionNext: 'SectionNext',
+    sectionContinuous: 'SectionContinuous',
+    sectionEven: 'SectionEven',
+    sectionOdd: 'SectionOdd',
+    line: 'Line',
+});
+/** Word.ListLevelType: what a list level paints in front of its paragraphs (CR-002 phase H). */
+export const ListLevelType = Object.freeze({
+    bullet: 'Bullet',
+    number: 'Number',
+    picture: 'Picture',
+});
+/** Word.ListNumbering: the number formats `list.setLevelNumbering` takes. */
+export const ListNumbering = Object.freeze({
+    none: 'None',
+    arabic: 'Arabic',
+    upperRoman: 'UpperRoman',
+    lowerRoman: 'LowerRoman',
+    upperLetter: 'UpperLetter',
+    lowerLetter: 'LowerLetter',
+});
+/** Word.ListBullet: the bullets `list.setLevelBullet` takes. */
+export const ListBullet = Object.freeze({
+    custom: 'Custom',
+    solid: 'Solid',
+    hollow: 'Hollow',
+    square: 'Square',
+    diamonds: 'Diamonds',
+    arrow: 'Arrow',
+    checkmark: 'Checkmark',
+});
+/** Word.ContentControlType: the kinds w:sdtPr types (CR-002 section 3.5; the views are phase C/E). */
+export const ContentControlType = Object.freeze({
+    unknown: 'Unknown',
+    richText: 'RichText',
+    plainText: 'PlainText',
+    picture: 'Picture',
+    datePicker: 'DatePicker',
+    comboBox: 'ComboBox',
+    dropDownList: 'DropDownList',
+    checkBox: 'CheckBox',
+    repeatingSection: 'RepeatingSection',
+    repeatingSectionItem: 'RepeatingSectionItem',
+    group: 'Group',
+    buildingBlockGallery: 'BuildingBlockGallery',
+    citation: 'Citation',
+    bibliography: 'Bibliography',
+    equation: 'Equation',
+});
+/**
+ * Word.Style: the values `styleBuiltIn` reads and accepts ('Heading1'; 'Other' is read for a style
+ * that is not built in and cannot be set). `style` is the display name ('Heading 1'); the id is the
+ * views' `styleId` extension. The list agrees with the content API's `BUILT_IN_STYLES` (tested).
+ */
+export const Style = Object.freeze({
+    other: 'Other',
+    normal: 'Normal',
+    heading1: 'Heading1',
+    heading2: 'Heading2',
+    heading3: 'Heading3',
+    heading4: 'Heading4',
+    heading5: 'Heading5',
+    heading6: 'Heading6',
+    heading7: 'Heading7',
+    heading8: 'Heading8',
+    heading9: 'Heading9',
+    toc1: 'Toc1',
+    toc2: 'Toc2',
+    toc3: 'Toc3',
+    toc4: 'Toc4',
+    toc5: 'Toc5',
+    toc6: 'Toc6',
+    toc7: 'Toc7',
+    toc8: 'Toc8',
+    toc9: 'Toc9',
+    footnoteText: 'FootnoteText',
+    header: 'Header',
+    footer: 'Footer',
+    caption: 'Caption',
+    footnoteReference: 'FootnoteReference',
+    endnoteReference: 'EndnoteReference',
+    endnoteText: 'EndnoteText',
+    title: 'Title',
+    subtitle: 'Subtitle',
+    hyperlink: 'Hyperlink',
+    strong: 'Strong',
+    emphasis: 'Emphasis',
+    noSpacing: 'NoSpacing',
+    listParagraph: 'ListParagraph',
+    quote: 'Quote',
+    intenseQuote: 'IntenseQuote',
+    subtleEmphasis: 'SubtleEmphasis',
+    intenseEmphasis: 'IntenseEmphasis',
+    subtleReference: 'SubtleReference',
+    intenseReference: 'IntenseReference',
+    bookTitle: 'BookTitle',
+    bibliography: 'Bibliography',
+    tocHeading: 'TocHeading',
+    tableGrid: 'TableGrid',
+    plainTable1: 'PlainTable1',
+    plainTable2: 'PlainTable2',
+    plainTable3: 'PlainTable3',
+    plainTable4: 'PlainTable4',
+    plainTable5: 'PlainTable5',
+    gridTable1Light: 'GridTable1Light',
+    listTable1Light: 'ListTable1Light',
+});
+/** Word.ErrorCodes, the `code` an error carries. */
+export const ErrorCodes = Object.freeze({
+    accessDenied: 'AccessDenied',
+    generalException: 'GeneralException',
+    invalidArgument: 'InvalidArgument',
+    itemNotFound: 'ItemNotFound',
+    notAllowed: 'NotAllowed',
+    notImplemented: 'NotImplemented',
+    searchDialogIsOpen: 'SearchDialogIsOpen',
+    searchStringInvalidOrTooLong: 'SearchStringInvalidOrTooLong',
+});
+/** Word.SearchOptions.newObject(): a fresh options bag, as add-in code builds one. */
+export const SearchOptions = Object.freeze({
+    newObject() {
+        return { matchCase: false, matchWholeWord: false, matchWildcards: false };
+    },
+});

package/dist/office-js/errors.d.mts

@@ -0,0 +1,29 @@
+/**
+ * A member of the Word API that this package does not implement. The message names the class and
+ * the member, so an add-in's unsupported call fails at the call with something actionable:
+ * `Word.Paragraph.getNextOrNullObject is not supported by @docx4j/core-ts`.
+ */
+export declare class NotSupportedError extends Error {
+    /** The Word class, as Office JS names it ('Paragraph', 'Body', 'RequestContext'). */
+    readonly className: string;
+    /** The member that was read, written or called. */
+    readonly member: string;
+    /** Word.ErrorCodes.notImplemented. */
+    readonly code = "NotImplemented";
+    constructor(
+    /** The Word class, as Office JS names it ('Paragraph', 'Body', 'RequestContext'). */
+    className: string, 
+    /** The member that was read, written or called. */
+    member: string, detail?: string);
+}
+/** Nothing matched: `getFirst()` on an empty collection, or a member of a null object. */
+export declare class ItemNotFoundError extends Error {
+    /** Word.ErrorCodes.itemNotFound. */
+    readonly code = "ItemNotFound";
+    constructor(message: string);
+}
+/** A result read before `context.sync()` resolved it (Office JS: ValueNotLoaded). */
+export declare class ValueNotLoadedError extends Error {
+    readonly code = "ValueNotLoaded";
+    constructor(message?: string);
+}