muhammara 4.0.0 → 5.0.0

package/CHANGELOG.md

@@ -7,6 +7,47 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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
+
+- definitions: appendPage optionnal parameter
+- Build musl/musl-arm with node 20
+- Support negative rotation in recipe page changes
+- registerFont now returns recipe as stated in typescript definition
+
+### Added
+
+- Add nodejs v21.0.0
+
+## [4.0.0] - 2023-07-14
+
 ### Fixed
 
 - Underline in text object
@@ -21,14 +62,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - 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
+- Option to add annotation replies to annotations
+- Textboxes now show title and date as annotations in pdfs
 
 ### Removed
 
 - Dependency to static-eval and static-module as they are not used directly
+- Node versions: 11.x - 14.x
+- Electron versions: 11.x - 14.2
 
 ### Changed
 
+- Updated node-gyp version to 1.0.10
 - Older node ubuntu 18.04 builds are now building on docker, as github actions removed 18.04
+- CI linux builds use ubuntu 20.04 instead of 18.04 -> glibc Update, see readme for breaking changes in v4
 
 ## [3.8.0] - 2023-03-01
 
@@ -391,7 +438,10 @@ with the following changes.
 
 - Initial release
 
-[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/3.8.0...HEAD
+[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/5.0.0...HEAD
+[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
 [3.7.0]: https://github.com/julianhille/MuhammaraJS/compare/3.6.0...3.7.0
 [3.6.0]: https://github.com/julianhille/MuhammaraJS/compare/3.5.0...3.6.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,12 @@ 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
+
+- 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 +173,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

@@ -5,17 +5,16 @@
 */
 
 function PDFRStreamForBuffer(buffer) {
-  this.innerArray = Array.prototype.slice.call(buffer, 0);
+  this.buffer = buffer;
   this.rposition = 0;
-  this.fileSize = this.innerArray.length;
+  this.fileSize = this.buffer.length;
   this.mStartPosition = 0;
 }
 
 PDFRStreamForBuffer.prototype.read = function (inAmount) {
   var amountToRead = inAmount;
-  var arr = this.innerArray.slice(
-    this.rposition,
-    this.rposition + amountToRead
+  var arr = Array.from(
+    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

@@ -27,30 +27,35 @@ exports.comment = function comment(text = "", x, y, options = {}) {
  * @name annot
  * @function
  * @memberof Recipe
- * @todo support for rich texst RC
+ * @todo support for rich text RC
  * @todo support for opacity CA
  * @param {number} x - The coordinate x
  * @param {number} y - The coordinate y
- * @param {string} subtype - The markup annotation type 'Text'|'FreeText'|'Line'|'Square'|'Circle'|'Polygon'|'PolyLine'|'Highlight'|'Underline'|'Squiggly'|'StrikeOut'|'Stamp'|'Caret'|'Ink'|'FileAttachment'|'Sound'
+ * @param {string} subtype - The markup annotation type 'Text'|'Link'|'FreeText'|'Line'|'Square'|'Circle'|'Polygon'|'PolyLine'|'Highlight'|'Underline'|'Squiggly'|'StrikeOut'|'Caret'|'Stamp'|'Ink'|'Popup'|'FileAttachment'|'Sound'|'Movie'|'Screen'|'Widget'|'PrinterMark'|'TrapNet'|'Watermark'|'3D'|'Redact'|'Projection'|'RichMedia'
  * @param {Object} [options] - The options
  * @param {string} [options.title] - The title.
- * @param {boolean} [options.open=false] - Open the annotation by default?
+ * @param {boolean} [options.open=false] - Open the annotation. Annotation will be closed by default. Specific to text annotations; subtype='Text'
+ * @param {boolean} [options.richText] - Rich text
  * @param {'invisible'|'hidden'|'print'|'nozoom'|'norotate'|'noview'|'readonly'|'locked'|'togglenoview'} [options.flag] - The flag property
- * @param {'Comment'|'Key'|'Note'|'Help'|'NewParagraph'|'Paragraph'|'Insert'} [options.icon] - The icon of annotation.
+ * @param {'Comment'|'Key'|'Note'|'Help'|'NewParagraph'|'Paragraph'|'Insert'} [options.icon='Note'] - The icon of annotation. Specific to text annotations. Default value: 'Note'
  * @param {number} [options.width] - Width
  * @param {number} [options.height] - Height
+ * @param {string} [options.date] - Date of annotation
+ * @param {string} [options.subject] - The subject.
+ * @param {Array} [options.replies] - Array of annotation replies
  */
 exports.annot = function annot(
   x,
   y,
   subtype,
-  options = { text: "", width: 0, height: 0 }
+  options = { text: "", width: 0, height: 0 },
 ) {
-  const { text, width, height } = options;
+  const { text, width, height, replies } = options;
   this.annotationsToWrite.push({
     subtype,
     args: { text, x, y, width, height, options },
     pageNumber: this.pageNumber,
+    replies,
   });
   return this;
 };
@@ -59,8 +64,9 @@ exports.annot = function annot(
 // Link, Popup, Movie, Widget, Screen, PrinterMark, TrapNet, Watermark, 3D
 exports._attachNonMarkupAnnot = function _attachNonMarkupAnnot() {};
 
-exports._annot = function _annot(subtype, args = {}, pageNumber) {
-  const { x, y, width, height, text, options } = args;
+exports._annot = function _annot(subtype, args = {}, pageNumber, ref) {
+  const { x, y, width, height, options, reply } = args;
+  let { text } = args;
   this._startDictionary(pageNumber);
   const { rotate } = this.metadata[pageNumber];
   let { nx, ny } = this._calibrateCoordinateForAnnots(x, y, 0, 0, pageNumber);
@@ -92,17 +98,26 @@ exports._annot = function _annot(subtype, args = {}, pageNumber) {
     {
       title: "",
       subject: "",
-      date: new Date(),
+      date: "",
       open: false,
       flag: "", // 'readonly'
     },
-    options
+    options,
   );
 
   const ex = nWidth ? nWidth : 0;
   const ey = nHeight ? nHeight : 0;
   const position = [nx, ny, nx + ex, ny + ey];
 
+  if (reply && ref) {
+    text = reply.text;
+    params.title = reply.title || params.title;
+    params.date = reply.date || params.date;
+    params.subject = reply.subject || params.subject;
+    params.richText = Boolean(reply.richText);
+    params.flag = reply.flag || params.flag;
+  }
+
   this.dictionaryContext
     .writeKey("Type")
     .writeNameValue("Annot")
@@ -117,7 +132,9 @@ exports._annot = function _annot(subtype, args = {}, pageNumber) {
     .writeKey("T")
     .writeLiteralStringValue(params.title || "")
     .writeKey("M")
-    .writeLiteralStringValue(this.writer.createPDFDate(params.date).toString())
+    .writeLiteralStringValue(
+      this.writer.createPDFDate(new Date(params.date)).toString(),
+    )
     .writeKey("Open")
     .writeBooleanValue(params.open)
     .writeKey("F")
@@ -127,9 +144,9 @@ exports._annot = function _annot(subtype, args = {}, pageNumber) {
    * Rich Text Strings
    * 12.7.3.4
    */
-  if (text && options.richText) {
+  if (text && params.richText) {
     const richText =
-      text.substring(0, 5) !== "<?xml" ? contentToRC(text) : options.richText;
+      text.substring(0, 5) !== "<?xml" ? contentToRC(text) : params.richText;
     const richTextContent = richText;
     this.dictionaryContext
       .writeKey("RC")
@@ -141,6 +158,14 @@ exports._annot = function _annot(subtype, args = {}, pageNumber) {
       .writeLiteralStringValue(textContent);
   }
 
+  if (reply && ref) {
+    this.dictionaryContext
+      .writeKey("IRT")
+      .writeObjectReferenceValue(ref)
+      .writeKey("RT")
+      .writeNameValue("R");
+  }
+
   let { border, color } = options;
 
   if (this._getTextMarkupAnnotationSubtype(subtype)) {
@@ -212,12 +237,19 @@ exports._annot = function _annot(subtype, args = {}, pageNumber) {
   if (params.icon) {
     this.dictionaryContext.writeKey("Name").writeNameValue(params.icon);
   }
-  this._endDictionary(pageNumber);
+  return this._endDictionary(pageNumber);
 };
 
 exports._writeAnnotations = function _writeAnnotations() {
   this.annotationsToWrite.forEach((annot) => {
-    this._annot(annot.subtype, annot.args, annot.pageNumber);
+    const ref = this._annot(annot.subtype, annot.args, annot.pageNumber);
+
+    if (annot.replies) {
+      annot.replies.forEach((reply) => {
+        annot.args.reply = reply;
+        this._annot(annot.subtype, annot.args, annot.pageNumber, ref);
+      });
+    }
   });
   this.annotations.forEach((pageAnnots, index) => {
     this._writeAnnotation(index);
@@ -276,6 +308,8 @@ exports._endDictionary = function _endDictionary(pageNumber) {
   const pageIndex = pageNumber - 1;
   this.annotations[pageIndex] = this.annotations[pageIndex] || [];
   this.annotations[pageIndex].push(this.dictionaryObject);
+
+  return this.dictionaryObject;
 };
 
 exports._getTextMarkupAnnotationSubtype =

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();
@@ -79,6 +79,8 @@ exports._registerFont = function _registerFont(
       break;
   }
   this.fonts[family] = font;
+
+  return this;
 };
 
 function _getFontFile(self, options = {}) {
@@ -89,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

@@ -4,7 +4,7 @@ exports.htmlToTextObjects = function (htmlCodes) {
   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;
   return textObjects;

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 },
         );
       });
     }