muhammara 3.8.0 → 4.0.0

package/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Fixed
+
+- Underline in text object
+- Recipe type / arg documentation
+- Add missing type `userPassword` to `EncryptOptions`
+
+### Added
+
+- Strikethrough implementation in text object
+- Add electron 23.2., 23.3
+- Recipe infos to readme
+- 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
+
+### Removed
+
+- Dependency to static-eval and static-module as they are not used directly
+
+### Changed
+
+- Older node ubuntu 18.04 builds are now building on docker, as github actions removed 18.04
+
 ## [3.8.0] - 2023-03-01
 
 ### Added

package/README.md

@@ -28,15 +28,26 @@ It serves as a drop in replacement.
 
 # Caution
 
-Version 2.0 will be incompatible with some older node and
+## Breaking changes
+
+### Version 2.x
+
+will be incompatible with some older node and
 electron versions because we needed to upgrade node-pre-gyp.
 
-Version 3.x has breaking changes:
+### Version 3.x
 
 - Node < 11 and Electron < 11 removed the prebuilts
 - Renamed typo exported value from eTokenSeprator to eTokenSeparator
 
-This wont affect alot of you but still.
+This won't affect a lot of you but still.
+
+### Version 4.x
+
+- Node < 15 and electron < 15 pre-builts have been removed
+- Ubuntu 18.04 has been removed from github actions and so it is unable to build on 18.04.
+  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.
 
 # Installation
 
@@ -82,3 +93,249 @@ You can find samples and documentation [here](./docs/Home.md)
 To generate the documentation you could clone this repo and execute:
 
 `npm run recipe-jsdoc`
