@tsed/schema 7.79.3 → 7.80.0

package/lib/types-esm/decorators/collections/collectionOf.d.ts

@@ -0,0 +1,101 @@
+export interface ArrayOfChainedDecorators {
+    (...args: any): any;
+    /**
+     * An array instance is valid against `minItems` if its size is greater than, or equal to, the value of this keyword.
+     *
+     * ::: warning
+     * The value `minItems` MUST be a non-negative integer.
+     * :::
+     *
+     * ::: tip
+     * Omitting this keyword has the same behavior as a value of 0.
+     * :::
+     */
+    MinItems(minItems: number): this;
+    /**
+     * The value `maxItems` MUST be a non-negative integer.
+     *
+     * An array instance is valid against `maxItems` if its size is less than, or equal to, the value of this keyword.
+     *
+     * :: warning
+     * The value `maxItems` MUST be a non-negative integer.
+     * :::
+     */
+    MaxItems(maxItems: number): this;
+    /**
+     * Set the type of the item collection. The possible value is String, Boolean, Number, Date, Object, Class, etc...
+     *
+     * The array instance will be valid against "contains" if at least one of its elements is valid against the given schema.
+     */
+    Contains(): this;
+    /**
+     * If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.
+     */
+    UniqueItems(uniqueItems?: boolean): this;
+}
+export interface MapOfChainedDecorators {
+    (...args: any): any;
+    /**
+     * An object instance is valid against `minProperties` if its number of properties is less than, or equal to, the value of this keyword.
+     *
+     * ::: warning
+     * The value of this keyword MUST be a non-negative integer.
+     * :::
+     */
+    MinProperties(minProperties: number): this;
+    /**
+     * An object instance is valid against `maxProperties` if its number of properties is less than, or equal to, the value of this keyword.
+     *
+     * ::: warning
+     * The value of this keyword MUST be a non-negative integer.
+     * :::
+     */
+    MaxProperties(maxProperties: number): this;
+}
+export interface CollectionOfChainedDecorators extends MapOfChainedDecorators, ArrayOfChainedDecorators {
+}
+/**
+ * Set the type of the item collection. The possible value is String, Boolean, Number, Date, Object, Class, etc...
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(String).MinLength(0).MaxLength(0)
+ *    property: string[];
+ * }
+ * ```
+ * ::: warning
+ * You mustn't use the `type Type = string | number` as parameters Type.
+ *
+ * This example doesn't work:
+ *
+ * ```typescript
+ * type Type = "string" | "number"
+ * class Model {
+ *    @CollectionOf(Type)
+ *    property: Type[];
+ * }
+ * ```
+ * :::
+ *
+ * @param {Type<any>} type
+ * @param collectionType
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export declare function CollectionOf(type: any, collectionType?: any): CollectionOfChainedDecorators;
+/**
+ * Alias of @@GenericOf@@ decorator.
+ * @param type
+ * @decorator
+ */
+export declare function ArrayOf(type: any): ArrayOfChainedDecorators;
+/**
+ * Alias of @@GenericOf@@ decorator.
+ * @param type
+ * @decorator
+ */
+export declare function MapOf(type: any): MapOfChainedDecorators;

package/lib/types-esm/decorators/collections/maxItems.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The value `maxItems` MUST be a non-negative integer.
+ *
+ * An array instance is valid against `maxItems` if its size is less than, or equal to, the value of this keyword.
+ *
+ * :: warning
+ * The value `maxItems` MUST be a non-negative integer.
+ * :::
+ *
+ * :: warning
+ * This decorator will be removed in v7.
+ * For v6 user, use @@MaxItems@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(String)
+ *    @MaxItems(10)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "maxItems": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} maxItems
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ * @ajv-errors
+ */
+export declare const MaxItems: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(maxItems: number) => (...args: any[]) => any>;

package/lib/types-esm/decorators/collections/maxProperties.d.ts

