copilot-sdk-supercharged 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392f8acf685d1aa8978a06e40ebd965ab0ca2a7420a7194a91d5b89f1468e925
-  data.tar.gz: 8b91a8a18f10a8bb5e0b85ffee7eabf309246b268303436741a3d87dceca28fe
+  metadata.gz: 8d80c4e262952967db3b9ed58e8899587afa12b158074ab57d7f475af58ccd68
+  data.tar.gz: 302abe246cec1dd679f2036f49407a10b01756c421634a3c97f6fb1105743606
 SHA512:
-  metadata.gz: 333bb586d18fa374572905b4044cceef361659eba6b7be7dcbbfdc2c621fa9ac0ce400a6b64e28549ec6d84fbf8279fe93d30222d3ace4ae715d6aa6f33a154d
-  data.tar.gz: ffd63d77549c4e8e6d41cb242012a2af2eae8a01faecb773055cc158ce59386cdf68ad10315653bb3a9aad6dd1ed0e768d14b87a23785fb8e030545dbb38c16d
+  metadata.gz: e7aa7ee115dfe39db890cffa6d1d4535caf0b6926cde80b0346b5ce3e8e5a9ca24b688af91c49b223aa5fbdb1e95733052f142b4bcef42d18d69101ccae1fde5
+  data.tar.gz: f51f8baeb7ede5fb5db28855db3e94f397379e78d75e9f6aa871a6c970733b8bfd80ab5d3013acc21510add30f29be55e7db79cb6251061355470b220e95655a

data/lib/copilot/client.rb

@@ -845,6 +845,23 @@ module Copilot
         payload[:infiniteSessions] = is_cfg.respond_to?(:to_wire) ? is_cfg.to_wire : is_cfg
       end
 
+      # --- Upstream-sync session options (parity with @github/copilot-sdk) ---
+      payload[:enableCitations] = config[:enable_citations] unless config[:enable_citations].nil?
+      payload[:excludedBuiltinAgents] = config[:excluded_builtin_agents] if config[:excluded_builtin_agents]
+      if config[:session_limits]
+        sl = config[:session_limits]
+        payload[:sessionLimits] = sl.respond_to?(:to_wire) ? sl.to_wire : sl
+      end
+      if config[:memory]
+        mem = config[:memory]
+        payload[:memory] = mem.respond_to?(:to_wire) ? mem.to_wire : mem
+      end
+      payload[:otlpProtocol] = config[:otlp_protocol] if config[:otlp_protocol]
+      payload[:enableWebSocketResponses] = config[:enable_web_socket_responses] unless config[:enable_web_socket_responses].nil?
+      payload[:expAssignments] = config[:exp_assignments] if config[:exp_assignments]
+      # MCP OAuth host token handler: signal to the runtime that a handler is registered.
+      payload[:mcpAuthHandler] = true if config[:on_mcp_auth_request]
+
       payload
     end
 

data/lib/copilot/session.rb

@@ -68,10 +68,13 @@ module Copilot
     # @param response_format [String, nil]       desired response format ("text", "image", "json_object")
     # @param image_options   [ImageOptions, nil] options for image generation
     # @return [String] the message ID
-    def send(prompt:, attachments: nil, mode: nil, response_format: nil, image_options: nil)
+    def send(prompt:, attachments: nil, mode: nil, agent_mode: nil, display_prompt: nil, request_headers: nil, response_format: nil, image_options: nil)
       payload = { sessionId: @session_id, prompt: prompt }
       payload[:attachments] = attachments if attachments
       payload[:mode] = mode if mode
+      payload[:agentMode] = agent_mode if agent_mode
+      payload[:displayPrompt] = display_prompt if display_prompt
+      payload[:requestHeaders] = request_headers if request_headers
       payload[:responseFormat] = response_format if response_format
       payload[:imageOptions] = image_options.to_h if image_options
 
@@ -108,7 +111,7 @@ module Copilot
     # @return [SessionEvent, nil] the final assistant.message event, or nil
     # @raise [Timeout::Error] if the timeout expires before session.idle
     # @raise [RuntimeError] if the session emits a session.error event
