@docx4j/core-ts 0.1.0

package/dist/model/content/tree.mjs

@@ -0,0 +1,120 @@
+import { isElement, typeNameOf } from '@docx4j/generated-objects-ts/builders/wml';
+export { isElement, typeNameOf, walk, find, linkParents, textOf, W_NS } from '@docx4j/generated-objects-ts/builders/wml';
+/** Types whose value holds runs (directly or through sdtContent); w:del is not among them: deleted text is not the text. */
+const RUN_HOLDERS = new Set([
+    'org_docx4j_wml.P.Hyperlink', 'org_docx4j_wml.SdtRun', 'org_docx4j_wml.RunIns', 'org_docx4j_wml.CTSmartTagRun',
+    'org_docx4j_wml.CTCustomXmlRun', 'org_docx4j_wml.P.Dir', 'org_docx4j_wml.P.Bdo', 'org_docx4j_wml.CTSimpleField',
+    'org_docx4j_wml.RunTrackChange', 'org_docx4j_wml.CTSdtContentRun',
+]);
+/**
+ * The run-level items a holder keeps, by the model's own property names: `content` for most,
+ * `customXmlOrSmartTagOrSdt` for w:ins, w:del, w:moveFrom and w:moveTo (docx4j's names for
+ * the choice groups), `sdtContent.content` for a run-level content control.
+ */
+export function runItemsOf(value) {
+    const v = value;
+    if (Array.isArray(v.content))
+        return v.content;
+    if (Array.isArray(v.customXmlOrSmartTagOrSdt))
+        return v.customXmlOrSmartTagOrSdt;
+    if (v.sdtContent)
+        return runItemsOf(v.sdtContent);
+    return undefined;
+}
+function itemText(item) {
+    var _a, _b;
+    const t = item.name.localPart;
+    const v = item.value;
+    switch (t) {
+        case 't': return String((_a = v.value) !== null && _a !== void 0 ? _a : '');
+        case 'tab': return '\t';
+        case 'br': return '\n';
+        case 'cr': return '\n';
+        case 'noBreakHyphen': return '‑';
+        case 'softHyphen': return '­';
+        case 'sym': {
+            const code = (_b = v._char) !== null && _b !== void 0 ? _b : v.char;
+            return typeof code === 'string' && /^[0-9A-Fa-f]{4}$/.test(code) ? String.fromCharCode(parseInt(code, 16)) : '';
+        }
+        default: return undefined;
+    }
+}
+/** The text segments of a paragraph (or any run holder) in order. Deleted text (w:del) is skipped. */
+export function segmentsOf(container) {
+    const out = [];
+    let pos = 0;
+    const visitRuns = (items) => {
+        var _a;
+        if (!items)
+            return;
+        for (let i = 0; i < items.length; i++) {
+            const el = items[i];
+            const tn = typeNameOf(el);
+            if (tn === 'org_docx4j_wml.R') {
+                const run = el.value;
+                const content = (_a = run.content) !== null && _a !== void 0 ? _a : [];
+                for (let j = 0; j < content.length; j++) {
+                    const item = content[j];
+                    const text = itemText(item);
+                    if (text === undefined)
+                        continue;
+                    out.push({ item, owner: content, index: j, run, runOwner: items, runIndex: i, text, start: pos, end: pos + text.length, editable: item.name.localPart === 't' });
+                    pos += text.length;
+                }
+            }
+            else if (tn !== undefined && RUN_HOLDERS.has(tn)) {
+                visitRuns(runItemsOf(el.value));
+            }
+        }
+    };
+    visitRuns(runItemsOf(container));
+    return out;
+}
+/** The runs of a paragraph, direct and nested in hyperlinks, content controls and insertions, in order. */
+export function runsOf(container) {
+    const out = [];
+    const visit = (items) => {
+        if (!items)
+            return;
+        for (const el of items) {
+            const tn = typeNameOf(el);
+            if (tn === 'org_docx4j_wml.R')
+                out.push(el);
+            else if (tn !== undefined && RUN_HOLDERS.has(tn))
+                visit(runItemsOf(el.value));
+        }
+    };
+    visit(runItemsOf(container));
+    return out;
+}
+/** The block-level children of a container: body, header, footer, cell, sdt content, table (rows), row (cells). */
+export function childrenOf(value) {
+    var _a;
+    const v = value;
+    if (v.TYPE_NAME === 'org_docx4j_wml.SdtBlock')
+        return (_a = v.sdtContent) === null || _a === void 0 ? void 0 : _a.content;
+    return Array.isArray(v.content) ? v.content : undefined;
+}
+/** True for what a body or cell may hold directly (the Body content union), by TYPE_NAME. */
+export const BLOCK_LEVEL_TYPES = new Set([
+    'org_docx4j_wml.P', 'org_docx4j_wml.Tbl', 'org_docx4j_wml.SdtBlock', 'org_docx4j_wml.CTCustomXmlBlock', 'org_docx4j_wml.CTAltChunk',
+    'org_docx4j_wml.ProofErr', 'org_docx4j_wml.RangePermissionStart', 'org_docx4j_wml.CTPerm', 'org_docx4j_wml.CTBookmark',
+    'org_docx4j_wml.CTMarkupRange', 'org_docx4j_wml.CTMoveBookmark', 'org_docx4j_wml.CTMoveFromRangeEnd', 'org_docx4j_wml.CTMoveToRangeEnd',
+    'org_docx4j_wml.CommentRangeStart', 'org_docx4j_wml.CommentRangeEnd', 'org_docx4j_wml.CTTrackChange', 'org_docx4j_wml.CTMarkup',
+    'org_docx4j_wml.RunIns', 'org_docx4j_wml.RunDel', 'org_docx4j_wml.RunTrackChange', 'org_docx4j_math.CTOMathPara', 'org_docx4j_math.CTOMath',
+]);
+/** A run element with the given items and, optionally, run properties (the builders' r() takes text; this takes items). */
+export function runOf(items, rPr) {
+    const value = { TYPE_NAME: 'org_docx4j_wml.R', content: items };
+    if (rPr)
+        value.rPr = rPr;
+    return { name: { namespaceURI: 'http://schemas.openxmlformats.org/wordprocessingml/2006/main', localPart: 'r' }, value };
+}
+/** A paragraph element with the given runs and, optionally, paragraph properties. */
+export function paragraphOf(runs, pPr) {
+    const value = { TYPE_NAME: 'org_docx4j_wml.P', content: runs };
+    if (pPr)
+        value.pPr = pPr;
+    return { name: { namespaceURI: 'http://schemas.openxmlformats.org/wordprocessingml/2006/main', localPart: 'p' }, value };
+}
+export { isElement as isTypedElement };

