pdfmake 0.3.0-beta.9 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdfmake",
-  "version": "0.3.0-beta.9",
+  "version": "0.3.0",
   "description": "Client/server side PDF printing in pure JavaScript",
   "main": "js/index.js",
   "esnext": "src/index.js",
@@ -9,44 +9,45 @@
     "test": "tests"
   },
   "dependencies": {
-    "@foliojs-fork/linebreak": "^1.1.1",
-    "@foliojs-fork/pdfkit": "^0.14.0",
-    "iconv-lite": "^0.6.3",
-    "xmldoc": "^1.3.0"
+    "linebreak": "^1.1.0",
+    "pdfkit": "^0.17.2",
+    "xmldoc": "^2.0.3"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.6",
-    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
-    "@babel/preset-env": "^7.23.6",
+    "@babel/cli": "^7.28.3",
+    "@babel/core": "^7.28.5",
+    "@babel/plugin-transform-modules-commonjs": "^7.27.1",
+    "@babel/preset-env": "^7.28.5",
+    "@eslint/js": "^9.39.2",
     "assert": "^2.1.0",
-    "babel-loader": "^9.1.3",
+    "babel-loader": "^10.0.0",
     "brfs": "^2.0.2",
     "browserify-zlib": "^0.2.0",
-    "buffer": "6.0.3",
-    "core-js": "3.19.0",
-    "eslint": "^8.55.0",
-    "eslint-plugin-jsdoc": "^46.9.1",
-    "expose-loader": "^4.1.0",
+    "buffer": "^6.0.3",
+    "core-js": "^3.47.0",
+    "eslint": "^9.39.2",
+    "eslint-plugin-jsdoc": "^61.5.0",
+    "expose-loader": "^5.0.1",
     "file-saver": "^2.0.5",
-    "mocha": "^10.2.0",
+    "globals": "^16.5.0",
+    "mocha": "^11.7.5",
     "npm-run-all": "^4.1.5",
     "process": "^0.11.10",
-    "rewire": "^7.0.0",
-    "shx": "^0.3.4",
-    "sinon": "^17.0.1",
-    "source-map-loader": "^4.0.1",
+    "rewire": "^9.0.1",
+    "shx": "^0.4.0",
+    "sinon": "^21.0.1",
+    "source-map-loader": "^5.0.0",
     "stream-browserify": "^3.0.0",
     "string-replace-webpack-plugin": "^0.1.3",
     "svg-to-pdfkit": "^0.1.8",
-    "terser-webpack-plugin": "^5.3.9",
+    "terser-webpack-plugin": "^5.3.16",
     "transform-loader": "^0.2.4",
     "util": "^0.12.5",
-    "webpack": "^5.89.0",
-    "webpack-cli": "^5.1.4"
+    "webpack": "^5.104.1",
+    "webpack-cli": "^6.0.1"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "scripts": {
     "test": "run-s build mocha lint",

package/src/DocMeasure.js

@@ -34,12 +34,18 @@ class DocMeasure {
 		return this.measureNode(docStructure);
 	}
 
+	measureBlock(node) {
+		return this.measureNode(node);
+	}
+
 	measureNode(node) {
 		return this.styleStack.auto(node, () => {
 			// TODO: refactor + rethink whether this is the proper way to handle margins
 			node._margin = getNodeMargin(node, this.styleStack);
 
-			if (node.columns) {
+			if (node.section) {
+				return extendMargins(this.measureSection(node));
+			} else if (node.columns) {
 				return extendMargins(this.measureColumns(node));
 			} else if (node.stack) {
 				return extendMargins(this.measureVerticalContainer(node));
@@ -128,8 +134,14 @@ class DocMeasure {
 		this.convertIfBase64Image(node);
 
 		let image = this.pdfDocument.provideImage(node.image);
+
 		let imageSize = { width: image.width, height: image.height };
 
+		// If EXIF orientation calls for it, swap width and height
+		if (image.orientation > 4) {
+			imageSize = { width: image.height, height: image.width };
+		}
+
 		this.measureImageWithDimensions(node, imageSize);
 
 		return node;
@@ -459,6 +471,14 @@ class DocMeasure {
 		return node;
 	}
 
+	measureSection(node) {
+		// TODO: properties
+
+		node.section = this.measureNode(node.section);
+
+		return node;
+	}
+
 	measureColumns(node) {
 		let columns = node.columns;
 		node._gap = this.styleStack.getProperty('columnGap') || 0;

package/src/DocPreprocessor.js

@@ -20,10 +20,17 @@ class DocPreprocessor {
 		this.parentNode = null;
 		this.tocs = [];
 		this.nodeReferences = [];
-		return this.preprocessNode(docStructure);
+		return this.preprocessNode(docStructure, true);
 	}
 
-	preprocessNode(node) {
+	preprocessBlock(node) {
+		this.parentNode = null;
+		this.tocs = [];
+		this.nodeReferences = [];
+		return this.preprocessNode(node);
+	}
+
+	preprocessNode(node, isSectionAllowed = false) {
 		// expand shortcuts and casting values
 		if (Array.isArray(node)) {
 			node = { stack: node };
@@ -33,10 +40,16 @@ class DocPreprocessor {
 			node.text = convertValueToString(node.text);
 		}
 
-		if (node.columns) {
+		if (node.section) {
+			if (!isSectionAllowed) {
+				throw new Error(`Incorrect document structure, section node is only allowed at the root level of document structure: ${stringifyNode(node)}`);
+			}
+
+			return this.preprocessSection(node);
+		} else if (node.columns) {
 			return this.preprocessColumns(node);
 		} else if (node.stack) {
-			return this.preprocessVerticalContainer(node);
+			return this.preprocessVerticalContainer(node, isSectionAllowed);
 		} else if (node.ul) {
 			return this.preprocessList(node);
 		} else if (node.ol) {
@@ -64,6 +77,12 @@ class DocPreprocessor {
 		}
 	}
 
+	preprocessSection(node) {
+		node.section = this.preprocessNode(node.section);
+
+		return node;
+	}
+
 	preprocessColumns(node) {
 		let columns = node.columns;
 
@@ -74,11 +93,11 @@ class DocPreprocessor {
 		return node;
 	}
 
-	preprocessVerticalContainer(node) {
+	preprocessVerticalContainer(node, isSectionAllowed) {
 		let items = node.stack;
 
 		for (let i = 0, l = items.length; i < l; i++) {
-			items[i] = this.preprocessNode(items[i]);
+			items[i] = this.preprocessNode(items[i], isSectionAllowed);
 		}
 
 		return node;

package/src/DocumentContext.js

@@ -6,30 +6,27 @@ import { EventEmitter } from 'events';
  * It facilitates column divisions and vertical sync
  */
 class DocumentContext extends EventEmitter {
-	constructor(pageSize, pageMargins) {
+	constructor() {
 		super();
 		this.pages = [];
-
-		this.pageMargins = pageMargins;
-
-		this.x = pageMargins.left;
-		this.availableWidth = pageSize.width - pageMargins.left - pageMargins.right;
-		this.availableHeight = 0;
+		this.pageMargins = undefined;
+		this.x = undefined;
+		this.availableWidth = undefined;
+		this.availableHeight = undefined;
 		this.page = -1;
 
 		this.snapshots = [];
 		this.backgroundLength = [];
-
-		this.addPage(pageSize);
 	}
 
-	beginColumnGroup() {
+	beginColumnGroup(marginXTopParent, bottomByPage = {}) {
 		this.snapshots.push({
 			x: this.x,
 			y: this.y,
 			availableHeight: this.availableHeight,
 			availableWidth: this.availableWidth,
 			page: this.page,
+			bottomByPage: bottomByPage ? bottomByPage : {},
 			bottomMost: {
 				x: this.x,
 				y: this.y,
@@ -41,6 +38,23 @@ class DocumentContext extends EventEmitter {
 		});
 
 		this.lastColumnWidth = 0;
+		if (marginXTopParent) {
+			this.marginXTopParent = marginXTopParent;
+		}
+	}
+
+	updateBottomByPage() {
+		const lastSnapshot = this.snapshots[this.snapshots.length - 1];
+		const lastPage = this.page;
+		let previousBottom = -Number.MIN_VALUE;
+		if (lastSnapshot.bottomByPage[lastPage]) {
+			previousBottom = lastSnapshot.bottomByPage[lastPage];
+		}
+		lastSnapshot.bottomByPage[lastPage] = Math.max(previousBottom, this.y);
+	}
+
+	resetMarginXTopParent() {
+		this.marginXTopParent = null;
 	}
 
 	beginColumn(width, offset, endingCell) {
@@ -65,10 +79,10 @@ class DocumentContext extends EventEmitter {
 		}
 	}
 
-	markEnding(endingCell) {
+	markEnding(endingCell, originalXOffset, discountY) {
 		this.page = endingCell._columnEndingContext.page;
-		this.x = endingCell._columnEndingContext.x;
-		this.y = endingCell._columnEndingContext.y;
+		this.x = endingCell._columnEndingContext.x + originalXOffset;
+		this.y = endingCell._columnEndingContext.y - discountY;
 		this.availableWidth = endingCell._columnEndingContext.availableWidth;
 		this.availableHeight = endingCell._columnEndingContext.availableHeight;
 		this.lastColumnWidth = endingCell._columnEndingContext.lastColumnWidth;
@@ -111,6 +125,7 @@ class DocumentContext extends EventEmitter {
 			this.availableHeight -= (y - saved.bottomMost.y);
 		}
 		this.lastColumnWidth = saved.lastColumnWidth;
+		return saved.bottomByPage;
 	}
 
 	addMargin(left, right) {
@@ -128,14 +143,19 @@ class DocumentContext extends EventEmitter {
 	initializePage() {
 		this.y = this.pageMargins.top;
 		this.availableHeight = this.getCurrentPage().pageSize.height - this.pageMargins.top - this.pageMargins.bottom;
-		this.pageSnapshot().availableWidth = this.getCurrentPage().pageSize.width - this.pageMargins.left - this.pageMargins.right;
+		const { pageCtx, isSnapshot } = this.pageSnapshot();
+		pageCtx.availableWidth = this.getCurrentPage().pageSize.width - this.pageMargins.left - this.pageMargins.right;
+		if (isSnapshot && this.marginXTopParent) {
+			pageCtx.availableWidth -= this.marginXTopParent[0];
+			pageCtx.availableWidth -= this.marginXTopParent[1];
+		}
 	}
 
 	pageSnapshot() {
 		if (this.snapshots[0]) {
-			return this.snapshots[0];
+			return { pageCtx: this.snapshots[0], isSnapshot: true };
 		} else {
-			return this;
+			return { pageCtx: this, isSnapshot: false };
 		}
 	}
 
@@ -186,13 +206,23 @@ class DocumentContext extends EventEmitter {
 		let prevPage = this.page;
 		let prevY = this.y;
 
+		// If we are in a column group
+		if (this.snapshots.length > 0) {
+			let lastSnapshot = this.snapshots[this.snapshots.length - 1];
+			// We have to update prevY accordingly by also taking into consideration
+			// the 'y' of cells that don't break page
+			if (lastSnapshot.bottomMost && lastSnapshot.bottomMost.y) {
+				prevY = Math.max(this.y, lastSnapshot.bottomMost.y);
+			}
+		}
+
 		let createNewPage = nextPageIndex >= this.pages.length;
 		if (createNewPage) {
 			let currentAvailableWidth = this.availableWidth;
 			let currentPageOrientation = this.getCurrentPage().pageSize.orientation;
 
 			let pageSize = getPageSize(this.getCurrentPage(), pageOrientation);
-			this.addPage(pageSize);
+			this.addPage(pageSize, null, this.getCurrentPage().customProperties);
 
 			if (currentPageOrientation === pageSize.orientation) {
 				this.availableWidth = currentAvailableWidth;
@@ -210,14 +240,20 @@ class DocumentContext extends EventEmitter {
 		};
 	}
 
-	addPage(pageSize) {
-		let page = { items: [], pageSize: pageSize };
+	addPage(pageSize, pageMargin = null, customProperties = {}) {
+		if (pageMargin !== null) {
+			this.pageMargins = pageMargin;
+			this.x = pageMargin.left;
+			this.availableWidth = pageSize.width - pageMargin.left - pageMargin.right;
+		}
+
+		let page = { items: [], pageSize: pageSize, pageMargins: this.pageMargins, customProperties: customProperties };
 		this.pages.push(page);
 		this.backgroundLength.push(0);
 		this.page = this.pages.length - 1;
 		this.initializePage();
 
-		this.emit('pageAdded');
+		this.emit('pageAdded', page);
 
 		return page;
 	}

package/src/ElementWriter.js

@@ -8,12 +8,19 @@ import { EventEmitter } from 'events';
  * their positions based on the context
  */
 class ElementWriter extends EventEmitter {
+
+	/**
+	 * @param {DocumentContext} context
+	 */
 	constructor(context) {
 		super();
 		this._context = context;
 		this.contextStack = [];
 	}
 
+	/**
+	 * @returns {DocumentContext}
+	 */
 	context() {
 		return this._context;
 	}
@@ -259,9 +266,12 @@ class ElementWriter extends EventEmitter {
 		}
 	}
 
-	addVector(vector, ignoreContextX, ignoreContextY, index) {
+	addVector(vector, ignoreContextX, ignoreContextY, index, forcePage) {
 		let context = this.context();
 		let page = context.getCurrentPage();
+		if (isNumber(forcePage)) {
+			page = context.pages[forcePage];
+		}
 		let position = this.getCurrentPositionOnPage();
 
 		if (page) {
@@ -322,10 +332,21 @@ class ElementWriter extends EventEmitter {
 					var v = pack(item.item);
 
 					offsetVector(v, useBlockXOffset ? (block.xOffset || 0) : ctx.x, useBlockYOffset ? (block.yOffset || 0) : ctx.y);
-					page.items.push({
-						type: 'vector',
-						item: v
-					});
+					if (v._isFillColorFromUnbreakable) {
+						// If the item is a fillColor from an unbreakable block
+						// We have to add it at the beginning of the items body array of the page
+						delete v._isFillColorFromUnbreakable;
+						const endOfBackgroundItemsIndex = ctx.backgroundLength[ctx.page];
+						page.items.splice(endOfBackgroundItemsIndex, 0, {
+							type: 'vector',
+							item: v
+						});
+					} else {
+						page.items.push({
+							type: 'vector',
+							item: v
+						});
+					}
 					break;
 
 				case 'image':
@@ -357,7 +378,7 @@ class ElementWriter extends EventEmitter {
 	 * pushContext(width, height) - creates and pushes a new context with the specified width and height
 	 * pushContext() - creates a new context for unbreakable blocks (with current availableWidth and full-page-height)
 	 *
-	 * @param {object|number} contextOrWidth
+	 * @param {DocumentContext|number} contextOrWidth
 	 * @param {number} height
 	 */
 	pushContext(contextOrWidth, height) {
@@ -367,7 +388,9 @@ class ElementWriter extends EventEmitter {
 		}
 
 		if (isNumber(contextOrWidth)) {
-			contextOrWidth = new DocumentContext({ width: contextOrWidth, height: height }, { left: 0, right: 0, top: 0, bottom: 0 });
+			let width = contextOrWidth;
+			contextOrWidth = new DocumentContext();
+			contextOrWidth.addPage({ width: width, height: height }, { left: 0, right: 0, top: 0, bottom: 0 });
 		}
 
 		this.contextStack.push(this.context());