mindee 1.3.3 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v1.4.0
+### Fixes
+* :bug: cut/merge pages of an encrypted PDF leads to unexpected results
+* :bug: logger not activating in some cases
+* :bug: align PDF cut/merge with other client libs
+
+### Changes
+* :sparkles: Add TIFF and HEIC support
+* :white_check_mark: fully test PDF cut function
+
 ## v1.3.3
 
 ### Fixes

package/mindee/errors/handler.js

@@ -1,4 +1,4 @@
-const logger = require("../logger");
+const { logger } = require("../logger");
 
 class ErrorHandler {
   constructor(throwOnError = true) {

package/mindee/index.js

@@ -1,5 +1,5 @@
 const errorHandler = require("./errors/handler");
-const logger = require("./logger");
+const { logger, LOG_LEVELS } = require("./logger");
 const APIReceipt = require("./api/receipt");
 const APIInvoice = require("./api/invoice");
 const APIFinancialDocument = require("./api/financialDocument");
@@ -20,7 +20,10 @@ class Client {
     this.receiptToken = receiptToken || process.env.MINDEE_RECEIPT_TOKEN;
     this.invoiceToken = invoiceToken || process.env.MINDEE_INVOICE_TOKEN;
     errorHandler.throwOnError = throwOnError;
-    logger.level = debug ?? process.env.MINDEE_DEBUG ? "debug" : "warn";
+    logger.level =
+      debug ?? process.env.MINDEE_DEBUG
+        ? LOG_LEVELS["debug"]
+        : LOG_LEVELS["warn"];
     this.receipt = new APIReceipt(this.receiptToken);
     this.invoice = new APIInvoice(this.invoiceToken);
     this.financialDocument = new APIFinancialDocument(

package/mindee/inputs.js

@@ -6,17 +6,21 @@ const concat = require("concat-stream");
 const { Base64Encode } = require("base64-stream");
 const fileType = require("file-type");
 const ArrayBufferEncode = require("base64-arraybuffer");
+const { logger } = require("./logger");
 
 class Input {
   MIMETYPES = {
-    png: "image/png",
-    jpg: "image/jpg",
+    pdf: "application/pdf",
+    heic: "image/heic",
+    jpg: "image/jpeg",
     jpeg: "image/jpeg",
+    png: "image/png",
+    tif: "image/tiff",
+    tiff: "image/tiff",
     webp: "image/webp",
-    pdf: "application/pdf",
   };
   ALLOWED_INPUT_TYPE = ["base64", "path", "stream", "dummy"];
-  CUT_PDF_SIZE = 5;
+  MAX_DOC_PAGES = 3;
 
   /**
    * @param {(String | Buffer)} file - the file that will be read. Either path or base64 string, or a steam
@@ -47,6 +51,10 @@ class Input {
     else if (this.inputType === "path") await this.initFile();
     else if (this.inputType === "stream") await this.initStream();
     else this.initDummy();
+
+    if (this.fileExtension === "application/pdf" && this.allowCutPdf === true) {
+      await this.cutPdf();
+    }
   }
 
   async initBase64() {
@@ -67,10 +75,6 @@ class Input {
       const filetype = this.filename.split(".").pop();
       this.fileExtension = this.MIMETYPES[filetype];
     }
-
-    if (this.fileExtension === "application/pdf" && this.allowCutPdf == true) {
-      await this.cutPdf();
-    }
   }
 
   async initFile() {
@@ -90,10 +94,6 @@ class Input {
       );
     }
     this.fileExtension = this.MIMETYPES[filetype];
-
-    if (this.fileExtension === "application/pdf" && this.allowCutPdf == true) {
-      await this.cutPdf();
-    }
   }
 
   async initStream() {
@@ -134,19 +134,42 @@ class Input {
     });
   }
 
-  /** Cut PDF if pages > 5 */
-  async cutPdf() {
-    // convert document to PDFDocument & cut CUT_PDF_SIZE - 1 first pages and last page
+  async countPages() {
     let pdfDocument = await PDFDocument.load(this.fileObject, {
       ignoreEncryption: true,
     });
-    const splitedPdfDocument = await PDFDocument.create();
-    const pdfLength = pdfDocument.getPageCount();
-    if (pdfLength <= this.CUT_PDF_SIZE) return;
-    const pagesNumbers = [...Array(pdfLength - 1).keys(), pdfLength - 1];
-    const pages = await splitedPdfDocument.copyPages(pdfDocument, pagesNumbers);
-    pages.forEach((page) => splitedPdfDocument.addPage(page));
-    const data = await splitedPdfDocument.save();
+    return pdfDocument.getPageCount();
+  }
+
+  /** Merge PDF pages */
+  async cutPdf() {
+    let currentPdf = await PDFDocument.load(this.fileObject, {
+      ignoreEncryption: true,
+    });
+
+    const pdfLength = currentPdf.getPageCount();
+    if (pdfLength <= this.MAX_DOC_PAGES) {
+      return;
+    }
+
+    if (currentPdf.isEncrypted) {
+      logger.warn(
+        "PDF of %d pages is encrypted, not possible to cut pages.",
+        pdfLength
+      );
+      return;
+    }
+
+    const newPdf = await PDFDocument.create();
+    const pagesNumbers = [0, pdfLength - 2, pdfLength - 1].slice(
+      0,
+      this.MAX_DOC_PAGES
+    );
+
+    const pages = await newPdf.copyPages(currentPdf, pagesNumbers);
+    pages.forEach((page) => newPdf.addPage(page));
+    const data = await newPdf.save();
+
     if (this.inputType === "path") {
       this.fileObject = Buffer.from(data);
     } else if (this.inputType === "base64") {

package/mindee/logger.js

@@ -12,22 +12,23 @@ class Logger {
   }
 
   debug(...args) {
-    if (this.level <= LOGGER_LEVELS["debug"]) console.debug(args);
+    if (this.level <= LOGGER_LEVELS["debug"]) console.debug(...args);
   }
 
   info(...args) {
-    if (this.level <= LOGGER_LEVELS["info"]) console.info(args);
+    if (this.level <= LOGGER_LEVELS["info"]) console.info(...args);
   }
 
   warn(...args) {
-    if (this.level <= LOGGER_LEVELS["warn"]) console.warn(args);
+    if (this.level <= LOGGER_LEVELS["warn"]) console.warn(...args);
   }
 
   error(...args) {
-    if (this.level <= LOGGER_LEVELS["error"]) console.error(args);
+    if (this.level <= LOGGER_LEVELS["error"]) console.error(...args);
   }
 }
 
-const logger = new Logger();
-
-module.exports = logger;
+module.exports = {
+  logger: new Logger(),
+  LOG_LEVELS: LOGGER_LEVELS,
+};

package/package.json

@@ -1,15 +1,24 @@
 {
   "name": "mindee",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "description": "Mindee Client Library for Node.js",
   "main": "mindee/index.js",
   "license": "MIT",
   "scripts": {
     "build": "babel mindee -d lib",
-    "test": "npm run build && mocha tests/**/*.js",
+    "test": "npm run build && mocha tests/*.js tests/**/*.js",
     "lint": "eslint 'mindee/**/*.js' 'tests/*.js' --max-warnings=0 --report-unused-disable-directives && echo '✔  Your .js files look good.'",
     "documentation": "jsdoc -r mindee -d docs"
   },
+  "files": [
+    "mindee/",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">= 12.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
@@ -20,8 +29,8 @@
   },
   "homepage": "https://github.com/mindee/mindee-api-nodejs/#readme",
   "devDependencies": {
-    "@babel/cli": "^7.12.8",
-    "@babel/core": "^7.12.9",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.12",
     "@babel/eslint-parser": "^7.12.1",
     "@babel/preset-env": "^7.12.7",
     "@babel/register": "^7.12.1",

package/.eslintrc

@@ -1,24 +0,0 @@
-{
-    "env": {
-        "node": true,
-        "es6": true,
-        "mocha": true
-    },
-    "parser": "@babel/eslint-parser",
-    "extends": ["eslint:recommended", "plugin:prettier/recommended"],
-    "globals": {
-        "Promise": true
-    },
-    "rules": {
-        "quotes": [
-            "error",
-            "double",
-            {
-                "avoidEscape": true,
-                "allowTemplateLiterals": false
-            }
-        ],
-        "comma-dangle": [2, "always-multiline"],
-        "no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
-    }
-}

package/.mocharc.yaml

@@ -1,2 +0,0 @@
-require:
-  - '@babel/register'