@travetto/web-aws-lambda 8.0.0-alpha.9 → 8.0.1

package/README.md

@@ -13,18 +13,25 @@ npm install @travetto/web-aws-lambda
 yarn add @travetto/web-aws-lambda
 ```
 
-This module provides an adapter between [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications") and [AWS Lambda](https://aws.amazon.com/lambda/).  The event-driven invocation model for [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications") aligns cleanly with [AWS Lambda](https://aws.amazon.com/lambda/)'s model for event-driven operation.  
+This module provides an adapter between [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications") and [AWS Lambda](https://aws.amazon.com/lambda/). The event-driven invocation model for [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications") aligns cleanly with [AWS Lambda](https://aws.amazon.com/lambda/)'s model for event-driven operation. 
 
 **NOTE:** The only caveat to consider, is that while the framework supports streams for responses, [AWS Lambda](https://aws.amazon.com/lambda/) does not. Any streaming result will be read and converted into a [Buffer](https://nodejs.org/api/buffer.html) before being sent back.
 
-## CLI - Packaging Lambdas
+## CLI - pack:lambda
+Use this command to produce the Lambda-ready archive for deployment.
 
-**Terminal: Invoking a Package Build**
+**Terminal: Help for pack:lambda**
 ```bash
 $ trv pack:lambda --help
 
 Usage: pack:lambda [options] [args...:string]
 
+Description:
+  Build an AWS Lambda-ready zip package using the pack pipeline.
+
+  Configures the Lambda entrypoint and emits a compressed deployment artifact
+  suitable for direct Lambda upload workflows.
+
 Options:
   -b, --buildDir <string>              Workspace for building (default: "/tmp/<temp-folder>")
   --clean, --no-clean                  Clean workspace (default: true)
@@ -43,4 +50,6 @@ Options:
   -np, --npm-package <string>          External NPM Packages (default: [])
   -m, --module <module>                Module to run for
   --help                               display help for command
