@jayfong/x-server 1.13.1 → 1.15.0

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.15.0](https://github.com/jfWorks/x-server/compare/v1.14.1...v1.15.0) (2022-04-26)
+
+
+### Features
+
+* x.env ([e39771f](https://github.com/jfWorks/x-server/commit/e39771f998f4b952bda528105fb18b6895e0ce81))
+
+### [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)
 
 

package/lib/_cjs/cli/build_util.js

@@ -23,7 +23,7 @@ var _vtils = require("vtils");
 
 class BuildUtil {
   static async build(options) {
-    var _options$minify, _options$inlineEnvs;
+    var _options$minify;
 
     const mainFile = _nodePath.default.join(options.cwd, 'src/main.ts');
 
@@ -75,7 +75,10 @@ class BuildUtil {
       sourcemap: false,
       treeShaking: true,
       banner: {
-        js: `${`;${(_options$inlineEnvs = options.inlineEnvs) == null ? void 0 : _options$inlineEnvs.map(env => `process.env[${JSON.stringify(env.key)}]=${JSON.stringify(env.value)}`).join(';')}` || ''};`
+        js: `;process.env.X_SERVER_ENVS=${JSON.stringify((options.inlineEnvs || []).reduce((res, item) => {
+          res[item.key] = item.value;
+          return res;
+        }, {}))}};`
       },
       plugins: [{
         name: 'extract-assets',

package/lib/_cjs/cli/env_util.js

@@ -105,9 +105,18 @@ class EnvUtil {
   }
 
   static async importFile(options) {
-    for (const env of await EnvUtil.parseFile(options)) {
+    const envs = await EnvUtil.parseFile(options);
+    const envsObj = {};
+
+    for (const env of envs) {
+      envsObj[env.key] = env.value;
       process.env[env.key] = env.value;
     }
+
+    process.env.X_SERVER_ENVS = JSON.stringify({ // @ts-ignore
+      ...JSON.parse(process.env.X_SERVER_ENVS || '{}'),
+      ...envsObj
+    });
   }
 
   static makeTypes(envs) {

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/captcha.js

@@ -16,37 +16,38 @@ 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;
-
-    if (((_options$text = options.text) == null ? void 0 : _options$text.length) !== this.options.size) {
+    if (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

@@ -5,8 +5,10 @@ exports.x = void 0;
 
 var _dispose = require("./services/dispose");
 
+const env = JSON.parse(process.env.X_SERVER_ENVS || '{}');
 const x = {
-  appId: process.env.APP_ID,
+  appId: env.APP_ID,
+  env: env,
   register: (...services) => {
     for (const service of services) {
       // @ts-ignore

package/lib/cli/build_util.js

@@ -8,7 +8,7 @@ import path from 'node:path';
 import { dedent, uniq } from 'vtils';
 export class BuildUtil {
   static async build(options) {
-    var _options$minify, _options$inlineEnvs;
+    var _options$minify;
 
     const mainFile = path.join(options.cwd, 'src/main.ts');
     const pkgFile = path.join(options.cwd, 'package.json');
@@ -51,7 +51,10 @@ export class BuildUtil {
       sourcemap: false,
       treeShaking: true,
       banner: {
-        js: `${`;${(_options$inlineEnvs = options.inlineEnvs) == null ? void 0 : _options$inlineEnvs.map(env => `process.env[${JSON.stringify(env.key)}]=${JSON.stringify(env.value)}`).join(';')}` || ''};`
+        js: `;process.env.X_SERVER_ENVS=${JSON.stringify((options.inlineEnvs || []).reduce((res, item) => {
+          res[item.key] = item.value;
+          return res;
+        }, {}))}};`
       },
       plugins: [{
         name: 'extract-assets',

package/lib/cli/env_util.js

@@ -95,9 +95,18 @@ export class EnvUtil {
   }
 
   static async importFile(options) {
-    for (const env of await EnvUtil.parseFile(options)) {
+    const envs = await EnvUtil.parseFile(options);
+    const envsObj = {};
+
+    for (const env of envs) {
+      envsObj[env.key] = env.value;
       process.env[env.key] = env.value;
     }
+
+    process.env.X_SERVER_ENVS = JSON.stringify({ // @ts-ignore
+      ...JSON.parse(process.env.X_SERVER_ENVS || '{}'),
+      ...envsObj
+    });
   }
 
   static makeTypes(envs) {

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/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,37 @@ 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;
-
-    if (((_options$text = options.text) == null ? void 0 : _options$text.length) !== this.options.size) {
+    if (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,9 @@
+/// <reference types="node" />
 import { BaseService } from './services/base';
 import './services/dispose';
 export interface X {
     readonly appId: string;
+    readonly env: NodeJS.ProcessEnv;
     readonly register: (...services: BaseService[]) => void;
 }
 export declare const x: X;

package/lib/x.js

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

package/package.json

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