Merge branch 'master' into pr/1437

.babelrc

@@ -5,7 +5,7 @@
       {
         "modules": false,
         "targets": {
-          "node": "6.10"
+          "node": "18"
         }
       }
     ]
@@ -17,11 +17,11 @@
           "@babel/preset-env",
           {
             "targets": {
-              "node": "6.10"
+              "node": "18"
             }
           }
         ]
       ]
     }
   }
-}
+}

.github/workflows/lint-test.yml

@@ -7,23 +7,22 @@ on: [push, pull_request]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Install dependencies
-      run: yarn --frozen-lockfile
-    - name: Run ESLint
-      run: npm run lint
-    - name: Run tests
-      run: npm test
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+      - name: Run ESLint
+        run: npm run lint
+      - name: Run tests
+        run: npm test

CHANGELOG.md

@@ -2,7 +2,39 @@
 
 ### Unreleased
 
+- Update fontkit to 2.0
+- Update linebreak to 1.1
+
+### [v0.15.2] - 2024-12-15
+
+- Fix index not counting when rendering ordered lists (#1517)
+- Fix PDF/A3 compliance of attachments
+- Fix CIDSet generation only for PDF/A1 subset
+- Fix missing acroform font dictionary
+- Fix modify time comparison check equality embedded files
+
+### [v0.15.1] - 2024-10-30
+
+- Fix browserify transform sRGB_IEC61966_2_1.icc file
+- Fix time comparison check equality embedded files
+
+### [v0.15.0] - 2024-03-23
+
+- Add subset for PDF/UA
+- Fix for line breaks in list items (#1486)
+- Fix for soft hyphen not being replaced by visible hyphen if necessary (#457)
+- Optimize output files by ignoring identity transforms
+- Fix for Acroforms - setting an option to false will still apply the flag (#1495)
+- Fix for text extraction in PDFium-based viewers due to invalid ToUnicodeMap (#1498)
+- Remove deprecated `write` method
+- Drop support for Node.js < 18 and for browsers released before 2020
+
+### [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)
+
+- Add support for EXIF orientation on JPEG images (#626 and #1353)
 
 ### [v0.13.0] - 2021-10-24
 

README.md

@@ -31,7 +31,7 @@ Installation uses the [npm](http://npmjs.org/) package manager. Just type the fo
   - Transformations
   - Linear and radial gradients
 - Text
-  - Line wrapping
+  - Line wrapping (with soft hyphen recognition)
   - Text alignments
   - Bulleted lists
 - Font embedding
@@ -129,7 +129,7 @@ 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](https://github.com/blikblum/pdfkit-webpack-example).
+- Use [webpack](https://webpack.js.org/). See [complete example](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

docs/accessibility.md

@@ -14,6 +14,8 @@ Universal Accessibility) document (which is an extension of Tagged PDF):
  * Pass the option `pdfVersion: '1.5'` (or a higher version) when creating your `PDFDocument`
    (depending on the features you use, you may only need 1.4; refer to the PDF reference for
    details).
+ * Pass the option `subset: 'PDF/UA'` when creating your `PDFDocument` (if you wish the PDF to
+   be identified as PDF/UA-1).
  * Pass the option `tagged: true` when creating your `PDFDocument` (technically, this sets the
    `Marked` property in the `Markings` dictionary to `true` in the PDF).
  * Provide a `Title` in the `info` option, and pass `displayTitle: true` when creating your

docs/attachments.md

@@ -24,6 +24,7 @@ There are a few other options for `doc.file`:
 * `hidden` - if true, do not show file in the list of embedded files
 * `creationDate` - override the date and time the file was created
 * `modifiedDate` - override the date and time the file was last updated
+* `relationship` - relationship between the PDF document and its attached file. Can be 'Alternative', 'Data', 'Source', 'Supplement' or 'Unspecified'.
 
 If you are attaching a file from your file system, creationDate and modifiedDate will be set to the source file's creationDate and modifiedDate.
 

docs/getting_started.md

@@ -14,7 +14,7 @@ in your JavaScript source file and create an instance of the
 `PDFDocument` class.
 
     const PDFDocument = require('pdfkit');
-    const doc = new PDFDocument;
+    const doc = new PDFDocument();
 
 `PDFDocument` instances are readable Node streams. They don't get saved anywhere automatically,
 but you can call the `pipe` method to send the output of the PDF document to another
@@ -287,6 +287,8 @@ For PDF/A-2 and PDF/A-3, the `pdfVersion` needs to be set to at least `1.7` and
 
 In order to verify the generated document for PDF/A and its subsets conformance, veraPDF is an excellent open source validator.
 
+Please note that PDF/A requires fonts to be embedded, as such the standard fonts PDFKit comes with cannot be used because they are in AFM format, which only provides neccessary metrics, without the font data. You should use `registerFont()` and use embeddable fonts such as `ttf`.
+
 ### Adding content
 
 Once you've created a `PDFDocument` instance, you can add content to the

docs/images.md

@@ -7,21 +7,22 @@ rendered at the current point in the text flow (below the last line of text).
 Otherwise, it is positioned absolutely at the specified point. The image will
 be scaled according to the following options.
 
-* Neither `width` or `height` provided - image is rendered at full size
-* `width` provided but not `height` - image is scaled proportionally to fit in the provided `width`
-* `height` provided but not `width` - image is scaled proportionally to fit in the provided `height`
-* Both `width` and `height` provided - image is stretched to the dimensions provided
-* `scale` factor provided - image is scaled proportionally by the provided scale factor
-* `fit` array provided - image is scaled proportionally to fit within the passed width and height
-* `cover` array provided - image is scaled proportionally to completely cover the rectangle defined by the passed width and height
-* `link` - a URL to link this image to (shortcut to create an annotation)
-* `goTo` - go to anchor (shortcut to create an annotation)
-* `destination` - create anchor to this image
+- Neither `width` or `height` provided - image is rendered at full size
+- `width` provided but not `height` - image is scaled proportionally to fit in the provided `width`
+- `height` provided but not `width` - image is scaled proportionally to fit in the provided `height`
+- Both `width` and `height` provided - image is stretched to the dimensions provided
+- `scale` factor provided - image is scaled proportionally by the provided scale factor
+- `fit` array provided - image is scaled proportionally to fit within the passed width and height
+- `cover` array provided - image is scaled proportionally to completely cover the rectangle defined by the passed width and height
+- `link` - a URL to link this image to (shortcut to create an annotation)
+- `goTo` - go to anchor (shortcut to create an annotation)
+- `destination` - create anchor to this image
+- `ignoreOrientation` - (true/false) ignore JPEG EXIF orientation. By default, images with JPEG EXIF orientation are properly rotated and/or flipped. Defaults to `false`, unless `ignoreOrientation` option set to `true` when creating the `PDFDocument` object (e.g. `new PDFDocument({ignoreOrientation: true})`)
 
 When a `fit` or `cover` array is provided, PDFKit accepts these additional options:
 
-* `align` - horizontally align the image, the possible values are `'left'`, `'center'` and `'right'`
-* `valign` - vertically align the image, the possible values are `'top'`, `'center'` and `'bottom'`
+- `align` - horizontally align the image, the possible values are `'left'`, `'center'` and `'right'`
+- `valign` - vertically align the image, the possible values are `'top'`, `'center'` and `'bottom'`
 
 Here is an example showing some of these options.
 
@@ -48,11 +49,11 @@ Here is an example showing some of these options.
        .rect(430, 15, 100, 100).stroke()
        .text('Centered', 430, 0);
 
-* * *
+---
 
 This example produces the following output:
 
-![0](images/images.png "400")
+![0](images/images.png '400')
 
 That is all there is to adding images to your PDF documents with PDFKit. Now
 let's look at adding outlines.

examples/kitchen-sink.js

@@ -1,4 +1,4 @@
-var PDFDocument = require('../js/pdfkit');
+var PDFDocument = require('../');
 var tiger = require('./tiger');
 var fs = require('fs');
 

examples/webpack/README.md

@@ -14,7 +14,7 @@ Simple example of using PdfKit with webpack
 [`webpack.config.js`](webpack.config.js)
 
 - add alias to map `fs` calls to pdfkit virtual file system [implementation](../../lib/virtual-fs.js)
-- ignore iconv-lite and crypto packages to save bundle file size
+- ignore crypto package to save bundle file size
 - add aliases to native node packages (buffer, stream, zlib, util, assert)
 - configure `*.afm` files to be imported as text
 - configure all files in `src/static-assets` folder to be imported encoded as base64

examples/webpack/package.json

@@ -1,21 +1,20 @@
 {
   "license": "MIT",
   "dependencies": {
-    "assert": "^2.0.0",
+    "assert": "^2.1.0",
     "brace": "^0.11.1",
     "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
-    "pdfkit": "^0.12.3",
+    "pdfkit": "^0.15.0",
     "process": "^0.11.10",
-    "readable-stream": "^3.6.0",
-    "util": "^0.12.4"
+    "readable-stream": "^4.5.2",
+    "util": "^0.12.5"
   },
   "devDependencies": {
-    "brfs": "^2.0.2",
-    "html-webpack-plugin": "^5.3.2",
+    "html-webpack-plugin": "^5.6.0",
     "transform-loader": "^0.2.4",
-    "webpack": "^5.44.0",
-    "webpack-cli": "^4.7.2"
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4"
   },
   "scripts": {
     "dev": "webpack --mode development",

examples/webpack/webpack.config.js

@@ -13,11 +13,10 @@ module.exports = {
     })
   ],
   resolve: {
+    symlinks: false,
     alias: {
       // maps fs to a virtual one allowing to register file content dynamically
-      fs: 'pdfkit/js/virtual-fs.js',
-      // iconv-lite is used to load cid less fonts (not spec compliant)
-      'iconv-lite': false
+      fs: __dirname + '/../../js/virtual-fs.js'
     },
     fallback: {
       // crypto module is not necessary at browser
@@ -48,23 +47,6 @@ module.exports = {
       {
         test: /src[/\\]lazy-assets/,
         type: 'asset/resource'
-      },
-      // convert to base64 and include inline file system binary files used by fontkit and linebreak
-      {
-        enforce: 'post',
-        test: /fontkit[/\\]index.js$/,
-        loader: 'transform-loader',
-        options: {
-          brfs: {}
-        }
-      },
-      {
-        enforce: 'post',
-        test: /linebreak[/\\]src[/\\]linebreaker.js/,
-        loader: 'transform-loader',
-        options: {
-          brfs: {}
-        }
       }
     ]
   }

lib/document.js

@@ -4,7 +4,6 @@ By Devon Govett
 */
 
 import stream from 'stream';
-import fs from 'fs';
 import PDFObject from './object';
 import PDFReference from './reference';
 import PDFPage from './page';
@@ -220,7 +219,9 @@ class PDFDocument extends stream.Readable {
   addNamedEmbeddedFile(name, ref) {
     if (!this._root.data.Names.data.EmbeddedFiles) {
       // disabling /Limits for this tree fixes attachments not showing in Adobe Reader
-      this._root.data.Names.data.EmbeddedFiles = new PDFNameTree({ limits: false });
+      this._root.data.Names.data.EmbeddedFiles = new PDFNameTree({
+        limits: false
+      });
     }
 
     // add filespec to EmbeddedFiles
@@ -270,20 +271,6 @@ class PDFDocument extends stream.Readable {
     }
   }
 
-  write(filename, fn) {
-    // print a deprecation warning with a stacktrace
-    const err = new Error(`\
-PDFDocument#write is deprecated, and will be removed in a future version of PDFKit. \
-Please pipe the document into a Node stream.\
-`);
-
-    console.warn(err.stack);
-
-    this.pipe(fs.createWriteStream(filename));
-    this.end();
-    return this.once('end', fn);
-  }
-
   end() {
     this.flushPages();
 

lib/font/embedded.js

@@ -128,10 +128,7 @@ class EmbeddedFont extends PDFFont {
       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
@@ -183,7 +180,7 @@ class EmbeddedFont extends PDFFont {
       descriptor.data.FontFile2 = fontFile;
     }
 
-    if (this.document.subset) {
+    if (this.document.subset && this.document.subset === 1) {
       const CIDSet = Buffer.from('FFFFFFFFC0', 'hex');
       const CIDSetRef = this.document.ref();
       CIDSetRef.write(CIDSet);
@@ -252,6 +249,15 @@ class EmbeddedFont extends PDFFont {
       entries.push(`<${encoded.join(' ')}>`);
     }
 
+    const chunkSize = 256;
+    const chunks = Math.ceil(entries.length / chunkSize);
+    const ranges = [];
+    for (let i = 0; i < chunks; i++) {
+      const start = i * chunkSize;
+      const end = Math.min((i + 1) * chunkSize, entries.length);
+      ranges.push(`<${toHex(start)}> <${toHex(end - 1)}> [${entries.slice(start, end).join(' ')}]`);
+    }
+
     cmap.end(`\
 /CIDInit /ProcSet findresource begin
 12 dict begin
@@ -267,7 +273,7 @@ begincmap
 <0000><ffff>
 endcodespacerange
 1 beginbfrange
-<0000> <${toHex(entries.length - 1)}> [${entries.join(' ')}]
+${ranges.join('\n')}
 endbfrange
 endcmap
 CMapName currentdict /CMap defineresource pop

lib/font_factory.js

@@ -1,5 +1,5 @@
 import fs from 'fs';
-import fontkit from 'fontkit';
+import * as fontkit from 'fontkit';
 import StandardFont from './font/standard';
 import EmbeddedFont from './font/embedded';
 
@@ -13,12 +13,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) {