@github/copilot-sdk 1.0.13-preview.3 → 1.0.13-preview.6

package/dist/generated/rpc.d.ts

@@ -3,7 +3,7 @@
  * Generated from: api.schema.json
  */
 import type { MessageConnection } from "vscode-jsonrpc/node.js";
-import type { AbortReason, Attachment, AutoTier, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerSource, McpServerStatus, ModelChangeSource, PermissionMode, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, TaskCompleteData, TaskCompletionOutcome, UserToolSessionApproval, Verbosity } from "./session-events.js";
+import type { AbortReason, AgentModelPolicy, Attachment, AutoTier, ContextTier, EmbeddedBlobResourceContents, EmbeddedTextResourceContents, McpOauthHttpResponse, McpOauthWWWAuthenticateParams, McpServerSource, McpServerStatus, ModelChangeSource, PermissionMode, PermissionPromptRequest, PermissionRule, ReasoningSummary, SessionEvent, SessionLimitsConfig, SessionMode, ShutdownType, SkillSource, TaskCompleteData, TaskCompletionOutcome, UserToolSessionApproval, Verbosity } from "./session-events.js";
 /** A value that can be represented losslessly on the SDK JSON wire. */
 export type JsonValue = null | boolean | number | string | JsonValue[] | {
     [key: string]: JsonValue;
@@ -529,7 +529,13 @@ export type CatalogNetworkFailureReason =
  | "tls"
 /** The connection was refused or reset. */
  | "connection-refused"
-/** The authority returned a status the runtime treats as a failure. */
+/** The configured proxy returned 407 and requires authentication. */
+ | "proxy-authentication-required"
+/** The authority rate-limited requests and supplied or implied a bounded cooldown. */
+ | "rate-limited"
+/** The authority returned a transient 5xx response. */
+ | "service-unavailable"
+/** The authority returned another status the runtime treats as a failure. */
  | "http-status"
 /** The response exceeded the permitted size. */
  | "response-too-large"
@@ -824,6 +830,64 @@ export type DiscoveredExtensionMode =
  | "load_only"
 /** Extensions are loaded and the agent can create, reload, and manage them. */
  | "load_and_augment";
+/**
+ * Hook event name. Discovery emits the file-configurable subset; SDK callbacks additionally support callback-only events.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HookType".
+ */
+/** @experimental */
+export type HookType = 
+/** Runs before a tool is invoked. */
+"preToolUse"
+/** Runs before an MCP tool is invoked. */
+ | "preMcpToolCall"
+/** Runs after a tool completes successfully. */
+ | "postToolUse"
+/** Runs after a tool fails. */
+ | "postToolUseFailure"
+/** Runs after the user submits a prompt. */
+ | "userPromptSubmitted"
+/** Runs after the runtime transforms the submitted prompt for the model, before it is added to session history. */
+ | "userPromptTransformed"
+/** Runs when a session starts. */
+ | "sessionStart"
+/** Runs when a session ends. */
+ | "sessionEnd"
+/** Runs after an agent result is produced. */
+ | "postResult"
+/** Runs before a pull request description is generated. */
+ | "prePRDescription"
+/** Runs when the agent encounters an error. */
+ | "errorOccurred"
+/** Runs when the agent stops. */
+ | "agentStop"
+/** Runs when a subagent starts. */
+ | "subagentStart"
+/** Runs when a subagent stops. */
+ | "subagentStop"
+/** Runs before conversation context is compacted. */
+ | "preCompact"
+/** Runs when the agent requests permission. */
+ | "permissionRequest"
+/** Runs when the agent emits a notification. */
+ | "notification";
+/**
+ * Configuration tier that contributed a discovered hook action.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HookOrigin".
+ */
+/** @experimental */
+export type HookOrigin = 
+/** Hook loaded from user settings or the user's hook directory. */
+"user"
+/** Hook loaded from repository settings or the repository hook directory. */
+ | "repository"
+/** Hook provided by an enabled installed or explicit plugin. Projectless rows omit projectPath and do not expand a project directory. */
+ | "plugin"
+/** Hook enforced by centrally managed policy. */
+ | "policy";
 /**
  * Server transport type: stdio, http, sse (deprecated), or memory
  *
@@ -1075,6 +1139,15 @@ export type FactoryRunFailure = {
      * Factory failure variant discriminator.
      */
     type: "factory_accounting_incomplete";
+} | {
+    /**
+     * Factory run identifier.
+     */
+    runId: string;
+    /**
+     * Factory failure variant discriminator.
+     */
+    type: "factory_provider_disconnected";
 };
 /**
  * Cumulative resource ceiling that stopped a factory run.
@@ -4272,7 +4345,7 @@ export interface AgentGetCurrentResult {
     agent?: AgentInfo | null;
 }
 /**
- * Agent metadata, including identifiers, display details, source, tools, model, MCP servers, skills, and file path.
+ * Agent metadata, including identifiers, display details, source, tools, model, models, MCP servers, skills, and file path.
  *
  * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
  * via the `definition` "AgentInfo".
@@ -4312,6 +4385,11 @@ export interface AgentInfo {
      * Authored preferred model id for this agent. Runtime model selection may choose a different model; omitted means no authored preference.
      */
     model?: string;
