@goldstack/utils-aws-lambda 0.1.4 → 0.1.8

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/collectLambdasFromFiles.d.ts

@@ -1,14 +1,14 @@
-export declare enum RouteType {
-    DIR = "DIR",
-    FUNCTION = "FUNCTION"
-}
-export interface LambdaConfig {
-    name: string;
-    type: RouteType;
-    absoluteFilePath: string;
-    relativeFilePath: string;
-    path: string;
-    route: string;
-}
-export declare function readLambdaConfig(dir: string): LambdaConfig[];
+export declare enum RouteType {
+    DIR = "DIR",
+    FUNCTION = "FUNCTION"
+}
+export interface LambdaConfig {
+    name: string;
+    type: RouteType;
+    absoluteFilePath: string;
+    relativeFilePath: string;
+    path: string;
+    route: string;
+}
+export declare function readLambdaConfig(dir: string): LambdaConfig[];
 //# sourceMappingURL=collectLambdasFromFiles.d.ts.map

package/dist/src/generate/collectLambdasFromFiles.js

@@ -1,103 +1,103 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readLambdaConfig = exports.RouteType = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = require("path");
-var RouteType;
-(function (RouteType) {
-    RouteType["DIR"] = "DIR";
-    RouteType["FUNCTION"] = "FUNCTION";
-})(RouteType = exports.RouteType || (exports.RouteType = {}));
-function readLambdaConfig(dir) {
-    const result = readLambdaConfigImpl(dir, dir);
-    if (!result.children) {
-        throw new Error('Invalid directory ' + dir);
-    }
-    return flattenConfig(result.children).filter((e) => e.type === RouteType.FUNCTION);
-}
-exports.readLambdaConfig = readLambdaConfig;
-function flattenConfig(config) {
-    const arr = [];
-    for (const child of Object.entries(config)) {
-        const newVal = { ...child[1] };
-        newVal.children = undefined;
-        arr.push(newVal);
-        if (child[1].children) {
-            arr.push(...flattenConfig(child[1].children));
-        }
-    }
-    return arr;
-}
-function posixPath(pathstring) {
-    return pathstring.split(path_1.sep).join(path_1.posix.sep);
-}
-function removeExtension(path) {
-    return path.replace(/\.[^/.]+$/, '');
-}
-function makePath(configRoot, dir) {
-    const path = removeExtension(posixPath((0, path_1.relative)(configRoot, dir)));
-    if (path === '$index') {
-        return '/';
-    }
-    if (path.indexOf('$index') !== -1) {
-        let newPath = path.replace('$index', '');
-        // API Gateway does not accept routes like /myroute/
-        newPath = newPath.slice(0, newPath.length - 1);
-        return `/${newPath}`;
-    }
-    if (path === '$default') {
-        return '$default';
-    }
-    return `/${path}`;
-}
-function makeRoute(configRoot, dir) {
-    const route = makePath(configRoot, dir);
-    if (route === '$default') {
-        return '$default';
-    }
-    return `ANY ${route}`;
-}
-function readLambdaConfigImpl(configRoot, dir) {
-    const root = dir;
-    const rootRoute = makeRoute(configRoot, dir);
-    const configItem = {
-        name: root,
-        type: RouteType.DIR,
-        absoluteFilePath: dir,
-        path: makePath(configRoot, dir),
-        relativeFilePath: (0, path_1.relative)(configRoot, dir),
-        route: rootRoute,
-    };
-    const dirHandle = fs_1.default.opendirSync(dir);
-    let dirEntry;
-    while ((dirEntry = dirHandle.readSync()) !== null) {
-        if (!configItem.children) {
-            configItem.children = {};
-        }
-        const name = dirEntry.name;
-        const fullPath = (0, path_1.resolve)(root, name);
-        if (dirEntry.isDirectory()) {
-            configItem.children[name] = readLambdaConfigImpl(configRoot, fullPath);
-        }
-        else if (dirEntry.isFile()) {
-            const route = makeRoute(configRoot, fullPath);
-            configItem.children[name] = {
-                name: removeExtension(name),
-                type: RouteType.FUNCTION,
-                path: makePath(configRoot, fullPath),
-                absoluteFilePath: fullPath,
-                relativeFilePath: (0, path_1.relative)(configRoot, fullPath),
-                route: route,
-            };
-        }
-        else {
-            continue;
-        }
-    }
-    dirHandle.closeSync();
-    return configItem;
-}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readLambdaConfig = exports.RouteType = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+var RouteType;
+(function (RouteType) {
+    RouteType["DIR"] = "DIR";
+    RouteType["FUNCTION"] = "FUNCTION";
+})(RouteType = exports.RouteType || (exports.RouteType = {}));
+function readLambdaConfig(dir) {
+    const result = readLambdaConfigImpl(dir, dir);
+    if (!result.children) {
+        throw new Error('Invalid directory ' + dir);
+    }
+    return flattenConfig(result.children).filter((e) => e.type === RouteType.FUNCTION);
+}
+exports.readLambdaConfig = readLambdaConfig;
+function flattenConfig(config) {
+    const arr = [];
+    for (const child of Object.entries(config)) {
+        const newVal = { ...child[1] };
+        newVal.children = undefined;
+        arr.push(newVal);
+        if (child[1].children) {
+            arr.push(...flattenConfig(child[1].children));
+        }
+    }
+    return arr;
+}
+function posixPath(pathstring) {
+    return pathstring.split(path_1.sep).join(path_1.posix.sep);
+}
+function removeExtension(path) {
+    return path.replace(/\.[^/.]+$/, '');
+}
+function makePath(configRoot, dir) {
+    const path = removeExtension(posixPath((0, path_1.relative)(configRoot, dir)));
+    if (path === '$index') {
+        return '/';
+    }
+    if (path.indexOf('$index') !== -1) {
+        let newPath = path.replace('$index', '');
+        // API Gateway does not accept routes like /myroute/
+        newPath = newPath.slice(0, newPath.length - 1);
+        return `/${newPath}`;
+    }
+    if (path === '$default') {
+        return '$default';
+    }
+    return `/${path}`;
+}
+function makeRoute(configRoot, dir) {
+    const route = makePath(configRoot, dir);
+    if (route === '$default') {
+        return '$default';
+    }
+    return `ANY ${route}`;
+}
+function readLambdaConfigImpl(configRoot, dir) {
+    const root = dir;
+    const rootRoute = makeRoute(configRoot, dir);
+    const configItem = {
+        name: root,
+        type: RouteType.DIR,
+        absoluteFilePath: dir,
+        path: makePath(configRoot, dir),
+        relativeFilePath: (0, path_1.relative)(configRoot, dir),
+        route: rootRoute,
+    };
+    const dirHandle = fs_1.default.opendirSync(dir);
+    let dirEntry;
+    while ((dirEntry = dirHandle.readSync()) !== null) {
+        if (!configItem.children) {
+            configItem.children = {};
+        }
+        const name = dirEntry.name;
+        const fullPath = (0, path_1.resolve)(root, name);
+        if (dirEntry.isDirectory()) {
+            configItem.children[name] = readLambdaConfigImpl(configRoot, fullPath);
+        }
+        else if (dirEntry.isFile()) {
+            const route = makeRoute(configRoot, fullPath);
+            configItem.children[name] = {
+                name: removeExtension(name),
+                type: RouteType.FUNCTION,
+                path: makePath(configRoot, fullPath),
+                absoluteFilePath: fullPath,
+                relativeFilePath: (0, path_1.relative)(configRoot, fullPath),
+                route: route,
+            };
+        }
+        else {
+            continue;
+        }
+    }
+    dirHandle.closeSync();
+    return configItem;
+}
 //# sourceMappingURL=collectLambdasFromFiles.js.map

