@tsed/schema 6.95.9 → 6.95.10

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

@@ -1,459 +0,0 @@
-import { ValueOf } from "@tsed/core";
-import { JsonFormatTypes } from "../../domain/JsonFormatTypes";
-/**
- * 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
- */
-export declare function Format(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
- */
-export declare function Email(): (...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).
- */
-export declare function DateTime(): (...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
- */
-export declare function DateFormat(): (...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
- */
-export declare function TimeFormat(): (...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
- */
-export declare function Uri(): (...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
- */
-export declare function Url(): (...args: any[]) => any;

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

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

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

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

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

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

@@ -1,58 +0,0 @@
-import { IgnoreCallback } from "../../interfaces";
-/**
- * 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.mongoose) // don't ignore prop only if mongoose
- *   password: string;
- * }
- * ```
- *
- * The controller:
- * ```typescript
- * import {Post, Controller, BodyParams} from "@tsed/common";
- * import {Person} from "../models/Person";
- *
- * @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
- */
-export declare function Ignore(cb?: boolean | IgnoreCallback): (...args: any[]) => any;

package/lib/cjs/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/cjs/decorators/common/jsonEntityFn.d.ts

@@ -1,21 +0,0 @@
-import { DecoratorParameters } from "@tsed/core";
-import type { JsonEntityStore } from "../../domain";
-/**
- * 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;