@kittl/pdfkit 0.17.4 → 0.17.51

package/package.json

@@ -9,7 +9,7 @@
     "document",
     "vector"
   ],
-  "version": "0.17.4",
+  "version": "0.17.51",
   "homepage": "http://pdfkit.org/",
   "author": {
     "name": "Devon Govett",
@@ -58,7 +58,7 @@
   "scripts": {
     "prepublishOnly": "npm run build",
     "build": "rollup -c && npm run build-standalone",
-    "build-standalone": "browserify --standalone PDFDocument --ignore crypto js/pdfkit.js > js/pdfkit.standalone.js",
+    "build-standalone": "browserify js/pdfkit.js --standalone PDFDocument --ignore crypto --no-builtins -t brfs > js/pdfkit.standalone.js",
     "browserify-example": "browserify examples/browserify/browser.js > examples/browserify/bundle.js",
     "pdf-guide": "node docs/generate.js",
     "website": "node docs/generate_website.js",
@@ -70,9 +70,20 @@
     "test:visual": "jest visual/",
     "test:unit": "jest unit/"
   },
-  "main": "js/pdfkit.js",
-  "module": "js/pdfkit.es.js",
-  "types": "types/index.d.ts",
+  "types": "./types/pdfkit.d.ts",
+  "exports": {
+    ".": {
+      "require": "./js/pdfkit.js",
+      "import": "./js/pdfkit.es.js",
+      "types": "./types/pdfkit.d.ts"
+    },
+    "./writeSVG": {
+      "require": "./js/write_svg.js",
+      "import": "./js/write_svg.es.js",
+      "types": "./types/write_svg.d.ts"
+    },
+    "./js/virtual-fs.js": "./js/virtual-fs.js"
+  },
   "browserify": {
     "transform": [
       "brfs"

package/types/{index.d.ts → pdfkit.d.ts}

@@ -40,7 +40,7 @@ shader(fn: () => any): any;
       data: Uint8Array | Buffer;
       channels: number;
       alternate: string | string[];
-    };
+    }
 }
 
 declare namespace PDFKit.Mixins {
@@ -388,8 +388,8 @@ declare namespace PDFKit.Mixins {
     }
 
     interface PDFColor {
-        beingColorProfile(label: string): this;
-        endColorProfile(): this;
+        beginColorSpace(label: string): this;
+        endColorSpace(): this;
         fillColor(color: ColorValue, opacity?: number): this;
         strokeColor(color: ColorValue, opacity?: number): this;
         opacity(opacity: number): this;
@@ -877,26 +877,7 @@ declare namespace PDFKit {
         fontLayoutCache?: boolean;
     }
 
-    interface PDFDocument
-        extends
-            NodeJS.ReadableStream,
-            Mixins.PDFMetadata,
-            Mixins.PDFAnnotation,
-            Mixins.PDFColor,
-            Mixins.PDFImage,
-            Mixins.PDFTable,
-            Mixins.PDFText,
-            Mixins.PDFVector,
-            Mixins.PDFFont,
-            Mixins.PDFAcroForm,
-            Mixins.PDFMarking,
-            Mixins.PDFAttachment,
-            Mixins.PDFMetadata,
-            Mixins.PDFSubset,
-            Mixins.PDFOutline,
-            Mixins.PDFColorSpace,
-            Mixins.PDFOutputIntent
-    {
+    class PDFDocument {
         /**
          * PDF Version
          */
@@ -917,11 +898,12 @@ declare namespace PDFKit {
          * Represent the current page.
          */
         page: PDFPage;
+        outline: PDFKit.PDFOutline;
 
         x: number;
         y: number;
 
-        new(options?: PDFDocumentOptions): PDFDocument;
+        constructor(options?: PDFDocumentOptions);
 
         addPage(options?: PDFDocumentOptions): PDFDocument;
         continueOnNewPage(options?: PDFDocumentOptions): PDFDocument;
@@ -951,21 +933,39 @@ declare namespace PDFKit {
         addNamedEmbeddedFile(name: string, ref: PDFKitReference): void;
         addNamedJavaScript(name: string, js: string): void;
 
-        ref(data: {}): PDFKitReference;
-        addContent(data: any): PDFDocument;
+        ref(data: Record<string, unknown>): PDFKitReference;
+        addContent(data: unknown): PDFDocument;
         end(): void;
         toString(): string;
     }
-}
 
-declare module "pdfkit" {
-    var doc: PDFKit.PDFDocument;
-    export = doc;
+    interface PDFDocument
+        extends
+            NodeJS.ReadableStream,
+            Mixins.PDFMetadata,
+            Mixins.PDFAnnotation,
+            Mixins.PDFColor,
+            Mixins.PDFImage,
+            Mixins.PDFTable,
+            Mixins.PDFText,
+            Mixins.PDFVector,
+            Mixins.PDFFont,
+            Mixins.PDFAcroForm,
+            Mixins.PDFMarking,
+            Mixins.PDFAttachment,
+            Mixins.PDFSubset,
+            Mixins.PDFOutline,
+            Mixins.PDFColorSpace,
+            Mixins.PDFOutputIntent {}
 }
 
+declare const PDFDocument: typeof PDFKit.PDFDocument;
+
+export default PDFDocument;
+
 declare module "pdfkit/js/pdfkit.standalone" {
-    var doc: PDFKit.PDFDocument;
-    export = doc;
+    const PDFDocument: typeof PDFKit.PDFDocument;
+    export default PDFDocument;
 }
 
 declare module "pdfkit/js/gradient" {

package/types/write_svg.d.ts

@@ -0,0 +1,76 @@
+import PDFKit from './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}
+ */
+export default function SVGtoPDF(
+  doc: PDFKit.PDFDocument,
+  svg: SVGElement | string,
+  x?: number,
+  y?: number,
+  options?: SVGtoPDF.Options,
+): void;
+
+export declare namespace SVGtoPDF {
+  type RGBColor = [[number, number, number], number];
+  type CMYKColor = [[number, 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) => { src: string | Uint8Array, properties?: BitmapProperties };
+
+    /** 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: RGBColor | CMYKColor,
+      raw: string,
+    ) => RGBColor | CMYKColor;
+
+    /** function called when there is a warning */
+    warningCallback?: (warning: string, error?: unknown) => void;
+
+    /** assume that units are PDF points instead of SVG pixels */
+    assumePt?: boolean;
+
+    /** precision factor for approximate calculations (default = 3) */
+    precision?: number;
+  }
+
+  interface BitmapProperties {
+    width: number;
+    height: number;
+    channels: number;
+    colorSpace: string;
+    isBitmap: true;
+  }
+}