@tsed/schema 7.79.3 → 7.80.0

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

@@ -0,0 +1,466 @@
+import { ValueOf } from "@tsed/core";
+import { JsonFormatTypes } from "../../domain/JsonFormatTypes.js";
+/**
+ * The following formats are supported for string validation with `format` keyword:
+ *
+ * - **date**: full-date according to [RFC3339](https://json-schema.org/latest/json-schema-validation.html#RFC3339).
+ * - **time**: time with optional time-zone.
+ * - **date-time**: date-time from the same source (time-zone is mandatory).
+ * - **uri**: full uri with optional protocol.
+ * - **email**: email address.
+ * - **hostname**: host name according to [RFC1034](https://tools.ietf.org/html/rfc1034#section-3.1).
+ * - **ipv4**: IP address v4.
+ * - **ipv6**: IP address v6.
+ * - **regex**: tests whether a string is a valid regular expression by passing it to RegExp constructor.
+ *
+ * ::: warning
+ * For v6 user, use @@Format@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Format("email")
+ *    property: string;
+ * }
+ * ```
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "email"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Format("email")
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "email"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string} format
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @ajv-errors
+ */
+export declare const Format: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>;
+/**
+ * Apply an email validation on property.
+ *
+ * ::: warning
+ * For v6 user, use @@Email@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Email()
+ *    property: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "email"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Email()
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "email"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * > See [Format](api/common/jsonschema/schema) decorator.
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @schema
+ * @swagger
+ * @input
+ * @ajv-errors
+ */
+export declare const Email: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;
+/**
+ * Apply a date-time validation on property.
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @DateTime()
+ *    property: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "date-time"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @DateTime()
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "date-time"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * > See [Format](api/common/jsonschema/schema) decorator.
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ * @auto-map The data will be stored on the right place according to the type and collectionType (primitive or collection).
+ * @ajv-errors
+ */
+export declare const DateTime: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;
+/**
+ * Apply a time validation on property.
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Time()
+ *    property: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "time"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Time()
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "time"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * > See [Format](api/common/jsonschema/schema) decorator.
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ * @ajv-errors
+ */
+export declare const DateFormat: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;
+/**
+ * Apply a time validation on property.
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @TimeFormat()
+ *    property: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "time"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @TimeFormat()
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "time"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * > See [Format](api/common/jsonschema/schema) decorator.
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ * @ajv-errors
+ */
+export declare const TimeFormat: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;
+/**
+ * Apply a uri validation on property.
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Uri()
+ *    property: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "uri"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Uri()
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "uri"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * > See [Format](api/common/jsonschema/schema) decorator.
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ * @ajv-errors
+ */
+export declare const Uri: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;
+/**
+ * Apply a url validation on property.
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Url()
+ *    property: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "format": "url"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Url()
+ *    @CollectionOf(String)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "string",
+ *          "format": "url"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * > See [Format](api/common/jsonschema/schema) decorator.
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ * @ajv-errors
+ */
+export declare const Url: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;

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

@@ -0,0 +1,10 @@
+/**
+ * Allow to forward group on specific property.
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function ForwardGroups(bool?: boolean): PropertyDecorator;

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

@@ -0,0 +1,12 @@
+/**
+ * Apply groups validation strategy
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function Groups<T>(groupsDefinition: Record<string, (keyof T)[]>): ClassDecorator;
+export declare function Groups<T>(groupName: string, groups: string[]): ParameterDecorator;
+export declare function Groups(...groups: string[]): Function;

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

@@ -0,0 +1,32 @@
+/**
+ * Disable documentation for the class and his endpoint.
+ *
+ * ````typescript
+ * @Controller('/')
+ * export class Ctrl {
+ *
+ *   @Get('/')
+ *   @Hidden()
+ *   hiddenRoute(){
+ *
+ *   }
+ * }
+ *
+ * @Controller('/')
+ * @Hidden()
+ * export class Ctrl {
+ *   @Get('/')
+ *   hiddenRoute() {
+ *
+ *   }
+ *   @Get('/2')
+ *   hiddenRoute2() {
+ *
+ *   }
+ * }
+ * ```
+ *
+ * @decorator
+ * @ignore
+ */
+export declare function Hidden(): Function;

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

@@ -0,0 +1,59 @@
+import { IgnoreCallback } from "../../interfaces/IgnoreCallback.js";
+/**
+ * Ignore the property when JsonMapper serialize the class to a Plain Object JavaScript.
+ *
+ * ::: warning
+ * Swagger will not generate documentation for the ignored property.
+ * :::
+ *
+ * ```typescript
+ * class User {
+ *   @Ignore()
+ *   _id: string;
+ *
+ *   @Property()
+ *   firstName: string;
+ *
+ *   @Property()
+ *   lastName: string;
+ *
+ *   @Ignore((value, ctx) => !ctx.endpoint)
+ *   password: string;
+ * }
+ * ```
+ *
+ * The controller:
+ * ```typescript
+ * import {Post, Controller, BodyParams} from "@tsed/common";
+ * import {Person} from "../models/Person.js";
+ *
+ * @Controller("/")
+ * export class UsersCtrl {
+ *   @Get("/")
+ *   get(): User {
+ *     const user = new User();
+ *     user._id = "12345";
+ *     user.firstName = "John";
+ *     user.lastName = "Doe";
+ *     user.password = "secretpassword";
+ *     return
+ *   }
+ * }
+ * ```
+ *
+ * The expected json object:
+ *
+ * ```json
+ * {
+ *  "firstName": "John",
+ *  "lastName": "Doe"
+ * }
+ * ```
+ * @param cb Callback to know if the property must be ignored
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @deprecated Since v7. Use @Groups decorator instead of and enable `jsonMapper.strictGroups` in your configuration.
+ */
+export declare function Ignore(cb?: boolean | IgnoreCallback): (...args: any[]) => any;

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

@@ -0,0 +1,61 @@
+/**
+ * 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

@@ -0,0 +1,21 @@
+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;