copilot-sdk-supercharged 1.0.14 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ed56f2facb108cac8435418675fbd54c967be07a9efc4f863764aba536fb417
-  data.tar.gz: c70d0bc764352309c987bc23061f63364f3983c59b5b1f2da8b5d8a47195d93f
+  metadata.gz: ac265973156bd106fe6625fb7aff8c3be3ce02578e28413900b958381c366315
+  data.tar.gz: d463146e751af0d4e57254761d308f9c52f56ff41ef6607124b2fb5eb58f3fb9
 SHA512:
-  metadata.gz: d04ba41f5f45220e114461c9d8b74521b0554813124ed6b9dffa55b7b04bfa9ce1358e2c58182a1855eae4618b5075d5e817c955c274bcaa87b9f189dc10f050
-  data.tar.gz: 11e852c1f8e2b5d141821bf7c30cf493c64618ce302fc884402b9867d7376c9706a5d3fa387073acfe2e8ae107be398ab4dde21897995e36acc9bec3a5024abc
+  metadata.gz: aeb633fd58ca1526dd2e1d17efd570ecabc4482b7fbb224c04b5481dcd35257121147a2af1c1a7bf4a7228381abc76d35346bc3f03f1021c9e04c4ac40f703f7
+  data.tar.gz: 0d56cb6866c59504cbd6a00af8bb36267f20bc7390eaa8e7774b9cd193756865fdc27ef73ec29fc54a8780261c808aee34131f365a1034ea866b1e2f11bd282f

data/README.md

@@ -296,6 +296,20 @@ The SDK uses a background reader thread for the JSON-RPC connection. Event handl
 
 The `send_and_wait` method uses a `Mutex` + `ConditionVariable` to block the calling thread until the session becomes idle, which is the recommended pattern for synchronous usage.
 
+## Image Generation
+
+Request image responses using `response_format` and `image_options`:
+
+```ruby
+response = session.send_and_wait(
+  prompt: "Generate a sunset over mountains",
+  response_format: "image",
+  image_options: Copilot::ImageOptions.new(
+    size: "1024x1024", quality: "hd", style: "natural"
+  )
+)
+```
+
 ## License
 
 MIT - see [LICENSE](../LICENSE) for details.

data/lib/copilot/session.rb

@@ -57,14 +57,18 @@ module Copilot
 
     # Send a message to this session.
     #
-    # @param prompt      [String]       the message text
-    # @param attachments [Array, nil]   optional file/directory/selection attachments
-    # @param mode        [String, nil]  "enqueue" (default) or "immediate"
+    # @param prompt          [String]            the message text
+    # @param attachments     [Array, nil]        optional file/directory/selection attachments
+    # @param mode            [String, nil]       "enqueue" (default) or "immediate"
+    # @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)
+    def send(prompt:, attachments: nil, mode: nil, response_format: nil, image_options: nil)
       payload = { sessionId: @session_id, prompt: prompt }
       payload[:attachments] = attachments if attachments
       payload[:mode] = mode if mode
+      payload[:responseFormat] = response_format if response_format
+      payload[:imageOptions] = image_options.to_h if image_options
       response = @rpc_client.request("session.send", payload)
       response["messageId"]
     end
@@ -74,14 +78,16 @@ module Copilot
     # This is a convenience method that combines {#send} with waiting for
     # the +session.idle+ event.
     #
-    # @param prompt      [String]       the message text
-    # @param attachments [Array, nil]   optional attachments
-    # @param mode        [String, nil]  delivery mode
-    # @param timeout     [Numeric]      seconds to wait (default 60)
+    # @param prompt          [String]            the message text
+    # @param attachments     [Array, nil]        optional attachments
+    # @param mode            [String, nil]       delivery mode
+    # @param response_format [String, nil]       desired response format ("text", "image", "json_object")
+    # @param image_options   [ImageOptions, nil] options for image generation
+    # @param timeout         [Numeric]           seconds to wait (default 60)
     # @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, timeout: 60)
+    def send_and_wait(prompt:, attachments: nil, mode: nil, response_format: nil, image_options: nil, timeout: 60)
       idle_mutex = Mutex.new
       idle_cv    = ConditionVariable.new
       idle_fired = false