package/dist/model/index.d.mts

@@ -0,0 +1 @@
+export * from './content/index.mjs';

package/dist/model/index.mjs

@@ -0,0 +1,2 @@
+// src/model: the content API now; PropertyResolver, list numbering and fonts with CR-001 Phase B.
+export * from './content/index.mjs';

package/dist/opc/ContentTypeManager.d.mts

@@ -0,0 +1,37 @@
+import { PartName } from './PartName.mjs';
+export declare const CONTENT_TYPES_NS = "http://schemas.openxmlformats.org/package/2006/content-types";
+/**
+ * `[Content_Types].xml` (docx4j org.docx4j.openpackaging.contenttype.ContentTypeManager):
+ * `Default` maps an extension to a content type, `Override` a part name. Lookups are
+ * case-insensitive; the names are written back as given.
+ */
+export declare class ContentTypeManager {
+    /** Extension (lower case) to content type. */
+    private readonly defaults;
+    /** Lower-cased part name to [part name as written, content type]. */
+    private readonly overrides;
+    /** A manager with the two defaults every package needs: rels and xml. */
+    static createDefault(): ContentTypeManager;
+    /** Parses `[Content_Types].xml`. */
+    static parse(xml: string): ContentTypeManager;
+    /** The XML of `[Content_Types].xml`, defaults first as Word writes it. */
+    toXml(): string;
+    /** The content type of a part: its override if any, else the default for its extension. */
+    getContentType(partName: PartName | string): string | undefined;
+    addDefaultContentType(extension: string, contentType: string): void;
+    addOverrideContentType(partName: PartName | string, contentType: string): void;
+    /** Registers a part's content type: as a default when one already covers the extension, else as an override (docx4j RelationshipsPart.addPart). */
+    addContentType(partName: PartName | string, contentType: string): void;
+    /** Removes the override for a part; when there is none, the default for its extension (docx4j semantics). */
+    removeContentType(partName: PartName | string): void;
+    removeOverrideContentType(partName: PartName | string): void;
+    removeDefaultContentType(extension: string): void;
+    getDefaultContentType(extension: string): string | undefined;
+    getOverrideContentType(partName: PartName | string): string | undefined;
+    /** Whether any default or override names this content type. */
+    isContentTypeRegistered(contentType: string): boolean;
+    /** Part names overridden to a content type (docx4j getPartNameOverridenByContentType, all of them). */
+    getPartNamesForContentType(contentType: string): PartName[];
+    get defaultEntries(): ReadonlyMap<string, string>;
+    get overrideEntries(): [PartName, string][];
+}

package/dist/opc/ContentTypeManager.mjs

