docx 9.9.0 → 9.10.0

package/dist/index.cjs

@@ -12786,7 +12786,7 @@ var import_hash = /* @__PURE__ */ __toESM((/* @__PURE__ */ __commonJSMin(((expor
 	hash.sha512 = hash.sha.sha512;
 	hash.ripemd160 = hash.ripemd.ripemd160;
 })))(), 1);
-var urlAlphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";
+var urlAlphabet = "57X6y3wQZNzYjJB2L_10pxbackgroundhimselfUTF-8DEMOGRAPHICSVqvt4KW9";
 //#endregion
 //#region node_modules/nanoid/non-secure/index.js
 var customAlphabet = (alphabet, defaultSize = 21) => {
@@ -14583,48 +14583,6 @@ var ChildNonVisualProperties = class extends XmlComponent {
 	}
 };
 //#endregion
-//#region src/file/drawing/doc-properties/doc-properties-children.ts
-/**
-* Child elements for document properties.
-*
-* This module provides hyperlink elements that can be attached to
-* drawing elements for interactive behavior.
-*
-* @module
-*/
-/**
-* Creates a click hyperlink element for a drawing.
-*
-* This element defines what happens when a user clicks on a drawing element.
-*
-* ## XSD Schema
-* ```xml
-* <xsd:complexType name="CT_Hyperlink">
-*   <xsd:group ref="EG_PContent" minOccurs="0" maxOccurs="unbounded"/>
-*   <xsd:attribute name="tgtFrame" type="s:ST_String"/>
-*   <xsd:attribute name="tooltip" type="s:ST_String"/>
-*   <xsd:attribute name="docLocation" type="s:ST_String"/>
-*   <xsd:attribute name="history" type="s:ST_OnOff"/>
-*   <xsd:attribute name="anchor" type="s:ST_String"/>
-*   <xsd:attribute ref="r:id"/>
-* </xsd:complexType>
-* ```
-*
-* @param linkId - The relationship ID for the hyperlink target
-* @param hasXmlNs - Whether to include the XML namespace declaration
-* @returns An XML component representing the click hyperlink
-*/
-var createHyperlinkClick = (linkId, hasXmlNs) => new BuilderElement({
-	name: "a:hlinkClick",
-	attributes: _objectSpread2(_objectSpread2({}, hasXmlNs ? { xmlns: {
-		key: "xmlns:a",
-		value: "http://schemas.openxmlformats.org/drawingml/2006/main"
-	} } : {}), {}, { id: {
-		key: "r:id",
-		value: `rId${linkId}`
-	} })
-});
-//#endregion
 //#region src/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/non-visual-properties/non-visual-properties-attributes.ts
 /**
 * Non-visual properties attributes module.
@@ -14705,7 +14663,7 @@ var NonVisualProperties = class extends XmlComponent {
 		for (let i = context.stack.length - 1; i >= 0; i--) {
 			const element = context.stack[i];
 			if (!(element instanceof ConcreteHyperlink)) continue;
-			this.root.push(createHyperlinkClick(element.linkId, false));
+			this.root.push(element.createDrawingClick(context, false));
 			break;
 		}
 		const result = super.prepForXml(context);
@@ -15375,6 +15333,48 @@ var createRelationship = (id, type, target, targetMode) => new BuilderElement({
 	}
 });
 //#endregion
+//#region src/file/drawing/doc-properties/doc-properties-children.ts
+/**
+* Child elements for document properties.
+*
+* This module provides hyperlink elements that can be attached to
+* drawing elements for interactive behavior.
+*
+* @module
+*/
+/**
+* Creates a click hyperlink element for a drawing.
+*
+* This element defines what happens when a user clicks on a drawing element.
+*
+* ## XSD Schema
+* ```xml
+* <xsd:complexType name="CT_Hyperlink">
+*   <xsd:group ref="EG_PContent" minOccurs="0" maxOccurs="unbounded"/>
+*   <xsd:attribute name="tgtFrame" type="s:ST_String"/>
+*   <xsd:attribute name="tooltip" type="s:ST_String"/>
+*   <xsd:attribute name="docLocation" type="s:ST_String"/>
+*   <xsd:attribute name="history" type="s:ST_OnOff"/>
+*   <xsd:attribute name="anchor" type="s:ST_String"/>
+*   <xsd:attribute ref="r:id"/>
+* </xsd:complexType>
+* ```
+*
+* @param linkId - The relationship ID for the hyperlink target
+* @param hasXmlNs - Whether to include the XML namespace declaration
+* @returns An XML component representing the click hyperlink
+*/
+var createHyperlinkClick = (linkId, hasXmlNs) => new BuilderElement({
+	name: "a:hlinkClick",
+	attributes: _objectSpread2(_objectSpread2({}, hasXmlNs ? { xmlns: {
+		key: "xmlns:a",
+		value: "http://schemas.openxmlformats.org/drawingml/2006/main"
+	} } : {}), {}, { id: {
+		key: "r:id",
+		value: `rId${linkId}`
+	} })
+});
+//#endregion
 //#region src/file/drawing/doc-properties/non-visual-drawing-properties.ts
 /**
 * Non-visual drawing properties (`CT_NonVisualDrawingProps`) of the shapes, pictures and groups inside a drawing:
@@ -15569,7 +15569,7 @@ var DocProperties = class extends XmlComponent {
 		} else for (let i = context.stack.length - 1; i >= 0; i--) {
 			const element = context.stack[i];
 			if (!(element instanceof ConcreteHyperlink)) continue;
-			this.root.push(createHyperlinkClick(element.linkId, true));
+			this.root.push(element.createDrawingClick(context, true));
 			break;
 		}
 		if (this.decorative) this.root.push(createDecorativeExtensionList(true));
@@ -18957,20 +18957,44 @@ var HyperlinkType = {
 * ```
 */
 var ConcreteHyperlink = class extends XmlComponent {
-	constructor(children, relationshipId, anchor) {
+	/**
+	* @param children - Inline content of the hyperlink
+	* @param relationshipId - Id of the external relationship, without the rId prefix
+	* @param anchor - Bookmark name or external URL fragment
+	* @param externalLink - The full address of an external hyperlink, so the relationship id is kept alongside its anchor
+	*/
+	constructor(children, relationshipId, anchor, externalLink) {
 		super("w:hyperlink");
 		_defineProperty(this, "linkId", void 0);
+		_defineProperty(this, "drawingLink", void 0);
 		this.linkId = relationshipId;
+		this.drawingLink = anchor && externalLink !== void 0 ? new DrawingLink(externalLink) : void 0;
 		const attributes = new HyperlinkAttributes({
 			history: 1,
 			anchor: anchor ? anchor : void 0,
-			id: !anchor ? `rId${this.linkId}` : void 0
+			id: !anchor || externalLink !== void 0 ? `rId${this.linkId}` : void 0
 		});
 		this.root.push(attributes);
 		children.forEach((child) => {
 			this.root.push(child);
 		});
 	}
+	/**
+	* Creates the `a:hlinkClick` of a picture in the hyperlink, which links to the same address.
+	*
+	* The hyperlink decides which relationship its pictures use, rather than the pictures reading `linkId`, because only it
+	* knows whether that relationship has lost the fragment to `w:anchor`. The picture's relationship is added as the
+	* picture is written, through the context's relationships, so it lands in the part the picture is in, both when
+	* packing and when patching.
+	*
+	* @param context - The context the picture is written in, whose relationships get the picture's link if it has its own
+	* @param declareNamespace - Declares the DrawingML namespace, for elements outside `a:graphic` such as `wp:docPr`
+	*/
+	createDrawingClick(context, declareNamespace) {
+		if (!this.drawingLink) return createHyperlinkClick(this.linkId, declareNamespace);
+		this.drawingLink.addRelationship(context);
+		return this.drawingLink.createClick(declareNamespace);
+	}
 };
 /**
 * Represents an internal hyperlink to a bookmark within the document.
@@ -19019,6 +19043,11 @@ var InternalHyperlink = class extends ConcreteHyperlink {
 * External hyperlinks create a relationship to an external resource (URL).
 * The relationship is created during document preparation and the hyperlink
 * is converted to a ConcreteHyperlink with the relationship ID.
+* URL fragments of at most 255 UTF-16 units are written as anchors, preserving any additional # characters.
+* Longer fragments stay in the original relationship URI to avoid exceeding Word's anchor limit;
+* those links retain the existing limitations for fragments with multiple # characters.
+* Word appends the anchor to the relationship target as described in MS-OI29500 §17.16.22:
+* https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oi29500/df06e423-11a6-4a36-bfb3-82139e531781
 *
 * Reference: http://officeopenxml.com/WPhyperlink.php
 *
@@ -19032,6 +19061,7 @@ var InternalHyperlink = class extends ConcreteHyperlink {
 *   <xsd:group ref="EG_PContent" minOccurs="0" maxOccurs="unbounded"/>
 *   <xsd:attribute ref="r:id"/>
 *   <xsd:attribute name="history" type="s:ST_OnOff" use="optional"/>
+*   <xsd:attribute name="anchor" type="s:ST_String" use="optional"/>
 * </xsd:complexType>
 * ```
 *
@@ -19480,6 +19510,29 @@ var PageReference = class extends Run {
 	}
 };
 //#endregion
+//#region src/file/paragraph/links/external-hyperlink-target.ts
+/**
+* External hyperlink targets and fragments for WordprocessingML.
+*
+* Word appends the anchor to the relationship target, separated by a # character.
+* Reference: https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oi29500/df06e423-11a6-4a36-bfb3-82139e531781
+*
+* @module
+*/
+var MAX_ANCHOR_LENGTH = 255;
+/**
+* Splits a nonempty fragment that fits Word's anchor limit without decoding or normalizing either part.
+* Longer fragments stay in the original relationship URI, retaining its existing multi-hash limitations.
+*/
+var externalHyperlinkTarget = (link) => {
+	const index = link.indexOf("#");
+	const fragmentLength = link.length - index - 1;
+	return index > 0 && fragmentLength > 0 && fragmentLength <= MAX_ANCHOR_LENGTH ? {
+		target: link.slice(0, index),
+		anchor: link.slice(index + 1)
+	} : { target: link };
+};
+//#endregion
 //#region src/file/fonts/font.ts
 /**
 * Font module for WordprocessingML documents.
@@ -19618,32 +19671,26 @@ var createFont = ({ name, altName, panose1, charset, family, notTrueType, pitch,
 	]
 });
 //#endregion
-//#region src/file/fonts/create-regular-font.ts
+//#region src/file/fonts/create-embedded-font.ts
 /**
-* Creates a regular embedded font with default settings.
+* Creates an embedded font with default settings.
 *
 * This helper function creates a font definition with standard font signature
 * values that work for most common fonts. The signature specifies Unicode
 * and code page ranges supported by the font.
 *
-* @param options - Font creation options
-* @param options.name - Font name
-* @param options.index - Font relationship index
-* @param options.fontKey - Unique font key (GUID) for obfuscation
-* @param options.characterSet - Optional character set identifier
-*
 * @returns XmlComponent representing the font definition
 *
 * @example
 * ```typescript
-* const font = createRegularFont({
+* const font = createEmbeddedFont({
 *   name: "Arial",
-*   index: 1,
-*   fontKey: "12345678-1234-1234-1234-123456789012"
+*   embedRegular: { id: "rId1", fontKey: "12345678-1234-1234-1234-123456789012" },
+*   embedBold: { id: "rId2", fontKey: "12345678-1234-1234-1234-123456789013" },
 * });
 * ```
 */
-var createRegularFont = ({ name, index, fontKey, characterSet }) => createFont({
+var createEmbeddedFont = ({ name, characterSet, embedRegular, embedBold, embedItalic, embedBoldItalic }) => createFont({
 	name,
 	sig: {
 		usb0: "E0002AFF",
@@ -19656,10 +19703,10 @@ var createRegularFont = ({ name, index, fontKey, characterSet }) => createFont({
 	charset: characterSet,
 	family: "auto",
 	pitch: "variable",
-	embedRegular: {
-		fontKey,
-		id: `rId${index}`
-	}
+	embedRegular,
+	embedBold,
+	embedItalic,
+	embedBoldItalic
 });
 //#endregion
 //#region src/file/fonts/font-table.ts
@@ -19737,25 +19784,47 @@ var createFontTable = (fonts) => new BuilderElement({
 			value: "w14 w15 w16se w16cid w16 w16cex w16sdtdh"
 		}
 	},
-	children: fonts.map((font, i) => createRegularFont({
-		name: font.name,
-		index: i + 1,
-		fontKey: font.fontKey,
-		characterSet: font.characterSet
-	}))
+	children: fonts.map(createEmbeddedFont)
 });
 //#endregion
 //#region src/file/fonts/font-wrapper.ts
+var FACES = [
+	{
+		option: "data",
+		element: "embedRegular",
+		bold: false,
+		italic: false
+	},
+	{
+		option: "bold",
+		element: "embedBold",
+		bold: true,
+		italic: false
+	},
+	{
+		option: "italic",
+		element: "embedItalic",
+		bold: false,
+		italic: true
+	},
+	{
+		option: "boldItalic",
+		element: "embedBoldItalic",
+		bold: true,
+		italic: true
+	}
+];
 /**
 * Wrapper class for managing the font table and its relationships.
 *
 * Creates a font table with embedded font files and manages the relationships
-* required for font embedding. Each font is assigned a unique key for obfuscation.
+* required for font embedding. Each face of a font is embedded as a file of its own,
+* with a unique key for obfuscation.
 *
 * @example
 * ```typescript
 * const fontWrapper = new FontWrapper([
-*   { name: "CustomFont", data: fontBuffer }
+*   { name: "CustomFont", data: fontBuffer, bold: boldFontBuffer }
 * ]);
 * ```
 */
@@ -19764,12 +19833,43 @@ var FontWrapper = class {
 		_defineProperty(this, "options", void 0);
 		_defineProperty(this, "fontTable", void 0);
 		_defineProperty(this, "relationships", void 0);
-		_defineProperty(this, "fontOptionsWithKey", []);
+		_defineProperty(
+			this,
+			/** @deprecated Use `files`, which has the file and key of each face a font embeds, not only the regular face's key */
+			"fontOptionsWithKey",
+			[]
+		);
+		_defineProperty(
+			this,
+			/** The files of the faces the fonts embed, in order: the Nth is `fonts/font<N>.odttf`, with the relationship `rId<N>` */
+			"files",
+			[]
+		);
 		this.options = options;
-		this.fontOptionsWithKey = options.map((o) => _objectSpread2(_objectSpread2({}, o), {}, { fontKey: uniqueUuid() }));
-		this.fontTable = createFontTable(this.fontOptionsWithKey);
+		const faces = options.map((font) => FACES.flatMap(({ option, element, bold, italic }) => {
+			const data = font[option];
+			return data ? [{
+				element,
+				file: {
+					name: font.name,
+					data,
+					bold,
+					italic,
+					fontKey: uniqueUuid()
+				}
+			}] : [];
+		}));
+		this.files = faces.flatMap((ofFont) => ofFont.map(({ file }) => file));
+		this.fontOptionsWithKey = options.map((font, index) => _objectSpread2(_objectSpread2({}, font), {}, { fontKey: faces[index][0].file.fontKey }));
+		this.fontTable = createFontTable(options.map((font, index) => _objectSpread2({
+			name: font.name,
+			characterSet: font.characterSet
+		}, Object.fromEntries(faces[index].map(({ element, file }) => [element, {
+			id: `rId${this.files.indexOf(file) + 1}`,
+			fontKey: file.fontKey
+		}])))));
 		this.relationships = new Relationships();
-		for (let i = 0; i < options.length; i++) this.relationships.addRelationship(i + 1, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font", `fonts/font${i + 1}.odttf`);
+		for (let i = 0; i < this.files.length; i++) this.relationships.addRelationship(i + 1, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font", `fonts/font${i + 1}.odttf`);
 	}
 	get View() {
 		return this.fontTable;
@@ -20292,8 +20392,9 @@ var Paragraph = class extends FileChild {
 	prepForXml(context) {
 		for (const element of this.root) if (element instanceof ExternalHyperlink) {
 			const index = this.root.indexOf(element);
-			const concreteHyperlink = new ConcreteHyperlink(element.options.children, uniqueId());
-			context.viewWrapper.Relationships.addRelationship(concreteHyperlink.linkId, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink", element.options.link, TargetModeType.EXTERNAL);
+			const { target, anchor } = externalHyperlinkTarget(element.options.link);
+			const concreteHyperlink = new ConcreteHyperlink(element.options.children, uniqueId(), anchor, element.options.link);
+			context.viewWrapper.Relationships.addRelationship(concreteHyperlink.linkId, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink", target, TargetModeType.EXTERNAL);
 			this.root[index] = concreteHyperlink;
 		}
 		return super.prepForXml(context);
@@ -35468,7 +35569,7 @@ var Compiler = class {
 			zip.file(`word/media/${data.fileName}`, data.data);
 			zip.file(`word/media/${data.fallback.fileName}`, data.fallback.data);
 		}
-		for (const [i, { data: buffer, fontKey }] of file.FontTable.fontOptionsWithKey.entries()) zip.file(`word/fonts/font${i + 1}.odttf`, obfuscate(buffer, fontKey));
+		for (const [i, { data: buffer, fontKey }] of file.FontTable.files.entries()) zip.file(`word/fonts/font${i + 1}.odttf`, obfuscate(buffer, fontKey));
 		return zip;
 	}
 	xmlifyFile(file, prettify) {
@@ -37763,12 +37864,13 @@ var patchDocument = function() {
 					json: element,
 					patch: _objectSpread2(_objectSpread2({}, patchValue), {}, { children: patchValue.children.flatMap((child) => child instanceof Bookmark ? child.writtenAs : [child]).map((child) => {
 						if (child instanceof ExternalHyperlink) {
-							const concreteHyperlink = new ConcreteHyperlink(child.options.children, uniqueId());
+							const { target, anchor } = externalHyperlinkTarget(child.options.link);
+							const concreteHyperlink = new ConcreteHyperlink(child.options.children, uniqueId(), anchor, child.options.link);
 							hyperlinkRelationships.push({
 								key,
 								id: concreteHyperlink.linkId,
 								type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
-								target: child.options.link,
+								target,
 								targetMode: TargetModeType.EXTERNAL
 							});
 							return concreteHyperlink;

package/dist/index.d.cts

@@ -1307,7 +1307,26 @@ declare const CompoundLine: {
  */
 export declare class ConcreteHyperlink extends XmlComponent {
     readonly linkId: string;
-    constructor(children: readonly ParagraphChild[], relationshipId: string, anchor?: string);
+    private readonly drawingLink?;
+    /**
+     * @param children - Inline content of the hyperlink
+     * @param relationshipId - Id of the external relationship, without the rId prefix
+     * @param anchor - Bookmark name or external URL fragment
+     * @param externalLink - The full address of an external hyperlink, so the relationship id is kept alongside its anchor
+     */
+    constructor(children: readonly ParagraphChild[], relationshipId: string, anchor?: string, externalLink?: string);
+    /**
+     * Creates the `a:hlinkClick` of a picture in the hyperlink, which links to the same address.
+     *
+     * The hyperlink decides which relationship its pictures use, rather than the pictures reading `linkId`, because only it
+     * knows whether that relationship has lost the fragment to `w:anchor`. The picture's relationship is added as the
+     * picture is written, through the context's relationships, so it lands in the part the picture is in, both when
+     * packing and when patching.
+     *
+     * @param context - The context the picture is written in, whose relationships get the picture's link if it has its own
+     * @param declareNamespace - Declares the DrawingML namespace, for elements outside `a:graphic` such as `wp:docPr`
+     */
+    createDrawingClick(context: IContext, declareNamespace: boolean): XmlComponent;
 }
 
 /**
@@ -3465,6 +3484,23 @@ export declare type EffectExtentAttributes = {
  */
 export declare const eighthPointMeasureValue: (val: number) => number;
 
+/**
+ * A font file the document embeds: one face of one of its fonts, with the unique key it is obfuscated with.
+ *
+ * @property name - Font family name
+ * @property data - Font file data of the face
+ * @property bold - Whether the face is bold
+ * @property italic - Whether the face is italic
+ * @property fontKey - Unique key (GUID) the file is obfuscated with
+ */
+declare type EmbeddedFontFile = {
+    readonly name: string;
+    readonly data: Buffer;
+    readonly bold: boolean;
+    readonly italic: boolean;
+    readonly fontKey: string;
+};
+
 /**
  * A file of a package that is embedded in the document, such as a sheet of an embedded workbook.
  */
@@ -3657,6 +3693,11 @@ export declare type EstimatedPageNumbers = {
  * External hyperlinks create a relationship to an external resource (URL).
  * The relationship is created during document preparation and the hyperlink
  * is converted to a ConcreteHyperlink with the relationship ID.
+ * URL fragments of at most 255 UTF-16 units are written as anchors, preserving any additional # characters.
+ * Longer fragments stay in the original relationship URI to avoid exceeding Word's anchor limit;
+ * those links retain the existing limitations for fragments with multiple # characters.
+ * Word appends the anchor to the relationship target as described in MS-OI29500 §17.16.22:
+ * https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oi29500/df06e423-11a6-4a36-bfb3-82139e531781
  *
  * Reference: http://officeopenxml.com/WPhyperlink.php
  *
@@ -3670,6 +3711,7 @@ export declare type EstimatedPageNumbers = {
  *   <xsd:group ref="EG_PContent" minOccurs="0" maxOccurs="unbounded"/>
  *   <xsd:attribute ref="r:id"/>
  *   <xsd:attribute name="history" type="s:ST_OnOff" use="optional"/>
+ *   <xsd:attribute name="anchor" type="s:ST_String" use="optional"/>
  * </xsd:complexType>
  * ```
  *
@@ -3908,14 +3950,20 @@ export declare const fillSequenceNumbers: (body: IXmlableObject, context: IConte
 declare type FontOptions = {
     /** Font family name */
     readonly name: string;
-    /** Font file data (TTF, OTF, etc.) */
+    /** Font file data (TTF, OTF, etc.) of the regular face */
     readonly data: Buffer;
+    /** Font file data of the bold face, embedded as `w:embedBold` */
+    readonly bold?: Buffer;
+    /** Font file data of the italic face, embedded as `w:embedItalic` */
+    readonly italic?: Buffer;
+    /** Font file data of the bold italic face, embedded as `w:embedBoldItalic` */
+    readonly boldItalic?: Buffer;
     /** Character set/encoding for the font */
     readonly characterSet?: (typeof CharacterSet)[keyof typeof CharacterSet];
 };
 
 /**
- * Font options extended with a unique font key.
+ * Font options extended with the unique key of the regular face's file.
  */
 declare type FontOptionsWithKey = FontOptions & {
     readonly fontKey: string;
@@ -3925,12 +3973,13 @@ declare type FontOptionsWithKey = FontOptions & {
  * Wrapper class for managing the font table and its relationships.
  *
  * Creates a font table with embedded font files and manages the relationships
- * required for font embedding. Each font is assigned a unique key for obfuscation.
+ * required for font embedding. Each face of a font is embedded as a file of its own,
+ * with a unique key for obfuscation.
  *
  * @example
  * ```typescript
  * const fontWrapper = new FontWrapper([
- *   { name: "CustomFont", data: fontBuffer }
+ *   { name: "CustomFont", data: fontBuffer, bold: boldFontBuffer }
  * ]);
  * ```
  */
@@ -3938,7 +3987,10 @@ declare class FontWrapper implements IViewWrapper {
     readonly options: readonly FontOptions[];
     private readonly fontTable;
     private readonly relationships;
+    /** @deprecated Use `files`, which has the file and key of each face a font embeds, not only the regular face's key */
     readonly fontOptionsWithKey: readonly FontOptionsWithKey[];
+    /** The files of the faces the fonts embed, in order: the Nth is `fonts/font<N>.odttf`, with the relationship `rId<N>` */
+    readonly files: readonly EmbeddedFontFile[];
     constructor(options: readonly FontOptions[]);
     get View(): XmlComponent;
     get Relationships(): Relationships;
@@ -7756,7 +7808,12 @@ export declare type ITableRowPropertiesOptions = ITableRowPropertiesOptionsBase
 export declare type ITableRowPropertiesOptionsBase = {
     /** Whether the row can be split across pages (cantSplit) */
     readonly cantSplit?: boolean;
-    /** Whether the row should be repeated as a header row on each page (tblHeader) */
+    /**
+     * Whether the row should be repeated as a header row on each page (tblHeader).
+     *
+     * Only the table's first row and the rows straight after it that also set this repeat. Word ignores it on
+     * any row further down, so to repeat a different header for each part of a table, make each part a table of its own.
+     */
     readonly tableHeader?: boolean;
     /** Row height configuration (trHeight) */
     readonly height?: {