@eggjs/tegg-ajv-plugin 3.62.0 → 4.0.0-beta.10

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.
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 模式
@@ -0,0 +1 @@
1
+ export * from './lib/Ajv.ts';
package/dist/index.js ADDED
@@ -0,0 +1,2 @@
1
+ export * from "./lib/Ajv.js";
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxjQUFjLENBQUMifQ==
@@ -1,4 +1,4 @@
1
- import { type Schema } from 'ajv/dist/2019';
1
+ import { type Schema } from 'ajv/dist/2019.js';
2
2
  import { type Ajv as IAjv, AjvInvalidParamError } from '@eggjs/tegg/ajv';
3
3
  export declare class Ajv implements IAjv {
4
4
  #private;
@@ -0,0 +1,72 @@
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQWp2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2xpYi9BanYudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7OztBQUFBLE9BQU8sRUFBZSxPQUFPLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN4RCxPQUFPLFVBQVUsTUFBTSxvQkFBb0IsQ0FBQztBQUM1QyxPQUFPLFFBQVEsTUFBTSxxQkFBcUIsQ0FBQztBQUMzQyxPQUFPLEVBQW9CLG9CQUFvQixFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFDekUsT0FBTyxFQUFFLGNBQWMsRUFBRSxXQUFXLEVBQUUsYUFBYSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBS2xFLElBQU0sR0FBRyxHQUFULE1BQU0sR0FBRzs7SUFDZCxNQUFNLENBQUMsc0JBQXNCLEdBQUcsb0JBQW9CLENBQUM7SUFFckQsWUFBWSxDQUFVO0lBR1osS0FBSztRQUNiLElBQUksQ0FBQyxZQUFZLEdBQUcsSUFBSSxPQUFPLEVBQUUsQ0FBQztRQUNsQyw2Q0FBNkM7UUFDN0MsUUFBUSxDQUFDLElBQUksQ0FBQyxZQUFZLEVBQUUsV0FBVyxDQUFDLENBQUM7UUFDekMsNENBQTRDO1FBQzVDLFVBQVUsQ0FBQyxJQUFJLENBQUMsWUFBWSxFQUFFO1lBQzVCLFdBQVc7WUFDWCxNQUFNO1lBQ04sTUFBTTtZQUNOLE9BQU87WUFDUCxVQUFVO1lBQ1YsTUFBTTtZQUNOLE1BQU07WUFDTixLQUFLO1lBQ0wsZUFBZTtZQUNmLE1BQU07WUFDTixjQUFjO1lBQ2QsY0FBYztZQUNkLHVCQUF1QjtZQUN2QixPQUFPO1NBQ1IsQ0FBQzthQUNDLFVBQVUsQ0FBQyxNQUFNLENBQUM7YUFDbEIsVUFBVSxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLE1BQWMsRUFBRSxJQUFhO1FBQ3BDLE1BQU0sTUFBTSxHQUFHLElBQUksQ0FBQyxZQUFZLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUN4RCxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDWixNQUFNLElBQUksS0FBRyxDQUFDLHNCQUFzQixDQUFDLG1CQUFtQixFQUFFO2dCQUN4RCxTQUFTLEVBQUUsSUFBSTtnQkFDZixhQUFhLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUM7Z0JBQ3JDLE1BQU0sRUFBRSxJQUFJLENBQUMsWUFBWSxDQUFDLE1BQU87YUFDbEMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7O0FBdkNTO0lBRFQsYUFBYSxFQUFFOzs7O2dDQXdCZjtBQTdCVSxHQUFHO0lBSGYsY0FBYyxDQUFDO1FBQ2QsV0FBVyxFQUFFLFdBQVcsQ0FBQyxNQUFNO0tBQ2hDLENBQUM7R0FDVyxHQUFHLENBOENmIn0=
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "eggModule": {
11
11
  "name": "teggAjv"
12
12
  },
13
- "version": "3.62.0",
13
+ "version": "4.0.0-beta.10",
14
14
  "description": "ajv plugin for egg and tegg",
15
15
  "keywords": [
16
16
  "egg",
@@ -20,20 +20,16 @@
20
20
  "tegg",
21
21
  "ajv"
22
22
  ],
23
+ "type": "module",
24
+ "exports": {
25
+ ".": "./dist/index.js",
26
+ "./lib/Ajv": "./dist/lib/Ajv.js",
27
+ "./package.json": "./package.json"
28
+ },
23
29
  "files": [
24
- "lib/**/*.js",
25
- "lib/**/*.d.ts",
26
- "typings/*.d.ts"
30
+ "dist"
27
31
  ],
28
- "types": "typings/index.d.ts",
29
- "scripts": {
30
- "test": "cross-env NODE_ENV=test NODE_OPTIONS='--no-deprecation' mocha",
31
- "clean": "tsc -b --clean",
32
- "tsc": "npm run clean && tsc -p ./tsconfig.json",
33
- "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json",
34
- "prepublishOnly": "npm run tsc:pub"
35
- },
36
- "homepage": "https://github.com/eggjs/tegg",
32
+ "homepage": "https://github.com/eggjs/tegg/tree/next/plugin/ajv",
37
33
  "bugs": {
38
34
  "url": "https://github.com/eggjs/tegg/issues"
39
35
  },
@@ -43,30 +39,34 @@
43
39
  "directory": "plugin/ajv"
44
40
  },