@@ -0,0 +1,126 @@
+import { PartName } from './PartName.mjs';
+import { ContentTypes } from './ContentTypes.mjs';
+import { InvalidFormatException } from './exceptions.mjs';
+import { XML_DECLARATION, parseXml, childElements } from '../xml/dom.mjs';
+export const CONTENT_TYPES_NS = 'http://schemas.openxmlformats.org/package/2006/content-types';
+/**
+ * `[Content_Types].xml` (docx4j org.docx4j.openpackaging.contenttype.ContentTypeManager):
+ * `Default` maps an extension to a content type, `Override` a part name. Lookups are
+ * case-insensitive; the names are written back as given.
+ */
+export class ContentTypeManager {
+    constructor() {
+        /** Extension (lower case) to content type. */
+        this.defaults = new Map();
+        /** Lower-cased part name to [part name as written, content type]. */
+        this.overrides = new Map();
+    }
+    /** A manager with the two defaults every package needs: rels and xml. */
+    static createDefault() {
+        const ctm = new ContentTypeManager();
+        ctm.addDefaultContentType('rels', ContentTypes.RELATIONSHIPS_PART);
+        ctm.addDefaultContentType('xml', ContentTypes.APPLICATION_XML);
+        return ctm;
+    }
+    /** Parses `[Content_Types].xml`. */
+    static parse(xml) {
+        const ctm = new ContentTypeManager();
+        const doc = parseXml(xml);
+        const root = doc.documentElement;
+        if (root.localName !== 'Types')
+            throw new InvalidFormatException(`[Content_Types].xml: expected Types, found ${root.nodeName}`);
+        for (const el of childElements(root)) {
+            if (el.localName === 'Default') {
+                const ext = el.getAttribute('Extension');
+                const ct = el.getAttribute('ContentType');
+                if (ext !== null && ct !== null)
+                    ctm.addDefaultContentType(ext, ct);
+            }
+            else if (el.localName === 'Override') {
+                const name = el.getAttribute('PartName');
+                const ct = el.getAttribute('ContentType');
+                if (name !== null && ct !== null)
+                    ctm.addOverrideContentType(name, ct);
+            }
+        }
+        return ctm;
+    }
+    /** The XML of `[Content_Types].xml`, defaults first as Word writes it. */
+    toXml() {
+        let out = `${XML_DECLARATION}<Types xmlns="${CONTENT_TYPES_NS}">`;
+        for (const [ext, ct] of this.defaults)
+            out += `<Default Extension="${escapeAttr(ext)}" ContentType="${escapeAttr(ct)}"/>`;
+        for (const [, [name, ct]] of this.overrides)
+            out += `<Override PartName="${escapeAttr(name)}" ContentType="${escapeAttr(ct)}"/>`;
+        return out + '</Types>';
+    }
+    /** The content type of a part: its override if any, else the default for its extension. */
+    getContentType(partName) {
+        const pn = PartName.of(partName);
+        const override = this.overrides.get(pn.key);
+        if (override)
+            return override[1];
+        return this.defaults.get(pn.extension.toLowerCase());
+    }
+    addDefaultContentType(extension, contentType) {
+        this.defaults.set(extension.toLowerCase(), contentType);
+    }
+    addOverrideContentType(partName, contentType) {
+        const pn = PartName.of(partName);
+        this.overrides.set(pn.key, [pn.name, contentType]);
+    }
+    /** Registers a part's content type: as a default when one already covers the extension, else as an override (docx4j RelationshipsPart.addPart). */
+    addContentType(partName, contentType) {
+        const pn = PartName.of(partName);
+        if (this.defaults.get(pn.extension.toLowerCase()) === contentType)
+            return;
+        this.addOverrideContentType(pn, contentType);
+    }
+    /** Removes the override for a part; when there is none, the default for its extension (docx4j semantics). */
+    removeContentType(partName) {
+        const pn = PartName.of(partName);
+        if (this.overrides.delete(pn.key))
+            return;
+        this.defaults.delete(pn.extension.toLowerCase());
+    }
+    removeOverrideContentType(partName) {
+        this.overrides.delete(PartName.of(partName).key);
+    }
+    removeDefaultContentType(extension) {
+        this.defaults.delete(extension.toLowerCase());
+    }
+    getDefaultContentType(extension) {
+        return this.defaults.get(extension.toLowerCase());
+    }
+    getOverrideContentType(partName) {
+        var _a;
+        return (_a = this.overrides.get(PartName.of(partName).key)) === null || _a === void 0 ? void 0 : _a[1];
+    }
+    /** Whether any default or override names this content type. */
+    isContentTypeRegistered(contentType) {
+        for (const ct of this.defaults.values())
+            if (ct === contentType)
+                return true;
+        for (const [, ct] of this.overrides.values())
+            if (ct === contentType)
+                return true;
+        return false;
+    }
+    /** Part names overridden to a content type (docx4j getPartNameOverridenByContentType, all of them). */
+    getPartNamesForContentType(contentType) {
+        const out = [];
+        for (const [name, ct] of this.overrides.values())
+            if (ct === contentType)
+                out.push(PartName.of(name));
+        return out;
+    }
+    get defaultEntries() {
+        return this.defaults;
+    }
+    get overrideEntries() {
+        return [...this.overrides.values()].map(([name, ct]) => [PartName.of(name), ct]);
+    }
+}
+function escapeAttr(s) {
+    return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/"/g, '&quot;');
+}

package/dist/opc/ContentTypes.d.mts

