@github/copilot-sdk 0.2.1 → 0.2.2-preview.0

package/dist/cjs/client.js

@@ -166,6 +166,9 @@ class CopilotClient {
         "githubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)"
       );
     }
+    if (options.sessionFs) {
+      this.validateSessionFsConfig(options.sessionFs);
+    }
     if (options.cliUrl) {
       const { host, port } = this.parseCliUrl(options.cliUrl);
       this.actualHost = host;
@@ -220,6 +223,17 @@ class CopilotClient {
     }
     return { host, port };
   }
+  validateSessionFsConfig(config) {
+    if (!config.initialCwd) {
+      throw new Error("sessionFs.initialCwd is required");
+    }
+    if (!config.sessionStatePath) {
+      throw new Error("sessionFs.sessionStatePath is required");
+    }
+    if (config.conventions !== "windows" && config.conventions !== "posix") {
+      throw new Error("sessionFs.conventions must be either 'windows' or 'posix'");
+    }
+  }
   /**
    * Starts the CLI server and establishes a connection.
    *
@@ -514,6 +528,7 @@ class CopilotClient {
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
         provider: config.provider,
+        modelCapabilities: config.modelCapabilities,
         requestPermission: true,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,
@@ -634,6 +649,7 @@ class CopilotClient {
           description: cmd.description
         })),
         provider: config.provider,
+        modelCapabilities: config.modelCapabilities,
         requestPermission: true,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,

package/dist/client.d.ts

@@ -89,6 +89,7 @@ export declare class CopilotClient {
      * Supports formats: "host:port", "http://host:port", "https://host:port", or just "port"
      */
     private parseCliUrl;
+    private validateSessionFsConfig;
     /**
      * Starts the CLI server and establishes a connection.
      *

package/dist/client.js

@@ -146,6 +146,9 @@ class CopilotClient {
         "githubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)"
       );
     }
+    if (options.sessionFs) {
+      this.validateSessionFsConfig(options.sessionFs);
+    }
     if (options.cliUrl) {
       const { host, port } = this.parseCliUrl(options.cliUrl);
       this.actualHost = host;
@@ -200,6 +203,17 @@ class CopilotClient {
     }
     return { host, port };
   }
+  validateSessionFsConfig(config) {
+    if (!config.initialCwd) {
+      throw new Error("sessionFs.initialCwd is required");
+    }
+    if (!config.sessionStatePath) {
+      throw new Error("sessionFs.sessionStatePath is required");
+    }
+    if (config.conventions !== "windows" && config.conventions !== "posix") {
+      throw new Error("sessionFs.conventions must be either 'windows' or 'posix'");
+    }
+  }
   /**
    * Starts the CLI server and establishes a connection.
    *
@@ -494,6 +508,7 @@ class CopilotClient {
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
         provider: config.provider,
+        modelCapabilities: config.modelCapabilities,
         requestPermission: true,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,
@@ -614,6 +629,7 @@ class CopilotClient {
           description: cmd.description
         })),
         provider: config.provider,
+        modelCapabilities: config.modelCapabilities,
         requestPermission: true,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,

package/dist/generated/rpc.d.ts

@@ -36,41 +36,7 @@ export interface ModelsListResult {
          * Display name
          */
         name: string;
-        /**
-         * Model capabilities and limits
-         */
-        capabilities: {
-            /**
-             * Feature flags indicating what the model supports
-             */
-            supports: {
-                /**
-                 * Whether this model supports vision/image input
-                 */
-                vision?: boolean;
-                /**
-                 * Whether this model supports reasoning effort configuration
-                 */
-                reasoningEffort?: boolean;
-            };
-            /**
-             * Token limits for prompts, outputs, and context window
-             */
-            limits: {
-                /**
-                 * Maximum number of prompt/input tokens
-                 */
-                max_prompt_tokens?: number;
-                /**
-                 * Maximum number of output/completion tokens
-                 */
-                max_output_tokens?: number;
-                /**
-                 * Maximum total context window size in tokens
-                 */
-                max_context_window_tokens: number;
-            };
-        };
+        capabilities: ModelCapabilities;
         /**
          * Policy state (if applicable)
          */
