@tsed/platform-serverless 8.0.0-alpha.1 → 8.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/lib/esm/builder/PlatformServerless.js.map +1 -1
  2. package/lib/esm/builder/PlatformServerlessHandler.js +1 -1
  3. package/lib/esm/builder/PlatformServerlessHandler.js.map +1 -1
  4. package/lib/esm/domain/ServerlessContext.js.map +1 -1
  5. package/lib/esm/domain/ServerlessRequest.js.map +1 -1
  6. package/lib/esm/domain/ServerlessResponse.js +5 -10
  7. package/lib/esm/domain/ServerlessResponse.js.map +1 -1
  8. package/lib/esm/domain/ServerlessResponseStream.js.map +1 -1
  9. package/lib/esm/exports.js +1 -1
  10. package/lib/esm/exports.js.map +1 -1
  11. package/lib/esm/utils/getRequestId.js.map +1 -1
  12. package/lib/esm/utils/setResponseHeaders.js.map +1 -1
  13. package/lib/types/builder/PlatformServerless.d.ts +2 -2
  14. package/lib/types/builder/PlatformServerlessHandler.d.ts +2 -2
  15. package/lib/types/domain/ServerlessContext.d.ts +1 -1
  16. package/lib/types/domain/ServerlessResponseStream.d.ts +4 -2
  17. package/lib/types/exports.d.ts +1 -1
  18. package/lib/types/utils/getRequestId.d.ts +1 -1
  19. package/lib/types/utils/setResponseHeaders.d.ts +1 -1
  20. package/package.json +24 -24
  21. package/vitest.config.mts +3 -3
  22. package/lib/cjs/builder/PlatformServerless.js +0 -180
  23. package/lib/cjs/builder/PlatformServerless.js.map +0 -1
  24. package/lib/cjs/builder/PlatformServerlessHandler.js +0 -113
  25. package/lib/cjs/builder/PlatformServerlessHandler.js.map +0 -1
  26. package/lib/cjs/domain/ServerlessContext.js +0 -41
  27. package/lib/cjs/domain/ServerlessContext.js.map +0 -1
  28. package/lib/cjs/domain/ServerlessEvent.js +0 -3
  29. package/lib/cjs/domain/ServerlessEvent.js.map +0 -1
  30. package/lib/cjs/domain/ServerlessRequest.js +0 -95
  31. package/lib/cjs/domain/ServerlessRequest.js.map +0 -1
  32. package/lib/cjs/domain/ServerlessResponse.js +0 -198
  33. package/lib/cjs/domain/ServerlessResponse.js.map +0 -1
  34. package/lib/cjs/domain/ServerlessResponseStream.js +0 -76
  35. package/lib/cjs/domain/ServerlessResponseStream.js.map +0 -1
  36. package/lib/cjs/exports.js +0 -16
  37. package/lib/cjs/exports.js.map +0 -1
  38. package/lib/cjs/index.js +0 -18
  39. package/lib/cjs/index.js.map +0 -1
  40. package/lib/cjs/package.json +0 -3
  41. package/lib/cjs/utils/getRequestId.js +0 -15
  42. package/lib/cjs/utils/getRequestId.js.map +0 -1
  43. package/lib/cjs/utils/isInAWS.js +0 -12
  44. package/lib/cjs/utils/isInAWS.js.map +0 -1
  45. package/lib/cjs/utils/setResponseHeaders.js +0 -47
  46. package/lib/cjs/utils/setResponseHeaders.js.map +0 -1
  47. package/lib/esm/package.json +0 -3
  48. package/lib/types-esm/builder/PlatformServerless.d.ts +0 -37
  49. package/lib/types-esm/builder/PlatformServerlessHandler.d.ts +0 -14
  50. package/lib/types-esm/domain/ServerlessContext.d.ts +0 -26
  51. package/lib/types-esm/domain/ServerlessEvent.d.ts +0 -2
  52. package/lib/types-esm/domain/ServerlessRequest.d.ts +0 -59
  53. package/lib/types-esm/domain/ServerlessResponse.d.ts +0 -101
  54. package/lib/types-esm/domain/ServerlessResponseStream.d.ts +0 -27
  55. package/lib/types-esm/exports.d.ts +0 -3
  56. package/lib/types-esm/index.d.ts +0 -14
  57. package/lib/types-esm/utils/getRequestId.d.ts +0 -3
  58. package/lib/types-esm/utils/isInAWS.d.ts +0 -1
  59. package/lib/types-esm/utils/setResponseHeaders.d.ts +0 -6
