* docs: add image search & generation design spec and implementation plan - Spec: dual-source image search (Openverse + Wikimedia), multi-provider image generation - Plan: 16 tasks covering types, server endpoints, settings UI, property panel, auto-search pipeline, MCP integration * feat(types): add image service types and imagePrompt to ImageNode * feat(server): add image service API key validation endpoint Adds POST /api/ai/image-service-test that validates credentials for openverse (client_credentials), openai/custom (Bearer + /v1/models), gemini (API key + v1beta/models), and replicate (Bearer + /v1/models). * feat(server): add multi-provider image generation endpoint * feat(server): add dual-source image search endpoint (Openverse + Wikimedia) POST /api/ai/image-search searches freely-licensed images via Openverse with automatic fallback to Wikimedia Commons on 429 rate-limit responses. Supports optional OAuth credentials for authenticated Openverse requests. * feat(store): add imageSearchStatuses to canvas store for runtime status tracking * feat(store): add image generation config and Openverse OAuth to agent settings * feat(editor): add Images tab to agent settings dialog Adds Popover primitive, ImagesPage component with Image Search (Openverse OAuth, test) and Image Generation (provider select, API key, model, base URL) sections, and wires them into the settings dialog sidebar. * feat(panels): add image search popover with Openverse/Wikimedia results grid * feat(panels): add image generate popover with multi-provider support * feat(panels): add Search and Generate buttons to image property section * feat(ai): update prompts to use imagePrompt instead of src for image nodes * feat(ai): add auto-search pipeline with Openverse/Wikimedia fallback * feat(ai): trigger auto image search after design generation completes * feat(mcp): implement G() operation for image search in batch design DSL Adds the G(parent, mode, prompt) operation to batch_design DSL that creates an image node and optionally fetches a real image URL via the image-search API when mode is "search". Converts executeLine to async to support the network call. * feat(mcp): auto-fill images after design refinement in layered pipeline * feat(ai): split imageSearchQuery and imagePrompt for search vs generation - ImageNode now has both imageSearchQuery (short keywords for search) and imagePrompt (long description for AI image generation) - AI prompts instruct LLM to generate both fields - Search pipeline and popovers use imageSearchQuery - Generate popover uses imagePrompt - Server-side simplifySearchQuery kept as fallback for manual input * fix(ai): hook auto image search into orchestrator completion path The primary generation path uses executeOrchestration -> insertStreamingNode, not applyNodesToCanvas/animateNodesToCanvas. Added scanAndFillImages call to orchestrator.ts after all sub-agents complete. Added debug logging. Removed plan/spec docs from git. * style(editor): remove provider names from image search ready status * fix(panels): clean up image gen error display and settings UI - Parse API error response to show concise message instead of raw JSON - Limit error text to 2 lines with line-clamp - Fix image gen test button sending wrong service name - Inline Image Search ready indicator with section header - Remove debug logging from image search pipeline * style(panels): allow up to 4 lines for image gen error message * fix: avoid 1-frame delay when resizing canvas (#60) rAF callbacks run before ResizeObserver in the same frame. Scheduling render in ResizeObserver via rAF defers it to the next frame. Invoke render() synchronously to leverage ResizeObserver's pre-paint timing and ensure immediate visual update. * feat(electron): implement desktop application structure and auto-updater - Introduced a new Electron desktop application with a structured directory for apps and packages. - Added auto-updater functionality to manage application updates seamlessly. - Created a comprehensive menu system for the desktop app. - Implemented logging capabilities for better debugging and error tracking. - Configured build settings for various platforms (macOS, Windows, Linux) using electron-builder. - Established TypeScript configurations for both the desktop and web applications. - Integrated Vite for the web application with support for React and Tailwind CSS. - Added icons and assets for the desktop application. * chore: update package versions to 0.5.0 across all package.json files and add pre-commit hook for version synchronization - Bumped version to 0.5.0 in package.json files for the main project, desktop app, web app, and all packages. - Introduced a pre-commit hook to automatically sync version numbers from branch names to all package.json files. * chore: update package versions to 0.5.0 and refactor Skia components - Bumped version to 0.5.0 in bun.lock and all relevant package.json files. - Refactored Skia components to utilize shared functionality from @zseven-w/pen-renderer, including image loading, hit testing, and path utilities. - Removed redundant code and improved modularity by re-exporting necessary functions and classes from the renderer package. * fix(panels): handle string fill values in icon nodes (#61) AI-generated icon/path nodes may have fill stored as a raw string instead of a PenFill[] array, causing "Cannot use 'in' operator" crash when selecting the node in the property panel. * chore: update documentation and project structure for monorepo organization - Added a new version bump command to synchronize all package.json files. - Updated the project structure to reflect a monorepo setup with organized workspaces for apps and packages. - Enhanced README files in multiple languages to include the new structure and commands. - Adjusted image paths in documentation to point to the correct locations for the desktop application. * feat(ai): incremental image search and improved image generation prompts - Refactor image search from batch post-generation to incremental queue: enqueueImageForSearch() triggers as each image node is inserted during streaming, so images appear progressively instead of all at once after generation completes. scanAndFillImages() remains as a final sweep. - Update imagePrompt guidance to avoid "transparent background" and similar phrases that many models cannot reliably produce. - Pass node width/height from image panel to generation endpoint for aspect-ratio-aware output (Gemini aspect ratio mapping, OpenAI size selection, Replicate dimensions). * feat(ai): multi-profile image generation config and cleaner error messages - Support multiple image generation profiles with active selection; first configured profile becomes default. Old single-config migrated automatically on hydrate. - Fix Gemini aspect ratio: move to generationConfig.imageConfig per API spec. - Extract clean error messages from provider JSON responses (Gemini error.message, OpenAI error.message, Replicate detail) instead of returning raw JSON text. - Remove destructive client-side regex that mangled error display. * feat(design-md): integrate design system panel and functionality - Added a new DesignMdPanel component for managing design system specifications. - Implemented functionality to toggle the design system panel in the editor layout and toolbar. - Introduced new commands for importing, exporting, and auto-generating design.md content. - Updated AI chat handlers to utilize design.md data for enhanced design generation. - Enhanced localization support for design system features across multiple languages. * perf(canvas): skip draw calls for nodes outside the viewport (#64) Add viewport culling in render() to avoid issuing CanvasKit draw calls for off-screen nodes. A 64px screen-space buffer is kept around the viewport edges so nearby nodes are pre-rendered, preventing pop-in during fast panning. * feat(utils): enhance Windows process spawning for CLI scripts - Updated the buildSpawnClaudeCodeProcess function to handle .cmd and .ps1 scripts appropriately. - Implemented PowerShell invocation for .ps1 files and ensured safe defaults for .cmd and .exe files. - Improved handling of command execution to avoid limitations of cmd.exe. * feat(ai): add support for Gemini CLI integration - Extended the AI provider options to include 'gemini' across various components and APIs. - Implemented functions for generating, validating, and connecting to the Gemini CLI. - Added Gemini-specific error handling and model fetching logic. - Updated UI components to display Gemini as a selectable provider with appropriate icons and labels. - Enhanced localization support for Gemini-related features in multiple languages. * feat(editor): warn before closing with unsaved changes Intercept window/tab close when isDirty is true: - Electron: native dialog with Save / Don't Save / Cancel - Web: beforeunload handler + confirm on New/Open actions - i18n: close-confirm strings for all 15 locales * feat(ipc): extract IPC handlers to a dedicated module - Moved IPC dialog handling and updater functions from main.ts to ipc-handlers.ts for better organization and maintainability. - Implemented file open/save dialogs, theme setting, and preferences management through IPC. - Enhanced updater functionality with state management and auto-update settings. - Improved code structure by separating concerns, making it easier to manage IPC-related logic. * feat(docs): update CLAUDE documentation and add new files for desktop and web apps - Enhanced CLAUDE.md with detailed module documentation references for `packages/` and `apps/`. - Updated `pen-core` description to include clone utilities in `pen-core`. - Added new documentation files for the desktop and web applications, outlining their structure, components, and functionalities. - Included IPC handler details in the desktop app documentation for better clarity on file dialogs and theme synchronization. * feat(docker): add Gemini CLI support and update documentation - Introduced a new Docker build stage for the Gemini CLI, allowing users to install and run it. - Updated the Dockerfile to include the installation of the Gemini CLI alongside existing CLI tools. - Enhanced README files in multiple languages to document the new `openpencil-gemini` image variant. - Added Gemini CLI connection instructions to the main README for better user guidance. * feat(docs): add Gemini CLI connection instructions to multiple language READMEs - Updated README files in German, Spanish, French, Hindi, Indonesian, Japanese, Korean, Portuguese, Russian, Thai, Turkish, Vietnamese, and both Traditional and Simplified Chinese to include connection instructions for the Gemini CLI. - Enhanced documentation to improve user guidance for connecting the Gemini CLI in agent settings. * perf(renderer): replace count-based text cache limits with memory-based eviction (#66) previous limits (PARA_CACHE_MAX=200, TEXT_CACHE_MAX=300) were too small for scenes with many nodes, causing constant cache churn and paragraph rebuilds every frame, which dropped FPS significantly during canvas pan. - switch to byte-budget limits (64 MB paragraphs, 256 MB bitmaps) - bitmap size measured exactly as cw*ch*4; paragraph WASM heap estimated as content.length*64+4096 - eviction uses Map insertion order (FIFO) instead of a separate string[] array, replacing O(n) array.shift() with O(1) Map.entries().next() - evict before insert so the budget check includes the incoming entry --------- Co-authored-by: Fini <fini.yang@gmail.com> Co-authored-by: leinaldo <60176594+leinaldo@users.noreply.github.com>
4034 lines
97 KiB
TypeScript
4034 lines
97 KiB
TypeScript
// This file is auto-generated by @hey-api/openapi-ts
|
|
|
|
import { client } from "./client.gen.js"
|
|
import { buildClientParams, type Client, type Options as Options2, type TDataShape } from "./client/index.js"
|
|
import type {
|
|
AgentPartInput,
|
|
AppAgentsResponses,
|
|
AppLogErrors,
|
|
AppLogResponses,
|
|
AppSkillsResponses,
|
|
Auth as Auth3,
|
|
AuthRemoveErrors,
|
|
AuthRemoveResponses,
|
|
AuthSetErrors,
|
|
AuthSetResponses,
|
|
CommandListResponses,
|
|
Config as Config3,
|
|
ConfigGetResponses,
|
|
ConfigProvidersResponses,
|
|
ConfigUpdateErrors,
|
|
ConfigUpdateResponses,
|
|
EventSubscribeResponses,
|
|
EventTuiCommandExecute,
|
|
EventTuiPromptAppend,
|
|
EventTuiSessionSelect,
|
|
EventTuiToastShow,
|
|
ExperimentalResourceListResponses,
|
|
ExperimentalSessionListResponses,
|
|
ExperimentalWorkspaceCreateErrors,
|
|
ExperimentalWorkspaceCreateResponses,
|
|
ExperimentalWorkspaceListResponses,
|
|
ExperimentalWorkspaceRemoveErrors,
|
|
ExperimentalWorkspaceRemoveResponses,
|
|
FileListResponses,
|
|
FilePartInput,
|
|
FilePartSource,
|
|
FileReadResponses,
|
|
FileStatusResponses,
|
|
FindFilesResponses,
|
|
FindSymbolsResponses,
|
|
FindTextResponses,
|
|
FormatterStatusResponses,
|
|
GlobalConfigGetResponses,
|
|
GlobalConfigUpdateErrors,
|
|
GlobalConfigUpdateResponses,
|
|
GlobalDisposeResponses,
|
|
GlobalEventResponses,
|
|
GlobalHealthResponses,
|
|
InstanceDisposeResponses,
|
|
LspStatusResponses,
|
|
McpAddErrors,
|
|
McpAddResponses,
|
|
McpAuthAuthenticateErrors,
|
|
McpAuthAuthenticateResponses,
|
|
McpAuthCallbackErrors,
|
|
McpAuthCallbackResponses,
|
|
McpAuthRemoveErrors,
|
|
McpAuthRemoveResponses,
|
|
McpAuthStartErrors,
|
|
McpAuthStartResponses,
|
|
McpConnectResponses,
|
|
McpDisconnectResponses,
|
|
McpLocalConfig,
|
|
McpRemoteConfig,
|
|
McpStatusResponses,
|
|
OutputFormat,
|
|
Part as Part2,
|
|
PartDeleteErrors,
|
|
PartDeleteResponses,
|
|
PartUpdateErrors,
|
|
PartUpdateResponses,
|
|
PathGetResponses,
|
|
PermissionListResponses,
|
|
PermissionReplyErrors,
|
|
PermissionReplyResponses,
|
|
PermissionRespondErrors,
|
|
PermissionRespondResponses,
|
|
PermissionRuleset,
|
|
ProjectCurrentResponses,
|
|
ProjectInitGitResponses,
|
|
ProjectListResponses,
|
|
ProjectUpdateErrors,
|
|
ProjectUpdateResponses,
|
|
ProviderAuthResponses,
|
|
ProviderListResponses,
|
|
ProviderOauthAuthorizeErrors,
|
|
ProviderOauthAuthorizeResponses,
|
|
ProviderOauthCallbackErrors,
|
|
ProviderOauthCallbackResponses,
|
|
PtyConnectErrors,
|
|
PtyConnectResponses,
|
|
PtyCreateErrors,
|
|
PtyCreateResponses,
|
|
PtyGetErrors,
|
|
PtyGetResponses,
|
|
PtyListResponses,
|
|
PtyRemoveErrors,
|
|
PtyRemoveResponses,
|
|
PtyUpdateErrors,
|
|
PtyUpdateResponses,
|
|
QuestionAnswer,
|
|
QuestionListResponses,
|
|
QuestionRejectErrors,
|
|
QuestionRejectResponses,
|
|
QuestionReplyErrors,
|
|
QuestionReplyResponses,
|
|
SessionAbortErrors,
|
|
SessionAbortResponses,
|
|
SessionChildrenErrors,
|
|
SessionChildrenResponses,
|
|
SessionCommandErrors,
|
|
SessionCommandResponses,
|
|
SessionCreateErrors,
|
|
SessionCreateResponses,
|
|
SessionDeleteErrors,
|
|
SessionDeleteMessageErrors,
|
|
SessionDeleteMessageResponses,
|
|
SessionDeleteResponses,
|
|
SessionDiffResponses,
|
|
SessionForkResponses,
|
|
SessionGetErrors,
|
|
SessionGetResponses,
|
|
SessionInitErrors,
|
|
SessionInitResponses,
|
|
SessionListResponses,
|
|
SessionMessageErrors,
|
|
SessionMessageResponses,
|
|
SessionMessagesErrors,
|
|
SessionMessagesResponses,
|
|
SessionPromptAsyncErrors,
|
|
SessionPromptAsyncResponses,
|
|
SessionPromptErrors,
|
|
SessionPromptResponses,
|
|
SessionRevertErrors,
|
|
SessionRevertResponses,
|
|
SessionShareErrors,
|
|
SessionShareResponses,
|
|
SessionShellErrors,
|
|
SessionShellResponses,
|
|
SessionStatusErrors,
|
|
SessionStatusResponses,
|
|
SessionSummarizeErrors,
|
|
SessionSummarizeResponses,
|
|
SessionTodoErrors,
|
|
SessionTodoResponses,
|
|
SessionUnrevertErrors,
|
|
SessionUnrevertResponses,
|
|
SessionUnshareErrors,
|
|
SessionUnshareResponses,
|
|
SessionUpdateErrors,
|
|
SessionUpdateResponses,
|
|
SubtaskPartInput,
|
|
TextPartInput,
|
|
ToolIdsErrors,
|
|
ToolIdsResponses,
|
|
ToolListErrors,
|
|
ToolListResponses,
|
|
TuiAppendPromptErrors,
|
|
TuiAppendPromptResponses,
|
|
TuiClearPromptResponses,
|
|
TuiControlNextResponses,
|
|
TuiControlResponseResponses,
|
|
TuiExecuteCommandErrors,
|
|
TuiExecuteCommandResponses,
|
|
TuiOpenHelpResponses,
|
|
TuiOpenModelsResponses,
|
|
TuiOpenSessionsResponses,
|
|
TuiOpenThemesResponses,
|
|
TuiPublishErrors,
|
|
TuiPublishResponses,
|
|
TuiSelectSessionErrors,
|
|
TuiSelectSessionResponses,
|
|
TuiShowToastResponses,
|
|
TuiSubmitPromptResponses,
|
|
VcsGetResponses,
|
|
WorktreeCreateErrors,
|
|
WorktreeCreateInput,
|
|
WorktreeCreateResponses,
|
|
WorktreeListResponses,
|
|
WorktreeRemoveErrors,
|
|
WorktreeRemoveInput,
|
|
WorktreeRemoveResponses,
|
|
WorktreeResetErrors,
|
|
WorktreeResetInput,
|
|
WorktreeResetResponses,
|
|
} from "./types.gen.js"
|
|
|
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<
|
|
TData,
|
|
ThrowOnError
|
|
> & {
|
|
/**
|
|
* You can provide a client instance returned by `createClient()` instead of
|
|
* individual options. This might be also useful if you want to implement a
|
|
* custom client.
|
|
*/
|
|
client?: Client
|
|
/**
|
|
* You can pass arbitrary values through the `meta` object. This can be
|
|
* used to access values that aren't defined as part of the SDK function.
|
|
*/
|
|
meta?: Record<string, unknown>
|
|
}
|
|
|
|
class HeyApiClient {
|
|
protected client: Client
|
|
|
|
constructor(args?: { client?: Client }) {
|
|
this.client = args?.client ?? client
|
|
}
|
|
}
|
|
|
|
class HeyApiRegistry<T> {
|
|
private readonly defaultKey = "default"
|
|
|
|
private readonly instances: Map<string, T> = new Map()
|
|
|
|
get(key?: string): T {
|
|
const instance = this.instances.get(key ?? this.defaultKey)
|
|
if (!instance) {
|
|
throw new Error(`No SDK client found. Create one with "new OpencodeClient()" to fix this error.`)
|
|
}
|
|
return instance
|
|
}
|
|
|
|
set(value: T, key?: string): void {
|
|
this.instances.set(key ?? this.defaultKey, value)
|
|
}
|
|
}
|
|
|
|
export class Config extends HeyApiClient {
|
|
/**
|
|
* Get global configuration
|
|
*
|
|
* Retrieve the current global OpenCode configuration settings and preferences.
|
|
*/
|
|
public get<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>) {
|
|
return (options?.client ?? this.client).get<GlobalConfigGetResponses, unknown, ThrowOnError>({
|
|
url: "/global/config",
|
|
...options,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Update global configuration
|
|
*
|
|
* Update global OpenCode configuration settings and preferences.
|
|
*/
|
|
public update<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
config?: Config3
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams([parameters], [{ args: [{ key: "config", map: "body" }] }])
|
|
return (options?.client ?? this.client).patch<GlobalConfigUpdateResponses, GlobalConfigUpdateErrors, ThrowOnError>({
|
|
url: "/global/config",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Global extends HeyApiClient {
|
|
/**
|
|
* Get health
|
|
*
|
|
* Get health information about the OpenCode server.
|
|
*/
|
|
public health<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>) {
|
|
return (options?.client ?? this.client).get<GlobalHealthResponses, unknown, ThrowOnError>({
|
|
url: "/global/health",
|
|
...options,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get global events
|
|
*
|
|
* Subscribe to global events from the OpenCode system using server-sent events.
|
|
*/
|
|
public event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>) {
|
|
return (options?.client ?? this.client).sse.get<GlobalEventResponses, unknown, ThrowOnError>({
|
|
url: "/global/event",
|
|
...options,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Dispose instance
|
|
*
|
|
* Clean up and dispose all OpenCode instances, releasing all resources.
|
|
*/
|
|
public dispose<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>) {
|
|
return (options?.client ?? this.client).post<GlobalDisposeResponses, unknown, ThrowOnError>({
|
|
url: "/global/dispose",
|
|
...options,
|
|
})
|
|
}
|
|
|
|
private _config?: Config
|
|
get config(): Config {
|
|
return (this._config ??= new Config({ client: this.client }))
|
|
}
|
|
}
|
|
|
|
export class Auth extends HeyApiClient {
|
|
/**
|
|
* Remove auth credentials
|
|
*
|
|
* Remove authentication credentials
|
|
*/
|
|
public remove<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
providerID: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "providerID" }] }])
|
|
return (options?.client ?? this.client).delete<AuthRemoveResponses, AuthRemoveErrors, ThrowOnError>({
|
|
url: "/auth/{providerID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Set auth credentials
|
|
*
|
|
* Set authentication credentials
|
|
*/
|
|
public set<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
providerID: string
|
|
auth?: Auth3
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "providerID" },
|
|
{ key: "auth", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).put<AuthSetResponses, AuthSetErrors, ThrowOnError>({
|
|
url: "/auth/{providerID}",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Project extends HeyApiClient {
|
|
/**
|
|
* List all projects
|
|
*
|
|
* Get a list of projects that have been opened with OpenCode.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ProjectListResponses, unknown, ThrowOnError>({
|
|
url: "/project",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get current project
|
|
*
|
|
* Retrieve the currently active project that OpenCode is working with.
|
|
*/
|
|
public current<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ProjectCurrentResponses, unknown, ThrowOnError>({
|
|
url: "/project/current",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Initialize git repository
|
|
*
|
|
* Create a git repository for the current project and return the refreshed project info.
|
|
*/
|
|
public initGit<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<ProjectInitGitResponses, unknown, ThrowOnError>({
|
|
url: "/project/git/init",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Update project
|
|
*
|
|
* Update project properties such as name, icon, and commands.
|
|
*/
|
|
public update<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
projectID: string
|
|
directory?: string
|
|
workspace?: string
|
|
name?: string
|
|
icon?: {
|
|
url?: string
|
|
override?: string
|
|
color?: string
|
|
}
|
|
commands?: {
|
|
/**
|
|
* Startup script to run when creating a new workspace (worktree)
|
|
*/
|
|
start?: string
|
|
}
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "projectID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "name" },
|
|
{ in: "body", key: "icon" },
|
|
{ in: "body", key: "commands" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).patch<ProjectUpdateResponses, ProjectUpdateErrors, ThrowOnError>({
|
|
url: "/project/{projectID}",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Pty extends HeyApiClient {
|
|
/**
|
|
* List PTY sessions
|
|
*
|
|
* Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<PtyListResponses, unknown, ThrowOnError>({
|
|
url: "/pty",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Create PTY session
|
|
*
|
|
* Create a new pseudo-terminal (PTY) session for running shell commands and processes.
|
|
*/
|
|
public create<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
command?: string
|
|
args?: Array<string>
|
|
cwd?: string
|
|
title?: string
|
|
env?: {
|
|
[key: string]: string
|
|
}
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "command" },
|
|
{ in: "body", key: "args" },
|
|
{ in: "body", key: "cwd" },
|
|
{ in: "body", key: "title" },
|
|
{ in: "body", key: "env" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<PtyCreateResponses, PtyCreateErrors, ThrowOnError>({
|
|
url: "/pty",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Remove PTY session
|
|
*
|
|
* Remove and terminate a specific pseudo-terminal (PTY) session.
|
|
*/
|
|
public remove<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
ptyID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "ptyID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<PtyRemoveResponses, PtyRemoveErrors, ThrowOnError>({
|
|
url: "/pty/{ptyID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get PTY session
|
|
*
|
|
* Retrieve detailed information about a specific pseudo-terminal (PTY) session.
|
|
*/
|
|
public get<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
ptyID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "ptyID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<PtyGetResponses, PtyGetErrors, ThrowOnError>({
|
|
url: "/pty/{ptyID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Update PTY session
|
|
*
|
|
* Update properties of an existing pseudo-terminal (PTY) session.
|
|
*/
|
|
public update<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
ptyID: string
|
|
directory?: string
|
|
workspace?: string
|
|
title?: string
|
|
size?: {
|
|
rows: number
|
|
cols: number
|
|
}
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "ptyID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "title" },
|
|
{ in: "body", key: "size" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).put<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError>({
|
|
url: "/pty/{ptyID}",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Connect to PTY session
|
|
*
|
|
* Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
|
|
*/
|
|
public connect<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
ptyID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "ptyID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<PtyConnectResponses, PtyConnectErrors, ThrowOnError>({
|
|
url: "/pty/{ptyID}/connect",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Config2 extends HeyApiClient {
|
|
/**
|
|
* Get configuration
|
|
*
|
|
* Retrieve the current OpenCode configuration settings and preferences.
|
|
*/
|
|
public get<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ConfigGetResponses, unknown, ThrowOnError>({
|
|
url: "/config",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Update configuration
|
|
*
|
|
* Update OpenCode configuration settings and preferences.
|
|
*/
|
|
public update<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
config?: Config3
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "config", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).patch<ConfigUpdateResponses, ConfigUpdateErrors, ThrowOnError>({
|
|
url: "/config",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* List config providers
|
|
*
|
|
* Get a list of all configured AI providers and their default models.
|
|
*/
|
|
public providers<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ConfigProvidersResponses, unknown, ThrowOnError>({
|
|
url: "/config/providers",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Tool extends HeyApiClient {
|
|
/**
|
|
* List tool IDs
|
|
*
|
|
* Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.
|
|
*/
|
|
public ids<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ToolIdsResponses, ToolIdsErrors, ThrowOnError>({
|
|
url: "/experimental/tool/ids",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* List tools
|
|
*
|
|
* Get a list of available tools with their JSON schema parameters for a specific provider and model combination.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
directory?: string
|
|
workspace?: string
|
|
provider: string
|
|
model: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "provider" },
|
|
{ in: "query", key: "model" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ToolListResponses, ToolListErrors, ThrowOnError>({
|
|
url: "/experimental/tool",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Workspace extends HeyApiClient {
|
|
/**
|
|
* List workspaces
|
|
*
|
|
* List all workspaces.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ExperimentalWorkspaceListResponses, unknown, ThrowOnError>({
|
|
url: "/experimental/workspace",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Create workspace
|
|
*
|
|
* Create a workspace for the current project.
|
|
*/
|
|
public create<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
id?: string
|
|
type?: string
|
|
branch?: string | null
|
|
extra?: unknown | null
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "id" },
|
|
{ in: "body", key: "type" },
|
|
{ in: "body", key: "branch" },
|
|
{ in: "body", key: "extra" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<
|
|
ExperimentalWorkspaceCreateResponses,
|
|
ExperimentalWorkspaceCreateErrors,
|
|
ThrowOnError
|
|
>({
|
|
url: "/experimental/workspace",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Remove workspace
|
|
*
|
|
* Remove an existing workspace.
|
|
*/
|
|
public remove<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
id: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "id" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<
|
|
ExperimentalWorkspaceRemoveResponses,
|
|
ExperimentalWorkspaceRemoveErrors,
|
|
ThrowOnError
|
|
>({
|
|
url: "/experimental/workspace/{id}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Session extends HeyApiClient {
|
|
/**
|
|
* List sessions
|
|
*
|
|
* Get a list of all OpenCode sessions across projects, sorted by most recently updated. Archived sessions are excluded by default.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
roots?: boolean
|
|
start?: number
|
|
cursor?: number
|
|
search?: string
|
|
limit?: number
|
|
archived?: boolean
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "roots" },
|
|
{ in: "query", key: "start" },
|
|
{ in: "query", key: "cursor" },
|
|
{ in: "query", key: "search" },
|
|
{ in: "query", key: "limit" },
|
|
{ in: "query", key: "archived" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ExperimentalSessionListResponses, unknown, ThrowOnError>({
|
|
url: "/experimental/session",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Resource extends HeyApiClient {
|
|
/**
|
|
* Get MCP resources
|
|
*
|
|
* Get all available MCP resources from connected servers. Optionally filter by name.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ExperimentalResourceListResponses, unknown, ThrowOnError>({
|
|
url: "/experimental/resource",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Experimental extends HeyApiClient {
|
|
private _workspace?: Workspace
|
|
get workspace(): Workspace {
|
|
return (this._workspace ??= new Workspace({ client: this.client }))
|
|
}
|
|
|
|
private _session?: Session
|
|
get session(): Session {
|
|
return (this._session ??= new Session({ client: this.client }))
|
|
}
|
|
|
|
private _resource?: Resource
|
|
get resource(): Resource {
|
|
return (this._resource ??= new Resource({ client: this.client }))
|
|
}
|
|
}
|
|
|
|
export class Worktree extends HeyApiClient {
|
|
/**
|
|
* Remove worktree
|
|
*
|
|
* Remove a git worktree and delete its branch.
|
|
*/
|
|
public remove<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
worktreeRemoveInput?: WorktreeRemoveInput
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "worktreeRemoveInput", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<WorktreeRemoveResponses, WorktreeRemoveErrors, ThrowOnError>({
|
|
url: "/experimental/worktree",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* List worktrees
|
|
*
|
|
* List all sandbox worktrees for the current project.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<WorktreeListResponses, unknown, ThrowOnError>({
|
|
url: "/experimental/worktree",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Create worktree
|
|
*
|
|
* Create a new git worktree for the current project and run any configured startup scripts.
|
|
*/
|
|
public create<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
worktreeCreateInput?: WorktreeCreateInput
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "worktreeCreateInput", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<WorktreeCreateResponses, WorktreeCreateErrors, ThrowOnError>({
|
|
url: "/experimental/worktree",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Reset worktree
|
|
*
|
|
* Reset a worktree branch to the primary default branch.
|
|
*/
|
|
public reset<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
worktreeResetInput?: WorktreeResetInput
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "worktreeResetInput", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<WorktreeResetResponses, WorktreeResetErrors, ThrowOnError>({
|
|
url: "/experimental/worktree/reset",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Session2 extends HeyApiClient {
|
|
/**
|
|
* List sessions
|
|
*
|
|
* Get a list of all OpenCode sessions, sorted by most recently updated.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
roots?: boolean
|
|
start?: number
|
|
search?: string
|
|
limit?: number
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "roots" },
|
|
{ in: "query", key: "start" },
|
|
{ in: "query", key: "search" },
|
|
{ in: "query", key: "limit" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionListResponses, unknown, ThrowOnError>({
|
|
url: "/session",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Create session
|
|
*
|
|
* Create a new OpenCode session for interacting with AI assistants and managing conversations.
|
|
*/
|
|
public create<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
parentID?: string
|
|
title?: string
|
|
permission?: PermissionRuleset
|
|
workspaceID?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "parentID" },
|
|
{ in: "body", key: "title" },
|
|
{ in: "body", key: "permission" },
|
|
{ in: "body", key: "workspaceID" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionCreateResponses, SessionCreateErrors, ThrowOnError>({
|
|
url: "/session",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get session status
|
|
*
|
|
* Retrieve the current status of all sessions, including active, idle, and completed states.
|
|
*/
|
|
public status<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionStatusResponses, SessionStatusErrors, ThrowOnError>({
|
|
url: "/session/status",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Delete session
|
|
*
|
|
* Delete a session and permanently remove all associated data, including messages and history.
|
|
*/
|
|
public delete<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<SessionDeleteResponses, SessionDeleteErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get session
|
|
*
|
|
* Retrieve detailed information about a specific OpenCode session.
|
|
*/
|
|
public get<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionGetResponses, SessionGetErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Update session
|
|
*
|
|
* Update properties of an existing session, such as title or other metadata.
|
|
*/
|
|
public update<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
title?: string
|
|
time?: {
|
|
archived?: number
|
|
}
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "title" },
|
|
{ in: "body", key: "time" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).patch<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get session children
|
|
*
|
|
* Retrieve all child sessions that were forked from the specified parent session.
|
|
*/
|
|
public children<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionChildrenResponses, SessionChildrenErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/children",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get session todos
|
|
*
|
|
* Retrieve the todo list associated with a specific session, showing tasks and action items.
|
|
*/
|
|
public todo<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionTodoResponses, SessionTodoErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/todo",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Initialize session
|
|
*
|
|
* Analyze the current application and create an AGENTS.md file with project-specific agent configurations.
|
|
*/
|
|
public init<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
modelID?: string
|
|
providerID?: string
|
|
messageID?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "modelID" },
|
|
{ in: "body", key: "providerID" },
|
|
{ in: "body", key: "messageID" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionInitResponses, SessionInitErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/init",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Fork session
|
|
*
|
|
* Create a new session by forking an existing session at a specific message point.
|
|
*/
|
|
public fork<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
messageID?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "messageID" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionForkResponses, unknown, ThrowOnError>({
|
|
url: "/session/{sessionID}/fork",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Abort session
|
|
*
|
|
* Abort an active session and stop any ongoing AI processing or command execution.
|
|
*/
|
|
public abort<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionAbortResponses, SessionAbortErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/abort",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Unshare session
|
|
*
|
|
* Remove the shareable link for a session, making it private again.
|
|
*/
|
|
public unshare<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<SessionUnshareResponses, SessionUnshareErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/share",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Share session
|
|
*
|
|
* Create a shareable link for a session, allowing others to view the conversation.
|
|
*/
|
|
public share<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionShareResponses, SessionShareErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/share",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get message diff
|
|
*
|
|
* Get the file changes (diff) that resulted from a specific user message in the session.
|
|
*/
|
|
public diff<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
messageID?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "messageID" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionDiffResponses, unknown, ThrowOnError>({
|
|
url: "/session/{sessionID}/diff",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Summarize session
|
|
*
|
|
* Generate a concise summary of the session using AI compaction to preserve key information.
|
|
*/
|
|
public summarize<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
providerID?: string
|
|
modelID?: string
|
|
auto?: boolean
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "providerID" },
|
|
{ in: "body", key: "modelID" },
|
|
{ in: "body", key: "auto" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/summarize",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get session messages
|
|
*
|
|
* Retrieve all messages in a session, including user prompts and AI responses.
|
|
*/
|
|
public messages<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
limit?: number
|
|
before?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "limit" },
|
|
{ in: "query", key: "before" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionMessagesResponses, SessionMessagesErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/message",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Send message
|
|
*
|
|
* Create and send a new message to a session, streaming the AI response.
|
|
*/
|
|
public prompt<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
messageID?: string
|
|
model?: {
|
|
providerID: string
|
|
modelID: string
|
|
}
|
|
agent?: string
|
|
noReply?: boolean
|
|
tools?: {
|
|
[key: string]: boolean
|
|
}
|
|
format?: OutputFormat
|
|
system?: string
|
|
variant?: string
|
|
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "messageID" },
|
|
{ in: "body", key: "model" },
|
|
{ in: "body", key: "agent" },
|
|
{ in: "body", key: "noReply" },
|
|
{ in: "body", key: "tools" },
|
|
{ in: "body", key: "format" },
|
|
{ in: "body", key: "system" },
|
|
{ in: "body", key: "variant" },
|
|
{ in: "body", key: "parts" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionPromptResponses, SessionPromptErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/message",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Delete message
|
|
*
|
|
* Permanently delete a specific message (and all of its parts) from a session. This does not revert any file changes that may have been made while processing the message.
|
|
*/
|
|
public deleteMessage<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
messageID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "path", key: "messageID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<
|
|
SessionDeleteMessageResponses,
|
|
SessionDeleteMessageErrors,
|
|
ThrowOnError
|
|
>({
|
|
url: "/session/{sessionID}/message/{messageID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get message
|
|
*
|
|
* Retrieve a specific message from a session by its message ID.
|
|
*/
|
|
public message<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
messageID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "path", key: "messageID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<SessionMessageResponses, SessionMessageErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/message/{messageID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Send async message
|
|
*
|
|
* Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.
|
|
*/
|
|
public promptAsync<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
messageID?: string
|
|
model?: {
|
|
providerID: string
|
|
modelID: string
|
|
}
|
|
agent?: string
|
|
noReply?: boolean
|
|
tools?: {
|
|
[key: string]: boolean
|
|
}
|
|
format?: OutputFormat
|
|
system?: string
|
|
variant?: string
|
|
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "messageID" },
|
|
{ in: "body", key: "model" },
|
|
{ in: "body", key: "agent" },
|
|
{ in: "body", key: "noReply" },
|
|
{ in: "body", key: "tools" },
|
|
{ in: "body", key: "format" },
|
|
{ in: "body", key: "system" },
|
|
{ in: "body", key: "variant" },
|
|
{ in: "body", key: "parts" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionPromptAsyncResponses, SessionPromptAsyncErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/prompt_async",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Send command
|
|
*
|
|
* Send a new command to a session for execution by the AI assistant.
|
|
*/
|
|
public command<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
messageID?: string
|
|
agent?: string
|
|
model?: string
|
|
arguments?: string
|
|
command?: string
|
|
variant?: string
|
|
parts?: Array<{
|
|
id?: string
|
|
type: "file"
|
|
mime: string
|
|
filename?: string
|
|
url: string
|
|
source?: FilePartSource
|
|
}>
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "messageID" },
|
|
{ in: "body", key: "agent" },
|
|
{ in: "body", key: "model" },
|
|
{ in: "body", key: "arguments" },
|
|
{ in: "body", key: "command" },
|
|
{ in: "body", key: "variant" },
|
|
{ in: "body", key: "parts" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionCommandResponses, SessionCommandErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/command",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Run shell command
|
|
*
|
|
* Execute a shell command within the session context and return the AI's response.
|
|
*/
|
|
public shell<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
agent?: string
|
|
model?: {
|
|
providerID: string
|
|
modelID: string
|
|
}
|
|
command?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "agent" },
|
|
{ in: "body", key: "model" },
|
|
{ in: "body", key: "command" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionShellResponses, SessionShellErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/shell",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Revert message
|
|
*
|
|
* Revert a specific message in a session, undoing its effects and restoring the previous state.
|
|
*/
|
|
public revert<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
messageID?: string
|
|
partID?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "messageID" },
|
|
{ in: "body", key: "partID" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionRevertResponses, SessionRevertErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/revert",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Restore reverted messages
|
|
*
|
|
* Restore all previously reverted messages in a session.
|
|
*/
|
|
public unrevert<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<SessionUnrevertResponses, SessionUnrevertErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/unrevert",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Part extends HeyApiClient {
|
|
/**
|
|
* Delete a part from a message
|
|
*/
|
|
public delete<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
messageID: string
|
|
partID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "path", key: "messageID" },
|
|
{ in: "path", key: "partID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<PartDeleteResponses, PartDeleteErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/message/{messageID}/part/{partID}",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Update a part in a message
|
|
*/
|
|
public update<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
messageID: string
|
|
partID: string
|
|
directory?: string
|
|
workspace?: string
|
|
part?: Part2
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "path", key: "messageID" },
|
|
{ in: "path", key: "partID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "part", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).patch<PartUpdateResponses, PartUpdateErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/message/{messageID}/part/{partID}",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Permission extends HeyApiClient {
|
|
/**
|
|
* Respond to permission
|
|
*
|
|
* Approve or deny a permission request from the AI assistant.
|
|
*
|
|
* @deprecated
|
|
*/
|
|
public respond<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
sessionID: string
|
|
permissionID: string
|
|
directory?: string
|
|
workspace?: string
|
|
response?: "once" | "always" | "reject"
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "sessionID" },
|
|
{ in: "path", key: "permissionID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "response" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<PermissionRespondResponses, PermissionRespondErrors, ThrowOnError>({
|
|
url: "/session/{sessionID}/permissions/{permissionID}",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Respond to permission request
|
|
*
|
|
* Approve or deny a permission request from the AI assistant.
|
|
*/
|
|
public reply<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
requestID: string
|
|
directory?: string
|
|
workspace?: string
|
|
reply?: "once" | "always" | "reject"
|
|
message?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "requestID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "reply" },
|
|
{ in: "body", key: "message" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<PermissionReplyResponses, PermissionReplyErrors, ThrowOnError>({
|
|
url: "/permission/{requestID}/reply",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* List pending permissions
|
|
*
|
|
* Get all pending permission requests across all sessions.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<PermissionListResponses, unknown, ThrowOnError>({
|
|
url: "/permission",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Question extends HeyApiClient {
|
|
/**
|
|
* List pending questions
|
|
*
|
|
* Get all pending question requests across all sessions.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<QuestionListResponses, unknown, ThrowOnError>({
|
|
url: "/question",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Reply to question request
|
|
*
|
|
* Provide answers to a question request from the AI assistant.
|
|
*/
|
|
public reply<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
requestID: string
|
|
directory?: string
|
|
workspace?: string
|
|
answers?: Array<QuestionAnswer>
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "requestID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "answers" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<QuestionReplyResponses, QuestionReplyErrors, ThrowOnError>({
|
|
url: "/question/{requestID}/reply",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Reject question request
|
|
*
|
|
* Reject a question request from the AI assistant.
|
|
*/
|
|
public reject<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
requestID: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "requestID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<QuestionRejectResponses, QuestionRejectErrors, ThrowOnError>({
|
|
url: "/question/{requestID}/reject",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Oauth extends HeyApiClient {
|
|
/**
|
|
* OAuth authorize
|
|
*
|
|
* Initiate OAuth authorization for a specific AI provider to get an authorization URL.
|
|
*/
|
|
public authorize<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
providerID: string
|
|
directory?: string
|
|
workspace?: string
|
|
method?: number
|
|
inputs?: {
|
|
[key: string]: string
|
|
}
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "providerID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "method" },
|
|
{ in: "body", key: "inputs" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<
|
|
ProviderOauthAuthorizeResponses,
|
|
ProviderOauthAuthorizeErrors,
|
|
ThrowOnError
|
|
>({
|
|
url: "/provider/{providerID}/oauth/authorize",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* OAuth callback
|
|
*
|
|
* Handle the OAuth callback from a provider after user authorization.
|
|
*/
|
|
public callback<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
providerID: string
|
|
directory?: string
|
|
workspace?: string
|
|
method?: number
|
|
code?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "providerID" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "method" },
|
|
{ in: "body", key: "code" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<
|
|
ProviderOauthCallbackResponses,
|
|
ProviderOauthCallbackErrors,
|
|
ThrowOnError
|
|
>({
|
|
url: "/provider/{providerID}/oauth/callback",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Provider extends HeyApiClient {
|
|
/**
|
|
* List providers
|
|
*
|
|
* Get a list of all available AI providers, including both available and connected ones.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ProviderListResponses, unknown, ThrowOnError>({
|
|
url: "/provider",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get provider auth methods
|
|
*
|
|
* Retrieve available authentication methods for all AI providers.
|
|
*/
|
|
public auth<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<ProviderAuthResponses, unknown, ThrowOnError>({
|
|
url: "/provider/auth",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
private _oauth?: Oauth
|
|
get oauth(): Oauth {
|
|
return (this._oauth ??= new Oauth({ client: this.client }))
|
|
}
|
|
}
|
|
|
|
export class Find extends HeyApiClient {
|
|
/**
|
|
* Find text
|
|
*
|
|
* Search for text patterns across files in the project using ripgrep.
|
|
*/
|
|
public text<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
directory?: string
|
|
workspace?: string
|
|
pattern: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "pattern" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FindTextResponses, unknown, ThrowOnError>({
|
|
url: "/find",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Find files
|
|
*
|
|
* Search for files or directories by name or pattern in the project directory.
|
|
*/
|
|
public files<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
directory?: string
|
|
workspace?: string
|
|
query: string
|
|
dirs?: "true" | "false"
|
|
type?: "file" | "directory"
|
|
limit?: number
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "query" },
|
|
{ in: "query", key: "dirs" },
|
|
{ in: "query", key: "type" },
|
|
{ in: "query", key: "limit" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FindFilesResponses, unknown, ThrowOnError>({
|
|
url: "/find/file",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Find symbols
|
|
*
|
|
* Search for workspace symbols like functions, classes, and variables using LSP.
|
|
*/
|
|
public symbols<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
directory?: string
|
|
workspace?: string
|
|
query: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "query" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FindSymbolsResponses, unknown, ThrowOnError>({
|
|
url: "/find/symbol",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class File extends HeyApiClient {
|
|
/**
|
|
* List files
|
|
*
|
|
* List files and directories in a specified path.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
directory?: string
|
|
workspace?: string
|
|
path: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "path" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FileListResponses, unknown, ThrowOnError>({
|
|
url: "/file",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Read file
|
|
*
|
|
* Read the content of a specified file.
|
|
*/
|
|
public read<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
directory?: string
|
|
workspace?: string
|
|
path: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "query", key: "path" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FileReadResponses, unknown, ThrowOnError>({
|
|
url: "/file/content",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Get file status
|
|
*
|
|
* Get the git status of all files in the project.
|
|
*/
|
|
public status<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FileStatusResponses, unknown, ThrowOnError>({
|
|
url: "/file/status",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Event extends HeyApiClient {
|
|
/**
|
|
* Subscribe to events
|
|
*
|
|
* Get events
|
|
*/
|
|
public subscribe<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).sse.get<EventSubscribeResponses, unknown, ThrowOnError>({
|
|
url: "/event",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Auth2 extends HeyApiClient {
|
|
/**
|
|
* Remove MCP OAuth
|
|
*
|
|
* Remove OAuth credentials for an MCP server
|
|
*/
|
|
public remove<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
name: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "name" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).delete<McpAuthRemoveResponses, McpAuthRemoveErrors, ThrowOnError>({
|
|
url: "/mcp/{name}/auth",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Start MCP OAuth
|
|
*
|
|
* Start OAuth authentication flow for a Model Context Protocol (MCP) server.
|
|
*/
|
|
public start<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
name: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "name" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<McpAuthStartResponses, McpAuthStartErrors, ThrowOnError>({
|
|
url: "/mcp/{name}/auth",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Complete MCP OAuth
|
|
*
|
|
* Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.
|
|
*/
|
|
public callback<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
name: string
|
|
directory?: string
|
|
workspace?: string
|
|
code?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "name" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "code" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError>({
|
|
url: "/mcp/{name}/auth/callback",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Authenticate MCP OAuth
|
|
*
|
|
* Start OAuth flow and wait for callback (opens browser)
|
|
*/
|
|
public authenticate<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
name: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "name" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<McpAuthAuthenticateResponses, McpAuthAuthenticateErrors, ThrowOnError>(
|
|
{
|
|
url: "/mcp/{name}/auth/authenticate",
|
|
...options,
|
|
...params,
|
|
},
|
|
)
|
|
}
|
|
}
|
|
|
|
export class Mcp extends HeyApiClient {
|
|
/**
|
|
* Get MCP status
|
|
*
|
|
* Get the status of all Model Context Protocol (MCP) servers.
|
|
*/
|
|
public status<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<McpStatusResponses, unknown, ThrowOnError>({
|
|
url: "/mcp",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Add MCP server
|
|
*
|
|
* Dynamically add a new Model Context Protocol (MCP) server to the system.
|
|
*/
|
|
public add<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
name?: string
|
|
config?: McpLocalConfig | McpRemoteConfig
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "name" },
|
|
{ in: "body", key: "config" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<McpAddResponses, McpAddErrors, ThrowOnError>({
|
|
url: "/mcp",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Connect an MCP server
|
|
*/
|
|
public connect<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
name: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "name" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<McpConnectResponses, unknown, ThrowOnError>({
|
|
url: "/mcp/{name}/connect",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Disconnect an MCP server
|
|
*/
|
|
public disconnect<ThrowOnError extends boolean = false>(
|
|
parameters: {
|
|
name: string
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "path", key: "name" },
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<McpDisconnectResponses, unknown, ThrowOnError>({
|
|
url: "/mcp/{name}/disconnect",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
private _auth?: Auth2
|
|
get auth(): Auth2 {
|
|
return (this._auth ??= new Auth2({ client: this.client }))
|
|
}
|
|
}
|
|
|
|
export class Control extends HeyApiClient {
|
|
/**
|
|
* Get next TUI request
|
|
*
|
|
* Retrieve the next TUI (Terminal User Interface) request from the queue for processing.
|
|
*/
|
|
public next<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<TuiControlNextResponses, unknown, ThrowOnError>({
|
|
url: "/tui/control/next",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Submit TUI response
|
|
*
|
|
* Submit a response to the TUI request queue to complete a pending request.
|
|
*/
|
|
public response<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
body?: unknown
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "body", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiControlResponseResponses, unknown, ThrowOnError>({
|
|
url: "/tui/control/response",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Tui extends HeyApiClient {
|
|
/**
|
|
* Append TUI prompt
|
|
*
|
|
* Append prompt to the TUI
|
|
*/
|
|
public appendPrompt<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
text?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "text" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiAppendPromptResponses, TuiAppendPromptErrors, ThrowOnError>({
|
|
url: "/tui/append-prompt",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Open help dialog
|
|
*
|
|
* Open the help dialog in the TUI to display user assistance information.
|
|
*/
|
|
public openHelp<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiOpenHelpResponses, unknown, ThrowOnError>({
|
|
url: "/tui/open-help",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Open sessions dialog
|
|
*
|
|
* Open the session dialog
|
|
*/
|
|
public openSessions<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiOpenSessionsResponses, unknown, ThrowOnError>({
|
|
url: "/tui/open-sessions",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Open themes dialog
|
|
*
|
|
* Open the theme dialog
|
|
*/
|
|
public openThemes<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiOpenThemesResponses, unknown, ThrowOnError>({
|
|
url: "/tui/open-themes",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Open models dialog
|
|
*
|
|
* Open the model dialog
|
|
*/
|
|
public openModels<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiOpenModelsResponses, unknown, ThrowOnError>({
|
|
url: "/tui/open-models",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Submit TUI prompt
|
|
*
|
|
* Submit the prompt
|
|
*/
|
|
public submitPrompt<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiSubmitPromptResponses, unknown, ThrowOnError>({
|
|
url: "/tui/submit-prompt",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Clear TUI prompt
|
|
*
|
|
* Clear the prompt
|
|
*/
|
|
public clearPrompt<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiClearPromptResponses, unknown, ThrowOnError>({
|
|
url: "/tui/clear-prompt",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Execute TUI command
|
|
*
|
|
* Execute a TUI command (e.g. agent_cycle)
|
|
*/
|
|
public executeCommand<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
command?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "command" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiExecuteCommandResponses, TuiExecuteCommandErrors, ThrowOnError>({
|
|
url: "/tui/execute-command",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Show TUI toast
|
|
*
|
|
* Show a toast notification in the TUI
|
|
*/
|
|
public showToast<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
title?: string
|
|
message?: string
|
|
variant?: "info" | "success" | "warning" | "error"
|
|
duration?: number
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "title" },
|
|
{ in: "body", key: "message" },
|
|
{ in: "body", key: "variant" },
|
|
{ in: "body", key: "duration" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiShowToastResponses, unknown, ThrowOnError>({
|
|
url: "/tui/show-toast",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Publish TUI event
|
|
*
|
|
* Publish a TUI event
|
|
*/
|
|
public publish<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
body?: EventTuiPromptAppend | EventTuiCommandExecute | EventTuiToastShow | EventTuiSessionSelect
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ key: "body", map: "body" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiPublishResponses, TuiPublishErrors, ThrowOnError>({
|
|
url: "/tui/publish",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Select session
|
|
*
|
|
* Navigate the TUI to display the specified session.
|
|
*/
|
|
public selectSession<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
sessionID?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "sessionID" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<TuiSelectSessionResponses, TuiSelectSessionErrors, ThrowOnError>({
|
|
url: "/tui/select-session",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
private _control?: Control
|
|
get control(): Control {
|
|
return (this._control ??= new Control({ client: this.client }))
|
|
}
|
|
}
|
|
|
|
export class Instance extends HeyApiClient {
|
|
/**
|
|
* Dispose instance
|
|
*
|
|
* Clean up and dispose the current OpenCode instance, releasing all resources.
|
|
*/
|
|
public dispose<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<InstanceDisposeResponses, unknown, ThrowOnError>({
|
|
url: "/instance/dispose",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Path extends HeyApiClient {
|
|
/**
|
|
* Get paths
|
|
*
|
|
* Retrieve the current working directory and related path information for the OpenCode instance.
|
|
*/
|
|
public get<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<PathGetResponses, unknown, ThrowOnError>({
|
|
url: "/path",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Vcs extends HeyApiClient {
|
|
/**
|
|
* Get VCS info
|
|
*
|
|
* Retrieve version control system (VCS) information for the current project, such as git branch.
|
|
*/
|
|
public get<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<VcsGetResponses, unknown, ThrowOnError>({
|
|
url: "/vcs",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Command extends HeyApiClient {
|
|
/**
|
|
* List commands
|
|
*
|
|
* Get a list of all available commands in the OpenCode system.
|
|
*/
|
|
public list<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<CommandListResponses, unknown, ThrowOnError>({
|
|
url: "/command",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class App extends HeyApiClient {
|
|
/**
|
|
* Write log
|
|
*
|
|
* Write a log entry to the server logs with specified level and metadata.
|
|
*/
|
|
public log<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
service?: string
|
|
level?: "debug" | "info" | "error" | "warn"
|
|
message?: string
|
|
extra?: {
|
|
[key: string]: unknown
|
|
}
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
{ in: "body", key: "service" },
|
|
{ in: "body", key: "level" },
|
|
{ in: "body", key: "message" },
|
|
{ in: "body", key: "extra" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).post<AppLogResponses, AppLogErrors, ThrowOnError>({
|
|
url: "/log",
|
|
...options,
|
|
...params,
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
...options?.headers,
|
|
...params.headers,
|
|
},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* List agents
|
|
*
|
|
* Get a list of all available AI agents in the OpenCode system.
|
|
*/
|
|
public agents<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<AppAgentsResponses, unknown, ThrowOnError>({
|
|
url: "/agent",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* List skills
|
|
*
|
|
* Get a list of all available skills in the OpenCode system.
|
|
*/
|
|
public skills<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<AppSkillsResponses, unknown, ThrowOnError>({
|
|
url: "/skill",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Lsp extends HeyApiClient {
|
|
/**
|
|
* Get LSP status
|
|
*
|
|
* Get LSP server status
|
|
*/
|
|
public status<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<LspStatusResponses, unknown, ThrowOnError>({
|
|
url: "/lsp",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class Formatter extends HeyApiClient {
|
|
/**
|
|
* Get formatter status
|
|
*
|
|
* Get formatter status
|
|
*/
|
|
public status<ThrowOnError extends boolean = false>(
|
|
parameters?: {
|
|
directory?: string
|
|
workspace?: string
|
|
},
|
|
options?: Options<never, ThrowOnError>,
|
|
) {
|
|
const params = buildClientParams(
|
|
[parameters],
|
|
[
|
|
{
|
|
args: [
|
|
{ in: "query", key: "directory" },
|
|
{ in: "query", key: "workspace" },
|
|
],
|
|
},
|
|
],
|
|
)
|
|
return (options?.client ?? this.client).get<FormatterStatusResponses, unknown, ThrowOnError>({
|
|
url: "/formatter",
|
|
...options,
|
|
...params,
|
|
})
|
|
}
|
|
}
|
|
|
|
export class OpencodeClient extends HeyApiClient {
|
|
public static readonly __registry = new HeyApiRegistry<OpencodeClient>()
|
|
|
|
constructor(args?: { client?: Client; key?: string }) {
|
|
super(args)
|
|
OpencodeClient.__registry.set(this, args?.key)
|
|
}
|
|
|
|
private _global?: Global
|
|
get global(): Global {
|
|
return (this._global ??= new Global({ client: this.client }))
|
|
}
|
|
|
|
private _auth?: Auth
|
|
get auth(): Auth {
|
|
return (this._auth ??= new Auth({ client: this.client }))
|
|
}
|
|
|
|
private _project?: Project
|
|
get project(): Project {
|
|
return (this._project ??= new Project({ client: this.client }))
|
|
}
|
|
|
|
private _pty?: Pty
|
|
get pty(): Pty {
|
|
return (this._pty ??= new Pty({ client: this.client }))
|
|
}
|
|
|
|
private _config?: Config2
|
|
get config(): Config2 {
|
|
return (this._config ??= new Config2({ client: this.client }))
|
|
}
|
|
|
|
private _tool?: Tool
|
|
get tool(): Tool {
|
|
return (this._tool ??= new Tool({ client: this.client }))
|
|
}
|
|
|
|
private _experimental?: Experimental
|
|
get experimental(): Experimental {
|
|
return (this._experimental ??= new Experimental({ client: this.client }))
|
|
}
|
|
|
|
private _worktree?: Worktree
|
|
get worktree(): Worktree {
|
|
return (this._worktree ??= new Worktree({ client: this.client }))
|
|
}
|
|
|
|
private _session?: Session2
|
|
get session(): Session2 {
|
|
return (this._session ??= new Session2({ client: this.client }))
|
|
}
|
|
|
|
private _part?: Part
|
|
get part(): Part {
|
|
return (this._part ??= new Part({ client: this.client }))
|
|
}
|
|
|
|
private _permission?: Permission
|
|
get permission(): Permission {
|
|
return (this._permission ??= new Permission({ client: this.client }))
|
|
}
|
|
|
|
private _question?: Question
|
|
get question(): Question {
|
|
return (this._question ??= new Question({ client: this.client }))
|
|
}
|
|
|
|
private _provider?: Provider
|
|
get provider(): Provider {
|
|
return (this._provider ??= new Provider({ client: this.client }))
|
|
}
|
|
|
|
private _find?: Find
|
|
get find(): Find {
|
|
return (this._find ??= new Find({ client: this.client }))
|
|
}
|
|
|
|
private _file?: File
|
|
get file(): File {
|
|
return (this._file ??= new File({ client: this.client }))
|
|
}
|
|
|
|
private _event?: Event
|
|
get event(): Event {
|
|
return (this._event ??= new Event({ client: this.client }))
|
|
}
|
|
|
|
private _mcp?: Mcp
|
|
get mcp(): Mcp {
|
|
return (this._mcp ??= new Mcp({ client: this.client }))
|
|
}
|
|
|
|
private _tui?: Tui
|
|
get tui(): Tui {
|
|
return (this._tui ??= new Tui({ client: this.client }))
|
|
}
|
|
|
|
private _instance?: Instance
|
|
get instance(): Instance {
|
|
return (this._instance ??= new Instance({ client: this.client }))
|
|
}
|
|
|
|
private _path?: Path
|
|
get path(): Path {
|
|
return (this._path ??= new Path({ client: this.client }))
|
|
}
|
|
|
|
private _vcs?: Vcs
|
|
get vcs(): Vcs {
|
|
return (this._vcs ??= new Vcs({ client: this.client }))
|
|
}
|
|
|
|
private _command?: Command
|
|
get command(): Command {
|
|
return (this._command ??= new Command({ client: this.client }))
|
|
}
|
|
|
|
private _app?: App
|
|
get app(): App {
|
|
return (this._app ??= new App({ client: this.client }))
|
|
}
|
|
|
|
private _lsp?: Lsp
|
|
get lsp(): Lsp {
|
|
return (this._lsp ??= new Lsp({ client: this.client }))
|
|
}
|
|
|
|
private _formatter?: Formatter
|
|
get formatter(): Formatter {
|
|
return (this._formatter ??= new Formatter({ client: this.client }))
|
|
}
|
|
}
|