@github/copilot-sdk 1.0.9-preview.2 → 1.0.9

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 | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | ToolSearchActivatedEvent | 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 | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | AutoModeResolvedEvent | ManagedSettingsResolvedEvent | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | FactoryRunUpdatedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | McpToolsListChangedEvent | McpResourcesListChangedEvent | McpPromptsListChangedEvent | 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 | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | ToolSearchActivatedEvent | 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 | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | AutoModeResolvedEvent | ManagedSettingsResolvedEvent | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | FactoryRunUpdatedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | McpToolsListChangedEvent | McpResourcesListChangedEvent | McpPromptsListChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
 /**
  * Hosting platform type of the repository (github or ado)
  */
@@ -274,7 +274,9 @@ export type AbortReason =
 /** A remote command requested the abort. */
  | "remote_command"
 /** An MCP server delivered a user.abort notification. */
- | "user_abort";
+ | "user_abort"
+/** Autopilot stopped the run because the active objective reached its user-set --max-ai-credits limit. */
+ | "autopilot_credit_limit";
 /**
  * Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration.
  */
@@ -365,7 +367,7 @@ export type SystemMessageRole =
 /**
  * Structured metadata identifying what triggered this notification
  */
-export type SystemNotification = SystemNotificationAgentCompleted | SystemNotificationAgentIdle | SystemNotificationNewInboxMessage | SystemNotificationShellCompleted | SystemNotificationShellDetachedCompleted | SystemNotificationInstructionDiscovered | SystemNotificationUnclassified;
+export type SystemNotification = SystemNotificationAgentCompleted | SystemNotificationAgentIdle | SystemNotificationNewInboxMessage | SystemNotificationShellCompleted | SystemNotificationShellDetachedCompleted | SystemNotificationInstructionDiscovered | SystemNotificationFactoryCompleted | SystemNotificationUnclassified;
 /**
  * Whether the agent completed successfully or failed
  */
@@ -374,10 +376,22 @@ export type SystemNotificationAgentCompletedStatus =
 "completed"
 /** The agent failed. */
  | "failed";
+/**
+ * Terminal status reached by a factory execution attempt.
+ */
+export type SystemNotificationFactoryCompletedStatus = 
+/** The factory completed successfully. */
+"completed"
+/** The factory was halted. */
+ | "halted"
+/** The factory was cancelled. */
+ | "cancelled"
+/** The factory failed. */
+ | "error";
 /**
  * Details of the permission being requested
  */
-export type PermissionRequest = PermissionRequestShell | PermissionRequestWrite | PermissionRequestRead | PermissionRequestMcp | PermissionRequestUrl | PermissionRequestMemory | PermissionRequestCustomTool | PermissionRequestHook | PermissionRequestExtensionManagement | PermissionRequestExtensionPermissionAccess;
+export type PermissionRequest = PermissionRequestShell | PermissionRequestWrite | PermissionRequestRead | PermissionRequestMcp | PermissionRequestUrl | PermissionRequestMemory | PermissionRequestCustomTool | PermissionRequestHook | PermissionRequestExtensionManagement | PermissionRequestFactory | PermissionRequestExtensionPermissionAccess;
 /**
  * Whether this is a store or vote memory operation
  */
@@ -394,10 +408,18 @@ export type PermissionRequestMemoryDirection =
 "upvote"
 /** Vote that the memory is incorrect or outdated. */
  | "downvote";
+/**
+ * Operation gated by a factory permission request.
+ */
+export type FactoryPermissionOperation = 
+/** Running a registered factory, which spends subagents, active time, and AI credits under the approved limits. */
+"run"
+/** Authoring a factory, which writes JavaScript into a session-scoped extension and loads it. */
+ | "author";
 /**
  * Derived user-facing permission prompt details for UI consumers
  */
