muhammara 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.1.0] - 2022-09-30
+
+### Changed
+
+- Update TypeScript declaration for `PDFStreamForResponse` to accept any writable stream as an argument, not just `PDFRStreamForFile`
+
+### Added
+
+- Node 18
+- Electron 20.0, 20.1, 20.2
+- Prettier as dev dependency and basics
+- Electron 19.1
+
 ## [3.0.0] - 2022-07-19
 
 ### Fixed
@@ -16,9 +29,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - drawPath can now be used differently and this new way can be described with ts.
-The old style is `drawPath(x1, y1, x2, y2..., options)` we now allow `drawPath([[x1, y1], [x2, y2]...], options)` too
+  The old style is `drawPath(x1, y1, x2, y2..., options)` we now allow `drawPath([[x1, y1], [x2, y2]...], options)` too
 - scn and SCN can now be used differently and this new way can be described with ts.
-  The old style is `scn(c1, c2, c3, c4, ..., 'patternName')` we now allow `scn([[c1, c2, c3, c4, ...],  'patternName')` too
+  The old style is `scn(c1, c2, c3, c4, ..., 'patternName')` we now allow `scn([[c1, c2, c3, c4, ...], 'patternName')` too
 
 ### Changed
 
@@ -91,7 +104,7 @@ The old style is `drawPath(x1, y1, x2, y2..., options)` we now allow `drawPath([
 ### Added
 
 - Add Electron 13.3.0
-- Documentation (copy of  the wiki)
+- Documentation (copy of the wiki)
 - Add Electron 13.2.3
 - Add Electron 13.5.0
 - Add Electron 14.0.1
@@ -115,8 +128,8 @@ The old style is `drawPath(x1, y1, x2, y2..., options)` we now allow `drawPath([
 
 ### Fixed
 
-* Yarn v2 incompatibiliy
-* Build issues on mac OS big sur
+- Yarn v2 incompatibiliy
+- Build issues on mac OS big sur
 
 ## [1.8.0] - 2021-05-28
 
@@ -131,56 +144,56 @@ The old style is `drawPath(x1, y1, x2, y2..., options)` we now allow `drawPath([
 
 ### Added
 
-* More electron 11.x releases
-* Add electron 12.0.0
-* Add electron 10.2, 10.3
-* Add electron 9.4, 9.3
+- More electron 11.x releases
+- Add electron 12.0.0
+- Add electron 10.2, 10.3
+- Add electron 9.4, 9.3
 
 ## [1.6.0] - 2021-02-17
 
 ### Fixed
 
-* Update the g++ compiler from 4.8 to 5.4 (default on xenial) for linux builds
-* Changed builds from travis and app veyor to github
+- Update the g++ compiler from 4.8 to 5.4 (default on xenial) for linux builds
+- Changed builds from travis and app veyor to github
 
 ### Added
 
-* Electron 11
-* Added Node 15
+- Electron 11
+- Added Node 15
 
 ## [1.5.1] - 2020-10-10
 
 ### Added
 
-* Added manual workflow to reduce release errors
+- Added manual workflow to reduce release errors
 
 ### Fixed
 
-* Huge package size as npm publish does not use .gitignore or .npmignore locally
+- Huge package size as npm publish does not use .gitignore or .npmignore locally
 
 ## [1.5.0] - 2020-10-10
 
 ### Added
 
-* Electron 7.3, 8.3, 8.4, 8.5 and 9.3
+- Electron 7.3, 8.3, 8.4, 8.5 and 9.3
 
 ## [1.4.3] - 2020-10-09
 
 ### Fixed
 
-* Return code fixed for builds on app veyor.
-* Winwdows builds successfully with electron 10.x
-* NPM version on app veyor fixed to build electron 2.x again
+- Return code fixed for builds on app veyor.
+- Winwdows builds successfully with electron 10.x
+- NPM version on app veyor fixed to build electron 2.x again
 
 ### Added
 
-* Add electron 10.1.3
+- Add electron 10.1.3
 
 ## [1.4.2] - 2020-08-27
 
 ### Added
 
-* Add electron 10.0
+- Add electron 10.0
 
 ## [1.4.1] - 2020-08-13
 
@@ -190,56 +203,55 @@ debug output.
 
 ### Fixed
 
-* Removed debug output from packaged dependency `node-pre-gyp`
-
+- Removed debug output from packaged dependency `node-pre-gyp`
 
 ## [1.4.0] - 2020-08-10
 
 ### Added
 
-* Add electron 9.2
+- Add electron 9.2
 
 ## [1.3.0] - 2020-08-06
 
 ### Added
 
-* Add electron-9.1 pre built
+- Add electron-9.1 pre built
 
 ### Fixed
 
-* Add missing typescript declaration files to published packages
+- Add missing typescript declaration files to published packages
 
 ## [1.2.0] - 2020-06-01
 
 ### Fixed
 
-* Updated freetype to 2.10.0
-* Updated libpng dependency to 1.6.37
-* Updated libaesgm dependency
-* Update libjpeg dependency to 9d
-* Updated libtiff dependency to 3.9.7
+- Updated freetype to 2.10.0
+- Updated libpng dependency to 1.6.37
+- Updated libaesgm dependency
+- Update libjpeg dependency to 9d
+- Updated libtiff dependency to 3.9.7
 
 ## [1.1.0] - 2020-05-27
 
 ### Added
 
-* Added infos about being hummusjs drop in replacement
-* Added electron v9.0.0
+- Added infos about being hummusjs drop in replacement
+- Added electron v9.0.0
 
 ### Fixed
 
-* Updated dependencies and dev dependencies
+- Updated dependencies and dev dependencies
 
 ## [1.0.1] - 2020-05-08
 
 ### Fixed
 
-* Fixed readme to include infos about muhammaraJS and hummus
-* Fixed node-pre-gyp binary download links
+- Fixed readme to include infos about muhammaraJS and hummus
+- Fixed node-pre-gyp binary download links
 
 ### Removed
 
-* Unecessary dependency on aws-sdk
+- Unecessary dependency on aws-sdk
 
 ## [1.0.0] - 2020-05-07
 
@@ -248,22 +260,22 @@ with the following changes.
 
 ### Added
 
-* Store releases @github
-* Listen for tags instead of a commit message
-* Added node v13, v14, electron 6.1, 7.1, 7.2, 8.0, 8.1, 8.2
+- Store releases @github
+- Listen for tags instead of a commit message
+- Added node v13, v14, electron 6.1, 7.1, 7.2, 8.0, 8.1, 8.2
 
 ### Fixed
 
-* Updated v8:GET / v8:SET calls which are incompatible with newer node version (>13)
+- Updated v8:GET / v8:SET calls which are incompatible with newer node version (>13)
 
 ### Removed
 
-* Dropped support for electron 1.8
-
+- Dropped support for electron 1.8
 
-* Initial release
+- Initial release
 
-[Unreleased]: https://github.com/julianhille/MuhammaraJS/compare/3.0.0...HEAD
+[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/3.1.0...HEAD
+[3.1.0]: https://github.com/julianhille/MuhammaraJS/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/julianhille/MuhammaraJS/compare/2.6.0...3.0.0
 [2.6.0]: https://github.com/julianhille/MuhammaraJS/compare/2.5.0...2.6.0
 [2.5.0]: https://github.com/julianhille/MuhammaraJS/compare/2.4.0...2.5.0

package/PDFRStreamForBuffer.js

@@ -4,38 +4,40 @@
     @author Luciano Júnior
 */
 
-function PDFRStreamForBuffer(buffer){
-    this.innerArray = Array.prototype.slice.call(buffer, 0);
-    this.rposition = 0;
-    this.fileSize = this.innerArray.length;
-}
-
-PDFRStreamForBuffer.prototype.read = function(inAmount){
-    var amountToRead = inAmount;
-    var arr = this.innerArray.slice(this.rposition,this.rposition+amountToRead);
-    this.rposition += amountToRead;
-    return arr;
-}
-
-PDFRStreamForBuffer.prototype.notEnded = function(){
-    return this.rposition < this.fileSize;
-}
-
-PDFRStreamForBuffer.prototype.setPosition = function(inPosition){
-    this.rposition = inPosition;
-}
-
-PDFRStreamForBuffer.prototype.setPositionFromEnd = function(inPosition){
-    this.rposition = this.fileSize-inPosition;
-}
-
-PDFRStreamForBuffer.prototype.skip = function(inAmount){
-    this.rposition += inAmount;
-}
-
-PDFRStreamForBuffer.prototype.getCurrentPosition = function(){
-    return this.rposition;
+function PDFRStreamForBuffer(buffer) {
+  this.innerArray = Array.prototype.slice.call(buffer, 0);
+  this.rposition = 0;
+  this.fileSize = this.innerArray.length;
 }
 
+PDFRStreamForBuffer.prototype.read = function (inAmount) {
+  var amountToRead = inAmount;
+  var arr = this.innerArray.slice(
+    this.rposition,
+    this.rposition + amountToRead
+  );
+  this.rposition += amountToRead;
+  return arr;
+};
+
+PDFRStreamForBuffer.prototype.notEnded = function () {
+  return this.rposition < this.fileSize;
+};
+
+PDFRStreamForBuffer.prototype.setPosition = function (inPosition) {
+  this.rposition = inPosition;
+};
+
+PDFRStreamForBuffer.prototype.setPositionFromEnd = function (inPosition) {
+  this.rposition = this.fileSize - inPosition;
+};
+
+PDFRStreamForBuffer.prototype.skip = function (inAmount) {
+  this.rposition += inAmount;
+};
+
+PDFRStreamForBuffer.prototype.getCurrentPosition = function () {
+  return this.rposition;
+};
 
 module.exports = PDFRStreamForBuffer;

package/PDFRStreamForFile.js

@@ -1,58 +1,49 @@
-var fs = require('fs');
+var fs = require("fs");
 /*
     PDFRStreamForFile is an implementation of a read stream using the supplied file path.
 */
 
-function PDFRStreamForFile(inPath)
-{
-    this.rs = fs.openSync(inPath,'r');
-    this.path = inPath;
-    this.rposition = 0;
-    this.fileSize = fs.statSync(inPath)["size"];
+function PDFRStreamForFile(inPath) {
+  this.rs = fs.openSync(inPath, "r");
+  this.path = inPath;
+  this.rposition = 0;
+  this.fileSize = fs.statSync(inPath)["size"];
 }
 
-PDFRStreamForFile.prototype.read = function(inAmount)
-{
-    var buffer = new Buffer(inAmount*2);
-    var bytesRead = fs.readSync(this.rs, buffer, 0, inAmount,this.rposition);
-    var arr = [];
+PDFRStreamForFile.prototype.read = function (inAmount) {
+  var buffer = new Buffer(inAmount * 2);
+  var bytesRead = fs.readSync(this.rs, buffer, 0, inAmount, this.rposition);
+  var arr = [];
 
-    for(var i=0;i<bytesRead;++i)
-        arr.push(buffer[i]);
-    this.rposition+=bytesRead;
-    return arr;
-}
+  for (var i = 0; i < bytesRead; ++i) arr.push(buffer[i]);
+  this.rposition += bytesRead;
+  return arr;
+};
 
-PDFRStreamForFile.prototype.notEnded = function()
-{
-    return this.rposition < this.fileSize;
-}
+PDFRStreamForFile.prototype.notEnded = function () {
+  return this.rposition < this.fileSize;
+};
 
-PDFRStreamForFile.prototype.setPosition = function(inPosition)
-{
-    this.rposition = inPosition;
-}
+PDFRStreamForFile.prototype.setPosition = function (inPosition) {
+  this.rposition = inPosition;
+};
 
-PDFRStreamForFile.prototype.setPositionFromEnd = function(inPosition)
-{
-    this.rposition = this.fileSize-inPosition;
-}
+PDFRStreamForFile.prototype.setPositionFromEnd = function (inPosition) {
+  this.rposition = this.fileSize - inPosition;
+};
 
-PDFRStreamForFile.prototype.skip = function(inAmount)
-{
-    this.rposition += inAmount;
-}
+PDFRStreamForFile.prototype.skip = function (inAmount) {
+  this.rposition += inAmount;
+};
 
-PDFRStreamForFile.prototype.getCurrentPosition = function()
-{
-    return this.rposition;
-}
+PDFRStreamForFile.prototype.getCurrentPosition = function () {
+  return this.rposition;
+};
 
 function noop() {}
 
-PDFRStreamForFile.prototype.close = function(inCallback)
-{
-    fs.close(this.rs,inCallback ? inCallback : noop);
+PDFRStreamForFile.prototype.close = function (inCallback) {
+  fs.close(this.rs, inCallback ? inCallback : noop);
 };
 
-module.exports = PDFRStreamForFile;
+module.exports = PDFRStreamForFile;

package/PDFStreamForResponse.js

@@ -2,28 +2,21 @@
     PDFStreamForResponse is an implementation of a write stream that writes directly to an HTTP response.
     Using this stream frees the user from having to create a PDF file on disk when generating on-demand PDFs
 */
-function PDFStreamForResponse(inResponse)
-{
-    this.response = inResponse;
-    this.position = 0;
+function PDFStreamForResponse(inResponse) {
+  this.response = inResponse;
+  this.position = 0;
 }
 
-PDFStreamForResponse.prototype.write = function(inBytesArray)
-{
-    if(inBytesArray.length > 0)
-    {
-        this.response.write(new Buffer(inBytesArray));
-        this.position+=inBytesArray.length;
-        return inBytesArray.length;
-    }
-    else
-        return 0;
+PDFStreamForResponse.prototype.write = function (inBytesArray) {
+  if (inBytesArray.length > 0) {
+    this.response.write(new Buffer(inBytesArray));
+    this.position += inBytesArray.length;
+    return inBytesArray.length;
+  } else return 0;
 };
 
-
-PDFStreamForResponse.prototype.getCurrentPosition = function()
-{
-    return this.position;
+PDFStreamForResponse.prototype.getCurrentPosition = function () {
+  return this.position;
 };
 
-module.exports = PDFStreamForResponse;
+module.exports = PDFStreamForResponse;

package/PDFWStreamForBuffer.js

@@ -1,32 +1,25 @@
-function PDFWStreamForBuffer()
-{
-    this.buffer = null;
-    this.position = 0;
+function PDFWStreamForBuffer() {
+  this.buffer = null;
+  this.position = 0;
 }
 
-PDFWStreamForBuffer.prototype.write = function(inBytesArray)
-{
-    if(inBytesArray.length > 0)
-    {
-        if(!this.buffer)
-        {
-            this.buffer = Buffer.from(inBytesArray);
-        }
-        else
-        {
-            this.buffer = Buffer.concat([this.buffer, Buffer.from(inBytesArray)]);
-        }
-
-        this.position += inBytesArray.length;
-        return inBytesArray.length;
+PDFWStreamForBuffer.prototype.write = function (inBytesArray) {
+  if (inBytesArray.length > 0) {
+    if (!this.buffer) {
+      this.buffer = Buffer.from(inBytesArray);
+    } else {
+      this.buffer = Buffer.concat([this.buffer, Buffer.from(inBytesArray)]);
     }
 
-    return 0;
+    this.position += inBytesArray.length;
+    return inBytesArray.length;
+  }
+
+  return 0;
 };
 
-PDFWStreamForBuffer.prototype.getCurrentPosition = function()
-{
-    return this.position;
+PDFWStreamForBuffer.prototype.getCurrentPosition = function () {
+  return this.position;
 };
 
 module.exports = PDFWStreamForBuffer;

package/PDFWStreamForFile.js

@@ -1,51 +1,38 @@
-var fs = require('fs');
+var fs = require("fs");
 
 /*
     PDFWStreamForFile is an implementation of a write stream using the supplied file path.
 */
 
-function PDFWStreamForFile(inPath)
-{
-    this.ws = fs.createWriteStream(inPath);
-    this.position = 0;
-    this.path = inPath;
+function PDFWStreamForFile(inPath) {
+  this.ws = fs.createWriteStream(inPath);
+  this.position = 0;
+  this.path = inPath;
 }
 
-PDFWStreamForFile.prototype.write = function(inBytesArray)
-{
-    if(inBytesArray.length > 0)
-    {
-        this.ws.write(new Buffer(inBytesArray));
-        this.position+=inBytesArray.length;
-        return inBytesArray.length;
-    }
-    else
-        return 0;
+PDFWStreamForFile.prototype.write = function (inBytesArray) {
+  if (inBytesArray.length > 0) {
+    this.ws.write(new Buffer(inBytesArray));
+    this.position += inBytesArray.length;
+    return inBytesArray.length;
+  } else return 0;
 };
 
-PDFWStreamForFile.prototype.getCurrentPosition = function()
-{
-    return this.position;
+PDFWStreamForFile.prototype.getCurrentPosition = function () {
+  return this.position;
 };
 
-PDFWStreamForFile.prototype.close = function(inCallback)
-{
-    if(this.ws)
-    {
-        var self = this;
+PDFWStreamForFile.prototype.close = function (inCallback) {
+  if (this.ws) {
+    var self = this;
 
-        this.ws.end(function()
-        {
-            self.ws = null;
-            if(inCallback)
-                inCallback();
-        })
-    }
-    else
-    {
-        if(inCallback)
-            inCallback();
-    }
+    this.ws.end(function () {
+      self.ws = null;
+      if (inCallback) inCallback();
+    });
+  } else {
+    if (inCallback) inCallback();
+  }
 };
 
-module.exports = PDFWStreamForFile;
+module.exports = PDFWStreamForFile;

package/README.md

@@ -1,4 +1,5 @@
 # Welcome to MuhammaraJS
+
 [![NPM version](http://img.shields.io/npm/v/muhammara.svg?style=flat)](https://www.npmjs.org/package/muhammara)
 [![Build status](https://github.com/julianhille/MuhammaraJS/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/julianhille/MuhammaraJS/actions/workflows/build.yml)
 
@@ -11,7 +12,6 @@ hummusJS github wiki: available [here](https://github.com/galkahana/HummusJS/wik
 Welcome to HummusJS.
 A Fast NodeJS Module for Creating, Parsing an Manipulating PDF Files and Streams.
 
-
 Original Project
 Project site is [here](http://www.pdfhummus.com).
 

package/binding.gyp

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

package/muhammara.d.ts

@@ -1,4 +1,4 @@
-declare module 'muhammara' {
+declare module "muhammara" {
   import EventEmitter = require("events");
   export type PosX = number;
   export type PosY = number;
@@ -16,33 +16,36 @@ declare module 'muhammara' {
 
   export function createWriter(
     input: FilePath | WriteStream,
-    options?: PDFWriterOptions,
+    options?: PDFWriterOptions
   ): PDFWriter;
   export function createWriterToModify(
     inFile: FilePath,
-    options?: PDFWriterToModifyOptions,
+    options?: PDFWriterToModifyOptions
   ): PDFWriter;
   export function createWriterToModify(
     inStream: ReadStream,
     outStream: WriteStream,
-    options?: PDFWriterToModifyOptions,
+    options?: PDFWriterToModifyOptions
   ): PDFWriter;
 
   export function createWriterToContinue(
     restartFile: string,
     restartStateFile: string,
-    options?: PDFWriterToContinueOptions,
+    options?: PDFWriterToContinueOptions
   ): PDFWriter;
-  export function createReader(input: FilePath | ReadStream, options?: PDFReaderOptions): PDFReader;
+  export function createReader(
+    input: FilePath | ReadStream,
+    options?: PDFReaderOptions
+  ): PDFReader;
   export function recrypt(
     originalPdfPath: FilePath,
     newPdfPath: FilePath,
-    options?: PDFRecryptOptions,
+    options?: PDFRecryptOptions
   ): void;
   export function recrypt(
     originalPdfStream: PDFRStreamForFile | PDFRStreamForBuffer,
     newPdfStream: PDFWStreamForFile | PDFWStreamForBuffer,
-    options?: PDFRecryptOptions,
+    options?: PDFRecryptOptions
   ): void;
 
   export interface WriteStream {
@@ -73,7 +76,7 @@ declare module 'muhammara' {
     new (
       writer: PDFWriter,
       pageIndex?: number,
-      ensureContentEncapsulation?: boolean,
+      ensureContentEncapsulation?: boolean
     ): PDFPageModifier;
     startContext(): this;
     getContext(): XObjectContentContext;
@@ -83,12 +86,12 @@ declare module 'muhammara' {
       left: number,
       bottom: number,
       right: number,
-      top: number,
+      top: number
     ): this;
     writePage(): this;
   }
 
-  export type PDFImageType = 'JPG' | 'PDF' | 'PNG' | 'TIFF'
+  export type PDFImageType = "JPG" | "PDF" | "PNG" | "TIFF";
 
   export interface PDFRStreamForFile extends ReadStream {
     new (inPath: FilePath): PDFRStreamForFile;
@@ -105,41 +108,45 @@ declare module 'muhammara' {
   }
 
   export interface GraphicOptions extends ColorOptions {
-    type?: 'stroke' | 'fill' | 'clip';
+    type?: "stroke" | "fill" | "clip";
     width?: number;
     close?: boolean;
   }
-  export type TransformationMatrix = [a: number, b: number, c: number, d: number, e: number, f: number]
-
+  export type TransformationMatrix = [
+    a: number,
+    b: number,
+    c: number,
+    d: number,
+    e: number,
+    f: number
+  ];
 
   enum LineJoinStyle {
     LINEJOIN_ROUND,
     LINEJOIN_BEVEL,
     LINEJOIN_MITER_VARIABLE,
-    LINEJOIN_MITER          = 2,
-    LINEJOIN_MITER_FIXED    = 3
+    LINEJOIN_MITER = 2,
+    LINEJOIN_MITER_FIXED = 3,
   }
 
-  enum EEncoding
-  {
-    EEncodingText = 'text',
-    EEncodingCode = 'code',
-    EEncodingHex = 'hex'
+  enum EEncoding {
+    EEncodingText = "text",
+    EEncodingCode = "code",
+    EEncodingHex = "hex",
   }
 
   enum LineCapStyle {
     LINECAP_BUTT = 0,
     LINECAP_ROUND,
-    LINECAP_SQUARE
+    LINECAP_SQUARE,
   }
 
   export interface TextRenderOptions {
-    encoding?: EEncoding
+    encoding?: EEncoding;
   }
 
   export type Glyph = Array<[number, number]>;
 
-
   export interface AbstractContentContext {
     b(): this;
     B(): this;
@@ -208,24 +215,39 @@ declare module 'muhammara' {
     Tf(fontReferenced: UsedFont | string, fontSize: number): this;
     Tj(text: string | Glyph): this;
     Quote(text: string | Glyph): this;
-    DoubleQuote(wordSpacing: number, characterString: number, text: string | Glyph): this;
+    DoubleQuote(
+      wordSpacing: number,
+      characterString: number,
+      text: string | Glyph
+    ): this;
     TJ(value: string | Glyph, options?: TextRenderOptions): this;
     writeFreeCode(freeCode: string): this;
     drawPath(...parameters: any[]): this; // This can't be materialized in TypeScript
     ////drawPath(...xyPairs: number[], options: GraphicOptions): this;
-    drawPath(xyPairs:  Array<[number, number]>, options: GraphicOptions): this;
+    drawPath(xyPairs: Array<[number, number]>, options: GraphicOptions): this;
     drawCircle(x: PosX, y: PosY, r: number, options: GraphicOptions): this;
     drawSquare(x: PosX, y: PosY, l: number, options: GraphicOptions): this;
-    drawRectangle(x: PosX, y: PosY, w: number, h: number, options: GraphicOptions): this;
+    drawRectangle(
+      x: PosX,
+      y: PosY,
+      w: number,
+      h: number,
+      options: GraphicOptions
+    ): this;
     writeText(text: string, x: PosX, y: PosY, options?: WriteTextOptions): this;
-    drawImage(x: PosX, y: PosY, imagePath: string, options?: ImageOptions): this;
+    drawImage(
+      x: PosX,
+      y: PosY,
+      imagePath: string,
+      options?: ImageOptions
+    ): this;
   }
 
   export interface TransformationObject {
     width: number;
     height: number;
     proportional?: boolean;
-    fit?: 'always' | 'overflow';
+    fit?: "always" | "overflow";
   }
 
   export interface ImageOptions {
@@ -251,9 +273,9 @@ declare module 'muhammara' {
   }
 
   export interface PDFStreamForResponse extends WriteStream {
-    new (res: PDFRStreamForFile): PDFStreamForResponse;
+    new (res: NodeJS.WritableStream): PDFStreamForResponse;
   }
-	
+
   export interface PDFWStreamForBuffer extends WriteStream {
     new (): PDFWStreamForBuffer;
     buffer: Promise<any>;
@@ -330,7 +352,7 @@ declare module 'muhammara' {
 
   export interface ResourcesDictionary {
     addFormXObjectMapping(formXObject: FormXObject): string;
-    addImageXObjectMapping(imageXObject: ImageXObject|number): string;
+    addImageXObjectMapping(imageXObject: ImageXObject | number): string;
     addProcsetResource(procSetName: string): void;
     addExtGStateMapping(stateObjectId: number): string;
     addFontMapping(fontObjectId: number): string;
@@ -369,7 +391,10 @@ declare module 'muhammara' {
   }
 
   export interface UsedFont {
-    calculateTextDimensions(text: string | any, fontSize: number): TextDimension;
+    calculateTextDimensions(
+      text: string | any,
+      fontSize: number
+    ): TextDimension;
   }
 
   export interface ByteWriter {
@@ -395,7 +420,10 @@ declare module 'muhammara' {
     getPagesCount(): number;
     getTrailer(): PDFDictionary;
     queryDictionaryObject(dictionary: PDFDictionary, name: string): PDFObject;
-    queryArrayObject(objectList: PDFArray, index: number): undefined|PDFObject;
+    queryArrayObject(
+      objectList: PDFArray,
+      index: number
+    ): undefined | PDFObject;
     parseNewObject(objectId: number): PDFObject;
     getPageObjectID(objectId: number): number;
     parsePageDictionary(objectId: number): PDFDictionary;
@@ -403,7 +431,11 @@ declare module 'muhammara' {
     getObjectsCount(): number;
     isEncrypted(): boolean;
     getXrefSize(): number;
-    getXrefEntry(objectId: number): { objectPosition: number, revision: number, type: number };
+    getXrefEntry(objectId: number): {
+      objectPosition: number;
+      revision: number;
+      type: number;
+    };
     getXrefSize(): number;
     getXrefPosition(objectId: number): number;
     startReadingFromStream(inputStream: PDFStreamInput): ByteReader;
@@ -464,30 +496,30 @@ declare module 'muhammara' {
   export interface OutputFile {
     openFile(filePath: FilePath, append?: boolean): void;
     closeFile(): void;
-    getFilePath(): string|undefined;
-    getOutputStream(): ByteWriterWithPosition|undefined;
+    getFilePath(): string | undefined;
+    getOutputStream(): ByteWriterWithPosition | undefined;
   }
 
   export interface InputFile {
     openFile(filePath: FilePath): void;
     closeFile(): void;
-    getFilePath(): string|undefined;
-    getFileSize(): number|undefined;
-    getInputStream(): ByteReaderWithPosition|undefined;
+    getFilePath(): string | undefined;
+    getFileSize(): number | undefined;
+    getInputStream(): ByteReaderWithPosition | undefined;
   }
 
-    export enum EInfoTrapped {
-      EInfoTrappedTrue,
-      EInfoTrappedFalse,
-      EInfoTrappedUnknown
-    }
+  export enum EInfoTrapped {
+    EInfoTrappedTrue,
+    EInfoTrappedFalse,
+    EInfoTrappedUnknown,
+  }
 
   export interface InfoDictionary {
     addAdditionalInfoEntry(key: string, value: string): void;
     removeAdditionalInfoEntry(key: string): void;
     clearAdditionalInfoEntries(): void;
     getAdditionalInfoEntry(key: string): string;
-    getAdditionalInfoEntries(key: string): {[key: string]: string}
+    getAdditionalInfoEntries(key: string): { [key: string]: string };
     setCreationDate(date: string | Date): void;
     setModDate(date: string | Date): void;
 
@@ -519,15 +551,21 @@ declare module 'muhammara' {
     ): number;
     mergePDFPageToPage(target: PDFPage, sourcePageIndex: number): void;
     appendPDFPageFromPDF(sourcePageNumber: number): number; // stream start bytes?
-    mergePDFPageToFormXObject(sourcePage: PDFPage, targetPageNumber: number): void;
-    getSourceDocumentParser(input: FilePath | ReadStream, options?: PDFReaderOptions): PDFReader;
+    mergePDFPageToFormXObject(
+      sourcePage: PDFPage,
+      targetPageNumber: number
+    ): void;
+    getSourceDocumentParser(
+      input: FilePath | ReadStream,
+      options?: PDFReaderOptions
+    ): PDFReader;
     copyDirectObjectAsIs(objectToCopy: PDFObject): void;
     copyObject(objectId: number): number;
     copyDirectObjectWithDeepCopy(objectToCopy: PDFObject): Array<number>;
     copyNewObjectsForDirectObject(objectIds: Array<number>): void;
     getCopiedObjectID(objectId: number): number;
-    getCopiedObjects(): {[key: string]: number};
-    replaceSourceObjects(replaceMap: {[key: string]: number}): void;
+    getCopiedObjects(): { [key: string]: number };
+    replaceSourceObjects(replaceMap: { [key: string]: number }): void;
     getSourceDocumentStream(): ByteReaderWithPosition;
   }
 
@@ -540,13 +578,13 @@ declare module 'muhammara' {
     writeNameValue(nameValue: string): this;
     writeRectangleValue(values: Array<number>): this;
     writeRectangleValue(a: number, b: number, c: number, d: number): this;
-    writeLiteralStringValue(literal: Array<number>|string): this;
+    writeLiteralStringValue(literal: Array<number> | string): this;
     writeBooleanValue(boolValue: boolean): this;
     writeObjectReferenceValue(objectId: number): this;
   }
 
   export interface ByteWriterWithPosition {
-    write(bytes: Array<number>):  number;
+    write(bytes: Array<number>): number;
     getCurrentPosition(): number;
   }
 
@@ -557,7 +595,7 @@ declare module 'muhammara' {
   enum ETokenSeparator {
     eTokenSeparatorSpace,
     eTokenSeparatorEndLine,
-    eTokenSeparatorNone
+    eTokenSeparatorNone,
   }
 
   export interface ObjectsContext {
@@ -569,7 +607,10 @@ declare module 'muhammara' {
     endLine(): this;
     endDictionary(dictionary: DictionaryContext): this;
     endIndirectObject(): this;
-    writeIndirectObjectReference(objectId: FormXObjectId, generationNumber?: number): this;
+    writeIndirectObjectReference(
+      objectId: FormXObjectId,
+      generationNumber?: number
+    ): this;
     startNewIndirectObject(objectId: FormXObjectId): this;
     startNewIndirectObject(): FormXObjectId;
     startModifiedIndirectObject(objectId: FormXObjectId): this;
@@ -647,7 +688,12 @@ declare module 'muhammara' {
     PhotoshopYDensity?: number;
   }
 
-  export type PDFRectangle = [lowerLeftX: number, lowerLeftY: number, upperRightX: number, upperRightY: number];
+  export type PDFRectangle = [
+    lowerLeftX: number,
+    lowerLeftY: number,
+    upperRightX: number,
+    upperRightY: number
+  ];
 
   export interface MergeOptions {
     password?: string;
@@ -657,8 +703,7 @@ declare module 'muhammara' {
 
   export interface AppendOptions extends MergeOptions {}
 
-  export type inInterPagesCallback = () => {}
-
+  export type inInterPagesCallback = () => {};
 
   export interface PDFWriter {
     end(): PDFWriter;
@@ -668,33 +713,82 @@ declare module 'muhammara' {
     writePageAndReturnID(page: PDFPage): number;
     startPageContentContext(page: PDFPage): PageContentContext;
     pausePageContentContext(pageContextContext: PageContentContext): this;
-    createFormXObject(x: PosX, y: PosY, width: Width, height: Height, objectId?: FormXObjectId): FormXObject;
+    createFormXObject(
+      x: PosX,
+      y: PosY,
+      width: Width,
+      height: Height,
+      objectId?: FormXObjectId
+    ): FormXObject;
     endFormXObject(formXObject: FormXObject): this;
-    createFormXObjectFromJPG(file: FilePath | PDFRStreamForFile, objectId?: FormXObjectId): FormXObject;
+    createFormXObjectFromJPG(
+      file: FilePath | PDFRStreamForFile,
+      objectId?: FormXObjectId
+    ): FormXObject;
     getFontForFile(inFontFilePath: FilePath, index?: number): UsedFont;
     getFontForFile(
       inFontFilePath: FilePath,
       inOptionalMetricsFile?: string,
-      index?: number,
+      index?: number
     ): UsedFont;
-    attachURLLinktoCurrentPage(url: string, x: PosX, y: PosY, width: Width, height: Height): this;
+    attachURLLinktoCurrentPage(
+      url: string,
+      x: PosX,
+      y: PosY,
+      width: Width,
+      height: Height
+    ): this;
     shutdown(outputFilePath: FilePath): this;
-    createFormXObjectFromTIFF(filePath: FilePath | PDFRStreamForFile, objectId?: FormXObjectId): FormXObject;
-    createImageXObjectFromJPG(filePath: FilePath | PDFRStreamForFile, objectId?: FormXObjectId): ImageXObject;
-    createFormXObjectFromPNG(filePath: FilePath | PDFRStreamForFile, objectId?: FormXObjectId): FormXObject;
+    createFormXObjectFromTIFF(
+      filePath: FilePath | PDFRStreamForFile,
+      objectId?: FormXObjectId
+    ): FormXObject;
+    createImageXObjectFromJPG(
+      filePath: FilePath | PDFRStreamForFile,
+      objectId?: FormXObjectId
+    ): ImageXObject;
+    createFormXObjectFromPNG(
+      filePath: FilePath | PDFRStreamForFile,
+      objectId?: FormXObjectId
+    ): FormXObject;
     retrieveJPGImageInformation(filePath: FilePath): JPEGInformation;
     getObjectsContext(): ObjectsContext;
     getDocumentContext(): DocumentContext;
-    appendPDFPagesFromPDF(source: FilePath | ReadStream, options?: AppendOptions): number[];
-    mergePDFPagesToPage(page: PDFPage, file: FilePath | PDFRStreamForFile, options?: MergeOptions, callback?: inInterPagesCallback): this;
-    mergePDFPagesToPage(page: PDFPage, file: FilePath | PDFRStreamForFile, callback?: inInterPagesCallback) : this;
-    createPDFCopyingContext(source: FilePath | ReadStream): DocumentCopyingContext;
-    createFormXObjectsFromPDF(file: FilePath, box?: PDFBox |  PDFPageBoxType, options?: MergeOptions, transformation?: TransformationMatrix, objectIds?: FormXObjectId[]): FormXObjectId[];
+    appendPDFPagesFromPDF(
+      source: FilePath | ReadStream,
+      options?: AppendOptions
+    ): number[];
+    mergePDFPagesToPage(
+      page: PDFPage,
+      file: FilePath | PDFRStreamForFile,
+      options?: MergeOptions,
+      callback?: inInterPagesCallback
+    ): this;
+    mergePDFPagesToPage(
+      page: PDFPage,
+      file: FilePath | PDFRStreamForFile,
+      callback?: inInterPagesCallback
+    ): this;
+    createPDFCopyingContext(
+      source: FilePath | ReadStream
+    ): DocumentCopyingContext;
+    createFormXObjectsFromPDF(
+      file: FilePath,
+      box?: PDFBox | PDFPageBoxType,
+      options?: MergeOptions,
+      transformation?: TransformationMatrix,
+      objectIds?: FormXObjectId[]
+    ): FormXObjectId[];
     createPDFCopyingContextForModifiedFile(): DocumentCopyingContext;
     createPDFTextString(): PDFTextString;
     createPDFDate(): PDFDate;
-    getImageDimensions(inFontFilePath: FilePath | ReadStream): RectangleDimension;
-    getImagePagesCount(imagePath: FilePath, options?: {password?: string}): number;
+    getImageDimensions(
+      inFontFilePath: FilePath | ReadStream
+    ): RectangleDimension;
+    getImagePagesCount(
+      imagePath: FilePath,
+      options?: { password?: string }
+    ): number;
     getImageType(imagePath: FilePath): PDFImageType | undefined;
     getModifiedFileParser(): PDFReader;
     getModifiedInputFile(): InputFile;
@@ -704,6 +798,9 @@ declare module 'muhammara' {
 
     /* Js Extensions (in muhammara.js) */
     getEvents(): EventEmitter;
-    triggerDocumentExtensionEvent(eventName: string | symbol, eventParams: any): void;
+    triggerDocumentExtensionEvent(
+      eventName: string | symbol,
+      eventParams: any
+    ): void;
   }
 }

package/muhammara.js

@@ -1,31 +1,34 @@
-var fs = require('fs');
-var path = require('path');
-var pregyp = require('@mapbox/node-pre-gyp');
-var binding_path = pregyp.find(path.resolve(path.join(__dirname,'./package.json')));
-var muhammara = module.exports = require(binding_path);
-var EventEmitter = require('events').EventEmitter;
+var fs = require("fs");
+var path = require("path");
+var pregyp = require("@mapbox/node-pre-gyp");
+var binding_path = pregyp.find(
+  path.resolve(path.join(__dirname, "./package.json"))
+);
+var muhammara = (module.exports = require(binding_path));
+var EventEmitter = require("events").EventEmitter;
 
 /*
     addons to PDFWriter prototype for events listening
 */
 
-muhammara.PDFWriter.prototype.getEvents = function() {
-    if(!this.events)
-        this.events = new EventEmitter();
-    return this.events;
-}
-
-muhammara.PDFWriter.prototype.triggerDocumentExtensionEvent = function(eventName, eventParams) {
-    eventParams.writer = this;
-    this.getEvents().emit(eventName,eventParams);
-}
+muhammara.PDFWriter.prototype.getEvents = function () {
+  if (!this.events) this.events = new EventEmitter();
+  return this.events;
+};
 
+muhammara.PDFWriter.prototype.triggerDocumentExtensionEvent = function (
+  eventName,
+  eventParams
+) {
+  eventParams.writer = this;
+  this.getEvents().emit(eventName, eventParams);
+};
 
 /*
     addon class for simple node wrappers
 */
-muhammara.PDFStreamForResponse = require('./PDFStreamForResponse');
-muhammara.PDFWStreamForFile = require('./PDFWStreamForFile');
-muhammara.PDFRStreamForFile = require('./PDFRStreamForFile');
-muhammara.PDFRStreamForBuffer = require('./PDFRStreamForBuffer');
-muhammara.PDFWStreamForBuffer = require('./PDFWStreamForBuffer');
+muhammara.PDFStreamForResponse = require("./PDFStreamForResponse");
+muhammara.PDFWStreamForFile = require("./PDFWStreamForFile");
+muhammara.PDFRStreamForFile = require("./PDFRStreamForFile");
+muhammara.PDFRStreamForBuffer = require("./PDFRStreamForBuffer");
+muhammara.PDFWStreamForBuffer = require("./PDFWStreamForBuffer");

package/node_modules/@mapbox/node-pre-gyp/CHANGELOG.md

@@ -1,5 +1,8 @@
 # node-pre-gyp changelog
 
+## 1.0.10
+- Upgraded minimist to 1.2.6 to address dependabot alert [CVE-2021-44906](https://nvd.nist.gov/vuln/detail/CVE-2021-44906)
+
 ## 1.0.9
 - Upgraded node-fetch to 2.6.7 to address [CVE-2022-0235](https://www.cve.org/CVERecord?id=CVE-2022-0235)
 - Upgraded detect-libc to 2.0.0 to use non-blocking NodeJS(>=12) Report API

package/node_modules/@mapbox/node-pre-gyp/README.md

@@ -81,7 +81,7 @@ Options include:
  - `--runtime=node-webkit`: customize the runtime: `node`, `electron` and `node-webkit` are the valid options
  - `--fallback-to-build`: fallback to building from source if pre-built binary is not available
  - `--target=0.4.0`: Pass the target node or node-webkit version to compile against
- - `--target_arch=ia32`: Pass the target arch and override the host `arch`. Valid values are 'ia32','x64', or `arm`.
+ - `--target_arch=ia32`: Pass the target arch and override the host `arch`. Any value that is [supported by Node.js](https://nodejs.org/api/os.html#osarch) is valid.
  - `--target_platform=win32`: Pass the target platform and override the host `platform`. Valid values are `linux`, `darwin`, `win32`, `sunos`, `freebsd`, `openbsd`, and `aix`.
 
 Both `--build-from-source` and `--fallback-to-build` can be passed alone or they can provide values. You can pass `--fallback-to-build=false` to override the option as declared in package.json. In addition to being able to pass `--build-from-source` you can also pass `--build-from-source=myapp` where `myapp` is the name of your module.

package/node_modules/@mapbox/node-pre-gyp/package.json

@@ -1,8 +1,8 @@
 {
   "_from": "@mapbox/node-pre-gyp@^1.0.5",
-  "_id": "@mapbox/node-pre-gyp@1.0.9",
+  "_id": "@mapbox/node-pre-gyp@1.0.10",
   "_inBundle": false,
-  "_integrity": "sha512-aDF3S3rK9Q2gey/WAttUlISduDItz5BU3306M9Eyv6/oS40aMprnopshtlKTykxRNIBEZuRMaZAnbrQ4QtKGyw==",
+  "_integrity": "sha512-4ySo4CjzStuprMwk35H5pPbkymjv1SF3jGLj6rAHp/xT/RF7TL7bd9CTm1xDY49K2qF7jmR/g7k+SkLETP6opA==",
   "_location": "/@mapbox/node-pre-gyp",
   "_phantomChildren": {},
   "_requested": {
@@ -19,8 +19,8 @@
   "_requiredBy": [
     "/"
   ],
-  "_resolved": "https://registry.npmjs.org/@mapbox/node-pre-gyp/-/node-pre-gyp-1.0.9.tgz",
-  "_shasum": "09a8781a3a036151cdebbe8719d6f8b25d4058bc",
+  "_resolved": "https://registry.npmjs.org/@mapbox/node-pre-gyp/-/node-pre-gyp-1.0.10.tgz",
+  "_shasum": "8e6735ccebbb1581e5a7e652244cadc8a844d03c",
   "_spec": "@mapbox/node-pre-gyp@^1.0.5",
   "_where": "/home/runner/work/MuhammaraJS/MuhammaraJS",
   "author": {
@@ -93,5 +93,5 @@
     "update-crosswalk": "node scripts/abi_crosswalk.js",
     "upload-coverage": "nyc report --reporter json && codecov --clear --flags=unit --file=./coverage/coverage-final.json"
   },
-  "version": "1.0.9"
+  "version": "1.0.10"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "muhammara",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Create, read and modify PDF files and streams. A drop in replacement for hummusjs PDF library",
   "homepage": "https://github.com/julianhille/Muhammarajs",
   "license": "Apache-2.0",
@@ -13,6 +13,7 @@
   "scripts": {
     "install": "node-pre-gyp install --fallback-to-build ${EXTRA_NODE_PRE_GYP_FLAGS:-\"\"}",
     "test": "mocha -R tap ./tests/*.js --timeout 15000",
+    "test:codestyle": "npx prettier -c ./",
     "test:electron": "electron-mocha -R tap ./tests/*.js --timeout 15000",
     "package": "node-pre-gyp package"
   },
@@ -41,14 +42,12 @@
   "dependencies": {
     "@mapbox/node-pre-gyp": "^1.0.5"
   },
-  "bundledDependencies": [
-    "@mapbox/node-pre-gyp"
-  ],
   "devDependencies": {
     "@types/node": "^18.0.0",
     "chai": "^4.3.6",
     "mocha": "^8.4.0",
-    "npm": "^6.14.5"
+    "npm": "^6.14.5",
+    "prettier": "^2.7.1"
   },
   "binary": {
     "module_name": "muhammara",
@@ -59,5 +58,8 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
-  }
+  },
+  "bundleDependencies": [
+    "@mapbox/node-pre-gyp"
+  ]
 }