lambda-live-debugger 1.0.4 → 1.0.5

package/README.md

@@ -109,6 +109,8 @@ The configuration is saved to `lldebugger.config.ts`.
  -o, --observable                Observable mode
  -i --interval <interval>        Observable mode interval (default: "3000")
  --config-env <evironment>       SAM environment
+ --sam-config-file <file>        SAM configuration file
+ --sam-template-file <file>      SAM template file
  --profile <profile>             AWS profile to use
  --region <region>               AWS region to use
  --role <role>                   AWS role to use

package/dist/configuration/getConfigFromCliArgs.mjs

@@ -21,6 +21,8 @@ export async function getConfigFromCliArgs(supportedFrameworks = []) {
     program.option('-o, --observable', 'Observable mode');
     program.option('-i --interval <interval>', 'Observable mode interval', defaultObservableInterval.toString());
     program.option('--config-env <evironment>', 'SAM environment');
+    program.option('--sam-config-file <file>', 'SAM configuration file');
+    program.option('--sam-template-file <file>', 'SAM template file');
     program.option('--profile <profile>', 'AWS profile to use');
     program.option('--region <region>', 'AWS region to use');
     program.option('--role <role>', 'AWS role to use');

package/dist/configuration/getConfigFromWizard.mjs

@@ -86,6 +86,18 @@ export async function getConfigFromWizard({ configFromCliArgs, supportedFramewor
                 message: 'Would you like to enter SAM environment?',
                 default: configFromCliArgs.configEnv ?? currentConfig?.configEnv,
             },
+            {
+                type: 'input',
+                name: 'samConfigFile',
+                message: 'Would you like to enter SAM configuration file (default = samconfig.toml)?',
+                default: configFromCliArgs.samConfigFile ?? currentConfig?.samConfigFile,
+            },
+            {
+                type: 'input',
+                name: 'samTemplateFile',
+                message: 'Would you like to enter SAM template file (default = template.yaml)?',
+                default: configFromCliArgs.samTemplateFile ?? currentConfig?.samTemplateFile,
+            },
         ]);
         answers = { ...answers, ...samAnswers };
     }
@@ -108,9 +120,9 @@ export async function getConfigFromWizard({ configFromCliArgs, supportedFramewor
             type: 'confirm',
             name: 'observable',
             message: 'Do you want to use observable mode, which just sends events to the debugger and do not use the respose?',
-            default: configFromCliArgs.observable !== undefined
+            default: !!(configFromCliArgs.observable !== undefined
                 ? configFromCliArgs.observable
-                : currentConfig?.observable,
+                : currentConfig?.observable),
         },
     ]);
     answers = { ...answers, ...answersObservable };
