@tsed/schema 7.79.4 → 7.80.0

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

@@ -0,0 +1,46 @@
+/**
+ * Constructs a json schema object type whose property keys are keys and whose property values are type.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * type keys = 'one' | 'two';
+ *
+ * class Part {
+ *   prop: string;
+ * }
+ *
+ * type Parts = Record<keys, Part>;
+ *
+ * class Test {
+ *   @RecordOf(Part, 'one', 'two')
+ *   parts: Parts;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *     "type": "object",
+ *     "properties": {
+ *         "one": {
+ *             "$ref": "#/components/schemas/Part"
+ *         },
+ *         "two": {
+ *             "$ref": "#/components/schemas/Part"
+ *         },
+ *     },
+ * }
+ * ```
+ *
+ * @param model
+ * @param keys
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export declare function RecordOf(model: any, ...keys: string[]): (...args: any[]) => any;

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

@@ -0,0 +1,44 @@
+/**
+ * Add required annotation on Property or Parameter.
+ *
+ * The @@Required@@ decorator can be used on two cases.
+ *
+ * To decorate a parameters:
+ *
+ * ```typescript
+ * @Post("/")
+ * async method(@Required() @BodyParams("field") field: string) {}
+ * ```
+ *
+ * To decorate a model:
+ *
+ * ```typescript
+ * class Model {
+ *   @Required()
+ *   field: string;
+ * }
+ * ```
+ *
+ * ::: tip
+ * Required will throw a BadRequest when the given value is `null`, an empty string or `undefined`.
+ * :::
+ *
+ * ### Allow values
+ *
+ * In some case, you didn't want trigger a BadRequest when the value is an empty string for example.
+ * The decorator `@Allow()`, allow you to configure a value list for which there will be no exception.
+ *
+ * ```typescript
+ * class Model {
+ *   @Allow("") // add automatically required flag
+ *   field: string;
+ * }
+ * ```
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare const Required: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(required?: boolean, ...allowedRequiredValues: any[]) => any>;

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

@@ -0,0 +1,10 @@
+/**
+ * Apply groups validation strategy for required property.
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function RequiredGroups(...groups: string[]): PropertyDecorator;

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

@@ -0,0 +1,53 @@
+import { JsonSchema, JsonSchemaObject } from "../../domain/JsonSchema.js";
+import { SpecTypes } from "../../domain/SpecTypes.js";
+/**
+ * Write data formatted to JsonSchema.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * @Schema({title: "test"})
+ * class Model {
+ *    @Schema({formatMinimum: "1987-10-24"})
+ *    @Format("date")
+ *    birthDate: Date
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "title": "test",
+ *   "properties": {
+ *     "birthdate": {
+ *        "type": "string",
+ *        "format": "date",
+ *        "formatMinimum": "1987-10-24"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param partialSchema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export declare function Schema(partialSchema: Partial<JsonSchemaObject> | JsonSchema): (...args: any[]) => any;
+/**
+ * Apply specific schema depending on the spec version
+ * @param specType
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export declare function For(specType: SpecTypes, schema: any): (...args: any[]) => any;

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

@@ -0,0 +1,39 @@
+/**
+ * Add title metadata on the decorated element.
+ *
+ * ::: warning
+ * For v6 user, use @@Title@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Title("title")
+ *    id: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "id": {
+ *        "type": "string",
+ *        "title": "title"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string} title
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export declare function Title(title: string): (...args: any[]) => any;

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

@@ -0,0 +1,8 @@
+/**
+ * Create a new custom formats validator
+ * @param name
+ * @param options
+ * @decorator
+ * @ajv
+ */
+export declare function TypeError(msg: string): ClassDecorator;

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

