@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/workflow-blueprints.ts

@@ -0,0 +1,123 @@
+// ABOUTME: CLI commands for Workflow Blueprint.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createWorkflowBlueprintsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('workflow-blueprints')
+    .description('Workflow Blueprint');
+
+
+  cmd
+    .command('list-workflow-blueprints')
+    .description('Show all workflow blueprints')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `name`
+  - `description`
+  - `goal`
+  - `created_on`
+  - `updated_on`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching workflow blueprint...').start();
+      try {
+        const data = await client.listWorkflowBlueprints({
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-workflow-blueprint <blueprint-id>')
+    .description('Show a workflow blueprint')
+    .action(async (blueprint_id) => {
+      const spinner = createSpinner('Fetching workflow blueprint...').start();
+      try {
+        const data = await client.getWorkflowBlueprint({
+          blueprint_id,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-workflow-blueprint-actions <blueprint-id>')
+    .description('Show workflow blueprint actions')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `name`
+  - `created_on`')
+    .action(async (blueprint_id, options) => {
+      const spinner = createSpinner('Fetching workflow blueprint...').start();
+      try {
+        const data = await client.listWorkflowBlueprintActions({
+          blueprint_id,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-workflow-blueprint-action <blueprint-id> <action-id>')
+    .description('Show a workflow blueprint action')
+    .action(async (blueprint_id, action_id) => {
+      const spinner = createSpinner('Fetching workflow blueprint...').start();
+      try {
+        const data = await client.getWorkflowBlueprintAction({
+          blueprint_id,
+          action_id,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/workflows.ts

@@ -0,0 +1,265 @@
+// ABOUTME: CLI commands for Workflow.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+import { confirmDelete } from '../utils/confirm.js';
+
+export function createWorkflowsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('workflows')
+    .description('Workflow');
+
+
+  cmd
+    .command('list')
+    .description('Show all workflows')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `name`
+  - `description`
+  - `goal`
+  - `status`
+  - `created_on`
+  - `updated_on`
+  - `activated_on`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching workflow...').start();
+      try {
+        const data = await client.listWorkflows({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create')
+    .description('Create a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating workflow...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createWorkflow({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <workflow-id>')
+    .description('Show a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Fetching workflow...').start();
+      try {
+        const data = await client.getWorkflow({
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('patch <workflow-id>')
+    .description('Update a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Updating workflow...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchWorkflow({
+          workflow_id,
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <workflow-id>')
+    .description('Delete a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (workflow_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('workflow', workflow_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting workflow...').start();
+      try {
+        const data = await client.deleteWorkflow({
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('activate <workflow-id>')
+    .description('Activate a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .option('--sender-email <value>', 'sender_email')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Creating workflow...').start();
+      try {
+        const data = await client.activateWorkflow({
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+          senderEmail: options.senderEmail,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('deactivate <workflow-id>')
+    .description('Deactivate a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Creating workflow...').start();
+      try {
+        const data = await client.deactivateWorkflow({
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('lock <workflow-id>')
+    .description('Lock a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--key <value>', 'key')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Creating workflow...').start();
+      try {
+        const data = await client.lockWorkflow({
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          key: options.key,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unlock <workflow-id>')
+    .description('Unlock a workflow')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--key <value>', 'key')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Creating workflow...').start();
+      try {
+        const data = await client.unlockWorkflow({
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          key: options.key,
+        });
+
+        spinner.stop();
+        formatter.success('Workflow created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/types/profile.ts

@@ -0,0 +1,93 @@
+// ABOUTME: Profile system controlling CLI behavior per user persona.
+// ABOUTME: Three profiles: developer (scripting), marketer (guided), balanced (default).
+
+export type ProfileType = "developer" | "marketer" | "balanced";
+export type OutputFormat = "json" | "table" | "compact";
+export type ColorScheme = "none" | "minimal" | "moderate" | "rich";
+export type DateFormat = "iso8601" | "friendly" | "relative";
+
+export interface ProfileConfig {
+  output: {
+    format: OutputFormat;
+    colors: ColorScheme;
+    pretty_print: boolean;
+    show_tips: boolean;
+  };
+  behavior: {
+    interactive_prompts: boolean | "auto";
+    confirm_destructive: boolean;
+    show_progress: boolean;
+  };
+  display: {
+    date_format: DateFormat;
+    show_ids: boolean;
+    verbose_errors: boolean;
+  };
+}
+
+export const DEVELOPER_PROFILE: ProfileConfig = {
+  output: {
+    format: "json",
+    colors: "none",
+    pretty_print: false,
+    show_tips: false,
+  },
+  behavior: {
+    interactive_prompts: false,
+    confirm_destructive: false,
+    show_progress: false,
+  },
+  display: {
+    date_format: "iso8601",
+    show_ids: true,
+    verbose_errors: true,
+  },
+};
+
+export const MARKETER_PROFILE: ProfileConfig = {
+  output: {
+    format: "compact",
+    colors: "rich",
+    pretty_print: true,
+    show_tips: true,
+  },
+  behavior: {
+    interactive_prompts: true,
+    confirm_destructive: true,
+    show_progress: true,
+  },
+  display: {
+    date_format: "relative",
+    show_ids: false,
+    verbose_errors: false,
+  },
+};
+
+export const BALANCED_PROFILE: ProfileConfig = {
+  output: {
+    format: "table",
+    colors: "moderate",
+    pretty_print: true,
+    show_tips: false,
+  },
+  behavior: {
+    interactive_prompts: "auto",
+    confirm_destructive: true,
+    show_progress: true,
+  },
+  display: {
+    date_format: "friendly",
+    show_ids: true,
+    verbose_errors: false,
+  },
+};
+
+const PROFILES: Record<ProfileType, ProfileConfig> = {
+  developer: DEVELOPER_PROFILE,
+  marketer: MARKETER_PROFILE,
+  balanced: BALANCED_PROFILE,
+};
+
+export function getProfileConfig(type: ProfileType = "balanced"): ProfileConfig {
+  return PROFILES[type] ?? BALANCED_PROFILE;
+}