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

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

@@ -0,0 +1,272 @@
+export declare const HTTP_STATUS_MESSAGES: {
+    "100": {
+        label: string;
+        code: string;
+    };
+    "101": {
+        label: string;
+        code: string;
+    };
+    "102": {
+        label: string;
+        code: string;
+    };
+    "103": {
+        label: string;
+        code: string;
+    };
+    "200": {
+        label: string;
+        code: string;
+    };
+    "201": {
+        label: string;
+        code: string;
+    };
+    "202": {
+        label: string;
+        code: string;
+    };
+    "203": {
+        label: string;
+        code: string;
+    };
+    "204": {
+        label: string;
+        code: string;
+    };
+    "205": {
+        label: string;
+        code: string;
+    };
+    "206": {
+        label: string;
+        code: string;
+    };
+    "207": {
+        label: string;
+        code: string;
+    };
+    "208": {
+        label: string;
+        code: string;
+    };
+    "226": {
+        label: string;
+        code: string;
+    };
+    "300": {
+        label: string;
+        code: string;
+    };
+    "301": {
+        label: string;
+        code: string;
+    };
+    "302": {
+        label: string;
+        code: string;
+    };
+    "303": {
+        label: string;
+        code: string;
+    };
+    "304": {
+        label: string;
+        code: string;
+    };
+    "305": {
+        label: string;
+        code: string;
+    };
+    "306": {
+        label: string;
+        code: string;
+    };
+    "307": {
+        label: string;
+        code: string;
+    };
+    "308": {
+        label: string;
+        code: string;
+    };
+    "310": {
+        label: string;
+        code: string;
+    };
+    "400": {
+        label: string;
+        code: string;
+    };
+    "401": {
+        label: string;
+        code: string;
+    };
+    "402": {
+        label: string;
+        code: string;
+    };
+    "403": {
+        label: string;
+        code: string;
+    };
+    "404": {
+        label: string;
+        code: string;
+    };
+    "405": {
+        label: string;
+        code: string;
+    };
+    "406": {
+        label: string;
+        code: string;
+    };
+    "407": {
+        label: string;
+        code: string;
+    };
+    "408": {
+        label: string;
+        code: string;
+    };
+    "409": {
+        label: string;
+        code: string;
+    };
+    "410": {
+        label: string;
+        code: string;
+    };
+    "411": {
+        label: string;
+        code: string;
+    };
+    "412": {
+        label: string;
+        code: string;
+    };
+    "413": {
+        label: string;
+        code: string;
+    };
+    "414": {
+        label: string;
+        code: string;
+    };
+    "415": {
+        label: string;
+        code: string;
+    };
+    "416": {
+        label: string;
+        code: string;
+    };
+    "417": {
+        label: string;
+        code: string;
+    };
+    "418": {
+        label: string;
+        code: string;
+    };
+    "421": {
+        label: string;
+        code: string;
+    };
+    "422": {
+        label: string;
+        code: string;
+    };
+    "423": {
+        label: string;
+        code: string;
+    };
+    "424": {
+        label: string;
+        code: string;
+    };
+    "425": {
+        label: string;
+        code: string;
+    };
+    "426": {
+        label: string;
+        code: string;
+    };
+    "427": {
+        label: string;
+        code: string;
+    };
+    "428": {
+        label: string;
+        code: string;
+    };
+    "429": {
+        label: string;
+        code: string;
+    };
+    "430": {
+        label: string;
+        code: string;
+    };
+    "431": {
+        label: string;
+        code: string;
+    };
+    "451": {
+        label: string;
+        code: string;
+    };
+    "500": {
+        label: string;
+        code: string;
+    };
+    "501": {
+        label: string;
+        code: string;
+    };
+    "502": {
+        label: string;
+        code: string;
+    };
+    "503": {
+        label: string;
+        code: string;
+    };
+    "504": {
+        label: string;
+        code: string;
+    };
+    "505": {
+        label: string;
+        code: string;
+    };
+    "506": {
+        label: string;
+        code: string;
+    };
+    "507": {
+        label: string;
+        code: string;
+    };
+    "508": {
+        label: string;
+        code: string;
+    };
+    "509": {
+        label: string;
+        code: string;
+    };
+    "510": {
+        label: string;
+        code: string;
+    };
+    "511": {
+        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/anyOf.d.ts

@@ -2,10 +2,6 @@ import { AnyJsonSchema } from "../../domain/JsonSchema";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
  *
- * ::: warning
- * AnyOf isn't supported by OS2
- * :::
- *
  * @decorator
  * @validation
  * @swagger

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/jsonEntityFn.d.ts

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

@@ -2,10 +2,6 @@ import { AnyJsonSchema } from "../../domain/JsonSchema";
 /**
  * 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

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/{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/{decorators → types/decorators}/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./class/children";
 export * from "./collections/collectionContains";
 export * from "./collections/collectionOf";
 export * from "./collections/maxItems";
@@ -11,6 +12,7 @@ export * from "./operations/deprecated";
 export * from "./operations/consumes";
 export * from "./operations/contentType";
 export * from "./operations/in";
+export * from "./operations/inFile";
 export * from "./operations/operationId";
 export * from "./operations/operationPath";
 export * from "./operations/path";
@@ -24,6 +26,7 @@ export * from "./operations/summary";
 export * from "./operations/partial";
 export * from "./operations/redirect";
 export * from "./operations/location";
+export * from "./operations/route";
 export * from "./common/additionalProperties";
 export * from "./common/allow";
 export * from "./common/any";
@@ -32,6 +35,7 @@ export * from "./common/const";
 export * from "./common/default";
 export * from "./common/description";
 export * from "./common/example";
+export * from "./common/examples";
 export * from "./common/enum";
 export * from "./common/exclusiveMaximum";
 export * from "./common/exclusiveMinimum";

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;