@ebowwa/terminal 0.3.3 → 0.3.5

package/dist/tmux.d.ts

@@ -0,0 +1,212 @@
+/**
+ * tmux-based Terminal Sessions
+ * Provides persistent terminal sessions using tmux on remote servers
+ * Includes automatic tmux installation and session management
+ */
+import type { SSHOptions } from "./types.js";
+/**
+ * tmux session configuration
+ */
+interface TmuxConfig {
+    /** Session name prefix for codespaces sessions */
+    sessionPrefix: string;
+    /** Default shell to use in tmux */
+    defaultShell: string;
+    /** Terminal type */
+    term: string;
+    /** Timeout for SSH commands (seconds) */
+    timeout: number;
+    /** Scrollback limit (lines) */
+    historyLimit: number;
+    /** Session age limit for cleanup (milliseconds) */
+    sessionAgeLimit: number;
+}
+/**
+ * Generate a tmux session name for a host
+ */
+export declare function generateSessionName(host: string, user?: string): string;
+/**
+ * Check if tmux is installed on the remote server
+ */
+export declare function isTmuxInstalled(options: SSHOptions): Promise<boolean>;
+/**
+ * Install tmux on the remote server
+ *
+ * FALLBACK MECHANISM: This should NOT be the primary installation method.
+ * tmux should be installed via cloud-init during initial node provisioning.
+ *
+ * This function exists for:
+ * - Legacy nodes provisioned before cloud-init included tmux
+ * - Manual node provisioning outside cheapspaces
+ * - Recovery scenarios where cloud-init failed
+ *
+ * @see workspace/docs/design/node-agent/TMUX-INSTALLATION.md
+ * @see workspace/src/lib/bootstrap/cloud-init.ts - where tmux should be added to packages
+ *
+ * Supports Debian/Ubuntu (apt) and CentOS/RHEL (yum/dnf)
+ */
+export declare function installTmux(options: SSHOptions): Promise<{
+    success: boolean;
+    message: string;
+}>;
+/**
+ * Ensure tmux is available, installing if necessary
+ */
+export declare function ensureTmux(options: SSHOptions): Promise<{
+    success: boolean;
+    message: string;
+}>;
+/**
+ * List existing tmux sessions on the remote server
+ */
+export declare function listTmuxSessions(options: SSHOptions): Promise<string[]>;
+/**
+ * Check if a specific tmux session exists
+ */
+export declare function hasTmuxSession(sessionName: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Create or attach to a tmux session
+ * Returns the SSH command arguments to connect to the tmux session
+ */
+export declare function createOrAttachTmuxSession(host: string, user?: string, keyPath?: string, config?: Partial<TmuxConfig>): Promise<{
+    sshArgs: string[];
+    sessionName: string;
+    newlyCreated: boolean;
+}>;
+/**
+ * Kill a tmux session on the remote server
+ */
+export declare function killTmuxSession(sessionName: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Get tmux session information
+ */
+export declare function getTmuxSessionInfo(sessionName: string, options: SSHOptions): Promise<{
+    exists: boolean;
+    windows?: number;
+    panes?: number;
+} | null>;
+/**
+ * Cleanup old tmux sessions on a remote server
+ * Kills sessions with matching prefix that are older than specified age limit
+ * @param options SSH connection options
+ * @param config Optional configuration (uses default age limit if not provided)
+ * @returns Object with cleaned count and errors
+ */
+export declare function cleanupOldTmuxSessions(options: SSHOptions, config?: Partial<TmuxConfig>): Promise<{
+    cleaned: number;
+    errors: string[];
+}>;
+/**
+ * Get resource usage information for tmux sessions on a remote server
+ * @param options SSH connection options
+ * @returns Resource usage summary
+ */
+export declare function getTmuxResourceUsage(options: SSHOptions): Promise<{
+    totalSessions: number;
+    codespacesSessions: number;
+    estimatedMemoryMB: number;
+} | null>;
+/**
+ * Send a command to a specific pane in a tmux session
+ * @param sessionName Target tmux session name
+ * @param paneIndex Pane index (default: 0 for first pane)
+ * @param command Command to execute (sent as keystrokes)
+ * @param options SSH connection options
+ */
+export declare function sendCommandToPane(sessionName: string, command: string, paneIndex: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Split a pane horizontally or vertically in a tmux session
+ * @param sessionName Target tmux session name
+ * @param windowIndex Window index (default: 0)
+ * @param direction Split direction: "h" (horizontal) or "v" (vertical)
+ * @param command Optional command to run in the new pane
+ * @param options SSH connection options
+ * @returns The new pane index
+ */
+export declare function splitPane(sessionName: string, direction: "h" | "v", command: string | null, options: SSHOptions): Promise<string | null>;
+/**
+ * List all windows in a tmux session
+ * @param sessionName Target tmux session name
+ * @param options SSH connection options
+ */
+export declare function listSessionWindows(sessionName: string, options: SSHOptions): Promise<Array<{
+    index: string;
+    name: string;
+    active: boolean;
+}>>;
+/**
+ * List all panes in a tmux session window
+ * @param sessionName Target tmux session name
+ * @param windowIndex Window index (default: 0)
+ * @param options SSH connection options
+ */
+export declare function listWindowPanes(sessionName: string, windowIndex: string, options: SSHOptions): Promise<Array<{
+    index: string;
+    currentPath: string;
+    pid: string;
+    active: boolean;
+}>>;
+/**
+ * Capture the current output of a pane
+ * @param sessionName Target tmux session name
+ * @param paneIndex Pane index (default: 0)
+ * @param options SSH connection options
+ */
+export declare function capturePane(sessionName: string, paneIndex: string, options: SSHOptions): Promise<string | null>;
+/**
+ * Get scrollback/history from a pane
+ * @param sessionName Target tmux session name
+ * @param paneIndex Pane index (default: 0)
+ * @param lines Number of lines to retrieve (default: all)
+ * @param options SSH connection options
+ */
+export declare function getPaneHistory(sessionName: string, paneIndex: string, lines: number, options: SSHOptions): Promise<string | null>;
+/**
+ * Switch to a specific window in a tmux session
+ * @param sessionName Target tmux session name
+ * @param windowIndex Target window index
+ * @param options SSH connection options
+ */
+export declare function switchWindow(sessionName: string, windowIndex: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Switch to a specific pane in a tmux session window
+ * @param sessionName Target tmux session name
+ * @param paneIndex Target pane index (e.g., "0", "1", "0.1" for window.pane)
+ * @param options SSH connection options
+ */
+export declare function switchPane(sessionName: string, paneIndex: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Rename a window in a tmux session
+ * @param sessionName Target tmux session name
+ * @param windowIndex Window index (default: 0)
+ * @param newName New window name
+ * @param options SSH connection options
+ */
+export declare function renameWindow(sessionName: string, windowIndex: string, newName: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Kill a specific pane in a tmux session
+ * @param sessionName Target tmux session name
+ * @param paneIndex Pane index to kill
+ * @param options SSH connection options
+ */
+export declare function killPane(sessionName: string, paneIndex: string, options: SSHOptions): Promise<boolean>;
+/**
+ * Get detailed information about all panes in a session
+ * @param sessionName Target tmux session name
+ * @param options SSH connection options
+ */
+export declare function getDetailedSessionInfo(sessionName: string, options: SSHOptions): Promise<{
+    exists: boolean;
+    windows: Array<{
+        index: string;
+        name: string;
+        active: boolean;
+        panes: Array<{
+            index: string;
+            currentPath: string;
+            pid: string;
+            active: boolean;
+        }>;
+    }>;
+} | null>;
+export {};

package/dist/types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * SSH type definitions
+ */
+export interface SSHOptions {
+    host: string;
+    user?: string;
+    timeout?: number;
+    port?: number;
+    keyPath?: string;
+    password?: string;
+}
+export interface SCPOptions extends SSHOptions {
+    source: string;
+    destination: string;
+    recursive?: boolean;
+    preserve?: boolean;
+}

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "@ebowwa/terminal",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Terminal session management with tmux integration, SSH client, WebSocket support, and MCP interface",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.js",
-    "./mcp": "./dist/mcp/index.js",
-    "./client": "./dist/index.js"
-  },
-  "scripts": {
-    "build": "bun build src/index.ts --outdir dist --target bun --external '@ebowwa/*' --external 'node-ssh' --external 'hono' --external 'zod' && bun build src/mcp/index.ts --outdir dist/mcp --target bun --external '@ebowwa/*' --external 'node-ssh' --external 'hono' --external 'zod' --external '@modelcontextprotocol/*'",
-    "prepublishOnly": "bun run build"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./mcp": {
+      "types": "./dist/mcp/index.d.ts",
+      "default": "./dist/mcp/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "default": "./dist/types.d.ts"
+    }
   },
+  "scripts": {},
   "files": [
     "dist"
   ],
@@ -44,6 +50,7 @@
   },
   "dependencies": {
     "@ebowwa/codespaces-types": "^1.4.0",
+    "@ebowwa/ssh": "^0.2.1",
     "node-ssh": "^13.2.1",
     "hono": "^4.11.3",
     "zod": "^3.24.1"