@ketd/gemini-cli-sdk 0.3.7 → 0.3.8

package/dist/index.d.cts

@@ -268,7 +268,9 @@ declare enum JsonStreamEventType {
     /** Message completion with metadata */
     FINISHED = "finished",
     /** Model information */
-    MODEL_INFO = "model_info"
+    MODEL_INFO = "model_info",
+    /** Ask user questions (CLI → Host) */
+    ASK_USER = "ask_user"
 }
 /**
  * Base event interface
@@ -410,10 +412,45 @@ interface ModelInfoEvent extends BaseJsonStreamEvent {
     type: JsonStreamEventType.MODEL_INFO;
     value: string;
 }
+/**
+ * Question option for AskUserEvent
+ */
+interface QuestionOption {
+    label: string;
+    description: string;
+}
+/**
+ * Question type for AskUserEvent
+ */
+declare enum QuestionType {
+    CHOICE = "choice",
+    TEXT = "text",
+    YESNO = "yesno"
+}
+/**
+ * Question in AskUserEvent
+ */
+interface Question {
+    question: string;
+    header: string;
+    type?: QuestionType;
+    options?: QuestionOption[];
+    multiSelect?: boolean;
+    placeholder?: string;
+}
+/**
+ * Ask user event (CLI → Host)
+ * Emitted when the ask_user tool needs structured user input
+ */
+interface AskUserEvent extends BaseJsonStreamEvent {
+    type: JsonStreamEventType.ASK_USER;
+    questions: Question[];
+    correlation_id: string;
+}
 /**
  * Union type of all JSON stream events
  */
-type JsonStreamEvent = InitEvent | MessageEvent | ToolUseEvent | ToolCallRequestEvent | ToolResultEvent | ThoughtEvent | ErrorEvent | ResultEvent | ContentEvent | FinishedEvent | ModelInfoEvent;
+type JsonStreamEvent = InitEvent | MessageEvent | ToolUseEvent | ToolCallRequestEvent | ToolResultEvent | ThoughtEvent | ErrorEvent | ResultEvent | ContentEvent | FinishedEvent | ModelInfoEvent | AskUserEvent;
 /**
  * Gemini CLI exit codes
  */
@@ -491,7 +528,9 @@ declare enum JsonInputMessageType {
     /** User message */
     USER = "user",
     /** Control command */
-    CONTROL = "control"
+    CONTROL = "control",
+    /** Response to ask_user event (Host → CLI) */
+    ASK_USER_RESPONSE = "ask_user_response"
 }
 /**
  * User message sent to CLI
@@ -559,10 +598,21 @@ interface ControlInputMessage {
     control: InterruptControl | TruncateHistoryControl | ResumeSessionControl | ReplaceHistoryControl;
     session_id?: string;
 }
+/**
+ * Response to ask_user event (Host → CLI)
+ * Sent when the host has collected user answers for an ask_user request
+ */
+interface AskUserResponseInputMessage {
+    type: JsonInputMessageType.ASK_USER_RESPONSE;
+    correlation_id: string;
+    answers: {
+        [questionIndex: string]: string;
+    };
+}
 /**
  * Union type for input messages
  */
-type JsonInputMessage = UserInputMessage | ControlInputMessage;
+type JsonInputMessage = UserInputMessage | ControlInputMessage | AskUserResponseInputMessage;
 /**
  * Hook configuration types (from Gemini CLI)
  */
@@ -1019,6 +1069,18 @@ declare class GeminiStreamClient extends EventEmitter$1 {
         role: string;
         parts: unknown[];
     }>): Promise<void>;
+    /**
+     * Send a response to an ask_user request from the CLI
+     *
+     * When the CLI emits an 'ask_user' event (from the ask_user tool),
+     * the host collects user answers and sends them back via this method.
+     *
+     * @param correlationId - The correlation_id from the AskUserEvent
+     * @param answers - Map of question index to user's answer string
+     */
+    sendAskUserResponse(correlationId: string, answers: {
+        [questionIndex: string]: string;
+    }): void;
     /**
      * Stop the CLI process
      */
@@ -1137,4 +1199,4 @@ declare function formatDuration(ms: number): string;
  */
 declare function formatTokens(tokens: number): string;
 
