refactor: partially unify pdfkit (#3065)

Author: diegomura

.changeset/fair-cougars-reflect.md

@@ -0,0 +1,7 @@
+---
+"@react-pdf/pdfkit": patch
+"@react-pdf/render": patch
+"@react-pdf/renderer": patch
+---
+
+refactor: partially unify pdfkit 

packages/pdfkit/src/document.js

@@ -22,7 +22,6 @@ import AttachmentsMixin from './mixins/attachments';
 import LineWrapper from './line_wrapper';
 import SubsetMixin from './mixins/subsets';
 import MetadataMixin from './mixins/metadata';
-import capitalize from './utils/capitalize';
 
 class PDFDocument extends stream.Readable {
   constructor(options = {}) {
@@ -61,7 +60,6 @@ class PDFDocument extends stream.Readable {
     this._waiting = 0;
     this._ended = false;
     this._offset = 0;
-
     const Pages = this.ref({
       Type: 'Pages',
       Count: 0,
@@ -82,26 +80,19 @@ class PDFDocument extends stream.Readable {
       this._root.data.Lang = new String(this.options.lang);
     }
 
-    if (this.options.pageLayout) {
-      this._root.data.PageLayout = capitalize(this.options.pageLayout);
-    }
-
-    if (this.options.pageMode) {
-      this._root.data.PageMode = capitalize(this.options.pageMode);
-    }
-
     // The current page
     this.page = null;
 
     // Initialize mixins
+    this.initMetadata();
     this.initColor();
     this.initVector();
-    this.initFonts();
+    this.initFonts(options.font);
     this.initText();
     this.initImages();
     this.initOutline();
-    this.initSubset(options);
     this.initMarkings(options);
+    this.initSubset(options);
 
     // Initialize the metadata
     this.info = {
@@ -129,7 +120,8 @@ class PDFDocument extends stream.Readable {
     // Initialize security settings
     // this._security = PDFSecurity.create(this, options);
 
-    // Write the header PDF version
+    // Write the header
+    // PDF version
     this._write(`%PDF-${this.version}`);
 
     // 4 binary chars, as recommended by the spec
@@ -142,7 +134,6 @@ class PDFDocument extends stream.Readable {
   }
 
   addPage(options) {
-    // end the current page if needed
     if (options == null) {
       ({ options } = this);
     }
@@ -161,12 +152,16 @@ class PDFDocument extends stream.Readable {
     pages.Kids.push(this.page.dictionary);
     pages.Count++;
 
+    // reset x and y coordinates
+    this.x = this.page.margins.left;
+    this.y = this.page.margins.top;
+
     // flip PDF coordinate system so that the origin is in
     // the top left rather than the bottom left
     this._ctm = [1, 0, 0, 1, 0, 0];
     this.transform(1, 0, 0, -1, 0, this.page.height);
 
-    // this.emit('pageAdded');
+    this.emit('pageAdded');
 
     return this;
   }
@@ -181,13 +176,30 @@ class PDFDocument extends stream.Readable {
     return this;
   }
 
+  bufferedPageRange() {
+    return { start: this._pageBufferStart, count: this._pageBuffer.length };
+  }
+
+  switchToPage(n) {
+    let page;
+    if (!(page = this._pageBuffer[n - this._pageBufferStart])) {
+      throw new Error(
+        `switchToPage(${n}) out of bounds, current buffer covers pages ${
+          this._pageBufferStart
+        } to ${this._pageBufferStart + this._pageBuffer.length - 1}`
+      );
+    }
+
+    return (this.page = page);
+  }
+
   flushPages() {
     // this local variable exists so we're future-proof against
     // reentrant calls to flushPages.
     const pages = this._pageBuffer;
     this._pageBuffer = [];
     this._pageBufferStart += pages.length;
-    for (let page of Array.from(pages)) {
+    for (let page of pages) {
       this.endPageMarkings(page);
       page.end();
     }
@@ -234,9 +246,8 @@ class PDFDocument extends stream.Readable {
     return ref;
   }
 
-  _read() {
-    // do nothing, but this method is required by node
-  }
+  _read() {}
+  // do nothing, but this method is required by node
 
   _write(data) {
     if (!Buffer.isBuffer(data)) {
@@ -262,6 +273,7 @@ class PDFDocument extends stream.Readable {
 
   end() {
     this.flushPages();
+
     this._info = this.ref();
     for (let key in this.info) {
       let val = this.info[key];
@@ -289,6 +301,8 @@ class PDFDocument extends stream.Readable {
       this.endSubset();
     }
 
+    this.endMetadata();
+
     this._root.end();
     this._root.data.Pages.end();
     this._root.data.Names.end();
@@ -298,15 +312,15 @@ class PDFDocument extends stream.Readable {
       this._root.data.ViewerPreferences.end();
     }
 
-    // if (this._security) {
-    //   this._security.end();
-    // }
+    if (this._security) {
+      this._security.end();
+    }
 
     if (this._waiting === 0) {
       return this._finalize();
+    } else {
+      return (this._ended = true);
     }
-
-    this._ended = true;
   }
 
   _finalize() {
@@ -316,7 +330,7 @@ class PDFDocument extends stream.Readable {
     this._write(`0 ${this._offsets.length + 1}`);
     this._write('0000000000 65535 f ');
 
-    for (let offset of Array.from(this._offsets)) {
+    for (let offset of this._offsets) {
       offset = `0000000000${offset}`.slice(-10);
       this._write(offset + ' 00000 n ');
     }
@@ -328,10 +342,9 @@ class PDFDocument extends stream.Readable {
       Info: this._info,
       ID: [this._id, this._id]
     };
-
-    // if (this._security) {
-    //   trailer.Encrypt = this._security.dictionary;
-    // }
+    if (this._security) {
+      trailer.Encrypt = this._security.dictionary;
+    }
 
     this._write('trailer');
     this._write(PDFObject.convert(trailer));
@@ -353,7 +366,6 @@ const mixin = (methods) => {
   Object.assign(PDFDocument.prototype, methods);
 };
 
-// Load mixins
 mixin(MetadataMixin);
 mixin(ColorMixin);
 mixin(VectorMixin);

packages/pdfkit/src/font_factory.js

@@ -0,0 +1,30 @@
+import fs from 'fs';
+import * as fontkit from 'fontkit';
+import StandardFont from './font/standard';
+import EmbeddedFont from './font/embedded';
+
+class PDFFontFactory {
+  static open(document, src, family, id) {
+    let font;
+    if (typeof src === 'string') {
+      if (StandardFont.isStandardFont(src)) {
+        return new StandardFont(document, src, id);
+      }
+
+      src = fs.readFileSync(src);
+    }
+    if (src instanceof Uint8Array) {
+      font = fontkit.create(src, family);
+    } else if (src instanceof ArrayBuffer) {
+      font = fontkit.create(new Uint8Array(src), family);
+    }
+
+    if (font == null) {
+      throw new Error('Not a supported font format or standard PDF font.');
+    }
+
+    return new EmbeddedFont(document, font, id);
+  }
+}
+
+export default PDFFontFactory;

packages/pdfkit/src/mixins/attachments.js

@@ -1,10 +1,5 @@
 import fs from 'fs';
-// This file is ran directly with Node - needs to have .js extension
-// eslint-disable-next-line import/extensions
-import * as CryptoJS from 'crypto-js/core.js';
-// This file is ran directly with Node - needs to have .js extension
-// eslint-disable-next-line import/extensions
-import MD5 from 'crypto-js/md5.js';
+import CryptoJS from 'crypto-js';
 
 export default {
   /**
@@ -17,10 +12,12 @@ export default {
    *  * options.hidden: if true, do not add attachment to EmbeddedFiles dictionary. Useful for file attachment annotations
    *  * options.creationDate: override creation date
    *  * options.modifiedDate: override modified date
+   *  * options.relationship: Relationship between the PDF document and its attached file. Can be 'Alternative', 'Data', 'Source', 'Supplement' or 'Unspecified'.
    * @returns filespec reference
    */
   file(src, options = {}) {
     options.name = options.name || src;
+    options.relationship = options.relationship || 'Unspecified';
 
     const refBody = {
       Type: 'EmbeddedFile',
@@ -37,12 +34,12 @@ export default {
       data = Buffer.from(new Uint8Array(src));
     } else {
       let match;
-      if ((match = /^data:(.*);base64,(.*)$/.exec(src))) {
+      if ((match = /^data:(.*?);base64,(.*)$/.exec(src))) {
         if (match[1]) {
           refBody.Subtype = match[1].replace('/', '#2F');
         }
         data = Buffer.from(match[2], 'base64');
-      } else if (!BROWSER) {
+      } else {
         data = fs.readFileSync(src);
         if (!data) {
           throw new Error(`Could not read contents of file at filepath ${src}`);
@@ -52,8 +49,6 @@ export default {
         const { birthtime, ctime } = fs.statSync(src);
         refBody.Params.CreationDate = birthtime;
         refBody.Params.ModDate = ctime;
-      } else {
-        throw new Error(`Could not find file ${src}`);
       }
     }
 
@@ -70,7 +65,9 @@ export default {
     }
 
     // add checksum and size information
-    const checksum = MD5(CryptoJS.lib.WordArray.create(new Uint8Array(data)));
+    const checksum = CryptoJS.MD5(
+      CryptoJS.lib.WordArray.create(new Uint8Array(data))
+    );
     refBody.Params.CheckSum = new String(checksum);
     refBody.Params.Size = data.byteLength;
 
@@ -90,6 +87,7 @@ export default {
     // add filespec for embedded file
     const fileSpecBody = {
       Type: 'Filespec',
+      AFRelationship: options.relationship,
       F: new String(options.name),
       EF: { F: ref },
       UF: new String(options.name)
@@ -104,6 +102,13 @@ export default {
       this.addNamedEmbeddedFile(options.name, filespec);
     }
 
+    // Add file to the catalogue to be PDF/A3 compliant
+    if (this._root.data.AF) {
+      this._root.data.AF.push(filespec);
+    } else {
+      this._root.data.AF = [filespec];
+    }
+
     return filespec;
   }
 };
@@ -114,7 +119,8 @@ function isEqual(a, b) {
     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
+    a.Params.CreationDate.getTime() === b.Params.CreationDate.getTime() &&
+    ((a.Params.ModDate === undefined && b.Params.ModDate === undefined) ||
+      a.Params.ModDate.getTime() === b.Params.ModDate.getTime())
   );
 }