@aptos-scp/isl-component-resource-definition 1.0.1 → 1.0.3

package/README.md

@@ -2,6 +2,66 @@
 
 Component is used to automate the initialization of AWS resources, specifically AWS EventBridge, based on user-defined metadata. 
 
+## Usage
+
+The component provides a CLI wrapper for AWS SAM commands with environment variable substitution.
+
+### Basic Usage
+
+```bash
+resource-definition deploy --stack-name %STACK_NAME%
+```
+
+### Environment Variable Substitution
+
+Arguments wrapped with `%` are replaced with their corresponding environment variable values:
+
+```bash
+# If STACK_NAME=my-stack
+resource-definition deploy --stack-name %STACK_NAME%
+# Executes: sam deploy --stack-name my-stack
+```
+
+### Parameter Overrides
+
+The `PARAMETER_OVERRIDE` environment variable supports special handling for nested environment variables:
+
+#### Key-Value with Environment Variable Reference
+
+```bash
+# Environment variables:
+# PARAMETER_OVERRIDE="IslSample=$ISL_SAMPLE IslResponseEventbusArn=arn:aws:events:eu-west-1:123456789:event-bus/my-bus"
+# ISL_SAMPLE=sample-value
+
+resource-definition deploy --parameter-overrides %PARAMETER_OVERRIDE%
+# Executes: sam deploy --parameter-overrides IslSample=sample-value IslResponseEventbusArn=arn:aws:events:eu-west-1:123456789:event-bus/my-bus
+```
+
+#### Standalone Environment Variable Reference
+
+When `PARAMETER_OVERRIDE` contains `$ENV_VAR_NAME` without a key, the environment variable name is converted to PascalCase as the key:
+
+```bash
+# Environment variables:
+# PARAMETER_OVERRIDE="$ISL_RESPONSE_EVENTBUS_ARN"
+# ISL_RESPONSE_EVENTBUS_ARN=arn:aws:events:eu-west-1:123456789:event-bus/my-bus
+
+resource-definition deploy --parameter-overrides %PARAMETER_OVERRIDE%
+# Executes: sam deploy --parameter-overrides IslResponseEventbusArn=arn:aws:events:eu-west-1:123456789:event-bus/my-bus
+```
+
+#### Mixed Format
+
+```bash
+# Environment variables:
+# PARAMETER_OVERRIDE="$ISL_SAMPLE CustomKey=$CUSTOM_VALUE StaticKey=static-value"
+# ISL_SAMPLE=sample-value
+# CUSTOM_VALUE=custom-resolved
+
+resource-definition deploy --parameter-overrides %PARAMETER_OVERRIDE%
+# Executes: sam deploy --parameter-overrides IslSample=sample-value CustomKey=custom-resolved StaticKey=static-value
+```
+
 ## Establish environment variables (workstation installation)
 
 Copy the .env.example file with default/sample environment variables for development to .env.

package/lib/resource-definition/implementations/SamResourceDefinition.d.ts

@@ -2,4 +2,6 @@ import { IResourceDefinition } from "../interfaces/IResourceDefinition";
 export declare class SamResourceDefinition implements IResourceDefinition {
     execute(inputCommand: string, args: string[]): Promise<void>;
     private evaluateEnvVars;
+    private evaluateParameterOverride;
+    private snakeCaseToPascalCase;
 }

package/lib/resource-definition/implementations/SamResourceDefinition.js

@@ -30,11 +30,49 @@ class SamResourceDefinition {
         return args.map((arg) => {
             if (arg.startsWith("%") && arg.endsWith("%")) {
                 const envVar = arg.slice(1, -1);
-                return process.env[envVar] || "";
+                const envValue = process.env[envVar] || "";
+                if (envVar === "PARAMETER_OVERRIDE") {
+                    return this.evaluateParameterOverride(envValue);
+                }
+                return envValue;
             }
             return arg;
         });
     }
+    evaluateParameterOverride(value) {
+        return value
+            .split(" ")
+            .filter((item) => item.trim() !== "")
+            .map((pair) => {
+            const equalsIndex = pair.indexOf("=");
+            // Handle standalone $ENV_VAR without key=value format
+            if (equalsIndex === -1 && pair.startsWith("$")) {
+                const envVarName = pair.slice(1);
+                const pascalCaseKey = this.snakeCaseToPascalCase(envVarName);
+                const envValue = process.env[envVarName] || "";
+                return `${pascalCaseKey}=${envValue}`;
+            }
+            if (equalsIndex === -1) {
+                return pair;
+            }
+            const key = pair.slice(0, equalsIndex);
+            const pairValue = pair.slice(equalsIndex + 1);
+            if (pairValue.startsWith("$")) {
+                const nestedEnvVar = pairValue.slice(1);
+                const nestedValue = process.env[nestedEnvVar] || "";
+                return `${key}=${nestedValue}`;
+            }
+            return pair;
+        })
+            .join(" ");
+    }
+    snakeCaseToPascalCase(snakeCase) {
+        return snakeCase
+            .toLowerCase()
+            .split("_")
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+            .join("");
+    }
 }
 exports.SamResourceDefinition = SamResourceDefinition;
 //# sourceMappingURL=SamResourceDefinition.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/isl-component-resource-definition",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Component is used to create Serverless application",
   "private": false,
   "license": "SEE LICENSE IN LICENSE.md",