@github/copilot-sdk 1.0.29-preview.7 → 1.0.29-preview.9

package/README.md

@@ -286,7 +286,7 @@ new CopilotClient(options?: CopilotClientOptions)
     - `RuntimeConnection.forStdio({ path?, args?, env? })` (default) — spawn the runtime and communicate over its stdin/stdout.
     - `RuntimeConnection.forTcp({ port?, connectionToken?, path?, args?, env? })` — spawn the runtime as a TCP server.
     - `RuntimeConnection.forUri(url, { connectionToken? })` — connect to an already-running runtime (mutually exclusive with `gitHubToken`/`useLoggedInUser`). There is no top-level `cliUrl` shortcut; use this factory for URL-based connections.
-    - `RuntimeConnection.forInProcess()` — host the runtime in-process over its native C ABI (FFI). **Experimental.** Because the runtime shares this process, `env`, `telemetry`, and `workingDirectory` are rejected with this transport; set them on the host process instead.
+    - `RuntimeConnection.forInProcess()` — host the runtime in-process over its native C ABI (FFI). **Experimental.** Client-level `env`, `telemetry`, and `workingDirectory` are rejected; use supported typed options and configure working directories per session.
     - The child-process transports (`forStdio`/`forTcp`) also accept a per-connection `env`. Set it there or via the top-level `env` option — not both (setting both throws).
     - Managed child-process connections materialize the bundled `copilot-runtime` and adjacent `runtime.node`, then launch the wrapper by default. An explicit connection `path` or `COPILOT_CLI_PATH` overrides the bundled runtime.
 - `mode?: "empty" | "copilot-cli"` - Defaulting strategy. Use `"empty"` for multi-user server mode; defaults to `"copilot-cli"`.
