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

package/dist/session.d.ts

@@ -1,7 +1,7 @@
 import { createSessionRpc } from "./generated/rpc.js";
-import type { ModelSwitchAutoTierResult } from "./generated/rpc.js";
+import type { ModelSwitchAutoTierResult, SessionManagementPolicy } from "./generated/rpc.js";
 import type { OpenCanvasInstance } from "./generated/rpc.js";
-import type { MessageOptions, ResponseSchema, ContextTier, ReasoningEffort, ReasoningSummary, AutoTier, ModelCapabilitiesOverride, SessionCapabilities, SessionConfig, SessionEvent, SessionEventHandler, SessionEventType, SessionUiApi, TranscriptRecovery, TypedSessionEventHandler } from "./types.js";
+import type { MessageOptions, ResponseSchema, ContextTier, ReasoningEffort, ReasoningSummary, AutoTier, ModelCapabilitiesOverride, SessionCapabilities, SessionConfig, SessionEvent, SessionEventHandler, SessionEventType, SessionUiApi, SessionCreationHandler, TranscriptRecovery, TypedSessionEventHandler } from "./types.js";
 import { type SessionWorkflowApi } from "./workflow.js";
 /** Assistant message event - the final response from the assistant. */
 export type AssistantMessageEvent = Extract<SessionEvent, {
@@ -48,6 +48,7 @@ export declare class CopilotSession {
     /** Settles once every earlier `setTools` call has finished. */
     private setToolsQueue;
     private pendingExternalTools;
+    private pendingSessionCreations;
     private canvases;
     private bearerTokenProviders;
     private commandHandlers;
@@ -60,6 +61,7 @@ export declare class CopilotSession {
     private exitPlanModeHandler?;
     private autoModeSwitchHandler?;
     private skillProvider?;
+    private sessionCreationHandler?;
     private hooks?;
     private transformCallbacks?;
     private _rpc;
@@ -244,6 +246,11 @@ export declare class CopilotSession {
     private _confirm;
     private _select;
     private _input;
+    /**
+     * Registers the host's creation callback without enabling the tool group.
+     * Enable it separately with `session.rpc.management.configure({ enabled: true })`.
+     */
+    setSessionCreationHandler(handler?: SessionCreationHandler): Promise<SessionManagementPolicy>;
     private requireSkillProvider;
     /**
      * Runs a provider call with an abort signal tied to the runtime's request

package/dist/session.js

@@ -157,6 +157,11 @@ class WorkflowProgressBuffer {
     if (this.closed) {
       throw new Error("Cannot log after the workflow run has settled");
     }
+    if (typeof text !== "string") {
+      throw new TypeError(
+        `${kind}() expects a string; got ${text === null ? "null" : typeof text}.`
+      );
+    }
     this.pending.push({ seq: this.nextSeq++, kind, text });
     this.scheduleFlush();
   }
@@ -284,6 +289,7 @@ class CopilotSession {
   /** Settles once every earlier `setTools` call has finished. */
   setToolsQueue = Promise.resolve();
   pendingExternalTools = /* @__PURE__ */ new Map();
+  pendingSessionCreations = /* @__PURE__ */ new Set();
   canvases = /* @__PURE__ */ new Map();
   bearerTokenProviders = /* @__PURE__ */ new Map();
   commandHandlers = /* @__PURE__ */ new Map();
@@ -296,6 +302,7 @@ class CopilotSession {
   exitPlanModeHandler;
   autoModeSwitchHandler;
   skillProvider;
+  sessionCreationHandler;
   hooks;
   transformCallbacks;
   _rpc = null;
@@ -883,6 +890,10 @@ class CopilotSession {
       controller.abort();
     }
     this.pendingExternalTools.clear();
+    for (const controller of this.pendingSessionCreations) {
+      controller.abort();
+    }
+    this.pendingSessionCreations.clear();
     this.eventHandlers.clear();
     this.typedEventHandlers.clear();
     this.toolHandlers.clear();
@@ -893,6 +904,7 @@ class CopilotSession {
     this.exitPlanModeHandler = void 0;
     this.autoModeSwitchHandler = void 0;
     this.skillProvider = void 0;
+    this.sessionCreationHandler = void 0;
     this.hooks = void 0;
     this.traceContextProvider = void 0;
     this.bearerTokenProviders.clear();
@@ -1856,6 +1868,41 @@ class CopilotSession {
     this.assertConnected();
     this.skillProvider = provider;
   }
+  /**
+   * Registers the host's creation callback without enabling the tool group.
+   * Enable it separately with `session.rpc.management.configure({ enabled: true })`.
+   */
+  async setSessionCreationHandler(handler) {
+    this.assertConnected();
+    const previous = this.sessionCreationHandler;
+    this.sessionCreationHandler = handler;
+    try {
+      return await this.rpc.management.configure({ hasCreateHandler: handler !== void 0 });
+    } catch (error) {
+      if (this.sessionCreationHandler === handler) this.sessionCreationHandler = previous;
+      throw error;
+    }
+  }
+  /** @internal */
+  async _handleSessionManagementCreate(request, token) {
+    this.assertConnected();
+    const handler = this.sessionCreationHandler;
+    if (!handler || request.parentSessionId !== this.sessionId || request.sessionId !== this.sessionId) {
+      throw new Error("Session creation handler is unavailable");
+    }
+    const controller = new AbortController();
+    this.pendingSessionCreations.add(controller);
+    const subscription = token.onCancellationRequested(() => controller.abort());
+    if (token.isCancellationRequested) controller.abort();
+    try {
+      return await handler(request, { signal: controller.signal });
+    } catch {
+      throw new Error("Session creation callback failed");
+    } finally {
+      subscription.dispose();
+      this.pendingSessionCreations.delete(controller);
+    }
+  }
   /**
    * Handles a `skillProvider.list` request from the runtime.
    *

package/dist/types.d.ts

@@ -9,13 +9,23 @@ export type { InstallationConfirmationHandler } from "./installationConfirmation
 import type { AgentModelPolicy, AttachmentExtensionContext as GeneratedExtensionContextAttachment, AutoTier, ModelProviderRef, PermissionRequest as GeneratedPermissionRequest, PermissionRequestedData as GeneratedPermissionRequestedData, PermissionRequestedEvent as GeneratedPermissionRequestedEvent, ReasoningSummary, SessionLimitsConfig, SessionEvent as GeneratedSessionEvent } from "./generated/session-events.js";
 import type { CopilotSession } from "./session.js";
 import type { JsonValue } from "./workflow.js";
-import type { ExtensionLaunchProviderHandler as GeneratedExtensionLaunchProvider, AutopilotOptions, GitHubTokenAcquireRequest, GitHubTokenAcquireResult, GitHubTelemetryNotification, HostDiagnostics, ModelBillingTokenPrices, DiagnosticsConfiguration, OpenCanvasInstance, ProtocolExternalToolNamespace, CurrentToolMetadata, KerberosAuthAcquireRequest, KerberosAuthMode, KerberosAuthScope, SandboxConfig } from "./generated/rpc.js";
+import type { ExtensionLaunchProviderHandler as GeneratedExtensionLaunchProvider, AutopilotOptions, GitHubTokenAcquireRequest, GitHubTokenAcquireResult, GitHubTelemetryNotification, HostDiagnostics, ModelBillingTokenPrices, DiagnosticsConfiguration, OpenCanvasInstance, ProtocolExternalToolNamespace, CurrentToolMetadata, KerberosAuthAcquireRequest, KerberosAuthMode, KerberosAuthScope, SandboxConfig, SessionManagementCreateHostRequest, SessionManagementCreateResult } from "./generated/rpc.js";
 import type { ToolSet } from "./toolSet.js";
 export type { KerberosAuthAcquireRequest, KerberosAuthMode, KerberosAuthScope, } from "./generated/rpc.js";
 export type { RemoteSessionMode } from "./generated/rpc.js";
 export type { AutopilotOptions } from "./generated/rpc.js";
 export type { CurrentToolMetadata } from "./generated/rpc.js";
 export type { SandboxConfig, SandboxConfigSource } from "./generated/rpc.js";
+export type { ManagedSessionInfo, SessionManagementCloseRequest, SessionManagementCloseResult, SessionManagementConfigureRequest, SessionManagementCreateHostRequest, SessionManagementCreateRequest, SessionManagementCreateResult, SessionManagementListRequest, SessionManagementListResult, SessionManagementMessageRequest, SessionManagementMessageResult, SessionManagementPolicy, SessionManagementScope, SessionManagementToolOverrides, } from "./generated/rpc.js";
+/**
+ * Creates and supervises a separate session for this session's management tools.
+ * Use newSessionId as the child's exact identity and apply the requested launch
+ * options and permission ceiling. Route approvals independently, retain the new
+ * session, and dispose it with the host. Do not copy the parent's conversation.
+ */
+export type SessionCreationHandler = (request: SessionManagementCreateHostRequest, options: {
+    signal: AbortSignal;
+}) => SessionManagementCreateResult | Promise<SessionManagementCreateResult>;
 export type { AuthIdentityMetadata, AuthInfoType, ConnectorAccountRequest, ConnectorAvailability, ConnectorCapabilities, ConnectorCatalogEntry, ConnectorCatalogResult, ConnectorCatalogStatus, ConnectorConnectRequest, ConnectorConnectResult, ConnectorContinueRequest, ConnectorDisconnectResult, ConnectorMcpStatus, ConnectorReconcileRequest, ConnectorRuntimeStatus, ConnectorSessionAccount, ConnectorSessionAccountResult, ConnectorStatus, ExtensionLaunchProfile, ExtensionLaunchProviderResolveRequest, ExtensionLaunchProviderResolveResult, GitHubTokenAcquireReason, GitHubTokenAcquireResult, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, HostDiagnostics, HostErrorReportingStatus, InstallationConfirmationRequest, InstallationConfirmationResponse, InstallationDecision, InstallationReview, McpInstallationReview, } from "./generated/rpc.js";
 /**
  * Arguments passed to a session's {@link GitHubTokenProvider}.
@@ -363,7 +373,8 @@ export interface CopilotClientOptions {
     /**
      * Whether to use the logged-in user for authentication.
      * When true, the runtime will attempt to use stored OAuth tokens or gh CLI auth.
-     * When false, only explicit tokens (gitHubToken or environment variables) are used.
+     * When false, only explicit tokens such as gitHubToken are used; environment variable
+     * tokens (COPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKEN) are ignored.
      * @default true (but defaults to false when gitHubToken is provided)
      */
     useLoggedInUser?: boolean;
@@ -1854,9 +1865,10 @@ export interface LargeToolOutputConfig {
     outputDirectory?: string;
 }
 /**
- * Valid reasoning effort levels for models that support it.
+ * Model-defined reasoning effort for models that support it.
+ * Use client.listModels() to discover supported values; BYOK providers can define additional levels.
  */
-export type ReasoningEffort = "low" | "medium" | "high" | "xhigh" | "max";
+export type ReasoningEffort = string;
 /**
  * Context window tier for the session. "long_context" pins the session to the
  * long-context tier when the selected model supports it.

package/docs/examples.md

@@ -198,7 +198,7 @@ Use `session.send()` to programmatically inject a new user message.
 ```js
 hooks: {
     onUserPromptSubmitted: async (input) => {
-        if (/\\burgent\\b/i.test(input.prompt)) {
+        if (/\burgent\b/i.test(input.prompt)) {
             // Fire-and-forget a follow-up message
             setTimeout(() => session.send({ prompt: "Please prioritize this." }), 0);
         }
@@ -217,7 +217,7 @@ hooks: {
     onPreToolUse: async (input) => {
         if (input.toolName === "bash") {
             const cmd = String(input.toolArgs?.command || "");
-            if (/rm\\s+-rf/i.test(cmd) || /Remove-Item\\s+.*-Recurse/i.test(cmd)) {
+            if (/rm\s+-rf/i.test(cmd) || /Remove-Item\s+.*-Recurse/i.test(cmd)) {
                 return {
                     permissionDecision: "deny",
                     permissionDecisionReason: "Destructive commands are not allowed.",
@@ -394,7 +394,7 @@ function copyToClipboard(text) {
 const session = await joinSession({
     hooks: {
         onUserPromptSubmitted: async (input) => {
-            if (/\\bcopy\\b/i.test(input.prompt)) {
+            if (/\bcopy\b/i.test(input.prompt)) {
                 copyNextResponse = true;
             }
         },
@@ -513,7 +513,7 @@ const debounce = new Map();
 
 watch(cwd, { recursive: true }, (eventType, filename) => {
     if (!filename || eventType !== "change") return;
-    if (filename.split(/[\\\\\\/]/).some((p) => IGNORE.has(p))) return;
+    if (filename.split(/[\\/]/).some((p) => IGNORE.has(p))) return;
 
     if (debounce.has(filename)) clearTimeout(debounce.get(filename));
     debounce.set(filename, setTimeout(() => {
@@ -524,7 +524,7 @@ watch(cwd, { recursive: true }, (eventType, filename) => {
         try { if (!statSync(fullPath).isFile()) return; } catch { return; }
         const relPath = relative(cwd, fullPath);
         session.send({
-            prompt: `The user edited \\`${relPath}\\`.`,
+            prompt: `The user edited \`${relPath}\`.`,
             attachments: [{ type: "file", path: fullPath }],
         });
     }, 500));
@@ -619,7 +619,7 @@ function openInEditor(filePath) {
 const session = await joinSession({
     hooks: {
         onUserPromptSubmitted: async (input) => {
-            if (/\\bcopy this\\b/i.test(input.prompt)) {
+            if (/\bcopy this\b/i.test(input.prompt)) {
                 copyNextResponse = true;
             }
             return {
@@ -629,7 +629,7 @@ const session = await joinSession({
         onPreToolUse: async (input) => {
             if (input.toolName === "bash") {
                 const cmd = String(input.toolArgs?.command || "");
-                if (/rm\\s+-rf\\s+\//i.test(cmd) || /Remove-Item\\s+.*-Recurse/i.test(cmd)) {
+                if (/rm\s+-rf\s+\//i.test(cmd) || /Remove-Item\s+.*-Recurse/i.test(cmd)) {
                     return {
                         permissionDecision: "deny",
                         permissionDecisionReason: "Destructive commands are not allowed.",

package/package.json

@@ -5,8 +5,8 @@
         "url": "https://github.com/github/copilot-agent-runtime.git",
         "directory": "src/sdk/nodejs"
     },
-    "version": "1.0.29-preview.0",
-    "copilotCliVersion": "1.0.106-1",
+    "version": "1.0.29-preview.2",
+    "copilotCliVersion": "1.0.106-3",
     "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
     "main": "./dist/cjs/index.js",
     "types": "./dist/index.d.ts",
@@ -79,8 +79,9 @@
         "@types/node": "^26.6.5",
         "@types/semver": "7.8.0",
         "@types/ws": "^8.18.1",
-        "@typescript-eslint/eslint-plugin": "^8.72.1",
-        "@typescript-eslint/parser": "^8.72.1",
+        "@typescript-eslint/eslint-plugin": "^8.72.0",
+        "@typescript-eslint/parser": "^8.72.0",
+        "@vitest/coverage-v8": "^5.0.5",
         "esbuild": "^0.28.1",
         "eslint": "^10.13.0",
         "file-entry-cache": "file:./scripts/eslint-file-cache",
@@ -114,18 +115,18 @@
         "README.md"
     ],
     "copilotRuntime": {
-        "sourceSha": "1fb35cfaf220f19b8983d5cbd2f7aa2128e58b3c",
-        "version": "1.0.106-1",
+        "sourceSha": "70ffdab66d4c7eb84302789a8536c02d955da3ed",
+        "version": "1.0.106-3",
         "visibility": "public"
     },
     "optionalDependencies": {
-        "@github/copilot-sdk-darwin-arm64": "1.0.29-preview.0",
-        "@github/copilot-sdk-darwin-x64": "1.0.29-preview.0",
-        "@github/copilot-sdk-linux-arm64": "1.0.29-preview.0",
-        "@github/copilot-sdk-linux-x64": "1.0.29-preview.0",
-        "@github/copilot-sdk-linuxmusl-arm64": "1.0.29-preview.0",
-        "@github/copilot-sdk-linuxmusl-x64": "1.0.29-preview.0",
-        "@github/copilot-sdk-win32-arm64": "1.0.29-preview.0",
-        "@github/copilot-sdk-win32-x64": "1.0.29-preview.0"
+        "@github/copilot-sdk-darwin-arm64": "1.0.29-preview.2",
+        "@github/copilot-sdk-darwin-x64": "1.0.29-preview.2",
+        "@github/copilot-sdk-linux-arm64": "1.0.29-preview.2",
+        "@github/copilot-sdk-linux-x64": "1.0.29-preview.2",
+        "@github/copilot-sdk-linuxmusl-arm64": "1.0.29-preview.2",
+        "@github/copilot-sdk-linuxmusl-x64": "1.0.29-preview.2",
+        "@github/copilot-sdk-win32-arm64": "1.0.29-preview.2",
+        "@github/copilot-sdk-win32-x64": "1.0.29-preview.2"
     }
 }