@eggjs/tegg-ajv-plugin 4.0.0-beta.3 → 4.0.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +12 -0
  2. package/dist/_virtual/_@oxc-project_runtime@0.93.0/helpers/decorate.js +10 -0
  3. package/dist/_virtual/_@oxc-project_runtime@0.93.0/helpers/decorateMetadata.js +7 -0
  4. package/dist/index.d.ts +2 -0
  5. package/dist/index.js +3 -0
  6. package/dist/lib/Ajv.d.ts +17 -0
  7. package/dist/lib/Ajv.js +59 -0
  8. package/package.json +26 -29
  9. package/lib/Ajv.d.ts +0 -13
  10. package/lib/Ajv.js +0 -72
  11. package/typings/index.d.ts +0 -4
package/README.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @eggjs/tegg-ajv-plugin
2
2
 
3
+ [![NPM version][npm-image]][npm-url]
4
+ [![Known Vulnerabilities][snyk-image]][snyk-url]
5
+ [![npm download][download-image]][download-url]
6
+ [![Node.js Version](https://img.shields.io/node/v/@eggjs/tegg-ajv-plugin.svg?style=flat)](https://nodejs.org/en/download/)
7
+
8
+ [npm-image]: https://img.shields.io/npm/v/@eggjs/tegg-ajv-plugin.svg?style=flat-square
9
+ [npm-url]: https://npmjs.org/package/@eggjs/tegg-ajv-plugin
10
+ [snyk-image]: https://snyk.io/test/npm/@eggjs/tegg-ajv-plugin/badge.svg?style=flat-square
11
+ [snyk-url]: https://snyk.io/test/npm/@eggjs/tegg-ajv-plugin
12
+ [download-image]: https://img.shields.io/npm/dm/@eggjs/tegg-ajv-plugin.svg?style=flat-square
13
+ [download-url]: https://npmjs.org/package/@eggjs/tegg-ajv-plugin
14
+
3
15
  参考 [egg-typebox-validate](https://github.com/xiekw2010/egg-typebox-validate) 的最佳实践，结合 ajv + typebox，只需要定义一次参数类型和规则，就能同时拥有参数校验和类型定义（完整的 ts 类型提示）。
4
16
 
5
17
  ## egg 模式
package/dist/_virtual/_@oxc-project_runtime@0.93.0/helpers/decorate.js ADDED
@@ -0,0 +1,10 @@
1
+ //#region \0@oxc-project+runtime@0.93.0/helpers/decorate.js
2
+ function __decorate(decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ }
8
+
9
+ //#endregion
10
+ export { __decorate };
package/dist/_virtual/_@oxc-project_runtime@0.93.0/helpers/decorateMetadata.js ADDED
@@ -0,0 +1,7 @@
1
+ //#region \0@oxc-project+runtime@0.93.0/helpers/decorateMetadata.js
2
+ function __decorateMetadata(k, v) {
3
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
4
+ }
5
+
6
+ //#endregion
7
+ export { __decorateMetadata };
package/dist/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { Ajv } from "./lib/Ajv.js";
2
+ export { Ajv };
package/dist/index.js ADDED
@@ -0,0 +1,3 @@
1
+ import { Ajv } from "./lib/Ajv.js";
2
+
3
+ export { Ajv };
package/dist/lib/Ajv.d.ts ADDED
@@ -0,0 +1,17 @@
1
+ import { Schema } from "ajv/dist/2019.js";
2
+ import { Ajv as Ajv$1, AjvInvalidParamError } from "@eggjs/tegg/ajv";
3
+
4
+ //#region src/lib/Ajv.d.ts
5
+ declare class Ajv implements Ajv$1 {
6
+ #private;
7
+ static InvalidParamErrorClass: typeof AjvInvalidParamError;
8
+ protected _init(): void;
9
+ /**
10
+ * Validate data with typebox Schema.
11
+ *
12
+ * If validate fail, with throw `Ajv.InvalidParamErrorClass`
13
+ */
14
+ validate(schema: Schema, data: unknown): void;
15
+ }
16
+ //#endregion
17
+ export { Ajv };
package/dist/lib/Ajv.js ADDED
@@ -0,0 +1,59 @@
1
+ import { __decorateMetadata } from "../_virtual/_@oxc-project_runtime@0.93.0/helpers/decorateMetadata.js";
2
+ import { __decorate } from "../_virtual/_@oxc-project_runtime@0.93.0/helpers/decorate.js";
3
+ import { Ajv2019 } from "ajv/dist/2019.js";
4
+ import addFormats from "@eggjs/ajv-formats";
5
+ import keyWords from "@eggjs/ajv-keywords";
6
+ import { AjvInvalidParamError } from "@eggjs/tegg/ajv";
7
+ import { AccessLevel, LifecycleInit, SingletonProto } from "@eggjs/tegg";
8
+
9
+ //#region src/lib/Ajv.ts
10
+ var _Ajv;
11
+ let Ajv = class Ajv$2 {
12
+ static {
13
+ _Ajv = this;
14
+ }
15
+ static InvalidParamErrorClass = AjvInvalidParamError;
16
+ #ajvInstance;
17
+ _init() {
18
+ this.#ajvInstance = new Ajv2019();
19
+ keyWords(this.#ajvInstance, "transform");
20
+ addFormats(this.#ajvInstance, [
21
+ "date-time",
22
+ "time",
23
+ "date",
24
+ "email",
25
+ "hostname",
26
+ "ipv4",
27
+ "ipv6",
28
+ "uri",
29
+ "uri-reference",
30
+ "uuid",
31
+ "uri-template",
32
+ "json-pointer",
33
+ "relative-json-pointer",
34
+ "regex"
35
+ ]).addKeyword("kind").addKeyword("modifier");
36
+ }
37
+ /**
38
+ * Validate data with typebox Schema.
39
+ *
40
+ * If validate fail, with throw `Ajv.InvalidParamErrorClass`
41
+ */
42
+ validate(schema, data) {
43
+ if (!this.#ajvInstance.validate(schema, data)) throw new _Ajv.InvalidParamErrorClass("Validation Failed", {
44
+ errorData: data,
45
+ currentSchema: JSON.stringify(schema),
46
+ errors: this.#ajvInstance.errors
47
+ });
48
+ }
49
+ };
50
+ __decorate([
51
+ LifecycleInit(),
52
+ __decorateMetadata("design:type", Function),
53
+ __decorateMetadata("design:paramtypes", []),
54
+ __decorateMetadata("design:returntype", void 0)
55
+ ], Ajv.prototype, "_init", null);
56
+ Ajv = _Ajv = __decorate([SingletonProto({ accessLevel: AccessLevel.PUBLIC })], Ajv);
57
+
58
+ //#endregion
59
+ export { Ajv };
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "eggModule": {
11
11
  "name": "teggAjv"
12
12
  },
13
- "version": "4.0.0-beta.3",
13
+ "version": "4.0.0-beta.5",
14
14
  "description": "ajv plugin for egg and tegg",
15
15
  "keywords": [
16
16
  "egg",
@@ -22,24 +22,14 @@
22
22
  ],
23
23
  "type": "module",
24
24
  "exports": {
25
- ".": {
26
- "types": "./src/index.d.ts",
27
- "default": "./src/index.js"
28
- },
25
+ ".": "./dist/index.js",
26
+ "./lib/Ajv": "./dist/lib/Ajv.js",
29
27
  "./package.json": "./package.json"
30
28
  },
31
29
  "files": [
32
- "lib/**/*.js",
33
- "lib/**/*.d.ts",
34
- "typings/**/*.d.ts"
30
+ "dist"
35
31
  ],
36
- "scripts": {
37
- "clean": "tsc -b --clean",
38
- "tsc": "npm run clean && tsc -p ./tsconfig.json",
39
- "tsc:pub": "npm run tsc",
40
- "prepublishOnly": "npm run tsc"
41
- },
42
- "homepage": "https://github.com/eggjs/tegg",
32
+ "homepage": "https://github.com/eggjs/tegg/tree/next/plugin/ajv",
43
33
  "bugs": {
44
34
  "url": "https://github.com/eggjs/tegg/issues"
45
35
  },
@@ -49,27 +39,34 @@
49
39
  "directory": "plugin/ajv"
50
40
  },
51
41
  "engines": {
52
- "node": ">=20.0.0"
42
+ "node": ">=22.18.0"
53
43
  },
54
44
  "dependencies": {
55
45
  "@eggjs/ajv-formats": "^3.0.1",
56
46
  "@eggjs/ajv-keywords": "^5.1.0",
57
- "@eggjs/tegg": "^4.0.0-beta.3",
58
- "@sinclair/typebox": "^0.32.20",
59
- "ajv": "^8.17.1"
47
+ "ajv": "^8.17.1",
48
+ "@eggjs/tegg": "4.0.0-beta.5"
60
49
  },
61
50
  "devDependencies": {
62
- "@eggjs/mock": "6",
63
- "@eggjs/tegg-config": "^4.0.0-beta.3",
64
- "@eggjs/tegg-controller-plugin": "^4.0.0-beta.3",
65
- "@eggjs/tegg-plugin": "^4.0.0-beta.3",
66
- "@types/node": "22",
67
- "egg": "4",
68
- "ts-node": "10",
69
- "typescript": "5"
51
+ "@eggjs/mock": "beta",
52
+ "@types/node": "^22.10.5",
53
+ "egg": "beta",
54
+ "typescript": "^5.9.3",
55
+ "tsdown": "^0.15.6",
56
+ "unplugin-unused": "^0.5.3",
57
+ "@eggjs/tegg-config": "4.0.0-beta.5",
58
+ "@eggjs/tegg-controller-plugin": "4.0.0-beta.5",
59
+ "@eggjs/tegg-plugin": "4.0.0-beta.5"
70
60
  },
71
61
  "publishConfig": {
72
62
  "access": "public"
73
63
  },
74
- "gitHead": "6b84b0275fd728a4973746a5341236fe0481a33e"
75
- }
64
+ "main": "./dist/index.js",
65
+ "module": "./dist/index.js",
66
+ "types": "./dist/index.d.ts",
67
+ "scripts": {
68
+ "clean": "rimraf dist",
69
+ "build": "tsdown",
70
+ "typecheck": "tsc --noEmit"
71
+ }
72
+ }
package/lib/Ajv.d.ts DELETED
@@ -1,13 +0,0 @@
1
- import { type Schema } from 'ajv/dist/2019.js';
2
- import { type Ajv as IAjv, AjvInvalidParamError } from '@eggjs/tegg/ajv';
3
- export declare class Ajv implements IAjv {
4
- #private;
5
- static InvalidParamErrorClass: typeof AjvInvalidParamError;
6
- protected _init(): void;
7
- /**
8
- * Validate data with typebox Schema.
9
- *
10
- * If validate fail, with throw `Ajv.InvalidParamErrorClass`
11
- */
12
- validate(schema: Schema, data: unknown): void;
13
- }
package/lib/Ajv.js DELETED
@@ -1,72 +0,0 @@
1
- var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
2
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
3
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
4
- else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
5
- return c > 3 && r && Object.defineProperty(target, key, r), r;
6
- };
7
- var __metadata = (this && this.__metadata) || function (k, v) {
8
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
9
- };
10
- var Ajv_1;
11
- import { Ajv2019 } from 'ajv/dist/2019.js';
12
- import addFormats from '@eggjs/ajv-formats';
13
- import keyWords from '@eggjs/ajv-keywords';
14
- import { AjvInvalidParamError } from '@eggjs/tegg/ajv';
15
- import { SingletonProto, AccessLevel, LifecycleInit } from '@eggjs/tegg';
16
- let Ajv = class Ajv {
17
- static { Ajv_1 = this; }
18
- static InvalidParamErrorClass = AjvInvalidParamError;
19
- #ajvInstance;
20
- _init() {
21
- this.#ajvInstance = new Ajv2019();
22
- // @ts-expect-error ajv-keywords is not typed
23
- keyWords(this.#ajvInstance, 'transform');
24
- // @ts-expect-error ajv-formats is not typed
25
- addFormats(this.#ajvInstance, [
26
- 'date-time',
27
- 'time',
28
- 'date',
29
- 'email',
30
- 'hostname',
31
- 'ipv4',
32
- 'ipv6',
33
- 'uri',
34
- 'uri-reference',
35
- 'uuid',
36
- 'uri-template',
37
- 'json-pointer',
38
- 'relative-json-pointer',
39
- 'regex',
40
- ])
41
- .addKeyword('kind')
42
- .addKeyword('modifier');
43
- }
44
- /**
45
- * Validate data with typebox Schema.
46
- *
47
- * If validate fail, with throw `Ajv.InvalidParamErrorClass`
48
- */
49
- validate(schema, data) {
50
- const result = this.#ajvInstance.validate(schema, data);
51
- if (!result) {
52
- throw new Ajv_1.InvalidParamErrorClass('Validation Failed', {
53
- errorData: data,
54
- currentSchema: JSON.stringify(schema),
55
- errors: this.#ajvInstance.errors,
56
- });
57
- }
58
- }
59
- };
60
- __decorate([
61
- LifecycleInit(),
62
- __metadata("design:type", Function),
63
- __metadata("design:paramtypes", []),
64
- __metadata("design:returntype", void 0)
65
- ], Ajv.prototype, "_init", null);
66
- Ajv = Ajv_1 = __decorate([
67
- SingletonProto({
68
- accessLevel: AccessLevel.PUBLIC,
69
- })
70
- ], Ajv);
71
- export { Ajv };
72
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQWp2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiQWp2LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSxPQUFPLEVBQWUsT0FBTyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDeEQsT0FBTyxVQUFVLE1BQU0sb0JBQW9CLENBQUM7QUFDNUMsT0FBTyxRQUFRLE1BQU0scUJBQXFCLENBQUM7QUFDM0MsT0FBTyxFQUFvQixvQkFBb0IsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBQ3pFLE9BQU8sRUFBRSxjQUFjLEVBQUUsV0FBVyxFQUFFLGFBQWEsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUtsRSxJQUFNLEdBQUcsR0FBVCxNQUFNLEdBQUc7O0lBQ2QsTUFBTSxDQUFDLHNCQUFzQixHQUFHLG9CQUFvQixDQUFDO0lBRXJELFlBQVksQ0FBVTtJQUdaLEtBQUs7UUFDYixJQUFJLENBQUMsWUFBWSxHQUFHLElBQUksT0FBTyxFQUFFLENBQUM7UUFDbEMsNkNBQTZDO1FBQzdDLFFBQVEsQ0FBQyxJQUFJLENBQUMsWUFBWSxFQUFFLFdBQVcsQ0FBQyxDQUFDO1FBQ3pDLDRDQUE0QztRQUM1QyxVQUFVLENBQUMsSUFBSSxDQUFDLFlBQVksRUFBRTtZQUM1QixXQUFXO1lBQ1gsTUFBTTtZQUNOLE1BQU07WUFDTixPQUFPO1lBQ1AsVUFBVTtZQUNWLE1BQU07WUFDTixNQUFNO1lBQ04sS0FBSztZQUNMLGVBQWU7WUFDZixNQUFNO1lBQ04sY0FBYztZQUNkLGNBQWM7WUFDZCx1QkFBdUI7WUFDdkIsT0FBTztTQUNSLENBQUM7YUFDQyxVQUFVLENBQUMsTUFBTSxDQUFDO2FBQ2xCLFVBQVUsQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM1QixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILFFBQVEsQ0FBQyxNQUFjLEVBQUUsSUFBYTtRQUNwQyxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDeEQsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ1osTUFBTSxJQUFJLEtBQUcsQ0FBQyxzQkFBc0IsQ0FBQyxtQkFBbUIsRUFBRTtnQkFDeEQsU0FBUyxFQUFFLElBQUk7Z0JBQ2YsYUFBYSxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDO2dCQUNyQyxNQUFNLEVBQUUsSUFBSSxDQUFDLFlBQVksQ0FBQyxNQUFPO2FBQ2xDLENBQUMsQ0FBQztRQUNMLENBQUM7SUFDSCxDQUFDOztBQXZDUztJQURULGFBQWEsRUFBRTs7OztnQ0F3QmY7QUE3QlUsR0FBRztJQUhmLGNBQWMsQ0FBQztRQUNkLFdBQVcsRUFBRSxXQUFXLENBQUMsTUFBTTtLQUNoQyxDQUFDO0dBQ1csR0FBRyxDQThDZiJ9
package/typings/index.d.ts DELETED
@@ -1,4 +0,0 @@
1
- import 'egg';
2
- import '@eggjs/tegg-plugin';
3
- import '@eggjs/tegg-config';
4
- import '@eggjs/tegg-controller-plugin';