@tsed/schema 6.87.2 → 6.90.0

package/lib/types/constants/httpStatusMessages.d.ts

@@ -0,0 +1,272 @@
+export declare const HTTP_STATUS_MESSAGES: {
+    "100": {
+        label: string;
+        code: string;
+    };
+    "101": {
+        label: string;
+        code: string;
+    };
+    "102": {
+        label: string;
+        code: string;
+    };
+    "103": {
+        label: string;
+        code: string;
+    };
+    "200": {
+        label: string;
+        code: string;
+    };
+    "201": {
+        label: string;
+        code: string;
+    };
+    "202": {
+        label: string;
+        code: string;
+    };
+    "203": {
+        label: string;
+        code: string;
+    };
+    "204": {
+        label: string;
+        code: string;
+    };
+    "205": {
+        label: string;
+        code: string;
+    };
+    "206": {
+        label: string;
+        code: string;
+    };
+    "207": {
+        label: string;
+        code: string;
+    };
+    "208": {
+        label: string;
+        code: string;
+    };
+    "226": {
+        label: string;
+        code: string;
+    };
+    "300": {
+        label: string;
+        code: string;
+    };
+    "301": {
+        label: string;
+        code: string;
+    };
+    "302": {
+        label: string;
+        code: string;
+    };
+    "303": {
+        label: string;
+        code: string;
+    };
+    "304": {
+        label: string;
+        code: string;
+    };
+    "305": {
+        label: string;
+        code: string;
+    };
+    "306": {
+        label: string;
+        code: string;
+    };
+    "307": {
+        label: string;
+        code: string;
+    };
+    "308": {
+        label: string;
+        code: string;
+    };
+    "310": {
+        label: string;
+        code: string;
+    };
+    "400": {
+        label: string;
+        code: string;
+    };
+    "401": {
+        label: string;
+        code: string;
+    };
+    "402": {
+        label: string;
+        code: string;
+    };
+    "403": {
+        label: string;
+        code: string;
+    };
+    "404": {
+        label: string;
+        code: string;
+    };
+    "405": {
+        label: string;
+        code: string;
+    };
+    "406": {
+        label: string;
+        code: string;
+    };
+    "407": {
+        label: string;
+        code: string;
+    };
+    "408": {
+        label: string;
+        code: string;
+    };
+    "409": {
+        label: string;
+        code: string;
+    };
+    "410": {
+        label: string;
+        code: string;
+    };
+    "411": {
+        label: string;
+        code: string;
+    };
+    "412": {
+        label: string;
+        code: string;
+    };
+    "413": {
+        label: string;
+        code: string;
+    };
+    "414": {
+        label: string;
+        code: string;
+    };
+    "415": {
+        label: string;
+        code: string;
+    };
+    "416": {
+        label: string;
+        code: string;
+    };
+    "417": {
+        label: string;
+        code: string;
+    };
+    "418": {
+        label: string;
+        code: string;
+    };
+    "421": {
+        label: string;
+        code: string;
+    };
+    "422": {
+        label: string;
+        code: string;
+    };
+    "423": {
+        label: string;
+        code: string;
+    };
+    "424": {
+        label: string;
+        code: string;
+    };
+    "425": {
+        label: string;
+        code: string;
+    };
+    "426": {
+        label: string;
+        code: string;
+    };
+    "427": {
+        label: string;
+        code: string;
+    };
+    "428": {
+        label: string;
+        code: string;
+    };
+    "429": {
+        label: string;
+        code: string;
+    };
+    "430": {
+        label: string;
+        code: string;
+    };
+    "431": {
+        label: string;
+        code: string;
+    };
+    "451": {
+        label: string;
+        code: string;
+    };
+    "500": {
+        label: string;
+        code: string;
+    };
+    "501": {
+        label: string;
+        code: string;
+    };
+    "502": {
+        label: string;
+        code: string;
+    };
+    "503": {
+        label: string;
+        code: string;
+    };
+    "504": {
+        label: string;
+        code: string;
+    };
+    "505": {
+        label: string;
+        code: string;
+    };
+    "506": {
+        label: string;
+        code: string;
+    };
+    "507": {
+        label: string;
+        code: string;
+    };
+    "508": {
+        label: string;
+        code: string;
+    };
+    "509": {
+        label: string;
+        code: string;
+    };
+    "510": {
+        label: string;
+        code: string;
+    };
+    "511": {
+        label: string;
+        code: string;
+    };
+};
+export declare function getStatusConstant(status: number | string): any;
+export declare function getStatusMessage(status: number | string): any;

package/lib/types/decorators/class/children.d.ts

@@ -0,0 +1,11 @@
+import { Type } from "@tsed/core";
+/**
+ * Add Children class to compose routes
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @param children
+ */
+export declare function Children(...children: Type<any>[]): ClassDecorator;

package/lib/types/decorators/collections/collectionContains.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionContains(String).MinLength(0).MaxLength(0)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * @param {Type<any>} type
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export declare function CollectionContains(type: any): import("./collectionOf").CollectionOfChainedDecorators;

package/lib/types/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/decorators/collections/maxItems.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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
+ */
+export declare function MaxItems(maxItems: number): (...args: any[]) => any;

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

@@ -0,0 +1,70 @@
+/**
+ * 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
+ */
+export declare function MaxProperties(maxProperties: number): (...args: any[]) => any;

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

@@ -0,0 +1,51 @@
+/**
+ * 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
+ */
+export declare function MinItems(minItems: number): (...args: any[]) => any;

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

@@ -0,0 +1,69 @@
+/**
+ * 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
+ */
+export declare function MinProperties(minProperties: number): (...args: any[]) => any;

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

@@ -0,0 +1,50 @@
+/**
+ * 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
+ */
+export declare function UniqueItems(uniqueItems?: boolean): (...args: any[]) => any;

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

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