vona-module-a-captcha 5.0.8 → 5.0.10

package/dist/.metadata/index.d.ts

@@ -1,23 +1,23 @@
 import type { TypeSymbolKeyFieldsMore } from 'vona-module-a-orm';
 import type { TypeEntityOptionsFields, TypeControllerOptionsActions } from 'vona-module-a-openapi';
-/** middleware: begin */
-export * from '../bean/middleware.captcha.ts';
-import type { IMiddlewareOptionsCaptcha } from '../bean/middleware.captcha.ts';
+/** interceptor: begin */
+export * from '../bean/interceptor.captchaVerify.ts';
+import type { IInterceptorOptionsCaptchaVerify } from '../bean/interceptor.captchaVerify.ts';
 import 'vona';
 declare module 'vona-module-a-aspect' {
-    interface IMiddlewareRecordLocal {
-        'a-captcha:captcha': IMiddlewareOptionsCaptcha;
+    interface IInterceptorRecordLocal {
+        'a-captcha:captchaVerify': IInterceptorOptionsCaptchaVerify;
     }
 }
 declare module 'vona-module-a-captcha' {
-    interface MiddlewareCaptcha {
+    interface InterceptorCaptchaVerify {
     }
-    interface MiddlewareCaptcha {
-        get $beanFullName(): 'a-captcha.middleware.captcha';
-        get $onionName(): 'a-captcha:captcha';
+    interface InterceptorCaptchaVerify {
+        get $beanFullName(): 'a-captcha.interceptor.captchaVerify';
+        get $onionName(): 'a-captcha:captchaVerify';
     }
 }
-/** middleware: end */
+/** interceptor: end */
 /** bean: begin */
 export * from '../bean/bean.captcha.ts';
 import 'vona';

package/dist/bean/interceptor.captchaVerify.d.ts

@@ -0,0 +1,11 @@
+import type { Next } from 'vona';
+import type { IDecoratorInterceptorOptions, IInterceptorExecute } from 'vona-module-a-aspect';
+import type { ICaptchaSceneRecord } from '../types/captchaScene.ts';
+import { BeanBase } from 'vona';
+export interface IInterceptorOptionsCaptchaVerify extends IDecoratorInterceptorOptions {
+    scene?: keyof ICaptchaSceneRecord;
+    bodyField?: string;
+}
+export declare class InterceptorCaptchaVerify extends BeanBase implements IInterceptorExecute {
+    execute(options: IInterceptorOptionsCaptchaVerify, next: Next): Promise<any>;
+}

package/dist/index.js

@@ -1,5 +1,5 @@
 import { BeanInfo, BeanBase, uuidv4, beanFullNameFromOnionName, deepExtend, BeanScopeBase, createBeanDecorator } from 'vona';
-import { Middleware } from 'vona-module-a-aspect';
+import { Interceptor, Aspect } from 'vona-module-a-aspect';
 import { getRandomInt } from '@cabloy/utils';
 import { Bean, Scope } from 'vona-module-a-bean';
 import { CacheRedis, BeanCacheRedisBase } from 'vona-module-a-cache';
@@ -9,35 +9,27 @@ import { Passport } from 'vona-module-a-user';
 import z from 'zod';
 
 var _dec$6, _dec2$6, _class$6;
-let MiddlewareCaptcha = (_dec$6 = Middleware({
+let InterceptorCaptchaVerify = (_dec$6 = Interceptor({
   bodyField: 'captcha'
 }), _dec2$6 = BeanInfo({
   module: "a-captcha"
-}), _dec$6(_class$6 = _dec2$6(_class$6 = class MiddlewareCaptcha extends BeanBase {
+}), _dec$6(_class$6 = _dec2$6(_class$6 = class InterceptorCaptchaVerify extends BeanBase {
   async execute(options, next) {
+    // scene
     const sceneName = options.scene;
-    if (!sceneName) throw new Error('please specify the captcha scene name');
+    if (!sceneName) throw new Error('should specify the captchaVerify scene name');
     // captcha
     const bodyField = options.bodyField;
     const captcha = this.ctx.request.body[bodyField];
     if (!captcha) throw new Error('not found captcha data');
+    if (typeof captcha !== 'object') throw new Error('not found valid captcha data');
+    // verify
     const verified = await this.bean.captcha.verify(captcha.id, captcha.token, sceneName);
-    if (!verified) throw combineCaptchaError(bodyField, this.scope.locale.CaptchaInvalid());
+    if (!verified) throw this.bean.zod.customError([bodyField], this.scope.locale.CaptchaInvalid());
     // next
     return next();
   }
 }) || _class$6) || _class$6);
-function combineCaptchaError(bodyField, message) {
-  // error
-  const error = new Error();
-  error.code = 422;
-  error.message = [{
-    code: 'custom',
-    path: [bodyField],
-    message
-  }];
-  return error;
-}
 
 var _dec$5, _dec2$5, _class$5;
 const SymbolProviders = Symbol('SymbolProviders');
@@ -78,13 +70,40 @@ let BeanCaptcha = (_dec$5 = Bean(), _dec2$5 = BeanInfo({
     return result;
   }
   async refresh(id, sceneName) {
-    // delete cache
-    await this.scope.cacheRedis.captcha.del(id);
+    let captchaData = await this.getCaptchaData(id);
+    if (!captchaData) {
+      // create
+      return await this.create(sceneName);
+    }
+    // scene
+    if (captchaData.scene !== sceneName) this.app.throw(403);
     // create
-    return await this.create(sceneName);
+    const beanInstance = this._getProviderInstance(captchaData.provider);
+    const providerOptions = this._getProviderOptions(captchaData.scene, captchaData.provider);
+    const captcha = await beanInstance.create(providerOptions);
+    // data
+    captchaData = {
+      scene: sceneName,
+      provider: captchaData.provider,
+      token: captcha.token
+    };
+    // cache
+    await this.scope.cacheRedis.captcha.set(captchaData, id, {
+      ttl: providerOptions.ttl ?? this.scope.config.captchaProvider.ttl
+    });
+    // result
+    const result = {
+      id,
+      provider: captchaData.provider,
+      payload: captcha.payload
+    };
+    if (this.scope.config.captcha.showToken) {
+      result.token = captcha.token;
+    }
+    return result;
   }
   async verify(id, token, sceneName) {
-    const captchaData = await this.getCaptchaData(id);
+    let captchaData = await this.getCaptchaData(id);
     if (!captchaData) return false;
     // scene
     if (captchaData.scene !== sceneName) return false;
@@ -92,44 +111,53 @@ let BeanCaptcha = (_dec$5 = Bean(), _dec2$5 = BeanInfo({
     const tokenSecondary = captchaData.token2;
     if (tokenSecondary) {
       // delete cache
-      this.ctx.commit(async () => {
-        await this.scope.cacheRedis.captcha.del(id);
-      });
+      await this.scope.cacheRedis.captcha.del(id);
       return tokenSecondary === token;
     }
     // provider
     const beanInstance = this._getProviderInstance(captchaData.provider);
     const providerOptions = this._getProviderOptions(captchaData.scene, captchaData.provider);
     // verify
+    if (!captchaData.token) return false;
     const verified = await beanInstance.verify(captchaData.token, token, providerOptions);
     if (!verified) {
-      // do not mutate cache
+      // update token. not delete cache for refresh
+      captchaData = {
+        ...captchaData,
+        token: undefined
+      };
+      await this.scope.cacheRedis.captcha.set(captchaData, id, {
+        ttl: providerOptions.ttl ?? this.scope.config.captchaProvider.ttl
+      });
       return false;
     }
     // delete cache
-    this.ctx.commit(async () => {
-      await this.scope.cacheRedis.captcha.del(id);
-    });
+    await this.scope.cacheRedis.captcha.del(id);
     // ok
     return true;
   }
   async verifyImmediate(id, token) {
     let captchaData = await this.getCaptchaData(id);
     if (!captchaData) return false;
-    // tokenSecondary
-    let tokenSecondary = captchaData.token2;
-    if (tokenSecondary) return tokenSecondary; // maybe called more times
+    if (!captchaData.token) return false;
     // provider
     const beanInstance = this._getProviderInstance(captchaData.provider);
     const providerOptions = this._getProviderOptions(captchaData.scene, captchaData.provider);
     // verify
     const verified = await beanInstance.verify(captchaData.token, token, providerOptions);
     if (!verified) {
-      // do not mutate cache
+      // update token. not delete cache for refresh
+      captchaData = {
+        ...captchaData,
+        token: undefined
+      };
+      await this.scope.cacheRedis.captcha.set(captchaData, id, {
+        ttl: providerOptions.ttl ?? this.scope.config.captchaProvider.ttl
+      });
       return false;
     }
     // tokenSecondary
-    tokenSecondary = uuidv4();
+    const tokenSecondary = uuidv4();
     captchaData = {
       ...captchaData,
       token: undefined,
@@ -347,6 +375,13 @@ function $locale(key) {
 }
 /** scope: end */
 
+function Verify(options) {
+  return Aspect.interceptor('a-captcha:captchaVerify', options);
+}
+const Captcha = {
+  verify: Verify
+};
+
 function CaptchaProvider(options) {
   return createBeanDecorator('captchaProvider', options);
 }
@@ -355,4 +390,4 @@ function CaptchaScene(options) {
   return createBeanDecorator('captchaScene', options);
 }
 
-export { $locale, BeanCaptcha, CacheRedisCaptcha, CaptchaProvider, CaptchaScene, ControllerCaptcha, DtoCaptchaData, DtoCaptchaVerify, MiddlewareCaptcha, ScopeModuleACaptcha, config, locales };
+export { $locale, BeanCaptcha, CacheRedisCaptcha, Captcha, CaptchaProvider, CaptchaScene, ControllerCaptcha, DtoCaptchaData, DtoCaptchaVerify, InterceptorCaptchaVerify, ScopeModuleACaptcha, config, locales };

package/dist/lib/captcha.d.ts

@@ -0,0 +1,6 @@
+import type { IInterceptorOptionsCaptchaVerify } from '../bean/interceptor.captchaVerify.ts';
+declare function Verify(options?: Partial<IInterceptorOptionsCaptchaVerify>): MethodDecorator;
+export declare const Captcha: {
+    verify: typeof Verify;
+};
+export {};

package/dist/lib/index.d.ts

@@ -1,2 +1,3 @@
+export * from './captcha.ts';
 export * from './captchaProvider.ts';
 export * from './captchaScene.ts';

package/dist/types/captchaProvider.d.ts

@@ -16,7 +16,7 @@ export interface IDecoratorCaptchaProviderOptions extends TypeOnionOptionsEnable
 }
 declare module 'vona-module-a-onion' {
     interface BeanOnion {
-        captchaProvider: ServiceOnion<IDecoratorCaptchaProviderOptions, keyof ICaptchaProviderRecord>;
+        captchaProvider: ServiceOnion<ICaptchaProviderRecord>;
     }
 }
 declare module 'vona' {

package/dist/types/captchaScene.d.ts

@@ -17,7 +17,7 @@ export interface IDecoratorCaptchaSceneOptions {
 }
 declare module 'vona-module-a-onion' {
     interface BeanOnion {
-        captchaScene: ServiceOnion<IDecoratorCaptchaSceneOptions, keyof ICaptchaSceneRecord>;
+        captchaScene: ServiceOnion<ICaptchaSceneRecord>;
     }
 }
 declare module 'vona' {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-captcha",
   "type": "module",
-  "version": "5.0.8",
+  "version": "5.0.10",
   "title": "a-captcha",
   "vonaModule": {
     "dependencies": {},

package/dist/bean/middleware.captcha.d.ts

@@ -1,11 +0,0 @@
-import type { Next } from 'vona';
-import type { IDecoratorMiddlewareOptions, IMiddlewareExecute } from 'vona-module-a-aspect';
-import type { ICaptchaSceneRecord } from '../types/captchaScene.ts';
-import { BeanBase } from 'vona';
-export interface IMiddlewareOptionsCaptcha extends IDecoratorMiddlewareOptions {
-    scene?: keyof ICaptchaSceneRecord;
-    bodyField?: string;
-}
-export declare class MiddlewareCaptcha extends BeanBase implements IMiddlewareExecute {
-    execute(options: IMiddlewareOptionsCaptcha, next: Next): Promise<any>;
-}