@@ -0,0 +1,118 @@
+/** Content type constants, as docx4j org.docx4j.openpackaging.contenttype.ContentTypes. */
+export declare const ContentTypes: {
+    readonly CONTENT_TYPES_PART: "application/vnd.openxmlformats-package.content-types+xml";
+    readonly RELATIONSHIPS_PART: "application/vnd.openxmlformats-package.relationships+xml";
+    readonly APPLICATION_XML: "application/xml";
+    readonly XML: "text/xml";
+    readonly PACKAGE_COREPROPERTIES: "application/vnd.openxmlformats-package.core-properties+xml";
+    readonly OFFICEDOCUMENT_CUSTOMPROPERTIES: "application/vnd.openxmlformats-officedocument.custom-properties+xml";
+    readonly OFFICEDOCUMENT_EXTENDEDPROPERTIES: "application/vnd.openxmlformats-officedocument.extended-properties+xml";
+    readonly OFFICEDOCUMENT_CUSTOMXML_DATASTORAGEPROPERTIES: "application/vnd.openxmlformats-officedocument.customXmlProperties+xml";
+    readonly OFFICEDOCUMENT_CUSTOMXML_DATASTORAGE: "application/xml";
+    readonly OFFICEDOCUMENT_THEME: "application/vnd.openxmlformats-officedocument.theme+xml";
+    readonly OFFICEDOCUMENT_THEME_OVERRIDE: "application/vnd.openxmlformats-officedocument.themeOverride+xml";
+    readonly OFFICEDOCUMENT_FONT: "application/vnd.openxmlformats-officedocument.obfuscatedFont";
+    readonly TRUETYPE_FONT: "application/x-font-ttf";
+    readonly OFFICEDOCUMENT_VBA_PROJECT: "application/vnd.ms-office.vbaProject";
+    readonly OFFICEDOCUMENT_VBA_DATA: "application/vnd.ms-word.vbaData+xml";
+    readonly OFFICEDOCUMENT_VBA_PROJECT_SIGNATURE: "application/vnd.ms-office.vbaProjectSignature";
+    readonly OFFICEDOCUMENT_OLE_OBJECT: "application/vnd.openxmlformats-officedocument.oleObject";
+    readonly OFFICEDOCUMENT_ACTIVEX_OBJECT: "application/vnd.ms-office.activeX";
+    readonly OFFICEDOCUMENT_ACTIVEX_XML_OBJECT: "application/vnd.ms-office.activeX+xml";
+    readonly WEB_EXTENSION_TASKPANES: "application/vnd.ms-office.webextensiontaskpanes+xml";
+    readonly WEB_EXTENSION_WEBEXTENSION: "application/vnd.ms-office.webextension+xml";
+    readonly WORDPROCESSINGML_DOCUMENT: "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml";
+    readonly WORDPROCESSINGML_DOCUMENT_MACROENABLED: "application/vnd.ms-word.document.macroEnabled.main+xml";
+    readonly WORDPROCESSINGML_TEMPLATE: "application/vnd.openxmlformats-officedocument.wordprocessingml.template.main+xml";
+    readonly WORDPROCESSINGML_TEMPLATE_MACROENABLED: "application/vnd.ms-word.template.macroEnabledTemplate.main+xml";
+    readonly WORDPROCESSINGML_COMMENTS: "application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml";
+    readonly WORDPROCESSINGML_COMMENTS_EXTENDED: "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml";
+    readonly WORDPROCESSINGML_COMMENTS_IDS: "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsIds+xml";
+    readonly WORDPROCESSINGML_ENDNOTES: "application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml";
+    readonly WORDPROCESSINGML_FONTTABLE: "application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml";
+    readonly WORDPROCESSINGML_FOOTER: "application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml";
+    readonly WORDPROCESSINGML_FOOTNOTES: "application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml";
+    readonly WORDPROCESSINGML_GLOSSARYDOCUMENT: "application/vnd.openxmlformats-officedocument.wordprocessingml.document.glossary+xml";
+    readonly WORDPROCESSINGML_HEADER: "application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml";
+    readonly MS_WORD_KEYMAP: "application/vnd.ms-word.keyMapCustomizations+xml";
+    readonly WORDPROCESSINGML_NUMBERING: "application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml";
+    readonly WORDPROCESSINGML_PEOPLE: "application/vnd.openxmlformats-officedocument.wordprocessingml.people+xml";
+    readonly WORDPROCESSINGML_SETTINGS: "application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml";
+    readonly WORDPROCESSINGML_STYLES: "application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml";
+    readonly WORDPROCESSINGML_STYLESWITHEFFECTS: "application/vnd.ms-word.stylesWithEffects+xml";
+    readonly WORDPROCESSINGML_WEBSETTINGS: "application/vnd.openxmlformats-officedocument.wordprocessingml.webSettings+xml";
+    readonly DRAWINGML_DIAGRAM_DATA: "application/vnd.openxmlformats-officedocument.drawingml.diagramData+xml";
+    readonly DRAWINGML_DIAGRAM_LAYOUT: "application/vnd.openxmlformats-officedocument.drawingml.diagramLayout+xml";
+    readonly DRAWINGML_DIAGRAM_COLORS: "application/vnd.openxmlformats-officedocument.drawingml.diagramColors+xml";
+    readonly DRAWINGML_DIAGRAM_STYLE: "application/vnd.openxmlformats-officedocument.drawingml.diagramStyle+xml";
+    readonly DRAWINGML_DIAGRAM_LAYOUT_HEADER: "application/vnd.openxmlformats-officedocument.drawingml.diagramLayoutHeader+xml";
+    readonly DRAWINGML_DIAGRAM_DRAWING: "application/vnd.ms-office.drawingml.diagramDrawing+xml";
+    readonly DRAWINGML_CHART: "application/vnd.openxmlformats-officedocument.drawingml.chart+xml";
+    readonly DRAWINGML_DRAWING: "application/vnd.openxmlformats-officedocument.drawing+xml";
+    readonly DRAWINGML_CHART_SHAPES: "application/vnd.openxmlformats-officedocument.drawingml.chartshapes+xml";
+    readonly CHART_EX: "application/vnd.ms-office.chartex+xml";
+    readonly CHART_STYLE: "application/vnd.ms-office.chartstyle+xml";
+    readonly CHART_COLOR_STYLE: "application/vnd.ms-office.chartcolorstyle+xml";
+    readonly VML_DRAWING: "application/vnd.openxmlformats-officedocument.vmlDrawing";
+    readonly PRESENTATION: "application/vnd.openxmlformats-officedocument.presentationml.presentation";
+    readonly PRESENTATIONML_MAIN: "application/vnd.openxmlformats-officedocument.presentationml.presentation.main+xml";
+    readonly PRESENTATIONML_MACROENABLED: "application/vnd.ms-powerpoint.presentation.macroEnabled.main+xml";
+    readonly PRESENTATIONML_TEMPLATE: "application/vnd.openxmlformats-officedocument.presentationml.template.main+xml";
+    readonly PRESENTATIONML_TEMPLATE_MACROENABLED: "application/vnd.ms-powerpoint.template.macroEnabled.main+xml";
+    readonly PRESENTATIONML_SLIDESHOW: "application/vnd.openxmlformats-officedocument.presentationml.slideshow.main+xml";
+    readonly PRESENTATIONML_COMMENTS: "application/vnd.openxmlformats-officedocument.presentationml.comments+xml";
+    readonly PRESENTATIONML_COMMENT_AUTHORS: "application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml";
+    readonly PRESENTATIONML_FONT_DATA: "application/x-fontdata";
+    readonly PRESENTATIONML_SLIDE: "application/vnd.openxmlformats-officedocument.presentationml.slide+xml";
+    readonly PRESENTATIONML_SLIDE_MASTER: "application/vnd.openxmlformats-officedocument.presentationml.slideMaster+xml";
+    readonly PRESENTATIONML_SLIDE_LAYOUT: "application/vnd.openxmlformats-officedocument.presentationml.slideLayout+xml";
+    readonly PRESENTATIONML_TABLE_STYLES: "application/vnd.openxmlformats-officedocument.presentationml.tableStyles+xml";
+    readonly PRESENTATIONML_PRES_PROPS: "application/vnd.openxmlformats-officedocument.presentationml.presProps+xml";
+    readonly PRESENTATIONML_VIEW_PROPS: "application/vnd.openxmlformats-officedocument.presentationml.viewProps+xml";
+    readonly PRESENTATIONML_TAGS: "application/vnd.openxmlformats-officedocument.presentationml.tags+xml";
+    readonly PRESENTATIONML_NOTES_SLIDE: "application/vnd.openxmlformats-officedocument.presentationml.notesSlide+xml";
+    readonly PRESENTATIONML_NOTES_MASTER: "application/vnd.openxmlformats-officedocument.presentationml.notesMaster+xml";
+    readonly PRESENTATIONML_HANDOUT_MASTER: "application/vnd.openxmlformats-officedocument.presentationml.handoutMaster+xml";
+    readonly SPREADSHEETML_WORKBOOK: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml";
+    readonly SPREADSHEETML_WORKBOOK_MACROENABLED: "application/vnd.ms-excel.sheet.macroEnabled.main+xml";
+    readonly SPREADSHEETML_TEMPLATE: "application/vnd.openxmlformats-officedocument.spreadsheetml.template.main+xml";
+    readonly SPREADSHEETML_TEMPLATE_MACROENABLED: "application/vnd.ms-excel.template.macroEnabled.main+xml";
+    readonly SPREADSHEETML_PRINTER_SETTINGS: "application/vnd.openxmlformats-officedocument.spreadsheetml.printerSettings";
+    readonly SPREADSHEETML_STYLES: "application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml";
+    readonly SPREADSHEETML_WORKSHEET: "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml";
+    readonly SPREADSHEETML_CHARTSHEET: "application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml";
+    readonly SPREADSHEETML_CALC_CHAIN: "application/vnd.openxmlformats-officedocument.spreadsheetml.calcChain+xml";
+    readonly SPREADSHEETML_SHARED_STRINGS: "application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml";
+    readonly SPREADSHEETML_PIVOT_CACHE_DEFINITION: "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheDefinition+xml";
+    readonly SPREADSHEETML_PIVOT_CACHE_RECORDS: "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheRecords+xml";
+    readonly SPREADSHEETML_PIVOT_TABLE: "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotTable+xml";
+    readonly SPREADSHEETML_QUERY_TABLE: "application/vnd.openxmlformats-officedocument.spreadsheetml.queryTable+xml";
+    readonly SPREADSHEETML_TABLE: "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml";
+    readonly SPREADSHEETML_COMMENTS: "application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml";
+    readonly SPREADSHEETML_CONNECTIONS: "application/vnd.openxmlformats-officedocument.spreadsheetml.connections+xml";
+    readonly SPREADSHEETML_EXTERNAL_LINK: "application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml";
+    readonly DIGITAL_SIGNATURE_ORIGIN_PART: "application/vnd.openxmlformats-package.digital-signature-origin";
+    readonly DIGITAL_SIGNATURE_XML_SIGNATURE_PART: "application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml";
+    readonly INK_ML: "application/inkml+xml";
+    readonly IMAGE_EMF: "image/x-emf";
+    readonly IMAGE_EMF2: "image/emf";
+    readonly IMAGE_WMF: "image/x-wmf";
+    readonly IMAGE_GIF: "image/gif";
+    readonly IMAGE_JPEG: "image/jpeg";
+    readonly IMAGE_JPEG_XR: "image/vnd.ms-photo";
+    readonly IMAGE_PICT: "image/pict";
+    readonly IMAGE_PNG: "image/png";
+    readonly IMAGE_X_PNG: "image/x-png";
+    readonly IMAGE_TIFF: "image/tiff";
+    readonly IMAGE_WEBP: "image/webp";
+    readonly IMAGE_EPS: "application/postscript";
+    readonly IMAGE_BMP: "image/bmp";
+    readonly IMAGE_SVG: "image/svg+xml";
+    readonly OCTET_STREAM: "application/octet-stream";
+};
+/** Content type by lower-case file extension for the image kinds the object model relates to. */
+export declare const IMAGE_CONTENT_TYPES_BY_EXTENSION: Readonly<Record<string, string>>;
+/** Whether bytes of this content type are XML (parsed to a DOM when the registry has no typed part). */
+export declare function isXmlContentType(contentType: string | undefined): boolean;
+/** Already-compressed media, stored rather than deflated in a zip (docx4j ZipPartStore.shouldCompress). */
+export declare function isStoredUncompressed(contentType: string | undefined): boolean;

