muhammara 2.6.0 → 3.0.0

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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
@@ -241,7 +263,8 @@ with the following changes.
 
 * Initial release
 
-[Unreleased]: https://github.com/julianhille/MuhammaraJS/compare/2.6.0...HEAD
+[Unreleased]: https://github.com/julianhille/MuhammaraJS/compare/3.0.0...HEAD
+[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/README.md

@@ -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/muhammara.d.ts

@@ -179,9 +179,11 @@ declare module 'muhammara' {
     SC(...colorComponents: number[]): this;
     SCN(...parameters: any[]): this; // This can't be materialized in TypeScript
     ////SCN(...colorComponents: number[], patternName?: string): this;
+    SCN(colorComponents: number[], patternName?: string): this;
     sc(...colorComponents: number[]): this;
     scn(...parameters: any[]): this; // This can't be materialized in TypeScript
     ////scn(...colorComponents: number[], patternName?: string): this;
+    scn(colorComponents: number[], patternName?: string): this;
     G(gray: number): this;
     g(gray: number): this;
     RG(r: number, g: number, b: number): this;
@@ -211,6 +213,7 @@ declare module 'muhammara' {
     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;
     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;
@@ -549,12 +552,12 @@ declare module 'muhammara' {
 
   export type eTokenSeparatorSpace = 0;
   export type eTokenSeparatorEndLine = 1;
-  export type eTokenSepratorNone = 2;
+  export type eTokenSeparatorNone = 2;
 
   enum ETokenSeparator {
     eTokenSeparatorSpace,
     eTokenSeparatorEndLine,
-    eTokenSepratorNone
+    eTokenSeparatorNone
   }
 
   export interface ObjectsContext {

package/node_modules/safe-buffer/package.json

@@ -16,6 +16,7 @@
     "fetchSpec": "~5.2.0"
   },
   "_requiredBy": [
+    "/randombytes",
     "/string_decoder"
   ],
   "_resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",

package/node_modules/set-blocking/package.json

@@ -16,8 +16,7 @@
     "fetchSpec": "^2.0.0"
   },
   "_requiredBy": [
-    "/npmlog",
-    "/yargs"
+    "/npmlog"
   ],
   "_resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz",
   "_shasum": "045f9782d011ae9a6803ddd382b24392b3d890f7",

package/node_modules/string-width/package.json

@@ -16,8 +16,11 @@
     "fetchSpec": "^4.2.3"
   },
   "_requiredBy": [
+    "/cliui",
     "/gauge",
-    "/wide-align"
+    "/wide-align",
+    "/wrap-ansi",
+    "/yargs"
   ],
   "_resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
   "_shasum": "269c7117d27b05ad2e536830a8ec895ef9c6d010",

package/node_modules/strip-ansi/package.json

@@ -16,8 +16,10 @@
     "fetchSpec": "^6.0.1"
   },
   "_requiredBy": [
+    "/cliui",
     "/gauge",
-    "/string-width"
+    "/string-width",
+    "/wrap-ansi"
   ],
   "_resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
   "_shasum": "9e26c63d30f53443e9489495b2105d37b67a85d9",

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "muhammara",
-  "version": "2.6.0",
-  "description": "Create, read and modify PDF files and streams. A drop in replacement for hummujs PDF library",
+  "version": "3.0.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",
   "author": "Julian <j.hille484@gmail.com>",
   "main": "./muhammara.js",
   "types": "./muhammara.d.ts",
   "engines": {
-    "node": ">=8"
+    "node": ">=11"
   },
   "scripts": {
     "install": "node-pre-gyp install --fallback-to-build ${EXTRA_NODE_PRE_GYP_FLAGS:-\"\"}",
@@ -46,8 +46,8 @@
   ],
   "devDependencies": {
     "@types/node": "^18.0.0",
-    "chai": "^4.2.0",
-    "mocha": "^6.2.3",
+    "chai": "^4.3.6",
+    "mocha": "^8.4.0",
     "npm": "^6.14.5"
   },
   "binary": {

package/src/AbstractContentContextDriver.cpp

@@ -816,20 +816,34 @@ METHOD_RETURN_TYPE AbstractContentContextDriver::SCN(const ARGS_TYPE& args)
         SET_FUNCTION_RETURN_VALUE(UNDEFINED)
     }
     
-	if (args.Length() == 0 ||
-        (args.Length() == 1 && !args[0]->IsNumber()))
+	if (
+	    args.Length() == 0 ||
+        (args.Length() == 1 && !(args[0]->IsNumber() || args[0]->IsArray())) ||
+        (args.Length() > 1 && !(args[args.Length()-1]->IsNumber() || args[args.Length()-1]->IsArray() || args[args.Length()-1]->IsString() ))
+
+        )
     {
-		THROW_EXCEPTION("Wrong Arguments, please provide at least one color component");
+		THROW_EXCEPTION("Wrong Arguments, please provide at least one color component or a list of color components and optional a pattern name");
 		SET_FUNCTION_RETURN_VALUE(UNDEFINED)
 	}
-    
+
+    double* components;
+    int componentsLength = 0;
     bool hasPatternArgument = args[args.Length()-1]->IsString();
-    int componentsLength = hasPatternArgument ? args.Length() - 1 : args.Length();
-    
-    double* components = new double[componentsLength];
-    for(int i = 0; i < componentsLength; ++i)
-        components[i] = TO_NUMBER(args[i])->Value();
-    
+    if (!args[0]->IsArray()) {
+        componentsLength = hasPatternArgument ? args.Length() - 1 : args.Length();
+        components = new double[componentsLength];
+        for(int i = 0; i < componentsLength; ++i)
+            components[i] = TO_NUMBER(args[i])->Value();
+    } else {
+        Local<Object> arr = args[0]->TO_OBJECT();
+        componentsLength = TO_INT32(arr->Get(GET_CURRENT_CONTEXT, NEW_STRING("length")).ToLocalChecked())->Value();
+        components = new double[componentsLength];
+        for(int i = 0; i < componentsLength; ++i) {
+           components[i] = TO_NUMBER(arr->Get(GET_CURRENT_CONTEXT, i).ToLocalChecked())->Value();
+       }
+    }
+
     if(hasPatternArgument)
         contentContext->GetContext()->SCN(components,componentsLength,*UTF_8_VALUE(args[args.Length()-1]->TO_STRING()));
     else
@@ -880,20 +894,34 @@ METHOD_RETURN_TYPE AbstractContentContextDriver::scn(const ARGS_TYPE& args)
         SET_FUNCTION_RETURN_VALUE(UNDEFINED)
     }
     