-export type PermissionPromptRequest = PermissionPromptRequestCommands | PermissionPromptRequestWrite | PermissionPromptRequestRead | PermissionPromptRequestMcp | PermissionPromptRequestUrl | PermissionPromptRequestMemory | PermissionPromptRequestCustomTool | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement | PermissionPromptRequestExtensionPermissionAccess;
+export type PermissionPromptRequest = PermissionPromptRequestCommands | PermissionPromptRequestWrite | PermissionPromptRequestRead | PermissionPromptRequestMcp | PermissionPromptRequestUrl | PermissionPromptRequestMemory | PermissionPromptRequestCustomTool | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement | PermissionPromptRequestFactory | PermissionPromptRequestExtensionPermissionAccess;
 /**
  * Why the auto-approval judge produced no usable recommendation. Present only alongside an `error` recommendation, where the human-readable reason is a fixed string and therefore cannot distinguish these cases. Intended to make a judge failure reportable by a consumer that has no access to the host's logs.
  */
@@ -443,7 +465,7 @@ export type PermissionResult = PermissionApproved | PermissionApprovedForSession
 /**
  * The approval to add as a session-scoped rule
  */
-export type UserToolSessionApproval = UserToolSessionApprovalCommands | UserToolSessionApprovalRead | UserToolSessionApprovalWrite | UserToolSessionApprovalMcp | UserToolSessionApprovalMemory | UserToolSessionApprovalCustomTool | UserToolSessionApprovalExtensionManagement | UserToolSessionApprovalExtensionPermissionAccess;
+export type UserToolSessionApproval = UserToolSessionApprovalCommands | UserToolSessionApprovalRead | UserToolSessionApprovalWrite | UserToolSessionApprovalMcp | UserToolSessionApprovalMemory | UserToolSessionApprovalCustomTool | UserToolSessionApprovalExtensionManagement | UserToolSessionApprovalFactory | UserToolSessionApprovalExtensionPermissionAccess;
 /**
  * Elicitation mode; "form" for structured input, "url" for browser-based. Defaults to "form" when absent.
  */
@@ -607,7 +629,7 @@ export type McpServerSource =
 /** Server bundled with the runtime. */
  | "builtin";
 /**
- * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
+ * Connection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configured
  */
 export type McpServerStatus = 
 /** The server is connected and available. */
@@ -620,6 +642,8 @@ export type McpServerStatus =
  | "pending"
 /** The server is configured but disabled. */
  | "disabled"
+/** The server was intentionally stopped and can be restarted on demand when policy permits; a server quarantined by restrictive managed policy stays stopped and cannot be restarted until the policy allows it. */
+ | "stopped"
 /** The server is not configured for this session. */
  | "not_configured";
 /**
@@ -709,6 +733,7 @@ export interface StartData {
      * When set, identifies a parent session whose context this session continues — e.g., a detached headless rem-agent run launched on the parent's interactive shutdown. Telemetry from this session is reported under the parent's session_id.
      */
     detachedFromSpawningParentSessionId?: string;
+    githubMcpToolConfig?: GitHubMcpToolConfig;
     /**
      * Identifier of the software producing the events (e.g., "copilot-agent")
      */
@@ -779,6 +804,27 @@ export interface WorkingDirectoryContext {
      */
     repositoryHost?: string;
 }
+/**
+ * Per-session configuration for the built-in GitHub MCP server
+ */
+export interface GitHubMcpToolConfig {
+    /**
+     * Additional GitHub MCP tools requested by the session
+     */
+    additionalTools?: string[];
+    /**
+     * Additional GitHub MCP toolsets requested by the session
+     */
+    additionalToolsets?: string[];
+    /**
+     * Whether to use the read-write endpoint and request all toolsets
+     */
+    enableAllTools?: boolean;
+    /**
+     * Whether to request the GitHub MCP insiders build
+     */
+    enableInsidersMode?: boolean;
+}
 /**
  * Optional session limits.
  */