@@ -0,0 +1,11 @@
+/**
+ * Set the property as WriteOnly.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export declare function WriteOnly(writeOnly?: boolean): (...args: any[]) => any;

package/lib/types-esm/decorators/config/jsonEntityComponent.d.ts

@@ -0,0 +1,10 @@
+import { DecoratorTypes, Type } from "@tsed/core";
+import { JsonEntityStore } from "../../domain/JsonEntityStore.js";
+/**
+ * Declare a new JsonEntityStore class for a specific decorator type.
+ *
+ * @ignore
+ * @param type
+ * @decorator
+ */
+export declare function JsonEntityComponent(type: DecoratorTypes): (target: Type<JsonEntityStore>) => void;

package/lib/types-esm/decorators/generics/genericOf.d.ts

@@ -0,0 +1,76 @@
+import { GenericValue } from "../../utils/generics.js";
+export interface GenericOfChainedDecorators {
+    (...args: any): any;
+    /**
+     * Declare a nested generic models
+     * @param generics
+     */
+    Nested(...generics: GenericValue[]): this;
+}
+/**
+ * Set the types of a Generic class.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Product {
+ *   @Property()
+ *   label: string;
+ * }
+ *
+ * @Generics("T")
+ * class Paginated<T> {
+ *   @CollectionOf("T")
+ *   data: T[];
+ *
+ *   @Property()
+ *   totalCount: number;
+ * }
+ *
+ * class Payload {
+ *    @GenericOf(Product)
+ *    products: Paginated<Product>;
+ * }
+ * ```
+ *
+ * ## Example with nested generics
+ *
+ * ```typescript
+ * class Product {
+ *   @Property()
+ *   label: string;
+ * }
+ *
+ * @Generics("T")
+ * class Paginated<T> {
+ *   @CollectionOf("T")
+ *   data: T[];
+ *
+ *   @Property()
+ *   totalCount: number;
+ * }
+ *
+ * @Generics("D")
+ * class Submission<D> {
+ *   @Property()
+ *   _id: string;
+ *
+ *   @Property("D")
+ *   data: D;
+ * }
+ *
+ * class Payload {
+ *    @GenericOf(Submissions).Nested(Product)
+ *    submissions: Paginated<Submission<Product>>;
+ * }
+ * ```
+ *
+ * @param {Type<any>[]} generics
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @generics
+ */
+export declare function GenericOf(...generics: GenericValue[]): GenericOfChainedDecorators;

package/lib/types-esm/decorators/generics/generics.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Define generics list. This list is used by @@GenericOf@@ and the @@getJsonSchema@@ function to build the correct JsonSchema.
+ *
+ * See @@GenericOf@@ decorator for more details.
+ *
+ * @param generics
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @generics
+ */
+export declare function Generics(...generics: string[]): (target: any) => void;

package/lib/types-esm/decorators/operations/acceptMime.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Set a mime list which are acceptable and checks if the specified content types are acceptable, based on the request’s Accept HTTP header field.
+ *
+ * ```typescript
+ *  @Controller('/mypath')
+ *  export class MyCtrl {
+ *
+ *    @Get('/')
+ *    @AcceptMime('application/json')
+ *    public getResource(){}
+ *  }
+ * ```
+ *
+ * @param mimes
+ * @decorator
+ * @operation
+ * @response
+ */
+export declare function AcceptMime(...mimes: string[]): Function;

package/lib/types-esm/decorators/operations/consumes.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Add consumes metadata on the decorated element.
+ *
+ * ## Examples
+ *
+ * ```typescript
+ * class Model {
+ *    @Consumes("application/x-www-form-urlencoded")
+ *    id: string;
+ * }
+ * ```
+ *
+ * @param consumes
+ * @decorator
+ * @swagger
+ * @classDecorator
+ * @operation
+ */
+export declare function Consumes(...consumes: string[]): (...args: any[]) => any;

package/lib/types-esm/decorators/operations/contentType.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Sets the Content-Type HTTP header to the MIME type as determined by mime.lookup() for the specified type.
+ * If type contains the “/” character, then it sets the `Content-Type` to type.
+ *
+ * ```typescript
+ *  @ContentType('.html');              // => 'text/html'
+ *  @ContentType('html');               // => 'text/html'
+ *  @ContentType('json');               // => 'application/json'
+ *  @ContentType('application/json');   // => 'application/json'
+ *  @ContentType('png');                // => image/png
+ *  private myMethod() {}
+ * ```
+ *
+ * @param type
+ * @decorator
+ * @operation
+ * @response
+ * @headers
+ */
+export declare function ContentType(type: string): import("./returns.js").ReturnsChainedDecorators;

