@withbuddi/buddi 0.1.0-pre.52 → 0.1.0-pre.54

package/node_modules/docx/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?: {

package/node_modules/docx/dist/index.d.ts

@@ -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?: {