-    def send_and_wait(prompt:, attachments: nil, mode: nil, response_format: nil, image_options: nil, timeout: 60)
+    def send_and_wait(prompt:, attachments: nil, mode: nil, agent_mode: nil, display_prompt: nil, request_headers: nil, response_format: nil, image_options: nil, timeout: 60)
       idle_mutex = Mutex.new
       idle_cv    = ConditionVariable.new
       idle_fired = false
@@ -139,6 +142,8 @@ module Copilot
 
       begin
         self.send(prompt: prompt, attachments: attachments, mode: mode,
+                  agent_mode: agent_mode, display_prompt: display_prompt,
+                  request_headers: request_headers,
                   response_format: response_format, image_options: image_options)
 
         idle_mutex.synchronize do

data/lib/copilot/types.rb

@@ -75,132 +75,6 @@ module Copilot
     end
   end
 
-  # An action exposed by a canvas.
-  CanvasAction = Struct.new(:name, :description, :input_schema, keyword_init: true) do
-    def to_h
-      h = { name: name, description: description }
-      h[:inputSchema] = input_schema unless input_schema.nil?
-      h
-    end
-  end
-
-  # Declarative metadata for a canvas.
-  CanvasDeclaration = Struct.new(
-    :id, :display_name, :description, :input_schema, :actions,
-    keyword_init: true
-  ) do
-    def to_h
-      h = { id: id, displayName: display_name, description: description }
-      h[:inputSchema] = input_schema unless input_schema.nil?
-      h[:actions] = actions.map { |action| action.respond_to?(:to_h) ? action.to_h : action } unless actions.nil?
-      h
-    end
-  end
-
-  # Response returned when opening a canvas.
-  CanvasOpenResponse = Struct.new(:url, :title, :status, keyword_init: true) do
-    def to_h
-      h = {}
-      h[:url] = url if url
-      h[:title] = title if title
-      h[:status] = status if status
-      h
-    end
-  end
-
-  # Host capabilities passed to canvas callbacks.
-  CanvasHostCapabilities = Struct.new(:canvases, keyword_init: true) do
-    def self.from_hash(h)
-      h ||= {}
-      new(canvases: h.fetch("canvases", false))
-    end
-
-    def to_h
-      { canvases: !!canvases }
-    end
-  end
-
-  # Host context passed to canvas callbacks.
-  CanvasHostContext = Struct.new(:capabilities, keyword_init: true) do
-    def self.from_hash(h)
-      h ||= {}
-      new(capabilities: CanvasHostCapabilities.from_hash(h["capabilities"]))
-    end
-
-    def to_h
-      { capabilities: (capabilities || CanvasHostCapabilities.new(canvases: false)).to_h }
-    end
-  end
-
-  # Context provided when a canvas is opened.
-  CanvasOpenContext = Struct.new(
-    :session_id, :extension_id, :canvas_id, :instance_id, :input, :host,
-    keyword_init: true
-  ) do
-    def self.from_hash(h)
-      new(
-        session_id: h["sessionId"],
-        extension_id: h["extensionId"],
-        canvas_id: h["canvasId"],
-        instance_id: h["instanceId"],
-        input: h["input"],
-        host: h["host"] && CanvasHostContext.from_hash(h["host"])
-      )
-    end
-  end
-
-  # Context provided when a canvas action is invoked.
-  CanvasActionContext = Struct.new(
-    :session_id, :extension_id, :canvas_id, :instance_id, :action_name, :input, :host,
-    keyword_init: true
-  ) do
-    def self.from_hash(h)
-      new(
-        session_id: h["sessionId"],
-        extension_id: h["extensionId"],
-        canvas_id: h["canvasId"],
-        instance_id: h["instanceId"],
-        action_name: h["actionName"],
-        input: h["input"],
-        host: h["host"] && CanvasHostContext.from_hash(h["host"])
-      )
-    end
-  end
-
-  # Context provided for canvas lifecycle events.
-  CanvasLifecycleContext = Struct.new(
-    :session_id, :extension_id, :canvas_id, :instance_id, :host,
-    keyword_init: true
-  ) do
-    def self.from_hash(h)
-      new(
-        session_id: h["sessionId"],
-        extension_id: h["extensionId"],
-        canvas_id: h["canvasId"],
-        instance_id: h["instanceId"],
-        host: h["host"] && CanvasHostContext.from_hash(h["host"])
-      )
-    end
-  end
-
-  # GitHub repository metadata associated with a cloud session.
-  CloudSessionRepository = Struct.new(:owner, :name, :branch, keyword_init: true) do
-    def to_h
-      h = { owner: owner, name: name }
-      h[:branch] = branch if branch
-      h
-    end
-  end
-
-  # Cloud-session creation options.
-  CloudSessionOptions = Struct.new(:repository, keyword_init: true) do
-    def to_h
-      h = {}
-      h[:repository] = repository.respond_to?(:to_h) ? repository.to_h : repository if repository
-      h
-    end
-  end
-
   # System message in append mode (default).
   SystemMessageAppendConfig = Struct.new(:mode, :content, keyword_init: true) do
     def to_h