-	if (args.Length() == 0 ||
-        (args.Length() == 1 && !args[0]->IsNumber()))
+    if (
+        args.Length() == 0 ||
+        (args.Length() == 1 && !(args[0]->IsNumber() || args[0]->IsArray())) ||
+        (args.Length() > 1 && !(args[args.Length()-1]->IsNumber() || args[args.Length()-1]->IsArray() || args[args.Length()-1]->IsString() ))
+
+        )
     {
-		THROW_EXCEPTION("Wrong Arguments, please provide at least one color component");
-		SET_FUNCTION_RETURN_VALUE(UNDEFINED)
-	}
-    
+        THROW_EXCEPTION("Wrong Arguments, please provide at least one color component or a list of color components and optional a pattern name");
+        SET_FUNCTION_RETURN_VALUE(UNDEFINED)
+    }
+
+    double* components;
+    int componentsLength = 0;
     bool hasPatternArgument = args[args.Length()-1]->IsString();
-    int componentsLength = hasPatternArgument ? args.Length() - 1 : args.Length();
-    
-    double* components = new double[componentsLength];
-    for(int i = 0; i < componentsLength; ++i)
-        components[i] = TO_NUMBER(args[i])->Value();
-    
+    if (!args[0]->IsArray()) {
+        componentsLength = hasPatternArgument ? args.Length() - 1 : args.Length();
+        components = new double[componentsLength];
+        for(int i = 0; i < componentsLength; ++i)
+            components[i] = TO_NUMBER(args[i])->Value();
+    } else {
+        Local<Object> arr = args[0]->TO_OBJECT();
+        componentsLength = TO_INT32(arr->Get(GET_CURRENT_CONTEXT, NEW_STRING("length")).ToLocalChecked())->Value();
+        components = new double[componentsLength];
+        for(int i = 0; i < componentsLength; ++i) {
+           components[i] = TO_NUMBER(arr->Get(GET_CURRENT_CONTEXT, i).ToLocalChecked())->Value();
+       }
+    }
+
     if(hasPatternArgument)
         contentContext->GetContext()->scn(components,componentsLength,*UTF_8_VALUE(args[args.Length()-1]->TO_STRING()));
     else