package/lib/types-esm/decorators/operations/deprecated.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Add deprecated metadata on the decorated element.
+ *
+ * ## Examples
+ *
+ * ```typescript
+ *
+ * @Deprecated()
+ * class MyCtrl {
+ *   @Deprecated()
+ *   @Get("/")
+ *   method(){
+ *   }
+ * }
+ * ```
+ *
+ * @param deprecated
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+export declare function Deprecated(deprecated?: boolean): (...args: any[]) => any;

package/lib/types-esm/decorators/operations/header.d.ts

@@ -0,0 +1,49 @@
+import { JsonHeader, JsonHeaders } from "../../interfaces/JsonOpenSpec.js";
+/**
+ * Sets the response’s HTTP header field to value. To set multiple fields at once, pass an object as the parameter.
+ *
+ * ```typescript
+ * @Header('Content-Type', 'text/plain');
+ * private myMethod() {}
+ *
+ * @Status(204)
+ * @Header({
+ *   "Content-Type": "text/plain",
+ *   "Content-Length": 123,
+ *   "ETag": {
+ *     "value": "12345",
+ *     "description": "header description"
+ *   }
+ * })
+ * private myMethod() {}
+ * ```
+ *
+ * This example will produce the swagger responses object:
+ *
+ * ```json
+ * {
+ *   "responses": {
+ *     "204": {
+ *       "description": "Description",
+ *       "headers": {
+ *          "Content-Type": {
+ *             "type": "string"
+ *          },
+ *          "Content-Length": {
+ *             "type": "number"
+ *          },
+ *          "ETag": {
+ *             "type": "string",
+ *             "description": "header description"
+ *          }
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @decorator
+ * @operation
+ * @response
+ */
+export declare function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader): Function;

package/lib/types-esm/decorators/operations/in.d.ts

@@ -0,0 +1,64 @@
+import { Type } from "@tsed/core";
+import { JsonParameterTypes } from "../../domain/JsonParameterTypes.js";
+import { JsonSchema, JsonSchemaObject } from "../../domain/JsonSchema.js";
+export interface InChainedDecorators {
+    <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
+    (target: Object, propertyKey: string | symbol, parameterIndex: number): void;
+    (target: Function): void;
+    /**
+     * Type of this in parameter
+     * @param type
+     */
+    Type(type: Type<any>): this;
+    /**
+     *
+     * @param name
+     */
+    Name(name: string): this;
+    /**
+     *
+     * @param description
+     */
+    Description(description: string): this;
+    /**
+     *
+     * @param required
+     */
+    Required(required?: boolean): this;
+    /**
+     * Add pattern constraint. Only available for OPENAPI.
+     * @param pattern
+     */
+    Pattern(pattern: string | RegExp): this;
+    /**
+     * Add custom schema.
+     * @param schema
+     */
+    Schema(schema: Partial<JsonSchemaObject | JsonSchema>): this;
+}
+/**
+ * Add a input parameter.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application to decorate parameters. Use @@BodyParams@@, @@PathParams@@, etc... instead.
+ * But you can use this decorator on Method, to add extra in parameters like Authorization header.
+ *
+ * ```typescript
+ * @Controller("/")
+ * class MyController {
+ *    @Get("/")
+ *    @In("header").Type(String).Name("Authorization").Required()
+ *    method() {
+ *    }
+ *  }
+ * ```
+ * :::
+ *
+ * @param inType
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @operation
+ */
+export declare function In(inType: JsonParameterTypes | string): InChainedDecorators;

