pdfmake 0.3.3 → 0.3.4

package/js/OutputDocument.js

@@ -3,8 +3,8 @@
 exports.__esModule = true;
 exports.default = void 0;
 class OutputDocument {
-  /**
-   * @param {Promise<object>} pdfDocumentPromise
+  /**
+   * @param {Promise<object>} pdfDocumentPromise
    */
   constructor(pdfDocumentPromise) {
     this.bufferSize = 1073741824;
@@ -12,15 +12,15 @@ class OutputDocument {
     this.bufferPromise = null;
   }
 
-  /**
-   * @returns {Promise<object>}
+  /**
+   * @returns {Promise<object>}
    */
   getStream() {
     return this.pdfDocumentPromise;
   }
 
-  /**
-   * @returns {Promise<Buffer>}
+  /**
+   * @returns {Promise<Buffer>}
    */
   getBuffer() {
     const getBufferInternal = async () => {
@@ -45,16 +45,16 @@ class OutputDocument {
     return this.bufferPromise;
   }
 
-  /**
-   * @returns {Promise<string>}
+  /**
+   * @returns {Promise<string>}
    */
   async getBase64() {
     const buffer = await this.getBuffer();
     return buffer.toString('base64');
   }
 
-  /**
-   * @returns {Promise<string>}
+  /**
+   * @returns {Promise<string>}
    */
   async getDataUrl() {
     const data = await this.getBase64();

package/js/OutputDocumentServer.js

@@ -6,9 +6,9 @@ var _OutputDocument = _interopRequireDefault(require("./OutputDocument"));
 var _fs = _interopRequireDefault(require("fs"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class OutputDocumentServer extends _OutputDocument.default {
-  /**
-   * @param {string} filename
-   * @returns {Promise}
+  /**
+   * @param {string} filename
+   * @returns {Promise}
    */
   async write(filename) {
     const stream = await this.getStream();

package/js/PDFDocument.js

@@ -102,9 +102,9 @@ class PDFDocument extends _pdfkit.default {
     return image;
   }
 
-  /**
-   * @param {Array} color pdfmake format: [<pattern name>, <color>]
-   * @returns {Array} pdfkit format: [<pattern object>, <color>]
+  /**
+   * @param {Array} color pdfmake format: [<pattern name>, <color>]
+   * @returns {Array} pdfkit format: [<pattern object>, <color>]
    */
   providePattern(color) {
     if (Array.isArray(color) && color.length === 2) {

package/js/PageElementWriter.js

@@ -6,17 +6,17 @@ var _ElementWriter = _interopRequireDefault(require("./ElementWriter"));
 var _PageSize = require("./PageSize");
 var _DocumentContext = _interopRequireDefault(require("./DocumentContext"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * An extended ElementWriter which can handle:
- * - page-breaks (it adds new pages when there's not enough space left),
- * - repeatable fragments (like table-headers, which are repeated everytime
- *                         a page-break occurs)
- * - transactions (used for unbreakable-blocks when we want to make sure
- *                 whole block will be rendered on the same page)
+/**
+ * An extended ElementWriter which can handle:
+ * - page-breaks (it adds new pages when there's not enough space left),
+ * - repeatable fragments (like table-headers, which are repeated everytime
+ *                         a page-break occurs)
+ * - transactions (used for unbreakable-blocks when we want to make sure
+ *                 whole block will be rendered on the same page)
  */
 class PageElementWriter extends _ElementWriter.default {
-  /**
-   * @param {DocumentContext} context
+  /**
+   * @param {DocumentContext} context
    */
   constructor(context) {
     super(context);
@@ -50,6 +50,12 @@ class PageElementWriter extends _ElementWriter.default {
   endClip() {
     return super.endClip();
   }
+  beginVerticalAlignment(verticalAlignment) {
+    return super.beginVerticalAlignment(verticalAlignment);
+  }
+  endVerticalAlignment(verticalAlignment) {
+    return super.endVerticalAlignment(verticalAlignment);
+  }
   addFragment(fragment, useBlockXOffset, useBlockYOffset, dontUpdateContextPosition) {
     return this._fitOnPage(() => super.addFragment(fragment, useBlockXOffset, useBlockYOffset, dontUpdateContextPosition));
   }

package/js/Printer.js

@@ -11,26 +11,26 @@ var _Renderer = _interopRequireDefault(require("./Renderer"));
 var _variableType = require("./helpers/variableType");
 var _tools = require("./helpers/tools");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * Printer which turns document definition into a pdf
- *
- * @example
- * var fontDescriptors = {
- *	Roboto: {
- *		normal: 'fonts/Roboto-Regular.ttf',
- *		bold: 'fonts/Roboto-Medium.ttf',
- *		italics: 'fonts/Roboto-Italic.ttf',
- *		bolditalics: 'fonts/Roboto-MediumItalic.ttf'
- *	}
- * };
- *
- * var printer = new PdfPrinter(fontDescriptors);
+/**
+ * Printer which turns document definition into a pdf
+ *
+ * @example
+ * var fontDescriptors = {
+ *	Roboto: {
+ *		normal: 'fonts/Roboto-Regular.ttf',
+ *		bold: 'fonts/Roboto-Medium.ttf',
+ *		italics: 'fonts/Roboto-Italic.ttf',
+ *		bolditalics: 'fonts/Roboto-MediumItalic.ttf'
+ *	}
+ * };
+ *
+ * var printer = new PdfPrinter(fontDescriptors);
  */
 class PdfPrinter {
-  /**
-   * @param {object} fontDescriptors font definition dictionary
-   * @param {object} virtualfs
-   * @param {object} urlResolver
+  /**
+   * @param {object} fontDescriptors font definition dictionary
+   * @param {object} virtualfs
+   * @param {object} urlResolver
    */
   constructor(fontDescriptors, virtualfs = null, urlResolver = null) {
     this.fontDescriptors = fontDescriptors;
@@ -38,13 +38,13 @@ class PdfPrinter {
     this.urlResolver = urlResolver;
   }
 
-  /**
-   * Executes layout engine for the specified document and renders it into a pdfkit document
-   * ready to be saved.
-   *
-   * @param {object} docDefinition
-   * @param {object} options
-   * @returns {Promise<PDFDocument>} resolved promise return a pdfkit document
+  /**
+   * Executes layout engine for the specified document and renders it into a pdfkit document
+   * ready to be saved.
+   *
+   * @param {object} docDefinition
+   * @param {object} options
+   * @returns {Promise<PDFDocument>} resolved promise return a pdfkit document
    */
   async createPdfKitDocument(docDefinition, options = {}) {
     await this.resolveUrls(docDefinition);
@@ -109,9 +109,9 @@ class PdfPrinter {
     return this.pdfKitDoc;
   }
 
-  /**
-   * @param {object} docDefinition
-   * @returns {Promise}
+  /**
+   * @param {object} docDefinition
+   * @returns {Promise}
    */
   async resolveUrls(docDefinition) {
     const getExtendedUrl = url => {

package/js/Renderer.js

@@ -19,14 +19,14 @@ const findFont = (fonts, requiredFonts, defaultFont) => {
   return defaultFont;
 };
 
-/**
- * Shift the "y" height of the text baseline up or down (superscript or subscript,
- * respectively). The exact shift can / should be changed according to standard
- * conventions.
- *
- * @param {number} y
- * @param {object} inline
- * @returns {number}
+/**
+ * Shift the "y" height of the text baseline up or down (superscript or subscript,
+ * respectively). The exact shift can / should be changed according to standard
+ * conventions.
+ *
+ * @param {number} y
+ * @param {object} inline
+ * @returns {number}
  */
 const offsetText = (y, inline) => {
   let newY = y;
@@ -82,6 +82,12 @@ class Renderer {
           case 'endClip':
             this.endClip();
             break;
+          case 'beginVerticalAlignment':
+            this.beginVerticalAlignment(item.item);
+            break;
+          case 'endVerticalAlignment':
+            this.endVerticalAlignment(item.item);
+            break;
         }
         renderedItems++;
         if (this.progressCallback) {
@@ -364,6 +370,32 @@ class Renderer {
   endClip() {
     this.pdfDocument.restore();
   }
+  beginVerticalAlignment(item) {
+    if (item.isCellContentMultiPage) {
+      return;
+    }
+    switch (item.verticalAlignment) {
+      case 'middle':
+        this.pdfDocument.save();
+        this.pdfDocument.translate(0, -(item.getNodeHeight() - item.getViewHeight()) / 2);
+        break;
+      case 'bottom':
+        this.pdfDocument.save();
+        this.pdfDocument.translate(0, -(item.getNodeHeight() - item.getViewHeight()));
+        break;
+    }
+  }
+  endVerticalAlignment(item) {
+    if (item.isCellContentMultiPage) {
+      return;
+    }
+    switch (item.verticalAlignment) {
+      case 'middle':
+      case 'bottom':
+        this.pdfDocument.restore();
+        break;
+    }
+  }
   renderWatermark(page) {
     let watermark = page.watermark;
     this.pdfDocument.fill(watermark.color);

package/js/SVGMeasure.js

@@ -4,11 +4,11 @@ exports.__esModule = true;
 exports.default = void 0;
 var _xmldoc = require("xmldoc");
 var _variableType = require("./helpers/variableType");
-/**
- * Strip unit postfix, parse number, but return undefined instead of NaN for bad input
- *
- * @param {string} textVal
- * @returns {?number}
+/**
+ * Strip unit postfix, parse number, but return undefined instead of NaN for bad input
+ *
+ * @param {string} textVal
+ * @returns {?number}
  */
 const stripUnits = textVal => {
   let n = parseFloat(textVal);
@@ -18,11 +18,11 @@ const stripUnits = textVal => {
   return n;
 };
 
-/**
- * Make sure it's valid XML and the root tag is <svg/>, returns xmldoc DOM
- *
- * @param {string} svgString
- * @returns {object}
+/**
+ * Make sure it's valid XML and the root tag is <svg/>, returns xmldoc DOM
+ *
+ * @param {string} svgString
+ * @returns {object}
  */
 const parseSVG = svgString => {
   let doc;

package/js/StyleContextStack.js

@@ -3,13 +3,13 @@
 exports.__esModule = true;
 exports.default = void 0;
 var _variableType = require("./helpers/variableType");
-/**
- * Used for style inheritance and style overrides
+/**
+ * Used for style inheritance and style overrides
  */
 class StyleContextStack {
-  /**
-   * @param {object} styleDictionary named styles dictionary
-   * @param {object} defaultStyle optional default style definition
+  /**
+   * @param {object} styleDictionary named styles dictionary
+   * @param {object} defaultStyle optional default style definition
    */
   constructor(styleDictionary, defaultStyle = {}) {
     this.styleDictionary = styleDictionary;
@@ -17,10 +17,10 @@ class StyleContextStack {
     this.styleOverrides = [];
   }
 
-  /**
-   * Creates cloned version of current stack
-   *
-   * @returns {StyleContextStack} current stack snapshot
+  /**
+   * Creates cloned version of current stack
+   *
+   * @returns {StyleContextStack} current stack snapshot
    */
   clone() {
     let stack = new StyleContextStack(this.styleDictionary, this.defaultStyle);
@@ -30,21 +30,21 @@ class StyleContextStack {
     return stack;
   }
 
-  /**
-   * Pushes style-name or style-overrides-object onto the stack for future evaluation
-   *
-   * @param {string|object} styleNameOrOverride style-name (referring to styleDictionary) or
-   *                                            a new dictionary defining overriding properties
+  /**
+   * Pushes style-name or style-overrides-object onto the stack for future evaluation
+   *
+   * @param {string|object} styleNameOrOverride style-name (referring to styleDictionary) or
+   *                                            a new dictionary defining overriding properties
    */
   push(styleNameOrOverride) {
     this.styleOverrides.push(styleNameOrOverride);
   }
 
-  /**
-   * Removes last style-name or style-overrides-object from the stack
-   *
-   * @param {number} howMany optional number of elements to be popped (if not specified,
-   *                         one element will be removed from the stack)
+  /**
+   * Removes last style-name or style-overrides-object from the stack
+   *
+   * @param {number} howMany optional number of elements to be popped (if not specified,
+   *                         one element will be removed from the stack)
    */
   pop(howMany = 1) {
     while (howMany-- > 0) {
@@ -52,13 +52,13 @@ class StyleContextStack {
     }
   }
 
-  /**
-   * Creates a set of named styles or/and a style-overrides-object based on the item,
-   * pushes those elements onto the stack for future evaluation and returns the number
-   * of elements pushed, so they can be easily popped then.
-   *
-   * @param {object} item - an object with optional style property and/or style overrides
-   * @returns {number} the number of items pushed onto the stack
+  /**
+   * Creates a set of named styles or/and a style-overrides-object based on the item,
+   * pushes those elements onto the stack for future evaluation and returns the number
+   * of elements pushed, so they can be easily popped then.
+   *
+   * @param {object} item - an object with optional style property and/or style overrides
+   * @returns {number} the number of items pushed onto the stack
    */
   autopush(item) {
     if ((0, _variableType.isString)(item)) {
@@ -85,13 +85,13 @@ class StyleContextStack {
     return styleNames.length + 1;
   }
 
-  /**
-   * Automatically pushes elements onto the stack, using autopush based on item,
-   * executes callback and then pops elements back. Returns value returned by callback
-   *
-   * @param {object} item - an object with optional style property and/or style overrides
-   * @param {Function} callback to be called between autopush and pop
-   * @returns {object} value returned by callback
+  /**
+   * Automatically pushes elements onto the stack, using autopush based on item,
+   * executes callback and then pops elements back. Returns value returned by callback
+   *
+   * @param {object} item - an object with optional style property and/or style overrides
+   * @param {Function} callback to be called between autopush and pop
+   * @returns {object} value returned by callback
    */
   auto(item, callback) {
     let pushedItems = this.autopush(item);
@@ -102,11 +102,11 @@ class StyleContextStack {
     return result;
   }
 
-  /**
-   * Evaluates stack and returns value of a named property
-   *
-   * @param {string} property - property name
-   * @returns {?any} property value or null if not found
+  /**
+   * Evaluates stack and returns value of a named property
+   *
+   * @param {string} property - property name
+   * @returns {?any} property value or null if not found
    */
   getProperty(property) {
     const getStylePropertyFromStyle = (styleName, property, visited = new Set()) => {
@@ -150,12 +150,12 @@ class StyleContextStack {
     return this.defaultStyle && this.defaultStyle[property];
   }
 
-  /**
-   * @param {object} item
-   * @param {StyleContextStack} styleContextStack
-   * @param {string} property
-   * @param {any} defaultValue
-   * @returns {any}
+  /**
+   * @param {object} item
+   * @param {StyleContextStack} styleContextStack
+   * @param {string} property
+   * @param {any} defaultValue
+   * @returns {any}
    */
   static getStyleProperty(item, styleContextStack, property, defaultValue) {
     let value;
@@ -172,10 +172,10 @@ class StyleContextStack {
     return (0, _variableType.isValue)(value) ? value : defaultValue;
   }
 
-  /**
-   * @param {object} source
-   * @param {object} destination
-   * @returns {object}
+  /**
+   * @param {object} source
+   * @param {object} destination
+   * @returns {object}
    */
   static copyStyle(source = {}, destination = {}) {
     // TODO: default style to source

package/js/TableProcessor.js

@@ -145,6 +145,7 @@ class TableProcessor {
       this._tableTopBorderY = writer.context().y;
       writer.context().moveDown(this.topLineWidth);
     }
+    this.rowTopPageY = writer.context().y + this.rowPaddingTop;
     if (this.dontBreakRows && rowIndex > 0) {
       writer.beginUnbreakableBlock();
     }
@@ -441,6 +442,19 @@ class TableProcessor {
           this.drawVerticalLine(xs[i].x, y1 - hzLineOffset, y2 + this.bottomLineWidth, xs[i].index, writer, rowIndex, xs[i - 1] ? xs[i - 1].index : null);
         }
         if (i < l - 1) {
+          body[rowIndex][colIndex]._willBreak = body[rowIndex][colIndex]._willBreak ?? willBreak;
+          if (body[rowIndex][colIndex]._bottomY === undefined) {
+            let bottomY = this.dontBreakRows ? y2 + this.bottomLineWidth : y2 + this.bottomLineWidth / 2;
+            if (willBreak || this.dontBreakRows) {
+              bottomY = bottomY - this.rowPaddingBottom;
+            }
+            body[rowIndex][colIndex]._bottomY = bottomY - this.reservedAtBottom;
+          }
+          body[rowIndex][colIndex]._rowTopPageY = this.rowTopPageY;
+          if (this.dontBreakRows) {
+            body[rowIndex][colIndex]._rowTopPageYPadding = this.rowPaddingTop;
+          }
+          body[rowIndex][colIndex]._lastPageNumber = ys[yi].page + 1;
           let fillColor = body[rowIndex][colIndex].fillColor;
           let fillOpacity = body[rowIndex][colIndex].fillOpacity;
           if (!fillColor) {

package/js/TextBreaker.js

@@ -6,11 +6,11 @@ var _linebreak = _interopRequireDefault(require("linebreak"));
 var _variableType = require("./helpers/variableType");
 var _StyleContextStack = _interopRequireDefault(require("./StyleContextStack"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * @param {string} text
- * @param {boolean} noWrap
- * @param {boolean} breakAll
- * @returns {Array}
+/**
+ * @param {string} text
+ * @param {boolean} noWrap
+ * @param {boolean} breakAll
+ * @returns {Array}
  */
 const splitWords = (text, noWrap, breakAll = false) => {
   let words = [];
@@ -67,10 +67,10 @@ const splitWords = (text, noWrap, breakAll = false) => {
   return words;
 };
 
-/**
- * @param {Array} words
- * @param {boolean} noWrap
- * @returns {?string}
+/**
+ * @param {Array} words
+ * @param {boolean} noWrap
+ * @returns {?string}
  */
 const getFirstWord = (words, noWrap) => {
   let word = words[0];
@@ -88,10 +88,10 @@ const getFirstWord = (words, noWrap) => {
   return word.text;
 };
 
-/**
- * @param {Array} words
- * @param {boolean} noWrap
- * @returns {?string}
+/**
+ * @param {Array} words
+ * @param {boolean} noWrap
+ * @returns {?string}
  */
 const getLastWord = (words, noWrap) => {
   let word = words[words.length - 1];
@@ -112,10 +112,10 @@ const getLastWord = (words, noWrap) => {
   return word.text;
 };
 class TextBreaker {
-  /**
-   * @param {string|Array} texts
-   * @param {StyleContextStack} styleContextStack
-   * @returns {Array}
+  /**
+   * @param {string|Array} texts
+   * @param {StyleContextStack} styleContextStack
+   * @returns {Array}
    */
   getBreaks(texts, styleContextStack) {
     let results = [];

package/js/TextInlines.js

@@ -8,9 +8,9 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 const LEADING = /^(\s)+/g;
 const TRAILING = /(\s)+$/g;
 
-/**
- * @param {Array} array
- * @returns {Array}
+/**
+ * @param {Array} array
+ * @returns {Array}
  */
 const flattenTextArray = array => {
   function flatten(array) {
@@ -30,24 +30,24 @@ const flattenTextArray = array => {
   return array;
 };
 
-/**
- * Text measurement utility
+/**
+ * Text measurement utility
  */
 class TextInlines {
-  /**
-   * @param {object} pdfDocument object is instance of PDFDocument
+  /**
+   * @param {object} pdfDocument object is instance of PDFDocument
    */
   constructor(pdfDocument) {
     this.pdfDocument = pdfDocument;
   }
 
-  /**
-   * Converts an array of strings (or inline-definition-objects) into a collection
-   * of inlines and calculated minWidth/maxWidth and their min/max widths
-   *
-   * @param {Array|object} textArray an array of inline-definition-objects (or strings)
-   * @param {StyleContextStack} styleContextStack current style stack
-   * @returns {object} collection of inlines, minWidth, maxWidth
+  /**
+   * Converts an array of strings (or inline-definition-objects) into a collection
+   * of inlines and calculated minWidth/maxWidth and their min/max widths
+   *
+   * @param {Array|object} textArray an array of inline-definition-objects (or strings)
+   * @param {StyleContextStack} styleContextStack current style stack
+   * @returns {object} collection of inlines, minWidth, maxWidth
    */
   buildInlines(textArray, styleContextStack) {
     const getTrimmedWidth = item => {
@@ -144,23 +144,23 @@ class TextInlines {
     return array;
   }
 
-  /**
-   * Width of text
-   *
-   * @param {string} text
-   * @param {object} inline
-   * @returns {number}
+  /**
+   * Width of text
+   *
+   * @param {string} text
+   * @param {object} inline
+   * @returns {number}
    */
   widthOfText(text, inline) {
     return inline.font.widthOfString(text, inline.fontSize, inline.fontFeatures) + (inline.characterSpacing || 0) * (text.length - 1);
   }
 
-  /**
-   * Returns size of the specified string (without breaking it) using the current style
-   *
-   * @param {string} text text to be measured
-   * @param {object} styleContextStack current style stack
-   * @returns {object} size of the specified string
+  /**
+   * Returns size of the specified string (without breaking it) using the current style
+   *
+   * @param {string} text text to be measured
+   * @param {object} styleContextStack current style stack
+   * @returns {object} size of the specified string
    */
   sizeOfText(text, styleContextStack) {
     //TODO: refactor - extract from measure
@@ -187,13 +187,13 @@ class TextInlines {
     };
   }
 
-  /**
-   * Returns size of the specified rotated string (without breaking it) using the current style
-   *
-   * @param {string} text text to be measured
-   * @param {number} angle
-   * @param {object} styleContextStack current style stack
-   * @returns {object} size of the specified string
+  /**
+   * Returns size of the specified rotated string (without breaking it) using the current style
+   *
+   * @param {string} text text to be measured
+   * @param {number} angle
+   * @param {object} styleContextStack current style stack
+   * @returns {object} size of the specified string
    */
   sizeOfRotatedText(text, angle, styleContextStack) {
     let angleRad = angle * Math.PI / -180;

package/js/base.js

@@ -13,10 +13,10 @@ class pdfmake {
     this.urlResolver = null;
   }
 
-  /**
-   * @param {object} docDefinition
-   * @param {?object} options
-   * @returns {object}
+  /**
+   * @param {object} docDefinition
+   * @param {?object} options
+   * @returns {object}
    */
   createPdf(docDefinition, options = {}) {
     if (!(0, _variableType.isObject)(docDefinition)) {