@github/copilot-sdk 1.0.0 → 1.0.2-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 | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | PermissionsChangedEvent | PlanChangedEvent | 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 | 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 | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
+export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | 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 | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
 /**
  * Hosting platform type of the repository (github or ado)
  */
@@ -164,6 +164,51 @@ export type AbortReason =
  | "remote_command"
 /** An MCP server delivered a user.abort notification. */
  | "user_abort";
+/**
+ * Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration.
+ */
+export type ToolExecutionStartToolDescriptionMetaUIVisibility = 
+/** Tool is callable by the model (LLM tool surface) */
+"model"
+/** Tool is callable by the MCP App view (iframe) via session.mcp.apps.callTool */
+ | "app";
+/**
+ * A model-facing binary result as persisted: full inline data, a size-omitted marker, or a deduplicated asset reference
+ */
+/** @experimental */
+export type PersistedBinaryResult = PersistedBinaryImage | OmittedBinaryResult | BinaryAssetReference;
+/**
+ * Binary result type discriminator. Use "image" for images and "resource" for other binary data.
+ */
+export type PersistedBinaryImageType = 
+/** Binary image data. */
+"image"
+/** Other binary resource data. */
+ | "resource";
+/**
+ * Why the binary data is absent: it exceeded the inline size limit, or its asset was unavailable
+ */
+export type OmittedBinaryOmittedReason = 
+/** Bytes exceeded the session's inline size limit. */
+"too_large"
+/** The referenced binary asset could not be found (e.g. a truncated log). */
+ | "asset_unavailable";
+/**
+ * Binary result type discriminator. Use "image" for images and "resource" for other binary data.
+ */
+export type OmittedBinaryType = 
+/** Binary image data. */
+"image"
+/** Other binary resource data. */
+ | "resource";
+/**
+ * Binary result type discriminator. Use "image" for images and "resource" for other binary data.
+ */
+export type BinaryAssetReferenceType = 
+/** Binary image data. */
+"image"
+/** Other binary resource data. */
+ | "resource";
 /**
  * A content block within a tool result, which may be text, terminal output, image, audio, or a resource
  */
@@ -198,6 +243,14 @@ export type SkillInvokedTrigger =
  | "agent-invoked"
 /** Skill content loaded as part of another context, such as a configured custom agent or subagent. */
  | "context-load";
+/**
+ * Binary asset type discriminator. Use "image" for images and "resource" otherwise.
+ */
+export type BinaryAssetType = 
+/** Binary image data. */
+"image"
+/** Other binary resource data. */
+ | "resource";
 /**
  * Message role: "system" for system prompts, "developer" for developer-injected instructions
  */
@@ -375,7 +428,11 @@ export type ExtensionsLoadedExtensionSource =
 /** Extension discovered from the current project. */
 "project"
 /** Extension discovered from the user's extension directory. */
- | "user";
+ | "user"
+/** Extension contributed by an installed plugin. */
+ | "plugin"
+/** Extension discovered from the current session's state directory. */
+ | "session";
 /**
  * Current status: running, disabled, failed, or starting
  */
