pdfmake 0.2.4 → 0.3.0-beta.2

package/js/Printer.js

@@ -0,0 +1,300 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _PDFDocument = _interopRequireDefault(require("./PDFDocument"));
+
+var _LayoutBuilder = _interopRequireDefault(require("./LayoutBuilder"));
+
+var _SVGMeasure = _interopRequireDefault(require("./SVGMeasure"));
+
+var _PageSize = require("./PageSize");
+
+var _tableLayouts = require("./tableLayouts");
+
+var _Renderer = _interopRequireDefault(require("./Renderer"));
+
+var _variableType = require("./helpers/variableType");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 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
+   */
+  constructor(fontDescriptors, virtualfs = null, urlResolver = null) {
+    this.fontDescriptors = fontDescriptors;
+    this.virtualfs = virtualfs;
+    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
+   */
+
+
+  createPdfKitDocument(docDefinition, options = {}) {
+    return new Promise((resolve, reject) => {
+      this.resolveUrls(docDefinition).then(() => {
+        try {
+          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);
+          let pdfOptions = {
+            size: [pageSize.width, pageSize.height],
+            pdfVersion: docDefinition.version,
+            compress: docDefinition.compress,
+            userPassword: docDefinition.userPassword,
+            ownerPassword: docDefinition.ownerPassword,
+            permissions: docDefinition.permissions,
+            fontLayoutCache: typeof options.fontLayoutCache === 'boolean' ? options.fontLayoutCache : true,
+            bufferPages: options.bufferPages || false,
+            autoFirstPage: false,
+            info: createMetadata(docDefinition),
+            font: null
+          };
+          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);
+
+          if (options.tableLayouts) {
+            builder.registerTableLayouts(options.tableLayouts);
+          }
+
+          let pages = builder.layoutDocument(docDefinition.content, this.pdfKitDoc, docDefinition.styles || {}, docDefinition.defaultStyle || {
+            fontSize: 12,
+            font: 'Roboto'
+          }, docDefinition.background, docDefinition.header, docDefinition.footer, docDefinition.watermark, docDefinition.pageBreakBefore);
+          let maxNumberPages = docDefinition.maxPagesNumber || -1;
+
+          if ((0, _variableType.isNumber)(maxNumberPages) && maxNumberPages > -1) {
+            pages = pages.slice(0, maxNumberPages);
+          } // if pageSize.height is set to Infinity, calculate the actual height of the page that
+          // was laid out using the height of each of the items in the page.
+
+
+          if (pageSize.height === Infinity) {
+            let pageHeight = calculatePageHeight(pages, docDefinition.pageMargins);
+            this.pdfKitDoc.options.size = [pageSize.width, pageHeight];
+          }
+
+          const renderer = new _Renderer.default(this.pdfKitDoc, options.progressCallback);
+          renderer.renderPages(pages);
+          resolve(this.pdfKitDoc);
+        } catch (e) {
+          reject(e);
+        }
+      }, result => {
+        reject(result);
+      });
+    });
+  }
+  /**
+   * @param {object} docDefinition
+   * @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();
+      }
+
+      for (let font in this.fontDescriptors) {
+        if (this.fontDescriptors.hasOwnProperty(font)) {
+          if (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) {
+            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) {
+            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) {
+            let url = getExtendedUrl(this.fontDescriptors[font].bolditalics);
+            this.urlResolver.resolve(url.url, url.headers);
+            this.fontDescriptors[font].bolditalics = url.url;
+          }
+        }
+      }
+
+      if (docDefinition.images) {
+        for (let image in docDefinition.images) {
+          if (docDefinition.images.hasOwnProperty(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;
+          }
+        }
+      }
+
+      this.urlResolver.resolved().then(() => {
+        resolve();
+      }, result => {
+        reject(result);
+      });
+    });
+  }
+
+}
+
+function createMetadata(docDefinition) {
+  // PDF standard has these properties reserved: Title, Author, Subject, Keywords,
+  // Creator, Producer, CreationDate, ModDate, Trapped.
+  // To keep the pdfmake api consistent, the info field are defined lowercase.
+  // Custom properties don't contain a space.
+  function standardizePropertyKey(key) {
+    let standardProperties = ['Title', 'Author', 'Subject', 'Keywords', 'Creator', 'Producer', 'CreationDate', 'ModDate', 'Trapped'];
+    let standardizedKey = key.charAt(0).toUpperCase() + key.slice(1);
+
+    if (standardProperties.includes(standardizedKey)) {
+      return standardizedKey;
+    }
+
+    return key.replace(/\s+/g, '');
+  }
+
+  let info = {
+    Producer: 'pdfmake',
+    Creator: 'pdfmake'
+  };
+
+  if (docDefinition.info) {
+    for (let key in docDefinition.info) {
+      let value = docDefinition.info[key];
+
+      if (value) {
+        key = standardizePropertyKey(key);
+        info[key] = value;
+      }
+    }
+  }
+
+  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') {
+      return item.item.getHeight();
+    } else if (item.item._height) {
+      return item.item._height;
+    } else if (item.type === 'vector') {
+      return item.item.y1 > item.item.y2 ? item.item.y1 : item.item.y2;
+    } else {
+      // TODO: add support for next item types
+      return 0;
+    }
+  }
+
+  function getBottomPosition(item) {
+    let top = item.item.y || 0;
+    let height = getItemHeight(item);
+    return top + height;
+  }
+
+  let fixedMargins = (0, _PageSize.normalizePageMargin)(margins || 40);
+  let height = fixedMargins.top;
+  pages.forEach(page => {
+    page.items.forEach(item => {
+      let bottomPosition = getBottomPosition(item);
+
+      if (bottomPosition > height) {
+        height = bottomPosition;
+      }
+    });
+  });
+  height += fixedMargins.bottom;
+  return height;
+}
+
+var _default = PdfPrinter;
+exports.default = _default;