Use crop-universal to factorize code

GMartigny · Jan 29, 2020 · c8e4adc · c8e4adc
1 parent 5599366
commit c8e4adc
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 53 deletions.
diff --git a/index.mjs b/index.mjs
@@ -1,19 +1,19 @@
 import Canvas from "canvas";
-import detect from "detect-edges";
-
-const { loadImage, createCanvas } = Canvas;
+import crop from "crop-universal";
 
 const defaultOptions = {
     outputFormat: "png",
 };
 
+const cropper = crop(Canvas);
+
 /**
  * @typedef {Object} Options
  * @prop {String} [outputFormat="png"] - Format of the output image (`"png"` or `"jpeg"`)
  */
 /**
  * Crop transparent pixels from an image
- * @param {String|HTMLCanvasElement} input - Path to the image to process or a tainted canvas
+ * @param {String|Canvas.Canvas|Canvas.Image} input - Path to the image to process, another Canvas or an Image
  * @param {Options} options - Some options
  * @returns {Promise<Buffer>}
  */
@@ -23,44 +23,23 @@ export default async (input, options) => {
         ...options,
     };
 
-    if (!input) {
-        throw new Error("No input given.");
-    }
-
+    // Check outputFormat
     const supportedFormat = ["png", "jpeg"];
     if (!supportedFormat.includes(outputFormat)) {
         const supported = JSON.stringify(supportedFormat);
         throw new Error(`outputFormat should only be one of ${supported}, but "${outputFormat}" was given.`);
     }
 
-    const isString = typeof input === "string";
-
-    let canvas;
-    let image;
-
-    if (isString) {
-        image = await loadImage(input);
-        const { width, height } = image;
-        canvas = createCanvas(width, height);
-    }
-    else {
-        canvas = input;
-    }
-
-    const { width, height } = canvas;
-    const context = canvas.getContext("2d");
-
-    if (isString) {
-        context.drawImage(image, 0, 0, width, height);
-    }
-
-    const data = context.getImageData(0, 0, width, height);
-
-    const { top, right, bottom, left } = detect(canvas, options);
-
-    canvas.width = width - (left + right);
-    canvas.height = height - (top + bottom);
-    context.putImageData(data, -left, -top);
-
-    return canvas.toBuffer(`image/${outputFormat}`);
+    // Do crop
+    const canvas = await cropper(input, options);
+
+    // Export as a buffer
+    return new Promise((resolve, reject) => canvas.toBuffer((error, buffer) => {
+        if (error) {
+            reject(error);
+        }
+        else {
+            resolve(buffer);
+        }
+    }, `image/${outputFormat}`));
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,18 @@
 {
     "name": "crop-node",
     "version": "2.0.0",
-    "description": "Crop transparent pixel from image",
+    "description": "Crop transparent pixel from image in Node.js",
+    "keywords": [
+        "trim",
+        "image",
+        "edge",
+        "cut",
+        "resize",
+        "transparent",
+        "opacity",
+        "pixel",
+        "remove"
+    ],
     "main": "index.mjs",
     "scripts": {
         "test": "ava"
@@ -18,17 +29,6 @@
         "type": "git",
         "url": "git+https://github.com/GMartigny/crop-node.git"
     },
-    "keywords": [
-        "trim",
-        "image",
-        "edge",
-        "cut",
-        "resize",
-        "transparent",
-        "opacity",
-        "pixel",
-        "remove"
-    ],
     "author": "GMartigny",
     "license": "MIT",
     "bugs": {
@@ -44,6 +44,6 @@
     },
     "dependencies": {
         "canvas": "^2.6.1",
-        "detect-edges": "^1.0.1"
+        "crop-universal": "^1.0.0"
     }
 }
diff --git a/readme.md b/readme.md
@@ -3,7 +3,8 @@
 [![Package version](https://flat.badgen.net/npm/v/crop-node)](https://www.npmjs.com/package/crop-node)
 [![Package size](https://badgen.net/bundlephobia/minzip/crop-node)](https://bundlephobia.com/result?p=crop-node)
 
-Crop all transparent pixel around an image's edges. ([CLI version](https://github.com/gmartigny/crop-node-cli))
+Crop all transparent pixel around an image's edges. ([CLI version](https://github.com/GMartigny/crop-node-cli))
+
 
 ## Installation
 
@@ -13,7 +14,8 @@ Crop all transparent pixel around an image's edges. ([CLI version](https://githu
 ## Usage
 
 ```js
-const crop = require("crop-noode");
+const crop = require("crop-node");
+const { writeFileSync } = require("fs");
 
 // Path to an image file
 const path = "path/to/image.png";
@@ -47,6 +49,13 @@ const options = {
 In addition, all [options of `detect-edges`](https://github.com/GMartigny/detect-edges#options) are supported.
 
 
+## Related
+
+ - CLI version [`crop-node-cli`](https://github.com/GMartigny/crop-node-cli)
+ - Browser version [`crop-browser`](https://github.com/GMartigny/crop-browser)
+ - Environment agnostic [`crop-universal`](https://github.com/GMartigny/crop-universal)
+
+
 ## License
 
 [MIT](license)