acp-sdk 0.8.0 → 0.10.0

data/lib/acp/transport/stdio.rb

@@ -13,6 +13,7 @@ class ACP::Transport::Stdio
   # @rbs @write_lock: Thread::Mutex
   # @rbs @lock: Thread::Mutex
   # @rbs @pending: Hash[untyped, Thread::Queue]
+  # @rbs @serving: Hash[untyped, ACP::Transport::Cancellation]
   # @rbs @next_id: Integer
   # @rbs @closed: bool
   # @rbs @logger: ACP::Transport::_Logger
@@ -31,6 +32,7 @@ class ACP::Transport::Stdio
     @write_lock = Mutex.new
     @lock = Mutex.new
     @pending = {}
+    @serving = {}
     @next_id = 0
     @closed = false
     @logger = logger
@@ -70,6 +72,34 @@ class ACP::Transport::Stdio
     write({ 'jsonrpc' => '2.0', 'method' => method, 'params' => params }.compact)
   end
 
+  # The waiting caller is released only by the peer's answer, which the spec
+  # requires to be either a result or the -32800 error.
+  #
+  # @rbs id: untyped
+  # @rbs return: void
+  def cancel(id)
+    pending = @lock.synchronize { @pending.key?(id) }
+    notify('$/cancel_request', { 'requestId' => id }) if pending
+  end
+
+  # Each id is re-checked against the pending table, so one that settled
+  # between the snapshot and its cancel is not cancelled.
+  #
+  # @rbs return: void
+  def cancel_requests
+    @lock.synchronize { @pending.keys }.each { |id| cancel(id) }
+  end
+
+  # The cancellation of the request the calling thread is serving, or nil off
+  # a serve thread. A handler observes the peer's $/cancel_request through it
+  # and can end early with ACP::RequestError.request_cancelled; whatever it
+  # returns, the transport sends exactly one response.
+  #
+  # @rbs return: ACP::Transport::Cancellation?
+  def cancellation
+    ACP::Transport::Cancellation.current
+  end
+
   private
 
   # @rbs line: String
@@ -91,7 +121,11 @@ class ACP::Transport::Stdio
   def route(message, requests, notifications)
     method = message['method']
     error = message['error']
-    if method.is_a?(String) && message.key?('id')
+    if method == '$/cancel_request' && !message.key?('id')
+      # Cancellation is transport-owned: the notification targets a request
+      # the transport is serving, not application state.
+      cancel_request(message['params'])
+    elsif method.is_a?(String) && message.key?('id')
       serve(requests[method], message['id'], message['params'], method)
     elsif method.is_a?(String)
       # Run on the reader thread so notifications (session/update) keep their
@@ -136,7 +170,9 @@ class ACP::Transport::Stdio
   # @rbs method: String
   # @rbs return: void
   def serve(handler, id, params, method)
+    cancellation = register_serving(id)
     Thread.new do
+      ACP::Transport::Cancellation.current = cancellation
       outcome = handler ? invoke(handler, params) : ACP::RequestError.method_not_found(method)
       case outcome
       when ACP::Transport::Reply
@@ -144,7 +180,42 @@ class ACP::Transport::Stdio
         quietly('reply after callback', &outcome.after)
       else reply(id, outcome)
       end
+    ensure
+      unregister_serving(id)
+    end
+  end
+
+  # Registered before the serve thread starts so a cancel racing the request
+  # cannot be missed, and dropped once the response is on the wire so later
+  # cancels for the id are ignored.
+  #
+  # @rbs id: untyped
+  # @rbs return: ACP::Transport::Cancellation
+  def register_serving(id)
+    cancellation = ACP::Transport::Cancellation.new
+    @lock.synchronize { @serving[id] = cancellation }
+    cancellation
+  end
+
+  # @rbs id: untyped
+  # @rbs return: void
+  def unregister_serving(id)
+    @lock.synchronize { @serving.delete(id) }
+  end
+
+  # A notification has no reply to carry a malformed params failure, so one
+  # is warned and dropped rather than answered.
+  #
+  # @rbs params: untyped
+  # @rbs return: void
+  def cancel_request(params)
+    id = params.is_a?(Hash) ? params['requestId'] : nil
+    unless id.is_a?(String) || id.is_a?(Integer)
+      return @logger.warn('dropped malformed $/cancel_request: missing requestId')
     end
