@github/copilot-sdk 1.0.15-preview.0 → 1.0.15-preview.2

package/dist/generated/rpc.js

@@ -1807,6 +1807,77 @@ function createSessionRpc(connection, sessionId) {
       }
     },
     /** @experimental */
+    connectors: {
+      /**
+       * Returns feature availability and bounded polling limits for the EXPERIMENTAL session connector API. This method never performs a Connector service request.
+       *
+       * @returns Feature detection and hard polling limits for the EXPERIMENTAL session connector API.
+       */
+      getCapabilities: async () => connection.sendRequest("session.connectors.getCapabilities", { sessionId }),
+      /**
+       * Returns authoritative session Connector state from current availability, pinned account selection, cached catalog, and live MCP projection without performing a Connector service request.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      getStatus: async () => connection.sendRequest("session.connectors.getStatus", { sessionId }),
+      /**
+       * Returns the cached Connector catalog for the pinned opaque account selection, fetching it only when this session has no cached catalog.
+       *
+       * @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
+       *
+       * @returns Validated Connector catalog snapshot cached by the session.
+       */
+      list: async (params) => connection.sendRequest("session.connectors.list", { sessionId, ...params }),
+      /**
+       * Refreshes and validates the Connector catalog for the pinned opaque account selection.
+       *
+       * @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
+       *
+       * @returns Validated Connector catalog snapshot cached by the session.
+       */
+      refresh: async (params) => connection.sendRequest("session.connectors.refresh", { sessionId, ...params }),
+      /**
+       * Initiates an idempotent Connector connection request without opening a browser. Returns connected when the service is immediately authoritative, consent_required with a validated URL, or pending with an opaque continuation ID.
+       *
+       * @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
+       *
+       * @returns Typed result of initiating or continuing a Connector connection.
+       */
+      connect: async (params) => connection.sendRequest("session.connectors.connect", { sessionId, ...params }),
+      /**
+       * Re-initiates an idempotent Connector connection request without browser or UI effects, with the same typed outcomes as connect.
+       *
+       * @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
+       *
+       * @returns Typed result of initiating or continuing a Connector connection.
+       */
+      reconnect: async (params) => connection.sendRequest("session.connectors.reconnect", { sessionId, ...params }),
+      /**
+       * Continues a pending Connector connection with caller-supplied attempt, interval, and deadline bounds. The runtime never opens the returned consent URL.
+       *
+       * @param params Explicitly bounded continuation of a pending Connector connection.
+       *
+       * @returns Typed result of initiating or continuing a Connector connection.
+       */
+      continueConnection: async (params) => connection.sendRequest("session.connectors.continueConnection", { sessionId, ...params }),
+      /**
+       * Disconnects one Connector for the pinned opaque account selection, refreshes the authoritative catalog, and removes its session-owned MCP projection.
+       *
+       * @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
+       *
+       * @returns Authoritative result after disconnect and MCP reconciliation.
+       */
+      disconnect: async (params) => connection.sendRequest("session.connectors.disconnect", { sessionId, ...params }),
+      /**
+       * Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
+       *
+       * @param params Requests authoritative Connector-to-MCP reconciliation for the pinned account.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      reconcile: async (params) => connection.sendRequest("session.connectors.reconcile", { sessionId, ...params })
+    },
+    /** @experimental */
     managedSettings: {
       /**
        * Waits for the live session's in-flight managed-settings application, then returns the retained effective snapshot used by runtime enforcement and by `session.managed_settings_resolved`. It does not perform another account, device, or server resolution, and rejects when resolution has not produced a snapshot.
@@ -1922,7 +1993,15 @@ function createSessionRpc(connection, sessionId) {
        *
        * @returns The selectable model entries synthesized for the models added by this call.
        */
-      add: async (params) => connection.sendRequest("session.provider.add", { sessionId, ...params })
+      add: async (params) => connection.sendRequest("session.provider.add", { sessionId, ...params }),
+      /**
+       * Atomically updates the session's BYOK provider and model registry by applying the supplied snapshot, replacing existing entries, updating models, or removing entries absent from the snapshot.
+       *
+       * @param params Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
+       *
+       * @returns The selectable model entries and selection ids synthesized for the synchronized BYOK models.
+       */
+      sync: async (params) => connection.sendRequest("session.provider.sync", { sessionId, ...params })
     },
     /** @experimental */
     options: {
@@ -2248,9 +2327,9 @@ function createSessionRpc(connection, sessionId) {
        */
       setRequired: async (params) => connection.sendRequest("session.permissions.setRequired", { sessionId, ...params }),
       /**
-       * Clears session-scoped tool permission approvals.
+       * Clears session-scoped tool approvals and, for full resets, exact session-approved paths.
        *
-       * @param params Clears session-scoped tool permission approvals, and optionally the location-scoped ones.
+       * @param params Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
        *
        * @returns Indicates whether the operation succeeded.
        */
@@ -2266,9 +2345,9 @@ function createSessionRpc(connection, sessionId) {
       /** @experimental */
       paths: {
         /**
-         * Returns the session's allowed directories and primary working directory.
+         * Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.
          *
-         * @returns Snapshot of the session's allow-listed directories and primary working directory.
+         * @returns Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
          */
         list: async () => connection.sendRequest("session.permissions.paths.list", { sessionId }),
         /**
@@ -2943,6 +3022,23 @@ function createInternalSessionRpc(connection, sessionId) {
       unregisterExternalClient: async (params) => connection.sendRequest("session.mcp.unregisterExternalClient", { sessionId, ...params })
     },
     /** @experimental */
+    connectors: {
+      /**
+       * Reconciles the authoritative Connector catalog into the session MCP projection during startup with a bounded deadline and fail-closed cleanup.
+       *
+       * @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      reconcileForStartup: async (params) => connection.sendRequest("session.connectors.reconcileForStartup", { sessionId, ...params }),
+      /**
+       * Removes the runtime-owned Connector MCP projection without changing service-side connections.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      withdrawProjection: async () => connection.sendRequest("session.connectors.withdrawProjection", { sessionId })
+    },
+    /** @experimental */
     commands: {
       /**
        * Finalizes persistence associated with a client-applied slash-command effect.

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

@@ -9,7 +9,7 @@ export type JsonValue = null | boolean | number | string | JsonValue[] | {
 /**
  * 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 | IndexedSearchEvent | WarningEvent | ModelChangeEvent | AutoTierRecommendationEvent | AutoTierSwitchFailedEvent | ModeChangedEvent | ModeNoticeDeliveredEvent | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | CompletionReceiptEvent | FusionRouteStartedEvent | FusionRouteFailedEvent | FusionResolvedEvent | FusionCompletedEvent | PermissionRecoveryEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantFusionPhaseStartedEvent | AssistantFusionPhaseActivityEvent | AssistantFusionPhaseCompletedEvent | AssistantFusionPhaseFailedEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | ModelCallFinishedEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | ToolSearchActivatedEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentConfiguredEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | PermissionCarriedForwardEvent | PermissionMessageAuthorizationEvent | PermissionMessageAuthorizationReadEvent | PermissionMessageAuthorizationDegradedEvent | PermissionAssentDetectedEvent | PermissionContextualAuthorizationEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | UIEphemeralQueryEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | AutoModeResolvedEvent | ManagedSettingsResolvedEvent | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | FactoryRunUpdatedEvent | FactoryRunStartedEvent | FactoryRunSettledEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | McpServerRemovedEvent | McpServerNeedsReconnectEvent | 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 | IndexedSearchEvent | WarningEvent | ModelChangeEvent | ModelDeselectedEvent | AutoTierRecommendationEvent | AutoTierSwitchFailedEvent | ModeChangedEvent | ModeNoticeDeliveredEvent | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | ContextClearedEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | CompletionReceiptEvent | FusionRouteStartedEvent | FusionRouteFailedEvent | FusionResolvedEvent | FusionCompletedEvent | PermissionRecoveryEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantFusionPhaseStartedEvent | AssistantFusionPhaseActivityEvent | AssistantFusionPhaseCompletedEvent | AssistantFusionPhaseFailedEvent | AssistantServerToolProgressEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | ModelCallFinishedEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | ToolSearchActivatedEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentConfiguredEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | PermissionCarriedForwardEvent | PermissionMessageAuthorizationEvent | PermissionMessageAuthorizationReadEvent | PermissionMessageAuthorizationDegradedEvent | PermissionAssentDetectedEvent | PermissionContextualAuthorizationEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | UIEphemeralQueryEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | AutoModeResolvedEvent | ManagedSettingsResolvedEvent | ManagedSettingsEnforcedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | FactoryRunUpdatedEvent | FactoryRunStartedEvent | FactoryRunSettledEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | McpServerRemovedEvent | McpServerNeedsReconnectEvent | McpToolsListChangedEvent | McpResourcesListChangedEvent | McpPromptsListChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
 /**
  * Routing preference used when the session model is `auto`. `fast` is an integrator-only latency preset and is not a first-party GitHub Copilot product preference.
  */
@@ -299,6 +299,12 @@ export type ModelChangeSource =
  | "changeboarding_shortcut"
 /** An SDK or RPC caller selected the model. */
  | "sdk";
+/**
+ * Why the session no longer has an explicitly selected model.
+ */
+export type ModelDeselectedReason = 
+/** A host-managed provider snapshot no longer publishes the selected model. */
+"provider_withdrawn";
 /**
  * Auto preferences that Copilot API can recommend.
  */
@@ -2102,6 +2108,46 @@ export interface ModelChangeData {
     source?: ModelChangeSource;
     verbosity?: Verbosity;
 }
+/**
+ * Session event "session.model_deselected". The model the user had explicitly selected is no longer available, because the host that published it withdrew it, so the session no longer has an explicit selection. The next turn resolves a default as though the user had never chosen a model. Clients should stop presenting the previous model as selected. This event is durable because resume rebuilds the selected model from the event log; without it a resumed session would restore a model its provider no longer serves. Reasoning effort, verbosity, and other session-level preferences are deliberately unchanged, because they belong to the session rather than to the model.
+ */
+export interface ModelDeselectedEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: ModelDeselectedData;
+    /**
+     * 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.model_deselected".
+     */
+    type: "session.model_deselected";
+}
+/**
+ * The model the user had explicitly selected is no longer available, because the host that published it withdrew it, so the session no longer has an explicit selection. The next turn resolves a default as though the user had never chosen a model. Clients should stop presenting the previous model as selected. This event is durable because resume rebuilds the selected model from the event log; without it a resumed session would restore a model its provider no longer serves. Reasoning effort, verbosity, and other session-level preferences are deliberately unchanged, because they belong to the session rather than to the model.
+ */
+export interface ModelDeselectedData {
+    /**
+     * Model that was selected before the host withdrew it.
+     */
+    previousModel: string;
+    reason: ModelDeselectedReason;
+}
 /**
  * Session event "session.auto_tier_recommendation". Live-only Auto preference recommendation from Copilot API after a successful Auto model call.
  */
@@ -3657,6 +3703,12 @@ export interface FusionResolvedData {
      * Stable identifier for the resolved HydraFusion turn.
      */
     fusionId: string;
+    /**
+     * Short human-readable summary of the selected workflow, suitable for immediate client display after routing. May be absent in older durable events; omit the explanation or derive one from pattern and phasePlan. Display text, not a stable machine-readable value.
+     *
+     * @experimental
+     */
+    hint?: string;
     /**
      * Version of the executable model universe used for selection.
      */
@@ -6196,6 +6248,10 @@ export interface ToolExecutionStartData {
      * Name of the tool being executed
      */
     toolName: string;
+    /**
+     * Human-readable display title for the tool, when the selected tool descriptor has a non-empty title.
+     */
+    toolTitle?: string;
     /**
      * Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event
      */
@@ -7719,6 +7775,10 @@ export interface SystemMessageData {
      * The system or developer prompt text sent as model input
      */
     content: string;
+    /**
+     * Optional ordered structured blocks corresponding to content, retained for prompt-cache layout restoration.
+     */
+    contentBlocks?: SystemMessageContentBlock[];
     /**
      * Logical interaction identifier for the model run receiving this prompt
      */
@@ -7730,12 +7790,29 @@ export interface SystemMessageData {
     name?: string;
     role: SystemMessageRole;
 }
+/**
+ * One persisted structured system-message block and its cache intent
+ */
+export interface SystemMessageContentBlock {
+    /**
+     * Explicit prompt-cache intent. True places a breakpoint after this block, false suppresses one, and absence preserves the provider's legacy default.
+     */
+    cacheBreakpoint?: boolean;
+    /**
+     * Text content for this system-message block.
+     */
+    content: string;
+    /**
+     * Diagnostic classification indicating whether the block is stable across equivalent sessions.
+     */
+    isStatic?: boolean;
+}
 /**
  * Metadata about the prompt template and its construction
  */
 export interface SystemMessageMetadata {
     /**
-     * Version identifier of the prompt template used
+     * Version identifier of the prompt template or structured prompt layout used
      */
     promptVersion?: string;
     /**

package/dist/index.d.ts

@@ -8,8 +8,10 @@ export { DisableBypassPermissionsModes, RuntimeConnection } from "./types.js";
 export { BuiltInTools, ToolSet } from "./toolSet.js";
 export { CopilotSession, type AssistantMessageEvent } from "./session.js";
 export { defineFactory, FactoryResumeError, isFactoryRunTerminal } from "./factory.js";
+export { defineWorkflow, WorkflowResumeError, isWorkflowRunTerminal } from "./workflow.js";
 export { Canvas, CanvasError, createCanvas, type CanvasAction, type CanvasDeclaration, type CanvasHostContext, type CanvasHostContextCapabilities, type CanvasJsonSchema, type CanvasOptions, } from "./canvas.js";
 export { defineTool, approveAll, createAttributedPermissionResult, convertMcpCallToolResult, createSessionFsAdapter, CopilotRequestHandler, CopilotWebSocketHandler, CopilotWebSocketCloseStatus, CopilotWebSocketForwarder, SessionFsSqliteTransactionFailure, SYSTEM_MESSAGE_SECTIONS, } from "./types.js";
 export type * from "./generated/session-events.js";
 export type { AskUserVariant, CommandContext, CommandDefinition, CommandHandler, CanvasProviderIdentity, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, AgentStopHandler, AgentStopHookInput, AgentStopHookOutput, UserPromptTransformedHandler, UserPromptTransformedHookInput, UserPromptTransformedHookOutput, CopilotClientInfo, CopilotClientMode, CopilotClientOptions, CopilotExpAssignmentResponse, StdioRuntimeConnection, InProcessRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, ChildProcessRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExpConfigEntry, ExpFlagValue, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionLaunchProfile, ExtensionLaunchProvider, ExtensionLaunchProviderResolveRequest, ExtensionLaunchProviderResolveResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, GitHubMcpToolConfig, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, GitHubTokenAcquireReason, GitHubTokenAcquireResult, GitHubTokenProvider, GitHubTokenProviderArgs, GitHubTokenProviderResult, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, FactoryLimits, FactoryMeta, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, BearerTokenProvider, ExtensionContextAttachment, MessageOptions, ResponseSchema, MessageSource, ManagedSettings, ManagedSettingsPermissions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, AutoTier, CapiSessionOptions, CurrentModel, ModelSwitchAutoTierResult, ModelSwitchAutoTierStatus, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, NamedProviderConfig, PermissionHandler, PermissionRequest, PermissionRequestedData, PermissionRequestedEvent, PermissionRequestResult, AttributedPermissionResult, PermissionDecisionContext, PermissionDecisionOutcome, PermissionDecisionSource, PermissionDecisionSurface, PermissionResponseCapability, 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, FactoryLimitOverrides, FactoryResumeErrorCode, SessionFactoryApi, FactoryAgentOptions, FactoryContext, FactoryDefinition, FactoryHandle, FactoryJsonSchema, JsonValue, FactoryPipelineStage, FactoryStepOptions, FactoryRunResult, FactoryRunStatus, FactoryRunSummary, FactoryListRunsOptions, FactoryRunsPage, FactoryRunDetail, FactoryProgressPage, FactoryProgressLine, FactoryPhaseObservation, FactoryPhaseStatus, FactoryAgentSummary, } from "./factory.js";
+export type { WorkflowRunOptions, WorkflowResumeOptions, WorkflowLimitOverrides, WorkflowResumeErrorCode, SessionWorkflowApi, WorkflowAgentOptions, WorkflowContext, WorkflowDefinition, WorkflowHandle, WorkflowJsonSchema, WorkflowLimits, WorkflowMeta, WorkflowPipelineStage, WorkflowStepOptions, WorkflowRunResult, WorkflowRunStatus, WorkflowRunSummary, WorkflowListRunsOptions, WorkflowRunsPage, WorkflowRunDetail, WorkflowProgressPage, WorkflowProgressLine, WorkflowPhaseObservation, WorkflowPhaseStatus, WorkflowAgentSummary, } from "./workflow.js";

package/dist/index.js

@@ -3,6 +3,7 @@ import { DisableBypassPermissionsModes, RuntimeConnection } from "./types.js";
 import { BuiltInTools, ToolSet } from "./toolSet.js";
 import { CopilotSession } from "./session.js";
 import { defineFactory, FactoryResumeError, isFactoryRunTerminal } from "./factory.js";
+import { defineWorkflow, WorkflowResumeError, isWorkflowRunTerminal } from "./workflow.js";
 import {
   Canvas,
   CanvasError,
@@ -37,6 +38,7 @@ export {
   SYSTEM_MESSAGE_SECTIONS,
   SessionFsSqliteTransactionFailure,
   ToolSet,
+  WorkflowResumeError,
   approveAll,
   convertMcpCallToolResult,
   createAttributedPermissionResult,
@@ -44,5 +46,7 @@ export {
   createSessionFsAdapter,
   defineFactory,
   defineTool,
-  isFactoryRunTerminal
+  defineWorkflow,
+  isFactoryRunTerminal,
+  isWorkflowRunTerminal
 };

package/dist/session.d.ts

@@ -3,6 +3,7 @@ import type { ModelSwitchAutoTierResult } from "./generated/rpc.js";
 import type { OpenCanvasInstance } from "./generated/rpc.js";
 import type { MessageOptions, ResponseSchema, ContextTier, ReasoningEffort, ReasoningSummary, AutoTier, ModelCapabilitiesOverride, SessionCapabilities, SessionEvent, SessionEventHandler, SessionEventType, SessionUiApi, TypedSessionEventHandler } from "./types.js";
 import { type SessionFactoryApi } from "./factory.js";
+import { type SessionWorkflowApi } from "./workflow.js";
 /** Assistant message event - the final response from the assistant. */
 export type AssistantMessageEvent = Extract<SessionEvent, {
     type: "assistant.message";
@@ -50,6 +51,8 @@ export declare class CopilotSession {
     private commandHandlers;
     private factories;
     private factoryAbortControllers;
+    private workflows;
+    private workflowAbortControllers;
     private permissionHandler?;
     private mcpAuthHandler?;
     private userInputHandler?;
@@ -75,6 +78,7 @@ export declare class CopilotSession {
      * change or be removed in future SDK or CLI releases.
      */
     readonly factory: SessionFactoryApi;
+    readonly workflow: SessionWorkflowApi;
     /**
      * Resolve a start/resume envelope into the terminal envelope callers expect.
      *
@@ -94,6 +98,18 @@ export declare class CopilotSession {
      * dropped invalidation from leaving the wait pending forever.
      */
     private waitForFactoryRun;
+    private settleWorkflowRun;
+    /**
+     * Resolve when a workflow run reaches a terminal status.
+     *
+     * The subscription is installed *before* the first read so a transition
+     * landing between the two cannot be missed, and re-reads are serialized so
+     * overlapping invalidation events cannot interleave — the run's revision
+     * advances once per operation, so a burst of events is common and must
+     * collapse into a single in-flight read. A bounded periodic re-read keeps a
+     * dropped invalidation from leaving the wait pending forever.
+     */
+    private waitForWorkflowRun;
     /**
      * Typed session-scoped RPC methods.
      */