🤖 Merge PR DefinitelyTyped#74433 [pdfmake] Add properties for 0.3.3 by @kryops

Author: kryops

types/pdfmake/interfaces.d.ts

@@ -726,11 +726,21 @@ export interface Style {
      */
     decorationColor?: string | undefined;
 
+    /**
+     * Line thickness of the {@link decoration} in `pt`.
+     *
+     * If used in combination with a {@link decorationStyle}, this value is only used as a baseline
+     * for the computation of the actual line width.
+     *
+     * Defaults to a value derived from the {@link fontSize}.
+     */
+    decorationThickness?: number | undefined;
+
     /**
      * Margins to apply.
      *
      * Overrides the single-side `marginXXX` properties, unless this value is inherited
-     * from a style and they are set directly on the content object.
+     * from another style.
      *
      * Ignored for content within an inline text array
      * (`{ text: [{ ... }] }`).
@@ -741,31 +751,31 @@ export interface Style {
      * Margin in `pt` to apply above the content.
      *
      * If {@link margin} is set, this value is ignored, unless the margin was inherited
-     * from a style and the value is set directly on the content object.
+     * from another style.
      */
     marginTop?: number | undefined;
 
     /**
      * Margin in `pt` to apply to the right of the content.
      *
      * If {@link margin} is set, this value is ignored, unless the margin was inherited
-     * from a style and the value is set directly on the content object.
+     * from another style.
      */
     marginRight?: number | undefined;
 
     /**
      * Margin in `pt` to apply below the content.
      *
      * If {@link margin} is set, this value is ignored, unless the margin was inherited
-     * from a style and the value is set directly on the content object.
+     * from another style.
      */
     marginBottom?: number | undefined;
 
     /**
      * Margin in `pt` to apply to the left of the content.
      *
      * If {@link margin} is set, this value is ignored, unless the margin was inherited
-     * from a style and the value is set directly on the content object.
+     * from another style.
      */
     marginLeft?: number | undefined;
 
@@ -872,6 +882,21 @@ export interface Style {
     columnGap?: number | undefined;
 }
 
+/**
+ * Named style defined in {@link TDocumentDefinitions.styles}.
+ */
+export interface NamedStyle extends Style {
+    /**
+     * Names of other styles in {@link TDocumentDefinitions.styles} to extend.
+     *
+     * An array applies the styles in the given order, later styles overriding
+     * properties from the earlier ones.
+     *
+     * Extended styles are overridden by the properties on this style.
+     */
+    extends?: string | string[] | undefined;
+}
+
 /**
  * Applies one or more styles.
  *
@@ -1623,6 +1648,27 @@ export interface TableOfContent {
      *   {@link ContentTocItem.tocItem} to its ID
      */
     id?: string | undefined;
+
+    /**
+     * If set to `true`, the table of contents is hidden when it contains no items.
+     */
+    hideEmpty?: boolean | undefined;
+
+    /**
+     * Controls how the items are sorted.
+     *
+     * Defaults to `page`.
+     */
+    sortBy?: "page" | "title" | undefined;
+
+    /**
+     * Specifies the locale used for sorting as BCP 47 language tag, e.g. `en-US`.
+     *
+     * Only relevant if {@link sortBy} is set to `title`.
+     *
+     * Defaults to the system locale.
+     */
+    sortLocale?: string | undefined;
 }
 
 /**
@@ -1990,7 +2036,7 @@ export interface ImageCover {
  * Dictionary of reusable style definitions that can be referenced by their key.
  */
 export interface StyleDictionary {
-    [name: string]: Style;
+    [name: string]: NamedStyle;
 }
 
 /**
@@ -2264,7 +2310,7 @@ export interface TDocumentDefinitions {
     /**
      * Dictionary for reusable styles to be referenced by their key throughout the document.
      *
-     * To define styles that should apply by default, use {@link defaultStyles} instead.
+     * To define styles that should apply by default, use {@link defaultStyle} instead.
      */
     styles?: StyleDictionary | undefined;
 

types/pdfmake/test/pdfmake-examples-tests.ts

@@ -912,6 +912,50 @@ const margins: TDocumentDefinitions = {
     },
 };
 