@@ -0,0 +1,71 @@
+/**
+ * An object instance is valid against `maxProperties` if its number of properties is less than, or equal to, the value of this keyword.
+ *
+ * ::: warning
+ * The value of this keyword MUST be a non-negative integer.
+ * :::
+ *
+ * ::: warning
+ * This decorator will be removed in v7.
+ * For v6 user, use @@MaxProperties@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### On prop
+ * ```typescript
+ * class Model {
+ *    @MaxProperties(10)
+ *    property: any;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "any",
+ *       "maxProperties": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### On class
+ *
+ * ```typescript
+ * @MaxProperties(10)
+ * class Model {
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "maxProperties": 10
+ * }
+ * ```
+ *
+ * ### On Parameter
+ *
+ * ```typescript
+ *
+ * class Model {
+ *   method(@Any() @MaxProperties(10) obj: any){}
+ * }
+ * ```
+ *
+ * @param {number} maxProperties The maximum properties allowed on the given object
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ * @ajv-errors
+ */
+export declare const MaxProperties: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(maxProperties: number) => (...args: any[]) => any>;

package/lib/types-esm/decorators/collections/minItems.d.ts

@@ -0,0 +1,52 @@
+/**
+ * An array instance is valid against `minItems` if its size is greater than, or equal to, the value of this keyword.
+ *
+ * ::: warning
+ * The value `minItems` MUST be a non-negative integer.
+ * :::
+ *
+ * ::: tip
+ * Omitting this keyword has the same behavior as a value of 0.
+ * :::
+ *
+ * ::: warning
+ * For v6 user, use @@MinItems@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(String)
+ *    @MinItems(10)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "minItems": 10,
+ *       "items": {
+ *         "type": "string"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} minItems
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ * @ajv-errors
+ */
+export declare const MinItems: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(minItems: number) => (...args: any[]) => any>;

package/lib/types-esm/decorators/collections/minProperties.d.ts

@@ -0,0 +1,70 @@
+/**
+ * An object instance is valid against `minProperties` if its number of properties is less than, or equal to, the value of this keyword.
+ *
+ * ::: warning
+ * The value of this keyword MUST be a non-negative integer.
+ * :::
+ *
+ * ::: warning
+ * For v6 user, use @@MinProperties@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### On prop
+ * ```typescript
+ * class Model {
+ *    @MinProperties(10)
+ *    property: any;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "any",
+ *       "minProperties": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### On class
+ *
+ * ```typescript
+ * @MinProperties(10)
+ * class Model {
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "minProperties": 10
+ * }
+ * ```
+ *
+ * ### On Parameter
+ *
+ * ```typescript
+ *
+ * class Model {
+ *   method(@Any() @MinProperties(10) obj: any){}
+ * }
+ * ```
+ *
+ * @param {number} minProperties The minimum properties allowed on the object.
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ * @ajv-errors
+ */
+export declare const MinProperties: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(minProperties: number) => (...args: any[]) => any>;

package/lib/types-esm/decorators/collections/uniqueItems.d.ts

@@ -0,0 +1,51 @@
+/**
+ * If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.
+ *
+ * ::: warning
+ * For v6 user, use @@UniqueItems@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @UniqueItems()  // default true
+ *    property: number[];
+ * }
+ * ```
+ *
+ *  * ```typescript
+ * class Model {
+ *    @CollectionOf(String)
+ *    @UniqueItems()
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "uniqueItems": true,
+ *       "items": {
+ *         "type": "string"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {boolean} uniqueItems
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ * @ajv-errors
+ */
+export declare const UniqueItems: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(uniqueItems?: boolean) => (...args: any[]) => any>;

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

@@ -0,0 +1,11 @@
+import { AnyJsonSchema } from "../../domain/JsonSchema.js";
+/**
+ * Accept unknown properties on the deserialized model.
+ *
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+export declare function AdditionalProperties(schema: boolean | AnyJsonSchema): (...args: any[]) => any;

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

@@ -0,0 +1,13 @@
+import { AnyJsonSchema } from "../../domain/JsonSchema.js";
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param allOf
+ */
+export declare function AllOf(...allOf: AnyJsonSchema[]): (...args: any[]) => any;

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

