feat: api gateway v2 with config (#13)

* feat: api gateway with config

* feat: support value config

* feat: clean-up dependencies and pass config and logger to global

* chore: remove unused files

* chore: add success handler and update package version to beta

* chore(release): publish v0.0.3

* chore: add canary publishing

* chore: version package using canary

* chore: update package for carary script

* chore: update dependencies between packages to use file

* chore: force canary on env and aws packages

* chore: describe additional use cases

* feat: introduce mapping for success handler

* feat: add success response mapper

* fix: export create success response

* fix: linting issue for no unresolved aws-lambda module

* chore: enable confirmation before publishing packages

* fix: build before releasing change

* chore: publish ci published minor version

.eslintrc.js

@@ -59,7 +59,7 @@ module.exports = {
         devDependencies: ['**/__tests__/**']
       }
     ],
-    'import/no-unresolved': [2, { ignore: ['fsevents'] }],
+    'import/no-unresolved': [2, { ignore: ['fsevents', 'aws-lambda'] }],
     'import/order': 2,
     'no-console': 2,
     'no-restricted-imports': [

CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.0.3](https://github.com/cabiri-io/sls-pipe/compare/v0.0.2...v0.0.3) (2020-11-17)
+
+
+### Features
+
+* api gateway with config ([c8e49c0](https://github.com/cabiri-io/sls-pipe/commit/c8e49c019ed4830bb43b2d13bd56dbafa3c5aed3))
+* clean-up dependencies and pass config and logger to global ([ffd5aa1](https://github.com/cabiri-io/sls-pipe/commit/ffd5aa1ca132207cd012f72008f1712fe7a1bb38))
+* support value config ([0013bff](https://github.com/cabiri-io/sls-pipe/commit/0013bff60b2c29d66257128a4a02ba4820992d71))
+
+
+
+
+
 ## 0.0.2 (2020-07-29)
 
 

lerna.json

@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.0.2",
+  "version": "0.0.3",
   "command": {
     "version": {
       "includeMergedTags": true,

package.json

@@ -20,7 +20,8 @@
     "pretty-quick": "pretty-quick",
     "prettify:fix": "prettier --write 'packages/**/*.{js,ts}'",
     "prettify": "prettier --check 'packages/**/*.{js,ts}'",
-    "publish:ci": "lerna publish patch --yes --create-release github  --conventional-commits"
+    "publish:canary": "yarn build && lerna publish --canary --force-publish=@cabiri-io/sls-env,@cabiri-io/sls-aws",
+    "publish:ci": "yarn build && lerna publish minor --create-release github --conventional-commits"
   },
   "workspaces": [
     "packages/*"

packages/sls-app/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.0.3](https://github.com/cabiri-io/sls-pipe/compare/v0.0.2...v0.0.3) (2020-11-17)
+
+**Note:** Version bump only for package @cabiri-io/sls-app
+
+
+
+
+
 ## 0.0.2 (2020-07-29)
 
 

packages/sls-app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cabiri-io/sls-app",
-  "version": "0.0.2",
+  "version": "0.0.3-alpha.1",
   "author": "Cabiri <[email protected]>",
   "license": "UNLICENSED",
   "repository": {

packages/sls-aws/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.0.3](https://github.com/cabiri-io/sls-pipe/compare/v0.0.2...v0.0.3) (2020-11-17)
+
+
+### Features
+
+* api gateway with config ([c8e49c0](https://github.com/cabiri-io/sls-pipe/commit/c8e49c019ed4830bb43b2d13bd56dbafa3c5aed3))
+
+
+
+
+
 ## 0.0.2 (2020-07-29)
 
 

packages/sls-aws/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cabiri-io/sls-aws",
-  "version": "0.0.2",
+  "version": "0.0.3-alpha.1",
   "author": "Cabiri <[email protected]>",
   "license": "UNLICENSED",
   "repository": {
@@ -16,9 +16,11 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@cabiri-io/sls-env": "^0.0.2"
+    "@cabiri-io/sls-env": "file:../sls-env"
   },
-  "devDependencies": {
+  "optionalDependencies": {
     "@types/aws-lambda": "^8.10.59"
+  },
+  "devDependencies": {
   }
 }

packages/sls-aws/src/api-gateway/__tests__/response.test.ts

@@ -0,0 +1,48 @@
+import { createSuccessResponse } from '../index'
+
+describe('structure response', () => {
+  it('creates response with sensible defaults', () => {
+    const successResponse = createSuccessResponse()
+
+    const result = successResponse({ message: 'value' })
+
+    expect(result).toMatchInlineSnapshot(`
+      Object {
+        "body": "{\\"message\\":\\"value\\"}",
+        "statusCode": 200,
+      }
+    `)
+  })
+
+  it('allows override of status code', () => {
+    type Message = { message: string }
+    const successResponse = createSuccessResponse<Message, never>({ statusCode: 201 })
+
+    const result = successResponse({ message: 'value' })
+
+    expect(result).toMatchInlineSnapshot(`
+      Object {
+        "body": "{\\"message\\":\\"value\\"}",
+        "statusCode": 201,
+      }
+    `)
+  })
+
+  it('allows mapping between different types', () => {
+    type Message = { message: string }
+    type Echo = { value: string }
+
+    const message2Echo = (m: Message): Echo => ({ value: m.message })
+
+    const successResponse = createSuccessResponse<Message, Echo>({ statusCode: 201, mapper: message2Echo })
+
+    const result = successResponse({ message: 'hello' })
+
+    expect(result).toMatchInlineSnapshot(`
+      Object {
+        "body": "{\\"value\\":\\"hello\\"}",
+        "statusCode": 201,
+      }
+    `)
+  })
+})

packages/sls-aws/src/api-gateway/handler.ts

@@ -0,0 +1,14 @@
+import { EnvConfig, Handler, SlsEnvironment, environment } from '@cabiri-io/sls-env'
+import type { APIGatewayProxyEventV2, APIGatewayProxyResultV2, Context } from 'aws-lambda'
+import { createSuccessResponse } from './response'
+
+type APIGatewayV2Handler<T = never> = Handler<APIGatewayProxyEventV2, Context, APIGatewayProxyResultV2<T>>
+
+// fixme: or maybe we create a different versions of apiGatewayV2 for example
+// apiGatewayV2<D, P, R>
+// apiGatewayV2Config<D, P, R, C>
+// apiGatewayV2CustomResponse<D, P, R, HR, C = never>
+export const apiGatewayV2 = <D, P, R, C = never>(
+  config?: EnvConfig
+): SlsEnvironment<APIGatewayV2Handler<never>, C, D, P, R> =>
+  environment<APIGatewayV2Handler<never>, C, D, P, R>(config).successHandler(createSuccessResponse())

packages/sls-aws/src/api-gateway/index.ts

@@ -0,0 +1,2 @@
+export { createSuccessResponse } from './response'
+export { apiGatewayV2 } from './handler'

packages/sls-aws/src/api-gateway/response.ts

@@ -0,0 +1,14 @@
+import type { APIGatewayProxyStructuredResultV2 } from 'aws-lambda'
+
+type StructuredResult<T, R> = APIGatewayProxyStructuredResultV2 & { mapper?: (t: T) => R }
+
+export const createSuccessResponse = <T, R = never>(config?: StructuredResult<T, R extends never ? T : R>) => (
+  t: T
+): APIGatewayProxyStructuredResultV2 => {
+  const { mapper, statusCode, ...defaultValues } = config ?? {}
+  return {
+    statusCode: statusCode ?? 200,
+    ...defaultValues,
+    body: JSON.stringify(mapper?.(t) ?? t)
+  }
+}

packages/sls-aws/src/index.ts

@@ -1,11 +1,2 @@
-import { EnvConfig, SlsEnvironment, environment } from '@cabiri-io/sls-env'
-// eslint-disable-next-line import/no-unresolved
-import type { Context, SNSEvent } from 'aws-lambda'
-import { jsonSNSMessage } from './sns/json-sns-message'
-import { jsonSNSMessages } from './sns/json-sns-messages'
-
-export const snsMessage = <D, P>(config?: EnvConfig): SlsEnvironment<SNSEvent, Context, D, P, void> =>
-  environment<SNSEvent, Context, D, P, void>(config).payload(jsonSNSMessage)
-
-export const snsMessages = <D, P>(config?: EnvConfig): SlsEnvironment<SNSEvent, Context, D, Array<P>, void> =>
-  environment<SNSEvent, Context, D, Array<P>, void>(config).payload(jsonSNSMessages)
+export { snsMessage, snsMessages } from './sns'
+export { apiGatewayV2, createSuccessResponse } from './api-gateway'

packages/sls-aws/src/sns/index.ts

@@ -0,0 +1,12 @@
+import { EnvConfig, Handler, SlsEnvironment, environment } from '@cabiri-io/sls-env'
+import type { Context, SNSEvent } from 'aws-lambda'
+import { jsonSNSMessage } from './json-sns-message'
+import { jsonSNSMessages } from './json-sns-messages'
+
+type SNSHandler = Handler<SNSEvent, Context, void>
+
+export const snsMessage = <D, P, C = never>(config?: EnvConfig): SlsEnvironment<SNSHandler, C, D, P> =>
+  environment<SNSHandler, C, D, P>(config).payload(jsonSNSMessage)
+
+export const snsMessages = <D, P, C = never>(config?: EnvConfig): SlsEnvironment<SNSHandler, C, D, Array<P>> =>
+  environment<SNSHandler, C, D, Array<P>>(config).payload(jsonSNSMessages)

packages/sls-aws/src/sns/json-sns-message.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/no-unresolved
 import type { Context, SNSEvent } from 'aws-lambda'
 
 import { PayloadError, PayloadParseError } from '../error/parse'

packages/sls-aws/src/sns/json-sns-messages.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/no-unresolved
 import type { Context, SNSEvent } from 'aws-lambda'
 
 import { PayloadParseError } from '../error/parse'

packages/sls-aws/tsconfig.json

@@ -2,6 +2,6 @@
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist",
+    "outDir": "dist"
   }
 }

packages/sls-env/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.0.3](https://github.com/cabiri-io/sls-pipe/compare/v0.0.2...v0.0.3) (2020-11-17)
+
+
+### Features
+
+* api gateway with config ([c8e49c0](https://github.com/cabiri-io/sls-pipe/commit/c8e49c019ed4830bb43b2d13bd56dbafa3c5aed3))
+* clean-up dependencies and pass config and logger to global ([ffd5aa1](https://github.com/cabiri-io/sls-pipe/commit/ffd5aa1ca132207cd012f72008f1712fe7a1bb38))
+* support value config ([0013bff](https://github.com/cabiri-io/sls-pipe/commit/0013bff60b2c29d66257128a4a02ba4820992d71))
+
+
+
+
+
 ## 0.0.2 (2020-07-29)
 
 

packages/sls-env/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cabiri-io/sls-env",
-  "version": "0.0.2",
+  "version": "0.0.3-alpha.1",
   "author": "Cabiri <[email protected]>",
   "license": "UNLICENSED",
   "description": "Environment to build your serverless applications",
@@ -16,9 +16,6 @@
   "homepage": "https://github.com/cabiri-io/sls-pipe#readme",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "dependencies": {
-    "lodash.camelcase": "^4.3.0"
-  },
   "devDependencies": {
     "@types/lodash.camelcase": "^4.3.6",
     "@types/lodash.snakecase": "^4.1.6",