@eggjs/typebox-validate 4.0.0-beta.22 → 4.0.0-beta.23

package/README.md

@@ -57,7 +57,7 @@ export default HomeController;
 这就是这个库想要解决的问题，对于参数校验，写一遍类型就够了：
 
 ```diff
-+ import { Static, Type } from 'egg-typebox-validate/typebox';
++ import { Static, Type } from '@eggjs/typebox-validate/typebox';
 
 class HomeController extends Controller {
   async index() {
@@ -108,7 +108,7 @@ export default HomeController;
 针对 `egg@4.x` 及以上版本，使用
 
 ```js
-npm i egg-typebox-validate -S
+npm i @eggjs/typebox-validate -S
 ```
 
 针对 `egg@3.x` 版本，使用
@@ -124,7 +124,7 @@ npm i egg-typebox-validate@3 -S
 const plugin: EggPlugin = {
   typeboxValidate: {
     enable: true,
-    package: 'egg-typebox-validate',
+    package: '@eggjs/typebox-validate',
   },
 };
 ```
@@ -132,7 +132,7 @@ const plugin: EggPlugin = {
 3. 在业务代码中使用
 
 ```diff
-+ import { Static, Type } from 'egg-typebox-validate/typebox';
++ import { Static, Type } from '@eggjs/typebox-validate/typebox';
 
 // 写在 controller 外面，静态化，性能更好，下面有 benchmark
 + const paramsSchema = Type.Object({
@@ -280,7 +280,7 @@ Fastest is #ajv define once
 
 ## 总结
 
-切换到 egg-typebox-validate 校验后：
+切换到 `@eggjs/typebox-validate` 校验后：
 
 1. 可以解决 ts 项目中参数校验代码写两遍类型的问题，提升代码重用率，可维护性等问题
 2. 用标准 json-schema 来做参数校验，是更加标准的业界做法，内置更多业界标准模型
@@ -290,7 +290,7 @@ Fastest is #ajv define once
 1. `ctx.tValidate` 参数校验失败后，抛出错误，内部实现（错误码、错误标题等）逻辑和 `ctx.validate` 的保持一致
 
 ```diff
-+ import { Static, Type } from 'egg-typebox-validate/typebox';
++ import { Static, Type } from '@eggjs/typebox-validate/typebox';
 
 ctx.tValidate(Type.Object({
   name: Type.String(),
@@ -300,7 +300,7 @@ ctx.tValidate(Type.Object({
 2. `ctx.tValidateWithoutThrow` 直接校验，不抛出错误
 
 ```diff
-+ import { Static, Type } from 'egg-typebox-validate/typebox';
++ import { Static, Type } from '@eggjs/typebox-validate/typebox';
 
 const valid = ctx.tValidateWithoutThrow(Type.Object({
   name: Type.String(),
@@ -318,7 +318,7 @@ if (valid) {
 3. ⭐⭐⭐ 装饰器 decorator `@Validate([ [rule1, ctx => ctx.xx1], [rule2, ctx => ctx.xx2] ])` 调用（写法更干净，推荐使用!️）
 
 ```diff
-+ import { Validate, ValidateFactory } from 'egg-typebox-validate/decorator';
++ import { Validate, ValidateFactory } from '@eggjs/typebox-validate/decorator';
 
 const ValidateWithRedirect = ValidateFactory(ctx => ctx.redirect('/422'));
 

package/dist/app/extend/context.d.ts

@@ -0,0 +1,12 @@
+import { Context } from 'egg';
+import type { Schema } from 'ajv/dist/2019.js';
+export default class AjvContext extends Context {
+    tValidate(schema: Schema, data: unknown): boolean;
+    tValidateWithoutThrow(schema: Schema, data: unknown): boolean;
+}
+declare module 'egg' {
+    interface Context {
+        tValidate(schema: Schema, data: unknown): boolean;
+        tValidateWithoutThrow(schema: Schema, data: unknown): boolean;
+    }
+}

package/dist/app/extend/context.js

@@ -0,0 +1,22 @@
+import { Context } from 'egg';
+export default class AjvContext extends Context {
+    tValidate(schema, data) {
+        const ajv = this.app.ajv;
+        const res = ajv.validate(schema, data);
+        if (!res) {
+            this.throw(422, 'Validation Failed', {
+                code: 'invalid_param',
+                errorData: data,
+                // TODO: high CPU usage https://github.com/eggjs/egg/pull/5583#discussion_r2404265446
+                currentSchema: JSON.stringify(schema),
+                errors: ajv.errors,
+            });
+        }
+        return res;
+    }
+    tValidateWithoutThrow(schema, data) {
+        const res = this.app.ajv.validate(schema, data);
+        return res;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLEtBQUssQ0FBQztBQUc5QixNQUFNLENBQUMsT0FBTyxPQUFPLFVBQVcsU0FBUSxPQUFPO0lBQzdDLFNBQVMsQ0FBQyxNQUFjLEVBQUUsSUFBYTtRQUNyQyxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQztRQUN6QixNQUFNLEdBQUcsR0FBRyxHQUFHLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUN2QyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7WUFDVCxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxtQkFBbUIsRUFBRTtnQkFDbkMsSUFBSSxFQUFFLGVBQWU7Z0JBQ3JCLFNBQVMsRUFBRSxJQUFJO2dCQUNmLHFGQUFxRjtnQkFDckYsYUFBYSxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDO2dCQUNyQyxNQUFNLEVBQUUsR0FBRyxDQUFDLE1BQU07YUFDbkIsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztRQUNELE9BQU8sR0FBRyxDQUFDO0lBQ2IsQ0FBQztJQUVELHFCQUFxQixDQUFDLE1BQWMsRUFBRSxJQUFhO1FBQ2pELE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDaEQsT0FBTyxHQUFHLENBQUM7SUFDYixDQUFDO0NBQ0YifQ==

package/dist/app.d.ts

@@ -0,0 +1,12 @@
+import type { Application, ILifecycleBoot } from 'egg';
+import { Ajv2019 as Ajv } from 'ajv/dist/2019.js';
+export default class AppBootHook implements ILifecycleBoot {
+    app: Application;
+    constructor(app: Application);
+    configDidLoad(): Promise<void>;
+}
+declare module 'egg' {
+    interface Application {
+        ajv: Ajv;
+    }
+}

package/dist/app.js

@@ -0,0 +1,43 @@
+import addFormats from 'ajv-formats';
+import { Ajv2019 as Ajv } from 'ajv/dist/2019.js';
+import keyWords from 'ajv-keywords';
+const getAjvInstance = () => {
+    const ajv = new Ajv();
+    // @ts-expect-error - keyWords types are not fully compatible
+    keyWords(ajv, 'transform');
+    // @ts-expect-error - addFormats types are not fully compatible
+    addFormats(ajv, [
+        'date-time',
+        'time',
+        'date',
+        'email',
+        'hostname',
+        'ipv4',
+        'ipv6',
+        'uri',
+        'uri-reference',
+        'uuid',
+        'uri-template',
+        'json-pointer',
+        'relative-json-pointer',
+        'regex',
+    ])
+        .addKeyword('kind')
+        .addKeyword('modifier');
+    return ajv;
+};
+export default class AppBootHook {
+    app;
+    constructor(app) {
+        this.app = app;
+        this.app.ajv = getAjvInstance();
+    }
+    async configDidLoad() {
+        const config = this.app.config;
+        const typeboxValidate = config.typeboxValidate;
+        if (typeboxValidate) {
+            typeboxValidate.patchAjv?.(this.app.ajv);
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLFVBQVUsTUFBTSxhQUFhLENBQUM7QUFDckMsT0FBTyxFQUFFLE9BQU8sSUFBSSxHQUFHLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUNsRCxPQUFPLFFBQVEsTUFBTSxjQUFjLENBQUM7QUFFcEMsTUFBTSxjQUFjLEdBQUcsR0FBRyxFQUFFO0lBQzFCLE1BQU0sR0FBRyxHQUFHLElBQUksR0FBRyxFQUFFLENBQUM7SUFDdEIsNkRBQTZEO0lBQzdELFFBQVEsQ0FBQyxHQUFHLEVBQUUsV0FBVyxDQUFDLENBQUM7SUFDM0IsK0RBQStEO0lBQy9ELFVBQVUsQ0FBQyxHQUFHLEVBQUU7UUFDZCxXQUFXO1FBQ1gsTUFBTTtRQUNOLE1BQU07UUFDTixPQUFPO1FBQ1AsVUFBVTtRQUNWLE1BQU07UUFDTixNQUFNO1FBQ04sS0FBSztRQUNMLGVBQWU7UUFDZixNQUFNO1FBQ04sY0FBYztRQUNkLGNBQWM7UUFDZCx1QkFBdUI7UUFDdkIsT0FBTztLQUNSLENBQUM7U0FDQyxVQUFVLENBQUMsTUFBTSxDQUFDO1NBQ2xCLFVBQVUsQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUMxQixPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUMsQ0FBQztBQUVGLE1BQU0sQ0FBQyxPQUFPLE9BQU8sV0FBVztJQUN2QixHQUFHLENBQWM7SUFFeEIsWUFBWSxHQUFnQjtRQUMxQixJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztRQUNmLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxHQUFHLGNBQWMsRUFBRSxDQUFDO0lBQ2xDLENBQUM7SUFFRCxLQUFLLENBQUMsYUFBYTtRQUNqQixNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztRQUMvQixNQUFNLGVBQWUsR0FBRyxNQUFNLENBQUMsZUFBZSxDQUFDO1FBQy9DLElBQUksZUFBZSxFQUFFLENBQUM7WUFDcEIsZUFBZSxDQUFDLFFBQVEsRUFBRSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDM0MsQ0FBQztJQUNILENBQUM7Q0FDRiJ9

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

@@ -0,0 +1,17 @@
+import type { Ajv2019 as Ajv } from 'ajv/dist/2019.js';
+export interface TypeboxValidateConfig {
+    patchAjv?: (ajv: Ajv) => void;
+}
+declare const _default: {
+    typeboxValidate: TypeboxValidateConfig;
+};
+export default _default;
+declare module 'egg' {
+    interface EggAppConfig {
+        /**
+         * typebox validate options
+         * @member Config#typeboxValidate
+         */
+        typeboxValidate: TypeboxValidateConfig;
+    }
+}

package/dist/config/config.default.js

@@ -0,0 +1,6 @@
+export default {
+    typeboxValidate: {
+        patchAjv: undefined,
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU1BLGVBQWU7SUFDYixlQUFlLEVBQUU7UUFDZixRQUFRLEVBQUUsU0FBUztLQUNLO0NBQzNCLENBQUMifQ==

package/dist/decorator.d.ts

@@ -0,0 +1,9 @@
+import type { Context } from 'egg';
+import type { TSchema } from './typebox.ts';
+import type { ErrorObject } from 'ajv/dist/2019.js';
+type CustomErrorMessage = (ctx: Context, errors: ErrorObject[]) => string;
+type GetData = (ctx: Context, args: unknown[]) => unknown;
+export type ValidateRule = [TSchema, GetData, CustomErrorMessage?];
+export declare function ValidateFactory(customHandler: (ctx: Context, data?: unknown, schema?: TSchema, customError?: CustomErrorMessage) => void): (rules: ValidateRule[]) => MethodDecorator;
+export declare const Validate: (rules: ValidateRule[]) => MethodDecorator;
+export {};

package/dist/decorator.js

@@ -0,0 +1,31 @@
+export function ValidateFactory(customHandler) {
+    return function Validate(rules) {
+        return (_, __, descriptor) => {
+            const fn = descriptor.value;
+            descriptor.value = async function (...args) {
+                const { ctx } = this;
+                for (const rule of rules) {
+                    const [schema, getData, customError] = rule;
+                    const data = getData(ctx, args);
+                    const valid = ctx.tValidateWithoutThrow(schema, data);
+                    if (!valid && customHandler) {
+                        return customHandler(ctx, data, schema, customError);
+                    }
+                }
+                return await fn.apply(this, args);
+            };
+            return descriptor;
+        };
+    };
+}
+export const Validate = ValidateFactory((ctx, data, schema, customError) => {
+    const app = ctx.app;
+    const message = customError ? customError(ctx, app.ajv.errors) : 'Validation Failed';
+    ctx.throw(422, message, {
+        code: 'invalid_param',
+        errorData: data,
+        currentSchema: JSON.stringify(schema),
+        errors: app.ajv.errors,
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2RlY29yYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFTQSxNQUFNLFVBQVUsZUFBZSxDQUM3QixhQUF5RztJQUV6RyxPQUFPLFNBQVMsUUFBUSxDQUFDLEtBQXFCO1FBQzVDLE9BQU8sQ0FBQyxDQUFDLEVBQUUsRUFBRSxFQUFFLFVBQThCLEVBQXNCLEVBQUU7WUFDbkUsTUFBTSxFQUFFLEdBQUcsVUFBVSxDQUFDLEtBQUssQ0FBQztZQUM1QixVQUFVLENBQUMsS0FBSyxHQUFHLEtBQUssV0FBVyxHQUFHLElBQWU7Z0JBQ25ELE1BQU0sRUFBRSxHQUFHLEVBQUUsR0FBRyxJQUF3QixDQUFDO2dCQUN6QyxLQUFLLE1BQU0sSUFBSSxJQUFJLEtBQUssRUFBRSxDQUFDO29CQUN6QixNQUFNLENBQUMsTUFBTSxFQUFFLE9BQU8sRUFBRSxXQUFXLENBQUMsR0FBRyxJQUFJLENBQUM7b0JBQzVDLE1BQU0sSUFBSSxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7b0JBQ2hDLE1BQU0sS0FBSyxHQUFHLEdBQUcsQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7b0JBQ3RELElBQUksQ0FBQyxLQUFLLElBQUksYUFBYSxFQUFFLENBQUM7d0JBQzVCLE9BQU8sYUFBYSxDQUFDLEdBQUcsRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLFdBQVcsQ0FBQyxDQUFDO29CQUN2RCxDQUFDO2dCQUNILENBQUM7Z0JBQ0QsT0FBTyxNQUFNLEVBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO1lBQ3BDLENBQUMsQ0FBQztZQUNGLE9BQU8sVUFBVSxDQUFDO1FBQ3BCLENBQUMsQ0FBQztJQUNKLENBQUMsQ0FBQztBQUNKLENBQUM7QUFFRCxNQUFNLENBQUMsTUFBTSxRQUFRLEdBQUcsZUFBZSxDQUFDLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLEVBQUU7SUFDekUsTUFBTSxHQUFHLEdBQUcsR0FBRyxDQUFDLEdBQUcsQ0FBQztJQUNwQixNQUFNLE9BQU8sR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLEdBQUcsQ0FBQyxNQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsbUJBQW1CLENBQUM7SUFDdEYsR0FBRyxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsT0FBTyxFQUFFO1FBQ3RCLElBQUksRUFBRSxlQUFlO1FBQ3JCLFNBQVMsRUFBRSxJQUFJO1FBQ2YsYUFBYSxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDO1FBQ3JDLE1BQU0sRUFBRSxHQUFHLENBQUMsR0FBRyxDQUFDLE1BQU07S0FDdkIsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDLENBQUMifQ==

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import './types.ts';
+export { Ajv2019 as Ajv } from 'ajv/dist/2019.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+import "./types.js";
+export { Ajv2019 as Ajv } from 'ajv/dist/2019.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUM7QUFFcEIsT0FBTyxFQUFFLE9BQU8sSUFBSSxHQUFHLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQyJ9

package/dist/typebox.d.ts

@@ -0,0 +1 @@
+export * from '@sinclair/typebox';

package/dist/typebox.js

@@ -0,0 +1,2 @@
+export * from '@sinclair/typebox';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWJveC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy90eXBlYm94LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsbUJBQW1CLENBQUMifQ==

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+import './config/config.default.ts';
+import './app.ts';
+import './app/extend/context.ts';

package/dist/types.js

@@ -0,0 +1,4 @@
+import "./config/config.default.js";
+import "./app.js";
+import "./app/extend/context.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyw0QkFBNEIsQ0FBQztBQUNwQyxPQUFPLFVBQVUsQ0FBQztBQUNsQixPQUFPLHlCQUF5QixDQUFDIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/typebox-validate",
-  "version": "4.0.0-beta.22",
+  "version": "4.0.0-beta.23",
   "description": "another validate for typescript egg projects",
   "type": "module",
   "eggPlugin": {
@@ -31,6 +31,11 @@
     "eggPlugin",
     "egg-plugin"
   ],
+  "license": "MIT",
+  "homepage": "https://github.com/eggjs/egg/tree/next/plugins/typebox-validate",
+  "bugs": {
+    "url": "https://github.com/eggjs/egg/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/eggjs/egg.git",
@@ -47,7 +52,7 @@
     "ajv-keywords": "^5.1.0"
   },
   "peerDependencies": {
-    "egg": "4.1.0-beta.22"
+    "egg": "4.1.0-beta.23"
   },
   "devDependencies": {
     "@types/node": "^24.6.2",
@@ -57,15 +62,15 @@
     "tsdown": "^0.15.4",
     "typescript": "^5.9.3",
     "vitest": "4.0.0-beta.16",
-    "@eggjs/mock": "7.0.0-beta.22",
-    "egg": "4.1.0-beta.22",
-    "@eggjs/tsconfig": "3.1.0-beta.22"
+    "@eggjs/tsconfig": "3.1.0-beta.23",
+    "@eggjs/mock": "7.0.0-beta.23",
+    "egg": "4.1.0-beta.23"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "tsdown && rimraf dist && tsc -b --clean && tsc -p tsconfig.build.json",
+    "build": "tsdown && rimraf dist *.tsbuildinfo && tsc -p tsconfig.build.json",
     "clean": "rimraf dist",
     "typecheck": "tsc --noEmit",
     "lint": "oxlint --type-aware",