@docx4j/core-ts 0.3.2 → 0.4.0

package/dist/model/customxml/bindings.mjs

@@ -1,6 +1,7 @@
 import { deepCopy } from '@docx4j/generated-objects-ts';
 import * as el from '@docx4j/generated-objects-ts/el/org_docx4j_wml';
 import { sdtProperty } from '@docx4j/generated-objects-ts/builders/wml';
+import { bindPicture } from './pictures.mjs';
 /** The style Word gives placeholder text, and the text docx4j's placeholder.xml carries. */
 export const PLACEHOLDER_STYLE = 'PlaceholderText';
 export const PLACEHOLDER_TEXT = 'Click here to enter text.';
@@ -114,9 +115,10 @@ function dateOf(value) {
 /**
  * Pushes the custom XML value into one control (docx4j BindingHandler's per-sdt work). Returns
  * false when nothing was written: no binding, no part, an XPath that selects nothing, a kind
- * this phase does not handle (pictures, explicit rich text), or a node holding a Flat OPC package.
+ * this phase does not handle (explicit rich text), a node holding a Flat OPC package, or a
+ * picture control whose node holds no image (`notes` says which; CR-005 section 9).
  */
-export function applyBindingTo(control) {
+export function applyBindingTo(control, notes) {
     var _a;
     const mapping = control.xmlMapping;
     if (!mapping.isMapped)
@@ -125,9 +127,14 @@ export function applyBindingTo(control) {
     if (!node)
         return false;
     const value = node.text.trim();
-    // A picture binding carries base64 image data; docx4j replaces the a:blip embed. Deferred (section 12).
-    if (control.type === 'Picture')
-        return false;
+    // A picture control's node holds base64 image data: the picture's a:blip is pointed at a new
+    // image part and the drawing kept, as docx4j's bind.xslt mode picture3 does (CR-005 section 9).
+    if (control.type === 'Picture') {
+        const outcome = bindPicture(control, value, { kind: 'keep' }, control.title || control.tag || `picture control ${control.id}`);
+        if (outcome.note)
+            notes === null || notes === void 0 ? void 0 : notes.push(outcome.note);
+        return outcome.done;
+    }
     // Explicit rich text is bound from flat OPC or XHTML in docx4j; deferred, as it is there for this route.
     if (sdtProperty(control.sdt.sdtPr, 'richText') !== undefined)
         return false;
@@ -169,15 +176,18 @@ export function applyBindingTo(control) {
 /** `applyBindings` over a list of controls. */
 export function applyBindingsTo(controls) {
     const result = { bound: 0, updated: 0, skipped: 0 };
+    const notes = [];
     for (const control of controls) {
         if (!control.xmlMapping.isMapped)
             continue;
         result.bound++;
-        if (applyBindingTo(control))
+        if (applyBindingTo(control, notes))
             result.updated++;
         else
             result.skipped++;
     }
+    if (notes.length > 0)
+        result.notes = notes;
     return result;
 }
 /**
@@ -194,6 +204,8 @@ export function updateFromControl(control) {
     const node = mapping.customXmlNode;
     if (!node)
         return false;
+    // A picture control is the asynchronous pass's (updateFromPictureControl, CR-005 section 9): its
+    // image's bytes go back to the node as base64, as Word 15 writes them (check 38).
     if (control.type === 'Picture')
         return false;
     if (sdtProperty(control.sdt.sdtPr, 'richText') !== undefined)
@@ -236,6 +248,9 @@ export function updateFromControls(controls) {
     for (const control of controls) {
         if (!control.xmlMapping.isMapped)
             continue;
+        // counted by the picture pass, which reads the image part (CR-005 section 9)
+        if (control.type === 'Picture')
+            continue;
         result.bound++;
         if (updateFromControl(control))
             result.updated++;

package/dist/model/customxml/index.d.mts

@@ -5,3 +5,6 @@ export { XmlMapping, type CustomXmlPartLookup } from './XmlMapping.mjs';
 export { CheckboxContentControl, DatePickerContentControl, ListContentControl, ContentControlListItem, PictureContentControl, RepeatingSectionContentControl, GroupContentControl, checkboxRun, CHECKED_SYMBOL, UNCHECKED_SYMBOL, CHECKBOX_FONT, } from './kinds.mjs';
 export { applyBindingsTo, applyBindingTo, updateFromControls, updateFromControl, runsForValue, formatDate, holdsFlatOpc, PLACEHOLDER_STYLE, PLACEHOLDER_TEXT, type BindingResult } from './bindings.mjs';
 export { controlIdScope, sdtKindFor, isRunLevel } from './insert.mjs';
+export { tagParamsOf, xpathsEntriesOf, selectEntryNode, OPENDOPE_XPATHS_NS, XHTML_CONTENT_TYPE, PICTURE_HANDLER, type XPathsEntry } from './opendope.mjs';
+export { applyXhtmlBindingTo, applyXhtmlBindingsTo, isXhtmlBound, type XhtmlHost, type XhtmlBindingOptions } from './xhtml.mjs';
+export { applyPictureHandlerTo, applyPictureHandlersTo, isPictureHandlerBound, bindPicture, pictureWidthOf, updateFromPictureControl, updateFromPictureControls, type PictureWidth, type PictureOutcome } from './pictures.mjs';

package/dist/model/customxml/index.mjs

@@ -7,3 +7,6 @@ export { XmlMapping } from './XmlMapping.mjs';
 export { CheckboxContentControl, DatePickerContentControl, ListContentControl, ContentControlListItem, PictureContentControl, RepeatingSectionContentControl, GroupContentControl, checkboxRun, CHECKED_SYMBOL, UNCHECKED_SYMBOL, CHECKBOX_FONT, } from './kinds.mjs';
 export { applyBindingsTo, applyBindingTo, updateFromControls, updateFromControl, runsForValue, formatDate, holdsFlatOpc, PLACEHOLDER_STYLE, PLACEHOLDER_TEXT } from './bindings.mjs';
 export { controlIdScope, sdtKindFor, isRunLevel } from './insert.mjs';
+export { tagParamsOf, xpathsEntriesOf, selectEntryNode, OPENDOPE_XPATHS_NS, XHTML_CONTENT_TYPE, PICTURE_HANDLER } from './opendope.mjs';
+export { applyXhtmlBindingTo, applyXhtmlBindingsTo, isXhtmlBound } from './xhtml.mjs';
+export { applyPictureHandlerTo, applyPictureHandlersTo, isPictureHandlerBound, bindPicture, pictureWidthOf, updateFromPictureControl, updateFromPictureControls } from './pictures.mjs';

package/dist/model/customxml/opendope.d.mts

@@ -0,0 +1,32 @@
+import type { CustomXmlPartLookup } from './XmlMapping.mjs';
+import type { CustomXmlNode } from './CustomXmlPart.mjs';
+export declare const OPENDOPE_XPATHS_NS = "http://opendope.org/xpaths";
+export declare const XHTML_CONTENT_TYPE = "application/xhtml+xml";
+/** The tag's `od:Handler` value for a picture (the specification's section 9.3; CR-005 section 9). */
+export declare const PICTURE_HANDLER = "picture";
+/** The tag's parameters, `key=value` pairs separated by `&`, in order; a value is as written (the content type keeps its `/` and `+`). */
+export declare function tagParamsOf(tag: string): Map<string, string>;
+/**
+ * An XPaths part entry: `<xpath id="x1"><dataBinding storeItemID xpath prefixMappings/></xpath>`.
+ * The attributes are unqualified (`xpaths.xsd`: `attributeFormDefault="unqualified"`; docx4j's
+ * `org.opendope.xpaths.Xpaths` and its invoice.docx write them so); a `w:`-qualified form, which
+ * this package's own check 37 and 38 files were made with, is read as well.
+ */
+export interface XPathsEntry {
+    id: string;
+    storeItemID: string;
+    xpath: string;
+    prefixMappings: string;
+}
+/** The XPaths part's entries by id, from the first custom XML part in the OpenDoPE XPaths namespace; empty without one. */
+export declare function xpathsEntriesOf(parts: CustomXmlPartLookup): Map<string, XPathsEntry>;
+/**
+ * The node an `od:xpath` entry selects: the entry's XPath over the part its `storeItemID` names
+ * (the id compared without braces or case, as `getItem` does). What a tag-bound control's pass
+ * starts from; the note says why there is no node.
+ */
+export declare function selectEntryNode(entryId: string, parts: CustomXmlPartLookup): {
+    node: CustomXmlNode;
+} | {
+    note: string;
+};

package/dist/model/customxml/opendope.mjs

@@ -0,0 +1,56 @@
+export const OPENDOPE_XPATHS_NS = 'http://opendope.org/xpaths';
+export const XHTML_CONTENT_TYPE = 'application/xhtml+xml';
+/** The tag's `od:Handler` value for a picture (the specification's section 9.3; CR-005 section 9). */
+export const PICTURE_HANDLER = 'picture';
+/** The tag's parameters, `key=value` pairs separated by `&`, in order; a value is as written (the content type keeps its `/` and `+`). */
+export function tagParamsOf(tag) {
+    const out = new Map();
+    for (const pair of tag.split('&')) {
+        const eq = pair.indexOf('=');
+        if (eq <= 0)
+            continue;
+        const key = pair.slice(0, eq).trim();
+        if (!out.has(key))
+            out.set(key, pair.slice(eq + 1).trim());
+    }
+    return out;
+}
+/** The XPaths part's entries by id, from the first custom XML part in the OpenDoPE XPaths namespace; empty without one. */
+export function xpathsEntriesOf(parts) {
+    const out = new Map();
+    const part = parts.items.find((p) => p.namespaceUri === OPENDOPE_XPATHS_NS);
+    if (!part)
+        return out;
+    const root = part.document.documentElement;
+    if (!root)
+        return out;
+    const entries = root.getElementsByTagNameNS(OPENDOPE_XPATHS_NS, 'xpath');
+    for (let i = 0; i < entries.length; i++) {
+        const entry = entries[i];
+        const id = entry.getAttribute('id');
+        const binding = entry.getElementsByTagNameNS(OPENDOPE_XPATHS_NS, 'dataBinding')[0];
+        if (!id || !binding)
+            continue;
+        const read = (name) => binding.getAttribute(name) || binding.getAttributeNS('http://schemas.openxmlformats.org/wordprocessingml/2006/main', name) || binding.getAttribute(`w:${name}`) || '';
+        out.set(id, { id, storeItemID: read('storeItemID'), xpath: read('xpath'), prefixMappings: read('prefixMappings') });
+    }
+    return out;
+}
+/**
+ * The node an `od:xpath` entry selects: the entry's XPath over the part its `storeItemID` names
+ * (the id compared without braces or case, as `getItem` does). What a tag-bound control's pass
+ * starts from; the note says why there is no node.
+ */
+export function selectEntryNode(entryId, parts) {
+    var _a;
+    const entry = xpathsEntriesOf(parts).get(entryId);
+    if (!entry)
+        return { note: `od:xpath=${entryId}: no such entry in the XPaths part` };
+    const part = (_a = parts.getItem(entry.storeItemID)) !== null && _a !== void 0 ? _a : parts.items.find((p) => p.id.replace(/[{}]/g, '').toLowerCase() === entry.storeItemID.replace(/[{}]/g, '').toLowerCase());
+    if (!part)
+        return { note: `od:xpath=${entryId}: no custom XML part ${entry.storeItemID}` };
+    const node = part.selectSingleNode(entry.xpath, entry.prefixMappings);
+    if (!node)
+        return { note: `od:xpath=${entryId}: ${entry.xpath} selects nothing` };
+    return { node };
+}

package/dist/model/customxml/pictures.d.mts

@@ -0,0 +1,54 @@
+import type { ContentControl } from '../content/ContentControl.mjs';
+import type { CustomXmlPartLookup } from './XmlMapping.mjs';
+import type { BindingResult } from './bindings.mjs';
+/**
+ * What the tag's `width` says: absent keeps the control's drawing and replaces its image; `auto`
+ * a new inline picture at its natural size, scaled down to the text width; `N` the same, scaled
+ * down to N twips when that is narrower than the text width (a value that is neither is `auto`,
+ * which is what docx4j does with one it cannot parse).
+ */
+export type PictureWidth = {
+    kind: 'keep';
+} | {
+    kind: 'auto';
+} | {
+    kind: 'twips';
+    twips: number;
+};
+export interface PictureOutcome {
+    done: boolean;
+    /** Why the control was left as it was. */
+    note?: string;
+}
+/** Whether a control is bound to a picture through its tag (`od:Handler=picture` with an `od:xpath`). */
+export declare function isPictureHandlerBound(control: ContentControl): boolean;
+/** The tag's `width` parameter, read as `PictureWidth` says. */
+export declare function pictureWidthOf(params: Map<string, string>): PictureWidth;
+/**
+ * Binds one control to a value: base64 image data (a data URL accepted). With `keep`, the first
+ * `a:blip`'s `r:embed` is pointed at a new image part and the drawing is left as it is; a picture
+ * control holding no picture gets a new inline one at its natural size instead (docx4j's pre-v3
+ * fallback), a tag-bound control holding none is left and noted. Otherwise the control's content
+ * becomes one run holding a new inline picture, sized as `PictureWidth` says, in the first
+ * paragraph of a block-level control (its properties kept) or as a run-level control's content.
+ * An empty value, a value that is not an image this package reads (PNG, JPEG, GIF, BMP; SVG where
+ * the drawing is kept, since it has no pixel size to place a new picture at), and a body with no
+ * part each leave the control as it was, with a note. The image part the control showed before
+ * stays in the package, as docx4j leaves it.
+ */
+export declare function bindPicture(control: ContentControl, value: string, width: PictureWidth, label: string): PictureOutcome;
+/** Binds one tag-bound control (shape b): the entry's node, the tag's width. */
+export declare function applyPictureHandlerTo(control: ContentControl, parts: CustomXmlPartLookup): PictureOutcome;
+/** The picture pass over the tag-bound controls, after the text bindings: counted into the result, what was left said in its notes. */
+export declare function applyPictureHandlersTo(controls: ContentControl[], parts: CustomXmlPartLookup, result: BindingResult): void;
+/**
+ * The reverse direction for a mapped picture control (docx4j's `UpdateXmlFromDocumentSurface`
+ * skips pictures; Word 15 writes the picture back, check 38): the bytes of the image part the
+ * first `a:blip` embeds, as base64, into the node. Nothing is written when the node already holds
+ * those bytes (compared decoded, so Word's line-wrapped base64 counts as the same), when the
+ * control shows no picture, or when the blip's part is not an image part. Asynchronous, since a
+ * part's bytes may still be in the container.
+ */
+export declare function updateFromPictureControl(control: ContentControl): Promise<boolean>;
+/** `updateFromContentControls`' picture pass: the mapped picture controls, counted into the result. */
+export declare function updateFromPictureControls(controls: ContentControl[], result: BindingResult): Promise<void>;

package/dist/model/customxml/pictures.mjs

@@ -0,0 +1,186 @@
+import { find } from '../content/tree.mjs';
+import { addImage, addImagePart, writableWidthEmu } from '../content/InlinePicture.mjs';
+import { ImagePart } from '../../parts/BinaryPart.mjs';
+import { base64Decode, base64Encode } from '../../xml/dom.mjs';
+import { enclosingCellOf } from '../properties/table.mjs';
+import { tagParamsOf, selectEntryNode, PICTURE_HANDLER } from './opendope.mjs';
+const EMU_PER_TWIP = 635;
+const BLIP = 'org_docx4j_dml.CTBlip';
+/** Whether a control is bound to a picture through its tag (`od:Handler=picture` with an `od:xpath`). */
+export function isPictureHandlerBound(control) {
+    const params = tagParamsOf(control.tag);
+    return params.get('od:Handler') === PICTURE_HANDLER && params.has('od:xpath');
+}
+/** The tag's `width` parameter, read as `PictureWidth` says. */
+export function pictureWidthOf(params) {
+    const width = params.get('width');
+    if (width === undefined)
+        return { kind: 'keep' };
+    const twips = /^\d+$/.test(width.trim()) ? Number(width) : 0;
+    return twips > 0 ? { kind: 'twips', twips } : { kind: 'auto' };
+}
+/** The node's value as base64: a data URL's prefix dropped, whitespace left to the lenient decoder. */
+function base64Of(value) {
+    return value.replace(/^\s*data:[^,]*,/, '').trim();
+}
+function messageOf(e) {
+    return e instanceof Error ? e.message : String(e);
+}
+/** The first `a:blip` anywhere in the control's content, whose `r:embed` is the image. */
+function firstBlipOf(control) {
+    var _a;
+    for (const blip of find((_a = control.sdt.sdtContent) !== null && _a !== void 0 ? _a : {}, BLIP))
+        return blip;
+    return undefined;
+}
+/** A width stated in twips (`dxa`, or no type), else undefined. */
+function twipsOf(width) {
+    return width && typeof width.w === 'number' && width.w >= 0 && (width.type === undefined || width.type === 'dxa') ? width.w : undefined;
+}
+/**
+ * Word's default cell margins, 108 twips left and right (the `Normal Table` style's
+ * `w:tblCellMar`, which every table inherits), taken where neither the cell nor the table states
+ * one; a table style stating other margins is not read.
+ */
+const DEFAULT_CELL_MARGIN_TWIPS = 108;
+/** The cell's left and right margins together, in twips: `w:tcMar`, else the table's `w:tblCellMar`, else Word's defaults. */
+function cellMarginsTwips(tc, tbl) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const own = (_a = tc.tcPr) === null || _a === void 0 ? void 0 : _a.tcMar;
+    const table = (_b = tbl.tblPr) === null || _b === void 0 ? void 0 : _b.tblCellMar;
+    const left = (_e = (_c = twipsOf(own === null || own === void 0 ? void 0 : own.left)) !== null && _c !== void 0 ? _c : twipsOf((_d = table === null || table === void 0 ? void 0 : table.left) !== null && _d !== void 0 ? _d : table === null || table === void 0 ? void 0 : table.start)) !== null && _e !== void 0 ? _e : DEFAULT_CELL_MARGIN_TWIPS;
+    const right = (_h = (_f = twipsOf(own === null || own === void 0 ? void 0 : own.right)) !== null && _f !== void 0 ? _f : twipsOf((_g = table === null || table === void 0 ? void 0 : table.right) !== null && _g !== void 0 ? _g : table === null || table === void 0 ? void 0 : table.end)) !== null && _h !== void 0 ? _h : DEFAULT_CELL_MARGIN_TWIPS;
+    return left + right;
+}
+/**
+ * The width a new picture must fit, in EMU: the cell's `w:tcW` less its margins when the control
+ * is in a table cell and the width is stated in twips (a percentage or `auto` falls to the page),
+ * else the page's text width; narrowed to `width=N`. Undefined where nothing states a width (a
+ * header's body has no `w:sectPr`): the natural size then.
+ */
+function maxWidthEmu(control, width) {
+    var _a;
+    const cell = enclosingCellOf(control.element.value);
+    const tcW = cell ? twipsOf((_a = cell.tc.tcPr) === null || _a === void 0 ? void 0 : _a.tcW) : undefined;
+    const inner = cell && tcW !== undefined ? tcW - cellMarginsTwips(cell.tc, cell.tbl) : undefined;
+    const cellEmu = inner !== undefined && inner > 0 ? inner * EMU_PER_TWIP : undefined;
+    const text = cellEmu !== null && cellEmu !== void 0 ? cellEmu : writableWidthEmu(control.parentBody.container);
+    if (width.kind === 'twips') {
+        const wanted = width.twips * EMU_PER_TWIP;
+        return text === undefined ? wanted : Math.min(wanted, text);
+    }
+    return text;
+}
+/**
+ * Binds one control to a value: base64 image data (a data URL accepted). With `keep`, the first
+ * `a:blip`'s `r:embed` is pointed at a new image part and the drawing is left as it is; a picture
+ * control holding no picture gets a new inline one at its natural size instead (docx4j's pre-v3
+ * fallback), a tag-bound control holding none is left and noted. Otherwise the control's content
+ * becomes one run holding a new inline picture, sized as `PictureWidth` says, in the first
+ * paragraph of a block-level control (its properties kept) or as a run-level control's content.
+ * An empty value, a value that is not an image this package reads (PNG, JPEG, GIF, BMP; SVG where
+ * the drawing is kept, since it has no pixel size to place a new picture at), and a body with no
+ * part each leave the control as it was, with a note. The image part the control showed before
+ * stays in the package, as docx4j leaves it.
+ */
+export function bindPicture(control, value, width, label) {
+    const base64 = base64Of(value);
+    if (base64 === '')
+        return { done: false, note: `${label}: the node is empty; the control is left as it is` };
+    const source = control.parentBody.part;
+    if (!source)
+        return { done: false, note: `${label}: the control's body has no part to hold an image` };
+    if (width.kind === 'keep') {
+        const blip = firstBlipOf(control);
+        if (blip) {
+            try {
+                blip.embed = addImagePart(source, base64).relId;
+            }
+            catch (e) {
+                return { done: false, note: `${label}: not an image this package reads (${messageOf(e)})` };
+            }
+            control.isShowingPlaceholder = false;
+            return { done: true };
+        }
+        if (control.type !== 'Picture')
+            return { done: false, note: `${label}: the control holds no a:blip to point at the image (od:Handler=picture without width keeps the drawing)` };
+        width = { kind: 'auto' };
+    }
+    let run;
+    try {
+        run = addImage(source, base64, control.parentBody.container, maxWidthEmu(control, width)).run;
+    }
+    catch (e) {
+        return { done: false, note: `${label}: not an image this package reads (${messageOf(e)})` };
+    }
+    control.setBoundContent([run]);
+    return { done: true };
+}
+/** Binds one tag-bound control (shape b): the entry's node, the tag's width. */
+export function applyPictureHandlerTo(control, parts) {
+    var _a;
+    const params = tagParamsOf(control.tag);
+    const entryId = (_a = params.get('od:xpath')) !== null && _a !== void 0 ? _a : '';
+    const selected = selectEntryNode(entryId, parts);
+    if ('note' in selected)
+        return { done: false, note: selected.note };
+    return bindPicture(control, selected.node.text, pictureWidthOf(params), `od:xpath=${entryId}`);
+}
+/** The picture pass over the tag-bound controls, after the text bindings: counted into the result, what was left said in its notes. */
+export function applyPictureHandlersTo(controls, parts, result) {
+    var _a;
+    for (const control of controls) {
+        if (!isPictureHandlerBound(control))
+            continue;
+        result.bound++;
+        const outcome = applyPictureHandlerTo(control, parts);
+        if (outcome.done)
+            result.updated++;
+        else
+            result.skipped++;
+        if (outcome.note)
+            ((_a = result.notes) !== null && _a !== void 0 ? _a : (result.notes = [])).push(outcome.note);
+    }
+}
+/**
+ * The reverse direction for a mapped picture control (docx4j's `UpdateXmlFromDocumentSurface`
+ * skips pictures; Word 15 writes the picture back, check 38): the bytes of the image part the
+ * first `a:blip` embeds, as base64, into the node. Nothing is written when the node already holds
+ * those bytes (compared decoded, so Word's line-wrapped base64 counts as the same), when the
+ * control shows no picture, or when the blip's part is not an image part. Asynchronous, since a
+ * part's bytes may still be in the container.
+ */
+export async function updateFromPictureControl(control) {
+    var _a;
+    const mapping = control.xmlMapping;
+    if (!mapping.isMapped || control.type !== 'Picture')
+        return false;
+    const node = mapping.customXmlNode;
+    if (!node)
+        return false;
+    const blip = firstBlipOf(control);
+    const source = control.parentBody.part;
+    if (!(blip === null || blip === void 0 ? void 0 : blip.embed) || !source)
+        return false;
+    const part = (_a = source.relationshipsPart) === null || _a === void 0 ? void 0 : _a.getPart(blip.embed);
+    if (!(part instanceof ImagePart))
+        return false;
+    const bytes = await part.getBytes();
+    const held = base64Decode(node.text);
+    if (held.length === bytes.length && held.every((b, i) => b === bytes[i]))
+        return false;
+    node.text = base64Encode(bytes);
+    return true;
+}
+/** `updateFromContentControls`' picture pass: the mapped picture controls, counted into the result. */
+export async function updateFromPictureControls(controls, result) {
+    for (const control of controls) {
+        if (control.type !== 'Picture' || !control.xmlMapping.isMapped)
+            continue;
+        result.bound++;
+        if (await updateFromPictureControl(control))
+            result.updated++;
+        else
+            result.skipped++;
+    }
+}

package/dist/model/customxml/xhtml.d.mts

@@ -0,0 +1,42 @@
+import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
+import type { PropertyResolver } from '../properties/index.mjs';
+import type { ContentControl } from '../content/ContentControl.mjs';
+import type { CustomXmlPartLookup } from './XmlMapping.mjs';
+import type { BindingResult } from './bindings.mjs';
+/** What the XHTML pass needs of the package. */
+export interface XhtmlHost {
+    numbering: {
+        newList(options?: {
+            bullet?: boolean;
+        }): Promise<string>;
+        restart(numId: string): string;
+    };
+    styles: {
+        ensure(ids: readonly string[]): Promise<string[]>;
+    };
+    requireStyles(ids: Iterable<string>): void;
+    getPropertyResolver(): Promise<PropertyResolver>;
+    getMainDocumentPart(): {
+        styleDefinitionsPart?: {
+            readContents(): Promise<wml.Styles>;
+        } | undefined;
+    };
+}
+export interface XhtmlBindingOptions {
+    /** The HTML parser: a browser's `DOMParser` by default; jsdom's or linkedom's in Node. */
+    parser?: (html: string) => Document;
+}
+/** Whether a control is bound to XHTML through its tag. */
+export declare function isXhtmlBound(control: ContentControl): boolean;
+/**
+ * Binds one XHTML control. Returns what was done, or a note saying why not: no entry, no part, no
+ * node, no parser in this runtime. The content the markup gave that the control cannot hold is in
+ * `dropped` (a run-level control's blocks after the first, and what the converter dropped).
+ */
+export declare function applyXhtmlBindingTo(control: ContentControl, parts: CustomXmlPartLookup, host: XhtmlHost, options?: XhtmlBindingOptions): Promise<{
+    done: boolean;
+    note?: string;
+    dropped?: Record<string, number>;
+}>;
+/** The XHTML pass over the controls, after the text bindings: counted into the result, what was left said in its notes. */
+export declare function applyXhtmlBindingsTo(controls: ContentControl[], parts: CustomXmlPartLookup, host: XhtmlHost, result: BindingResult, options?: XhtmlBindingOptions): Promise<void>;

package/dist/model/customxml/xhtml.mjs

@@ -0,0 +1,162 @@
+import { deepCopy } from '@docx4j/generated-objects-ts';
+import { Namespaces } from '../../parts/Namespaces.mjs';
+import { typeNameOf, linkParents, childrenOf } from '../content/tree.mjs';
+import { contentOf } from '../content/ooxml.mjs';
+import { convertHtml, styleLookupOf } from '../../html/convert.mjs';
+import { blocksToXml, needsOf, HYPERLINK_STYLE } from '../../html/elements.mjs';
+import { tagParamsOf, xpathsEntriesOf, XHTML_CONTENT_TYPE } from './opendope.mjs';
+/** Whether a control is bound to XHTML through its tag. */
+export function isXhtmlBound(control) {
+    const params = tagParamsOf(control.tag);
+    return params.get('od:ContentType') === XHTML_CONTENT_TYPE && params.has('od:xpath');
+}
+async function lookupFor(host) {
+    var _a, _b, _c;
+    const entries = [];
+    const part = host.getMainDocumentPart().styleDefinitionsPart;
+    if (part) {
+        const styles = await part.readContents();
+        for (const s of (_a = styles.style) !== null && _a !== void 0 ? _a : []) {
+            if (!s.styleId)
+                continue;
+            if (s.type !== undefined && s.type !== 'paragraph' && s.type !== 'character')
+                continue;
+            if (s.hidden !== undefined && s.hidden.val !== false)
+                continue;
+            entries.push({ id: s.styleId, name: (_c = (_b = s.name) === null || _b === void 0 ? void 0 : _b.val) !== null && _c !== void 0 ? _c : s.styleId });
+        }
+    }
+    const resolver = await host.getPropertyResolver();
+    return styleLookupOf(entries, resolver.getStyle('TableGrid') ? ['TableGrid'] : []);
+}
+/** The object behind an element: a parsed fragment's elements are wrapped (`{ name, value }`), the tree's own may not be. */
+function innerOf(element) {
+    const e = element;
+    return e.name !== undefined && e.value !== undefined && typeof e.value === 'object' ? e.value : element;
+}
+/** The control's run properties onto every run the markup left without any (a hyperlink's runs included). */
+function applyRunProperties(elements, rPr) {
+    if (!rPr)
+        return;
+    const visit = (items) => {
+        if (!items)
+            return;
+        for (const item of items) {
+            const name = typeNameOf(item);
+            const inner = innerOf(item);
+            if (name === 'org_docx4j_wml.R') {
+                const run = inner;
+                if (!run.rPr)
+                    run.rPr = deepCopy(rPr);
+            }
+            else if (name !== undefined) {
+                visit(childrenOf(inner));
+            }
+        }
+    };
+    visit(elements);
+}
+function inlineContentOf(paragraph) {
+    var _a;
+    const content = (_a = childrenOf(innerOf(paragraph))) !== null && _a !== void 0 ? _a : [];
+    return content.filter((item) => { const n = typeNameOf(item); return n === 'org_docx4j_wml.R' || n === 'org_docx4j_wml.P.Hyperlink'; });
+}
+/**
+ * Binds one XHTML control. Returns what was done, or a note saying why not: no entry, no part, no
+ * node, no parser in this runtime. The content the markup gave that the control cannot hold is in
+ * `dropped` (a run-level control's blocks after the first, and what the converter dropped).
+ */
+export async function applyXhtmlBindingTo(control, parts, host, options = {}) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _j;
+    const params = tagParamsOf(control.tag);
+    const entryId = params.get('od:xpath');
+    const entry = xpathsEntriesOf(parts).get(entryId);
+    if (!entry)
+        return { done: false, note: `od:xpath=${entryId}: no such entry in the XPaths part` };
+    const part = (_a = parts.getItem(entry.storeItemID)) !== null && _a !== void 0 ? _a : parts.items.find((p) => p.id.replace(/[{}]/g, '').toLowerCase() === entry.storeItemID.replace(/[{}]/g, '').toLowerCase());
+    if (!part)
+        return { done: false, note: `od:xpath=${entryId}: no custom XML part ${entry.storeItemID}` };
+    const node = part.selectSingleNode(entry.xpath, entry.prefixMappings);
+    if (!node)
+        return { done: false, note: `od:xpath=${entryId}: ${entry.xpath} selects nothing` };
+    const parser = (_b = options.parser) !== null && _b !== void 0 ? _b : (typeof DOMParser === 'function' ? (h) => new DOMParser().parseFromString(h, 'text/html') : undefined);
+    if (!parser)
+        return { done: false, note: `od:xpath=${entryId}: XHTML needs an HTML parser (applyBindings({ html: { parser } }))` };
+    const converted = convertHtml(node.text, await lookupFor(host), { parser });
+    const dropped = { ...converted.report.dropped };
+    const { blocks } = converted;
+    // What the document must give first: the styles the markup names, a definition per list, a relationship per link.
+    if (converted.report.stylesWanted.length > 0) {
+        try {
+            await host.styles.ensure(converted.report.stylesWanted);
+        }
+        catch {
+            dropped['styles the defaults lack'] = ((_c = dropped['styles the defaults lack']) !== null && _c !== void 0 ? _c : 0) + converted.report.stylesWanted.length;
+        }
+    }
+    const needs = needsOf(blocks);
+    const lists = new Map();
+    let firstNumbered;
+    for (const { key, bullet } of needs.lists) {
+        if (bullet)
+            lists.set(key, await host.numbering.newList({ bullet: true }));
+        else if (firstNumbered === undefined) {
+            firstNumbered = await host.numbering.newList({ bullet: false });
+            lists.set(key, firstNumbered);
+        }
+        else
+            lists.set(key, host.numbering.restart(firstNumbered));
+    }
+    const links = new Map();
+    const rels = needs.links.length > 0 ? (_d = control.parentBody.part) === null || _d === void 0 ? void 0 : _d.getRelationshipsPart(true) : undefined;
+    if (rels) {
+        for (const address of needs.links)
+            links.set(address, rels.addExternalRelationship(Namespaces.HYPERLINK, address).id);
+        host.requireStyles([HYPERLINK_STYLE]);
+    }
+    else if (needs.links.length > 0)
+        dropped['links'] = ((_e = dropped['links']) !== null && _e !== void 0 ? _e : 0) + needs.links.length;
+    const elements = await contentOf(blocksToXml(blocks, { numId: (key) => lists.get(key), relId: (address) => links.get(address) }));
+    applyRunProperties(elements, control.runProperties);
+    const sdt = control.sdt;
+    (_f = sdt.sdtContent) !== null && _f !== void 0 ? _f : (sdt.sdtContent = {});
+    const content = ((_g = (_j = sdt.sdtContent).content) !== null && _g !== void 0 ? _g : (_j.content = []));
+    if (control.form === 'Run') {
+        // A run-level control holds inline content: the first paragraph's, the rest reported.
+        const first = elements.find((e) => typeNameOf(e) === 'org_docx4j_wml.P');
+        const inlines = first ? inlineContentOf(first) : [];
+        const rest = elements.length - (first ? 1 : 0);
+        if (rest > 0)
+            dropped['blocks after the first, in a run-level control'] = ((_h = dropped['blocks after the first, in a run-level control']) !== null && _h !== void 0 ? _h : 0) + rest;
+        content.length = 0;
+        content.push(...inlines);
+        linkParents(content, sdt.sdtContent);
+    }
+    else {
+        content.length = 0;
+        content.push(...elements);
+        linkParents(content, sdt.sdtContent);
+    }
+    control.isShowingPlaceholder = false;
+    return Object.keys(dropped).length > 0 ? { done: true, dropped } : { done: true };
+}
+/** The XHTML pass over the controls, after the text bindings: counted into the result, what was left said in its notes. */
+export async function applyXhtmlBindingsTo(controls, parts, host, result, options = {}) {
+    var _a, _b;
+    for (const control of controls) {
+        if (!isXhtmlBound(control))
+            continue;
+        result.bound++;
+        const outcome = await applyXhtmlBindingTo(control, parts, host, options);
+        if (outcome.done)
+            result.updated++;
+        else
+            result.skipped++;
+        if (outcome.note)
+            ((_a = result.notes) !== null && _a !== void 0 ? _a : (result.notes = [])).push(outcome.note);
+        if (outcome.dropped)
+            for (const [kind, n] of Object.entries(outcome.dropped))
+                ((_b = result.notes) !== null && _b !== void 0 ? _b : (result.notes = [])).push(`${control.tag}: dropped ${kind} (${n})`);
+    }
+}

package/dist/packages/WordprocessingMLPackage.mjs

@@ -621,6 +621,7 @@ export class WordprocessingMLPackage extends OpcPackage {
                 return bodies;
             },
             customXmlRelationshipSource: () => this.getMainDocumentPart(),
+            xhtmlHost: this,
         })));
     }
     get progId() {