@github/copilot-sdk 1.0.25 → 1.0.26-preview.0

package/dist/generated/rpc.d.ts

@@ -2591,6 +2591,41 @@ export type HistoryRewindOutcome =
  | "checkpoint-cleanup-failed"
 /** Files and conversation were rewound, but obsolete file snapshots could not be removed; only conversation-and-files rewinds produce this. */
  | "snapshot-prune-failed";
+/**
+ * Validated admission credential, or null when the application rejects it.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostAuthenticateResult".
+ */
+/** @experimental */
+export type HostAuthenticateResult = HostAuthenticationResult | null;
+/**
+ * Explicit host-wide session admission policy.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostAuthentication".
+ */
+/** @experimental */
+export type HostAuthentication = {
+    /**
+     * Host-wide admission mode discriminator.
+     */
+    mode: "github";
+} | {
+    /**
+     * Host-wide admission mode discriminator.
+     */
+    mode: "none";
+} | {
+    /**
+     * Host-wide admission mode discriminator.
+     */
+    mode: "custom";
+    /**
+     * Stable nonempty owner identity; validated identities must match exactly.
+     */
+    requireIdentity: string;
+};
 /** @experimental */
 export type HostExitReason = 
 /** The owner requested disposal. */
@@ -2601,6 +2636,37 @@ export type HostExitReason =
  | "ownerDisconnected"
 /** The runtime is shutting down. */
  | "runtimeShutdown";
+/**
+ * Trusted admission context, not inference authentication or session configuration.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostSessionAuthentication".
+ */
+/** @experimental */
+export type HostSessionAuthentication = {
+    /**
+     * Trusted admission mode discriminator.
+     */
+    mode: "github";
+    /**
+     * Verified host account identity.
+     */
+    identity: string;
+} | {
+    /**
+     * Trusted admission mode discriminator.
+     */
+    mode: "custom";
+    /**
+     * Verified application identity.
+     */
+    identity: string;
+} | {
+    /**
+     * Trusted admission mode discriminator.
+     */
+    mode: "none";
+};
 /**
  * A supported image-service operation.
  *
@@ -5962,32 +6028,13 @@ export type StaffUpdateChannelMigrationStatus =
 /** The account is on the experimental channel, which the migration deliberately leaves alone, and the migration is recorded as done. */
  | "excluded-experimental";
 /**
- * Subagent settings to apply, or null to clear the live session override
+ * Configured subagent settings, or null when absent
  *
  * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
  * via the `definition` "SubagentSettings".
  */
 /** @experimental */
-export type SubagentSettings = {
-    /**
-     * Per-agent settings keyed by subagent agent_type
-     */
-    agents?: {
-        [k: string]: SubagentSettingsEntry | undefined;
-    };
-    /**
-     * Names of subagents the user has turned off; they cannot be dispatched
-     */
-    disabledSubagents?: string[];
-    /**
-     * Maximum number of subagents that can run concurrently; applies to usage-based billing users only
-     */
-    maxConcurrency?: number;
-    /**
-     * Maximum subagent nesting depth; applies to usage-based billing users only
-     */
-    maxDepth?: number;
-} | null;
+export type SubagentSettings = SubagentSettingsConfig | null;
 /**
  * Context tier override for matching subagents
  *
@@ -11778,6 +11825,19 @@ export interface ConnectRemoteSessionParams {
      */
     sessionId: string;
 }
+/**
+ * The host application's Microsoft Entra registration, shared by its sessions. This identifies the application requesting tokens, not their target resource.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "EntraAuthConfig".
+ */
+/** @experimental */
+export interface EntraAuthConfig {
+    /**
+     * Application (client) ID of the host's Microsoft Entra registration. Must be nonblank. The runtime does not supply a default application.
+     */
+    clientId: string;
+}
 /**
  * Local file system absolute paths within the session working directory to check against its content-exclusion policy.
  *
@@ -14122,6 +14182,70 @@ export interface HooksDiscoverResult {
      */
     errors: string[];
 }
