@cumulusds/aws-apig-bypass 0.0.1

package/lib/create-api-gateway-event.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createAPIGatewayEvent;
+
+function createAPIGatewayEvent({
+  pathParameters = null,
+  path = "",
+  body = null,
+  queryStringParameters = null
+} = {}) {
+  return {
+    body,
+    headers: {},
+    multiValueHeaders: {},
+    httpMethod: "",
+    isBase64Encoded: false,
+    path,
+    pathParameters,
+    queryStringParameters,
+    multiValueQueryStringParameters: null,
+    stageVariables: null,
+    requestContext: {
+      accountId: "",
+      apiId: "",
+      httpMethod: "",
+      identity: {
+        accessKey: null,
+        accountId: null,
+        apiKey: null,
+        caller: null,
+        cognitoAuthenticationProvider: null,
+        cognitoAuthenticationType: null,
+        cognitoIdentityId: null,
+        cognitoIdentityPoolId: null,
+        sourceIp: "",
+        user: null,
+        userAgent: null,
+        userArn: null
+      },
+      stage: "",
+      requestId: "",
+      resourceId: "",
+      resourcePath: ""
+    },
+    resource: ""
+  };
+}

package/lib/create-api-gateway-event.js.flow

@@ -0,0 +1,57 @@
+// @flow
+
+import type { APIGatewayEvent } from "flow-aws-lambda";
+
+export type PathParameters = { [name: string]: string } | null;
+export type QueryStringParameters = { [name: string]: string } | null;
+
+export type CreateAPIGatewayEventOptions = {
+  body?: string,
+  path?: string,
+  pathParameters?: PathParameters,
+  queryStringParameters?: QueryStringParameters
+};
+
+export default function createAPIGatewayEvent({
+  pathParameters = null,
+  path = "",
+  body = null,
+  queryStringParameters = null
+}: CreateAPIGatewayEventOptions = {}): APIGatewayEvent<string> {
+  return {
+    body,
+    headers: {},
+    multiValueHeaders: {},
+    httpMethod: "",
+    isBase64Encoded: false,
+    path,
+    pathParameters,
+    queryStringParameters,
+    multiValueQueryStringParameters: null,
+    stageVariables: null,
+    requestContext: {
+      accountId: "",
+      apiId: "",
+      httpMethod: "",
+      identity: {
+        accessKey: null,
+        accountId: null,
+        apiKey: null,
+        caller: null,
+        cognitoAuthenticationProvider: null,
+        cognitoAuthenticationType: null,
+        cognitoIdentityId: null,
+        cognitoIdentityPoolId: null,
+        sourceIp: "",
+        user: null,
+        userAgent: null,
+        userArn: null
+      },
+      stage: "",
+      requestId: "",
+      resourceId: "",
+      resourcePath: ""
+    },
+    resource: ""
+  };
+}