@@ -1757,6 +1785,7 @@ METHOD_RETURN_TYPE AbstractContentContextDriver::WriteFreeCode(const ARGS_TYPE&
 }
 
 /* context.drawPath(x1,y1,x2,y2,x3,y3...{type:stroke, color:#FF00FF, width:3, close:true})
+/* context.drawPath([[x1,y1],[x2,y2].....]...{type:stroke, color:#FF00FF, width:3, close:true})
  */
 METHOD_RETURN_TYPE AbstractContentContextDriver::DrawPath(const ARGS_TYPE& args)
 {
@@ -1769,24 +1798,64 @@ METHOD_RETURN_TYPE AbstractContentContextDriver::DrawPath(const ARGS_TYPE& args)
         THROW_EXCEPTION("Null content context. Please create a context");
         SET_FUNCTION_RETURN_VALUE(UNDEFINED)
     }
-    
-    if(args.Length() < 2)
+
+    if(
+        (args.Length() == 1 && !args[0]->IsArray()) ||
+        args.Length() < 2
+    )
     {
-		THROW_EXCEPTION("Wrong Arguments, please provide path coordinates and an optional options object");
+		THROW_EXCEPTION("Wrong Arguments, please provide path coordinates as numbers (x1, y1, x2, y2 etc) or as list of coordinates and an optional options object");
 		SET_FUNCTION_RETURN_VALUE(UNDEFINED)
     }
-    
-    contentContext->SetupColorAndLineWidth(args[args.Length() - 1]);
-    
-    contentContext->GetContext()->m(TO_NUMBER(args[0])->Value(),TO_NUMBER(args[1])->Value());
-    for(int i=2;i<args.Length()-1;i+=2)
+    if (!args[0]->IsArray())
     {
-        if(!args[i]->IsNumber()) // options object, stop
-            break;
-        contentContext->GetContext()->l(TO_NUMBER(args[i])->Value(),TO_NUMBER(args[i+1])->Value());
+        contentContext->SetupColorAndLineWidth(args[args.Length() - 1]);
+        contentContext->GetContext()->m(TO_NUMBER(args[0])->Value(),TO_NUMBER(args[1])->Value());
+        for(int i=2;i<args.Length()-1;i+=2)
+        {
+            if(!args[i]->IsNumber()) // options object, stop
+                break;
+            contentContext->GetContext()->l(TO_NUMBER(args[i])->Value(),TO_NUMBER(args[i+1])->Value());
+        }
+
+        contentContext->FinishPath(args[args.Length() - 1]);
+    }
+    else
+    {
+        Local<Object> outer = args[0]->TO_OBJECT();
+        int arrayLength =TO_INT32(outer->Get(GET_CURRENT_CONTEXT, NEW_STRING("length")).ToLocalChecked())->Value();
+        if(arrayLength <= 1) {
+            THROW_EXCEPTION("Wrong arguments. Coordinate list must have at least one point");
+            SET_FUNCTION_RETURN_VALUE(UNDEFINED);
+        }
+        Local<Object> inner;
+        contentContext->SetupColorAndLineWidth(args[args.Length() - 1]);
+        for(int i=0;i<arrayLength;++i) {
+            inner = outer->Get(GET_CURRENT_CONTEXT, i).ToLocalChecked()->TO_OBJECT();
+
+            if (!inner->IsArray() || TO_INT32(inner->Get(GET_CURRENT_CONTEXT, NEW_STRING("length")).ToLocalChecked())->Value() != 2)
+            {
+               THROW_EXCEPTION("Wrong arguments. Coordinate list must have exactly one x and one y value");
+               SET_FUNCTION_RETURN_VALUE(UNDEFINED);
+               break;
+            }
+            if (i == 0)
+            {
+                contentContext->GetContext()->m(
+                    TO_NUMBER(inner->Get(GET_CURRENT_CONTEXT, 0).ToLocalChecked())->Value(),
+                    TO_NUMBER(inner->Get(GET_CURRENT_CONTEXT, 1).ToLocalChecked())->Value()
+                );
+            }
+            else
+            {
+                contentContext->GetContext()->l(
+                    TO_NUMBER(inner->Get(GET_CURRENT_CONTEXT, 0).ToLocalChecked())->Value(),
+                    TO_NUMBER(inner->Get(GET_CURRENT_CONTEXT, 1).ToLocalChecked())->Value()
+                );
+            }
+        }
+        contentContext->FinishPath(args[args.Length() - 1]);
     }
