@github/copilot-sdk 0.3.0-preview.0 → 0.3.0-preview.1

package/README.md

@@ -86,8 +86,8 @@ new CopilotClient(options?: CopilotClientOptions)
 - `useStdio?: boolean` - Use stdio transport instead of TCP (default: true)
 - `logLevel?: string` - Log level (default: "info")
 - `autoStart?: boolean` - Auto-start server (default: true)
-- `githubToken?: string` - GitHub token for authentication. When provided, takes priority over other auth methods.
-- `useLoggedInUser?: boolean` - Whether to use logged-in user for authentication (default: true, but false when `githubToken` is provided). Cannot be used with `cliUrl`.
+- `gitHubToken?: string` - GitHub token for authentication. When provided, takes priority over other auth methods.
+- `useLoggedInUser?: boolean` - Whether to use logged-in user for authentication (default: true, but false when `gitHubToken` is provided). Cannot be used with `cliUrl`.
 - `telemetry?: TelemetryConfig` - OpenTelemetry configuration for the CLI process. Providing this object enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below.
 - `onGetTraceContext?: TraceContextProvider` - Advanced: callback for linking your application's own OpenTelemetry spans into the same distributed trace as the CLI's spans. Not needed for normal telemetry collection. See [Telemetry](#telemetry) below.
 

package/dist/cjs/client.js

@@ -164,9 +164,9 @@ class CopilotClient {
         "isChildProcess must be used in conjunction with useStdio and not with cliUrl"
       );
     }