package/dist/src/generate/collectLambdasFromFiles.spec.d.ts

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=collectLambdasFromFiles.spec.d.ts.map

package/dist/src/generate/collectLambdasFromFiles.spec.js

@@ -1,26 +1,26 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = __importDefault(require("assert"));
-const collectLambdasFromFiles_1 = require("./collectLambdasFromFiles");
-describe('Lambda utils', () => {
-    const routes = (0, collectLambdasFromFiles_1.readLambdaConfig)('./testData/routes');
-    it('Should obtain config from files', async () => {
-        var _a, _b;
-        (0, assert_1.default)(!!routes.find((e) => e.route === '$default'));
-        (0, assert_1.default)(!!routes.find((e) => e.route === 'ANY /bird/abilities'));
-        (0, assert_1.default)(!!routes.find((e) => e.route === 'ANY /'));
-        (0, assert_1.default)(!!routes.find((e) => e.route === 'ANY /bird'));
-        (0, assert_1.default)(((_a = routes.find((e) => e.route === 'ANY /bird')) === null || _a === void 0 ? void 0 : _a.relativeFilePath) ===
-            'bird.ts');
-        (0, assert_1.default)(((_b = routes.find((e) => e.route === 'ANY /bird')) === null || _b === void 0 ? void 0 : _b.name) === 'bird');
-    });
-    it('Should be able to handle index files', async () => {
-        // console.log(JSON.stringify(routes, null, 2));
-        const indexRoute = routes.find((e) => e.route === 'ANY /dog');
-        (0, assert_1.default)(indexRoute !== undefined);
-    });
-});
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
+const collectLambdasFromFiles_1 = require("./collectLambdasFromFiles");
+describe('Lambda utils', () => {
+    const routes = (0, collectLambdasFromFiles_1.readLambdaConfig)('./testData/routes');
+    it('Should obtain config from files', async () => {
+        var _a, _b;
+        (0, assert_1.default)(!!routes.find((e) => e.route === '$default'));
+        (0, assert_1.default)(!!routes.find((e) => e.route === 'ANY /bird/abilities'));
+        (0, assert_1.default)(!!routes.find((e) => e.route === 'ANY /'));
+        (0, assert_1.default)(!!routes.find((e) => e.route === 'ANY /bird'));
+        (0, assert_1.default)(((_a = routes.find((e) => e.route === 'ANY /bird')) === null || _a === void 0 ? void 0 : _a.relativeFilePath) ===
+            'bird.ts');
+        (0, assert_1.default)(((_b = routes.find((e) => e.route === 'ANY /bird')) === null || _b === void 0 ? void 0 : _b.name) === 'bird');
+    });
+    it('Should be able to handle index files', async () => {
+        // console.log(JSON.stringify(routes, null, 2));
+        const indexRoute = routes.find((e) => e.route === 'ANY /dog');
+        (0, assert_1.default)(indexRoute !== undefined);
+    });
+});
 //# sourceMappingURL=collectLambdasFromFiles.spec.js.map

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