@@ -1386,7 +1432,7 @@ export interface ModelChangeEvent {
  */
 export interface ModelChangeData {
     /**
-     * Reason the change happened, when not user-initiated. Currently `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path. UI clients can use this to render contextual copy.
+     * Reason the change happened, when not user-initiated. `"rate_limit_auto_switch"` for changes triggered by the auto-mode-switch rate-limit recovery path, or `"refusal_fallback"` when the active model declined a request (content refusal) and the runtime switched to the configured refusal-fallback model. UI clients can use this to render contextual copy.
      */
     cause?: string;
     /**
@@ -2159,6 +2205,49 @@ export interface UsageInfoData {
      */
     toolDefinitionsTokens?: number;
 }
+/**
+ * Session event "session.context_cleared". Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages)
+ */
+export interface ContextClearedEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: ContextClearedData;
+    /**
+     * 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.context_cleared".
+     */
+    type: "session.context_cleared";
+}
+/**
+ * Context-cleared details emitted when the host clears the conversation (the session.history.clearContext RPC / Session.clearContextMessages)
+ */
+export interface ContextClearedData {
+    /**
+     * Optional initial message set after clearing
+     */
+    initialMessage?: string;
+    /**
+     * Number of conversation messages that were cleared
+     */
+    messagesCleared: number;
+}
 /**
  * Session event "session.compaction_start". Context window breakdown at the start of LLM-powered conversation compaction
  */
