@docx4j/core-ts 0.1.0

package/dist/opc/ZipPartStore.d.mts

@@ -0,0 +1,32 @@
+import type { PartStore, PartSink, PutOptions } from './PartStore.mjs';
+/**
+ * A zip container read from bytes (docx4j io3.stores.ZipPartStore). The central directory is
+ * read once; an entry is inflated on first `load` and then cached. ZIP64 archives are rejected.
+ */
+export declare class ZipPartStore implements PartStore {
+    private readonly data;
+    private readonly entries;
+    private readonly order;
+    private readonly cache;
+    constructor(source: Uint8Array | ArrayBuffer);
+    partNames(): Iterable<string>;
+    has(partName: string): boolean;
+    size(partName: string): number | undefined;
+    load(partName: string): Promise<Uint8Array>;
+    loadSync(partName: string): Uint8Array;
+    private readCentralDirectory;
+}
+/**
+ * Writes a zip (docx4j ZipPartStore, the save half). Entries are written in `put` order, so the
+ * saver puts `[Content_Types].xml` first, as Word does; entries are deflated unless `compress`
+ * is false (already-compressed media).
+ */
+export declare class ZipPartSink implements PartSink<Uint8Array> {
+    private readonly files;
+    private readonly level;
+    constructor(options?: {
+        level?: number;
+    });
+    put(partName: string, bytes: Uint8Array, options?: PutOptions): void;
+    finish(): Promise<Uint8Array>;
+}

package/dist/opc/ZipPartStore.mjs

@@ -0,0 +1,117 @@
+import { inflateSync, zipSync } from 'fflate';
+import { InvalidFormatException } from './exceptions.mjs';
+/**
+ * A zip container read from bytes (docx4j io3.stores.ZipPartStore). The central directory is
+ * read once; an entry is inflated on first `load` and then cached. ZIP64 archives are rejected.
+ */
+export class ZipPartStore {
+    constructor(source) {
+        this.entries = new Map();
+        this.order = [];
+        this.cache = new Map();
+        this.data = source instanceof Uint8Array ? source : new Uint8Array(source);
+        this.readCentralDirectory();
+    }
+    partNames() {
+        return this.order;
+    }
+    has(partName) {
+        return this.entries.has(partName);
+    }
+    size(partName) {
+        var _a;
+        return (_a = this.entries.get(partName)) === null || _a === void 0 ? void 0 : _a.size;
+    }
+    async load(partName) {
+        return this.loadSync(partName);
+    }
+    loadSync(partName) {
+        const cached = this.cache.get(partName);
+        if (cached)
+            return cached;
+        const e = this.entries.get(partName);
+        if (!e)
+            throw new Error(`No entry ${partName} in zip`);
+        const d = this.data;
+        const off = e.localHeaderOffset;
+        if (readU32(d, off) !== 0x04034b50)
+            throw new InvalidFormatException(`Bad local header for ${partName}`);
+        const nameLen = readU16(d, off + 26);
+        const extraLen = readU16(d, off + 28);
+        const start = off + 30 + nameLen + extraLen;
+        const raw = d.subarray(start, start + e.compressedSize);
+        let bytes;
+        if (e.method === 0)
+            bytes = raw.slice();
+        else if (e.method === 8)
+            bytes = inflateSync(raw);
+        else
+            throw new InvalidFormatException(`Unsupported compression method ${e.method} for ${partName}`);
+        this.cache.set(partName, bytes);
+        return bytes;
+    }
+    readCentralDirectory() {
+        const d = this.data;
+        // End of central directory record: signature 0x06054b50, at most 64 KB of comment after it.
+        let eocd = -1;
+        for (let i = d.length - 22; i >= 0 && i >= d.length - 22 - 0xffff; i--) {
+            if (readU32(d, i) === 0x06054b50) {
+                eocd = i;
+                break;
+            }
+        }
+        if (eocd < 0)
+            throw new InvalidFormatException('Not a zip file (no end of central directory record)');
+        const count = readU16(d, eocd + 10);
+        const cdOffset = readU32(d, eocd + 16);
+        if (count === 0xffff || cdOffset === 0xffffffff)
+            throw new InvalidFormatException('ZIP64 archives are not supported');
+        let p = cdOffset;
+        const decoder = new TextDecoder('utf-8');
+        for (let i = 0; i < count; i++) {
+            if (readU32(d, p) !== 0x02014b50)
+                throw new InvalidFormatException('Bad central directory entry');
+            const method = readU16(d, p + 10);
+            const compressedSize = readU32(d, p + 20);
+            const size = readU32(d, p + 24);
+            const nameLen = readU16(d, p + 28);
+            const extraLen = readU16(d, p + 30);
+            const commentLen = readU16(d, p + 32);
+            const localHeaderOffset = readU32(d, p + 42);
+            if (compressedSize === 0xffffffff || size === 0xffffffff || localHeaderOffset === 0xffffffff) {
+                throw new InvalidFormatException('ZIP64 archives are not supported');
+            }
+            const name = decoder.decode(d.subarray(p + 46, p + 46 + nameLen));
+            p += 46 + nameLen + extraLen + commentLen;
+            if (name.endsWith('/'))
+                continue; // directory entry
+            this.entries.set(name, { name, method, compressedSize, size, localHeaderOffset });
+            this.order.push(name);
+        }
+    }
+}
+/**
+ * Writes a zip (docx4j ZipPartStore, the save half). Entries are written in `put` order, so the
+ * saver puts `[Content_Types].xml` first, as Word does; entries are deflated unless `compress`
+ * is false (already-compressed media).
+ */
+export class ZipPartSink {
+    constructor(options) {
+        var _a;
+        this.files = {};
+        this.level = (_a = options === null || options === void 0 ? void 0 : options.level) !== null && _a !== void 0 ? _a : 6;
+    }
+    put(partName, bytes, options) {
+        const name = partName.startsWith('/') ? partName.substring(1) : partName;
+        this.files[name] = [bytes, { level: (options === null || options === void 0 ? void 0 : options.compress) === false ? 0 : this.level }];
+    }
+    async finish() {
+        return zipSync(this.files);
+    }
+}
+function readU16(d, p) {
+    return d[p] | (d[p + 1] << 8);
+}
+function readU32(d, p) {
+    return (d[p] | (d[p + 1] << 8) | (d[p + 2] << 16) | (d[p + 3] << 24)) >>> 0;
+}

