@brimveyn/aimux-config 0.1.0

package/src/types.ts

@@ -0,0 +1,568 @@
+// -----------------------------------------------------------------------------
+// Self-contained types for the aimux keymap/config surface.
+// These are duplicated from the aimux CLI's internal types to keep this
+// package dependency-free. They must stay structurally identical with the
+// CLI types in `aimux`'s `src/state/types.ts`, `src/input/modes/types.ts`,
+// `src/ui/themes.ts`, and `src/state/layout-tree.ts`.
+// -----------------------------------------------------------------------------
+
+// ─── Mode identifiers ─────────────────────────────────────────────────────────
+
+export type ModeId =
+  | 'navigation'
+  | 'terminal-input'
+  | 'layout'
+  | 'modal.new-tab'
+  | 'modal.new-tab.command-edit'
+  | 'modal.session-picker'
+  | 'modal.session-picker.filtering'
+  | 'modal.session-name'
+  | 'modal.create-session'
+  | 'modal.rename-tab'
+  | 'modal.snippet-picker'
+  | 'modal.snippet-picker.filtering'
+  | 'modal.snippet-editor'
+  | 'modal.theme-picker'
+  | 'modal.help'
+  | 'modal.split-picker'
+
+// ─── Primitive app types ──────────────────────────────────────────────────────
+
+export type BuiltinAssistantId = 'claude' | 'codex' | 'opencode' | 'terminal'
+export type AssistantId = BuiltinAssistantId | (string & {})
+export type TabStatus = 'starting' | 'running' | 'disconnected' | 'exited' | 'error'
+export type TabActivity = 'busy' | 'idle'
+export type FocusMode = 'navigation' | 'terminal-input' | 'modal' | 'command-edit' | 'layout'
+export type SplitDirection = 'horizontal' | 'vertical'
+
+// ─── Terminal data shapes ─────────────────────────────────────────────────────
+
+export interface TerminalSpan {
+  text: string
+  fg?: string
+  bg?: string
+  bold?: boolean
+  italic?: boolean
+  underline?: boolean
+  cursor?: boolean
+}
+
+export interface TerminalLine {
+  spans: TerminalSpan[]
+}
+
+export interface TerminalSnapshot {
+  lines: TerminalLine[]
+  viewportY: number
+  baseY: number
+  cursorVisible: boolean
+}
+
+export interface TerminalModeState {
+  mouseTrackingMode: 'none' | 'x10' | 'vt200' | 'drag' | 'any'
+  sendFocusMode: boolean
+  alternateScrollMode: boolean
+  isAlternateBuffer: boolean
+  bracketedPasteMode: boolean
+}
+
+// ─── Layout ───────────────────────────────────────────────────────────────────
+
+export type LayoutLeaf = { type: 'leaf'; tabId: string }
+export type LayoutSplit = {
+  type: 'split'
+  direction: SplitDirection
+  ratio: number
+  first: LayoutNode
+  second: LayoutNode
+}
+export type LayoutNode = LayoutLeaf | LayoutSplit
+
+// ─── Records ──────────────────────────────────────────────────────────────────
+
+export interface PersistedTabSnapshot {
+  id: string
+  assistant: AssistantId
+  title: string
+  command: string
+  status: Exclude<TabStatus, 'disconnected'>
+  buffer: string
+  viewport?: TerminalSnapshot
+  terminalModes: TerminalModeState
+  errorMessage?: string
+  exitCode?: number
+}
+
+export interface WorkspaceSnapshotV1 {
+  version: 1
+  savedAt: string
+  activeTabId: string | null
+  sidebar: {
+    visible: boolean
+    width: number
+    gitPanelVisible?: boolean
+    gitPanelRatio?: number
+  }
+  tabs: PersistedTabSnapshot[]
+  layoutTree?: LayoutNode
+  layoutTrees?: Record<string, LayoutNode>
+  tabGroupMap?: Record<string, string>
+}
+
+export interface SessionRecord {
+  id: string
+  name: string
+  projectPath?: string
+  createdAt: string
+  updatedAt: string
+  lastOpenedAt: string
+  workspaceSnapshot?: WorkspaceSnapshotV1
+}
+
+export interface TabSession {
+  id: string
+  assistant: AssistantId
+  title: string
+  status: TabStatus
+  activity?: TabActivity
+  buffer: string
+  viewport?: TerminalSnapshot
+  terminalModes: TerminalModeState
+  command: string
+  errorMessage?: string
+  exitCode?: number
+}
+
+export interface SnippetRecord {
+  id: string
+  name: string
+  content: string
+}
+
+export type DirectoryResultType = 'git-repo' | 'worktree' | 'workspace'
+
+export interface DirectoryResult {
+  path: string
+  type: DirectoryResultType
+}
+
+// ─── Sidebar / git panel / modal state (for ModeContext) ──────────────────────
+
+export interface SidebarState {
+  visible: boolean
+  width: number
+  minWidth: number
+  maxWidth: number
+  gitPanelVisible: boolean
+  gitPanelRatio: number
+}
+
+export type GitFileStatus = 'M' | 'A' | 'D' | 'R' | 'C' | 'U' | '?'
+export type GitFileSection = 'staged' | 'unstaged' | 'untracked'
+
+export interface GitFileEntry {
+  path: string
+  renamedFrom?: string
+  section: GitFileSection
+  status: GitFileStatus
+  added: number | null
+  removed: number | null
+}
+
+export type GitPanelError = 'not-a-repo' | 'unknown'
+
+export interface GitPanelState {
+  branch: string | null
+  ahead: number
+  behind: number
+  files: GitFileEntry[]
+  error: GitPanelError | null
+}
+
+interface ModalBase {
+  selectedIndex: number
+  editBuffer: string | null
+  sessionTargetId: string | null
+}
+
+export interface ModalClosed extends ModalBase {
+  type: null
+  editBuffer: null
+  sessionTargetId: null
+}
+
+export interface ModalNewTab extends ModalBase {
+  type: 'new-tab'
+}
+export interface ModalSessionPicker extends ModalBase {
+  type: 'session-picker'
+}
+export interface ModalSessionName extends ModalBase {
+  type: 'session-name'
+}
+export interface ModalRenameTab extends ModalBase {
+  type: 'rename-tab'
+}
+export interface ModalSnippetPicker extends ModalBase {
+  type: 'snippet-picker'
+}
+export interface ModalThemePicker extends ModalBase {
+  type: 'theme-picker'
+}
+export interface ModalHelp extends ModalBase {
+  type: 'help'
+}
+export interface ModalSplitPicker extends ModalBase {
+  type: 'split-picker'
+  splitDirection: SplitDirection
+}
+export interface ModalCreateSession extends ModalBase {
+  type: 'create-session'
+  directoryResults: DirectoryResult[]
+  pendingProjectPath: string | null
+  activeField: 'directory' | 'name'
+  nameBuffer: string
+}
+export interface ModalSnippetEditor extends ModalBase {
+  type: 'snippet-editor'
+  activeField: 'name' | 'content'
+  contentBuffer: string
+}
+
+export type ModalState =
+  | ModalClosed
+  | ModalNewTab
+  | ModalSessionPicker
+  | ModalSessionName
+  | ModalRenameTab
+  | ModalSnippetPicker
+  | ModalThemePicker
+  | ModalHelp
+  | ModalSplitPicker
+  | ModalCreateSession
+  | ModalSnippetEditor
+
+export interface LayoutState {
+  terminalCols: number
+  terminalRows: number
+}
+
+export interface AppState {
+  tabs: TabSession[]
+  activeTabId: string | null
+  layoutTrees: Record<string, LayoutNode>
+  tabGroupMap: Record<string, string>
+  sessions: SessionRecord[]
+  currentSessionId: string | null
+  snippets: SnippetRecord[]
+  focusMode: FocusMode
+  sidebar: SidebarState
+  modal: ModalState
+  layout: LayoutState
+  customCommands: Record<AssistantId, string>
+  gitPanel: GitPanelState
+  pendingChords: string[] | null
+}
+
+// ─── AppAction union ──────────────────────────────────────────────────────────
+
+export type ModalAction =
+  | { type: 'open-new-tab-modal' }
+  | { type: 'open-help-modal' }
+  | { type: 'open-split-picker'; direction: SplitDirection }
+  | { type: 'open-session-picker' }
+  | { type: 'open-session-name-modal'; sessionTargetId?: string; initialName?: string }
+  | { type: 'close-modal' }
+  | { type: 'move-modal-selection'; delta: number }
+  | { type: 'begin-command-edit' }
+  | { type: 'update-command-edit'; char: string }
+  | { type: 'commit-command-edit' }
+  | { type: 'cancel-command-edit' }
+  | { type: 'open-create-session-modal' }
+  | { type: 'set-directory-results'; results: DirectoryResult[] }
+  | { type: 'switch-create-session-field' }
+  | { type: 'select-directory' }
+  | { type: 'begin-session-filter' }
+  | { type: 'open-rename-tab-modal' }
+  | { type: 'open-snippet-picker' }
+  | { type: 'open-snippet-editor'; snippetId?: string }
+  | { type: 'begin-snippet-filter' }
+  | { type: 'open-theme-picker' }
+
+export type SessionAction =
+  | { type: 'load-session'; sessionId: string; workspaceSnapshot?: WorkspaceSnapshotV1 }
+  | { type: 'set-sessions'; sessions: SessionRecord[] }
+  | { type: 'create-session-record'; session: SessionRecord }
+  | { type: 'rename-session-record'; sessionId: string; name: string }
+  | { type: 'delete-session-record'; sessionId: string }
+
+export type TabAction =
+  | { type: 'add-tab'; tab: TabSession }
+  | {
+      type: 'hydrate-workspace'
+      tabs: TabSession[]
+      activeTabId: string | null
+      layoutTree?: LayoutNode | null
+      layoutTrees?: Record<string, LayoutNode>
+      tabGroupMap?: Record<string, string>
+    }
+  | { type: 'close-tab'; tabId: string }
+  | { type: 'close-active-tab' }
+  | { type: 'set-active-tab'; tabId: string }
+  | { type: 'move-active-tab'; delta: number }
+  | { type: 'reorder-active-tab'; delta: number }
+  | { type: 'reset-tab-session'; tabId: string }
+  | { type: 'rename-tab'; tabId: string; title: string }
+  | { type: 'append-tab-buffer'; tabId: string; chunk: string }
+  | {
+      type: 'replace-tab-viewport'
+      tabId: string
+      viewport: TerminalSnapshot
+      terminalModes: TerminalModeState
+    }
+  | { type: 'set-tab-activity'; tabId: string; activity?: TabActivity }
+  | { type: 'set-tab-status'; tabId: string; status: TabStatus; exitCode?: number }
+  | { type: 'set-tab-error'; tabId: string; message: string }
+
+export type LayoutAction =
+  | {
+      type: 'split-pane'
+      direction: SplitDirection
+      newTab: TabSession
+    }
+  | { type: 'close-pane'; tabId: string }
+  | {
+      type: 'focus-pane-direction'
+      direction: 'left' | 'right' | 'up' | 'down'
+    }
+  | {
+      type: 'resize-pane'
+      tabId: string
+      delta: number
+      axis?: SplitDirection
+    }
+  | {
+      type: 'set-split-ratio'
+      tabId: string
+      ratio: number
+      axis?: SplitDirection
+    }
+
+export type UIAction =
+  | { type: 'toggle-sidebar' }
+  | { type: 'resize-sidebar'; delta: number }
+  | { type: 'set-focus-mode'; focusMode: FocusMode }
+  | { type: 'set-terminal-size'; cols: number; rows: number }
+  | { type: 'toggle-git-panel' }
+  | { type: 'resize-git-panel'; delta: number }
+  | { type: 'set-pending-chords'; chords: string[] | null }
+
+export interface GitRefreshPayload {
+  branch: string | null
+  ahead: number
+  behind: number
+  files: GitFileEntry[]
+}
+
+export type GitPanelAction =
+  | { type: 'git-refresh-success'; payload: GitRefreshPayload }
+  | { type: 'git-refresh-error'; kind: GitPanelError }
+  | { type: 'git-panel-reset' }
+
+export type DataAction =
+  | { type: 'set-snippets'; snippets: SnippetRecord[] }
+  | { type: 'delete-snippet'; snippetId: string }
+
+export type AppAction =
+  | ModalAction
+  | SessionAction
+  | TabAction
+  | LayoutAction
+  | UIAction
+  | DataAction
+  | GitPanelAction
+
+// ─── Side effects ─────────────────────────────────────────────────────────────
+
+export type SideEffect =
+  | { type: 'quit'; state: AppState }
+  | { type: 'launch-selected-assistant' }
+  | { type: 'confirm-selected-session' }
+  | { type: 'delete-selected-session' }
+  | { type: 'open-rename-selected-session' }
+  | { type: 'create-session'; name: string; projectPath?: string }
+  | { type: 'close-tab'; tabId: string }
+  | { type: 'restart-tab'; tab: TabSession }
+  | { type: 'paste-selected-snippet' }
+  | { type: 'paste-snippet-to-group' }
+  | { type: 'edit-selected-snippet' }
+  | { type: 'delete-selected-snippet' }
+  | { type: 'save-snippet-editor' }
+  | { type: 'save-custom-command' }
+  | { type: 'apply-theme'; action: 'open' }
+  | { type: 'apply-theme'; action: 'restore' }
+  | { type: 'apply-theme'; action: 'confirm' }
+  | { type: 'apply-theme'; action: 'preview'; delta: 1 | -1 }
+  | { type: 'rename-session'; sessionId: string; name: string }
+  | { type: 'split-pane'; direction: SplitDirection }
+  | { type: 'confirm-split' }
+
+// ─── Key input / KeyResult / ModeContext ──────────────────────────────────────
+
+/** Structural shape for a parsed key event. Matches @opentui/core's KeyEvent. */
+export interface KeyInput {
+  name: string
+  ctrl: boolean
+  meta: boolean
+  shift: boolean
+  sequence: string
+}
+
+export interface KeyResult {
+  actions: AppAction[]
+  effects: SideEffect[]
+  transition?: ModeId
+}
+
+export interface ModeContext {
+  readonly state: AppState
+}
+
+// ─── Themes ───────────────────────────────────────────────────────────────────
+
+export interface ThemeColors {
+  background: string
+  panel: string
+  panelMuted: string
+  panelHighlight: string
+  overlay: string
+  border: string
+  borderActive: string
+  text: string
+  textMuted: string
+  accent: string
+  accentAlt: string
+  warning: string
+  danger: string
+  success: string
+  dim: string
+}
+
+export type ThemeId =
+  | 'aimux'
+  | 'dracula'
+  | 'dracula-at-night'
+  | 'everforest'
+  | 'tokyo-night'
+  | 'gruvbox-dark'
+  | 'catppuccin-mocha'
+  | 'nord'
+  | 'solarized-dark'
+  | 'one-dark'
+  | 'kanagawa'
+
+export interface ThemeDefinition {
+  base?: ThemeId
+  colors: ThemeColors
+}
+
+// ─── Backend config (stub) ────────────────────────────────────────────────────
+
+export interface BackendConfig {
+  command: string
+  args?: string[]
+}
+
+// ─── Sidebar config (stub) ────────────────────────────────────────────────────
+
+export interface SidebarConfig {
+  widgets?: string[]
+  width?: number
+}
+
+// ─── Hooks config (stub) ──────────────────────────────────────────────────────
+
+export interface HooksConfig {
+  onSessionCreate?: (session: { name: string; projectPath?: string }) => void | Promise<void>
+}
+
+// ─── Snippet config (stub) ────────────────────────────────────────────────────
+
+export interface SnippetDef {
+  name: string
+  trigger?: string
+  text: string
+}
+
+// ─── Action value types ───────────────────────────────────────────────────────
+
+export type ActionFn = (ctx: ModeContext) => KeyResult | null
+export type Action = KeyResult | ActionFn
+
+// ─── Keymap builder API types ─────────────────────────────────────────────────
+
+export interface GroupBuilderApi {
+  map(keys: string, action: Action): GroupBuilderApi
+  group(
+    prefix: string,
+    name: string,
+    configure: (g: GroupBuilderApi) => GroupBuilderApi
+  ): GroupBuilderApi
+}
+
+export interface ModeBindingBuilderApi {
+  map(keys: string, action: Action): ModeBindingBuilderApi
+  unmap(keys: string): ModeBindingBuilderApi
+  group(
+    prefix: string,
+    name: string,
+    configure: (g: GroupBuilderApi) => GroupBuilderApi
+  ): ModeBindingBuilderApi
+  passthrough(): ModeBindingBuilderApi
+}
+
+export interface KeymapBuilderApi {
+  leader(key: string): KeymapBuilderApi
+  timeout(ms: number): KeymapBuilderApi
+  mode(id: ModeId, configure: (m: ModeBindingBuilderApi) => ModeBindingBuilderApi): KeymapBuilderApi
+}
+
+// ─── Top-level user config ────────────────────────────────────────────────────
+
+export interface AimuxUserConfig {
+  theme?: ThemeId | ThemeDefinition
+  keymaps?: (k: KeymapBuilderApi) => KeymapBuilderApi
+  backends?: Record<string, BackendConfig>
+  sidebar?: SidebarConfig
+  hooks?: HooksConfig
+  snippets?: SnippetDef[]
+}
+
+// ─── Resolved config (internal) ───────────────────────────────────────────────
+
+export interface BindingDef {
+  keys: string
+  result: Action
+  group?: string
+}
+
+export interface ModeKeymapDef {
+  bindings: BindingDef[]
+  removals: string[]
+  isPassthrough: boolean
+}
+
+export interface ResolvedKeymapConfig {
+  leader: string
+  timeout: number
+  modes: Map<ModeId, ModeKeymapDef>
+}
+
+export interface ResolvedConfig {
+  theme: ThemeId | ThemeDefinition | undefined
+  keymaps: ResolvedKeymapConfig
+  backends: Record<string, BackendConfig>
+  sidebar: SidebarConfig
+  hooks: HooksConfig
+  snippets: SnippetDef[]
+}