@github/copilot-sdk 0.3.0 → 1.0.0-beta.1

package/dist/generated/rpc.d.ts

@@ -38,6 +38,34 @@ export type ExtensionSource = "project" | "user";
  * via the `definition` "ExtensionStatus".
  */
 export type ExtensionStatus = "running" | "disabled" | "failed" | "starting";
+/**
+ * Tool call result (string or expanded result object)
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolResult".
+ */
+export type ExternalToolResult = string | ExternalToolTextResultForLlm;
+/**
+ * A content block within a tool result, which may be text, terminal output, image, audio, or a resource
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContent".
+ */
+export type ExternalToolTextResultForLlmContent = ExternalToolTextResultForLlmContentText | ExternalToolTextResultForLlmContentTerminal | ExternalToolTextResultForLlmContentImage | ExternalToolTextResultForLlmContentAudio | ExternalToolTextResultForLlmContentResourceLink | ExternalToolTextResultForLlmContentResource;
+/**
+ * Theme variant this icon is intended for
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentResourceLinkIconTheme".
+ */
+export type ExternalToolTextResultForLlmContentResourceLinkIconTheme = "light" | "dark";
+/**
+ * The embedded resource contents, either text or base64-encoded binary
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentResourceDetails".
+ */
+export type ExternalToolTextResultForLlmContentResourceDetails = EmbeddedTextResourceContents | EmbeddedBlobResourceContents;
 export type FilterMapping = {
     [k: string]: FilterMappingValue;
 } | FilterMappingString;
@@ -79,6 +107,7 @@ export type McpServerConfigLocalType = "local" | "stdio";
  * via the `definition` "McpServerConfigHttpType".
  */
 export type McpServerConfigHttpType = "http" | "sse";
+export type McpServerConfigHttpOauthGrantType = "authorization_code" | "client_credentials";
 /**
  * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
  *
@@ -100,7 +129,7 @@ export type McpServerSource = "user" | "workspace" | "plugin" | "builtin";
  * via the `definition` "SessionMode".
  */
 export type SessionMode = "interactive" | "plan" | "autopilot";
-export type PermissionDecision = PermissionDecisionApproveOnce | PermissionDecisionApproveForSession | PermissionDecisionApproveForLocation | PermissionDecisionReject | PermissionDecisionUserNotAvailable;
+export type PermissionDecision = PermissionDecisionApproveOnce | PermissionDecisionApproveForSession | PermissionDecisionApproveForLocation | PermissionDecisionApprovePermanently | PermissionDecisionReject | PermissionDecisionUserNotAvailable;
 /**
  * The approval to add as a session-scoped rule
  *
@@ -144,12 +173,41 @@ export type SessionFsSetProviderConventions = "windows" | "posix";
  */
 export type ShellKillSignal = "SIGTERM" | "SIGKILL" | "SIGINT";
 /**
- * Tool call result (string or expanded result object)
+ * Current lifecycle status of the task
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "TaskAgentInfoStatus".
+ */
+export type TaskAgentInfoStatus = "running" | "idle" | "completed" | "failed" | "cancelled";
+/**
+ * How the agent is currently being managed by the runtime
  *
  * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
- * via the `definition` "ToolsHandlePendingToolCall".
+ * via the `definition` "TaskAgentInfoExecutionMode".
  */
-export type ToolsHandlePendingToolCall = string | ToolCallResult;
+export type TaskAgentInfoExecutionMode = "sync" | "background";
+export type TaskInfo = TaskAgentInfo | TaskShellInfo;
+/**
+ * Current lifecycle status of the task
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "TaskShellInfoStatus".
+ */
+export type TaskShellInfoStatus = "running" | "idle" | "completed" | "failed" | "cancelled";
+/**
+ * Whether the shell runs inside a managed PTY session or as an independent background process
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "TaskShellInfoAttachmentMode".
+ */
+export type TaskShellInfoAttachmentMode = "attached" | "detached";
+/**
+ * Whether the shell command is currently sync-waited or background-managed
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "TaskShellInfoExecutionMode".
+ */
+export type TaskShellInfoExecutionMode = "sync" | "background";
 export type UIElicitationFieldValue = string | number | boolean | string[];
 export type UIElicitationSchemaProperty = UIElicitationStringEnumField | UIElicitationStringOneOfField | UIElicitationArrayEnumField | UIElicitationArrayAnyOfField | UIElicitationSchemaPropertyBoolean | UIElicitationSchemaPropertyString | UIElicitationSchemaPropertyNumber;
 export type UIElicitationSchemaPropertyStringFormat = "email" | "uri" | "date" | "date-time";
