feat: typescript support (#42)

* feat: typescript support

You can use ts or js. Linting and build for both

* adjustments

* update README

* update jest to handle typescript

Author: adampash

.eslintignore

@@ -0,0 +1 @@
+src/**/*.ts

.eslintrc

@@ -15,6 +15,17 @@
     "jasmine": true,
     "xit": true,
     "jest": true
+  },
+  "settings": {
+    "plugins": [
+      "import"
+    ],
+    "rules": {
+      "import/no-unresolved": "error"
+    },
+    "import/resolver": {
+      "typescript": {},
+    }
   }
 }
 

.gitignore

@@ -3,3 +3,4 @@ node_modules
 .webpack
 .serverless
 .env*
+.build

README.md

@@ -2,7 +2,7 @@
 [![Greenkeeper badge](https://badges.greenkeeper.io/postlight/serverless-babel-starter.svg)](https://greenkeeper.io/)
 [![CircleCI](https://circleci.com/gh/postlight/serverless-babel-starter/tree/master.svg?style=svg)](https://circleci.com/gh/postlight/serverless-babel-starter/tree/master)
 
-Postlight's Modern Serverless Starter Kit adds a light layer on top of the Serverless framework, giving you the latest in modern JavaScript (ES6 via Webpack + Babel, testing with Jest, linting with ESLint, and formatting with Prettier), the ease and power of Serverless, and a few handy helpers (like functions for handling warm functions and response helpers).
+Postlight's Modern Serverless Starter Kit adds a light layer on top of the Serverless framework, giving you the latest in modern JavaScript (ES6 via Webpack + Babel, TypeScript (but only if you want it), testing with Jest, linting with ESLint, and formatting with Prettier), the ease and power of Serverless, and a few handy helpers (like functions for handling warm functions and response helpers).
 
 Once installed, you can create and deploy functions with the latest ES6 features in minutes, with linting and formatting baked in.
 

jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  "roots": [
+    "<rootDir>/src"
+  ],
+	"testRegex": "(.*\\.test\\.(tsx?|jsx?))$",
+  "transform": {
+    "^.+\\.tsx?$": "ts-jest",
+    "^.+\\.jsx?$": "babel-jest"
+  },
+  "moduleFileExtensions": [
+    "ts",
+    "tsx",
+    "js",
+    "jsx",
+    "json",
+    "node"
+  ],
+}

package.json

@@ -8,9 +8,10 @@
     "deploy": "export NODE_ENV=dev && yarn deploy:env",
     "deploy:production": "export NODE_ENV=production && yarn deploy:env",
     "deploy:stage": "export NODE_ENV=stage && yarn deploy:env",
-    "lint": "eslint ./src",
+    "lint": "tslint -c tslint.json --fix './src/**/*.ts' && eslint ./src --fix",
     "precommit": "lint-staged",
     "serve": "serverless offline start",
+    "serve:watch": "nodemon -e js,ts,jsx,tsx -x serverless offline start",
     "tail:hello": "serverless logs --function hello --tail",
     "test": "jest",
     "test:watch": "jest --watch",
@@ -21,29 +22,40 @@
   "devDependencies": {
     "@babel/core": "7.2.2",
     "@babel/preset-env": "7.2.3",
+    "@types/jest": "^23.3.10",
     "babel-core": "^7.0.0-bridge.0",
     "babel-jest": "^23.4.2",
     "babel-loader": "^8.0.0",
     "eslint": "^5.4.0",
     "eslint-config-airbnb": "^17.1.0",
     "eslint-config-prettier": "^3.0.1",
+    "eslint-import-resolver-typescript": "^1.1.1",
     "eslint-plugin-import": "^2.14.0",
     "eslint-plugin-jsx-a11y": "^6.1.1",
     "eslint-plugin-react": "^7.11.0",
     "husky": "^1.0.0",
     "jest": "^23.5.0",
     "lint-staged": "^8.0.0",
+    "nodemon": "^1.18.9",
     "prettier": "^1.14.2",
     "serverless": "^1.32.0",
     "serverless-offline": "^3.25.10",
     "serverless-webpack": "^5.2.0",
+    "ts-jest": "^23.10.5",
+    "ts-loader": "^5.3.1",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.17.0",
+    "tslint-react": "^3.6.0",
+    "typescript": "^3.2.1",
     "webpack": "^4.17.1",
     "webpack-node-externals": "^1.7.2"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@types/aws-lambda": "^8.10.15"
+  },
   "lint-staged": {
     "src/**/*.js": [
-      "yarn lint -- --fix",
+      "yarn lint",
       "prettier --write",
       "git add"
     ]

serverless.yml

@@ -63,6 +63,16 @@ custom:
 #    - exclude-me-dir/**
 
 functions:
+  hello-typescript:
+    handler: src/hello-ts.default
+    events:
+      - http:
+          path: hello-typescript
+          method: get
+      # Ping every 5 minutes to avoid cold starts
+      - schedule:
+          rate: rate(5 minutes)
+          enabled: true
   hello:
     handler: src/hello.default
     events:

src/hello-ts.ts

@@ -0,0 +1,23 @@
+import { successResponse, runWarm } from './utils';
+
+const helloTs: AWSLambda.Handler = (
+  event: AWSLambda.APIGatewayEvent,
+  _context,
+  callback
+) => {
+  // successResponse handles wrapping the response in an API Gateway friendly
+  // format (see other responses, including CORS, in `./utils/lambda-response.js)
+  const response = successResponse({
+    message: 'Go Serverless! Your function executed successfully!',
+    input: event,
+  });
+
+  callback(null, response);
+
+  // Use this code if you don't use the http event with the LAMBDA-PROXY integration
+  // callback(null, { message: 'Go Serverless v1.0! Your function executed successfully!', event });
+};
+
+// runWarm function handles pings from the scheduler so you don't
+// have to put that boilerplate in your function.
+export default runWarm(helloTs);

src/types/index.ts

@@ -0,0 +1,15 @@
+export interface IEvent {
+  source: string;
+}
+
+interface IJSON {
+  [key: string]: any;
+}
+
+export type ICallback = (param1: any | null, response: IJSON | string) => void;
+
+export type ILambdaFunc = (
+  event: IEvent,
+  context: {},
+  callback: ICallback
+) => void | ILambdaFunc;