@tsed/schema 6.80.1 → 6.81.0

package/benchmark/cold-start.js

@@ -0,0 +1,17 @@
+function printMemory(event) {
+  const used = process.memoryUsage();
+  const obj = {event};
+
+  for (let key in used) {
+    // console.log(`${key} ${} MB`);
+    obj[key] = Math.round((used[key] / 1024 / 1024) * 100) / 100;
+  }
+
+  obj.timestamp = Date.now();
+
+  console.log(JSON.stringify(obj));
+}
+console.time("benchmark");
+require("@tsed/schema");
+console.timeEnd("benchmark");
+printMemory();

package/lib/constants/httpStatusMessages.d.ts

@@ -1,5 +1,272 @@
 export declare const HTTP_STATUS_MESSAGES: {
-    [key: string]: string;
+    "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;
-export declare function getStatusMessage(status: number): string;
+export declare function getStatusConstant(status: number | string): any;
+export declare function getStatusMessage(status: number | string): any;

package/lib/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/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) => any): (...args: any[]) => any;
+export declare function JsonEntityFn<T extends JsonEntityStore = JsonEntityStore>(fn: (entity: T, parameters: DecoratorParameters) => any): (...args: any[]) => any;

package/lib/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;
+}

package/lib/domain/JsonEntityStore.d.ts