@@ -229,6 +287,10 @@ export interface AgentInfo {
      * Description of the agent's purpose
      */
     description: string;
+    /**
+     * Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path.
+     */
+    path?: string;
 }
 /** @experimental */
 export interface AgentList {
@@ -271,6 +333,28 @@ export interface CommandsHandlePendingCommandResult {
      */
     success: boolean;
 }
+/** @internal */
+export interface ConnectRequest {
+    /**
+     * Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN
+     */
+    token?: string;
+}
+/** @internal */
+export interface ConnectResult {
+    /**
+     * Always true on success
+     */
+    ok: true;
+    /**
+     * Server protocol version number
+     */
+    protocolVersion: number;
+    /**
+     * Server package version
+     */
+    version: string;
+}
 export interface CurrentModel {
     /**
      * Currently active model identifier
@@ -289,6 +373,34 @@ export interface DiscoveredMcpServer {
      */
     enabled: boolean;
 }
+export interface EmbeddedBlobResourceContents {
+    /**
+     * URI identifying the resource
+     */
+    uri: string;
+    /**
+     * MIME type of the blob content
+     */
+    mimeType?: string;
+    /**
+     * Base64-encoded binary content of the resource
+     */
+    blob: string;
+}
+export interface EmbeddedTextResourceContents {
+    /**
+     * URI identifying the resource
+     */
+    uri: string;
+    /**
+     * MIME type of the text content
+     */
+    mimeType?: string;
+    /**
+     * Text content of the resource
+     */
+    text: string;
+}
 export interface Extension {
     /**
      * Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper')
@@ -326,6 +438,195 @@ export interface ExtensionsEnableRequest {
      */
     id: string;
 }
+/**
+ * Expanded external tool result payload
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlm".
+ */
+export interface ExternalToolTextResultForLlm {
+    /**
+     * Text result returned to the model
+     */
+    textResultForLlm: string;
+    /**
+     * Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized.
+     */
+    resultType?: string;
+    /**
+     * Optional error message for failed executions
+     */
+    error?: string;
+    /**
+     * Detailed log content for timeline display
+     */
+    sessionLog?: string;
+    /**
+     * Optional tool-specific telemetry
+     */
+    toolTelemetry?: {
+        [k: string]: unknown;
+    };
+    /**
+     * Structured content blocks from the tool
+     */
+    contents?: ExternalToolTextResultForLlmContent[];
+    [k: string]: unknown;
+}
+/**
+ * Plain text content block
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentText".
+ */
+export interface ExternalToolTextResultForLlmContentText {
+    /**
+     * Content block type discriminator
+     */
+    type: "text";
+    /**
+     * The text content
+     */
+    text: string;
+}
+/**
+ * Terminal/shell output content block with optional exit code and working directory
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentTerminal".
+ */
+export interface ExternalToolTextResultForLlmContentTerminal {
+    /**
+     * Content block type discriminator
+     */
+    type: "terminal";
+    /**
+     * Terminal/shell output text
+     */
+    text: string;
+    /**
+     * Process exit code, if the command has completed
+     */
+    exitCode?: number;
+    /**
+     * Working directory where the command was executed
+     */
+    cwd?: string;
+}
+/**
+ * Image content block with base64-encoded data
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentImage".
+ */
+export interface ExternalToolTextResultForLlmContentImage {
+    /**
+     * Content block type discriminator
+     */
+    type: "image";
+    /**
+     * Base64-encoded image data
+     */
+    data: string;
+    /**
+     * MIME type of the image (e.g., image/png, image/jpeg)
+     */
+    mimeType: string;
+}
+/**
+ * Audio content block with base64-encoded data
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentAudio".
+ */
+export interface ExternalToolTextResultForLlmContentAudio {
+    /**
+     * Content block type discriminator
+     */
+    type: "audio";
+    /**
+     * Base64-encoded audio data
+     */
+    data: string;
+    /**
+     * MIME type of the audio (e.g., audio/wav, audio/mpeg)
+     */
+    mimeType: string;
+}
+/**
+ * Resource link content block referencing an external resource
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentResourceLink".
+ */
+export interface ExternalToolTextResultForLlmContentResourceLink {
+    /**
+     * Icons associated with this resource
+     */
+    icons?: ExternalToolTextResultForLlmContentResourceLinkIcon[];
+    /**
+     * Resource name identifier
+     */
+    name: string;
+    /**
+     * Human-readable display title for the resource
+     */
+    title?: string;
+    /**
+     * URI identifying the resource
+     */
+    uri: string;
+    /**
+     * Human-readable description of the resource
+     */
+    description?: string;
+    /**
+     * MIME type of the resource content
+     */
+    mimeType?: string;
+    /**
+     * Size of the resource in bytes
+     */
+    size?: number;
+    /**
+     * Content block type discriminator
+     */
+    type: "resource_link";
+}
+/**
+ * Icon image for a resource
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentResourceLinkIcon".
+ */
+export interface ExternalToolTextResultForLlmContentResourceLinkIcon {
+    /**
+     * URL or path to the icon image
+     */
+    src: string;
+    /**
+     * MIME type of the icon image
+     */
+    mimeType?: string;
+    /**
+     * Available icon sizes (e.g., ['16x16', '32x32'])
+     */
+    sizes?: string[];
+    theme?: ExternalToolTextResultForLlmContentResourceLinkIconTheme;
+}
+/**
+ * Embedded resource content block with inline text or binary data
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ExternalToolTextResultForLlmContentResource".
+ */
+export interface ExternalToolTextResultForLlmContentResource {
+    /**
+     * Content block type discriminator
+     */
+    type: "resource";
+    resource: ExternalToolTextResultForLlmContentResourceDetails;
+}
 /** @experimental */
 export interface FleetStartRequest {
     /**
@@ -340,7 +641,18 @@ export interface FleetStartResult {
      */
     started: boolean;
 }
-export interface HandleToolCallResult {
+export interface HandlePendingToolCallRequest {
+    /**
+     * Request ID of the pending tool call
+     */
+    requestId: string;
+    result?: ExternalToolResult;
+    /**
+     * Error message if the tool call failed
+     */
+    error?: string;
+}
+export interface HandlePendingToolCallResult {
     /**
      * Whether the tool call result was handled successfully
      */
@@ -507,6 +819,7 @@ export interface McpServerConfigHttp {
     };
     oauthClientId?: string;
     oauthPublicClient?: boolean;
+    oauthGrantType?: McpServerConfigHttpOauthGrantType;
 }
 export interface McpConfigDisableRequest {
     /**
@@ -811,7 +1124,7 @@ export interface ModeSetRequest {
 }
 export interface NameGetResult {
     /**
-     * The session name, falling back to the auto-generated summary, or null if neither exists
+     * The session name (user-set or auto-generated), or null if not yet set
      */
     name: string | null;
 }
@@ -832,7 +1145,11 @@ export interface PermissionDecisionApproveForSession {
      * Approved and remembered for the rest of the session
      */
     kind: "approve-for-session";
-    approval: PermissionDecisionApproveForSessionApproval;
+    approval?: PermissionDecisionApproveForSessionApproval;
+    /**
+     * The URL domain to approve for this session
+     */
+    domain?: string;
 }
 export interface PermissionDecisionApproveForSessionApprovalCommands {
     kind: "commands";
@@ -897,6 +1214,16 @@ export interface PermissionDecisionApproveForLocationApprovalCustomTool {
     kind: "custom-tool";
     toolName: string;
 }
+export interface PermissionDecisionApprovePermanently {
+    /**
+     * Approved and persisted across sessions
+     */
+    kind: "approve-permanently";
+    /**
+     * The URL domain to approve permanently
+     */
+    domain: string;
+}
 export interface PermissionDecisionReject {
     /**
      * Denied by the user during an interactive prompt
@@ -1407,6 +1734,194 @@ export interface SkillsEnableRequest {
      */
     name: string;
 }
+export interface TaskAgentInfo {
+    /**
+     * Task kind
+     */
+    type: "agent";
+    /**
+     * Unique task identifier
+     */
+    id: string;
+    /**
+     * Tool call ID associated with this agent task
+     */
+    toolCallId: string;
+    /**
+     * Short description of the task
+     */
+    description: string;
+    status: TaskAgentInfoStatus;
+    /**
+     * ISO 8601 timestamp when the task was started
+     */
+    startedAt: string;
+    /**
+     * ISO 8601 timestamp when the task finished
+     */
+    completedAt?: string;
+    /**
+     * Accumulated active execution time in milliseconds
+     */
+    activeTimeMs?: number;
+    /**
+     * ISO 8601 timestamp when the current active period began
+     */
+    activeStartedAt?: string;
+    /**
+     * Error message when the task failed
+     */
+    error?: string;
+    /**
+     * Type of agent running this task
+     */
+    agentType: string;
+    /**
+     * Prompt passed to the agent
+     */
+    prompt: string;
+    /**
+     * Result text from the task when available
+     */
+    result?: string;
+    /**
+     * Model used for the task when specified
+     */
+    model?: string;
+    executionMode?: TaskAgentInfoExecutionMode;
+    /**
+     * Whether the task is currently in the original sync wait and can be moved to background mode. False once it is already backgrounded, idle, finished, or no longer has a promotable sync waiter.
+     */
+    canPromoteToBackground?: boolean;
+    /**
+     * Most recent response text from the agent
+     */
+    latestResponse?: string;
+    /**
+     * ISO 8601 timestamp when the agent entered idle state
+     */
+    idleSince?: string;
+}
+export interface TaskShellInfo {
+    /**
+     * Task kind
+     */
+    type: "shell";
+    /**
+     * Unique task identifier
+     */
+    id: string;
+    /**
+     * Short description of the task
+     */
+    description: string;
+    status: TaskShellInfoStatus;
+    /**
+     * ISO 8601 timestamp when the task was started
+     */
+    startedAt: string;
+    /**
+     * ISO 8601 timestamp when the task finished
+     */
+    completedAt?: string;
+    /**
+     * Command being executed
+     */
+    command: string;
+    attachmentMode: TaskShellInfoAttachmentMode;
+    executionMode?: TaskShellInfoExecutionMode;
+    /**
+     * Whether this shell task can be promoted to background mode
+     */
+    canPromoteToBackground?: boolean;
+    /**
+     * Path to the detached shell log, when available
+     */
+    logPath?: string;
+    /**
+     * Process ID when available
+     */
+    pid?: number;
+}
+/** @experimental */
+export interface TaskList {
+    /**
+     * Currently tracked tasks
+     */
+    tasks: TaskInfo[];
+}
+/** @experimental */
+export interface TasksCancelRequest {
+    /**
+     * Task identifier
+     */
+    id: string;
+}
+/** @experimental */
+export interface TasksCancelResult {
+    /**
+     * Whether the task was successfully cancelled
+     */
+    cancelled: boolean;
+}
+/** @experimental */
+export interface TasksPromoteToBackgroundRequest {
+    /**
+     * Task identifier
+     */
+    id: string;
+}
+/** @experimental */
+export interface TasksPromoteToBackgroundResult {
+    /**
+     * Whether the task was successfully promoted to background mode
+     */
+    promoted: boolean;
+}
+/** @experimental */
+export interface TasksRemoveRequest {
+    /**
+     * Task identifier
+     */
+    id: string;
+}
+/** @experimental */
+export interface TasksRemoveResult {
+    /**
+     * Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first).
+     */
+    removed: boolean;
+}
+/** @experimental */
+export interface TasksStartAgentRequest {
+    /**
+     * Type of agent to start (e.g., 'explore', 'task', 'general-purpose')
+     */
+    agentType: string;
+    /**
+     * Task prompt for the agent
+     */
+    prompt: string;
+    /**
+     * Short name for the agent, used to generate a human-readable ID
+     */
+    name: string;
+    /**
+     * Short description of the task
+     */
+    description?: string;
+    /**
+     * Optional model override
+     */
+    model?: string;
+}
+/** @experimental */
+export interface TasksStartAgentResult {
+    /**
+     * Generated agent ID for the background task
+     */
+    agentId: string;
+}
 export interface Tool {
     /**
      * Tool identifier (e.g., "bash", "grep", "str_replace_editor")
@@ -1431,43 +1946,12 @@ export interface Tool {
      */
     instructions?: string;
 }
-export interface ToolCallResult {
-    /**
-     * Text result to send back to the LLM
-     */
-    textResultForLlm: string;
-    /**
-     * Type of the tool result
-     */
-    resultType?: string;
-    /**
-     * Error message if the tool call failed
-     */
-    error?: string;
-    /**
-     * Telemetry data from tool execution
-     */
-    toolTelemetry?: {
-        [k: string]: unknown;
-    };
-}
 export interface ToolList {
     /**
      * List of available built-in tools with metadata
      */
     tools: Tool[];
 }
-export interface ToolsHandlePendingToolCallRequest {
-    /**
-     * Request ID of the pending tool call
-     */
-    requestId: string;
-    result?: ToolsHandlePendingToolCall;
-    /**
-     * Error message if the tool call failed
-     */
-    error?: string;
-}
 export interface ToolsListRequest {
     /**
      * Optional model ID — when provided, the returned tool list reflects model-specific overrides
@@ -1616,6 +2100,16 @@ export interface UsageGetMetricsResult {
      * Raw count of user-initiated API requests
      */
     totalUserRequests: number;
+    /**
+     * Session-wide accumulated nano-AI units cost
+     */
+    totalNanoAiu?: number;
+    /**
+     * Session-wide per-token-type accumulated token counts
+     */
+    tokenDetails?: {
+        [k: string]: UsageMetricsTokenDetail;
+    };
     /**
      * Total time spent in model API calls (milliseconds)
      */
@@ -1644,6 +2138,12 @@ export interface UsageGetMetricsResult {
      */
     lastCallOutputTokens: number;
 }
+export interface UsageMetricsTokenDetail {
+    /**
+     * Accumulated token count for this token type
+     */
+    tokenCount: number;
+}
 /**
  * Aggregated code change metrics
  *
@@ -1667,6 +2167,16 @@ export interface UsageMetricsCodeChanges {
 export interface UsageMetricsModelMetric {
     requests: UsageMetricsModelMetricRequests;
     usage: UsageMetricsModelMetricUsage;
+    /**
+     * Accumulated nano-AI units cost for this model
+     */
+    totalNanoAiu?: number;
+    /**
+     * Token count details per type
+     */
+    tokenDetails?: {
+        [k: string]: UsageMetricsModelMetricTokenDetail;
+    };
 }
 /**
  * Request count and cost metrics for this model
@@ -1712,6 +2222,12 @@ export interface UsageMetricsModelMetricUsage {
      */
     reasoningTokens?: number;
 }
+export interface UsageMetricsModelMetricTokenDetail {
+    /**
+     * Accumulated token count for this token type
+     */
+    tokenCount: number;
+}
 export interface WorkspacesCreateFileRequest {
     /**
      * Relative path within the workspace files directory
@@ -1733,8 +2249,9 @@ export interface WorkspacesGetWorkspaceResult {
         repository?: string;
         host_type?: "github" | "ado";
         branch?: string;
-        summary?: string;
         name?: string;
+        user_named?: boolean;
+        summary?: string;
         summary_count?: number;
         created_at?: string;
         updated_at?: string;
@@ -1801,8 +2318,17 @@ export declare function createServerRpc(connection: MessageConnection): {
         fork: (params: SessionsForkRequest) => Promise<SessionsForkResult>;
     };
 };
+/**
+ * Create typed server-scoped RPC methods that are part of the SDK's internal
+ * surface (e.g. handshake helpers). Not exported on the public client API.
+ * @internal
+ */
+export declare function createInternalServerRpc(connection: MessageConnection): {
+    connect: (params: ConnectRequest) => Promise<ConnectResult>;
+};
 /** Create typed session-scoped RPC methods. */
 export declare function createSessionRpc(connection: MessageConnection, sessionId: string): {
+    suspend: () => Promise<void>;
     auth: {
         getStatus: () => Promise<SessionAuthStatus>;
     };
@@ -1845,6 +2371,14 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
         reload: () => Promise<AgentReloadResult>;
     };
     /** @experimental */
+    tasks: {
+        startAgent: (params: TasksStartAgentRequest) => Promise<TasksStartAgentResult>;
+        list: () => Promise<TaskList>;
+        promoteToBackground: (params: TasksPromoteToBackgroundRequest) => Promise<TasksPromoteToBackgroundResult>;
+        cancel: (params: TasksCancelRequest) => Promise<TasksCancelResult>;
+        remove: (params: TasksRemoveRequest) => Promise<TasksRemoveResult>;
+    };
+    /** @experimental */
     skills: {
         list: () => Promise<SkillList>;
         enable: (params: SkillsEnableRequest) => Promise<void>;
@@ -1874,7 +2408,7 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
         reload: () => Promise<void>;
     };
     tools: {
-        handlePendingToolCall: (params: ToolsHandlePendingToolCallRequest) => Promise<HandleToolCallResult>;
+        handlePendingToolCall: (params: HandlePendingToolCallRequest) => Promise<HandlePendingToolCallResult>;
     };
     commands: {
         handlePendingCommand: (params: CommandsHandlePendingCommandRequest) => Promise<CommandsHandlePendingCommandResult>;