@dsmrt/axiom-cli 1.0.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @dsmrt/axiom-cli
 
+## 1.2.0
+
+### Minor Changes
+
+- 6c846be: adding cli subcommand for init for config files
+
+## 1.1.0
+
+### Minor Changes
+
+- b1a56bc: adding debug logging to the cli and config packages
+
+### Patch Changes
+
+- Updated dependencies [b1a56bc]
+  - @dsmrt/axiom-config@1.1.0
+
 ## 1.0.0
 
 ### Major Changes

package/dist/bin/axiom.js

@@ -28,6 +28,16 @@ var import_yargs = __toESM(require("yargs"));
 
 // src/commands/config.ts
 var import_axiom_config = require("@dsmrt/axiom-config");
+
+// src/debug.ts
+var isDebugEnabled = () => process.env.AXIOM_DEBUG === "true" || process.env.AXIOM_DEBUG === "1";
+var debug = (message, ...args) => {
+  if (isDebugEnabled()) {
+    console.error(`[axiom:cli] ${message}`, ...args);
+  }
+};
+
+// src/commands/config.ts
 var Config = class {
   command = "config";
   describe = "print the config";
@@ -38,13 +48,230 @@ var Config = class {
     return args;
   };
   handler = async (args) => {
-    console.log(JSON.stringify(await this.loadConfig(args)));
+    debug(`Config command handler called with env: ${args.env}`);
+    const config = await this.loadConfig(args);
+    debug(`Config loaded successfully, outputting as JSON`);
+    console.log(JSON.stringify(config));
   };
   loadConfig = async (args) => {
+    debug(`Loading config with env: ${args.env}`);
     return (0, import_axiom_config.loadConfig)(args);
   };
 };
 