package/dist/opc/ContentTypes.mjs

@@ -0,0 +1,139 @@
+/** Content type constants, as docx4j org.docx4j.openpackaging.contenttype.ContentTypes. */
+export const ContentTypes = {
+    CONTENT_TYPES_PART: 'application/vnd.openxmlformats-package.content-types+xml',
+    RELATIONSHIPS_PART: 'application/vnd.openxmlformats-package.relationships+xml',
+    APPLICATION_XML: 'application/xml',
+    XML: 'text/xml',
+    PACKAGE_COREPROPERTIES: 'application/vnd.openxmlformats-package.core-properties+xml',
+    OFFICEDOCUMENT_CUSTOMPROPERTIES: 'application/vnd.openxmlformats-officedocument.custom-properties+xml',
+    OFFICEDOCUMENT_EXTENDEDPROPERTIES: 'application/vnd.openxmlformats-officedocument.extended-properties+xml',
+    OFFICEDOCUMENT_CUSTOMXML_DATASTORAGEPROPERTIES: 'application/vnd.openxmlformats-officedocument.customXmlProperties+xml',
+    OFFICEDOCUMENT_CUSTOMXML_DATASTORAGE: 'application/xml',
+    OFFICEDOCUMENT_THEME: 'application/vnd.openxmlformats-officedocument.theme+xml',
+    OFFICEDOCUMENT_THEME_OVERRIDE: 'application/vnd.openxmlformats-officedocument.themeOverride+xml',
+    OFFICEDOCUMENT_FONT: 'application/vnd.openxmlformats-officedocument.obfuscatedFont',
+    TRUETYPE_FONT: 'application/x-font-ttf',
+    OFFICEDOCUMENT_VBA_PROJECT: 'application/vnd.ms-office.vbaProject',
+    OFFICEDOCUMENT_VBA_DATA: 'application/vnd.ms-word.vbaData+xml',
+    OFFICEDOCUMENT_VBA_PROJECT_SIGNATURE: 'application/vnd.ms-office.vbaProjectSignature',
+    OFFICEDOCUMENT_OLE_OBJECT: 'application/vnd.openxmlformats-officedocument.oleObject',
+    OFFICEDOCUMENT_ACTIVEX_OBJECT: 'application/vnd.ms-office.activeX',
+    OFFICEDOCUMENT_ACTIVEX_XML_OBJECT: 'application/vnd.ms-office.activeX+xml',
+    WEB_EXTENSION_TASKPANES: 'application/vnd.ms-office.webextensiontaskpanes+xml',
+    WEB_EXTENSION_WEBEXTENSION: 'application/vnd.ms-office.webextension+xml',
+    WORDPROCESSINGML_DOCUMENT: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml',
+    WORDPROCESSINGML_DOCUMENT_MACROENABLED: 'application/vnd.ms-word.document.macroEnabled.main+xml',
+    WORDPROCESSINGML_TEMPLATE: 'application/vnd.openxmlformats-officedocument.wordprocessingml.template.main+xml',
+    WORDPROCESSINGML_TEMPLATE_MACROENABLED: 'application/vnd.ms-word.template.macroEnabledTemplate.main+xml',
+    WORDPROCESSINGML_COMMENTS: 'application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml',
+    WORDPROCESSINGML_COMMENTS_EXTENDED: 'application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml',
+    WORDPROCESSINGML_COMMENTS_IDS: 'application/vnd.openxmlformats-officedocument.wordprocessingml.commentsIds+xml',
+    WORDPROCESSINGML_ENDNOTES: 'application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml',
+    WORDPROCESSINGML_FONTTABLE: 'application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml',
+    WORDPROCESSINGML_FOOTER: 'application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml',
+    WORDPROCESSINGML_FOOTNOTES: 'application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml',
+    WORDPROCESSINGML_GLOSSARYDOCUMENT: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.glossary+xml',
+    WORDPROCESSINGML_HEADER: 'application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml',
+    MS_WORD_KEYMAP: 'application/vnd.ms-word.keyMapCustomizations+xml',
+    WORDPROCESSINGML_NUMBERING: 'application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml',
+    WORDPROCESSINGML_PEOPLE: 'application/vnd.openxmlformats-officedocument.wordprocessingml.people+xml',
+    WORDPROCESSINGML_SETTINGS: 'application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml',
+    WORDPROCESSINGML_STYLES: 'application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml',
+    WORDPROCESSINGML_STYLESWITHEFFECTS: 'application/vnd.ms-word.stylesWithEffects+xml',
+    WORDPROCESSINGML_WEBSETTINGS: 'application/vnd.openxmlformats-officedocument.wordprocessingml.webSettings+xml',
+    DRAWINGML_DIAGRAM_DATA: 'application/vnd.openxmlformats-officedocument.drawingml.diagramData+xml',
+    DRAWINGML_DIAGRAM_LAYOUT: 'application/vnd.openxmlformats-officedocument.drawingml.diagramLayout+xml',
+    DRAWINGML_DIAGRAM_COLORS: 'application/vnd.openxmlformats-officedocument.drawingml.diagramColors+xml',
+    DRAWINGML_DIAGRAM_STYLE: 'application/vnd.openxmlformats-officedocument.drawingml.diagramStyle+xml',
+    DRAWINGML_DIAGRAM_LAYOUT_HEADER: 'application/vnd.openxmlformats-officedocument.drawingml.diagramLayoutHeader+xml',
+    DRAWINGML_DIAGRAM_DRAWING: 'application/vnd.ms-office.drawingml.diagramDrawing+xml',
+    DRAWINGML_CHART: 'application/vnd.openxmlformats-officedocument.drawingml.chart+xml',
+    DRAWINGML_DRAWING: 'application/vnd.openxmlformats-officedocument.drawing+xml',
+    DRAWINGML_CHART_SHAPES: 'application/vnd.openxmlformats-officedocument.drawingml.chartshapes+xml',
+    CHART_EX: 'application/vnd.ms-office.chartex+xml',
+    CHART_STYLE: 'application/vnd.ms-office.chartstyle+xml',
+    CHART_COLOR_STYLE: 'application/vnd.ms-office.chartcolorstyle+xml',
+    VML_DRAWING: 'application/vnd.openxmlformats-officedocument.vmlDrawing',
+    PRESENTATION: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    PRESENTATIONML_MAIN: 'application/vnd.openxmlformats-officedocument.presentationml.presentation.main+xml',
+    PRESENTATIONML_MACROENABLED: 'application/vnd.ms-powerpoint.presentation.macroEnabled.main+xml',
+    PRESENTATIONML_TEMPLATE: 'application/vnd.openxmlformats-officedocument.presentationml.template.main+xml',
+    PRESENTATIONML_TEMPLATE_MACROENABLED: 'application/vnd.ms-powerpoint.template.macroEnabled.main+xml',
+    PRESENTATIONML_SLIDESHOW: 'application/vnd.openxmlformats-officedocument.presentationml.slideshow.main+xml',
+    PRESENTATIONML_COMMENTS: 'application/vnd.openxmlformats-officedocument.presentationml.comments+xml',
+    PRESENTATIONML_COMMENT_AUTHORS: 'application/vnd.openxmlformats-officedocument.presentationml.commentAuthors+xml',
+    PRESENTATIONML_FONT_DATA: 'application/x-fontdata',
+    PRESENTATIONML_SLIDE: 'application/vnd.openxmlformats-officedocument.presentationml.slide+xml',
+    PRESENTATIONML_SLIDE_MASTER: 'application/vnd.openxmlformats-officedocument.presentationml.slideMaster+xml',
+    PRESENTATIONML_SLIDE_LAYOUT: 'application/vnd.openxmlformats-officedocument.presentationml.slideLayout+xml',
+    PRESENTATIONML_TABLE_STYLES: 'application/vnd.openxmlformats-officedocument.presentationml.tableStyles+xml',
+    PRESENTATIONML_PRES_PROPS: 'application/vnd.openxmlformats-officedocument.presentationml.presProps+xml',
+    PRESENTATIONML_VIEW_PROPS: 'application/vnd.openxmlformats-officedocument.presentationml.viewProps+xml',
+    PRESENTATIONML_TAGS: 'application/vnd.openxmlformats-officedocument.presentationml.tags+xml',
+    PRESENTATIONML_NOTES_SLIDE: 'application/vnd.openxmlformats-officedocument.presentationml.notesSlide+xml',
+    PRESENTATIONML_NOTES_MASTER: 'application/vnd.openxmlformats-officedocument.presentationml.notesMaster+xml',
+    PRESENTATIONML_HANDOUT_MASTER: 'application/vnd.openxmlformats-officedocument.presentationml.handoutMaster+xml',
+    SPREADSHEETML_WORKBOOK: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml',
+    SPREADSHEETML_WORKBOOK_MACROENABLED: 'application/vnd.ms-excel.sheet.macroEnabled.main+xml',
+    SPREADSHEETML_TEMPLATE: 'application/vnd.openxmlformats-officedocument.spreadsheetml.template.main+xml',
+    SPREADSHEETML_TEMPLATE_MACROENABLED: 'application/vnd.ms-excel.template.macroEnabled.main+xml',
+    SPREADSHEETML_PRINTER_SETTINGS: 'application/vnd.openxmlformats-officedocument.spreadsheetml.printerSettings',
+    SPREADSHEETML_STYLES: 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml',
+    SPREADSHEETML_WORKSHEET: 'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml',
+    SPREADSHEETML_CHARTSHEET: 'application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml',
+    SPREADSHEETML_CALC_CHAIN: 'application/vnd.openxmlformats-officedocument.spreadsheetml.calcChain+xml',
+    SPREADSHEETML_SHARED_STRINGS: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml',
+    SPREADSHEETML_PIVOT_CACHE_DEFINITION: 'application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheDefinition+xml',
+    SPREADSHEETML_PIVOT_CACHE_RECORDS: 'application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheRecords+xml',
+    SPREADSHEETML_PIVOT_TABLE: 'application/vnd.openxmlformats-officedocument.spreadsheetml.pivotTable+xml',
+    SPREADSHEETML_QUERY_TABLE: 'application/vnd.openxmlformats-officedocument.spreadsheetml.queryTable+xml',
+    SPREADSHEETML_TABLE: 'application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml',
+    SPREADSHEETML_COMMENTS: 'application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml',
+    SPREADSHEETML_CONNECTIONS: 'application/vnd.openxmlformats-officedocument.spreadsheetml.connections+xml',
+    SPREADSHEETML_EXTERNAL_LINK: 'application/vnd.openxmlformats-officedocument.spreadsheetml.externalLink+xml',
+    DIGITAL_SIGNATURE_ORIGIN_PART: 'application/vnd.openxmlformats-package.digital-signature-origin',
+    DIGITAL_SIGNATURE_XML_SIGNATURE_PART: 'application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml',
+    INK_ML: 'application/inkml+xml',
+    IMAGE_EMF: 'image/x-emf',
+    IMAGE_EMF2: 'image/emf',
+    IMAGE_WMF: 'image/x-wmf',
+    IMAGE_GIF: 'image/gif',
+    IMAGE_JPEG: 'image/jpeg',
+    IMAGE_JPEG_XR: 'image/vnd.ms-photo',
+    IMAGE_PICT: 'image/pict',
+    IMAGE_PNG: 'image/png',
+    IMAGE_X_PNG: 'image/x-png',
+    IMAGE_TIFF: 'image/tiff',
+    IMAGE_WEBP: 'image/webp',
+    IMAGE_EPS: 'application/postscript',
+    IMAGE_BMP: 'image/bmp',
+    IMAGE_SVG: 'image/svg+xml',
+    OCTET_STREAM: 'application/octet-stream',
+};
+/** Content type by lower-case file extension for the image kinds the object model relates to. */
+export const IMAGE_CONTENT_TYPES_BY_EXTENSION = {
+    png: ContentTypes.IMAGE_PNG,
+    jpg: ContentTypes.IMAGE_JPEG,
+    jpeg: ContentTypes.IMAGE_JPEG,
+    gif: ContentTypes.IMAGE_GIF,
+    bmp: ContentTypes.IMAGE_BMP,
+    tif: ContentTypes.IMAGE_TIFF,
+    tiff: ContentTypes.IMAGE_TIFF,
+    emf: ContentTypes.IMAGE_EMF,
+    wmf: ContentTypes.IMAGE_WMF,
+    svg: ContentTypes.IMAGE_SVG,
+    webp: ContentTypes.IMAGE_WEBP,
+    wdp: ContentTypes.IMAGE_JPEG_XR,
+    eps: ContentTypes.IMAGE_EPS,
+};
+/** Whether bytes of this content type are XML (parsed to a DOM when the registry has no typed part). */
+export function isXmlContentType(contentType) {
+    if (contentType === undefined)
+        return false;
+    return contentType.endsWith('+xml') || contentType === ContentTypes.APPLICATION_XML || contentType === ContentTypes.XML;
+}
+/** Already-compressed media, stored rather than deflated in a zip (docx4j ZipPartStore.shouldCompress). */
+export function isStoredUncompressed(contentType) {
+    return contentType === ContentTypes.IMAGE_PNG || contentType === ContentTypes.IMAGE_X_PNG
+        || contentType === ContentTypes.IMAGE_JPEG || contentType === ContentTypes.IMAGE_GIF;
+}