package/lib/create-client.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createClient;
+
+var _createLambdaClient = _interopRequireDefault(require("./create-lambda-client"));
+
+var _jsonStringify = _interopRequireDefault(require("./json-stringify"));
+
+var _parsePayload = _interopRequireDefault(require("./parse-payload"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Create an APIGatewayHandlerClient. The client invokes an API Gateway handler, bypassing the gateway. It adapts the AWS SDK by packing and unpacking messages for invoking the handler.
+ *
+ * @param options
+ * @returns {APIGatewayHandlerClient<T>}
+ */
+function createClient(options) {
+  const client = (0, _createLambdaClient.default)(options);
+  return async event => (0, _parsePayload.default)((await client((0, _jsonStringify.default)(event))));
+}

package/lib/create-client.js.flow

@@ -0,0 +1,30 @@
+// @flow
+
+import type { APIGatewayEvent } from "flow-aws-lambda";
+import createLambdaClient from "./create-lambda-client";
+import type { Response } from "./response";
+import jsonStringify from "./json-stringify";
+import parsePayload from "./parse-payload";
+import type { LambdaInvoke } from "./lambda-invoke";
+
+/**
+ * Client that directly invokes an API Gateway handler, bypassing the gateway. The client handles packing and unpacking messages for invoking the handler.
+ */
+export type APIGatewayHandlerClient<T> = (event: APIGatewayEvent<string>) => Promise<Response<T>>;
+
+export type CreateClientOptions<T> = {
+  Lambda: LambdaInvoke,
+  FunctionName: string,
+  Validate?: T => void
+};
+
+/**
+ * Create an APIGatewayHandlerClient. The client invokes an API Gateway handler, bypassing the gateway. It adapts the AWS SDK by packing and unpacking messages for invoking the handler.
+ *
+ * @param options
+ * @returns {APIGatewayHandlerClient<T>}
+ */
+export default function createClient<T>(options: CreateClientOptions<T>): APIGatewayHandlerClient<T> {
+  const client = createLambdaClient(options);
+  return async (event: APIGatewayEvent<string>) => parsePayload<T>(await client(jsonStringify(event)));
+}

package/lib/create-lambda-client.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createLambdaClient;
+
+/**
+ * AWS Lambda SDK adapter for createClient.
+ */
+function createLambdaClient({
+  Lambda,
+  FunctionName
+}) {
+  return async Payload => {
+    const invocationResponse = await Lambda.invoke({
+      FunctionName,
+      Payload
+    }).promise();
+
+    if (invocationResponse.StatusCode !== 200) {
+      var _invocationResponse$S;
+
+      throw new Error(`AWS Lambda invocation API failed with status ${(_invocationResponse$S = invocationResponse.StatusCode) !== null && _invocationResponse$S !== void 0 ? _invocationResponse$S : "(no status code)"}`);
+    }
+
+    if (typeof invocationResponse.Payload !== "string") {
+      throw new Error(`AWS Lambda invocation API returned the wrong payload type '${typeof invocationResponse.Payload}'; expected 'string'`);
+    }
+
+    return invocationResponse.Payload;
+  };
+}

package/lib/create-lambda-client.js.flow

@@ -0,0 +1,35 @@
+// @flow
+
+import type { LambdaInvoke } from "./lambda-invoke";
+
+interface Blob {}
+type _Blob = Buffer | Uint8Array | Blob | string;
+type LambdaClientType = (event: _Blob) => Promise<string>;
+
+export type CreateLambdaClientOptions = {
+  Lambda: LambdaInvoke,
+  FunctionName: string
+};
+
+/**
+ * AWS Lambda SDK adapter for createClient.
+ */
+export default function createLambdaClient({ Lambda, FunctionName }: CreateLambdaClientOptions): LambdaClientType {
+  return async (Payload: _Blob) => {
+    const invocationResponse = await Lambda.invoke({
+      FunctionName,
+      Payload
+    }).promise();
+    if (invocationResponse.StatusCode !== 200) {
+      throw new Error(
+        `AWS Lambda invocation API failed with status ${invocationResponse.StatusCode ?? "(no status code)"}`
+      );
+    }
+    if (typeof invocationResponse.Payload !== "string") {
+      throw new Error(
+        `AWS Lambda invocation API returned the wrong payload type '${typeof invocationResponse.Payload}'; expected 'string'`
+      );
+    }
+    return invocationResponse.Payload;
+  };
+}

package/lib/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "createClient", {
+  enumerable: true,
+  get: function () {
+    return _createClient.default;
+  }
+});
+Object.defineProperty(exports, "createAPIGatewayEvent", {
+  enumerable: true,
+  get: function () {
+    return _createApiGatewayEvent.default;
+  }
+});
+
+var _createClient = _interopRequireDefault(require("./create-client"));
+
+var _createApiGatewayEvent = _interopRequireDefault(require("./create-api-gateway-event"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib/index.js.flow

@@ -0,0 +1,4 @@
+// @flow
+
+export { default as createClient } from "./create-client";
+export { default as createAPIGatewayEvent } from "./create-api-gateway-event";

package/lib/json-stringify.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = jsonStringify;
+
+/**
+ * Stringify to JSON, returning a string or else throwing an exception because of unserializable input.
+ *
+ * @param value
+ * @returns {string}
+ */
+// flowlint-next-line unclear-type:off
+function jsonStringify(value) {
+  const result = JSON.stringify(value);
+
+  if (result == null) {
+    throw new Error("Cannot stringify value");
+  }
+
+  return result;
+}

package/lib/json-stringify.js.flow

@@ -0,0 +1,16 @@
+// @flow
+
+/**
+ * Stringify to JSON, returning a string or else throwing an exception because of unserializable input.
+ *
+ * @param value
+ * @returns {string}
+ */
+// flowlint-next-line unclear-type:off
+export default function jsonStringify(value: any): string {
+  const result = JSON.stringify(value);
+  if (result == null) {
+    throw new Error("Cannot stringify value");
+  }
+  return result;
+}

package/lib/lambda-invoke.js

@@ -0,0 +1 @@
+"use strict";

package/lib/lambda-invoke.js.flow

@@ -0,0 +1,10 @@
+// @flow
+
+import type Lambda from "@cumulusds/flow-aws-sdk/clients/lambda";
+
+/**
+ * This library only needs the invoke method from aws-sdk Lambda client.
+ */
+export type LambdaInvoke = {
+  +invoke: $PropertyType<Lambda, "invoke">
+};

package/lib/parse-payload.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = parsePayload;
+
+/**
+ * Decode the handler response
+ *
+ * @param payload
+ * @param validate if given, the validate function is called on the parsed response body. The function should throw an exception if the response is invalid.
+ * @returns {{headers: {[p: string]: boolean|number|string}, data: *, status: number}}
+ */
+function parsePayload(payload, validate) {
+  var _proxyResult$headers;
+
+  const proxyResult = JSON.parse(payload);
+
+  if (proxyResult.isBase64Encoded === true) {
+    throw new Error("A base64 encoded response from API Gateway handler was received, but is not supported.");
+  }
+
+  const data = JSON.parse(proxyResult.body);
+  validate === null || validate === void 0 ? void 0 : validate(data);
+  return {
+    data,
+    status: proxyResult.statusCode,
+    headers: (_proxyResult$headers = proxyResult.headers) !== null && _proxyResult$headers !== void 0 ? _proxyResult$headers : {}
+  };
+}

package/lib/parse-payload.js.flow

@@ -0,0 +1,25 @@
+// @flow
+
+import type { ProxyResult } from "flow-aws-lambda";
+import type { Response } from "./response";
+
+/**
+ * Decode the handler response
+ *
+ * @param payload
+ * @param validate if given, the validate function is called on the parsed response body. The function should throw an exception if the response is invalid.
+ * @returns {{headers: {[p: string]: boolean|number|string}, data: *, status: number}}
+ */
+export default function parsePayload<T>(payload: string, validate?: T => void): Response<T> {
+  const proxyResult: ProxyResult = JSON.parse(payload);
+  if (proxyResult.isBase64Encoded === true) {
+    throw new Error("A base64 encoded response from API Gateway handler was received, but is not supported.");
+  }
+  const data: T = JSON.parse(proxyResult.body);
+  validate?.(data);
+  return {
+    data,
+    status: proxyResult.statusCode,
+    headers: proxyResult.headers ?? {}
+  };
+}

package/lib/response.js

@@ -0,0 +1 @@
+"use strict";

package/lib/response.js.flow

@@ -0,0 +1,15 @@
+// @flow
+
+/**
+ * Decoded handler response
+ */
+export type Response<T> = {|
+  // the response provided by the handler
+  data: T,
+
+  // the HTTP status code
+  status: number,
+
+  // response headers
+  headers: { [header: string]: boolean | number | string }
+|};

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@cumulusds/aws-apig-bypass",
+  "version": "0.0.1",
+  "description": "Client for API Gateway handlers, bypassing API Gateway by directly invoking the Lambda",
+  "repository": "https://github.com/CumulusDS/aws-apig-bypass",
+  "author": "Cumulus Digital Systems",
+  "license": "MIT",
+  "private": false,
+  "engines": {
+    "node": ">=10"
+  },
+  "main": "lib/index.js",
+  "src": [
+    "bin, lib",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "run-p build:babel build:flow-copy-source build:license-checker",
+    "build:babel": "babel src --out-dir lib --ignore test.js",
+    "build:flow-copy-source": "flow-copy-source --ignore test.js src lib",
+    "build:license-checker": "license-checker --csv --out var/licenses.csv",
+    "clean": "shx rm -rf lib",
+    "git:push": "git push --follow-tags",
+    "publish:patch": "run-s version:patch git:push",
+    "publish:minor": "run-s version:minor git:push",
+    "publish:major": "run-s version:major git:push",
+    "sites": "node bin/sites.js",
+    "test": "run-p --aggregate-output test:**",
+    "test:flow:coverage-report": "flow-coverage-report -i '{src,test}/**/*.js' -t html -t text --threshold 99 --output-dir var/coverage/flow",
+    "test:flow:status": "flow status",
+    "test:jest": "jest --color",
+    "test:lint": "eslint *.js src test",
+    "test:prettier": "prettier --list-different \"{src,test}/**/*.{js,jsx,yml}\" \"*.{js,yml}\"",
+    "version:patch": "yarn version --new-version patch",
+    "version:minor": "yarn version --new-version minor",
+    "version:major": "yarn version --new-version major"
+  },
+  "jest": {
+    "verbose": true,
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "src/**/*.js"
+    ],
+    "testEnvironment": "node",
+    "coverageDirectory": "var/coverage/test",
+    "coverageThreshold": {
+      "global": {
+        "branches": 100,
+        "functions": 100,
+        "lines": 100,
+        "statements": 100
+      }
+    }
+  },
+  "dependencies": {
+    "@cumulusds/flow-aws-sdk": "^2.818.0",
+    "flow-aws-lambda": "CumulusDS/flow-aws-lambda#ef1bd9a0342e55a0e9e1b225bdbc2a3c2a4d5632"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.0.0",
+    "@babel/core": "^7.7.4",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.7.4",
+    "@babel/plugin-proposal-optional-chaining": "^7.12.7",
+    "@babel/preset-env": "^7.0.0",
+    "@babel/preset-flow": "^7.0.0",
+    "babel-eslint": "10.0.3",
+    "babel-jest": "^24.9.0",
+    "eslint": "^7.5.0",
+    "eslint-config-airbnb-base": "14.0.0",
+    "eslint-config-prettier": "^2.9.0",
+    "eslint-plugin-flowtype": "^2.49.3",
+    "eslint-plugin-import": "2.18.2",
+    "eslint-plugin-jest": "^21.15.1",
+    "eslint-plugin-prettier": "^2.6.0",
+    "flow-bin": "^0.141.0",
+    "flow-copy-source": "^2.0.9",
+    "flow-coverage-report": "^0.8.0",
+    "flow-typed": "^3.2.1",
+    "git-describe": "^4.0.4",
+    "jest": "^26.0.0",
+    "license-checker": "^25.0.1",
+    "npm-run-all": "^4.1.3",
+    "prettier": "^1.14.0",
+    "shx": "^0.3.2"
+  }
+}

package/prettier.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  printWidth: 120
+};

