@stll/folio-core 0.47.7 → 0.49.0

package/dist/docx/groupDrawingParser.js

@@ -1,6 +1,6 @@
 import { emuToPixels } from "../utils/units.js";
+import { collectGroupTextBoxes, readTransform } from "./drawingGroupChildren.js";
 import { parseImage, resolveImageData } from "./imageParser.js";
-import { PREVIEW_KINDS } from "./previewBudget.js";
 import { findAllDeep, findChildByLocalName, findChildrenByLocalName, getAttribute, getChildElements, getLocalName, getTextContent, parseNumericAttribute } from "./xmlParser.js";
 import { escapeXmlAttribute, escapeXmlText } from "@stll/docx-core";
 //#region src/docx/groupDrawingParser.ts
@@ -10,6 +10,7 @@ const DEFAULT_FONT_HALF_POINTS = 22;
 const DEFAULT_LINE_WIDTH_EMU = 9525;
 const HALF_POINT_TO_EMU = 6350;
 const MAX_GROUP_SHAPES = 256;
+const MAX_GROUP_DEPTH = 16;
 const CROP_SCALE = 1e5;
 const MAX_PATH_COMMANDS = 1e4;
 const MAX_TEXT_CHARACTERS = 2e4;
@@ -80,34 +81,66 @@ const pathData = (path) => {
 	}
 	return commands.join(" ");
 };