@@ -0,0 +1,28 @@
+/**
+ * Add allowed values when the property or parameters is required.
+ *
+ * #### Example on parameter:
+ *
+ * ```typescript
+ * @Post("/")
+ * async method(@Allow("") @BodyParams("field") field: string) {}
+ * ```
+ * > Required will throw a BadRequest when the given value is `null` or `undefined` but not for an empty string.
+ *
+ * #### Example on model:
+ *
+ * ```typescript
+ * class Model {
+ *   @Allow("")
+ *   field: string;
+ * }
+ * ```
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function Allow(...values: any[]): any;

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

@@ -0,0 +1,38 @@
+import { Type } from "@tsed/core";
+import type { JSONSchema6TypeName } from "json-schema";
+/**
+ * Set the type of the array items.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Any()
+ *    property: any;
+ *
+ *    @Any(String, Number, Boolean)
+ *    property: string | number | boolean;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": ["integer", "number", "string", "boolean", "array", "object", "null"]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function Any(...types: (JSONSchema6TypeName | Type<any> | any)[]): (...args: any[]) => any;

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

@@ -0,0 +1,17 @@
+import { AnyJsonSchema } from "../../domain/JsonSchema.js";
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
+ *
+ * ::: warning
+ * AnyOf isn't supported by OS2
+ * :::
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param anyOf
+ */
+export declare function AnyOf(...anyOf: AnyJsonSchema[]): (...args: any[]) => any;

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

@@ -0,0 +1,61 @@
+import type { JSONSchema6Type } from "json-schema";
+/**
+ * The const keyword is used to restrict a value to a fixed value.
+ *
+ * ::: warning
+ * For v6 user, use @@Const@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With a string
+ *
+ * ```typescript
+ * class Model {
+ *    @Const("value1")
+ *    property: "value1";
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "const": "value1"
+ *     }
+ *   }
+ * }
+ * ```
+ *  * ### With a boolean
+ *
+ * ```typescript
+ * class Model {
+ *    @Const(true)
+ *    property: boolean;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "boolean",
+ *       "const": true
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string | number | boolean } constValue
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+export declare function Const(constValue: JSONSchema6Type | any): (...args: any[]) => any;

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

@@ -0,0 +1,26 @@
+/**
+ * Set a custom key on JsonSchema that is not a part of the official spec.
+ *
+ * This custom key can only be displayed if the @@getJsonSchema@@ is called with `{customKeys: true}`.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export declare function CustomKey(key: string, value: any): (...args: any[]) => any;
+/**
+ * Set a group of custom keys on JsonSchema that is not a part of the official spec.
+ *
+ * This custom key can only be displayed if the @@getJsonSchema@@ is called with `{customKeys: true}`.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export declare function CustomKeys(obj: Record<string, any>): (...args: any[]) => any;

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

@@ -0,0 +1,41 @@
+/**
+ * There are no restrictions placed on the value of this keyword.
+ *
+ * ::: warning
+ * For v6 user, use @@Default@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * This keyword can be used to supply a default JSON value associated with a particular schema.
+ * It is RECOMMENDED that a default value be valid against the associated schema.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Default("10")
+ *    property: string = "10";
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "default": "10"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string | number | boolean | {}} defaultValue
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function Default(defaultValue: string | number | boolean | {}): (...args: any[]) => any;

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

@@ -0,0 +1,32 @@
+/**
+ * Set default error message.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * @DefaultMsg("foo should be a string")
+ * class Model {
+ *    property: number;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": "number"
+ *   }
+ *   "errorMessage": {
+ *     "_": "foo should be a string"
+ *   }
+ * }
+ * ```
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+export declare function DefaultMsg(message: string): ClassDecorator;