@eggjs/typebox-validate 0.0.0-beta.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021 David Tse
+Copyright (c) 2025-present eggjs-community and the contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,465 @@
+# @eggjs/typebox-validate
+
+[![NPM version][npm-image]][npm-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/typebox-validate.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/typebox-validate
+[codecov-image]: https://img.shields.io/codecov/c/github/eggjs-community/@eggjs/typebox-validate.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/eggjs-community/@eggjs/typebox-validate?branch=master
+[snyk-image]: https://snyk.io/test/npm/@eggjs/typebox-validate/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/@eggjs/typebox-validate
+[download-image]: https://img.shields.io/npm/dm/@eggjs/typebox-validate.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/typebox-validate
+
+基于 [typebox](https://github.com/sinclairzx81/typebox) 和 [ajv](https://github.com/ajv-validator/ajv) 封装的 egg validate 插件。
+
+## 为什么有这个项目
+
+一直以来，在 typescript 的 egg 项目里，对参数校验 ctx.validate 是比较难受的，比如:
+
+```js
+class HomeController extends Controller {
+  async index() {
+    const { ctx } = this;
+    // 写一遍 js 的类型校验
+    ctx.validate({
+      id: 'string',
+      name: {
+        type: 'string',
+        required: false,
+      },
+      timestamp: {
+        type: 'number',
+        required: false,
+      },
+    }, ctx.params);
+
+    // 写一遍 ts 的类型定义，为了后面拿参数定义
+    const params: {
+      id: string;
+      name?: string;
+      timestamp: number;
+    } = ctx.params;
+    ...
+    ctx.body = params.id;
+  }
+}
+
+export default HomeController;
+```
+
+可以看到这里我们写了两遍的类型定义，一遍 js 的定义（用 [parameter](https://github.com/node-modules/parameter) 库的规则），另一遍用 ts 的方式来强转我们的参数类型，方便我们后面写代码的时候能得到 ts 的类型效果。
+对于简单的类型写起来还好，但是对于复杂点的参数定义，开发体验就不是那么好了。
+
+这就是这个库想要解决的问题，对于参数校验，写一遍类型就够了：
+
+```diff
++ import { Static, Type } from 'egg-typebox-validate/typebox';
+
+class HomeController extends Controller {
+  async index() {
+    const { ctx } = this;
+    // 写 js 类型定义
+-   ctx.validate({
+-     id: 'string',
+-     name: {
+-       type: 'string',
+-       required: false,
+-     },
+-     timestamp: {
+-       type: 'number',
+-       required: false,
+-     },
+-   }, ctx.params);
+
++   const paramsSchema = Type.Object({
++     id: Type.String(),
++     name: Type.Optional(Type.String()),
++     timestamp: Type.Optional(Type.Integer()),
++   });
+    // 直接校验
++   ctx.tValidate(paramsSchema, ctx.params);
+    // 不用写 js 类型定义
++   const params: Static<typeof paramsSchema> = ctx.params;
+-   const params: {
+-     id: string;
+-     name?: string;
+-     timestamp: number;
+-   } = ctx.params;
+    ...
+    ctx.body = params.id;
+  }
+}
+
+export default HomeController;
+```
+
+用 `Static<typeof typebox>` 推导出的 ts 类型：
+
+![tpian](https://gw.alipayobjects.com/zos/antfincdn/XjH2W7lEB/ad5b628c-9ff9-456d-bb7b-2fb0ac418f1c.png)
+
+## 怎么使用
+
+1. 安装
+
+针对 `egg@4.x` 及以上版本，使用
+
+```js
+npm i egg-typebox-validate -S
+```
+
+针对 `egg@3.x` 版本，使用
+
+```js
+npm i egg-typebox-validate@3 -S
+```
+
+1. 在项目中配置
+
+```js
+// config/plugin.ts
+const plugin: EggPlugin = {
+  typeboxValidate: {
+    enable: true,
+    package: 'egg-typebox-validate',
+  },
+};
+```
+
+3. 在业务代码中使用
+
+```diff
++ import { Static, Type } from 'egg-typebox-validate/typebox';
+
+// 写在 controller 外面，静态化，性能更好，下面有 benchmark
++ const paramsSchema = Type.Object({
++   id: Type.String(),
++   name: Type.String(),
++   timestamp: Type.Integer(),
++ });
+
+// 可以直接 export 出去，给下游 service 使用
++ export type ParamsType = Static<typeof paramsSchema>;
+
+class HomeController extends Controller {
+  async index() {
+    const { ctx } = this;
+
+    // 直接校验
++   ctx.tValidate(paramsSchema, ctx.params);
+    // 不用写 js 类型定义
++   const params: ParamsType = ctx.params;
+
+    ...
+  }
+}
+
+export default HomeController;
+```
+
+## 除了类型定义 write once 外，还有更多好处
+
+1. 类型组合方式特别香，能解决很多 DRY(Don't Repeat Yourself) 问题。比如有几张 db 表，都定义了 name 必填和 description 选填，那这个规则可以在各个实体类方法中被组合了。
+
+Show me the code!
+
+```ts
+export const TYPEBOX_NAME_DESC_OBJECT = Type.Object({
+  name: Type.String(),
+  description: Type.Optional(Type.String()),
+});
+
+// type NameAndDesc = { name: string; description?: string }
+type NameAndDesc = Static<typeof TYPEBOX_NAME_DESC_OBJECT>;
+
+// controller User
+async create() {
+  const { ctx } = this;
+  const USER_TYPEBOX = Type.Intersect([
+    TYPEBOX_NAME_DESC_OBJECT,
+    Type.Object({ avatar: Type.String() }),
+  ])
+  ctx.tValidate(USER_TYPEBOX, ctx.request.body);
+
+  // 在编辑器都能正确得到提示
+  // type User = { name: string; description?: string } & { avatar: string }
+  const { name, description, avatar } = ctx.request.body as Static<typeof USER_TYPEBOX>;
+  ...
+}
+
+// controller Photo
+async create() {
+  const { ctx } = this;
+  const PHOTO_TYPEBOX = Type.Intersect([
+    TYPEBOX_NAME_DESC_OBJECT,
+    Type.Object({ location: Type.String() }),
+  ])
+  ctx.tValidate(PHOTO_TYPEBOX, ctx.request.body);
+
+  // 在编辑器都能正确得到提示
+  // type Photo = { name: string; description?: string } & { location: string }
+  const { name, description, location } = ctx.request.body as Static<typeof PHOTO_TYPEBOX>;
+  ...
+}
+```
+
+2. 校验规则使用的是业界标准的 [json-schema](https://json-schema.org/) 规范，内置很多[开箱即用的类型](https://github.com/ajv-validator/ajv-formats#formats)。
+
+```js
+('date-time',
+  'time',
+  'date',
+  'email',
+  'hostname',
+  'ipv4',
+  'ipv6',
+  'uri',
+  'uri-reference',
+  'uuid',
+  'uri-template',
+  'json-pointer',
+  'relative-json-pointer',
+  'regex');
+```
+
+3. 写定义的时候写的是 js 对象(`Type.Number()`)，有类型提示，语法也比较简单，有提示不容易写错；写 parameter 规范的时候，写字符串(`'nunber'`)有时候会不小心写错 😂，再加上它对于复杂嵌套对象的写法还是比较困难的，我每次都会查文档，官方的文档也不全。但是 typebox，就很容易举一反三了。
+
+## 与 egg-validate 性能比较
+
+egg-typebox-validate 底层使用的是 [ajv](https://github.com/ajv-validator/ajv), 官网上宣称是 _**The fastest JSON validator for Node.js and browser.**_
+
+结论是在静态化的场景下，ajv 的性能要比 parameter 好得多，快不是一个数量级，详见[benchmark](./benchmark/ajv-vs-parameter.mjs)
+
+```js
+suite
+  .add('#ajv', function () {
+    const rule = Type.Object({
+      name: Type.String(),
+      description: Type.Optional(Type.String()),
+      location: Type.Enum({ shanghai: 'shanghai', hangzhou: 'hangzhou' }),
+    });
+    ajv.validate(rule, DATA);
+  })
+  .add('#ajv define once', function () {
+    ajv.validate(typeboxRule, DATA);
+  })
+  .add('#parameter', function () {
+    const rule = {
+      name: 'string',
+      description: {
+        type: 'string',
+        required: false,
+      },
+      location: ['shanghai', 'hangzhou'],
+    };
+    p.validate(rule, DATA);
+  })
+  .add('#parameter define once', function () {
+    p.validate(parameterRule, DATA);
+  });
+```
+
+在 MacBook Pro(2.2 GHz 六核Intel Core i7)上，跑出来结果是:
+
+```bash
+#ajv x 941 ops/sec ±3.97% (73 runs sampled)
+#ajv define once x 17,188,370 ops/sec ±11.53% (73 runs sampled)
+#parameter x 2,544,118 ops/sec ±4.68% (79 runs sampled)
+#parameter define once x 2,541,590 ops/sec ±5.34% (77 runs sampled)
+Fastest is #ajv define once
+```
+
+## 从 egg-validate 迁移到这个库的成本
+
+1. 把原来字符串式 js 对象写法迁移到 typebox 的对象写法。typebox 的写法还算简单和容易举一反三
+2. 把 `ctx.validate` 替换成 `ctx.tValidate`
+3. 建议渐进式迁移，先迁简单的，对业务影响不大的
+
+## 总结
+
+切换到 egg-typebox-validate 校验后：
+
+1. 可以解决 ts 项目中参数校验代码写两遍类型的问题，提升代码重用率，可维护性等问题
+2. 用标准 json-schema 来做参数校验，是更加标准的业界做法，内置更多业界标准模型
+
+## API
+
+1. `ctx.tValidate` 参数校验失败后，抛出错误，内部实现（错误码、错误标题等）逻辑和 `ctx.validate` 的保持一致
+
+```diff
++ import { Static, Type } from 'egg-typebox-validate/typebox';
+
+ctx.tValidate(Type.Object({
+  name: Type.String(),
+}), ctx.request.body);
+```
+
+2. `ctx.tValidateWithoutThrow` 直接校验，不抛出错误
+
+```diff
++ import { Static, Type } from 'egg-typebox-validate/typebox';
+
+const valid = ctx.tValidateWithoutThrow(Type.Object({
+  name: Type.String(),
+}), ctx.request.body);
+
+if (valid) {
+  ...
+} else {
+  const errors = this.app.ajv.errors
+  // handle errors
+  ...
+}
+```
+
+3. ⭐⭐⭐ 装饰器 decorator `@Validate([ [rule1, ctx => ctx.xx1], [rule2, ctx => ctx.xx2] ])` 调用（写法更干净，推荐使用!️）
+
+```diff
++ import { Validate, ValidateFactory } from 'egg-typebox-validate/decorator';
+
+const ValidateWithRedirect = ValidateFactory(ctx => ctx.redirect('/422'));
+
+class HomeController extends Controller {
++ @Validate([
++   [paramsSchema, ctx => ctx.params],
++   [bodySchema, ctx => ctx.request.body, (ctx, errors) => 'MyErrorPrefix: ' + errors.map(e => e.message).join(', ')],
++ ])
+  async index() {
+    const { ctx } = this;
+
+    // 直接校验
+-   ctx.tValidate(paramsSchema, ctx.params);
+-   ctx.tValidate(bodySchema, ctx.request.body);
+    // 不用写 js 类型定义
+    const params: ParamsType = ctx.params;
+
+    ...
+  }
++ @ValidateWithRedirect([paramsSchema, ctx => ctx.params])
+  async post() {
+    // ...
+  }
+}
+
+export default HomeController;
+```
+
+目前装饰器只支持有 `this.ctx` 的 class 上使用，比如 controller，service 等。也可以通过内置的 `ValidateFactory` 自定义校验失败后的回调逻辑，更多使用案例可以看这个项目里写的测试用例。
+
+## 怎么写 typebox 定义
+
+参考 [https://github.com/sinclairzx81/typebox#types](https://github.com/sinclairzx81/typebox#types)
+
+## 支持 ajv 对 string 的 transform 校验
+
+比如:
+
+```js
+const body = { name: '  david   ' };
+
+ctx.tValidate(
+  Type.Object({
+    name: Type.String({ minLength: 1, maxLength: 5, transform: ['trim'] }),
+  }),
+  body
+);
+```
+
+1. 是可以通过校验的
+2. 会对 body 有副作用，改写 name 字段，trim name 字段，body 会变成 `{ name: 'david' }`
+
+更多 ajv 对 string 的 transform 操作，详见 [https://ajv.js.org/packages/ajv-keywords.html#transform](https://ajv.js.org/packages/ajv-keywords.html#transform)
+
+## 如何写自定义校验规则
+
+比如想校验上传的 string 是否是合法的 json string，我们可以对 Type.String 的 format 做 patch，针对 string 加一个 'json-string' 的 format
+
+1. 在 config.default.ts 里 patch 默认 ajv 实例的规则
+
+```ts
+config.typeboxValidate = {
+  patchAjv: ajv => {
+    ajv.addFormat('json-string', {
+      type: 'string',
+      validate: x => {
+        try {
+          JSON.parse(x);
+          return true;
+        } catch (err) {
+          return false;
+        }
+      },
+    });
+  },
+};
+```
+
+2. 使用
+
+```ts
+async someFunc() {
+  const typebox = Type.Object({
+    jsonString: Type.Optional(Type.String({ format: 'json-string' })),
+  });
+
+  const res = ctx.tValidate(typebox, { a: '{"a":1}' }) // valid
+  const res = ctx.tValidate(typebox, { a: 'wrong{"a":1}' }) // invalid
+}
+```
+
+当然也可以定义其他各种规则，比如我们常见的 semver 规范，那可以在我们的配置里继续 patch ajv string format
+
+```diff
++ import { valid } from 'semver';
+
+config.typeboxValidate = {
+  patchAjv: (ajv) => {
+    ajv.addFormat('json-string', {
+      type: 'string',
+      validate: (x) => {
+        try {
+          JSON.parse(x);
+          return true;
+        } catch (err) {
+          return false;
+        }
+      }
+    });
+
++   ajv.addFormat("semver", {
++     type: "string",
++     validate: (x) => valid(x) != null,
++   })
+  }
+}
+```
+
+使用例子：
+
+```ts
+async someFunc() {
+  const typebox = Type.Object({
+    version: Type.String({ format: 'semver' }),
+  });
+
+  const res = ctx.tValidate(typebox, { a: '1.0.0' }) // valid
+  const res = ctx.tValidate(typebox, { a: 'a.b.c' }) // invalid
+}
+```
+
+上面例子是 string 的例子，当然也可以对其他类型做其他 patch，比如 number，array 等，限制你的只有想象力。
+
+全部 json-schema 支持的类型：[https://json-schema.org/understanding-json-schema/reference/type.html](https://json-schema.org/understanding-json-schema/reference/type.html)
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

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,21 @@
+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,
+                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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLEtBQUssQ0FBQztBQUc5QixNQUFNLENBQUMsT0FBTyxPQUFPLFVBQVcsU0FBUSxPQUFPO0lBQzdDLFNBQVMsQ0FBQyxNQUFjLEVBQUUsSUFBYTtRQUNyQyxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQztRQUN6QixNQUFNLEdBQUcsR0FBRyxHQUFHLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUN2QyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7WUFDVCxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxtQkFBbUIsRUFBRTtnQkFDbkMsSUFBSSxFQUFFLGVBQWU7Z0JBQ3JCLFNBQVMsRUFBRSxJQUFJO2dCQUNmLGFBQWEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQztnQkFDckMsTUFBTSxFQUFFLEdBQUcsQ0FBQyxNQUFNO2FBQ25CLENBQUMsQ0FBQztRQUNMLENBQUM7UUFDRCxPQUFPLEdBQUcsQ0FBQztJQUNiLENBQUM7SUFFRCxxQkFBcUIsQ0FBQyxNQUFjLEVBQUUsSUFBYTtRQUNqRCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ2hELE9BQU8sR0FBRyxDQUFDO0lBQ2IsQ0FBQztDQUNGIn0=

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

@@ -0,0 +1,79 @@
+{
+  "name": "@eggjs/typebox-validate",
+  "version": "0.0.0-beta.1",
+  "description": "another validate for typescript egg projects",
+  "type": "module",
+  "eggPlugin": {
+    "name": "typeboxValidate"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./app": "./dist/app.js",
+    "./app/extend/context": "./dist/app/extend/context.js",
+    "./config/config.default": "./dist/config/config.default.js",
+    "./decorator": "./dist/decorator.js",
+    "./typebox": "./dist/typebox.js",
+    "./types": "./dist/types.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "egg",
+    "eggjs",
+    "validate",
+    "ajv",
+    "typebox",
+    "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",
+    "directory": "plugins/typebox-validate"
+  },
+  "author": "xiekw2010",
+  "engines": {
+    "node": ">= 22.18.0"
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.23.0",
+    "ajv": "^8.8.2",
+    "ajv-formats": "^2.1.1",
+    "ajv-keywords": "^5.1.0"
+  },
+  "peerDependencies": {
+    "egg": "4.1.0-beta.22"
+  },
+  "devDependencies": {
+    "@types/node": "^24.6.2",
+    "oxlint": "^1.19.0",
+    "rimraf": "^6.0.1",
+    "semver": "^7.7.2",
+    "tsdown": "^0.15.4",
+    "typescript": "^5.9.3",
+    "vitest": "4.0.0-beta.16",
+    "@eggjs/tsconfig": "3.1.0-beta.22",
+    "@eggjs/mock": "7.0.0-beta.22",
+    "egg": "4.1.0-beta.22"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsdown && rimraf dist *.tsbuildinfo && tsc -p tsconfig.build.json",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint --type-aware",
+    "test": "vitest run"
+  }
+}