@jayfong/x-server 1.13.0 → 1.14.1

package/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.14.1](https://github.com/jfWorks/x-server/compare/v1.14.0...v1.14.1) (2022-04-26)
+
+
+### Bug Fixes
+
+* requestDataSchema ([8b4f910](https://github.com/jfWorks/x-server/commit/8b4f910b1e9efbc082571b9ef407d7baf31b6319))
+
+## [1.14.0](https://github.com/jfWorks/x-server/compare/v1.13.1...v1.14.0) (2022-04-26)
+
+
+### Features
+
+* requestDataSchema ([72970dd](https://github.com/jfWorks/x-server/commit/72970dd63810ab9b3fcdc9390fcde3cfdd4a6013))
+
+
+### Bug Fixes
+
+* text -> code ([a8571e3](https://github.com/jfWorks/x-server/commit/a8571e3c99036467f2110b5ab30798c4e6bc42af))
+
+### [1.13.1](https://github.com/jfWorks/x-server/compare/v1.13.0...v1.13.1) (2022-04-26)
+
+
+### Bug Fixes
+
+* appname -> appid ([88d14d1](https://github.com/jfWorks/x-server/commit/88d14d18078c7bc19ddf2c973e53cc0353a533de))
+
 ## [1.13.0](https://github.com/jfWorks/x-server/compare/v1.12.0...v1.13.0) (2022-04-26)
 
 

package/lib/_cjs/core/define_task.js

@@ -12,7 +12,7 @@ var _x = require("../x");
 async function defineTask(options) {
   const queue = new _bull.default(options.name, {
     redis: _x.x.redis.options,
-    prefix: `${_x.x.appName}_task`
+    prefix: `${_x.x.appId}_task`
   });
   queue.process(async job => {
     return options.handle(job.data);

package/lib/_cjs/core/handler.js

@@ -9,9 +9,12 @@ var _dispose = require("../services/dispose");
 
 var _http_error = require("../core/http_error");
 
+var _validator = require("vtils/validator");
+
 class Handler {
   constructor(options) {
     this.options = options;
+    this.requestDataSchema = void 0;
 
     this.handle = async (data, ctx) => {
       // 前置 hook
@@ -27,6 +30,19 @@ class Handler {
     };
 
     this.handleHttp = async (data, ctx) => {
+      // 请求数据验证
+      if (this.requestDataSchema) {
+        try {
+          data = await this.requestDataSchema.validate(data, {
+            strict: true,
+            abortEarly: true,
+            stripUnknown: true
+          });
+        } catch (err) {
+          throw new _http_error.HttpError.BadRequest(err.message);
+        }
+      }
+
       let res = await this.options.handle(data, ctx); // 打包返回数据
 
       if (this.options.responseDataPack) {
@@ -78,6 +94,10 @@ class Handler {
         dispose.dispose();
       });
     };
+
+    if (options.requestDataSchema) {
+      this.requestDataSchema = options.requestDataSchema(_validator.yup);
+    }
   }
 
   static addHook(hook) {

package/lib/_cjs/services/cache.js

@@ -16,7 +16,7 @@ class CacheService {
     this.options = options;
     this.serviceName = 'cache';
     this.prefix = void 0;
-    this.prefix = `${_x.x.appName}:`;
+    this.prefix = `${_x.x.appId}:`;
   }
 
   toRedisKey(key) {

package/lib/_cjs/services/captcha.js

@@ -16,37 +16,40 @@ class CaptchaService {
   }
 
   async generate() {
-    const text = Math.random().toString().slice(0 - this.options.size);
-    const token = await _x.x.cache.save(text, this.options.ttl);
+    const code = Math.random().toString().slice(0 - this.options.size);
+    const token = await _x.x.cache.save(code, this.options.ttl);
     return {
-      text: text,
-      token: token
+      token: token,
+      code: code
     };
   }
 
   async generateImage() {
-    const res = _svgCaptcha.default.create({
+    const {
+      text: code,
+      data: svg
+    } = _svgCaptcha.default.create({
       size: this.options.size
     });
 
-    const token = await _x.x.cache.save(res.text, this.options.ttl);
+    const token = await _x.x.cache.save(code, this.options.ttl);
     return {
-      text: res.text,
-      svg: res.data,
-      token: token
+      token: token,
+      code: code,
+      svg: svg
     };
   }
 
   async verify(options) {
-    var _options$text;
+    var _options$code;
 
-    if (((_options$text = options.text) == null ? void 0 : _options$text.length) !== this.options.size) {
+    if (((_options$code = options.code) == null ? void 0 : _options$code.length) !== this.options.size) {
       return false;
     }
 
-    const expectedText = await _x.x.cache.get(options.token);
+    const expectedCode = await _x.x.cache.get(options.token);
     await _x.x.cache.remove(options.token);
-    return options.text === expectedText;
+    return options.code === expectedCode;
   }
 
 }

package/lib/_cjs/x.js

@@ -6,7 +6,7 @@ exports.x = void 0;
 var _dispose = require("./services/dispose");
 
 const x = {
-  appName: process.env.APP_NAME,
+  appId: process.env.APP_ID,
   register: (...services) => {
     for (const service of services) {
       // @ts-ignore

package/lib/core/define_task.js

@@ -3,7 +3,7 @@ import { x } from "../x";
 export async function defineTask(options) {
   const queue = new Queue(options.name, {
     redis: x.redis.options,
-    prefix: `${x.appName}_task`
+    prefix: `${x.appId}_task`
   });
   queue.process(async job => {
     return options.handle(job.data);

package/lib/core/handler.d.ts

@@ -1,6 +1,7 @@
 import type { XHandler } from './types';
 export declare class Handler<TReqData extends any = void, TResData extends any = void, TReqMethod extends XHandler.Method = XHandler.Method> {
     readonly options: XHandler.Options<TReqData, TResData, TReqMethod>;
+    private requestDataSchema;
     constructor(options: XHandler.Options<TReqData, TResData, TReqMethod>);
     handle: XHandler.Handle<TReqData, TResData, TReqMethod>;
     private handleHttp;

package/lib/core/handler.js

@@ -1,9 +1,11 @@
 import { DataPacker } from 'vtils';
 import { DisposeService } from "../services/dispose";
 import { HttpError } from "../core/http_error";
+import { yup } from 'vtils/validator';
 export class Handler {
   constructor(options) {
     this.options = options;
+    this.requestDataSchema = void 0;
 
     this.handle = async (data, ctx) => {
       // 前置 hook
@@ -19,6 +21,19 @@ export class Handler {
     };
 
     this.handleHttp = async (data, ctx) => {
+      // 请求数据验证
+      if (this.requestDataSchema) {
+        try {
+          data = await this.requestDataSchema.validate(data, {
+            strict: true,
+            abortEarly: true,
+            stripUnknown: true
+          });
+        } catch (err) {
+          throw new HttpError.BadRequest(err.message);
+        }
+      }
+
       let res = await this.options.handle(data, ctx); // 打包返回数据
 
       if (this.options.responseDataPack) {
@@ -70,6 +85,10 @@ export class Handler {
         dispose.dispose();
       });
     };
+
+    if (options.requestDataSchema) {
+      this.requestDataSchema = options.requestDataSchema(yup);
+    }
   }
 
   static addHook(hook) {

package/lib/core/types.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="node" />
 import { BasePlugin } from '../plugins/base';
 import { BaseService } from '../services/base';
-import type { AsyncOrSync, OneOrMore } from 'vtils/types';
+import { yup } from 'vtils/validator';
+import type { AsyncOrSync, OneOrMore, RequiredDeep } from 'vtils/types';
 import type { DisposeService } from '../services/dispose';
 import type { Handler } from './handler';
 import type { IncomingHttpHeaders } from 'http';
@@ -89,6 +90,10 @@ export declare namespace XHandler {
          * @default false
          */
         responseDataPack?: boolean;
+        /**
+         * 请求数据验证结构
+         */
+        requestDataSchema?: (_: typeof yup) => yup.GetSchema<RequiredDeep<TReqData>>;
         /**
          * 处理器
          */

package/lib/services/cache.js

@@ -6,7 +6,7 @@ export class CacheService {
     this.options = options;
     this.serviceName = 'cache';
     this.prefix = void 0;
-    this.prefix = `${x.appName}:`;
+    this.prefix = `${x.appId}:`;
   }
 
   toRedisKey(key) {

package/lib/services/captcha.d.ts

@@ -11,17 +11,17 @@ export interface CaptchaOptions {
     ttl: MsValue;
 }
 export interface CaptchaGenerateResult {
-    text: string;
     token: string;
+    code: string;
 }
 export interface CaptchaGenerateImageResult {
-    text: string;
-    svg: string;
     token: string;
+    code: string;
+    svg: string;
 }
 export interface CaptchaVerifyOptions {
-    text: string;
     token: string;
+    code: string;
 }
 export declare class CaptchaService implements BaseService {
     private options;

package/lib/services/captcha.js

@@ -7,36 +7,39 @@ export class CaptchaService {
   }
 
   async generate() {
-    const text = Math.random().toString().slice(0 - this.options.size);
-    const token = await x.cache.save(text, this.options.ttl);
+    const code = Math.random().toString().slice(0 - this.options.size);
+    const token = await x.cache.save(code, this.options.ttl);
     return {
-      text: text,
-      token: token
+      token: token,
+      code: code
     };
   }
 
   async generateImage() {
-    const res = svgCaptcha.create({
+    const {
+      text: code,
+      data: svg
+    } = svgCaptcha.create({
       size: this.options.size
     });
-    const token = await x.cache.save(res.text, this.options.ttl);
+    const token = await x.cache.save(code, this.options.ttl);
     return {
-      text: res.text,
-      svg: res.data,
-      token: token
+      token: token,
+      code: code,
+      svg: svg
     };
   }
 
   async verify(options) {
-    var _options$text;
+    var _options$code;
 
-    if (((_options$text = options.text) == null ? void 0 : _options$text.length) !== this.options.size) {
+    if (((_options$code = options.code) == null ? void 0 : _options$code.length) !== this.options.size) {
       return false;
     }
 
-    const expectedText = await x.cache.get(options.token);
+    const expectedCode = await x.cache.get(options.token);
     await x.cache.remove(options.token);
-    return options.text === expectedText;
+    return options.code === expectedCode;
   }
 
 }

package/lib/x.d.ts

@@ -1,7 +1,7 @@
 import { BaseService } from './services/base';
 import './services/dispose';
 export interface X {
-    readonly appName: string;
+    readonly appId: string;
     readonly register: (...services: BaseService[]) => void;
 }
 export declare const x: X;

package/lib/x.js

@@ -1,6 +1,6 @@
 import { DisposeService } from "./services/dispose";
 export const x = {
-  appName: process.env.APP_NAME,
+  appId: process.env.APP_ID,
   register: (...services) => {
     for (const service of services) {
       // @ts-ignore

package/package.json

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