45
41
  "engines": {
46
- "node": ">=16.0.0"
42
+ "node": ">=22.18.0"
47
43
  },
48
44
  "dependencies": {
49
45
  "@eggjs/ajv-formats": "^3.0.1",
50
46
  "@eggjs/ajv-keywords": "^5.1.0",
51
- "@eggjs/tegg": "^3.62.0",
52
- "@sinclair/typebox": "^0.32.20",
53
- "ajv": "^8.12.0"
47
+ "ajv": "^8.17.1",
48
+ "@eggjs/tegg": "4.0.0-beta.10"
54
49
  },
55
50
  "devDependencies": {
56
- "@eggjs/tegg-config": "^3.62.0",
57
- "@eggjs/tegg-controller-plugin": "^3.62.0",
58
- "@eggjs/tegg-plugin": "^3.62.0",
59
- "@types/mocha": "^10.0.1",
60
- "@types/node": "^20.2.4",
61
- "cross-env": "^7.0.3",
62
- "egg": "^3.9.1",
63
- "egg-mock": "^5.5.0",
64
- "mocha": "^10.2.0",
65
- "ts-node": "^10.9.1",
66
- "typescript": "^5.0.4"
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.10",
58
+ "@eggjs/tegg-controller-plugin": "4.0.0-beta.10",
59
+ "@eggjs/tegg-plugin": "4.0.0-beta.10"
67
60
  },
68
61
  "publishConfig": {
69
62
  "access": "public"
70
63
  },
