Update README.md

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jscanify",
-  "version": "1.4.0",
+  "version": "1.3.3",
   "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": "^3.1.0",
+    "canvas": "^2.11.2",
-    "jsdom": "^26.0.0",
+    "jsdom": "^22.0.0",
-    "mocha": "^11.1.0"
+    "mocha": "^10.2.0"
   }
 }

src/jscanify-node.js

@@ -1,4 +1,4 @@
-/*! jscanify v1.4.0 | (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");
@@ -153,9 +153,9 @@ class jscanify {
   extractPaper(image, resultWidth, resultHeight, cornerPoints) {
     const canvas = createCanvas();
     const img = cv.imread(image);
-    const maxContour = cornerPoints ? null : this.findPaperContour(img);
+    const maxContour = this.findPaperContour(img);
 
-    if(maxContour == null && cornerPoints === undefined){
+    if(maxContour == null){
       return null;
     }
 

src/jscanify.js

@@ -1,4 +1,4 @@
-/*! jscanify v1.4.0 | (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"
@@ -144,9 +144,9 @@
     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){
+      if(maxContour == null){
         return null;
       }
 

test/tests.js

@@ -39,30 +39,21 @@ function setup() {
   })
 }
 
-let scanner;
+console.log("=== beginning  tests ===");
-let cv;
+console.log("loading OpenCV.js...");
 
-before(function (done) {
+const scanner = new jscanify();
-    console.log("=== beginning  tests ===");
+scanner.loadOpenCV(function (cv) {
-    console.log("loading OpenCV.js...");
-
-    scanner = new jscanify();
-    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) {
+  function test(testImage, imageCount) {
     describe("image #" + imageCount, function () {
-        it("should highlight paper", function () {
+      it("should highlight paper", function (done) {
         const highlighted = scanner.highlightPaper(testImage);
         const higlightedOutputPath = OUTPUT_FOLDER + "highlighted-" + imageCount + ".jpg";
         writeFileSync(
@@ -71,9 +62,10 @@ function test(testImage, imageCount) {
         );
 
         assert.ok(existsSync(higlightedOutputPath));
+        done();
       });
 
-        it("should extract paper", function () {
+      it("should extract paper", function (done) {
         const extracted = scanner.extractPaper(testImage, 386, 500);
         const extractedOutputPath = OUTPUT_FOLDER + "extracted-" + imageCount + ".jpg";
         
@@ -83,9 +75,10 @@ function test(testImage, imageCount) {
         );
 
         assert.ok(existsSync(extractedOutputPath));
+        done();
       });
 
-        it("should label corner points", function () {
+      it("should label corner points", function (done) {
         const parsedImage = cv.imread(testImage);
         const paperContour = scanner.findPaperContour(parsedImage);
         const {
@@ -118,23 +111,27 @@ function test(testImage, imageCount) {
         writeFileSync(cornerPointsOutputPath, canvas.toBuffer("image/jpeg"));
 
         assert.ok(existsSync(cornerPointsOutputPath));
+        done();
       });
     });
-}
+  }
 
-let imageCount = 1;
+  setup();
 
-/*
+  let imageCount = 1;
+
+  /*
    * go through all images in test image directory
    */
-readdirSync(TEST_IMAGE_DIRECTORY).forEach((file) => {
+  readdirSync(TEST_IMAGE_DIRECTORY).forEach((file) => {
     const TEST_IMAGE_PATH = path.join(TEST_IMAGE_DIRECTORY, file);
     
-    if (!file.endsWith("-sized.png")) { // these images are for the website, not testing
+    if(!file.endsWith("-sized.png")){ // these images are for the website, not testing
       let tempCount = imageCount++;
   
       loadImage(TEST_IMAGE_PATH).then(function (image) {
         test(image, tempCount);
       });
     }
-})
+  })
+});