@clouden-cdk/aws-lambda-typescript

TypeScript Build Step for AWS CDK Lambda Functions

Copyright (C) Clouden Oy 2019, author Kenneth Falck [e-mail].

Released under the MIT license.

Versioning indicates compatibility with AWS CDK major and minor versions. 1.5.x will be compatible with AWS CDK 1.5.x and so on.

Overview

This is a drop-in wrapper replacement for the AWS CDK Lambda Code asset object to add TypeScript support for Lambda Functions

When using this wrapper, the source asset path is first compiled as TypeScript and the results are saved in new deploy directory (.deploy), which is then deployed using the standard AWS CDK Lambda Code object.

Installation

npm install @clouden-cdk/aws-lambda-typescript

Usage

Use TypeScriptCode.asset('path/to/lambda-source-code') when creating a Lambda Function.

The path that you provide should include at least a package.json file and a tsconfig.json file.

import { Function } from '@aws-cdk/aws-lambda'
import { TypeScriptCode } from '@clouden-cdk/aws-lambda-typescript'

const lambdaFunction = new Function(this, 'TestFunction', {
  functionName: 'test-function',
  code: TypeScriptCode.asset('path/to/lambda-source-code')),
  handler: 'handler.default',
  runtime: lambda.Runtime.NODEJS_10_X,
})

Here is an example tsconfig.json file that we use in Clouden projects like webcat.fi:

{
  "compilerOptions": {
    "target":"ES2017",
    "module": "commonjs",
    "lib": ["es2016", "es2017.object", "es2017.string", "esnext.asynciterable"],
    "declaration": true,
    "strict": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "noImplicitThis": true,
    "alwaysStrict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": false,
    "inlineSourceMap": true,
    "inlineSources": true,
    "experimentalDecorators": true,
    "strictPropertyInitialization": false,
    "emitDecoratorMetadata": true,
    "esModuleInterop": true,
    "rootDir": "."
  }
}

Notes

The TypeScript build involves two steps:

1. Run tsc to build the files in the source path and save output to the deploy path.
2. Copy package.json and package-lock.json from the source path to the deploy path and run npm install --production there.

The end result of these steps is that the deploy path contains everything needed to deploy the Lambda function.

The TypeScriptCode object keeps track of build paths and only builds each path once per CDK invocation. It also keeps track of package.json and package-lock.json files and only runs npm install when they have changed, or when npm install has not yet been run.