-const renderGeometry = (wsp) => {
+/**
+* A child's own `a:xfrm` rotation and flips, applied about its centre in the
+* coordinate space it is drawn in (ECMA-376 §20.1.7.6).
+*/
+const withChildTransform = (element, piece) => {
+	if (!piece) return piece;
+	const transform = readTransform(findChildByLocalName(findChildByLocalName(element, "spPr"), "xfrm"));
+	return wrapTransformed(transform, piece);
+};
+const wrapTransformed = (transform, piece) => {
+	if (transform.rotation === 0 && !transform.flipH && !transform.flipV) return piece;
+	const centerX = transform.x + transform.width / 2;
+	const centerY = transform.y + transform.height / 2;
+	const operations = [];
+	if (transform.rotation !== 0) operations.push(`rotate(${transform.rotation} ${centerX} ${centerY})`);
+	if (transform.flipH || transform.flipV) operations.push(`translate(${centerX} ${centerY}) scale(${transform.flipH ? -1 : 1} ${transform.flipV ? -1 : 1}) translate(${-centerX} ${-centerY})`);
+	return `<g transform="${operations.join(" ")}">${piece}</g>`;
+};
+/**
+* `unitScale` is how many EMUs one unit of the child coordinate space spans.
+* Line widths are authored in EMUs, so they are divided by it to be drawn in
+* the space the geometry is in.
+*/
+const renderGeometry = (wsp, unitScale) => {
 	const { x, y, width, height } = childTransform(wsp);
-	if (width <= 0 || height <= 0) return "";
 	const spPr = findChildByLocalName(wsp, "spPr");
 	const style = findChildByLocalName(wsp, "style");
 	const styleStroke = colorFrom(findChildByLocalName(style, "lnRef"), "none");
 	const fill = colorFrom(spPr, "none");
 	const line = findChildByLocalName(spPr, "ln");
 	const stroke = colorFrom(line, styleStroke);
-	const strokeWidth = line ? parseNumericAttribute(line, null, "w") ?? DEFAULT_LINE_WIDTH_EMU : 0;
+	const strokeWidth = (line ? parseNumericAttribute(line, null, "w") ?? DEFAULT_LINE_WIDTH_EMU : 0) / unitScale;
+	const strokeColor = stroke === "none" ? "none" : `#${stroke}`;
+	if (width <= 0 || height <= 0) {
+		if (width < 0 || height < 0 || width === 0 && height === 0 || strokeColor === "none") return "";
+		return `<line x1="${x}" y1="${y}" x2="${x + width}" y2="${y + height}" stroke="${strokeColor}" stroke-width="${strokeWidth}"/>`;
+	}
 	const paths = findAllDeep(findChildByLocalName(spPr, "custGeom"), "a", "path");
-	if (paths.length === 0) return `<rect x="${x}" y="${y}" width="${width}" height="${height}" fill="${fill === "none" ? "none" : `#${fill}`}" stroke="${stroke === "none" ? "none" : `#${stroke}`}" stroke-width="${strokeWidth}"/>`;
+	if (paths.length === 0) return `<rect x="${x}" y="${y}" width="${width}" height="${height}" fill="${fill === "none" ? "none" : `#${fill}`}" stroke="${strokeColor}" stroke-width="${strokeWidth}"/>`;
 	return paths.map((path) => {
 		const viewWidth = numericAttr(path, "w") || width;
 		const viewHeight = numericAttr(path, "h") || height;
 		const d = pathData(path);
 		if (!d) return "";
-		return `<path d="${d}" transform="translate(${x} ${y}) scale(${width / viewWidth} ${height / viewHeight})" fill="${fill === "none" ? "none" : `#${fill}`}" stroke="${stroke === "none" ? "none" : `#${stroke}`}" stroke-width="${strokeWidth}"/>`;
+		return `<path d="${d}" transform="translate(${x} ${y}) scale(${width / viewWidth} ${height / viewHeight})" fill="${fill === "none" ? "none" : `#${fill}`}" stroke="${strokeColor}" stroke-width="${strokeWidth}"/>`;
 	}).join("");
 };
-const renderTextBox = (wsp) => {
+/**
+* An approximate rendering of a text box the layout does not host (an inline
+* group, or one placed by alignment rather than offset). Font sizes are in
+* EMUs and the drawing is in child units, hence `unitScale`.
+*/
+const renderTextBox = (wsp, unitScale) => {
 	const { x, y, width, height } = childTransform(wsp);
 	if (width <= 0 || height <= 0) return "";
 	const paragraphs = findAllDeep(wsp, "w", "p");
 	const firstSize = findAllDeep(wsp, "w", "sz").at(0);
 	const halfPoints = numericAttr(firstSize ?? null, "val") || DEFAULT_FONT_HALF_POINTS;
 	const color = colorFrom(findAllDeep(wsp, "w", "color").at(0) ?? null, DEFAULT_TEXT_COLOR);
-	const fontSize = halfPoints * HALF_POINT_TO_EMU;
+	const fontSize = halfPoints * HALF_POINT_TO_EMU / unitScale;
 	const maxCharacters = Math.max(1, Math.floor(width / (fontSize * .38)));
 	const lines = paragraphs.flatMap((paragraph) => wrapLine(getTextContent(paragraph).slice(0, MAX_TEXT_CHARACTERS), maxCharacters)).map(escapeXmlText);
 	if (lines.length === 0) return "";
@@ -138,55 +171,110 @@ const renderPicture = (picture, index, rels, media) => {
 	return `<defs><clipPath id="${clipId}"><rect x="${x}" y="${y}" width="${width}" height="${height}"/></clipPath></defs><g clip-path="url(#${clipId})">${image}</g>`;
 };
 const groupViewBox = (group, width, height) => {
-	const transform = findChildByLocalName(findChildByLocalName(group, "grpSpPr"), "xfrm");
-	const childOffset = findChildByLocalName(transform, "chOff");
-	const childExtent = findChildByLocalName(transform, "chExt");
-	const childWidth = numericAttr(childExtent, "cx");
-	const childHeight = numericAttr(childExtent, "cy");
+	const transform = readTransform(findChildByLocalName(findChildByLocalName(group, "grpSpPr"), "xfrm"));
 	return {
-		x: numericAttr(childOffset, "x"),
-		y: numericAttr(childOffset, "y"),
-		width: childWidth > 0 ? childWidth : width,
-		height: childHeight > 0 ? childHeight : height
+		x: transform.childX,
+		y: transform.childY,
+		width: transform.childWidth > 0 ? transform.childWidth : width,
+		height: transform.childHeight > 0 ? transform.childHeight : height
 	};
 };
-const createSvg = (group, width, height, rels, media) => {
-	const children = getChildElements(group).slice(0, MAX_GROUP_SHAPES);
-	let content = "";
-	for (const [index, child] of children.entries()) {
-		const localName = getLocalName(child.name ?? "");
-		let piece;
-		if (localName === "pic") piece = renderPicture(child, index, rels, media);
-		else if (localName === "wsp") piece = findChildByLocalName(child, "txbx") ? renderTextBox(child) : renderGeometry(child);
-		else continue;
-		content += piece;
-		if (content.length > MAX_SVG_CHARACTERS) return null;
-	}
-	if (!content) return null;
+/**
+* A nested group's child space drawn inside its frame in the parent's space,
+* then turned by the group's own rotation and flips.
+*/
+const nestedGroupTransform = (transform) => {
+	const scaleX = transform.childWidth > 0 ? transform.width / transform.childWidth : 1;
+	const scaleY = transform.childHeight > 0 ? transform.height / transform.childHeight : 1;
+	return `translate(${transform.x} ${transform.y}) scale(${scaleX} ${scaleY}) translate(${-transform.childX} ${-transform.childY})`;
+};
+const averageScale = (scale) => (scale.x + scale.y) / 2 || 1;
+const createSvg = (group, width, height, rels, media, hostedTextBoxes) => {
+	let total = 0;
+	let shapes = 0;
+	let serial = 0;
+	/** One container's markup, or null once the budget is spent. */
+	const render = (container, scale, depth) => {
+		let content = "";
+		for (const child of getChildElements(container)) {
+			const index = serial;
+			serial += 1;
+			if (shapes >= MAX_GROUP_SHAPES) break;
+			const localName = getLocalName(child.name ?? "");
+			let piece;
+			if (localName === "pic") {
+				shapes += 1;
+				piece = withChildTransform(child, renderPicture(child, index, rels, media));
+			} else if (localName === "wsp") {
+				shapes += 1;
+				if (hostedTextBoxes.has(child)) continue;
+				const unitScale = averageScale(scale);
+				piece = withChildTransform(child, findChildByLocalName(child, "txbx") ? `${renderGeometry(child, unitScale)}${renderTextBox(child, unitScale)}` : renderGeometry(child, unitScale));
+			} else if (localName === "grpSp" && depth < MAX_GROUP_DEPTH) {
+				const transform = readTransform(findChildByLocalName(findChildByLocalName(child, "grpSpPr"), "xfrm"));
+				const scaleX = transform.childWidth > 0 ? transform.width / transform.childWidth : 1;
+				const scaleY = transform.childHeight > 0 ? transform.height / transform.childHeight : 1;
+				const nested = render(child, {
+					x: scale.x * scaleX,
+					y: scale.y * scaleY
+				}, depth + 1);
+				if (nested === null) return null;
+				piece = nested ? wrapTransformed(transform, `<g transform="${nestedGroupTransform(transform)}">${nested}</g>`) : "";
+				total -= nested.length;
+			} else continue;
+			content += piece;
+			total += piece.length;
+			if (total > MAX_SVG_CHARACTERS) return null;
+		}
+		return content;
+	};
 	const viewBox = groupViewBox(group, width, height);
+	const content = render(group, {
+		x: width / viewBox.width,
+		y: height / viewBox.height
+	}, 0);
+	if (content === null || !content && hostedTextBoxes.size === 0) return null;
 	return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="${viewBox.x} ${viewBox.y} ${viewBox.width} ${viewBox.height}" width="${emuToPixels(width)}" height="${emuToPixels(height)}">${content}</svg>`;
 };
 const groupElement = (drawing) => {
 	return findChildByLocalName(findAllDeep(drawing, "a", "graphicData").at(0) ?? null, "wgp");
 };
 /**
+* Whether the layout can place the group's text boxes itself. A floating group
+* positioned by offsets on both axes puts each child at the group's offset
+* plus the child's frame, which a text box anchored beside the group can state
+* exactly; an inline group or one placed by alignment has no such offset.
+*/
+const hostsTextBoxes = (image) => {
+	const position = image.position;
+	return image.wrap.type !== "inline" && image.anchor?.useSimplePosition !== true && position !== void 0 && position.horizontal.alignment === void 0 && position.horizontal.posOffset !== void 0 && position.vertical.alignment === void 0 && position.vertical.posOffset !== void 0;
+};
+/** The text boxes each group preview leaves to the layout, keyed by the preview. */
+const hostedTextBoxFrames = /* @__PURE__ */ new WeakMap();
+/**
+* The text boxes a group preview does not draw, which the paragraph parser
+* lifts out as text boxes of their own. Undefined for any other image.
+*/
+const groupPreviewTextBoxes = (image) => hostedTextBoxFrames.get(image);
+/**
 * Whether a `w:drawing` carries a WordprocessingGroup payload. A group this
 * module declines to rasterize has no editable projection either — the shape
 * model holds one shape, not a group — so the caller must preserve it raw.
 */
 const isGroupDrawing = (drawing) => groupElement(drawing) !== null;
 /** Parse a WordprocessingGroup drawing into a safe SVG-backed image preview. */
-const parseGroupDrawing = (drawing, rels, media) => {
+const parseGroupDrawing = (drawing, previews, rels, media) => {
 	const group = groupElement(drawing);
 	if (!group) return null;
 	const image = parseImage(drawing, void 0, void 0);
 	if (!image || image.size.width <= 0 || image.size.height <= 0) return null;
-	const svg = createSvg(group, image.size.width, image.size.height, rels, media);
+	const hosted = hostsTextBoxes(image) ? collectGroupTextBoxes(group, image.size.width, image.size.height) : [];
+	const svg = createSvg(group, image.size.width, image.size.height, rels, media, new Set(hosted.map(({ wsp }) => wsp)));
 	if (!svg || svg.length > MAX_SVG_CHARACTERS) return null;
-	image.src = `${PREVIEW_KINDS.wpGroup.srcPrefix}${encodeURIComponent(svg)}`;
-	image.mimeType = PREVIEW_KINDS.wpGroup.mimeType;
-	image.filename = PREVIEW_KINDS.wpGroup.filename;
-	return image;
+	const { rId: _rId, src: _src, mimeType: _mimeType, filename: _filename, ...frame } = image;
+	const preview = previews.svgImage("wpGroup", svg, frame);
+	if (hosted.length > 0) hostedTextBoxFrames.set(preview, hosted);
+	return preview;
 };
 //#endregion
-export { isGroupDrawing, parseGroupDrawing };
+export { groupPreviewTextBoxes, isGroupDrawing, parseGroupDrawing };

package/dist/docx/headerFooterParser.d.ts

@@ -1,5 +1,6 @@
 import { document_d_exports } from "../types/document.js";
 import { NumberingMap } from "./numberingParser.js";
+import { PreviewLedger } from "./previewBudget.js";
 import { StyleMap } from "./styleParser.js";
 import { parseFooterReference, parseFooterReferences, parseHeaderReference, parseHeaderReferences } from "./headerFooterRefParser.js";
 //#region src/docx/headerFooterParser.d.ts
@@ -28,9 +29,11 @@ type HeaderFooterMap = {
  * @param numbering - Parsed numbering definitions for lists
  * @param rels - Relationships for resolving hyperlinks/images
  * @param media - Media files for images
+ * @param previews - The ledger of the package this part belongs to; a part
+ *   read on its own charges its previews to no package
  * @returns HeaderFooter object
  */
-declare function parseHeader(headerXml: string, hdrFtrType?: document_d_exports.HeaderFooterType, styles?: StyleMap | null, theme?: document_d_exports.Theme | null, numbering?: NumberingMap | null, rels?: document_d_exports.RelationshipMap | null, media?: Map<string, document_d_exports.MediaFile> | null): document_d_exports.HeaderFooter;
+declare function parseHeader(headerXml: string, hdrFtrType?: document_d_exports.HeaderFooterType, styles?: StyleMap | null, theme?: document_d_exports.Theme | null, numbering?: NumberingMap | null, rels?: document_d_exports.RelationshipMap | null, media?: Map<string, document_d_exports.MediaFile> | null, previews?: PreviewLedger): document_d_exports.HeaderFooter;
 /**
  * Parse a footer XML file (word/footer*.xml)
  *
@@ -41,9 +44,11 @@ declare function parseHeader(headerXml: string, hdrFtrType?: document_d_exports.
  * @param numbering - Parsed numbering definitions for lists
  * @param rels - Relationships for resolving hyperlinks/images
  * @param media - Media files for images
+ * @param previews - The ledger of the package this part belongs to; a part
+ *   read on its own charges its previews to no package
  * @returns HeaderFooter object
  */
-declare function parseFooter(footerXml: string, hdrFtrType?: document_d_exports.HeaderFooterType, styles?: StyleMap | null, theme?: document_d_exports.Theme | null, numbering?: NumberingMap | null, rels?: document_d_exports.RelationshipMap | null, media?: Map<string, document_d_exports.MediaFile> | null): document_d_exports.HeaderFooter;
+declare function parseFooter(footerXml: string, hdrFtrType?: document_d_exports.HeaderFooterType, styles?: StyleMap | null, theme?: document_d_exports.Theme | null, numbering?: NumberingMap | null, rels?: document_d_exports.RelationshipMap | null, media?: Map<string, document_d_exports.MediaFile> | null, previews?: PreviewLedger): document_d_exports.HeaderFooter;
 /**
  * Generic function to parse either header or footer
  *

package/dist/docx/headerFooterParser.js

@@ -3,6 +3,7 @@ import { blockPlainText } from "./blockPlainText.js";
 import { parseFooterReference, parseFooterReferences, parseHeaderReference, parseHeaderReferences } from "./headerFooterRefParser.js";
 import { assignHeaderFooterVerbatimXml } from "./headerFooterVerbatim.js";
 import { cloneParagraphWithPropertySource } from "./paragraphPropertySource.js";
+import { standalonePreviewLedger } from "./previewBudget.js";
 import { parseWatermark } from "./watermarkParser.js";
 import { collectXmlnsDeclarations, parseXml } from "./xmlParser.js";
 //#region src/docx/headerFooterParser.ts
@@ -16,9 +17,11 @@ import { collectXmlnsDeclarations, parseXml } from "./xmlParser.js";
 * @param numbering - Parsed numbering definitions for lists
 * @param rels - Relationships for resolving hyperlinks/images
 * @param media - Media files for images
+* @param previews - The ledger of the package this part belongs to; a part
+*   read on its own charges its previews to no package
 * @returns HeaderFooter object
 */
-function parseHeader(headerXml, hdrFtrType = "default", styles = null, theme = null, numbering = null, rels = null, media = null) {
+function parseHeader(headerXml, hdrFtrType = "default", styles = null, theme = null, numbering = null, rels = null, media = null, previews = standalonePreviewLedger()) {
 	const result = {
 		type: "header",
 		hdrFtrType,
@@ -35,11 +38,15 @@ function parseHeader(headerXml, hdrFtrType = "default", styles = null, theme = n
 	}
 	result.content = parseBlockContent(rootElement, styles, theme, numbering, rels, media, {
 		inHeaderFooter: true,
-		rootXmlns: collectXmlnsDeclarations(rootElement)
+		rootXmlns: collectXmlnsDeclarations(rootElement),
+		previews
 	});
 	if (watermarkResult) {
 		const host = result.content.at(watermarkResult.blockIndex);
-		if (host?.type === "paragraph") result.content[watermarkResult.blockIndex] = cloneParagraphWithPropertySource(host, { content: [] });
+		if (host?.type === "paragraph") {
+			previews.release(host.content);
+			result.content[watermarkResult.blockIndex] = cloneParagraphWithPropertySource(host, { content: [] });
+		}
 	}
 	assignHeaderFooterVerbatimXml(result, headerXml);
 	return result;
@@ -54,9 +61,11 @@ function parseHeader(headerXml, hdrFtrType = "default", styles = null, theme = n
 * @param numbering - Parsed numbering definitions for lists
 * @param rels - Relationships for resolving hyperlinks/images
 * @param media - Media files for images
+* @param previews - The ledger of the package this part belongs to; a part
+*   read on its own charges its previews to no package
 * @returns HeaderFooter object
 */
-function parseFooter(footerXml, hdrFtrType = "default", styles = null, theme = null, numbering = null, rels = null, media = null) {
+function parseFooter(footerXml, hdrFtrType = "default", styles = null, theme = null, numbering = null, rels = null, media = null, previews = standalonePreviewLedger()) {
 	const result = {
 		type: "footer",
 		hdrFtrType,
@@ -67,7 +76,8 @@ function parseFooter(footerXml, hdrFtrType = "default", styles = null, theme = n
 	if (!rootElement) return result;
 	result.content = parseBlockContent(rootElement, styles, theme, numbering, rels, media, {
 		inHeaderFooter: true,
-		rootXmlns: collectXmlnsDeclarations(rootElement)
+		rootXmlns: collectXmlnsDeclarations(rootElement),
+		previews
 	});
 	assignHeaderFooterVerbatimXml(result, footerXml);
 	return result;

package/dist/docx/hyperlinkParser.d.ts

@@ -1,6 +1,8 @@
 import { document_d_exports } from "../types/document.js";
 import { XmlElement } from "./xmlParser.js";
+import { PreviewLedger } from "./previewBudget.js";
 import { StyleMap } from "./styleParser.js";
+import { ChildReader } from "./containerChildren.js";
 //#region src/docx/hyperlinkParser.d.ts
 /**
  * Parse a hyperlink element (w:hyperlink)
@@ -13,10 +15,19 @@ import { StyleMap } from "./styleParser.js";
  * @param styles - Style map for resolving run styles
  * @param theme - Theme for resolving colors/fonts
  * @param media - Media files map for image data
+ * @param previews - The ledger of the package this link belongs to; a link
+ *   read on its own charges its previews to no package
  * @returns Parsed Hyperlink object
  */
-declare function parseHyperlink(node: XmlElement, rels: document_d_exports.RelationshipMap | null, styles?: StyleMap | null, theme?: document_d_exports.Theme | null, media?: Map<string, document_d_exports.MediaFile> | null, rootXmlns?: Record<string, string>): document_d_exports.Hyperlink;
-/** What {@link hyperlinkChildHandlers} needs to read one child of a link. */
+declare function parseHyperlink(node: XmlElement, rels: document_d_exports.RelationshipMap | null, styles?: StyleMap | null, theme?: document_d_exports.Theme | null, media?: Map<string, document_d_exports.MediaFile> | null, rootXmlns?: Record<string, string>, previews?: PreviewLedger): document_d_exports.Hyperlink;
+/**
+ * A `w:hyperlink`'s own attributes as a link with no children yet.
+ *
+ * The paragraph parser's revision-segmenting walk reads the children itself,
+ * so it takes the shell rather than a link whose children it would discard.
+ */
+declare function parseHyperlinkShell(node: XmlElement, rels: document_d_exports.RelationshipMap | null): document_d_exports.Hyperlink;
+/** What {@link HYPERLINK_CHILD_HANDLERS} needs to read one child of a link. */
 type HyperlinkChildContext = {
   /** Where a parsed or captured child lands, in source order. */
   push: (child: document_d_exports.Hyperlink["children"][number]) => void;
@@ -24,6 +35,7 @@ type HyperlinkChildContext = {
   theme: document_d_exports.Theme | null;
   rels: document_d_exports.RelationshipMap | null;
   media: Map<string, document_d_exports.MediaFile> | null;
+  previews: PreviewLedger;
   inScopeXmlns: Record<string, string>;
 };
 /**
@@ -43,39 +55,39 @@ type HyperlinkChildContext = {
  * recognising is recognised by all of them rather than by whichever list
  * somebody remembered to update.
  */
-declare const hyperlinkChildHandlers: (context: HyperlinkChildContext) => {
-  r: (child: XmlElement) => void;
-  bookmarkStart: (child: XmlElement) => void;
-  bookmarkEnd: (child: XmlElement) => void;
-  bdo: (child: XmlElement) => void;
-  dir: (child: XmlElement) => void;
-  customXml: (child: XmlElement) => void;
-  smartTag: (child: XmlElement) => void;
-  del: "capture";
-  ins: "capture";
-  moveFrom: "capture";
-  moveTo: "capture";
-  commentRangeEnd: "capture";
-  commentRangeStart: "capture";
-  customXmlDelRangeEnd: "capture";
-  customXmlDelRangeStart: "capture";
-  customXmlInsRangeEnd: "capture";
-  customXmlInsRangeStart: "capture";
-  customXmlMoveFromRangeEnd: "capture";
-  customXmlMoveFromRangeStart: "capture";
-  customXmlMoveToRangeEnd: "capture";
-  customXmlMoveToRangeStart: "capture";
-  fldSimple: (child: XmlElement) => void;
-  hyperlink: (child: XmlElement) => void;
-  moveFromRangeEnd: "capture";
-  moveFromRangeStart: "capture";
-  moveToRangeEnd: "capture";
-  moveToRangeStart: "capture";
-  permEnd: "capture";
-  permStart: "capture";
-  proofErr: "capture";
-  sdt: "capture";
-  subDoc: "capture";
+declare const HYPERLINK_CHILD_HANDLERS: {
+  readonly r: (child: XmlElement, { push, styles, theme, rels, media, previews, inScopeXmlns }: HyperlinkChildContext) => void;
+  readonly bookmarkStart: (child: XmlElement, { push }: HyperlinkChildContext) => void;
+  readonly bookmarkEnd: (child: XmlElement, { push }: HyperlinkChildContext) => void;
+  readonly bdo: ChildReader<HyperlinkChildContext>;
+  readonly dir: ChildReader<HyperlinkChildContext>;
+  readonly customXml: ChildReader<HyperlinkChildContext>;
+  readonly smartTag: ChildReader<HyperlinkChildContext>;
+  readonly del: "capture";
+  readonly ins: "capture";
+  readonly moveFrom: "capture";
+  readonly moveTo: "capture";
+  readonly commentRangeEnd: "capture";
+  readonly commentRangeStart: "capture";
+  readonly customXmlDelRangeEnd: "capture";
+  readonly customXmlDelRangeStart: "capture";
+  readonly customXmlInsRangeEnd: "capture";
+  readonly customXmlInsRangeStart: "capture";
+  readonly customXmlMoveFromRangeEnd: "capture";
+  readonly customXmlMoveFromRangeStart: "capture";
+  readonly customXmlMoveToRangeEnd: "capture";
+  readonly customXmlMoveToRangeStart: "capture";
+  readonly fldSimple: (child: XmlElement, { push }: HyperlinkChildContext) => void;
+  readonly hyperlink: (child: XmlElement, { push }: HyperlinkChildContext) => void;
+  readonly moveFromRangeEnd: "capture";
+  readonly moveFromRangeStart: "capture";
+  readonly moveToRangeEnd: "capture";
+  readonly moveToRangeStart: "capture";
+  readonly permEnd: "capture";
+  readonly permStart: "capture";
+  readonly proofErr: "capture";
+  readonly sdt: "capture";
+  readonly subDoc: "capture";
 };
 /**
  * Get the display text of a hyperlink
@@ -169,4 +181,4 @@ declare function createExternalHyperlink(url: string, children: document_d_expor
   target?: string;
 }): document_d_exports.Hyperlink;
 //#endregion
-export { HyperlinkChildContext, createExternalHyperlink, createInternalHyperlink, getHyperlinkRuns, getHyperlinkText, getHyperlinkUrl, hasContent, hyperlinkChildHandlers, isExternalLink, isInternalLink, parseHyperlink, resolveHyperlinkUrl };
+export { HYPERLINK_CHILD_HANDLERS, HyperlinkChildContext, createExternalHyperlink, createInternalHyperlink, getHyperlinkRuns, getHyperlinkText, getHyperlinkUrl, hasContent, isExternalLink, isInternalLink, parseHyperlink, parseHyperlinkShell, resolveHyperlinkUrl };