@@ -229,23 +103,21 @@ module Copilot
     SAFETY               = "safety"
     TOOL_INSTRUCTIONS    = "tool_instructions"
     CUSTOM_INSTRUCTIONS  = "custom_instructions"
-    RUNTIME_INSTRUCTIONS = "runtime_instructions"
     LAST_INSTRUCTIONS    = "last_instructions"
   end
 
   # Override action for a system prompt section.
   module SectionOverrideAction
-    REPLACE   = "replace"
-    REMOVE    = "remove"
-    APPEND    = "append"
-    PREPEND   = "prepend"
-    TRANSFORM = "transform"
+    REPLACE = "replace"
+    REMOVE  = "remove"
+    APPEND  = "append"
+    PREPEND = "prepend"
   end
 
   # Override operation for a single system prompt section.
-  SectionOverride = Struct.new(:action, :content, :transform, keyword_init: true) do
+  SectionOverride = Struct.new(:action, :content, keyword_init: true) do
     def to_h
-      h = { action: transform ? SectionOverrideAction::TRANSFORM : action }
+      h = { action: action }
       h[:content] = content if content
       h
     end
@@ -390,69 +262,6 @@ module Copilot
     end
   end
 
-  # Slash command input completion constants.
-  # Valid values: "directory"
-  module SlashCommandInputCompletion
-    DIRECTORY = "directory"
-  end
-
-  # Slash command kind constants.
-  # Valid values: "builtin", "client", "skill"
-  module SlashCommandKind
-    BUILTIN = "builtin"
-    CLIENT  = "client"
-    SKILL   = "skill"
-  end
-
-  # Input configuration for a slash command.
-  SlashCommandInput = Struct.new(:hint, :completion, keyword_init: true) do
-    def to_h
-      h = { hint: hint }
-      h[:completion] = completion if completion
-      h
-    end
-  end
-
-  # Information about a slash command.
-  SlashCommandInfo = Struct.new(
-    :allow_during_agent_execution, :description, :kind, :name,
-    :aliases, :experimental, :input,
-    keyword_init: true
-  ) do
-    def to_h
-      h = {
-        allowDuringAgentExecution: allow_during_agent_execution,
-        description: description,
-        kind: kind,
-        name: name,
-      }
-      h[:aliases] = aliases if aliases
-      h[:experimental] = experimental unless experimental.nil?
-      h[:input] = input.to_h if input
-      h
-    end
-  end
-
-  # Request to invoke a command.
-  CommandsInvokeRequest = Struct.new(:name, :input, keyword_init: true) do
-    def to_h
-      h = { name: name }
-      h[:input] = input if input
-      h
-    end
-  end
-
-  # Request to list available commands.
-  CommandsListRequest = Struct.new(:include_builtins, :include_client_commands, :include_skills, keyword_init: true) do
-    def to_h
-      h = {}
-      h[:includeBuiltins] = include_builtins unless include_builtins.nil?
-      h[:includeClientCommands] = include_client_commands unless include_client_commands.nil?
-      h[:includeSkills] = include_skills unless include_skills.nil?
-      h
-    end
-  end
-
   # Context for a slash-command invocation.
   CommandContext = Struct.new(:session_id, :command, :command_name, :args, keyword_init: true)
 
