@tsed/common 6.119.0 → 6.119.1

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

@@ -2,6 +2,7 @@
 import { ContextMethods, DIContext, DIContextOptions } from "@tsed/di";
 import { EndpointMetadata } from "@tsed/schema";
 import { IncomingMessage, ServerResponse } from "http";
+import { IncomingEvent } from "../interfaces/IncomingEvent";
 import { PlatformApplication } from "../services/PlatformApplication";
 import { PlatformRequest } from "../services/PlatformRequest";
 import { PlatformResponse } from "../services/PlatformResponse";
@@ -12,36 +13,40 @@ declare global {
     }
 }
 export interface PlatformContextOptions extends DIContextOptions {
-    event: {
-        response?: ServerResponse;
-        request?: IncomingMessage;
-    };
+    event: IncomingEvent;
     ignoreUrlPatterns?: any[];
     endpoint?: EndpointMetadata;
 }
-export declare class PlatformContext extends DIContext implements ContextMethods {
-    /**
-     * The current @@EndpointMetadata@@ resolved by Ts.ED during the request.
-     */
-    endpoint: EndpointMetadata;
+export declare class PlatformContext<PReq extends PlatformRequest = PlatformRequest, PRes extends PlatformResponse = PlatformResponse> extends DIContext implements ContextMethods {
+    #private;
+    event: IncomingEvent;
     /**
      * The data return by the previous endpoint if you use multiple handler on the same route. By default data is empty.
      */
     data: any;
+    /**
+     * The error caught by the current handler
+     */
+    error?: unknown;
     /**
      * The current @@PlatformResponse@@.
      */
-    readonly response: PlatformResponse;
+    readonly response: PRes;
     /**
      * The current @@PlatformRequest@@.
      */
-    readonly request: PlatformRequest;
+    readonly request: PReq;
     private ignoreUrlPatterns;
-    constructor({ event, endpoint, ignoreUrlPatterns, ResponseKlass, RequestKlass, ...options }: PlatformContextOptions);
+    constructor(options: PlatformContextOptions);
+    /**
+     * The current @@EndpointMetadata@@ resolved by Ts.ED during the request.
+     */
+    get endpoint(): EndpointMetadata;
+    set endpoint(endpoint: EndpointMetadata);
     get url(): string;
     get app(): PlatformApplication<TsED.Application, TsED.Router>;
     destroy(): Promise<void>;
-    isDone(): boolean;
+    isDone(): any;
     /**
      * Return the framework request instance (Express, Koa, etc...)
      */
@@ -62,4 +67,5 @@ export declare class PlatformContext extends DIContext implements ContextMethods
      * Return the original application instance.
      */
     getApp<T = any>(): T;
+    upgrade(event: IncomingEvent): void;
 }

package/lib/types/services/PlatformRequest.d.ts

@@ -1,12 +1,14 @@
 /// <reference types="node" />
 import { IncomingHttpHeaders, IncomingMessage } from "http";
 import type { PlatformContext } from "../domain/PlatformContext";
-import { IncomingEvent } from "../interfaces/IncomingEvent";
 import type { PlatformResponse } from "./PlatformResponse";
 declare global {
     namespace TsED {
         interface Request {
             id: string;
+            /**
+             * @deprecated
+             */
             $ctx: PlatformContext;
         }
     }
@@ -15,16 +17,16 @@ declare global {
  * Platform Request abstraction layer.
  * @platform
  */
-export declare class PlatformRequest<T extends {
+export declare class PlatformRequest<Req extends {
     [key: string]: any;
 } = any> {
-    protected $ctx: PlatformContext;
-    raw: T;
+    readonly $ctx: PlatformContext;
+    constructor($ctx: PlatformContext);
     /**
      * The current @@PlatformResponse@@.
      */
-    response: PlatformResponse;
-    constructor({ request }: IncomingEvent, $ctx: PlatformContext);
+    get response(): PlatformResponse;
+    get raw(): Req;
     get secure(): boolean;
     get host(): string;
     get protocol(): string;
@@ -76,7 +78,7 @@ export declare class PlatformRequest<T extends {
     /**
      * Return the original request framework instance
      */
-    get request(): T;
+    get request(): Req;
     /**
      * Return the original request node.js instance
      */
@@ -105,7 +107,7 @@ export declare class PlatformRequest<T extends {
     /**
      * Return the Framework response object (express, koa, etc...)
      */
-    getRequest<Req = T>(): Req;
+    getRequest<R = Req>(): R;
     /**
      * Return the Node.js response object
      */

package/lib/types/services/PlatformResponse.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
 import { OutgoingHttpHeaders, ServerResponse } from "http";
-import { IncomingEvent } from "../interfaces/IncomingEvent";
 import type { PlatformRequest } from "./PlatformRequest";
 import type { PlatformContext } from "../domain/PlatformContext";
 declare global {
@@ -14,15 +13,15 @@ export declare type HeaderValue = Array<boolean | number | string> | boolean | n
  * Platform Response abstraction layer.
  * @platform
  */
-export declare class PlatformResponse<T extends Record<string, any> = any> {
-    protected $ctx: PlatformContext;
+export declare class PlatformResponse<Res extends Record<string, any> = any> {
+    readonly $ctx: PlatformContext;
+    data: any;
+    constructor($ctx: PlatformContext);
     /**
      * The current @@PlatformRequest@@.
      */
-    request: PlatformRequest;
-    data: any;
-    raw: T;
-    constructor({ response }: IncomingEvent, $ctx: PlatformContext);
+    get request(): PlatformRequest;
+    get raw(): Res;
     /**
      * Get the current statusCode
      */
@@ -36,7 +35,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
     /**
      * Return the original response framework instance
      */
-    get response(): T;
+    get response(): Res;
     /**
      * Return the original response node.js instance
      */
@@ -56,7 +55,7 @@ export declare class PlatformResponse<T extends Record<string, any> = any> {
     /**
      * Return the Framework response object (express, koa, etc...)
      */
-    getResponse<Res = T>(): Res;
+    getResponse<R = Res>(): R;
     /**
      * Return the Node.js response object
      */

package/lib/types/services/PlatformTest.d.ts

@@ -1,5 +1,5 @@
-import { DITest, DITestOptions, InjectorService } from "@tsed/di";
 import { Type } from "@tsed/core";
+import { DITest, DITestOptions, InjectorService } from "@tsed/di";
 import { PlatformContext, PlatformContextOptions } from "../domain/PlatformContext";
 import { PlatformAdapter, PlatformBuilderSettings } from "./PlatformAdapter";
 /**
@@ -54,5 +54,5 @@ export declare class PlatformTest extends DITest {
     static callback(): any;
     static createRequest(options?: any): any;
     static createResponse(options?: any): any;
-    static createRequestContext(options?: Partial<PlatformContextOptions & any>): PlatformContext;
+    static createRequestContext(options?: Partial<PlatformContextOptions & any>): PlatformContext<import("./PlatformRequest").PlatformRequest<any>, import("./PlatformResponse").PlatformResponse<any>>;
 }

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

@@ -1,9 +1,12 @@
 import { InjectorService } from "@tsed/di";
 import { PlatformContext } from "../domain/PlatformContext";
+import { PlatformRequest } from "../services/PlatformRequest";
+import { PlatformResponse } from "../services/PlatformResponse";
 import { IncomingEvent } from "../interfaces/IncomingEvent";
+export declare function ignoreLog(ignoreUrlPatterns: any[] | undefined): ((ignore: boolean, data: any, url: string) => any) | undefined;
 /**
  * Create the TsED context to wrap request, response, injector, etc...
  * @param injector
  * @ignore
  */
-export declare function createContext(injector: InjectorService): (event: IncomingEvent) => Promise<PlatformContext>;
+export declare function createContext(injector: InjectorService): (event: IncomingEvent) => Promise<PlatformContext<PlatformRequest<any>, PlatformResponse<any>>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/common",
-  "version": "6.119.0",
+  "version": "6.119.1",
   "description": "A TypeScript Framework on top of Express",
   "private": false,
   "source": "./src/index.ts",
@@ -62,22 +62,22 @@
     }
   ],
   "dependencies": {
-    "@tsed/components-scan": "6.119.0",
-    "@tsed/core": "6.119.0",
-    "@tsed/di": "6.119.0",
-    "@tsed/exceptions": "6.119.0",
-    "@tsed/json-mapper": "6.119.0",
+    "@tsed/components-scan": "6.119.1",
+    "@tsed/core": "6.119.1",
+    "@tsed/di": "6.119.1",
+    "@tsed/exceptions": "6.119.1",
+    "@tsed/json-mapper": "6.119.1",
     "@tsed/logger": ">=6.2.0",
     "@tsed/logger-file": ">=6.2.0",
-    "@tsed/perf": "6.119.0",
-    "@tsed/platform-cache": "6.119.0",
-    "@tsed/platform-exceptions": "6.119.0",
-    "@tsed/platform-log-middleware": "6.119.0",
-    "@tsed/platform-middlewares": "6.119.0",
-    "@tsed/platform-params": "6.119.0",
-    "@tsed/platform-response-filter": "6.119.0",
-    "@tsed/platform-views": "6.119.0",
-    "@tsed/schema": "6.119.0",
+    "@tsed/perf": "6.119.1",
+    "@tsed/platform-cache": "6.119.1",
+    "@tsed/platform-exceptions": "6.119.1",
+    "@tsed/platform-log-middleware": "6.119.1",
+    "@tsed/platform-middlewares": "6.119.1",
+    "@tsed/platform-params": "6.119.1",
+    "@tsed/platform-response-filter": "6.119.1",
+    "@tsed/platform-views": "6.119.1",
+    "@tsed/schema": "6.119.1",
     "@types/json-schema": "7.0.11",
     "@types/on-finished": "2.3.1",
     "on-finished": "2.4.1",