@docx4j/core-ts 0.1.0 → 0.1.2

package/dist/parts/pml/index.mjs

@@ -1,41 +1,239 @@
+import { createPresentationSldIdLstSldId, createPresentationSldMasterIdLstSldMasterId, createSlideLayoutIdListSldLayoutId, } from '@docx4j/generated-objects-ts/factory/org_pptx4j_pml';
 import { XmlPart } from '../XmlPart.mjs';
 import { BinaryPart } from '../BinaryPart.mjs';
 import { ContentTypes } from '../../opc/ContentTypes.mjs';
 import { Namespaces } from '../Namespaces.mjs';
+import { Pptx4jException } from '../../opc/exceptions.mjs';
 const P = 'http://schemas.openxmlformats.org/presentationml/2006/main';
 const A = 'http://schemas.openxmlformats.org/drawingml/2006/main';
+/** The parts an id list's `r:id`s point at, in list order, skipping any that is not of the class. */
+function partsByRelId(entries, rp, cls) {
+    const out = [];
+    for (const entry of entries) {
+        const part = rp.getPart(entry.rid);
+        if (part instanceof cls)
+            out.push(part);
+    }
+    return out;
+}
+/**
+ * A new `p:sldId/@id` (docx4j `JaxbPmlPart.getSlideId()`, ECMA-376 4.8.17 ST_SlideId: 256 to
+ * 2147483647). Random, as docx4j's is: nothing in the package numbers them.
+ */
+export function nextSlideId() {
+    return Math.floor(Math.random() * 2147483392) + 256;
+}
+/**
+ * A new `p:sldLayoutId/@id` or `p:sldMasterId/@id` (docx4j
+ * `JaxbPmlPart.getSlideLayoutOrMasterId()`, ECMA-376 4.8.18 and 4.8.20: above 2147483648).
+ */
+export function nextSlideLayoutOrMasterId() {
+    return Math.floor(Math.random() * 2147483647) + 2147483648;
+}
 export class MainPresentationPart extends XmlPart {
     constructor(partName = '/ppt/presentation.xml', contentType = ContentTypes.PRESENTATIONML_MAIN) {
         super(partName, contentType, Namespaces.PRESENTATIONML_MAIN, { namespaceURI: P, localPart: 'presentation' });
     }
     setPartShortcut(part, relationshipType) {
-        if (relationshipType === Namespaces.THEME) {
-            this.themePart = part;
-            return true;
+        switch (relationshipType) {
+            case Namespaces.THEME:
+                this.themePart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_NOTES_MASTER:
+                this.notesMasterPart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_COMMENT_AUTHORS:
+                this.commentAuthorsPart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_PRES_PROPS:
+                this.presentationPropertiesPart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_VIEW_PROPS:
+                this.viewPropertiesPart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_TABLE_STYLES:
+                this.tableStylesPart = part;
+                return true;
+            default: return false;
         }
-        return false;
     }
+    /**
+     * The slides, in `p:sldIdLst` order (docx4j `getSlideParts()`), once the part is unmarshalled;
+     * before that, in relationship order, which is the order they were added in.
+     */
     get slideParts() {
+        var _a;
         const rp = this.relationshipsPart;
         if (!rp)
             return [];
+        if (this.isUnmarshalled) {
+            const entries = (_a = this.contents.sldIdLst) === null || _a === void 0 ? void 0 : _a.sldId;
+            if (entries)
+                return partsByRelId(entries, rp, SlidePart);
+        }
         return rp.getRelationshipsByType(Namespaces.PRESENTATIONML_SLIDE).map((r) => rp.getPart(r)).filter((p) => p instanceof SlidePart);
     }
+    /** The slides in `p:sldIdLst` order, unmarshalling the part first (docx4j `getSlideParts()`). */
+    async getSlideParts() {
+        await this.getContents();
+        return this.slideParts;
+    }
+    /** The slide masters, in `p:sldMasterIdLst` order once the part is unmarshalled. */
+    get slideMasterParts() {
+        var _a;
+        const rp = this.relationshipsPart;
+        if (!rp)
+            return [];
+        if (this.isUnmarshalled) {
+            const entries = (_a = this.contents.sldMasterIdLst) === null || _a === void 0 ? void 0 : _a.sldMasterId;
+            if (entries)
+                return partsByRelId(entries, rp, SlideMasterPart);
+        }
+        return rp.getRelationshipsByType(Namespaces.PRESENTATIONML_SLIDE_MASTER).map((r) => rp.getPart(r)).filter((p) => p instanceof SlideMasterPart);
+    }
+    /** The slide at an index of `p:sldIdLst` (docx4j `getSlide(int)`). */
+    getSlide(index) {
+        const slides = this.slideParts;
+        const slide = slides[index];
+        if (!slide)
+            throw new Pptx4jException(`No slide at index ${index}. (There are ${slides.length} slides)`);
+        return slide;
+    }
+    /** docx4j `getSlideCount()`. */
+    get slideCount() {
+        var _a, _b, _c;
+        return (_c = (_b = (_a = this.contents.sldIdLst) === null || _a === void 0 ? void 0 : _a.sldId) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0;
+    }
+    /**
+     * Adds a slide part as a target and appends a `p:sldId` for it (docx4j
+     * `addSlideIdListEntry(SlidePart)`); the part must be unmarshalled.
+     */
+    addSlideIdListEntry(slidePart, mode = 'OVERWRITE_IF_NAME_EXISTS') {
+        const rel = this.addTargetPart(slidePart, mode);
+        const entry = createPresentationSldIdLstSldId({ id: nextSlideId(), rid: rel.id });
+        this.sldIdLst().sldId.push(entry);
+        return entry;
+    }
+    /**
+     * docx4j `addSlide(SlidePart)` / `addSlide(int, SlidePart)`: appends the slide, or inserts it
+     * at `index`, renaming the part if the name is taken (PowerPoint cannot open a package in which
+     * two relationships target the same slide, so a slide is never added twice).
+     *
+     * `layoutPart`, when given, becomes the slide's layout relationship, as a slide needs one.
+     */
+    addSlide(slidePart, index, layoutPart) {
+        const sldId = this.sldIdLst().sldId;
+        if (index !== undefined && (index < 0 || index > sldId.length)) {
+            throw new Pptx4jException(`Can't add slide at index ${index}. (There are ${sldId.length} slides) `);
+        }
+        const rel = this.addTargetPart(slidePart, 'RENAME_IF_NAME_EXISTS');
+        const entry = createPresentationSldIdLstSldId({ id: nextSlideId(), rid: rel.id });
+        if (index === undefined)
+            sldId.push(entry);
+        else
+            sldId.splice(index, 0, entry);
+        if (layoutPart)
+            slidePart.addTargetPart(layoutPart);
+        return entry;
+    }
+    /** docx4j `addSlideMasterIdListEntry(SlideMasterPart)`. */
+    addSlideMasterIdListEntry(masterPart) {
+        var _a, _b;
+        var _c;
+        const rel = this.addTargetPart(masterPart);
+        const entry = createPresentationSldMasterIdLstSldMasterId({ id: nextSlideLayoutOrMasterId(), rid: rel.id });
+        const lst = ((_a = (_c = this.contents).sldMasterIdLst) !== null && _a !== void 0 ? _a : (_c.sldMasterIdLst = { sldMasterId: [] }));
+        ((_b = lst.sldMasterId) !== null && _b !== void 0 ? _b : (lst.sldMasterId = [])).push(entry);
+        return entry;
+    }
+    /** docx4j `removeSlide(int)`: the `p:sldId`, the relationship and the part. */
+    removeSlide(index) {
+        const sldId = this.sldIdLst().sldId;
+        const entry = sldId[index];
+        if (!entry)
+            throw new Pptx4jException(`No slide at index ${index}. (There are ${sldId.length} slides) `);
+        sldId.splice(index, 1);
+        const rp = this.relationshipsPart;
+        const part = rp.getPart(entry.rid);
+        rp.removePart(part.partName);
+        return part;
+    }
+    sldIdLst() {
+        var _a, _b;
+        const contents = this.contents;
+        const lst = ((_a = contents.sldIdLst) !== null && _a !== void 0 ? _a : (contents.sldIdLst = { sldId: [] }));
+        (_b = lst.sldId) !== null && _b !== void 0 ? _b : (lst.sldId = []);
+        return lst;
+    }
 }
 export class SlidePart extends XmlPart {
-    constructor(partName) {
+    constructor(partName = '/ppt/slides/slide1.xml') {
         super(partName, ContentTypes.PRESENTATIONML_SLIDE, Namespaces.PRESENTATIONML_SLIDE, { namespaceURI: P, localPart: 'sld' });
     }
+    setPartShortcut(part, relationshipType) {
+        switch (relationshipType) {
+            case Namespaces.PRESENTATIONML_SLIDE_LAYOUT:
+                this.slideLayoutPart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_NOTES_SLIDE:
+                this.notesSlidePart = part;
+                return true;
+            case Namespaces.PRESENTATIONML_COMMENTS:
+                this.commentsPart = part;
+                return true;
+            default: return false;
+        }
+    }
 }
 export class SlideLayoutPart extends XmlPart {
-    constructor(partName) {
+    constructor(partName = '/ppt/slideLayouts/slideLayout1.xml') {
         super(partName, ContentTypes.PRESENTATIONML_SLIDE_LAYOUT, Namespaces.PRESENTATIONML_SLIDE_LAYOUT, { namespaceURI: P, localPart: 'sldLayout' });
     }
+    setPartShortcut(part, relationshipType) {
+        if (relationshipType === Namespaces.PRESENTATIONML_SLIDE_MASTER) {
+            this.slideMasterPart = part;
+            return true;
+        }
+        return false;
+    }
 }
 export class SlideMasterPart extends XmlPart {
-    constructor(partName) {
+    constructor(partName = '/ppt/slideMasters/slideMaster1.xml') {
         super(partName, ContentTypes.PRESENTATIONML_SLIDE_MASTER, Namespaces.PRESENTATIONML_SLIDE_MASTER, { namespaceURI: P, localPart: 'sldMaster' });
     }
+    setPartShortcut(part, relationshipType) {
+        if (relationshipType === Namespaces.THEME) {
+            this.themePart = part;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Adds a layout part as a target and appends a `p:sldLayoutId` for it (docx4j
+     * `addSlideLayoutIdListEntry`); the master must be unmarshalled.
+     */
+    addSlideLayoutIdListEntry(slideLayoutPart) {
+        var _a, _b;
+        var _c;
+        const rel = this.addTargetPart(slideLayoutPart);
+        const entry = createSlideLayoutIdListSldLayoutId({ id: nextSlideLayoutOrMasterId(), rid: rel.id });
+        const lst = ((_a = (_c = this.contents).sldLayoutIdLst) !== null && _a !== void 0 ? _a : (_c.sldLayoutIdLst = { sldLayoutId: [] }));
+        ((_b = lst.sldLayoutId) !== null && _b !== void 0 ? _b : (lst.sldLayoutId = [])).push(entry);
+        return entry;
+    }
+    /** This master's layouts, in `p:sldLayoutIdLst` order once the master is unmarshalled. */
+    get slideLayoutParts() {
+        var _a;
+        const rp = this.relationshipsPart;
+        if (!rp)
+            return [];
+        if (this.isUnmarshalled) {
+            const entries = (_a = this.contents.sldLayoutIdLst) === null || _a === void 0 ? void 0 : _a.sldLayoutId;
+            if (entries)
+                return partsByRelId(entries, rp, SlideLayoutPart);
+        }
+        return rp.getRelationshipsByType(Namespaces.PRESENTATIONML_SLIDE_LAYOUT).map((r) => rp.getPart(r)).filter((p) => p instanceof SlideLayoutPart);
+    }
 }
 export class NotesSlidePart extends XmlPart {
     constructor(partName) {
@@ -88,3 +286,4 @@ export class FontDataPart extends BinaryPart {
         super(partName, ContentTypes.PRESENTATIONML_FONT_DATA, Namespaces.PRESENTATIONML_FONT_DATA);
     }
 }
+export { placeholderGeometry, placeholderShape, slidePlaceholders, layoutPlaceholders, addShapes, bodyLines, placeholdersOf, slidePlaceholdersFor, } from './placeholders.mjs';

package/dist/parts/pml/placeholders.d.mts

@@ -0,0 +1,71 @@
+import type * as pml from '@docx4j/generated-objects-ts/modules/org_pptx4j_pml';
+/** The text of a created slide's placeholders; `body` is one paragraph per line, or per entry. */
+export interface SlideTextOptions {
+    /** The title placeholder's text; the placeholder is left empty (its prompt) when absent. */
+    title?: string;
+    /** The body placeholder's text: a string (split on newlines) or one string per paragraph. */
+    body?: string | string[];
+}
+/** A rectangle in EMU, as `a:xfrm` carries it. */
+export interface Rect {
+    x: number;
+    y: number;
+    cx: number;
+    cy: number;
+}
+/**
+ * Where the title and body placeholders sit, as fractions of the slide: PowerPoint's own
+ * Title and Content layout at 4:3 (title 685800, 457200, 7772400 x 1143000; body 685800,
+ * 1600200, 7772400 x 4525963 of 9144000 x 6858000), so any slide size is laid out the same way.
+ */
+export declare function placeholderGeometry(sldSz: {
+    cx?: number;
+    cy?: number;
+} | undefined): {
+    title: Rect;
+    body: Rect;
+};
+/** The body text as paragraphs: a string is split on newlines, as Office JS's `insertText` does. */
+export declare function bodyLines(body: string | string[] | undefined): string[];
+/**
+ * One placeholder shape (docx4j's `SAMPLE_SHAPE` in `PresentationMLPackage`, and the layout
+ * markup of its `SlidePlaceholder` sample): `p:sp` with `a:spLocks noGrp`, the `p:ph`, an
+ * optional `a:xfrm` and a `p:txBody` of the lines given.
+ */
+export declare function placeholderShape(options: {
+    id: number;
+    name: string;
+    type?: pml.STPlaceholderType;
+    idx?: number;
+    xfrm?: Rect;
+    lines?: string[];
+}): pml.Shape;
+/**
+ * The title (`p:ph type="title"`) and body (`p:ph idx="1"`) shapes a created **slide** carries,
+ * with no geometry of their own: each inherits the layout's, which is what a placeholder is for.
+ */
+export declare function slidePlaceholders(text?: SlideTextOptions): pml.Shape[];
+/**
+ * The same pair for the **layout**, with the geometry the slides inherit and PowerPoint's own
+ * prompt text. Without these the slide's placeholders would have nothing to inherit from and
+ * PowerPoint would draw them at the origin with no size.
+ */
+export declare function layoutPlaceholders(sldSz: {
+    cx?: number;
+    cy?: number;
+} | undefined): pml.Shape[];
+/** The placeholder shapes of a slide, layout or master, in shape-tree order. */
+export declare function placeholdersOf(cSld: pml.CommonSlideData | undefined): {
+    shape: pml.Shape;
+    ph: pml.CTPlaceholder;
+}[];
+/**
+ * The placeholders a new slide on this layout carries: one shape per placeholder the layout
+ * defines (bar the date, footer and slide-number ones), with the layout's `type` and `idx` so
+ * that each inherits that layout shape's position and text style, and with the text given in the
+ * first title and the first body one. A layout that defines none - docx4j's own - gets the
+ * default title and body pair.
+ */
+export declare function slidePlaceholdersFor(layout: pml.CommonSlideData | undefined, text?: SlideTextOptions): pml.Shape[];
+/** Puts shapes into a slide's or layout's shape tree (docx4j `cSld.getSpTree().getSpOrGrpSpOrGraphicFrame().add(...)`). */
+export declare function addShapes(spTree: pml.GroupShape, shapes: pml.Shape[]): void;

package/dist/parts/pml/placeholders.mjs

@@ -0,0 +1,141 @@
+import { createShape, createShapeNvSpPr, createNvPr, createCTPlaceholder, } from '@docx4j/generated-objects-ts/factory/org_pptx4j_pml';
+import { createCTNonVisualDrawingProps, createCTNonVisualDrawingShapeProps, createCTShapeLocking, createCTShapeProperties, createCTTextBody, createCTTextBodyProperties, createCTTextListStyle, createCTTextParagraph, createCTRegularTextRun, createCTTextCharacterProperties, createCTTransform2D, createCTPoint2D, createCTPositiveSize2D, } from '@docx4j/generated-objects-ts/factory/org_docx4j_dml';
+/**
+ * Where the title and body placeholders sit, as fractions of the slide: PowerPoint's own
+ * Title and Content layout at 4:3 (title 685800, 457200, 7772400 x 1143000; body 685800,
+ * 1600200, 7772400 x 4525963 of 9144000 x 6858000), so any slide size is laid out the same way.
+ */
+export function placeholderGeometry(sldSz) {
+    var _a, _b;
+    const w = (_a = sldSz === null || sldSz === void 0 ? void 0 : sldSz.cx) !== null && _a !== void 0 ? _a : 9144000;
+    const h = (_b = sldSz === null || sldSz === void 0 ? void 0 : sldSz.cy) !== null && _b !== void 0 ? _b : 6858000;
+    const at = (fx, fy, fcx, fcy) => ({ x: Math.round(w * fx), y: Math.round(h * fy), cx: Math.round(w * fcx), cy: Math.round(h * fcy) });
+    return { title: at(0.075, 0.0667, 0.85, 0.1667), body: at(0.075, 0.2333, 0.85, 0.66) };
+}
+/** `a:p/a:r/a:t` paragraphs for a placeholder's `p:txBody`; one empty paragraph when there is no text. */
+function paragraphsOf(lines) {
+    if (lines.length === 0)
+        return [createCTTextParagraph({ endParaRPr: createCTTextCharacterProperties({ lang: 'en-US' }) })];
+    return lines.map((text, i) => createCTTextParagraph({
+        egTextRun: [createCTRegularTextRun({ rPr: createCTTextCharacterProperties({ lang: 'en-US' }), t: text })],
+        ...(i === lines.length - 1 ? { endParaRPr: createCTTextCharacterProperties({ lang: 'en-US' }) } : {}),
+    }));
+}
+/** The body text as paragraphs: a string is split on newlines, as Office JS's `insertText` does. */
+export function bodyLines(body) {
+    if (body === undefined)
+        return [];
+    const lines = Array.isArray(body) ? body.slice() : body.split('\n');
+    while (lines.length > 0 && lines[lines.length - 1] === '')
+        lines.pop();
+    return lines;
+}
+/**
+ * One placeholder shape (docx4j's `SAMPLE_SHAPE` in `PresentationMLPackage`, and the layout
+ * markup of its `SlidePlaceholder` sample): `p:sp` with `a:spLocks noGrp`, the `p:ph`, an
+ * optional `a:xfrm` and a `p:txBody` of the lines given.
+ */
+export function placeholderShape(options) {
+    var _a;
+    const ph = createCTPlaceholder({
+        ...(options.type === undefined ? {} : { type: options.type }),
+        ...(options.idx === undefined ? {} : { idx: options.idx }),
+    });
+    const spPr = createCTShapeProperties(options.xfrm === undefined ? {} : {
+        xfrm: createCTTransform2D({
+            off: createCTPoint2D({ x: options.xfrm.x, y: options.xfrm.y }),
+            ext: createCTPositiveSize2D({ cx: options.xfrm.cx, cy: options.xfrm.cy }),
+        }),
+    });
+    return createShape({
+        nvSpPr: createShapeNvSpPr({
+            cNvPr: createCTNonVisualDrawingProps({ id: options.id, name: options.name }),
+            cNvSpPr: createCTNonVisualDrawingShapeProps({ spLocks: createCTShapeLocking({ noGrp: true }) }),
+            nvPr: createNvPr({ ph }),
+        }),
+        spPr,
+        txBody: createCTTextBody({
+            bodyPr: createCTTextBodyProperties(),
+            lstStyle: createCTTextListStyle(),
+            p: paragraphsOf((_a = options.lines) !== null && _a !== void 0 ? _a : []),
+        }),
+    });
+}
+/**
+ * The title (`p:ph type="title"`) and body (`p:ph idx="1"`) shapes a created **slide** carries,
+ * with no geometry of their own: each inherits the layout's, which is what a placeholder is for.
+ */
+export function slidePlaceholders(text = {}) {
+    return [
+        placeholderShape({ id: 2, name: 'Title 1', type: 'title', ...(text.title === undefined ? {} : { lines: [text.title] }) }),
+        placeholderShape({ id: 3, name: 'Content Placeholder 2', idx: 1, lines: bodyLines(text.body) }),
+    ];
+}
+/**
+ * The same pair for the **layout**, with the geometry the slides inherit and PowerPoint's own
+ * prompt text. Without these the slide's placeholders would have nothing to inherit from and
+ * PowerPoint would draw them at the origin with no size.
+ */
+export function layoutPlaceholders(sldSz) {
+    const geometry = placeholderGeometry(sldSz);
+    return [
+        placeholderShape({ id: 2, name: 'Title 1', type: 'title', xfrm: geometry.title, lines: ['Click to edit Master title style'] }),
+        placeholderShape({ id: 3, name: 'Content Placeholder 2', idx: 1, xfrm: geometry.body, lines: ['Click to edit Master text styles'] }),
+    ];
+}
+/** The placeholder shapes of a slide, layout or master, in shape-tree order. */
+export function placeholdersOf(cSld) {
+    var _a, _b, _c, _d;
+    const out = [];
+    for (const item of (_b = (_a = cSld === null || cSld === void 0 ? void 0 : cSld.spTree) === null || _a === void 0 ? void 0 : _a.spOrGrpSpOrGraphicFrame) !== null && _b !== void 0 ? _b : []) {
+        const shape = item;
+        const ph = (_d = (_c = shape === null || shape === void 0 ? void 0 : shape.nvSpPr) === null || _c === void 0 ? void 0 : _c.nvPr) === null || _d === void 0 ? void 0 : _d.ph;
+        if (shape.TYPE_NAME === 'org_pptx4j_pml.Shape' && ph)
+            out.push({ shape, ph });
+    }
+    return out;
+}
+/** Date, footer and slide-number placeholders: a layout's, which a new slide does not repeat
+ *  (docx4j's `SlidePlaceholder` sample deletes exactly these three when it derives a slide). */
+const NOT_ON_A_NEW_SLIDE = new Set(['dt', 'ftr', 'sldNum']);
+/**
+ * The placeholders a new slide on this layout carries: one shape per placeholder the layout
+ * defines (bar the date, footer and slide-number ones), with the layout's `type` and `idx` so
+ * that each inherits that layout shape's position and text style, and with the text given in the
+ * first title and the first body one. A layout that defines none - docx4j's own - gets the
+ * default title and body pair.
+ */
+export function slidePlaceholdersFor(layout, text = {}) {
+    const usable = placeholdersOf(layout).filter(({ ph }) => ph.type === undefined || !NOT_ON_A_NEW_SLIDE.has(ph.type));
+    if (usable.length === 0)
+        return slidePlaceholders(text);
+    let id = 2;
+    let titleTaken = false;
+    let bodyTaken = false;
+    return usable.map(({ shape, ph }) => {
+        const isTitle = ph.type === 'title' || ph.type === 'ctrTitle';
+        let lines = [];
+        if (isTitle && !titleTaken) {
+            titleTaken = true;
+            lines = text.title === undefined ? [] : [text.title];
+        }
+        else if (!isTitle && !bodyTaken) {
+            bodyTaken = true;
+            lines = bodyLines(text.body);
+        }
+        return placeholderShape({
+            id: id++,
+            name: shape.nvSpPr.cNvPr.name || (isTitle ? 'Title 1' : 'Content Placeholder 2'),
+            ...(ph.type === undefined ? {} : { type: ph.type }),
+            ...(ph.idx === undefined ? {} : { idx: ph.idx }),
+            lines,
+        });
+    });
+}
+/** Puts shapes into a slide's or layout's shape tree (docx4j `cSld.getSpTree().getSpOrGrpSpOrGraphicFrame().add(...)`). */
+export function addShapes(spTree, shapes) {
+    var _a;
+    const into = ((_a = spTree.spOrGrpSpOrGraphicFrame) !== null && _a !== void 0 ? _a : (spTree.spOrGrpSpOrGraphicFrame = []));
+    for (const shape of shapes)
+        into.push(shape);
+}

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

@@ -1,5 +1,6 @@
 import type * as sml from '@docx4j/generated-objects-ts/modules/org_xlsx4j_sml';
 import { XmlPart } from '../XmlPart.mjs';
+import { DefaultXmlPart } from '../DefaultXmlPart.mjs';
 import { BinaryPart } from '../BinaryPart.mjs';
 import { Part } from '../Part.mjs';
 import { PartName } from '../../opc/PartName.mjs';
@@ -9,13 +10,51 @@ export declare class WorkbookPart extends XmlPart<sml.Workbook> {
     stylesPart: StylesPart | undefined;
     themePart: ThemePart | undefined;
     calcChainPart: CalcChainPart | undefined;
+    /** The workbook's survey part, if it has one (CR-004). */
+    surveyPart: SurveyPart | undefined;
+    /** The Power Pivot data model (`/xl/model/item.data`), if the workbook has one (CR-004). */
+    dataModelPart: DataModelPart | undefined;
     constructor(partName?: PartName | string, contentType?: string);
     setPartShortcut(part: Part, relationshipType: string): boolean;
-    /** Worksheet parts in relationship order (the sheet order is in `contents.sheets`). */
+    /**
+     * The worksheets, in `sheets` order (the order Excel shows the tabs in) once the workbook is
+     * unmarshalled; before that, in relationship order.
+     */
     get worksheetParts(): WorksheetPart[];
+    /** The worksheets in `sheets` order, unmarshalling the workbook first. */
+    getWorksheetParts(): Promise<WorksheetPart[]>;
+    /** The worksheet at an index of `sheets` (docx4j `WorkbookPart.getWorksheet(int)`). */
+    getWorksheet(index: number): WorksheetPart;
+    /** The workbook's slicer caches (`/xl/slicerCaches/slicerCacheN.xml`), in relationship order. */
+    get slicerCacheParts(): SlicerCachePart[];
+    /** The workbook's timeline caches (`/xl/timelineCaches/timelineCacheN.xml`), in relationship order. */
+    get timelineCacheParts(): TimelineCachePart[];
+    /** The workbook's custom data properties parts, in relationship order; each names a `CustomDataPart`. */
+    get customDataPropertiesParts(): CustomDataPropertiesPart[];
+    /** docx4j `WorkbookPart.isDate1904()`. */
+    get isDate1904(): boolean;
 }
 export declare class WorksheetPart extends XmlPart<sml.Worksheet> {
+    /** The sheet's drawing part (docx4j's `Drawing`), set from the `drawing` relationship. */
+    drawingPart: Part | undefined;
+    /** The sheet's legacy comments part. */
+    commentsPart: SpreadsheetCommentsPart | undefined;
     constructor(partName: PartName | string);
+    setPartShortcut(part: Part, relationshipType: string): boolean;
+    /** The sheet's table parts (`xl/tables/tableN.xml`), in relationship order. */
+    get tableParts(): TablePart[];
+    /** The sheet's slicers parts (`/xl/slicers/slicerN.xml`), in relationship order (CR-004). */
+    get slicersParts(): SlicersPart[];
+    /** The sheet's timelines parts (`/xl/timelines/timelineN.xml`), in relationship order (CR-004). */
+    get timelinesParts(): TimelinesPart[];
+    /**
+     * The sheet's form-control properties parts (`/xl/ctrlProps/ctrlPropN.xml`), in relationship
+     * order: one per `x:control`, whose `r:id` names it from inside the sheet's
+     * `mc:AlternateContent` (CR-004).
+     */
+    get controlPropertiesParts(): ControlPropertiesPart[];
+    /** The workbook this sheet belongs to, through its source relationship. */
+    get workbookPart(): WorkbookPart | undefined;
 }
 export declare class ChartsheetPart extends XmlPart<sml.CTChartsheet> {
     constructor(partName: PartName | string);
@@ -59,3 +98,43 @@ export declare class ExternalLinkPart extends XmlPart<sml.CTExternalLink> {
 export declare class PrinterSettingsPart extends BinaryPart {
     constructor(partName: PartName | string);
 }
+/** A slicer cache (`x14:slicerCacheDefinition`), from the workbook. docx4j `SlicerCachePart`. */
+export declare class SlicerCachePart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/** A sheet's slicers (`x14:slicers`). docx4j `SlicersPart`. */
+export declare class SlicersPart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/** A timeline cache (`x15:timelineCacheDefinition`), from the workbook. docx4j `TimelineCachePart`. */
+export declare class TimelineCachePart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/** A sheet's timelines (`x15:timelines`). docx4j `TimelinesPart`. */
+export declare class TimelinesPart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/** A form control's properties (`x14:formControlPr`), from a worksheet. docx4j `ControlPropertiesPart`. */
+export declare class ControlPropertiesPart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/** The properties of a custom data part (`x14:datastoreItem`). docx4j `CustomDataPropertiesPart`. */
+export declare class CustomDataPropertiesPart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/** A survey (`x15:survey`), from the workbook. docx4j `SurveyPart`. */
+export declare class SurveyPart extends DefaultXmlPart {
+    constructor(partName?: PartName | string);
+}
+/**
+ * Custom data, whatever an add-in put there (docx4j `CustomDataPart`).  Its content type is the
+ * generic `application/binary`, so the registry chooses it by relationship type, as it does for
+ * altChunk, embedded packages, OLE objects and custom XML (CR-001 section 5.4).
+ */
+export declare class CustomDataPart extends BinaryPart {
+    constructor(partName?: PartName | string, contentType?: string);
+}
+/** The Power Pivot data model (`/xl/model/item.data`, [MS-XLDM]). docx4j `DataModelPart`. */
+export declare class DataModelPart extends BinaryPart {
+    constructor(partName?: PartName | string);
+}