+
+Examples:
 ```

package/__index__.ts

@@ -1,2 +1,2 @@
 export * from './src/handler.ts';
-export * from './src/util.ts';
+export * from './src/util.ts';

package/package.json

@@ -1,38 +1,41 @@
 {
   "name": "@travetto/web-aws-lambda",
-  "version": "8.0.0-alpha.9",
-  "type": "module",
+  "version": "8.0.1",
   "description": "Web APIs entry point support for AWS Lambdas.",
   "keywords": [
-    "web",
     "aws-lambda",
     "travetto",
-    "typescript"
+    "typescript",
+    "web"
   ],
   "homepage": "https://travetto.io",
   "license": "MIT",
   "author": {
-    "email": "travetto.framework@gmail.com",
-    "name": "Travetto Framework"
+    "name": "Travetto Framework",
+    "email": "travetto.framework@gmail.com"
+  },
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/web-aws-lambda"
   },
   "files": [
     "__index__.ts",
     "src",
     "support"
   ],
+  "type": "module",
   "main": "__index__.ts",
-  "repository": {
-    "url": "git+https://github.com/travetto/travetto.git",
-    "directory": "module/web-aws-lambda"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@travetto/web": "^8.0.0-alpha.8",
-    "@types/aws-lambda": "^8.10.161"
+    "@travetto/web": "^8.0.1",
+    "@types/aws-lambda": "^8.10.163"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.12",
-    "@travetto/pack": "^8.0.0-alpha.10",
-    "@travetto/test": "^8.0.0-alpha.7"
+    "@travetto/cli": "^8.0.1",
+    "@travetto/pack": "^8.0.1",
+    "@travetto/test": "^8.0.1"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {
@@ -47,8 +50,5 @@
   },
   "travetto": {
     "displayName": "Web AWS Lambda"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/handler.ts

@@ -1,16 +1,15 @@
 import type lambda from 'aws-lambda';
 
-import { Runtime, ConsoleManager } from '@travetto/runtime';
+import { ConfigurationService } from '@travetto/config';
 import { DependencyRegistryIndex, Inject, Injectable } from '@travetto/di';
 import { Registry } from '@travetto/registry';
-import { ConfigurationService } from '@travetto/config';
+import { ConsoleManager, Runtime } from '@travetto/runtime';
 import type { StandardWebRouter } from '@travetto/web';
 
 import { AwsLambdaWebUtil } from './util.ts';
 
 @Injectable()
 export class AwsLambdaWebHandler {
-
   static inst: AwsLambdaWebHandler;
 
   static entryPoint(): (event: lambda.APIGatewayProxyEvent, context: lambda.Context) => Promise<lambda.APIGatewayProxyResult> {
@@ -35,4 +34,4 @@ export class AwsLambdaWebHandler {
     const response = await this.router.dispatch({ request });
     return AwsLambdaWebUtil.toLambdaResult(response, event.isBase64Encoded);
   }
-}
+}

package/src/util.ts

@@ -1,29 +1,29 @@
 import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
 
-import { BinaryUtil, castTo, CodecUtil, type BinaryArray } from '@travetto/runtime';
+import { type BinaryArray, BinaryUtil, CodecUtil, castTo } from '@travetto/runtime';
 import { WebBodyUtil, WebCommonUtil, WebRequest, WebResponse } from '@travetto/web';
 
 export class AwsLambdaWebUtil {
-
   /**
    * Create a request from an api gateway event
    */
   static toWebRequest(event: APIGatewayProxyEvent): WebRequest {
     // Build request
-    const body = !event.body ? undefined :
-      event.isBase64Encoded ?
-        CodecUtil.fromBase64String(event.body) :
-        CodecUtil.fromUTF8String(event.body);
+    const body = !event.body
+      ? undefined
+      : event.isBase64Encoded
+        ? CodecUtil.fromBase64String(event.body)
+        : CodecUtil.fromUTF8String(event.body);
 
     return new WebRequest({
       context: {
         connection: {
           httpProtocol: 'http',
-          ip: event.requestContext.identity?.sourceIp,
+          ip: event.requestContext.identity?.sourceIp
         },
         httpMethod: castTo(event.httpMethod.toUpperCase()),
         httpQuery: castTo(event.queryStringParameters!),
-        path: event.path,
+        path: event.path
       },
       headers: { ...event.headers, ...event.multiValueHeaders },
       body: WebBodyUtil.markRawBinary(body)
@@ -38,9 +38,7 @@ export class AwsLambdaWebUtil {
       context: response.context,
       ...WebBodyUtil.toBinaryMessage(response)
     });
-    const output: BinaryArray = binaryResponse.body ?
-      await BinaryUtil.toBinaryArray(binaryResponse.body) :
-      BinaryUtil.makeBinaryArray(0);
+    const output: BinaryArray = binaryResponse.body ? await BinaryUtil.toBinaryArray(binaryResponse.body) : BinaryUtil.makeBinaryArray(0);
 
     const isBase64Encoded = !!output.byteLength && base64Encoded;
     const headers: Record<string, string> = {};
@@ -59,7 +57,7 @@ export class AwsLambdaWebUtil {
       isBase64Encoded,
       body: isBase64Encoded ? CodecUtil.toBase64String(output) : CodecUtil.toUTF8String(output),
       headers,
-      multiValueHeaders,
+      multiValueHeaders
     };
   }
-}
+}

package/support/cli.pack_lambda.ts

@@ -1,13 +1,16 @@
 import { CliCommand, CliUtil } from '@travetto/cli';
+
 import { PackOperation } from '@travetto/pack/support/bin/operation.ts';
 import { BasePackCommand, type PackOperationShape } from '@travetto/pack/support/pack.base.ts';
 
 /**
- * Standard lambda support for pack
+ * Build an AWS Lambda-ready zip package using the pack pipeline.
+ *
+ * Configures the Lambda entrypoint and emits a compressed deployment artifact
+ * suitable for direct Lambda upload workflows.
  */
 @CliCommand()
 export class PackLambdaCommand extends BasePackCommand {
-
   constructor() {
     super();
     this.entryPoint = '@travetto/web-aws-lambda/support/entry.handler.ts';
@@ -22,9 +25,6 @@ export class PackLambdaCommand extends BasePackCommand {
   }
 
   getOperations(): PackOperationShape<this>[] {
-    return [
-      ...super.getOperations(),
-      PackOperation.compress
-    ];
+    return [...super.getOperations(), PackOperation.compress];
   }
-}
+}

package/support/entry.handler.ts

@@ -1,3 +1,3 @@
 // @trv-no-transform
 import { AwsLambdaWebHandler } from '../src/handler.ts';
-export const handler = AwsLambdaWebHandler.entryPoint();
+export const handler = AwsLambdaWebHandler.entryPoint();

package/support/test/dispatcher.ts

@@ -1,8 +1,8 @@
 import type { APIGatewayProxyEvent, Context } from 'aws-lambda';
 
 import { Inject, Injectable } from '@travetto/di';
+import { asFull, type BinaryArray, BinaryUtil, CodecUtil, castTo, RuntimeError } from '@travetto/runtime';
 import { type WebDispatcher, type WebFilterContext, type WebRequest, WebResponse } from '@travetto/web';
-import { RuntimeError, asFull, BinaryUtil, castTo, CodecUtil, type BinaryArray } from '@travetto/runtime';
 
 import { WebTestDispatchUtil } from '@travetto/web/support/test/dispatch-util.ts';
 
@@ -48,8 +48,8 @@ function toLambdaEvent(request: WebRequest<BinaryArray>): APIGatewayProxyEvent {
     isBase64Encoded: true,
     body: request.body ? CodecUtil.toBase64String(request.body) : null,
     requestContext: castTo({
-      identity: castTo({ sourceIp: '127.0.0.1' }),
-    }),
+      identity: castTo({ sourceIp: '127.0.0.1' })
+    })
   };
 }
 
@@ -58,7 +58,6 @@ function toLambdaEvent(request: WebRequest<BinaryArray>): APIGatewayProxyEvent {
  */
 @Injectable()
 export class LocalAwsLambdaWebDispatcher implements WebDispatcher {
-
   @Inject()
   app: AwsLambdaWebHandler;
 
@@ -68,10 +67,8 @@ export class LocalAwsLambdaWebDispatcher implements WebDispatcher {
 
     return WebTestDispatchUtil.finalizeResponseBody(
       new WebResponse<unknown>({
-        body: response.isBase64Encoded ?
-          CodecUtil.fromBase64String(response.body) :
-          CodecUtil.fromUTF8String(response.body),
-        headers: { ...response.headers ?? {}, ...response.multiValueHeaders ?? {} },
+        body: response.isBase64Encoded ? CodecUtil.fromBase64String(response.body) : CodecUtil.fromUTF8String(response.body),
+        headers: { ...(response.headers ?? {}), ...(response.multiValueHeaders ?? {}) },
         context: {
           httpStatusCode: response.statusCode
         }
@@ -79,4 +76,4 @@ export class LocalAwsLambdaWebDispatcher implements WebDispatcher {
       true
     );
   }
-}
+}