+
+    cancellation = @lock.synchronize { @serving[id] }
+    cancellation&.cancel
   end
 
   # For code with no reply to carry an error: a notification handler, or a

data/lib/acp/types/unstable/accept_nes_notification.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::AcceptNesNotification
+  # @dynamic session_id
+  attr_reader :session_id #: String
+
+  # @dynamic id
+  attr_reader :id #: String
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs session_id: String
+  # @rbs id: String
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(session_id:, id:, meta: nil)
+    @session_id = session_id
+    @id = id
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::AcceptNesNotification
+  def self.from_h(hash)
+    new(
+      session_id: ACP::Types::Check.string(ACP::Types::Check.key(hash, 'sessionId'), 'sessionId'),
+      id: ACP::Types::Check.string(ACP::Types::Check.key(hash, 'id'), 'id'),
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    { 'sessionId' => session_id, 'id' => id, '_meta' => meta }.compact
+  end
+end

data/lib/acp/types/unstable/agent_capabilities.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::AgentCapabilities
+  # @dynamic load_session
+  attr_reader :load_session #: bool?
+
+  # @dynamic prompt_capabilities
+  attr_reader :prompt_capabilities #: ACP::Types::PromptCapabilities?
+
+  # @dynamic mcp_capabilities
+  attr_reader :mcp_capabilities #: ACP::Types::Unstable::McpCapabilities?
+
+  # @dynamic session_capabilities
+  attr_reader :session_capabilities #: ACP::Types::Unstable::SessionCapabilities?
+
+  # @dynamic auth
+  attr_reader :auth #: ACP::Types::AgentAuthCapabilities?
+
+  # @dynamic providers
+  attr_reader :providers #: ACP::Types::Unstable::ProvidersCapabilities?
+
+  # @dynamic nes
+  attr_reader :nes #: ACP::Types::Unstable::NesCapabilities?
+
+  # @dynamic position_encoding
+  attr_reader :position_encoding #: String?
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs load_session: bool?
+  # @rbs prompt_capabilities: ACP::Types::PromptCapabilities?
+  # @rbs mcp_capabilities: ACP::Types::Unstable::McpCapabilities?
+  # @rbs session_capabilities: ACP::Types::Unstable::SessionCapabilities?
+  # @rbs auth: ACP::Types::AgentAuthCapabilities?
+  # @rbs providers: ACP::Types::Unstable::ProvidersCapabilities?
+  # @rbs nes: ACP::Types::Unstable::NesCapabilities?
+  # @rbs position_encoding: String?
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(
+    load_session: nil,
+    prompt_capabilities: nil,
+    mcp_capabilities: nil,
+    session_capabilities: nil,
+    auth: nil,
+    providers: nil,
+    nes: nil,
+    position_encoding: nil,
+    meta: nil
+  )
+    @load_session = load_session
+    @prompt_capabilities = prompt_capabilities
+    @mcp_capabilities = mcp_capabilities
+    @session_capabilities = session_capabilities
+    @auth = auth
+    @providers = providers
+    @nes = nes
+    @position_encoding = position_encoding
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::AgentCapabilities
+  def self.from_h(hash)
+    new(
+      load_session: ACP::Types::Check.boolean(hash['loadSession'], 'loadSession', allow_nil: true),
+      prompt_capabilities: ACP::Types::Check.object(
+        hash['promptCapabilities'],
+        'promptCapabilities',
+        ACP::Types::PromptCapabilities,
+        allow_nil: true
+      ),
+      mcp_capabilities: ACP::Types::Check.object(
+        hash['mcpCapabilities'],
+        'mcpCapabilities',
+        ACP::Types::Unstable::McpCapabilities,
+        allow_nil: true
+      ),
+      session_capabilities: ACP::Types::Check.object(
+        hash['sessionCapabilities'],
+        'sessionCapabilities',
+        ACP::Types::Unstable::SessionCapabilities,
+        allow_nil: true
+      ),
+      auth: ACP::Types::Check.object(hash['auth'], 'auth', ACP::Types::AgentAuthCapabilities, allow_nil: true),
+      providers: ACP::Types::Check.object(
+        hash['providers'],
+        'providers',
+        ACP::Types::Unstable::ProvidersCapabilities,
+        allow_nil: true
+      ),
+      nes: ACP::Types::Check.object(hash['nes'], 'nes', ACP::Types::Unstable::NesCapabilities, allow_nil: true),
+      position_encoding: ACP::Types::Check.enum(
+        hash['positionEncoding'],
+        'positionEncoding',
+        %w[utf-16 utf-32 utf-8],
+        allow_nil: true
+      ),
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    {
+      'loadSession' => load_session,
+      'promptCapabilities' => prompt_capabilities&.to_h,
+      'mcpCapabilities' => mcp_capabilities&.to_h,
+      'sessionCapabilities' => session_capabilities&.to_h,
+      'auth' => auth&.to_h,
+      'providers' => providers&.to_h,
+      'nes' => nes&.to_h,
+      'positionEncoding' => position_encoding,
+      '_meta' => meta
+    }.compact
+  end
+end

data/lib/acp/types/unstable/client_capabilities.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::ClientCapabilities
+  # @dynamic fs
+  attr_reader :fs #: ACP::Types::FileSystemCapabilities?
+
+  # @dynamic terminal
+  attr_reader :terminal #: bool?
+
+  # @dynamic session
+  attr_reader :session #: ACP::Types::Unstable::ClientSessionCapabilities?
+
+  # @dynamic subagents
+  attr_reader :subagents #: ACP::Types::Unstable::SubagentCapabilities?
+
+  # @dynamic plan
+  attr_reader :plan #: ACP::Types::Unstable::PlanCapabilities?
+
+  # @dynamic auth
+  attr_reader :auth #: ACP::Types::AuthCapabilities?
+
+  # @dynamic elicitation
+  attr_reader :elicitation #: ACP::Types::ElicitationCapabilities?
+
+  # @dynamic nes
+  attr_reader :nes #: ACP::Types::Unstable::ClientNesCapabilities?
+
+  # @dynamic position_encodings
+  attr_reader :position_encodings #: Array[String]?
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs fs: ACP::Types::FileSystemCapabilities?
+  # @rbs terminal: bool?
+  # @rbs session: ACP::Types::Unstable::ClientSessionCapabilities?
+  # @rbs subagents: ACP::Types::Unstable::SubagentCapabilities?
+  # @rbs plan: ACP::Types::Unstable::PlanCapabilities?
+  # @rbs auth: ACP::Types::AuthCapabilities?
+  # @rbs elicitation: ACP::Types::ElicitationCapabilities?
+  # @rbs nes: ACP::Types::Unstable::ClientNesCapabilities?
+  # @rbs position_encodings: Array[String]?
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(
+    fs: nil,
+    terminal: nil,
+    session: nil,
+    subagents: nil,
+    plan: nil,
+    auth: nil,
+    elicitation: nil,
+    nes: nil,
+    position_encodings: nil,
+    meta: nil
+  )
+    @fs = fs
+    @terminal = terminal
+    @session = session
+    @subagents = subagents
+    @plan = plan
+    @auth = auth
+    @elicitation = elicitation
+    @nes = nes
+    @position_encodings = position_encodings
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::ClientCapabilities
+  def self.from_h(hash)
+    position_encodings = ACP::Types::Check.array(
+      hash['positionEncodings'],
+      'positionEncodings',
+      allow_nil: true
+    ) do |item, path|
+      ACP::Types::Check.enum(item, path, %w[utf-16 utf-32 utf-8])
+    end
+    new(
+      fs: ACP::Types::Check.object(hash['fs'], 'fs', ACP::Types::FileSystemCapabilities, allow_nil: true),
+      terminal: ACP::Types::Check.boolean(hash['terminal'], 'terminal', allow_nil: true),
+      session: ACP::Types::Check.object(
+        hash['session'],
+        'session',
+        ACP::Types::Unstable::ClientSessionCapabilities,
+        allow_nil: true
+      ),
+      subagents: ACP::Types::Check.object(
+        hash['subagents'],
+        'subagents',
+        ACP::Types::Unstable::SubagentCapabilities,
+        allow_nil: true
+      ),
+      plan: ACP::Types::Check.object(hash['plan'], 'plan', ACP::Types::Unstable::PlanCapabilities, allow_nil: true),
+      auth: ACP::Types::Check.object(hash['auth'], 'auth', ACP::Types::AuthCapabilities, allow_nil: true),
+      elicitation: ACP::Types::Check.object(
+        hash['elicitation'],
+        'elicitation',
+        ACP::Types::ElicitationCapabilities,
+        allow_nil: true
+      ),
+      nes: ACP::Types::Check.object(hash['nes'], 'nes', ACP::Types::Unstable::ClientNesCapabilities, allow_nil: true),
+      position_encodings:,
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    {
+      'fs' => fs&.to_h,
+      'terminal' => terminal,
+      'session' => session&.to_h,
+      'subagents' => subagents&.to_h,
+      'plan' => plan&.to_h,
+      'auth' => auth&.to_h,
+      'elicitation' => elicitation&.to_h,
+      'nes' => nes&.to_h,
+      'positionEncodings' => position_encodings,
+      '_meta' => meta
+    }.compact
+  end
+end

data/lib/acp/types/unstable/client_nes_capabilities.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::ClientNesCapabilities
+  # @dynamic jump
+  attr_reader :jump #: ACP::Types::Unstable::NesJumpCapabilities?
+
+  # @dynamic rename
+  attr_reader :rename #: ACP::Types::Unstable::NesRenameCapabilities?
+
+  # @dynamic search_and_replace
+  attr_reader :search_and_replace #: ACP::Types::Unstable::NesSearchAndReplaceCapabilities?
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs jump: ACP::Types::Unstable::NesJumpCapabilities?
+  # @rbs rename: ACP::Types::Unstable::NesRenameCapabilities?
+  # @rbs search_and_replace: ACP::Types::Unstable::NesSearchAndReplaceCapabilities?
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(jump: nil, rename: nil, search_and_replace: nil, meta: nil)
+    @jump = jump
+    @rename = rename
+    @search_and_replace = search_and_replace
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::ClientNesCapabilities
+  def self.from_h(hash)
+    new(
+      jump: ACP::Types::Check.object(hash['jump'], 'jump', ACP::Types::Unstable::NesJumpCapabilities, allow_nil: true),
+      rename: ACP::Types::Check.object(
+        hash['rename'],
+        'rename',
+        ACP::Types::Unstable::NesRenameCapabilities,
+        allow_nil: true
+      ),
+      search_and_replace: ACP::Types::Check.object(
+        hash['searchAndReplace'],
+        'searchAndReplace',
+        ACP::Types::Unstable::NesSearchAndReplaceCapabilities,
+        allow_nil: true
+      ),
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    {
+      'jump' => jump&.to_h,
+      'rename' => rename&.to_h,
+      'searchAndReplace' => search_and_replace&.to_h,
+      '_meta' => meta
+    }.compact
+  end
+end

data/lib/acp/types/unstable/client_session_capabilities.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::ClientSessionCapabilities
+  # @dynamic compaction
+  attr_reader :compaction #: Hash[String, untyped]?
+
+  # @dynamic config_options
+  attr_reader :config_options #: ACP::Types::SessionConfigOptionsCapabilities?
+
+  # @dynamic notices
+  attr_reader :notices #: Hash[String, untyped]?
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs compaction: Hash[String, untyped]?
+  # @rbs config_options: ACP::Types::SessionConfigOptionsCapabilities?
+  # @rbs notices: Hash[String, untyped]?
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(compaction: nil, config_options: nil, notices: nil, meta: nil)
+    @compaction = compaction
+    @config_options = config_options
+    @notices = notices
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::ClientSessionCapabilities
+  def self.from_h(hash)
+    new(
+      compaction: hash['compaction'],
+      config_options: ACP::Types::Check.object(
+        hash['configOptions'],
+        'configOptions',
+        ACP::Types::SessionConfigOptionsCapabilities,
+        allow_nil: true
+      ),
+      notices: hash['notices'],
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    {
+      'compaction' => compaction,
+      'configOptions' => config_options&.to_h,
+      'notices' => notices,
+      '_meta' => meta
+    }.compact
+  end
+end

data/lib/acp/types/unstable/close_nes_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::CloseNesRequest
+  # @dynamic session_id
+  attr_reader :session_id #: String
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs session_id: String
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(session_id:, meta: nil)
+    @session_id = session_id
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::CloseNesRequest
+  def self.from_h(hash)
+    new(
+      session_id: ACP::Types::Check.string(ACP::Types::Check.key(hash, 'sessionId'), 'sessionId'),
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    { 'sessionId' => session_id, '_meta' => meta }.compact
+  end
+end

data/lib/acp/types/unstable/close_nes_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::CloseNesResponse
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(meta: nil)
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::CloseNesResponse
+  def self.from_h(hash)
+    new(meta: hash['_meta'])
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    { '_meta' => meta }.compact
+  end
+end

data/lib/acp/types/unstable/compaction_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+module ACP::Types::Unstable::CompactionStatus
+  IN_PROGRESS = 'in_progress'
+  COMPLETED = 'completed'
+  FAILED = 'failed'
+  CANCELLED = 'cancelled'
+end

data/lib/acp/types/unstable/compaction_summary_chunk.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Generated by bin/types from schema/schema.unstable.json. Do not edit.
+# Unstable: not part of the ACP spec, may change or disappear at any point.
+
+class ACP::Types::Unstable::CompactionSummaryChunk
+  # @dynamic compaction_id
+  attr_reader :compaction_id #: String
+
+  # @dynamic content
+  attr_reader :content #: ACP::Types::ContentBlock::t
+
+  # @dynamic meta
+  attr_reader :meta #: Hash[String, untyped]?
+
+  # @rbs compaction_id: String
+  # @rbs content: ACP::Types::ContentBlock::t
+  # @rbs meta: Hash[String, untyped]?
+  # @rbs return: void
+  def initialize(compaction_id:, content:, meta: nil)
+    @compaction_id = compaction_id
+    @content = content
+    @meta = meta
+    freeze
+  end
+
+  # @rbs hash: Hash[String, untyped]
+  # @rbs return: ACP::Types::Unstable::CompactionSummaryChunk
+  def self.from_h(hash)
+    new(
+      compaction_id: ACP::Types::Check.string(ACP::Types::Check.key(hash, 'compactionId'), 'compactionId'),
+      content: ACP::Types::Check.object(ACP::Types::Check.key(hash, 'content'), 'content', ACP::Types::ContentBlock),
+      meta: hash['_meta']
+    )
+  end
+
+  # @rbs return: Hash[String, untyped]
+  def to_h
+    { 'compactionId' => compaction_id, 'content' => content.to_h, '_meta' => meta }.compact
+  end
+end