@github/copilot-sdk 0.1.31-unstable.0 → 0.1.31

package/README.md

@@ -52,10 +52,17 @@ await session.send({ prompt: "What is 2+2?" });
 await done;
 
 // Clean up
-await session.destroy();
+await session.disconnect();
 await client.stop();
 ```
 
+Sessions also support `Symbol.asyncDispose` for use with [`await using`](https://github.com/tc39/proposal-explicit-resource-management) (TypeScript 5.2+/Node.js 18.0+):
+
+```typescript
+await using session = await client.createSession({ model: "gpt-5" });
+// session is automatically disconnected when leaving scope
+```
+
 ## API Reference
 
 ### CopilotClient
@@ -265,9 +272,13 @@ Abort the currently processing message in this session.
 
 Get all events/messages from this session.
 
-##### `destroy(): Promise<void>`
+##### `disconnect(): Promise<void>`
+
+Disconnect the session and free resources. Session data on disk is preserved for later resumption.
+
+##### `destroy(): Promise<void>` *(deprecated)*
 
-Destroy the session and free resources.
+Deprecated — use `disconnect()` instead.
 
 ---
 

package/dist/client.d.ts

@@ -74,10 +74,14 @@ export declare class CopilotClient {
      * Stops the CLI server and closes all active sessions.
      *
      * This method performs graceful cleanup:
-     * 1. Destroys all active sessions with retry logic
+     * 1. Closes all active sessions (releases in-memory resources)
      * 2. Closes the JSON-RPC connection
      * 3. Terminates the CLI server process (if spawned by this client)
      *
+     * Note: session data on disk is preserved, so sessions can be resumed later.
+     * To permanently remove session data before stopping, call
+     * {@link deleteSession} for each session first.
+     *
      * @returns A promise that resolves with an array of errors encountered during cleanup.
      *          An empty array indicates all cleanup succeeded.
      *
@@ -242,10 +246,12 @@ export declare class CopilotClient {
      */
     getLastSessionId(): Promise<string | undefined>;
     /**
-     * Deletes a session and its data from disk.
+     * Permanently deletes a session and all its data from disk, including
+     * conversation history, planning state, and artifacts.
      *
-     * This permanently removes the session and all its conversation history.
-     * The session cannot be resumed after deletion.
+     * Unlike {@link CopilotSession.disconnect}, which only releases in-memory
+     * resources and preserves session data for later resumption, this method
+     * is irreversible. The session cannot be resumed after deletion.
      *
      * @param sessionId - The ID of the session to delete
      * @returns A promise that resolves when the session is deleted

package/dist/client.js

@@ -188,10 +188,14 @@ class CopilotClient {
    * Stops the CLI server and closes all active sessions.
    *
    * This method performs graceful cleanup:
-   * 1. Destroys all active sessions with retry logic
+   * 1. Closes all active sessions (releases in-memory resources)
    * 2. Closes the JSON-RPC connection
    * 3. Terminates the CLI server process (if spawned by this client)
    *
+   * Note: session data on disk is preserved, so sessions can be resumed later.
+   * To permanently remove session data before stopping, call
+   * {@link deleteSession} for each session first.
+   *
    * @returns A promise that resolves with an array of errors encountered during cleanup.
    *          An empty array indicates all cleanup succeeded.
    *
@@ -210,7 +214,7 @@ class CopilotClient {
       let lastError = null;
       for (let attempt = 1; attempt <= 3; attempt++) {
         try {
-          await session.destroy();
+          await session.disconnect();
           lastError = null;
           break;
         } catch (error) {
@@ -224,7 +228,7 @@ class CopilotClient {
       if (lastError) {
         errors.push(
           new Error(
-            `Failed to destroy session ${sessionId} after 3 attempts: ${lastError.message}`
+            `Failed to disconnect session ${sessionId} after 3 attempts: ${lastError.message}`
           )
         );
       }
@@ -625,10 +629,12 @@ class CopilotClient {
     return response.sessionId;
   }
   /**
-   * Deletes a session and its data from disk.
+   * Permanently deletes a session and all its data from disk, including
+   * conversation history, planning state, and artifacts.
    *
-   * This permanently removes the session and all its conversation history.
-   * The session cannot be resumed after deletion.
+   * Unlike {@link CopilotSession.disconnect}, which only releases in-memory
+   * resources and preserves session data for later resumption, this method
+   * is irreversible. The session cannot be resumed after deletion.
    *
    * @param sessionId - The ID of the session to delete
    * @returns A promise that resolves when the session is deleted

package/dist/generated/rpc.d.ts

@@ -407,7 +407,14 @@ export interface SessionToolsHandlePendingToolCallParams {
      */
     sessionId: string;
     requestId: string;
-    result?: string;
+    result?: string | {
+        textResultForLlm: string;
+        resultType?: string;
+        error?: string;
+        toolTelemetry?: {
+            [k: string]: unknown;
+        };
+    };
     error?: string;
 }
 export interface SessionPermissionsHandlePendingPermissionRequestResult {
@@ -420,8 +427,19 @@ export interface SessionPermissionsHandlePendingPermissionRequestParams {
     sessionId: string;
     requestId: string;
     result: {
-        kind: "approved" | "denied-by-rules" | "denied-no-approval-rule-and-could-not-request-from-user" | "denied-interactively-by-user";
-        rules?: unknown[];
+        kind: "approved";
+    } | {
+        kind: "denied-by-rules";
+        rules: unknown[];
+    } | {
+        kind: "denied-no-approval-rule-and-could-not-request-from-user";
+    } | {
+        kind: "denied-interactively-by-user";
+        feedback?: string;
+    } | {
+        kind: "denied-by-content-exclusion-policy";
+        path: string;
+        message: string;
     };
 }
 /** Create typed server-scoped RPC methods (no session required). */

package/dist/session.d.ts

@@ -31,7 +31,7 @@ export type AssistantMessageEvent = Extract<SessionEvent, {
  * await session.sendAndWait({ prompt: "Hello, world!" });
  *
  * // Clean up
- * await session.destroy();
+ * await session.disconnect();
  * ```
  */
 export declare class CopilotSession {
@@ -72,7 +72,7 @@ export declare class CopilotSession {
      *
      * @param options - The message options including the prompt and optional attachments
      * @returns A promise that resolves with the message ID of the response
-     * @throws Error if the session has been destroyed or the connection fails
+     * @throws Error if the session has been disconnected or the connection fails
      *
      * @example
      * ```typescript
@@ -97,7 +97,7 @@ export declare class CopilotSession {
      * @returns A promise that resolves with the final assistant message when the session becomes idle,
      *          or undefined if no assistant message was received
      * @throws Error if the timeout is reached before the session becomes idle
-     * @throws Error if the session has been destroyed or the connection fails
+     * @throws Error if the session has been disconnected or the connection fails
      *
      * @example
      * ```typescript
@@ -250,7 +250,7 @@ export declare class CopilotSession {
      * assistant responses, tool executions, and other session events.
      *
      * @returns A promise that resolves with an array of all session events
-     * @throws Error if the session has been destroyed or the connection fails
+     * @throws Error if the session has been disconnected or the connection fails
      *
      * @example
      * ```typescript
@@ -264,22 +264,39 @@ export declare class CopilotSession {
      */
     getMessages(): Promise<SessionEvent[]>;
     /**
-     * Destroys this session and releases all associated resources.
+     * Disconnects this session and releases all in-memory resources (event handlers,
+     * tool handlers, permission handlers).
      *
-     * After calling this method, the session can no longer be used. All event
-     * handlers and tool handlers are cleared. To continue the conversation,
-     * use {@link CopilotClient.resumeSession} with the session ID.
+     * Session state on disk (conversation history, planning state, artifacts) is
+     * preserved, so the conversation can be resumed later by calling
+     * {@link CopilotClient.resumeSession} with the session ID. To permanently
+     * remove all session data including files on disk, use
+     * {@link CopilotClient.deleteSession} instead.
      *
-     * @returns A promise that resolves when the session is destroyed
+     * After calling this method, the session object can no longer be used.
+     *
+     * @returns A promise that resolves when the session is disconnected
      * @throws Error if the connection fails
      *
      * @example
      * ```typescript
-     * // Clean up when done
-     * await session.destroy();
+     * // Clean up when done — session can still be resumed later
+     * await session.disconnect();
      * ```
      */
+    disconnect(): Promise<void>;
+    /**
+     * @deprecated Use {@link disconnect} instead. This method will be removed in a future release.
+     *
+     * Disconnects this session and releases all in-memory resources.
+     * Session data on disk is preserved for later resumption.
+     *
+     * @returns A promise that resolves when the session is disconnected
+     * @throws Error if the connection fails
+     */
     destroy(): Promise<void>;
+    /** Enables `await using session = ...` syntax for automatic cleanup. */
+    [Symbol.asyncDispose](): Promise<void>;
     /**
      * Aborts the currently processing message in this session.
      *
@@ -287,7 +304,7 @@ export declare class CopilotSession {
      * and can continue to be used for new messages.
      *
      * @returns A promise that resolves when the abort request is acknowledged
-     * @throws Error if the session has been destroyed or the connection fails
+     * @throws Error if the session has been disconnected or the connection fails
      *
      * @example
      * ```typescript

package/dist/session.js

@@ -1,3 +1,4 @@
+import { ConnectionError, ResponseError } from "vscode-jsonrpc/node";
 import { createSessionRpc } from "./generated/rpc.js";
 class CopilotSession {
   /**
@@ -45,7 +46,7 @@ class CopilotSession {
    *
    * @param options - The message options including the prompt and optional attachments
    * @returns A promise that resolves with the message ID of the response
-   * @throws Error if the session has been destroyed or the connection fails
+   * @throws Error if the session has been disconnected or the connection fails
    *
    * @example
    * ```typescript
@@ -78,7 +79,7 @@ class CopilotSession {
    * @returns A promise that resolves with the final assistant message when the session becomes idle,
    *          or undefined if no assistant message was received
    * @throws Error if the timeout is reached before the session becomes idle
-   * @throws Error if the session has been destroyed or the connection fails
+   * @throws Error if the session has been disconnected or the connection fails
    *
    * @example
    * ```typescript
@@ -220,7 +221,13 @@ class CopilotSession {
       await this.rpc.tools.handlePendingToolCall({ requestId, result });
     } catch (error) {
       const message = error instanceof Error ? error.message : String(error);
-      await this.rpc.tools.handlePendingToolCall({ requestId, error: message });
+      try {
+        await this.rpc.tools.handlePendingToolCall({ requestId, error: message });
+      } catch (rpcError) {
+        if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {
+          throw rpcError;
+        }
+      }
     }
   }
   /**
@@ -234,12 +241,18 @@ class CopilotSession {
       });
       await this.rpc.permissions.handlePendingPermissionRequest({ requestId, result });
     } catch (_error) {
-      await this.rpc.permissions.handlePendingPermissionRequest({
-        requestId,
-        result: {
-          kind: "denied-no-approval-rule-and-could-not-request-from-user"
+      try {
+        await this.rpc.permissions.handlePendingPermissionRequest({
+          requestId,
+          result: {
+            kind: "denied-no-approval-rule-and-could-not-request-from-user"
+          }
+        });
+      } catch (rpcError) {
+        if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {
+          throw rpcError;
         }
-      });
+      }
     }
   }
   /**
@@ -364,7 +377,7 @@ class CopilotSession {
    * assistant responses, tool executions, and other session events.
    *
    * @returns A promise that resolves with an array of all session events
-   * @throws Error if the session has been destroyed or the connection fails
+   * @throws Error if the session has been disconnected or the connection fails
    *
    * @example
    * ```typescript
@@ -383,22 +396,27 @@ class CopilotSession {
     return response.events;
   }
   /**
-   * Destroys this session and releases all associated resources.
+   * Disconnects this session and releases all in-memory resources (event handlers,
+   * tool handlers, permission handlers).
    *
-   * After calling this method, the session can no longer be used. All event
-   * handlers and tool handlers are cleared. To continue the conversation,
-   * use {@link CopilotClient.resumeSession} with the session ID.
+   * Session state on disk (conversation history, planning state, artifacts) is
+   * preserved, so the conversation can be resumed later by calling
+   * {@link CopilotClient.resumeSession} with the session ID. To permanently
+   * remove all session data including files on disk, use
+   * {@link CopilotClient.deleteSession} instead.
    *
-   * @returns A promise that resolves when the session is destroyed
+   * After calling this method, the session object can no longer be used.
+   *
+   * @returns A promise that resolves when the session is disconnected
    * @throws Error if the connection fails
    *
    * @example
    * ```typescript
-   * // Clean up when done
-   * await session.destroy();
+   * // Clean up when done — session can still be resumed later
+   * await session.disconnect();
    * ```
    */
-  async destroy() {
+  async disconnect() {
     await this.connection.sendRequest("session.destroy", {
       sessionId: this.sessionId
     });
@@ -407,6 +425,22 @@ class CopilotSession {
     this.toolHandlers.clear();
     this.permissionHandler = void 0;
   }
+  /**
+   * @deprecated Use {@link disconnect} instead. This method will be removed in a future release.
+   *
+   * Disconnects this session and releases all in-memory resources.
+   * Session data on disk is preserved for later resumption.
+   *
+   * @returns A promise that resolves when the session is disconnected
+   * @throws Error if the connection fails
+   */
+  async destroy() {
+    return this.disconnect();
+  }
+  /** Enables `await using session = ...` syntax for automatic cleanup. */
+  async [Symbol.asyncDispose]() {
+    return this.disconnect();
+  }
   /**
    * Aborts the currently processing message in this session.
    *
@@ -414,7 +448,7 @@ class CopilotSession {
    * and can continue to be used for new messages.
    *
    * @returns A promise that resolves when the abort request is acknowledged
-   * @throws Error if the session has been destroyed or the connection fails
+   * @throws Error if the session has been disconnected or the connection fails
    *
    * @example
    * ```typescript

package/dist/types.d.ts

@@ -185,10 +185,8 @@ export interface PermissionRequest {
     toolCallId?: string;
     [key: string]: unknown;
 }
-export interface PermissionRequestResult {
-    kind: "approved" | "denied-by-rules" | "denied-no-approval-rule-and-could-not-request-from-user" | "denied-interactively-by-user";
-    rules?: unknown[];
-}
+import type { SessionPermissionsHandlePendingPermissionRequestParams } from "./generated/rpc.js";
+export type PermissionRequestResult = SessionPermissionsHandlePendingPermissionRequestParams["result"];
 export type PermissionHandler = (request: PermissionRequest, invocation: {
     sessionId: string;
 }) => Promise<PermissionRequestResult> | PermissionRequestResult;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "0.1.31-unstable.0",
+  "version": "0.1.31",
   "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -44,7 +44,7 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@github/copilot": "^0.0.421",
+    "@github/copilot": "^1.0.2",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"
   },