@github/copilot-sdk 1.0.0 → 1.0.1

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 | 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 | CanvasClosedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
 /**
  * Hosting platform type of the repository (github or ado)
  */
@@ -562,6 +562,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 +699,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 +729,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 +810,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 +827,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 +838,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
@@ -1457,6 +1473,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
      */
@@ -2467,6 +2487,10 @@ export interface AssistantMessageData {
      * @experimental
      */
     anthropicAdvisorModel?: string;
+    /**
+     * Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances.
+     */
+    apiCallId?: string;
     /**
      * The assistant's text response content
      */
@@ -3630,7 +3654,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 +3776,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 +3985,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 +4032,10 @@ 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 "system.message". System/developer instruction content with role and optional template metadata
@@ -6699,6 +6731,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/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;

package/dist/session.js

@@ -253,6 +253,8 @@ class CopilotSession {
       this._capabilities = { ...this._capabilities, ...event.data };
     } else if (event.type === "session.canvas.opened") {
       this.upsertOpenCanvasFromEvent(event.data);
+    } else if (event.type === "session.canvas.closed") {
+      this.removeOpenCanvasFromEvent(event.data);
     }
   }
   upsertOpenCanvasFromEvent(data) {
@@ -262,6 +264,18 @@ class CopilotSession {
     }
     this.upsertOpenCanvas(data);
   }
+  removeOpenCanvasFromEvent(data) {
+    if (!data || typeof data !== "object" || typeof data.instanceId !== "string" || data.instanceId.length === 0) {
+      console.warn("failed to deserialize session.canvas.closed payload");
+      return;
+    }
+    this.removeOpenCanvas(data.instanceId);
+  }
+  removeOpenCanvas(instanceId) {
+    this.openCanvasInstances = this.openCanvasInstances.filter(
+      (open) => open.instanceId !== instanceId
+    );
+  }
   upsertOpenCanvas(instance) {
     const index = this.openCanvasInstances.findIndex(
       (open) => open.instanceId === instance.instanceId
@@ -553,8 +567,8 @@ class CopilotSession {
   /**
    * 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() {
     return [...this.openCanvasInstances];

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
   "main": "./dist/cjs/index.js",
   "types": "./dist/index.d.ts",
@@ -56,7 +56,7 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@github/copilot": "^1.0.57",
+    "@github/copilot": "^1.0.61",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"
   },
@@ -79,7 +79,7 @@
     "vitest": "^4.0.18"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": "^20.19.0 || >=22.12.0"
   },
   "files": [
     "dist/**/*",