@github/copilot-sdk 1.0.4 → 1.0.5-preview.0

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

@@ -5,7 +5,7 @@
 /**
  * Union of all session event variants emitted by the Copilot CLI runtime.
  */
-export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | CustomNotificationEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
+export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
 /**
  * Hosting platform type of the repository (github or ado)
  */
@@ -111,9 +111,9 @@ export type UserMessageAgentMode =
 /** The agent is in shell-focused UI mode. */
  | "shell";
 /**
- * A user message attachment — a file, directory, code selection, blob, GitHub reference, or extension-supplied context payload
+ * A user message attachment — a file, directory, code selection, blob, GitHub reference, GitHub-anchored pointer, or extension-supplied context payload
  */
-export type Attachment = AttachmentFile | AttachmentDirectory | AttachmentSelection | AttachmentGitHubReference | AttachmentBlob | AttachmentExtensionContext;
+export type Attachment = AttachmentFile | AttachmentDirectory | AttachmentSelection | AttachmentGitHubReference | AttachmentGitHubCommit | AttachmentGitHubRelease | AttachmentGitHubActionsJob | AttachmentGitHubRepository | AttachmentGitHubFileDiff | AttachmentGitHubTreeComparison | AttachmentGitHubUrl | AttachmentGitHubFile | AttachmentGitHubSnippet | AttachmentBlob | AttachmentExtensionContext;
 /**
  * Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable
  */
@@ -132,6 +132,16 @@ export type AttachmentGitHubReferenceType =
  | "pr"
 /** GitHub discussion reference. */
  | "discussion";
+/**
+ * How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message's origin (human vs. system/command/schedule/skill/etc.) is carried separately by `source`. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is `idle`, the same mechanism as a human starting a fresh turn.
+ */
+export type UserMessageDelivery = 
+/** Delivered while the loop was idle; starts its own run immediately (a human's fresh turn, or a system notification waking an idle agent). */
+"idle"
+/** Injected into the current in-flight run while the agent was busy (immediate mode). */
+ | "steering"
+/** Enqueued while the agent was busy; processed as its own run afterward. */
+ | "queued";
 /**
  * The system that produced a citation.
  */
@@ -355,6 +365,18 @@ export type ElicitationCompletedAction =
  | "decline"
 /** The user dismissed the request. */
  | "cancel";
+/**
+ * Reason the runtime is requesting host-provided MCP OAuth credentials
+ */
+export type McpOauthRequestReason = 
+/** Initial credentials are required before connecting to the MCP server. */
+"initial"
+/** The current host-provided credential was rejected and a replacement is requested. */
+ | "refresh"
+/** The server requires a new host authorization flow before continuing. */
+ | "reauth"
+/** The server requires a credential with additional scope or audience. */
+ | "upscope";
 /**
  * How the pending MCP OAuth request was completed
  */
@@ -363,6 +385,26 @@ export type McpOauthCompletionOutcome =
 "token"
 /** The request completed without an OAuth provider. */
  | "cancelled";
+/**
+ * Why dynamic headers are being requested.
+ */
+export type McpHeadersRefreshRequiredReason = 
+/** The transport is making its first dynamic header request for this server. */
+"startup"
+/** The previously cached dynamic headers expired. */
+ | "ttl-expired"
+/** The server returned 401 and stale dynamic headers were invalidated. */
+ | "auth-failed";
+/**
+ * How the pending MCP headers refresh request resolved.
+ */
+export type McpHeadersRefreshCompletedOutcome = 
+/** The host supplied dynamic headers. */
+"headers"
+/** The host responded with no dynamic headers. */
+ | "none"
+/** No response arrived within the bounded window. */
+ | "timeout";
 /**
  * The user's auto-mode-switch choice
  */
