v3.1.0

- extra function now have all the editing options.
- Small updates in readme

js-script/CaptchaGenerator.d.ts

@@ -28,7 +28,7 @@ export declare class CaptchaGenerator {
      * @type {string}
      * @since 2.0.3
      */
-    get text(): string;
+    get text(): string | undefined;
     /**
      * set dimension for your captcha image
      * @param {integer} height Height of captcha image.

js-script/CaptchaGenerator.js

@@ -23,7 +23,7 @@ class CaptchaGenerator {
         this.captcha = constants_1.defaultCaptchaOption;
         this.trace = constants_1.defaultTraceOptions;
         this.decoy = constants_1.defaultDecoyOptions;
-        this.captcha.text = (0, util_1.randomText)(this.captcha.characters);
+        this.captcha.text = (0, util_1.randomText)(this.captcha.characters || 6);
     }
     /**
      * Get the text of captcha.

js-script/captcha.d.ts

@@ -28,9 +28,9 @@ export declare class Captcha {
     get text(): string;
     /**
      * Get png image of captcha.
-     * @returns {Buffer} Get png image of captcha created.
+     * @returns {Buffer | Promise<Buffer>} Get png image of captcha created.
      */
-    get png(): Buffer;
+    get png(): Buffer | Promise<Buffer>;
     /**
      * Draw image on your captcha.
      * @param {Image} image Choose image you want to add.
@@ -57,4 +57,5 @@ export declare class Captcha {
      * @returns {Captcha}
      */
     drawCaptcha(captchaOption?: SetCaptchaOption): Captcha;
+    toBuffer(): void;
 }

js-script/captcha.js

