Port upstream sync: require permission handler, new events, agent/compaction APIs

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>

Author: Copilot

.lastmerge

@@ -1 +1 @@
-f0909a78ce6c242f1f07e91b72ab7a7d8c910531
+b9f746ab1b9c5f31af03a6f8a6cf4e680b3fd6b8

CHANGELOG.md

@@ -8,17 +8,34 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
-> **Upstream sync:** [`github/copilot-sdk@c263dfc`](https://github.com/github/copilot-sdk/commit/c263dfc69055f9f28ee2d4b121cf617fca5a42dc)
+> **Upstream sync:** [`github/copilot-sdk@b9f746a`](https://github.com/github/copilot-sdk/commit/b9f746ab1b9c5f31af03a6f8a6cf4e680b3fd6b8)
 
 ### Added
 
-- `SessionConfig.setClientName(String)` / `getClientName()` — identifies the application using the SDK; included in the User-Agent header for API requests (upstream: [`397ef66`](https://github.com/github/copilot-sdk/commit/397ef66))
-- `ResumeSessionConfig.setClientName(String)` / `getClientName()` — same for resumed sessions
-- `PermissionHandler.APPROVE_ALL` — pre-built handler that approves all permission requests (upstream: [`3e2d2b2`](https://github.com/github/copilot-sdk/commit/3e2d2b2))
+- `CopilotSession.listAgents()` — lists custom agents available for selection (upstream: [`9d998fb`](https://github.com/github/copilot-sdk/commit/9d998fb))
+- `CopilotSession.getCurrentAgent()` — gets the currently selected custom agent (upstream: [`9d998fb`](https://github.com/github/copilot-sdk/commit/9d998fb))
+- `CopilotSession.selectAgent(String)` — selects a custom agent for the session (upstream: [`9d998fb`](https://github.com/github/copilot-sdk/commit/9d998fb))
+- `CopilotSession.deselectAgent()` — deselects the current custom agent (upstream: [`9d998fb`](https://github.com/github/copilot-sdk/commit/9d998fb))
+- `CopilotSession.compact()` — triggers immediate session context compaction (upstream: [`9d998fb`](https://github.com/github/copilot-sdk/commit/9d998fb))
+- `AgentInfo` — new JSON type representing a custom agent with `name`, `displayName`, and `description` (upstream: [`9d998fb`](https://github.com/github/copilot-sdk/commit/9d998fb))
+- New event types: `SessionTaskCompleteEvent` (`session.task_complete`), `AssistantStreamingDeltaEvent` (`assistant.streaming_delta`), `SubagentDeselectedEvent` (`subagent.deselected`) (upstream: various commits)
+- `AssistantTurnStartEvent` data now includes `interactionId` field
+- `AssistantMessageEvent` data now includes `interactionId` field
+- `ToolExecutionCompleteEvent` data now includes `model` and `interactionId` fields
+- `SkillInvokedEvent` data now includes `pluginName` and `pluginVersion` fields
+- `AssistantUsageEvent` data now includes `copilotUsage` field with `CopilotUsage` and `TokenDetails` nested types
+- E2E tests for custom tool permission approval and denial flows (upstream: [`388f2f3`](https://github.com/github/copilot-sdk/commit/388f2f3))
 
 ### Changed
 
-- **Breaking:** permissions are now denied by default when no `OnPermissionRequest` handler is provided. The `requestPermission` flag is always sent as `true` so the server calls back for every permission request; the SDK returns a deny result when no handler is registered (upstream: [`3e2d2b2`](https://github.com/github/copilot-sdk/commit/3e2d2b2))
+- **Breaking:** `createSession(SessionConfig)` now requires a non-null `onPermissionRequest` handler; throws `IllegalArgumentException` if not provided (upstream: [`279f6c4`](https://github.com/github/copilot-sdk/commit/279f6c4))
+- **Breaking:** `resumeSession(String, ResumeSessionConfig)` now requires a non-null `onPermissionRequest` handler; throws `IllegalArgumentException` if not provided (upstream: [`279f6c4`](https://github.com/github/copilot-sdk/commit/279f6c4))
+- **Breaking:** The no-arg `createSession()` and `resumeSession(String)` overloads were removed (upstream: [`279f6c4`](https://github.com/github/copilot-sdk/commit/279f6c4))
+- `AssistantMessageDeltaEvent` data: `totalResponseSizeBytes` field moved to new `AssistantStreamingDeltaEvent` (upstream: various)
+
+### Fixed
+
+- Permission checks now also apply to SDK-registered custom tools, invoking the `onPermissionRequest` handler with `kind="custom-tool"` before executing tools (upstream: [`388f2f3`](https://github.com/github/copilot-sdk/commit/388f2f3))
 
 ## [1.0.9] - 2026-02-16
 

src/main/java/com/github/copilot/sdk/CopilotClient.java

@@ -47,7 +47,10 @@
  * try (var client = new CopilotClient()) {
  * 	client.start().get();
  *
- * 	var session = client.createSession(new SessionConfig().setModel("gpt-5")).get();
+ * 	var session = client
+ * 			.createSession(
+ * 					new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5"))
+ * 			.get();
  *
  * 	session.on(AssistantMessageEvent.class, msg -> {
  * 		System.out.println(msg.getData().content());
@@ -273,14 +276,37 @@ private CompletableFuture<Void> cleanupConnection() {
      * <p>
      * The session maintains conversation state and can be used to send messages and
      * receive responses. Remember to close the session when done.
+     * <p>
+     * A permission handler is required when creating a session. Use
+     * {@link com.github.copilot.sdk.json.PermissionHandler#APPROVE_ALL} to approve
+     * all permission requests, or provide a custom handler to control permissions
+     * selectively.
+     *
+     * <p>
+     * Example:
+     *
+     * <pre>{@code
+     * var session = client.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get();
+     * }</pre>
      *
      * @param config
-     *            configuration for the session (model, tools, etc.)
+     *            configuration for the session, including the required
+     *            {@link SessionConfig#setOnPermissionRequest(com.github.copilot.sdk.json.PermissionHandler)}
+     *            handler
      * @return a future that resolves with the created CopilotSession
-     * @see #createSession()
+     * @throws IllegalArgumentException
+     *             if {@code config} is {@code null} or does not have a permission
+     *             handler set
      * @see SessionConfig
+     * @see com.github.copilot.sdk.json.PermissionHandler#APPROVE_ALL
      */
     public CompletableFuture<CopilotSession> createSession(SessionConfig config) {
+        if (config == null || config.getOnPermissionRequest() == null) {
+            return CompletableFuture.failedFuture(
+                    new IllegalArgumentException("An onPermissionRequest handler is required when creating a session. "
+                            + "For example, to allow all permissions, use: "
+                            + "new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)"));
+        }
         return ensureConnected().thenCompose(connection -> {
             var request = SessionRequestBuilder.buildCreateRequest(config);
 
@@ -293,32 +319,38 @@ public CompletableFuture<CopilotSession> createSession(SessionConfig config) {
         });
     }
 
-    /**
-     * Creates a new Copilot session with default configuration.
-     *
-     * @return a future that resolves with the created CopilotSession
-     * @see #createSession(SessionConfig)
-     */
-    public CompletableFuture<CopilotSession> createSession() {
-        return createSession(null);
-    }
-
     /**
      * Resumes an existing Copilot session.
      * <p>
      * This restores a previously saved session, allowing you to continue a
      * conversation. The session's history is preserved.
+     * <p>
+     * A permission handler is required when resuming a session. Use
+     * {@link com.github.copilot.sdk.json.PermissionHandler#APPROVE_ALL} to approve
+     * all permission requests, or provide a custom handler to control permissions
+     * selectively.
      *
      * @param sessionId
      *            the ID of the session to resume
      * @param config
-     *            configuration for the resumed session
+     *            configuration for the resumed session, including the required
+     *            {@link ResumeSessionConfig#setOnPermissionRequest(com.github.copilot.sdk.json.PermissionHandler)}
+     *            handler
      * @return a future that resolves with the resumed CopilotSession
-     * @see #resumeSession(String)
+     * @throws IllegalArgumentException
+     *             if {@code config} is {@code null} or does not have a permission
+     *             handler set
      * @see #listSessions()
      * @see #getLastSessionId()
+     * @see com.github.copilot.sdk.json.PermissionHandler#APPROVE_ALL
      */
     public CompletableFuture<CopilotSession> resumeSession(String sessionId, ResumeSessionConfig config) {
+        if (config == null || config.getOnPermissionRequest() == null) {
+            return CompletableFuture.failedFuture(
+                    new IllegalArgumentException("An onPermissionRequest handler is required when resuming a session. "
+                            + "For example, to allow all permissions, use: "
+                            + "new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)"));
+        }
         return ensureConnected().thenCompose(connection -> {
             var request = SessionRequestBuilder.buildResumeRequest(sessionId, config);
 
@@ -331,18 +363,6 @@ public CompletableFuture<CopilotSession> resumeSession(String sessionId, ResumeS
         });
     }
 
-    /**
-     * Resumes an existing session with default configuration.
-     *
-     * @param sessionId
-     *            the ID of the session to resume
-     * @return a future that resolves with the resumed CopilotSession
-     * @see #resumeSession(String, ResumeSessionConfig)
-     */
-    public CompletableFuture<CopilotSession> resumeSession(String sessionId) {
-        return resumeSession(sessionId, null);
-    }
-
     /**
      * Gets the current connection state.
      *

src/main/java/com/github/copilot/sdk/CopilotSession.java

@@ -7,6 +7,7 @@
 import java.io.Closeable;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -20,13 +21,16 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.github.copilot.sdk.events.AbstractSessionEvent;
 import com.github.copilot.sdk.events.AssistantMessageEvent;
 import com.github.copilot.sdk.events.SessionErrorEvent;
 import com.github.copilot.sdk.events.SessionEventParser;
 import com.github.copilot.sdk.events.SessionIdleEvent;
+import com.github.copilot.sdk.json.AgentInfo;
 import com.github.copilot.sdk.json.GetMessagesResponse;
 import com.github.copilot.sdk.json.HookInvocation;
 import com.github.copilot.sdk.json.MessageOptions;
@@ -58,8 +62,10 @@
  * <h2>Example Usage</h2>
  *
  * <pre>{@code
- * // Create a session
- * var session = client.createSession(new SessionConfig().setModel("gpt-5")).get();
+ * // Create a session with a permission handler (required)
+ * var session = client
+ * 		.createSession(new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5"))
+ * 		.get();
  *
  * // Register type-safe event handlers
  * session.on(AssistantMessageEvent.class, msg -> {
@@ -802,6 +808,84 @@ public CompletableFuture<Void> abort() {
         return rpc.invoke("session.abort", Map.of("sessionId", sessionId), Void.class);
     }
 
+    /**
+     * Lists the custom agents available for selection in this session.
+     *
+     * @return a future that resolves with the list of available agents
+     * @throws IllegalStateException
+     *             if this session has been terminated
+     * @since 1.0.11
+     */
+    public CompletableFuture<List<AgentInfo>> listAgents() {
+        ensureNotTerminated();
+        return rpc.invoke("session.agent.list", Map.of("sessionId", sessionId), AgentListResponse.class)
+                .thenApply(response -> response.agents() != null
+                        ? Collections.unmodifiableList(response.agents())
+                        : Collections.emptyList());
+    }
+
+    /**
+     * Gets the currently selected custom agent for this session, or {@code null} if
+     * no custom agent is selected.
+     *
+     * @return a future that resolves with the current agent, or {@code null} if
+     *         using the default agent
+     * @throws IllegalStateException
+     *             if this session has been terminated
+     * @since 1.0.11
+     */
+    public CompletableFuture<AgentInfo> getCurrentAgent() {
+        ensureNotTerminated();
+        return rpc.invoke("session.agent.getCurrent", Map.of("sessionId", sessionId), AgentGetCurrentResponse.class)
+                .thenApply(AgentGetCurrentResponse::agent);
+    }
+
+    /**
+     * Selects a custom agent for this session.
+     *
+     * @param agentName
+     *            the name/identifier of the agent to select
+     * @return a future that resolves with the selected agent information
+     * @throws IllegalStateException
+     *             if this session has been terminated
+     * @since 1.0.11
+     */
+    public CompletableFuture<AgentInfo> selectAgent(String agentName) {
+        ensureNotTerminated();
+        return rpc.invoke("session.agent.select", Map.of("sessionId", sessionId, "name", agentName),
+                AgentSelectResponse.class).thenApply(AgentSelectResponse::agent);
+    }
+
+    /**
+     * Deselects the currently selected custom agent, returning to the default
+     * agent.
+     *
+     * @return a future that completes when the agent is deselected
+     * @throws IllegalStateException
+     *             if this session has been terminated
+     * @since 1.0.11
+     */
+    public CompletableFuture<Void> deselectAgent() {
+        ensureNotTerminated();
+        return rpc.invoke("session.agent.deselect", Map.of("sessionId", sessionId), Void.class);
+    }
+
+    /**
+     * Compacts the session context to reduce token usage.
+     * <p>
+     * This triggers an immediate session compaction, summarizing the conversation
+     * history to free up context window space.
+     *
+     * @return a future that completes when compaction finishes
+     * @throws IllegalStateException
+     *             if this session has been terminated
+     * @since 1.0.11
+     */
+    public CompletableFuture<Void> compact() {
+        ensureNotTerminated();
+        return rpc.invoke("session.compaction.compact", Map.of("sessionId", sessionId), Void.class);
+    }
+
     /**
      * Verifies that this session has not yet been terminated.
      *
@@ -843,4 +927,18 @@ public void close() {
         hooksHandler.set(null);
     }
 
+    // ===== Internal response types for agent API =====
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    private record AgentListResponse(@JsonProperty("agents") List<AgentInfo> agents) {
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    private record AgentGetCurrentResponse(@JsonProperty("agent") AgentInfo agent) {
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    private record AgentSelectResponse(@JsonProperty("agent") AgentInfo agent) {
+    }
+
 }

src/main/java/com/github/copilot/sdk/events/AbstractSessionEvent.java

@@ -55,9 +55,11 @@ public abstract sealed class AbstractSessionEvent permits
         SessionModelChangeEvent, SessionModeChangedEvent, SessionPlanChangedEvent, SessionWorkspaceFileChangedEvent,
         SessionHandoffEvent, SessionTruncationEvent, SessionSnapshotRewindEvent, SessionUsageInfoEvent,
         SessionCompactionStartEvent, SessionCompactionCompleteEvent, SessionShutdownEvent, SessionContextChangedEvent,
+        SessionTaskCompleteEvent,
         // Assistant events
         AssistantTurnStartEvent, AssistantIntentEvent, AssistantReasoningEvent, AssistantReasoningDeltaEvent,
-        AssistantMessageEvent, AssistantMessageDeltaEvent, AssistantTurnEndEvent, AssistantUsageEvent, AbortEvent,
+        AssistantMessageEvent, AssistantMessageDeltaEvent, AssistantStreamingDeltaEvent, AssistantTurnEndEvent,
+        AssistantUsageEvent, AbortEvent,
         // Tool events
         ToolUserRequestedEvent, ToolExecutionStartEvent, ToolExecutionPartialResultEvent, ToolExecutionProgressEvent,
         ToolExecutionCompleteEvent,
@@ -66,8 +68,8 @@ public abstract sealed class AbstractSessionEvent permits
         // Skill events
         SkillInvokedEvent,
         // Other events
-        SubagentStartedEvent, SubagentCompletedEvent, SubagentFailedEvent, SubagentSelectedEvent, HookStartEvent,
-        HookEndEvent, SystemMessageEvent {
+        SubagentStartedEvent, SubagentCompletedEvent, SubagentFailedEvent, SubagentSelectedEvent,
+        SubagentDeselectedEvent, HookStartEvent, HookEndEvent, SystemMessageEvent {
 
     @JsonProperty("id")
     private UUID id;

src/main/java/com/github/copilot/sdk/events/AssistantMessageDeltaEvent.java

@@ -34,7 +34,6 @@ public void setData(AssistantMessageDeltaData data) {
     @JsonIgnoreProperties(ignoreUnknown = true)
     public record AssistantMessageDeltaData(@JsonProperty("messageId") String messageId,
             @JsonProperty("deltaContent") String deltaContent,
-            @JsonProperty("totalResponseSizeBytes") Double totalResponseSizeBytes,
             @JsonProperty("parentToolCallId") String parentToolCallId) {
     }
 }

src/main/java/com/github/copilot/sdk/events/AssistantMessageEvent.java

@@ -73,6 +73,7 @@ public void setData(AssistantMessageData data) {
     public record AssistantMessageData(@JsonProperty("messageId") String messageId,
             @JsonProperty("content") String content, @JsonProperty("toolRequests") List<ToolRequest> toolRequests,
             @JsonProperty("parentToolCallId") String parentToolCallId,
+            @JsonProperty("interactionId") String interactionId,
             @JsonProperty("reasoningOpaque") String reasoningOpaque,
             @JsonProperty("reasoningText") String reasoningText,
             @JsonProperty("encryptedContent") String encryptedContent) {

src/main/java/com/github/copilot/sdk/events/AssistantStreamingDeltaEvent.java

@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.events;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Event: assistant.streaming_delta
+ *
+ * @since 1.0.11
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public final class AssistantStreamingDeltaEvent extends AbstractSessionEvent {
+
+    @JsonProperty("data")
+    private AssistantStreamingDeltaData data;
+
+    @Override
+    public String getType() {
+        return "assistant.streaming_delta";
+    }
+
+    public AssistantStreamingDeltaData getData() {
+        return data;
+    }
+
+    public void setData(AssistantStreamingDeltaData data) {
+        this.data = data;
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public record AssistantStreamingDeltaData(@JsonProperty("totalResponseSizeBytes") double totalResponseSizeBytes) {
+    }
+}

src/main/java/com/github/copilot/sdk/events/AssistantTurnStartEvent.java

@@ -32,6 +32,7 @@ public void setData(AssistantTurnStartData data) {
     }
 
     @JsonIgnoreProperties(ignoreUnknown = true)
-    public record AssistantTurnStartData(@JsonProperty("turnId") String turnId) {
+    public record AssistantTurnStartData(@JsonProperty("turnId") String turnId,
+            @JsonProperty("interactionId") String interactionId) {
     }
 }