@goldstack/utils-aws-lambda 0.1.3 → 0.1.7

package/README.md

@@ -1,3 +1,38 @@
 # Goldstack AWS Lambda Tools
 
-This library provides a simple wrapper around the AWS CLI to deploy Lambdas.
+This library provides a simple wrapper around the AWS CLI to deploy Lambdas and define Lambda infrastructure.
+
+## deployFunction
+
+This function will deploy an AWS lambda. Note this function will either need Docker to be available locally or the AWS cli.
+
+```typescript
+interface DeployFunctionParams {
+  lambdaPackageDir: string;
+  targetArchiveName?: string;
+  awsCredentials: AWS.Credentials;
+  region: string;
+  functionName: string;
+}
+
+function async deployFunction(
+  params: DeployFunctionParams
+): Promise<any> {}
+```
+
+## readLambdaConfig
+
+This function will generate a configuration for AWS HTTP API Gateway based on `.ts` files in a folder. For more information, see [Goldstack Documentation - Defining Routes](https://docs.goldstack.party/docs/modules/lambda-api#defining-routes-1)
+
+```typescript
+export interface LambdaConfig {
+  name: string;
+  type: RouteType;
+  absoluteFilePath: string;
+  relativeFilePath: string;
+  path: string;
+  route: string;
+}
+
+function readLambdaConfig(dir: string): LambdaConfig[] {}
+```

package/dist/src/generate/generateFunctionName.d.ts

@@ -0,0 +1,6 @@
+import { LambdaConfig } from './collectLambdasFromFiles';
+/**
+ * Generates a valid function name for a route
+ */
+export declare const generateFunctionName: (prefix: string | undefined, config: LambdaConfig) => string;
+//# sourceMappingURL=generateFunctionName.d.ts.map

package/dist/src/generate/generateFunctionName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateFunctionName.d.ts","sourceRoot":"","sources":["../../../src/generate/generateFunctionName.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAgBzD;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,GAAG,SAAS,UAClB,YAAY,KACnB,MAoCF,CAAC"}

package/dist/src/generate/generateFunctionName.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateFunctionName = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const INDEX_MARKER = '__index';
+const DEFAULT_MARKER = '__default';
+const santiseFunctionName = (input) => {
+    return input
+        .replace(/\//g, '-')
+        .replace(/\$/g, '_')
+        .replace(/\{/g, '_')
+        .replace(/\}/g, '_')
+        .replace(/\+/g, '_')
+        .replace(/[^\w\-_]/gi, '_');
+};
+/**
+ * Generates a valid function name for a route
+ */
+const generateFunctionName = (prefix, config) => {
+    let name = config.name;
+    if (name === '$default') {
+        // '$' is not a valid character in a lambda function name
+        name = DEFAULT_MARKER;
+    }
+    if (name === '$index') {
+        name = INDEX_MARKER;
+    }
+    name = santiseFunctionName(name);
+    let pathPrefix = '';
+    const segments = config.path.split('/');
+    if (segments.length === 2 && name === INDEX_MARKER) {
+        pathPrefix = `${segments[1]}-`;
+    }
+    if (segments.length > 2) {
+        segments.shift(); // remove first element since path starts with '/' and thus the first element is always ''
+        segments.pop(); // remove the last element since that is the name of the function in the route
+        pathPrefix = santiseFunctionName(segments.join('-'));
+        pathPrefix = `${pathPrefix}-`;
+    }
+    name = `${pathPrefix}${name}`;
+    name = (`${prefix}-` || '') + name;
+    // Lambda names cannot be larger than 64 characters
+    // in that case shorten name and append a hash
+    if (name.length > 64) {
+        name = `${name.substring(0, 40)}-${crypto_1.default
+            .createHash('md5')
+            .update(name)
+            .digest('hex')
+            .substring(0, 20)}`;
+    }
+    return name;
+};
+exports.generateFunctionName = generateFunctionName;
+//# sourceMappingURL=generateFunctionName.js.map

package/dist/src/generate/generateFunctionName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateFunctionName.js","sourceRoot":"","sources":["../../../src/generate/generateFunctionName.ts"],"names":[],"mappings":";;;;;;AACA,oDAA4B;AAE5B,MAAM,YAAY,GAAG,SAAS,CAAC;AAC/B,MAAM,cAAc,GAAG,WAAW,CAAC;AAEnC,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAU,EAAE;IACpD,OAAO,KAAK;SACT,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF;;GAEG;AACI,MAAM,oBAAoB,GAAG,CAClC,MAA0B,EAC1B,MAAoB,EACZ,EAAE;IACV,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACvB,IAAI,IAAI,KAAK,UAAU,EAAE;QACvB,yDAAyD;QACzD,IAAI,GAAG,cAAc,CAAC;KACvB;IACD,IAAI,IAAI,KAAK,QAAQ,EAAE;QACrB,IAAI,GAAG,YAAY,CAAC;KACrB;IACD,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEjC,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,KAAK,YAAY,EAAE;QAClD,UAAU,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC;KAChC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,0FAA0F;QAC5G,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,8EAA8E;QAC9F,UAAU,GAAG,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACrD,UAAU,GAAG,GAAG,UAAU,GAAG,CAAC;KAC/B;IAED,IAAI,GAAG,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC;IAC9B,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IAEnC,mDAAmD;IACnD,8CAA8C;IAC9C,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE;QACpB,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,gBAAM;aACtC,UAAU,CAAC,KAAK,CAAC;aACjB,MAAM,CAAC,IAAI,CAAC;aACZ,MAAM,CAAC,KAAK,CAAC;aACb,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;KACvB;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAvCW,QAAA,oBAAoB,wBAuC/B"}

package/dist/src/utilsAwsLambda.d.ts

@@ -1,4 +1,5 @@
 export { readLambdaConfig } from './generate/collectLambdasFromFiles';
+export { generateFunctionName } from './generate/generateFunctionName';
 export type { LambdaConfig } from './generate/collectLambdasFromFiles';
 import AWS from 'aws-sdk';
 export interface DeployFunctionParams {

package/dist/src/utilsAwsLambda.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utilsAwsLambda.d.ts","sourceRoot":"","sources":["../../src/utilsAwsLambda.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,GAAG,MAAM,SAAS,CAAC;AAE1B,MAAM,WAAW,oBAAoB;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,GAAG,CAAC,WAAW,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,cAAc,WACjB,oBAAoB,KAC3B,QAAQ,GAAG,CA2Cb,CAAC"}
+{"version":3,"file":"utilsAwsLambda.d.ts","sourceRoot":"","sources":["../../src/utilsAwsLambda.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,GAAG,MAAM,SAAS,CAAC;AAE1B,MAAM,WAAW,oBAAoB;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,GAAG,CAAC,WAAW,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,cAAc,WACjB,oBAAoB,KAC3B,QAAQ,GAAG,CA2Cb,CAAC"}

package/dist/src/utilsAwsLambda.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deployFunction = exports.readLambdaConfig = void 0;
+exports.deployFunction = exports.generateFunctionName = exports.readLambdaConfig = void 0;
 const utils_aws_cli_1 = require("@goldstack/utils-aws-cli");
 const utils_sh_1 = require("@goldstack/utils-sh");
 var collectLambdasFromFiles_1 = require("./generate/collectLambdasFromFiles");
 Object.defineProperty(exports, "readLambdaConfig", { enumerable: true, get: function () { return collectLambdasFromFiles_1.readLambdaConfig; } });
+var generateFunctionName_1 = require("./generate/generateFunctionName");
+Object.defineProperty(exports, "generateFunctionName", { enumerable: true, get: function () { return generateFunctionName_1.generateFunctionName; } });
 const deployFunction = async (params) => {
     const targetArchive = params.targetArchiveName || `lambda-${new Date().getTime()}.zip`;
     await (0, utils_sh_1.rmSafe)(targetArchive);

package/dist/src/utilsAwsLambda.js.map

@@ -1 +1 @@
-{"version":3,"file":"utilsAwsLambda.js","sourceRoot":"","sources":["../../src/utilsAwsLambda.ts"],"names":[],"mappings":";;;AAAA,4DAAkD;AAClD,kDAAkD;AAElD,8EAAsE;AAA7D,2HAAA,gBAAgB,OAAA;AAclB,MAAM,cAAc,GAAG,KAAK,EACjC,MAA4B,EACd,EAAE;IAChB,MAAM,aAAa,GACjB,MAAM,CAAC,iBAAiB,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;IAEnE,MAAM,IAAA,iBAAM,EAAC,aAAa,CAAC,CAAC;IAC5B,MAAM,IAAA,cAAG,EAAC;QACR,SAAS,EAAE,MAAM,CAAC,gBAAgB;QAClC,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,IAAA,sBAAM,EAAC;QAChC,WAAW,EAAE,MAAM,CAAC,cAAc;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE;YACP,MAAM,EAAE,IAAI;SACb;QACD,OAAO,EAAE,+CAA+C,MAAM,CAAC,YAAY,uBAAuB,aAAa,EAAE;KAClH,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;QAC7B,MAAM,IAAA,iBAAM,EAAC,aAAa,CAAC,CAAC;KAC7B;IAED,mCAAmC;IACnC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,OAAO,OAAO,GAAG,EAAE,IAAI,KAAK,KAAK,QAAQ,EAAE;QACzC,MAAM,GAAG,GAAG,MAAM,IAAA,sBAAM,EAAC;YACvB,WAAW,EAAE,MAAM,CAAC,cAAc;YAClC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE;gBACP,MAAM,EAAE,IAAI;aACb;YACD,OAAO,EAAE,uCAAuC,MAAM,CAAC,YAAY,EAAE;SACtE,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QACjC,OAAO,EAAE,CAAC;KACX;IACD,IAAI,OAAO,IAAI,EAAE,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,oBAAoB,CAAC,CAAC;KAC5E;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC,CAAC;AA7CW,QAAA,cAAc,kBA6CzB"}
+{"version":3,"file":"utilsAwsLambda.js","sourceRoot":"","sources":["../../src/utilsAwsLambda.ts"],"names":[],"mappings":";;;AAAA,4DAAkD;AAClD,kDAAkD;AAElD,8EAAsE;AAA7D,2HAAA,gBAAgB,OAAA;AAEzB,wEAAuE;AAA9D,4HAAA,oBAAoB,OAAA;AActB,MAAM,cAAc,GAAG,KAAK,EACjC,MAA4B,EACd,EAAE;IAChB,MAAM,aAAa,GACjB,MAAM,CAAC,iBAAiB,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;IAEnE,MAAM,IAAA,iBAAM,EAAC,aAAa,CAAC,CAAC;IAC5B,MAAM,IAAA,cAAG,EAAC;QACR,SAAS,EAAE,MAAM,CAAC,gBAAgB;QAClC,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,IAAA,sBAAM,EAAC;QAChC,WAAW,EAAE,MAAM,CAAC,cAAc;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE;YACP,MAAM,EAAE,IAAI;SACb;QACD,OAAO,EAAE,+CAA+C,MAAM,CAAC,YAAY,uBAAuB,aAAa,EAAE;KAClH,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;QAC7B,MAAM,IAAA,iBAAM,EAAC,aAAa,CAAC,CAAC;KAC7B;IAED,mCAAmC;IACnC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,OAAO,OAAO,GAAG,EAAE,IAAI,KAAK,KAAK,QAAQ,EAAE;QACzC,MAAM,GAAG,GAAG,MAAM,IAAA,sBAAM,EAAC;YACvB,WAAW,EAAE,MAAM,CAAC,cAAc;YAClC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE;gBACP,MAAM,EAAE,IAAI;aACb;YACD,OAAO,EAAE,uCAAuC,MAAM,CAAC,YAAY,EAAE;SACtE,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QACjC,OAAO,EAAE,CAAC;KACX;IACD,IAAI,OAAO,IAAI,EAAE,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,oBAAoB,CAAC,CAAC;KAC5E;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC,CAAC;AA7CW,QAAA,cAAc,kBA6CzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goldstack/utils-aws-lambda",
-  "version": "0.1.3",
+  "version": "0.1.7",
   "description": "Utilities for deploying AWS Lambda functions",
   "keywords": [
     "goldstack",
@@ -42,7 +42,7 @@
     "version:apply:force": "yarn version $@ && yarn version apply"
   },
   "dependencies": {
-    "@goldstack/utils-aws-cli": "0.3.35",
+    "@goldstack/utils-aws-cli": "0.3.36",
     "@goldstack/utils-log": "0.2.9",
     "@goldstack/utils-sh": "0.4.22",
     "aws-sdk": "2.1001.0"