@jayfong/x-server 2.20.0 → 2.21.1

package/lib/_cjs/services/captcha.js

@@ -23,6 +23,7 @@ class CaptchaService {
     };
   }
   async generate(payload) {
+    var _payload$retryCount;
     const chars = this.charsetMap[payload.charset];
     let code = '';
     for (let i = 0; i < payload.size; i++) {
@@ -30,7 +31,9 @@ class CaptchaService {
     }
     const token = await _x.x.cache.save({
       code: code,
-      scene: payload.scene
+      scene: payload.scene,
+      retryCount: (_payload$retryCount = payload.retryCount) != null ? _payload$retryCount : 0,
+      extra: payload.extra
     }, payload.ttl);
     return {
       token: token,
@@ -46,8 +49,10 @@ class CaptchaService {
       charPreset: this.charsetMap[payload.charset].join('')
     });
     const token = await _x.x.cache.save({
-      code,
-      scene: payload.scene
+      code: code,
+      scene: payload.scene,
+      retryCount: payload.retryCount || 0,
+      extra: payload.extra
     }, payload.ttl);
     const dataUrl = (0, _miniSvgDataUri.default)(svg);
     return {
@@ -61,8 +66,14 @@ class CaptchaService {
     if (expected == null) {
       return false;
     }
-    await _x.x.cache.remove(options.token);
-    return expected.scene === options.scene && options.code.toLowerCase() === expected.code.toLowerCase();
+    if (expected.retryCount === 0) {
+      await _x.x.cache.remove(options.token);
+    } else {
+      expected.retryCount--;
+      const ttl = await _x.x.cache.ttl(options.token);
+      await _x.x.cache.set(options.token, expected, ttl);
+    }
+    return expected.scene === options.scene && options.code.toLowerCase() === expected.code.toLowerCase() && (options.extra ? options.extra(expected.extra) : true);
   }
 }
 exports.CaptchaService = CaptchaService;

package/lib/services/captcha.d.ts

@@ -1,9 +1,11 @@
 import { type MsValue } from 'vtils';
 import { BaseService } from './base';
 export type CaptchaServiceGenerateCharset = '09' | '19' | 'az' | 'AZ' | 'aZ' | '0z' | '0Z' | '1z' | '1Z';
-export interface CaptchaServiceGeneratePayload {
+export interface CaptchaServiceGeneratePayload<T> {
     /**
      * 场景值
+     *
+     * 比如：防止后台验证码图片登录用其他场景下的短信验证码
      */
     scene: string;
     /**
@@ -18,6 +20,16 @@ export interface CaptchaServiceGeneratePayload {
      * 字符集
      */
     charset: CaptchaServiceGenerateCharset;
+    /**
+     * 可重试次数
+     *
+     * @default 0
+     */
+    retryCount?: number;
+    /**
+     * 其他信息
+     */
+    extra?: T;
 }
 export interface CaptchaServiceGenerateResult {
     token: string;
@@ -33,17 +45,18 @@ export interface CaptchaServiceGenerateDataUrlResult {
     code: string;
     dataUrl: string;
 }
-export interface CaptchaServiceVerifyOptions {
+export interface CaptchaServiceVerifyOptions<T> {
     token: string;
     code: string;
     scene: string;
+    extra?: (extra: T) => boolean;
 }
 export declare class CaptchaService implements BaseService {
     serviceName: string;
     private charsetMap;
-    generate(payload: CaptchaServiceGeneratePayload): Promise<CaptchaServiceGenerateResult>;
-    generateDataUrl(payload: CaptchaServiceGeneratePayload): Promise<CaptchaServiceGenerateDataUrlResult>;
-    verify(options: CaptchaServiceVerifyOptions): Promise<boolean>;
+    generate<T extends Record<string, any>>(payload: CaptchaServiceGeneratePayload<T>): Promise<CaptchaServiceGenerateResult>;
+    generateDataUrl<T extends Record<string, any>>(payload: CaptchaServiceGeneratePayload<T>): Promise<CaptchaServiceGenerateDataUrlResult>;
+    verify<T extends Record<string, any>>(options: CaptchaServiceVerifyOptions<T>): Promise<boolean>;
 }
 declare module '../x' {
     interface X {

package/lib/services/captcha.js

@@ -18,6 +18,7 @@ export class CaptchaService {
     };
   }
   async generate(payload) {
+    var _payload$retryCount;
     const chars = this.charsetMap[payload.charset];
     let code = '';
     for (let i = 0; i < payload.size; i++) {
@@ -25,7 +26,9 @@ export class CaptchaService {
     }
     const token = await x.cache.save({
       code: code,
-      scene: payload.scene
+      scene: payload.scene,
+      retryCount: (_payload$retryCount = payload.retryCount) != null ? _payload$retryCount : 0,
+      extra: payload.extra
     }, payload.ttl);
     return {
       token: token,
@@ -41,8 +44,10 @@ export class CaptchaService {
       charPreset: this.charsetMap[payload.charset].join('')
     });
     const token = await x.cache.save({
-      code,
-      scene: payload.scene
+      code: code,
+      scene: payload.scene,
+      retryCount: payload.retryCount || 0,
+      extra: payload.extra
     }, payload.ttl);
     const dataUrl = svgToDataUrl(svg);
     return {
@@ -56,7 +61,13 @@ export class CaptchaService {
     if (expected == null) {
       return false;
     }
-    await x.cache.remove(options.token);
-    return expected.scene === options.scene && options.code.toLowerCase() === expected.code.toLowerCase();
+    if (expected.retryCount === 0) {
+      await x.cache.remove(options.token);
+    } else {
+      expected.retryCount--;
+      const ttl = await x.cache.ttl(options.token);
+      await x.cache.set(options.token, expected, ttl);
+    }
+    return expected.scene === options.scene && options.code.toLowerCase() === expected.code.toLowerCase() && (options.extra ? options.extra(expected.extra) : true);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "2.20.0",
+  "version": "2.21.1",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",