package/lib/types-esm/decorators/operations/inFile.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Add a input file parameter.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application to decorate parameters. Use @@BodyParams@@, @@PathParams@@, etc... instead.
+ * But you can use this decorator on Method, to add extra in parameters like Authorization header.
+ *
+ * ```typescript
+ * @Controller("/")
+ * class MyController {
+ *    @Post("/")
+ *    method(@InFile("file1") file: any) {
+ *    }
+ *  }
+ * ```
+ * :::
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @operation
+ * @param name
+ */
+export declare function InFile(name: string): ParameterDecorator;

package/lib/types-esm/decorators/operations/location.d.ts

@@ -0,0 +1,22 @@
+import { JsonHeader } from "../../interfaces/JsonOpenSpec.js";
+/**
+ * Sets the response Location HTTP header to the specified path parameter.
+ *
+ * ```typescript
+ *  @Location('/foo/bar', {description: 'Location to the next step'})
+ *  @Location('http://example.com')
+ *  @Location('back')
+ *  private myMethod() {
+ *
+ *  }
+ * ```
+ *
+ * A path value of “back” has a special meaning, it refers to the URL specified in the `Referer` header of the request. If the `Referer` header was not specified, it refers to “/”.
+ *
+ * @param location
+ * @param meta
+ * @returns {Function}
+ * @decorator
+ * @operation
+ */
+export declare function Location(location: string, meta?: JsonHeader): import("./returns.js").ReturnsChainedDecorators;

package/lib/types-esm/decorators/operations/operation.d.ts

@@ -0,0 +1,60 @@
+import { OperationVerbs } from "../../constants/OperationVerbs.js";
+export interface RouteChainedDecorators {
+    <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
+    /**
+     * @param string
+     * @constructor
+     */
+    Path(string: string): this;
+    /**
+     * Set the operation method
+     * @param method
+     */
+    Method(method: OperationVerbs | string): this;
+    /**
+     * Set the operation id
+     * @param id
+     */
+    Id(id: string): this;
+    /**
+     * Set the operation id
+     * @param name
+     */
+    Name(name: string): this;
+    /**
+     *
+     * @param description
+     */
+    Description(description: string): this;
+    /**
+     * Summary
+     * @constructor
+     * @param Summary
+     */
+    Summary(Summary: string): this;
+    Use(...args: any[]): this;
+    UseAfter(...args: any[]): this;
+    UseBefore(...args: any[]): this;
+}
+/**
+ * Describe a new route with a method and path.
+ *
+ * ```typescript
+ * @Controller('/')
+ * export class Ctrl {
+ *
+ *    @Route('GET', '/')
+ *    get() { }
+ * }
+ *
+ * ```
+ *
+ * @returns {Function}
+ * @param method
+ * @param path
+ * @param args
+ * @decorator
+ * @operation
+ */
+export declare function Operation(method: string, path: string, ...args: any[]): RouteChainedDecorators;
+export declare function Operation(...args: any[]): RouteChainedDecorators;

package/lib/types-esm/decorators/operations/operationId.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Set a swagger operationId explicitly.
+ *
+ * @param operationId
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+export declare function OperationId(operationId: string): (...args: any[]) => any;

package/lib/types-esm/decorators/operations/operationPath.d.ts

@@ -0,0 +1,21 @@
+import { OperationVerbs } from "../../constants/OperationVerbs.js";
+/**
+ * Declare new Operation with his path and http method.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application.
+ *
+ * Use theses decorators instead:
+ *
+ * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
+ *
+ * :::
+ *
+ * @param method
+ * @param path
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+export declare function OperationPath(method: OperationVerbs | string, path?: string | RegExp): (...args: any[]) => any;

package/lib/types-esm/decorators/operations/partial.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Apply Partial group strategy on the input model
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export declare function Partial(): ParameterDecorator;

package/lib/types-esm/decorators/operations/path.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Set class path to expose all endpoints
+ *
+ * ::: warning
+ * Don't use this decorator to change the path if you develop your application with Ts.ED.
+ * :::
+ *
+ * @param path
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @operation
+ */
+export declare function Path(path: string): (...args: any[]) => any;