@@ -111,7 +117,8 @@ module Copilot
       end
 
       begin
-        self.send(prompt: prompt, attachments: attachments, mode: mode)
+        self.send(prompt: prompt, attachments: attachments, mode: mode,
+                  response_format: response_format, image_options: image_options)
 
         idle_mutex.synchronize do
           unless idle_fired
@@ -177,6 +184,13 @@ module Copilot
       events.map { |e| SessionEvent.from_hash(e) }
     end
 
+    # Retrieve metadata for this session.
+    #
+    # @return [Hash] the session metadata
+    def get_metadata
+      @rpc_client.request("session.getMetadata", { sessionId: @session_id })
+    end
+
     # Destroy this session and release associated resources.
     def destroy
       @rpc_client.request("session.destroy", { sessionId: @session_id })

data/lib/copilot/types.rb

@@ -92,6 +92,49 @@ module Copilot
     end
   end
 
+  # Known system prompt section identifiers for "customize" mode.
+  module SystemPromptSection
+    IDENTITY             = "identity"
+    TONE                 = "tone"
+    TOOL_EFFICIENCY      = "tool_efficiency"
+    ENVIRONMENT_CONTEXT  = "environment_context"
+    CODE_CHANGE_RULES    = "code_change_rules"
+    GUIDELINES           = "guidelines"
+    SAFETY               = "safety"
+    TOOL_INSTRUCTIONS    = "tool_instructions"
+    CUSTOM_INSTRUCTIONS  = "custom_instructions"
+    LAST_INSTRUCTIONS    = "last_instructions"
+  end
+
+  # Override action for a system prompt section.
+  module SectionOverrideAction
+    REPLACE = "replace"
+    REMOVE  = "remove"
+    APPEND  = "append"
+    PREPEND = "prepend"
+  end
+
+  # Override operation for a single system prompt section.
+  SectionOverride = Struct.new(:action, :content, keyword_init: true) do
+    def to_h
+      h = { action: action }
+      h[:content] = content if content
+      h
+    end
+  end
+
+  # System message in customize mode - section-level overrides.
+  SystemMessageCustomizeConfig = Struct.new(:sections, :content, keyword_init: true) do
+    def to_h
+      h = { mode: "customize" }
+      if sections
+        h[:sections] = sections.transform_values(&:to_h)
+      end
+      h[:content] = content if content
+      h
+    end
+  end
+
   # Permission request from the server.
   PermissionRequest = Struct.new(:kind, :tool_call_id, :extra, keyword_init: true) do
     def self.from_hash(h)
@@ -190,6 +233,7 @@ module Copilot
   # Custom agent configuration.
   CustomAgentConfig = Struct.new(
     :name, :display_name, :description, :tools, :prompt, :mcp_servers, :infer,
+    :skills,
     keyword_init: true
   ) do
     def to_wire
@@ -199,6 +243,7 @@ module Copilot
       h[:tools] = tools if tools
       h[:mcpServers] = mcp_servers if mcp_servers
       h[:infer] = infer unless infer.nil?
+      h[:skills] = skills if skills
       h
     end
   end
@@ -217,13 +262,33 @@ module Copilot
     end
   end
 
+  # Context for a slash-command invocation.
+  CommandContext = Struct.new(:session_id, :command, :command_name, :args, keyword_init: true)
+
+  # Definition of a slash command registered with the session.
+  # handler is a callable (Proc/lambda) that receives a CommandContext.
+  CommandDefinition = Struct.new(:name, :description, :handler, keyword_init: true)
+
+  # Context for an elicitation request from the server.
+  ElicitationContext = Struct.new(
+    :session_id, :message, :requested_schema, :mode, :elicitation_source, :url,
+    keyword_init: true
+  )
+
+  # Result returned from an elicitation handler.
+  ElicitationResult = Struct.new(:action, :content, keyword_init: true)
+
   # Configuration for creating a session.
   SessionConfig = Struct.new(
     :session_id, :model, :reasoning_effort, :config_dir,
     :tools, :system_message, :available_tools, :excluded_tools,
     :provider, :on_permission_request, :on_user_input_request, :hooks,
-    :working_directory, :streaming, :mcp_servers, :custom_agents,
+    :working_directory, :streaming, :include_sub_agent_streaming_events,
+    :mcp_servers, :custom_agents,
     :skill_directories, :disabled_skills, :infinite_sessions,
+    :model_capabilities, :enable_config_discovery,
+    :github_token,
+    :commands, :on_elicitation_request,
     keyword_init: true
   )
 
