jscanify 1.3.2 → 1.3.3

package/README.md

@@ -22,7 +22,6 @@ Supports the web, NodeJS, <a href="https://github.com/ColonelParrot/react-scanif
 Available on <a href="https://www.npmjs.com/package/jscanify">npm</a> or via <a href="https://www.jsdelivr.com/package/gh/ColonelParrot/jscanify">cdn</a><br/>
 </p>
 
-
 **Features**:
 
 - paper detection & highlighting
@@ -39,6 +38,8 @@ Available on <a href="https://www.npmjs.com/package/jscanify">npm</a> or via <a
 
 <img src="docs/images/github-explanation-long.png" />
 
+<h3 align="center" margin="0"><a href="https://github.com/puffinsoft/jscanify/wiki">➡️ view documentation</a></h3>
+
 <hr/>
 
 ## Quickstart
@@ -125,3 +126,5 @@ To export the paper to a PDF, see [here](https://stackoverflow.com/questions/236
 
 - for optimal paper detection, the paper should be placed on a flat surface with a solid background color
 - we recommend wrapping your code using `jscanify` in a window `load` event listener to ensure OpenCV is loaded
+
+<h3 align="center" margin="0"><a href="https://github.com/puffinsoft/jscanify/wiki">➡️ view documentation</a></h3>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jscanify",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Open-source Javascript mobile document scanner.",
   "main": "src/jscanify-node.js",
   "directories": {

package/src/jscanify-node.js

@@ -1,4 +1,4 @@
-/*! jscanify v1.3.2 | (c) ColonelParrot and other contributors | MIT License */
+/*! jscanify v1.3.3 | (c) ColonelParrot and other contributors | MIT License */
 
 const { Canvas, createCanvas, Image, ImageData } = require("canvas");
 const { JSDOM } = require("jsdom");
@@ -80,7 +80,10 @@ class jscanify {
       }
     }
 
-    const maxContour = contours.get(maxContourIndex);
+    const maxContour =
+    maxContourIndex >= 0 ?
+      contours.get(maxContourIndex) :
+      null;
 
     imgGray.delete();
     imgBlur.delete();
@@ -138,6 +141,9 @@ class jscanify {
 
   /**
    * Extracts and undistorts the image detected within the frame.
+   * 
+   * Returns `null` if no paper is detected.
+   * 
    * @param {*} image image to process
    * @param {*} resultWidth desired result paper width
    * @param {*} resultHeight desired result paper height
@@ -148,6 +154,11 @@ class jscanify {
     const canvas = createCanvas();
     const img = cv.imread(image);
     const maxContour = this.findPaperContour(img);
+
+    if(maxContour == null){
+      return null;
+    }
+
     const {
       topLeftCorner,
       topRightCorner,

package/src/jscanify.js

@@ -1,4 +1,4 @@
-/*! jscanify v1.3.2 | (c) ColonelParrot and other contributors | MIT License */
+/*! jscanify v1.3.3 | (c) ColonelParrot and other contributors | MIT License */
 
 (function (global, factory) {
   typeof exports === "object" && typeof module !== "undefined"
@@ -71,7 +71,10 @@
         }
       }
 
-      const maxContour = contours.get(maxContourIndex);
+      const maxContour =
+        maxContourIndex >= 0 ?
+          contours.get(maxContourIndex) :
+          null;
 
       imgGray.delete();
       imgBlur.delete();
@@ -129,7 +132,10 @@
 
     /**
      * Extracts and undistorts the image detected within the frame.
-     * @param {*} image image to process
+     * 
+     * Returns `null` if no paper is detected.
+     *  
+    * @param {*} image image to process
      * @param {*} resultWidth desired result paper width
      * @param {*} resultHeight desired result paper height
      * @param {*} cornerPoints optional custom corner points, in case automatic corner points are incorrect
@@ -137,11 +143,13 @@
      */
     extractPaper(image, resultWidth, resultHeight, cornerPoints) {
       const canvas = document.createElement("canvas");
-
       const img = cv.imread(image);
-
       const maxContour = this.findPaperContour(img);
 
+      if(maxContour == null){
+        return null;
+      }
+
       const {
         topLeftCorner,
         topRightCorner,