@@ -1,6 +1,6 @@
-import { LambdaConfig } from './collectLambdasFromFiles';
-/**
- * Generates a valid function name for a route
- */
-export declare const generateFunctionName: (prefix: string | undefined, config: LambdaConfig) => string;
+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.js

@@ -1,42 +1,42 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFunctionName = void 0;
-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_gateway_lambda_2281';
-    }
-    if (name === '$index') {
-        name = 'index_root_lambda_4423';
-    }
-    name = santiseFunctionName(name);
-    let pathPrefix = '';
-    const segments = config.path.split('/');
-    if (segments.length === 2 && name === 'index_root_lambda_4423') {
-        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;
-    return name;
-};
-exports.generateFunctionName = generateFunctionName;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateFunctionName = void 0;
+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_gateway_lambda_2281';
+    }
+    if (name === '$index') {
+        name = 'index_root_lambda_4423';
+    }
+    name = santiseFunctionName(name);
+    let pathPrefix = '';
+    const segments = config.path.split('/');
+    if (segments.length === 2 && name === 'index_root_lambda_4423') {
+        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;
+    return name;
+};
+exports.generateFunctionName = generateFunctionName;
 //# sourceMappingURL=generateFunctionName.js.map

package/dist/src/utilsAwsLambda.d.ts