package/src/create-api-gateway-event.js

@@ -0,0 +1,57 @@
+// @flow
+
+import type { APIGatewayEvent } from "flow-aws-lambda";
+
+export type PathParameters = { [name: string]: string } | null;
+export type QueryStringParameters = { [name: string]: string } | null;
+
+export type CreateAPIGatewayEventOptions = {
+  body?: string,
+  path?: string,
+  pathParameters?: PathParameters,
+  queryStringParameters?: QueryStringParameters
+};
+
+export default function createAPIGatewayEvent({
+  pathParameters = null,
+  path = "",
+  body = null,
+  queryStringParameters = null
+}: CreateAPIGatewayEventOptions = {}): APIGatewayEvent<string> {
+  return {
+    body,
+    headers: {},
+    multiValueHeaders: {},
+    httpMethod: "",
+    isBase64Encoded: false,
+    path,
+    pathParameters,
+    queryStringParameters,
+    multiValueQueryStringParameters: null,
+    stageVariables: null,
+    requestContext: {
+      accountId: "",
+      apiId: "",
+      httpMethod: "",
+      identity: {
+        accessKey: null,
+        accountId: null,
+        apiKey: null,
+        caller: null,
+        cognitoAuthenticationProvider: null,
+        cognitoAuthenticationType: null,
+        cognitoIdentityId: null,
+        cognitoIdentityPoolId: null,
+        sourceIp: "",
+        user: null,
+        userAgent: null,
+        userArn: null
+      },
+      stage: "",
+      requestId: "",
+      resourceId: "",
+      resourcePath: ""
+    },
+    resource: ""
+  };
+}

