@navios/commander-tui 1.1.0 → 1.3.0

package/lib/interface-DQEIz9Mb.d.cts

@@ -0,0 +1,699 @@
+import { CliRenderer, RGBA, SyntaxStyle, TreeSitterClient } from "@opentui/core";
+import { LogLevel } from "@navios/core";
+import { ReactNode } from "react";
+
+//#region src/types/message.types.d.ts
+type MessageType = 'log' | 'file' | 'diff' | 'fileError' | 'loading' | 'progress' | 'group' | 'table';
+interface BaseMessage {
+  id: string;
+  type: MessageType;
+  timestamp: Date;
+}
+/**
+ * Semantic variants for log messages that don't map directly to LogLevel.
+ * These affect styling but the underlying LogLevel is used for filtering.
+ */
+type LogMessageVariant = 'success' | 'trace';
+interface LogMessageData extends BaseMessage {
+  type: 'log';
+  level: LogLevel;
+  /** Content is always a string - objects are formatted before storage */
+  content: string;
+  label?: string;
+  trace?: string;
+  /** Optional semantic variant for styling (e.g., 'success' shows green even though level is 'log') */
+  variant?: LogMessageVariant;
+}
+interface FileMessageData extends BaseMessage {
+  type: 'file';
+  filePath: string;
+  content: string;
+}
+interface DiffMessageData extends BaseMessage {
+  type: 'diff';
+  filePath: string;
+  diff: string;
+  view?: 'unified' | 'split';
+}
+interface FileErrorMessageData extends BaseMessage {
+  type: 'fileError';
+  filePath: string;
+  content: string;
+  errorLines: number[];
+  startLine: number;
+}
+interface LoadingMessageData extends BaseMessage {
+  type: 'loading';
+  content: string;
+  status: 'loading' | 'success' | 'fail';
+  resolvedContent?: string;
+}
+interface ProgressMessageData extends BaseMessage {
+  type: 'progress';
+  label: string;
+  current: number;
+  total: number;
+  status: 'active' | 'complete' | 'failed';
+  resolvedContent?: string;
+}
+interface GroupMessageData extends BaseMessage {
+  type: 'group';
+  label: string;
+  collapsed: boolean;
+  isEnd: boolean;
+}
+interface TableMessageData extends BaseMessage {
+  type: 'table';
+  headers: string[];
+  rows: string[][];
+  title?: string;
+}
+type MessageData = LogMessageData | FileMessageData | DiffMessageData | FileErrorMessageData | LoadingMessageData | ProgressMessageData | GroupMessageData | TableMessageData;
+interface PromiseOptions<T> {
+  loading: string;
+  success: string | ((data: T) => string);
+  error: string | ((error: Error) => string);
+}
+interface LoadingHandle {
+  success: (message: string) => void;
+  fail: (message: string) => void;
+}
+interface ProgressHandle {
+  update: (current: number, label?: string) => void;
+  complete: (message?: string) => void;
+  fail: (message?: string) => void;
+}
+//#endregion
+//#region src/types/log.types.d.ts
+interface LogLevelColors {
+  border: string;
+  background: string;
+  text?: string;
+}
+type LogLevelColorMap = Record<LogLevel, LogLevelColors>;
+/**
+ * Color map for semantic variants (success, trace) that override level colors.
+ */
+type VariantColorMap = Record<LogMessageVariant, LogLevelColors>;
+interface LogMessageProps {
+  /** Log level determines the color scheme */
+  level: LogLevel;
+  /** Optional semantic variant for styling (e.g., 'success' shows green even though level is 'log') */
+  variant?: LogMessageVariant;
+  /** Message content - can be string or React nodes */
+  children: ReactNode;
+  /** Optional timestamp to display */
+  timestamp?: Date | string;
+  /** Optional label/prefix (e.g., "API", "Database") */
+  label?: string;
+  /** Optional stack trace to display (for trace level) */
+  trace?: string;
+  /** Optional custom border color (overrides level color) */
+  borderColor?: string | RGBA;
+  /** Optional custom background color (overrides level color) */
+  backgroundColor?: string | RGBA;
+  /** Border width style - 'thin' uses left border only, 'thick' uses left+top+bottom */
+  borderStyle?: 'thin' | 'thick';
+  /** Padding inside the message box */
+  padding?: number;
+  /** Margin around the message */
+  margin?: number;
+}
+//#endregion
+//#region src/types/file.types.d.ts
+type FileLogMode = 'full' | 'diff' | 'partial';
+interface FileLogBaseProps {
+  /** File path or name to display in header */
+  filePath: string;
+  /** Override auto-detected filetype for syntax highlighting */
+  filetype?: string;
+  /** Show line numbers */
+  showLineNumbers?: boolean;
+  /** Show header with file path */
+  showHeader?: boolean;
+  /** Custom header background color */
+  headerBackgroundColor?: string | RGBA;
+}
+interface FileLogFullProps extends FileLogBaseProps {
+  mode: 'full';
+  /** The complete file content */
+  content: string;
+}
+interface FileLogDiffProps extends FileLogBaseProps {
+  mode: 'diff';
+  /** Unified diff string */
+  diff: string;
+  /** Diff view mode */
+  view?: 'unified' | 'split';
+}
+interface FileLogPartialProps extends FileLogBaseProps {
+  mode: 'partial';
+  /** File content (full or partial) */
+  content: string;
+  /** Starting line number of the content (1-indexed) */
+  startLine: number;
+  /** Lines to highlight as errors */
+  errorLines?: number[];
+  /** Error highlighting colors */
+  errorLineBackground?: string | RGBA;
+  errorLineBorderColor?: string | RGBA;
+}
+type FileLogProps = FileLogFullProps | FileLogDiffProps | FileLogPartialProps;
+//#endregion
+//#region src/types/theme.types.d.ts
+/**
+ * Color scheme for a single log level.
+ */
+interface LogLevelTheme {
+  border: string;
+  background: string;
+  text?: string;
+}
+/**
+ * Sidebar color scheme.
+ */
+interface SidebarTheme {
+  background?: string;
+  selectedBackground: string;
+  hoverBackground: string;
+  text: string;
+  textDim: string;
+  border: string;
+  badge: string;
+  focusBorder: string;
+}
+/**
+ * Screen header color scheme.
+ */
+interface HeaderTheme {
+  background?: string;
+  text: string;
+  border: string;
+}
+/**
+ * Status indicator with icon and color.
+ */
+interface StatusIndicator {
+  icon: string;
+  color: string;
+}
+/**
+ * Status indicators for all screen states.
+ */
+interface StatusIndicatorsTheme {
+  waiting: StatusIndicator;
+  pending: StatusIndicator;
+  success: StatusIndicator;
+  fail: StatusIndicator;
+  static: StatusIndicator;
+}
+/**
+ * Separator colors for sidebar sections.
+ */
+interface SeparatorTheme {
+  line: string;
+  text: string;
+}
+/**
+ * Progress bar and loading indicator colors.
+ */
+interface ProgressTheme {
+  border: string;
+  background: string;
+  barFilled: string;
+  barEmpty: string;
+  text: string;
+  textDim: string;
+  complete: string;
+  completeBackground: string;
+  failed: string;
+  failedBackground: string;
+}
+/**
+ * Collapsible group colors.
+ */
+interface GroupTheme {
+  border: string;
+  background: string;
+  headerText: string;
+  icon: string;
+}
+/**
+ * Table display colors.
+ */
+interface TableTheme {
+  border: string;
+  background: string;
+  headerText: string;
+  cellText: string;
+  title: string;
+  separator: string;
+}
+/**
+ * File display colors.
+ */
+interface FileTheme {
+  border: string;
+  background: string;
+  headerText: string;
+  headerBackground: string;
+}
+/**
+ * Interactive prompt colors.
+ */
+interface PromptTheme {
+  question: string;
+  optionText: string;
+  optionTextDim: string;
+  optionSelected: string;
+  optionSelectedBackground: string;
+  confirmButton: string;
+  cancelButton: string;
+  buttonBackground: string;
+  buttonSelectedBackground: string;
+  inputBorder: string;
+  inputBackground: string;
+  inputText: string;
+  inputPlaceholder: string;
+  inputCursor: string;
+  border: string;
+  focusBorder: string;
+}
+/**
+ * Error highlighting colors for file displays.
+ */
+interface ErrorHighlightTheme {
+  background: string;
+  border: string;
+  gutterBackground: string;
+}
+/**
+ * Filter bar colors.
+ */
+interface FilterTheme {
+  background: string;
+  border: string;
+  text: string;
+  textDim: string;
+  inputBackground: string;
+  inputText: string;
+  inputPlaceholder: string;
+  cursor: string;
+  activeLevel: string;
+  inactiveLevel: string;
+}
+/**
+ * Help overlay colors.
+ */
+interface HelpTheme {
+  background: string;
+  border: string;
+  title: string;
+  category: string;
+  key: string;
+  description: string;
+  hint: string;
+}
+/**
+ * General semantic colors.
+ */
+interface SemanticColors {
+  primary: string;
+  secondary: string;
+  success: string;
+  warning: string;
+  error: string;
+  muted: string;
+  background?: string;
+  foreground: string;
+}
+/**
+ * Complete theme definition.
+ */
+interface Theme {
+  /** Theme identifier */
+  name: string;
+  /** Log level color schemes */
+  logLevels: Record<LogLevel, LogLevelTheme>;
+  /** Sidebar colors */
+  sidebar: SidebarTheme;
+  /** Screen header colors */
+  header: HeaderTheme;
+  /** Status indicator colors and icons */
+  statusIndicators: StatusIndicatorsTheme;
+  /** Separator colors */
+  separator: SeparatorTheme;
+  /** Progress bar colors */
+  progress: ProgressTheme;
+  /** Collapsible group colors */
+  group: GroupTheme;
+  /** Table display colors */
+  table: TableTheme;
+  /** File display colors */
+  file: FileTheme;
+  /** Prompt colors */
+  prompt: PromptTheme;
+  /** Error highlighting colors */
+  errorHighlight: ErrorHighlightTheme;
+  /** Filter bar colors */
+  filter: FilterTheme;
+  /** Help overlay colors */
+  help: HelpTheme;
+  /** General semantic colors */
+  colors: SemanticColors;
+}
+/**
+ * Theme preset names.
+ */
+type ThemePreset = 'dark' | 'light' | 'high-contrast';
+/**
+ * Deep partial type for theme overrides.
+ */
+type DeepPartial<T> = { [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P] };
+/**
+ * Partial theme for creating custom themes.
+ */
+type PartialTheme = DeepPartial<Theme>;
+//#endregion
+//#region src/types/screen.types.d.ts
+interface ScreenProps {
+  /** Screen title/name displayed in header */
+  name: string;
+  /** Child log messages/file logs */
+  children: ReactNode;
+  /** Enable auto-scroll to bottom on new content */
+  stickyScroll?: boolean;
+  /** Show scroll position indicator */
+  showScrollIndicator?: boolean;
+  /** Screen header background color */
+  headerBackgroundColor?: string | RGBA;
+  /** Screen header text color */
+  headerTextColor?: string | RGBA;
+  /** Whether this screen is currently focused */
+  focused?: boolean;
+  /** Callback when screen is scrolled */
+  onScroll?: (scrollTop: number, scrollHeight: number) => void;
+}
+interface ScreenDefinition {
+  /** Unique screen identifier */
+  id: string;
+  /** Display name for sidebar */
+  name: string;
+  /** Optional icon/badge character */
+  icon?: string;
+  /** Unread/notification count */
+  badgeCount?: number;
+}
+interface ScreenManagerProps {
+  /** Screen definitions for the sidebar */
+  screens: ScreenDefinition[];
+  /** Currently active screen ID */
+  activeScreenId: string;
+  /** Callback when screen selection changes */
+  onScreenChange?: (screenId: string) => void;
+  /** Screen content - should be conditionally rendered based on activeScreenId */
+  children: ReactNode;
+  /** Force show/hide sidebar (overrides auto behavior) */
+  sidebarVisible?: boolean;
+  /** Callback when sidebar visibility changes */
+  onSidebarVisibilityChange?: (visible: boolean) => void;
+  /** Sidebar width (columns) */
+  sidebarWidth?: number;
+  /** Sidebar position */
+  sidebarPosition?: 'left' | 'right';
+  /** Key to toggle sidebar visibility */
+  toggleSidebarKey?: string;
+  /** Sidebar header title */
+  sidebarTitle?: string;
+}
+type FocusArea = 'sidebar' | 'content';
+interface LoggerContextValue {
+  /** Shared SyntaxStyle instance for code highlighting */
+  syntaxStyle?: SyntaxStyle;
+  /** Shared TreeSitterClient for parsing */
+  treeSitterClient?: TreeSitterClient;
+  /** Default colors for log levels (derived from theme for backwards compatibility) */
+  levelColors: LogLevelColorMap;
+  /** Current theme */
+  theme: Theme;
+}
+type ScreenStatus = 'waiting' | 'pending' | 'success' | 'fail' | 'static';
+interface BindOptions {
+  exitOnCtrlC?: boolean;
+  sidebarWidth?: number;
+  sidebarPosition?: 'left' | 'right';
+  sidebarTitle?: string;
+  /** Auto close after all screens complete successfully (delay in ms, default 5000) */
+  autoClose?: boolean | number;
+  /** Theme to use for the TUI (theme object or preset name) */
+  theme?: Theme | ThemePreset;
+  /** Enable mouse support (default: true) */
+  useMouse?: boolean;
+}
+//#endregion
+//#region src/types/prompt.types.d.ts
+interface ChoiceOption {
+  label: string;
+  value: string;
+  /** If true, this option allows text input */
+  input?: boolean;
+}
+interface BasePromptData {
+  id: string;
+  timestamp: Date;
+  resolved: boolean;
+  /** Auto-resolve timeout in ms */
+  timeout?: number;
+  /** Timestamp when timeout started */
+  timeoutStarted?: number;
+}
+interface ChoicePromptData extends BasePromptData {
+  type: 'choice';
+  question: string;
+  choices: ChoiceOption[];
+  defaultChoice: string;
+  selectedIndex: number;
+  inputMode: boolean;
+  inputValue: string;
+  resolvedValue?: string;
+}
+interface ConfirmPromptData extends BasePromptData {
+  type: 'confirm';
+  question: string;
+  confirmText: string;
+  cancelText: string;
+  defaultValue: boolean;
+  selectedValue: boolean;
+  resolvedValue?: boolean;
+}
+interface InputPromptData extends BasePromptData {
+  type: 'input';
+  question: string;
+  placeholder: string;
+  defaultValue: string;
+  value: string;
+  resolvedValue?: string;
+}
+interface MultiChoicePromptData extends BasePromptData {
+  type: 'multiChoice';
+  question: string;
+  choices: ChoiceOption[];
+  selectedIndices: Set<number>;
+  focusedIndex: number;
+  minSelect: number;
+  maxSelect: number;
+  resolvedValues?: string[];
+}
+type PromptData = ChoicePromptData | ConfirmPromptData | InputPromptData | MultiChoicePromptData;
+interface ChoiceOptions {
+  question: string;
+  choices: ChoiceOption[];
+  defaultChoice?: string;
+  /** Auto-resolve with default after timeout (ms) */
+  timeout?: number;
+}
+interface ConfirmOptions {
+  question: string;
+  confirmText?: string;
+  cancelText?: string;
+  defaultValue?: boolean;
+  /** Auto-resolve with default after timeout (ms) */
+  timeout?: number;
+}
+interface InputOptions {
+  question: string;
+  placeholder?: string;
+  defaultValue?: string;
+  /** Auto-resolve with default after timeout (ms) */
+  timeout?: number;
+}
+interface MultiChoiceOptions {
+  question: string;
+  choices: ChoiceOption[];
+  defaultChoices?: string[];
+  minSelect?: number;
+  maxSelect?: number;
+  /** Auto-resolve with default after timeout (ms) */
+  timeout?: number;
+}
+//#endregion
+//#region src/types/keyboard.types.d.ts
+/**
+ * Key event from the terminal.
+ */
+interface KeyEvent {
+  name: string;
+  sequence?: string;
+  ctrl?: boolean;
+  meta?: boolean;
+  shift?: boolean;
+}
+/**
+ * Context available to keyboard handlers.
+ */
+interface KeyboardContext {
+  /** Has multiple screens (sidebar visible) */
+  hasSidebar: boolean;
+  /** Currently focused area */
+  focusArea: FocusArea;
+  /** Whether a prompt is active */
+  hasPrompt: boolean;
+  /** Whether prompt is in text input mode */
+  inInputMode: boolean;
+  /** Whether filter bar is visible */
+  isFilterActive: boolean;
+  /** Whether help overlay is visible */
+  isHelpVisible: boolean;
+}
+/**
+ * Handler function for a key binding.
+ * Return true to prevent further processing, false/void to continue.
+ */
+type KeyHandler = (key: KeyEvent, context: KeyboardContext) => boolean | void;
+/**
+ * Category for organizing bindings in help overlay.
+ */
+type KeyBindingCategory = 'general' | 'navigation' | 'screen' | 'prompt' | 'filter';
+/**
+ * Condition for when a binding is active.
+ */
+interface KeyBindingCondition {
+  hasPrompt?: boolean;
+  inInputMode?: boolean;
+  focusArea?: FocusArea;
+  isFilterActive?: boolean;
+  isHelpVisible?: boolean;
+  hasSidebar?: boolean;
+}
+/**
+ * A single key binding definition.
+ */
+interface KeyBinding {
+  /** Key name(s) that trigger this binding */
+  key: string | string[];
+  /** Require Ctrl modifier */
+  ctrl?: boolean;
+  /** Require Meta/Cmd modifier */
+  meta?: boolean;
+  /** Require Shift modifier (for capital letters) */
+  shift?: boolean;
+  /** Handler function */
+  handler: KeyHandler;
+  /** Description for help overlay */
+  description: string;
+  /** Category for grouping in help */
+  category: KeyBindingCategory;
+  /** Condition when this binding is active */
+  when?: KeyBindingCondition;
+  /** Priority (higher = checked first, default 0) */
+  priority?: number;
+}
+/**
+ * Configuration for the keyboard manager.
+ */
+interface KeyBindingsConfig {
+  /** Custom bindings (added to defaults) */
+  bindings?: KeyBinding[];
+  /** Override specific default bindings by key */
+  overrides?: Record<string, Partial<KeyBinding>>;
+  /** Disable specific keys */
+  disabled?: string[];
+}
+//#endregion
+//#region src/types/filter.types.d.ts
+/**
+ * Filter state for log filtering.
+ */
+interface FilterState {
+  /** Which log levels are enabled (shown) */
+  enabledLevels: Set<LogLevel>;
+  /** Text search query */
+  searchQuery: string;
+  /** Whether the filter bar is visible */
+  isVisible: boolean;
+  /** Which filter field is focused */
+  focusedField: 'search' | 'levels';
+}
+/**
+ * All log levels in order.
+ */
+declare const ALL_LOG_LEVELS: LogLevel[];
+/**
+ * Create a default filter state.
+ */
+declare function createDefaultFilterState(): FilterState;
+/**
+ * Check if any filtering is active.
+ */
+declare function hasActiveFilter(filter: FilterState): boolean;
+/**
+ * Level counts for display.
+ */
+type LevelCounts = Record<LogLevel, number>;
+//#endregion
+//#region src/adapters/interface.d.ts
+/**
+ * Root instance returned by adapter's createRoot method.
+ * Abstracts the framework-specific root implementation.
+ */
+interface AdapterRoot {
+  /**
+   * Render an element to the root.
+   * @param element - Framework-specific element to render
+   */
+  render(element: unknown): void;
+  /**
+   * Unmount and cleanup the root.
+   */
+  unmount(): void;
+}
+/**
+ * Props passed to the adapter's internal bridge component.
+ * The manager type is kept generic to avoid circular imports.
+ */
+interface AdapterRenderProps {
+  manager: unknown;
+  theme?: Theme;
+}
+/**
+ * Abstract interface for rendering adapters.
+ * Implementations provide framework-specific rendering capabilities.
+ */
+interface AdapterInterface {
+  /**
+   * Create a root instance for rendering.
+   * @param renderer - CLI renderer from @opentui/core
+   * @returns Root instance with render/unmount methods, or a Promise that resolves to one
+   */
+  createRoot(renderer: CliRenderer): AdapterRoot | Promise<AdapterRoot>;
+  /**
+   * Render the adapter's internal bridge component to the root.
+   * The adapter owns its bridge component - no component is passed in.
+   * @param root - Root instance created by createRoot
+   * @param props - Props to pass to the bridge component
+   */
+  renderToRoot(root: AdapterRoot, props: AdapterRenderProps): void;
+}
+//#endregion
+export { FileLogBaseProps as $, ScreenDefinition as A, HelpTheme as B, InputPromptData as C, TableMessageData as Ct, BindOptions as D, PromptData as E, ErrorHighlightTheme as F, SemanticColors as G, PartialTheme as H, FileTheme as I, StatusIndicator as J, SeparatorTheme as K, FilterTheme as L, ScreenProps as M, ScreenStatus as N, FocusArea as O, DeepPartial as P, ThemePreset as Q, GroupTheme as R, InputOptions as S, PromiseOptions as St, MultiChoicePromptData as T, ProgressTheme as U, LogLevelTheme as V, PromptTheme as W, TableTheme as X, StatusIndicatorsTheme as Y, Theme as Z, ChoiceOption as _, LogMessageVariant as _t, FilterState as a, LogLevelColorMap as at, ConfirmOptions as b, ProgressHandle as bt, hasActiveFilter as c, VariantColorMap as ct, KeyBindingCondition as d, FileErrorMessageData as dt, FileLogDiffProps as et, KeyBindingsConfig as f, FileMessageData as ft, BasePromptData as g, LogMessageData as gt, KeyboardContext as h, LoadingMessageData as ht, ALL_LOG_LEVELS as i, FileLogProps as it, ScreenManagerProps as j, LoggerContextValue as k, KeyBinding as l, BaseMessage as lt, KeyHandler as m, LoadingHandle as mt, AdapterRenderProps as n, FileLogMode as nt, LevelCounts as o, LogLevelColors as ot, KeyEvent as p, GroupMessageData as pt, SidebarTheme as q, AdapterRoot as r, FileLogPartialProps as rt, createDefaultFilterState as s, LogMessageProps as st, AdapterInterface as t, FileLogFullProps as tt, KeyBindingCategory as u, DiffMessageData as ut, ChoiceOptions as v, MessageData as vt, MultiChoiceOptions as w, ConfirmPromptData as x, ProgressMessageData as xt, ChoicePromptData as y, MessageType as yt, HeaderTheme as z };
+//# sourceMappingURL=interface-DQEIz9Mb.d.cts.map