@tsed/platform-serverless 6.87.2 → 6.90.0

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

@@ -0,0 +1,19 @@
+import { DIContext, DIContextOptions } from "@tsed/di";
+import { JsonEntityStore } from "@tsed/schema";
+import { APIGatewayEventDefaultAuthorizerContext, APIGatewayProxyEventBase, Context } from "aws-lambda";
+import { ServerlessRequest } from "./ServerlessRequest";
+import { ServerlessResponse } from "./ServerlessResponse";
+export interface ServerlessContextOptions extends DIContextOptions {
+    event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    context: Context;
+    endpoint: JsonEntityStore;
+}
+export declare class ServerlessContext extends DIContext {
+    readonly response: ServerlessResponse;
+    readonly request: ServerlessRequest;
+    readonly context: Context;
+    readonly event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    readonly endpoint: JsonEntityStore;
+    constructor({ event, context, endpoint, ...options }: ServerlessContextOptions);
+    destroy(): Promise<void>;
+}

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

@@ -0,0 +1,55 @@
+import type { APIGatewayEventDefaultAuthorizerContext, APIGatewayProxyEventBase, Context } from "aws-lambda";
+export interface ServerlessRequestOptions {
+    event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    context: Context;
+}
+/**
+ * @platform
+ */
+export declare class ServerlessRequest {
+    readonly raw: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    constructor({ event }: ServerlessRequestOptions);
+    get secure(): boolean;
+    get host(): string;
+    get protocol(): string;
+    /**
+     * Get the url of the request.
+     *
+     * Is equivalent of `express.response.originalUrl || express.response.url`.
+     */
+    get url(): string;
+    get headers(): import("aws-lambda").APIGatewayProxyEventHeaders;
+    get method(): string;
+    /**
+     * Contains key-value pairs of data submitted in the request body. By default, it is `undefined`, and is populated when you use
+     * `body-parsing` middleware such as `express.json()` or `express.urlencoded()`.
+     */
+    get body(): any;
+    get rawBody(): any;
+    /**
+     * This property is an object containing properties mapped to the named route `parameters`.
+     * For example, if you have the route `/user/:name`, then the `name` property is available as `req.params.name`.
+     * This object defaults to `{}`.
+     */
+    get params(): {
+        [key: string]: any;
+    };
+    /**
+     * This property is an object containing a property for each query string parameter in the route.
+     * When query parser is set to disabled, it is an empty object `{}`, otherwise it is the result of the configured query parser.
+     */
+    get query(): {
+        [key: string]: any;
+    };
+    /**
+     * Returns the HTTP request header specified by field. The match is case-insensitive.
+     *
+     * ```typescript
+     * request.get('Content-Type') // => "text/plain"
+     * ```
+     *
+     * @param name
+     */
+    get(name: string): any;
+    destroy(): void;
+}

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

@@ -0,0 +1,105 @@
+import type { APIGatewayEventDefaultAuthorizerContext, APIGatewayProxyEventBase, Context } from "aws-lambda";
+import type { ServerlessRequest } from "./ServerlessRequest";
+export interface ServerlessResponseOptions {
+    event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    context: Context;
+    request: ServerlessRequest;
+}
+export declare type HeaderValue = boolean | number | string;
+/**
+ * @platform
+ */
+export declare class ServerlessResponse {
+    #private;
+    readonly event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    readonly request: ServerlessRequest;
+    constructor({ event, request }: ServerlessResponseOptions);
+    /**
+     * Get the current statusCode
+     */
+    get statusCode(): number;
+    set statusCode(status: number);
+    /**
+     * An object that contains response local variables scoped to the request, and therefore available only to the view(s) rendered during that request / response cycle (if any). Otherwise, this property is identical to app.locals.
+     *
+     * This property is useful for exposing request-level information such as the request path name, authenticated user, user settings, and so on.
+     */
+    get locals(): Record<string, any>;
+    get isHeadersSent(): boolean;
+    getStatus(): number;
+    /**
+     * Sets the HTTP status for the response.
+     *
+     * @param status
+     */
+    status(status: number): this;
+    set(name: string, value: any): this;
+    /**
+     * Returns the HTTP response header specified by field. The match is case-insensitive.
+     *
+     * ```typescript
+     * response.get('Content-Type') // => "text/plain"
+     * ```
+     *
+     * @param name
+     */
+    get(name: string): string | number | boolean | undefined;
+    getHeaders(): Record<string, HeaderValue>;
+    hasStatus(): boolean;
+    /**
+     * Set header `field` to `val`, or pass
+     * an object of header fields.
+     *
+     * Examples:
+     * ```typescript
+     * response.setHeaders({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+     * ```
+     *
+     * Aliased as `res.header()`.
+     */
+    setHeaders(headers: Record<string, HeaderValue>): this;
+    setHeader(key: string, item: HeaderValue | null | undefined): this;
+    /**
+     * Set `Content-Type` response header with `type` through `mime.lookup()`
+     * when it does not contain "/", or set the Content-Type to `type` otherwise.
+     *
+     * Examples:
+     *
+     *     res.type('.html');
+     *     res.type('html');
+     *     res.type('json');
+     *     res.type('application/json');
+     *     res.type('png');
+     */
+    contentType(contentType: string): this;
+    contentLength(length: number): this;
+    getContentLength(): number | undefined;
+    getContentType(): string;
+    /**
+     * Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an [HTTP status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+     * If not specified, status defaults to `302 Found`.
+     *
+     * @param status
+     * @param url
+     */
+    redirect(status: number, url: string): this;
+    /**
+     * Sets the response Location HTTP header to the specified path parameter.
+     *
+     * @param url
+     */
+    location(url: string): this;
+    /**
+     * Send any data to your consumer.
+     *
+     * This method accept a ReadableStream, a plain object, boolean, string, number, null and undefined data.
+     * It choose the better way to send the data.
+     *
+     * @param body
+     */
+    body(body: any): this;
+    getBody(): any;
+    isDone(): boolean;
+    onEnd(cb: Function): this;
+    destroy(): void;
+}

