@github/copilot-sdk 1.0.20 → 1.0.21-preview.1

package/dist/generated/session-events.d.ts

@@ -71,7 +71,9 @@ export type RemediationAction =
 /** Review or widen the sandbox policy. The blocked path or host is named by the accompanying message or by the tool result the action arrived with. */
  | "review_sandbox_policy"
 /** Permit outbound network access in the sandbox policy. */
- | "allow_sandbox_outbound";
+ | "allow_sandbox_outbound"
+/** Discard conversation history back through the blocked request before continuing. */
+ | "rewind_conversation";
 /**
  * The session mode the agent is operating in
  */
@@ -1942,7 +1944,7 @@ export interface ErrorData {
      */
     errorCode?: string;
     /**
-     * Category of error (e.g., "authentication", "authorization", "quota", "rate_limit", "context_limit", "query")
+     * Category of error (e.g., "authentication", "authorization", "policy", "quota", "rate_limit", "context_limit", "query")
      */
     errorType: string;
     /**
@@ -1953,6 +1955,14 @@ export interface ErrorData {
      * GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs
      */
     providerCallId?: string;
+    /**
+     * Sanitized provider-defined error parameter preserved from a structured upstream error envelope, when available.
+     */
+    providerErrorParam?: string;
+    /**
+     * Provider-defined error type preserved from a structured upstream error envelope, when available (for example, `invalid_request_error`).
+     */
+    providerErrorType?: string;
     remediation?: RemediationAction;
     /**
      * Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation
@@ -4071,6 +4081,10 @@ export interface CompactionCompleteCompactionTokensUsed {
      */
     outputTokens?: number;
     provider?: ModelProviderRef;
+    /**
+     * Number of model requests represented by this aggregated compaction usage
+     */
+    requestCount?: number;
 }
 /**
  * Token usage detail for a single billing category
@@ -4197,6 +4211,14 @@ export interface PermissionRecoveryData {
      */
     maxAttempts: number;
     onBlocked: PermissionRecoveryOnBlocked;
+    /**
+     * Subagent identifier that owns this recovery episode when the request was delegated through a parent permission service
+     */
+    ownerAgentId?: string;
+    /**
+     * Root or child execution-session identifier that owns this recovery episode; omitted for legacy snapshots
+     */
+    ownerSessionId?: string;
     reason: PermissionRecoveryReason;
     status: PermissionRecoveryStatus;
 }
