@tsed/schema 7.0.0-beta.2 → 7.0.0-beta.20

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

@@ -1,269 +1,8 @@
 export declare const HTTP_STATUS_MESSAGES: {
-    "100": {
+    [x: string]: {
         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;
     };

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

@@ -2,6 +2,10 @@ 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/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/types/decorators/common/jsonEntityFn.d.ts

@@ -1,5 +1,5 @@
 import { DecoratorParameters } from "@tsed/core";
-import type { JsonEntityStore } from "../../domain";
+import type { JsonEntityStore } from "../../domain/JsonEntityStore";
 /**
  * Decorator util to compose another decorator. See @@Description@@ decorator implementation for more details.
  *

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

@@ -2,6 +2,10 @@ 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/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/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/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/returns.d.ts

@@ -87,11 +87,16 @@ export interface ReturnsChainedDecorators {
      */
     Title(title: string): this;
     /**
-     *
+     * Use group to filter model
      * @param groups
-     * @constructor
      */
     Groups(...groups: string[]): this;
+    /**
+     * Add a list of allowed groups to filter dynamically fields. Listed groups can be used by the consumer to change
+     * the mapped response.
+     * @param allowedGroups
+     */
+    AllowedGroups(...allowedGroups: string[]): this;
     [key: string]: any;
 }
 /**

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/types/domain/JsonEntityStore.d.ts

@@ -132,5 +132,6 @@ export declare abstract class JsonEntityStore implements JsonEntityStoreOptions
     set(key: string, value?: any): Store;
     protected abstract build(): void;
     protected buildType(type: any): void;
+    toString(): string;
     static get(target: Type<any>, propertyKey: string | symbol, descriptor?: any): JsonEntityStore;
 }

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

@@ -1,4 +1,4 @@
-import { JsonSchemaOptions } from "../interfaces";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
 export declare class JsonMap<T> extends Map<string, any> {
     [key: string]: any;
     constructor(obj?: Partial<T>);

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

@@ -1,13 +1,21 @@
+import { Type } from "@tsed/core";
+import type { JsonClassStore } from "./JsonClassStore";
 import { JsonEntityStore, JsonEntityStoreOptions } from "./JsonEntityStore";
 import { JsonOperation } from "./JsonOperation";
 import type { JsonParameterStore } from "./JsonParameterStore";
-import type { JsonClassStore } from "./JsonClassStore";
+export interface JsonViewOptions {
+    path: string;
+    options: any;
+}
+export interface JsonRedirectOptions {
+    status: number | undefined;
+    url: string;
+}
 export declare class JsonMethodStore extends JsonEntityStore {
     readonly parent: JsonClassStore;
     middlewares: any[];
     beforeMiddlewares: any[];
     afterMiddlewares: any[];
-    constructor(options: JsonEntityStoreOptions);
     /**
      * Ref to JsonOperation when the decorated object is a method.
      */
@@ -16,10 +24,25 @@ export declare class JsonMethodStore extends JsonEntityStore {
      * List of children JsonEntityStore (properties or methods or params)
      */
     readonly children: Map<string | number, JsonParameterStore>;
+    constructor(options: JsonEntityStoreOptions);
+    get params(): JsonParameterStore[];
+    get view(): JsonViewOptions;
+    set view(view: JsonViewOptions);
+    get acceptMimes(): string[];
+    set acceptMimes(mimes: string[]);
     get parameters(): JsonParameterStore[];
     get operationPaths(): Map<string, import("./JsonOperation").JsonMethodPath>;
-    getResponseOptions(status: number, contentType?: string): undefined | any;
-    protected build(): void;
+    /**
+     * Get an endpoint.
+     * @param target
+     * @param propertyKey
+     * @param descriptor
+     */
+    static get(target: Type<any>, propertyKey: string | symbol, descriptor?: PropertyDescriptor): JsonMethodStore;
+    getResponseOptions(status: number, { contentType, includes }?: {
+        contentType?: string;
+        includes?: string[];
+    }): undefined | any;
     /**
      * Append middlewares to the beforeMiddlewares list.
      * @param args
@@ -37,4 +60,33 @@ export declare class JsonMethodStore extends JsonEntityStore {
      * @param args
      */
     use(args: Function[]): this;
+    /**
+     * Find the value at the controller level. Let this value be extended or overridden by the endpoint itself.
+     *
+     * @param key
+     * @returns {any}
+     */
+    get<T = any>(key: any): T;
+    getParamTypes(): Record<string, boolean>;
+    protected build(): void;
 }
+/**
+ * EndpointMetadata contains metadata about a controller and his method.
+ * Each annotation (@Get, @Body...) attached to a method are stored into endpoint.
+ * EndpointMetadata convert this metadata to an array which contain arguments to call an Express method.
+ *
+ * Example :
+ *```typescript
+ * @Controller("/my-path")
+ * provide MyClass {
+ *
+ *     @Get("/")
+ *     @Authenticated()
+ *     public myMethod(){}
+ * }
+ *```
+ *
+ * @alias JsonMethodStore
+ */
+export declare type EndpointMetadata = JsonMethodStore;
+export declare const EndpointMetadata: typeof JsonMethodStore;

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

@@ -1,5 +1,6 @@
 import { OpenSpecSecurity, OpenSpecTag, OS3Operation } from "@tsed/openspec";
-import { JsonHeader, JsonSchemaOptions } from "../interfaces";
+import { JsonHeader } from "../interfaces/JsonOpenSpec";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
 import { JsonMap } from "./JsonMap";
 import { JsonParameter } from "./JsonParameter";
 import { JsonResponse } from "./JsonResponse";
@@ -7,7 +8,6 @@ import { JsonSchema } from "./JsonSchema";
 export interface JsonMethodPath {
     path: string | RegExp;
     method: string;
-    isFinal?: boolean;
     [key: string]: any;
 }
 export interface JsonOperationOptions extends OS3Operation<JsonSchema, JsonParameter, JsonMap<JsonResponse>> {

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

@@ -2,6 +2,4 @@ import { JsonMethodPath } from "./JsonOperation";
 export declare class JsonOperationPathsMap extends Map<string, JsonMethodPath> {
     setOperationPath(operationPath: JsonMethodPath): void;
     protected getKey: (method: string, path: any) => string;
-    protected updateFinalRouteState(key: string): void;
-    protected setFinalRoute(key: string, operationPath: JsonMethodPath): void;
 }

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

@@ -1,24 +1,25 @@
 import { Type } from "@tsed/core";
+import { JsonMethodStore } from "./JsonMethodStore";
 import { JsonMethodPath, JsonOperation } from "./JsonOperation";
-import { JsonEntityStore } from "./JsonEntityStore";
-export declare class JsonOperationRoute<Entity extends JsonEntityStore = JsonEntityStore> {
+export declare class JsonOperationRoute<Entity extends JsonMethodStore = JsonMethodStore> {
     readonly token: Type<any>;
     readonly endpoint: Entity;
     readonly operationPath?: JsonMethodPath;
     readonly basePath?: string;
+    readonly paramsTypes: Record<string, boolean>;
     constructor(options: Partial<JsonOperationRoute>);
-    get url(): string;
+    get url(): any;
     get path(): string | RegExp | undefined;
-    get fullPath(): string;
+    get fullPath(): any;
     get method(): string;
-    get isFinal(): boolean;
     get name(): string;
     get className(): string;
     get methodClassName(): string;
-    get parameters(): any;
+    get parameters(): import("./JsonParameterStore").JsonParameterStore[];
     get propertyKey(): string;
     get propertyName(): string;
     get store(): import("@tsed/core").Store;
     get operation(): JsonOperation;
     get operationId(): any;
+    has(key: string): boolean;
 }

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

@@ -1,6 +1,6 @@
 import { Type } from "@tsed/core";
 import { OpenSpecHash, OpenSpecRef, OS3Example, OS3Parameter } from "@tsed/openspec";
-import { JsonSchemaOptions } from "../interfaces";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
 import { NestedGenerics } from "../utils/generics";
 import { JsonMap } from "./JsonMap";
 import { JsonSchema } from "./JsonSchema";
@@ -18,5 +18,6 @@ export declare class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> imp
     schema(schema: JsonSchema): this;
     toJSON(options?: JsonSchemaOptions): any;
     private build;
+    private getFileSchema;
     private refToParameters;
 }

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

@@ -1,14 +1,30 @@
 import { Type } from "@tsed/core";
-import { JsonEntityStore } from "./JsonEntityStore";
+import { JsonEntityStore, JsonEntityStoreOptions } from "./JsonEntityStore";
 import type { JsonMethodStore } from "./JsonMethodStore";
 import { JsonParameter } from "./JsonParameter";
 import { JsonSchema } from "./JsonSchema";
+export interface JsonParameterStoreOptions extends JsonEntityStoreOptions {
+    dataPath?: string;
+    paramType?: string;
+    expression?: string;
+}
+export interface PipeMethods<T = any, R = any> {
+    transform(value: T, metadata: JsonParameterStore): R;
+}
 export declare class JsonParameterStore extends JsonEntityStore {
+    paramType: string;
+    expression: string;
+    dataPath: string;
+    /**
+     * Define pipes can be called by the framework to transform input parameter
+     */
+    pipes: Type<PipeMethods>[];
     /**
      * Ref to JsonParameter when the decorated object is a parameter.
      */
     readonly parameter: JsonParameter;
     readonly parent: JsonMethodStore;
+    constructor(options: JsonParameterStoreOptions);
     get nestedGenerics(): Type<any>[][];
     set nestedGenerics(nestedGenerics: Type<any>[][]);
     /**
@@ -19,6 +35,7 @@ export declare class JsonParameterStore extends JsonEntityStore {
     set required(value: boolean);
     get allowedRequiredValues(): any[];
     static getParams<T extends JsonParameterStore = JsonParameterStore>(target: Type<any>, propertyKey: string | symbol): T[];
+    static get(target: Type<any>, propertyKey: string | symbol, index: number): JsonParameterStore;
     /**
      * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
      * @param value
@@ -28,3 +45,8 @@ export declare class JsonParameterStore extends JsonEntityStore {
     protected getSchema(type: any): JsonSchema;
     protected build(): void;
 }
+/**
+ * @alias JsonParameterStore
+ */
+export declare type ParamMetadata = JsonParameterStore;
+export declare const ParamMetadata: typeof JsonParameterStore;

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

@@ -1,3 +1,4 @@
+import { Type } from "@tsed/core";
 import { JsonEntityStore } from "./JsonEntityStore";
 import type { JsonClassStore } from "./JsonClassStore";
 export declare class JsonPropertyStore extends JsonEntityStore {
@@ -20,4 +21,10 @@ export declare class JsonPropertyStore extends JsonEntityStore {
      */
     isRequired(value: any): boolean;
     protected build(): void;
+    static get(target: Type<any>, propertyKey: string | symbol): JsonPropertyStore;
 }
+/**
+ * @alias JsonPropertyStore
+ */
+export declare type PropertyMetadata = JsonPropertyStore;
+export declare const PropertyMetadata: typeof JsonPropertyStore;

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

@@ -1,10 +1,12 @@
 import { OS3MediaType, OS3Response } from "@tsed/openspec";
-import { JsonHeader, JsonSchemaOptions } from "../interfaces";
+import { JsonHeader } from "../interfaces/JsonOpenSpec";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
 import { JsonMap } from "./JsonMap";
 import { JsonSchema } from "./JsonSchema";
 export declare type JsonResponseOptions = OS3Response<JsonSchema, string | JsonHeader>;
 export declare class JsonMedia extends JsonMap<OS3MediaType<JsonSchema>> {
     groups: string[];
+    allowedGroups?: Set<string>;
     schema(schema: JsonSchema): this;
     examples(examples: any): this;
     toJSON(options?: JsonSchemaOptions): any;