@digicole/pdfmake-rtl 2.1.0 → 2.1.2

package/CHANGELOG.md

@@ -1,83 +1,118 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [2.1.0] - 2026-02-08
-
-### Added
-
-- Major version upgrade with significant architectural improvements
-- Full rewrite of RTL processing pipeline for better performance and reliability
-- Support for RTL list tables with proper right-to-left rendering
-- RTL-aware ordered and unordered list handling within table cells
-
-### Improved
-
-- Overall RTL text rendering quality and consistency
-- Performance optimizations for large documents with mixed LTR/RTL content
-
-### Fixed
-
-- Fixed mixed character rendering issues with combined LTR/RTL scripts
-- Fixed mixed language text handling for Arabic, Persian, Urdu alongside Latin characters
-- Corrected bidirectional text reordering in mixed-language paragraphs
-
-### Breaking Changes
-
-- Major version bump; review migration guide for upgrading from v1.x
-
-## [1.3.6] - 2025-08-08
-
-### Added
-
-- Enhanced RTL table handling with improved column reversal for Arabic, Persian, and Urdu text
-- New `reverseTableRowPreserveSpans` function to handle complex table structures with colSpan and rowSpan
-- Automatic RTL detection and processing for tables containing RTL content
-- Support for preserving table header structure in RTL layouts
-- Comprehensive test examples for RTL table scenarios
-
-### Improved
-
-- Auto-RTL detection logic now respects explicit `supportRTL: false` setting
-- Better handling of nested table headers with mixed span attributes
-- Enhanced RTL text processing with proper bidirectional text support
-- Improved column reversal algorithm that preserves span relationships
-
-### Fixed
-
-- Fixed RTL table header positioning issues with colSpan and rowSpan elements
-- Resolved auto-RTL detection overriding explicit RTL settings
-- Fixed column ordering in complex nested header structures
-- Corrected span placeholder handling in RTL table reversal
-
-### Technical Details
-
-- Added `processAutoRTLTable` function for intelligent RTL detection
-- Enhanced `rtlUtils.js` with span-aware reversal algorithms
-- Improved error handling for empty object placeholders in span structures
-- Added comprehensive unit tests for RTL table functionality
-
-### Examples Added
-
-- `examples/rtl-nested-header.js` - Demonstrates complex RTL table with nested headers
-- `examples/test-simple-rtl-table.js` - Basic RTL table functionality test
-- `examples/test-no-spans-rtl-table.js` - RTL table without span elements
-
-### Breaking Changes
-
-- None. All changes are backward compatible.
-
-### Notes
-
-- RTL detection threshold set to 30% RTL content for automatic table reversal
-- Headers with span structures are preserved to maintain layout integrity
-- Cell-level RTL text rendering (`bidi: true`) applied automatically for RTL content
-
----
-
-## Previous Versions
-
-This is the first tracked version of the changelog. For earlier changes, please refer to the git commit history.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.1.2] - 2026-02-10
+
+### Added
+
+- RTL table grid right-alignment: tables with `rtl: true` or auto-detected RTL now draw borders and grid lines starting from the right side of the page
+- Internal `_rtl` flag on table nodes for the drawing phase (`TableProcessor` / `LayoutBuilder`)
+- New RTL table example in `examples/tables-rtl.js` demonstrating right-aligned grid
+
+### Changed
+
+- Package renamed from `pdfmake-rtl` to `@digicole/pdfmake-rtl` (scoped npm package)
+
+### Fixed
+
+- Fixed RTL tables with `widths: ['auto', …]` rendering their grid/borders flush-left instead of flush-right
+- `TableProcessor.beginTable()` now shifts `rowSpanData` positions right by the unused space for RTL tables
+- `LayoutBuilder.processRow()` now shifts `context.x` right so cell content aligns with the right-aligned grid
+
+---
+
+## [2.1.1] - 2026-02-10
+
+### Added
+
+- Browser example `examples/simple-rtl-table.html` for quick RTL testing in the browser
+- README quick-start sections for Node.js and browser usage
+
+### Fixed
+
+- Complete rewrite of `adjustRTLInlines()` with proper bidi-like run-based reordering (7-step algorithm) for correct punctuation placement in mixed RTL/LTR text
+- Stack-based balanced bracket pair detection with UBA Rule L4 mirroring for parentheses in RTL context
+- Brackets adjacent to numbers or LTR text are now preserved correctly (e.g. `1)` stays as `1)`)
+
+---
+
+## [2.1.0] - 2026-02-08
+
+### Added
+
+- Major version upgrade with significant architectural improvements
+- Full rewrite of RTL processing pipeline for better performance and reliability
+- Support for RTL list tables with proper right-to-left rendering
+- RTL-aware ordered and unordered list handling within table cells
+
+### Improved
+
+- Overall RTL text rendering quality and consistency
+- Performance optimizations for large documents with mixed LTR/RTL content
+
+### Fixed
+
+- Fixed mixed character rendering issues with combined LTR/RTL scripts
+- Fixed mixed language text handling for Arabic, Persian, Urdu alongside Latin characters
+- Corrected bidirectional text reordering in mixed-language paragraphs
+
+### Breaking Changes
+
+- Major version bump; review migration guide for upgrading from v1.x
+
+## [1.3.6] - 2025-08-08
+
+### Added
+
+- Enhanced RTL table handling with improved column reversal for Arabic, Persian, and Urdu text
+- New `reverseTableRowPreserveSpans` function to handle complex table structures with colSpan and rowSpan
+- Automatic RTL detection and processing for tables containing RTL content
+- Support for preserving table header structure in RTL layouts
+- Comprehensive test examples for RTL table scenarios
+
+### Improved
+
+- Auto-RTL detection logic now respects explicit `supportRTL: false` setting
+- Better handling of nested table headers with mixed span attributes
+- Enhanced RTL text processing with proper bidirectional text support
+- Improved column reversal algorithm that preserves span relationships
+
+### Fixed
+
+- Fixed RTL table header positioning issues with colSpan and rowSpan elements
+- Resolved auto-RTL detection overriding explicit RTL settings
+- Fixed column ordering in complex nested header structures
+- Corrected span placeholder handling in RTL table reversal
+
+### Technical Details
+
+- Added `processAutoRTLTable` function for intelligent RTL detection
+- Enhanced `rtlUtils.js` with span-aware reversal algorithms
+- Improved error handling for empty object placeholders in span structures
+- Added comprehensive unit tests for RTL table functionality
+
+### Examples Added
+
+- `examples/rtl-nested-header.js` - Demonstrates complex RTL table with nested headers
+- `examples/test-simple-rtl-table.js` - Basic RTL table functionality test
+- `examples/test-no-spans-rtl-table.js` - RTL table without span elements
+
+### Breaking Changes
+
+- None. All changes are backward compatible.
+
+### Notes
+
+- RTL detection threshold set to 30% RTL content for automatic table reversal
+- Headers with span structures are preserved to maintain layout integrity
+- Cell-level RTL text rendering (`bidi: true`) applied automatically for RTL content
+
+---
+
+## Previous Versions
+
+This is the first tracked version of the changelog. For earlier changes, please refer to the git commit history.

