pdfkit 0.15.2 → 0.16.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## pdfkit changelog
 
+### [v0.16.0] - 2024-12-29
+
+- Update fontkit to 2.0
+- Update linebreak to 1.1
+- Add support for spot colors
+- Add support to scale text horizontally
+- Add an option to keep the indentation after a new line starts and allow to indent a whole paragraph/text element
+- Add `Name` property for set custom icon for `note()`
+- Fix sets tab order to "Structure" when a document is tagged
+- Fix font cache collision for fonts with missing postscript name or bad TTF metadata or identical metadata for different fonts
+- Fix for embedding fonts into PDF (font name must not contain spaces)
+- Fix measuring text when OpenType features are passed in to .text()
+
 ### [v0.15.2] - 2024-12-15
 
 - Fix index not counting when rendering ordered lists (#1517)

package/README.md

@@ -128,8 +128,8 @@ complex documents with a very small amount of code. For more, see the `demo` fol
 
 There are three ways to use PDFKit in the browser:
 
-- Use [Browserify](http://browserify.org/). See demo [source code](demo/browser.js) and [build script](https://github.com/foliojs/pdfkit/blob/master/package.json#L56)
-- Use [webpack](https://webpack.js.org/). See [complete example](examples/webpack).
+- Use [Browserify](http://browserify.org/). See demo [source code](https://github.com/foliojs/pdfkit/blob/master/examples/browserify/browser.js) and [build script](https://github.com/foliojs/pdfkit/blob/master/package.json#L62)
+- Use [webpack](https://webpack.js.org/). See [complete example](https://github.com/foliojs/pdfkit/blob/master/examples/webpack).
 - Use prebuilt version. Distributed as `pdfkit.standalone.js` file in the [releases](https://github.com/foliojs/pdfkit/releases) or in the package `js` folder.
 
 In addition to PDFKit, you'll need somewhere to stream the output to. HTML5 has a

package/js/pdfkit.es.js

@@ -2,7 +2,7 @@ import stream from 'stream';
 import zlib from 'zlib';
 import CryptoJS from 'crypto-js';
 import fs from 'fs';
-import fontkit from 'fontkit';
+import * as fontkit from 'fontkit';
 import { EventEmitter } from 'events';
 import LineBreaker from 'linebreak';
 import exif from 'jpeg-exif';
@@ -51,19 +51,39 @@ class PDFTree {
     out.push('>>');
     return out.join('\n');
   }
-  _compareKeys( /*a, b*/
+  _compareKeys(/*a, b*/
   ) {
     throw new Error('Must be implemented by subclasses');
   }
   _keysName() {
     throw new Error('Must be implemented by subclasses');
   }
-  _dataForKey( /*k*/
+  _dataForKey(/*k*/
   ) {
     throw new Error('Must be implemented by subclasses');
   }
 }
 
+class SpotColor {
+  constructor(doc, name, C, M, Y, K) {
+    this.id = 'CS' + Object.keys(doc.spotColors).length;
+    this.name = name;
+    this.values = [C, M, Y, K];
+    this.ref = doc.ref(['Separation', this.name, 'DeviceCMYK', {
+      Range: [0, 1, 0, 1, 0, 1, 0, 1],
+      C0: [0, 0, 0, 0],
+      C1: this.values.map(value => value / 100),
+      FunctionType: 2,
+      Domain: [0, 1],
+      N: 1
+    }]);
+    this.ref.end();
+  }
+  toString() {
+    return `${this.ref.id} 0 R`;
+  }
+}
+
 /*
 PDFObject - converts JavaScript types into their corresponding PDF types.
 By Devon Govett
@@ -136,7 +156,7 @@ class PDFObject {
       // Buffers are converted to PDF hex strings
     } else if (Buffer.isBuffer(object)) {
       return `<${object.toString('hex')}>`;
-    } else if (object instanceof PDFAbstractReference || object instanceof PDFTree) {
+    } else if (object instanceof PDFAbstractReference || object instanceof PDFTree || object instanceof SpotColor) {
       return object.toString();
     } else if (object instanceof Date) {
       let string = `D:${pad(object.getUTCFullYear(), 4)}` + pad(object.getUTCMonth() + 1, 2) + pad(object.getUTCDate(), 2) + pad(object.getUTCHours(), 2) + pad(object.getUTCMinutes(), 2) + pad(object.getUTCSeconds(), 2) + 'Z';
@@ -191,7 +211,7 @@ class PDFReference extends PDFAbstractReference {
     this.buffer = [];
   }
   write(chunk) {
-    if (!Buffer.isBuffer(chunk)) {
+    if (!(chunk instanceof Uint8Array)) {
       chunk = Buffer.from(chunk + '\n', 'binary');
     }
     this.uncompressedLength += chunk.length;
@@ -380,8 +400,20 @@ class PDFPage {
   write(chunk) {
     return this.content.write(chunk);
   }
+
+  // Set tab order if document is tagged for accessibility.
+  _setTabOrder() {
+    if (!this.dictionary.Tabs && this.document.hasMarkInfoDictionary()) {
+      this.dictionary.data.Tabs = 'S';
+    }
+  }
   end() {
+    this._setTabOrder();
     this.dictionary.end();
+    this.resources.data.ColorSpace = this.resources.data.ColorSpace || {};
+    for (let color of Object.values(this.document.spotColors)) {
+      this.resources.data.ColorSpace[color.id] = color;
+    }
     this.resources.end();
     return this.content.end();
   }
@@ -1002,9 +1034,9 @@ function wordArrayToBuffer(wordArray) {
 const PASSWORD_PADDING = [0x28, 0xbf, 0x4e, 0x5e, 0x4e, 0x75, 0x8a, 0x41, 0x64, 0x00, 0x4e, 0x56, 0xff, 0xfa, 0x01, 0x08, 0x2e, 0x2e, 0x00, 0xb6, 0xd0, 0x68, 0x3e, 0x80, 0x2f, 0x0c, 0xa9, 0xfe, 0x64, 0x53, 0x69, 0x7a];
 
 const {
-  number
+  number: number$2
 } = PDFObject;
-class PDFGradient {
+class PDFGradient$1 {
   constructor(doc) {
     this.doc = doc;
     this.stops = [];
@@ -1091,7 +1123,7 @@ class PDFGradient {
       Type: 'Pattern',
       PatternType: 2,
       Shading: shader,
-      Matrix: this.matrix.map(number)
+      Matrix: this.matrix.map(number$2)
     });
     pattern.end();
     if (this.stops.some(stop => stop[2] < 1)) {
@@ -1169,7 +1201,7 @@ class PDFGradient {
     return this.doc.addContent(`/${this.id} ${op}`);
   }
 }
-class PDFLinearGradient extends PDFGradient {
+class PDFLinearGradient$1 extends PDFGradient$1 {
   constructor(doc, x1, y1, x2, y2) {
     super(doc);
     this.x1 = x1;
@@ -1187,10 +1219,10 @@ class PDFLinearGradient extends PDFGradient {
     });
   }
   opacityGradient() {
-    return new PDFLinearGradient(this.doc, this.x1, this.y1, this.x2, this.y2);
+    return new PDFLinearGradient$1(this.doc, this.x1, this.y1, this.x2, this.y2);
   }
 }
-class PDFRadialGradient extends PDFGradient {
+class PDFRadialGradient$1 extends PDFGradient$1 {
   constructor(doc, x1, y1, r1, x2, y2, r2) {
     super(doc);
     this.doc = doc;
@@ -1211,13 +1243,13 @@ class PDFRadialGradient extends PDFGradient {
     });
   }
   opacityGradient() {
-    return new PDFRadialGradient(this.doc, this.x1, this.y1, this.r1, this.x2, this.y2, this.r2);
+    return new PDFRadialGradient$1(this.doc, this.x1, this.y1, this.r1, this.x2, this.y2, this.r2);
   }
 }
 var Gradient = {
-  PDFGradient,
-  PDFLinearGradient,
-  PDFRadialGradient
+  PDFGradient: PDFGradient$1,
+  PDFLinearGradient: PDFLinearGradient$1,
+  PDFRadialGradient: PDFRadialGradient$1
 };
 
 /*
@@ -1225,7 +1257,7 @@ PDF tiling pattern support. Uncolored only.
  */
 
 const underlyingColorSpaces = ['DeviceCMYK', 'DeviceRGB'];
-class PDFTilingPattern {
+class PDFTilingPattern$1 {
   constructor(doc, bBox, xStep, yStep, stream) {
     this.doc = doc;
     this.bBox = bBox;
@@ -1303,19 +1335,20 @@ class PDFTilingPattern {
   }
 }
 var pattern = {
-  PDFTilingPattern
+  PDFTilingPattern: PDFTilingPattern$1
 };
 
 const {
-  PDFGradient: PDFGradient$1,
-  PDFLinearGradient: PDFLinearGradient$1,
-  PDFRadialGradient: PDFRadialGradient$1
+  PDFGradient,
+  PDFLinearGradient,
+  PDFRadialGradient
 } = Gradient;
 const {
-  PDFTilingPattern: PDFTilingPattern$1
+  PDFTilingPattern
 } = pattern;
 var ColorMixin = {
   initColor() {
+    this.spotColors = {};
     // The opacity dictionaries
     this._opacityRegistry = {};
     this._opacityCount = 0;
@@ -1332,6 +1365,8 @@ var ColorMixin = {
         color = [hex >> 16, hex >> 8 & 0xff, hex & 0xff];
       } else if (namedColors[color]) {
         color = namedColors[color];
+      } else if (this.spotColors[color]) {
+        return this.spotColors[color];
       }
     }
     if (Array.isArray(color)) {
@@ -1347,11 +1382,11 @@ var ColorMixin = {
     return null;
   },
   _setColor(color, stroke) {
-    if (color instanceof PDFGradient$1) {
+    if (color instanceof PDFGradient) {
       color.apply(stroke);
       return true;
       // see if tiling pattern, decode & apply it it
-    } else if (Array.isArray(color) && color[0] instanceof PDFTilingPattern$1) {
+    } else if (Array.isArray(color) && color[0] instanceof PDFTilingPattern) {
       color[0].apply(stroke, color[1]);
       return true;
     }
@@ -1366,8 +1401,12 @@ var ColorMixin = {
     const op = stroke ? 'SCN' : 'scn';
     const space = this._getColorSpace(color);
     this._setColorSpace(space, stroke);
-    color = color.join(' ');
-    this.addContent(`${color} ${op}`);
+    if (color instanceof SpotColor) {
+      this.page.colorSpaces[color.id] = color.ref;
+      this.addContent(`1 ${op}`);
+    } else {
+      this.addContent(`${color.join(' ')} ${op}`);
+    }
     return true;
   },
   _setColorSpace(space, stroke) {
@@ -1375,6 +1414,9 @@ var ColorMixin = {
     return this.addContent(`/${space} ${op}`);
   },
   _getColorSpace(color) {
+    if (color instanceof SpotColor) {
+      return color.id;
+    }
     return color.length === 4 ? 'DeviceCMYK' : 'DeviceRGB';
   },
   fillColor(color, opacity) {
@@ -1441,13 +1483,18 @@ var ColorMixin = {
     return this.addContent(`/${name} gs`);
   },
   linearGradient(x1, y1, x2, y2) {
-    return new PDFLinearGradient$1(this, x1, y1, x2, y2);
+    return new PDFLinearGradient(this, x1, y1, x2, y2);
   },
   radialGradient(x1, y1, r1, x2, y2, r2) {
-    return new PDFRadialGradient$1(this, x1, y1, r1, x2, y2, r2);
+    return new PDFRadialGradient(this, x1, y1, r1, x2, y2, r2);
   },
   pattern(bbox, xStep, yStep, stream) {
-    return new PDFTilingPattern$1(this, bbox, xStep, yStep, stream);
+    return new PDFTilingPattern(this, bbox, xStep, yStep, stream);
+  },
+  addSpotColor(name, C, M, Y, K) {
+    const color = new SpotColor(this, name, C, M, Y, K);
+    this.spotColors[name] = color;
+    return this;
   }
 };
 var namedColors = {
@@ -2693,7 +2740,7 @@ class EmbeddedFont extends PDFFont {
     if (isCFF) {
       fontFile.data.Subtype = 'CIDFontType0C';
     }
-    this.subset.encodeStream().on('data', data => fontFile.write(data)).on('end', () => fontFile.end());
+    fontFile.end(this.subset.encode());
     const familyClass = ((this.font['OS/2'] != null ? this.font['OS/2'].sFamilyClass : undefined) || 0) >> 8;
     let flags = 0;
     if (this.font.post.isFixedPitch) {
@@ -2712,7 +2759,7 @@ class EmbeddedFont extends PDFFont {
 
     // generate a tag (6 uppercase letters. 17 is the char code offset from '0' to 'A'. 73 will map to 'Z')
     const tag = [1, 2, 3, 4, 5, 6].map(i => String.fromCharCode((this.id.charCodeAt(i) || 73) + 17)).join('');
-    const name = tag + '+' + this.font.postscriptName;
+    const name = tag + '+' + this.font.postscriptName.replaceAll(' ', '_');
     const {
       bbox
     } = this.font;
@@ -2834,12 +2881,10 @@ class PDFFontFactory {
       }
       src = fs.readFileSync(src);
     }
-    if (Buffer.isBuffer(src)) {
+    if (src instanceof Uint8Array) {
       font = fontkit.create(src, family);
-    } else if (src instanceof Uint8Array) {
-      font = fontkit.create(Buffer.from(src), family);
     } else if (src instanceof ArrayBuffer) {
-      font = fontkit.create(Buffer.from(new Uint8Array(src)), family);
+      font = fontkit.create(new Uint8Array(src), family);
     }
     if (font == null) {
       throw new Error('Not a supported font format or standard PDF font.');
@@ -2848,6 +2893,18 @@ class PDFFontFactory {
   }
 }
 
+const isEqualFont = (font1, font2) => {
+  // compare font checksum
+  if (font1.font._tables?.head?.checkSumAdjustment !== font2.font._tables?.head?.checkSumAdjustment) {
+    return false;
+  }
+
+  // compare font name table
+  if (JSON.stringify(font1.font._tables?.name?.records) !== JSON.stringify(font2.font._tables?.name?.records)) {
+    return false;
+  }
+  return true;
+};
 var FontsMixin = {
   initFonts() {
     let defaultFont = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'Helvetica';
@@ -2901,7 +2958,7 @@ var FontsMixin = {
 
     // check for existing font familes with the same name already in the PDF
     // useful if the font was passed as a buffer
-    if (font = this._fontFamilies[this._font.name]) {
+    if ((font = this._fontFamilies[this._font.name]) && isEqualFont(this._font, font)) {
       this._font = font;
       return this;
     }
@@ -2940,12 +2997,13 @@ class LineWrapper extends EventEmitter {
   constructor(document, options) {
     super();
     this.document = document;
-    this.indent = options.indent || 0;
-    this.characterSpacing = options.characterSpacing || 0;
-    this.wordSpacing = options.wordSpacing === 0;
+    this.horizontalScaling = options.horizontalScaling || 100;
+    this.indent = (options.indent || 0) * this.horizontalScaling / 100;
+    this.characterSpacing = (options.characterSpacing || 0) * this.horizontalScaling / 100;
+    this.wordSpacing = (options.wordSpacing === 0) * this.horizontalScaling / 100;
     this.columns = options.columns || 1;
-    this.columnGap = options.columnGap != null ? options.columnGap : 18; // 1/4 inch
-    this.lineWidth = (options.width - this.columnGap * (this.columns - 1)) / this.columns;
+    this.columnGap = (options.columnGap != null ? options.columnGap : 18) * this.horizontalScaling / 100; // 1/4 inch
+    this.lineWidth = (options.width * this.horizontalScaling / 100 - this.columnGap * (this.columns - 1)) / this.columns;
     this.spaceLeft = this.lineWidth;
     this.startX = this.document.x;
     this.startY = this.document.y;
@@ -2970,6 +3028,14 @@ class LineWrapper extends EventEmitter {
       const indent = this.continuedX || this.indent;
       this.document.x += indent;
       this.lineWidth -= indent;
+
+      // if indentAllLines is set to true
+      // we're not resetting the indentation for this paragraph after the first line
+      if (options.indentAllLines) {
+        return;
+      }
+
+      // otherwise we start the next line without indent
       return this.once('line', () => {
         this.document.x -= indent;
         this.lineWidth += indent;
@@ -3080,14 +3146,15 @@ class LineWrapper extends EventEmitter {
   }
   wrap(text, options) {
     // override options from previous continued fragments
+    this.horizontalScaling = options.horizontalScaling || 100;
     if (options.indent != null) {
-      this.indent = options.indent;
+      this.indent = options.indent * this.horizontalScaling / 100;
     }
     if (options.characterSpacing != null) {
-      this.characterSpacing = options.characterSpacing;
+      this.characterSpacing = options.characterSpacing * this.horizontalScaling / 100;
     }
     if (options.wordSpacing != null) {
-      this.wordSpacing = options.wordSpacing;
+      this.wordSpacing = options.wordSpacing * this.horizontalScaling / 100;
     }
     if (options.ellipsis != null) {
       this.ellipsis = options.ellipsis;
@@ -3245,7 +3312,7 @@ class LineWrapper extends EventEmitter {
 }
 
 const {
-  number: number$2
+  number
 } = PDFObject;
 var TextMixin = {
   initText() {
@@ -3315,7 +3382,8 @@ var TextMixin = {
   },
   widthOfString(string) {
     let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    return this._font.widthOfString(string, this._fontSize, options.features) + (options.characterSpacing || 0) * (string.length - 1);
+    const horizontalScaling = options.horizontalScaling || 100;
+    return (this._font.widthOfString(string, this._fontSize, options.features) + (options.characterSpacing || 0) * (string.length - 1)) * horizontalScaling / 100;
   },
   heightOfString(text, options) {
     const {
@@ -3493,7 +3561,7 @@ var TextMixin = {
     this._fragment(text, this.x, this.y, options);
     const lineGap = options.lineGap || this._lineGap || 0;
     if (!wrapper) {
-      return this.x += this.widthOfString(text);
+      return this.x += this.widthOfString(text, options);
     } else {
       return this.y += this.currentLineHeight(true) + lineGap;
     }
@@ -3509,6 +3577,7 @@ var TextMixin = {
     const align = options.align || 'left';
     let wordSpacing = options.wordSpacing || 0;
     const characterSpacing = options.characterSpacing || 0;
+    const horizontalScaling = options.horizontalScaling || 100;
 
     // text alignments
     if (options.width) {
@@ -3635,10 +3704,10 @@ var TextMixin = {
     this.addContent('BT');
 
     // text position
-    this.addContent(`1 0 0 1 ${number$2(x)} ${number$2(y)} Tm`);
+    this.addContent(`1 0 0 1 ${number(x)} ${number(y)} Tm`);
 
     // font and font size
-    this.addContent(`/${this._font.id} ${number$2(this._fontSize)} Tf`);
+    this.addContent(`/${this._font.id} ${number(this._fontSize)} Tf`);
 
     // rendering mode
     const mode = options.fill && options.stroke ? 2 : options.stroke ? 1 : 0;
@@ -3648,7 +3717,12 @@ var TextMixin = {
 
     // Character spacing
     if (characterSpacing) {
-      this.addContent(`${number$2(characterSpacing)} Tc`);
+      this.addContent(`${number(characterSpacing)} Tc`);
+    }
+
+    // Horizontal scaling
+    if (horizontalScaling !== 100) {
+      this.addContent(`${horizontalScaling} Tz`);
     }
 
     // Add the actual text
@@ -3690,7 +3764,7 @@ var TextMixin = {
       if (last < cur) {
         const hex = encoded.slice(last, cur).join('');
         const advance = positions[cur - 1].xAdvance - positions[cur - 1].advanceWidth;
-        commands.push(`<${hex}> ${number$2(-advance)}`);
+        commands.push(`<${hex}> ${number(-advance)}`);
       }
       return last = cur;
     };
@@ -3712,13 +3786,13 @@ var TextMixin = {
         flush(i);
 
         // Move the text position and flush just the current character
-        this.addContent(`1 0 0 1 ${number$2(x + pos.xOffset * scale)} ${number$2(y + pos.yOffset * scale)} Tm`);
+        this.addContent(`1 0 0 1 ${number(x + pos.xOffset * scale)} ${number(y + pos.yOffset * scale)} Tm`);
         flush(i + 1);
         hadOffset = true;
       } else {
         // If the last character had an offset, reset the text position
         if (hadOffset) {
-          this.addContent(`1 0 0 1 ${number$2(x)} ${number$2(y)} Tm`);
+          this.addContent(`1 0 0 1 ${number(x)} ${number(y)} Tm`);
           hadOffset = false;
         }
 
@@ -4223,7 +4297,9 @@ var AnnotationsMixin = {
     let options = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : {};
     options.Subtype = 'Text';
     options.Contents = new String(contents);
-    options.Name = 'Comment';
+    if (options.Name == null) {
+      options.Name = 'Comment';
+    }
     if (options.color == null) {
       options.color = [243, 223, 92];
     }
@@ -4748,6 +4824,9 @@ var MarkingsMixin = {
     }
     return this._root.data.MarkInfo;
   },
+  hasMarkInfoDictionary() {
+    return !!this._root.data.MarkInfo;
+  },
   getStructTreeRoot() {
     if (!this._root.data.StructTreeRoot) {
       this._root.data.StructTreeRoot = this.ref({
@@ -5793,5 +5872,5 @@ mixin(AttachmentsMixin);
 mixin(SubsetMixin);
 PDFDocument.LineWrapper = LineWrapper;
 
-export default PDFDocument;
+export { PDFDocument as default };
 //# sourceMappingURL=pdfkit.es.js.map