Update README.md

docs/index.html

@@ -32,7 +32,7 @@
           fill="black" class="octo-body"></path>
       </svg>
     </a>
-    <img src="images/logo-full.png" alt="jscanify logo" style="height: 100px" />
+    <img src="images/logo-full.png" alt="jscanify logo" style="width: 375px" />
     <h2>the javascript document scanning library.</h2>
     <br />
     <div class="view-on">

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jscanify",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Open-source Javascript mobile document scanner.",
   "main": "src/jscanify-node.js",
   "directories": {
@@ -25,8 +25,8 @@
   },
   "homepage": "https://colonelparrot.github.io/jscanify/",
   "dependencies": {
-    "canvas": "^2.11.2",
+    "canvas": "^3.1.0",
-    "jsdom": "^22.0.0",
+    "jsdom": "^26.0.0",
-    "mocha": "^10.2.0"
+    "mocha": "^11.1.0"
   }
 }

src/jscanify-node.js

@@ -1,4 +1,4 @@
-/*! jscanify v1.3.2 | (c) ColonelParrot and other contributors | MIT License */
+/*! jscanify v1.4.0 | (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
@@ -147,7 +153,12 @@ class jscanify {
   extractPaper(image, resultWidth, resultHeight, cornerPoints) {
     const canvas = createCanvas();
     const img = cv.imread(image);
-    const maxContour = this.findPaperContour(img);
+    const maxContour = cornerPoints ? null : this.findPaperContour(img);
+
+    if(maxContour == null && cornerPoints === undefined){
+      return null;
+    }
+
     const {
       topLeftCorner,
       topRightCorner,

src/jscanify.js

@@ -1,4 +1,4 @@
-/*! jscanify v1.3.2 | (c) ColonelParrot and other contributors | MIT License */
+/*! jscanify v1.4.0 | (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,6 +132,9 @@
 
     /**
      * 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
@@ -137,10 +143,12 @@
      */
     extractPaper(image, resultWidth, resultHeight, cornerPoints) {
       const canvas = document.createElement("canvas");
-
       const img = cv.imread(image);
+      const maxContour = cornerPoints ? null : this.findPaperContour(img);
 
-      const maxContour = this.findPaperContour(img);
+      if(maxContour == null && cornerPoints === undefined){
+        return null;
+      }
 
       const {
         topLeftCorner,

test/tests.js

@@ -39,21 +39,30 @@ function setup() {
     })
 }
 
+let scanner;
+let cv;
+
+before(function (done) {
     console.log("=== beginning  tests ===");
     console.log("loading OpenCV.js...");
 
-const scanner = new jscanify();
+    scanner = new jscanify();
-scanner.loadOpenCV(function (cv) {
+    scanner.loadOpenCV(function (loadedCv) {
+        cv = loadedCv;
 
         console.log("Finished loading OpenCV.js");
         console.log("Writing test images to: " + OUTPUT_FOLDER);
+        setup()
+        done();
+    });
+});
 
 /**
  * tests an individual image
  */
 function test(testImage, imageCount) {
     describe("image #" + imageCount, function () {
-      it("should highlight paper", function (done) {
+        it("should highlight paper", function () {
             const highlighted = scanner.highlightPaper(testImage);
             const higlightedOutputPath = OUTPUT_FOLDER + "highlighted-" + imageCount + ".jpg";
             writeFileSync(
@@ -62,10 +71,9 @@ scanner.loadOpenCV(function (cv) {
             );
 
             assert.ok(existsSync(higlightedOutputPath));
-        done();
         });
 
-      it("should extract paper", function (done) {
+        it("should extract paper", function () {
             const extracted = scanner.extractPaper(testImage, 386, 500);
             const extractedOutputPath = OUTPUT_FOLDER + "extracted-" + imageCount + ".jpg";
 
@@ -75,10 +83,9 @@ scanner.loadOpenCV(function (cv) {
             );
 
             assert.ok(existsSync(extractedOutputPath));
-        done();
         });
 
-      it("should label corner points", function (done) {
+        it("should label corner points", function () {
             const parsedImage = cv.imread(testImage);
             const paperContour = scanner.findPaperContour(parsedImage);
             const {
@@ -111,13 +118,10 @@ scanner.loadOpenCV(function (cv) {
             writeFileSync(cornerPointsOutputPath, canvas.toBuffer("image/jpeg"));
 
             assert.ok(existsSync(cornerPointsOutputPath));
-        done();
         });
     });
 }
 
-  setup();
-
 let imageCount = 1;
 
 /*
@@ -134,4 +138,3 @@ scanner.loadOpenCV(function (cv) {
         });
     }
 })
-});