+    /**
+     * Authored preferred model ids for this agent, in priority order. Runtime model selection chooses the first available model; omitted means no authored preference.
+     */
+    models?: string[];
+    modelPolicy?: AgentModelPolicy;
     /**
      * MCP server configurations attached to this agent, keyed by server name. Server config shape mirrors the MCP `mcpServers` schema.
      *
@@ -5527,6 +5605,10 @@ export interface CatalogNetworkFailureError {
      * HTTP status code, when the failure was a rejected response.
      */
     statusCode?: number;
+    /**
+     * Bounded cooldown in seconds before another catalog request should be attempted, when the authority supplied a numeric Retry-After value or the runtime applied its documented fallback.
+     */
+    retryAfterSeconds?: number;
     /**
      * Human-readable explanation, safe to surface. Never contains a query, URL, handle, or secret.
      */
@@ -5578,7 +5660,7 @@ export interface CatalogPolicyRejectedError {
 export interface CatalogSearchRequest {
     contract: CatalogClientContract;
     /**
-     * Free-text search query. Never written to logs or telemetry.
+     * Free-text search query. Persisted as tool input for session continuity, but omitted from telemetry.
      */
     query: string;
     /**
@@ -6425,6 +6507,37 @@ export interface DiscoveredExtensionsEnableRequest {
      */
     ids: string[];
 }
+/**
+ * One server-discovered hook action from user, repository, plugin, or managed-policy configuration.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "DiscoveredHook".
+ */
+/** @experimental */
+export interface DiscoveredHook {
+    /**
+     * Deterministic identifier for this server-discovered action row. It remains stable while the project, origin, source, event, action content, and duplicate ordinal are unchanged. This is row identity, not the key persisted in disabledHooks.
+     */
+    id: string;
+    hookType: HookType;
+    origin: HookOrigin;
+    /**
+     * Human-readable source label, such as a hook file path, settings source, or plugin name.
+     */
+    source?: string;
+    /**
+     * Input project path for which this server-side action was resolved. Set on every row returned for project-scoped discovery, including repeated user and policy actions.
+     */
+    projectPath?: string;
+    /**
+     * Whether this action is enabled under the server-side discovery settings. Concrete sessions may differ because they can add session-specific directories, plugins, or trust. False when its disable key is present in the user's disabled-hooks setting or disable-all settings suppress the action.
+     */
+    enabled: boolean;
+    /**
+     * Durable content hash used by hook enablement. Identical actions may intentionally share this key. Omitted when changing the user's disabled-hooks setting cannot change the action's current server-discovered state, including managed-policy hooks, session-start prompt actions, actions suppressed by disable-all settings, and projectless plugin actions that require project-directory expansion.
+     */
+    disableKey?: string;
+}
 /**
  * MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state.
  *
@@ -7761,6 +7874,10 @@ export interface FactoryRunResult {
      * Factory run identifier.
      */
     runId: string;
+    /**
+     * One-based execution attempt represented by this envelope. Absent before the first attempt starts or when returned by an older runtime.
+     */
+    attempt?: number;
     status: FactoryRunStatus;
     /**
      * Completed factory result.
@@ -8482,6 +8599,44 @@ export interface HistoryTruncateResult {
      */
     checkpointCleanupError?: string;
 }