@@ -1,13 +1,13 @@
-export { readLambdaConfig } from './generate/collectLambdasFromFiles';
-export { generateFunctionName } from './generate/generateFunctionName';
-export type { LambdaConfig } from './generate/collectLambdasFromFiles';
-import AWS from 'aws-sdk';
-export interface DeployFunctionParams {
-    lambdaPackageDir: string;
-    targetArchiveName?: string;
-    awsCredentials: AWS.Credentials;
-    region: string;
-    functionName: string;
-}
-export declare const deployFunction: (params: DeployFunctionParams) => Promise<any>;
+export { readLambdaConfig } from './generate/collectLambdasFromFiles';
+export { generateFunctionName } from './generate/generateFunctionName';
+export type { LambdaConfig } from './generate/collectLambdasFromFiles';
+import AWS from 'aws-sdk';
+export interface DeployFunctionParams {
+    lambdaPackageDir: string;
+    targetArchiveName?: string;
+    awsCredentials: AWS.Credentials;
+    region: string;
+    functionName: string;
+}
+export declare const deployFunction: (params: DeployFunctionParams) => Promise<any>;
 //# sourceMappingURL=utilsAwsLambda.d.ts.map

package/dist/src/utilsAwsLambda.js

@@ -1,51 +1,51 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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);
-    await (0, utils_sh_1.zip)({
-        directory: params.lambdaPackageDir,
-        target: targetArchive,
-        mode: 511,
-    });
-    const deployResult = await (0, utils_aws_cli_1.awsCli)({
-        credentials: params.awsCredentials,
-        region: params.region,
-        options: {
-            silent: true,
-        },
-        command: `lambda update-function-code --function-name ${params.functionName} --zip-file fileb://${targetArchive}`,
-    });
-    if (!params.targetArchiveName) {
-        await (0, utils_sh_1.rmSafe)(targetArchive);
-    }
-    // wait until lambda becomes active
-    let counter = 0;
-    let state = '';
-    while (counter < 20 && state !== 'Active') {
-        const res = await (0, utils_aws_cli_1.awsCli)({
-            credentials: params.awsCredentials,
-            region: params.region,
-            options: {
-                silent: true,
-            },
-            command: `lambda get-function --function-name ${params.functionName}`,
-        });
-        const data = JSON.parse(res);
-        state = data.Configuration.State;
-        counter++;
-    }
-    if (counter >= 20) {
-        throw new Error(`Function was still in state '${state}' after deployment`);
-    }
-    return JSON.parse(deployResult);
-};
-exports.deployFunction = deployFunction;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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);
+    await (0, utils_sh_1.zip)({
+        directory: params.lambdaPackageDir,
+        target: targetArchive,
+        mode: 511,
+    });
+    const deployResult = await (0, utils_aws_cli_1.awsCli)({
+        credentials: params.awsCredentials,
+        region: params.region,
+        options: {
+            silent: true,
+        },
+        command: `lambda update-function-code --function-name ${params.functionName} --zip-file fileb://${targetArchive}`,
+    });
+    if (!params.targetArchiveName) {
+        await (0, utils_sh_1.rmSafe)(targetArchive);
+    }
+    // wait until lambda becomes active
+    let counter = 0;
+    let state = '';
+    while (counter < 20 && state !== 'Active') {
+        const res = await (0, utils_aws_cli_1.awsCli)({
+            credentials: params.awsCredentials,
+            region: params.region,
+            options: {
+                silent: true,
+            },
+            command: `lambda get-function --function-name ${params.functionName}`,
+        });
+        const data = JSON.parse(res);
+        state = data.Configuration.State;
+        counter++;
+    }
+    if (counter >= 20) {
+        throw new Error(`Function was still in state '${state}' after deployment`);
+    }
+    return JSON.parse(deployResult);
+};
+exports.deployFunction = deployFunction;
 //# sourceMappingURL=utilsAwsLambda.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goldstack/utils-aws-lambda",
-  "version": "0.1.4",
+  "version": "0.1.8",
   "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.37",
     "@goldstack/utils-log": "0.2.9",
     "@goldstack/utils-sh": "0.4.22",
     "aws-sdk": "2.1001.0"