@dsmrt/axiom-cli 0.1.2 → 0.2.0

package/dist/chunk-FKMXG4JE.mjs

@@ -0,0 +1,395 @@
+// src/bin/axiom.ts
+import yargs from "yargs";
+
+// src/commands/config.ts
+import { loadConfig } from "@dsmrt/axiom-config";
+var Config = class {
+  command = "config";
+  describe = "print the config";
+  builder = (args) => {
+    args.option("env", {
+      type: "string"
+    });
+    return args;
+  };
+  handler = async (args) => {
+    console.log(await this.loadConfig(args));
+  };
+  loadConfig = async (args) => {
+    return loadConfig(args);
+  };
+};
+
+// src/commands/params/base.ts
+var ParamsCommand = class {
+  command = "params";
+  describe = "Manage SSM parameters";
+  builder = (args) => {
+    args.demandCommand().command(new GetCommand()).command(new SetCommand()).command(new DeleteCommand());
+    return args;
+  };
+  handler = async () => {
+    console.log("\u{1F44D}");
+  };
+};
+
+// src/commands/params/get.ts
+import { loadConfig as loadConfig2 } from "@dsmrt/axiom-config";
+import { ParameterCollection } from "@dsmrt/axiom-aws-sdk";
+import { SSMClient } from "@aws-sdk/client-ssm";
+
+// src/aws/credentials-provider.ts
+import { fromNodeProviderChain } from "@aws-sdk/credential-providers";
+import {
+  AssumeRoleCommand,
+  STSClient
+} from "@aws-sdk/client-sts";
+import inquirer from "inquirer";
+
+// src/cache.ts
+import os from "os";
+import fs from "fs";
+var DEFAULT_DIRECTORY = `${os.homedir()}/.axiom/cache`;
+var cache_default = class {
+  constructor(cacheDir = DEFAULT_DIRECTORY) {
+    this.cacheDir = cacheDir;
+  }
+  get(name) {
+    const file = `${this.cacheDir}/${name}`;
+    if (!fs.existsSync(file)) {
+      return;
+    }
+    const buffer = fs.readFileSync(file);
+    const item = JSON.parse(buffer.toString());
+    if (item.expires === void 0) {
+      return item.data;
+    }
+    item.expires = new Date(item.expires);
+    if (item.expires < /* @__PURE__ */ new Date()) {
+      this.delete(name);
+      return;
+    }
+    return item.data;
+  }
+  delete(name) {
+    fs.unlinkSync(`${this.cacheDir}/${name}`);
+  }
+  set(name, value, expires) {
+    if (!fs.existsSync(this.cacheDir)) {
+      fs.mkdirSync(this.cacheDir, {
+        recursive: true,
+        mode: 448
+      });
+    }
+    fs.writeFileSync(
+      `${this.cacheDir}/${name}`,
+      JSON.stringify({
+        expires,
+        data: value
+      }),
+      {
+        mode: 384
+      }
+    );
+  }
+};
+
+// src/aws/credentials-provider.ts
+var CACHE_KEY_PREFIX = "axiom#aws-credentials";
+var cache = new cache_default();
+var returnCredentialsFromAssumerole = (creds) => {
+  return {
+    accessKeyId: `${creds.AccessKeyId}`,
+    secretAccessKey: `${creds.SecretAccessKey}`,
+    sessionToken: `${creds.SessionToken}`
+  };
+};
+var CachedCredentialViaProfileAndRegion = async (profile, region) => {
+  const cacheKeyName = `${CACHE_KEY_PREFIX}#${profile}`;
+  const creds = cache.get(cacheKeyName);
+  if (creds !== void 0) {
+    return async () => returnCredentialsFromAssumerole(creds);
+  }
+  return fromNodeProviderChain({
+    profile,
+    roleAssumer: roleAssumerCallable({
+      region: region ?? "us-east-1",
+      cacheKeyName
+    }),
+    mfaCodeProvider
+  });
+};
+var roleAssumerCallable = (config) => {
+  return async (sourceCreds, params) => {
+    const command = new AssumeRoleCommand(params);
+    const client = new STSClient({
+      region: config.region,
+      credentials: sourceCreds
+    });
+    const result = await client.send(command);
+    const creds = result.Credentials;
+    if (creds === void 0 || creds?.AccessKeyId === void 0 || creds?.SecretAccessKey === void 0 || creds?.SessionToken === void 0) {
+      throw new Error("Unable to fetch credentials.");
+    }
+    cache.set(config.cacheKeyName, creds, creds.Expiration);
+    return returnCredentialsFromAssumerole(creds);
+  };
+};
+var mfaCodeProvider = async (mfaSerial) => {
+  const mfaCode = await inquirer.prompt({
+    name: "code",
+    message: `Enter MFA code for ${mfaSerial}: `,
+    type: "password"
+  });
+  return mfaCode.code;
+};
+var CachedCredentialProvider = (config) => {
+  return CachedCredentialViaProfileAndRegion(config.profile, config.region);
+};
+
+// src/options.ts
+var commonOptions = () => {
+  return {
+    env: {
+      string: true,
+      desc: "Environment name like, prod, staging, dev, etc."
+    }
+  };
+};
+var awsOptions = () => {
+  return {
+    account: {
+      string: true,
+      desc: "AWS Account number like, 1243944546"
+    },
+    region: {
+      string: true,
+      desc: "AWS region like, us-east-1"
+    },
+    profile: {
+      string: true,
+      desc: "AWS configured profile"
+    },
+    baseParameterPath: {
+      string: true,
+      desc: "SSM parameter path base where configs like secrets and infrastucture managed items are set"
+    }
+  };
+};
+
+// src/commands/params/utils.ts
+var buildPath = (config, path) => {
+  if (path === void 0) {
+    return config.aws?.baseParameterPath;
+  }
+  if (/^\//.test(path)) {
+    return path;
+  }
+  return `${config.aws?.baseParameterPath.replace(/\/$/, "")}/${path}`;
+};
+
+// src/commands/params/get.ts
+import chalk from "chalk";
+var GetCommand = class {
+  command = "get [path]";
+  describe = "Get all parameters under the base path";
+  builder = (args) => {
+    const config = loadConfig2();
+    args.options({ ...commonOptions(), ...awsOptions() });
+    args.positional("path", {
+      type: "string",
+      describe: `OPTIONAL path to parameter. Supports absolute and relative paths.
+Example:
+	"/root/myParam" or "service/secret" (which translates to, "${buildPath(
+        config,
+        "service/secret"
+      )})`
+    });
+    return args;
+  };
+  handler = async (args) => {
+    const config = loadConfig2({ env: args.env });
+    const collection = new ParameterCollection(
+      config.aws?.baseParameterPath,
+      new SSMClient({
+        region: config.aws.region,
+        credentials: await CachedCredentialProvider({
+          profile: config.aws.profile,
+          region: config.aws.region,
+          baseParameterPath: config.aws.baseParameterPath,
+          account: config.aws.account
+        })
+      })
+    );
+    const params = await collection.get();
+    params.forEach((parameter) => {
+      console.log(
+        chalk.gray(
+          parameter.Name?.replace(/\/([^/]+)$/, "/" + chalk.bold.green("$1"))
+        ),
+        chalk.bold.white(parameter.Value)
+      );
+    });
+  };
+};
+
+// src/commands/params/set.ts
+import { loadConfig as loadConfig3 } from "@dsmrt/axiom-config";
+import inquirer2 from "inquirer";
+import {
+  SSMClient as SSMClient2,
+  PutParameterCommand,
+  ParameterType
+} from "@aws-sdk/client-ssm";
+import chalk2 from "chalk";
+var SetCommand = class {
+  command = "set <path> <value>";
+  describe = "Set all parameters under the base path";
+  builder = (args) => {
+    const config = loadConfig3();
+    args.positional("path", {
+      type: "string",
+      describe: `Path to parameter. Supports absolute and relative paths.
+Example: "/root/myParam" or "service/secret" (which translates to, "${buildPath(
+        config,
+        "service/secret"
+      )})`
+    });
+    args.demandOption("path", "Path is required");
+    args.positional("value", {
+      type: "string"
+    });
+    args.demandOption("value", "Value is required");
+    args.option("force", {
+      boolean: true,
+      default: false,
+      describe: "force set parameter without prompt",
+      alias: "f"
+    });
+    args.option("secure", {
+      boolean: true,
+      default: true,
+      describe: "Save parameter as a secure string"
+    });
+    args.option("overwrite", {
+      boolean: true,
+      default: true,
+      describe: "Overwrite parameter if it already exists"
+    });
+    return args.options({
+      ...commonOptions(),
+      ...awsOptions()
+    });
+  };
+  handler = async (args) => {
+    const config = loadConfig3({ env: args.env });
+    if (args.force !== true) {
+      const res = await inquirer2.prompt({
+        type: "confirm",
+        name: "setParam",
+        message: `Are you sure you want to set '${args.path}'?`
+      });
+      if (!res.setParam) {
+        console.log("Doing nothing.");
+        return;
+      }
+    }
+    const client = new SSMClient2({
+      region: config.aws.region,
+      credentials: await CachedCredentialProvider(config.aws)
+    });
+    const params = await client.send(
+      new PutParameterCommand({
+        Name: buildPath(config, args.path),
+        Value: args.value,
+        Type: args.secure ? ParameterType.SECURE_STRING : ParameterType.STRING,
+        Overwrite: args.overwrite
+      })
+    );
+    console.log(chalk2.green("Version: "), chalk2.white.bold(params.Version));
+  };
+};
+
+// src/commands/params/delete.ts
+import { loadConfig as loadConfig4 } from "@dsmrt/axiom-config";
+import inquirer3 from "inquirer";
+import { SSMClient as SSMClient3, DeleteParameterCommand } from "@aws-sdk/client-ssm";
+var log = console.log;
+var DeleteCommand = class {
+  command = "delete <path>";
+  describe = "Delete SSM parameters";
+  client;
+  builder = (args) => {
+    const config = loadConfig4();
+    args.positional("path", {
+      type: "string",
+      describe: `Path to parameter. Supports absolute and relative paths.
+Example: "/root/myParam" or "service/secret" (which translates to, "${buildPath(
+        config,
+        "service/secret"
+      )})`,
+      default: config.aws?.baseParameterPath,
+      demandOption: true
+    }).demandOption("path", "Path is required");
+    args.option("force", {
+      boolean: true,
+      default: false,
+      describe: "force delete parameter without prompt",
+      alias: "f"
+    });
+    return args;
+  };
+  handler = async (args) => {
+    const config = loadConfig4({ env: args.env });
+    const path = buildPath(args, args.path);
+    const client = new SSMClient3({
+      region: config.aws?.region,
+      credentials: await CachedCredentialProvider(config.aws)
+    });
+    if (path === args.aws.baseParameterPath) {
+      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 inquirer3.prompt({
+        type: "confirm",
+        name: "delete",
+        message: `Are you sure you want to delete '${path}'?`
+      });
+      if (!res.delete) {
+        log("Doing nothing.");
+        return;
+      }
+    }
+    await client.send(
+      new DeleteParameterCommand({
+        Name: path
+      })
+    );
+    log("\u{1F44D}");
+  };
+};
+
+// src/bin/axiom.ts
+yargs(process.argv.slice(2)).env("AXIOM").scriptName("axiom").option("config", {
+  alias: "c",
+  string: true
+}).command(new Config()).command(new ParamsCommand()).strict().usage(
+  `
+Axiom - an AWS focused config cli
+
+USAGE:
+           $0 [options] <command>
+       `
+).demandCommand(1, "").alias("h", "help").argv;
+
+export {
+  Config,
+  ParamsCommand,
+  commonOptions,
+  awsOptions,
+  GetCommand,
+  SetCommand,
+  DeleteCommand
+};

