@ketd/gemini-cli-sdk 0.1.8 → 0.2.0

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+import { EventEmitter as EventEmitter$1 } from 'node:events';
 
 /**
  * Type definitions for Gemini CLI SDK
@@ -289,6 +290,90 @@ interface QueryResult {
         message: string;
     };
 }
+/**
+ * Input message types for Stream Client (SDK → CLI via stdin)
+ */
+declare enum JsonInputMessageType {
+    /** User message */
+    USER = "user",
+    /** Control command */
+    CONTROL = "control"
+}
+/**
+ * User message sent to CLI
+ */
+interface UserInputMessage {
+    type: JsonInputMessageType.USER;
+    content: string;
+    session_id?: string;
+}
+/**
+ * Control message sent to CLI
+ */
+interface ControlInputMessage {
+    type: JsonInputMessageType.CONTROL;
+    control: {
+        subtype: 'interrupt' | 'cancel' | 'shutdown';
+    };
+    session_id?: string;
+}
+/**
+ * Union type for input messages
+ */
+type JsonInputMessage = UserInputMessage | ControlInputMessage;
+/**
+ * Options for GeminiStreamClient
+ */
+interface GeminiStreamOptions {
+    /**
+     * Path to Gemini CLI executable
+     * @example 'node_modules/@google/gemini-cli/bundle/gemini.js'
+     */
+    pathToGeminiCLI: string;
+    /**
+     * Session ID for this client instance
+     * Each client manages one session
+     */
+    sessionId: string;
+    /**
+     * Workspace ID (optional, for tracking)
+     */
+    workspaceId?: string;
+    /**
+     * Google AI API Key
+     * Can also be set via GEMINI_API_KEY environment variable
+     */
+    apiKey?: string;
+    /**
+     * Model name
+     * @default 'gemini-2.0-flash-exp'
+     */
+    model?: string;
+    /**
+     * Working directory for CLI execution
+     * @default process.cwd()
+     */
+    cwd?: string;
+    /**
+     * Approval mode for tool execution
+     * @default 'default'
+     */
+    approvalMode?: 'default' | 'auto_edit' | 'yolo';
+    /**
+     * Custom environment variables
+     */
+    env?: Record<string, string>;
+    /**
+     * Enable debug mode
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Timeout for process initialization (ms)
+     * @default 30000
+     */
+    initTimeout?: number;
+}
 
 /**
  * Core query function for Gemini CLI SDK
@@ -392,6 +477,132 @@ declare class GeminiClient extends EventEmitter {
     getOptions(): Readonly<GeminiOptions>;
 }
 
+/**
+ * GeminiStreamClient - Persistent stream-based client for Gemini CLI
+ *
+ * Architecture:
+ * - 1 Client = 1 Node.js Process = 1 Session
+ * - Communication via stdin/stdout JSONL
+ * - Process stays alive for multiple message exchanges
+ * - Similar to Claude Agent SDK's SubprocessCLITransport
+ */
+
+/**
+ * Events emitted by GeminiStreamClient
+ */
+interface StreamClientEvents {
+    /** JSON stream event from CLI */
+    event: (event: JsonStreamEvent) => void;
+    /** Process started */
+    started: () => void;
+    /** Process ready (INIT event received) */
+    ready: (initEvent: InitEvent) => void;
+    /** Process stopped */
+    stopped: (code: number | null) => void;
+    /** Error occurred */
+    error: (error: Error) => void;
+}
+declare interface GeminiStreamClient {
+    on<K extends keyof StreamClientEvents>(event: K, listener: StreamClientEvents[K]): this;
+    emit<K extends keyof StreamClientEvents>(event: K, ...args: Parameters<StreamClientEvents[K]>): boolean;
+}
+/**
+ * GeminiStreamClient
+ *
+ * Manages a persistent Gemini CLI process for stream-based communication.
+ *
+ * @example
+ * ```typescript
+ * const client = new GeminiStreamClient({
+ *   pathToGeminiCLI: './gemini.js',
+ *   sessionId: 'session-123',
+ *   apiKey: process.env.GEMINI_API_KEY,
+ * });
+ *
+ * client.on('event', (event) => {
+ *   console.log('Event:', event);
+ * });
+ *
+ * await client.start();
+ * await client.sendMessage('Hello, Gemini!');
+ * await client.stop();
+ * ```
+ */
+declare class GeminiStreamClient extends EventEmitter$1 {
+    private options;
+    private process;
+    private stdinStream;
+    private readlineInterface;
+    private status;
+    private initEvent;
+    private initTimeout;
+    constructor(options: GeminiStreamOptions);
+    /**
+     * Start the Gemini CLI process
+     */
+    start(): Promise<void>;
+    /**
+     * Send a user message to the CLI
+     */
+    sendMessage(content: string): Promise<void>;
+    /**
+     * Send an interrupt control command
+     */
+    interrupt(): Promise<void>;
+    /**
+     * Stop the CLI process
+     */
+    stop(timeout?: number): Promise<void>;
+    /**
+     * Check if client is ready to send messages
+     */
+    isReady(): boolean;
+    /**
+     * Get current status
+     */
+    getStatus(): ProcessStatus;
+    /**
+     * Get init event (contains session_id, model, etc.)
+     */
+    getInitEvent(): InitEvent | null;
+    /**
+     * Get process PID
+     */
+    getPid(): number | undefined;
+    /**
+     * Build CLI command arguments
+     */
+    private buildCommand;
+    /**
+     * Build environment variables
+     */
+    private buildEnv;
+    /**
+     * Write a JSON message to stdin
+     */
+    private writeMessage;
+    /**
+     * Start reading JSONL events from stdout
+     */
+    private startReadLoop;
+    /**
+     * Handle a JSON stream event
+     */
+    private handleEvent;
+    /**
+     * Wait for INIT event
+     */
+    private waitForInit;
+    /**
+     * Handle process exit
+     */
+    private handleProcessExit;
+    /**
+     * Handle process error
+     */
+    private handleProcessError;
+}
+
 /**
  * Utility functions for Gemini CLI SDK
  */
