@github/copilot-sdk 1.0.9-preview.2 → 1.0.9

package/dist/types.d.ts

@@ -4,7 +4,7 @@
 import type { Canvas } from "./canvas.js";
 import type { SessionFsProvider } from "./sessionFsProvider.js";
 import type { CopilotRequestHandler } from "./copilotRequestHandler.js";
-import type { ReasoningSummary, SessionLimitsConfig, SessionEvent as GeneratedSessionEvent } from "./generated/session-events.js";
+import type { 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 { GitHubTelemetryNotification, ModelBillingTokenPrices, OpenCanvasInstance, RemoteSessionMode, CurrentToolMetadata } from "./generated/rpc.js";
 import type { ToolSet } from "./toolSet.js";
@@ -12,7 +12,9 @@ export type { RemoteSessionMode } from "./generated/rpc.js";
 export type { CurrentToolMetadata } from "./generated/rpc.js";
 export type { GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, } from "./generated/rpc.js";
 export type { ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, } from "./generated/rpc.js";
-export type SessionEvent = GeneratedSessionEvent;
+export type SessionEvent = Exclude<GeneratedSessionEvent, {
+    type: "permission.requested";
+}> | PermissionRequestedEvent;
 export type { ReasoningSummary } from "./generated/session-events.js";
 export type { SessionFsProvider } from "./sessionFsProvider.js";
 export { createSessionFsAdapter } from "./sessionFsProvider.js";
@@ -838,15 +840,27 @@ export interface SystemMessageCustomizeConfig {
  * - Customize mode: Section-level overrides with graceful fallback
  */
 export type SystemMessageConfig = SystemMessageAppendConfig | SystemMessageReplaceConfig | SystemMessageCustomizeConfig;
+import type { PermissionDecisionRequest } from "./generated/rpc.js";
 /**
  * Permission request types from the server. This is the generated
  * discriminated union from the runtime schema — switch on `kind` to
  * access the variant-specific fields (e.g. shell `commands`, write
  * `fileName`/`diff`, mcp `toolName`/`args`).
+ *
+ * `managedApprovalRequired` indicates that managed policy requires an explicit
+ * user decision. Hosts should bypass automatic approval and present their
+ * normal confirmation UI. The runtime currently emits it for managed Shell,
+ * Read, Edit, and Domain selector asks.
  */
-export type { PermissionRequest } from "./generated/session-events.js";
-import type { PermissionRequest } from "./generated/session-events.js";
-import type { PermissionDecisionRequest } from "./generated/rpc.js";
+export type PermissionRequest = GeneratedPermissionRequest & {
+    readonly managedApprovalRequired?: boolean;
+};
+export type PermissionRequestedData = Omit<GeneratedPermissionRequestedData, "permissionRequest"> & {
+    permissionRequest: PermissionRequest;
+};
+export type PermissionRequestedEvent = Omit<GeneratedPermissionRequestedEvent, "data"> & {
+    data: PermissionRequestedData;
+};
 /**
  * Permission decision result returned from a {@link PermissionHandler}.
  * The discriminated `kind` field selects the decision. Variant-specific
@@ -858,7 +872,11 @@ export type PermissionRequestResult = PermissionDecisionRequest["result"] | {
 };
 export type PermissionHandler = (request: PermissionRequest, invocation: {
     sessionId: string;
+    managedSettingsEnabled?: boolean;
 }) => Promise<PermissionRequestResult> | PermissionRequestResult;
+/**
+ * Approves permission requests when managed settings are disabled.
+ */
 export declare const approveAll: PermissionHandler;
 export declare const defaultJoinSessionPermissionHandler: PermissionHandler;
 /**
@@ -1092,6 +1110,29 @@ export interface UserPromptSubmittedHookOutput {
 export type UserPromptSubmittedHandler = (input: UserPromptSubmittedHookInput, invocation: {
     sessionId: string;
 }) => Promise<UserPromptSubmittedHookOutput | void> | UserPromptSubmittedHookOutput | void;
+/**
+ * Input for the user-prompt-transformed hook.
+ *
+ * This hook runs after the runtime has transformed the submitted prompt with
+ * generated context, but before it is persisted to session history or sent to
+ * the model.
+ */
+export interface UserPromptTransformedHookInput extends BaseHookInput {
+    prompt: string;
+    transformedPrompt: string;
+}
+/**
+ * Output for the user-prompt-transformed hook.
+ */
+export interface UserPromptTransformedHookOutput {
+    modifiedTransformedPrompt?: string;
+}
+/**
+ * Handler for the user-prompt-transformed hook.
+ */
+export type UserPromptTransformedHandler = (input: UserPromptTransformedHookInput, invocation: {
+    sessionId: string;
+}) => Promise<UserPromptTransformedHookOutput | void> | UserPromptTransformedHookOutput | void;
 /**
  * Input for session-start hook
  */
@@ -1227,6 +1268,10 @@ export interface SessionHooks {
      * Called when the user submits a prompt
      */
     onUserPromptSubmitted?: UserPromptSubmittedHandler;
+    /**
+     * Called after the runtime transforms a submitted prompt and before it is stored.
+     */
+    onUserPromptTransformed?: UserPromptTransformedHandler;
     /**
      * Called when a session starts
      */
@@ -1432,7 +1477,7 @@ export interface LargeToolOutputConfig {
 /**
  * Valid reasoning effort levels for models that support it.
  */
-export type ReasoningEffort = "low" | "medium" | "high" | "xhigh";
+export type ReasoningEffort = "low" | "medium" | "high" | "xhigh" | "max";
 /**
  * Context window tier for the session. "long_context" pins the session to the
  * long-context tier when the selected model supports it.
@@ -1624,6 +1669,19 @@ export interface CopilotExpAssignmentResponse {
     /** Assignment context string forwarded to CAPI and telemetry. */
     AssignmentContext: string;
 }
+/**
+ * Configuration for the built-in GitHub MCP server.
+ *
+ * `disableFormDeferral` only applies to the built-in GitHub MCP server and
+ * only has an effect when MCP Apps and form-backed GitHub tools are enabled.
+ */
+export interface GitHubMcpToolConfig {
+    enableAllTools?: boolean;
+    additionalToolsets?: string[];
+    additionalTools?: string[];
+    enableInsidersMode?: boolean;
+    disableFormDeferral?: boolean;
+}
 /**
  * Shared configuration fields used by both {@link SessionConfig} (for
  * creating a new session) and {@link ResumeSessionConfig} (for resuming
@@ -1650,6 +1708,11 @@ export interface SessionConfigBase {
      * Use "none" to suppress summary output regardless of whether reasoning is enabled.
      */
     reasoningSummary?: ReasoningSummary;
+    /**
+     * Controls whether the session enables experimental features.
+     * Defaults to `false` in `"empty"` mode; otherwise the runtime decides when unset.
+     */
+    enableExperimentalMode?: boolean;
     /**
      * Context window tier for models that support it. Use "long_context" to pin
      * the session to the long-context tier; omit or use "default" otherwise.
@@ -1914,6 +1977,13 @@ export interface SessionConfigBase {
      * @default false
      */
     enableMcpApps?: boolean;
+    /**
+     * Configuration for the built-in GitHub MCP server.
+     *
+     * `disableFormDeferral` only applies to the built-in GitHub MCP server and
+     * only has an effect when MCP Apps and form-backed GitHub tools are enabled.
+     */
+    githubMcpToolConfig?: GitHubMcpToolConfig;
     /**
      * Handler for exit-plan-mode requests from the agent.
      * When provided, enables `exitPlanMode.request` callbacks.
@@ -1934,6 +2004,12 @@ export interface SessionConfigBase {
      * Tool operations will be relative to this directory.
      */
     workingDirectory?: string;
+    /**
+     * Additional directories the agent may access beyond the working directory.
+     * Relative paths are resolved against the session's working directory.
+     * Re-supply these directories when resuming a session.
+     */
+    additionalDirectories?: string[];
     /**
      * Enable streaming of assistant message and reasoning chunks.
      * When true, ephemeral assistant.message_delta and assistant.reasoning_delta
@@ -2008,6 +2084,12 @@ export interface SessionConfigBase {
      * List of skill names to disable.
      */
     disabledSkills?: string[];
+    /**
+     * Exact MCP server names to disable for this session. Disabled servers are not
+     * started or authenticated when creating or cold-resuming a session. Supplying
+     * this on a resident resume cannot stop servers that are already running.
+     */
+    disabledMcpServers?: string[];
     /**
      * Infinite session configuration for persistent workspaces and automatic compaction.
      * When enabled (default), sessions automatically manage context limits and persist state.

package/dist/types.js

@@ -112,7 +112,18 @@ const SYSTEM_MESSAGE_SECTIONS = {
     description: "End-of-prompt instructions: parallel tool calling, persistence, task completion"
   }
 };
-const approveAll = () => ({ kind: "approve-once" });
+const approveAll = (request, invocation) => {
+  if (invocation.managedSettingsEnabled) {
+    throw new Error("approveAll cannot be used when managed settings are enabled");
+  }
+  if ("managedApprovalRequired" in request) {
+    const managedApprovalRequired = request.managedApprovalRequired;
+    if (managedApprovalRequired !== void 0 && managedApprovalRequired !== false) {
+      return { kind: "no-result" };
+    }
+  }
+  return { kind: "approve-once" };
+};
 const defaultJoinSessionPermissionHandler = () => ({
   kind: "no-result"
 });

package/docs/agent-author.md

@@ -258,7 +258,7 @@ Subscribe to session events. Returns an unsubscribe function.
 
 ```js
 const unsub = session.on("tool.execution_complete", (event) => {
-    // event.data.toolName, event.data.success, event.data.result
+    // event.data.success, event.data.result
 });
 ```
 
@@ -268,9 +268,9 @@ const unsub = session.on("tool.execution_complete", (event) => {
 | ------------------------- | ------------------------------------------------------ |
 | `assistant.message`       | `content`, `messageId`                                 |
 | `tool.execution_start`    | `toolCallId`, `toolName`, `arguments`                  |
-| `tool.execution_complete` | `toolCallId`, `toolName`, `success`, `result`, `error` |
+| `tool.execution_complete` | `toolCallId`, `success`, `result`, `error`             |
 | `user.message`            | `content`, `attachments`, `source`                     |
-| `session.idle`            | `backgroundTasks`                                      |
+| `session.idle`            | `aborted`                                              |
 | `session.error`           | `errorType`, `message`, `stack`                        |
 | `permission.requested`    | `requestId`, `permissionRequest.kind`                  |
 | `session.shutdown`        | `shutdownType`, `totalPremiumRequests`                 |

package/docs/examples.md

@@ -368,7 +368,7 @@ session.on((event) => {
 
 ```js
 const unsubscribe = session.on("tool.execution_complete", (event) => {
-    // event.data.toolName, event.data.success, event.data.result, event.data.error
+    // event.data.success, event.data.result, event.data.error
 });
 
 // Later, stop listening
@@ -417,9 +417,9 @@ session.on("assistant.message", (event) => {
 | `assistant.message`         | Agent's final response                           | `content`, `messageId`, `toolRequests`                 |
 | `assistant.message_delta`   | Message content chunks (ephemeral)               | `deltaContent`                                         |
 | `tool.execution_start`      | A tool is about to run                           | `toolCallId`, `toolName`, `arguments`                  |
-| `tool.execution_complete`   | A tool finished running                          | `toolCallId`, `toolName`, `success`, `result`, `error` |
+| `tool.execution_complete`   | A tool finished running                          | `toolCallId`, `success`, `result`, `error`             |
 | `user.message`              | User sent a message                              | `content`, `attachments`, `source`                     |
-| `session.idle`              | Session finished processing a turn               | `backgroundTasks`                                      |
+| `session.idle`              | Session finished processing a turn               | `aborted`                                              |
 | `session.error`             | An error occurred                                | `errorType`, `message`, `stack`                        |
 | `permission.requested`      | Agent needs permission (shell, file write, etc.) | `requestId`, `permissionRequest.kind`                  |
 | `session.shutdown`          | Session is ending                                | `shutdownType`, `totalPremiumRequests`, `codeChanges`  |
@@ -677,6 +677,6 @@ session.on("assistant.message", (event) => {
 });
 
 session.on("tool.execution_complete", (event) => {
-    // event.data.success, event.data.toolName, event.data.result
+    // event.data.success, event.data.result
 });
 ```

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "1.0.9-preview.2",
+  "version": "1.0.9",
   "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.76-5",
+    "@github/copilot": "^1.0.78",
     "koffi": "^3.1.0",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"