package/src/create-client.js

@@ -0,0 +1,30 @@
+// @flow
+
+import type { APIGatewayEvent } from "flow-aws-lambda";
+import createLambdaClient from "./create-lambda-client";
+import type { Response } from "./response";
+import jsonStringify from "./json-stringify";
+import parsePayload from "./parse-payload";
+import type { LambdaInvoke } from "./lambda-invoke";
+
+/**
+ * Client that directly invokes an API Gateway handler, bypassing the gateway. The client handles packing and unpacking messages for invoking the handler.
+ */
+export type APIGatewayHandlerClient<T> = (event: APIGatewayEvent<string>) => Promise<Response<T>>;
+
+export type CreateClientOptions<T> = {
+  Lambda: LambdaInvoke,
+  FunctionName: string,
+  Validate?: T => void
+};
+
+/**
+ * Create an APIGatewayHandlerClient. The client invokes an API Gateway handler, bypassing the gateway. It adapts the AWS SDK by packing and unpacking messages for invoking the handler.
+ *
+ * @param options
+ * @returns {APIGatewayHandlerClient<T>}
+ */
+export default function createClient<T>(options: CreateClientOptions<T>): APIGatewayHandlerClient<T> {
+  const client = createLambdaClient(options);
+  return async (event: APIGatewayEvent<string>) => parsePayload<T>(await client(jsonStringify(event)));
+}