@@ -3323,6 +3412,14 @@ export interface AssistantMessageData {
      * Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances.
      */
     apiCallId?: string;
+    /**
+     * Total messages the model call's response was split into, one per reasoning boundary. Absent for a single-message response; the last chunk is the one where chunkIndex is chunkCount - 1.
+     */
+    chunkCount?: number;
+    /**
+     * Zero-based position of this message within its model call's response. Absent when the response was not split into chunks.
+     */
+    chunkIndex?: number;
     /**
      * Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled.
      *
@@ -4201,6 +4298,12 @@ export interface ToolExecutionStartData {
  * 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 {
+    /**
+     * The command with a redundant leading `cd` into the working directory removed, present only when there was one to remove. Computed with the same routine the shell driver applies before spawning, so a surface that renders this shows the text that actually runs. Consumers that display it should keep the original tool arguments available on demand.
+     *
+     * @experimental
+     */
+    displayCommand?: string;
     /**
      * Whether the command includes a file write redirection (e.g., > or >>).
      */
@@ -5729,6 +5832,54 @@ export interface SystemNotificationInstructionDiscovered {
      */
     type: "instruction_discovered";
 }
+/**
+ * System notification metadata for a factory execution attempt that reached a terminal state.
+ */
+export interface SystemNotificationFactoryCompleted {
+    /**
+     * Execution attempt that reached this terminal state.
+     */
+    attempt: number;
+    /**
+     * Consumed AI usage in nano-AIU.
+     */
+    consumedNanoAiu: number;
+    /**
+     * Subagents consumed by the run across all attempts.
+     */
+    consumedSubagents: number;
+    /**
+     * Accumulated active execution time in milliseconds.
+     */
+    elapsedMs: number;
+    /**
+     * Persisted factory name.
+     */
+    factoryName: string;
+    /**
+     * Machine-readable terminal failure details, when present.
+     */
+    failure?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * Bounded prompt-safe preview of the completed result.
+     */
+    resultPreview?: string;
+    /**
+     * Actionable run_factory resume guidance for a resource-limit failure.
+     */
+    retryGuidance?: string;
+    /**
+     * Factory run identifier.
+     */
+    runId: string;
+    status: SystemNotificationFactoryCompletedStatus;
+    /**
+     * Type discriminator. Always "factory_completed".
+     */
+    type: "factory_completed";
+}
 /**
  * System notification metadata from an external host that does not match a runtime-owned notification kind.
  */
@@ -6147,6 +6298,73 @@ export interface PermissionRequestExtensionManagement {
      */
     toolCallId?: string;
 }
+/**
+ * Factory run or authoring permission request
+ */
+export interface PermissionRequestFactory {
+    /**
+     * Canonical key used for scoped factory approvals
+     */
+    approvalKey: string;
+    /**
+     * Whether this factory is eligible for persistent approval
+     */
+    canPersistApproval: boolean;
+    declaredMaxAiCredits?: number;
+    declaredMaxConcurrentSubagents?: number;
+    declaredMaxTotalSubagents?: number;
+    declaredTimeoutSeconds?: number;
+    /**
+     * Factory description
+     */
+    description: string;
+    /**
+     * Permission kind discriminator
+     */
+    kind: "factory";
+    /**
+     * Effective AI-credit limit; omitted means unlimited
+     */
+    maxAiCredits?: number;
+    /**
+     * Effective concurrent-subagent limit; omitted means unlimited
+     */
+    maxConcurrentSubagents?: number;
+    /**
+     * Effective total-subagent limit; omitted means unlimited
+     */
+    maxTotalSubagents?: number;
+    /**
+     * Factory name
+     */
+    name: string;
+    operation: FactoryPermissionOperation;
+    /**
+     * Declared factory phases
+     */
+    phases: FactoryPermissionPhase[];
+    /**
+     * Effective active-time limit in seconds; omitted means unlimited
+     */
+    timeoutSeconds?: number;
+    /**
+     * Tool call ID that triggered this permission request
+     */
+    toolCallId?: string;
+}
+/**
+ * A declared phase shown in a factory permission prompt.
+ */
+export interface FactoryPermissionPhase {
+    /**
+     * Optional phase detail
+     */
+    detail?: string;
+    /**
+     * Phase title
+     */
+    title: string;
+}
 /**
  * Extension permission access request
  */
@@ -6535,6 +6753,70 @@ export interface PermissionPromptRequestExtensionManagement {
      */
     toolCallId?: string;
 }
+/**
+ * Factory run or authoring permission prompt
+ */
+export interface PermissionPromptRequestFactory {
+    /**
+     * Canonical key used for scoped factory approvals
+     */
+    approvalKey: string;
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
+    /**
+     * Whether this factory is eligible for persistent approval
+     */
+    canPersistApproval: boolean;
+    declaredMaxAiCredits?: number;
+    declaredMaxConcurrentSubagents?: number;
+    declaredMaxTotalSubagents?: number;
+    declaredTimeoutSeconds?: number;
+    /**
+     * Factory description
+     */
+    description: string;
+    /**
+     * Prompt kind discriminator
+     */
+    kind: "factory";
+    /**
+     * Whether managed policy requires a human response and forbids host auto-approval
+     */
+    managedApprovalRequired?: boolean;
+    /**
+     * Effective AI-credit limit; omitted means unlimited
+     */
+    maxAiCredits?: number;
+    /**
+     * Effective concurrent-subagent limit; omitted means unlimited
+     */
+    maxConcurrentSubagents?: number;
+    /**
+     * Effective total-subagent limit; omitted means unlimited
+     */
+    maxTotalSubagents?: number;
+    /**
+     * Factory name
+     */
+    name: string;
+    operation: FactoryPermissionOperation;
+    /**
+     * Declared factory phases
+     */
+    phases: FactoryPermissionPhase[];
+    /**
+     * Effective active-time limit in seconds; omitted means unlimited
+     */
+    timeoutSeconds?: number;
+    /**
+     * Tool call ID that triggered this permission request
+     */
+    toolCallId?: string;
+}
 /**
  * Extension permission access prompt
  */
@@ -6708,6 +6990,19 @@ export interface UserToolSessionApprovalExtensionManagement {
      */
     operation?: string;
 }
+/**
+ * Session-scoped factory approval, optionally narrowed by approval key.
+ */
+export interface UserToolSessionApprovalFactory {
+    /**
+     * Optional factory operation name or canonical approval key
+     */
+    approvalKey?: string;
+    /**
+     * Factory approval kind
+     */
+    kind: "factory";
+}
 /**
  * Session-scoped tool-approval rule for an extension's permission-gated capability access, keyed by extension name.
  */

package/dist/index.d.ts

@@ -11,5 +11,5 @@ export { defineFactory, FactoryResumeError, isFactoryRunTerminal } from "./facto
 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, SessionFsSqliteTransactionFailure, SYSTEM_MESSAGE_SECTIONS, } from "./types.js";
 export type * from "./generated/session-events.js";
