canvas - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

CHANGELOG.md

@@ -14,2 +14,13 @@ # Changelog
 
+2.3.0
+==================
+### Added
+* Add support for multiple PDF page sizes
+* Add support for embedding document metadata in PDFs
+
+### Fixed
+* Don't crash when font string is invalid (bug since 2.2.0) (#1328)
+* Fix memory leak in `canvas.toBuffer()` (#1202, #1296)
+* Fix memory leak in `ctx.font=` (#1202)
+
 2.2.0
@@ -16,0 +27,0 @@ ==================

lib/canvas.js

@@ -76,2 +76,10 @@ 'use strict';
  *
+ * @param {object} [options]
+ * @param {string} [options.title]
+ * @param {string} [options.author]
+ * @param {string} [options.subject]
+ * @param {string} [options.keywords]
+ * @param {string} [options.creator]
+ * @param {Date} [options.creationDate]
+ * @param {Date} [options.modDate]
  * @return {PDFStream}
@@ -81,4 +89,4 @@ * @public
 Canvas.prototype.pdfStream =
-Canvas.prototype.createPDFStream = function(){
-  return new PDFStream(this);
+Canvas.prototype.createPDFStream = function(options){
+  return new PDFStream(this, options);
 };
@@ -85,0 +93,0 @@

package.json

 {
   "name": "canvas",
   "description": "Canvas graphics API backed by Cairo",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "author": "TJ Holowaychuk <[e-mail]>",
@@ -35,3 +35,3 @@ "main": "index.js",
   "binary": {
-    "module_name": "canvas-prebuilt",
+    "module_name": "canvas",
     "module_path": "build/Release",
@@ -43,3 +43,3 @@ "host": "https://github.com/node-gfx/node-canvas-prebuilt/releases/download/",
   "dependencies": {
-    "nan": "^2.11.1",
+    "nan": "^2.12.1",
     "node-pre-gyp": "^0.11.0"
@@ -46,0 +46,0 @@ },

Readme.md

@@ -243,5 +243,6 @@ # node-canvas
 * **callback** If provided, the buffer will be provided in the callback instead of being returned by the function. Invoked with an error as the first argument if encoding failed, or the resulting buffer as the second argument if it succeeded. Not supported for mimeType `raw` or for PDF or SVG canvases.
-* **mimeType** A string indicating the image format. Valid options are `image/png`, `image/jpeg` (if node-canvas was built with JPEG support) and `raw` (unencoded ARGB32 data in native-endian byte order, top-to-bottom). Defaults to `image/png`. If the canvas is a PDF or SVG canvas, this argument is ignored and a PDF or SVG is returned always.
+* **mimeType** A string indicating the image format. Valid options are `image/png`, `image/jpeg` (if node-canvas was built with JPEG support), `raw` (unencoded ARGB32 data in native-endian byte order, top-to-bottom), `application/pdf` (for PDF canvases) and `image/svg+xml` (for SVG canvases). Defaults to `image/png` for image canvases, or the corresponding type for PDF or SVG canvas.
 * **config**
-  * For `image/jpeg` an object specifying the quality (0 to 1), if progressive compression should be used and/or if chroma subsampling should be used: `{quality: 0.75, progressive: false, chromaSubsampling: true}`. All properties are optional.
+  * For `image/jpeg`, an object specifying the quality (0 to 1), if progressive compression should be used and/or if chroma subsampling should be used: `{quality: 0.75, progressive: false, chromaSubsampling: true}`. All properties are optional.
+
   * For `image/png`, an object specifying the ZLIB compression level (between 0 and 9), the compression filter(s), the palette (indexed PNGs only), the the background palette index (indexed PNGs only) and/or the resolution (ppi): `{compressionLevel: 6, filters: canvas.PNG_ALL_FILTERS, palette: undefined, backgroundIndex: 0, resolution: undefined}`. All properties are optional.
@@ -251,2 +252,8 @@
 
+  * For `application/pdf`, an object specifying optional document metadata: `{title: string, author: string, subject: string, keywords: string, creator: string, creationDate: Date, modDate: Date}`. All properties are optional and default to `undefined`, except for `creationDate`, which defaults to the current date. *Adding metadata requires Cairo 1.16.0 or later.*
+
+    For a description of these properties, see page 550 of [PDF 32000-1:2008](https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/PDF32000_2008.pdf).
+
+    Note that there is no standard separator for `keywords`. A space is recommended because it is in common use by other applications, and Cairo will enclose the list of keywords in quotes if a comma or semicolon is used.
+
 **Return value**
@@ -288,5 +295,11 @@
 
-// SVG and PDF canvases ignore the mimeType argument
+// SVG and PDF canvases
 const myCanvas = createCanvas(w, h, 'pdf')
 myCanvas.toBuffer() // returns a buffer containing a PDF-encoded canvas
+// With optional metadata:
+myCanvas.toBuffer('application/pdf', {
+  title: 'my picture',
+  keywords: 'node.js demo cairo',
+  creationDate: new Date()
+})
 ```
@@ -353,3 +366,3 @@
 const stream = canvas.createJPEGStream({
-  quality: 95,
+  quality: 0.95,
   chromaSubsampling: false
@@ -365,2 +378,4 @@ })
 
+* `config` an object specifying optional document metadata: `{title: string, author: string, subject: string, keywords: string, creator: string, creationDate: Date, modDate: Date}`. See `toBuffer()` for more information. *Adding metadata requires Cairo 1.16.0 or later.*
+
 Applies to PDF canvases only. Creates a [`ReadableStream`](https://nodejs.org/api/stream.html#stream_class_stream_readable) that emits the encoded PDF. `canvas.toBuffer()` also produces an encoded PDF, but `createPDFStream()` can be used to reduce memory usage.
@@ -450,4 +465,20 @@
 canvas.createPDFStream() // returns a ReadableStream that emits a PDF
+// With optional document metadata (requires Cairo 1.16.0):
+canvas.toBuffer('application/pdf', {
+  title: 'my picture',
+  keywords: 'node.js demo cairo',
+  creationDate: new Date()
+})
 ```
 
+It is also possible to create pages with different sizes by passing `width` and `height` to the `.addPage()` method:
+
+```js
+ctx.font = '22px Helvetica'
+ctx.fillText('Hello World', 50, 80)
+ctx.addPage(400, 800)
+
+ctx.fillText('Hello World 2', 50, 80)
+```
+
 See also:
@@ -462,3 +493,3 @@
 
-node-canvas can create SVG documents instead of images. The canva type must be set when creating the canvas as follows:
+node-canvas can create SVG documents instead of images. The canvas type must be set when creating the canvas as follows:
 
@@ -517,2 +548,14 @@ ```js
 
+## Testing
+
+First make sure you've built the latest version. Get all the deps you need (see [compiling](#compiling) above), and run:
+
+```
+npm install --build-from-source
+```
+
+For visual tests: `npm run test-server` and point your browser to http://localhost:4000.
+
+For unit tests: `npm run test`.
+
 ## Benchmarks
@@ -519,0 +562,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

350549

increased by0.69%

Lines of code

1278

increased by0.63%

Number of lines in readme file

598

increased by7.75%

Worsened metrics

Number of package files

61

decreased by-3.17%

Dependency changes

• Updatednan@^2.12.1