+const namedStylesWithExtends: TDocumentDefinitions = {
+    content: [
+        {
+            text: "This is a header, using header style",
+            style: "header",
+        },
+        "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Confectum ponit legam, perferendis nomine miserum, animi. Moveat nesciunt triari naturam.\n\n",
+        {
+            text: "Subheader 1 - using subheader style",
+            style: "subheader",
+        },
+        "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Confectum ponit legam, perferendis nomine miserum, animi. Moveat nesciunt triari naturam posset, eveniunt specie deorsus efficiat sermone instituendarum fuisse veniat, eademque mutat debeo. Delectet plerique protervi diogenem dixerit logikh levius probabo adipiscuntur afficitur, factis magistra inprobitatem aliquo andriam obiecta, religionis, imitarentur studiis quam, clamat intereant vulgo admonitionem operis iudex stabilitas vacillare scriptum nixam, reperiri inveniri maestitiam istius eaque dissentias idcirco gravis, refert suscipiet recte sapiens oportet ipsam terentianus, perpauca sedatio aliena video.",
+        "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Confectum ponit legam, perferendis nomine miserum, animi. Moveat nesciunt triari naturam posset, eveniunt specie deorsus efficiat sermone instituendarum fuisse veniat, eademque mutat debeo. Delectet plerique protervi diogenem dixerit logikh levius probabo adipiscuntur afficitur, factis magistra inprobitatem aliquo andriam obiecta, religionis, imitarentur studiis quam, clamat intereant vulgo admonitionem operis iudex stabilitas vacillare scriptum nixam, reperiri inveniri maestitiam istius eaque dissentias idcirco gravis, refert suscipiet recte sapiens oportet ipsam terentianus, perpauca sedatio aliena video.",
+        "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Confectum ponit legam, perferendis nomine miserum, animi. Moveat nesciunt triari naturam posset, eveniunt specie deorsus efficiat sermone instituendarum fuisse veniat, eademque mutat debeo. Delectet plerique protervi diogenem dixerit logikh levius probabo adipiscuntur afficitur, factis magistra inprobitatem aliquo andriam obiecta, religionis, imitarentur studiis quam, clamat intereant vulgo admonitionem operis iudex stabilitas vacillare scriptum nixam, reperiri inveniri maestitiam istius eaque dissentias idcirco gravis, refert suscipiet recte sapiens oportet ipsam terentianus, perpauca sedatio aliena video.\n\n",
+        {
+            text: "Subheader 2 - using subheader style",
+            style: "subheader",
+        },
+        "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Confectum ponit legam, perferendis nomine miserum, animi. Moveat nesciunt triari naturam posset, eveniunt specie deorsus efficiat sermone instituendarum fuisse veniat, eademque mutat debeo. Delectet plerique protervi diogenem dixerit logikh levius probabo adipiscuntur afficitur, factis magistra inprobitatem aliquo andriam obiecta, religionis, imitarentur studiis quam, clamat intereant vulgo admonitionem operis iudex stabilitas vacillare scriptum nixam, reperiri inveniri maestitiam istius eaque dissentias idcirco gravis, refert suscipiet recte sapiens oportet ipsam terentianus, perpauca sedatio aliena video.",
+        "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Confectum ponit legam, perferendis nomine miserum, animi. Moveat nesciunt triari naturam posset, eveniunt specie deorsus efficiat sermone instituendarum fuisse veniat, eademque mutat debeo. Delectet plerique protervi diogenem dixerit logikh levius probabo adipiscuntur afficitur, factis magistra inprobitatem aliquo andriam obiecta, religionis, imitarentur studiis quam, clamat intereant vulgo admonitionem operis iudex stabilitas vacillare scriptum nixam, reperiri inveniri maestitiam istius eaque dissentias idcirco gravis, refert suscipiet recte sapiens oportet ipsam terentianus, perpauca sedatio aliena video.\n\n",
+        {
+            text:
+                "It is possible to apply multiple styles, by passing an array. This paragraph uses two styles: quote and small. When multiple styles are provided, they are evaluated in the specified order which is important in case they define the same properties",
+            style: ["quote", "small"],
+        },
+    ],
+    styles: {
+        header: {
+            fontSize: 18,
+            bold: true,
+        },
+        subheader: {
+            fontSize: 15,
+            extends: "header",
+        },
+        quote: {
+            italics: true,
+        },
+        small: {
+            fontSize: 8,
+        },
+    },
+};
+
 const pageReference: TDocumentDefinitions = {
     content: [
         {
@@ -2467,6 +2511,15 @@ const textDecorations: TDocumentDefinitions = {
                 },
             ],
         },
+        " ",
+        {
+            columns: [
+                { text: "Dashed style", decoration: "underline", decorationStyle: "dashed", decorationThickness: 3 },
+                { text: "Dotted style", decoration: "underline", decorationStyle: "dotted", decorationThickness: 3 },
+                { text: "Double style", decoration: "underline", decorationStyle: "double", decorationThickness: 3 },
+                { text: "Wavy style", decoration: "underline", decorationStyle: "wavy", decorationThickness: 3 },
+            ],
+        },
     ],
 };
 
@@ -2483,6 +2536,8 @@ const toc: TDocumentDefinitions = {
                 textMargin: [0, 0, 0, 0],
                 textStyle: { italics: true },
                 numberStyle: { bold: true },
+                sortBy: "page",
+                sortLocale: "cs",
             },
         },
         {

types/pdfmake/test/pdfmake-interfaces-tests.ts

@@ -5,8 +5,10 @@ import {
     ContentImage,
     ContentOrderedList,
     ContentSvg,
+    ContentToc,
     ContentUnorderedList,
     CustomTableLayout,
+    StyleDictionary,
     Table,
     TableCell,
     TDocumentDefinitions,
@@ -403,3 +405,27 @@ const svgWithLink: Content = [
         link: "http://foo.bar",
     },
 ];
+
+const hideEmptyToC: ContentToc = {
+    toc: {
+        hideEmpty: true,
+    },
+};
+
+const styleExtends: StyleDictionary = {
+    header: {
+        fontSize: 18,
+        bold: true,
+    },
+    subheader: {
+        fontSize: 15,
+        extends: "header",
+    },
+    smallheader: {
+        italics: true,
+        extends: ["subheader", "small"],
+    },
+    small: {
+        fontSize: 8,
+    },
+};