muhammara 4.1.0 → 5.0.1

package/CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [5.0.1] - 2024-09-28
+
+### Added
+
+- Tests for bold, italic, underline, strikethrough, and highlights in textboxes
+- Add missing node v21 and v22 to the build matrix (#417)
+
+## [5.0.0] - 2024-09-08
+
+### Added
+
+- Add electron 24.7 and 24.8
+- Add electron 25.4, 25.5, 25.6, 25.7, 25.8 and 25.9
+- Add electron 26.0, 26.1, 26.2, 26.3, 26.4, 26.5, 26.6
+- Add electron 27.0, 27.1, 27.2 and 27.3
+- Add electron 28.0, 28.1, 28.2 and 28.3
+- Add electron 29.0, 29.1, 29.2, 29.3 and 29.4
+- Add electron 30.0, 30.1, 30.2, 30.3 and 30.4
+- Add electron 31.0, 31.1, 31.2, 31.3 and 31.4
+- Add electron 32.0
+- Add node v22.0.0
+
+### Remove
+
+- Outdated electron 23.x versions
+- Node version <= 16
+
+### Update
+
+- Update dependencies
+  - Including tar which removes a security vulnerability
+- new Buffer to Buffer.from
+
 ## [4.1.0] - 2023-12-13
 
 ### Fixed
@@ -24,15 +57,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Fixed
 
-- Underline in text object
 - Recipe type / arg documentation
 - Add missing type `userPassword` to `EncryptOptions`
+- Underline in text object
 
 ### Added
 
-- Strikethrough implementation in text object
 - Add electron 23.2., 23.3
 - Recipe infos to readme
+- Strikethrough implementation in text object
 - Electron v24.1, 24.2, 24.3, 24.4, 24.5, 24.6
 - Add node 20.x
 - Add electron v25.0, 25.1, 25.2, 25.3
@@ -412,7 +445,9 @@ with the following changes.
 
 - Initial release
 
-[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/4.1.0...HEAD
+:[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/5.0.1...HEAD
+[5.0.1]: https://github.com/julianhille/MuhammaraJS/compare/5.0.0...5.0.1
+[5.0.0]: https://github.com/julianhille/MuhammaraJS/compare/4.1.0...5.0.0
 [4.1.0]: https://github.com/julianhille/MuhammaraJS/compare/4.0.0...4.1.0
 [4.0.0]: https://github.com/julianhille/MuhammaraJS/compare/3.8.0...4.0.0
 [3.8.0]: https://github.com/julianhille/MuhammaraJS/compare/3.7.0...3.8.0

package/README.md

@@ -4,12 +4,12 @@
 [![Build status](https://github.com/julianhille/MuhammaraJS/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/julianhille/MuhammaraJS/actions/workflows/build.yml)
 
 Welcome to MuhammaraJS.
-A Fast NodeJS Module for Creating, Parsing an Manipulating PDF Files and Streams.
+A Fast NodeJS Module for creating, parsing and manipulating PDF files and streams.
 
 Original Project (CPP base version)
 Project site is [here](http://www.pdfhummus.com).
 
-If you are looking for a C++ Library go [here](https://github.com/galkahana/PDF-Writer).
+If you are looking for a C++ library go [here](https://github.com/galkahana/PDF-Writer).
 
 ## Hummus JS is the base
 
@@ -19,7 +19,7 @@ He did an awesome job, but discontinued hummusjs.
 The documentation for MuhammaraJS / HummusJS is still located at the
 hummusJS github wiki: available [here](https://github.com/galkahana/HummusJS/wiki)
 
-## muhammara-recipe '(formerly known as hummus-recipe) as been added
+## muhammara-recipe (formerly known as hummus-recipe) as been added
 
 Muhammara-recipe and hummus-recipe has been integrated, dependencies updated
 and is now shipped along with muhammara itself.
@@ -49,6 +49,15 @@ This won't affect a lot of you but still.
   This means the glibc has been raised to 2.31 which might break pre-builts for you.
   It is still possible to build for older glibc version.
 
+### Version 5.x
+
+- You may need to update your base linux distro where you use this as muhammara now needs GLIBCXX_3.4.31
+  Github removed ubuntu 18.04 runners and so we build on 20.04 now.
+  Ubuntu 20.04 comes with newer libstdc++6 and this brings newer glibc with it.
+- Node <= 16 pre-builts have been removed
+- Electron <= 23 pre-builts have been removed
+- GCC 13 needed / std ++ 20 (only needed if you compile yourself)
+
 # Installation
 
 ```
@@ -167,7 +176,7 @@ pdfDoc
       stroke: [0, 0, 140],
       fill: [153, 143, 32],
       lineWidth: 5,
-    }
+    },
   )
   .rectangle(240, 400, 50, 50, {
     stroke: "#3b7721",

package/binding.gyp

@@ -7,8 +7,8 @@
             'dependencies': [
                './src/deps/PDFWriter/binding.gyp:pdfwriter'
             ],
-            "cflags_cc": [ "-std=c++17" ],
-            "cflags": [ "-std=c++17" ],
+            "cflags_cc": [ "-std=c++20" ],
+            "cflags": [ "-std=c++20" ],
             'include_dirs': [
                 './src',
                 './src/deps/PDFWriter',
@@ -20,7 +20,7 @@
 				{
 					'AdditionalOptions':
 						[
-						'/std:c++17',
+						'/std:c++20',
 						]
 				}
 			},
@@ -28,7 +28,7 @@
 ['OS=="mac"', {
           'xcode_settings': {
             'CLANG_CXX_LIBRARY': 'libc++',
-             "OTHER_CFLAGS": [ "-std=c++17"]
+             "OTHER_CFLAGS": [ "-std=c++20"]
           }
         }],
           ['OS=="win"', {

package/lib/PDFRStreamForBuffer.js

@@ -14,7 +14,7 @@ function PDFRStreamForBuffer(buffer) {
 PDFRStreamForBuffer.prototype.read = function (inAmount) {
   var amountToRead = inAmount;
   var arr = Array.from(
-    this.buffer.subarray(this.rposition, this.rposition + amountToRead)
+    this.buffer.subarray(this.rposition, this.rposition + amountToRead),
   );
   this.rposition += amountToRead;
   return arr;

package/lib/PDFRStreamForFile.js

@@ -12,7 +12,7 @@ function PDFRStreamForFile(inPath) {
 }
 
 PDFRStreamForFile.prototype.read = function (inAmount) {
-  var buffer = new Buffer(inAmount * 2);
+  var buffer = Buffer.alloc(inAmount * 2);
   var bytesRead = fs.readSync(this.rs, buffer, 0, inAmount, this.rposition);
   var arr = [];
 

package/lib/PDFStreamForResponse.js

@@ -9,7 +9,7 @@ function PDFStreamForResponse(inResponse) {
 
 PDFStreamForResponse.prototype.write = function (inBytesArray) {
   if (inBytesArray.length > 0) {
-    this.response.write(new Buffer(inBytesArray));
+    this.response.write(Buffer.from(inBytesArray));
     this.position += inBytesArray.length;
     return inBytesArray.length;
   } else return 0;

package/lib/PDFWStreamForFile.js

@@ -12,7 +12,7 @@ function PDFWStreamForFile(inPath) {
 
 PDFWStreamForFile.prototype.write = function (inBytesArray) {
   if (inBytesArray.length > 0) {
-    this.ws.write(new Buffer(inBytesArray));
+    this.ws.write(Buffer.from(inBytesArray));
     this.position += inBytesArray.length;
     return inBytesArray.length;
   } else return 0;

package/lib/Recipe.js

@@ -79,7 +79,7 @@ class Recipe {
         this.output,
         Object.assign({}, this.encryptOptions, {
           version: this._getVersion(this.options.version),
-        })
+        }),
       );
     } else {
       this.read();
@@ -90,7 +90,7 @@ class Recipe {
             new muhammara.PDFStreamForResponse(this.outStream),
             Object.assign({}, this.encryptOptions, {
               log: this.logFile,
-            })
+            }),
           );
         } else {
           this.writer = muhammara.createWriterToModify(
@@ -98,7 +98,7 @@ class Recipe {
             Object.assign({}, this.encryptOptions, {
               modifiedFilePath: this.output,
               log: this.logFile,
-            })
+            }),
           );
         }
       } catch (err) {
@@ -122,7 +122,7 @@ class Recipe {
   get position() {
     const { ox, oy } = this._reverseCoordinate(
       this._position.x,
-      this._position.y
+      this._position.y,
     );
     return {
       x: ox,
@@ -222,7 +222,7 @@ class Recipe {
           new muhammara.PDFStreamForResponse(this.outStream),
           Object.assign({}, this.encryptOptions, {
             log: this.logFile,
-          })
+          }),
         );
       } else {
         this.writer = muhammara.createWriterToModify(
@@ -230,7 +230,7 @@ class Recipe {
           Object.assign({}, this.encryptOptions, {
             modifiedFilePath: this.output,
             log: this.logFile,
-          })
+          }),
         );
       }
 
@@ -242,7 +242,7 @@ class Recipe {
       if (this.isBufferSrc) {
         // eslint-disable-next-line no-console
         console.log(
-          "Feature: Inserting Pages is not supported in Buffer Mode yet."
+          "Feature: Inserting Pages is not supported in Buffer Mode yet.",
         );
       } else {
         this._insertPages();

package/lib/muhammara.js

@@ -1,7 +1,7 @@
 var path = require("path");
 var pregyp = require("@mapbox/node-pre-gyp");
 var binding_path = pregyp.find(
-  path.resolve(path.join(__dirname, "../package.json"))
+  path.resolve(path.join(__dirname, "../package.json")),
 );
 var muhammara = (module.exports = require(binding_path));
 var EventEmitter = require("events").EventEmitter;
@@ -17,7 +17,7 @@ muhammara.PDFWriter.prototype.getEvents = function () {
 
 muhammara.PDFWriter.prototype.triggerDocumentExtensionEvent = function (
   eventName,
-  eventParams
+  eventParams,
 ) {
   eventParams.writer = this;
   this.getEvents().emit(eventName, eventParams);

package/lib/recipe/annotation.js

@@ -48,7 +48,7 @@ exports.annot = function annot(
   x,
   y,
   subtype,
-  options = { text: "", width: 0, height: 0 }
+  options = { text: "", width: 0, height: 0 },
 ) {
   const { text, width, height, replies } = options;
   this.annotationsToWrite.push({
@@ -102,7 +102,7 @@ exports._annot = function _annot(subtype, args = {}, pageNumber, ref) {
       open: false,
       flag: "", // 'readonly'
     },
-    options
+    options,
   );
 
   const ex = nWidth ? nWidth : 0;
@@ -133,7 +133,7 @@ exports._annot = function _annot(subtype, args = {}, pageNumber, ref) {
     .writeLiteralStringValue(params.title || "")
     .writeKey("M")
     .writeLiteralStringValue(
-      this.writer.createPDFDate(new Date(params.date)).toString()
+      this.writer.createPDFDate(new Date(params.date)).toString(),
     )
     .writeKey("Open")
     .writeBooleanValue(params.open)

package/lib/recipe/colors.js

@@ -81,7 +81,7 @@ exports.chroma = function chroma(name, value, colorspace = "") {
       // device colorspaces gray, rgb, and cmyk.
       if (![2, 6, 8].includes(value.toString().length)) {
         throw new Error(
-          "Color value has incorrect size for gray, rgb, or cmyk colorspaces"
+          "Color value has incorrect size for gray, rgb, or cmyk colorspaces",
         );
       }
 

package/lib/recipe/coordinate.js

@@ -20,7 +20,7 @@ exports._calibrateCoordinate = function _calibrateCoordinate(
   y,
   offsetX = 0,
   offsetY = 0,
-  pageNumber
+  pageNumber,
 ) {
   pageNumber = pageNumber || this.pageNumber;
   const { height, mediaBox } = this.metadata[pageNumber];
@@ -41,14 +41,14 @@ exports._calibrateCoordinateForAnnots = function _calibrateCoordinateForAnnots(
   y,
   offsetX = 0,
   offsetY = 0,
-  pageNumber
+  pageNumber,
 ) {
   const { nx: tx, ny: ty } = this._calibrateCoordinate(
     x,
     y,
     offsetX,
     offsetY,
-    pageNumber
+    pageNumber,
   );
   const { width, height, rotate, mediaBox } = this.metadata[pageNumber];
   const startX = mediaBox[0];
@@ -78,7 +78,7 @@ exports._calibrateCoordinateForAnnots = function _calibrateCoordinateForAnnots(
     ty,
     360 - rotate,
     rotateOffsetX,
-    rotateOffsetY
+    rotateOffsetY,
   );
   return {
     nx,
@@ -91,7 +91,7 @@ exports._reverseCoordinate = function _reverseCoordinate(
   y,
   offsetX = 0,
   offsetY = 0,
-  pageNumber
+  pageNumber,
 ) {
   pageNumber = pageNumber || this.pageNumber;
   const { height } = this.metadata[pageNumber];

package/lib/recipe/encrypt.js

@@ -44,7 +44,7 @@ exports.permission = function permission(flags = "print") {
 
 exports._getEncryptOptions = function _getEncryptOptions(
   options,
-  addPermissions = true
+  addPermissions = true,
 ) {
   const encryptOptions = {};
 

package/lib/recipe/font.js

@@ -12,7 +12,7 @@ const path = require("path");
 exports.registerFont = function registerFont(
   fontName = "",
   fontSrcPath = "",
-  type = "regular"
+  type = "regular",
 ) {
   return this._registerFont(fontName, fontSrcPath, type);
 };
@@ -55,7 +55,7 @@ exports._loadFonts = function _loadFonts(fontSrcPath) {
 exports._registerFont = function _registerFont(
   fontName,
   fontSrcPath,
-  type = "regular"
+  type = "regular",
 ) {
   this.fonts = this.fonts || {};
   let family = fontName.toLowerCase();
@@ -91,10 +91,10 @@ function _getFontFile(self, options = {}) {
     (options.bold || options.isBold) && (options.italic || options.isItalic)
       ? "bi"
       : options.italic || options.isItalic
-      ? "i"
-      : options.bold || options.isBold
-      ? "b"
-      : "r";
+        ? "i"
+        : options.bold || options.isBold
+          ? "b"
+          : "r";
 
   if (options.font) {
     const fontFamily = self.fonts[options.font.toLowerCase()];

package/lib/recipe/htmlToTextObjects.js

@@ -1,12 +1,12 @@
 const DOMParser = require("@xmldom/xmldom").DOMParser;
 
-exports.htmlToTextObjects = function (htmlCodes) {
+exports.htmlToTextObjects = function (htmlCodes, options = {}) {
   htmlCodes = htmlCodes.replace(/<br\/?>/g, "<p>[@@DONOT_RENDER_THIS@@]</p>");
   const nodes = new DOMParser().parseFromString(
     `<html>${htmlCodes}</html>`,
-    "text/html"
+    "text/html",
   );
-  const textObjects = parseNode(nodes).childs[0].childs;
+  const textObjects = parseNode(nodes, options).childs[0].childs;
   return textObjects;
 };
 
@@ -40,7 +40,7 @@ function isItalicTag(tagName = "") {
   return italicTags.includes(tagName);
 }
 
-function parseNode(node) {
+function parseNode(node, options) {
   const attributes = [];
   const styles = {};
   for (let i in node.attributes) {
@@ -82,6 +82,7 @@ function parseNode(node) {
   const parsedData = {
     value,
     tag: node.tagName,
+    font: options.font,
     isBold: isBoldTag(node.tagName),
     isItalic: isItalicTag(node.tagName),
     underline: node.tagName == "u",
@@ -89,12 +90,14 @@ function parseNode(node) {
     attributes,
     styles,
     needsLineBreaker: needsLineBreaker(node.tagName),
+    size: options.size,
     sizeRatio: getFontSizeRatio(node.tagName),
+    sizeRatios: [getFontSizeRatio(node.tagName)],
     link: node.tagName == "a" ? node.attributes[0].value : null,
     childs: [],
   };
   for (let num in node.childNodes) {
-    parsedData.childs.push(parseNode(node.childNodes[num]));
+    parsedData.childs.push(parseNode(node.childNodes[num], options));
   }
   const ignoreValue = ["\n", "\n\n"];
   parsedData.childs = parsedData.childs.filter((item) => {

package/lib/recipe/image.js

@@ -17,7 +17,7 @@
 exports.image = function image(imgSrc, x, y, options = {}) {
   const { width, height, offsetX, offsetY } = this._getImgOffset(
     imgSrc,
-    options
+    options,
   );
   const imgOptions = {
     transformation: {

package/lib/recipe/info.js

@@ -36,7 +36,7 @@ exports._readInfo = function _readInfo() {
       .getSourceDocumentParser()
       .queryDictionaryObject(
         copyCtx.getSourceDocumentParser().getTrailer(),
-        "Info"
+        "Info",
       );
 
     const oldInfo =
@@ -138,19 +138,19 @@ exports._writeInfo = function _writeInfo() {
         case "modDate":
           infoDictionary.addAdditionalInfoEntry(
             "source-ModDate",
-            oldInfo.modDate
+            oldInfo.modDate,
           );
           break;
         case "creator":
           infoDictionary.addAdditionalInfoEntry(
             "source-Creator",
-            oldInfo.creator
+            oldInfo.creator,
           );
           break;
         case "producer":
           infoDictionary.addAdditionalInfoEntry(
             "source-Producer",
-            oldInfo.producer
+            oldInfo.producer,
           );
           break;
         default:
@@ -301,7 +301,7 @@ exports.structure = function structure(output) {
 
     const itemTrailer = pdfReader.queryDictionaryObject(
       pdfReader.getTrailer(),
-      item
+      item,
     );
     logToFile(item);
     iterateObjectTypes(itemTrailer);

package/lib/recipe/insertPage.js

@@ -13,7 +13,7 @@ const hummusUtils = require("./utils");
 exports.insertPage = function insertPage(
   afterPageNumber,
   pdfSrc,
-  srcPageNumber
+  srcPageNumber,
 ) {
   if (isNaN(afterPageNumber)) {
     throw new Error("The afterPageNumber is inValid.");
@@ -68,7 +68,7 @@ exports._insertPages = function _insertPages() {
         hummusUtils.appendPDFPagesFromPDFWithAnnotations(
           pdfWriter,
           info.pdfSrc,
-          { specificRanges }
+          { specificRanges },
         );
       });
     }

package/lib/recipe/page.js

@@ -111,7 +111,7 @@ exports.editPage = function editPage(pageNumber) {
   const pageModifier = new muhammara.PDFPageModifier(
     pdfWriter,
     pageIndex,
-    true
+    true,
   );
   this.page = pageModifier;
   this.pageNumber = pageNumber;
@@ -135,31 +135,31 @@ exports.editPage = function editPage(pageNumber) {
       `[${startX}, ${startY}] is HERE`,
       startX,
       startY,
-      textOptions
+      textOptions,
     );
     context.writeText(
       `[${startX}, width/2] is HERE`,
       startX,
       width / 2,
-      textOptions
+      textOptions,
     );
     context.writeText(
       `[${startX}, height/2] is HERE`,
       startX,
       height / 2,
-      textOptions
+      textOptions,
     );
     context.writeText(
       `[width/2, ${startY}] is HERE`,
       width / 2,
       startY,
-      textOptions
+      textOptions,
     );
     context.writeText(
       `[height/2, ${startY}] is HERE`,
       height / 2,
       startY,
-      textOptions
+      textOptions,
     );
   }
   return this;
@@ -167,7 +167,7 @@ exports.editPage = function editPage(pageNumber) {
 
 exports._resumePageRotation = function _resumePageRotation(
   pageNumber,
-  context
+  context,
 ) {
   pageNumber = pageNumber || this.pageNumber;
   const {

package/lib/recipe/shapes.js

@@ -88,8 +88,8 @@ function _n_gon(sides, cx, cy, radius, options = {}) {
     lineWidth = options.lineWidth
       ? options.lineWidth
       : options.width
-      ? options.width
-      : 2;
+        ? options.width
+        : 2;
   }
 
   let ngon = [];
@@ -372,7 +372,7 @@ exports.triangle = function triangle(x, y, traits, options = {}) {
 
   if (traits.length !== 3) {
     throw new Error(
-      "Triangle requires 3 traits (sides/angles) for definition."
+      "Triangle requires 3 traits (sides/angles) for definition.",
     );
   }
 
@@ -456,21 +456,21 @@ exports.triangle = function triangle(x, y, traits, options = {}) {
           [ma_A.point(1).x, ma_A.point(1).y],
           [ma_A.point(2).x, ma_A.point(2).y],
         ],
-        { color: "green", width: 0.5 }
+        { color: "green", width: 0.5 },
       );
       this.line(
         [
           [mb_B.point(1).x, mb_B.point(1).y],
           [mb_B.point(2).x, mb_B.point(2).y],
         ],
-        { color: "green", width: 0.5 }
+        { color: "green", width: 0.5 },
       );
       this.line(
         [
           [mc_C.point(1).x, mc_C.point(1).y],
           [mc_C.point(2).x, mc_C.point(2).y],
         ],
-        { color: "green", width: 0.5 }
+        { color: "green", width: 0.5 },
       );
     }
 
@@ -478,7 +478,7 @@ exports.triangle = function triangle(x, y, traits, options = {}) {
       triangle.incenter.point.x,
       triangle.incenter.point.y,
       triangle.incenter.radius,
-      { color: "green", width: 0.5 }
+      { color: "green", width: 0.5 },
     );
     let ctr_A = new Line(triangle.incenter.point, triangle.A);
     let ap = ctr_A.extend(10);
@@ -533,7 +533,7 @@ const Triangle = class Triangle {
         });
         if (sss[0] + sss[1] <= sss[2]) {
           throw new Error(
-            "Not a valid triangle inequality (sum of 2 shortest sides must be greater than third side"
+            "Not a valid triangle inequality (sum of 2 shortest sides must be greater than third side",
           );
         }
 
@@ -550,7 +550,7 @@ const Triangle = class Triangle {
         angC = 180 - angA - angB;
         if (angC <= 0) {
           throw new Error(
-            "Not a valid triangle angle specification (sum of 2 angles must less than 180)"
+            "Not a valid triangle angle specification (sum of 2 angles must less than 180)",
           );
         }
         a = (c * Math.sin(toRadians(angA))) / Math.sin(toRadians(angC));
@@ -861,7 +861,7 @@ exports.arrow = function arrow(x, y, options = {}) {
       head.I[0],
       y - halfShaft,
       head.E[0],
-      y - halfShaft
+      y - halfShaft,
     );
     const ke_shaft_intercept = KE.intersect(shaft_top);
     arrow.joinShaft(ke_shaft_intercept);
@@ -894,7 +894,7 @@ exports.arrow = function arrow(x, y, options = {}) {
         arrow.tip.K,
         arrow.tip.I,
       ],
-      options
+      options,
     );
   } else {
     // Starting at arrow head tip (Pt I below),
@@ -921,7 +921,7 @@ exports.arrow = function arrow(x, y, options = {}) {
         arrow.tip.K,
         arrow.tip.I,
       ],
-      options
+      options,
     ); // back to point of arrow to close polygon
   }
 
@@ -1193,7 +1193,7 @@ const Line = class Line {
     if (!this._length) {
       this._length = Math.sqrt(
         Math.pow(this._pt2.x - this._pt1.x, 2) +
-          Math.pow(this._pt2.y - this._pt1.y, 2)
+          Math.pow(this._pt2.y - this._pt1.y, 2),
       );
     }
 
@@ -1243,7 +1243,7 @@ const Line = class Line {
         deltaX = distance * ss;
         deltaY = slope * deltaX;
         newLen = Math.sqrt(
-          Math.pow(opt.x - (x + deltaX), 2) + Math.pow(opt.y - (y + deltaY), 2)
+          Math.pow(opt.x - (x + deltaX), 2) + Math.pow(opt.y - (y + deltaY), 2),
         );
         break;
     }