package/lib/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from "@tsed/di";
+export { Get, Post, Put, Delete, Head, Patch, Options, Route as Lambda } from "@tsed/schema";
+export * from "@tsed/platform-params";
+export * from "./builder/PlatformServerlessHandler";
+export * from "./builder/PlatformServerless";
+export * from "./services/PlatformServerlessTest";
+export * from "./domain/ServerlessContext";
+export * from "./domain/ServerlessResponse";
+export * from "./domain/ServerlessResponse";

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

@@ -0,0 +1,46 @@
+import { Type } from "@tsed/core";
+import { DITest } from "@tsed/di";
+import { JsonEntityStore } from "@tsed/schema";
+import { APIGatewayEventDefaultAuthorizerContext, APIGatewayProxyEventBase, APIGatewayProxyHandler, Context } from "aws-lambda";
+import { APIGatewayProxyResult } from "aws-lambda/trigger/api-gateway-proxy";
+import { PlatformServerless } from "../builder/PlatformServerless";
+import { ServerlessContext } from "../domain/ServerlessContext";
+export interface LambdaPromiseResult extends Promise<APIGatewayProxyResult> {
+}
+export declare class LambdaClientRequest extends Promise<APIGatewayProxyResult> {
+    event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    context: Context;
+    static call(lambdaName: string): LambdaClientRequest;
+    static get(path: string, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): LambdaClientRequest;
+    static post(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): LambdaClientRequest;
+    static put(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): LambdaClientRequest;
+    static patch(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): LambdaClientRequest;
+    static delete(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): LambdaClientRequest;
+    static createFakeEvent(event?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>;
+    static createFakeContext(context?: Context): Context;
+    get(path: string, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): this;
+    post(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): this;
+    patch(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): this;
+    put(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): this;
+    delete(path: string, body?: any, options?: Partial<APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>>): this;
+    query(query: any): this;
+    params(pathParameters: any): this;
+    headers(headers: Record<string, any>): this;
+    body(body: any): this;
+    protected init(lambda: string, resolve: Function, reject: Function): void;
+}
+export declare class PlatformServerlessTest extends DITest {
+    static callbacks: Record<string, APIGatewayProxyHandler>;
+    static instance: PlatformServerless;
+    static request: typeof LambdaClientRequest;
+    static bootstrap(settings?: Partial<TsED.Configuration & {
+        lambda: Type[];
+    }>): () => Promise<void>;
+    /**
+     * Resets the test injector of the test context, so it won't pollute your next test. Call this in your `tearDown` logic.
+     */
+    static reset(): Promise<void>;
+    static createServerlessContext({ endpoint }: {
+        endpoint: JsonEntityStore;
+    }): ServerlessContext;
+}

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

@@ -0,0 +1,2 @@
+import { APIGatewayEventDefaultAuthorizerContext, APIGatewayProxyEventBase, Context } from "aws-lambda";
+export declare function getRequestId(event: APIGatewayProxyEventBase<APIGatewayEventDefaultAuthorizerContext>, context: Context): string;

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

@@ -0,0 +1,5 @@
+import { ServerlessContext } from "../domain/ServerlessContext";
+/**
+ * @ignore
+ */
+export declare function setResponseHeaders(ctx: ServerlessContext): void;

package/package.json

@@ -1,28 +1,32 @@
 {
   "name": "@tsed/platform-serverless",
-  "version": "6.87.2",
+  "version": "6.90.0",
   "description": "Platform serverless module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
-  "main": "./lib/index.js",
-  "typings": "./lib/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "typings": "./lib/types/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "default": "./lib/index.modern.js"
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
   },
   "scripts": {
-    "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json",
+    "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 jest"
   },
   "dependencies": {
-    "@tsed/core": "6.87.2",
-    "@tsed/di": "6.87.2",
-    "@tsed/exceptions": "6.87.2",
-    "@tsed/json-mapper": "6.87.2",
+    "@tsed/core": "6.90.0",
+    "@tsed/di": "6.90.0",
+    "@tsed/exceptions": "6.90.0",
+    "@tsed/json-mapper": "6.90.0",
     "@tsed/logger": "^6.0.0",
-    "@tsed/platform-exceptions": "6.87.2",
-    "@tsed/platform-params": "6.87.2",
-    "@tsed/schema": "6.87.2",
+    "@tsed/platform-exceptions": "6.90.0",
+    "@tsed/platform-params": "6.90.0",
+    "@tsed/schema": "6.90.0",
     "encodeurl": "^1.0.2",
     "mime": "^2.5.2",
     "tslib": "2.2.0",

package/readme.md

@@ -117,6 +117,46 @@ functions:
               method: get
 ```
 
+## Invoke a lambda with serverless
+
+Serverless provide a plugin named `serverless-offline`. This Serverless plugin emulates AWS λ and API Gateway on your local machine to speed up your development cycles.
+To do so, it starts an HTTP server that handles the request's lifecycle like APIG does and invokes your handlers.
+
+So, by using the `serverless offline` command, we'll be able to invoke our function. For that, we need also to build our code before invoke the lambda.
+
+To simplify our workflow, we can add the following npm script command in our `package.json`:
+
+```json
+{
+  "scripts": {
+    "invoke:timeslots": "yarn build && serverless invoke local -f timeslots",
+    "invoke:any": "yarn serverless invoke local -f any --data '{\"path\":\"/timeslots\", \"httpMethod\": \"GET\"}'"
+  }
+}
+```
+
+Now, we can run the following command to invoke our lambda:
+
+```
+yarn invoke:timeslots
+// OR
+npm run invoke:timeslots
+```
+
+You should see in the terminal the following result:
+
+```json
+{
+    "statusCode": 200,
+    "body": "[{\"id\":\"b6de4fc7-faaa-4cd7-a144-42f6af0dec6b\",\"title\":\"title\",\"description\":\"description\",\"start_date\":\"2021-10-29T10:40:57.019Z\",\"end_date\":\"2021-10-29T10:40:57.019Z\",\"created_at\":\"2021-10-29T10:40:57.019Z\",\"update_at\":\"2021-10-29T10:40:57.019Z\"}]",
+    "headers": {
+        "content-type": "application/json",
+        "x-request-id": "ebb52d5e-113b-40da-b34e-c14811df596b"
+    },
+    "isBase64Encoded": false
+}
+```
+
 ## Manage routes from code
 
 Declaring all routes in the `serverless.yml` file can be a source of error. `@tsed/platform-serverless` can
@@ -149,47 +189,31 @@ functions:
           path: '{proxy+}'
 ```
 
-Now, Ts.ED will handle request and call the expected lambda.
+Then, edit the `handler.ts` and change the exported functions:
 
-## Invoke a lambda with serverless
+```typescript
+import {PlatformServerless} from "@tsed/platform-serverless";
+import {TimeslotsLambda} from "./TimeslotsLambda";
 
-Serverless provide a plugin named `serverless-offline`. This Serverless plugin emulates AWS λ and API Gateway on your local machine to speed up your development cycles.
-To do so, it starts an HTTP server that handles the request's lifecycle like APIG does and invokes your handlers.
+const platform = PlatformServerless.bootstrap({
+  lambda: [TimeslotsLambda]
+});
 
-So, by using the `serverless offline` command, we'll be able to invoke our function. For that, we need also to build our code before invoke the lambda.
+export const handler = platform.handler();
+```
+
+Now, Ts.ED will handle request and call the expected lambda in your controllers.
 
 To simplify our workflow, we can add the following npm script command in our `package.json`:
 
 ```json
 {
   "scripts": {
-    "invoke:timeslots": "yarn build && serverless invoke local -f timeslots"
+    "invoke:any": "yarn serverless invoke local -f any --data '{\"path\":\"/timeslots\", \"httpMethod\": \"GET\"}'"
   }
 }
 ```
 
-Now, we can run the following command to invoke our lambda:
-
-```
-yarn invoke:timeslots
-// OR
-npm run invoke:timeslots
-```
-
-You should see in the terminal the following result:
-
-```json
-{
-    "statusCode": 200,
-    "body": "[{\"id\":\"b6de4fc7-faaa-4cd7-a144-42f6af0dec6b\",\"title\":\"title\",\"description\":\"description\",\"start_date\":\"2021-10-29T10:40:57.019Z\",\"end_date\":\"2021-10-29T10:40:57.019Z\",\"created_at\":\"2021-10-29T10:40:57.019Z\",\"update_at\":\"2021-10-29T10:40:57.019Z\"}]",
-    "headers": {
-        "content-type": "application/json",
-        "x-request-id": "ebb52d5e-113b-40da-b34e-c14811df596b"
-    },
-    "isBase64Encoded": false
-}
-```
-
 ## Get AwsContext and AwsEvent
 
 ```typescript

package/tsconfig.compile.esm.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "exclude": [
+    "node_modules",
+    "test",
+    "lib",
+    "benchmark",
+    "coverage",
+    "spec",
+    "**/*.benchmark.ts",
+    "**/*.spec.ts",
+    "keys",
+    "jest.config.js"
+  ]
+}