@@ -9158,6 +9180,14 @@ export interface PermissionRequestedEvent {
  */
 export interface PermissionRequestedData {
     agentMode?: SessionMode;
+    /**
+     * Delegated agent that owns permission recovery when the owner session multiplexes remote agents. Absent otherwise.
+     */
+    ownerAgentId?: string;
+    /**
+     * Execution session that owns permission recovery for this request. Absent on historical events.
+     */
+    ownerSessionId?: string;
     permissionMode?: PermissionMode;
     permissionRequest: PermissionRequest;
     promptRequest?: PermissionPromptRequest;

package/dist/index.d.ts

@@ -4,7 +4,7 @@
  * JSON-RPC based SDK for programmatic control of GitHub Copilot CLI
  */
 export { CopilotClient } from "./client.js";
-export type { HostLocalServerOptions, HostGitHubEnvironmentOptions } from "./generated/rpc.js";
+export type { HostLocalServerOptions, HostGitHubEnvironmentOptions, ModelGetReasoningSummariesRequest, ModelGetReasoningSummariesResult, } from "./generated/rpc.js";
 export { AhpHost, type AhpHostExit, type AhpHostOptions, type AhpSessionCreateRequest, type AhpSessionResumeRequest, } from "./host.js";
 export { DisableBypassPermissionsModes, RuntimeConnection } from "./types.js";
 export { BuiltInTools, ToolSet } from "./toolSet.js";

package/dist/types.d.ts

@@ -1574,6 +1574,8 @@ export type MCPServerConfig = MCPStdioServerConfig | MCPHTTPServerConfig;
  * Configuration for a custom agent.
  */
 export interface CustomAgentConfig {
+    /** Declarative hook actions keyed by event name, active only for this agent. */
+    hooks?: Record<string, Record<string, unknown>[]>;
     /**
      * Unique name of the custom agent.
      */
@@ -2411,7 +2413,11 @@ export interface SessionConfigBase {
      */
     agent?: string;
     /**
-     * Directories to load skills from.
+     * Explicit discovery-only skill roots. No general filesystem access is granted.
+     * Available without `enableConfigDiscovery`; skill and managed disables still apply.
+     * Relative paths resolve once when supplied against the request's effective
+     * `workingDirectory`, and retained roots do not move when it changes.
+     * Null and omission are equivalent; `[]` clears only the explicit SDK contribution.
      */
     skillDirectories?: string[];
     /**
@@ -2430,6 +2436,25 @@ export interface SessionConfigBase {
      * or be removed in future SDK or CLI releases.
      */
     skillProvider?: SkillProvider;
+    /**
+     * Explicit discovery-only agent roots, separate from `customAgents` objects.
+     * No general filesystem access is granted. Available without `enableConfigDiscovery`;
+     * source and managed disables still apply.
+     * Relative paths resolve once when supplied against the request's effective
+     * `workingDirectory`, and retained roots do not move when it changes.
+     * Null and omission are equivalent; `[]` clears only the explicit SDK contribution.
+     */
+    agentDirectories?: string[];
+    /**
+     * Explicit discovery-only file-hook roots, separate from callback `hooks`.
+     * No general filesystem access is granted. Available without `enableConfigDiscovery`
+     * or `enableFileHooks` (which controls repository-origin hooks only);
+     * hook and managed disables still apply.
+     * Relative paths resolve once when supplied against the request's effective
+     * `workingDirectory`, and retained roots do not move when it changes.
+     * Null and omission are equivalent; `[]` clears only the explicit SDK contribution.
+     */
+    hookDirectories?: string[];
     /**
      * Local filesystem paths to Open Plugins-format directories
      * (https://open-plugins.com/) to load for this session.
@@ -2445,7 +2470,12 @@ export interface SessionConfigBase {
      */
     pluginDirectories?: string[];
     /**
-     * Additional directories to search for custom instruction files.
+     * Explicit discovery-only instruction roots using the existing SDK instruction formats.
+     * No general filesystem access is granted. Available without `enableConfigDiscovery`;
+     * instruction and managed disables still apply.
+     * Relative paths resolve once when supplied against the request's effective
+     * `workingDirectory`, and retained roots do not move when it changes.
+     * Null and omission are equivalent; `[]` clears only the explicit SDK contribution.
      */
     instructionDirectories?: string[];
     /**
@@ -2549,9 +2579,9 @@ export interface SessionConfigBase {
      */
     enableOnDemandInstructionDiscovery?: boolean;
     /**
-     * When true, enables loading of file-based hooks from `.github/hooks/`.
-     * This is separate from the `hooks` callback parameter which gates SDK
-     * hook event registration.
+     * When true, enables repository-origin file hooks from `.github/hooks/` and
+     * trusted repository-configured roots. Does not control explicit `hookDirectories`
+     * or the `hooks` callback parameter.
      */
     enableFileHooks?: boolean;
     /**
@@ -2608,6 +2638,14 @@ export interface SessionConfig extends SessionConfigBase {
      * Optional custom session ID. If not provided, the server generates one.
      */
     sessionId?: string;
+    /**
+     * Names the session at creation, as `session.name.set` would, and is validated the
+     * same way: non-empty, no leading or trailing whitespace, at most 100 UTF-16 units,
+     * no control characters, and no double quotes. A name also makes the session persist
+     * from the start, so it can be listed and resumed without ever running a turn.
+     * Local sessions only: cloud creation rejects it.
+     */
+    name?: string;
     /**
      * Invalidates the process-wide custom-instruction discovery cache before
      * creating this session. Use when instruction files changed in the same runtime.

package/package.json

@@ -5,8 +5,8 @@
         "url": "https://github.com/github/copilot-agent-runtime.git",
         "directory": "src/sdk/nodejs"
     },
-    "version": "1.0.20",
-    "copilotCliVersion": "1.0.96",
+    "version": "1.0.21-preview.1",
+    "copilotCliVersion": "1.0.97-1",
     "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
     "main": "./dist/cjs/index.js",
     "types": "./dist/index.d.ts",
@@ -85,13 +85,12 @@
         "json-schema": "^0.4.0",
         "json-schema-to-typescript": "^15.0.4",
         "prettier": "^3.8.1",
-        "quicktype-core": "^23.2.6",
         "rimraf": "^6.1.2",
         "semver": "^7.7.3",
         "tar": "^7.5.22",
         "tsx": "^4.20.6",
         "typescript": "^5.0.0",
-        "vitest": "^4.0.18",
+        "vitest": "^4.1.11",
         "ws": "^8.21.0"
     },
     "engines": {
@@ -104,18 +103,18 @@
         "README.md"
     ],
     "copilotRuntime": {
-        "sourceSha": "8227e3a7b5f74c8dde298fcc69dcb27a9a044a93",
-        "version": "1.0.96",
+        "sourceSha": "c47039bb19686a2781d7614b161431a4ac624d56",
+        "version": "1.0.97-1",
         "visibility": "public"
     },
     "optionalDependencies": {
-        "@github/copilot-sdk-darwin-arm64": "1.0.20",
-        "@github/copilot-sdk-darwin-x64": "1.0.20",
-        "@github/copilot-sdk-linux-arm64": "1.0.20",
-        "@github/copilot-sdk-linux-x64": "1.0.20",
-        "@github/copilot-sdk-linuxmusl-arm64": "1.0.20",
-        "@github/copilot-sdk-linuxmusl-x64": "1.0.20",
-        "@github/copilot-sdk-win32-arm64": "1.0.20",
-        "@github/copilot-sdk-win32-x64": "1.0.20"
+        "@github/copilot-sdk-darwin-arm64": "1.0.21-preview.1",
+        "@github/copilot-sdk-darwin-x64": "1.0.21-preview.1",
+        "@github/copilot-sdk-linux-arm64": "1.0.21-preview.1",
+        "@github/copilot-sdk-linux-x64": "1.0.21-preview.1",
+        "@github/copilot-sdk-linuxmusl-arm64": "1.0.21-preview.1",
+        "@github/copilot-sdk-linuxmusl-x64": "1.0.21-preview.1",
+        "@github/copilot-sdk-win32-arm64": "1.0.21-preview.1",
+        "@github/copilot-sdk-win32-x64": "1.0.21-preview.1"
     }
 }