pdfkit 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,6 +1,9 @@
 ## pdfkit changelog
 
-### Unreleased
+### [v0.14.0] - 2023-11-09
+
+- Add support for PDF/A-1b, PDF/A-1a, PDF/A-2b, PDF/A-2a, PDF/A-3b, PDF/A-3a
+- Update crypto-js to v4.2.0 (properly fix security issue)
 
 ### [v0.13.0] - 2021-10-24
 

package/js/pdfkit.es5.js

@@ -7,44 +7,6 @@ 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");
@@ -82,6 +44,40 @@ 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");
@@ -119,7 +115,7 @@ function _isNativeReflectConstruct() {
   if (typeof Proxy === "function") return true;
 
   try {
-    Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {}));
+    Date.prototype.toString.call(Reflect.construct(Date, [], function () {}));
     return true;
   } catch (e) {
     return false;
@@ -178,21 +174,18 @@ function _arrayWithHoles(arr) {
 }
 
 function _iterableToArray(iter) {
-  if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+  if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter);
 }
 
 function _iterableToArrayLimit(arr, i) {
-  var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
-
-  if (_i == null) return;
+  if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return;
   var _arr = [];
   var _n = true;
   var _d = false;
-
-  var _s, _e;
+  var _e = undefined;
 
   try {
-    for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
+    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
       _arr.push(_s.value);
 
       if (i && _arr.length === i) break;
@@ -237,9 +230,9 @@ function _nonIterableRest() {
 }
 
 function _createForOfIteratorHelper(o, allowArrayLike) {
-  var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"];
+  var it;
 
-  if (!it) {
+  if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) {
     if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") {
       if (it) o = it;
       var i = 0;
@@ -272,7 +265,7 @@ function _createForOfIteratorHelper(o, allowArrayLike) {
       err;
   return {
     s: function () {
-      it = it.call(o);
+      it = o[Symbol.iterator]();
     },
     n: function () {
       var step = it.next();
@@ -371,7 +364,9 @@ var PDFTree = /*#__PURE__*/function () {
     }
   }, {
     key: "_compareKeys",
-    value: function _compareKeys() {
+    value: function _compareKeys()
+    /*a, b*/
+    {
       throw new Error('Must be implemented by subclasses');
     }
   }, {
@@ -381,7 +376,9 @@ var PDFTree = /*#__PURE__*/function () {
     }
   }, {
     key: "_dataForKey",
-    value: function _dataForKey() {
+    value: function _dataForKey()
+    /*k*/
+    {
       throw new Error('Must be implemented by subclasses');
     }
   }]);
@@ -725,6 +722,23 @@ 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;
@@ -766,23 +780,6 @@ 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;
@@ -1257,6 +1254,41 @@ 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] : {};
 
@@ -1449,39 +1481,6 @@ 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;
@@ -3244,6 +3243,13 @@ 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);
 
@@ -3388,11 +3394,6 @@ var AFMFont = /*#__PURE__*/function () {
 
       return advances;
     }
-  }], [{
-    key: "open",
-    value: function open(filename) {
-      return new AFMFont(fs.readFileSync(filename, 'utf8'));
-    }
   }]);
 
   return AFMFont;
@@ -3790,6 +3791,14 @@ var EmbeddedFont = /*#__PURE__*/function (_PDFFont) {
         descriptor.data.FontFile2 = fontFile;
       }
 
+      if (this.document.subset) {
+        var CIDSet = Buffer.from('FFFFFFFFC0', 'hex');
+        var CIDSetRef = this.document.ref();
+        CIDSetRef.write(CIDSet);
+        CIDSetRef.end();
+        descriptor.data.CIDSet = CIDSetRef;
+      }
+
       descriptor.end();
       var descendantFontData = {
         Type: 'Font',
@@ -6693,6 +6702,175 @@ function isEqual(a, b) {
   return a.Subtype === b.Subtype && a.Params.CheckSum.toString() === b.Params.CheckSum.toString() && a.Params.Size === b.Params.Size && a.Params.CreationDate === b.Params.CreationDate && a.Params.ModDate === b.Params.ModDate;
 }
 
+var PDFA = {
+  initPDFA: function initPDFA(pSubset) {
+    if (pSubset.charAt(pSubset.length - 3) === '-') {
+      this.subset_conformance = pSubset.charAt(pSubset.length - 1).toUpperCase();
+      this.subset = parseInt(pSubset.charAt(pSubset.length - 2));
+    } else {
+      // Default to Basic conformance when user doesn't specify
+      this.subset_conformance = 'B';
+      this.subset = parseInt(pSubset.charAt(pSubset.length - 1));
+    }
+  },
+  endSubset: function endSubset() {
+    this._addPdfaMetadata();
+
+    var jsPath = "".concat(__dirname, "/data/sRGB_IEC61966_2_1.icc");
+    var jestPath = "".concat(__dirname, "/../color_profiles/sRGB_IEC61966_2_1.icc");
+
+    this._addColorOutputIntent(fs.existsSync(jsPath) ? jsPath : jestPath);
+  },
+  _addColorOutputIntent: function _addColorOutputIntent(pICCPath) {
+    var iccProfile = fs.readFileSync(pICCPath);
+    var colorProfileRef = this.ref({
+      Length: iccProfile.length,
+      N: 3
+    });
+    colorProfileRef.write(iccProfile);
+    colorProfileRef.end();
+    var intentRef = this.ref({
+      Type: 'OutputIntent',
+      S: 'GTS_PDFA1',
+      Info: new String('sRGB IEC61966-2.1'),
+      OutputConditionIdentifier: new String('sRGB IEC61966-2.1'),
+      DestOutputProfile: colorProfileRef
+    });
+    intentRef.end();
+    this._root.data.OutputIntents = [intentRef];
+  },
+  _getPdfaid: function _getPdfaid() {
+    return "\n        <rdf:Description xmlns:pdfaid=\"http://www.aiim.org/pdfa/ns/id/\" rdf:about=\"\">\n            <pdfaid:part>".concat(this.subset, "</pdfaid:part>\n            <pdfaid:conformance>").concat(this.subset_conformance, "</pdfaid:conformance>\n        </rdf:Description>\n        ");
+  },
+  _addPdfaMetadata: function _addPdfaMetadata() {
+    this.appendXML(this._getPdfaid());
+  }
+};
+
+var SubsetMixin = {
+  _importSubset: function _importSubset(subset) {
+    Object.assign(this, subset);
+  },
+  initSubset: function initSubset(options) {
+    switch (options.subset) {
+      case 'PDF/A-1':
+      case 'PDF/A-1a':
+      case 'PDF/A-1b':
+      case 'PDF/A-2':
+      case 'PDF/A-2a':
+      case 'PDF/A-2b':
+      case 'PDF/A-3':
+      case 'PDF/A-3a':
+      case 'PDF/A-3b':
+        this._importSubset(PDFA);
+
+        this.initPDFA(options.subset);
+        break;
+    }
+  }
+};
+
+var PDFMetadata = /*#__PURE__*/function () {
+  function PDFMetadata() {
+    _classCallCheck(this, PDFMetadata);
+
+    this._metadata = "\n        <?xpacket begin=\"\uFEFF\" id=\"W5M0MpCehiHzreSzNTczkc9d\"?>\n            <x:xmpmeta xmlns:x=\"adobe:ns:meta/\">\n                <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\">\n        ";
+  }
+
+  _createClass(PDFMetadata, [{
+    key: "_closeTags",
+    value: function _closeTags() {
+      this._metadata = this._metadata.concat("\n                </rdf:RDF>\n            </x:xmpmeta>\n        <?xpacket end=\"w\"?>\n        ");
+    }
+  }, {
+    key: "append",
+    value: function append(xml) {
+      var newline = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+      this._metadata = this._metadata.concat(xml);
+      if (newline) this._metadata = this._metadata.concat('\n');
+    }
+  }, {
+    key: "getXML",
+    value: function getXML() {
+      return this._metadata;
+    }
+  }, {
+    key: "getLength",
+    value: function getLength() {
+      return this._metadata.length;
+    }
+  }, {
+    key: "end",
+    value: function end() {
+      this._closeTags();
+
+      this._metadata = this._metadata.trim();
+    }
+  }]);
+
+  return PDFMetadata;
+}();
+
+var MetadataMixin = {
+  initMetadata: function initMetadata() {
+    this.metadata = new PDFMetadata();
+  },
+  appendXML: function appendXML(xml) {
+    var newline = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+    this.metadata.append(xml, newline);
+  },
+  _addInfo: function _addInfo() {
+    this.appendXML("\n        <rdf:Description rdf:about=\"\" xmlns:xmp=\"http://ns.adobe.com/xap/1.0/\">\n            <xmp:CreateDate>".concat(this.info.CreationDate.toISOString().split('.')[0] + "Z", "</xmp:CreateDate>\n            <xmp:CreatorTool>").concat(this.info.Creator, "</xmp:CreatorTool>\n        </rdf:Description>\n        "));
+
+    if (this.info.Title || this.info.Author || this.info.Subject) {
+      this.appendXML("\n            <rdf:Description rdf:about=\"\" xmlns:dc=\"http://purl.org/dc/elements/1.1/\">\n            ");
+
+      if (this.info.Title) {
+        this.appendXML("\n                <dc:title>\n                    <rdf:Alt>\n                        <rdf:li xml:lang=\"x-default\">".concat(this.info.Title, "</rdf:li>\n                    </rdf:Alt>\n                </dc:title>\n                "));
+      }
+
+      if (this.info.Author) {
+        this.appendXML("\n                <dc:creator>\n                    <rdf:Seq>\n                        <rdf:li>".concat(this.info.Author, "</rdf:li>\n                    </rdf:Seq>\n                </dc:creator>\n                "));
+      }
+
+      if (this.info.Subject) {
+        this.appendXML("\n                <dc:description>\n                    <rdf:Alt>\n                        <rdf:li xml:lang=\"x-default\">".concat(this.info.Subject, "</rdf:li>\n                    </rdf:Alt>\n                </dc:description>\n                "));
+      }
+
+      this.appendXML("\n            </rdf:Description>\n            ");
+    }
+
+    this.appendXML("\n        <rdf:Description rdf:about=\"\" xmlns:pdf=\"http://ns.adobe.com/pdf/1.3/\">\n            <pdf:Producer>".concat(this.info.Creator, "</pdf:Producer>"), false);
+
+    if (this.info.Keywords) {
+      this.appendXML("\n            <pdf:Keywords>".concat(this.info.Keywords, "</pdf:Keywords>"), false);
+    }
+
+    this.appendXML("\n        </rdf:Description>\n        ");
+  },
+  endMetadata: function endMetadata() {
+    this._addInfo();
+
+    this.metadata.end();
+    /*
+    Metadata was introduced in PDF 1.4, so adding it to 1.3 
+    will likely only take up more space.
+    */
+
+    if (this.version != 1.3) {
+      this.metadataRef = this.ref({
+        length: this.metadata.getLength(),
+        Type: 'Metadata',
+        Subtype: 'XML'
+      });
+      this.metadataRef.compress = false;
+      this.metadataRef.write(Buffer.from(this.metadata.getXML(), 'utf-8'));
+      this.metadataRef.end();
+      this._root.data.Metadata = this.metadataRef;
+    }
+  }
+};
+
 var PDFDocument = /*#__PURE__*/function (_stream$Readable) {
   _inherits(PDFDocument, _stream$Readable);
 
@@ -6764,6 +6942,8 @@ var PDFDocument = /*#__PURE__*/function (_stream$Readable) {
 
     _this.page = null; // Initialize mixins
 
+    _this.initMetadata();
+
     _this.initColor();
 
     _this.initVector();
@@ -6776,7 +6956,9 @@ var PDFDocument = /*#__PURE__*/function (_stream$Readable) {
 
     _this.initOutline();
 
-    _this.initMarkings(options); // Initialize the metadata
+    _this.initMarkings(options);
+
+    _this.initSubset(options); // Initialize the metadata
 
 
     _this.info = {
@@ -7025,6 +7207,12 @@ var PDFDocument = /*#__PURE__*/function (_stream$Readable) {
       this.endOutline();
       this.endMarkings();
 
+      if (this.subset) {
+        this.endSubset();
+      }
+
+      this.endMetadata();
+
       this._root.end();
 
       this._root.data.Pages.end();
@@ -7114,6 +7302,7 @@ var mixin = function mixin(methods) {
   Object.assign(PDFDocument.prototype, methods);
 };
 
+mixin(MetadataMixin);
 mixin(ColorMixin);
 mixin(VectorMixin);
 mixin(FontsMixin);
@@ -7124,6 +7313,7 @@ mixin(OutlineMixin);
 mixin(MarkingsMixin);
 mixin(AcroFormMixin);
 mixin(AttachmentsMixin);
+mixin(SubsetMixin);
 PDFDocument.LineWrapper = LineWrapper;
 
 export default PDFDocument;