@eggjs/tegg-ajv-plugin 3.36.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other 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,144 @@
+# @eggjs/tegg-ajv-plugin
+
+参考 [egg-typebox-validate](https://github.com/xiekw2010/egg-typebox-validate) 的最佳实践，结合 ajv + typebox，只需要定义一次参数类型和规则，就能同时拥有参数校验和类型定义（完整的 ts 类型提示）。
+
+## egg 模式
+
+### Install
+
+```shell
+# tegg 注解
+npm i --save @eggjs/tegg
+# tegg 插件
+npm i --save @eggjs/tegg-plugin
+# tegg ajv 插件
+npm i --save @eggjs/tegg-ajv-plugin
+```
+
+### Prepare
+
+```json
+// tsconfig.json
+{
+  "extends": "@eggjs/tsconfig"
+}
+```
+
+### Config
+
+```js
+// config/plugin.js
+exports.tegg = {
+  package: '@eggjs/tegg-plugin',
+  enable: true,
+};
+
+exports.teggAjv = {
+  package: '@eggjs/tegg-ajv-plugin',
+  enable: true,
+};
+```
+
+## standalone 模式
+
+### Install
+
+```shell
+# tegg 注解
+npm i --save @eggjs/tegg
+# tegg ajv 插件
+npm i --save @eggjs/tegg-ajv-plugin
+```
+
+### Prepare
+
+```json
+// tsconfig.json
+{
+  "extends": "@eggjs/tsconfig"
+}
+```
+
+## Usage
+
+1、定义入参校验 Schema
+
+使用 typebox 定义，会内置到 tegg 导出
+
+```ts
+import { Type, TransformEnum } from '@eggjs/tegg/ajv';
+
+const SyncPackageTaskSchema = Type.Object({
+  fullname: Type.String({
+    transform: [ TransformEnum.trim ],
+    maxLength: 100,
+  }),
+  tips: Type.String({
+    transform: [ TransformEnum.trim ],
+    maxLength: 1024,
+  }),
+  skipDependencies: Type.Boolean(),
+  syncDownloadData: Type.Boolean(),
+  // force sync immediately, only allow by admin
+  force: Type.Boolean(),
+  // sync history version
+  forceSyncHistory: Type.Boolean(),
+  // source registry
+  registryName: Type.Optional(Type.String()),
+});
+```
+
+2、从校验 Schema 生成静态的入参类型
+
+```ts
+import { Static } from '@eggjs/tegg/ajv';
+
+type SyncPackageTaskType = Static<typeof SyncPackageTaskSchema>;
+```
+
+3、在 Controller 中使用入参类型和校验 Schema
+
+注入全局单例 ajv，调用 `ajv.validate(XxxSchema, params)` 进行参数校验，参数校验失败会直接抛出 `AjvInvalidParamError` 异常，
+tegg 会自动返回相应的错误响应给客户端。
+
+```ts
+import { Inject, HTTPController, HTTPMethod, HTTPMethodEnum, HTTPBody } from '@eggjs/tegg';
+import { Ajv, Type, Static, TransformEnum } from '@eggjs/tegg/ajv';
+
+const SyncPackageTaskSchema = Type.Object({
+  fullname: Type.String({
+    transform: [ TransformEnum.trim ],
+    maxLength: 100,
+  }),
+  tips: Type.String({
+    transform: [ TransformEnum.trim ],
+    maxLength: 1024,
+  }),
+  skipDependencies: Type.Boolean(),
+  syncDownloadData: Type.Boolean(),
+  // force sync immediately, only allow by admin
+  force: Type.Boolean(),
+  // sync history version
+  forceSyncHistory: Type.Boolean(),
+  // source registry
+  registryName: Type.Optional(Type.String()),
+});
+
+type SyncPackageTaskType = Static<typeof SyncPackageTaskSchema>;
+
+@HTTPController()
+export class HelloController {
+  private readonly ajv: Ajv;
+
+  @HTTPMethod({
+    method: HTTPMethodEnum.POST,
+    path: '/sync',
+  })
+  async sync(@HTTPBody() task: SyncPackageTaskType) {
+    this.ajv.validate(SyncPackageTaskSchema, task);
+    return {
+      task,
+    };
+  }
+}
+```

package/lib/Ajv.d.ts

@@ -0,0 +1,13 @@
+import { type Schema } from 'ajv/dist/2019';
+import { type Ajv as IAjv, AjvInvalidParamError } from '@eggjs/tegg/ajv';
+export declare class Ajv implements IAjv {
+    #private;
+    static InvalidParamErrorClass: typeof AjvInvalidParamError;
+    protected _init(): void;
+    /**
+     * Validate data with typebox Schema.
+     *
+     * If validate fail, with throw `Ajv.InvalidParamErrorClass`
+     */
+    validate(schema: Schema, data: unknown): void;
+}

package/lib/Ajv.js

@@ -0,0 +1,90 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    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");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _Ajv_ajvInstance;
+var Ajv_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ajv = void 0;
+const _2019_1 = __importDefault(require("ajv/dist/2019"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
+const ajv_keywords_1 = __importDefault(require("ajv-keywords"));
+const ajv_1 = require("@eggjs/tegg/ajv");
+const tegg_1 = require("@eggjs/tegg");
+let Ajv = Ajv_1 = class Ajv {
+    constructor() {
+        _Ajv_ajvInstance.set(this, void 0);
+    }
+    _init() {
+        __classPrivateFieldSet(this, _Ajv_ajvInstance, new _2019_1.default(), "f");
+        (0, ajv_keywords_1.default)(__classPrivateFieldGet(this, _Ajv_ajvInstance, "f"), 'transform');
+        (0, ajv_formats_1.default)(__classPrivateFieldGet(this, _Ajv_ajvInstance, "f"), [
+            'date-time',
+            'time',
+            'date',
+            'email',
+            'hostname',
+            'ipv4',
+            'ipv6',
+            'uri',
+            'uri-reference',
+            'uuid',
+            'uri-template',
+            'json-pointer',
+            'relative-json-pointer',
+            'regex',
+        ])
+            .addKeyword('kind')
+            .addKeyword('modifier');
+    }
+    /**
+     * Validate data with typebox Schema.
+     *
+     * If validate fail, with throw `Ajv.InvalidParamErrorClass`
+     */
+    validate(schema, data) {
+        const result = __classPrivateFieldGet(this, _Ajv_ajvInstance, "f").validate(schema, data);
+        if (!result) {
+            throw new Ajv_1.InvalidParamErrorClass('Validation Failed', {
+                errorData: data,
+                currentSchema: JSON.stringify(schema),
+                errors: __classPrivateFieldGet(this, _Ajv_ajvInstance, "f").errors,
+            });
+        }
+    }
+};
+exports.Ajv = Ajv;
+_Ajv_ajvInstance = new WeakMap();
+Ajv.InvalidParamErrorClass = ajv_1.AjvInvalidParamError;
+__decorate([
+    (0, tegg_1.LifecycleInit)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], Ajv.prototype, "_init", null);
+exports.Ajv = Ajv = Ajv_1 = __decorate([
+    (0, tegg_1.SingletonProto)({
+        accessLevel: tegg_1.AccessLevel.PUBLIC,
+    })
+], Ajv);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQWp2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiQWp2LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSwwREFBcUQ7QUFDckQsOERBQXFDO0FBQ3JDLGdFQUFvQztBQUNwQyx5Q0FBeUU7QUFDekUsc0NBQXlFO0FBS2xFLElBQU0sR0FBRyxXQUFULE1BQU0sR0FBRztJQUFUO1FBR0wsbUNBQXNCO0lBeUN4QixDQUFDO0lBdENXLEtBQUs7UUFDYix1QkFBQSxJQUFJLG9CQUFnQixJQUFJLGVBQU8sRUFBRSxNQUFBLENBQUM7UUFDbEMsSUFBQSxzQkFBUSxFQUFDLHVCQUFBLElBQUksd0JBQWEsRUFBRSxXQUFXLENBQUMsQ0FBQztRQUN6QyxJQUFBLHFCQUFVLEVBQUMsdUJBQUEsSUFBSSx3QkFBYSxFQUFFO1lBQzVCLFdBQVc7WUFDWCxNQUFNO1lBQ04sTUFBTTtZQUNOLE9BQU87WUFDUCxVQUFVO1lBQ1YsTUFBTTtZQUNOLE1BQU07WUFDTixLQUFLO1lBQ0wsZUFBZTtZQUNmLE1BQU07WUFDTixjQUFjO1lBQ2QsY0FBYztZQUNkLHVCQUF1QjtZQUN2QixPQUFPO1NBQ1IsQ0FBQzthQUNDLFVBQVUsQ0FBQyxNQUFNLENBQUM7YUFDbEIsVUFBVSxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLE1BQWMsRUFBRSxJQUFhO1FBQ3BDLE1BQU0sTUFBTSxHQUFHLHVCQUFBLElBQUksd0JBQWEsQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3hELElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUNaLE1BQU0sSUFBSSxLQUFHLENBQUMsc0JBQXNCLENBQUMsbUJBQW1CLEVBQUU7Z0JBQ3hELFNBQVMsRUFBRSxJQUFJO2dCQUNmLGFBQWEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQztnQkFDckMsTUFBTSxFQUFFLHVCQUFBLElBQUksd0JBQWEsQ0FBQyxNQUFPO2FBQ2xDLENBQUMsQ0FBQztRQUNMLENBQUM7SUFDSCxDQUFDOztBQTNDVSxrQkFBRzs7QUFDUCwwQkFBc0IsR0FBRywwQkFBb0IsQUFBdkIsQ0FBd0I7QUFLM0M7SUFEVCxJQUFBLG9CQUFhLEdBQUU7Ozs7Z0NBc0JmO2NBM0JVLEdBQUc7SUFIZixJQUFBLHFCQUFjLEVBQUM7UUFDZCxXQUFXLEVBQUUsa0JBQVcsQ0FBQyxNQUFNO0tBQ2hDLENBQUM7R0FDVyxHQUFHLENBNENmIn0=

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@eggjs/tegg-ajv-plugin",
+  "eggPlugin": {
+    "name": "teggAjv",
+    "strict": false,
+    "dependencies": [
+      "tegg"
+    ]
+  },
+  "eggModule": {
+    "name": "teggAjv"
+  },
+  "version": "3.36.0",
+  "description": "ajv plugin for egg and tegg",
+  "keywords": [
+    "egg",
+    "plugin",
+    "typescript",
+    "module",
+    "tegg",
+    "ajv"
+  ],
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts",
+    "typings/*.d.ts"
+  ],
+  "types": "typings/index.d.ts",
+  "scripts": {
+    "test": "cross-env NODE_ENV=test NODE_OPTIONS='--no-deprecation' mocha",
+    "clean": "tsc -b --clean",
+    "tsc": "npm run clean && tsc -p ./tsconfig.json",
+    "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json",
+    "prepublishOnly": "npm run tsc:pub"
+  },
+  "homepage": "https://github.com/eggjs/tegg",
+  "bugs": {
+    "url": "https://github.com/eggjs/tegg/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eggjs/tegg.git",
+    "directory": "plugin/ajv"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "@eggjs/tegg": "^3.36.0",
+    "@sinclair/typebox": "^0.32.20",
+    "ajv": "^8.12.0",
+    "ajv-formats": "^3.0.1",
+    "ajv-keywords": "^5.1.0"
+  },
+  "devDependencies": {
+    "@eggjs/tegg-config": "^3.36.0",
+    "@eggjs/tegg-controller-plugin": "^3.36.0",
+    "@eggjs/tegg-plugin": "^3.36.0",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.2.4",
+    "cross-env": "^7.0.3",
+    "egg": "^3.9.1",
+    "egg-mock": "^5.5.0",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "b550d59a21f7c9991310ca6b6fd16ee581a5e17d"
+}

package/typings/index.d.ts

@@ -0,0 +1,4 @@
+import 'egg';
+import '@eggjs/tegg-plugin';
+import '@eggjs/tegg-config';
+import '@eggjs/tegg-controller-plugin';