-    if (options.cliUrl && (options.githubToken || options.useLoggedInUser !== void 0)) {
+    if (options.cliUrl && (options.gitHubToken || options.useLoggedInUser !== void 0)) {
       throw new Error(
-        "githubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)"
+        "gitHubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)"
       );
     }
     if (options.sessionFs) {
@@ -198,10 +198,11 @@ class CopilotClient {
       autoStart: options.autoStart ?? true,
       autoRestart: false,
       env: effectiveEnv,
-      githubToken: options.githubToken,
-      // Default useLoggedInUser to false when githubToken is provided, otherwise true
-      useLoggedInUser: options.useLoggedInUser ?? (options.githubToken ? false : true),
-      telemetry: options.telemetry
+      gitHubToken: options.gitHubToken,
+      // Default useLoggedInUser to false when gitHubToken is provided, otherwise true
+      useLoggedInUser: options.useLoggedInUser ?? (options.gitHubToken ? false : true),
+      telemetry: options.telemetry,
+      sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0
     };
   }
   /**
@@ -558,7 +559,8 @@ class CopilotClient {
         enableConfigDiscovery: config.enableConfigDiscovery,
         skillDirectories: config.skillDirectories,
         disabledSkills: config.disabledSkills,
-        infiniteSessions: config.infiniteSessions
+        infiniteSessions: config.infiniteSessions,
+        gitHubToken: config.gitHubToken
       });
       const { workspacePath, capabilities } = response;
       session["_workspacePath"] = workspacePath;
@@ -685,7 +687,8 @@ class CopilotClient {
         skillDirectories: config.skillDirectories,
         disabledSkills: config.disabledSkills,
         infiniteSessions: config.infiniteSessions,
-        disableResume: config.disableResume
+        disableResume: config.disableResume,
+        gitHubToken: config.gitHubToken
       });
       const { workspacePath, capabilities } = response;
       session["_workspacePath"] = workspacePath;
@@ -1035,16 +1038,22 @@ class CopilotClient {
       } else if (this.options.port > 0) {
         args.push("--port", this.options.port.toString());
       }
-      if (this.options.githubToken) {
+      if (this.options.gitHubToken) {
         args.push("--auth-token-env", "COPILOT_SDK_AUTH_TOKEN");
       }
       if (!this.options.useLoggedInUser) {
         args.push("--no-auto-login");
       }
+      if (this.options.sessionIdleTimeoutSeconds !== void 0 && this.options.sessionIdleTimeoutSeconds > 0) {
+        args.push(
+          "--session-idle-timeout",
+          this.options.sessionIdleTimeoutSeconds.toString()
+        );
+      }
       const envWithoutNodeDebug = { ...this.options.env };
       delete envWithoutNodeDebug.NODE_DEBUG;
-      if (this.options.githubToken) {
-        envWithoutNodeDebug.COPILOT_SDK_AUTH_TOKEN = this.options.githubToken;
+      if (this.options.gitHubToken) {
+        envWithoutNodeDebug.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;
       }
       if (!this.options.cliPath) {
         throw new Error(
@@ -1425,7 +1434,7 @@ stderr: ${stderrOutput}`
       }
       return {
         result: {
-          kind: "denied-no-approval-rule-and-could-not-request-from-user"
+          kind: "user-not-available"
         }
       };
     }

package/dist/cjs/generated/rpc.js

@@ -27,20 +27,22 @@ function createServerRpc(connection) {
   return {
     ping: async (params) => connection.sendRequest("ping", params),
     models: {
-      list: async () => connection.sendRequest("models.list", {})
+      list: async (params) => connection.sendRequest("models.list", params)
     },
     tools: {
       list: async (params) => connection.sendRequest("tools.list", params)
     },
     account: {
-      getQuota: async () => connection.sendRequest("account.getQuota", {})
+      getQuota: async (params) => connection.sendRequest("account.getQuota", params)
     },
     mcp: {
       config: {
         list: async () => connection.sendRequest("mcp.config.list", {}),
         add: async (params) => connection.sendRequest("mcp.config.add", params),
         update: async (params) => connection.sendRequest("mcp.config.update", params),
-        remove: async (params) => connection.sendRequest("mcp.config.remove", params)
+        remove: async (params) => connection.sendRequest("mcp.config.remove", params),
+        enable: async (params) => connection.sendRequest("mcp.config.enable", params),
+        disable: async (params) => connection.sendRequest("mcp.config.disable", params)
       },
       discover: async (params) => connection.sendRequest("mcp.discover", params)
     },
@@ -61,6 +63,9 @@ function createServerRpc(connection) {
 }
 function createSessionRpc(connection, sessionId) {
   return {
+    auth: {
+      getStatus: async () => connection.sendRequest("session.auth.getStatus", { sessionId })
+    },
     model: {
       getCurrent: async () => connection.sendRequest("session.model.getCurrent", { sessionId }),
       switchTo: async (params) => connection.sendRequest("session.model.switchTo", { sessionId, ...params })
@@ -111,7 +116,11 @@ function createSessionRpc(connection, sessionId) {
       list: async () => connection.sendRequest("session.mcp.list", { sessionId }),
       enable: async (params) => connection.sendRequest("session.mcp.enable", { sessionId, ...params }),
       disable: async (params) => connection.sendRequest("session.mcp.disable", { sessionId, ...params }),
-      reload: async () => connection.sendRequest("session.mcp.reload", { sessionId })
+      reload: async () => connection.sendRequest("session.mcp.reload", { sessionId }),
+      /** @experimental */
+      oauth: {
+        login: async (params) => connection.sendRequest("session.mcp.oauth.login", { sessionId, ...params })
+      }
     },
     /** @experimental */
     plugins: {
@@ -135,7 +144,9 @@ function createSessionRpc(connection, sessionId) {
       handlePendingElicitation: async (params) => connection.sendRequest("session.ui.handlePendingElicitation", { sessionId, ...params })
     },
     permissions: {
-      handlePendingPermissionRequest: async (params) => connection.sendRequest("session.permissions.handlePendingPermissionRequest", { sessionId, ...params })
+      handlePendingPermissionRequest: async (params) => connection.sendRequest("session.permissions.handlePendingPermissionRequest", { sessionId, ...params }),
+      setApproveAll: async (params) => connection.sendRequest("session.permissions.setApproveAll", { sessionId, ...params }),
+      resetSessionApprovals: async () => connection.sendRequest("session.permissions.resetSessionApprovals", { sessionId })
     },
     log: async (params) => connection.sendRequest("session.log", { sessionId, ...params }),
     shell: {

package/dist/cjs/session.js

@@ -349,7 +349,7 @@ class CopilotSession {
         await this.rpc.permissions.handlePendingPermissionRequest({
           requestId,
           result: {
-            kind: "denied-no-approval-rule-and-could-not-request-from-user"
+            kind: "user-not-available"
           }
         });
       } catch (rpcError) {
@@ -627,7 +627,7 @@ class CopilotSession {
    */
   async _handlePermissionRequestV2(request) {
     if (!this.permissionHandler) {
-      return { kind: "denied-no-approval-rule-and-could-not-request-from-user" };
+      return { kind: "user-not-available" };
     }
     try {
       const result = await this.permissionHandler(request, {
@@ -641,7 +641,7 @@ class CopilotSession {
       if (error instanceof Error && error.message === NO_RESULT_PERMISSION_V2_ERROR) {
         throw error;
       }
-      return { kind: "denied-no-approval-rule-and-could-not-request-from-user" };
+      return { kind: "user-not-available" };
     }
   }
   /**

package/dist/cjs/types.js

@@ -85,7 +85,7 @@ const SYSTEM_PROMPT_SECTIONS = {
     description: "End-of-prompt instructions: parallel tool calling, persistence, task completion"
   }
 };
-const approveAll = () => ({ kind: "approved" });
+const approveAll = () => ({ kind: "approve-once" });
 const defaultJoinSessionPermissionHandler = () => ({
   kind: "no-result"
 });

package/dist/client.js

@@ -144,9 +144,9 @@ class CopilotClient {
         "isChildProcess must be used in conjunction with useStdio and not with cliUrl"
       );
     }
-    if (options.cliUrl && (options.githubToken || options.useLoggedInUser !== void 0)) {
+    if (options.cliUrl && (options.gitHubToken || options.useLoggedInUser !== void 0)) {
       throw new Error(
-        "githubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)"
+        "gitHubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)"
       );
     }
     if (options.sessionFs) {
@@ -178,10 +178,11 @@ class CopilotClient {
       autoStart: options.autoStart ?? true,
       autoRestart: false,
       env: effectiveEnv,
-      githubToken: options.githubToken,
-      // Default useLoggedInUser to false when githubToken is provided, otherwise true
-      useLoggedInUser: options.useLoggedInUser ?? (options.githubToken ? false : true),
-      telemetry: options.telemetry
+      gitHubToken: options.gitHubToken,
+      // Default useLoggedInUser to false when gitHubToken is provided, otherwise true
+      useLoggedInUser: options.useLoggedInUser ?? (options.gitHubToken ? false : true),
+      telemetry: options.telemetry,
+      sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0
     };
   }
   /**
@@ -538,7 +539,8 @@ class CopilotClient {
         enableConfigDiscovery: config.enableConfigDiscovery,
         skillDirectories: config.skillDirectories,
         disabledSkills: config.disabledSkills,
-        infiniteSessions: config.infiniteSessions
+        infiniteSessions: config.infiniteSessions,
+        gitHubToken: config.gitHubToken
       });
       const { workspacePath, capabilities } = response;
       session["_workspacePath"] = workspacePath;
@@ -665,7 +667,8 @@ class CopilotClient {
         skillDirectories: config.skillDirectories,
         disabledSkills: config.disabledSkills,
         infiniteSessions: config.infiniteSessions,
-        disableResume: config.disableResume
+        disableResume: config.disableResume,
+        gitHubToken: config.gitHubToken
       });
       const { workspacePath, capabilities } = response;
       session["_workspacePath"] = workspacePath;
@@ -1015,16 +1018,22 @@ class CopilotClient {
       } else if (this.options.port > 0) {
         args.push("--port", this.options.port.toString());
       }
-      if (this.options.githubToken) {
+      if (this.options.gitHubToken) {
         args.push("--auth-token-env", "COPILOT_SDK_AUTH_TOKEN");
       }
       if (!this.options.useLoggedInUser) {
         args.push("--no-auto-login");
       }
+      if (this.options.sessionIdleTimeoutSeconds !== void 0 && this.options.sessionIdleTimeoutSeconds > 0) {
+        args.push(
+          "--session-idle-timeout",
+          this.options.sessionIdleTimeoutSeconds.toString()
+        );
+      }
       const envWithoutNodeDebug = { ...this.options.env };
       delete envWithoutNodeDebug.NODE_DEBUG;
-      if (this.options.githubToken) {
-        envWithoutNodeDebug.COPILOT_SDK_AUTH_TOKEN = this.options.githubToken;
+      if (this.options.gitHubToken) {
+        envWithoutNodeDebug.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;
       }
       if (!this.options.cliPath) {
         throw new Error(
@@ -1405,7 +1414,7 @@ stderr: ${stderrOutput}`
       }
       return {
         result: {
-          kind: "denied-no-approval-rule-and-could-not-request-from-user"
+          kind: "user-not-available"
         }
       };
     }