@@ -421,6 +421,20 @@ Create a new conversation session.
 - `hooks?: SessionHooks` - Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section.
 - `skillProvider?: SkillProvider` - **Experimental.** Serves skills from host storage instead of skill directories. Not persisted; pass it again on resume. See [Skill providers](#skill-providers-experimental).
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+declare function acquireTokenForHost(host: string): Promise<string>;
+
+const session = await client.createSession({
+    gitHubTokenProvider: async ({ host }) => ({
+        kind: "token",
+        accessToken: await acquireTokenForHost(host),
+        expiresIn: 8 * 60 * 60,
+    }),
+});
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 const session = await client.createSession({
     gitHubTokenProvider: async ({ host }) => ({
@@ -495,6 +509,7 @@ Request the TUI to switch to displaying the specified session. Only available in
 
 Subscribe to a specific session lifecycle event type. Returns an unsubscribe function.
 
+<!-- docs-validate: strict -->
 ```typescript
 const unsubscribe = client.onLifecycle("session.foreground", (event) => {
     console.log(`Session ${event.sessionId} is now in foreground`);
@@ -505,6 +520,7 @@ const unsubscribe = client.onLifecycle("session.foreground", (event) => {
 
 Subscribe to all session lifecycle events. Returns an unsubscribe function.
 
+<!-- docs-validate: strict -->
 ```typescript
 const unsubscribe = client.onLifecycle((event) => {
     console.log(`${event.type}: ${event.sessionId}`);
@@ -552,12 +568,32 @@ Returns the message ID.
 
 Use `source: "system"` for automated messages from your application:
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+await session.send({ prompt: "Context updated", source: "system" });
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 await session.send({ prompt: "Context updated", source: "system" });
 ```
 
 For a message from another agent, use its trusted sender ID:
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+await session.send({ prompt: "Review complete", source: "agent-reviewer-id" });
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 await session.send({ prompt: "Review complete", source: "agent-reviewer-id" });
 ```
@@ -590,6 +626,23 @@ Pass a raw JSON Schema or a Zod schema as `responseSchema` to `send` or
 `sendAndWait`. As with custom tool parameters, the SDK converts Zod schemas to
 JSON Schema before sending them:
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+import { z } from "zod";
+
+const answerSchema = z.object({ answer: z.number().int() });
+const message = await session.sendAndWait({
+    prompt: "What is 19 + 23?",
+    responseSchema: answerSchema,
+});
+console.log(message?.data.content); // JSON text
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 import { z } from "zod";
 
@@ -603,6 +656,20 @@ console.log(message?.data.content); // JSON text
 
 For a typed result, pass the Zod schema as the **second argument** instead:
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+import { z } from "zod";
+
+const answerSchema = z.object({ answer: z.number().int() });
+
+const answer = await session.sendAndWait("What is 19 + 23?", answerSchema);
+console.log(answer.answer); // number; TResult is inferred from answerSchema
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 const answer = await session.sendAndWait("What is 19 + 23?", answerSchema);
 console.log(answer.answer); // number; TResult is inferred from answerSchema
@@ -675,6 +742,28 @@ native `output_config.format` endpoint.
 
 Subscribe to a specific event type. The handler receives properly typed events.
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+// Listen for specific event types with full type inference
+session.on("assistant.message", (event) => {
+    console.log(event.data.content); // TypeScript knows about event.data.content
+});
+
+session.on("session.idle", () => {
+    console.log("Session is idle");
+});
+
+// Listen to streaming events
+session.on("assistant.message_delta", (event) => {
+    process.stdout.write(event.data.deltaContent);
+});
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 // Listen for specific event types with full type inference
 session.on("assistant.message", (event) => {
@@ -695,6 +784,22 @@ session.on("assistant.message_delta", (event) => {
 
 Subscribe to all session events. Returns an unsubscribe function.
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+const unsubscribe = session.on((event) => {
+    // Handle any event type
+    console.log(event.type, event);
+});
+
+// Later...
+unsubscribe();
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 const unsubscribe = session.on((event) => {
     // Handle any event type
@@ -722,6 +827,19 @@ The runtime does not apply the preference immediately. It records the request an
 
 Watch for the outcome through the `session.model_change` event on success or the ephemeral `session.auto_tier_switch_failed` event on failure. A failed activation leaves the incumbent effective tier unchanged. Read the authoritative state at any time with `session.rpc.model.getCurrent()`.
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+const result = await session.setAutoTier("intelligence");
+if (result.status === "pending") {
+    // Accepted, but not yet in effect.
+}
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 const result = await session.setAutoTier("intelligence");
 if (result.status === "pending") {
@@ -735,6 +853,23 @@ See [Auto tier persistence](../docs/features/session-persistence.md#auto-tier-pe
 
 Read the current model's reasoning-summary presentation policy without changing session state. Call `session.rpc.model.list()` first to load the model catalog; otherwise the result may have `ready: false`. The request and result types are exported from `@github/copilot-sdk`.
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+import type {
+    ModelGetReasoningSummariesRequest,
+    ModelGetReasoningSummariesResult,
+} from "@github/copilot-sdk";
+
+const presentation: ModelGetReasoningSummariesRequest = { summariesVisible: false };
+const policy: ModelGetReasoningSummariesResult =
+    await session.rpc.model.getReasoningSummaries(presentation);
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 import type {
     ModelGetReasoningSummariesRequest,
@@ -754,6 +889,26 @@ Replace the tools this client supplies to the session, together with the handler
 
 Once the runtime accepts the replacement, every tool call this session dispatches uses the new handlers; calls already running finish on their original handlers. If the runtime rejects it, the promise rejects and the previous tools and handlers stay in place. Concurrent calls are applied one at a time, in call order.
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+import { defineTool } from "@github/copilot-sdk";
+import { z } from "zod";
+
+declare function searchIssues(query: string): Promise<string>;
+
+await session.setTools([
+    defineTool("search_issues", {
+        description: "Search the issues shown on the current page",
+        parameters: z.object({ query: z.string() }),
+        handler: async ({ query }) => searchIssues(query),
+    }),
+]);
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 await session.setTools([
     defineTool("search_issues", {
@@ -782,6 +937,18 @@ Disconnect the session and free resources. Session data on disk is preserved for
 
 Host capabilities reported when the session was created or resumed. Use this to check feature support before calling capability-gated APIs.
 
+<!-- docs-validate: strict -->
+<!-- docs-validate: hidden -->
+```typescript
+import type { CopilotSession } from "@github/copilot-sdk";
+
+declare const session: CopilotSession;
+
+if (session.capabilities.ui?.elicitation) {
+    const ok = await session.ui.confirm("Deploy?");
+}
+```
+<!-- /docs-validate: hidden -->
 ```typescript
 if (session.capabilities.ui?.elicitation) {
     const ok = await session.ui.confirm("Deploy?");
@@ -1427,7 +1594,7 @@ console.log(session.workspacePath);
 // => ~/.copilot/session-state/{sessionId}/
 
 // Custom thresholds
-const session = await client.createSession({
+const tuned = await client.createSession({
     model: "gpt-5",
     infiniteSessions: {
         enabled: true,
@@ -1437,7 +1604,7 @@ const session = await client.createSession({
 });
 
 // Disable infinite sessions
-const session = await client.createSession({
+const disabled = await client.createSession({
     model: "gpt-5",
     infiniteSessions: { enabled: false },
 });
@@ -1475,13 +1642,13 @@ const disabled = await client.createSession({
 <!-- /docs-validate: hidden -->
 ```typescript
 // Enable memory for a session
-const session = await client.createSession({
+const enabled = await client.createSession({
     model: "gpt-5",
     memory: { enabled: true },
 });
 
 // Disable memory for a session
-const session = await client.createSession({
+const disabled = await client.createSession({
     model: "gpt-5",
     memory: { enabled: false },
 });

package/dist/cjs/cliVersion.js

@@ -22,7 +22,7 @@ __export(cliVersion_exports, {
   COPILOT_CLI_VERSION: () => COPILOT_CLI_VERSION
 });
 module.exports = __toCommonJS(cliVersion_exports);
-const COPILOT_CLI_VERSION = "1.0.106-8";
+const COPILOT_CLI_VERSION = "1.0.106-10";
 const COPILOT_CLI_USE_NPM_PACKAGE = false;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/client.js

@@ -301,6 +301,10 @@ function getNodeExecPath() {
 function getBundledRuntimePath() {
   return (0, import_runtimeArtifacts.ensureRuntimeBundle)(import_cliVersion.COPILOT_CLI_VERSION);
 }
+async function getSpawnableBundledRuntimePath() {
+  const runtimePath = await getBundledRuntimePath();
+  return process.platform === "win32" ? import_node_path.win32.toNamespacedPath(runtimePath) : runtimePath;
+}
 class TeardownResilientStreamMessageWriter extends import_node.StreamMessageWriter {
   suppressWriteErrors = false;
   constructor(writable) {
@@ -466,19 +470,22 @@ class CopilotClient {
    */
   constructor(options = {}) {
     const conn = options._internalConnection ?? options.connection ?? CopilotClient.resolveDefaultConnection();
+    if ((conn.kind === "uri" || conn.kind === "parent-process") && options.internalTestOptions !== void 0) {
+      throw new Error("internalTestOptions requires a runtime owned by this client");
+    }
     if (conn.kind === "uri" && (options.gitHubToken !== void 0 || options.useLoggedInUser !== void 0)) {
       throw new Error(
         "gitHubToken and useLoggedInUser cannot be used with RuntimeConnection.forUri (external server manages its own auth)"
       );
     }
-    if (conn.kind === "inprocess" && options.workingDirectory !== void 0) {
+    if (conn.kind === "inprocess" && options.env !== void 0) {
       throw new Error(
-        "workingDirectory is not supported with RuntimeConnection.forInProcess(): the in-process transport hosts the runtime in this process, so honoring it would require mutating the shared process-global cwd. Change the host process's working directory before constructing the client instead."
+        "env is not supported with RuntimeConnection.forInProcess(): environment variables belong to the shared host process. Use typed client/session options or a child-process transport."
       );
     }
-    if (conn.kind === "inprocess" && options.env !== void 0) {
+    if (conn.kind === "inprocess" && options.workingDirectory !== void 0) {
       throw new Error(
-        "env is not supported with RuntimeConnection.forInProcess(): the in-process transport loads the native runtime into the shared host process, whose single environment block cannot carry per-client values. Set the variables on the host process environment instead."
+        "workingDirectory is not supported with RuntimeConnection.forInProcess(): the in-process transport hosts the runtime in this process, so honoring it would require mutating the shared process-global cwd. Set SessionConfig.workingDirectory instead."
       );
     }
     if (conn.kind === "inprocess" && options.telemetry !== void 0) {
@@ -544,6 +551,7 @@ class CopilotClient {
     const connArgs = conn.kind === "stdio" || conn.kind === "tcp" ? conn.args ?? [] : [];
     this.connectionExtraArgs = [...connArgs];
     this.options = {
+      internalTestOptions: options.internalTestOptions,
       entra: options.entra ? { ...options.entra, tokenProvider: options.entra.tokenProvider } : void 0,
       workingDirectory: options.workingDirectory ?? process.cwd(),
       logLevel: options.logLevel,
@@ -815,12 +823,17 @@ class CopilotClient {
    * Stops the CLI server and closes all active sessions.
    *
    * This method performs graceful cleanup:
-   * 1. Closes all active sessions (releases in-memory resources)
+   * 1. Closes all active sessions (releases in-memory resources); detach
+   *    requests share one shutdown timeout
    * 2. Requests runtime shutdown for SDK-owned CLI processes
    * 3. Closes the JSON-RPC connection
    * 4. Signals EOF to an owned stdio process and waits for host cleanup, then
    *    terminates the process if it does not exit within the shutdown timeout
    *
+   * In-process connections first abort active turns without a timeout. That
+   * step is outside the detach deadline, so in-process stop() can still wait
+   * indefinitely if the runtime stops answering abort requests.
+   *
    * 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.
@@ -842,16 +855,31 @@ class CopilotClient {
     if (this.connectionConfig.kind === "inprocess") {
       await Promise.allSettled(activeSessions.map((session) => session.abort()));
     }
+    let detachDeadlineTimer;
+    const detachDeadline = new Promise((resolve2) => {
+      detachDeadlineTimer = setTimeout(() => resolve2("timeout"), RUNTIME_SHUTDOWN_TIMEOUT_MS);
+    });
     for (const session of activeSessions) {
       const sessionId = session.sessionId;
       let lastError = null;
+      let attempts = 0;
       for (let attempt = 1; attempt <= 3; attempt++) {
         if (this.connectionClosed) {
           lastError = null;
           break;
         }
+        attempts = attempt;
         try {
-          await session.disconnect();
+          const outcome = await Promise.race([
+            session.disconnect().then(() => "disconnected"),
+            detachDeadline
+          ]);
+          if (outcome === "timeout") {
+            lastError = new Error(
+              `session.detach did not complete within the ${RUNTIME_SHUTDOWN_TIMEOUT_MS}ms shutdown timeout`
+            );
+            break;
+          }
           lastError = null;
           break;
         } catch (error) {
@@ -869,11 +897,12 @@ class CopilotClient {
       if (lastError) {
         errors.push(
           new Error(
-            `Failed to disconnect session ${sessionId} after 3 attempts: ${lastError.message}`
+            `Failed to disconnect session ${sessionId} after ${attempts} ${attempts === 1 ? "attempt" : "attempts"}: ${lastError.message}`
           )
         );
       }
     }
+    clearTimeout(detachDeadlineTimer);
     for (const session of activeSessions) {
       session._markDisconnected();
     }
@@ -1143,7 +1172,7 @@ class CopilotClient {
    * // Session with model and tools
    * const session = await client.createSession({
    *   onPermissionRequest: approveAll,
-   *   model: "gpt-4",
+   *   model: "gpt-5.4",
    *   tools: [{
    *     name: "get_weather",
    *     description: "Get weather for a location",
@@ -2408,15 +2437,40 @@ class CopilotClient {
     };
   }
   /**
-   * Builds the environment for the spawned runtime child process (stdio/TCP): applies
-   * the auth token, connection token, `COPILOT_HOME`, keychain setting, and telemetry
-   * variables on top of the effective env. Not used by the in-process (FFI) transport,
-   * whose worker inherits the host process's ambient environment
-   * (see {@link CopilotClient.startInProcessFfi}).
+   * Builds runtime configuration for child processes and the per-host FFI snapshot.
+   * Typed auth, home, keychain, and telemetry options override the effective env.
    */
   buildRuntimeEnv() {
-    const env = { ...this.resolvedEnv };
+    const env = process.platform === "win32" ? Object.fromEntries(
+      Object.entries(this.resolvedEnv).map(([key, value]) => [
+        key.toUpperCase(),
+        value
+      ])
+    ) : { ...this.resolvedEnv };
     delete env.NODE_DEBUG;
+    const test = this.options.internalTestOptions;
+    if (test) {
+      const overrides = {
+        COPILOT_API_URL: test.copilotApiUrl,
+        COPILOT_DEBUG_GITHUB_API_URL: test.githubApiUrl,
+        HTTP_PROXY: test.proxyUrl,
+        HTTPS_PROXY: test.proxyUrl,
+        http_proxy: test.proxyUrl,
+        https_proxy: test.proxyUrl,
+        NO_PROXY: test.noProxy,
+        no_proxy: test.noProxy,
+        NODE_EXTRA_CA_CERTS: test.caCertificatePath,
+        SSL_CERT_FILE: test.caCertificatePath,
+        REQUESTS_CA_BUNDLE: test.caCertificatePath,
+        CURL_CA_BUNDLE: test.caCertificatePath,
+        GIT_SSL_CAINFO: test.caCertificatePath
+      };
+      for (const [key, value] of Object.entries(overrides)) {
+        if (value !== void 0) {
+          env[process.platform === "win32" ? key.toUpperCase() : key] = value;
+        }
+      }
+    }
     if (this.options.gitHubToken) {
       env.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;
     }
@@ -2425,6 +2479,9 @@ class CopilotClient {
     }
     if (this.options.baseDirectory) {
       env.COPILOT_HOME = this.options.baseDirectory;
+      if (this.connectionConfig.kind === "inprocess") {
+        env.COPILOT_CACHE_HOME = (0, import_node_path.join)(this.options.baseDirectory, "cache");
+      }
     }
     if (this.options.mode === "empty") {
       env.COPILOT_DISABLE_KEYTAR = "1";
@@ -2451,7 +2508,7 @@ class CopilotClient {
    * Start the CLI server process
    */
   async startCLIServer() {
-    this.resolvedCliPath ??= await getBundledRuntimePath();
+    this.resolvedCliPath ??= await getSpawnableBundledRuntimePath();
     return new Promise((resolve2, reject) => {
       this.stderrBuffer = "";
       const args = [...this.connectionExtraArgs, "--headless", "--no-auto-update"];
@@ -2489,6 +2546,22 @@ class CopilotClient {
           `Copilot CLI not found at ${this.resolvedCliPath}. Set COPILOT_CLI_PATH to use a custom installation.`
         );
       }
+      const workingDirectory = this.options.workingDirectory;
+      let workingDirectoryProblem;
+      try {
+        workingDirectoryProblem = (0, import_node_fs.statSync)(workingDirectory).isDirectory() ? void 0 : "does not exist or is not a directory";
+        if (!workingDirectoryProblem) {
+          (0, import_node_fs.accessSync)(workingDirectory, import_node_fs.constants.X_OK);
+        }
+      } catch (error) {
+        const code = error.code;
+        workingDirectoryProblem = code === "ENOENT" || code === "ENOTDIR" ? "does not exist or is not a directory" : `cannot be entered: ${error instanceof Error ? error.message : String(error)}`;
+      }
+      if (workingDirectoryProblem) {
+        throw new Error(
+          `Working directory ${workingDirectory} ${workingDirectoryProblem}.`
+        );
+      }
       const stdioConfig = this.connectionConfig.kind === "stdio" ? ["pipe", "pipe", "pipe"] : ["ignore", "pipe", "pipe"];
       const isJsFile = this.resolvedCliPath.endsWith(".js");
       if (isJsFile) {
@@ -2640,16 +2713,7 @@ stderr: ${this.stderrBuffer.trim().slice(-8192) || "(empty)"}`
       runtimeLibrary = (0, import_node_path.join)((0, import_node_path.dirname)(bundledRuntimePath), "runtime.node");
     }
     const { FfiRuntimeHost } = await import("./ffiRuntimeHost.js");
-    const environment = {};
-    if (this.options.gitHubToken) {
-      environment.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;
-    }
-    if (this.options.baseDirectory) {
-      environment.COPILOT_HOME = this.options.baseDirectory;
-    }
-    if (this.options.mode === "empty") {
-      environment.COPILOT_DISABLE_KEYTAR = "1";
-    }
+    const environment = this.buildRuntimeEnv();
     const args = [];
     if (this.options.logLevel) {
       args.push("--log-level", this.options.logLevel);

package/dist/cjs/generated/rpc.js

@@ -2628,7 +2628,7 @@ function createSessionRpc(connection, sessionId) {
       /** @experimental */
       login: {
         /**
-         * Begin an interactive login flow for a provider kind (dispatch is kind-only) and return its opaque flow id and first step.
+         * Begin an interactive login flow for a provider kind, optionally selecting how to authorize (`method`: `web` by default, or `device-code`), and return its opaque flow id and first step.
          *
          * @param params Begin an interactive login flow for a provider kind, optionally reusing a cached base identity or explicitly requesting provider account selection.
          *
@@ -2640,7 +2640,7 @@ function createSessionRpc(connection, sessionId) {
          *
          * @param params Advance an in-flight login flow, optionally fulfilling an input-required step.
          *
-         * @returns One step in an interactive login flow. The consumer acts on the step and calls advance to proceed. Browser-open is encoded as two distinct steps by design: `open-url` is CONSUMER-driven (the provider surfaces the authorize URL and the consumer opens it — github.com/GHEC web), while `needs-interaction` is PROVIDER-driven (the provider opens the browser or broker UI itself and does not surface a URL — Entra).
+         * @returns One step in an interactive login flow. The consumer acts on the step and calls advance to proceed. Browser-open is encoded as two distinct steps by design: `open-url` is CONSUMER-driven (the provider surfaces the authorize URL and the consumer opens it — github.com/GHEC web), while `needs-interaction` is PROVIDER-driven (the provider opens the browser or broker UI itself and does not surface a URL — Entra). A device-code flow surfaces its one-time code as `device-code`; the consumer shows the code, may open the verification URI, and calls advance, which resolves once the user has authorized the device.
          */
         advance: async (params) => connection.sendRequest("session.accounts.login.advance", { ...params, sessionId }),
         /**
@@ -4500,6 +4500,12 @@ function createSessionRpc(connection, sessionId) {
        * @returns Indicates whether an in-progress background compaction was cancelled.
        */
       cancelBackgroundCompaction: async () => connection.sendRequest("session.history.cancelBackgroundCompaction", { sessionId }),
+      /**
+       * Replaces this local session's compaction settings: the model, prompt and reasoning effort its automatic and manual compactions use. Each call replaces all three: an omitted field returns to its default. Settings are held in memory only, so re-apply them after resuming the session in a new process. A change applies to compactions that start afterwards, except that automatic compactions keep the model the running turn already chose for them until that turn ends; a compaction already in progress may still pick up a new reasoning effort. Rejects on a remote session.
+       *
+       * @param params Compaction settings for this session. Each call replaces the previous settings: an omitted field returns to its default. Settings live in memory until the session ends; re-apply them after resuming a session in a new process.
+       */
+      setCompactionConfig: async (params) => connection.sendRequest("session.history.setCompactionConfig", { ...params, sessionId }),
       /**
        * Aborts any in-progress manual compaction on a local session.
        *
@@ -4837,6 +4843,15 @@ function createInternalSessionRpc(connection, sessionId) {
       }
     },
     /** @experimental */
+    canvasSource: {
+      /**
+       * Closes a canvas through its original session source. Requires the privately admitted in-process CLI host.
+       *
+       * @param params Closes a canvas through its original owned or attached session namespace.
+       */
+      close: async (params) => connection.sendRequest("session.canvasSource.close", { ...params, sessionId })
+    },
+    /** @experimental */
     workflow: {
       /**
        * Internal tool-originated dynamic workflow invocation.

package/dist/cjs/session.js

@@ -1177,6 +1177,13 @@ class CopilotSession {
       } else if (typeof rawResult === "string") {
         result = rawResult;
       } else if (isToolResultObject(rawResult)) {
+        try {
+          JSON.stringify(rawResult.toolTelemetry);
+        } catch (error) {
+          const message = error instanceof Error ? error.message : String(error);
+          throw new Error(`failed to serialize tool telemetry: ${message}`);
+        }
+        JSON.stringify(rawResult);
         result = rawResult;
       } else {
         result = JSON.stringify(rawResult);

package/dist/cjs/types.js

@@ -71,11 +71,9 @@ const RuntimeConnection = {
   /**
    * Host the runtime in-process over the native runtime library's C ABI (FFI).
    *
-   * @experimental Per-client options lowered to environment variables (`env`,
-   * `telemetry`, `gitHubToken`, `baseDirectory`) are **not** honored in-process;
-   * the worker inherits the host process's ambient environment. Set the
-   * corresponding environment variables on the host process instead. See
-   * https://github.com/github/copilot-sdk/issues/1934.
+   * @experimental Runtime configuration from `gitHubToken` and
+   * `baseDirectory` is scoped to this host, not the process environment.
+   * Client-level `env`, `telemetry` and `workingDirectory` are unsupported.
    */
   forInProcess(options = {}) {
     return { kind: "inprocess", ...options };

package/dist/cliVersion.d.ts

@@ -1,2 +1,2 @@
-export declare const COPILOT_CLI_VERSION = "1.0.106-8";
+export declare const COPILOT_CLI_VERSION = "1.0.106-10";
 export declare const COPILOT_CLI_USE_NPM_PACKAGE = false;

package/dist/cliVersion.js

@@ -1,4 +1,4 @@
-const COPILOT_CLI_VERSION = "1.0.106-8";
+const COPILOT_CLI_VERSION = "1.0.106-10";
 const COPILOT_CLI_USE_NPM_PACKAGE = false;
 export {
   COPILOT_CLI_USE_NPM_PACKAGE,

package/dist/client.d.ts

@@ -139,12 +139,17 @@ export declare class CopilotClient {
      * Stops the CLI server and closes all active sessions.
      *
      * This method performs graceful cleanup:
-     * 1. Closes all active sessions (releases in-memory resources)
+     * 1. Closes all active sessions (releases in-memory resources); detach
+     *    requests share one shutdown timeout
      * 2. Requests runtime shutdown for SDK-owned CLI processes
      * 3. Closes the JSON-RPC connection
      * 4. Signals EOF to an owned stdio process and waits for host cleanup, then
      *    terminates the process if it does not exit within the shutdown timeout
      *
+     * In-process connections first abort active turns without a timeout. That
+     * step is outside the detach deadline, so in-process stop() can still wait
+     * indefinitely if the runtime stops answering abort requests.
+     *
      * 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.
@@ -469,11 +474,8 @@ export declare class CopilotClient {
      */
     onLifecycle(handler: SessionLifecycleHandler): () => void;
     /**
-     * Builds the environment for the spawned runtime child process (stdio/TCP): applies
-     * the auth token, connection token, `COPILOT_HOME`, keychain setting, and telemetry
-     * variables on top of the effective env. Not used by the in-process (FFI) transport,
-     * whose worker inherits the host process's ambient environment
-     * (see {@link CopilotClient.startInProcessFfi}).
+     * Builds runtime configuration for child processes and the per-host FFI snapshot.
+     * Typed auth, home, keychain, and telemetry options override the effective env.
      */
     private buildRuntimeEnv;
     /**