package/dist/index.d.mts

@@ -0,0 +1,78 @@
+import { Options as Options$1, CommandModule, CommandBuilder, ArgumentsCamelCase, Argv } from 'yargs';
+import * as _dsmrt_axiom_config from '@dsmrt/axiom-config';
+import { AwsConfigs, Config as Config$1 } from '@dsmrt/axiom-config';
+import { SSMClient } from '@aws-sdk/client-ssm';
+
+interface Item {
+    expires?: Date;
+    data: unknown;
+}
+
+declare const commonOptions: () => {
+    [key: string]: Options$1;
+};
+declare const awsOptions: () => {
+    [key: string]: Options$1;
+};
+
+interface ConfigOptions {
+    env: string;
+}
+declare class Config<U extends ConfigOptions> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder?: CommandBuilder<object, U> | undefined;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+    loadConfig: (args: ConfigOptions) => Promise<_dsmrt_axiom_config.ConfigContainer<object>>;
+}
+
+interface Options {
+}
+declare class ParamsCommand<U extends Options> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder: (args: Argv) => Argv<U>;
+    handler: () => Promise<void>;
+}
+
+interface GetOptions {
+    env: string;
+    path: string;
+}
+declare class GetCommand<U extends GetOptions> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder: (args: Argv) => Argv<U>;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+}
+
+interface SetOptions extends AwsConfigs {
+    env: string;
+    path: string;
+    value: string;
+    force: boolean;
+    secure: boolean;
+    overwrite: boolean;
+}
+declare class SetCommand<U extends SetOptions> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder: (args: Argv) => Argv<U>;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+}
+
+type Path = string;
+interface DeleteOptions {
+    path?: Path;
+    force: boolean;
+}
+type config = Config$1 & DeleteOptions;
+declare class DeleteCommand<U extends config> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    protected client: SSMClient | undefined;
+    builder: (args: Argv) => Argv<U>;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+}
+
+export { Config, DeleteCommand, type DeleteOptions, GetCommand, type GetOptions, type Item, ParamsCommand, SetCommand, type SetOptions, awsOptions, commonOptions };

