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.3",
+  "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.3 | (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");
@@ -153,9 +153,9 @@ 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){
+    if(maxContour == null && cornerPoints === undefined){
       return null;
     }
 

src/jscanify.js

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

test/tests.js

@@ -39,21 +39,30 @@ function setup() {
     })
 }
 
-console.log("=== beginning  tests ===");
+let scanner;
-console.log("loading OpenCV.js...");
+let cv;
 
-const scanner = new jscanify();
+before(function (done) {
-scanner.loadOpenCV(function (cv) {
+    console.log("=== beginning  tests ===");
+    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 (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,27 +118,23 @@ scanner.loadOpenCV(function (cv) {
             writeFileSync(cornerPointsOutputPath, canvas.toBuffer("image/jpeg"));
 
             assert.ok(existsSync(cornerPointsOutputPath));
-        done();
         });
     });
-  }
+}
 
-  setup();
+let imageCount = 1;
 
-  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);
         });
     }
-  })
+})
-});