71
- "gitHead": "b0c5d2dbae617d227909f338013b1e6310054270"
72
- }
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 && rimraf dist && tsc -b --clean && tsc",
70
+ "typecheck": "tsc --noEmit"
71
+ }
72
+ }
package/lib/Ajv.js DELETED
@@ -1,90 +0,0 @@
1
- "use strict";
2
- var __decorate = (this && this.__decorate) || function (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
- var __metadata = (this && this.__metadata) || function (k, v) {
9
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
- };
11
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
12
- if (kind === "m") throw new TypeError("Private method is not writable");
13
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
14
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
15
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
16
- };
17
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
18
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
19
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
20
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
21
- };
22
- var __importDefault = (this && this.__importDefault) || function (mod) {
23
- return (mod && mod.__esModule) ? mod : { "default": mod };
24
- };
25
- var _Ajv_ajvInstance;
26
- var Ajv_1;
27
- Object.defineProperty(exports, "__esModule", { value: true });
28
- exports.Ajv = void 0;
29
- const _2019_1 = __importDefault(require("ajv/dist/2019"));
30
- const ajv_formats_1 = __importDefault(require("@eggjs/ajv-formats"));
31
- const ajv_keywords_1 = __importDefault(require("@eggjs/ajv-keywords"));
32
- const ajv_1 = require("@eggjs/tegg/ajv");
33
- const tegg_1 = require("@eggjs/tegg");
34
- let Ajv = Ajv_1 = class Ajv {
35
- constructor() {
36
- _Ajv_ajvInstance.set(this, void 0);
37
- }
38
- _init() {
39
- __classPrivateFieldSet(this, _Ajv_ajvInstance, new _2019_1.default(), "f");
40
- (0, ajv_keywords_1.default)(__classPrivateFieldGet(this, _Ajv_ajvInstance, "f"), 'transform');
41
- (0, ajv_formats_1.default)(__classPrivateFieldGet(this, _Ajv_ajvInstance, "f"), [
42
- 'date-time',
43
- 'time',
44
- 'date',
45
- 'email',
46
- 'hostname',
47
- 'ipv4',
48
- 'ipv6',
49
- 'uri',
50
- 'uri-reference',
51
- 'uuid',
52
- 'uri-template',
53
- 'json-pointer',
54
- 'relative-json-pointer',
55
- 'regex',
56
- ])
57
- .addKeyword('kind')
58
- .addKeyword('modifier');
59
- }
60
- /**
61
- * Validate data with typebox Schema.
62
- *
63
- * If validate fail, with throw `Ajv.InvalidParamErrorClass`
64
- */
65
- validate(schema, data) {
66
- const result = __classPrivateFieldGet(this, _Ajv_ajvInstance, "f").validate(schema, data);
67
- if (!result) {
68
- throw new Ajv_1.InvalidParamErrorClass('Validation Failed', {
69
- errorData: data,
70
- currentSchema: JSON.stringify(schema),
71
- errors: __classPrivateFieldGet(this, _Ajv_ajvInstance, "f").errors,
72
- });
73
- }
74
- }
75
- };
76
- exports.Ajv = Ajv;
77
- _Ajv_ajvInstance = new WeakMap();
78
- Ajv.InvalidParamErrorClass = ajv_1.AjvInvalidParamError;
79
- __decorate([
80
- (0, tegg_1.LifecycleInit)(),
81
- __metadata("design:type", Function),
82
- __metadata("design:paramtypes", []),
83
- __metadata("design:returntype", void 0)
84
- ], Ajv.prototype, "_init", null);
85
- exports.Ajv = Ajv = Ajv_1 = __decorate([
86
- (0, tegg_1.SingletonProto)({
87
- accessLevel: tegg_1.AccessLevel.PUBLIC,
88
- })
89
- ], Ajv);
90
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQWp2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiQWp2LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSwwREFBcUQ7QUFDckQscUVBQTRDO0FBQzVDLHVFQUEyQztBQUMzQyx5Q0FBeUU7QUFDekUsc0NBQXlFO0FBS2xFLElBQU0sR0FBRyxXQUFULE1BQU0sR0FBRztJQUFUO1FBR0wsbUNBQXNCO0lBeUN4QixDQUFDO0lBdENXLEtBQUs7UUFDYix1QkFBQSxJQUFJLG9CQUFnQixJQUFJLGVBQU8sRUFBRSxNQUFBLENBQUM7UUFDbEMsSUFBQSxzQkFBUSxFQUFDLHVCQUFBLElBQUksd0JBQWEsRUFBRSxXQUFXLENBQUMsQ0FBQztRQUN6QyxJQUFBLHFCQUFVLEVBQUMsdUJBQUEsSUFBSSx3QkFBYSxFQUFFO1lBQzVCLFdBQVc7WUFDWCxNQUFNO1lBQ04sTUFBTTtZQUNOLE9BQU87WUFDUCxVQUFVO1lBQ1YsTUFBTTtZQUNOLE1BQU07WUFDTixLQUFLO1lBQ0wsZUFBZTtZQUNmLE1BQU07WUFDTixjQUFjO1lBQ2QsY0FBYztZQUNkLHVCQUF1QjtZQUN2QixPQUFPO1NBQ1IsQ0FBQzthQUNDLFVBQVUsQ0FBQyxNQUFNLENBQUM7YUFDbEIsVUFBVSxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLE1BQWMsRUFBRSxJQUFhO1FBQ3BDLE1BQU0sTUFBTSxHQUFHLHVCQUFBLElBQUksd0JBQWEsQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3hELElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUNaLE1BQU0sSUFBSSxLQUFHLENBQUMsc0JBQXNCLENBQUMsbUJBQW1CLEVBQUU7Z0JBQ3hELFNBQVMsRUFBRSxJQUFJO2dCQUNmLGFBQWEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQztnQkFDckMsTUFBTSxFQUFFLHVCQUFBLElBQUksd0JBQWEsQ0FBQyxNQUFPO2FBQ2xDLENBQUMsQ0FBQztRQUNMLENBQUM7SUFDSCxDQUFDOztBQTNDVSxrQkFBRzs7QUFDUCwwQkFBc0IsR0FBRywwQkFBb0IsQUFBdkIsQ0FBd0I7QUFLM0M7SUFEVCxJQUFBLG9CQUFhLEdBQUU7Ozs7Z0NBc0JmO2NBM0JVLEdBQUc7SUFIZixJQUFBLHFCQUFjLEVBQUM7UUFDZCxXQUFXLEVBQUUsa0JBQVcsQ0FBQyxNQUFNO0tBQ2hDLENBQUM7R0FDVyxHQUFHLENBNENmIn0=
@@ -1,4 +0,0 @@
1
- import 'egg';
2
- import '@eggjs/tegg-plugin';
3
- import '@eggjs/tegg-config';
4
- import '@eggjs/tegg-controller-plugin';