package/dist/index.d.ts

@@ -0,0 +1,78 @@
+import { Options as Options$1, CommandModule, CommandBuilder, ArgumentsCamelCase, Argv } from 'yargs';
+import * as _dsmrt_axiom_config from '@dsmrt/axiom-config';
+import { AwsConfigs, Config as Config$1 } from '@dsmrt/axiom-config';
+import { SSMClient } from '@aws-sdk/client-ssm';
+
+interface Item {
+    expires?: Date;
+    data: unknown;
+}
+
+declare const commonOptions: () => {
+    [key: string]: Options$1;
+};
+declare const awsOptions: () => {
+    [key: string]: Options$1;
+};
+
+interface ConfigOptions {
+    env: string;
+}
+declare class Config<U extends ConfigOptions> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder?: CommandBuilder<object, U> | undefined;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+    loadConfig: (args: ConfigOptions) => Promise<_dsmrt_axiom_config.ConfigContainer<object>>;
+}
+
+interface Options {
+}
+declare class ParamsCommand<U extends Options> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder: (args: Argv) => Argv<U>;
+    handler: () => Promise<void>;
+}
+
+interface GetOptions {
+    env: string;
+    path: string;
+}
+declare class GetCommand<U extends GetOptions> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder: (args: Argv) => Argv<U>;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+}
+
+interface SetOptions extends AwsConfigs {
+    env: string;
+    path: string;
+    value: string;
+    force: boolean;
+    secure: boolean;
+    overwrite: boolean;
+}
+declare class SetCommand<U extends SetOptions> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    builder: (args: Argv) => Argv<U>;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+}
+
+type Path = string;
+interface DeleteOptions {
+    path?: Path;
+    force: boolean;
+}
+type config = Config$1 & DeleteOptions;
+declare class DeleteCommand<U extends config> implements CommandModule<object, U> {
+    command: string;
+    describe: string;
+    protected client: SSMClient | undefined;
+    builder: (args: Argv) => Argv<U>;
+    handler: (args: ArgumentsCamelCase<U>) => Promise<void>;
+}
+
+export { Config, DeleteCommand, type DeleteOptions, GetCommand, type GetOptions, type Item, ParamsCommand, SetCommand, type SetOptions, awsOptions, commonOptions };