@cumulusds/aws-apig-bypass 0.3.0 → 1.0.0

package/README.md

@@ -7,6 +7,7 @@ We often build externally accessible REST endpoints using API Gateway and Lambda
 This library provides an adapter for the Lambda SDK to make it easy to directly invoke the handler.
 
 ```flow js
+import { createAPIGatewayEvent, createClient } from "@cumulusds/aws-apig-bypass";
 import { Lambda } from "aws-sdk";
 
 function getLunches(location: string, category: string): Promise<Array<Lunch>> {

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

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createAPIGatewayEvent;
+const defaultRequestContext = {
+  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: ""
+};
+function createAPIGatewayEvent({
+  body = null,
+  headers = {},
+  multiValueHeaders = {},
+  httpMethod = "",
+  isBase64Encoded = false,
+  pathParameters = null,
+  path = "",
+  queryStringParameters = null,
+  multiValueQueryStringParameters = null,
+  stageVariables = null,
+  requestContext = defaultRequestContext,
+  resource = ""
+} = {}) {
+  return {
+    body,
+    headers,
+    multiValueHeaders,
+    httpMethod,
+    isBase64Encoded,
+    path,
+    pathParameters,
+    queryStringParameters,
+    multiValueQueryStringParameters,
+    stageVariables,
+    requestContext,
+    resource
+  };
+}

package/lib/create-client.js

@@ -0,0 +1,23 @@
+"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 }; }
+/**
+ * Client that directly invokes an API Gateway handler, bypassing the gateway. The client handles packing and unpacking messages for invoking the handler.
+ */
+/**
+ * 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-lambda-client.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createLambdaClient;
+exports.LambdaInvokeError = void 0;
+class LambdaInvokeError extends Error {
+  constructor(response) {
+    var _response$FunctionErr;
+    super(["Invocation Failed", response.ExecutedVersion, response.StatusCode, response.FunctionError, response.Payload, response.LogResult != null ? Buffer.from(response.LogResult, "base64").toString("utf-8") : null].filter(x => x != null).join(": "));
+    this.code = (_response$FunctionErr = response.FunctionError) !== null && _response$FunctionErr !== void 0 ? _response$FunctionErr : "";
+  }
+}
+
+/**
+ * AWS Lambda SDK adapter for createClient.
+ */
+exports.LambdaInvokeError = LambdaInvokeError;
+function createLambdaClient({
+  Lambda,
+  FunctionName
+}) {
+  return async Payload => {
+    const invocationResponse = await Lambda.invoke({
+      FunctionName,
+      Payload
+    }).promise();
+    if (invocationResponse.StatusCode !== 200 || invocationResponse.FunctionError != null) {
+      throw new LambdaInvokeError(invocationResponse);
+    }
+    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/json-stringify.js

@@ -0,0 +1,20 @@
+"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/lambda-invoke.js

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

package/lib/parse-payload.js

@@ -0,0 +1,27 @@
+"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/response.js

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

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "@cumulusds/aws-apig-bypass",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "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",
   "engines": {
-    "node": "^14.15.0 || ^16.0.0 || ^18.0.0 || ^19.0.0"
+    "node": "^18.0.0 || ^20.0.0 || >=21.0.0"
   },
   "main": "lib/index.js",
-  "src": [
-    "bin, lib",
+  "files": [
+    "README.md",
+    "lib/*",
+    "lib/dynamodb/**",
+    "lib/services/**",
     "package.json"
   ],
   "scripts": {

package/.babelrc.js

@@ -1,15 +0,0 @@
-module.exports = {
-  presets: [
-    [
-      "@babel/preset-env",
-      {
-        targets: {
-          node: "10.15.0"
-        },
-        exclude: ["proposal-async-generator-functions"] // Do not transform async generator functions, since they are supported natively in Node 10 & 12.
-      }
-    ],
-    "@babel/preset-flow"
-  ],
-  plugins: ["@babel/plugin-proposal-nullish-coalescing-operator", "@babel/plugin-proposal-optional-chaining"]
-};

package/.eslintrc.js

@@ -1,15 +0,0 @@
-module.exports = {
-  extends: ["airbnb-base", "plugin:prettier/recommended", "plugin:flowtype/recommended"],
-  rules: {
-    "linebreak-style": "off",
-    "no-console": "off",
-    "no-restricted-syntax": "off"
-  },
-  plugins: ["jest", "flowtype"],
-  env: {
-    "jest/globals": true
-  },
-  parserOptions: {
-    ecmaVersion: 2020
-  }
-};

package/.flowconfig

@@ -1,13 +0,0 @@
-[ignore]
-<PROJECT_ROOT>/node_modules/config-chain/test/broken.json
-<PROJECT_ROOT>/node_modules/license-checker/tests/config/custom_format_broken.json
-<PROJECT_ROOT>/lib
-<PROJECT_ROOT>/node_modules/jest-resolve/node_modules/resolve/test/resolver/malformed_package_json/package.json
-
-[libs]
-node_modules/@cumulusds/flow-aws-sdk/index.js
-node_modules/@cumulusds/flow-aws-sdk/clients
-node_modules/@cumulusds/flow-aws-sdk/lib
-
-[lints]
-all=error