package/dist/opc/FlatOpcPartStore.d.mts

@@ -0,0 +1,42 @@
+import { type PackageElement } from '@docx4j/generated-objects-ts';
+import type { PartStore, PartSink, PutOptions } from './PartStore.mjs';
+export declare const PKG_NS = "http://schemas.microsoft.com/office/2006/xmlPackage";
+/**
+ * A flat OPC package (`pkg:package`, what Office JS `getOoxml()` returns) as a container
+ * (docx4j org.docx4j.openpackaging.io3.stores.FlatOpcPartStore is not a class there, but the
+ * same job is done by `FlatOpcXmlImporter`). The content types are carried per part, so
+ * `[Content_Types].xml` is synthesised. XML parts are serialised back to bytes on `load`; the
+ * document loaded from them is therefore not byte-identical to what Office would have zipped.
+ */
+export declare class FlatOpcPartStore implements PartStore {
+    private readonly parts;
+    private readonly order;
+    private readonly cache;
+    private contentTypesXml?;
+    /** From the `pkg:package` string. */
+    constructor(source: string | PackageElement);
+    private readString;
+    private readPackageElement;
+    private add;
+    /** The content type of a part as carried by the flat package. */
+    contentTypeOf(partName: string): string | undefined;
+    partNames(): Iterable<string>;
+    has(partName: string): boolean;
+    load(partName: string): Promise<Uint8Array>;
+    private buildContentTypes;
+}
+export interface FlatOpcSinkOptions {
+    /** The `mso-application` processing instruction's progid, e.g. 'Word.Document'; omitted when undefined. */
+    progId?: string;
+}
+/**
+ * Produces the `pkg:package` string for Office JS `insertOoxml()`. XML parts are embedded as
+ * XML (their declaration removed), everything else as base64 with the padding Word writes.
+ */
+export declare class FlatOpcPartSink implements PartSink<string> {
+    private readonly parts;
+    private readonly progId;
+    constructor(options?: FlatOpcSinkOptions);
+    put(partName: string, bytes: Uint8Array, options?: PutOptions): void;
+    finish(): Promise<string>;
+}