Repository navigation
Expand file tree
/
Copy pathapi_client.lua
More file actions
666 lines (572 loc) · 22.7 KB
/
Copy pathapi_client.lua
File metadata and controls
666 lines (572 loc) · 22.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
local server_job = require('opencode.server_job')
local state = require('opencode.state')
local url_encode = require('opencode.util').url_encode
local apply_path_map = require('opencode.util').apply_path_map
local reverse_transform_paths_recursive = require('opencode.util').reverse_transform_paths_recursive
local transform_paths_recursive = require('opencode.util').transform_paths_recursive
local is_version_greater_or_equal = require('opencode.util').is_version_greater_or_equal
--- @class OpencodeApiClient
--- @field base_url string The base URL of the opencode server
local OpencodeApiClient = {}
OpencodeApiClient.__index = OpencodeApiClient
--- Create a new API client instance
--- @param base_url? string The base URL of the opencode server
--- @return OpencodeApiClient
function OpencodeApiClient.new(base_url)
return setmetatable({
base_url = base_url and base_url:gsub('/$', ''), -- Remove trailing slash
}, OpencodeApiClient)
end
---Convert /global/event envelopes into the legacy event shape consumed by the
---rest of the plugin.
---@param event table|nil
---@return table|nil
local function normalize_global_event(event)
if type(event) ~= 'table' then
return nil
end
local payload = event.payload
if type(payload) ~= 'table' then
return nil
end
if payload.type == 'sync' then
local sync_event = payload.syncEvent
if type(sync_event) ~= 'table' then
return nil
end
local event_type = sync_event.type
if type(event_type) ~= 'string' then
return nil
end
event_type = event_type:gsub('%.%d+$', '')
return {
id = sync_event.id or payload.id,
type = event_type,
properties = sync_event.data,
}
end
if type(payload.type) ~= 'string' then
return nil
end
return {
id = payload.id,
type = payload.type,
properties = payload.properties,
}
end
---Ensure that base_url is set. Even thought we're subscribed to
---state.opencode_server, we still need this check because
---it's possible someone will try to make an api call in their event
---handler (e.g. event_manager or header)
---@return boolean
function OpencodeApiClient:_ensure_base_url()
-- NOTE: eventhough we're subscribed opencode_server, we need this check for
-- base_url because the notification about opencode_server being set to
-- non-nil my not have gotten to us in time
if self.base_url then
return true
end
if not state.opencode_server then
-- this is last resort - try to start the server and could be blocking
state.jobs.set_server(server_job.ensure_server():wait() --[[@as OpencodeServer]])
-- shouldn't normally happen but prevents error in replay tester
if not state.opencode_server then
return false
end
end
if not state.opencode_server.url then
state.opencode_server:get_spawn_promise():wait()
if not state.opencode_server.url then
return false
end
end
self.base_url = state.opencode_server.url:gsub('/$', '')
return true
end
--- Make a typed API call
--- @param endpoint string The API endpoint path
--- @param method string|nil HTTP method (default: 'GET')
--- @param body table|nil|boolean Request body
--- @param query table|nil Query parameters
--- @return Promise<any> promise
function OpencodeApiClient:_call(endpoint, method, body, query)
if not self:_ensure_base_url() then
return require('opencode.promise').new():reject('No server base url')
end
local url = self.base_url .. endpoint
if query then
if not query.directory then
query.directory = state.current_cwd or vim.fn.getcwd()
end
query = transform_paths_recursive(query)
local params = {}
for k, v in pairs(query) do
if v ~= nil then
table.insert(params, url_encode(k) .. '=' .. url_encode(v))
end
end
if #params > 0 then
url = url .. '?' .. table.concat(params, '&')
end
end
if body and type(body) == 'table' then
body = transform_paths_recursive(body)
end
return server_job.call_api(url, method, body):and_then(function(result)
return reverse_transform_paths_recursive(result)
end)
end
-- Project endpoints
--- List all projects
--- @param directory string|nil Directory path
--- @return Promise<OpencodeProject[]>
function OpencodeApiClient:list_projects(directory)
return self:_call('/project', 'GET', nil, { directory = directory })
end
--- Get the current project
--- @param directory string|nil Directory path
--- @return Promise<OpencodeProject>
function OpencodeApiClient:get_current_project(directory)
return self:_call('/project/current', 'GET', nil, { directory = directory })
end
-- Config endpoints
--- Get config info
--- @param directory string|nil Directory path
--- @return Promise<OpencodeConfig>
function OpencodeApiClient:get_config(directory)
return self:_call('/config', 'GET', nil, { directory = directory })
end
--- Update config
--- @param config OpencodeConfig Config object to update
--- @param directory string|nil Directory path
--- @return Promise<OpencodeConfig>
function OpencodeApiClient:update_config(config, directory)
return self:_call('/config', 'PATCH', config, { directory = directory })
end
--- List all providers
--- @param directory string|nil Directory path
--- @return Promise<OpencodeProvidersResponse>
function OpencodeApiClient:list_providers(directory)
return self:_call('/config/providers', 'GET', nil, { directory = directory })
end
--- Get the current path
--- @param directory string|nil Directory path
--- @return Promise<OpencodePath>
function OpencodeApiClient:get_path(directory)
return self:_call('/path', 'GET', nil, { directory = directory })
end
-- Session endpoints
--- List all sessions
--- @param directory string|nil Directory path
--- @return Promise<Session[]>
function OpencodeApiClient:list_sessions(directory)
return self:_call('/session', 'GET', nil, { directory = directory })
end
--- List sessions across all projects (experimental global endpoint).
--- Bypasses _call's automatic directory injection so the server returns all
--- directories instead of being filtered to the current cwd.
--- @return Promise<GlobalSession[]>
function OpencodeApiClient:list_sessions_global()
if not self:_ensure_base_url() then
return require('opencode.promise').new():reject('No server base url')
end
return server_job.call_api(self.base_url .. '/experimental/session', 'GET')
end
--- Create a new session
--- @param session_data {parentID?: string, title?: string}|nil|boolean Session creation data
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:create_session(session_data, directory)
return self:_call('/session', 'POST', session_data or false, { directory = directory })
end
--- Get session by ID
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:get_session(id, directory)
return self:_call('/session/' .. id, 'GET', nil, { directory = directory })
end
--- Delete a session
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:delete_session(id, directory)
return self:_call('/session/' .. id, 'DELETE', nil, { directory = directory })
end
--- Update session properties
--- @param id string Session ID (required)
--- @param session_update {title?: string} Session update data
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:update_session(id, session_update, directory)
return self:_call('/session/' .. id, 'PATCH', session_update, { directory = directory })
end
--- Get a session's children
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<Session[]>
function OpencodeApiClient:get_session_children(id, directory)
return self:_call('/session/' .. id .. '/children', 'GET', nil, { directory = directory })
end
--- Initialize session (analyze app and create AGENTS.md)
--- @param id string Session ID (required)
--- @param init_data {messageID: string, providerID: string, modelID: string} Initialization data
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:init_session(id, init_data, directory)
return self:_call('/session/' .. id .. '/init', 'POST', init_data, { directory = directory })
end
--- Abort a session
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:abort_session(id, directory)
return self:_call('/session/' .. id .. '/abort', 'POST', nil, { directory = directory })
end
--- Share a session
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:share_session(id, directory)
return self:_call('/session/' .. id .. '/share', 'POST', nil, { directory = directory })
end
--- Unshare a session
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:unshare_session(id, directory)
return self:_call('/session/' .. id .. '/share', 'DELETE', nil, { directory = directory })
end
--- Summarize a session
--- @param id string Session ID (required)
--- @param summary_data {providerID: string, modelID: string} Summary data
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:summarize_session(id, summary_data, directory)
return self:_call('/session/' .. id .. '/summarize', 'POST', summary_data, { directory = directory })
end
--- Fork an existing session at a specific message
--- @param id string Session ID (required)
--- @param fork_data {messageID?: string}|nil Fork data
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:fork_session(id, fork_data, directory)
return self:_call('/session/' .. id .. '/fork', 'POST', fork_data, { directory = directory })
end
-- Message endpoints
--- List messages for a session
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @param opts? { limit?: number } Optional query parameters
--- @return Promise<OpencodeMessage[]>
function OpencodeApiClient:list_messages(id, directory, opts)
local query = { directory = directory }
if opts then
for k, v in pairs(opts) do
query[k] = v
end
end
return self:_call('/session/' .. id .. '/message', 'GET', nil, query)
end
--- Create and send a new message to a session
--- @param id string Session ID (required)
--- @param message_data {messageID?: string, model?: {providerID: string, modelID: string}, agent?: string, variant?: string, system?: string, tools?: table<string, boolean>, parts: OpencodeMessagePart[]} Message creation data
--- @param directory string|nil Directory path
--- @return Promise<{info: MessageInfo, parts: OpencodeMessagePart[]}>
function OpencodeApiClient:create_message(id, message_data, directory)
return self:_call('/session/' .. id .. '/message', 'POST', message_data, { directory = directory })
end
--- Get a message from a session
--- @param id string Session ID (required)
--- @param messageID string Message ID (required)
--- @param directory string|nil Directory path
--- @return Promise<OpencodeMessage>
function OpencodeApiClient:get_message(id, messageID, directory)
return self:_call('/session/' .. id .. '/message/' .. messageID, 'GET', nil, { directory = directory })
end
--- Send a command to a session
--- @param id string Session ID (required)
--- @param command_data {messageID?: string, agent?: string, model?: string, arguments: string, command: string} Command data
--- @param directory string|nil Directory path
--- @return Promise<OpencodeMessage>
function OpencodeApiClient:send_command(id, command_data, directory)
return self:_call('/session/' .. id .. '/command', 'POST', command_data, { directory = directory })
end
--- Run a shell command
--- @param id string Session ID (required)
--- @param shell_data {agent?: string, command: string} Shell command data
--- @param directory string|nil Directory path
--- @return Promise<MessageInfo>
function OpencodeApiClient:run_shell(id, shell_data, directory)
return self:_call('/session/' .. id .. '/shell', 'POST', shell_data, { directory = directory })
end
--- Revert a message
--- @param id string Session ID (required)
--- @param revert_data {messageID: string, partID?: string} Revert data
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:revert_message(id, revert_data, directory)
return self:_call('/session/' .. id .. '/revert', 'POST', revert_data, { directory = directory })
end
--- Restore all reverted messages
--- @param id string Session ID (required)
--- @param directory string|nil Directory path
--- @return Promise<Session>
function OpencodeApiClient:unrevert_messages(id, directory)
return self:_call('/session/' .. id .. '/unrevert', 'POST', nil, { directory = directory })
end
--- List pending permissions
--- @param directory string|nil Directory path
--- @return Promise<OpencodePermission[]>
function OpencodeApiClient:list_permissions(directory)
return self:_call('/permission', 'GET', nil, { directory = directory })
end
--- Respond to a permission request
--- @param id string Session ID (required)
--- @param permissionID string Permission ID (required)
--- @param response_data {response: "once"|"always"|"reject"} Response data
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:respond_to_permission(id, permissionID, response_data, directory)
return self:_call(
'/session/' .. id .. '/permissions/' .. permissionID,
'POST',
response_data,
{ directory = directory }
)
end
--- List all commands
--- @param directory string|nil Directory path
--- @return Promise<OpencodeCommand[]>
function OpencodeApiClient:list_commands(directory)
return self:_call('/command', 'GET', nil, { directory = directory })
end
--- Find text in files
--- @param pattern string Search pattern (required)
--- @param directory string|nil Directory path
--- @return Promise<table[]> Search results
function OpencodeApiClient:find_text(pattern, directory)
return self:_call('/find', 'GET', nil, {
pattern = pattern,
directory = directory,
})
end
--- Find files
--- @param query string File search query (required)
--- @param directory string|nil Directory path
--- @return Promise<string[]> File paths
function OpencodeApiClient:find_files(query, directory)
return self:_call('/find/file', 'GET', nil, {
query = query,
directory = directory,
})
end
--- Find workspace symbols
--- @param query string Symbol search query (required)
--- @param directory string|nil Directory path
--- @return Promise<table[]> Symbols
function OpencodeApiClient:find_symbols(query, directory)
return self:_call('/find/symbol', 'GET', nil, {
query = query,
directory = directory,
})
end
-- File endpoints
--- List files and directories
--- @param path string File path (required)
--- @param directory string|nil Directory path
--- @return Promise<table[]>
function OpencodeApiClient:list_files(path, directory)
return self:_call('/file', 'GET', nil, {
path = path,
directory = directory,
})
end
--- Read a file
--- @param path string File path (required)
--- @param directory string|nil Directory path
--- @return Promise<table>
function OpencodeApiClient:read_file(path, directory)
return self:_call('/file/content', 'GET', nil, {
path = path,
directory = directory,
})
end
--- Get file status
--- @param directory string|nil Directory path
--- @return Promise<table[]>
function OpencodeApiClient:get_file_status(directory)
return self:_call('/file/status', 'GET', nil, { directory = directory })
end
-- Log endpoints
--- Write a log entry to the server logs
--- @param log_data {service: string, level: "debug"|"info"|"error"|"warn", message: string, extra?: table<string, any>} Log entry data
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:write_log(log_data, directory)
return self:_call('/log', 'POST', log_data, { directory = directory })
end
-- Agent endpoints
--- List all agents
--- @param directory string|nil Directory path
--- @return Promise<OpencodeAgent[]>
function OpencodeApiClient:list_agents(directory)
return self:_call('/agent', 'GET', nil, { directory = directory })
end
-- Question endpoints
--- List pending questions
--- @param directory string|nil Directory path
--- @return Promise<OpencodeQuestionRequest[]>
function OpencodeApiClient:list_questions(directory)
return self:_call('/question', 'GET', nil, { directory = directory })
end
--- Reply to a question
--- @param requestID string Question request ID (required)
--- @param answers string[][] Array of answers (each answer is array of selected labels)
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:reply_question(requestID, answers, directory)
return self:_call('/question/' .. requestID .. '/reply', 'POST', { answers = answers }, { directory = directory })
end
--- Reject a question
--- @param requestID string Question request ID (required)
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:reject_question(requestID, directory)
return self:_call('/question/' .. requestID .. '/reject', 'POST', nil, { directory = directory })
end
--- Subscribe to events (streaming)
--- @param directory string|nil Directory path
--- @param on_event fun(event: table) Event callback
--- @return table The streaming job handle
function OpencodeApiClient:subscribe_to_events(directory, on_event)
-- Make sure we have a base URL before attempting to subscribe. If we
-- cannot determine a base URL (server not running), return nil so
-- callers can handle the absence of a subscription without an error.
if not self:_ensure_base_url() then
return nil
end
if is_version_greater_or_equal(state.opencode_cli_version, '1.14.42') then
return self:_subscribe_to_global_events(directory, on_event)
end
local url = self.base_url .. '/event'
if directory then
local mapped_directory = apply_path_map(directory)
url = url .. '?directory=' .. url_encode(mapped_directory)
end
return server_job.stream_api(url, 'GET', nil, function(chunk)
chunk = chunk:gsub('^data:%s*', '')
local ok, event = pcall(vim.json.decode, vim.trim(chunk))
if ok and event then
local transformed_event = reverse_transform_paths_recursive(event)
on_event(transformed_event --[[@as table]])
end
end)
end
--- Subscribe to events (streaming)
--- @param directory string|nil Directory path
--- @param on_event fun(event: table) Event callback
--- @return table The streaming job handle
function OpencodeApiClient:_subscribe_to_global_events(directory, on_event)
-- Ensure base_url is available. If not, return nil instead of erroring.
if not self:_ensure_base_url() then
return nil
end
if not is_version_greater_or_equal(state.opencode_cli_version, '1.14.42') then
error('subscribe_to_global_events should not be called directly')
end
local url = self.base_url .. '/global/event'
if directory then
local mapped_directory = apply_path_map(directory)
url = url .. '?directory=' .. url_encode(mapped_directory)
end
return server_job.stream_api(url, 'GET', nil, function(chunk)
chunk = chunk:gsub('^data:%s*', '')
local ok, event = pcall(vim.json.decode, vim.trim(chunk))
if ok and event then
local normalized_event = normalize_global_event(event)
if normalized_event then
local transformed_event = reverse_transform_paths_recursive(normalized_event)
on_event(transformed_event --[[@as table]])
end
end
end)
end
-- Skill endpoints
--- List all skills
--- @param directory string|nil Directory path
--- @return Promise<OpencodeSkill[]>
function OpencodeApiClient:list_skills(directory)
return self:_call('/skill', 'GET', nil, { directory = directory })
end
-- Tool endpoints
--- List all tool IDs (including built-in and dynamically registered)
--- @param directory string|nil Directory path
--- @return Promise<string[]>
function OpencodeApiClient:list_tool_ids(directory)
return self:_call('/experimental/tool/ids', 'GET', nil, { directory = directory })
end
--- List tools with JSON schema parameters for a provider/model
--- @param provider string Provider name (required)
--- @param model string Model name (required)
--- @param directory string|nil Directory path
--- @return Promise<OpencodeToolList>
function OpencodeApiClient:list_tools(provider, model, directory)
return self:_call('/experimental/tool', 'GET', nil, {
provider = provider,
model = model,
directory = directory,
})
end
-- MCP endpoints
--- List all MCP servers
--- @param directory string|nil Directory path
--- @return Promise<table<string, table>>
function OpencodeApiClient:list_mcp_servers(directory)
return self:_call('/mcp', 'GET', nil, { directory = directory })
end
--- Connect an MCP server
--- @param name string MCP server name (required)
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:connect_mcp(name, directory)
if not name or name == '' then
return require('opencode.promise').new():reject('MCP server name is required')
end
return self:_call('/mcp/' .. name .. '/connect', 'POST', nil, { directory = directory })
end
--- Disconnect an MCP server
--- @param name string MCP server name (required)
--- @param directory string|nil Directory path
--- @return Promise<boolean>
function OpencodeApiClient:disconnect_mcp(name, directory)
if not name or name == '' then
return require('opencode.promise').new():reject('MCP server name is required')
end
return self:_call('/mcp/' .. name .. '/disconnect', 'POST', nil, { directory = directory })
end
--- Create a factory function for the module
--- @param base_url? string The base URL of the opencode server
--- @return OpencodeApiClient
local function create_client(base_url)
local state = require('opencode.state')
base_url = base_url or state.opencode_server and state.opencode_server.url
local api_client = OpencodeApiClient.new(base_url)
local function on_server_change(_, new_val, _)
-- NOTE: set base_url here if we can. we still need the check in _call
-- because the event firing on the server change may not have happened
-- before a caller is trying to make an api request, so the main benefit
-- of the subscription is setting base_url to nil when the server goes away
if new_val and new_val.url then
api_client.base_url = new_val.url
else
api_client.base_url = nil
end
end
state.store.subscribe('opencode_server', on_server_change)
return api_client
end
return {
new = OpencodeApiClient.new,
create = create_client,
}