@digicole/pdfmake-rtl 1.2.0 → 2.1.1

package/src/docPreprocessor.js

@@ -1,273 +1,306 @@
-'use strict';
-
-var isString = require('./helpers').isString;
-var isNumber = require('./helpers').isNumber;
-var isBoolean = require('./helpers').isBoolean;
-var isArray = require('./helpers').isArray;
-var isUndefined = require('./helpers').isUndefined;
-var fontStringify = require('./helpers').fontStringify;
-var rtlUtils = require('./rtlUtils');
-
-function DocPreprocessor() {
-
-}
-
-DocPreprocessor.prototype.preprocessDocument = function (docStructure) {
-	this.parentNode = null;
-	this.tocs = [];
-	this.nodeReferences = [];
-	return this.preprocessNode(docStructure);
-};
-
-DocPreprocessor.prototype.preprocessNode = function (node) {
-	// expand shortcuts and casting values
-	if (isArray(node)) {
-		node = { stack: node };
-	} else if (isString(node)) {
-		node = { text: node };
-	} else if (isNumber(node) || isBoolean(node)) {
-		node = { text: node.toString() };
-	} else if (node === undefined || node === null) {
-		node = { text: '' };
-	} else if (Object.keys(node).length === 0) { // empty object
-		node = { text: '' };
-	} else if ('text' in node && (node.text === undefined || node.text === null)) {
-		node.text = '';
-	}
-
-	if (node.columns) {
-		return this.preprocessColumns(node);
-	} else if (node.stack) {
-		return this.preprocessVerticalContainer(node);
-	} else if (node.ul) {
-		return this.preprocessList(node);
-	} else if (node.ol) {
-		return this.preprocessList(node);
-	} else if (node.table) {
-		return this.preprocessTable(node);
-	} else if (node.text !== undefined) {
-		return this.preprocessText(node);
-	} else if (node.toc) {
-		return this.preprocessToc(node);
-	} else if (node.image) {
-		return this.preprocessImage(node);
-	} else if (node.svg) {
-		return this.preprocessSVG(node);
-	} else if (node.canvas) {
-		return this.preprocessCanvas(node);
-	} else if (node.qr) {
-		return this.preprocessQr(node);
-	} else if (node.pageReference || node.textReference) {
-		return this.preprocessText(node);
-	} else {
-		throw 'Unrecognized document structure: ' + JSON.stringify(node, fontStringify);
-	}
-};
-
-DocPreprocessor.prototype.preprocessColumns = function (node) {
-	var columns = node.columns;
-
-	for (var i = 0, l = columns.length; i < l; i++) {
-		columns[i] = this.preprocessNode(columns[i]);
-	}
-
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessVerticalContainer = function (node) {
-	var items = node.stack;
-
-	for (var i = 0, l = items.length; i < l; i++) {
-		items[i] = this.preprocessNode(items[i]);
-	}
-
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessList = function (node) {
-	var items = node.ul || node.ol;
-
-	// Apply automatic RTL detection to list items
-	if (node.ul) {
-		node.ul = rtlUtils.processRTLList(node.ul);
-		items = node.ul;
-	} else if (node.ol) {
-		node.ol = rtlUtils.processRTLList(node.ol);
-		items = node.ol;
-	}
-
-	for (var i = 0, l = items.length; i < l; i++) {
-		items[i] = this.preprocessNode(items[i]);
-	}
-
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessTable = function (node) {
-	var col, row, cols, rows;
-
-	// Apply automatic RTL detection and processing
-	node = rtlUtils.processAutoRTLTable(node);
-
-	for (col = 0, cols = node.table.body[0].length; col < cols; col++) {
-		for (row = 0, rows = node.table.body.length; row < rows; row++) {
-			var rowData = node.table.body[row];
-			var data = rowData[col];
-			if (data !== undefined) {
-				if (data === null) { // transform to object
-					data = '';
-				}
-				if (!data._span) {
-					// Apply automatic RTL detection to cell content
-					data = rtlUtils.autoApplyRTL(data);
-					rowData[col] = this.preprocessNode(data);
-				}
-			}
-		}
-	}
-
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessText = function (node) {
-	// Apply automatic RTL detection to text elements
-	node = rtlUtils.autoApplyRTL(node);
-
-	if (node.tocItem) {
-		if (!isArray(node.tocItem)) {
-			node.tocItem = [node.tocItem];
-		}
-
-		for (var i = 0, l = node.tocItem.length; i < l; i++) {
-			if (!isString(node.tocItem[i])) {
-				node.tocItem[i] = '_default_';
-			}
-
-			var tocItemId = node.tocItem[i];
-
-			if (!this.tocs[tocItemId]) {
-				this.tocs[tocItemId] = { toc: { _items: [], _pseudo: true } };
-			}
-
-			if (!node.id) {
-				node.id = 'toc-' + tocItemId + '-' + this.tocs[tocItemId].toc._items.length;
-			}
-
-			var tocItemRef = {
-				_nodeRef: this._getNodeForNodeRef(node),
-				_textNodeRef: node
-			};
-			this.tocs[tocItemId].toc._items.push(tocItemRef);
-		}
-	}
-
-	if (node.id) {
-		if (this.nodeReferences[node.id]) {
-			if (!this.nodeReferences[node.id]._pseudo) {
-				throw "Node id '" + node.id + "' already exists";
-			}
-
-			this.nodeReferences[node.id]._nodeRef = this._getNodeForNodeRef(node);
-			this.nodeReferences[node.id]._textNodeRef = node;
-			this.nodeReferences[node.id]._pseudo = false;
-		} else {
-			this.nodeReferences[node.id] = {
-				_nodeRef: this._getNodeForNodeRef(node),
-				_textNodeRef: node
-			};
-		}
-	}
-
-	if (node.pageReference) {
-		if (!this.nodeReferences[node.pageReference]) {
-			this.nodeReferences[node.pageReference] = {
-				_nodeRef: {},
-				_textNodeRef: {},
-				_pseudo: true
-			};
-		}
-		node.text = '00000';
-		node.linkToDestination = node.pageReference;
-		node._pageRef = this.nodeReferences[node.pageReference];
-	}
-
-	if (node.textReference) {
-		if (!this.nodeReferences[node.textReference]) {
-			this.nodeReferences[node.textReference] = { _nodeRef: {}, _pseudo: true };
-		}
-
-		node.text = '';
-		node.linkToDestination = node.textReference;
-		node._textRef = this.nodeReferences[node.textReference];
-	}
-
-	if (node.text && node.text.text) {
-		node.text = [this.preprocessNode(node.text)];
-	} else if (isArray(node.text)) {
-		var isSetParentNode = false;
-		if (this.parentNode === null) {
-			this.parentNode = node;
-			isSetParentNode = true;
-		}
-
-		for (var i = 0, l = node.text.length; i < l; i++) {
-			node.text[i] = this.preprocessNode(node.text[i]);
-		}
-
-		if (isSetParentNode) {
-			this.parentNode = null;
-		}
-	}
-
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessToc = function (node) {
-	if (!node.toc.id) {
-		node.toc.id = '_default_';
-	}
-
-	node.toc.title = node.toc.title ? this.preprocessNode(node.toc.title) : null;
-	node.toc._items = [];
-
-	if (this.tocs[node.toc.id]) {
-		if (!this.tocs[node.toc.id].toc._pseudo) {
-			throw "TOC '" + node.toc.id + "' already exists";
-		}
-
-		node.toc._items = this.tocs[node.toc.id].toc._items;
-	}
-
-	this.tocs[node.toc.id] = node;
-
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessImage = function (node) {
-	if (!isUndefined(node.image.type) && !isUndefined(node.image.data) && (node.image.type === 'Buffer') && isArray(node.image.data)) {
-		node.image = Buffer.from(node.image.data);
-	}
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessSVG = function (node) {
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessCanvas = function (node) {
-	return node;
-};
-
-DocPreprocessor.prototype.preprocessQr = function (node) {
-	return node;
-};
-
-DocPreprocessor.prototype._getNodeForNodeRef = function (node) {
-	if (this.parentNode) {
-		return this.parentNode;
-	}
-
-	return node;
-};
-
-module.exports = DocPreprocessor;
+import { isString, isNumber, isValue, isEmptyObject } from './helpers/variableType';
+import { stringifyNode } from './helpers/node';
+import { processRTLElement, processRTLTable, containsRTL, applyRTLToNode } from './rtlUtils';
+
+const convertValueToString = value => {
+	if (isString(value)) {
+		return value.replace(/\t/g, '    '); // expand tab as spaces
+	} else if (isNumber(value) || typeof value === 'boolean') {
+		return value.toString();
+	} else if (!isValue(value) || isEmptyObject(value)) {
+		return '';
+	}
+
+	// TODO: throw exception ?
+
+	return value;
+};
+
+class DocPreprocessor {
+	preprocessDocument(docStructure) {
+		this.parentNode = null;
+		this.tocs = [];
+		this.nodeReferences = [];
+
+		// Check if RTL is enabled at document level
+		const documentRTL = docStructure.rtl === true;
+
+		// Process content for RTL if enabled
+		if (documentRTL && docStructure.content) {
+			docStructure.content = processRTLElement(docStructure.content, true);
+		}
+
+		return this.preprocessNode(docStructure, true);
+	}
+
+	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 };
+		} else if (isString(node) || isNumber(node) || typeof node === 'boolean' || !isValue(node) || isEmptyObject(node)) { // text node defined as value
+			node = { text: convertValueToString(node) };
+		} else if ('text' in node) { // cast value in text property
+			node.text = convertValueToString(node.text);
+		}
+
+		// Apply RTL processing if rtl property is set on this node
+		if (node && typeof node === 'object' && node.rtl === true) {
+			node = processRTLElement(node, true);
+		}
+		// Auto-detect RTL for text nodes without explicit rtl property
+		else if (node && typeof node === 'object' && node.text && typeof node.text === 'string' && containsRTL(node.text) && !node.rtl) {
+			node = applyRTLToNode(node, false);
+		}
+		// Auto-detect RTL for table nodes - reverse columns if table has RTL content
+		else if (node && typeof node === 'object' && node.table && !node.rtl) {
+			node = processRTLTable(node);
+		}
+
+		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, isSectionAllowed);
+		} else if (node.ul) {
+			return this.preprocessList(node);
+		} else if (node.ol) {
+			return this.preprocessList(node);
+		} else if (node.table) {
+			return this.preprocessTable(node);
+		} else if (node.text !== undefined) {
+			return this.preprocessText(node);
+		} else if (node.toc) {
+			return this.preprocessToc(node);
+		} else if (node.image) {
+			return this.preprocessImage(node);
+		} else if (node.svg) {
+			return this.preprocessSVG(node);
+		} else if (node.canvas) {
+			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 {
+			throw new Error(`Unrecognized document structure: ${stringifyNode(node)}`);
+		}
+	}
+
+	preprocessSection(node) {
+		node.section = this.preprocessNode(node.section);
+
+		return node;
+	}
+
+	preprocessColumns(node) {
+		let columns = node.columns;
+
+		for (let i = 0, l = columns.length; i < l; i++) {
+			columns[i] = this.preprocessNode(columns[i]);
+		}
+
+		return node;
+	}
+
+	preprocessVerticalContainer(node, isSectionAllowed) {
+		let items = node.stack;
+
+		for (let i = 0, l = items.length; i < l; i++) {
+			items[i] = this.preprocessNode(items[i], isSectionAllowed);
+		}
+
+		return node;
+	}
+
+	preprocessList(node) {
+		let items = node.ul || node.ol;
+
+		for (let i = 0, l = items.length; i < l; i++) {
+			items[i] = this.preprocessNode(items[i]);
+		}
+
+		return node;
+	}
+
+	preprocessTable(node) {
+		let col;
+		let row;
+		let cols;
+		let rows;
+
+		for (col = 0, cols = node.table.body[0].length; col < cols; col++) {
+			for (row = 0, rows = node.table.body.length; row < rows; row++) {
+				let rowData = node.table.body[row];
+				let data = rowData[col];
+				if (data !== undefined) {
+					if (data === null) { // transform to object
+						data = '';
+					}
+					if (!data._span) {
+						rowData[col] = this.preprocessNode(data);
+					}
+				}
+			}
+		}
+
+		return node;
+	}
+
+	preprocessText(node) {
+		if (node.tocItem) {
+			if (!Array.isArray(node.tocItem)) {
+				node.tocItem = [node.tocItem];
+			}
+
+			for (let i = 0, l = node.tocItem.length; i < l; i++) {
+				if (!isString(node.tocItem[i])) {
+					node.tocItem[i] = '_default_';
+				}
+
+				let tocItemId = node.tocItem[i];
+
+				if (!this.tocs[tocItemId]) {
+					this.tocs[tocItemId] = { toc: { _items: [], _pseudo: true } };
+				}
+
+				if (!node.id) {
+					node.id = `toc-${tocItemId}-${this.tocs[tocItemId].toc._items.length}`;
+				}
+
+				let tocItemRef = {
+					_nodeRef: this._getNodeForNodeRef(node),
+					_textNodeRef: node
+				};
+				this.tocs[tocItemId].toc._items.push(tocItemRef);
+			}
+		}
+
+		if (node.id) {
+			if (this.nodeReferences[node.id]) {
+				if (!this.nodeReferences[node.id]._pseudo) {
+					throw new Error(`Node id '${node.id}' already exists`);
+				}
+
+				this.nodeReferences[node.id]._nodeRef = this._getNodeForNodeRef(node);
+				this.nodeReferences[node.id]._textNodeRef = node;
+				this.nodeReferences[node.id]._pseudo = false;
+			} else {
+				this.nodeReferences[node.id] = {
+					_nodeRef: this._getNodeForNodeRef(node),
+					_textNodeRef: node
+				};
+			}
+		}
+
+		if (node.pageReference) {
+			if (!this.nodeReferences[node.pageReference]) {
+				this.nodeReferences[node.pageReference] = {
+					_nodeRef: {},
+					_textNodeRef: {},
+					_pseudo: true
+				};
+			}
+			node.text = '00000';
+			node.linkToDestination = node.pageReference;
+			node._pageRef = this.nodeReferences[node.pageReference];
+		}
+
+		if (node.textReference) {
+			if (!this.nodeReferences[node.textReference]) {
+				this.nodeReferences[node.textReference] = { _nodeRef: {}, _pseudo: true };
+			}
+
+			node.text = '';
+			node.linkToDestination = node.textReference;
+			node._textRef = this.nodeReferences[node.textReference];
+		}
+
+		if (node.text && node.text.text) {
+			node.text = [this.preprocessNode(node.text)];
+		} else if (Array.isArray(node.text)) {
+			let isSetParentNode = false;
+			if (this.parentNode === null) {
+				this.parentNode = node;
+				isSetParentNode = true;
+			}
+
+			for (let i = 0, l = node.text.length; i < l; i++) {
+				node.text[i] = this.preprocessNode(node.text[i]);
+			}
+
+			if (isSetParentNode) {
+				this.parentNode = null;
+			}
+		}
+
+		return node;
+	}
+
+	preprocessToc(node) {
+		if (!node.toc.id) {
+			node.toc.id = '_default_';
+		}
+
+		node.toc.title = node.toc.title ? this.preprocessNode(node.toc.title) : null;
+		node.toc._items = [];
+
+		if (this.tocs[node.toc.id]) {
+			if (!this.tocs[node.toc.id].toc._pseudo) {
+				throw new Error(`TOC '${node.toc.id}' already exists`);
+			}
+
+			node.toc._items = this.tocs[node.toc.id].toc._items;
+		}
+
+		this.tocs[node.toc.id] = node;
+
+		return node;
+	}
+
+	preprocessImage(node) {
+		if ((node.image.type !== undefined) && (node.image.data !== undefined) && (node.image.type === 'Buffer') && Array.isArray(node.image.data)) {
+			node.image = Buffer.from(node.image.data);
+		}
+		return node;
+	}
+
+	preprocessCanvas(node) {
+		return node;
+	}
+
+	preprocessSVG(node) {
+		return node;
+	}
+
+	preprocessQr(node) {
+		return node;
+	}
+
+	preprocessAttachment(node) {
+		return node;
+	}
+
+	_getNodeForNodeRef(node) {
+		if (this.parentNode) {
+			return this.parentNode;
+		}
+
+		return node;
+	}
+}
+
+export default DocPreprocessor;