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

package/dist/generated/rpc.js

@@ -733,6 +733,22 @@ function createServerRpc(connection) {
        * @returns Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
        */
       search: async (params) => connection.sendRequest("catalog.search", params),
+      /**
+       * Retrieves one saved feed by its opaque ID, optionally filtered by trust tier. Requires catalog-feeds and catalog-search-credential-required, and uses the same authority, credential policy, optional session binding and candidate projection as catalog.search, so available entries are the same inert candidates, with the same installability, handles and display metadata, and install through the same confirmed flows. Entries keep the feed's order; an entry the runtime cannot present is returned as unavailable with a reason rather than failing the feed. No anonymous retry. Read-only: nothing is installed, configured, or persisted.
+       *
+       * @param params Retrieves one saved feed by its opaque ID. Requires catalog-feeds and catalog-search-credential-required; add catalog-search-session-bound with policySessionId to retain the selected session's authority for installation, exactly as for catalog.search.
+       *
+       * @returns Outcome of catalog.getSavedFeed: the feed with its entries, or one typed refusal. An entry that cannot be presented never fails the feed.
+       */
+      getSavedFeed: async (params) => connection.sendRequest("catalog.getSavedFeed", params),
+      /**
+       * Retrieves one generated feed by strategy and key, such as telemetry/popular, optionally filtered by trust tier. Requires catalog-feeds and catalog-search-credential-required, and uses the same authority, credential policy, optional session binding and candidate projection as catalog.search, so available entries are the same inert candidates, with the same installability, handles and display metadata, and install through the same confirmed flows. Entries keep the feed's order; an entry the runtime cannot present is returned as unavailable with a reason rather than failing the feed. No anonymous retry. Read-only: nothing is installed, configured, or persisted.
+       *
+       * @param params Retrieves one generated feed, computed on every request, by strategy and key, such as `telemetry` and `popular`. Requires catalog-feeds and catalog-search-credential-required; add catalog-search-session-bound with policySessionId to retain the selected session's authority for installation, exactly as for catalog.search.
+       *
+       * @returns Outcome of catalog.getGeneratedFeed: the feed with its entries, or one typed refusal. An entry that cannot be presented never fails the feed.
+       */
+      getGeneratedFeed: async (params) => connection.sendRequest("catalog.getGeneratedFeed", params),
       /**
        * Terminates one retained catalog selection group. A selected outcome returns the native host a fresh single-use candidate handle plus the original searchId for a later explicit mcp.planInstall call; non-selected outcomes release the group without producing a planning input. Candidate state, cards, URLs, credentials and private identifiers remain inside the runtime. The model-facing catalog_select tool projects the result separately and never exposes the candidate handle or searchId.
        *
@@ -2128,7 +2144,7 @@ function createSessionRpc(connection, sessionId) {
         /**
          * Begin an interactive login flow for a provider kind (dispatch is kind-only) and return its opaque flow id and first step.
          *
-         * @param params Begin an interactive login flow for a provider kind. Dispatch is kind-only.
+         * @param params Begin an interactive login flow for a provider kind, optionally reusing a cached base identity or explicitly requesting provider account selection.
          *
          * @returns A started login flow: its opaque id and first step.
          */
@@ -2727,6 +2743,14 @@ function createSessionRpc(connection, sessionId) {
        * @returns Progress information for the task, or null when no task with that ID is tracked.
        */
       getProgress: async (params) => connection.sendRequest("session.tasks.getProgress", { ...params, sessionId }),
+      /**
+       * Reads a detached shell task's output after a cursor, optionally waiting for new output or for the shell to finish.
+       *
+       * @param params Detached shell task to read output from, with an optional cursor and long-poll wait. waitMs defaults to zero (maximum 30000).
+       *
+       * @returns Output a detached shell task wrote after the request cursor, with the cursor for the next read.
+       */
+      readOutput: async (params) => connection.sendRequest("session.tasks.readOutput", { ...params, sessionId }),
       /**
        * Returns the first sync-waiting task that can currently be promoted to background mode.
        *

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

@@ -3907,6 +3907,10 @@ export interface CompactionStartEvent {
  * Context window breakdown at the start of LLM-powered conversation compaction
  */
 export interface CompactionStartData {
+    /**
+     * Identifier shared with the matching compaction completion event
+     */
+    compactionAttemptId?: string;
     /**
      * Token count from non-system messages (user, assistant, tool) at compaction start
      */
@@ -3919,10 +3923,18 @@ export interface CompactionStartData {
      * Model identifier used for compaction, when known
      */
     model?: string;
+    /**
+     * Destination model for a model-switch compaction when it differs from the compacting model
+     */
+    switchTargetModel?: string;
     /**
      * Token count from system message(s) at compaction start
      */
     systemTokens?: number;
+    /**
+     * Destination prompt-token budget when it differs from the effective compaction token limit
+     */
+    targetPromptTokenLimit?: number;
     /**
      * Model context window token limit the compaction is targeting, when known
      */
@@ -3979,6 +3991,10 @@ export interface CompactionCompleteData {
      * File path where the checkpoint was stored
      */
     checkpointPath?: string;
+    /**
+     * Identifier shared with the matching compaction start event
+     */
+    compactionAttemptId?: string;
     compactionTokensUsed?: CompactionCompleteCompactionTokensUsed;
     /**
      * Token count from non-system messages (user, assistant, tool) after compaction
@@ -3992,10 +4008,30 @@ export interface CompactionCompleteData {
      * Error message if compaction failed
      */
     error?: string;
+    /**
+     * Bounded reason for a typed failed outcome. Unknown future values are preserved.
+     */
+    failureReason?: string;
+    /**
+     * Model identifier at admission when routing later changed to the reported compaction model
+     */
+    initialModel?: string;
     /**
      * Number of messages removed during compaction
      */
     messagesRemoved?: number;
+    /**
+     * Model identifier used for compaction when provider usage does not already supply it
+     */
+    model?: string;
+    /**
+     * Typed terminal outcome for this observed compaction completion. Unknown future values are preserved.
+     */
+    outcome?: string;
+    /**
+     * Bounded reason for an expected non-application outcome such as cancellation or no applicable history. Unknown future values are preserved.
+     */
+    outcomeReason?: string;
     /**
      * Total tokens in conversation after compaction
      */
@@ -4029,10 +4065,22 @@ export interface CompactionCompleteData {
      * LLM-generated summary of the compacted conversation history
      */
     summaryContent?: string;
+    /**
+     * Destination model for a model-switch compaction when it differs from the compacting model
+     */
+    switchTargetModel?: string;
     /**
      * Token count from system message(s) after compaction
      */
     systemTokens?: number;
+    /**
+     * Destination prompt-token budget when it differs from the effective compaction token limit
+     */
+    targetPromptTokenLimit?: number;
+    /**
+     * Open accounting-basis identifier for trustworthy paired pre/post token measurements. The current runtime emits local_full_context_estimate.
+     */
+    tokenAccountingBasis?: string;
     /**
      * Model context window token limit the compaction was targeting, when known
      */
@@ -7396,6 +7444,12 @@ export interface ToolShellOutputEvent {
  * Live, append-only shell output. Not persisted or replayed to late subscribers. Text is decoded and redacted per chunk; chunks need not contain complete lines.
  */
 export interface ToolShellOutputData {
+    /**
+     * Experimental HydraFusion attribution of the staged phase whose tool call produced this output. Absent outside a staged phase.
+     *
+     * @experimental
+     */
+    fusion?: FusionAttribution;
     /**
      * Zero-based publication sequence across all output streams for this tool call. Not a byte offset or an OS write-order guarantee.
      */
@@ -7559,6 +7613,12 @@ export interface ToolExecutionCompleteData {
     toolTelemetry?: {
         [k: string]: JsonValue | undefined;
     };
+    /**
+     * Provider-reported usage of a separately metered runtime-owned tool operation, independent of the conversation model. Present on success or failure when usage is known. Experimental.
+     *
+     * @experimental
+     */
+    toolUsage?: ToolExecutionUsage;
     /**
      * Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event
      */
@@ -8071,6 +8131,50 @@ export interface ToolExecutionCompleteToolDescriptionMetaUI {
      */
     visibility?: ToolExecutionCompleteToolDescriptionMetaUIVisibility[];
 }
+/**
+ * Authoritative usage reported by a separately metered runtime-owned tool operation. May be present on a failed tool when the service reported usage before local result processing failed. Missing token counts or billing mean unavailable, not zero.
+ */
+/** @experimental */
+export interface ToolExecutionUsage {
+    accounting?: UsageAccountingIdentity;
+    copilotUsage?: AssistantUsageCopilotUsage;
+    /**
+     * Total provider-reported input tokens across all modalities.
+     */
+    inputTokens?: number;
+    inputTokensDetails?: ToolExecutionUsageTokenDetails;
+    /**
+     * Requested model for the tool operation, independent of the conversation model. Not a provider-confirmed serving model.
+     */
+    model: string;
+    /**
+     * Total provider-reported output tokens across all modalities.
+     */
+    outputTokens?: number;
+    outputTokensDetails?: ToolExecutionUsageTokenDetails;
+    provider?: ModelProviderRef;
+    /**
+     * Runtime-generated identifier for this metered operation. Deduplicates repeated delivery or replay; not an upstream billing identifier.
+     */
+    requestId: string;
+    /**
+     * Provider-reported sum of input and output tokens.
+     */
+    totalTokens?: number;
+}
+/**
+ * Provider-reported image and text token counts, which are subsets of the corresponding total rather than additional tokens.
+ */
+export interface ToolExecutionUsageTokenDetails {
+    /**
+     * Image tokens included in the corresponding input or output total.
+     */
+    imageTokens: number;
+    /**
+     * Text tokens included in the corresponding input or output total.
+     */
+    textTokens: number;
+}
 /**
  * Session event "tool_search.activated". Persisted generic client-side tool activations restored when a session resumes.
  */
@@ -9182,6 +9286,12 @@ export interface PermissionRequestedEvent {
  */
 export interface PermissionRequestedData {
     agentMode?: SessionMode;
+    /**
+     * Experimental HydraFusion attribution of the staged phase whose tool call raised this request. Absent outside a staged phase.
+     *
+     * @experimental
+     */
+    fusion?: FusionAttribution;
     /**
      * Delegated agent that owns permission recovery when the owner session multiplexes remote agents. Absent otherwise.
      */

package/dist/session.js

@@ -825,12 +825,12 @@ class CopilotSession {
         }
       }
     } else if (event.type === "permission.requested") {
-      const { requestId, permissionRequest, resolvedByHook } = event.data;
+      const { requestId, permissionRequest, promptRequest, resolvedByHook } = event.data;
       if (resolvedByHook) {
         return;
       }
       if (this.permissionHandler) {
-        void this._executePermissionAndRespond(requestId, permissionRequest);
+        void this._executePermissionAndRespond(requestId, permissionRequest, promptRequest);
       }
     } else if (event.type === "mcp.oauth_required") {
       const data = event.data;
@@ -989,12 +989,14 @@ class CopilotSession {
    * Executes a permission handler and sends the result back via RPC.
    * @internal
    */
-  async _executePermissionAndRespond(requestId, permissionRequest) {
+  async _executePermissionAndRespond(requestId, permissionRequest, promptRequest) {
     try {
-      const handlerResult = await this.permissionHandler(permissionRequest, {
+      const invocation = {
         sessionId: this.sessionId,
-        managedSettingsEnabled: this.managedSettingsEnabled
-      });
+        managedSettingsEnabled: this.managedSettingsEnabled,
+        ...promptRequest === void 0 ? {} : { promptRequest }
+      };
+      const handlerResult = await this.permissionHandler(permissionRequest, invocation);
       const isAttributed = isAttributedPermissionResult(handlerResult);
       const result = isAttributed ? handlerResult.result : handlerResult;
       const decisionContext = isAttributed ? handlerResult.decisionContext : void 0;

package/dist/types.d.ts

@@ -988,10 +988,11 @@ import type { PermissionDecisionRequest, PermissionDecisionContext } from "./gen
  * 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.
+ * On the raw `permissionRequest`, `managedApprovalRequired` preserves managed
+ * policy provenance and one-shot restrictions. To determine whether a human
+ * response is still required, hosts should prefer
+ * `event.data.promptRequest?.managedApprovalRequired` when `promptRequest` is
+ * present, and fall back to the raw marker for older runtimes.
  */
 export type PermissionRequest = GeneratedPermissionRequest & {
     readonly managedApprovalRequired?: boolean;
@@ -1036,10 +1037,23 @@ export declare function isAttributedPermissionResult(result: PermissionRequestRe
  * permission behavior.
  */
 export declare function createAttributedPermissionResult(result: PermissionRequestResult | AttributedPermissionResult, decisionContext: PermissionDecisionContext): AttributedPermissionResult;
-export type PermissionHandler = (request: PermissionRequest, invocation: {
+/**
+ * Context supplied with a permission request callback.
+ */
+export interface PermissionHandlerInvocation {
     sessionId: string;
     managedSettingsEnabled?: boolean;
-}) => Promise<PermissionRequestResult | AttributedPermissionResult> | PermissionRequestResult | AttributedPermissionResult;
+    /**
+     * Derived user-facing prompt context when supplied by the runtime.
+     *
+     * Managed requests retain their raw `managedApprovalRequired` marker. Only
+     * standard prompt kinds (`commands`, `read`, `write`, `url`, and
+     * `workflow`) can clear that human requirement after Assisted approval.
+     * For missing or other prompt kinds, keep the raw marker authoritative.
+     */
+    promptRequest?: PermissionRequestedData["promptRequest"];
+}
+export type PermissionHandler = (request: PermissionRequest, invocation: PermissionHandlerInvocation) => Promise<PermissionRequestResult | AttributedPermissionResult> | PermissionRequestResult | AttributedPermissionResult;
 /**
  * Approves permission requests when managed settings are disabled.
  */

package/package.json

@@ -5,8 +5,8 @@
         "url": "https://github.com/github/copilot-agent-runtime.git",
         "directory": "src/sdk/nodejs"
     },
-    "version": "1.0.23-preview.0",
-    "copilotCliVersion": "1.0.99-0",
+    "version": "1.0.23-preview.2",
+    "copilotCliVersion": "1.0.99-2",
     "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
     "main": "./dist/cjs/index.js",
     "types": "./dist/index.d.ts",
@@ -54,6 +54,7 @@
         "generate": "cd ../scripts/codegen && npm run generate",
         "set:cli-version": "node scripts/set-cli-version.js",
         "update:protocol-version": "tsx scripts/update-protocol-version.ts",
+        "vendor:tools": "tsx scripts/vendor-build-tools.ts",
         "prepublishOnly": "npm run build",
         "package": "npm run clean && npm run build && node scripts/set-version.js && npm run pack:release && npm version 0.0.0-dev --no-git-tag-version --allow-same-version"
     },
@@ -81,19 +82,26 @@
         "@typescript-eslint/parser": "^8.54.0",
         "esbuild": "^0.28.1",
         "eslint": "^9.0.0",
+        "file-entry-cache": "file:./scripts/eslint-file-cache",
         "glob": "^13.0.1",
         "hpke-js": "^1.8.0",
         "json-schema": "^0.4.0",
         "json-schema-to-typescript": "^15.0.4",
-        "prettier": "^3.8.1",
+        "prettier": "file:../../../third_party/build-tools/prettier-3.8.1",
         "rimraf": "^6.1.2",
         "semver": "^7.7.3",
         "tar": "^7.5.22",
-        "tsx": "^4.20.6",
+        "tsx": "file:../../../third_party/build-tools/tsx-4.22.4",
         "typescript": "^5.0.0",
+        "vite": "file:../../../third_party/build-tools/vite-8.3.4",
         "vitest": "^4.1.11",
         "ws": "^8.21.0"
     },
+    "overrides": {
+        "file-entry-cache": "$file-entry-cache",
+        "prettier": "$prettier",
+        "vite": "$vite"
+    },
     "engines": {
         "node": "^20.19.0 || >=22.12.0"
     },
@@ -104,18 +112,18 @@
         "README.md"
     ],
     "copilotRuntime": {
-        "sourceSha": "1911cf98510f24398cbeeb739a76d9b12b0c74dc",
-        "version": "1.0.99-0",
+        "sourceSha": "c9e96f9dbdbbce59d7e045d5abc3590136576cf7",
+        "version": "1.0.99-2",
         "visibility": "public"
     },
     "optionalDependencies": {
-        "@github/copilot-sdk-darwin-arm64": "1.0.23-preview.0",
-        "@github/copilot-sdk-darwin-x64": "1.0.23-preview.0",
-        "@github/copilot-sdk-linux-arm64": "1.0.23-preview.0",
-        "@github/copilot-sdk-linux-x64": "1.0.23-preview.0",
-        "@github/copilot-sdk-linuxmusl-arm64": "1.0.23-preview.0",
-        "@github/copilot-sdk-linuxmusl-x64": "1.0.23-preview.0",
-        "@github/copilot-sdk-win32-arm64": "1.0.23-preview.0",
-        "@github/copilot-sdk-win32-x64": "1.0.23-preview.0"
+        "@github/copilot-sdk-darwin-arm64": "1.0.23-preview.2",
+        "@github/copilot-sdk-darwin-x64": "1.0.23-preview.2",
+        "@github/copilot-sdk-linux-arm64": "1.0.23-preview.2",
+        "@github/copilot-sdk-linux-x64": "1.0.23-preview.2",
+        "@github/copilot-sdk-linuxmusl-arm64": "1.0.23-preview.2",
+        "@github/copilot-sdk-linuxmusl-x64": "1.0.23-preview.2",
+        "@github/copilot-sdk-win32-arm64": "1.0.23-preview.2",
+        "@github/copilot-sdk-win32-x64": "1.0.23-preview.2"
     }
 }