+/**
+ * A decrypted credential presented by a supervised hosting participant.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostAuthenticateRequest".
+ */
+/** @experimental */
+export interface HostAuthenticateRequest {
+    /**
+     * Unique validation attempt, scoped to this host.
+     */
+    requestId: string;
+    /**
+     * Decrypted admission token, never an inference credential.
+     */
+    token: string;
+}
+/**
+ * A validated credential with a required, future RFC3339 expiration.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostAuthenticationResult".
+ */
+/** @experimental */
+export interface HostAuthenticationResult {
+    /**
+     * Stable identity, required to match the configured owner exactly.
+     */
+    identity: string;
+    /**
+     * Required future expiration in RFC3339 format.
+     */
+    expiresAt: string;
+}
+/**
+ * Notifies the owning application that validation ended.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostAuthenticationCancelledNotification".
+ */
+/** @experimental */
+export interface HostAuthenticationCancelledNotification {
+    /**
+     * Owning listener UUID.
+     */
+    hostId: string;
+    /**
+     * Validation attempt whose signal must be aborted.
+     */
+    requestId: string;
+}
+/**
+ * Cancels a pending validation on the supervised participant's connection.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostCancelAuthenticationRequest".
+ */
+/** @experimental */
+export interface HostCancelAuthenticationRequest {
+    /**
+     * Validation attempt to cancel.
+     */
+    requestId: string;
+}
 /**
  * Normalized listener settings delivered only to the supervised hosting participant.
  *
@@ -14130,6 +14254,7 @@ export interface HooksDiscoverResult {
  */
 /** @experimental */
 export interface HostConfiguration {
+    authentication?: HostAuthentication;
     localServer?: HostLocalServerConfiguration;
     githubEnvironment?: HostGitHubEnvironmentOptions;
     /**
@@ -14140,6 +14265,10 @@ export interface HostConfiguration {
      * Whether app-owned durable sessions are resumed by the owning application.
      */
     resumeFactory: boolean;
+    /**
+     * Initial remote creation policy, independent of application session factories. Defaults to denied when omitted.
+     */
+    allowCreatingNewSessions?: boolean;
 }
 /**
  * Normalized local WebSocket listener settings.
@@ -14437,6 +14566,7 @@ export interface HostRegisterSessionRequest {
  */
 /** @experimental */
 export interface HostSessionCreateCallback {
+    authentication?: HostSessionAuthentication;
     /**
      * Listener UUID identifying the owning application's host.
      */
@@ -14464,6 +14594,7 @@ export interface HostSessionCreateCallback {
  */
 /** @experimental */
 export interface HostSessionCreateRequest {
+    authentication?: HostSessionAuthentication;
     /**
      * Unique identity for this participation, independent of the session lifetime.
      */
@@ -14527,6 +14658,23 @@ export interface HostSessionReleaseRequest {
      */
     handoffId: string;
 }
+/**
+ * Changes remote session creation admission without disconnecting clients.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostSetSessionCreationPolicyRequest".
+ */
+/** @experimental */
+export interface HostSetSessionCreationPolicyRequest {
+    /**
+     * Listener UUID owned by the calling SDK connection.
+     */
+    hostId: string;
+    /**
+     * After acknowledgement, subsequent remote creation admissions use this policy. Already-admitted requests may finish.
+     */
+    allowCreatingNewSessions: boolean;
+}
 /**
  * Starts a supervised AHP host with at least one explicitly selected transport.
  *
@@ -14539,6 +14687,7 @@ export interface HostStartRequest {
      * Caller-generated UUID identifying this connection-owned listener.
      */
     hostId: string;
+    authentication?: HostAuthentication;
     /**
      * Stable application identity selecting its durable host catalog. Defaults to the persisted runtime compute GUID; must agree with githubEnvironment.computeId when both are supplied.
      */
@@ -14553,6 +14702,10 @@ export interface HostStartRequest {
      * Ask the owning application to resume its durable AHP sessions.
      */
     resumeFactory?: boolean;
+    /**
+     * Whether remote clients may create new sessions. Defaults to denied when omitted. Does not restrict owner work, publication, or existing sessions.
+     */
+    allowCreatingNewSessions?: boolean;
 }
 /**
  * Listener readiness, returned only after binding and the supervised participant's SDK handshake.
@@ -14626,6 +14779,27 @@ export interface HostUnregisterSessionRequest {
      */
     sessionId: string;
 }
+/**
+ * Application-owned token validation callback.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostValidateAuthenticationRequest".
+ */
+/** @experimental */
+export interface HostValidateAuthenticationRequest {
+    /**
+     * Owning listener UUID.
+     */
+    hostId: string;
+    /**
+     * Unique validation attempt.
+     */
+    requestId: string;
+    /**
+     * Decrypted admission token.
+     */
+    token: string;
+}
 /**
  * The runtime-selected image model and its account availability. Availability is independent of per-session image-generation enablement and does not override session policy or permissions.
  *
@@ -22361,6 +22535,20 @@ export interface ProtocolImageGenerationOptions {
      * @experimental
      */
     watermark?: boolean;
+    /**
+     * Experimental. Save each generated or edited image under the session-state
+     * directory's `images` folder and add a `saved_to: <path>` line per image to
+     * the tool result the model sees. Defaults to true; set false to opt out.
+     * Subagents follow their
+     * parent's value unless they set their own. A failed save still returns the
+     * image, without `saved_to`. Sessions without a local session-state
+     * directory, such as those using a session filesystem provider, never save.
+     * Re-supply after a cold resume. Does not enable image generation.
+     * This option may change or be removed in a future release.
+     *
+     * @experimental
+     */
+    saveToDisk?: boolean;
 }
 /**
  * BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both.
@@ -24699,6 +24887,28 @@ export interface SecretsAddFilterValuesResult {
      */
     ok: true;
 }
+/**
+ * Internal request-correlated completion of one submitted message.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "SendAndWaitResult".
+ */
+/** @experimental */
+export interface SendAndWaitResult {
+    /**
+     * Identifier assigned to the submitted user message.
+     */
+    messageId: string;
+    response?: SessionEvent;
+    /**
+     * Whether the request was aborted or removed before completing normally.
+     */
+    aborted: boolean;
+    /**
+     * Existing event at the completion boundary. SDK helpers drain its synchronous subscriber delivery before returning. Absent for quiet queue removal.
+     */
+    completionEventId?: string;
+}
 /**
  * Parameters for session.extensions.sendAttachmentsToMessage.
  *
@@ -29002,6 +29212,37 @@ export interface SlashCommandSetPlanModelResult {
      */
     runtimeSettingsChanged?: boolean;
 }
+/**
+ * Configured per-agent subagent overrides
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "SubagentSettingsConfig".
+ */
+/** @experimental */
+export interface SubagentSettingsConfig {
+    /**
+     * Per-agent settings keyed by subagent agent_type
+     */
+    agents?: {
+        [k: string]: SubagentSettingsEntry | undefined;
+    };
+    /**
+     * Configured opt-in for subagent context management tools; applied from persisted settings when the session starts
+     */
+    contextManagementTools?: boolean;
+    /**
+     * Names of subagents the user has turned off; they cannot be dispatched
+     */
+    disabledSubagents?: string[];
+    /**
+     * Maximum number of subagents that can run concurrently; applies to usage-based billing users only
+     */
+    maxConcurrency?: number;
+    /**
+     * Maximum subagent nesting depth; applies to usage-based billing users only
+     */
+    maxDepth?: number;
+}
 /**
  * Subagent model, reasoning effort, context tier, and auto-invocation settings
  *
@@ -29014,6 +29255,10 @@ export interface SubagentSettingsEntry {
      * Model override for matching subagents
      */
     model?: string;
+    /**
+     * Provider identifier for the configured model override
+     */
+    providerId?: string;
     modelPolicy?: AgentModelPolicy;
     /**
      * Reasoning effort override for matching subagents
@@ -30039,6 +30284,19 @@ export interface ToolsGetCurrentMetadataResult {
      */
     tools: CurrentToolMetadata[] | null;
 }