@@ -1,45 +1,101 @@
-import { Entity, EntityOptions, Store, Type } from "@tsed/core";
-import { JsonOperation } from "./JsonOperation";
-import { JsonParameter } from "./JsonParameter";
-import { JsonSchema } from "./JsonSchema";
-export interface JsonEntityStoreOptions extends EntityOptions {
+import { DecoratorTypes, Store, Type } from "@tsed/core";
+import type { JsonSchema } from "./JsonSchema";
+import type { JsonMethodStore } from "./JsonMethodStore";
+import type { JsonClassStore } from "./JsonClassStore";
+import type { JsonPropertyStore } from "./JsonPropertyStore";
+import type { JsonParameterStore } from "./JsonParameterStore";
+/**
+ * @ignore
+ */
+export declare const JsonEntitiesContainer: Map<DecoratorTypes, Type<JsonEntityStore>>;
+export interface JsonEntityStoreOptions {
+    decoratorType: DecoratorTypes;
+    target: Type<any>;
+    propertyKey?: string | symbol;
+    index?: number;
+    descriptor?: any;
+    type?: Type<any>;
+    collectionType?: Type<any>;
     [key: string]: any;
 }
-export declare class JsonEntityStore extends Entity implements JsonEntityStoreOptions {
+export declare abstract class JsonEntityStore implements JsonEntityStoreOptions {
+    /**
+     * Original property key decorated by the decorator
+     */
+    readonly propertyKey: string | symbol;
+    /**
+     * Alias of the property
+     */
+    readonly propertyName: string;
+    /**
+     * Parameter index
+     */
+    readonly index: number;
+    /**
+     * Method's descriptor
+     */
+    readonly descriptor: number;
+    /**
+     * Decorator type used to declare the JsonSchemaStore.
+     */
+    readonly decoratorType: DecoratorTypes;
+    /**
+     * Type of the collection (Array, Map, Set, etc...)
+     */
+    collectionType: Type<any>;
+    token: Type<any>;
     readonly store: Store;
     readonly isStore = true;
+    readonly parent: JsonEntityStore;
+    readonly target: Type<any>;
     /**
-     * List of children JsonEntityStore (properties or methods or params)
+     *
      */
-    readonly children: Map<string | number, JsonEntityStore>;
+    protected _type: Type<any>;
     /**
      * Ref to JsonSchema
      */
     protected _schema: JsonSchema;
+    [key: string]: any;
+    constructor(options: JsonEntityStoreOptions);
     /**
-     * Ref to JsonOperation when the decorated object is a method.
+     * Return the class name of the entity.
+     * @returns {string}
      */
-    protected _operation: JsonOperation;
+    get targetName(): string;
     /**
-     * Ref to JsonParameter when the decorated object is a parameter.
+     *
+     * @returns {boolean}
      */
-    protected _parameter: JsonParameter;
-    [key: string]: any;
-    constructor(options: JsonEntityStoreOptions);
-    get path(): string;
-    set path(path: string);
+    get isCollection(): boolean;
     /**
-     * Return the JsonSchema
+     *
+     * @returns {boolean}
      */
-    get schema(): JsonSchema;
+    get isArray(): boolean;
+    /**
+     *
+     * @returns {boolean}
+     */
+    get isPrimitive(): boolean;
+    /**
+     *
+     * @returns {boolean}
+     */
+    get isDate(): boolean;
+    /**
+     *
+     * @returns {boolean}
+     */
+    get isObject(): boolean;
     /**
-     * Return the JsonOperation
+     *
      */
-    get operation(): JsonOperation | undefined;
+    get isClass(): boolean;
     /**
-     * Return the JsonParameter
+     * Return the JsonSchema
      */
-    get parameter(): JsonParameter | undefined;
+    get schema(): JsonSchema;
     get nestedGenerics(): Type<any>[][];
     set nestedGenerics(nestedGenerics: Type<any>[][]);
     /**
@@ -59,34 +115,18 @@ export declare class JsonEntityStore extends Entity implements JsonEntityStoreOp
     get computedType(): any;
     get itemSchema(): JsonSchema;
     get parentSchema(): JsonSchema;
-    get parent(): JsonEntityStore;
-    /**
-     * Return the required state.
-     * @returns {boolean}
-     */
-    get required(): boolean;
-    /**
-     * Change the state of the required data.
-     * @param value
-     */
-    set required(value: boolean);
-    get allowedRequiredValues(): any[];
     /**
      *
-     * @param args
+     * @param target
      */
+    static from<T extends JsonClassStore = JsonClassStore>(target: Type<any>): T;
+    static from<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any, propertyKey: string | symbol): T;
+    static from<T extends JsonParameterStore = JsonParameterStore>(target: Type<any> | any, propertyKey: string | symbol, index: number): T;
+    static from<T extends JsonMethodStore = JsonMethodStore>(target: Type<any> | any, propertyKey: string | symbol, descriptor: PropertyDescriptor): T;
     static from<T extends JsonEntityStore = JsonEntityStore>(...args: any[]): T;
-    static fromMethod(target: any, propertyKey: string | symbol): JsonEntityStore;
+    static fromMethod<T extends JsonMethodStore = JsonMethodStore>(target: any, propertyKey: string | symbol): T;
     get<T = any>(key: string, defaultValue?: any): T;
-    getResponseOptions(status: number, contentType?: string): undefined | any;
-    /**
-     * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
-     * @param value
-     * @returns {boolean}
-     */
-    isRequired(value: any): boolean;
-    protected build(): void;
-    protected createProperty(): any;
-    protected createOperation(): JsonOperation;
-    protected createParameter(): JsonParameter;
+    set(key: string, value?: any): Store;
+    protected abstract build(): void;
+    protected buildType(type: any): void;
 }

package/lib/domain/JsonMethodStore.d.ts

@@ -0,0 +1,19 @@
+import { JsonEntityStore } from "./JsonEntityStore";
+import { JsonOperation } from "./JsonOperation";
+import type { JsonParameterStore } from "./JsonParameterStore";
+import type { JsonClassStore } from "./JsonClassStore";
+export declare class JsonMethodStore extends JsonEntityStore {
+    readonly parent: JsonClassStore;
+    /**
+     * Ref to JsonOperation when the decorated object is a method.
+     */
+    readonly operation: JsonOperation;
+    /**
+     * List of children JsonEntityStore (properties or methods or params)
+     */
+    readonly children: Map<string | number, JsonParameterStore>;
+    get parameters(): JsonParameterStore[];
+    get operationPaths(): Map<string, import("./JsonOperation").JsonMethodPath>;
+    getResponseOptions(status: number, contentType?: string): undefined | any;
+    protected build(): void;
+}

package/lib/domain/JsonOperationRoute.d.ts

@@ -1,5 +1,5 @@
 import { Type } from "@tsed/core";
-import { JsonMethodPath } from "./JsonOperation";
+import { JsonMethodPath, JsonOperation } from "./JsonOperation";
 import { JsonEntityStore } from "./JsonEntityStore";
 export declare class JsonOperationRoute<Entity extends JsonEntityStore = JsonEntityStore> {
     readonly token: Type<any>;
@@ -7,10 +7,18 @@ export declare class JsonOperationRoute<Entity extends JsonEntityStore = JsonEnt
     readonly operationPath?: JsonMethodPath;
     readonly basePath?: string;
     constructor(options: Partial<JsonOperationRoute>);
+    get url(): string;
     get path(): string | RegExp | undefined;
     get fullPath(): string;
     get method(): string;
     get isFinal(): boolean;
-    get propertyKey(): string | symbol;
+    get name(): string;
+    get className(): string;
+    get methodClassName(): string;
+    get parameters(): any;
+    get propertyKey(): string;
+    get propertyName(): string;
     get store(): import("@tsed/core").Store;
+    get operation(): JsonOperation;
+    get operationId(): any;
 }

package/lib/domain/JsonParameter.d.ts

@@ -8,6 +8,7 @@ export declare class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> imp
     nestedGenerics: Type<any>[][];
     groups: string[];
     $schema: JsonSchema;
+    expression: string;
     getName(): any;
     name(name: string): this;
     examples(examples: OpenSpecHash<OS3Example | OpenSpecRef>): this;

package/lib/domain/JsonParameterStore.d.ts

@@ -0,0 +1,30 @@
+import { Type } from "@tsed/core";
+import { JsonEntityStore } from "./JsonEntityStore";
+import type { JsonMethodStore } from "./JsonMethodStore";
+import { JsonParameter } from "./JsonParameter";
+import { JsonSchema } from "./JsonSchema";
+export declare class JsonParameterStore extends JsonEntityStore {
+    /**
+     * Ref to JsonParameter when the decorated object is a parameter.
+     */
+    readonly parameter: JsonParameter;
+    readonly parent: JsonMethodStore;
+    get nestedGenerics(): Type<any>[][];
+    set nestedGenerics(nestedGenerics: Type<any>[][]);
+    /**
+     * Return the required state.
+     * @returns {boolean}
+     */
+    get required(): boolean;
+    set required(value: boolean);
+    get allowedRequiredValues(): any[];
+    static getParams<T extends JsonParameterStore = JsonParameterStore>(target: Type<any>, propertyKey: string | symbol): T[];
+    /**
+     * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
+     * @param value
+     * @returns {boolean}
+     */
+    isRequired(value: any): boolean;
+    protected getSchema(type: any): JsonSchema;
+    protected build(): void;
+}

package/lib/domain/JsonPropertyStore.d.ts

@@ -0,0 +1,23 @@
+import { JsonEntityStore } from "./JsonEntityStore";
+import type { JsonClassStore } from "./JsonClassStore";
+export declare class JsonPropertyStore extends JsonEntityStore {
+    readonly parent: JsonClassStore;
+    /**
+     * Return the required state.
+     * @returns {boolean}
+     */
+    get required(): boolean;
+    /**
+     * Change the state of the required data.
+     * @param value
+     */
+    set required(value: boolean);
+    get allowedRequiredValues(): any[];
+    /**
+     * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
+     * @param value
+     * @returns {boolean}
+     */
+    isRequired(value: any): boolean;
+    protected build(): void;
+}

package/lib/domain/index.d.ts

@@ -7,6 +7,10 @@ export * from "./JsonSchema";
 export * from "./JsonFormatTypes";
 export * from "./SpecTypes";
 export * from "./JsonEntityStore";
+export * from "./JsonClassStore";
+export * from "./JsonMethodStore";
+export * from "./JsonParameterStore";
+export * from "./JsonPropertyStore";
 export * from "./JsonOperationRoute";
 export * from "./JsonParameterTypes";
 export * from "./JsonLazyRef";