pdfkit 0.12.3 → 0.13.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ### Unreleased
 
+### [v0.13.0] - 2021-10-24
+
+- Add tiling pattern support
+
+### [v0.12.3] - 2021-08-01
+
+- Remove examples from published package
+
 ### [v0.12.2] - 2021-08-01
 
 - Fix for PDF accessibility check. (#1265)

package/README.md

@@ -154,7 +154,7 @@ const stream = doc.pipe(blobStream());
 
 // add your content to the document here, as usual
 
-// get a blob when you're done
+// get a blob when you are done
 doc.end();
 stream.on('finish', function() {
   // get a blob you can do whatever you like with

package/js/pdfkit.es5.js

@@ -7,6 +7,44 @@ import { EventEmitter } from 'events';
 import LineBreaker from 'linebreak';
 import PNG from 'png-js';
 
+function ownKeys(object, enumerableOnly) {
+  var keys = Object.keys(object);
+
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+
+    if (enumerableOnly) {
+      symbols = symbols.filter(function (sym) {
+        return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+      });
+    }
+
+    keys.push.apply(keys, symbols);
+  }
+
+  return keys;
+}
+
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = arguments[i] != null ? arguments[i] : {};
+
+    if (i % 2) {
+      ownKeys(Object(source), true).forEach(function (key) {
+        _defineProperty(target, key, source[key]);
+      });
+    } else if (Object.getOwnPropertyDescriptors) {
+      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+      ownKeys(Object(source)).forEach(function (key) {
+        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+      });
+    }
+  }
+
+  return target;
+}
+
 function _classCallCheck(instance, Constructor) {
   if (!(instance instanceof Constructor)) {
     throw new TypeError("Cannot call a class as a function");
@@ -44,40 +82,6 @@ function _defineProperty(obj, key, value) {
   return obj;
 }
 
-function ownKeys(object, enumerableOnly) {
-  var keys = Object.keys(object);
-
-  if (Object.getOwnPropertySymbols) {
-    var symbols = Object.getOwnPropertySymbols(object);
-    if (enumerableOnly) symbols = symbols.filter(function (sym) {
-      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-    });
-    keys.push.apply(keys, symbols);
-  }
-
-  return keys;
-}
-
-function _objectSpread2(target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = arguments[i] != null ? arguments[i] : {};
-
-    if (i % 2) {
-      ownKeys(Object(source), true).forEach(function (key) {
-        _defineProperty(target, key, source[key]);
-      });
-    } else if (Object.getOwnPropertyDescriptors) {
-      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
-    } else {
-      ownKeys(Object(source)).forEach(function (key) {
-        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-      });
-    }
-  }
-
-  return target;
-}
-
 function _inherits(subClass, superClass) {
   if (typeof superClass !== "function" && superClass !== null) {
     throw new TypeError("Super expression must either be null or a function");
@@ -115,7 +119,7 @@ function _isNativeReflectConstruct() {
   if (typeof Proxy === "function") return true;
 
   try {
-    Date.prototype.toString.call(Reflect.construct(Date, [], function () {}));
+    Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {}));
     return true;
   } catch (e) {
     return false;
@@ -174,18 +178,21 @@ function _arrayWithHoles(arr) {
 }
 
 function _iterableToArray(iter) {
-  if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter);
+  if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
 }
 
 function _iterableToArrayLimit(arr, i) {
-  if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return;
+  var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+
+  if (_i == null) return;
   var _arr = [];
   var _n = true;
   var _d = false;
-  var _e = undefined;
+
+  var _s, _e;
 
   try {
-    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
+    for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
       _arr.push(_s.value);
 
       if (i && _arr.length === i) break;
@@ -230,9 +237,9 @@ function _nonIterableRest() {
 }
 
 function _createForOfIteratorHelper(o, allowArrayLike) {
-  var it;
+  var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"];
 
-  if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) {
+  if (!it) {
     if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") {
       if (it) o = it;
       var i = 0;
@@ -265,7 +272,7 @@ function _createForOfIteratorHelper(o, allowArrayLike) {
       err;
   return {
     s: function () {
-      it = o[Symbol.iterator]();
+      it = it.call(o);
     },
     n: function () {
       var step = it.next();
@@ -364,9 +371,7 @@ var PDFTree = /*#__PURE__*/function () {
     }
   }, {
     key: "_compareKeys",
-    value: function _compareKeys()
-    /*a, b*/
-    {
+    value: function _compareKeys() {
       throw new Error('Must be implemented by subclasses');
     }
   }, {
@@ -376,9 +381,7 @@ var PDFTree = /*#__PURE__*/function () {
     }
   }, {
     key: "_dataForKey",
-    value: function _dataForKey()
-    /*k*/
-    {
+    value: function _dataForKey() {
       throw new Error('Must be implemented by subclasses');
     }
   }]);
@@ -722,23 +725,6 @@ var PDFPage = /*#__PURE__*/function () {
 
 
   _createClass(PDFPage, [{
-    key: "maxY",
-    value: function maxY() {
-      return this.height - this.margins.bottom;
-    }
-  }, {
-    key: "write",
-    value: function write(chunk) {
-      return this.content.write(chunk);
-    }
-  }, {
-    key: "end",
-    value: function end() {
-      this.dictionary.end();
-      this.resources.end();
-      return this.content.end();
-    }
-  }, {
     key: "fonts",
     get: function get() {
       var data = this.resources.data;
@@ -762,6 +748,12 @@ var PDFPage = /*#__PURE__*/function () {
       var data = this.resources.data;
       return data.Pattern != null ? data.Pattern : data.Pattern = {};
     }
+  }, {
+    key: "colorSpaces",
+    get: function get() {
+      var data = this.resources.data;
+      return data.ColorSpace || (data.ColorSpace = {});
+    }
   }, {
     key: "annotations",
     get: function get() {
@@ -774,6 +766,23 @@ var PDFPage = /*#__PURE__*/function () {
       var data = this.dictionary.data;
       return data.StructParents != null ? data.StructParents : data.StructParents = this.document.createStructParentTreeNextKey();
     }
+  }, {
+    key: "maxY",
+    value: function maxY() {
+      return this.height - this.margins.bottom;
+    }
+  }, {
+    key: "write",
+    value: function write(chunk) {
+      return this.content.write(chunk);
+    }
+  }, {
+    key: "end",
+    value: function end() {
+      this.dictionary.end();
+      this.resources.end();
+      return this.content.end();
+    }
   }]);
 
   return PDFPage;
@@ -1248,41 +1257,6 @@ function saslprep(input) {
 }
 
 var PDFSecurity = /*#__PURE__*/function () {
-  _createClass(PDFSecurity, null, [{
-    key: "generateFileID",
-    value: function generateFileID() {
-      var info = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      var infoStr = "".concat(info.CreationDate.getTime(), "\n");
-
-      for (var key in info) {
-        // eslint-disable-next-line no-prototype-builtins
-        if (!info.hasOwnProperty(key)) {
-          continue;
-        }
-
-        infoStr += "".concat(key, ": ").concat(info[key].valueOf(), "\n");
-      }
-
-      return wordArrayToBuffer(CryptoJS.MD5(infoStr));
-    }
-  }, {
-    key: "generateRandomWordArray",
-    value: function generateRandomWordArray(bytes) {
-      return CryptoJS.lib.WordArray.random(bytes);
-    }
-  }, {
-    key: "create",
-    value: function create(document) {
-      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
-      if (!options.ownerPassword && !options.userPassword) {
-        return null;
-      }
-
-      return new PDFSecurity(document, options);
-    }
-  }]);
-
   function PDFSecurity(document) {
     var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
 
@@ -1475,6 +1449,39 @@ var PDFSecurity = /*#__PURE__*/function () {
     value: function end() {
       this.dictionary.end();
     }
+  }], [{
+    key: "generateFileID",
+    value: function generateFileID() {
+      var info = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var infoStr = "".concat(info.CreationDate.getTime(), "\n");
+
+      for (var key in info) {
+        // eslint-disable-next-line no-prototype-builtins
+        if (!info.hasOwnProperty(key)) {
+          continue;
+        }
+
+        infoStr += "".concat(key, ": ").concat(info[key].valueOf(), "\n");
+      }
+
+      return wordArrayToBuffer(CryptoJS.MD5(infoStr));
+    }
+  }, {
+    key: "generateRandomWordArray",
+    value: function generateRandomWordArray(bytes) {
+      return CryptoJS.lib.WordArray.random(bytes);
+    }
+  }, {
+    key: "create",
+    value: function create(document) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+      if (!options.ownerPassword && !options.userPassword) {
+        return null;
+      }
+
+      return new PDFSecurity(document, options);
+    }
   }]);
 
   return PDFSecurity;
@@ -1891,7 +1898,7 @@ var PDFGradient = /*#__PURE__*/function () {
     }
   }, {
     key: "apply",
-    value: function apply(op) {
+    value: function apply(stroke) {
       // apply gradient transform to existing document ctm
       var _this$doc$_ctm = _slicedToArray(this.doc._ctm, 6),
           m0 = _this$doc$_ctm[0],
@@ -1915,6 +1922,9 @@ var PDFGradient = /*#__PURE__*/function () {
         this.embed(m);
       }
 
+      this.doc._setColorSpace('Pattern', stroke);
+
+      var op = stroke ? 'SCN' : 'scn';
       return this.doc.addContent("/".concat(this.id, " ").concat(op));
     }
   }]);
@@ -2009,21 +2019,143 @@ var Gradient = {
   PDFRadialGradient: PDFRadialGradient
 };
 
+/*
+PDF tiling pattern support. Uncolored only.
+ */
+var underlyingColorSpaces = ['DeviceCMYK', 'DeviceRGB'];
+
+var PDFTilingPattern = /*#__PURE__*/function () {
+  function PDFTilingPattern(doc, bBox, xStep, yStep, stream) {
+    _classCallCheck(this, PDFTilingPattern);
+
+    this.doc = doc;
+    this.bBox = bBox;
+    this.xStep = xStep;
+    this.yStep = yStep;
+    this.stream = stream;
+  }
+
+  _createClass(PDFTilingPattern, [{
+    key: "createPattern",
+    value: function createPattern() {
+      // no resources needed for our current usage
+      // required entry
+      var resources = this.doc.ref();
+      resources.end(); // apply default transform matrix (flipped in the default doc._ctm)
+      // see document.js & gradient.js
+
+      var _this$doc$_ctm = _slicedToArray(this.doc._ctm, 6),
+          m0 = _this$doc$_ctm[0],
+          m1 = _this$doc$_ctm[1],
+          m2 = _this$doc$_ctm[2],
+          m3 = _this$doc$_ctm[3],
+          m4 = _this$doc$_ctm[4],
+          m5 = _this$doc$_ctm[5];
+
+      var m11 = 1,
+          m12 = 0,
+          m21 = 0,
+          m22 = 1,
+          dx = 0,
+          dy = 0;
+      var m = [m0 * m11 + m2 * m12, m1 * m11 + m3 * m12, m0 * m21 + m2 * m22, m1 * m21 + m3 * m22, m0 * dx + m2 * dy + m4, m1 * dx + m3 * dy + m5];
+      var pattern = this.doc.ref({
+        Type: 'Pattern',
+        PatternType: 1,
+        // tiling
+        PaintType: 2,
+        // 1-colored, 2-uncolored
+        TilingType: 2,
+        // 2-no distortion
+        BBox: this.bBox,
+        XStep: this.xStep,
+        YStep: this.yStep,
+        Matrix: m.map(function (v) {
+          return +v.toFixed(5);
+        }),
+        Resources: resources
+      });
+      pattern.end(this.stream);
+      return pattern;
+    }
+  }, {
+    key: "embedPatternColorSpaces",
+    value: function embedPatternColorSpaces() {
+      var _this = this;
+
+      // map each pattern to an underlying color space
+      // and embed on each page
+      underlyingColorSpaces.forEach(function (csName) {
+        var csId = _this.getPatternColorSpaceId(csName);
+
+        if (_this.doc.page.colorSpaces[csId]) return;
+
+        var cs = _this.doc.ref(['Pattern', csName]);
+
+        cs.end();
+        _this.doc.page.colorSpaces[csId] = cs;
+      });
+    }
+  }, {
+    key: "getPatternColorSpaceId",
+    value: function getPatternColorSpaceId(underlyingColorspace) {
+      return "CsP".concat(underlyingColorspace);
+    }
+  }, {
+    key: "embed",
+    value: function embed() {
+      if (!this.id) {
+        this.doc._patternCount = this.doc._patternCount + 1;
+        this.id = 'P' + this.doc._patternCount;
+        this.pattern = this.createPattern();
+      } // patterns are embedded in each page
+
+
+      if (!this.doc.page.patterns[this.id]) {
+        this.doc.page.patterns[this.id] = this.pattern;
+      }
+    }
+  }, {
+    key: "apply",
+    value: function apply(stroke, patternColor) {
+      // do any embedding/creating that might be needed
+      this.embedPatternColorSpaces();
+      this.embed();
+
+      var normalizedColor = this.doc._normalizeColor(patternColor);
+
+      if (!normalizedColor) throw Error("invalid pattern color. (value: ".concat(patternColor, ")")); // select one of the pattern color spaces
+
+      var csId = this.getPatternColorSpaceId(this.doc._getColorSpace(normalizedColor));
+
+      this.doc._setColorSpace(csId, stroke); // stroke/fill using the pattern and color (in the above underlying color space)
+
+
+      var op = stroke ? 'SCN' : 'scn';
+      return this.doc.addContent("".concat(normalizedColor.join(' '), " /").concat(this.id, " ").concat(op));
+    }
+  }]);
+
+  return PDFTilingPattern;
+}();
+
+var pattern = {
+  PDFTilingPattern: PDFTilingPattern
+};
+
 var PDFGradient$1 = Gradient.PDFGradient,
     PDFLinearGradient$1 = Gradient.PDFLinearGradient,
     PDFRadialGradient$1 = Gradient.PDFRadialGradient;
+var PDFTilingPattern$1 = pattern.PDFTilingPattern;
 var ColorMixin = {
   initColor: function initColor() {
     // The opacity dictionaries
     this._opacityRegistry = {};
     this._opacityCount = 0;
+    this._patternCount = 0;
     return this._gradCount = 0;
   },
   _normalizeColor: function _normalizeColor(color) {
-    if (color instanceof PDFGradient$1) {
-      return color;
-    }
-
     if (typeof color === 'string') {
       if (color.charAt(0) === '#') {
         if (color.length === 4) {
@@ -2055,6 +2187,18 @@ var ColorMixin = {
     return null;
   },
   _setColor: function _setColor(color, stroke) {
+    if (color instanceof PDFGradient$1) {
+      color.apply(stroke);
+      return true; // see if tiling pattern, decode & apply it it
+    } else if (Array.isArray(color) && color[0] instanceof PDFTilingPattern$1) {
+      color[0].apply(stroke, color[1]);
+      return true;
+    } // any other case should be a normal color and not a pattern
+
+
+    return this._setColorCore(color, stroke);
+  },
+  _setColorCore: function _setColorCore(color, stroke) {
     color = this._normalizeColor(color);
 
     if (!color) {
@@ -2063,25 +2207,21 @@ var ColorMixin = {
 
     var op = stroke ? 'SCN' : 'scn';
 
-    if (color instanceof PDFGradient$1) {
-      this._setColorSpace('Pattern', stroke);
-
-      color.apply(op);
-    } else {
-      var space = color.length === 4 ? 'DeviceCMYK' : 'DeviceRGB';
-
-      this._setColorSpace(space, stroke);
+    var space = this._getColorSpace(color);
 
-      color = color.join(' ');
-      this.addContent("".concat(color, " ").concat(op));
-    }
+    this._setColorSpace(space, stroke);
 
+    color = color.join(' ');
+    this.addContent("".concat(color, " ").concat(op));
     return true;
   },
   _setColorSpace: function _setColorSpace(space, stroke) {
     var op = stroke ? 'CS' : 'cs';
     return this.addContent("/".concat(space, " ").concat(op));
   },
+  _getColorSpace: function _getColorSpace(color) {
+    return color.length === 4 ? 'DeviceCMYK' : 'DeviceRGB';
+  },
   fillColor: function fillColor(color, opacity) {
     var set = this._setColor(color, false);
 
@@ -2168,6 +2308,9 @@ var ColorMixin = {
   },
   radialGradient: function radialGradient(x1, y1, r1, x2, y2, r2) {
     return new PDFRadialGradient$1(this, x1, y1, r1, x2, y2, r2);
+  },
+  pattern: function pattern(bbox, xStep, yStep, stream) {
+    return new PDFTilingPattern$1(this, bbox, xStep, yStep, stream);
   }
 };
 var namedColors = {
@@ -3101,13 +3244,6 @@ var WIN_ANSI_MAP = {
 var characters = ".notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n.notdef       .notdef        .notdef        .notdef\n  \nspace         exclam         quotedbl       numbersign\ndollar        percent        ampersand      quotesingle\nparenleft     parenright     asterisk       plus\ncomma         hyphen         period         slash\nzero          one            two            three\nfour          five           six            seven\neight         nine           colon          semicolon\nless          equal          greater        question\n  \nat            A              B              C\nD             E              F              G\nH             I              J              K\nL             M              N              O\nP             Q              R              S\nT             U              V              W\nX             Y              Z              bracketleft\nbackslash     bracketright   asciicircum    underscore\n  \ngrave         a              b              c\nd             e              f              g\nh             i              j              k\nl             m              n              o\np             q              r              s\nt             u              v              w\nx             y              z              braceleft\nbar           braceright     asciitilde     .notdef\n  \nEuro          .notdef        quotesinglbase florin\nquotedblbase  ellipsis       dagger         daggerdbl\ncircumflex    perthousand    Scaron         guilsinglleft\nOE            .notdef        Zcaron         .notdef\n.notdef       quoteleft      quoteright     quotedblleft\nquotedblright bullet         endash         emdash\ntilde         trademark      scaron         guilsinglright\noe            .notdef        zcaron         ydieresis\n  \nspace         exclamdown     cent           sterling\ncurrency      yen            brokenbar      section\ndieresis      copyright      ordfeminine    guillemotleft\nlogicalnot    hyphen         registered     macron\ndegree        plusminus      twosuperior    threesuperior\nacute         mu             paragraph      periodcentered\ncedilla       onesuperior    ordmasculine   guillemotright\nonequarter    onehalf        threequarters  questiondown\n  \nAgrave        Aacute         Acircumflex    Atilde\nAdieresis     Aring          AE             Ccedilla\nEgrave        Eacute         Ecircumflex    Edieresis\nIgrave        Iacute         Icircumflex    Idieresis\nEth           Ntilde         Ograve         Oacute\nOcircumflex   Otilde         Odieresis      multiply\nOslash        Ugrave         Uacute         Ucircumflex\nUdieresis     Yacute         Thorn          germandbls\n  \nagrave        aacute         acircumflex    atilde\nadieresis     aring          ae             ccedilla\negrave        eacute         ecircumflex    edieresis\nigrave        iacute         icircumflex    idieresis\neth           ntilde         ograve         oacute\nocircumflex   otilde         odieresis      divide\noslash        ugrave         uacute         ucircumflex\nudieresis     yacute         thorn          ydieresis".split(/\s+/);
 
 var AFMFont = /*#__PURE__*/function () {
-  _createClass(AFMFont, null, [{
-    key: "open",
-    value: function open(filename) {
-      return new AFMFont(fs.readFileSync(filename, 'utf8'));
-    }
-  }]);
-
   function AFMFont(contents) {
     _classCallCheck(this, AFMFont);
 
@@ -3252,6 +3388,11 @@ var AFMFont = /*#__PURE__*/function () {
 
       return advances;
     }
+  }], [{
+    key: "open",
+    value: function open(filename) {
+      return new AFMFont(fs.readFileSync(filename, 'utf8'));
+    }
   }]);
 
   return AFMFont;