@tsed/schema 7.79.3 → 7.80.0

package/lib/types-esm/decorators/common/description.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Add a description to the class, method or property
+ *
+ * ## Examples
+ * ### On class
+ *
+ * ```typescript
+ * @Description("description")
+ * class Model {
+ *
+ * }
+ * ```
+ *
+ * ### On method
+ *
+ * ```typescript
+ * @Controller("/")
+ * class ModelCtrl {
+ *    @Description("description")
+ *    async method() {}
+ * }
+ * ```
+ *
+ * ### On parameter
+ *
+ * ```typescript
+ * @Controller("/")
+ * class ModelCtrl {
+ *    async method(@Description("description") @PathParam("id") id: string) {}
+ * }
+ * ```
+ *
+ * ### On property
+ *
+ * ```typescript
+ * class Model {
+ *    @Description("description")
+ *    id: string;
+ * }
+ * ```
+ *
+ * @param {string} description
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @classDecorator
+ * @methodDecorator
+ * @propertyDecorator
+ * @parameterDecorator
+ */
+export declare function Description(description: any): (...args: any[]) => any;

package/lib/types-esm/decorators/common/discriminatorKey.d.ts

@@ -0,0 +1 @@
+export declare function DiscriminatorKey(): PropertyDecorator;

package/lib/types-esm/decorators/common/enum.d.ts

@@ -0,0 +1,101 @@
+import type { JSONSchema6Type } from "json-schema";
+declare function EnumFn(...enumValues: (JSONSchema6Type | any)[]): Function;
+/**
+ * The enum keyword is used to restrict a value to a fixed set of values.
+ * It must be an array with at least one element, where each element is unique.
+ *
+ * Elements in the array might be of any value, including null.
+ *
+ * ::: warning
+ * For v6 user, use @@Enum@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Enum("value1", "value2")
+ *    property: "value1" | "value2";
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "enum": ["value1", "value2"]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Enum("value1", "value2")
+ *    property: ("value1" | "value2")[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "enum": ["value1", "value2"]
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With Typescript Enum
+ *
+ * ```typescript
+ * enum SomeEnum {
+ *    ENUM_1 = "enum1",
+ *    ENUM_2 = "enum2"
+ * }
+ *
+ * class Model {
+ *    @Enum(SomeEnum)
+ *    property: SomeEnum;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *        "type": "string",
+ *        "enum": ["enum1", "enum2"]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string | number | boolean | {}} enumValue
+ * @param enumValues
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @ajv-errors
+ */
+export declare const Enum: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<typeof EnumFn>;
+export {};

package/lib/types-esm/decorators/common/errorMsg.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Add an error message to the property.
+ * @decorator
+ * @ajv
+ */
+export declare function ErrorMsg(obj: Record<string, string>): (...args: any[]) => any;

package/lib/types-esm/decorators/common/example.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Add an example metadata on the decorated element.
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @methodDecorator
+ * @classDecorator
+ */
+export declare function Example(...examples: any[]): Function;

package/lib/types-esm/decorators/common/examples.d.ts

@@ -0,0 +1,12 @@
+import { OpenSpecHash, OpenSpecRef, OS3Example } from "@tsed/openspec";
+/**
+ * Add a examples metadata on the decorated element.
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @methodDecorator
+ * @classDecorator
+ */
+export declare function Examples(examples: OpenSpecHash<OS3Example | OpenSpecRef>): ParameterDecorator;

package/lib/types-esm/decorators/common/exclusiveMaximum.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The value of `exclusiveMaximum` MUST be number, representing an exclusive upper limit for a numeric instance.
+ *
+ * If the instance is a number, then the instance is valid only if it has a value strictly less than (not equal to) `exclusiveMaximum`.
+ *
+ * ::: warning
+ * For v6 user, use @@ExclusiveMaximum@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @ExclusiveMaximum(10)
+ *    property: number;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "exclusiveMaximum": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @ExclusiveMaximum(10)
+ *    @CollectionOf(Number)
+ *    property: number[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "number",
+ *          "exclusiveMaximum": 10
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param maximum
+ * @param {boolean} exclusiveMaximum
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @ajv-errors
+ */
+export declare const ExclusiveMaximum: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(maximum: number, exclusiveMaximum?: boolean) => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(maximum: number, exclusive?: boolean) => (...args: any[]) => any>>;

package/lib/types-esm/decorators/common/exclusiveMinimum.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The value of `exclusiveMinimum` MUST be number, representing an exclusive upper limit for a numeric instance.
+ *
+ * If the instance is a number, then the instance is valid only if it has a value strictly greater than (not equal to) `exclusiveMinimum`.
+ *
+ * ::: warning
+ * For v6 user, use @@ExclusiveMinimum@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @ExclusiveMinimum(10)
+ *    property: number;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "exclusiveMinimum": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @ExclusiveMinimum(10)
+ *    @CollectionOf(Number)
+ *    property: number[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "number",
+ *          "exclusiveMinimum": 10
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param minimum
+ * @param {boolean} exclusiveMinimum
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @ajv-errors
+ */
+export declare const ExclusiveMinimum: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(minimum: number, exclusiveMinimum?: boolean) => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(minimum: number, exclusive?: boolean) => (...args: any[]) => any>>;