pdfkit 0.8.3 → 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+## pdfkit changelog
+
+### Unreleased
+
+### [v0.11.0] - 2019-12-03
+
+- Fix infinite loop when an individual character is bigger than the width of the text.
+- Fix infinite loop when text is positioned after page right margin
+- Allow links in continued text to be stopped by setting link to null
+- Add support to interlaced PNG files
+- Do not emit \_interopDefault helper in commonjs build
+- Fix gradient with multiple stops (#1045)
+- Set link annotation flag to print by default
+- Add support for AcroForms
+- Drop support for (uncommon) cid less fonts on standalone build (reduces bundle size)
+
+### [v0.10.0] - 2019-06-06
+
+- Fix links to pages within the document
+- Add support for named destinations
+- Throw errors when `dash(...)` is passed invalid lengths
+- Remove PDFDocument#output method
+- Add standalone build (js/pdfkit.standalone.js)
+
+### [v0.9.1] - 2019-04-30
+
+- Fix setting printing permission
+- Fix corruption of string objects in browser
+- Add option to set default font
+- Remove call to fontkit.openSync
+- Add standalone virtual file system implementation
+- Add option (fontLayoutCache) to disable font layout cache
+
+### [v0.9.0] - 2019-1-28
+
+- Convert to code base from coffescript to ES6+
+- Fix loading grayscale / transparent PNG files
+- Reduce number of calls to async functions
+- Implement encryption / access control

package/README.md

@@ -2,164 +2,174 @@
 
 A JavaScript PDF generation library for Node and the browser.
 
-[![](https://img.shields.io/gratipay/devongovett.svg)](https://gratipay.com/devongovett)
-
 ## Description
 
-PDFKit is a PDF document generation library for Node and the browser that makes creating complex, multi-page, printable documents easy. 
-It's written in CoffeeScript, but you can choose to use the API in plain 'ol JavaScript if you like. The API embraces 
-chainability, and includes both low level functions as well as abstractions for higher level functionality. The PDFKit API 
-is designed to be simple, so generating complex documents is often as simple as a few function calls.
+PDFKit is a PDF document generation library for Node and the browser that makes creating complex, multi-page, printable
+documents easy. The API embraces chainability, and includes both low level functions as well as abstractions for higher
+level functionality. The PDFKit API is designed to be simple, so generating complex documents is often as simple as
+a few function calls.
 
 Check out some of the [documentation and examples](http://pdfkit.org/docs/getting_started.html) to see for yourself!
 You can also read the guide as a [self-generated PDF](http://pdfkit.org/docs/guide.pdf) with example output displayed inline.
-If you'd like to see how it was generated, check out the README in the [docs](https://github.com/devongovett/pdfkit/tree/master/docs)
+If you'd like to see how it was generated, check out the README in the [docs](https://github.com/foliojs/pdfkit/tree/master/docs)
 folder.
 
 You can also try out an interactive in-browser demo of PDFKit [here](http://pdfkit.org/demo/browser.html).
 
 ## Installation
 
-Installation uses the [npm](http://npmjs.org/) package manager.  Just type the following command after installing npm.
+Installation uses the [npm](http://npmjs.org/) package manager. Just type the following command after installing npm.
 
     npm install pdfkit
 
 ## Features
 
-* Vector graphics
-  * HTML5 canvas-like API
-  * Path operations
-  * SVG path parser for easy path creation
-  * Transformations
-  * Linear and radial gradients
-* Text
-  * Line wrapping
-  * Text alignments
-  * Bulleted lists
-* Font embedding
-  * Supports TrueType (.ttf), OpenType (.otf), WOFF, WOFF2, TrueType Collections (.ttc), and Datafork TrueType (.dfont) fonts
-  * Font subsetting
-  * See [fontkit](http://github.com/devongovett/fontkit) for more details on advanced glyph layout support.
-* Image embedding
-  * Supports JPEG and PNG files (including indexed PNGs, and PNGs with transparency)
-* Annotations
-  * Links
-  * Notes
-  * Highlights
-  * Underlines
-  * etc.
-  
+- Vector graphics
+  - HTML5 canvas-like API
+  - Path operations
+  - SVG path parser for easy path creation
+  - Transformations
+  - Linear and radial gradients
+- Text
+  - Line wrapping
+  - Text alignments
+  - Bulleted lists
+- Font embedding
+  - Supports TrueType (.ttf), OpenType (.otf), WOFF, WOFF2, TrueType Collections (.ttc), and Datafork TrueType (.dfont) fonts
+  - Font subsetting
+  - See [fontkit](http://github.com/foliojs/fontkit) for more details on advanced glyph layout support.
+- Image embedding
+  - Supports JPEG and PNG files (including indexed PNGs, and PNGs with transparency)
+- Annotations
+  - Links
+  - Notes
+  - Highlights
+  - Underlines
+  - etc.
+- AcroForms
+- Outlines
+- PDF security
+  - Encryption
+  - Access privileges (printing, copying, modifying, annotating, form filling, content accessibility, document assembly)
+
 ## Coming soon!
 
-* Patterns fills
-* Outlines
-* PDF Security
-* Higher level APIs for creating tables and laying out content
-* More performance optimizations
-* Even more awesomeness, perhaps written by you! Please fork this repository and send me pull requests.
-    
+- Patterns fills
+- Higher level APIs for creating tables and laying out content
+- More performance optimizations
+- Even more awesomeness, perhaps written by you! Please fork this repository and send me pull requests.
+
 ## Example
 
-```coffeescript
-PDFDocument = require 'pdfkit'
+```javascript
+const PDFDocument = require('pdfkit');
+const fs = require('fs');
 
-# Create a document
-doc = new PDFDocument
+// Create a document
+const doc = new PDFDocument();
 
-# Pipe its output somewhere, like to a file or HTTP response
-# See below for browser usage
-doc.pipe fs.createWriteStream('output.pdf')
+// Pipe its output somewhere, like to a file or HTTP response
+// See below for browser usage
+doc.pipe(fs.createWriteStream('output.pdf'));
 
-# Embed a font, set the font size, and render some text
-doc.font('fonts/PalatinoBold.ttf')
-   .fontSize(25)
-   .text('Some text with an embedded font!', 100, 100)
+// Embed a font, set the font size, and render some text
+doc
+  .font('fonts/PalatinoBold.ttf')
+  .fontSize(25)
+  .text('Some text with an embedded font!', 100, 100);
 
-# Add an image, constrain it to a given size, and center it vertically and horizontally
+// Add an image, constrain it to a given size, and center it vertically and horizontally
 doc.image('path/to/image.png', {
-   fit: [250, 300],
-   align: 'center',
-   valign: 'center'
+  fit: [250, 300],
+  align: 'center',
+  valign: 'center'
 });
 
-# Add another page
-doc.addPage()
-   .fontSize(25)
-   .text('Here is some vector graphics...', 100, 100)
-
-# Draw a triangle
-doc.save()
-   .moveTo(100, 150)
-   .lineTo(100, 250)
-   .lineTo(200, 250)
-   .fill("#FF3300")
-
-# Apply some transforms and render an SVG path with the 'even-odd' fill rule
-doc.scale(0.6)
-   .translate(470, -380)
-   .path('M 250,75 L 323,301 131,161 369,161 177,301 z')
-   .fill('red', 'even-odd')
-   .restore()
-
-# Add some text with annotations
-doc.addPage()
-   .fillColor("blue")
-   .text('Here is a link!', 100, 100)
-   .underline(100, 100, 160, 27, color: "#0000FF")
-   .link(100, 100, 160, 27, 'http://google.com/')
-
-# Finalize PDF file
-doc.end()
+// Add another page
+doc
+  .addPage()
+  .fontSize(25)
+  .text('Here is some vector graphics...', 100, 100);
+
+// Draw a triangle
+doc
+  .save()
+  .moveTo(100, 150)
+  .lineTo(100, 250)
+  .lineTo(200, 250)
+  .fill('#FF3300');
+
+// Apply some transforms and render an SVG path with the 'even-odd' fill rule
+doc
+  .scale(0.6)
+  .translate(470, -380)
+  .path('M 250,75 L 323,301 131,161 369,161 177,301 z')
+  .fill('red', 'even-odd')
+  .restore();
+
+// Add some text with annotations
+doc
+  .addPage()
+  .fillColor('blue')
+  .text('Here is a link!', 100, 100)
+  .underline(100, 100, 160, 27, { color: '#0000FF' })
+  .link(100, 100, 160, 27, 'http://google.com/');
+
+// Finalize PDF file
+doc.end();
 ```
- 
-[The PDF output from this example](http://pdfkit.org/demo/out.pdf) (with a few additions) shows the power of PDFKit — producing 
-complex documents with a very small amount of code.  For more, see the `demo` folder and the 
+
+[The PDF output from this example](http://pdfkit.org/demo/out.pdf) (with a few additions) shows the power of PDFKit — producing
+complex documents with a very small amount of code. For more, see the `demo` folder and the
 [PDFKit programming guide](http://pdfkit.org/docs/getting_started.html).
 
 ## Browser Usage
 
-There are two ways to use PDFKit in the browser.  The first is to use [Browserify](http://browserify.org/),
-which is a Node module packager for the browser with the familiar `require` syntax.  The second is to use
-a prebuilt version of PDFKit, which you can [download from Github](https://github.com/devongovett/pdfkit/releases).
+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 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 
+In addition to PDFKit, you'll need somewhere to stream the output to. HTML5 has a
 [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) object which can be used to store binary data, and
-get URLs to this data in order to display PDF output inside an iframe, or upload to a server, etc.  In order to 
+get URLs to this data in order to display PDF output inside an iframe, or upload to a server, etc. In order to
 get a Blob from the output of PDFKit, you can use the [blob-stream](https://github.com/devongovett/blob-stream)
 module.
 
-The following example uses Browserify to load `PDFKit` and `blob-stream`, but if you're not using Browserify, 
-you can load them in whatever way you'd like (e.g. script tags).
+The following example uses Browserify or webpack to load `PDFKit` and `blob-stream`. See [here](https://codepen.io/blikblum/pen/gJNWMg?editors=1010) and [here](https://codepen.io/blikblum/pen/YboVNq?editors=1010) for examples
+of prebuilt version usage.
 
-```coffeescript
-# require dependencies
-PDFDocument = require 'pdfkit'
-blobStream  = require 'blob-stream'
+```javascript
+// require dependencies
+const PDFDocument = require('pdfkit');
+const blobStream = require('blob-stream');
 
-# create a document the same way as above
-doc = new PDFDocument
+// create a document the same way as above
+const doc = new PDFDocument();
 
-# pipe the document to a blob
-stream = doc.pipe(blobStream())
+// pipe the document to a blob
+const stream = doc.pipe(blobStream());
 
-# add your content to the document here, as usual
+// add your content to the document here, as usual
 
-# get a blob when you're done
-doc.end()
-stream.on 'finish', ->
-  # get a blob you can do whatever you like with
-  blob = stream.toBlob('application/pdf')
+// get a blob when you're done
+doc.end();
+stream.on('finish', function() {
+  // get a blob you can do whatever you like with
+  const blob = stream.toBlob('application/pdf');
 
-  # or get a blob URL for display in the browser
-  url = stream.toBlobURL('application/pdf')
-  iframe.src = url
+  // or get a blob URL for display in the browser
+  const url = stream.toBlobURL('application/pdf');
+  iframe.src = url;
+});
 ```
 
 You can see an interactive in-browser demo of PDFKit [here](http://pdfkit.org/demo/browser.html).
 
-Note that in order to Browserify a project using PDFKit, you need to install the `brfs` module with npm, 
-which is used to load built-in font data into the package. It is listed as a `devDependency` in 
-PDFKit's `package.json`, so it isn't installed by default for Node users. 
+Note that in order to Browserify a project using PDFKit, you need to install the `brfs` module with npm,
+which is used to load built-in font data into the package. It is listed as a `devDependency` in
+PDFKit's `package.json`, so it isn't installed by default for Node users.
 If you forget to install it, Browserify will print an error message.
 
 ## Documentation