@@ -469,30 +278,6 @@ module Copilot
   # Result returned from an elicitation handler.
   ElicitationResult = Struct.new(:action, :content, keyword_init: true)
 
-  # Exit plan mode request from the server.
-  ExitPlanModeRequest = Struct.new(:session_id, keyword_init: true) do
-    def self.from_hash(h)
-      new(session_id: h["sessionId"])
-    end
-  end
-
-  # Exit plan mode response.
-  ExitPlanModeResponse = Struct.new(:approved, keyword_init: true) do
-    def to_h
-      { approved: approved }
-    end
-  end
-
-  # Trace context for distributed tracing.
-  TraceContext = Struct.new(:traceparent, :tracestate, keyword_init: true) do
-    def to_h
-      h = {}
-      h[:traceparent] = traceparent if traceparent
-      h[:tracestate] = tracestate if tracestate
-      h
-    end
-  end
-
   # Configuration for creating a session.
   SessionConfig = Struct.new(
     :session_id, :model, :reasoning_effort, :config_dir,
@@ -503,7 +288,7 @@ module Copilot
     :skill_directories, :disabled_skills, :infinite_sessions,
     :model_capabilities, :enable_config_discovery,
     :github_token,
-    :commands, :on_elicitation_request, :on_exit_plan_mode,
+    :commands, :on_elicitation_request,
     :instruction_directories,
     keyword_init: true
   )
@@ -518,20 +303,14 @@ module Copilot
     :skill_directories, :disabled_skills, :infinite_sessions,
     :model_capabilities, :enable_config_discovery,
     :github_token,
-    :commands, :on_elicitation_request, :on_exit_plan_mode,
+    :commands, :on_elicitation_request,
     :instruction_directories,
     :disable_resume,
     keyword_init: true
   )
 
   # Response format for message responses.
-  module ResponseFormat
-    TEXT = "text"
-    IMAGE = "image"
-    JSON_OBJECT = "json_object"
-  end
-
-  RESPONSE_FORMATS = [ResponseFormat::TEXT, ResponseFormat::IMAGE, ResponseFormat::JSON_OBJECT].freeze
+  RESPONSE_FORMATS = %w[text image json_object].freeze
 
   # Options for image generation.
   ImageOptions = Struct.new(:size, :quality, :style, keyword_init: true) do
@@ -635,38 +414,10 @@ module Copilot
     end
   end
 
-  # Model billing token prices.
-  ModelBillingTokenPrices = Struct.new(
-    :batch_size, :cache_price, :input_price, :output_price,
-    keyword_init: true
-  ) do
-    def self.from_hash(h)
-      new(
-        batch_size: h["batchSize"],
-        cache_price: h["cachePrice"],
-        input_price: h["inputPrice"],
-        output_price: h["outputPrice"]
-      )
-    end
-  end
-
-  # Model picker price category constants.
-  # Valid values: "high", "low", "medium", "very_high"
-  module ModelPickerPriceCategory
-    HIGH      = "high"
-    LOW       = "low"
-    MEDIUM    = "medium"
-    VERY_HIGH = "very_high"
-  end
-
   # Model billing information.
-  ModelBilling = Struct.new(:multiplier, :token_prices, :picker_price_category, keyword_init: true) do
+  ModelBilling = Struct.new(:multiplier, keyword_init: true) do
     def self.from_hash(h)
-      new(
-        multiplier: h["multiplier"],
-        token_prices: h["tokenPrices"] ? ModelBillingTokenPrices.from_hash(h["tokenPrices"]) : nil,
-        picker_price_category: h["pickerPriceCategory"]
-      )
+      new(multiplier: h["multiplier"])
     end
   end
 
@@ -793,45 +544,6 @@ module Copilot
     end
   end
 