@@ -103,6 +69,61 @@ export interface ModelsListResult {
         defaultReasoningEffort?: string;
     }[];
 }
+/**
+ * Model capabilities and limits
+ */
+export interface ModelCapabilities {
+    supports: ModelCapabilitiesSupports;
+    limits: ModelCapabilitiesLimits;
+}
+/**
+ * Feature flags indicating what the model supports
+ */
+export interface ModelCapabilitiesSupports {
+    /**
+     * Whether this model supports vision/image input
+     */
+    vision?: boolean;
+    /**
+     * Whether this model supports reasoning effort configuration
+     */
+    reasoningEffort?: boolean;
+}
+/**
+ * Token limits for prompts, outputs, and context window
+ */
+export interface ModelCapabilitiesLimits {
+    /**
+     * Maximum number of prompt/input tokens
+     */
+    max_prompt_tokens?: number;
+    /**
+     * Maximum number of output/completion tokens
+     */
+    max_output_tokens?: number;
+    /**
+     * Maximum total context window size in tokens
+     */
+    max_context_window_tokens: number;
+    vision?: ModelCapabilitiesLimitsVision;
+}
+/**
+ * Vision-specific limits
+ */
+export interface ModelCapabilitiesLimitsVision {
+    /**
+     * MIME types the model accepts
+     */
+    supported_media_types: string[];
+    /**
+     * Maximum number of images per prompt
+     */
+    max_prompt_images: number;
+    /**
+     * Maximum image size in bytes
+     */
+    max_prompt_image_size: number;
+}
 export interface ToolsListResult {
     /**
      * List of available built-in tools with metadata
@@ -361,6 +382,47 @@ export interface SessionModelSwitchToParams {
      * Reasoning effort level to use for the model
      */
     reasoningEffort?: string;
+    modelCapabilities?: ModelCapabilitiesOverride;
+}
+/**
+ * Override individual model capabilities resolved by the runtime
+ */
+export interface ModelCapabilitiesOverride {
+    supports?: ModelCapabilitiesOverrideSupports;
+    limits?: ModelCapabilitiesOverrideLimits;
+}
+/**
+ * Feature flags indicating what the model supports
+ */
+export interface ModelCapabilitiesOverrideSupports {
+    vision?: boolean;
+    reasoningEffort?: boolean;
+}
+/**
+ * Token limits for prompts, outputs, and context window
+ */
+export interface ModelCapabilitiesOverrideLimits {
+    max_prompt_tokens?: number;
+    max_output_tokens?: number;
+    /**
+     * Maximum total context window size in tokens
+     */
+    max_context_window_tokens?: number;
+    vision?: ModelCapabilitiesOverrideLimitsVision;
+}
+export interface ModelCapabilitiesOverrideLimitsVision {
+    /**
+     * MIME types the model accepts
+     */
+    supported_media_types?: string[];
+    /**
+     * Maximum number of images per prompt
+     */
+    max_prompt_images?: number;
+    /**
+     * Maximum image size in bytes
+     */
+    max_prompt_image_size?: number;
 }
 export interface SessionModeGetResult {
     /**

package/dist/generated/session-events.d.ts

@@ -264,44 +264,9 @@ export type SessionEvent = {
     ephemeral: true;
     type: "session.idle";
     /**
-     * Payload indicating the agent is idle; includes any background tasks still in flight
+     * Payload indicating the session is fully idle with no background tasks in flight
      */
     data: {
-        /**
-         * Background tasks still running when the agent became idle
-         */
-        backgroundTasks?: {
-            /**
-             * Currently running background agents
-             */
-            agents: {
-                /**
-                 * Unique identifier of the background agent
-                 */
-                agentId: string;
-                /**
-                 * Type of the background agent
-                 */
-                agentType: string;
-                /**
-                 * Human-readable description of the agent task
-                 */
-                description?: string;
-            }[];
-            /**
-             * Currently running background shell commands
-             */
-            shells: {
-                /**
-                 * Unique identifier of the background shell
-                 */
-                shellId: string;
-                /**
-                 * Human-readable description of the shell command
-                 */
-                description?: string;
-            }[];
-        };
         /**
          * True when the preceding agentic loop was cancelled via abort signal
          */
@@ -2893,13 +2858,21 @@ export type SessionEvent = {
     ephemeral: true;
     type: "user_input.completed";
     /**
-     * User input request completion notification signaling UI dismissal
+     * User input request completion with the user's response
      */
     data: {
         /**
          * Request ID of the resolved user input request; clients should dismiss any UI for this request
          */
         requestId: string;
+        /**
+         * The user's answer to the input request
+         */
+        answer?: string;
+        /**
+         * Whether the answer was typed as free-form text rather than selected from choices
+         */
+        wasFreeform?: boolean;
     };
 } | {
     /**
@@ -2981,13 +2954,23 @@ export type SessionEvent = {
     ephemeral: true;
     type: "elicitation.completed";
     /**
-     * Elicitation request completion notification signaling UI dismissal
+     * Elicitation request completion with the user's response
      */
     data: {
         /**
          * Request ID of the resolved elicitation request; clients should dismiss any UI for this request
          */
         requestId: string;
+        /**
+         * The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed)
+         */
+        action?: "accept" | "decline" | "cancel";
+        /**
+         * The submitted form data when action is 'accept'; keys match the requested schema fields
+         */
+        content?: {
+            [k: string]: string | number | boolean | string[];
+        };
     };
 } | {
     /**
@@ -3389,13 +3372,29 @@ export type SessionEvent = {
     ephemeral: true;
     type: "exit_plan_mode.completed";
     /**
-     * Plan mode exit completion notification signaling UI dismissal
+     * Plan mode exit completion with the user's approval decision and optional feedback
      */
     data: {
         /**
          * Request ID of the resolved exit plan mode request; clients should dismiss any UI for this request
          */
         requestId: string;
+        /**
+         * Whether the plan was approved by the user
+         */
+        approved?: boolean;
+        /**
+         * Which action the user selected (e.g. 'autopilot', 'interactive', 'exit_only')
+         */
+        selectedAction?: string;
+        /**
+         * Whether edits should be auto-approved without confirmation
+         */
+        autoApproveEdits?: boolean;
+        /**
+         * Free-form feedback from the user if they requested changes to the plan
+         */
+        feedback?: string;
     };
 } | {
     /**

package/dist/index.d.ts

@@ -6,4 +6,4 @@
 export { CopilotClient } from "./client.js";
 export { CopilotSession, type AssistantMessageEvent } from "./session.js";
 export { defineTool, approveAll, SYSTEM_PROMPT_SECTIONS } from "./types.js";
-export type { CommandContext, CommandDefinition, CommandHandler, ConnectionState, CopilotClientOptions, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, InputOptions, MCPLocalServerConfig, MCPRemoteServerConfig, MCPServerConfig, MessageOptions, ModelBilling, ModelCapabilities, ModelInfo, ModelPolicy, PermissionHandler, PermissionRequest, PermissionRequestResult, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventType, SessionLifecycleHandler, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsHandler, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemPromptSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";
+export type { CommandContext, CommandDefinition, CommandHandler, ConnectionState, CopilotClientOptions, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, InputOptions, MCPLocalServerConfig, MCPRemoteServerConfig, MCPServerConfig, MessageOptions, ModelBilling, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, PermissionHandler, PermissionRequest, PermissionRequestResult, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventType, SessionLifecycleHandler, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsHandler, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemPromptSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";

package/dist/session.d.ts

@@ -5,7 +5,7 @@
 import type { MessageConnection } from "vscode-jsonrpc/node.js";
 import { createSessionRpc } from "./generated/rpc.js";
 import type { ClientSessionApiHandlers } from "./generated/rpc.js";
-import type { CommandHandler, ElicitationHandler, ElicitationContext, MessageOptions, PermissionHandler, PermissionRequestResult, ReasoningEffort, SectionTransformFn, SessionCapabilities, SessionEvent, SessionEventHandler, SessionEventType, SessionHooks, SessionUiApi, Tool, ToolHandler, TraceContextProvider, TypedSessionEventHandler, UserInputHandler, UserInputResponse } from "./types.js";
+import type { CommandHandler, ElicitationHandler, ElicitationContext, MessageOptions, PermissionHandler, PermissionRequestResult, ReasoningEffort, ModelCapabilitiesOverride, SectionTransformFn, SessionCapabilities, SessionEvent, SessionEventHandler, SessionEventType, SessionHooks, SessionUiApi, Tool, ToolHandler, TraceContextProvider, TypedSessionEventHandler, UserInputHandler, UserInputResponse } from "./types.js";
 export declare const NO_RESULT_PERMISSION_V2_ERROR = "Permission handlers cannot return 'no-result' when connected to a protocol v2 server.";
 /** Assistant message event - the final response from the assistant. */
 export type AssistantMessageEvent = Extract<SessionEvent, {
@@ -432,6 +432,7 @@ export declare class CopilotSession {
      */
     setModel(model: string, options?: {
         reasoningEffort?: ReasoningEffort;
+        modelCapabilities?: ModelCapabilitiesOverride;
     }): Promise<void>;
     /**
      * Log a message to the session timeline.

package/dist/types.d.ts

@@ -880,6 +880,8 @@ export interface SessionConfig {
      * Use client.listModels() to check supported values for each model.
      */
     reasoningEffort?: ReasoningEffort;
+    /** Per-property overrides for model capabilities, deep-merged over runtime defaults. */
+    modelCapabilities?: ModelCapabilitiesOverride;
     /**
      * Override the default configuration directory location.
      * When specified, the session will use this directory for storing config and state.
@@ -990,7 +992,7 @@ export interface SessionConfig {
 /**
  * Configuration for resuming a session
  */
-export type ResumeSessionConfig = Pick<SessionConfig, "clientName" | "model" | "tools" | "commands" | "systemMessage" | "availableTools" | "excludedTools" | "provider" | "streaming" | "reasoningEffort" | "onPermissionRequest" | "onUserInputRequest" | "onElicitationRequest" | "hooks" | "workingDirectory" | "configDir" | "mcpServers" | "customAgents" | "agent" | "skillDirectories" | "disabledSkills" | "infiniteSessions" | "onEvent" | "createSessionFsHandler"> & {
+export type ResumeSessionConfig = Pick<SessionConfig, "clientName" | "model" | "tools" | "commands" | "systemMessage" | "availableTools" | "excludedTools" | "provider" | "modelCapabilities" | "streaming" | "reasoningEffort" | "onPermissionRequest" | "onUserInputRequest" | "onElicitationRequest" | "hooks" | "workingDirectory" | "configDir" | "mcpServers" | "customAgents" | "agent" | "skillDirectories" | "disabledSkills" | "infiniteSessions" | "onEvent" | "createSessionFsHandler"> & {
     /**
      * When true, skips emitting the session.resume event.
      * Useful for reconnecting to a session without triggering resume-related side effects.
@@ -1202,6 +1204,12 @@ export interface ModelCapabilities {
         };
     };
 }
+/** Recursively makes all properties optional, preserving arrays as-is. */
+type DeepPartial<T> = T extends readonly (infer U)[] ? DeepPartial<U>[] : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+/** Deep-partial override for model capabilities — every property at any depth is optional. */
+export type ModelCapabilitiesOverride = DeepPartial<ModelCapabilities>;
 /**
  * Model policy state
  */

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "0.2.1",
+  "version": "0.2.2-preview.0",
   "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
   "main": "./dist/cjs/index.js",
   "types": "./dist/index.d.ts",
@@ -56,7 +56,7 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@github/copilot": "^1.0.17",
+    "@github/copilot": "^1.0.20-1",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"
   },