@syncular/cli 0.0.0-44

package/src/command-registry.ts

@@ -0,0 +1,700 @@
+import { listBuildpackIds } from './buildpacks';
+import { CLI_NAME } from './constants';
+import { listTemplateIds } from './templates';
+import type { InteractiveCommand, RootCommand } from './types';
+
+const USAGE_SUFFIX_LINES = [
+  'doctor',
+  'console [flags]',
+  'login [flags]',
+  'logout [flags]',
+  'whoami [flags]',
+  'create-space --name <name> [flags]',
+  'create --template <id> [flags]',
+  'dev [flags]',
+  'typegen [flags]',
+  'migrate-status [flags]',
+  'migrate-up [flags]',
+  'build [flags]',
+  'eject [flags]',
+  'target [flags]',
+  'deploy --space <spaceId> [flags]',
+  'verify --space <spaceId> [flags]',
+  'deployments --space <spaceId> [flags]',
+  'rollback --space <spaceId> --to <deploymentId> [flags]',
+];
+
+export const USAGE_LINES = USAGE_SUFFIX_LINES.map(
+  (line) => `${CLI_NAME} ${line}`
+);
+
+const TEMPLATE_IDS = listTemplateIds();
+const TEMPLATE_IDS_LABEL = TEMPLATE_IDS.join('|');
+const DEFAULT_TEMPLATE_ID = TEMPLATE_IDS.includes('syncular-libraries')
+  ? 'syncular-libraries'
+  : (TEMPLATE_IDS[0] ?? 'syncular-libraries');
+const BUILDPACK_IDS = listBuildpackIds();
+const BUILDPACK_IDS_LABEL = BUILDPACK_IDS.join('|');
+
+function parseBooleanInput(value: string): boolean | null {
+  const normalized = value.trim().toLowerCase();
+  if (
+    normalized === 'true' ||
+    normalized === '1' ||
+    normalized === 'yes' ||
+    normalized === 'on'
+  ) {
+    return true;
+  }
+  if (
+    normalized === 'false' ||
+    normalized === '0' ||
+    normalized === 'no' ||
+    normalized === 'off'
+  ) {
+    return false;
+  }
+  return null;
+}
+
+function pushOptionalFlag(argv: string[], flag: string, value: string): void {
+  const normalized = value.trim();
+  if (normalized.length === 0) {
+    return;
+  }
+  argv.push(flag, normalized);
+}
+
+const ALL_INTERACTIVE_COMMANDS: InteractiveCommand[] = [
+  {
+    id: 'doctor',
+    label: 'doctor',
+    description: 'Run local environment checks',
+    buildArgv() {
+      return ['doctor'];
+    },
+  },
+  {
+    id: 'console',
+    label: 'console',
+    description: 'Serve local Syncular Console static UI',
+    fields: [
+      { id: 'host', label: 'Host', defaultValue: '127.0.0.1' },
+      { id: 'port', label: 'Port', kind: 'number', defaultValue: '4310' },
+      { id: 'server-url', label: 'Sync API base URL (optional)' },
+      { id: 'token', label: 'Sync API token (optional)' },
+      { id: 'token-env', label: 'Read token from env var (optional)' },
+      {
+        id: 'open',
+        label: 'Open browser',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['console'];
+      pushOptionalFlag(argv, '--host', values.host ?? '');
+      pushOptionalFlag(argv, '--port', values.port ?? '');
+      pushOptionalFlag(argv, '--server-url', values['server-url'] ?? '');
+      pushOptionalFlag(argv, '--token', values.token ?? '');
+      pushOptionalFlag(argv, '--token-env', values['token-env'] ?? '');
+      const open = parseBooleanInput(values.open ?? 'false');
+      if (open === true) {
+        argv.push('--open', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'create',
+    label: 'create',
+    description: 'Scaffold a project from a template',
+    fields: [
+      {
+        id: 'template',
+        label: `Template ID (${TEMPLATE_IDS_LABEL})`,
+        required: true,
+        defaultValue: DEFAULT_TEMPLATE_ID,
+      },
+      { id: 'dir', label: 'Target directory (optional)' },
+      { id: 'name', label: 'Project name (spaces-app only, optional)' },
+      {
+        id: 'targets',
+        label: 'syncular-libraries targets (optional CSV)',
+      },
+      {
+        id: 'server-dialect',
+        label: 'syncular-libraries server dialect (optional)',
+      },
+      {
+        id: 'react-dialect',
+        label: 'syncular-libraries react dialect (optional)',
+      },
+      {
+        id: 'vanilla-dialect',
+        label: 'syncular-libraries vanilla dialect (optional)',
+      },
+      {
+        id: 'electron-dialect',
+        label: 'syncular-libraries electron dialect (optional)',
+      },
+      {
+        id: 'force',
+        label: 'Overwrite files',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['create'];
+      pushOptionalFlag(argv, '--template', values.template ?? '');
+      pushOptionalFlag(argv, '--dir', values.dir ?? '');
+      pushOptionalFlag(argv, '--name', values.name ?? '');
+      pushOptionalFlag(argv, '--targets', values.targets ?? '');
+      pushOptionalFlag(
+        argv,
+        '--server-dialect',
+        values['server-dialect'] ?? ''
+      );
+      pushOptionalFlag(argv, '--react-dialect', values['react-dialect'] ?? '');
+      pushOptionalFlag(
+        argv,
+        '--vanilla-dialect',
+        values['vanilla-dialect'] ?? ''
+      );
+      pushOptionalFlag(
+        argv,
+        '--electron-dialect',
+        values['electron-dialect'] ?? ''
+      );
+      const force = parseBooleanInput(values.force ?? 'false');
+      if (force === true) {
+        argv.push('--force', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'create-space',
+    label: 'create-space',
+    description: 'Create and provision a new hosted space',
+    fields: [
+      { id: 'name', label: 'Space name', required: true },
+      {
+        id: 'database-provider',
+        label: 'Database provider sqlite|neon|postgres',
+        defaultValue: 'sqlite',
+      },
+      {
+        id: 'connection-string',
+        label: 'Database connection string (optional)',
+      },
+      {
+        id: 'region',
+        label: 'Region auto|enam|wnam|weur|eeur|apac|oc',
+        defaultValue: 'auto',
+      },
+      { id: 'control-token', label: 'Control-plane bearer token (optional)' },
+      { id: 'actor-id', label: 'Actor id fallback (optional)' },
+      {
+        id: 'json',
+        label: 'JSON output',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['create-space'];
+      pushOptionalFlag(argv, '--name', values.name ?? '');
+      pushOptionalFlag(
+        argv,
+        '--database-provider',
+        values['database-provider'] ?? ''
+      );
+      pushOptionalFlag(
+        argv,
+        '--connection-string',
+        values['connection-string'] ?? ''
+      );
+      pushOptionalFlag(argv, '--region', values.region ?? '');
+      pushOptionalFlag(argv, '--control-token', values['control-token'] ?? '');
+      pushOptionalFlag(argv, '--actor-id', values['actor-id'] ?? '');
+      const json = parseBooleanInput(values.json ?? 'false');
+      if (json === true) {
+        argv.push('--json', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'dev',
+    label: 'dev',
+    description: 'Run local runtime with hot reload',
+    fields: [
+      { id: 'host', label: 'Host', defaultValue: '127.0.0.1' },
+      { id: 'port', label: 'Port', kind: 'number', defaultValue: '4312' },
+      {
+        id: 'db-provider',
+        label: 'DB provider sqlite|neon|postgres (optional)',
+      },
+      { id: 'db', label: 'SQLite path override (optional)' },
+      {
+        id: 'connection-string',
+        label: 'Postgres/Neon connection string (optional)',
+      },
+      {
+        id: 'watch',
+        label: 'Watch mode',
+        kind: 'boolean',
+        defaultValue: 'true',
+      },
+      {
+        id: 'open',
+        label: 'Open embedded console',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['dev'];
+      pushOptionalFlag(argv, '--host', values.host ?? '');
+      pushOptionalFlag(argv, '--port', values.port ?? '');
+      pushOptionalFlag(argv, '--db-provider', values['db-provider'] ?? '');
+      pushOptionalFlag(argv, '--db', values.db ?? '');
+      pushOptionalFlag(
+        argv,
+        '--connection-string',
+        values['connection-string'] ?? ''
+      );
+      const watch = parseBooleanInput(values.watch ?? 'true');
+      if (watch === false) {
+        argv.push('--watch', 'false');
+      }
+      const open = parseBooleanInput(values.open ?? 'false');
+      if (open === true) {
+        argv.push('--open', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'typegen',
+    label: 'typegen',
+    description: 'Generate TS database types from syncular.config.ts',
+    fields: [
+      { id: 'config', label: 'Config path (optional)' },
+      { id: 'out', label: 'Output file path (optional)' },
+      { id: 'dialect', label: 'Dialect sqlite|postgres (optional)' },
+      { id: 'tables', label: 'Restrict tables CSV (optional)' },
+      {
+        id: 'extends-sync-client-db',
+        label: 'Extend SyncClientDb',
+        kind: 'boolean',
+        defaultValue: 'true',
+      },
+      {
+        id: 'include-version-history',
+        label: 'Include version history',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+      {
+        id: 'syncular-import-type',
+        label: 'Import style scoped|umbrella (optional)',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['typegen'];
+      pushOptionalFlag(argv, '--config', values.config ?? '');
+      pushOptionalFlag(argv, '--out', values.out ?? '');
+      pushOptionalFlag(argv, '--dialect', values.dialect ?? '');
+      pushOptionalFlag(argv, '--tables', values.tables ?? '');
+      const extendsSyncClientDb = parseBooleanInput(
+        values['extends-sync-client-db'] ?? 'true'
+      );
+      if (extendsSyncClientDb !== null) {
+        argv.push(
+          '--extends-sync-client-db',
+          extendsSyncClientDb ? 'true' : 'false'
+        );
+      }
+      const includeVersionHistory = parseBooleanInput(
+        values['include-version-history'] ?? 'false'
+      );
+      if (includeVersionHistory !== null) {
+        argv.push(
+          '--include-version-history',
+          includeVersionHistory ? 'true' : 'false'
+        );
+      }
+      pushOptionalFlag(
+        argv,
+        '--syncular-import-type',
+        values['syncular-import-type'] ?? ''
+      );
+      return argv;
+    },
+  },
+  {
+    id: 'migrate-status',
+    label: 'migrate-status',
+    description: 'Show migration adapter status',
+    fields: [{ id: 'config', label: 'Config path (optional)' }],
+    buildArgv(values) {
+      const argv = ['migrate-status'];
+      pushOptionalFlag(argv, '--config', values.config ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'migrate-up',
+    label: 'migrate-up',
+    description: 'Apply migrations via adapter',
+    fields: [
+      { id: 'config', label: 'Config path (optional)' },
+      {
+        id: 'on-checksum-mismatch',
+        label: 'Checksum mismatch mode error|reset (optional)',
+      },
+      {
+        id: 'dry-run',
+        label: 'Dry run',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+      {
+        id: 'yes',
+        label: 'Confirm reset mode',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['migrate-up'];
+      pushOptionalFlag(argv, '--config', values.config ?? '');
+      pushOptionalFlag(
+        argv,
+        '--on-checksum-mismatch',
+        values['on-checksum-mismatch'] ?? ''
+      );
+      const dryRun = parseBooleanInput(values['dry-run'] ?? 'false');
+      if (dryRun === true) {
+        argv.push('--dry-run', 'true');
+      }
+      const yes = parseBooleanInput(values.yes ?? 'false');
+      if (yes === true) {
+        argv.push('--yes', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'build',
+    label: 'build',
+    description: 'Build artifact from syncular contract + buildpack',
+    fields: [
+      { id: 'target', label: 'Target (spaces, optional)' },
+      {
+        id: 'buildpack',
+        label: `Buildpack (${BUILDPACK_IDS_LABEL}, optional)`,
+      },
+      { id: 'config', label: 'Contract config path (optional)' },
+      { id: 'entry', label: 'Worker entry override (optional)' },
+      { id: 'out', label: 'Artifact output path (optional)' },
+      { id: 'manifest', label: 'Manifest output path (optional)' },
+      {
+        id: 'force',
+        label: 'Overwrite outputs',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['build'];
+      pushOptionalFlag(argv, '--target', values.target ?? '');
+      pushOptionalFlag(argv, '--buildpack', values.buildpack ?? '');
+      pushOptionalFlag(argv, '--config', values.config ?? '');
+      pushOptionalFlag(argv, '--entry', values.entry ?? '');
+      pushOptionalFlag(argv, '--out', values.out ?? '');
+      pushOptionalFlag(argv, '--manifest', values.manifest ?? '');
+      const force = parseBooleanInput(values.force ?? 'false');
+      if (force === true) {
+        argv.push('--force', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'eject',
+    label: 'eject',
+    description: 'Eject buildpack output for custom deployment',
+    fields: [
+      { id: 'target', label: 'Target (spaces, optional)' },
+      {
+        id: 'buildpack',
+        label: `Buildpack (${BUILDPACK_IDS_LABEL}, optional)`,
+      },
+      { id: 'config', label: 'Contract config path (optional)' },
+      { id: 'entry', label: 'Worker entry override (optional)' },
+      { id: 'out-dir', label: 'Output directory (optional)' },
+      {
+        id: 'force',
+        label: 'Overwrite outputs',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['eject'];
+      pushOptionalFlag(argv, '--target', values.target ?? '');
+      pushOptionalFlag(argv, '--buildpack', values.buildpack ?? '');
+      pushOptionalFlag(argv, '--config', values.config ?? '');
+      pushOptionalFlag(argv, '--entry', values.entry ?? '');
+      pushOptionalFlag(argv, '--out-dir', values['out-dir'] ?? '');
+      const force = parseBooleanInput(values.force ?? 'false');
+      if (force === true) {
+        argv.push('--force', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'target',
+    label: 'target',
+    description: 'Show or set default target profile',
+    fields: [{ id: 'set', label: 'Set target (spaces, optional)' }],
+    buildArgv(values) {
+      const argv = ['target'];
+      pushOptionalFlag(argv, '--set', values.set ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'deploy',
+    label: 'deploy',
+    description: 'Deploy runtime build to a space',
+    fields: [
+      { id: 'space', label: 'Space ID', required: true },
+      { id: 'target', label: 'Target (spaces, optional)' },
+      { id: 'control-token', label: 'Control-plane bearer token (optional)' },
+      { id: 'config', label: 'Contract config path (optional)' },
+      { id: 'entry', label: 'Worker entry override (optional)' },
+      { id: 'script-name', label: 'Script name override (optional)' },
+      { id: 'source', label: 'Source label (optional)' },
+      {
+        id: 'dry-run',
+        label: 'Dry run',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['deploy'];
+      pushOptionalFlag(argv, '--space', values.space ?? '');
+      pushOptionalFlag(argv, '--target', values.target ?? '');
+      pushOptionalFlag(argv, '--control-token', values['control-token'] ?? '');
+      pushOptionalFlag(argv, '--config', values.config ?? '');
+      pushOptionalFlag(argv, '--entry', values.entry ?? '');
+      pushOptionalFlag(argv, '--script-name', values['script-name'] ?? '');
+      pushOptionalFlag(argv, '--source', values.source ?? '');
+      const dryRun = parseBooleanInput(values['dry-run'] ?? 'false');
+      if (dryRun === true) {
+        argv.push('--dry-run', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'verify',
+    label: 'verify',
+    description: 'Verify deployment/runtime health',
+    fields: [
+      { id: 'space', label: 'Space ID', required: true },
+      { id: 'target', label: 'Target (spaces, optional)' },
+      { id: 'control-token', label: 'Control-plane bearer token (optional)' },
+      { id: 'base-url', label: 'Runtime URL override (optional)' },
+    ],
+    buildArgv(values) {
+      const argv = ['verify'];
+      pushOptionalFlag(argv, '--space', values.space ?? '');
+      pushOptionalFlag(argv, '--target', values.target ?? '');
+      pushOptionalFlag(argv, '--control-token', values['control-token'] ?? '');
+      pushOptionalFlag(argv, '--base-url', values['base-url'] ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'deployments',
+    label: 'deployments',
+    description: 'List deployment history for a space',
+    fields: [
+      { id: 'space', label: 'Space ID', required: true },
+      { id: 'control-token', label: 'Control-plane bearer token (optional)' },
+      { id: 'limit', label: 'Limit', kind: 'number', defaultValue: '20' },
+    ],
+    buildArgv(values) {
+      const argv = ['deployments'];
+      pushOptionalFlag(argv, '--space', values.space ?? '');
+      pushOptionalFlag(argv, '--control-token', values['control-token'] ?? '');
+      pushOptionalFlag(argv, '--limit', values.limit ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'rollback',
+    label: 'rollback',
+    description: 'Activate a previous deployment for a space',
+    fields: [
+      { id: 'space', label: 'Space ID', required: true },
+      { id: 'control-token', label: 'Control-plane bearer token (optional)' },
+      { id: 'to', label: 'Target deployment ID', required: true },
+      { id: 'reason', label: 'Reason (optional)' },
+    ],
+    buildArgv(values) {
+      const argv = ['rollback'];
+      pushOptionalFlag(argv, '--space', values.space ?? '');
+      pushOptionalFlag(argv, '--control-token', values['control-token'] ?? '');
+      pushOptionalFlag(argv, '--to', values.to ?? '');
+      pushOptionalFlag(argv, '--reason', values.reason ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'login',
+    label: 'login',
+    description: 'Authenticate CLI with Clerk and save token to keychain',
+    fields: [
+      { id: 'control-plane', label: 'Control-plane base URL (optional)' },
+    ],
+    buildArgv(values) {
+      const argv = ['login'];
+      pushOptionalFlag(argv, '--control-plane', values['control-plane'] ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'logout',
+    label: 'logout',
+    description: 'Clear saved CLI token from keychain',
+    fields: [
+      { id: 'control-plane', label: 'Control-plane base URL (optional)' },
+    ],
+    buildArgv(values) {
+      const argv = ['logout'];
+      pushOptionalFlag(argv, '--control-plane', values['control-plane'] ?? '');
+      return argv;
+    },
+  },
+  {
+    id: 'whoami',
+    label: 'whoami',
+    description: 'Validate current CLI auth token and print actor',
+    fields: [
+      { id: 'control-plane', label: 'Control-plane base URL (optional)' },
+      {
+        id: 'json',
+        label: 'JSON output',
+        kind: 'boolean',
+        defaultValue: 'false',
+      },
+    ],
+    buildArgv(values) {
+      const argv = ['whoami'];
+      pushOptionalFlag(argv, '--control-plane', values['control-plane'] ?? '');
+      const json = parseBooleanInput(values.json ?? 'false');
+      if (json === true) {
+        argv.push('--json', 'true');
+      }
+      return argv;
+    },
+  },
+  {
+    id: 'help',
+    label: 'help',
+    description: 'Show full command reference',
+    buildArgv() {
+      return ['help'];
+    },
+  },
+  {
+    id: 'quit',
+    label: 'quit',
+    description: 'Exit the interactive shell',
+    buildArgv() {
+      return null;
+    },
+  },
+];
+
+const interactiveCommandById = new Map(
+  ALL_INTERACTIVE_COMMANDS.map((command) => [command.id, command] as const)
+);
+
+function pickInteractiveCommands(
+  ...ids: InteractiveCommand['id'][]
+): InteractiveCommand[] {
+  return ids
+    .map((id) => interactiveCommandById.get(id) ?? null)
+    .filter((command): command is InteractiveCommand => command !== null);
+}
+
+export function listInteractiveCommands(
+  initialCommand: RootCommand | null
+): InteractiveCommand[] {
+  if (initialCommand === 'doctor') {
+    return pickInteractiveCommands('doctor', 'help', 'quit');
+  }
+  if (initialCommand === 'console') {
+    return pickInteractiveCommands('console', 'help', 'quit');
+  }
+  if (initialCommand === 'create') {
+    return pickInteractiveCommands('create', 'help', 'quit');
+  }
+  if (initialCommand === 'create-space') {
+    return pickInteractiveCommands('create-space', 'help', 'quit');
+  }
+  if (initialCommand === 'dev') {
+    return pickInteractiveCommands('dev', 'help', 'quit');
+  }
+  if (initialCommand === 'typegen') {
+    return pickInteractiveCommands('typegen', 'help', 'quit');
+  }
+  if (initialCommand === 'migrate-status') {
+    return pickInteractiveCommands('migrate-status', 'help', 'quit');
+  }
+  if (initialCommand === 'migrate-up') {
+    return pickInteractiveCommands('migrate-up', 'help', 'quit');
+  }
+  if (initialCommand === 'build') {
+    return pickInteractiveCommands('build', 'help', 'quit');
+  }
+  if (initialCommand === 'eject') {
+    return pickInteractiveCommands('eject', 'help', 'quit');
+  }
+  if (initialCommand === 'target') {
+    return pickInteractiveCommands('target', 'help', 'quit');
+  }
+  if (initialCommand === 'deploy') {
+    return pickInteractiveCommands('deploy', 'help', 'quit');
+  }
+  if (initialCommand === 'verify') {
+    return pickInteractiveCommands('verify', 'help', 'quit');
+  }
+  if (initialCommand === 'deployments') {
+    return pickInteractiveCommands('deployments', 'help', 'quit');
+  }
+  if (initialCommand === 'rollback') {
+    return pickInteractiveCommands('rollback', 'help', 'quit');
+  }
+  if (initialCommand === 'login') {
+    return pickInteractiveCommands('login', 'whoami', 'logout', 'help', 'quit');
+  }
+  if (initialCommand === 'logout') {
+    return pickInteractiveCommands('logout', 'login', 'whoami', 'help', 'quit');
+  }
+  if (initialCommand === 'whoami') {
+    return pickInteractiveCommands('whoami', 'login', 'logout', 'help', 'quit');
+  }
+
+  return ALL_INTERACTIVE_COMMANDS;
+}