@@ -232,14 +297,34 @@ module Copilot
     :model, :reasoning_effort, :config_dir,
     :tools, :system_message, :available_tools, :excluded_tools,
     :provider, :on_permission_request, :on_user_input_request, :hooks,
-    :working_directory, :streaming, :mcp_servers, :custom_agents,
+    :working_directory, :streaming, :include_sub_agent_streaming_events,
+    :mcp_servers, :custom_agents,
     :skill_directories, :disabled_skills, :infinite_sessions,
+    :model_capabilities, :enable_config_discovery,
+    :github_token,
+    :commands, :on_elicitation_request,
     :disable_resume,
     keyword_init: true
   )
 
+  # Response format for message responses.
+  RESPONSE_FORMATS = %w[text image json_object].freeze
+
+  # Options for image generation.
+  ImageOptions = Struct.new(:size, :quality, :style, keyword_init: true) do
+    def to_h
+      super.compact
+    end
+  end
+
+  # Image data from an assistant image response.
+  AssistantImageData = Struct.new(:format, :base64, :url, :revised_prompt, :width, :height, keyword_init: true)
+
+  # A content block in a mixed text+image response.
+  ContentBlock = Struct.new(:type, :text, :image, keyword_init: true)
+
   # Options for sending a message.
-  MessageOptions = Struct.new(:prompt, :attachments, :mode, keyword_init: true)
+  MessageOptions = Struct.new(:prompt, :attachments, :mode, :response_format, :image_options, :request_headers, keyword_init: true)
 
   # Ping response from the server.
   PingResponse = Struct.new(:message, :timestamp, :protocol_version, keyword_init: true) do
@@ -474,11 +559,39 @@ module Copilot
     end
   end
 
+  # Configuration for a custom session filesystem provider.
+  SessionFsConfig = Struct.new(
+    :initial_cwd, :session_state_path, :conventions,
+    keyword_init: true
+  )
+
+  # File metadata returned by session filesystem operations.
+  SessionFsFileInfo = Struct.new(
+    :name, :size, :is_directory, :is_file, :created_at, :modified_at,
+    keyword_init: true
+  )
+
+  # Interface for session filesystem providers.
+  # Implementors should include this module and define all methods.
+  module SessionFsProvider
+    def read_file(session_id, path) raise NotImplementedError end
+    def write_file(session_id, path, content) raise NotImplementedError end
+    def append_file(session_id, path, content) raise NotImplementedError end
+    def exists?(session_id, path) raise NotImplementedError end
+    def stat(session_id, path) raise NotImplementedError end
+    def mkdir(session_id, path, recursive: false) raise NotImplementedError end
+    def readdir(session_id, path) raise NotImplementedError end
+    def readdir_with_types(session_id, path) raise NotImplementedError end
+    def rm(session_id, path, recursive: false) raise NotImplementedError end
+    def rename(session_id, old_path, new_path) raise NotImplementedError end
+  end
+
   # Client options.
   ClientOptions = Struct.new(
     :cli_path, :cli_args, :cwd, :port, :use_stdio, :cli_url,
     :log_level, :auto_start, :auto_restart, :env,
-    :github_token, :use_logged_in_user,
+    :github_token, :use_logged_in_user, :session_idle_timeout_seconds,
+    :session_fs,
     keyword_init: true
   )
 end

data/lib/copilot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copilot-sdk-supercharged
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 2.0.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-12 00:00:00.000000000 Z
+date: 2026-04-25 00:00:00.000000000 Z
 dependencies: []
 description: |
   A Ruby SDK for interacting with the GitHub Copilot CLI server via JSON-RPC 2.0.