-export { type ContextConfig, type ControlInputMessage, type ControlSubtype, type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, GeminiStreamClient, type GeminiStreamOptions, type HooksConfiguration, type InitEvent, type InterruptControl, type JsonInputMessage, JsonInputMessageType, type JsonStreamEvent, JsonStreamEventType, LogLevel, type Logger, type LoggerOptions, type MCPServerConfig, type MCPServersConfig, type MessageEvent, ProcessStatus, type QueryResult, type ResultEvent, type ResumeSessionControl, SDKLogger, type StreamStats, type ThoughtEvent, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, type ToolsConfig, type TruncateHistoryControl, type UserInputMessage, createLogger, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, sdkLogger, silentLogger, validateApiKey, validateModel };
+export { type AskUserEvent, type AskUserResponseInputMessage, type ContextConfig, type ControlInputMessage, type ControlSubtype, type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, GeminiStreamClient, type GeminiStreamOptions, type HooksConfiguration, type InitEvent, type InterruptControl, type JsonInputMessage, JsonInputMessageType, type JsonStreamEvent, JsonStreamEventType, LogLevel, type Logger, type LoggerOptions, type MCPServerConfig, type MCPServersConfig, type MessageEvent, ProcessStatus, type QueryResult, type Question, type QuestionOption, QuestionType, type ResultEvent, type ResumeSessionControl, SDKLogger, type StreamStats, type ThoughtEvent, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, type ToolsConfig, type TruncateHistoryControl, type UserInputMessage, createLogger, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, sdkLogger, silentLogger, validateApiKey, validateModel };

package/dist/index.d.ts

@@ -268,7 +268,9 @@ declare enum JsonStreamEventType {
     /** Message completion with metadata */
     FINISHED = "finished",
     /** Model information */
-    MODEL_INFO = "model_info"
+    MODEL_INFO = "model_info",
+    /** Ask user questions (CLI → Host) */
+    ASK_USER = "ask_user"
 }
 /**
  * Base event interface
@@ -410,10 +412,45 @@ interface ModelInfoEvent extends BaseJsonStreamEvent {
     type: JsonStreamEventType.MODEL_INFO;
     value: string;
 }
+/**
+ * Question option for AskUserEvent
+ */
+interface QuestionOption {
+    label: string;
+    description: string;
+}
+/**
+ * Question type for AskUserEvent
+ */
+declare enum QuestionType {
+    CHOICE = "choice",
+    TEXT = "text",
+    YESNO = "yesno"
+}
+/**
+ * Question in AskUserEvent
+ */
+interface Question {
+    question: string;
+    header: string;
+    type?: QuestionType;
+    options?: QuestionOption[];
+    multiSelect?: boolean;
+    placeholder?: string;
+}
+/**
+ * Ask user event (CLI → Host)
+ * Emitted when the ask_user tool needs structured user input
+ */
+interface AskUserEvent extends BaseJsonStreamEvent {
+    type: JsonStreamEventType.ASK_USER;
+    questions: Question[];
+    correlation_id: string;
+}
 /**
  * Union type of all JSON stream events
  */
-type JsonStreamEvent = InitEvent | MessageEvent | ToolUseEvent | ToolCallRequestEvent | ToolResultEvent | ThoughtEvent | ErrorEvent | ResultEvent | ContentEvent | FinishedEvent | ModelInfoEvent;
+type JsonStreamEvent = InitEvent | MessageEvent | ToolUseEvent | ToolCallRequestEvent | ToolResultEvent | ThoughtEvent | ErrorEvent | ResultEvent | ContentEvent | FinishedEvent | ModelInfoEvent | AskUserEvent;
 /**
  * Gemini CLI exit codes
  */
@@ -491,7 +528,9 @@ declare enum JsonInputMessageType {
     /** User message */
     USER = "user",
     /** Control command */
-    CONTROL = "control"
+    CONTROL = "control",
+    /** Response to ask_user event (Host → CLI) */
+    ASK_USER_RESPONSE = "ask_user_response"
 }
 /**
  * User message sent to CLI
@@ -559,10 +598,21 @@ interface ControlInputMessage {
     control: InterruptControl | TruncateHistoryControl | ResumeSessionControl | ReplaceHistoryControl;
     session_id?: string;
 }
+/**
+ * Response to ask_user event (Host → CLI)
+ * Sent when the host has collected user answers for an ask_user request
+ */
+interface AskUserResponseInputMessage {
+    type: JsonInputMessageType.ASK_USER_RESPONSE;
+    correlation_id: string;
+    answers: {
+        [questionIndex: string]: string;
+    };
+}
 /**
  * Union type for input messages
  */
-type JsonInputMessage = UserInputMessage | ControlInputMessage;
+type JsonInputMessage = UserInputMessage | ControlInputMessage | AskUserResponseInputMessage;
 /**
  * Hook configuration types (from Gemini CLI)
  */
@@ -1019,6 +1069,18 @@ declare class GeminiStreamClient extends EventEmitter$1 {
         role: string;
         parts: unknown[];
     }>): Promise<void>;
+    /**
+     * Send a response to an ask_user request from the CLI
+     *
+     * When the CLI emits an 'ask_user' event (from the ask_user tool),
+     * the host collects user answers and sends them back via this method.
+     *
+     * @param correlationId - The correlation_id from the AskUserEvent
+     * @param answers - Map of question index to user's answer string
+     */
+    sendAskUserResponse(correlationId: string, answers: {
+        [questionIndex: string]: string;
+    }): void;
     /**
      * Stop the CLI process
      */
@@ -1137,4 +1199,4 @@ declare function formatDuration(ms: number): string;
  */
 declare function formatTokens(tokens: number): string;
 
