update dependencies, add custom api response method, and add lint-staged with eslint

Author: manwaring

.eslintrc.yml

@@ -0,0 +1,11 @@
+root: true
+
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaVersion: 2020
+  sourceType: module
+
+extends:
+  - plugin:@typescript-eslint/recommended
+  - prettier/@typescript-eslint
+  - plugin:prettier/recommended

CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [4.1.0]  (2020-10-31)
+
+### Added
+
+- Custom response option for api gateway responses
+
+### Changed
+
+- Update dependencies
+
 ## [4.0.6]  (2020-09-23)
 
 ### Changed
@@ -297,6 +307,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/),
 - Update older libraries
 - Now publish from Git tags instead of master pushes
 
+[4.1.0]: https://github.com/manwaring/lambda-wrapper/compare/v4.0.6...v4.1.0
 [4.0.6]: https://github.com/manwaring/lambda-wrapper/compare/v4.0.5...v4.0.6
 [4.0.5]: https://github.com/manwaring/lambda-wrapper/compare/v4.0.4...v4.0.5
 [4.0.4]: https://github.com/manwaring/lambda-wrapper/compare/v4.0.3...v4.0.4

jest.config.js

@@ -1,3 +1,4 @@
 module.exports = {
-  collectCoverageFrom: ['src/**/*.ts', '!src/**/*index.ts']
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*index.ts'],
+  coverageThreshold: { global: { lines: 90 }}
 };

package-lock.json

@@ -16,30 +16,43 @@
     "cfn-response": "^1.0.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.11.6",
-    "@babel/plugin-proposal-class-properties": "^7.10.4",
-    "@babel/preset-env": "^7.11.5",
-    "@babel/preset-typescript": "^7.10.4",
-    "@types/aws-lambda": "^8.10.62",
+    "@babel/core": "^7.12.3",
+    "@babel/plugin-proposal-class-properties": "^7.12.1",
+    "@babel/preset-env": "^7.12.1",
+    "@babel/preset-typescript": "^7.12.1",
+    "@types/aws-lambda": "^8.10.64",
     "@types/cfn-response": "^1.0.3",
-    "@types/jest": "^26.0.14",
-    "@types/node": "^14.11.2",
+    "@types/jest": "^26.0.15",
+    "@types/node": "^14.14.6",
+    "@typescript-eslint/eslint-plugin": "^4.6.0",
+    "@typescript-eslint/parser": "^4.6.0",
     "aws-lambda": "^1.0.6",
-    "aws-sdk": "^2.761.0",
-    "babel-jest": "^26.3.0",
-    "codecov": "^3.7.2",
+    "aws-sdk": "^2.783.0",
+    "babel-jest": "^26.6.1",
+    "codecov": "^3.8.0",
+    "eslint": "^7.12.1",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-prettier": "^3.1.4",
     "husky": "^4.3.0",
-    "jest": "^26.4.2",
-    "publish-please": "^5.5.1",
+    "jest": "^26.6.1",
+    "lint-staged": "^10.5.1",
+    "prettier": "^2.1.2",
+    "publish-please": "^5.5.2",
     "rimraf": "^3.0.2",
     "serverless-plugin-test-helper": "^2.4.5",
-    "typescript": "^4.0.3"
+    "typescript": "^4.0.5"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm test"
+      "pre-commit": "lint-staged && npm test"
     }
   },
+  "lint-staged": {
+    "./src/**/*.ts": [
+      "eslint --fix",
+      "git add ."
+    ]
+  },
   "publishConfig": {
     "access": "public"
   },

package.json

@@ -1,4 +1,4 @@
-import { success, error, invalid, notFound, notAuthorized, redirect } from './responses';
+import { success, error, invalid, notFound, notAuthorized, redirect, custom } from './responses';
 
 describe('API responses', () => {
   beforeEach(() => {
@@ -146,6 +146,17 @@ describe('API responses', () => {
     });
   });
 
+  it('Handles custom response', () => {
+    const response = custom({ statusCode: 418 });
+    expect(response).toEqual({
+      headers: {
+        'Access-Control-Allow-Origin': '*',
+        'Access-Control-Allow-Credentials': true,
+      },
+      statusCode: 418,
+    });
+  });
+
   it('Handles notFound response', () => {
     const response = notFound({ body: 'not found' });
     expect(response).toEqual({

src/api/shared/responses.test.ts

@@ -41,6 +41,12 @@ export function invalid({
   return response;
 }
 
+export function custom({ body, json = true, cors = true, statusCode, headers }: CustomParameters): ApiResponse {
+  const response = getResponseFromParameters({ body, json, cors, statusCode, headers });
+  metrics.custom(response);
+  return response;
+}
+
 const defaultNotFound: ResponseParameters = {
   cors: true,
   statusCode: 404,
@@ -135,6 +141,14 @@ export interface ResponseParameters {
   headers?: { [key: string]: any }; // custom headers to include
 }
 
+export interface CustomParameters {
+  body?: any; // response body
+  json?: boolean; // indicates if body should be JSON-stringified and content-type header set to application/json, defaults to true
+  cors?: boolean; // indicates if CORS headers should be added, defaults to true
+  statusCode: number; // status code to return, defaults by callback (success: 200, invalid: 400, notFound: 404, notAuthorized: 401, redirect: 302, error: 500)
+  headers?: { [key: string]: any }; // custom headers to include
+}
+
 export interface ErrorParameters {
   body?: any; // response body
   json?: boolean; // indicates if body should be JSON-stringified and content-type header set to application/json, defaults to true

src/api/shared/responses.ts

@@ -7,6 +7,7 @@ import {
   notAuthorized,
   error,
   redirect,
+  custom,
   ApiResponse,
   ResponseParameters,
   RedirectParameters,
@@ -33,6 +34,7 @@ export function api<T = any>(
       notAuthorized,
       error,
       redirect,
+      custom,
     };
     return custom(signature);
   };
@@ -53,6 +55,7 @@ export interface ApiSignature<T = any> {
   notAuthorized(params?: ResponseParameters): ApiResponse;
   redirect(params: RedirectParameters): ApiResponse;
   error(params?: ErrorParameters): ApiResponse;
+  custom(params: ResponseParameters): ApiResponse;
 }
 
 export interface WebsocketRequest {

src/api/v1/wrapper.ts

@@ -8,6 +8,7 @@ import {
   notAuthorized,
   error,
   redirect,
+  custom,
   ApiResponse,
   ResponseParameters,
   RedirectParameters,
@@ -33,6 +34,7 @@ export function httpApi<T = any>(
       notAuthorized,
       error,
       redirect,
+      custom,
     };
     return custom(signature);
   };
@@ -52,4 +54,5 @@ export interface HttpApiSignature<T = any> {
   notAuthorized(params?: ResponseParameters): ApiResponse;
   redirect(params: RedirectParameters): ApiResponse;
   error(params?: ErrorParameters): ApiResponse;
+  custom(params: ResponseParameters): ApiResponse;
 }

src/api/v2-http/wrapper.ts

@@ -45,4 +45,8 @@ export class Metrics {
   failure(response?: any): void {
     logger.debug(`Failure processing ${this.type} event, responding with`, response);
   }
+
+  custom(response?: any): void {
+    logger.debug(`Unknown processing status of ${this.type} event, responding with`, response);
+  }
 }