@@ -273,7 +285,7 @@ import { type LldConfigTs } from "lambda-live-debugger";
 export default {
   // Framework to use
   framework: "${config.framework}",
-  // AWS CDK context
+  // AWS CDK framework context
   context: ${config.context ? JSON.stringify(config.context) : undefined},
   // Serverless Framework stage
   stage: "${config.stage}",
@@ -287,8 +299,12 @@ export default {
   region: "${config.region}",
   // AWS role
   role: "${config.role}",
-  // SAM environment
+  // SAM framework environment
   configEnv: "${config.configEnv}",
+  // SAM framework configuration file
+  samConfigFile: "${config.samConfigFile}",
+  // SAM framework template file
+  samTemplateFile: "${config.samTemplateFile}",
   // Observable mode
   observable: ${config.observable},
   // Observable mode interval
@@ -327,6 +343,8 @@ function getConfigFromAnswers(answers) {
         region: answers.region,
         role: answers.role,
         configEnv: answers.configEnv,
+        samConfigFile: answers.samConfigFile,
+        samTemplateFile: answers.samTemplateFile,
         observable: answers.observable,
         interval: answers.interval !== undefined
             ? answers.interval

package/dist/configuration.mjs

@@ -17,7 +17,7 @@ async function readConfig() {
     const supportedFrameworks = ResourceDiscovery.getSupportedFrameworksNames();
     const configFromCliArgs = await getConfigFromCliArgs(supportedFrameworks);
     Configuration.setConfig(configFromCliArgs); // not complete config
-    const currentFramework = await ResourceDiscovery.getCurrentFrameworkName();
+    const currentFramework = await ResourceDiscovery.getCurrentFrameworkName(configFromCliArgs);
     Logger.setVerbose(configFromCliArgs.verbose === true);
     const configFileName = configFromCliArgs.config || configFileDefaultName;
     const configFromConfigFile = (await getConfigTsFromConfigFile(configFileName))

package/dist/frameworks/iFrameworks.d.ts

@@ -12,7 +12,7 @@ export interface IFramework {
      * Can this class handle the current project
      * @returns
      */
-    canHandle(): Promise<boolean>;
+    canHandle(config: LldConfigBase): Promise<boolean>;
     /**
      * Get Lambda functions
      * @param config

package/dist/frameworks/samFramework.d.ts

@@ -5,8 +5,6 @@ import { LldConfigBase } from '../types/lldConfig.js';
  * Support for AWS SAM framework
  */
 export declare class SamFramework implements IFramework {
-    protected samConfigFile: string;
-    protected samTemplateFile: string;
     /**
      * Framework name
      */
@@ -15,7 +13,13 @@ export declare class SamFramework implements IFramework {
      * Can this class handle the current project
      * @returns
      */
-    canHandle(): Promise<boolean>;
+    canHandle(config: LldConfigBase): Promise<boolean>;
+    /**
+     * Get configuration files
+     * @param config Configuration
+     * @returns Configuration files
+     */
+    private getConfigFiles;
     /**
      * Get Lambda functions
      * @param config Configuration

package/dist/frameworks/samFramework.mjs

@@ -10,8 +10,6 @@ import { Logger } from '../logger.mjs';
  * Support for AWS SAM framework
  */
 export class SamFramework {
-    samConfigFile = 'samconfig.toml';
-    samTemplateFile = 'template.yaml';
     /**
      * Framework name
      */
@@ -22,23 +20,37 @@ export class SamFramework {
      * Can this class handle the current project
      * @returns
      */
-    async canHandle() {
+    async canHandle(config) {
+        const { samConfigFile, samTemplateFile } = this.getConfigFiles(config);
         try {
-            await fs.access(path.resolve(this.samConfigFile), constants.F_OK);
+            await fs.access(samConfigFile, constants.F_OK);
         }
         catch {
-            Logger.verbose(`[SAM] This is not a SAM framework project. ${path.resolve(this.samConfigFile)} not found.`);
+            Logger.verbose(`[SAM] This is not a SAM framework project. ${samConfigFile} not found.`);
             return false;
         }
         try {
-            await fs.access(path.resolve(this.samTemplateFile), constants.F_OK);
+            await fs.access(samTemplateFile, constants.F_OK);
         }
         catch {
-            Logger.verbose(`[SAM] This is not a SAM framework project. ${path.resolve(this.samTemplateFile)} not found.`);
+            Logger.verbose(`[SAM] This is not a SAM framework project. ${samTemplateFile} not found.`);
             return false;
         }
         return true;
     }
+    /**
+     * Get configuration files
+     * @param config Configuration
+     * @returns Configuration files
+     */
+    getConfigFiles(config) {
+        const samConfigFile = config.samConfigFile ?? 'samconfig.toml';
+        const samTemplateFile = config.samTemplateFile ?? 'template.yaml';
+        return {
+            samConfigFile: path.resolve(samConfigFile),
+            samTemplateFile: path.resolve(samTemplateFile),
+        };
+    }
     /**
      * Get Lambda functions
      * @param config Configuration
@@ -50,14 +62,22 @@ export class SamFramework {
             profile: config.profile,
             role: config.role,
         };
+        const { samConfigFile, samTemplateFile } = this.getConfigFiles(config);
         const environment = config.configEnv ?? 'default';
-        const samConfigContent = await fs.readFile(path.resolve(this.samConfigFile), 'utf-8');
-        const samConfig = toml.parse(samConfigContent);
+        const samConfigContent = await fs.readFile(samConfigFile, 'utf-8');
+        let samConfig;
+        // is toml extension
+        if (samConfigFile.endsWith('.toml')) {
+            samConfig = toml.parse(samConfigContent);
+        }
+        else {
+            samConfig = yaml.parse(samConfigContent);
+        }
         const stackName = samConfig[environment]?.global?.parameters?.stack_name;
         if (!stackName) {
-            throw new Error(`Stack name not found in ${path.resolve(this.samConfigFile)}`);
+            throw new Error(`Stack name not found in ${samConfigFile}`);
         }
-        const samTemplateContent = await fs.readFile(path.resolve(this.samTemplateFile), 'utf-8');
+        const samTemplateContent = await fs.readFile(path.resolve(samTemplateFile), 'utf-8');
         const template = yaml.parse(samTemplateContent);
         const lambdas = [];
         // get all resources of type AWS::Serverless::Function

package/dist/resourceDiscovery.d.ts

@@ -6,7 +6,7 @@ declare function getSupportedFrameworksNames(): string[];
 /**
  * Get the name of the current framework
  */
-declare function getCurrentFrameworkName(): Promise<string | undefined>;
+declare function getCurrentFrameworkName(config: LldConfig): Promise<string | undefined>;
 declare function getLambdas(config: LldConfig): Promise<{
     codePath: string;
     functionName: string;

package/dist/resourceDiscovery.mjs

@@ -22,8 +22,8 @@ function getSupportedFrameworksNames() {
 /**
  * Get the name of the current framework
  */
-async function getCurrentFrameworkName() {
-    const framework = await getCurrentFramework(frameworksSupported);
+async function getCurrentFrameworkName(config) {
+    const framework = await getCurrentFramework(frameworksSupported, config);
     return framework?.name;
 }
 async function getLambdas(config) {
@@ -37,7 +37,7 @@ async function getLambdas(config) {
             frameworks = frameworks.filter((f) => f.name === config.framework);
         }
     }
-    const framework = await getCurrentFramework(frameworks);
+    const framework = await getCurrentFramework(frameworks, config);
     if (framework) {
         Logger.verbose(`Getting resources with '${framework.name}' framework`);
         resources = await framework.getLambdas(config);
@@ -61,10 +61,10 @@ async function getLambdas(config) {
 /**
  * Get the current framework
  */
-async function getCurrentFramework(frameworks) {
+async function getCurrentFramework(frameworks, config) {
     let framework;
     for (const f of frameworks) {
-        if (await f.canHandle()) {
+        if (await f.canHandle(config)) {
             framework = f;
             break;
         }

package/dist/types/lldConfig.d.ts

@@ -18,10 +18,6 @@ export type LldConfigBase = {
      * Filter by function name
      */
     function?: string;
-    /**
-     * SAM environment
-     */
-    configEnv?: string;
     /**
      * Observable mode
      * @default false
@@ -40,6 +36,18 @@ export type LldConfigBase = {
      * Start debugger
      */
     start?: boolean;
+    /**
+     * SAM framework cli parameter config-env
+     */
+    configEnv?: string;
+    /**
+     * SAM framework cli parameter config-file
+     */
+    samConfigFile?: string;
+    /**
+     * SAM framework cli parameter template-file
+     */
+    samTemplateFile?: string;
     /**
      * Resources discovery function
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-live-debugger",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "type": "module",
   "description": "Debug Lambda functions locally like it is running in the cloud",
   "repository": {
@@ -59,6 +59,8 @@
     "test-sls-esbuild-esm-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sls-esbuild-esm.test.ts",
     "test-sam-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/sam-basic.test.ts",
     "test-sam-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sam-basic.test.ts",
+    "test-sam-alt": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/sam-alt.test.ts",
+    "test-sam-alt-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sam-alt.test.ts",
     "test-terraform-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/terraform-basic.test.ts",
     "test-terraform-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/terraform-basic.test.ts",
     "docs:dev": "vitepress dev",
@@ -137,6 +139,7 @@
     "test/sls-basic",
     "test/sls-esbuild",
     "test/sam-basic",
+    "test/sam-alt",
     "test/terraform-basic"
   ]
 }