@@ -562,6 +619,10 @@ export interface ResumeData {
      * Total number of persisted events in the session at the time of resume
      */
     eventCount: number;
+    /**
+     * On-disk byte size of the session's persisted events.jsonl file at resume time; omitted when the file does not exist or cannot be stat'd
+     */
+    eventsFileSizeBytes?: number;
     /**
      * Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max")
      */
@@ -695,7 +756,7 @@ export interface ErrorData {
     url?: string;
 }
 /**
- * Session event "session.idle". Payload indicating the session is idle with no background agents in flight
+ * Session event "session.idle". Payload indicating the session is idle with no background agents or attached shell commands in flight
  */
 export interface IdleEvent {
     /**
@@ -725,7 +786,7 @@ export interface IdleEvent {
     type: "session.idle";
 }
 /**
- * Payload indicating the session is idle with no background agents in flight
+ * Payload indicating the session is idle with no background agents or attached shell commands in flight
  */
 export interface IdleData {
     /**
@@ -806,6 +867,14 @@ export interface ScheduleCreatedEvent {
  * Scheduled prompt registered via /every or /after
  */
 export interface ScheduleCreatedData {
+    /**
+     * Absolute fire time (epoch milliseconds) for a one-shot calendar schedule
+     */
+    at?: number;
+    /**
+     * 5-field cron expression for a recurring calendar schedule, evaluated in `tz`
+     */
+    cron?: string;
     /**
      * Optional user-facing label shown in the timeline instead of the actual prompt (e.g. `/skill-name args` when the prompt is a skill invocation expansion)
      */
@@ -815,9 +884,9 @@ export interface ScheduleCreatedData {
      */
     id: number;
     /**
-     * Interval between ticks in milliseconds
+     * Interval between ticks in milliseconds (relative-interval schedules)
      */
-    intervalMs: number;
+    intervalMs?: number;
     /**
      * Prompt text that gets enqueued on every tick
      */
@@ -826,6 +895,10 @@ export interface ScheduleCreatedData {
      * Whether the schedule re-arms after each tick (`/every`) or fires once (`/after`)
      */
     recurring?: boolean;
+    /**
+     * IANA timezone the `cron` expression is evaluated in
+     */
+    tz?: string;
 }
 /**
  * Session event "session.schedule_cancelled". Scheduled prompt cancelled from the schedule manager dialog
@@ -1182,6 +1255,41 @@ export interface PlanChangedEvent {
 export interface PlanChangedData {
     operation: PlanChangedOperation;
 }
+/**
+ * Session event "session.todos_changed". Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed.
+ */
+export interface TodosChangedEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: TodosChangedData;
+    /**
+     * 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 "session.todos_changed".
+     */
+    type: "session.todos_changed";
+}
+/**
+ * Signal-only event: the agent's todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed.
+ */
+export interface TodosChangedData {
+}
 /**
  * Session event "session.workspace_file_changed". Workspace file change details including path and operation type
  */
@@ -1457,6 +1565,10 @@ export interface ShutdownData {
      * Error description when shutdownType is "error"
      */
     errorReason?: string;
+    /**
+     * On-disk byte size of the session's persisted events.jsonl file at shutdown time; omitted when the file does not exist or cannot be stat'd
+     */
+    eventsFileSizeBytes?: number;
     /**
      * Per-model usage breakdown, keyed by model identifier
      */
@@ -2456,17 +2568,9 @@ export interface AssistantMessageEvent {
  */
 export interface AssistantMessageData {
     /**
-     * Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping
-     *
-     * @experimental
-     */
-    anthropicAdvisorBlocks?: unknown[];
-    /**
-     * Anthropic advisor model ID used for this response, for timeline display on replay
-     *
-     * @experimental
+     * Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances.
      */
-    anthropicAdvisorModel?: string;
+    apiCallId?: string;
     /**
      * The assistant's text response content
      */
@@ -2512,6 +2616,7 @@ export interface AssistantMessageData {
      * GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs
      */
     requestId?: string;
+    serverTools?: AssistantMessageServerTools;
     /**
      * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation
      */
@@ -2525,6 +2630,19 @@ export interface AssistantMessageData {
      */
     turnId?: string;
 }
+/**
+ * Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping
+ */
+/** @experimental */
+export interface AssistantMessageServerTools {
+    advisorModel?: string;
+    functionCallNamespaces?: {
+        [k: string]: string | undefined;
+    };
+    items?: unknown[];
+    provider: string;
+    rawContentBlocks?: unknown[];
+}
 /**
  * A tool invocation request from the assistant
  */
@@ -2738,6 +2856,11 @@ export interface AssistantUsageData {
      * Number of tokens written to prompt cache
      */
     cacheWriteTokens?: number;
+    /**
+     * Whether the model response was blocked or truncated by content filtering (finish_reason === 'content_filter'). For Anthropic models this corresponds to a 'refusal' stop reason.
+     */
+    contentFilterTriggered?: boolean;
+    copilotUsage?: AssistantUsageCopilotUsage;
     /**
      * Model multiplier cost for billing purposes
      *
@@ -2748,6 +2871,10 @@ export interface AssistantUsageData {
      * Duration of the API call in milliseconds
      */
     duration?: number;
+    /**
+     * Finish reason reported by the model for this API call (e.g. "stop", "length", "tool_calls", "content_filter"). Normalized to OpenAI vocabulary; for Anthropic models a "refusal" stop reason maps to "content_filter".
+     */
+    finishReason?: string;
     /**
      * What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls
      */
@@ -2794,6 +2921,15 @@ export interface AssistantUsageData {
      */
     timeToFirstTokenMs?: number;
 }
+/**
+ * Per-request cost and usage data from the CAPI copilot_usage response field
+ */
+export interface AssistantUsageCopilotUsage {
+    /**
+     * Total cost in nano-AI units for this request
+     */
+    totalNanoAiu: number;
+}
 /**
  * Token usage detail for a single billing category
  */
@@ -3033,6 +3169,7 @@ export interface ToolExecutionStartData {
      * Unique identifier for this tool call
      */
     toolCallId: string;
+    toolDescription?: ToolExecutionStartToolDescription;
     /**
      * Name of the tool being executed
      */
@@ -3042,6 +3179,39 @@ export interface ToolExecutionStartData {
      */
     turnId?: string;
 }
+/**
+ * Tool definition metadata, present for MCP tools with MCP Apps support
+ */
+export interface ToolExecutionStartToolDescription {
+    _meta?: ToolExecutionStartToolDescriptionMeta;
+    /**
+     * Tool description
+     */
+    description?: string;
+    /**
+     * Tool name
+     */
+    name: string;
+}
+/**
+ * MCP Apps metadata for UI resource association
+ */
+export interface ToolExecutionStartToolDescriptionMeta {
+    ui?: ToolExecutionStartToolDescriptionMetaUI;
+}
+/**
+ * Schema for the `ToolExecutionStartToolDescriptionMetaUI` type.
+ */
+export interface ToolExecutionStartToolDescriptionMetaUI {
+    /**
+     * URI of the UI resource
+     */
+    resourceUri?: string;
+    /**
+     * Who can access this tool
+     */
+    visibility?: ToolExecutionStartToolDescriptionMetaUIVisibility[];
+}
 /**
  * Session event "tool.execution_partial_result". Streaming tool execution output for incremental result display
  */
@@ -3222,6 +3392,12 @@ export interface ToolExecutionCompleteError {
  * Tool execution result on success
  */
 export interface ToolExecutionCompleteResult {
+    /**
+     * Model-facing binary results (base64 inline or size-omitted markers) sent to the LLM for this tool call
+     *
+     * @experimental
+     */
+    binaryResultsForLlm?: PersistedBinaryResult[];
     /**
      * Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency
      */
@@ -3234,8 +3410,93 @@ export interface ToolExecutionCompleteResult {
      * Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent.
      */
     detailedContent?: string;
+    /**
+     * Structured content (arbitrary JSON) returned verbatim by the MCP tool
+     */
+    structuredContent?: {
+        [k: string]: unknown | undefined;
+    };
     uiResource?: ToolExecutionCompleteUIResource;
 }
+/**
+ * Binary result returned by a tool for the model
+ */
+export interface PersistedBinaryImage {
+    /**
+     * Base64-encoded binary data
+     */
+    data: string;
+    /**
+     * Human-readable description of the binary data
+     */
+    description?: string;
+    /**
+     * Optional metadata from the producing tool.
+     */
+    metadata?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * MIME type of the binary data
+     */
+    mimeType: string;
+    type: PersistedBinaryImageType;
+}
+/**
+ * A binary result whose data was omitted from persistence due to the inline size limit
+ */
+/** @experimental */
+export interface OmittedBinaryResult {
+    /**
+     * Decoded byte length of the omitted binary data
+     */
+    byteLength: number;
+    /**
+     * Human-readable description of the binary data
+     */
+    description?: string;
+    /**
+     * Optional metadata from the producing tool.
+     */
+    metadata?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * MIME type of the omitted binary data
+     */
+    mimeType: string;
+    omittedReason: OmittedBinaryOmittedReason;
+    type: OmittedBinaryType;
+}
+/**
+ * A reference to binary data persisted once on a session.binary_asset event and shared by id
+ */
+/** @experimental */
+export interface BinaryAssetReference {
+    /**
+     * Content-addressed id of the session.binary_asset event that holds this binary's bytes (e.g. "sha256:...").
+     */
+    assetId: string;
+    /**
+     * Decoded byte length of the referenced binary data
+     */
+    byteLength: number;
+    /**
+     * Human-readable description of the binary data
+     */
+    description?: string;
+    /**
+     * Optional metadata from the producing tool.
+     */
+    metadata?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * MIME type of the referenced binary data
+     */
+    mimeType: string;
+    type: BinaryAssetReferenceType;
+}
 /**
  * Plain text content block
  */
@@ -3578,7 +3839,7 @@ export interface SkillInvokedData {
      */
     pluginVersion?: string;
     /**
-     * Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), personal-claude (~/.claude/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill)
+     * Source identifier for where the skill was discovered. Known values include: project (workspace skill), inherited (parent-directory skill), personal-copilot (~/.copilot/skills), personal-agents (~/.agents/skills), custom (configured directory), plugin (installed plugin), builtin (bundled runtime skill), and remote (org/enterprise skill)
      */
     source?: string;
     trigger?: SkillInvokedTrigger;
@@ -3630,7 +3891,7 @@ export interface SubagentStartedData {
      */
     agentName: string;
     /**
-     * Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck).
+     * Model the sub-agent will run with, when known at start.
      */
     model?: string;
     /**
@@ -3752,7 +4013,7 @@ export interface SubagentFailedData {
      */
     error: string;
     /**
-     * Model used by the sub-agent (if any model calls succeeded before failure)
+     * Model selected for the sub-agent, when known
      */
     model?: string;
     /**
@@ -3961,6 +4222,10 @@ export interface HookEndError {
      * Human-readable error message
      */
     message: string;
+    /**
+     * Source label of the hook that errored (e.g. the plugin it was loaded from), when known
+     */
+    source?: string;
     /**
      * Error stack trace, when available
      */
@@ -4004,6 +4269,73 @@ export interface HookProgressData {
      * Human-readable progress message from the hook process
      */
     message: string;
+    /**
+     * When true, this status message replaces the previous temporary one instead of accumulating
+     */
+    temporary?: boolean;
+}
+/**
+ * Session event "session.binary_asset". Canonical bytes for a content-addressed binary asset shared by reference across events
+ */
+/** @experimental */
+export interface BinaryAssetEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: BinaryAssetData;
+    /**
+     * When true, the event is transient and not persisted to the session event log on disk
+     */
+    ephemeral?: boolean;
+    /**
+     * 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 "session.binary_asset".
+     */
+    type: "session.binary_asset";
+}
+/**
+ * Canonical bytes for a content-addressed binary asset shared by reference across events
+ */
+export interface BinaryAssetData {
+    /**
+     * Content-addressed id for this binary asset (e.g. "sha256:...").
+     */
+    assetId: string;
+    /**
+     * Decoded byte length of the binary asset
+     */
+    byteLength: number;
+    /**
+     * Base64-encoded binary data
+     */
+    data: string;
+    /**
+     * Human-readable description of the binary data
+     */
+    description?: string;
+    /**
+     * Optional metadata from the producing tool.
+     */
+    metadata?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * MIME type of the binary asset
+     */
+    mimeType: string;
+    type: BinaryAssetType;
 }
 /**
  * Session event "system.message". System/developer instruction content with role and optional template metadata
@@ -6522,7 +6854,7 @@ export interface ExtensionsLoadedData {
  */
 export interface ExtensionsLoadedExtension {
     /**
-     * Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper')
+     * Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper', 'plugin:my-plugin:my-ext')
      */
     id: string;
     /**
@@ -6699,6 +7031,53 @@ export interface CanvasRegistryChangedCanvasAction {
      */
     name: string;
 }
+/**
+ * Session event "session.canvas.closed".
+ */
+export interface CanvasClosedEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: CanvasClosedData;
+    /**
+     * 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 "session.canvas.closed".
+     */
+    type: "session.canvas.closed";
+}
+/**
+ * Schema for the `CanvasClosedData` type.
+ */
+export interface CanvasClosedData {
+    /**
+     * Provider-local canvas identifier
+     */
+    canvasId: string;
+    /**
+     * Owning provider identifier
+     */
+    extensionId: string;
+    /**
+     * Stable caller-supplied identifier of the canvas instance that was closed
+     */
+    instanceId: string;
+}
 /**
  * Session event "session.extensions.attachments_pushed".
  */

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, 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, UiInputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, MessageOptions, ModelBilling, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, 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, 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, MessageOptions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, 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, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolTelemetry, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";

package/dist/session.d.ts

@@ -170,12 +170,14 @@ export declare class CopilotSession {
      */
     on(handler: SessionEventHandler): () => void;
     private upsertOpenCanvasFromEvent;
+    private removeOpenCanvasFromEvent;
+    private removeOpenCanvas;
     private upsertOpenCanvas;
     /**
      * Snapshot of canvas instances currently known to be open for this session.
      * Populated from the `session.resume` response and live `session.canvas.opened`
-     * events. Returns a defensive copy — mutating the returned array has no effect
-     * on the session.
+     * and `session.canvas.closed` events. Returns a defensive copy — mutating the
+     * returned array has no effect on the session.
      */
     get openCanvases(): OpenCanvasInstance[];
     private assertElicitation;