+/**
+ * Optional project paths and host-exclusion behavior for server-scoped hook discovery.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HooksDiscoverRequest".
+ */
+/** @experimental */
+export interface HooksDiscoverRequest {
+    /**
+     * Optional project directory paths whose trusted repository and project-expanded plugin hooks should be discovered. When omitted or empty, user, managed-policy, and globally enabled installed or explicit plugin hooks are returned without project expansion.
+     */
+    projectPaths?: string[];
+    /**
+     * When true, omit host-owned user and plugin hook rows and their diagnostics. Managed-policy hooks and trusted repository hooks remain visible, and host disabledHooks still contribute to each remaining row's effective enabled state. This filters sources rather than simulating a host with no settings.
+     */
+    excludeHostHooks?: boolean;
+}
+/**
+ * Server-discovered hook actions and partial-load diagnostics from user, repository, plugin, and managed-policy sources. Concrete sessions may include additional session-specific hook sources.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HooksDiscoverResult".
+ */
+/** @experimental */
+export interface HooksDiscoverResult {
+    /**
+     * All discovered hook actions. Byte-identical actions remain separate rows even when they share a disable key.
+     */
+    hooks: DiscoveredHook[];
+    /**
+     * Non-fatal source-loading warnings. Discovery remains complete for the affected source, although the source had a recoverable issue. Repository-settings warnings are prefixed with their project path when attribution is available.
+     */
+    warnings: string[];
+    /**
+     * Errors for hook sources or actions that could not be loaded, making the result partially incomplete. Other valid actions are still returned. Project-resolution and repository-settings errors are prefixed with their project path.
+     */
+    errors: string[];
+}
 /**
  * Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source.
  *
@@ -11704,6 +11859,10 @@ export interface ModelBillingPromo {
      * Human-readable promotion message. Does not include the expiry timestamp; consumers may format endsAt and append it when present.
      */
     message?: string;
+    /**
+     * Whether the service asked hosts to give this promotion a prominent surface, such as a dedicated banner, in addition to listing it with the model. `true` requests that surface and `false` asks for the model list only. Absent means the service expressed no preference — for example a response that predates the field — so hosts should apply their own default rather than read it as `false`.
+     */
+    showBanner?: boolean;
 }
 /**
  * Service-published warning text that hosts should display when presenting a model.
@@ -11751,6 +11910,10 @@ export interface ModelApplyStartupOverlayRequest {
      * Model required by server-managed policy, when configured.
      */
     serverManagedModel?: string;
+    /**
+     * Startup default model from the enterprise policy helper, when configured. Weakest of the managed sources: it applies only when neither device nor server policy names a model, and an explicit user selection still wins.
+     */
+    policyHelperModel?: string;
     /**
      * Model selected by repository settings, when configured.
      */
