@tsed/schema 7.0.0-alpha.1 → 7.0.0-beta.10

package/lib/types/constants/httpStatusMessages.d.ts

@@ -0,0 +1,11 @@
+export declare const HTTP_STATUS_MESSAGES: {
+    [x: string]: {
+        label: string;
+        code: string;
+    } | {
+        label: string;
+        code: string;
+    };
+};
+export declare function getStatusConstant(status: number | string): any;
+export declare function getStatusMessage(status: number | string): any;

package/lib/types/decorators/class/children.d.ts

@@ -0,0 +1,11 @@
+import { Type } from "@tsed/core";
+/**
+ * Add Children class to compose routes
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @param children
+ */
+export declare function Children(...children: Type<any>[]): ClassDecorator;

package/lib/{decorators → types/decorators}/collections/collectionOf.d.ts

@@ -31,7 +31,7 @@ export interface ArrayOfChainedDecorators {
     /**
      * If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.
      */
-    UniqueItems(uniqueItems: boolean): this;
+    UniqueItems(uniqueItems?: boolean): this;
 }
 export interface MapOfChainedDecorators {
     (...args: any): any;

package/lib/{decorators → types/decorators}/common/any.d.ts

@@ -1,5 +1,5 @@
 import { Type } from "@tsed/core";
-import { JSONSchema6TypeName } from "json-schema";
+import type { JSONSchema6TypeName } from "json-schema";
 /**
  * Set the type of the array items.
  *

package/lib/{decorators → types/decorators}/common/const.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema6Type } from "json-schema";
+import type { JSONSchema6Type } from "json-schema";
 /**
  * The const keyword is used to restrict a value to a fixed value.
  *

package/lib/{decorators → types/decorators}/common/enum.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema6Type } from "json-schema";
+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.

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

@@ -0,0 +1,12 @@
+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/{decorators → types/decorators}/common/ignore.d.ts

@@ -1,4 +1,4 @@
-import { IgnoreCallback } from "../../interfaces";
+import { IgnoreCallback } from "../../interfaces/IgnoreCallback";
 /**
  * Ignore the property when JsonMapper serialize the class to a Plain Object JavaScript.
  *

package/lib/{decorators → types/decorators}/common/jsonEntityFn.d.ts

@@ -1,5 +1,5 @@
 import { DecoratorParameters } from "@tsed/core";
-import { JsonEntityStore } from "../../domain";
+import type { JsonEntityStore } from "../../domain/JsonEntityStore";
 /**
  * Decorator util to compose another decorator. See @@Description@@ decorator implementation for more details.
  *
@@ -18,4 +18,4 @@ import { JsonEntityStore } from "../../domain";
  * @utils
  * @model
  */
-export declare function JsonEntityFn<T extends JsonEntityStore>(fn: (entity: T, parameters: DecoratorParameters) => void): (...args: any[]) => any;
+export declare function JsonEntityFn<T extends JsonEntityStore = JsonEntityStore>(fn: (entity: T, parameters: DecoratorParameters) => any): (...args: any[]) => any;

package/lib/{decorators → types/decorators}/common/nullable.d.ts

@@ -1,5 +1,5 @@
 import { Type } from "@tsed/core";
-import { JSONSchema6TypeName } from "json-schema";
+import type { JSONSchema6TypeName } from "json-schema";
 /**
  * Set field as nullable.
  *

package/lib/{decorators → types/decorators}/common/property.d.ts

@@ -6,5 +6,6 @@
  * @validation
  * @swagger
  * @schema
+ * @input
  */
 export declare function Property(type?: any): (...args: any[]) => any;

package/lib/types/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/{decorators → types/decorators}/common/requiredGroups.d.ts

@@ -7,4 +7,4 @@
  * @schema
  * @input
  */
-export declare function RequiredGroups(...groups: string[]): Function;
+export declare function RequiredGroups(...groups: string[]): PropertyDecorator;

package/lib/types/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/{decorators → types/decorators}/operations/in.d.ts

@@ -1,6 +1,6 @@
 import { Type } from "@tsed/core";
-import { JsonSchemaObject } from "../../domain";
 import { JsonParameterTypes } from "../../domain/JsonParameterTypes";
+import { JsonSchemaObject } from "../../domain/JsonSchema";
 export interface InChainedDecorators {
     <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
     (target: Object, propertyKey: string | symbol, parameterIndex: number): void;

package/lib/types/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/{decorators → types/decorators}/operations/operationPath.d.ts

@@ -1,14 +1,4 @@
-export declare enum OperationMethods {
-    ALL = "ALL",
-    GET = "GET",
-    POST = "POST",
-    PUT = "PUT",
-    PATCH = "PATCH",
-    HEAD = "HEAD",
-    DELETE = "DELETE",
-    OPTIONS = "OPTIONS",
-    CUSTOM = "CUSTOM"
-}
+import { OperationMethods } from "../../constants/httpMethods";
 /**
  * Declare new Operation with his path and http method.
  *

package/lib/{decorators → types/decorators}/operations/returns.d.ts

@@ -40,6 +40,21 @@ export interface ReturnsChainedDecorators {
      * @param types
      */
     Of(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    OneOf(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    AllOf(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    AnyOf(...types: GenericValue[]): this;
     /**
      * Declare a nested generic models
      * @param generics
@@ -235,4 +250,4 @@ export interface ReturnsChainedDecorators {
  * @response
  * @operation
  */
-export declare function Returns(status?: string | number, model?: Type<any>): ReturnsChainedDecorators;
+export declare function Returns(status?: string | number, model?: Type<any> | Type<any>[]): ReturnsChainedDecorators;

package/lib/types/decorators/operations/route.d.ts

@@ -0,0 +1,188 @@
+import { OperationMethods } from "../../constants/httpMethods";
+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: OperationMethods | 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 Route(method: string, path: string, ...args: any[]): RouteChainedDecorators;
+export declare function Route(...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function All(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Get(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Post(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Put(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Delete(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Head(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Patch(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;
+/**
+ * This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
+ *
+ * This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
+ * For example, if you placed the following route at the top of all other route definitions, it would require that
+ * all routes from that point on would require authentication, and automatically load a user.
+ * Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
+ * to continue matching subsequent routes.
+ * @param path
+ * @param args
+ * @returns {Function}
+ * @decorator
+ * @operation
+ * @httpMethod
+ */
+export declare function Options(path?: string | RegExp | any, ...args: any[]): RouteChainedDecorators;

package/lib/types/decorators/operations/view.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Use a view and sends the rendered HTML string to the client. Optional parameter:
+ *
+ * * viewOptions, an object whose properties define local variables for the view.
+ *
+ * The view argument is a string that is the file path of the view file to render.
+ * This can be an absolute path, or a path relative to the views setting.
+ * If the path does not contain a file extension, then the view engine setting determines the file extension.
+ * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())
+ * and render it using the loaded module’s __express function.
+ *
+ * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).
+ *
+ * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,
+ * and as so for security reasons should not contain input from the end-user.
+ *
+ * @param path Relative path to the view file.
+ * @param options Additional options
+ * @decorator
+ * @operation
+ * @response
+ */
+export declare function View(path: string, options?: Object): MethodDecorator;

package/lib/{domain → types/domain}/DecoratorContext.d.ts

@@ -12,12 +12,17 @@ export interface DecoratorActionHandler {
 export declare abstract class DecoratorContext<T = any> extends Map<string, any> {
     readonly methods: string[];
     protected decoratorType: DecoratorTypes;
-    protected store: JsonEntityStore;
+    protected entity: JsonEntityStore;
     protected actions: DecoratorActionHandler[];
+    constructor(opts?: any);
     addAction(cb: DecoratorActionHandler): this;
     build(): T;
     toObject(): any;
     getMergedKey(key: string, defaultValue: any): any;
-    protected abstract onInit(args: DecoratorParameters, decorator: any): void;
+    protected bind(args: DecoratorParameters, decorator: any): void;
+    protected onInit(args: DecoratorParameters, decorator: any): void;
+    protected onMapKey(key: string, value: any): void;
     protected runActions(): this;
+    protected beforeInit(): void;
+    protected afterInit(): void;
 }

package/lib/types/domain/JsonClassStore.d.ts

@@ -0,0 +1,12 @@
+import type { JsonMethodStore } from "./JsonMethodStore";
+import type { JsonPropertyStore } from "./JsonPropertyStore";
+import { JsonEntityStore } from "./JsonEntityStore";
+export declare class JsonClassStore extends JsonEntityStore {
+    /**
+     * List of children JsonEntityStore (properties or methods or params)
+     */
+    readonly children: Map<string | number, JsonMethodStore | JsonPropertyStore>;
+    get path(): string;
+    set path(path: string);
+    protected build(): void;
+}