package/dist/opc/exceptions.d.mts

@@ -0,0 +1,17 @@
+/** docx4j Docx4JException: anything the packaging layer cannot recover from. */
+export declare class Docx4JException extends Error {
+    readonly cause: unknown;
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+/** docx4j InvalidFormatException: a package, part name or relationship violates Open Packaging. */
+export declare class InvalidFormatException extends Docx4JException {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+/** docx4j PartUnrecognisedException: no part class for a content type (the registry falls back before this is thrown). */
+export declare class PartUnrecognisedException extends Docx4JException {
+    constructor(message: string);
+}

package/dist/opc/exceptions.mjs

@@ -0,0 +1,22 @@
+/** docx4j Docx4JException: anything the packaging layer cannot recover from. */
+export class Docx4JException extends Error {
+    constructor(message, options) {
+        super(message);
+        this.name = 'Docx4JException';
+        this.cause = options === null || options === void 0 ? void 0 : options.cause;
+    }
+}
+/** docx4j InvalidFormatException: a package, part name or relationship violates Open Packaging. */
+export class InvalidFormatException extends Docx4JException {
+    constructor(message, options) {
+        super(message, options);
+        this.name = 'InvalidFormatException';
+    }
+}
+/** docx4j PartUnrecognisedException: no part class for a content type (the registry falls back before this is thrown). */
+export class PartUnrecognisedException extends Docx4JException {
+    constructor(message) {
+        super(message);
+        this.name = 'PartUnrecognisedException';
+    }
+}

package/dist/opc/index.d.mts

@@ -0,0 +1,12 @@
+export { PartName, CONTENT_TYPES_NAME } from './PartName.mjs';
+export { ContentTypes, IMAGE_CONTENT_TYPES_BY_EXTENSION, isXmlContentType, isStoredUncompressed } from './ContentTypes.mjs';
+export { ContentTypeManager, CONTENT_TYPES_NS } from './ContentTypeManager.mjs';
+export { type PartStore, type PartSink, type PutOptions, MemoryPartStore, MemoryPartSink } from './PartStore.mjs';
+export { ZipPartStore, ZipPartSink } from './ZipPartStore.mjs';
+export { FlatOpcPartStore, FlatOpcPartSink, type FlatOpcSinkOptions, PKG_NS } from './FlatOpcPartStore.mjs';
+export { loadPackage, type LoadOptions } from './Load.mjs';
+export { savePackage } from './Save.mjs';
+export { mcePreprocess, createMcePreprocessor, resolveAlternateContent, MCE_NS, type McePreprocessOptions } from './mce/preprocessor.mjs';
+export { UNDERSTOOD_NAMESPACES } from './mce/understood.mjs';
+export { Docx4JException, InvalidFormatException, PartUnrecognisedException } from './exceptions.mjs';
+export { parseXml, serializeXml, serializeXmlPart, createDocument, encodeText, decodeXmlText, stripXmlDeclaration, base64Encode, base64Decode, childElements, XML_DECLARATION } from '../xml/dom.mjs';

package/dist/opc/index.mjs

@@ -0,0 +1,13 @@
+// The Open Packaging layer: names, content types, containers, load and save.
+export { PartName, CONTENT_TYPES_NAME } from './PartName.mjs';
+export { ContentTypes, IMAGE_CONTENT_TYPES_BY_EXTENSION, isXmlContentType, isStoredUncompressed } from './ContentTypes.mjs';
+export { ContentTypeManager, CONTENT_TYPES_NS } from './ContentTypeManager.mjs';
+export { MemoryPartStore, MemoryPartSink } from './PartStore.mjs';
+export { ZipPartStore, ZipPartSink } from './ZipPartStore.mjs';
+export { FlatOpcPartStore, FlatOpcPartSink, PKG_NS } from './FlatOpcPartStore.mjs';
+export { loadPackage } from './Load.mjs';
+export { savePackage } from './Save.mjs';
+export { mcePreprocess, createMcePreprocessor, resolveAlternateContent, MCE_NS } from './mce/preprocessor.mjs';
+export { UNDERSTOOD_NAMESPACES } from './mce/understood.mjs';
+export { Docx4JException, InvalidFormatException, PartUnrecognisedException } from './exceptions.mjs';
+export { parseXml, serializeXml, serializeXmlPart, createDocument, encodeText, decodeXmlText, stripXmlDeclaration, base64Encode, base64Decode, childElements, XML_DECLARATION } from '../xml/dom.mjs';

package/dist/opc/mce/preprocessor.d.mts

@@ -0,0 +1,15 @@
+import type { XmlPart } from '../../parts/XmlPart.mjs';
+export declare const MCE_NS = "http://schemas.openxmlformats.org/markup-compatibility/2006";
+export interface McePreprocessOptions {
+    /** Namespaces counted as understood; defaults to the object model's modules. */
+    understood?: ReadonlySet<string>;
+}
+/** The default preprocessor, over the object model's namespaces. */
+export declare function mcePreprocess(doc: Document, _part?: XmlPart<unknown>): void;
+/** A preprocessor over a namespace set of your own. */
+export declare function createMcePreprocessor(options: McePreprocessOptions): (doc: Document, part?: XmlPart<unknown>) => void;
+/**
+ * Resolves every mc:AlternateContent under a node, innermost first (a chosen branch may contain
+ * another). Returns the number resolved.
+ */
+export declare function resolveAlternateContent(root: Node, understood?: ReadonlySet<string>): number;

package/dist/opc/mce/preprocessor.mjs

@@ -0,0 +1,74 @@
+import { UNDERSTOOD_NAMESPACES } from './understood.mjs';
+export const MCE_NS = 'http://schemas.openxmlformats.org/markup-compatibility/2006';
+/** The default preprocessor, over the object model's namespaces. */
+export function mcePreprocess(doc, _part) {
+    resolveAlternateContent(doc, UNDERSTOOD_NAMESPACES);
+}
+/** A preprocessor over a namespace set of your own. */
+export function createMcePreprocessor(options) {
+    var _a;
+    const understood = (_a = options.understood) !== null && _a !== void 0 ? _a : UNDERSTOOD_NAMESPACES;
+    return (doc) => resolveAlternateContent(doc, understood);
+}
+/**
+ * Resolves every mc:AlternateContent under a node, innermost first (a chosen branch may contain
+ * another). Returns the number resolved.
+ */
+export function resolveAlternateContent(root, understood = UNDERSTOOD_NAMESPACES) {
+    let count = 0;
+    const visit = (node) => {
+        // Snapshot: replacing a child mutates the list.
+        const children = [];
+        for (let c = node.firstChild; c; c = c.nextSibling)
+            children.push(c);
+        for (const child of children) {
+            if (child.nodeType !== 1)
+                continue;
+            visit(child);
+            const el = child;
+            if (el.namespaceURI === MCE_NS && el.localName === 'AlternateContent') {
+                replaceAlternateContent(el, understood);
+                count++;
+            }
+        }
+    };
+    visit(root);
+    return count;
+}
+function replaceAlternateContent(ac, understood) {
+    let chosen;
+    let fallback;
+    for (let c = ac.firstChild; c; c = c.nextSibling) {
+        if (c.nodeType !== 1)
+            continue;
+        const el = c;
+        if (el.namespaceURI !== MCE_NS)
+            continue;
+        if (el.localName === 'Choice' && !chosen && choiceUnderstood(el, understood))
+            chosen = el;
+        else if (el.localName === 'Fallback' && !fallback)
+            fallback = el;
+    }
+    const branch = chosen !== null && chosen !== void 0 ? chosen : fallback;
+    const parent = ac.parentNode;
+    if (branch) {
+        const moved = [];
+        for (let c = branch.firstChild; c; c = c.nextSibling)
+            moved.push(c);
+        for (const n of moved)
+            parent.insertBefore(n, ac);
+    }
+    parent.removeChild(ac);
+}
+function choiceUnderstood(choice, understood) {
+    var _a;
+    const requires = ((_a = choice.getAttribute('Requires')) !== null && _a !== void 0 ? _a : '').trim();
+    if (requires === '')
+        return false;
+    for (const prefix of requires.split(/\s+/)) {
+        const ns = choice.lookupNamespaceURI(prefix);
+        if (!ns || !understood.has(ns))
+            return false;
+    }
+    return true;
+}

package/dist/opc/mce/understood.d.mts

@@ -0,0 +1 @@
+export declare const UNDERSTOOD_NAMESPACES: ReadonlySet<string>;

package/dist/opc/mce/understood.mjs

@@ -0,0 +1,98 @@
+// The namespaces the object model has modules for: what "understanding" an mc:Choice means here.
+// Mirrors the defaultElementNamespaceURI of every generated module of @docx4j/generated-objects-ts
+// (0.1.0); regenerate when modules are added. Word takes the first mc:Choice whose Requires
+// prefixes it all understands (ECMA-376 Part 3, 10.2.1), and so does this preprocessor.
+export const UNDERSTOOD_NAMESPACES = new Set([
+    'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+    'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+    'http://schemas.openxmlformats.org/package/2006/relationships',
+    'http://schemas.openxmlformats.org/markup-compatibility/2006',
+    'http://schemas.openxmlformats.org/officeDocument/2006/math',
+    'http://schemas.openxmlformats.org/officeDocument/2006/bibliography',
+    'http://schemas.openxmlformats.org/officeDocument/2006/customXml',
+    'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+    'http://schemas.openxmlformats.org/officeDocument/2006/custom-properties',
+    'http://schemas.openxmlformats.org/officeDocument/2006/extended-properties',
+    'http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes',
+    'http://schemas.openxmlformats.org/package/2006/metadata/core-properties',
+    'http://purl.org/dc/elements/1.1/',
+    'http://purl.org/dc/terms/',
+    'http://schemas.microsoft.com/office/2006/coverPageProps',
+    'http://schemas.microsoft.com/office/2006/xmlPackage',
+    'http://schemas.openxmlformats.org/drawingml/2006/main',
+    'http://schemas.openxmlformats.org/drawingml/2006/picture',
+    'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+    'http://schemas.openxmlformats.org/drawingml/2006/chart',
+    'http://schemas.openxmlformats.org/drawingml/2006/chartDrawing',
+    'http://schemas.openxmlformats.org/drawingml/2006/diagram',
+    'http://schemas.openxmlformats.org/drawingml/2006/compatibility',
+    'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+    'http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing',
+    'http://schemas.microsoft.com/office/drawing/2007/8/2/chart',
+    'http://schemas.microsoft.com/office/drawing/2008/diagram',
+    'http://schemas.microsoft.com/office/drawing/2010/main',
+    'http://schemas.microsoft.com/office/drawing/2010/picture',
+    'http://schemas.microsoft.com/office/drawing/2010/chartDrawing',
+    'http://schemas.microsoft.com/office/drawing/2010/diagram',
+    'http://schemas.microsoft.com/office/drawing/2012/main',
+    'http://schemas.microsoft.com/office/drawing/2012/chart',
+    'http://schemas.microsoft.com/office/drawing/2012/chartStyle',
+    'http://schemas.microsoft.com/office/drawing/2013/main/command',
+    'http://schemas.microsoft.com/office/drawing/2014/main',
+    'http://schemas.microsoft.com/office/drawing/2014/chart',
+    'http://schemas.microsoft.com/office/drawing/2014/chart/ac',
+    'http://schemas.microsoft.com/office/drawing/2014/chartex',
+    'http://schemas.microsoft.com/office/drawing/2016/11/main',
+    'http://schemas.microsoft.com/office/drawing/2016/12/diagram',
+    'http://schemas.microsoft.com/office/drawing/2016/ink',
+    'http://schemas.microsoft.com/office/drawing/2016/SVG/main',
+    'http://schemas.microsoft.com/office/drawing/2017/03/chart',
+    'http://schemas.microsoft.com/office/drawing/2017/decorative',
+    'http://schemas.microsoft.com/office/drawing/2017/model3d',
+    'http://schemas.microsoft.com/office/drawing/2018/animation',
+    'http://schemas.microsoft.com/office/drawing/2018/animation/model3d',
+    'http://schemas.microsoft.com/office/drawing/2018/hyperlinkcolor',
+    'http://schemas.microsoft.com/office/thememl/2012/main',
+    'urn:schemas-microsoft-com:vml',
+    'urn:schemas-microsoft-com:office:office',
+    'urn:schemas-microsoft-com:office:word',
+    'urn:schemas-microsoft-com:office:excel',
+    'urn:schemas-microsoft-com:office:powerpoint',
+    'http://schemas.microsoft.com/office/word/2006/wordml',
+    'http://schemas.microsoft.com/office/word/2010/wordml',
+    'http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas',
+    'http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing',
+    'http://schemas.microsoft.com/office/word/2010/wordprocessingGroup',
+    'http://schemas.microsoft.com/office/word/2010/wordprocessingShape',
+    'http://schemas.microsoft.com/office/word/2012/wordml',
+    'http://schemas.microsoft.com/office/word/2012/wordprocessingDrawing',
+    'http://schemas.microsoft.com/office/word/2015/wordml/symex',
+    'http://schemas.microsoft.com/office/word/2016/wordml/cid',
+    'http://schemas.microsoft.com/office/webextensions/taskpanes/2010/11',
+    'http://schemas.microsoft.com/office/webextensions/webextension/2010/11',
+    'http://schemas.microsoft.com/office/powerpoint/2010/main',
+    'http://schemas.microsoft.com/office/powerpoint/2012/main',
+    'http://schemas.microsoft.com/office/powerpoint/2013/main/command',
+    'http://schemas.microsoft.com/office/powerpoint/2014/inkAction',
+    'http://schemas.microsoft.com/office/powerpoint/2015/main',
+    'http://schemas.microsoft.com/office/powerpoint/2015/09/main',
+    'http://schemas.microsoft.com/office/powerpoint/2015/10/main',
+    'http://schemas.microsoft.com/office/powerpoint/2016/6/main',
+    'http://schemas.microsoft.com/office/powerpoint/2016/sectionzoom',
+    'http://schemas.microsoft.com/office/powerpoint/2016/slidezoom',
+    'http://schemas.microsoft.com/office/powerpoint/2016/summaryzoom',
+    'http://schemas.microsoft.com/office/powerpoint/2017/3/main',
+    'http://schemas.microsoft.com/office/powerpoint/2017/10/main',
+    'http://schemas.microsoft.com/office/powerpoint/2018/4/main',
+    'http://schemas.openxmlformats.org/presentationml/2006/main',
+    'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
+    'http://schemas.microsoft.com/office/excel/2006/main',
+    'http://schemas.microsoft.com/office/excel/2008/2/main',
+    'http://schemas.microsoft.com/office/excel/2010/spreadsheetDrawing',
+    'http://schemas.microsoft.com/ink/2010/main',
+    'http://www.w3.org/1998/Math/MathML',
+    'http://www.w3.org/2003/InkML',
+    'http://schemas.microsoft.com/office/2006/encryption',
+    'http://schemas.microsoft.com/office/2006/keyEncryptor/certificate',
+    'http://schemas.microsoft.com/office/2006/keyEncryptor/password',
+]);

package/dist/packages/OpcPackage.d.mts

@@ -0,0 +1,62 @@
+import type { Relationship } from '@docx4j/generated-objects-ts/modules/org_docx4j_relationships';
+import { PartName } from '../opc/PartName.mjs';
+import { ContentTypeManager } from '../opc/ContentTypeManager.mjs';
+import type { PartStore, PartSink } from '../opc/PartStore.mjs';
+import { type FlatOpcSinkOptions } from '../opc/FlatOpcPartStore.mjs';
+import { type LoadOptions } from '../opc/Load.mjs';
+import { Part, type RelationshipSource } from '../parts/Part.mjs';
+import { Parts } from '../parts/Parts.mjs';
+import { RelationshipsPart, type AddPartBehaviour } from '../parts/RelationshipsPart.mjs';
+import type { CustomXmlDataStoragePart } from '../parts/DefaultXmlPart.mjs';
+import { DocPropsCorePart, DocPropsExtendedPart, DocPropsCustomPart } from '../parts/docProps/index.mjs';
+/** Anything `OpcPackage.load` accepts: zip bytes, a flat OPC string, or a container. */
+export type PackageSource = Uint8Array | ArrayBuffer | string | PartStore;
+/**
+ * An Open Packaging Conventions package (docx4j org.docx4j.openpackaging.packages.OpcPackage):
+ * the content types, the package relationships and the parts reachable from them.
+ */
+export declare class OpcPackage implements RelationshipSource {
+    /** The pseudo part name of the package itself: the source of the package relationships. */
+    readonly partName: PartName;
+    contentTypeManager: ContentTypeManager;
+    relationshipsPart: RelationshipsPart;
+    readonly parts: Parts;
+    /** Where untouched parts are copied from on save. Undefined for a new package. */
+    sourcePartStore: PartStore | undefined;
+    /** Custom XML parts by the (lower-cased) itemID of their properties part. */
+    readonly customXmlDataStorageParts: Map<string, CustomXmlDataStoragePart>;
+    /** The options this package was loaded with. */
+    loadOptions: LoadOptions;
+    docPropsCorePart: DocPropsCorePart | undefined;
+    docPropsExtendedPart: DocPropsExtendedPart | undefined;
+    docPropsCustomPart: DocPropsCustomPart | undefined;
+    constructor();
+    get package(): OpcPackage;
+    /**
+     * Loads a package, picking the class (WordprocessingMLPackage, ...) from the main part's
+     * content type. A string is a flat OPC package; bytes are a zip; a PartStore is used as is.
+     */
+    static load(source: PackageSource, options?: LoadOptions): Promise<OpcPackage>;
+    getPart(partName: PartName | string): Part | undefined;
+    getRelationshipsPart(): RelationshipsPart;
+    /** Adds a part as a target of the package (docProps, the main part). */
+    addTargetPart(target: Part, mode?: AddPartBehaviour, proposedRelId?: string): Relationship;
+    setPartShortcut(part: Part, relationshipType: string): boolean;
+    /** The main part: the target of the officeDocument relationship. */
+    getMainPart(): Part | undefined;
+    /** Unmarshals every XML part, so that `contents` is available synchronously everywhere. */
+    unmarshalAll(): Promise<void>;
+    /** Adds empty core properties if absent (docx4j addDocPropsCorePart). */
+    addDocPropsCorePart(): DocPropsCorePart;
+    addDocPropsExtendedPart(): DocPropsExtendedPart;
+    /** The package as a zip. */
+    save(options?: {
+        level?: number;
+    }): Promise<Uint8Array>;
+    /** The package as a flat OPC `pkg:package` string, for Office JS `insertOoxml()`. */
+    saveFlatOpc(options?: FlatOpcSinkOptions): Promise<string>;
+    /** Writes the package to any sink. */
+    saveTo<R>(sink: PartSink<R>): Promise<R>;
+    /** The `mso-application` progid written to flat OPC; subclasses know theirs. */
+    protected get progId(): string | undefined;
+}

package/dist/packages/OpcPackage.mjs

@@ -0,0 +1,133 @@
+import { PartName } from '../opc/PartName.mjs';
+import { ContentTypeManager } from '../opc/ContentTypeManager.mjs';
+import { ZipPartStore, ZipPartSink } from '../opc/ZipPartStore.mjs';
+import { FlatOpcPartStore, FlatOpcPartSink } from '../opc/FlatOpcPartStore.mjs';
+import { loadPackage } from '../opc/Load.mjs';
+import { savePackage } from '../opc/Save.mjs';
+import { Docx4JException } from '../opc/exceptions.mjs';
+import { Namespaces } from '../parts/Namespaces.mjs';
+import { Parts } from '../parts/Parts.mjs';
+import { XmlPart } from '../parts/XmlPart.mjs';
+import { RelationshipsPart } from '../parts/RelationshipsPart.mjs';
+import { DocPropsCorePart, DocPropsExtendedPart } from '../parts/docProps/index.mjs';
+import { mcePreprocess } from '../opc/mce/preprocessor.mjs';
+import { createPackageForContentType, registerGenericPackageClass } from './registry.mjs';
+/**
+ * An Open Packaging Conventions package (docx4j org.docx4j.openpackaging.packages.OpcPackage):
+ * the content types, the package relationships and the parts reachable from them.
+ */
+export class OpcPackage {
+    constructor() {
+        /** The pseudo part name of the package itself: the source of the package relationships. */
+        this.partName = PartName.ROOT;
+        this.contentTypeManager = ContentTypeManager.createDefault();
+        this.parts = new Parts();
+        /** Custom XML parts by the (lower-cased) itemID of their properties part. */
+        this.customXmlDataStorageParts = new Map();
+        /** The options this package was loaded with. */
+        this.loadOptions = {};
+        this.relationshipsPart = RelationshipsPart.createPackageRels();
+        this.relationshipsPart.sourceP = this;
+        this.relationshipsPart.package = this;
+    }
+    get package() {
+        return this;
+    }
+    /**
+     * Loads a package, picking the class (WordprocessingMLPackage, ...) from the main part's
+     * content type. A string is a flat OPC package; bytes are a zip; a PartStore is used as is.
+     */
+    static async load(source, options = {}) {
+        const store = toStore(source);
+        const opts = { ...options };
+        if (opts.preprocessor === undefined && opts.mcePreprocess !== false)
+            opts.preprocessor = mcePreprocess;
+        const pkg = await loadPackage(store, createPackageForContentType, opts);
+        pkg.loadOptions = opts;
+        return pkg;
+    }
+    getPart(partName) {
+        return this.parts.get(partName);
+    }
+    getRelationshipsPart() {
+        return this.relationshipsPart;
+    }
+    /** Adds a part as a target of the package (docProps, the main part). */
+    addTargetPart(target, mode, proposedRelId) {
+        const rel = this.relationshipsPart.addPart(target, mode, proposedRelId);
+        this.setPartShortcut(target, target.relationshipType);
+        return rel;
+    }
+    setPartShortcut(part, relationshipType) {
+        switch (relationshipType) {
+            case Namespaces.PROPERTIES_CORE:
+                this.docPropsCorePart = part;
+                return true;
+            case Namespaces.PROPERTIES_EXTENDED:
+                this.docPropsExtendedPart = part;
+                return true;
+            case Namespaces.PROPERTIES_CUSTOM:
+                this.docPropsCustomPart = part;
+                return true;
+            default: return false;
+        }
+    }
+    /** The main part: the target of the officeDocument relationship. */
+    getMainPart() {
+        var _a;
+        const rel = (_a = this.relationshipsPart.getRelationshipByType(Namespaces.DOCUMENT)) !== null && _a !== void 0 ? _a : this.relationshipsPart.getRelationshipByType(Namespaces.DOCUMENT_STRICT);
+        return rel ? this.relationshipsPart.getPart(rel) : undefined;
+    }
+    /** Unmarshals every XML part, so that `contents` is available synchronously everywhere. */
+    async unmarshalAll() {
+        for (const part of this.parts)
+            if (part instanceof XmlPart)
+                await part.getContents();
+    }
+    /** Adds empty core properties if absent (docx4j addDocPropsCorePart). */
+    addDocPropsCorePart() {
+        if (!this.docPropsCorePart) {
+            const part = new DocPropsCorePart();
+            part.setContents({});
+            this.addTargetPart(part);
+        }
+        return this.docPropsCorePart;
+    }
+    addDocPropsExtendedPart() {
+        if (!this.docPropsExtendedPart) {
+            const part = new DocPropsExtendedPart();
+            part.setContents({});
+            this.addTargetPart(part);
+        }
+        return this.docPropsExtendedPart;
+    }
+    /** The package as a zip. */
+    save(options) {
+        return this.saveTo(new ZipPartSink(options));
+    }
+    /** The package as a flat OPC `pkg:package` string, for Office JS `insertOoxml()`. */
+    saveFlatOpc(options) {
+        return this.saveTo(new FlatOpcPartSink({ progId: this.progId, ...options }));
+    }
+    /** Writes the package to any sink. */
+    saveTo(sink) {
+        return savePackage(this, sink);
+    }
+    /** The `mso-application` progid written to flat OPC; subclasses know theirs. */
+    get progId() {
+        return undefined;
+    }
+}
+function toStore(source) {
+    if (typeof source === 'string')
+        return new FlatOpcPartStore(source);
+    if (source instanceof Uint8Array || source instanceof ArrayBuffer)
+        return new ZipPartStore(source);
+    if (isPartStore(source))
+        return source;
+    throw new Docx4JException('Unsupported package source');
+}
+function isPartStore(value) {
+    return typeof value === 'object' && value !== null && typeof value.load === 'function' && typeof value.has === 'function';
+}
+registerGenericPackageClass(OpcPackage);

package/dist/packages/PresentationMLPackage.d.mts

@@ -0,0 +1,12 @@
+import { OpcPackage, type PackageSource } from './OpcPackage.mjs';
+import type { LoadOptions } from '../opc/Load.mjs';
+import type { Part } from '../parts/Part.mjs';
+import type { MainPresentationPart } from '../parts/pml/index.mjs';
+/** A pptx (docx4j PresentationMLPackage). */
+export declare class PresentationMLPackage extends OpcPackage {
+    mainPresentationPart: MainPresentationPart | undefined;
+    static load(source: PackageSource, options?: LoadOptions): Promise<PresentationMLPackage>;
+    setPartShortcut(part: Part, relationshipType: string): boolean;
+    getMainPresentationPart(): MainPresentationPart;
+    protected get progId(): string;
+}