-    
-    contentContext->FinishPath(args[args.Length() - 1]);
     SET_FUNCTION_RETURN_VALUE(args.This())
 }
 

package/src/deps/PDFWriter/CFFANSIFontWriter.cpp

@@ -147,7 +147,7 @@ void CFFANSIFontWriter::WriteCharSet(	DictionaryContext* inDescriptorContext,
 	for (; it != inEncodedGlyphs.end(); ++it)
 	{
 		std::string glyphName = inFontInfo->GetGlyphName(it->first);
-		primitiveWriter.WriteName(glyphName.c_str(), eTokenSepratorNone);
+		primitiveWriter.WriteName(glyphName.c_str(), eTokenSeparatorNone);
 	}
 
 

package/src/deps/PDFWriter/ETokenSeparator.h

@@ -24,5 +24,5 @@ enum ETokenSeparator
 {
 	eTokenSeparatorSpace,
 	eTokenSeparatorEndLine,
-	eTokenSepratorNone
+	eTokenSeparatorNone
 };

package/src/deps/PDFWriter/ObjectsContext.h

@@ -100,7 +100,7 @@ public:
 
 	// Array writing, currently just writing begin and end brackets
 	void StartArray();
-	void EndArray(ETokenSeparator inSeparate = eTokenSepratorNone);
+	void EndArray(ETokenSeparator inSeparate = eTokenSeparatorNone);
 
 	// Indirect objects writing
 	// override that allocate a new object ID and returns it

package/src/deps/PDFWriter/PDFDocumentHandler.cpp

@@ -1518,7 +1518,7 @@ std::string PDFDocumentHandler::AsEncodedName(const std::string& inName)
 	OutputStringBufferStream aStringBuilder;
 
 	primitiveWriter.SetStreamForWriting(&aStringBuilder);
-	primitiveWriter.WriteName(inName,eTokenSepratorNone);
+	primitiveWriter.WriteName(inName,eTokenSeparatorNone);
 
 	return aStringBuilder.ToString().substr(1); // return without initial forward slash
 }
@@ -1728,7 +1728,7 @@ EStatusCode PDFDocumentHandler::MergeAndReplaceResourcesTokens(	IByteWriter* inT
 		status = traits.CopyToOutputStream(streamReader,(LongBufferSizeType)(it->ResourceTokenPosition - previousContentPosition));
 		if(status != PDFHummus::eSuccess)
 			break;
-		primitivesWriter.WriteName(inMappedResourcesNames.find(it->ResourceToken)->second,eTokenSepratorNone);
+		primitivesWriter.WriteName(inMappedResourcesNames.find(it->ResourceToken)->second,eTokenSeparatorNone);
 		// note that i'm using SkipBy here. if i want to use SkipTo, i have to user the skipper stream as input stream for the rest
 		// of the reader objects here, as SkipTo relies on information on how many bytes were read
 		skipper.SkipBy(it->ResourceToken.size() + 1); // skip the resource name in the read stream [include +1 for slash]

package/src/deps/PDFWriter/PrimitiveObjectsWriter.h

@@ -52,7 +52,7 @@ public:
 	void WriteNull(ETokenSeparator inSeparate = eTokenSeparatorSpace);
 
 	void StartArray();
-	void EndArray(ETokenSeparator inSeparate = eTokenSepratorNone);
+	void EndArray(ETokenSeparator inSeparate = eTokenSeparatorNone);
     
     IByteWriter* GetWritingStream();
 

package/src/muhammara.cpp

@@ -632,7 +632,7 @@ DEF_INIT(MuhammaraInit) {
     // ETokenSeparator
     EXPORTS_SET(exports,NEW_SYMBOL("eTokenSeparatorSpace"),NEW_NUMBER(eTokenSeparatorSpace))
     EXPORTS_SET(exports,NEW_SYMBOL("eTokenSeparatorEndLine"),NEW_NUMBER(eTokenSeparatorEndLine))
-    EXPORTS_SET(exports,NEW_SYMBOL("eTokenSepratorNone"),NEW_NUMBER(eTokenSepratorNone))
+    EXPORTS_SET(exports,NEW_SYMBOL("eTokenSeparatorNone"),NEW_NUMBER(eTokenSeparatorNone))
     
     // EXrefEntryType
     EXPORTS_SET(exports,NEW_SYMBOL("eXrefEntryExisting"),NEW_NUMBER(eXrefEntryExisting))