+// src/commands/init.ts
+var import_node_fs = require("fs");
+var import_node_path = require("path");
+var import_inquirer = __toESM(require("inquirer"));
+var Init = class {
+  command = "init";
+  describe = "Initialize Axiom configuration files";
+  builder = (args) => {
+    args.option("force", {
+      alias: "f",
+      type: "boolean",
+      description: "Overwrite existing config files",
+      default: false
+    }).option("name", {
+      type: "string",
+      description: "Project name"
+    }).option("account", {
+      type: "string",
+      description: "AWS account ID"
+    }).option("region", {
+      type: "string",
+      description: "AWS region"
+    }).option("profile", {
+      type: "string",
+      description: "AWS profile name"
+    }).option("custom-types", {
+      type: "boolean",
+      description: "Create custom types file for extending config"
+    });
+    return args;
+  };
+  handler = async (args) => {
+    debug(`Init command handler called with args: ${JSON.stringify(args)}`);
+    const cwd = process.cwd();
+    if (!(0, import_node_fs.existsSync)(cwd)) {
+      (0, import_node_fs.mkdirSync)(cwd, { recursive: true });
+    }
+    const configPath = (0, import_node_path.join)(cwd, ".axiom.ts");
+    const devConfigPath = (0, import_node_path.join)(cwd, ".axiom.dev.ts");
+    const typesPath = (0, import_node_path.join)(cwd, "axiom.config.d.ts");
+    if (!args.force) {
+      const existingFiles = [];
+      if ((0, import_node_fs.existsSync)(configPath)) existingFiles.push(".axiom.ts");
+      if ((0, import_node_fs.existsSync)(devConfigPath)) existingFiles.push(".axiom.dev.ts");
+      if ((0, import_node_fs.existsSync)(typesPath)) existingFiles.push("axiom.config.d.ts");
+      if (existingFiles.length > 0) {
+        console.error(
+          `\u274C Config files already exist: ${existingFiles.join(", ")}`
+        );
+        console.error("   Use --force to overwrite them.");
+        process.exit(1);
+      }
+    }
+    const answers = await import_inquirer.default.prompt([
+      {
+        type: "input",
+        name: "name",
+        message: "Project name:",
+        default: args.name || "my-app",
+        when: !args.name
+      },
+      {
+        type: "input",
+        name: "account",
+        message: "AWS account ID:",
+        default: args.account || "123456789012",
+        when: !args.account,
+        validate: (input) => {
+          if (/^\d{12}$/.test(input)) return true;
+          return "AWS account ID must be 12 digits";
+        }
+      },
+      {
+        type: "input",
+        name: "region",
+        message: "AWS region:",
+        default: args.region || "us-east-1",
+        when: !args.region
+      },
+      {
+        type: "input",
+        name: "profile",
+        message: "AWS profile name:",
+        default: args.profile || "default",
+        when: !args.profile
+      },
+      {
+        type: "confirm",
+        name: "createCustomTypes",
+        message: "Would you like to add custom config properties?",
+        default: true,
+        when: args.customTypes === void 0
+      }
+    ]);
+    const config = {
+      name: args.name || answers.name,
+      account: args.account || answers.account,
+      region: args.region || answers.region,
+      profile: args.profile || answers.profile,
+      createCustomTypes: args.customTypes !== void 0 ? args.customTypes : answers.createCustomTypes
+    };
+    debug(`Creating config files with config: ${JSON.stringify(config)}`);
+    if (config.createCustomTypes) {
+      const typesContent = this.generateTypesFile();
+      (0, import_node_fs.writeFileSync)(typesPath, typesContent);
+      console.log(`\u2705 Created ${typesPath}`);
+      debug(`Created types file: ${typesPath}`);
+    }
+    const baseConfigContent = this.generateBaseConfig(
+      config,
+      config.createCustomTypes
+    );
+    (0, import_node_fs.writeFileSync)(configPath, baseConfigContent);
+    console.log(`\u2705 Created ${configPath}`);
+    debug(`Created base config: ${configPath}`);
+    const devConfigContent = this.generateDevConfig(config.createCustomTypes);
+    (0, import_node_fs.writeFileSync)(devConfigPath, devConfigContent);
+    console.log(`\u2705 Created ${devConfigPath}`);
+    debug(`Created dev config: ${devConfigPath}`);
+    console.log("\n\u{1F389} Axiom configuration initialized successfully!");
+    console.log("\n\u{1F4DD} Next steps:");
+    console.log("   1. Edit .axiom.ts to customize your base configuration");
+    console.log(
+      "   2. Edit .axiom.dev.ts to customize your development configuration"
+    );
+    if (config.createCustomTypes) {
+      console.log(
+        "   3. Edit axiom.config.d.ts to add your custom config properties"
+      );
+    }
+    console.log(
+      `   ${config.createCustomTypes ? "4" : "3"}. Run 'axiom config' to verify your configuration`
+    );
+  };
+  generateTypesFile() {
+    return `/**
+ * Custom Axiom Configuration Types
+ *
+ * Extend this interface to add custom properties to your Axiom config.
+ * These properties will be type-safe when using loadConfig() in your code.
+ *
+ * Example:
+ *
+ * export interface CustomConfig {
+ *   apiUrl: string;
+ *   apiKey: string;
+ *   maxRetries: number;
+ *   features: {
+ *     authentication: boolean;
+ *     analytics: boolean;
+ *   };
+ * }
+ */
+
+export interface CustomConfig {
+	// Add your custom properties here
+	// Example:
+	// apiUrl: string;
+	// maxRetries: number;
+}
+`;
+  }
+  generateBaseConfig(config, hasCustomTypes) {
+    const importStatement = hasCustomTypes ? `import type { Config } from "@dsmrt/axiom-config";
+import type { CustomConfig } from "./axiom.config";
+
+type AxiomConfig = Config & CustomConfig;
+
+const config: AxiomConfig = {` : `import type { Config } from "@dsmrt/axiom-config";
+
+const config: Config = {`;
+    return `${importStatement}
+	name: "${config.name}",
+	env: "prod",
+	aws: {
+		account: "${config.account}",
+		region: "${config.region}",
+		profile: "${config.profile}",
+	},
+	baseParameterPath: "/${config.name}/prod",${hasCustomTypes ? `
+
+	// Add your custom config properties here
+	// Example:
+	// apiUrl: "https://api.example.com",
+	// maxRetries: 3,` : ""}
+};
+
+export default config;
+`;
+  }
+  generateDevConfig(hasCustomTypes) {
+    const importStatement = hasCustomTypes ? `import type { Config } from "@dsmrt/axiom-config";
+import type { CustomConfig } from "./axiom.config";
+
+type AxiomConfig = Config & CustomConfig;
+
+const config: Partial<AxiomConfig> = {` : `import type { Config } from "@dsmrt/axiom-config";
+
+const config: Partial<Config> = {`;
+    return `${importStatement}
+	env: "dev",
+	baseParameterPath: undefined, // Will be auto-generated as /{name}/dev${hasCustomTypes ? `,
+
+	// Override custom config properties for dev environment
+	// Example:
+	// apiUrl: "https://api.dev.example.com",` : ""}
+};
+
+export default config;
+`;
+  }
+};
+
 // src/commands/params/base.ts
 var ParamsCommand = class {
   command = "params";
@@ -67,10 +294,10 @@ var import_chalk = __toESM(require("chalk"));
 // src/aws/credentials-provider.ts
 var import_credential_providers = require("@aws-sdk/credential-providers");
 var import_client_sts = require("@aws-sdk/client-sts");
-var import_inquirer = __toESM(require("inquirer"));
+var import_inquirer2 = __toESM(require("inquirer"));
 
 // src/cache.ts
-var import_node_fs = __toESM(require("fs"));
+var import_node_fs2 = __toESM(require("fs"));
 var import_node_os = __toESM(require("os"));
 var DEFAULT_DIRECTORY = `${import_node_os.default.homedir()}/.axiom/cache`;
 var cache_default = class {
@@ -79,10 +306,10 @@ var cache_default = class {
   }
   get(name) {
     const file = `${this.cacheDir}/${name}`;
-    if (!import_node_fs.default.existsSync(file)) {
+    if (!import_node_fs2.default.existsSync(file)) {
       return;
     }
-    const buffer = import_node_fs.default.readFileSync(file);
+    const buffer = import_node_fs2.default.readFileSync(file);
     const item = JSON.parse(buffer.toString());
     if (item.expires === void 0) {
       return item.data;
@@ -95,16 +322,16 @@ var cache_default = class {
     return item.data;
   }
   delete(name) {
-    import_node_fs.default.unlinkSync(`${this.cacheDir}/${name}`);
+    import_node_fs2.default.unlinkSync(`${this.cacheDir}/${name}`);
   }
   set(name, value, expires) {
-    if (!import_node_fs.default.existsSync(this.cacheDir)) {
-      import_node_fs.default.mkdirSync(this.cacheDir, {
+    if (!import_node_fs2.default.existsSync(this.cacheDir)) {
+      import_node_fs2.default.mkdirSync(this.cacheDir, {
         recursive: true,
         mode: 448
       });
     }
-    import_node_fs.default.writeFileSync(
+    import_node_fs2.default.writeFileSync(
       `${this.cacheDir}/${name}`,
       JSON.stringify({
         expires,
@@ -159,7 +386,7 @@ var roleAssumerCallable = (config) => {
   };
 };
 var mfaCodeProvider = async (mfaSerial) => {
-  const mfaCode = await import_inquirer.default.prompt({
+  const mfaCode = await import_inquirer2.default.prompt({
     name: "code",
     message: `Enter MFA code for ${mfaSerial}: `,
     type: "password"
@@ -215,7 +442,16 @@ Example:
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Get command handler called with env: ${args.env}, path: ${args.path}`
+    );
     const config = await (0, import_axiom_config2.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const collection = new import_axiom_aws_sdk.ParameterCollection(
       config.aws?.baseParameterPath,
       new import_client_ssm.SSMClient({
@@ -228,7 +464,9 @@ Example:
         })
       })
     );
