@tsed/schema 6.97.2 → 6.98.3

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

@@ -1,7 +1,16 @@
+import { Type } from "@tsed/core";
 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[];
@@ -16,6 +25,11 @@ export declare class JsonMethodStore extends JsonEntityStore {
      * List of children JsonEntityStore (properties or methods or params)
      */
     readonly children: Map<string | number, JsonParameterStore>;
+    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;
@@ -37,4 +51,38 @@ 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;
+    /**
+     * Get an endpoint.
+     * @param target
+     * @param propertyKey
+     * @param descriptor
+     */
+    static get(target: Type<any>, propertyKey: string | symbol, descriptor?: PropertyDescriptor): JsonMethodStore;
 }
+/**
+ * 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/JsonOperationRoute.d.ts

@@ -1,11 +1,12 @@
 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 path(): string | RegExp | undefined;
@@ -15,10 +16,11 @@ export declare class JsonOperationRoute<Entity extends JsonEntityStore = JsonEnt
     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/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/JsonSchema.d.ts

@@ -218,7 +218,7 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
      *
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.23
      */
-    enum(enumValues: JSONSchema6Type[]): this;
+    enum(...enumValues: any[]): this;
     /**
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.1
      */

package/lib/types/utils/getOperationsRoutes.d.ts

@@ -1,8 +1,8 @@
 import { Type } from "@tsed/core";
+import { JsonMethodStore } from "../domain/JsonMethodStore";
 import { JsonOperationRoute } from "../domain/JsonOperationRoute";
-import { JsonEntityStore } from "../domain/JsonEntityStore";
 export interface GetOperationsRoutesOptions {
     withChildren?: boolean;
     basePath?: string;
 }
-export declare function getOperationsRoutes<Entity extends JsonEntityStore = JsonEntityStore>(token: Type<any> | any, options?: GetOperationsRoutesOptions): JsonOperationRoute<Entity>[];
+export declare function getOperationsRoutes<Entity extends JsonMethodStore = JsonMethodStore>(token: Type<any> | any, options?: GetOperationsRoutesOptions): JsonOperationRoute<Entity>[];

package/lib/types/utils/mapNullableType.d.ts

@@ -1,3 +1,3 @@
 import type { JsonSchema } from "../domain/JsonSchema";
 import type { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
-export declare function mapNullableType(obj: any, schema: JsonSchema, options: JsonSchemaOptions): any;
+export declare function mapNullableType(obj: any, schema: JsonSchema | null, options: JsonSchemaOptions): any;

package/lib/types/utils/serializeEnumValues.d.ts

@@ -0,0 +1,5 @@
+export declare const serializeEnum: (enumValue: any) => any;
+export declare function serializeEnumValues(enumValues: any[]): {
+    values: any[];
+    types: any;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/schema",
-  "version": "6.97.2",
+  "version": "6.98.3",
   "description": "JsonSchema module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
@@ -16,7 +16,7 @@
     "build": "yarn run build:esm && yarn run build:cjs",
     "build:cjs": "tsc --build tsconfig.compile.json",
     "build:esm": "tsc --build tsconfig.compile.esm.json",
-    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2 --coverage"
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2"
   },
   "keywords": [
     "TypeScript",
@@ -29,11 +29,11 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/core": "6.97.2",
-    "@tsed/openspec": "6.97.2",
+    "@tsed/core": "6.98.3",
+    "@tsed/openspec": "6.98.3",
     "camel-case": "4.1.2",
     "json-schema": "0.4.0",
-    "micromatch": "4.0.2",
+    "micromatch": "4.0.4",
     "pascal-case": "3.1.2",
     "tslib": "2.2.0"
   },
@@ -45,8 +45,8 @@
     "fs-extra": "9.0.1"
   },
   "peerDependencies": {
-    "@tsed/core": "^6.97.2",
-    "@tsed/openspec": "^6.97.2"
+    "@tsed/core": "^6.98.3",
+    "@tsed/openspec": "^6.98.3"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {