@cavi-ai/api-client/providers/opencode

export declare function createOpenCodeProviderModule(config: OpenCodeApiClientOptions): OpenCodeProviderModule;

/** Select v2 explicitly; the existing OpenCode factory retains its v1 contract. */
export declare function createOpenCodeV2ProviderModule(config: OpenCodeV2ApiClientOptions): RuntimeProviderModule;

/** Validate and URL-encode a dynamic OpenCode session identifier. */
export declare function encodeOpenCodeSessionId(sessionId: unknown): string;

/** The route and transport family used by `opencode serve`. */
export declare const OPENCODE_ENDPOINT_FAMILY: "legacy-http-sse";

/** SHA-256 of the verified live OpenCode OpenAPI document. */
export declare const OPENCODE_OPENAPI_SHA256: "46db986090aae41846cd6dbe16225a1d883f0bbcb4c48814008d3f6ce140aa5c";

/** Derived from PROVIDER_CAPABILITIES — the single declaration site. */
export declare const OPENCODE_RUNTIME_SUPPORT: Readonly<Partial<Record<"runs" | "streaming" | "media" | "wiki" | "agentConfig" | "teams" | "kanban" | "workspace" | "operator" | "discourse" | "batch", boolean>>>;

/** The OpenCode server release whose legacy HTTP/SSE contract is supported. */
export declare const OPENCODE_SERVER_VERSION: "1.18.27";

export declare class OpenCodeApiClient extends BaseHttpApiClient implements RuntimeClient {
    readonly request: HttpApiTransport;
    readonly scope: OpenCodeScope;
    private readonly defaultModel?;
    private readonly configuredPassword;
    private readonly authSecrets;
    private readonly runStore;
    private healthPromise?;
    constructor(options: OpenCodeApiClientOptions);
    getRuntimeCapabilities(): Promise<RuntimeCapabilities>;
    probeHealth(): Promise<OpenCodeHealthResponse>;
    private ensureHealth;
    private requestChecked;
    private cleanupSession;
    startRun(body: RuntimeRunStartBody): Promise<RuntimeRunStatus>;
    private modelString;
    getRun(runId: string): Promise<RuntimeRunStatus>;
    cancelRun(runId: string): Promise<{
        status: string;
    }>;
    streamRun(body: RuntimeRunStartBody, handlers: RunEventStreamHandlers, options?: {
        signal?: AbortSignal;
    }): Promise<void>;
}

export type OpenCodeApiClientOptions = {
    baseUrl: string;
    scope: OpenCodeScope;
    username?: string;
    password?: string;
    defaultModel?: string;
    fetchImpl?: typeof fetch;
    onTrace?: HttpApiClientOptions["onTrace"];
    defaultTimeoutMs?: number;
    cache?: RequestCache;
    credentials?: RequestCredentials;
};

export type OpenCodeScope = {
    directory: string;
    workspace?: string;
};

/** Polling lifecycle for the v2 HTTP API; deliberately does not advertise v1 SSE support. */
export declare class OpenCodeV2ApiClient implements RuntimeClient {
    private readonly http;
    private readonly options;
    constructor(options: OpenCodeV2ApiClientOptions);
    getRuntimeCapabilities(): Promise<RuntimeCapabilities>;
    private session;
    startRun(body: RuntimeRunStartBody): Promise<RuntimeRunStatus>;
    getRun(runId: string): Promise<RuntimeRunStatus>;
    cancelRun(runId: string): Promise<{
        status: string;
    }>;
}

/** OpenCode v2 uses location-scoped sessions. The v1 workspace selector is unsupported. */
export type OpenCodeV2ApiClientOptions = Omit<OpenCodeApiClientOptions, "scope"> & {
    scope: {
        directory: string;
    };
};

/**
 * Validate a request scope while preserving the caller's path strings exactly.
 * Whitespace is used only for presence checks; path normalization is not part
 * of the OpenCode protocol contract.
 */
export declare function validateOpenCodeScope(scope: unknown): OpenCodeScope;