+
+## Recipe
+
+### Instructions
+
+- [GetStarted](#getstarted)
+- [Coordinate System](#coordinate-system)
+- [Create a new PDF](#create-a-new-pdf)
+- [Modify an existing PDF](#modify-an-existing-pdf)
+- [PDF Pages/Info/Structure](#page-info)
+- [Append PDF](#append-pdf)
+- [Insert PDF](#insert-pdf)
+- [Overlay PDF](#overlay-pdf)
+- [Split PDF](#split-pdf)
+- [Encryption](#encryption)
+
+### GetStarted
+
+```bash
+const Recipe = require('muhammara').Recipe
+```
+
+### Coordinate System
+
+In order to make things easier, I use `Left-Top` as center `[0,0]` instead of `Left-Bottom`.
+You may write and edit the pdf like you write things on papers from the left top corner.
+It is similar to the [Html Canvas](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/drawImage)
+
+```javascript
+pdfDoc
+    .text('start from here', 0, 0)
+    .text('next line', 0, 20)
+    .text('some other texts', 100, 100)
+    ...
+```
+
+### Create a new PDF
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+
+const pdfDoc = new Recipe("new", "output.pdf", {
+  version: 1.6,
+  author: "John Doe",
+  title: "Hummus Recipe",
+  subject: "A brand new PDF",
+});
+
+pdfDoc.createPage("letter-size").endPage().endPDF();
+```
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("new", "output.pdf");
+
+pdfDoc
+  // 1st Page
+  .createPage("letter-size")
+  .circle("center", 100, 30, { stroke: "#3b7721", fill: "#eee000" })
+  .polygon(
+    [
+      [50, 250],
+      [100, 200],
+      [512, 200],
+      [562, 250],
+      [512, 300],
+      [100, 300],
+      [50, 250],
+    ],
+    {
+      color: [153, 143, 32],
+      stroke: [0, 0, 140],
+      fill: [153, 143, 32],
+      lineWidth: 5,
+    }
+  )
+  .rectangle(240, 400, 50, 50, {
+    stroke: "#3b7721",
+    fill: "#eee000",
+    lineWidth: 6,
+    opacity: 0.3,
+  })
+  .moveTo(200, 600)
+  .lineTo("center", 650)
+  .lineTo(412, 600)
+  .text("Welcome to Hummus-Recipe", "center", 250, {
+    color: "#066099",
+    fontSize: 30,
+    bold: true,
+    font: "Helvatica",
+    align: "center center",
+    opacity: 0.8,
+    rotation: 180,
+  })
+  .text("some text box", 450, 400, {
+    color: "#066099",
+    fontSize: 20,
+    font: "Courier New",
+    strikeOut: true,
+    highlight: {
+      color: [255, 0, 0],
+    },
+    textBox: {
+      width: 150,
+      lineHeight: 16,
+      padding: [5, 15],
+      style: {
+        lineWidth: 1,
+        stroke: "#00ff00",
+        fill: "#ff0000",
+        dash: [20, 20],
+        opacity: 0.1,
+      },
+    },
+  })
+  .comment("Feel free to open issues to help us!", "center", 100)
+  .endPage()
+  // 2nd page
+  .createPage("A4", 90)
+  .circle(150, 150, 300)
+  .endPage()
+  // end and save
+  .endPDF(() => {
+    /* done! */
+  });
+```
+
+#### Create a new PDF as a Buffer
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+
+const pdfDoc = new Recipe(Buffer.from("new"), null, {
+  version: 1.6,
+  author: "John Doe",
+  title: "Hummus Recipe",
+  subject: "A brand new PDF",
+});
+
+const pdfBuffer = pdfDoc.createPage("letter-size").endPage().endPDF();
+```
+
+### Modify an existing PDF
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+
+pdfDoc
+  // edit 1st page
+  .editPage(1)
+  .text("Add some texts to an existing pdf file", 150, 300)
+  .rectangle(20, 20, 40, 100)
+  .comment("Add 1st comment annotation", 200, 300)
+  .image("/path/to/image.jpg", 20, 100, { width: 300, keepAspectRatio: true })
+  .endPage()
+  // edit 2nd page
+  .editPage(2)
+  .comment("Add 2nd comment annotation", 200, 100)
+  .endPage()
+  // end and save
+  .endPDF();
+```
+
+### Page Info
+
+```javascript
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+console.log(pdfDoc.pageInfo(1));
+```
+
+#### Print the pdf structure
+
+```javascript
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+
+recipe.structure("pdf-structure.txt").endPDF(done);
+```
+
+### Append PDF
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+const longPDF = "/longPDF.pdf";
+
+pdfDoc
+  // just page 10
+  .appendPage(longPDF, 10)
+  // page 4 and page 6
+  .appendPage(longPDF, [4, 6])
+  // page 1-3 and 6-20
+  .appendPage(longPDF, [
+    [1, 3],
+    [6, 20],
+  ])
+  // all pages
+  .appendPage(longPDF)
+  .endPDF();
+```
+
+### Insert PDF
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+
+pdfDoc
+  // insert page3 from longPDF to current page 2
+  .insertPage(2, "/longPDF.pdf", 3)
+  .endPDF();
+```
+
+### Overlay PDF
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+
+pdfDoc.overlay("/overlayPDF.pdf").endPDF();
+```
+
+### Split PDF
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("input.pdf");
+const outputDir = path.join(__dirname, "output");
+
+pdfDoc.split(outputDir, "prefix").endPDF();
+```
+
+### Encryption
+
+```javascript
+const Recipe = require("muhammara").Recipe;
+const pdfDoc = new Recipe("input.pdf", "output.pdf");
+
+pdfDoc
+  .encrypt({
+    userPassword: "123",
+    ownerPassword: "123",
+    userProtectionFlag: 4,
+  })
+  .endPDF();
+```

package/lib/Recipe.js

@@ -9,7 +9,7 @@ const streams = require("memory-streams");
  * @namespace
  * @constructor
  * @param {string} src - The file path or Buffer of the src file.
- * @param {string} output - The path of the output file.
+ * @param {string} [output] - The path of the output file uses src if its not a buffer.
  * @param {Object} [options] - The options for pdfDoc
  * @param {number} [options.version] - The pdf version
  * @param {string} [options.author] - The author

package/lib/recipe/htmlToTextObjects.js

@@ -85,6 +85,7 @@ function parseNode(node) {
     isBold: isBoldTag(node.tagName),
     isItalic: isItalicTag(node.tagName),
     underline: node.tagName == "u",
+    strikeOut: node.tagName == "del",
     attributes,
     styles,
     needsLineBreaker: needsLineBreaker(node.tagName),

package/lib/recipe/overlay.js

@@ -9,6 +9,7 @@ const { xObjectForm } = require("./xObjectForm");
  * @param {number} x - The coordinate x
  * @param {number} y - The coordinate y
  * @param {number} [options.scale] - Scale the overlay pdf, default is 1
+ * @param {number} [options.page] - Page of the overlay pdf, default is 1
  * @param {boolean} [options.keepAspectRatio] - To keep the aspect ratio when scaling, default is true
  * @param {boolean} [options.fitWidth] - To set the width to 100% (use with keepAspectRatio=true)
  * @param {boolean} [options.fitHeight] - To set the height to 100% (use with keepAspectRatio=true)

package/lib/recipe/text.js

@@ -359,12 +359,8 @@ exports.text = function text(text = "", x, y, options = {}) {
       const addUnderline = (x, y, ctx, options) => {
         // underline implementation
         if (options.underline) {
-          // console.log(textWidth, lineWidth, currentLineWidth)
           const underlineY = y - options.textHeight * 0.1;
-          //  TODO: fix the line with calculation
-          const width =
-            currentLineWidth -
-            (isHTML || toWriteTextObject.text.endsWith(" ") ? spaceWidth : 0);
+          const width = options.lineWidth;
           ctx
             .q()
             .drawPath(x, underlineY, x + width, underlineY, options)
@@ -372,6 +368,18 @@ exports.text = function text(text = "", x, y, options = {}) {
         }
       };
 
+      const addStrikeOut = (x, y, ctx, options) => {
+        // strikethrough implementation
+        if (options.strikeOut) {
+          const strikeOutY = y + options.textHeight * 0.2;
+          const width = options.lineWidth;
+          ctx
+            .q()
+            .drawPath(x, strikeOutY, x + width, strikeOutY, options)
+            .Q();
+        }
+      };
+
       const addTextTraits = (ctx, options) => {
         ctx.Tf(options.font, options.size);
         ctx.Tc(options.charSpace);
@@ -394,6 +402,7 @@ exports.text = function text(text = "", x, y, options = {}) {
         ctx.ET();
 
         addUnderline(x, y, ctx, options);
+        addStrikeOut(x, y, ctx, options);
       };
 
       const justifyText = (left, x, wto, textBox, ctx, options, callback) => {
@@ -416,7 +425,7 @@ exports.text = function text(text = "", x, y, options = {}) {
 
       const writeText = (context, x, y, wto) => {
         const options = wto.writeOptions;
-        const { lineHeight, text, baseline } = wto;
+        const { lineWidth, lineHeight, text, baseline } = wto;
         let next_x = 0;
 
         if (text === "") {
@@ -424,6 +433,10 @@ exports.text = function text(text = "", x, y, options = {}) {
           return next_x;
         }
 
+        if (options.underline || options.strikeOut) {
+          options.lineWidth = lineWidth;
+        }
+
         // Produce a hilite under words?
         if (options.hilite) {
           const bgColor = options.hilite.color || "#ffff00";
@@ -798,6 +811,9 @@ exports._layoutText = function _layoutText(textObjects, textBox, pathOptions) {
         child.underline = textObject.underline
           ? textObject.underline
           : child.underline;
+        child.strikeOut = textObject.strikeOut
+          ? textObject.strikeOut
+          : child.strikeOut;
 
         child.lineID = textObject.lineID;
         writeValue(child);
@@ -1075,6 +1091,7 @@ function makeTextObjects(self, textObject = {}, pathOptions, textBox = {}) {
     color: textObject.styles.color,
     opacity: parseFloat(textObject.styles.opacity || pathOptions.opacity || 1),
     underline: textObject.underline || pathOptions.underline,
+    strikeOut: textObject.strikeOut || pathOptions.strikeOut,
     size: textObject.size,
     alignHorizontal: alignHorizontal,
     alignVertical: alignVertical,

package/lib/recipe/vector.helper.js

@@ -16,6 +16,7 @@ exports._getPathOptions = function _getPathOptions(
     size: options.size || this.current.defaultFontSize,
     charSpace: options.charSpace || 0,
     underline: false,
+    strikeOut: false,
     color: this._transformColor(options.color, {
       colorspace: colorspace,
       colorName: options.colorName,

package/muhammara.d.ts

@@ -263,6 +263,8 @@ declare module "muhammara" {
 
   export interface WriteTextOptions extends FontOptions, ColorOptions {
     underline?: boolean;
+    strikeOut?: boolean;
+    lineWidth?: number;
   }
 
   export interface XObjectContentContext extends AbstractContentContext {}
@@ -883,6 +885,7 @@ declare module "muhammara" {
     interface EncryptOptions {
       password?: string;
       ownerPassword?: string;
+      userPassword?: string;
       userProtectionFlag?: number;
     }
 
@@ -904,6 +907,7 @@ declare module "muhammara" {
     }
 
     interface OverlayOptions {
+      page?: number;
       scale?: number;
       keepAspectRatio?: boolean;
       fitWidth?: boolean;
@@ -929,16 +933,26 @@ declare module "muhammara" {
     }
 
     interface TextOptions {
+      charSpace?: number;
       color?: string | number[];
+      flow?: boolean;
+      overflow?: () => void;
+      layout?: number | string;
       opacity?: number;
       rotation?: number;
-      rotationOrigin?: number[];
+      rotationOrigin?: [number, number];
       font?: string;
       size?: number;
       align?: string;
       highlight?: boolean;
       underline?: boolean;
       strikeOut?: boolean;
+      hilite?:
+        | boolean
+        | {
+            color?: string | number[];
+            opacity?: number;
+          };
       textBox?: TextBox;
     }
 
@@ -993,7 +1007,7 @@ declare module "muhammara" {
   }
 
   export class Recipe {
-    constructor(src: string, output: string, options?: Recipe.RecipeOptions);
+    constructor(src: string, output?: string, options?: Recipe.RecipeOptions);
 
     constructor(buffer: Buffer, options?: Recipe.RecipeOptions);
 
@@ -1047,7 +1061,12 @@ declare module "muhammara" {
 
     editPage(pageNumber: number): Recipe;
 
-    pageInfo(pageNumber: number): Recipe;
+    pageInfo(pageNumber: number): {
+      width: number;
+      height: number;
+      rotate: number;
+      pageNumber: number;
+    };
 
     split(outputDir: string, prefix: string): Recipe;
 

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

@@ -1,5 +1,5 @@
 {
-  "_from": "@mapbox/node-pre-gyp@^1.0.5",
+  "_from": "@mapbox/node-pre-gyp@^1.0.10",
   "_id": "@mapbox/node-pre-gyp@1.0.10",
   "_inBundle": false,
   "_integrity": "sha512-4ySo4CjzStuprMwk35H5pPbkymjv1SF3jGLj6rAHp/xT/RF7TL7bd9CTm1xDY49K2qF7jmR/g7k+SkLETP6opA==",
@@ -8,20 +8,20 @@
   "_requested": {
     "type": "range",
     "registry": true,
-    "raw": "@mapbox/node-pre-gyp@^1.0.5",
+    "raw": "@mapbox/node-pre-gyp@^1.0.10",
     "name": "@mapbox/node-pre-gyp",
     "escapedName": "@mapbox%2fnode-pre-gyp",
     "scope": "@mapbox",
-    "rawSpec": "^1.0.5",
+    "rawSpec": "^1.0.10",
     "saveSpec": null,
-    "fetchSpec": "^1.0.5"
+    "fetchSpec": "^1.0.10"
   },
   "_requiredBy": [
     "/"
   ],
   "_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",
+  "_spec": "@mapbox/node-pre-gyp@^1.0.10",
   "_where": "/home/runner/work/MuhammaraJS/MuhammaraJS",
   "author": {
     "name": "Dane Springmeyer",

package/node_modules/inherits/package.json

@@ -16,15 +16,10 @@
     "fetchSpec": "^2.0.3"
   },
   "_requiredBy": [
-    "/concat-stream",
-    "/concat-stream/readable-stream",
-    "/duplexer2/readable-stream",
     "/glob",
     "/memory-streams/readable-stream",
     "/mocha/glob",
-    "/readable-stream",
-    "/static-module/readable-stream",
-    "/through2/readable-stream"
+    "/readable-stream"
   ],
   "_resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
   "_shasum": "0fa2c64f932917c3433a0ded55363aae37416b7c",

package/node_modules/make-dir/node_modules/semver/package.json

@@ -1,8 +1,8 @@
 {
   "_from": "semver@^6.0.0",
-  "_id": "semver@6.3.0",
+  "_id": "semver@6.3.1",
   "_inBundle": false,
-  "_integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+  "_integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
   "_location": "/make-dir/semver",
   "_phantomChildren": {},
   "_requested": {
@@ -18,10 +18,13 @@
   "_requiredBy": [
     "/make-dir"
   ],
-  "_resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
-  "_shasum": "ee0a64c8af5e8ceea67687b133761e1becbd1d3d",
+  "_resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
+  "_shasum": "556d2ef8689146e46dcea4bfdd095f3434dffcb4",
   "_spec": "semver@^6.0.0",
   "_where": "/home/runner/work/MuhammaraJS/MuhammaraJS/node_modules/make-dir",
+  "author": {
+    "name": "GitHub Inc."
+  },
   "bin": {
     "semver": "bin/semver.js"
   },
@@ -32,7 +35,8 @@
   "deprecated": false,
   "description": "The semantic version parser used by npm.",
   "devDependencies": {
-    "tap": "^14.3.1"
+    "@npmcli/template-oss": "4.17.0",
+    "tap": "^12.7.0"
   },
   "files": [
     "bin",
@@ -48,13 +52,18 @@
     "url": "git+https://github.com/npm/node-semver.git"
   },
   "scripts": {
-    "postpublish": "git push origin --follow-tags",
-    "postversion": "npm publish",
-    "preversion": "npm test",
-    "test": "tap"
+    "lint": "echo linting disabled",
+    "lintfix": "npm run lint -- --fix",
+    "postlint": "template-oss-check",
+    "posttest": "npm run lint",
+    "snap": "tap test/ --100 --timeout=30",
+    "template-oss-apply": "template-oss-apply --force",
+    "test": "tap test/ --100 --timeout=30"
   },
-  "tap": {
-    "check-coverage": true
+  "templateOSS": {
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
+    "content": "./scripts/template-oss",
+    "version": "4.17.0"
   },
-  "version": "6.3.0"
+  "version": "6.3.1"
 }