@byaga/cdk-patterns 0.11.0 → 0.11.2

package/lib/create-stack.d.ts

@@ -1,6 +1,7 @@
 import { IConstruct } from "constructs";
 import { Stack } from "aws-cdk-lib";
 import { StackProps } from "aws-cdk-lib/core";
+import { StackConfiguration } from "./load-configuration";
 /**
  * Interface for the arguments when creating a stack.
  */
@@ -19,6 +20,7 @@ export interface DeployStack {
     name: string;
     stage: string;
     project: string;
+    config: StackConfiguration;
 }
 /**
  * Creates a new stack.

package/lib/create-stack.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setCurrentStack = exports.getCurrentStack = exports.createStack = void 0;
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const generate_identifier_1 = require("./generate-identifier");
+const load_configuration_1 = require("./load-configuration");
 /**
  * Creates a new stack.
  * @param {IConstruct} scope - The scope in which to define this construct.
@@ -24,6 +25,7 @@ function createStack(scope, props) {
         name: props.stackName,
         stage,
         project: props.project,
+        config: (0, load_configuration_1.loadConfiguration)(stage)
     });
 }
 exports.createStack = createStack;

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export { buildNodeSource } from './build/nodejs/build-node-source';
 export { buildEcmaScript } from './build/nodejs/build-ecmascript';
 export { buildTypeScript } from './build/nodejs/build-typescript';
 export { createNodeJsLambda } from './lambda/create-nodejs-lambda';
-export { createStack } from './create-stack';
+export { createStack, StackArguments, getCurrentStack } from './create-stack';
+export { StackConfiguration } from './load-configuration';
 export { genName, genId, genStackResourceName, genStackResourceId } from './generate-identifier';
 export * as ssm from "./ssm";

package/lib/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ssm = exports.genStackResourceId = exports.genStackResourceName = exports.genId = exports.genName = exports.createStack = exports.createNodeJsLambda = exports.buildTypeScript = exports.buildEcmaScript = exports.buildNodeSource = void 0;
+exports.ssm = exports.genStackResourceId = exports.genStackResourceName = exports.genId = exports.genName = exports.getCurrentStack = exports.createStack = exports.createNodeJsLambda = exports.buildTypeScript = exports.buildEcmaScript = exports.buildNodeSource = void 0;
 var build_node_source_1 = require("./build/nodejs/build-node-source");
 Object.defineProperty(exports, "buildNodeSource", { enumerable: true, get: function () { return build_node_source_1.buildNodeSource; } });
 var build_ecmascript_1 = require("./build/nodejs/build-ecmascript");
@@ -34,6 +34,7 @@ var create_nodejs_lambda_1 = require("./lambda/create-nodejs-lambda");
 Object.defineProperty(exports, "createNodeJsLambda", { enumerable: true, get: function () { return create_nodejs_lambda_1.createNodeJsLambda; } });
 var create_stack_1 = require("./create-stack");
 Object.defineProperty(exports, "createStack", { enumerable: true, get: function () { return create_stack_1.createStack; } });
+Object.defineProperty(exports, "getCurrentStack", { enumerable: true, get: function () { return create_stack_1.getCurrentStack; } });
 var generate_identifier_1 = require("./generate-identifier");
 Object.defineProperty(exports, "genName", { enumerable: true, get: function () { return generate_identifier_1.genName; } });
 Object.defineProperty(exports, "genId", { enumerable: true, get: function () { return generate_identifier_1.genId; } });

package/lib/lambda/create-function.d.ts

@@ -10,7 +10,7 @@ export interface FunctionIntegrationProps {
 }
 export interface FunctionIntegration {
     id: string;
-    function: Lambda;
+    lambda: Lambda;
 }
 /**
  * Initializes a new function

package/lib/lambda/create-function.js

@@ -23,14 +23,14 @@ function createFunction(id, options) {
     const { stack } = (0, create_stack_1.getCurrentStack)();
     const details = {
         id,
-        function: new aws_lambda_1.Function(stack, (0, generate_identifier_1.genStackResourceId)(id, 'lambda'), props)
+        lambda: new aws_lambda_1.Function(stack, (0, generate_identifier_1.genStackResourceId)(id, 'lambda'), props)
     };
     new aws_cdk_lib_1.CfnOutput(stack, (0, generate_identifier_1.genStackResourceId)(id, 'function-name'), {
-        value: details.function.functionName,
+        value: details.lambda.functionName,
         exportName: (0, generate_identifier_1.genStackResourceName)(id, 'function-name')
     });
     new aws_logs_1.LogRetention(stack, (0, generate_identifier_1.genStackResourceId)(id, 'log-retention'), {
-        logGroupName: details.function.logGroup.logGroupName,
+        logGroupName: details.lambda.logGroup.logGroupName,
         retention: aws_logs_1.RetentionDays.ONE_WEEK,
         removalPolicy: core_1.RemovalPolicy.DESTROY,
     });

package/lib/load-configuration.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Interface for the stack configuration.
+ */
+export interface StackConfiguration {
+}
+/**
+ * Loads the configuration for a given stage.
+ * If the configuration file does not exist, an empty object is returned.
+ * @param {string} stage - The stage for which to load the configuration. Defaults to the value of the STAGE environment variable, or "develop" if STAGE is not set.
+ * @returns {StackConfiguration} The loaded configuration.
+ */
+export declare function loadConfiguration(stage?: string): StackConfiguration;

package/lib/load-configuration.js

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfiguration = void 0;
+const yaml = __importStar(require("js-yaml"));
+const fs = __importStar(require("fs-extra"));
+/**
+ * Loads the configuration for a given stage.
+ * If the configuration file does not exist, an empty object is returned.
+ * @param {string} stage - The stage for which to load the configuration. Defaults to the value of the STAGE environment variable, or "develop" if STAGE is not set.
+ * @returns {StackConfiguration} The loaded configuration.
+ */
+function loadConfiguration(stage = process.env.STAGE || "develop") {
+    const path = `config/${stage}.yml`;
+    if (fs.existsSync(path)) {
+        return yaml.load(fs.readFileSync(`config/${stage}.yml`).toString());
+    }
+    return {};
+}
+exports.loadConfiguration = loadConfiguration;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byaga/cdk-patterns",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "Collection of common patterns used when making AWS CloudFormation templates using CDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -24,12 +24,14 @@
     "constructs": "^10.3.0",
     "fs-extra": "^11.2.0",
     "glob": "^10.3.10",
-    "ignore": "^5.3.0"
+    "ignore": "^5.3.0",
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.11",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^20.11.5",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",
@@ -38,7 +40,6 @@
     "jest-html-reporters": "^3.1.7",
     "jest-junit": "^16.0.0",
     "ts-jest": "^29.1.1",
-    "ts-mockito": "^2.6.1",
     "typescript": "^5.3.3"
   },
   "repository": {