@tsed/schema 7.83.3 → 8.0.0-alpha.10

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

@@ -1,61 +0,0 @@
-/**
- * Set integer type.
- *
- * ::: warning
- * For v6 user, use @@Integer@@ from @tsed/schema instead of @@Integer@@ from @tsed/common.
- * :::
- *
- * ## Example
- *
- * ```typescript
- * class Model {
- *    @Integer()
- *    property: number;
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "integer"
- *     }
- *   }
- * }
- * ```
- *
- * ### With array of multiple types
- *
- * ```typescript
- * class Model {
- *    @Integer()
- *    property: number[];
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "array",
- *       "items": {
- *          "type": "integer"
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- */
-export declare function Integer(): (...args: any[]) => any;

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

@@ -1,21 +0,0 @@
-import { DecoratorParameters } from "@tsed/core";
-import type { JsonEntityStore } from "../../domain/JsonEntityStore.js";
-/**
- * Decorator util to compose another decorator. See @@Description@@ decorator implementation for more details.
- *
- * ## Usage
- *
- * ```typescript
- * export function Description(description: any) {
- *   return JsonEntityFn((entity: JsonEntityStore, args: DecoratorParameters) => {
- *       entity.itemSchema.description(description)
- *   });
- * }
- * ```
- *
- * @param fn
- * @decorator
- * @utils
- * @model
- */
-export declare function JsonEntityFn<T extends JsonEntityStore = JsonEntityStore>(fn: (entity: T, parameters: DecoratorParameters) => any): (...args: any[]) => any;

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

@@ -1,77 +0,0 @@
-/**
- * A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.
- *
- * The length of a string instance is defined as the number of its characters as defined by [RFC 7159](http://json-schema.org/latest/json-schema-validation.html#RFC7159).
- *
- * ::: warning
- * The value of maxLength MUST be a non-negative integer.
- * :::
- *
- * ::: tip
- * Omitting this keyword has the same behavior as a value of 0.
- * :::
- *
- * ::: warning
- * For v6 user, use @@MaxLength@@ from @tsed/schema instead of @tsed/common.
- * :::
- *
- * ## Example
- * ### With primitive type
- *
- * ```typescript
- * class Model {
- *    @MaxLength(10)
- *    property: number;
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "string",
- *       "maxLength": 10
- *     }
- *   }
- * }
- * ```
- *
- * ### With array type
- *
- * ```typescript
- * class Model {
- *    @MaxLength(10)
- *    @CollectionOf(String)
- *    property: string[];
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "array",
- *       "items": {
- *          "type": "string",
- *          "maxLength": 10
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * @param {number} maxLength The maximum length allowed
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- * @ajv-errors
- */
-export declare const MaxLength: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(maxLength: number) => (...args: any[]) => any>;

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

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

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

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

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

@@ -1,137 +0,0 @@
-/**
- * The value of `minimum` MUST be a number, representing an inclusive upper limit for a numeric instance.
- *
- * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to `minimum`.
- *
- * ::: warning
- * This decorator will be removed in v7.
- * For v6 user, use @@Minimum@@ from @tsed/schema instead of @tsed/common.
- * :::
- *
- * ## Example
- * ### With primitive type
- *
- * ```typescript
- * class Model {
- *    @Minimum(10)
- *    property: number;
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "number",
- *       "minimum": 10
- *     }
- *   }
- * }
- * ```
- *
- * ### With array type
- *
- * ```typescript
- * class Model {
- *    @Minimum(10)
- *    @CollectionOf(Number)
- *    property: number[];
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "array",
- *       "items": {
- *          "type": "number",
- *          "minimum": 10
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * @param {number} minimum The minimum value allowed
- * @param {boolean} exclusive
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- * @ajv-errors
- */
-export declare const Minimum: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(minimum: number, exclusive?: boolean) => (...args: any[]) => any>;
-/**
- * The value of `minimum` MUST be a number, representing an inclusive upper limit for a numeric instance.
- *
- * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to `minimum`.
- *
- * ## Example
- * ### With primitive type
- *
- * ```typescript
- * class Model {
- *    @Min(10)
- *    property: number;
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "number",
- *       "minimum": 10
- *     }
- *   }
- * }
- * ```
- *
- * ### With array type
- *
- * ```typescript
- * class Model {
- *    @Min(10)
- *    @CollectionOf(Number)
- *    property: number[];
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "array",
- *       "items": {
- *          "type": "number",
- *          "minimum": 10
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * @alias Minimum
- * @param minimum The minimum value allowed
- * @param exclusive
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- */
-export declare const Min: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(minimum: number, exclusive?: boolean) => (...args: any[]) => any>;

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

@@ -1,69 +0,0 @@
-/**
- * A numeric instance is valid only if division by this keyword's value results in an integer.
- *
- * ::: warning
- * The value of `multipleOf` MUST be a number, strictly greater than 0.
- * :::
- *
- * ::: warning
- * For v6 user, use @@MultipleOf@@ from @tsed/schema instead of @tsed/common.
- * :::
- *
- * ## Example
- * ### With primitive type
- *
- * ```typescript
- * class Model {
- *    @MultipleOf(2)
- *    property: Number;
- * }
- * ```
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "number",
- *       "multipleOf": 2
- *     }
- *   }
- * }
- * ```
- *
- * ### With array type
- *
- * ```typescript
- * class Model {
- *    @CollectionOf(number)
- *    @MultipleOf(2)
- *    property: number[];
- * }
- * ```
- *
- * Will produce:
- *
- * ```json
- * {
- *   "type": "object",
- *   "properties": {
- *     "property": {
- *       "type": "array",
- *       "items": {
- *          "type": "number",
- *          "multipleOf": 2
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * @param {number} multipleOf The multiple value allowed
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- * @ajv-errors
- */
-export declare const MultipleOf: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(multipleOf: number) => (...args: any[]) => any>;

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

@@ -1,32 +0,0 @@
-/**
- * Add a name metadata on the decorated element.
- *
- * ## Examples
- * ### On parameters
- *
- * ```typescript
- * async myMethod(@Name("nameOf") @PathParams("id") id: string): Promise<Model>  {
- *
- * }
- * ```
- *
- * ### On parameters
- *
- * ```typescript
- * @Name("AliasName")
- * @Controller("/")
- * class ModelCtrl {
- *
- * }
- * ```
- *
- * @param name
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- * @classDecorator
- * @operation
- */
-export declare function Name(name: any): (...args: any[]) => any;

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

@@ -1,25 +0,0 @@
-import { Type } from "@tsed/core";
-import type { JSONSchema6TypeName } from "json-schema";
-/**
- * Set field as nullable.
- *
- * ## Example
- *
- * ```typescript
- * class Model {
- *    @Nullable(Date)
- *    property: Date | null;
- *
- *    @Nullable(String, Number, Boolean)
- *    property: string | number | boolean | null;
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- */
-export declare function Nullable(type: JSONSchema6TypeName | Type<any> | any, ...types: (JSONSchema6TypeName | Type<any> | any)[]): any;

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

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

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

@@ -1,10 +0,0 @@
-/**
- * Add optional annotation on Property or Parameter.
- *
- * @decorator
- * @validation
- * @swagger
- * @schema
- * @input
- */
-export declare function Optional(): (...args: any[]) => any;