-export type { CommandContext, CommandDefinition, CommandHandler, CanvasProviderIdentity, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, AgentStopHandler, AgentStopHookInput, AgentStopHookOutput, CopilotClientMode, CopilotClientOptions, CopilotExpAssignmentResponse, StdioRuntimeConnection, InProcessRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, ChildProcessRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExpConfigEntry, ExpFlagValue, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, FactoryLimits, FactoryMeta, 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, SessionHooks, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, SessionForegroundEvent, SessionBackgroundEvent, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, SessionFsSqliteStatement, SessionFsSqliteTransactionErrorClass, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, CurrentToolMetadata, ToolTelemetry, ToolResultObject, ToolSearchConfig, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";
+export type { CommandContext, CommandDefinition, CommandHandler, CanvasProviderIdentity, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, AgentStopHandler, AgentStopHookInput, AgentStopHookOutput, UserPromptTransformedHandler, UserPromptTransformedHookInput, UserPromptTransformedHookOutput, CopilotClientMode, CopilotClientOptions, CopilotExpAssignmentResponse, StdioRuntimeConnection, InProcessRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, ChildProcessRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExpConfigEntry, ExpFlagValue, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, GitHubMcpToolConfig, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, FactoryLimits, FactoryMeta, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, BearerTokenProvider, MessageOptions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, CapiSessionOptions, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, NamedProviderConfig, PermissionHandler, PermissionRequest, PermissionRequestedData, PermissionRequestedEvent, PermissionRequestResult, ProviderConfig, ProviderModelConfig, ProviderTokenArgs, RemoteSessionMode, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionConfigBase, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventMetadata, SessionLifecycleEventType, SessionLifecycleHandler, SessionHooks, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, SessionForegroundEvent, SessionBackgroundEvent, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, SessionFsSqliteStatement, SessionFsSqliteTransactionErrorClass, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, CurrentToolMetadata, ToolTelemetry, ToolResultObject, ToolSearchConfig, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";
 export type { RunOptions, ResumeOptions, FactoryResumeErrorCode, SessionFactoryApi, FactoryAgentOptions, FactoryContext, FactoryDefinition, FactoryHandle, FactoryJsonSchema, JsonValue, FactoryPipelineStage, FactoryStepOptions, FactoryRunResult, FactoryRunStatus, FactoryRunSummary, FactoryRunDetail, FactoryProgressPage, FactoryProgressLine, FactoryPhaseObservation, FactoryPhaseStatus, FactoryAgentSummary, } from "./factory.js";

package/dist/session.d.ts

@@ -58,6 +58,7 @@ export declare class CopilotSession {
     private transformCallbacks?;
     private _rpc;
     private traceContextProvider?;
+    private readonly managedSettingsEnabled;
     private _capabilities;
     private openCanvasInstances;
     private disconnected;
@@ -68,6 +69,14 @@ export declare class CopilotSession {
      * change or be removed in future SDK or CLI releases.
      */
     readonly factory: SessionFactoryApi;
+    /**
+     * Resolve a start/resume envelope into the terminal envelope callers expect.
+     *
+     * The CLI may answer `session.factory.run` and `session.factory.resume`
+     * before the run settles, so a non-terminal envelope is followed by a wait
+     * on the run's terminal state.
+     */
+    private settleFactoryRun;
     /**
      * Resolve when a factory run reaches a terminal status.
      *

package/dist/session.js

@@ -205,6 +205,7 @@ class CopilotSession {
     this._workspacePath = _workspacePath;
     this.traceContextProvider = traceContextProvider;
     this.mcpAuthHandler = options?.mcpAuthHandler;
+    this.managedSettingsEnabled = options?.managedSettingsEnabled === true;
   }
   sessionId;
   connection;
@@ -227,6 +228,7 @@ class CopilotSession {
   transformCallbacks;
   _rpc = null;
   traceContextProvider;
+  managedSettingsEnabled;
   _capabilities = {};
   openCanvasInstances = [];
   disconnected = false;
@@ -253,7 +255,7 @@ class CopilotSession {
           limits: options?.limits
         }
       });
-      return toPublicFactoryRunResult(envelope);
+      return this.settleFactoryRun(envelope);
     }),
     resume: (async (runId, options) => {
       let response;
@@ -271,7 +273,7 @@ class CopilotSession {
         }
         throw error;
       }
-      return toPublicFactoryRunResult(response.run);
+      return this.settleFactoryRun(response.run);
     }),
     getRun: async (runId) => toPublicFactoryRunResult(await this.rpc.factory.getRun({ runId })),
     waitForRun: (runId, options) => this.waitForFactoryRun(runId, options?.signal),
@@ -280,6 +282,19 @@ class CopilotSession {
     getRunProgress: (runId, options = {}) => this.rpc.factory.getRunProgress({ runId, ...options }),
     cancel: async (runId) => toPublicFactoryRunResult(await this.rpc.factory.cancel({ runId }))
   };
+  /**
+   * Resolve a start/resume envelope into the terminal envelope callers expect.
+   *
+   * The CLI may answer `session.factory.run` and `session.factory.resume`
+   * before the run settles, so a non-terminal envelope is followed by a wait
+   * on the run's terminal state.
+   */
+  settleFactoryRun(envelope) {
+    if (isFactoryRunTerminal(envelope.status)) {
+      return Promise.resolve(toPublicFactoryRunResult(envelope));
+    }
+    return this.waitForFactoryRun(envelope.runId);
+  }
   /**
    * Resolve when a factory run reaches a terminal status.
    *
@@ -415,22 +430,20 @@ class CopilotSession {
   async sendAndWait(optionsOrPrompt, timeout) {
     const options = typeof optionsOrPrompt === "string" ? { prompt: optionsOrPrompt } : optionsOrPrompt;
     const effectiveTimeout = timeout ?? 6e4;
-    let resolveIdle;
-    let rejectWithError;
-    const idlePromise = new Promise((resolve, reject) => {
-      resolveIdle = resolve;
-      rejectWithError = reject;
+    let resolveOutcome;
+    const outcomePromise = new Promise((resolve) => {
+      resolveOutcome = resolve;
     });
     let lastAssistantMessage;
     const unsubscribe = this.on((event) => {
       if (event.type === "assistant.message") {
         lastAssistantMessage = event;
       } else if (event.type === "session.idle") {
-        resolveIdle();
+        resolveOutcome({ kind: "idle" });
       } else if (event.type === "session.error") {
         const error = new Error(event.data.message);
         error.stack = event.data.stack;
-        rejectWithError(error);
+        resolveOutcome({ kind: "error", error });
       }
     });
     let timeoutId;
@@ -446,7 +459,10 @@ class CopilotSession {
           effectiveTimeout
         );
       });
-      await Promise.race([idlePromise, timeoutPromise]);
+      const outcome = await Promise.race([outcomePromise, timeoutPromise]);
+      if (outcome.kind === "error") {
+        throw outcome.error;
+      }
       return lastAssistantMessage;
     } finally {
       if (timeoutId !== void 0) {
@@ -685,7 +701,8 @@ class CopilotSession {
   async _executePermissionAndRespond(requestId, permissionRequest) {
     try {
       const result = await this.permissionHandler(permissionRequest, {
-        sessionId: this.sessionId
+        sessionId: this.sessionId,
+        managedSettingsEnabled: this.managedSettingsEnabled
       });
       if (result.kind === "no-result") {
         return;
@@ -694,10 +711,15 @@ class CopilotSession {
         return;
       }
       await this.rpc.permissions.handlePendingPermissionRequest({ requestId, result });
-    } catch (_error) {
+    } catch (error) {
       if (this.disconnected) {
         return;
       }
+      console.error("Permission handler or response delivery failed", {
+        sessionId: this.sessionId,
+        requestId,
+        error
+      });
       try {
         await this.rpc.permissions.handlePendingPermissionRequest({
           requestId,
@@ -1342,6 +1364,7 @@ class CopilotSession {
       postToolUse: this.hooks.onPostToolUse,
       postToolUseFailure: this.hooks.onPostToolUseFailure,
       userPromptSubmitted: this.hooks.onUserPromptSubmitted,
+      userPromptTransformed: this.hooks.onUserPromptTransformed,
       sessionStart: this.hooks.onSessionStart,
       sessionEnd: this.hooks.onSessionEnd,
       errorOccurred: this.hooks.onErrorOccurred,