@@ -15189,6 +15352,10 @@ export interface QueuePendingItems {
      * Stable opaque id for the canonical queued item. Batch rows share one id.
      */
     id: string;
+    /**
+     * Stable identity of the queued user message. Present for message rows and absent for slash commands and model changes.
+     */
+    messageId?: string;
     kind: QueuePendingItemsKind;
     /**
      * Human-readable text to display for this queue entry in the UI
@@ -15817,7 +15984,7 @@ export interface SandboxConfigUserPolicyNetwork {
 /** @experimental */
 export interface SandboxConfigUserPolicyNetworkProxy {
     /**
-     * Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the scheme's standard port when omitted. Credentials must not be embedded here — a `user:pass@` authority is rejected; put them in the separate `username`/`password` fields. A credential-free http:// loopback URL is routed through the localhost proxy automatically; loopback covers localhost and any *.localhost subdomain, the whole 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or one with a username/password set, is used as-is.
+     * Proxy URL (e.g. http://proxy.example.com:8080). The port is optional and defaults to the scheme's standard port when omitted; an explicit port must be between 1 and 65535. Credentials must not be embedded here — a `user:pass@` authority is rejected; put them in the separate `username`/`password` fields. A credential-free http:// loopback proxy URL is routed through the localhost proxy automatically; loopback covers localhost and any *.localhost subdomain, the whole 127.0.0.0/8 range, ::1, and IPv4-mapped loopback (::ffff:127.0.0.1). An https:// URL, or one with a username/password set, is used as-is.
      */
     url: string;
     /**
@@ -17560,6 +17727,10 @@ export interface SessionOpenOptions {
      * Additional directories to search for skills.
      */
     skillDirectories?: string[];
+    /**
+     * Whether skill loading is enabled. When omitted, an SDK skill provider enables skills by default.
+     */
+    enableSkills?: boolean;
     /**
      * Built-in skill names to include in this session. When specified, only these runtime-bundled skills are available. Skills from other sources with the same name remain available.
      */
@@ -18698,6 +18869,28 @@ export interface SessionsPruneOldRequest {
      */
     excludeSessionIds?: string[];
 }
+/**
+ * Pagination options for reading an inactive or active local session's persisted event journal.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "SessionsReadPersistedEventsRequest".
+ */
+/** @experimental */
+export interface SessionsReadPersistedEventsRequest {
+    /**
+     * Session ID whose persisted event journal should be read.
+     */
+    sessionId: string;
+    /**
+     * Opaque cursor returned by a previous persisted-event read. Omit on the first call.
+     */
+    cursor?: string;
+    /**
+     * Maximum number of events to return in this batch (1–1000, default 200).
+     */
+    max?: number;
+    direction?: EventsReadDirection;
+}
 /**
  * Session ID whose in-use lock should be released.
  *
@@ -19065,7 +19258,7 @@ export interface SessionUpdateOptionsParams {
      */
     enableSessionStore?: boolean;
     /**
-     * Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset.
+     * Whether skill loading is enabled. Explicit false disables every source, including a bound SDK provider; changing the value invalidates the loaded skill snapshot. When omitted, creation falls back to enableConfigDiscovery unless an SDK skill provider is registered.
      */
     enableSkills?: boolean;
     contextTier?: OptionsUpdateContextTier;
@@ -19286,6 +19479,35 @@ export interface SkillList {
      */
     skills: Skill[];
 }
+/**
+ * Catalog-only metadata for one SDK-provided skill. The complete SKILL.md is fetched separately and lazily.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "SkillProviderDescriptor".
+ */
+/** @experimental */
+export interface SkillProviderDescriptor {
+    /**
+     * Invocation and display name.
+     */
+    name: string;
+    /**
+     * Description used in skill catalogs without fetching content.
+     */
+    description: string;
+    /**
+     * Whether users may invoke the skill directly. Defaults to true.
+     */
+    userInvocable?: boolean;
+    /**
+     * Whether model invocation is disabled. Defaults to false.
+     */
+    disableModelInvocation?: boolean;
+    /**
+     * Optional freeform argument hint used by slash-command catalogs.
+     */
+    argumentHint?: string;
+}
 /**
  * Skill names to mark as disabled in global configuration, replacing any previous list.
  *
@@ -19406,7 +19628,7 @@ export interface SkillsInvokedSkill {
      */
     name: string;
     /**
-     * Path to the SKILL.md file
+     * Path to the SKILL.md file, or an empty string for an SDK-provided skill without a filesystem identity
      */
     path: string;
     /**
@@ -19417,6 +19639,10 @@ export interface SkillsInvokedSkill {
      * Tools that should be auto-approved when this skill is active, captured at invocation time
      */
     allowedTools?: string[];
+    /**
+     * Whether model invocation was disabled when this skill was invoked
+     */
+    disableModelInvocation?: boolean;
     /**
      * Turn number when the skill was invoked
      */
@@ -19516,6 +19742,7 @@ export interface SlashCommandCompletedResult {
      * Optional user-facing message describing the completed command
      */
     message?: string;
+    mode?: SessionMode;
     /**
      * True when the invocation mutated user runtime settings; consumers caching settings should refresh
      */
@@ -19697,6 +19924,7 @@ export interface SubagentSettingsEntry {
      * Model override for matching subagents
      */
     model?: string;
+    modelPolicy?: AgentModelPolicy;
     /**
      * Reasoning effort override for matching subagents
      */
@@ -21999,6 +22227,19 @@ export interface SessionLimitPredictionPredictRequest {
     modelId?: string;
     clientType?: SessionLimitPredictionClientType;
 }
+/**
+ * Identifies the target session.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "SkillProviderListRequest".
+ */
+/** @experimental */
+export interface SkillProviderListRequest {
+    /**
+     * Target session identifier
+     */
+    sessionId: string;
+}
 /**
  * Identifies the target session.
  *
@@ -22025,6 +22266,17 @@ export declare function createServerRpc(connection: MessageConnection): {
      */
     ping: (params: PingRequest) => Promise<PingResult>;
     /** @experimental */
+    hooks: {
+        /**
+         * Discovers hook actions enabled under server-side discovery settings from user, repository, plugin, and managed-policy sources.
+         *
+         * @param params Optional project paths and host-exclusion behavior for server-scoped hook discovery.
+         *
+         * @returns Server-discovered hook actions and partial-load diagnostics from user, repository, plugin, and managed-policy sources. Concrete sessions may include additional session-specific hook sources.
+         */
+        discover: (params: HooksDiscoverRequest) => Promise<HooksDiscoverResult>;
+    };
+    /** @experimental */
     models: {
         /**
          * Lists Copilot models available to the authenticated user.
@@ -22492,6 +22744,14 @@ export declare function createServerRpc(connection: MessageConnection): {
          * @returns Sessions matching the filter, ordered most-recently-modified first.
          */
         list: (params: SessionsListRequest) => Promise<SessionList>;
+        /**
+         * Reads a page of durable events directly from a local session's persisted journal without creating, resuming, or activating the session. The initial backward read uses a bounded tail scan for fast first paint; cursor continuations preserve the session event-log paging semantics. Persisted events may omit payloads that are reconstructed only for an active session.
+         *
+         * @param params Pagination options for reading an inactive or active local session's persisted event journal.
+         *
+         * @returns Batch of session events returned by a read, with cursor and continuation metadata.
+         */
+        readPersistedEvents: (params: SessionsReadPersistedEventsRequest) => Promise<EventsReadResult>;
         /**
          * Finds the local session bound to a GitHub task ID, if any.
          *

package/dist/generated/rpc.js

@@ -11,6 +11,17 @@ function createServerRpc(connection) {
      */
     ping: async (params) => connection.sendRequest("ping", params),
     /** @experimental */
+    hooks: {
+      /**
+       * Discovers hook actions enabled under server-side discovery settings from user, repository, plugin, and managed-policy sources.
+       *
+       * @param params Optional project paths and host-exclusion behavior for server-scoped hook discovery.
+       *
+       * @returns Server-discovered hook actions and partial-load diagnostics from user, repository, plugin, and managed-policy sources. Concrete sessions may include additional session-specific hook sources.
+       */
+      discover: async (params) => connection.sendRequest("hooks.discover", params)
+    },
+    /** @experimental */
     models: {
       /**
        * Lists Copilot models available to the authenticated user.
@@ -478,6 +489,14 @@ function createServerRpc(connection) {
        * @returns Sessions matching the filter, ordered most-recently-modified first.
        */
       list: async (params) => connection.sendRequest("sessions.list", params),
+      /**
+       * Reads a page of durable events directly from a local session's persisted journal without creating, resuming, or activating the session. The initial backward read uses a bounded tail scan for fast first paint; cursor continuations preserve the session event-log paging semantics. Persisted events may omit payloads that are reconstructed only for an active session.
+       *
+       * @param params Pagination options for reading an inactive or active local session's persisted event journal.
+       *
+       * @returns Batch of session events returned by a read, with cursor and continuation metadata.
+       */
+      readPersistedEvents: async (params) => connection.sendRequest("sessions.readPersistedEvents", params),
       /**
        * Finds the local session bound to a GitHub task ID, if any.
        *