🤖 Merge PR DefinitelyTyped#74537 svg-to-pdfkit: Update types by @EliasWatson

Author: EliasWatson

types/svg-to-pdfkit/index.d.ts

@@ -1,30 +1,63 @@
 import PDFDocument = require("pdfkit");
 
+/**
+ * Insert SVG into a PDF document created with PDFKit.
+ *
+ * @param doc the PDF document created with PDFKit
+ * @param svg the SVG object or XML code
+ * @param x the x position where the SVG will be added
+ * @param y the y position where the SVG will be added
+ * @param options See {@link SVGtoPDF.Options}
+ */
 declare function SVGtoPDF(
     doc: typeof PDFDocument,
     svg: SVGElement | string,
     x?: number,
     y?: number,
-    options?: SVGtoPDF.SVGtoPDFOptions,
+    options?: SVGtoPDF.Options,
 ): void;
 
 declare namespace SVGtoPDF {
-    interface SVGtoPDFOptions {
+    type Color = [[number, number, number], number];
+    interface Options {
+        /** initial viewport width, by default it's the page width */
         width?: number;
+
+        /** initial viewport width, by default it's the page height */
         height?: number;
+
+        /** override alignment of the SVG content inside its viewport */
         preserveAspectRatio?: string;
+
+        /** use the CSS styles computed by the browser (for SVGElement only) */
         useCSS?: boolean;
+
+        /** function called to get the fonts, see source code */
         fontCallback?: (
             family: string,
             bold: boolean,
             italic: boolean,
             fontOptions: { fauxItalic: boolean; fauxBold: boolean },
         ) => string;
+
+        /** same as above for the images (for Node.js) */
         imageCallback?: (link: string) => string;
-        documentCallback?: (file: string) => string;
-        colorCallback?: (result: string, raw: string) => [[number, number, number], number];
-        warningCallback?: (str: string) => void;
+
+        /** same as above for the external SVG documents */
+        documentCallback?: (
+            file: string,
+        ) => SVGElement | string | (SVGElement | string)[];
+
+        /** function called to get color, making mapping to CMYK possible */
+        colorCallback?: (color: Color) => Color;
+
+        /** function called when there is a warning */
+        warningCallback?: (warning: string) => void;
+
+        /** assume that units are PDF points instead of SVG pixels */
         assumePt?: boolean;
+
+        /** precision factor for approximate calculations (default = 3) */
         precision?: number;
     }
 }

types/svg-to-pdfkit/svg-to-pdfkit-tests.ts

@@ -9,13 +9,13 @@ SvgToPdf(doc, "<svg>", 100, 100); // $ExpectType void
 
 SvgToPdf(doc, "<svg>", 100, 100, {}); // $ExpectType void
 
-// https://github.com/alafr/SVG-to-PDFKit/blob/4d2d8746bda1e9335c47bbe9ad91277c51fd5a07/source.js#L2477
-const options: SvgToPdf.SVGtoPDFOptions = {
+// https://github.com/alafr/SVG-to-PDFKit/blob/b091ebd4e7b7d2310eb1003511cd5de480f7e0e1/source.js#L2617
+const options: SvgToPdf.Options = {
     width: 100,
     height: 100,
     preserveAspectRatio: "xMinYMin",
     useCSS: true,
-    // https://github.com/alafr/SVG-to-PDFKit/blob/4d2d8746bda1e9335c47bbe9ad91277c51fd5a07/source.js#L2500
+    // https://github.com/alafr/SVG-to-PDFKit/blob/b091ebd4e7b7d2310eb1003511cd5de480f7e0e1/source.js#L2640
     fontCallback: (family, bold, italic, fontOptions) => {
         family; // $ExpectType string
         bold; // $ExpectType boolean
@@ -24,18 +24,17 @@ const options: SvgToPdf.SVGtoPDFOptions = {
         fontOptions.fauxItalic; // $ExpectType boolean
         return family;
     },
-    // https://github.com/alafr/SVG-to-PDFKit/blob/4d2d8746bda1e9335c47bbe9ad91277c51fd5a07/source.js#L2558
+    // https://github.com/alafr/SVG-to-PDFKit/blob/b091ebd4e7b7d2310eb1003511cd5de480f7e0e1/source.js#L2698
     imageCallback: link => {
         link; // $ExpectType string
         return link;
     },
-    // https://github.com/alafr/SVG-to-PDFKit/blob/4d2d8746bda1e9335c47bbe9ad91277c51fd5a07/source.js#L2562
-    colorCallback: (result, row) => {
-        result; // $ExpectType string
-        row; // $ExpectType string
+    // https://github.com/alafr/SVG-to-PDFKit/blob/b091ebd4e7b7d2310eb1003511cd5de480f7e0e1/source.js#L2703
+    colorCallback: (color) => {
+        color; // $ExpectType Color
         return [[255, 255, 255], 1];
     },
-    // https://github.com/alafr/SVG-to-PDFKit/blob/4d2d8746bda1e9335c47bbe9ad91277c51fd5a07/source.js#L2494
+    // https://github.com/alafr/SVG-to-PDFKit/blob/b091ebd4e7b7d2310eb1003511cd5de480f7e0e1/source.js#L2635
     warningCallback: str => {
         str; // $ExpectType string
         console.log(str);