-export { type ContextConfig, type ControlInputMessage, type ControlSubtype, type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, GeminiStreamClient, type GeminiStreamOptions, type HooksConfiguration, type InitEvent, type InterruptControl, type JsonInputMessage, JsonInputMessageType, type JsonStreamEvent, JsonStreamEventType, LogLevel, type Logger, type LoggerOptions, type MCPServerConfig, type MCPServersConfig, type MessageEvent, ProcessStatus, type QueryResult, type ResultEvent, type ResumeSessionControl, SDKLogger, type StreamStats, type ThoughtEvent, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, type ToolsConfig, type TruncateHistoryControl, type UserInputMessage, createLogger, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, sdkLogger, silentLogger, validateApiKey, validateModel };
+export { type AskUserEvent, type AskUserResponseInputMessage, type ContextConfig, type ControlInputMessage, type ControlSubtype, type ErrorEvent, ExitCode, GeminiClient, type GeminiOptions, GeminiSDKError, GeminiStreamClient, type GeminiStreamOptions, type HooksConfiguration, type InitEvent, type InterruptControl, type JsonInputMessage, JsonInputMessageType, type JsonStreamEvent, JsonStreamEventType, LogLevel, type Logger, type LoggerOptions, type MCPServerConfig, type MCPServersConfig, type MessageEvent, ProcessStatus, type QueryResult, type Question, type QuestionOption, QuestionType, type ResultEvent, type ResumeSessionControl, SDKLogger, type StreamStats, type ThoughtEvent, type ToolPermissionDecision, type ToolPermissionRequest, type ToolResultEvent, type ToolUseEvent, type ToolsConfig, type TruncateHistoryControl, type UserInputMessage, createLogger, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, sdkLogger, silentLogger, validateApiKey, validateModel };

package/dist/index.js

@@ -19,8 +19,15 @@ var JsonStreamEventType = /* @__PURE__ */ ((JsonStreamEventType2) => {
   JsonStreamEventType2["CONTENT"] = "content";
   JsonStreamEventType2["FINISHED"] = "finished";
   JsonStreamEventType2["MODEL_INFO"] = "model_info";
+  JsonStreamEventType2["ASK_USER"] = "ask_user";
   return JsonStreamEventType2;
 })(JsonStreamEventType || {});
+var QuestionType = /* @__PURE__ */ ((QuestionType2) => {
+  QuestionType2["CHOICE"] = "choice";
+  QuestionType2["TEXT"] = "text";
+  QuestionType2["YESNO"] = "yesno";
+  return QuestionType2;
+})(QuestionType || {});
 var ExitCode = /* @__PURE__ */ ((ExitCode2) => {
   ExitCode2[ExitCode2["SUCCESS"] = 0] = "SUCCESS";
   ExitCode2[ExitCode2["GENERAL_ERROR"] = 1] = "GENERAL_ERROR";
@@ -50,6 +57,7 @@ var GeminiSDKError = class _GeminiSDKError extends Error {
 var JsonInputMessageType = /* @__PURE__ */ ((JsonInputMessageType2) => {
   JsonInputMessageType2["USER"] = "user";
   JsonInputMessageType2["CONTROL"] = "control";
+  JsonInputMessageType2["ASK_USER_RESPONSE"] = "ask_user_response";
   return JsonInputMessageType2;
 })(JsonInputMessageType || {});
 
@@ -662,6 +670,26 @@ var GeminiStreamClient = class extends EventEmitter {
     };
     this.writeMessage(message);
   }
+  /**
+   * Send a response to an ask_user request from the CLI
+   *
+   * When the CLI emits an 'ask_user' event (from the ask_user tool),
+   * the host collects user answers and sends them back via this method.
+   *
+   * @param correlationId - The correlation_id from the AskUserEvent
+   * @param answers - Map of question index to user's answer string
+   */
+  sendAskUserResponse(correlationId, answers) {
+    if (!this.isReady()) {
+      throw new GeminiSDKError("Client not ready. Call start() first.");
+    }
+    const message = {
+      type: "ask_user_response" /* ASK_USER_RESPONSE */,
+      correlation_id: correlationId,
+      answers
+    };
+    this.writeMessage(message);
+  }
   /**
    * Stop the CLI process
    */
@@ -1021,6 +1049,6 @@ function formatTokens(tokens) {
   return tokens.toLocaleString();
 }
 
-export { ExitCode, GeminiClient, GeminiSDKError, GeminiStreamClient, JsonInputMessageType, JsonStreamEventType, LogLevel, ProcessStatus, SDKLogger, createLogger, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, sdkLogger, silentLogger, validateApiKey, validateModel };
+export { ExitCode, GeminiClient, GeminiSDKError, GeminiStreamClient, JsonInputMessageType, JsonStreamEventType, LogLevel, ProcessStatus, QuestionType, SDKLogger, createLogger, findGeminiCLI, formatDuration, formatTokens, getApiKey, query, sdkLogger, silentLogger, validateApiKey, validateModel };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map