muhammara 2.6.0 → 3.1.0

package/CHANGELOG.md

@@ -7,6 +7,41 @@ 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
+
+- Links in docs
+
+### 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
+- 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
+
+### Changed
+
+- Bump dev dependency versions s
+
+### Breaking
+
+- Node < 11 and Electron < 11 removed
+- Renamed typo exported value from eTokenSeprator to eTokenSeparator
+
 ## [2.6.0] - 2022-06-30
 
 ### Changed
@@ -69,7 +104,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### 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
@@ -93,8 +128,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### 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
 
@@ -109,56 +144,56 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### 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
 
@@ -168,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
 
@@ -226,22 +260,23 @@ 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/2.6.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
 [2.4.0]: https://github.com/julianhille/MuhammaraJS/compare/2.3.0...2.4.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).
 
@@ -22,6 +22,13 @@ If you are looking for a C++ Library go [here](https://github.com/galkahana/PDF-
 Version 2.0 will be incompatible with some older node and
 electron versions because we needed to upgrade node-pre-gyp.
 
+Version 3.x has breaking changes:
+
+- Node < 11 and Electron < 11 removed the prebuilts
+- Renamed typo exported value from eTokenSeprator to eTokenSeparator
+
+This wont affect alot of you but still.
+
 # Installation
 
 ```

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"', {