@tsed/schema 6.95.7 → 6.96.0

package/lib/cjs/decorators/common/allOf.d.ts

@@ -1,13 +0,0 @@
-import { AnyJsonSchema } from "../../domain/JsonSchema";
-/**
- * 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/cjs/decorators/common/allow.d.ts

@@ -1,28 +0,0 @@
-/**
- * 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/cjs/decorators/common/any.d.ts

@@ -1,38 +0,0 @@
-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/cjs/decorators/common/anyOf.d.ts

@@ -1,17 +0,0 @@
-import { AnyJsonSchema } from "../../domain/JsonSchema";
-/**
- * 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/cjs/decorators/common/const.d.ts

@@ -1,61 +0,0 @@
-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/cjs/decorators/common/customKey.d.ts

@@ -1,26 +0,0 @@
-/**
- * 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/cjs/decorators/common/default.d.ts

@@ -1,41 +0,0 @@
-/**
- * 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/cjs/decorators/common/description.d.ts

@@ -1,53 +0,0 @@
-/**
- * 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/cjs/decorators/common/enum.d.ts

@@ -1,98 +0,0 @@
-import type { JSONSchema6Type } from "json-schema";
-/**
- * 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
- */
-export declare function Enum(...enumValues: (JSONSchema6Type | any)[]): Function;

package/lib/cjs/decorators/common/example.d.ts

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

package/lib/cjs/decorators/common/examples.d.ts

@@ -1,12 +0,0 @@
-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/cjs/decorators/common/exclusiveMaximum.d.ts

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

package/lib/cjs/decorators/common/exclusiveMinimum.d.ts

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