@eggjs/ajv-decorator 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,5 @@
+# `@eggjs/ajv-decorator`
+
+## Usage
+
+Please read [@eggjs/tegg-ajv-plugin](../../plugin/ajv-plugin)

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from '@sinclair/typebox';
+export * from './src/enum/TransformEnum';
+export * from './src/error/AjvInvalidParamError';
+export * from './src/type/Ajv';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@sinclair/typebox"), exports);
+__exportStar(require("./src/enum/TransformEnum"), exports);
+__exportStar(require("./src/error/AjvInvalidParamError"), exports);
+__exportStar(require("./src/type/Ajv"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsb0RBQWtDO0FBQ2xDLDJEQUF5QztBQUN6QyxtRUFBaUQ7QUFDakQsaURBQStCIn0=

package/dist/src/enum/TransformEnum.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This keyword allows a string to be modified during validation.
+ * This keyword applies only to strings. If the data is not a string, the transform keyword is ignored.
+ * @see https://github.com/ajv-validator/ajv-keywords?tab=readme-ov-file#transform
+ */
+export declare enum TransformEnum {
+    /** remove whitespace from start and end */
+    trim = "trim",
+    /** remove whitespace from start */
+    trimStart = "trimStart",
+    /**
+     * @alias trimStart
+     */
+    trimLeft = "trimLeft",
+    /** remove whitespace from end */
+    trimEnd = "trimEnd",
+    /**
+     * @alias trimEnd
+     */
+    trimRight = "trimRight",
+    /** convert to lower case */
+    toLowerCase = "toLowerCase",
+    /** convert to upper case */
+    toUpperCase = "toUpperCase",
+    /**
+     * change string case to be equal to one of `enum` values in the schema
+     *
+     * **NOTE**: requires that all allowed values are unique when case insensitive
+     * ```ts
+     * const schema = {
+     *   type: "array",
+     *   items: {
+     *     type: "string",
+     *     transform: ["trim", Transform.toEnumCase],
+     *     enum: ["pH"],
+     *   },
+     * };
+     *
+     * const data = ["ph", " Ph", "PH", "pH "];
+     * ajv.validate(schema, data);
+     * console.log(data) // ['pH','pH','pH','pH'];
+     * ```
+     */
+    toEnumCase = "toEnumCase"
+}

package/dist/src/enum/TransformEnum.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformEnum = void 0;
+/**
+ * This keyword allows a string to be modified during validation.
+ * This keyword applies only to strings. If the data is not a string, the transform keyword is ignored.
+ * @see https://github.com/ajv-validator/ajv-keywords?tab=readme-ov-file#transform
+ */
+var TransformEnum;
+(function (TransformEnum) {
+    /** remove whitespace from start and end */
+    TransformEnum["trim"] = "trim";
+    /** remove whitespace from start */
+    TransformEnum["trimStart"] = "trimStart";
+    /**
+     * @alias trimStart
+     */
+    TransformEnum["trimLeft"] = "trimLeft";
+    /** remove whitespace from end */
+    TransformEnum["trimEnd"] = "trimEnd";
+    /**
+     * @alias trimEnd
+     */
+    TransformEnum["trimRight"] = "trimRight";
+    /** convert to lower case */
+    TransformEnum["toLowerCase"] = "toLowerCase";
+    /** convert to upper case */
+    TransformEnum["toUpperCase"] = "toUpperCase";
+    /**
+     * change string case to be equal to one of `enum` values in the schema
+     *
+     * **NOTE**: requires that all allowed values are unique when case insensitive
+     * ```ts
+     * const schema = {
+     *   type: "array",
+     *   items: {
+     *     type: "string",
+     *     transform: ["trim", Transform.toEnumCase],
+     *     enum: ["pH"],
+     *   },
+     * };
+     *
+     * const data = ["ph", " Ph", "PH", "pH "];
+     * ajv.validate(schema, data);
+     * console.log(data) // ['pH','pH','pH','pH'];
+     * ```
+     */
+    TransformEnum["toEnumCase"] = "toEnumCase";
+})(TransformEnum || (exports.TransformEnum = TransformEnum = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVHJhbnNmb3JtRW51bS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9lbnVtL1RyYW5zZm9ybUVudW0udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7R0FJRztBQUNILElBQVksYUF1Q1g7QUF2Q0QsV0FBWSxhQUFhO0lBQ3ZCLDJDQUEyQztJQUMzQyw4QkFBYSxDQUFBO0lBQ2IsbUNBQW1DO0lBQ25DLHdDQUF1QixDQUFBO0lBQ3ZCOztPQUVHO0lBQ0gsc0NBQXFCLENBQUE7SUFDckIsaUNBQWlDO0lBQ2pDLG9DQUFtQixDQUFBO0lBQ25COztPQUVHO0lBQ0gsd0NBQXVCLENBQUE7SUFDdkIsNEJBQTRCO0lBQzVCLDRDQUEyQixDQUFBO0lBQzNCLDRCQUE0QjtJQUM1Qiw0Q0FBMkIsQ0FBQTtJQUMzQjs7Ozs7Ozs7Ozs7Ozs7Ozs7O09Ba0JHO0lBQ0gsMENBQXlCLENBQUE7QUFDM0IsQ0FBQyxFQXZDVyxhQUFhLDZCQUFiLGFBQWEsUUF1Q3hCIn0=

package/dist/src/error/AjvInvalidParamError.d.ts

@@ -0,0 +1,12 @@
+import { type ErrorObject } from 'ajv/dist/2019';
+export interface AjvInvalidParamErrorOptions {
+    errorData: unknown;
+    currentSchema: string;
+    errors: ErrorObject[];
+}
+export declare class AjvInvalidParamError extends Error {
+    errorData: unknown;
+    currentSchema: string;
+    errors: ErrorObject[];
+    constructor(message: string, options: AjvInvalidParamErrorOptions);
+}

package/dist/src/error/AjvInvalidParamError.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AjvInvalidParamError = void 0;
+class AjvInvalidParamError extends Error {
+    constructor(message, options) {
+        super(message);
+        this.name = this.constructor.name;
+        this.errorData = options.errorData;
+        this.currentSchema = options.currentSchema;
+        this.errors = options.errors;
+    }
+}
+exports.AjvInvalidParamError = AjvInvalidParamError;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQWp2SW52YWxpZFBhcmFtRXJyb3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZXJyb3IvQWp2SW52YWxpZFBhcmFtRXJyb3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBUUEsTUFBYSxvQkFBcUIsU0FBUSxLQUFLO0lBSzdDLFlBQVksT0FBZSxFQUFFLE9BQW9DO1FBQy9ELEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNmLElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUM7UUFDbEMsSUFBSSxDQUFDLFNBQVMsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDO1FBQ25DLElBQUksQ0FBQyxhQUFhLEdBQUcsT0FBTyxDQUFDLGFBQWEsQ0FBQztRQUMzQyxJQUFJLENBQUMsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUM7SUFDL0IsQ0FBQztDQUNGO0FBWkQsb0RBWUMifQ==

package/dist/src/type/Ajv.d.ts

@@ -0,0 +1,4 @@
+import type { Schema } from 'ajv/dist/2019';
+export interface Ajv {
+    validate(schema: Schema, data: unknown): void;
+}

package/dist/src/type/Ajv.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQWp2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGUvQWp2LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@eggjs/ajv-decorator",
+  "version": "3.36.0",
+  "description": "tegg ajv decorator",
+  "keywords": [
+    "egg",
+    "typescript",
+    "decorator",
+    "tegg",
+    "ajv"
+  ],
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "typings": "dist/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"
+  },
+  "license": "MIT",
+  "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": "core/ajv-decorator"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.32.20",
+    "ajv": "^8.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.2.4",
+    "cross-env": "^7.0.3",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "gitHead": "b550d59a21f7c9991310ca6b6fd16ee581a5e17d"
+}