pdfmake 0.3.0-beta.1 → 0.3.0-beta.2

package/js/DocMeasure.js

@@ -70,6 +70,8 @@ class DocMeasure {
         return extendMargins(this.measureCanvas(node));
       } else if (node.qr) {
         return extendMargins(this.measureQr(node));
+      } else if (node.attachment) {
+        return extendMargins(this.measureAttachment(node));
       } else {
         throw new Error(`Unrecognized document structure: ${(0, _node.stringifyNode)(node)}`);
       }
@@ -744,6 +746,12 @@ class DocMeasure {
     return node;
   }
 
+  measureAttachment(node) {
+    node._width = node.width || 7;
+    node._height = node.height || 18;
+    return node;
+  }
+
 }
 
 var _default = DocMeasure;

package/js/DocPreprocessor.js

@@ -66,6 +66,8 @@ class DocPreprocessor {
       return this.preprocessCanvas(node);
     } else if (node.qr) {
       return this.preprocessQr(node);
+    } else if (node.attachment) {
+      return this.preprocessAttachment(node);
     } else if (node.pageReference || node.textReference) {
       return this.preprocessText(node);
     } else {
@@ -271,6 +273,10 @@ class DocPreprocessor {
     return node;
   }
 
+  preprocessAttachment(node) {
+    return node;
+  }
+
   _getNodeForNodeRef(node) {
     if (this.parentNode) {
       return this.parentNode;

package/js/ElementWriter.js

@@ -187,6 +187,29 @@ class ElementWriter extends _events.EventEmitter {
     return position;
   }
 
+  addAttachment(attachment, index) {
+    let context = this.context();
+    let page = context.getCurrentPage();
+    let position = this.getCurrentPositionOnPage();
+
+    if (!page || attachment.absolutePosition === undefined && context.availableHeight < attachment._height && page.items.length > 0) {
+      return false;
+    }
+
+    if (attachment._x === undefined) {
+      attachment._x = attachment.x || 0;
+    }
+
+    attachment.x = context.x + attachment._x;
+    attachment.y = context.y;
+    addPageItem(page, {
+      type: 'attachment',
+      item: attachment
+    }, index);
+    context.moveDown(attachment._height);
+    return position;
+  }
+
   alignImage(image) {
     let width = this.context().availableWidth;
     let imageWidth = image._minWidth;

package/js/LayoutBuilder.js

@@ -454,6 +454,8 @@ class LayoutBuilder {
         this.processCanvas(node);
       } else if (node.qr) {
         this.processQr(node);
+      } else if (node.attachment) {
+        this.processAttachment(node);
       } else if (!node._span) {
         throw new Error(`Unrecognized document structure: ${(0, _node.stringifyNode)(node)}`);
       }
@@ -790,6 +792,11 @@ class LayoutBuilder {
     node.positions.push(position);
   }
 
+  processAttachment(node) {
+    let position = this.writer.addAttachment(node);
+    node.positions.push(position);
+  }
+
 }
 
 function decorateNode(node) {

package/js/PDFDocument.js

@@ -22,7 +22,7 @@ const typeName = (bold, italics) => {
 };
 
 class PDFDocument extends _pdfkit.default {
-  constructor(fonts = {}, images = {}, patterns = {}, options = {}, virtualfs = null) {
+  constructor(fonts = {}, images = {}, patterns = {}, attachments = {}, options = {}, virtualfs = null) {
     super(options);
     this.fonts = {};
     this.fontCache = {};
@@ -49,6 +49,7 @@ class PDFDocument extends _pdfkit.default {
     }
 
     this.images = images;
+    this.attachments = attachments;
     this.virtualfs = virtualfs;
   }
 
@@ -147,6 +148,32 @@ class PDFDocument extends _pdfkit.default {
     return null;
   }
 
+  provideAttachment(src) {
+    const checkRequired = obj => {
+      if (!obj) {
+        throw new Error('No attachment');
+      }
+
+      if (!obj.src) {
+        throw new Error('The "src" key is required for attachments');
+      }
+
+      return obj;
+    };
+
+    if (typeof src === 'object') {
+      return checkRequired(src);
+    }
+
+    let attachment = checkRequired(this.attachments[src]);
+
+    if (this.virtualfs && this.virtualfs.existsSync(attachment.src)) {
+      return this.virtualfs.readFileSync(attachment.src);
+    }
+
+    return attachment;
+  }
+
   setOpenActionAsPrint() {
     let printActionRef = this.ref({
       Type: 'Action',

package/js/PageElementWriter.js

@@ -42,6 +42,10 @@ class PageElementWriter extends _ElementWriter.default {
     return this._fitOnPage(() => super.addQr(qr, index));
   }
 
+  addAttachment(attachment, index) {
+    return this._fitOnPage(() => super.addAttachment(attachment, index));
+  }
+
   addVector(vector, ignoreContextX, ignoreContextY, index) {
     return super.addVector(vector, ignoreContextX, ignoreContextY, index);
   }

package/js/Printer.js

@@ -62,6 +62,7 @@ class PdfPrinter {
           docDefinition.version = docDefinition.version || '1.3';
           docDefinition.compress = typeof docDefinition.compress === 'boolean' ? docDefinition.compress : true;
           docDefinition.images = docDefinition.images || {};
+          docDefinition.attachments = docDefinition.attachments || {};
           docDefinition.pageMargins = (0, _variableType.isValue)(docDefinition.pageMargins) ? docDefinition.pageMargins : 40;
           docDefinition.patterns = docDefinition.patterns || {};
           let pageSize = (0, _PageSize.normalizePageSize)(docDefinition.pageSize, docDefinition.pageOrientation);
@@ -78,7 +79,8 @@ class PdfPrinter {
             info: createMetadata(docDefinition),
             font: null
           };
-          this.pdfKitDoc = new _PDFDocument.default(this.fontDescriptors, docDefinition.images, docDefinition.patterns, pdfOptions, this.virtualfs);
+          this.pdfKitDoc = new _PDFDocument.default(this.fontDescriptors, docDefinition.images, docDefinition.patterns, docDefinition.attachments, pdfOptions, this.virtualfs);
+          embedFiles(docDefinition, this.pdfKitDoc);
           const builder = new _LayoutBuilder.default(pageSize, (0, _PageSize.normalizePageMargin)(docDefinition.pageMargins), new _SVGMeasure.default());
           builder.registerTableLayouts(_tableLayouts.tableLayouts);
 
@@ -121,6 +123,20 @@ class PdfPrinter {
 
 
   resolveUrls(docDefinition) {
+    const getExtendedUrl = url => {
+      if (typeof url === 'object') {
+        return {
+          url: url.url,
+          headers: url.headers
+        };
+      }
+
+      return {
+        url: url,
+        headers: {}
+      };
+    };
+
     return new Promise((resolve, reject) => {
       if (this.urlResolver === null) {
         resolve();
@@ -129,19 +145,27 @@ class PdfPrinter {
       for (let font in this.fontDescriptors) {
         if (this.fontDescriptors.hasOwnProperty(font)) {
           if (this.fontDescriptors[font].normal) {
-            this.urlResolver.resolve(this.fontDescriptors[font].normal);
+            let url = getExtendedUrl(this.fontDescriptors[font].normal);
+            this.urlResolver.resolve(url.url, url.headers);
+            this.fontDescriptors[font].normal = url.url;
           }
 
           if (this.fontDescriptors[font].bold) {
-            this.urlResolver.resolve(this.fontDescriptors[font].bold);
+            let url = getExtendedUrl(this.fontDescriptors[font].bold);
+            this.urlResolver.resolve(url.url, url.headers);
+            this.fontDescriptors[font].bold = url.url;
           }
 
           if (this.fontDescriptors[font].italics) {
-            this.urlResolver.resolve(this.fontDescriptors[font].italics);
+            let url = getExtendedUrl(this.fontDescriptors[font].italics);
+            this.urlResolver.resolve(url.url, url.headers);
+            this.fontDescriptors[font].italics = url.url;
           }
 
           if (this.fontDescriptors[font].bolditalics) {
-            this.urlResolver.resolve(this.fontDescriptors[font].bolditalics);
+            let url = getExtendedUrl(this.fontDescriptors[font].bolditalics);
+            this.urlResolver.resolve(url.url, url.headers);
+            this.fontDescriptors[font].bolditalics = url.url;
           }
         }
       }
@@ -149,7 +173,29 @@ class PdfPrinter {
       if (docDefinition.images) {
         for (let image in docDefinition.images) {
           if (docDefinition.images.hasOwnProperty(image)) {
-            this.urlResolver.resolve(docDefinition.images[image]);
+            let url = getExtendedUrl(docDefinition.images[image]);
+            this.urlResolver.resolve(url.url, url.headers);
+            docDefinition.images[image] = url.url;
+          }
+        }
+      }
+
+      if (docDefinition.attachments) {
+        for (let attachment in docDefinition.attachments) {
+          if (docDefinition.attachments.hasOwnProperty(attachment) && docDefinition.attachments[attachment].src) {
+            let url = getExtendedUrl(docDefinition.attachments[attachment].src);
+            this.urlResolver.resolve(url.url, url.headers);
+            docDefinition.attachments[attachment].src = url.url;
+          }
+        }
+      }
+
+      if (docDefinition.files) {
+        for (let file in docDefinition.files) {
+          if (docDefinition.files.hasOwnProperty(file) && docDefinition.files[file].src) {
+            let url = getExtendedUrl(docDefinition.files[file].src);
+            this.urlResolver.resolve(url.url, url.headers);
+            docDefinition.files[file].src = url.url;
           }
         }
       }
@@ -199,6 +245,22 @@ function createMetadata(docDefinition) {
   return info;
 }
 
+function embedFiles(docDefinition, pdfKitDoc) {
+  if (docDefinition.files) {
+    for (const key in docDefinition.files) {
+      const file = docDefinition.files[key];
+      if (!file.src) return;
+
+      if (pdfKitDoc.virtualfs && pdfKitDoc.virtualfs.existsSync(file.src)) {
+        file.src = pdfKitDoc.virtualfs.readFileSync(file.src);
+      }
+
+      file.name = file.name || key;
+      pdfKitDoc.file(file.src, file);
+    }
+  }
+}
+
 function calculatePageHeight(pages, margins) {
   function getItemHeight(item) {
     if (typeof item.item.getHeight === 'function') {

package/js/Renderer.js

@@ -100,6 +100,10 @@ class Renderer {
             this.renderSVG(item.item);
             break;
 
+          case 'attachment':
+            this.renderAttachment(item.item);
+            break;
+
           case 'beginClip':
             this.beginClip(item.item);
             break;
@@ -364,6 +368,21 @@ class Renderer {
     if (image.linkToDestination) {
       this.pdfDocument.goTo(image.x, image.y, image._width, image._height, image.linkToDestination);
     }
+
+    if (image.linkToFile) {
+      const attachment = this.pdfDocument.provideAttachment(image.linkToFile);
+      this.pdfDocument.fileAnnotation(image.x, image.y, image._width, image._height, attachment, // add empty rectangle as file annotation appearance with the same size as the rendered image
+      {
+        AP: {
+          N: {
+            Type: 'XObject',
+            Subtype: 'Form',
+            FormType: 1,
+            BBox: [image.x, image.y, image._width, image._height]
+          }
+        }
+      });
+    }
   }
 
   renderSVG(svg) {
@@ -389,6 +408,17 @@ class Renderer {
     (0, _svgToPdfkit.default)(this.pdfDocument, svg.svg, svg.x, svg.y, options);
   }
 
+  renderAttachment(attachment) {
+    const file = this.pdfDocument.provideAttachment(attachment.attachment);
+    const options = {};
+
+    if (attachment.icon) {
+      options.Name = attachment.icon;
+    }
+
+    this.pdfDocument.fileAnnotation(attachment.x, attachment.y, attachment._width, attachment._height, file, options);
+  }
+
   beginClip(rect) {
     this.pdfDocument.save();
     this.pdfDocument.addContent(`${rect.x} ${rect.y} ${rect.width} ${rect.height} re`);

package/js/URLResolver.js

@@ -9,11 +9,14 @@ var _https = _interopRequireDefault(require("https"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const fetchUrl = url => {
+const fetchUrl = (url, headers = {}) => {
   return new Promise((resolve, reject) => {
     const parsedUrl = new URL(url);
     const h = parsedUrl.protocol === 'https:' ? _https.default : _http.default;
-    h.get(url, res => {
+    let options = {
+      headers: headers
+    };
+    h.get(url, options, res => {
       if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
         // redirect url
         fetchUrl(res.headers.location).then(buffer => {
@@ -43,11 +46,11 @@ class URLResolver {
     this.resolving = {};
   }
 
-  resolve(url) {
+  resolve(url, headers = {}) {
     if (!this.resolving[url]) {
       this.resolving[url] = new Promise((resolve, reject) => {
         if (url.toLowerCase().indexOf('https://') === 0 || url.toLowerCase().indexOf('http://') === 0) {
-          fetchUrl(url).then(buffer => {
+          fetchUrl(url, headers).then(buffer => {
             this.fs.writeFileSync(url, buffer);
             resolve();
           }, result => {

package/js/browser-extensions/URLBrowserResolver.js

@@ -3,10 +3,15 @@
 exports.__esModule = true;
 exports.default = void 0;
 
-const fetchUrl = url => {
+const fetchUrl = (url, headers = {}) => {
   return new Promise((resolve, reject) => {
     const xhr = new XMLHttpRequest();
     xhr.open('GET', url, true);
+
+    for (let headerName in headers) {
+      xhr.setRequestHeader(headerName, headers[headerName]);
+    }
+
     xhr.responseType = 'arraybuffer';
 
     xhr.onreadystatechange = () => {
@@ -53,11 +58,11 @@ class URLBrowserResolver {
     this.resolving = {};
   }
 
-  resolve(url) {
+  resolve(url, headers = {}) {
     if (!this.resolving[url]) {
       this.resolving[url] = new Promise((resolve, reject) => {
         if (url.toLowerCase().indexOf('https://') === 0 || url.toLowerCase().indexOf('http://') === 0) {
-          fetchUrl(url).then(buffer => {
+          fetchUrl(url, headers).then(buffer => {
             this.fs.writeFileSync(url, buffer);
             resolve();
           }, result => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdfmake",
-  "version": "0.3.0-beta.1",
+  "version": "0.3.0-beta.2",
   "description": "Client/server side PDF printing in pure JavaScript",
   "main": "js/index.js",
   "esnext": "src/index.js",

package/src/DocMeasure.js

@@ -61,6 +61,8 @@ class DocMeasure {
 				return extendMargins(this.measureCanvas(node));
 			} else if (node.qr) {
 				return extendMargins(this.measureQr(node));
+			} else if (node.attachment) {
+				return extendMargins(this.measureAttachment(node));
 			} else {
 				throw new Error(`Unrecognized document structure: ${stringifyNode(node)}`);
 			}
@@ -689,6 +691,13 @@ class DocMeasure {
 		node._alignment = this.styleStack.getProperty('alignment');
 		return node;
 	}
+
+	measureAttachment(node) {
+		node._width = node.width || 7;
+		node._height = node.height || 18;
+
+		return node;
+	}
 }
 
 export default DocMeasure;

package/src/DocPreprocessor.js

@@ -55,6 +55,8 @@ class DocPreprocessor {
 			return this.preprocessCanvas(node);
 		} else if (node.qr) {
 			return this.preprocessQr(node);
+		} else if (node.attachment) {
+			return this.preprocessAttachment(node);
 		} else if (node.pageReference || node.textReference) {
 			return this.preprocessText(node);
 		} else {
@@ -246,6 +248,10 @@ class DocPreprocessor {
 		return node;
 	}
 
+	preprocessAttachment(node) {
+		return node;
+	}
+
 	_getNodeForNodeRef(node) {
 		if (this.parentNode) {
 			return this.parentNode;

package/src/ElementWriter.js

@@ -196,6 +196,32 @@ class ElementWriter extends EventEmitter {
 		return position;
 	}
 
+	addAttachment(attachment, index) {
+		let context = this.context();
+		let page = context.getCurrentPage();
+		let position = this.getCurrentPositionOnPage();
+
+		if (!page || (attachment.absolutePosition === undefined && context.availableHeight < attachment._height && page.items.length > 0)) {
+			return false;
+		}
+
+		if (attachment._x === undefined) {
+			attachment._x = attachment.x || 0;
+		}
+
+		attachment.x = context.x + attachment._x;
+		attachment.y = context.y;
+
+		addPageItem(page, {
+			type: 'attachment',
+			item: attachment
+		}, index);
+
+		context.moveDown(attachment._height);
+
+		return position;
+	}
+
 	alignImage(image) {
 		let width = this.context().availableWidth;
 		let imageWidth = image._minWidth;

package/src/LayoutBuilder.js

@@ -439,6 +439,8 @@ class LayoutBuilder {
 				this.processCanvas(node);
 			} else if (node.qr) {
 				this.processQr(node);
+			} else if (node.attachment) {
+				this.processAttachment(node);
 			} else if (!node._span) {
 				throw new Error(`Unrecognized document structure: ${stringifyNode(node)}`);
 			}
@@ -774,6 +776,11 @@ class LayoutBuilder {
 		let position = this.writer.addQr(node);
 		node.positions.push(position);
 	}
+
+	processAttachment(node) {
+		let position = this.writer.addAttachment(node);
+		node.positions.push(position);
+	}
 }
 
 function decorateNode(node) {

package/src/PDFDocument.js

@@ -13,7 +13,7 @@ const typeName = (bold, italics) => {
 };
 
 class PDFDocument extends PDFKit {
-	constructor(fonts = {}, images = {}, patterns = {}, options = {}, virtualfs = null) {
+	constructor(fonts = {}, images = {}, patterns = {}, attachments = {}, options = {}, virtualfs = null) {
 		super(options);
 
 		this.fonts = {};
@@ -41,6 +41,7 @@ class PDFDocument extends PDFKit {
 
 
 		this.images = images;
+		this.attachments = attachments;
 		this.virtualfs = virtualfs;
 	}
 
@@ -134,6 +135,31 @@ class PDFDocument extends PDFKit {
 		return null;
 	}
 
+	provideAttachment(src) {
+		const checkRequired = obj => {
+			if (!obj) {
+				throw new Error('No attachment');
+			}
+			if (!obj.src) {
+				throw new Error('The "src" key is required for attachments');
+			}
+
+			return obj;
+		};
+
+		if (typeof src === 'object') {
+			return checkRequired(src);
+		}
+
+		let attachment = checkRequired(this.attachments[src]);
+
+		if (this.virtualfs && this.virtualfs.existsSync(attachment.src)) {
+			return this.virtualfs.readFileSync(attachment.src);
+		}
+
+		return attachment;
+	}
+
 	setOpenActionAsPrint() {
 		let printActionRef = this.ref({
 			Type: 'Action',

package/src/PageElementWriter.js

@@ -35,6 +35,10 @@ class PageElementWriter extends ElementWriter {
 		return this._fitOnPage(() => super.addQr(qr, index));
 	}
 
+	addAttachment(attachment, index) {
+		return this._fitOnPage(() => super.addAttachment(attachment, index));
+	}
+
 	addVector(vector, ignoreContextX, ignoreContextY, index) {
 		return super.addVector(vector, ignoreContextX, ignoreContextY, index);
 	}

package/src/Printer.js

@@ -49,6 +49,7 @@ class PdfPrinter {
 					docDefinition.version = docDefinition.version || '1.3';
 					docDefinition.compress = typeof docDefinition.compress === 'boolean' ? docDefinition.compress : true;
 					docDefinition.images = docDefinition.images || {};
+					docDefinition.attachments = docDefinition.attachments || {};
 					docDefinition.pageMargins = isValue(docDefinition.pageMargins) ? docDefinition.pageMargins : 40;
 					docDefinition.patterns = docDefinition.patterns || {};
 
@@ -68,7 +69,8 @@ class PdfPrinter {
 						font: null
 					};
 
-					this.pdfKitDoc = new PDFDocument(this.fontDescriptors, docDefinition.images, docDefinition.patterns, pdfOptions, this.virtualfs);
+					this.pdfKitDoc = new PDFDocument(this.fontDescriptors, docDefinition.images, docDefinition.patterns, docDefinition.attachments, pdfOptions, this.virtualfs);
+					embedFiles(docDefinition, this.pdfKitDoc);
 
 					const builder = new LayoutBuilder(pageSize, normalizePageMargin(docDefinition.pageMargins), new SVGMeasure());
 
@@ -108,6 +110,14 @@ class PdfPrinter {
 	 * @returns {Promise}
 	 */
 	resolveUrls(docDefinition) {
+		const getExtendedUrl = url => {
+			if (typeof url === 'object') {
+				return { url: url.url, headers: url.headers };
+			}
+
+			return { url: url, headers: {} };
+		};
+
 		return new Promise((resolve, reject) => {
 			if (this.urlResolver === null) {
 				resolve();
@@ -116,16 +126,24 @@ class PdfPrinter {
 			for (let font in this.fontDescriptors) {
 				if (this.fontDescriptors.hasOwnProperty(font)) {
 					if (this.fontDescriptors[font].normal) {
-						this.urlResolver.resolve(this.fontDescriptors[font].normal);
+						let url = getExtendedUrl(this.fontDescriptors[font].normal);
+						this.urlResolver.resolve(url.url, url.headers);
+						this.fontDescriptors[font].normal = url.url;
 					}
 					if (this.fontDescriptors[font].bold) {
-						this.urlResolver.resolve(this.fontDescriptors[font].bold);
+						let url = getExtendedUrl(this.fontDescriptors[font].bold);
+						this.urlResolver.resolve(url.url, url.headers);
+						this.fontDescriptors[font].bold = url.url;
 					}
 					if (this.fontDescriptors[font].italics) {
-						this.urlResolver.resolve(this.fontDescriptors[font].italics);
+						let url = getExtendedUrl(this.fontDescriptors[font].italics);
+						this.urlResolver.resolve(url.url, url.headers);
+						this.fontDescriptors[font].italics = url.url;
 					}
 					if (this.fontDescriptors[font].bolditalics) {
-						this.urlResolver.resolve(this.fontDescriptors[font].bolditalics);
+						let url = getExtendedUrl(this.fontDescriptors[font].bolditalics);
+						this.urlResolver.resolve(url.url, url.headers);
+						this.fontDescriptors[font].bolditalics = url.url;
 					}
 				}
 			}
@@ -133,7 +151,29 @@ class PdfPrinter {
 			if (docDefinition.images) {
 				for (let image in docDefinition.images) {
 					if (docDefinition.images.hasOwnProperty(image)) {
-						this.urlResolver.resolve(docDefinition.images[image]);
+						let url = getExtendedUrl(docDefinition.images[image]);
+						this.urlResolver.resolve(url.url, url.headers);
+						docDefinition.images[image] = url.url;
+					}
+				}
+			}
+
+			if (docDefinition.attachments) {
+				for (let attachment in docDefinition.attachments) {
+					if (docDefinition.attachments.hasOwnProperty(attachment) && docDefinition.attachments[attachment].src) {
+						let url = getExtendedUrl(docDefinition.attachments[attachment].src);
+						this.urlResolver.resolve(url.url, url.headers);
+						docDefinition.attachments[attachment].src = url.url;
+					}
+				}
+			}
+
+			if (docDefinition.files) {
+				for (let file in docDefinition.files) {
+					if (docDefinition.files.hasOwnProperty(file) && docDefinition.files[file].src) {
+						let url = getExtendedUrl(docDefinition.files[file].src);
+						this.urlResolver.resolve(url.url, url.headers);
+						docDefinition.files[file].src = url.url;
 					}
 				}
 			}
@@ -180,6 +220,23 @@ function createMetadata(docDefinition) {
 	return info;
 }
 
+function embedFiles(docDefinition, pdfKitDoc) {
+	if (docDefinition.files) {
+		for (const key in docDefinition.files) {
+			const file = docDefinition.files[key];
+
+			if (!file.src) return;
+
+			if (pdfKitDoc.virtualfs && pdfKitDoc.virtualfs.existsSync(file.src)) {
+				file.src = pdfKitDoc.virtualfs.readFileSync(file.src);
+			}
+
+			file.name = file.name || key;
+			pdfKitDoc.file(file.src, file);
+		}
+	}
+}
+
 function calculatePageHeight(pages, margins) {
 	function getItemHeight(item) {
 		if (typeof item.item.getHeight === 'function') {