+    debug(`Fetching parameters from SSM...`);
     const params = await collection.get();
+    debug(`Retrieved ${params.size} parameters`);
     params.forEach((parameter) => {
       console.log(
         import_chalk.default.gray(
@@ -244,7 +482,7 @@ Example:
 var import_client_ssm2 = require("@aws-sdk/client-ssm");
 var import_axiom_config3 = require("@dsmrt/axiom-config");
 var import_chalk2 = __toESM(require("chalk"));
-var import_inquirer2 = __toESM(require("inquirer"));
+var import_inquirer3 = __toESM(require("inquirer"));
 
 // src/commands/params/utils.ts
 var buildPath = (config, path) => {
@@ -294,30 +532,50 @@ Example: "/root/myParam" or "service/secret"`
     });
   };
   handler = async (args) => {
+    debug(
+      `Set command handler called with path: ${args.path}, secure: ${args.secure}, overwrite: ${args.overwrite}, force: ${args.force}`
+    );
     const config = await (0, import_axiom_config3.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    const fullPath = buildPath(config, args.path);
+    debug(`Full parameter path: ${fullPath}`);
     if (args.force !== true) {
-      const res = await import_inquirer2.default.prompt({
+      debug(`Prompting user for confirmation...`);
+      const res = await import_inquirer3.default.prompt({
         type: "confirm",
         name: "setParam",
         message: `Are you sure you want to set '${args.path}'?`
       });
       if (!res.setParam) {
+        debug(`User declined, aborting`);
         console.log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const client = new import_client_ssm2.SSMClient({
       region: config.aws.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
+    debug(
+      `Sending parameter to SSM with type: ${args.secure ? "SecureString" : "String"}`
+    );
     const params = await client.send(
       new import_client_ssm2.PutParameterCommand({
-        Name: buildPath(config, args.path),
+        Name: fullPath,
         Value: args.value,
         Type: args.secure ? import_client_ssm2.ParameterType.SECURE_STRING : import_client_ssm2.ParameterType.STRING,
         Overwrite: args.overwrite
       })
     );
+    debug(`Parameter set successfully, version: ${params.Version}`);
     console.log(import_chalk2.default.green("Version: "), import_chalk2.default.white.bold(params.Version));
   };
 };
@@ -325,7 +583,7 @@ Example: "/root/myParam" or "service/secret"`
 // src/commands/params/delete.ts
 var import_client_ssm3 = require("@aws-sdk/client-ssm");
 var import_axiom_config4 = require("@dsmrt/axiom-config");
-var import_inquirer3 = __toESM(require("inquirer"));
+var import_inquirer4 = __toESM(require("inquirer"));
 var log = console.log;
 var DeleteCommand = class {
   command = "delete <path>";
@@ -347,33 +605,51 @@ Example: "/root/myParam" or "service/secret"`,
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Delete command handler called with path: ${args.path}, force: ${args.force}`
+    );
     const config = await (0, import_axiom_config4.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
     const path = buildPath(args, args.path);
+    debug(`Full parameter path: ${path}`);
+    debug(
+      `Creating SSM client with region: ${config.aws?.region}, profile: ${config.aws?.profile}`
+    );
     const client = new import_client_ssm3.SSMClient({
       region: config.aws?.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
     if (path === args.aws.baseParameterPath) {
+      debug(`Delete blocked: path matches base parameter path`);
       throw new Error(
         `Deleting the path (path: ${path}) that matches the base path (awsSsmParameterPath: ${args.awsSsmParameterPath}) is prohibited.`
       );
     }
     if (args.force !== true) {
-      const res = await import_inquirer3.default.prompt({
+      debug(`Prompting user for confirmation...`);
+      const res = await import_inquirer4.default.prompt({
         type: "confirm",
         name: "delete",
         message: `Are you sure you want to delete '${path}'?`
       });
       if (!res.delete) {
+        debug(`User declined, aborting`);
         log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(`Sending delete command to SSM for: ${path}`);
     await client.send(
       new import_client_ssm3.DeleteParameterCommand({
         Name: path
       })
     );
+    debug(`Parameter deleted successfully`);
     log("\u{1F44D}");
   };
 };
@@ -382,7 +658,17 @@ Example: "/root/myParam" or "service/secret"`,
 (0, import_yargs.default)(process.argv.slice(2)).env("AXIOM").scriptName("axiom").option("config", {
   alias: "c",
   string: true
-}).command(new Config()).command(new ParamsCommand()).strict().usage(
+}).option("debug", {
+  alias: "d",
+  type: "boolean",
+  description: "Enable debug output",
+  default: false,
+  global: true
+}).middleware((argv) => {
+  if (argv.debug) {
+    process.env.AXIOM_DEBUG = "true";
+  }
+}).command(new Init()).command(new Config()).command(new ParamsCommand()).strict().usage(
   `
 Axiom - an AWS focused config cli
 

package/dist/bin/axiom.mjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import "../chunk-72DOPOLO.mjs";
+import "../chunk-QRHY3BEA.mjs";