@@ -445,4 +656,4 @@ declare function formatDuration(ms: number): string;
  */
 declare function formatTokens(tokens: number): string;
 
-export { type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, type InitEvent, type JsonStreamEvent, JsonStreamEventType, type MessageEvent, ProcessStatus, type QueryResult, type ResultEvent, type StreamStats, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, validateApiKey, validateModel };
+export { type ControlInputMessage, type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, GeminiStreamClient, type GeminiStreamOptions, type InitEvent, type JsonInputMessage, JsonInputMessageType, type JsonStreamEvent, JsonStreamEventType, type MessageEvent, ProcessStatus, type QueryResult, type ResultEvent, type StreamStats, type ThoughtEvent, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, type UserInputMessage, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, validateApiKey, validateModel };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+import { EventEmitter as EventEmitter$1 } from 'node:events';
 
 /**
  * Type definitions for Gemini CLI SDK
@@ -289,6 +290,90 @@ interface QueryResult {
         message: string;
     };
 }
+/**
+ * Input message types for Stream Client (SDK → CLI via stdin)
+ */
+declare enum JsonInputMessageType {
+    /** User message */
+    USER = "user",
+    /** Control command */
+    CONTROL = "control"
+}
+/**
+ * User message sent to CLI
+ */
+interface UserInputMessage {
+    type: JsonInputMessageType.USER;
+    content: string;
+    session_id?: string;
+}
+/**
+ * Control message sent to CLI
+ */
+interface ControlInputMessage {
+    type: JsonInputMessageType.CONTROL;
+    control: {
+        subtype: 'interrupt' | 'cancel' | 'shutdown';
+    };
+    session_id?: string;
+}
+/**
+ * Union type for input messages
+ */
+type JsonInputMessage = UserInputMessage | ControlInputMessage;
+/**
+ * Options for GeminiStreamClient
+ */
+interface GeminiStreamOptions {
+    /**
+     * Path to Gemini CLI executable
+     * @example 'node_modules/@google/gemini-cli/bundle/gemini.js'
+     */
+    pathToGeminiCLI: string;
+    /**
+     * Session ID for this client instance
+     * Each client manages one session
+     */
+    sessionId: string;
+    /**
+     * Workspace ID (optional, for tracking)
+     */
+    workspaceId?: string;
+    /**
+     * Google AI API Key
+     * Can also be set via GEMINI_API_KEY environment variable
+     */
+    apiKey?: string;
+    /**
+     * Model name
+     * @default 'gemini-2.0-flash-exp'
+     */
+    model?: string;
+    /**
+     * Working directory for CLI execution
+     * @default process.cwd()
+     */
+    cwd?: string;
+    /**
+     * Approval mode for tool execution
+     * @default 'default'
+     */
+    approvalMode?: 'default' | 'auto_edit' | 'yolo';
+    /**
+     * Custom environment variables
+     */
+    env?: Record<string, string>;
+    /**
+     * Enable debug mode
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Timeout for process initialization (ms)
+     * @default 30000
+     */
+    initTimeout?: number;
+}
 
 /**
  * Core query function for Gemini CLI SDK
@@ -392,6 +477,132 @@ declare class GeminiClient extends EventEmitter {
     getOptions(): Readonly<GeminiOptions>;
 }
 
+/**
+ * GeminiStreamClient - Persistent stream-based client for Gemini CLI
+ *
+ * Architecture:
+ * - 1 Client = 1 Node.js Process = 1 Session
+ * - Communication via stdin/stdout JSONL
+ * - Process stays alive for multiple message exchanges
+ * - Similar to Claude Agent SDK's SubprocessCLITransport
+ */
+
+/**
+ * Events emitted by GeminiStreamClient
+ */
+interface StreamClientEvents {
+    /** JSON stream event from CLI */
+    event: (event: JsonStreamEvent) => void;
+    /** Process started */
+    started: () => void;
+    /** Process ready (INIT event received) */
+    ready: (initEvent: InitEvent) => void;
+    /** Process stopped */
+    stopped: (code: number | null) => void;
+    /** Error occurred */
+    error: (error: Error) => void;
+}
+declare interface GeminiStreamClient {
+    on<K extends keyof StreamClientEvents>(event: K, listener: StreamClientEvents[K]): this;
+    emit<K extends keyof StreamClientEvents>(event: K, ...args: Parameters<StreamClientEvents[K]>): boolean;
+}
+/**
+ * GeminiStreamClient
+ *
+ * Manages a persistent Gemini CLI process for stream-based communication.
+ *
+ * @example
+ * ```typescript
+ * const client = new GeminiStreamClient({
+ *   pathToGeminiCLI: './gemini.js',
+ *   sessionId: 'session-123',
+ *   apiKey: process.env.GEMINI_API_KEY,
+ * });
+ *
+ * client.on('event', (event) => {
+ *   console.log('Event:', event);
+ * });
+ *
+ * await client.start();
+ * await client.sendMessage('Hello, Gemini!');
+ * await client.stop();
+ * ```
+ */
+declare class GeminiStreamClient extends EventEmitter$1 {
+    private options;
+    private process;
+    private stdinStream;
+    private readlineInterface;
+    private status;
+    private initEvent;
+    private initTimeout;
+    constructor(options: GeminiStreamOptions);
+    /**
+     * Start the Gemini CLI process
+     */
+    start(): Promise<void>;
+    /**
+     * Send a user message to the CLI
+     */
+    sendMessage(content: string): Promise<void>;
+    /**
+     * Send an interrupt control command
+     */
+    interrupt(): Promise<void>;
+    /**
+     * Stop the CLI process
+     */
+    stop(timeout?: number): Promise<void>;
+    /**
+     * Check if client is ready to send messages
+     */
+    isReady(): boolean;
+    /**
+     * Get current status
+     */
+    getStatus(): ProcessStatus;
+    /**
+     * Get init event (contains session_id, model, etc.)
+     */
+    getInitEvent(): InitEvent | null;
+    /**
+     * Get process PID
+     */
+    getPid(): number | undefined;
+    /**
+     * Build CLI command arguments
+     */
+    private buildCommand;
+    /**
+     * Build environment variables
+     */
+    private buildEnv;
+    /**
+     * Write a JSON message to stdin
+     */
+    private writeMessage;
+    /**
+     * Start reading JSONL events from stdout
+     */
+    private startReadLoop;
+    /**
+     * Handle a JSON stream event
+     */
+    private handleEvent;
+    /**
+     * Wait for INIT event
+     */
+    private waitForInit;
+    /**
+     * Handle process exit
+     */
+    private handleProcessExit;
+    /**
+     * Handle process error
+     */
+    private handleProcessError;
+}
+
 /**
  * Utility functions for Gemini CLI SDK
  */
@@ -445,4 +656,4 @@ declare function formatDuration(ms: number): string;
  */
 declare function formatTokens(tokens: number): string;
 
-export { type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, type InitEvent, type JsonStreamEvent, JsonStreamEventType, type MessageEvent, ProcessStatus, type QueryResult, type ResultEvent, type StreamStats, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, validateApiKey, validateModel };
+export { type ControlInputMessage, type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, GeminiStreamClient, type GeminiStreamOptions, type InitEvent, type JsonInputMessage, JsonInputMessageType, type JsonStreamEvent, JsonStreamEventType, type MessageEvent, ProcessStatus, type QueryResult, type ResultEvent, type StreamStats, type ThoughtEvent, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, type UserInputMessage, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, validateApiKey, validateModel };