package/README.md

@@ -1,6 +1,4 @@
-<!-- [![Node.js CI][githubactions_img]][githubactions_url] -->
-
-# pdfmake-RTL [![GitHub][github_img]][github_url] [![npm][npm_img]][npm_url]
+# pdfmake-RTL [![Node.js CI][githubactions_img]][githubactions_url] [![GitHub][github_img]][github_url] [![npm][npm_img]][npm_url]
 
 [githubactions_img]: https://github.com/aysnet1/pdfmake-rtl/actions/workflows/node.js.yml/badge.svg?branch=master
 [githubactions_url]: https://github.com/aysnet1/pdfmake-rtl/actions
@@ -8,11 +6,10 @@
 [github_url]: https://github.com/bpampuch/pdfmake-rtl/releases/latest
 [npm_img]: https://img.shields.io/npm/v/pdfmake-rtl.svg?colorB=0E7FBF
 [npm_url]: https://www.npmjs.com/package/pdfmake-rtl
-[cdnjs_img]: https://img.shields.io/cdnjs/v/pdfmake-rtl.svg?colorB=0E7FBF
 
 <!-- [cndjs_url]: https://cdnjs.com/libraries/pdfmake-rtl -->
 
-**PDFMake RTL** is an enhanced version of PDFMake with **automatic RTL (Right-to-Left) language support** for Arabic, Persian (Farsi), Urdu, and other RTL scripts. No manual configuration needed - just write your content and the library automatically detects and handles RTL text!
+**PDFMake RTL** is an enhanced version of [PDFMake](https://www.npmjs.com/package/pdfmake) with **automatic RTL (Right-to-Left) language support** for Arabic, Persian (Farsi), Urdu, and other RTL scripts. No manual configuration needed—just write your content and the library automatically detects and handles RTL text!
 
 All existing PDFMake code works unchanged, with automatic RTL support added!
 
@@ -41,6 +38,10 @@ PDF document generation library for server-side and client-side in pure JavaScri
 
 Check out [the playground](http://aysnet1.github.io/pdfmake-rtl/playground.html) and [examples](https://github.com/aysnet1/pdfmake-rtl/tree/master/examples).
 
+## documentation
+
+For comprehensive guides, API references, and usage examples, visit the official documentation at [pdfmake.github.io/docs](https://pdfmake.github.io/docs/).
+
 ### Features
 
 #### 🔤 RTL Language Support
@@ -99,8 +100,8 @@ npm install pdfmake-rtl
 ```html
 <!-- Load pdfmake-rtl + fonts -->
 <script src="https://unpkg.com/pdfmake-rtl/build/pdfmake.min.js"></script>
-<!-- <script src="https://unpkg.com/pdfmake-rtl/build/vfs_fonts.js"></script>
-<script src="https://unpkg.com/pdfmake-rtl/build/fonts/Cairo.js"></script> -->
+<script src="https://unpkg.com/pdfmake-rtl/build/vfs_fonts.js"></script>
+<!-- <script src="https://unpkg.com/pdfmake-rtl/build/fonts/Cairo.js"></script> -->
 
 <script>
 	var dd = {
@@ -159,15 +160,15 @@ npm install pdfmake-rtl
 ## ⚡ Quick Start — Node.js (Server-Side)
 
 ```js
-var pdfmake = require("@digicole/pdfmake-rtl");
+var pdfmake = require("pdfmake-rtl");
 
 // Add fonts
 // Cairo is the default font for RTL languages (Arabic, Persian, Urdu)
 // Roboto is the default font for LTR/Latin text
-var Roboto = require("@digicole/pdfmake-rtl/fonts/Roboto");
+var Roboto = require("pdfmake-rtl/fonts/Roboto");
 pdfmake.addFonts(Roboto);
 
-var Cairo = require("@digicole/pdfmake-rtl/fonts/Cairo");
+var Cairo = require("pdfmake-rtl/fonts/Cairo");
 pdfmake.addFonts(Cairo);
 
 var dd = {

package/build/pdfmake.js

@@ -1,4 +1,4 @@
-/*! @digicole/pdfmake-rtl v2.0.0, @license MIT, @link https://github.com/aysnet1/pdfmake-rtl#readme */
+/*! @digicole/pdfmake-rtl v2.1.2, @license MIT, @link https://github.com/aysnet1/pdfmake-rtl#readme */
 (function webpackUniversalModuleDefinition(root, factory) {
 	if(typeof exports === 'object' && typeof module === 'object')
 		module.exports = factory();
@@ -23,7 +23,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 // EXTERNAL MODULE: ./node_modules/pdfkit/js/pdfkit.es.js
-var pdfkit_es = __webpack_require__(1341);
+var pdfkit_es = __webpack_require__(7697);
 ;// ./src/PDFDocument.js
 /* provided dependency */ var Buffer = __webpack_require__(783)["Buffer"];
 
@@ -380,7 +380,7 @@ const ARABIC_RANGE = (/* unused pure expression or super */ null && ([[0x0600, 0
 const PERSIAN_RANGE = (/* unused pure expression or super */ null && ([[0x06A9, 0x06AF],
 // Persian Kaf, Gaf
 [0x06C0, 0x06C3],
-// Persian Heh, Teh Marbuta variants
+// Persian Heh, Marbuta variants
 [0x06CC, 0x06CE],
 // Persian Yeh variants
 [0x06D0, 0x06D5],
@@ -725,6 +725,9 @@ function processRTLTable(tableNode, forceRTL) {
     shouldBeRTL = totalCells > 0 && rtlCellCount / totalCells >= 0.3;
   }
   if (shouldBeRTL) {
+    // Mark the table as RTL for the drawing phase (TableProcessor uses this)
+    tableNode.table._rtl = true;
+
     // Reverse table columns for RTL layout, handling colSpan correctly
     tableNode.table.body = tableNode.table.body.map(row => {
       if (Array.isArray(row)) {
@@ -5281,7 +5284,7 @@ class ElementWriter extends events.EventEmitter {
     const LTR_REGEX = /[A-Za-z\u00C0-\u024F\u1E00-\u1EFF]/;
     const NUMBER_PUNCTUATION_REGEX = /^(\d+)([.:/\-)(]+)(\s*)$/;
     // Characters that are "boundary neutral" — separators/punctuation between scripts
-    const BOUNDARY_NEUTRAL = /[\/\\\-()[\]{}<>:;.,!?@#$%^&*_=+|~`'"،؛؟\s]/;
+    const BOUNDARY_NEUTRAL = /[/\\\-()[\]{}<>:;.,!?@#$%^&*_=+|~`'"،؛؟\s]/;
 
     // --- Step 0: Pre-split inlines at RTL↔neutral and LTR↔neutral boundaries ---
     // e.g. "العربية/" → ["العربية", "/"]  and  "hello-" → ["hello", "-"]
@@ -5393,8 +5396,8 @@ class ElementWriter extends events.EventEmitter {
     // Find matching bracket pairs across runs. If the content between
     // a "(" neutral run and a ")" neutral run is predominantly one direction,
     // merge the opening bracket, content, and closing bracket into that direction.
-    const OPEN_BRACKETS = /[(\[{<]/;
-    const CLOSE_BRACKETS = /[)\]}>]/;
+    const OPEN_BRACKETS = /[(\\[{<]/;
+    //	const CLOSE_BRACKETS = /[)\]}>]/;
     const BRACKET_MATCH = {
       '(': ')',
       '[': ']',
@@ -6227,6 +6230,19 @@ class TableProcessor {
     columnCalculator.buildColumnWidths(tableNode.table.widths, availableWidth, this.offsets.total, tableNode);
     this.tableWidth = tableNode._offsets.total + getTableInnerContentWidth();
     this.rowSpanData = prepareRowSpanData();
+
+    // RTL table right-alignment: shift the table grid to the right
+    // when the table doesn't fill the full available width
+    if (tableNode.table._rtl) {
+      let fullAvailableWidth = writer.context().availableWidth;
+      let rtlOffset = fullAvailableWidth - this.tableWidth;
+      if (rtlOffset > 0.5) {
+        // only shift if there's meaningful space
+        for (let i = 0; i < this.rowSpanData.length; i++) {
+          this.rowSpanData[i].left += rtlOffset;
+        }
+      }
+    }
     this.cleanUpRepeatables = false;
 
     // headersRows and rowsWithoutPageBreak (headerRows + keepWithHeaderRows)
@@ -7570,6 +7586,19 @@ class LayoutBuilder {
     const marginXParent = this.nestedLevel === 1 ? marginX : null;
     const _bottomByPage = tableNode ? tableNode._bottomByPage : null;
     this.writer.context().beginColumnGroup(marginXParent, _bottomByPage);
+
+    // RTL table right-alignment: shift the starting x position to the right
+    // so that the table content aligns with the right-aligned grid
+    if (tableNode && tableNode.table && tableNode.table._rtl) {
+      let tableWidth = tableNode._offsets.total;
+      for (let w = 0; w < widths.length; w++) {
+        tableWidth += widths[w]._calcWidth;
+      }
+      let rtlOffset = this.writer.context().availableWidth - tableWidth;
+      if (rtlOffset > 0.5) {
+        this.writer.context().x += rtlOffset;
+      }
+    }
     for (let i = 0, l = cells.length; i < l; i++) {
       let cell = cells[i];
       let cellIndexBegin = i;
@@ -8702,26 +8731,26 @@ class Renderer {
 
 
 
-/**
- * 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, urlResolver) {
     if (virtualfs === void 0) {
@@ -8735,13 +8764,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) {
     if (options === void 0) {
@@ -8815,9 +8844,9 @@ class PdfPrinter {
     return this.pdfKitDoc;
   }
 
-  /**
-   * @param {object} docDefinition
-   * @returns {Promise}
+  /**
+   * @param {object} docDefinition
+   * @returns {Promise}
    */
   async resolveUrls(docDefinition) {
     const getExtendedUrl = url => {
@@ -8917,11 +8946,11 @@ class PdfPrinter {
     await this.urlResolver.resolved();
   }
 
-  /**
-   * Check if content contains RTL characters
-   * @param {any} content - Document content
-   * @returns {boolean} - True if content contains RTL characters
-   * @private
+  /**
+   * Check if content contains RTL characters
+   * @param {any} content - Document content
+   * @returns {boolean} - True if content contains RTL characters
+   * @private
    */
   _containsRTLContent(content) {
     if (!content) {
@@ -9171,7 +9200,7 @@ class OutputDocument {
 }
 /* harmony default export */ const src_OutputDocument = (OutputDocument);
 // EXTERNAL MODULE: ./node_modules/file-saver/dist/FileSaver.min.js
-var FileSaver_min = __webpack_require__(9304);
+var FileSaver_min = __webpack_require__(553);
 ;// ./src/browser-extensions/OutputDocumentBrowser.js
 
 
@@ -22615,7 +22644,7 @@ module.exports = {
 
 /***/ },
 
-/***/ 1341
+/***/ 7697
 (__unused_webpack_module, exports, __webpack_require__) {
 
 "use strict";
@@ -49726,7 +49755,7 @@ module.exports = function whichTypedArray(value) {
 
 /***/ },
 
-/***/ 9304
+/***/ 553
 (module, exports, __webpack_require__) {
 
 var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_ARRAY__, __WEBPACK_AMD_DEFINE_RESULT__;(function(a,b){if(true)!(__WEBPACK_AMD_DEFINE_ARRAY__ = [], __WEBPACK_AMD_DEFINE_FACTORY__ = (b),