-  # Experimental
-  # Diagnostics from loading skills.
-  SkillsLoadDiagnostics = Struct.new(:errors, :warnings, keyword_init: true) do
-    def self.from_hash(h)
-      new(
-        errors: h["errors"] || [],
-        warnings: h["warnings"] || []
-      )
-    end
-  end
-
-  # Per-session remote mode.
-  # "off" disables remote, "export" exports session events to Mission Control
-  # without enabling remote steering, "on" enables both export and remote steering.
-  module RemoteSessionMode
-    EXPORT = "export"
-    OFF    = "off"
-    ON     = "on"
-  end
-
-  # Experimental
-  # Request to enable remote mode for a session.
-  RemoteEnableRequest = Struct.new(:mode, keyword_init: true) do
-    def self.from_hash(h)
-      new(mode: h["mode"])
-    end
-  end
-
-  # Experimental
-  # Result of enabling remote mode for a session.
-  RemoteEnableResult = Struct.new(:remote_steerable, :url, keyword_init: true) do
-    def self.from_hash(h)
-      new(
-        remote_steerable: h["remoteSteerable"],
-        url: h["url"]
-      )
-    end
-  end
-
   # Foreground session info (TUI+server mode).
   ForegroundSessionInfo = Struct.new(:session_id, :workspace_path, keyword_init: true)
 
@@ -884,7 +596,67 @@ module Copilot
     :github_token, :use_logged_in_user, :session_idle_timeout_seconds,
     :session_fs,
     :copilot_home, :tcp_connection_token,
-    :on_get_trace_context,
+    :request_handler,
     keyword_init: true
   )
+
+  # --- Upstream-sync feature types (parity with @github/copilot-sdk) ---
+
+  # Per-session AI-credit budget; set +max_ai_credits+ to cap spend.
+  SessionLimitsConfig = Struct.new(:max_ai_credits, keyword_init: true) do
+    def to_wire
+      { maxAiCredits: max_ai_credits }.compact
+    end
+  end
+
+  # Opt-in persistent session memory.
+  MemoryConfiguration = Struct.new(:enabled, keyword_init: true) do
+    def to_wire
+      { enabled: enabled }.compact
+    end
+  end
+
+  # Arguments passed to a BYOK +bearer_token_provider+ callable (per-session scoping).
+  ProviderTokenArgs = Struct.new(:session_id, keyword_init: true)
+
+  # Intercept outbound LLM inference HTTP/WebSocket requests. Assign an instance to
+  # +ClientOptions#request_handler+ and override +send_request+ to mutate, replace,
+  # or forward the request. BYOK providers may also set +bearer_token_provider+.
+  class CopilotRequestHandler
+    def send_request(request, _context)
+      request
+    end
+  end
+
+  # Tool "defer" loading policy: eager pre-load ("never") or lazy via search ("auto").
+  module ToolDefer
+    AUTO  = "auto"
+    NEVER = "never"
+  end
+
+  # System-message section identifiers (used with system_message section overrides).
+  # The "preamble" section targets only the identity preamble; the "preserve" action
+  # protects an individually-addressable section from a group-level remove.
+  module SystemMessageSection
+    PREAMBLE          = "preamble"
+    IDENTITY          = "identity"
+    TOOL_INSTRUCTIONS = "tool_instructions"
+    PRESERVE          = "preserve"
+  end
+
+  # Hook names include :on_pre_tool_use, :on_post_tool_use, :on_pre_mcp_tool_call,
+  # and :on_mcp_auth_request (MCP OAuth host token handler).
+
+  # GitHub-anchored attachment variants.
+  module GitHubAttachment
+    GITHUB_COMMIT          = "GitHubCommit"
+    GITHUB_RELEASE         = "GitHubRelease"
+    GITHUB_ACTIONS_JOB     = "GitHubActionsJob"
+    GITHUB_REPOSITORY      = "GitHubRepository"
+    GITHUB_FILE_DIFF       = "GitHubFileDiff"
+    GITHUB_TREE_COMPARISON = "GitHubTreeComparison"
+    GITHUB_URL             = "GitHubUrl"
+    GITHUB_FILE            = "GitHubFile"
+    GITHUB_SNIPPET         = "GitHubSnippet"
+  end
 end

data/lib/copilot/version.rb

@@ -3,5 +3,5 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 
 module Copilot
-  VERSION = "2.3.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copilot-sdk-supercharged
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Jeremiah Isaacson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-25 00:00:00.000000000 Z
+date: 2026-07-08 00:00:00.000000000 Z
 dependencies: []
 description: |
   A Ruby SDK for interacting with the GitHub Copilot CLI server via JSON-RPC 2.0.