@reifydb/shell 0.2.0

package/dist/index.css

@@ -0,0 +1,22 @@
+/* src/terminal/styles.css */
+.xterm {
+  padding: 0;
+}
+.xterm-viewport {
+  scrollbar-width: thin;
+  scrollbar-color: #45475a #1e1e2e;
+}
+.xterm-viewport::-webkit-scrollbar {
+  width: 8px;
+}
+.xterm-viewport::-webkit-scrollbar-track {
+  background: #1e1e2e;
+}
+.xterm-viewport::-webkit-scrollbar-thumb {
+  background: #45475a;
+  border-radius: 4px;
+}
+.xterm-viewport::-webkit-scrollbar-thumb:hover {
+  background: #585b70;
+}
+/*# sourceMappingURL=index.css.map */

package/dist/index.css.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/terminal/styles.css"],"sourcesContent":["/* SPDX-License-Identifier: AGPL-3.0-or-later */\n/* Copyright (c) 2025 ReifyDB */\n\n/* xterm.js container styling */\n.xterm {\n  padding: 0;\n}\n\n.xterm-viewport {\n  /* Hide scrollbar but keep scrolling functional */\n  scrollbar-width: thin;\n  scrollbar-color: #45475a #1e1e2e;\n}\n\n.xterm-viewport::-webkit-scrollbar {\n  width: 8px;\n}\n\n.xterm-viewport::-webkit-scrollbar-track {\n  background: #1e1e2e;\n}\n\n.xterm-viewport::-webkit-scrollbar-thumb {\n  background: #45475a;\n  border-radius: 4px;\n}\n\n.xterm-viewport::-webkit-scrollbar-thumb:hover {\n  background: #585b70;\n}\n"],"mappings":";AAIA,CAAC;AACC,WAAS;AACX;AAEA,CAAC;AAEC,mBAAiB;AACjB,mBAAiB,QAAQ;AAC3B;AAEA,CANC,cAMc;AACb,SAAO;AACT;AAEA,CAVC,cAUc;AACb,cAAY;AACd;AAEA,CAdC,cAcc;AACb,cAAY;AACZ,iBAAe;AACjB;AAEA,CAnBC,cAmBc,yBAAyB;AACtC,cAAY;AACd;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,393 @@
+/**
+ * Terminal color theme configuration
+ */
+interface TerminalTheme {
+    background: string;
+    foreground: string;
+    cursor: string;
+    cursorAccent: string;
+    selectionBackground: string;
+    black: string;
+    red: string;
+    green: string;
+    yellow: string;
+    blue: string;
+    magenta: string;
+    cyan: string;
+    white: string;
+    brightBlack: string;
+    brightRed: string;
+    brightGreen: string;
+    brightYellow: string;
+    brightBlue: string;
+    brightMagenta: string;
+    brightCyan: string;
+    brightWhite: string;
+}
+/**
+ * Catppuccin Mocha theme - default theme
+ */
+declare const defaultTheme: TerminalTheme;
+/**
+ * ANSI escape codes for terminal colors and formatting
+ */
+declare const COLORS: {
+    readonly reset: "\u001B[0m";
+    readonly bold: "\u001B[1m";
+    readonly dim: "\u001B[2m";
+    readonly italic: "\u001B[3m";
+    readonly underline: "\u001B[4m";
+    readonly black: "\u001B[30m";
+    readonly red: "\u001B[31m";
+    readonly green: "\u001B[32m";
+    readonly yellow: "\u001B[33m";
+    readonly blue: "\u001B[34m";
+    readonly magenta: "\u001B[35m";
+    readonly cyan: "\u001B[36m";
+    readonly white: "\u001B[37m";
+    readonly brightBlack: "\u001B[90m";
+    readonly brightRed: "\u001B[91m";
+    readonly brightGreen: "\u001B[92m";
+    readonly brightYellow: "\u001B[93m";
+    readonly brightBlue: "\u001B[94m";
+    readonly brightMagenta: "\u001B[95m";
+    readonly brightCyan: "\u001B[96m";
+    readonly brightWhite: "\u001B[97m";
+};
+
+type KeyHandler = (key: string, domEvent: KeyboardEvent) => void;
+declare class TerminalAdapter {
+    private terminal;
+    private fitAddon;
+    private keyHandler;
+    private resizeObserver;
+    constructor(container: HTMLElement, theme?: TerminalTheme);
+    onKey(handler: KeyHandler): void;
+    write(text: string): void;
+    writeln(text: string): void;
+    clear(): void;
+    get cols(): number;
+    get rows(): number;
+    focus(): void;
+    dispose(): void;
+    static readonly COLORS: {
+        readonly reset: "\u001B[0m";
+        readonly bold: "\u001B[1m";
+        readonly dim: "\u001B[2m";
+        readonly italic: "\u001B[3m";
+        readonly underline: "\u001B[4m";
+        readonly black: "\u001B[30m";
+        readonly red: "\u001B[31m";
+        readonly green: "\u001B[32m";
+        readonly yellow: "\u001B[33m";
+        readonly blue: "\u001B[34m";
+        readonly magenta: "\u001B[35m";
+        readonly cyan: "\u001B[36m";
+        readonly white: "\u001B[37m";
+        readonly brightBlack: "\u001B[90m";
+        readonly brightRed: "\u001B[91m";
+        readonly brightGreen: "\u001B[92m";
+        readonly brightYellow: "\u001B[93m";
+        readonly brightBlue: "\u001B[94m";
+        readonly brightMagenta: "\u001B[95m";
+        readonly brightCyan: "\u001B[96m";
+        readonly brightWhite: "\u001B[97m";
+    };
+    static cursorUp(n?: number): string;
+    static cursorDown(n?: number): string;
+    static cursorForward(n?: number): string;
+    static cursorBack(n?: number): string;
+    static cursorPosition(row: number, col: number): string;
+    static clearLine(): string;
+    static clearToEndOfLine(): string;
+    static clearScreen(): string;
+    static saveCursor(): string;
+    static restoreCursor(): string;
+}
+
+/**
+ * Result from executing a statement
+ */
+interface ExecutionResult {
+    success: boolean;
+    data?: Record<string, unknown>[];
+    error?: string;
+    executionTime: number;
+}
+/**
+ * Interface for executing database statements.
+ * Implement this interface to connect the shell to any database backend.
+ */
+interface Executor {
+    /**
+     * Execute a statement and return the result
+     */
+    execute(statement: string): Promise<ExecutionResult>;
+    /**
+     * Get list of tables (optional, used by .tables command)
+     */
+    getTables?(): Promise<string[]>;
+    /**
+     * Get schema for a table (optional, used by .schema command)
+     */
+    getSchema?(tableName: string): Promise<string | null>;
+}
+/**
+ * Display mode for query results
+ */
+type DisplayMode = 'truncate' | 'full';
+/**
+ * Interface for history storage.
+ * Implement this to customize where history is persisted.
+ */
+interface HistoryStorage {
+    load(): string[];
+    save(entries: string[]): void;
+}
+/**
+ * Configuration options for the Shell
+ */
+interface ShellOptions {
+    /**
+     * The executor to use for running statements
+     */
+    executor: Executor;
+    /**
+     * Welcome message shown when shell starts.
+     * Can be a string, array of strings, or function returning strings.
+     * If not provided, a default welcome banner is shown.
+     */
+    welcomeMessage?: string | string[] | (() => string[]);
+    /**
+     * Primary prompt string (default: "reifydb> ")
+     * Can include ANSI color codes.
+     */
+    prompt?: string;
+    /**
+     * Prompt length without ANSI codes (for cursor positioning)
+     * Required if prompt contains ANSI codes.
+     */
+    promptLength?: number;
+    /**
+     * Continuation prompt for multi-line input (default: "     ... ")
+     * Can include ANSI color codes.
+     */
+    continuationPrompt?: string;
+    /**
+     * Continuation prompt length without ANSI codes
+     * Required if continuationPrompt contains ANSI codes.
+     */
+    continuationPromptLength?: number;
+    /**
+     * Terminal theme colors
+     */
+    theme?: TerminalTheme;
+    /**
+     * Key for localStorage history (default: "reifydb-shell-history")
+     */
+    historyKey?: string;
+    /**
+     * Custom history storage implementation.
+     * If provided, historyKey is ignored.
+     */
+    historyStorage?: HistoryStorage;
+    /**
+     * Initial display mode (default: "truncate")
+     */
+    displayMode?: DisplayMode;
+    /**
+     * Callback when user exits the shell
+     */
+    onExit?: () => void;
+}
+/**
+ * Internal context passed to dot command handlers
+ */
+interface DotCommandContext {
+    terminal: TerminalAdapter;
+    executor: Executor;
+    history: {
+        getAll(): string[];
+        clear(): void;
+    };
+    displayMode: DisplayMode;
+    setDisplayMode: (mode: DisplayMode) => void;
+    clearScreen: () => void;
+}
+/**
+ * Result from handling a dot command
+ */
+interface DotCommandResult {
+    handled: boolean;
+    exit?: boolean;
+}
+
+declare class Shell {
+    private terminal;
+    private lineEditor;
+    private history;
+    private multiline;
+    private executor;
+    private formatter;
+    private displayMode;
+    private isExited;
+    private primaryPrompt;
+    private primaryPromptLen;
+    private continuationPrompt;
+    private continuationPromptLen;
+    private welcomeMessage;
+    private onExit;
+    constructor(container: HTMLElement, options: ShellOptions);
+    start(): void;
+    dispose(): void;
+    private showWelcomeBanner;
+    private showPrompt;
+    private getCurrentPromptLen;
+    private setupKeyHandler;
+    private handleKey;
+    private redrawLine;
+    private navigateHistory;
+    private handleEnter;
+    private clearScreen;
+}
+
+declare class LineEditor {
+    private buffer;
+    private cursorPos;
+    private terminal;
+    constructor(terminal: TerminalAdapter);
+    get value(): string;
+    get cursor(): number;
+    clear(): void;
+    setValue(value: string): void;
+    insert(char: string): void;
+    backspace(): boolean;
+    delete(): boolean;
+    moveLeft(): boolean;
+    moveRight(): boolean;
+    moveToStart(): void;
+    moveToEnd(): void;
+    moveWordLeft(): void;
+    moveWordRight(): void;
+    clearLine(): void;
+    deleteToEnd(): void;
+    deleteToStart(): void;
+    deleteWord(): void;
+    render(prompt: string): void;
+}
+
+/**
+ * Default localStorage-based history storage
+ */
+declare class LocalStorageHistoryStorage implements HistoryStorage {
+    private key;
+    constructor(key?: string);
+    load(): string[];
+    save(entries: string[]): void;
+}
+/**
+ * In-memory history storage (no persistence)
+ */
+declare class MemoryHistoryStorage implements HistoryStorage {
+    private entries;
+    load(): string[];
+    save(entries: string[]): void;
+}
+declare class CommandHistory {
+    private entries;
+    private position;
+    private savedInput;
+    private storage;
+    constructor(storage?: HistoryStorage, historyKey?: string);
+    add(command: string): void;
+    previous(currentInput: string): string | null;
+    next(): string | null;
+    reset(): void;
+    getAll(): string[];
+    clear(): void;
+}
+
+declare class MultilineBuffer {
+    private lines;
+    get isEmpty(): boolean;
+    get content(): string;
+    addLine(line: string): void;
+    clear(): void;
+    isComplete(): boolean;
+    static isStatementComplete(input: string): boolean;
+}
+
+declare class OutputFormatter {
+    private terminal;
+    private displayMode;
+    constructor(terminal: TerminalAdapter, displayMode?: DisplayMode);
+    setDisplayMode(mode: DisplayMode): void;
+    formatResult(result: ExecutionResult): void;
+    private formatTable;
+    private formatError;
+    private formatExecutionTime;
+}
+
+interface TableColumn {
+    name: string;
+    width: number;
+}
+interface TableOptions {
+    maxWidth?: number;
+    truncate?: boolean;
+}
+declare class TableRenderer {
+    private data;
+    private columns;
+    private maxWidth;
+    private truncate;
+    constructor(data: Record<string, unknown>[], options?: TableOptions);
+    private calculateColumns;
+    private formatValue;
+    private truncateString;
+    render(): string[];
+    private fitColumns;
+    private padCenter;
+    private padRight;
+}
+
+/**
+ * Interface for WebAssembly database instances.
+ * This matches the WasmDB interface from reifydb-wasm.
+ */
+interface WasmDB {
+    admin(rql: string): Promise<unknown> | unknown;
+}
+/**
+ * Executor adapter for WebAssembly-based ReifyDB instances.
+ */
+declare class WasmExecutor implements Executor {
+    private db;
+    constructor(db: WasmDB);
+    execute(statement: string): Promise<ExecutionResult>;
+    getTables(): Promise<string[]>;
+    getSchema(tableName: string): Promise<string | null>;
+}
+
+/**
+ * Interface for WebSocket client.
+ * This matches the WsClient interface from @reifydb/client.
+ */
+interface WsClient {
+    admin<const S extends readonly unknown[]>(statements: string | string[], params: unknown, schemas: S): Promise<unknown[][]>;
+}
+/**
+ * Executor adapter for WebSocket-based ReifyDB connections.
+ */
+declare class WsExecutor implements Executor {
+    private client;
+    constructor(client: WsClient);
+    execute(statement: string): Promise<ExecutionResult>;
+    getTables(): Promise<string[]>;
+    getSchema(tableName: string): Promise<string | null>;
+    private extractValue;
+}
+
+declare function handleDotCommand(input: string, context: DotCommandContext): Promise<DotCommandResult>;
+
+export { COLORS, CommandHistory, type DisplayMode, type DotCommandContext, type DotCommandResult, type ExecutionResult, type Executor, type HistoryStorage, type KeyHandler, LineEditor, LocalStorageHistoryStorage, MemoryHistoryStorage, MultilineBuffer, OutputFormatter, Shell, type ShellOptions, type TableColumn, type TableOptions, TableRenderer, TerminalAdapter, type TerminalTheme, type WasmDB, WasmExecutor, type WsClient, WsExecutor, defaultTheme, handleDotCommand };