Merge pull request #5 from bennettsf/lambda-handling

Lambda handling, API.md updates

Author: roryhackney

packages/rest-api-construct/API.md

@@ -4,6 +4,55 @@
 
 ```ts
 
+import * as apiGateway from 'aws-cdk-lib/aws-apigateway';
+import { Construct } from 'constructs';
+import * as lamb from 'aws-cdk-lib/aws-lambda';
+
+// @public (undocumented)
+export type ExistingDirectory = {
+    path: string;
+};
+
+// @public (undocumented)
+export type ExistingLambda = {
+    id: string;
+    name: string;
+};
+
+// @public (undocumented)
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+
+// @public (undocumented)
+export type LambdaSource = {
+    runtime: lamb.Runtime;
+    source: ExistingDirectory | ExistingLambda | NewFromCode;
+};
+
+// @public (undocumented)
+export type NewFromCode = {
+    code: string;
+};
+
+// @public
+export class RestApiConstruct extends Construct {
+    constructor(scope: Construct, id: string, props: RestApiConstructProps);
+    // (undocumented)
+    readonly api: apiGateway.RestApi;
+}
+
+// @public (undocumented)
+export type RestApiConstructProps = {
+    apiName: string;
+    apiProps: RestApiPathConfig[];
+};
+
+// @public (undocumented)
+export type RestApiPathConfig = {
+    path: string;
+    routes: HttpMethod[];
+    lambdaEntry: LambdaSource;
+};
+
 // (No @packageDocumentation comment for this package)
 
 ```

packages/rest-api-construct/src/construct.test.ts

@@ -4,6 +4,54 @@ import { App, Stack } from 'aws-cdk-lib';
 import { Template } from 'aws-cdk-lib/assertions';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
 
+void describe('RestApiConstruct Lambda Handling', () => {
+  void it('loads an existing local lambda function if the directory is specified', () => {
+    const app = new App();
+    const stack = new Stack(app);
+    new RestApiConstruct(stack, 'RestApiLambdaTest', {
+      apiName: 'RestApiLambdaTest',
+      apiProps: [
+        {
+          path: 'items',
+          routes: ['GET'],
+          lambdaEntry: {
+            runtime: lambda.Runtime.NODEJS_18_X,
+            source: { path: 'packages/rest-api-construct/lib/test-assets' },
+          },
+        },
+      ],
+    });
+    const template = Template.fromStack(stack);
+    template.hasResourceProperties('AWS::Lambda::Function', {
+      Handler: 'index.handler',
+    });
+  });
+
+  void it('creates a new lambda function if the code is specified', () => {
+    const app = new App();
+    const stack = new Stack(app);
+    new RestApiConstruct(stack, 'RestApiNewLambdaTest', {
+      apiName: 'RestApiNewLambda',
+      apiProps: [
+        {
+          path: 'items',
+          routes: ['GET'],
+          lambdaEntry: {
+            runtime: lambda.Runtime.NODEJS_22_X,
+            source: {
+              code: "export const handler = () => {return 'Hello World! This is a new lambda function.';};",
+            },
+          },
+        },
+      ],
+    });
+    const template = Template.fromStack(stack);
+    template.hasResourceProperties('AWS::Lambda::Function', {
+      Handler: 'index.handler',
+    });
+  });
+});
+
 void describe('RestApiConstruct', () => {
   void it('creates a queue if specified', () => {
     const app = new App();

packages/rest-api-construct/src/construct.ts

@@ -30,8 +30,7 @@ export class RestApiConstruct extends Construct {
       const source = lambdaEntry.source;
 
       // Determine Lambda code source - either ExistingDirectory, NewFromCode, or ExistingLambda (function already exists in aws and does not need to be constructed)
-      let code: lambda.AssetCode | lambda.InlineCode =
-        lambda.Code.fromInline('');
+      let code!: lambda.AssetCode | lambda.InlineCode;
       if ('path' in source) {
         const src = source as ExistingDirectory;
         code = lambda.Code.fromAsset(src.path);

packages/rest-api-construct/src/index.ts

@@ -1 +1,3 @@
 export * from './construct.js';
+export * from './types.js';
+export { RestApiPathConfig, LambdaSource } from './types.js';

packages/rest-api-construct/src/test-assets/index.ts

@@ -0,0 +1,6 @@
+/**
+ * Hello world lambda used for testing providing a file for lambda for a rest api path
+ */
+export const handler = () => {
+  return 'Hello World! This is a lambda function.';
+};

packages/rest-api-construct/src/types.ts

@@ -6,7 +6,7 @@ export type ExistingLambda = { id: string; name: string };
 export type NewFromCode = { code: string };
 
 //adds runtime to the source
-type LambdaSource = {
+export type LambdaSource = {
   runtime: lamb.Runtime;
   source: ExistingDirectory | ExistingLambda | NewFromCode;
 };