@@ -38,7 +38,7 @@ class Captcha {
     }
     /**
      * Get png image of captcha.
-     * @returns {Buffer} Get png image of captcha created.
+     * @returns {Buffer | Promise<Buffer>} Get png image of captcha created.
      */
     get png() {
         this._canvas.async = this.async;
@@ -50,7 +50,7 @@ class Captcha {
      * @returns {Captcha}
      */
     drawImage(image) {
-        this._ctx.drawImage(image, 0, 0);
+        this._ctx.drawImage(image, 0, 0, this._width, this._height);
         return this;
     }
     /**
@@ -105,9 +105,9 @@ class Captcha {
         if (captchaOption.text)
             option.characters = captchaOption.text.length;
         if (!captchaOption.text && captchaOption.characters)
-            option.text = (0, util_1.randomText)(option.characters);
+            option.text = (0, util_1.randomText)(option.characters || 6);
         if (!option.text)
-            option.text = (0, util_1.randomText)(option.characters);
+            option.text = (0, util_1.randomText)(option.characters || 6);
         this._captcha = option;
         if (!this._coordinates[0])
             this._coordinates = (0, util_1.getRandomCoordinate)(this._height, this._width, option.characters || 6);
@@ -121,10 +121,10 @@ class Captcha {
             if (option.skew) {
                 this._ctx.transform(1, Math.random(), (0, util_1.getRandom)(20) / 100, 1, 0, 0);
             }
-            if (option.rotate > 0) {
+            if (option.rotate && option.rotate > 0) {
                 this._ctx.rotate((0, util_1.getRandom)(-option.rotate, option.rotate) * Math.PI / 180);
             }
-            if (((_a = option.colors) === null || _a === void 0 ? void 0 : _a.length) > 2) {
+            if (option.colors && ((_a = option.colors) === null || _a === void 0 ? void 0 : _a.length) > 2) {
                 this._ctx.fillStyle = option.colors[(0, util_1.getRandom)(option.colors.length - 1)];
             }
             this._ctx.fillText(option.text[n], 0, 0);
@@ -133,5 +133,8 @@ class Captcha {
         ;
         return this;
     }
+    toBuffer() {
+        this._canvas.toBuffer('png');
+    }
 }
 exports.Captcha = Captcha;

js-script/extra.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
-declare const captchaValue: {};
+import { Image } from "skia-canvas";
+import { SetCaptchaOption, SetDecoyOption, SetTraceOption } from "./constants";
 interface captchaValueSync {
     image: Buffer;
     text: string;
@@ -8,6 +9,12 @@ interface captchaValue {
     image: Promise<Buffer>;
     text: string;
 }
+interface CreateCaptchaOptions {
+    captcha?: SetCaptchaOption;
+    trace?: SetTraceOption;
+    decoy?: SetDecoyOption;
+    background?: Image;
+}
 /**
  * Create custom captcha from scratch.
  * @async
@@ -16,13 +23,13 @@ interface captchaValue {
  * @param {string} [text] Captcha text.
  * @returns
  */
-export declare function createCaptcha(width: number, height: number, text?: string): captchaValue;
+export declare function createCaptcha(width: number, height: number, option?: CreateCaptchaOptions): captchaValue;
 /**
  * Create captcha in sync mode.
  * @param {number} width captcha image width.
  * @param {number} height captcha image height.
- * @param {string} [text] Captcha text.
+ * @param {CreateCaptchaOptions} [option] Captcha text.
  * @returns
  */
-export declare function createCaptchaSync(width: number, height: number, text?: string): captchaValueSync;
+export declare function createCaptchaSync(width: number, height: number, option?: CreateCaptchaOptions): captchaValueSync;
 export {};

js-script/extra.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCaptchaSync = exports.createCaptcha = void 0;
 const _1 = require(".");
-const captchaValue = {};
 /**
  * Create custom captcha from scratch.
  * @async
@@ -11,21 +10,17 @@ const captchaValue = {};
  * @param {string} [text] Captcha text.
  * @returns
  */
-function createCaptcha(width, height, text) {
+function createCaptcha(width, height, option = {}) {
     const captcha = new _1.Captcha(width, height);
     const decoyCount = Math.floor(width * height / 2500);
-    captcha.addDecoy({
-        total: decoyCount,
-        opacity: 1
-    });
-    if (text) {
-        captcha.drawCaptcha({ text: text });
-    }
-    else {
-        captcha.drawCaptcha();
-        text = captcha.text;
-    }
-    captcha.drawTrace();
+    if (!option.decoy)
+        option.decoy = {};
+    if (!option.decoy.total)
+        option.decoy.total = decoyCount;
+    captcha.addDecoy(option.decoy);
+    captcha.drawCaptcha(option.captcha);
+    const text = captcha.text;
+    captcha.drawTrace(option.trace);
     captcha.addDecoy({ opacity: 1 });
     return { image: captcha.png, text: captcha.text };
 }
@@ -35,25 +30,21 @@ exports.createCaptcha = createCaptcha;
  * Create captcha in sync mode.
  * @param {number} width captcha image width.
  * @param {number} height captcha image height.
- * @param {string} [text] Captcha text.
+ * @param {CreateCaptchaOptions} [option] Captcha text.
  * @returns
  */
-function createCaptchaSync(width, height, text) {
+function createCaptchaSync(width, height, option = {}) {
     const captcha = new _1.Captcha(width, height);
     const decoyCount = Math.floor(width * height / 2500);
     captcha.async = false;
-    captcha.addDecoy({
-        total: decoyCount,
-        opacity: 1
-    });
-    if (text) {
-        captcha.drawCaptcha({ text: text });
-    }
-    else {
-        captcha.drawCaptcha();
-        text = captcha.text;
-    }
-    captcha.drawTrace();
+    if (!option.decoy)
+        option.decoy = {};
+    if (!option.decoy.total)
+        option.decoy.total = decoyCount;
+    captcha.addDecoy(option.decoy);
+    captcha.drawCaptcha(option.captcha);
+    const text = captcha.text;
+    captcha.drawTrace(option.trace);
     captcha.addDecoy({ opacity: 1 });
     return { image: captcha.png, text: captcha.text };
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "captcha-canvas",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "description": "A captcha generator by using skia-canvas module.",
   "main": "./js-script/index.js",
   "files": [
@@ -32,6 +32,7 @@
     "@types/node": "^14.11.8",
     "@types/skia-canvas": "^0.9.2",
     "better-docs": "^2.3.2",
+    "canvas": "^2.8.0",
     "eslint": "^7.27.0",
     "jsdoc": "^3.6.7",
     "typescript": "^4.0.2"

test.js

@@ -1,9 +1,10 @@
-"use strict";
-exports.__esModule = true;
-var fs_1 = require("fs");
-var js_script_1 = require("./js-script");
-var captcha = new js_script_1.CaptchaGenerator()
-    .setDimension(200, 200);
-console.log(__filename + captcha.text);
-(0, fs_1.writeFileSync)('assets/CaptchaGenerator/' + captcha.text + 'captcha.png', captcha.generateSync());
-console.log(captcha.text);
+const { writeFileSync } = require('fs');
+const { createCaptchaSync } = require('./js-script/extra');
+
+const captcha = createCaptchaSync(900, 300, {
+	captcha: {
+		size: 80,
+	},
+});
+
+writeFileSync('assets/captcha/default.png', captcha.image);