@@ -1,47 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.setResponseHeaders = void 0;
4
- function mergeHeaders(specHeaders, headers) {
5
- return Object.entries(specHeaders).reduce((headers, [key, item]) => {
6
- key = key.toLowerCase();
7
- const value = headers[key] === undefined ? item.example : headers[key];
8
- if (value !== undefined) {
9
- return {
10
- ...headers,
11
- [key]: String(value)
12
- };
13
- }
14
- return headers;
15
- }, headers);
16
- }
17
- /**
18
- * @ignore
19
- */
20
- function setResponseHeaders(ctx) {
21
- const { response, endpoint } = ctx;
22
- if (ctx.isDone()) {
23
- return;
24
- }
25
- const operation = endpoint.operation;
26
- if (!operation) {
27
- ctx.logger.debug({
28
- event: "MISSING_OPERATION_METADATA",
29
- message: "No operation found on the endpoint. The response headers are not set.",
30
- endpoint: endpoint
31
- });
32
- return;
33
- }
34
- if (!response.hasStatus()) {
35
- // apply status only if isn't already modified
36
- response.status(operation.getStatus());
37
- }
38
- const statusCode = response.statusCode;
39
- const headers = operation.getHeadersOf(response.statusCode);
40
- const mergedHeaders = mergeHeaders(headers, response.getHeaders());
41
- response.setHeaders(mergedHeaders);
42
- if (operation.isRedirection(statusCode)) {
43
- response.redirect(statusCode, String(mergedHeaders["location"]));
44
- }
45
- }
46
- exports.setResponseHeaders = setResponseHeaders;
47
- //# sourceMappingURL=setResponseHeaders.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"setResponseHeaders.js","sourceRoot":"","sources":["../../../src/utils/setResponseHeaders.ts"],"names":[],"mappings":";;;AAKA,SAAS,YAAY,CAAC,WAA2D,EAAE,OAAoC;IACrH,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;QACjE,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAExB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEvE,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO;gBACL,GAAG,OAAO;gBACV,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;aACrB,CAAC;SACH;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,EAAE,OAAO,CAAC,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,GAAuC;IACxE,MAAM,EAAC,QAAQ,EAAE,QAAQ,EAAC,GAAG,GAAG,CAAC;IACjC,IAAI,GAAG,CAAC,MAAM,EAAE,EAAE;QAChB,OAAO;KACR;IAED,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAsC,CAAC;IAElE,IAAI,CAAC,SAAS,EAAE;QACd,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;YACf,KAAK,EAAE,4BAA4B;YACnC,OAAO,EAAE,uEAAuE;YAChF,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;QACH,OAAO;KACR;IAED,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE;QACzB,8CAA8C;QAC9C,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC;KACxC;IAED,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IACvC,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAEnE,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAEnC,IAAI,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;QACvC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;KAClE;AACH,CAAC;AA/BD,gDA+BC"}
@@ -1,3 +0,0 @@
1
- {
2
- "type": "module"
3
- }
@@ -1,37 +0,0 @@
1
- import { Type } from "@tsed/core";
2
- import { InjectorService } from "@tsed/di";
3
- import type { Handler } from "aws-lambda";
4
- import type { Instance } from "find-my-way";
5
- import type { ServerlessEvent } from "../domain/ServerlessEvent";
6
- import { type RequestHandler } from "../domain/ServerlessResponseStream";
7
- export interface PlatformServerlessSettings extends Partial<TsED.Configuration> {
8
- lambda?: Type[];
9
- }
10
- /**
11
- * @platform
12
- */
13
- export declare class PlatformServerless {
14
- readonly name: string;
15
- private _injector;
16
- private _router;
17
- private _promise;
18
- get injector(): InjectorService;
19
- get settings(): import("@tsed/di").DIConfiguration;
20
- get promise(): Promise<any>;
21
- static bootstrap(settings?: Partial<TsED.Configuration> & {
22
- lambda?: Type[];
23
- }): PlatformServerless;
24
- /**
25
- * Create a new handler from the given token and propertyKey. No routing is used here.
26
- */
27
- static callback(token: Type<any>, propertyKey: string, settings?: Partial<TsED.Configuration>): Handler<ServerlessEvent> | RequestHandler;
28
- handler(): Handler;
29
- callbacks(tokens?: Type | Type[], callbacks?: any): Record<string, Handler>;
30
- ready(): Promise<void>;
31
- stop(): Promise<void>;
32
- init(): Promise<any>;
33
- protected callback(token: Type<any>, propertyKey: string): Handler<ServerlessEvent> | RequestHandler;
34
- protected initRouter(): Promise<Instance<any>>;
35
- protected createInjector(settings: any): this;
36
- protected loadInjector(): Promise<void>;
37
- }
@@ -1,14 +0,0 @@
1
- import { InjectorService, TokenProvider } from "@tsed/di";
2
- import type { PlatformExceptions } from "@tsed/platform-exceptions";
3
- import { PlatformParams } from "@tsed/platform-params";
4
- import { ServerlessContext } from "../domain/ServerlessContext.js";
5
- import type { ServerlessEvent } from "../domain/ServerlessEvent";
6
- export declare class PlatformServerlessHandler {
7
- protected injector: InjectorService;
8
- protected params: PlatformParams;
9
- protected exceptionsManager: Promise<PlatformExceptions>;
10
- createHandler(token: TokenProvider, propertyKey: string | symbol): ($ctx: ServerlessContext<ServerlessEvent>) => Promise<any>;
11
- private flush;
12
- private makeHttpResponse;
13
- private processResult;
14
- }
@@ -1,26 +0,0 @@
1
- import { DIContext, DIContextOptions } from "@tsed/di";
2
- import { JsonEntityStore } from "@tsed/schema";
3
- import { type APIGatewayProxyEvent, Context } from "aws-lambda";
4
- import { ServerlessRequest } from "./ServerlessRequest.js";
5
- import { ServerlessResponse } from "./ServerlessResponse.js";
6
- import type { ServerlessResponseStream } from "./ServerlessResponseStream";
7
- export interface ServerlessContextOptions<Event = APIGatewayProxyEvent> extends DIContextOptions {
8
- event: Event;
9
- context: Context;
10
- responseStream?: ServerlessResponseStream;
11
- endpoint: JsonEntityStore;
12
- }
13
- export declare class ServerlessContext<Event extends object = APIGatewayProxyEvent> extends DIContext {
14
- readonly response: ServerlessResponse<Event>;
15
- readonly request: ServerlessRequest<Event>;
16
- readonly context: Context;
17
- readonly event: Event;
18
- readonly responseStream: ServerlessResponseStream | undefined;
19
- readonly endpoint: JsonEntityStore;
20
- readonly PLATFORM = "SERVERLESS";
21
- constructor({ event, context, endpoint, responseStream, ...options }: ServerlessContextOptions<Event>);
22
- isHttpEvent(): boolean;
23
- isAuthorizerEvent(): boolean;
24
- destroy(): Promise<void>;
25
- isDone(): boolean;
26
- }
@@ -1,2 +0,0 @@
1
- import type { APIGatewayProxyEvent, APIGatewayProxyEventV2, APIGatewayTokenAuthorizerEvent, CloudWatchLogsEvent, DynamoDBStreamEvent, KinesisStreamEvent, S3Event, ScheduledEvent, SNSEvent, SQSEvent } from "aws-lambda";
2
- export type ServerlessEvent = APIGatewayProxyEvent | APIGatewayProxyEventV2 | S3Event | SQSEvent | SNSEvent | DynamoDBStreamEvent | KinesisStreamEvent | CloudWatchLogsEvent | ScheduledEvent | APIGatewayTokenAuthorizerEvent;
@@ -1,59 +0,0 @@
1
- import type { APIGatewayProxyEvent } from "aws-lambda";
2
- import { ServerlessContext } from "./ServerlessContext.js";
3
- /**
4
- * @platform
5
- */
6
- export declare class ServerlessRequest<Event extends object = APIGatewayProxyEvent> {
7
- protected $ctx: ServerlessContext<Event>;
8
- constructor($ctx: ServerlessContext<Event>);
9
- /**
10
- * APIGatewayProxyEvent to no break the current code
11
- * @note use getEvent() instead to use generic type
12
- */
13
- get event(): APIGatewayProxyEvent;
14
- get raw(): Event;
15
- get response(): import("./ServerlessResponse.js").ServerlessResponse<Event>;
16
- get secure(): boolean;
17
- get host(): string;
18
- get protocol(): string;
19
- /**
20
- * Get the url of the request.
21
- *
22
- * Is equivalent of `express.response.originalUrl || express.response.url`.
23
- */
24
- get url(): string;
25
- get headers(): import("aws-lambda").APIGatewayProxyEventHeaders;
26
- get method(): string;
27
- /**
28
- * Contains key-value pairs of data submitted in the request body. By default, it is `undefined`, and is populated when you use
29
- * `body-parsing` middleware such as `express.json()` or `express.urlencoded()`.
30
- */
31
- get body(): any;
32
- get rawBody(): any;
33
- /**
34
- * This property is an object containing properties mapped to the named route `parameters`.
35
- * For example, if you have the route `/user/:name`, then the `name` property is available as `req.params.name`.
36
- * This object defaults to `{}`.
37
- */
38
- get params(): {
39
- [key: string]: any;
40
- };
41
- /**
42
- * This property is an object containing a property for each query string parameter in the route.
43
- * When query parser is set to disabled, it is an empty object `{}`, otherwise it is the result of the configured query parser.
44
- */
45
- get query(): {
46
- [key: string]: any;
47
- };
48
- getEvent<E = Event>(): E;
49
- /**
50
- * Returns the HTTP request header specified by field. The match is case-insensitive.
51
- *
52
- * ```typescript
53
- * request.get('Content-Type') // => "text/plain"
54
- * ```
55
- *
56
- * @param name
57
- */
58
- get(name: string): any;
59
- }
@@ -1,101 +0,0 @@
1
- import type { APIGatewayProxyEvent } from "aws-lambda";
2
- import { ServerlessContext } from "./ServerlessContext.js";
3
- export type HeaderValue = boolean | number | string;
4
- /**
5
- * @platform
6
- */
7
- export declare class ServerlessResponse<Event extends object = APIGatewayProxyEvent> {
8
- #private;
9
- protected $ctx: ServerlessContext<Event>;
10
- constructor($ctx: ServerlessContext<Event>);
11
- get event(): Event;
12
- get raw(): Event;
13
- get request(): import("./ServerlessRequest.js").ServerlessRequest<Event>;
14
- /**
15
- * Get the current statusCode
16
- */
17
- get statusCode(): number;
18
- set statusCode(status: number);
19
- /**
20
- * 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.
21
- *
22
- * This property is useful for exposing request-level information such as the request path name, authenticated user, user settings, and so on.
23
- */
24
- get locals(): Record<string, any>;
25
- get isHeadersSent(): boolean;
26
- getStatus(): number;
27
- /**
28
- * Sets the HTTP status for the response.
29
- *
30
- * @param status
31
- */
32
- status(status: number): this;
33
- set(name: string, value: any): this;
34
- /**
35
- * Returns the HTTP response header specified by field. The match is case-insensitive.
36
- *
37
- * ```typescript
38
- * response.get('Content-Type') // => "text/plain"
39
- * ```
40
- *
41
- * @param name
42
- */
43
- get(name: string): string | number | boolean | undefined;
44
- getHeaders(): Record<string, HeaderValue>;
45
- hasStatus(): boolean;
46
- /**
47
- * Set header `field` to `val`, or pass
48
- * an object of header fields.
49
- *
50
- * Examples:
51
- * ```typescript
52
- * response.setHeaders({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
53
- * ```
54
- *
55
- * Aliased as `res.header()`.
56
- */
57
- setHeaders(headers: Record<string, HeaderValue>): this;
58
- setHeader(key: string, item: HeaderValue | null | undefined): this;
59
- /**
60
- * Set `Content-Type` response header with `type` through `mime.lookup()`
61
- * when it does not contain "/", or set the Content-Type to `type` otherwise.
62
- *
63
- * Examples:
64
- *
65
- * res.type('.html');
66
- * res.type('html');
67
- * res.type('json');
68
- * res.type('application/json');
69
- * res.type('png');
70
- */
71
- contentType(contentType: string): this;
72
- contentLength(length: number): this;
73
- getContentLength(): number | undefined;
74
- getContentType(): string;
75
- /**
76
- * 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).
77
- * If not specified, status defaults to `302 Found`.
78
- *
79
- * @param status
80
- * @param url
81
- */
82
- redirect(status: number, url: string): this;
83
- /**
84
- * Sets the response Location HTTP header to the specified path parameter.
85
- *
86
- * @param url
87
- */
88
- location(url: string): this;
89
- /**
90
- * Send any data to your consumer.
91
- *
92
- * This method accept a ReadableStream, a plain object, boolean, string, number, null and undefined data.
93
- * It choose the better way to send the data.
94
- *
95
- * @param body
96
- */
97
- body(body: any): this;
98
- getBody(): any;
99
- isDone(): boolean;
100
- destroy(): void;
101
- }
@@ -1,27 +0,0 @@
1
- /// <reference types="node" />
2
- import type { APIGatewayProxyEventV2, Callback, Context, Handler } from "aws-lambda";
3
- import { Stream } from "node:stream";
4
- export type ServerlessResponseMeta = {
5
- statusCode: number;
6
- headers: Record<string, string>;
7
- };
8
- declare global {
9
- const awsLambda: {
10
- streamifyResponse(handler: Handler): unknown | Promise<unknown>;
11
- HttpResponseStream: {
12
- from(resStream: ServerlessResponseStream | unknown, meta: ServerlessResponseMeta): ServerlessResponseStream;
13
- };
14
- };
15
- }
16
- export type RequestHandler = (ev: APIGatewayProxyEventV2, streamResponse?: ServerlessResponseStream, ctx?: Context, callback?: Callback) => unknown | Promise<unknown>;
17
- export declare class ServerlessResponseStream extends Stream.Writable {
18
- #private;
19
- _meta: ServerlessResponseMeta;
20
- constructor();
21
- static setMeta(resStream: ServerlessResponseStream, meta: ServerlessResponseMeta): any;
22
- static streamifyResponse(handler: RequestHandler): RequestHandler;
23
- private static buildResponse;
24
- _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
25
- setMeta(meta: ServerlessResponseMeta): void;
26
- getBufferedData(): Buffer;
27
- }
@@ -1,3 +0,0 @@
1
- export * from "@tsed/di";
2
- export { Get, Post, Put, Delete, Head, Patch, Options, Route as Lambda } from "@tsed/schema";
3
- export * from "@tsed/platform-params";
@@ -1,14 +0,0 @@
1
- /**
2
- * @file Automatically generated by @tsed/barrels.
3
- */
4
- export * from "./builder/PlatformServerless.js";
5
- export * from "./builder/PlatformServerlessHandler.js";
6
- export * from "./domain/ServerlessContext.js";
7
- export * from "./domain/ServerlessEvent.js";
8
- export * from "./domain/ServerlessRequest.js";
9
- export * from "./domain/ServerlessResponse.js";
10
- export * from "./domain/ServerlessResponseStream.js";
11
- export * from "./exports.js";
12
- export * from "./utils/getRequestId.js";
13
- export * from "./utils/isInAWS.js";
14
- export * from "./utils/setResponseHeaders.js";
@@ -1,3 +0,0 @@
1
- import { Context } from "aws-lambda";
2
- import type { ServerlessEvent } from "../domain/ServerlessEvent";
3
- export declare function getRequestId(event: ServerlessEvent, context: Context): string;
@@ -1 +0,0 @@
1
- export declare function isInAWS(): boolean;
@@ -1,6 +0,0 @@
1
- import { ServerlessContext } from "../domain/ServerlessContext.js";
2
- import type { ServerlessEvent } from "../domain/ServerlessEvent";
3
- /**
4
- * @ignore
5
- */
6
- export declare function setResponseHeaders(ctx: ServerlessContext<ServerlessEvent>): void;