@@ -531,6 +573,7 @@ export interface StartData {
      * Whether this session supports remote steering via GitHub
      */
     remoteSteerable?: boolean;
+    responseBudget?: ResponseBudgetConfig;
     /**
      * Model selected at session creation time, if any
      */
@@ -582,6 +625,19 @@ export interface WorkingDirectoryContext {
      */
     repositoryHost?: string;
 }
+/**
+ * Optional response budget limits.
+ */
+export interface ResponseBudgetConfig {
+    /**
+     * Maximum AI Credits allowed while responding to one top-level user message.
+     */
+    maxAiCredits?: number;
+    /**
+     * Maximum model-call iterations allowed while responding to one top-level user message.
+     */
+    maxModelIterations?: number;
+}
 /**
  * Session event "session.resume". Session resume metadata including current context and event count
  */
@@ -646,6 +702,10 @@ export interface ResumeData {
      * Whether this session supports remote steering via GitHub
      */
     remoteSteerable?: boolean;
+    /**
+     * Response budget limits currently configured at resume time; null when no budget is active
+     */
+    responseBudget?: ResponseBudgetConfig | null;
     /**
      * ISO 8601 timestamp when the session was resumed
      */
@@ -2142,6 +2202,7 @@ export interface UserMessageData {
      * The user's message text as displayed in the timeline
      */
     content: string;
+    delivery?: UserMessageDelivery;
     /**
      * CAPI interaction ID for correlating this user message with its turn
      */
@@ -2321,6 +2382,231 @@ export interface AttachmentGitHubReference {
      */
     url: string;
 }
+/**
+ * Pointer to a GitHub commit.
+ */
+export interface AttachmentGitHubCommit {
+    /**
+     * First line of the commit message
+     */
+    message: string;
+    /**
+     * Full commit SHA
+     */
+    oid: string;
+    repo: GitHubRepoRef;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_commit";
+    /**
+     * URL to the commit on GitHub
+     */
+    url: string;
+}
+/**
+ * Pointer to a GitHub repository.
+ */
+export interface GitHubRepoRef {
+    /**
+     * Numeric GitHub repository id
+     */
+    id?: number;
+    /**
+     * Repository name (without owner)
+     */
+    name: string;
+    /**
+     * Repository owner login (user or organization)
+     */
+    owner: string;
+}
+/**
+ * Pointer to a GitHub release.
+ */
+export interface AttachmentGitHubRelease {
+    /**
+     * Human-readable release name
+     */
+    name: string;
+    repo: GitHubRepoRef;
+    /**
+     * Git tag the release is anchored to
+     */
+    tagName: string;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_release";
+    /**
+     * URL to the release on GitHub
+     */
+    url: string;
+}
+/**
+ * Pointer to a GitHub Actions job.
+ */
+export interface AttachmentGitHubActionsJob {
+    /**
+     * Terminal conclusion of the job when finished (e.g., success, failure, cancelled). Absent for in-progress jobs.
+     */
+    conclusion?: string;
+    /**
+     * Job id within the workflow run
+     */
+    jobId: number;
+    /**
+     * Display name of the job
+     */
+    jobName: string;
+    repo: GitHubRepoRef;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_actions_job";
+    /**
+     * URL to the job on GitHub
+     */
+    url: string;
+    /**
+     * Display name of the workflow the job ran in
+     */
+    workflowName: string;
+}
+/**
+ * Pointer to a GitHub repository.
+ */
+export interface AttachmentGitHubRepository {
+    /**
+     * Short description of the repository
+     */
+    description?: string;
+    /**
+     * Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied.
+     */
+    ref?: string;
+    repo: GitHubRepoRef;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_repository";
+    /**
+     * URL to the repository on GitHub
+     */
+    url: string;
+}
+/**
+ * Pointer to a single-file diff. At least one of `head` and `base` must be present.
+ */
+export interface AttachmentGitHubFileDiff {
+    base?: AttachmentGitHubFileDiffSide;
+    head?: AttachmentGitHubFileDiffSide;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_file_diff";
+    /**
+     * URL to the diff on GitHub (e.g., a commit, compare, or PR-file URL)
+     */
+    url: string;
+}
+/**
+ * One side of a file diff (head or base)
+ */
+export interface AttachmentGitHubFileDiffSide {
+    /**
+     * Repository-relative path to the file
+     */
+    path: string;
+    /**
+     * Git ref (branch, tag, or commit SHA) the file is read at
+     */
+    ref: string;
+    repo: GitHubRepoRef;
+}
+/**
+ * Pointer to a comparison between two git revisions.
+ */
+export interface AttachmentGitHubTreeComparison {
+    base: AttachmentGitHubTreeComparisonSide;
+    head: AttachmentGitHubTreeComparisonSide;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_tree_comparison";
+    /**
+     * URL to the comparison on GitHub
+     */
+    url: string;
+}
+/**
+ * One side of a tree comparison (head or base)
+ */
+export interface AttachmentGitHubTreeComparisonSide {
+    repo: GitHubRepoRef;
+    /**
+     * Git revision (branch, tag, or commit SHA)
+     */
+    revision: string;
+}
+/**
+ * Generic GitHub URL reference.
+ */
+export interface AttachmentGitHubUrl {
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_url";
+    /**
+     * URL to the GitHub resource
+     */
+    url: string;
+}
+/**
+ * Pointer to a file in a GitHub repository at a specific ref.
+ */
+export interface AttachmentGitHubFile {
+    /**
+     * Repository-relative path to the file
+     */
+    path: string;
+    /**
+     * Git ref the file is read at (branch, tag, or commit SHA)
+     */
+    ref: string;
+    repo: GitHubRepoRef;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_file";
+    /**
+     * URL to the file on GitHub
+     */
+    url: string;
+}
+/**
+ * Pointer to a line range inside a file in a GitHub repository.
+ */
+export interface AttachmentGitHubSnippet {
+    lineRange: AttachmentFileLineRange;
+    /**
+     * Repository-relative path to the file
+     */
+    path: string;
+    /**
+     * Git ref the file is read at (branch, tag, or commit SHA)
+     */
+    ref: string;
+    repo: GitHubRepoRef;
+    /**
+     * Attachment type discriminator
+     */
+    type: "github_snippet";
+    /**
+     * URL to the snippet on GitHub (with line anchor)
+     */
+    url: string;
+}
 /**
  * Blob attachment with inline base64-encoded data
  */
@@ -3040,6 +3326,45 @@ export interface AssistantTurnEndData {
      */
     turnId: string;
 }
+/**
+ * Session event "assistant.idle". Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred
+ */
+export interface AssistantIdleEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: AssistantIdleData;
+    /**
+     * Always true for events that are transient and not persisted to the session event log on disk.
+     */
+    ephemeral: true;
+    /**
+     * Unique event identifier (UUID v4), generated when the event is emitted
+     */
+    id: string;
+    /**
+     * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
+     */
+    parentId: string | null;
+    /**
+     * ISO 8601 timestamp when the event was created
+     */
+    timestamp: string;
+    /**
+     * Type discriminator. Always "assistant.idle".
+     */
+    type: "assistant.idle";
+}
+/**
+ * Payload emitted whenever the main agent's processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred
+ */
+export interface AssistantIdleData {
+    /**
+     * True when the preceding agentic loop was cancelled via abort signal
+     */
+    aborted?: boolean;
+}
 /**
  * Session event "assistant.usage". LLM API call usage metrics including tokens, costs, quotas, and billing information
  */
@@ -3439,6 +3764,7 @@ export interface ToolExecutionStartData {
      * Tool call ID of the parent tool invocation when this event originates from a sub-agent
      */
     parentToolCallId?: string;
+    shellToolInfo?: ToolExecutionStartShellToolInfo;
     /**
      * Unique identifier for this tool call
      */
@@ -3453,6 +3779,19 @@ export interface ToolExecutionStartData {
      */
     turnId?: string;
 }
+/**
+ * Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs.
+ */
+export interface ToolExecutionStartShellToolInfo {
+    /**
+     * Whether the command includes a file write redirection (e.g., > or >>).
+     */
+    hasWriteFileRedirection: boolean;
+    /**
+     * File paths the command may read or write, derived from the command at start time. Produced by the same shell-aware extractor as PermissionRequestShell.possiblePaths, so it is present even when the command is auto-approved and no permission request fires.
+     */
+    possiblePaths: string[];
+}
 /**
  * Tool definition metadata, present for MCP tools with MCP Apps support
  */
@@ -6139,6 +6478,7 @@ export interface McpOauthRequiredEvent {
  * OAuth authentication request for an MCP server
  */
 export interface McpOauthRequiredData {
+    reason: McpOauthRequestReason;
     /**
      * Unique identifier for this OAuth request; used to respond via session.mcp.oauth.handlePendingRequest
      */
@@ -6166,6 +6506,10 @@ export interface McpOauthRequiredStaticClientConfig {
      * OAuth client ID for the server
      */
     clientId: string;
+    /**
+     * Optional OAuth client secret for confidential static clients, when the runtime can resolve one
+     */
+    clientSecret?: string;
     /**
      * Optional non-default OAuth grant type. When set to 'client_credentials', the OAuth flow runs headlessly using the client_id + keychain-stored secret (no browser, no callback server).
      */
@@ -6184,9 +6528,9 @@ export interface McpOauthWWWAuthenticateParams {
      */
     error?: string;
     /**
-     * Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter
+     * Protected resource metadata URL from the WWW-Authenticate resource_metadata parameter, if present
      */
-    resourceMetadataUrl: string;
+    resourceMetadataUrl?: string;
     /**
      * Requested OAuth scopes from the WWW-Authenticate scope parameter, if present
      */
@@ -6232,6 +6576,94 @@ export interface McpOauthCompletedData {
      */
     requestId: string;
 }
+/**
+ * Session event "mcp.headers_refresh_required". Dynamic headers refresh request for a remote MCP server
+ */
+export interface McpHeadersRefreshRequiredEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: McpHeadersRefreshRequiredData;
+    /**
+     * Always true for events that are transient and not persisted to the session event log on disk.
+     */
+    ephemeral: true;
+    /**
+     * Unique event identifier (UUID v4), generated when the event is emitted
+     */
+    id: string;
+    /**
+     * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
+     */
+    parentId: string | null;
+    /**
+     * ISO 8601 timestamp when the event was created
+     */
+    timestamp: string;
+    /**
+     * Type discriminator. Always "mcp.headers_refresh_required".
+     */
+    type: "mcp.headers_refresh_required";
+}
+/**
+ * Dynamic headers refresh request for a remote MCP server
+ */
+export interface McpHeadersRefreshRequiredData {
+    reason: McpHeadersRefreshRequiredReason;
+    /**
+     * Unique identifier for this headers refresh request; used to respond via session.mcp.headers.handlePendingHeadersRefreshRequest()
+     */
+    requestId: string;
+    /**
+     * Display name of the remote MCP server requesting headers
+     */
+    serverName: string;
+    /**
+     * URL of the remote MCP server requesting headers
+     */
+    serverUrl: string;
+}
+/**
+ * Session event "mcp.headers_refresh_completed". MCP headers refresh request completion notification
+ */
+export interface McpHeadersRefreshCompletedEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: McpHeadersRefreshCompletedData;
+    /**
+     * Always true for events that are transient and not persisted to the session event log on disk.
+     */
+    ephemeral: true;
+    /**
+     * Unique event identifier (UUID v4), generated when the event is emitted
+     */
+    id: string;
+    /**
+     * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
+     */
+    parentId: string | null;
+    /**
+     * ISO 8601 timestamp when the event was created
+     */
+    timestamp: string;
+    /**
+     * Type discriminator. Always "mcp.headers_refresh_completed".
+     */
+    type: "mcp.headers_refresh_completed";
+}
+/**
+ * MCP headers refresh request completion notification
+ */
+export interface McpHeadersRefreshCompletedData {
+    outcome: McpHeadersRefreshCompletedOutcome;
+    /**
+     * Request ID of the resolved headers refresh request
+     */
+    requestId: string;
+}
 /**
  * Session event "session.custom_notification". Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined.
  */

package/dist/index.d.ts

@@ -10,4 +10,4 @@ export { CopilotSession, type AssistantMessageEvent } from "./session.js";
 export { Canvas, CanvasError, createCanvas, type CanvasAction, type CanvasDeclaration, type CanvasHostContext, type CanvasHostContextCapabilities, type CanvasJsonSchema, type CanvasOptions, } from "./canvas.js";
 export { defineTool, approveAll, convertMcpCallToolResult, createSessionFsAdapter, CopilotRequestHandler, CopilotWebSocketHandler, CopilotWebSocketCloseStatus, CopilotWebSocketForwarder, SYSTEM_MESSAGE_SECTIONS, } from "./types.js";
 export type * from "./generated/session-events.js";
-export type { CommandContext, CommandDefinition, CommandHandler, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, CopilotClientMode, CopilotClientOptions, StdioRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, GetBearerToken, MessageOptions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, CapiSessionOptions, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, NamedProviderConfig, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, ProviderModelConfig, ProviderTokenArgs, RemoteSessionMode, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionConfigBase, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventMetadata, SessionLifecycleEventType, SessionLifecycleHandler, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, SessionForegroundEvent, SessionBackgroundEvent, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolTelemetry, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";
+export type { CommandContext, CommandDefinition, CommandHandler, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, CopilotClientMode, CopilotClientOptions, StdioRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, BearerTokenProvider, MessageOptions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, CapiSessionOptions, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, NamedProviderConfig, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, ProviderModelConfig, ProviderTokenArgs, RemoteSessionMode, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionConfigBase, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventMetadata, SessionLifecycleEventType, SessionLifecycleHandler, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, SessionForegroundEvent, SessionBackgroundEvent, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolTelemetry, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";

package/dist/session.js

@@ -510,7 +510,7 @@ class CopilotSession {
     };
   }
   /**
-   * Registers per-provider {@link GetBearerToken} callbacks for BYOK providers
+   * Registers per-provider {@link BearerTokenProvider} callbacks for BYOK providers
    * configured with managed-identity / on-demand bearer-token auth.
    *
    * The runtime never receives the callback itself; the SDK strips it from the
@@ -540,7 +540,8 @@ class CopilotSession {
           );
         }
         const token = await callback({
-          providerName: params.providerName
+          providerName: params.providerName,
+          sessionId: params.sessionId
         });
         return { token };
       }

package/dist/types.d.ts

@@ -1799,7 +1799,7 @@ export interface ResumeSessionConfig extends SessionConfigBase {
     openCanvases?: OpenCanvasInstance[];
 }
 /**
- * Arguments passed to a {@link GetBearerToken} callback when the runtime needs a
+ * Arguments passed to a {@link BearerTokenProvider} callback when the runtime needs a
  * fresh bearer token for a BYOK provider.
  *
  * @experimental Part of the experimental managed-identity / bearer-token-provider
@@ -1814,7 +1814,14 @@ export interface ProviderTokenArgs {
      * The callback closes over its own token scope/audience; the runtime is
      * provider-agnostic and forwards only the provider name.
      */
-    providerName: string;
+    readonly providerName: string;
+    /**
+     * Id of the session that triggered this token request. A client-level shared
+     * callback registered for many sessions can use this to resolve the owning
+     * session (e.g. via the client's session lookup) to scope token acquisition
+     * or caching per session.
+     */
+    readonly sessionId: string;
 }
 /**
  * Per-provider callback that resolves a bearer token on demand, returning the
@@ -1828,7 +1835,7 @@ export interface ProviderTokenArgs {
  * @experimental Part of the experimental managed-identity / bearer-token-provider
  * surface and may change or be removed in future SDK or CLI releases.
  */
-export type GetBearerToken = (args: ProviderTokenArgs) => Promise<string>;
+export type BearerTokenProvider = (args: ProviderTokenArgs) => Promise<string>;
 /**
  * Configuration for a custom API provider.
  */
@@ -1870,12 +1877,14 @@ export interface ProviderConfig {
      * When set, the SDK keeps this function client-side (it is never serialized)
      * and the runtime calls back into this client to acquire a token before each
      * outbound request. The runtime does no caching of its own, so the callback
-     * owns token caching and refresh. Mutually exclusive with {@link apiKey} /
-     * {@link bearerToken}.
+     * owns token caching and refresh. When set alongside {@link apiKey} /
+     * {@link bearerToken}, this callback takes precedence: the runtime applies
+     * the token it returns as the `Authorization: Bearer` header for each
+     * request and does not send the static credential.
      *
      * @experimental
      */
-    getBearerToken?: GetBearerToken;
+    bearerTokenProvider?: BearerTokenProvider;
     /**
      * Azure-specific options
      */
@@ -1960,12 +1969,14 @@ export interface NamedProviderConfig {
      * When set, the SDK keeps this function client-side (it is never serialized)
      * and the runtime calls back into this client to acquire a token before each
      * outbound request. The runtime does no caching of its own, so the callback
-     * owns token caching and refresh. Mutually exclusive with {@link apiKey} /
-     * {@link bearerToken}.
+     * owns token caching and refresh. When set alongside {@link apiKey} /
+     * {@link bearerToken}, this callback takes precedence: the runtime applies
+     * the token it returns as the `Authorization: Bearer` header for each
+     * request and does not send the static credential.
      *
      * @experimental
      */
-    getBearerToken?: GetBearerToken;
+    bearerTokenProvider?: BearerTokenProvider;
     /**
      * Azure-specific options.
      */

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "1.0.4",
+  "version": "1.0.5-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.65",
+    "@github/copilot": "^1.0.66-1",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"
   },