@midwayjs/captcha 3.6.1

package/README.md

@@ -0,0 +1,10 @@
+# midway captcha(verification code) module
+
+this is a sub package for midway.
+
+Document: [https://midwayjs.org](https://midwayjs.org)
+
+## License
+
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))
+

package/dist/config/config.default.d.ts

@@ -0,0 +1,3 @@
+import { CaptchaOptions } from '../interface';
+export declare const captcha: CaptchaOptions;
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.captcha = void 0;
+exports.captcha = {
+    size: 4,
+    noise: 1,
+    width: 120,
+    height: 40,
+    image: {
+        type: 'mixed',
+    },
+    formula: {},
+    text: {},
+    expirationTime: 3600,
+    idPrefix: 'midway:vc',
+};
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -0,0 +1,3 @@
+export declare class CaptchaConfiguration {
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,27 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptchaConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
+const cacheComponent = require("@midwayjs/cache");
+const DefaultConfig = require("./config/config.default");
+let CaptchaConfiguration = class CaptchaConfiguration {
+};
+CaptchaConfiguration = __decorate([
+    (0, core_1.Configuration)({
+        namespace: 'captcha',
+        imports: [cacheComponent],
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], CaptchaConfiguration);
+exports.CaptchaConfiguration = CaptchaConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const numbers = "0123456789";
+export declare const letters: string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.letters = exports.numbers = void 0;
+exports.numbers = '0123456789';
+const lowerCaseLetters = 'abcdefghijklmnopqrstuvwxyz';
+exports.letters = lowerCaseLetters + lowerCaseLetters.toUpperCase();
+//# sourceMappingURL=constants.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { CaptchaConfiguration as Configuration } from './configuration';
+export * from './interface';
+export * from './service';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.CaptchaConfiguration; } });
+__exportStar(require("./interface"), exports);
+__exportStar(require("./service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -0,0 +1,24 @@
+interface BaseCaptchaOptions {
+    size?: number;
+    noise?: number;
+    width?: number;
+    height?: number;
+}
+export interface CaptchaOptions extends BaseCaptchaOptions {
+    image?: ImageCaptchaOptions;
+    formula?: FormulaCaptchaOptions;
+    text?: TextCaptchaOptions;
+    expirationTime?: number;
+    idPrefix?: string;
+}
+export interface ImageCaptchaOptions extends BaseCaptchaOptions {
+    type?: 'number' | 'letter' | 'mixed';
+}
+export interface FormulaCaptchaOptions extends BaseCaptchaOptions {
+}
+export interface TextCaptchaOptions {
+    size?: number;
+    type?: 'number' | 'letter' | 'mixed';
+}
+export {};
+//# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/dist/service.d.ts

@@ -0,0 +1,22 @@
+import { CacheManager } from '@midwayjs/cache';
+import { FormulaCaptchaOptions, ImageCaptchaOptions, TextCaptchaOptions, CaptchaOptions } from './interface';
+export declare class CaptchaService {
+    cacheManager: CacheManager;
+    captcha: CaptchaOptions;
+    image(options?: ImageCaptchaOptions): Promise<{
+        id: string;
+        imageBase64: string;
+    }>;
+    formula(options?: FormulaCaptchaOptions): Promise<{
+        id: string;
+        imageBase64: string;
+    }>;
+    text(options?: TextCaptchaOptions): Promise<{
+        id: string;
+        text: string;
+    }>;
+    set(text: string): Promise<string>;
+    check(id: string, value: string): Promise<boolean>;
+    private getStoreId;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/service.js

@@ -0,0 +1,105 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptchaService = void 0;
+const core_1 = require("@midwayjs/core");
+const cache_1 = require("@midwayjs/cache");
+const svgCaptcha = require("svg-captcha");
+const svgBase64 = require("mini-svg-data-uri");
+const nanoid_1 = require("nanoid");
+const constants_1 = require("./constants");
+let CaptchaService = class CaptchaService {
+    async image(options) {
+        const { width, height, type } = Object.assign({}, this.captcha, this.captcha.image, options);
+        let ignoreChars = '';
+        switch (type) {
+            case 'letter':
+                ignoreChars = constants_1.numbers;
+                break;
+            case 'number':
+                ignoreChars = constants_1.letters;
+                break;
+        }
+        const { data, text } = svgCaptcha.create({
+            ignoreChars,
+            width,
+            height,
+        });
+        const id = await this.set(text);
+        const imageBase64 = svgBase64(data);
+        return { id, imageBase64 };
+    }
+    async formula(options) {
+        const { width, height } = Object.assign({}, this.captcha, this.captcha.formula, options);
+        const { data, text } = svgCaptcha.createMathExpr({
+            width,
+            height,
+        });
+        const id = await this.set(text);
+        const imageBase64 = svgBase64(data);
+        return { id, imageBase64 };
+    }
+    async text(options) {
+        const textOptions = Object.assign({}, this.captcha, this.captcha.text, options);
+        let chars = '';
+        switch (textOptions.type) {
+            case 'letter':
+                chars = constants_1.letters;
+                break;
+            case 'number':
+                chars = constants_1.numbers;
+                break;
+            default:
+                chars = constants_1.letters + constants_1.numbers;
+                break;
+        }
+        let text = '';
+        while (textOptions.size--) {
+            text += chars[Math.floor(Math.random() * chars.length)];
+        }
+        const id = await this.set(text);
+        return { id, text };
+    }
+    async set(text) {
+        const id = (0, nanoid_1.nanoid)();
+        await this.cacheManager.set(this.getStoreId(id), (text || '').toLowerCase(), { ttl: this.captcha.expirationTime });
+        return id;
+    }
+    async check(id, value) {
+        if (!id || !value) {
+            return false;
+        }
+        const storeId = this.getStoreId(id);
+        const storedValue = await this.cacheManager.get(storeId);
+        if (value.toLowerCase() !== storedValue) {
+            return false;
+        }
+        this.cacheManager.del(storeId);
+        return true;
+    }
+    getStoreId(id) {
+        return `${this.captcha}:${id}`;
+    }
+};
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", cache_1.CacheManager)
+], CaptchaService.prototype, "cacheManager", void 0);
+__decorate([
+    (0, core_1.Config)('captcha'),
+    __metadata("design:type", Object)
+], CaptchaService.prototype, "captcha", void 0);
+CaptchaService = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], CaptchaService);
+exports.CaptchaService = CaptchaService;
+//# sourceMappingURL=service.js.map

package/index.d.ts

@@ -0,0 +1,8 @@
+import { CaptchaOptions } from './dist/index';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    captcha?: Partial<CaptchaOptions>;
+  }
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@midwayjs/captcha",
+  "version": "3.6.1",
+  "description": "Midway Component for Captcha(Verification Code)",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
+    "ci": "npm run test"
+  },
+  "keywords": [],
+  "author": "",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "mini-svg-data-uri": "1.4.4",
+    "nanoid": "3.3.4",
+    "svg-captcha": "1.4.0",
+    "@midwayjs/cache": "^3.6.0"
+  },
+  "devDependencies": {
+    "@midwayjs/core": "^3.6.0",
+    "@midwayjs/koa": "^3.6.0",
+    "@midwayjs/mock": "^3.6.0"
+  }
+}