package/src/create-lambda-client.js

@@ -0,0 +1,35 @@
+// @flow
+
+import type { LambdaInvoke } from "./lambda-invoke";
+
+interface Blob {}
+type _Blob = Buffer | Uint8Array | Blob | string;
+type LambdaClientType = (event: _Blob) => Promise<string>;
+
+export type CreateLambdaClientOptions = {
+  Lambda: LambdaInvoke,
+  FunctionName: string
+};
+
+/**
+ * AWS Lambda SDK adapter for createClient.
+ */
+export default function createLambdaClient({ Lambda, FunctionName }: CreateLambdaClientOptions): LambdaClientType {
+  return async (Payload: _Blob) => {
+    const invocationResponse = await Lambda.invoke({
+      FunctionName,
+      Payload
+    }).promise();
+    if (invocationResponse.StatusCode !== 200) {
+      throw new Error(
+        `AWS Lambda invocation API failed with status ${invocationResponse.StatusCode ?? "(no status code)"}`
+      );
+    }
+    if (typeof invocationResponse.Payload !== "string") {
+      throw new Error(
+        `AWS Lambda invocation API returned the wrong payload type '${typeof invocationResponse.Payload}'; expected 'string'`
+      );
+    }
+    return invocationResponse.Payload;
+  };
+}

package/src/index.js

@@ -0,0 +1,4 @@
+// @flow
+
+export { default as createClient } from "./create-client";
+export { default as createAPIGatewayEvent } from "./create-api-gateway-event";

package/src/json-stringify.js

@@ -0,0 +1,16 @@
+// @flow
+
+/**
+ * Stringify to JSON, returning a string or else throwing an exception because of unserializable input.
+ *
+ * @param value
+ * @returns {string}
+ */
+// flowlint-next-line unclear-type:off
+export default function jsonStringify(value: any): string {
+  const result = JSON.stringify(value);
+  if (result == null) {
+    throw new Error("Cannot stringify value");
+  }
+  return result;
+}

package/src/lambda-invoke.js

@@ -0,0 +1,10 @@
+// @flow
+
+import type Lambda from "@cumulusds/flow-aws-sdk/clients/lambda";
+
+/**
+ * This library only needs the invoke method from aws-sdk Lambda client.
+ */
+export type LambdaInvoke = {
+  +invoke: $PropertyType<Lambda, "invoke">
+};

package/src/parse-payload.js

@@ -0,0 +1,25 @@
+// @flow
+
+import type { ProxyResult } from "flow-aws-lambda";
+import type { Response } from "./response";
+
+/**
+ * Decode the handler response
+ *
+ * @param payload
+ * @param validate if given, the validate function is called on the parsed response body. The function should throw an exception if the response is invalid.
+ * @returns {{headers: {[p: string]: boolean|number|string}, data: *, status: number}}
+ */
+export default function parsePayload<T>(payload: string, validate?: T => void): Response<T> {
+  const proxyResult: ProxyResult = JSON.parse(payload);
+  if (proxyResult.isBase64Encoded === true) {
+    throw new Error("A base64 encoded response from API Gateway handler was received, but is not supported.");
+  }
+  const data: T = JSON.parse(proxyResult.body);
+  validate?.(data);
+  return {
+    data,
+    status: proxyResult.statusCode,
+    headers: proxyResult.headers ?? {}
+  };
+}