+/**
+ * Current configured subagent settings for the session, before resolving defaults or inheritance.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "ToolsGetSubagentSettingsResult".
+ */
+/** @experimental */
+export interface ToolsGetSubagentSettingsResult {
+    /**
+     * Live subagent settings override, or current persisted settings when no override is active; null when no settings block exists
+     */
+    subagents?: SubagentSettings | null;
+}
 /**
  * Resolve, build, and validate the runtime tool list for this session. Subagent sessions and consumer flows that need an initialized tool set before `send` invoke this. Default base-class implementation is a no-op for sessions that don't support tool validation.
  *
@@ -32947,6 +33205,7 @@ export interface HostCreateSessionResult {
  */
 /** @experimental */
 export interface HostCreateSessionRequest {
+    authentication?: HostSessionAuthentication;
     /**
      * Unique identity for this participation, independent of the session lifetime.
      */
@@ -32998,6 +33257,15 @@ export interface HostReleaseSessionRequest {
 /** @experimental */
 export interface HostDisposeResult {
 }
+/**
+ * Empty acknowledgement for a completed host lifecycle operation.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostSetSessionCreationPolicyResult".
+ */
+/** @experimental */
+export interface HostSetSessionCreationPolicyResult {
+}
 /**
  * Private credentials delivered only to a runtime-owned Mission Control hosting participant.
  *
@@ -33031,6 +33299,7 @@ export interface HostGetEnvironmentCredentialsResult {
  */
 /** @experimental */
 export interface HostGetConfigurationResult {
+    authentication?: HostAuthentication;
     localServer?: HostLocalServerConfiguration;
     githubEnvironment?: HostGitHubEnvironmentOptions;
     /**
@@ -33041,6 +33310,44 @@ export interface HostGetConfigurationResult {
      * Whether app-owned durable sessions are resumed by the owning application.
      */
     resumeFactory: boolean;
+    /**
+     * Initial remote creation policy, independent of application session factories. Defaults to denied when omitted.
+     */
+    allowCreatingNewSessions?: boolean;
+}
+/**
+ * Private credentials delivered only to a runtime-owned Mission Control hosting participant.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostGetAuthenticationCredentialsResult".
+ */
+/** @experimental */
+export interface HostGetAuthenticationCredentialsResult {
+    /**
+     * Current bearer token for the authenticated GitHub identity.
+     */
+    token: string;
+    /**
+     * Hostname of the authenticated GitHub service.
+     */
+    githubHost: string;
+    /**
+     * GitHub API base URL for the authenticated service.
+     */
+    githubApiUrl: string;
+    /**
+     * Mission Control API origin for environment registration and management.
+     */
+    missionControlUrl: string;
+}
+/**
+ * Empty acknowledgement for a completed host lifecycle operation.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostCancelAuthenticationResult".
+ */
+/** @experimental */
+export interface HostCancelAuthenticationResult {
 }
 /**
  * Empty acknowledgement for a completed host lifecycle operation.
@@ -33583,6 +33890,7 @@ export interface HostMaterializeSessionResult {
  */
 /** @experimental */
 export interface HostMaterializeSessionRequest {
+    authentication?: HostSessionAuthentication;
     /**
      * Listener UUID identifying the owning application's host.
      */
@@ -33619,6 +33927,23 @@ export interface HostSessionReleasedRequest {
      */
     handoffId: string;
 }
+/**
+ * Notifies the owning application that validation ended.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "HostAuthenticationCancelledRequest".
+ */
+/** @experimental */
+export interface HostAuthenticationCancelledRequest {
+    /**
+     * Owning listener UUID.
+     */
+    hostId: string;
+    /**
+     * Validation attempt whose signal must be aborted.
+     */
+    requestId: string;
+}
 /**
  * Empty acknowledgement for a completed host lifecycle operation.
  *
@@ -33906,6 +34231,14 @@ export declare function createServerRpc(connection: MessageConnection): {
          * @returns Empty acknowledgement for a completed host lifecycle operation.
          */
         dispose: (params: HostDisposeRequest) => Promise<HostDisposeResult>;
+        /**
+         * Changes remote creation admission on a host owned by this SDK connection without disconnecting clients. Acknowledgement means subsequent admissions use the new policy; already-admitted creation may complete.
+         *
+         * @param params Changes remote session creation admission without disconnecting clients.
+         *
+         * @returns Empty acknowledgement for a completed host lifecycle operation.
+         */
+        setSessionCreationPolicy: (params: HostSetSessionCreationPolicyRequest) => Promise<HostSetSessionCreationPolicyResult>;
     };
     /**
      * Checks server responsiveness and returns protocol information.
@@ -36355,7 +36688,13 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
          */
         set: (params: ToolsSetRequest) => Promise<ToolsSetResult>;
         /**
-         * Sets the current session's live subagent settings override, which takes precedence over persisted user settings until cleared. Persisted user settings remain the source of truth for future sessions.
+         * Returns the session's live subagent settings override, or the current persisted user settings when no override is active. Returns null in subagents when no settings block exists; defaults, model inheritance, and billing limits are not resolved. Persisted settings are loaded strictly, including before the first turn, and loading errors are reported. Reading does not change the session or persist settings. Read-modify-write with updateSubagentSettings is not atomic; writing back creates a live override that ignores later persisted changes until cleared.
+         *
+         * @returns Current configured subagent settings for the session, before resolving defaults or inheritance.
+         */
+        getSubagentSettings: () => Promise<ToolsGetSubagentSettingsResult>;
+        /**
+         * Replaces the current session's complete live subagent settings override; nested fields are not merged. The override takes precedence over persisted user settings until cleared. Persisted user settings remain the source of truth for future sessions.
          *
          * @param params Subagent settings to apply to the current session
          *

package/dist/generated/rpc.js

@@ -204,7 +204,15 @@ function createServerRpc(connection) {
        *
        * @returns Empty acknowledgement for a completed host lifecycle operation.
        */
-      dispose: async (params) => connection.sendRequest("host.dispose", params)
+      dispose: async (params) => connection.sendRequest("host.dispose", params),
+      /**
+       * Changes remote creation admission on a host owned by this SDK connection without disconnecting clients. Acknowledgement means subsequent admissions use the new policy; already-admitted creation may complete.
+       *
+       * @param params Changes remote session creation admission without disconnecting clients.
+       *
+       * @returns Empty acknowledgement for a completed host lifecycle operation.
+       */
+      setSessionCreationPolicy: async (params) => connection.sendRequest("host.setSessionCreationPolicy", params)
     },
     /**
      * Checks server responsiveness and returns protocol information.
@@ -1674,6 +1682,28 @@ function createInternalServerRpc(connection) {
        * @returns Normalized listener settings delivered only to the supervised hosting participant.
        */
       getConfiguration: async () => connection.sendRequest("host.getConfiguration", {}),
+      /**
+       * Resolves the host account credential without applying Mission Control transport policy, only for its supervised GitHub hosting participant.
+       *
+       * @returns Private credentials delivered only to a runtime-owned Mission Control hosting participant.
+       */
+      getAuthenticationCredentials: async () => connection.sendRequest("host.getAuthenticationCredentials", {}),
+      /**
+       * Validates a decrypted admission credential through the owning application, only for its supervised custom-authentication participant.
+       *
+       * @param params A decrypted credential presented by a supervised hosting participant.
+       *
+       * @returns Validated admission credential, or null when the application rejects it.
+       */
+      authenticate: async (params) => connection.sendRequest("host.authenticate", params),
+      /**
+       * Cancels a supervised participant's pending admission validation.
+       *
+       * @param params Cancels a pending validation on the supervised participant's connection.
+       *
+       * @returns Empty acknowledgement for a completed host lifecycle operation.
+       */
+      cancelAuthentication: async (params) => connection.sendRequest("host.cancelAuthentication", params),
       /**
        * Reports a supervised hosting participant's bound AHP endpoint after its SDK handshake.
        *
@@ -3532,7 +3562,13 @@ function createSessionRpc(connection, sessionId) {
        */
       set: async (params) => connection.sendRequest("session.tools.set", { ...params, sessionId }),
       /**
-       * Sets the current session's live subagent settings override, which takes precedence over persisted user settings until cleared. Persisted user settings remain the source of truth for future sessions.
+       * Returns the session's live subagent settings override, or the current persisted user settings when no override is active. Returns null in subagents when no settings block exists; defaults, model inheritance, and billing limits are not resolved. Persisted settings are loaded strictly, including before the first turn, and loading errors are reported. Reading does not change the session or persist settings. Read-modify-write with updateSubagentSettings is not atomic; writing back creates a live override that ignores later persisted changes until cleared.
+       *
+       * @returns Current configured subagent settings for the session, before resolving defaults or inheritance.
+       */
+      getSubagentSettings: async () => connection.sendRequest("session.tools.getSubagentSettings", { sessionId }),
+      /**
+       * Replaces the current session's complete live subagent settings override; nested fields are not merged. The override takes precedence over persisted user settings until cleared. Persisted user settings remain the source of truth for future sessions.
        *
        * @param params Subagent settings to apply to the current session
        *
@@ -4292,6 +4328,16 @@ function createSessionRpc(connection, sessionId) {
 }
 function createInternalSessionRpc(connection, sessionId) {
   return {
+    /**
+     * Submits one message through normal admission and waits for its request-owned completion. Returns the exact root assistant event, or an explicit aborted/no-response outcome. Cancelling or timing out the wait does not abort agent work. Unsupported execution hosts reject the method before admitting the message.
+     *
+     * @param params Parameters for sending a user message to the session
+     *
+     * @returns Internal request-correlated completion of one submitted message.
+     *
+     * @experimental
+     */
+    sendAndWait: async (params) => connection.sendRequest("session.sendAndWait", { ...params, sessionId }),
     /**
      * Queues or sends an internal system notification to the session according to its passive policy.
      *