@opencode-ai/sdk 0.4.45 → 0.5.1

package/dist/gen/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Options as ClientOptions, TDataShape, Client } from "./client/index.js";
-import type { EventSubscribeData, EventSubscribeResponses, AppGetData, AppGetResponses, AppInitData, AppInitResponses, ConfigGetData, ConfigGetResponses, SessionListData, SessionListResponses, SessionCreateData, SessionCreateResponses, SessionCreateErrors, SessionDeleteData, SessionDeleteResponses, SessionGetData, SessionGetResponses, SessionUpdateData, SessionUpdateResponses, SessionInitData, SessionInitResponses, SessionAbortData, SessionAbortResponses, SessionUnshareData, SessionUnshareResponses, SessionShareData, SessionShareResponses, SessionSummarizeData, SessionSummarizeResponses, SessionMessagesData, SessionMessagesResponses, SessionChatData, SessionChatResponses, SessionMessageData, SessionMessageResponses, SessionShellData, SessionShellResponses, SessionRevertData, SessionRevertResponses, SessionUnrevertData, SessionUnrevertResponses, PostSessionByIdPermissionsByPermissionIdData, PostSessionByIdPermissionsByPermissionIdResponses, ConfigProvidersData, ConfigProvidersResponses, FindTextData, FindTextResponses, FindFilesData, FindFilesResponses, FindSymbolsData, FindSymbolsResponses, FileReadData, FileReadResponses, FileStatusData, FileStatusResponses, AppLogData, AppLogResponses, AppAgentsData, AppAgentsResponses, TuiAppendPromptData, TuiAppendPromptResponses, TuiOpenHelpData, TuiOpenHelpResponses, TuiOpenSessionsData, TuiOpenSessionsResponses, TuiOpenThemesData, TuiOpenThemesResponses, TuiOpenModelsData, TuiOpenModelsResponses, TuiSubmitPromptData, TuiSubmitPromptResponses, TuiClearPromptData, TuiClearPromptResponses, TuiExecuteCommandData, TuiExecuteCommandResponses } from "./types.gen.js";
+import type { EventSubscribeData, EventSubscribeResponses, AppGetData, AppGetResponses, AppInitData, AppInitResponses, ConfigGetData, ConfigGetResponses, SessionListData, SessionListResponses, SessionCreateData, SessionCreateResponses, SessionCreateErrors, SessionDeleteData, SessionDeleteResponses, SessionGetData, SessionGetResponses, SessionUpdateData, SessionUpdateResponses, SessionInitData, SessionInitResponses, SessionAbortData, SessionAbortResponses, SessionUnshareData, SessionUnshareResponses, SessionShareData, SessionShareResponses, SessionSummarizeData, SessionSummarizeResponses, SessionMessagesData, SessionMessagesResponses, SessionChatData, SessionChatResponses, SessionMessageData, SessionMessageResponses, SessionShellData, SessionShellResponses, SessionRevertData, SessionRevertResponses, SessionUnrevertData, SessionUnrevertResponses, PostSessionByIdPermissionsByPermissionIdData, PostSessionByIdPermissionsByPermissionIdResponses, ConfigProvidersData, ConfigProvidersResponses, FindTextData, FindTextResponses, FindFilesData, FindFilesResponses, FindSymbolsData, FindSymbolsResponses, FileReadData, FileReadResponses, FileStatusData, FileStatusResponses, AppLogData, AppLogResponses, AppAgentsData, AppAgentsResponses, TuiAppendPromptData, TuiAppendPromptResponses, TuiOpenHelpData, TuiOpenHelpResponses, TuiOpenSessionsData, TuiOpenSessionsResponses, TuiOpenThemesData, TuiOpenThemesResponses, TuiOpenModelsData, TuiOpenModelsResponses, TuiSubmitPromptData, TuiSubmitPromptResponses, TuiClearPromptData, TuiClearPromptResponses, TuiExecuteCommandData, TuiExecuteCommandResponses, AuthSetData, AuthSetResponses, AuthSetErrors } from "./types.gen.js";
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -177,6 +177,12 @@ declare class Tui extends _HeyApiClient {
      */
     executeCommand<ThrowOnError extends boolean = false>(options?: Options<TuiExecuteCommandData, ThrowOnError>): import("./client/types.js").RequestResult<TuiExecuteCommandResponses, unknown, ThrowOnError, "fields">;
 }
+declare class Auth extends _HeyApiClient {
+    /**
+     * Set authentication credentials
+     */
+    set<ThrowOnError extends boolean = false>(options: Options<AuthSetData, ThrowOnError>): import("./client/types.js").RequestResult<AuthSetResponses, AuthSetErrors, ThrowOnError, "fields">;
+}
 export declare class OpencodeClient extends _HeyApiClient {
     /**
      * Respond to a permission request
@@ -189,5 +195,6 @@ export declare class OpencodeClient extends _HeyApiClient {
     find: Find;
     file: File;
     tui: Tui;
+    auth: Auth;
 }
 export {};

package/dist/gen/sdk.gen.js

@@ -382,6 +382,21 @@ class Tui extends _HeyApiClient {
         });
     }
 }
+class Auth extends _HeyApiClient {
+    /**
+     * Set authentication credentials
+     */
+    set(options) {
+        return (options.client ?? this._client).put({
+            url: "/auth/{id}",
+            ...options,
+            headers: {
+                "Content-Type": "application/json",
+                ...options.headers,
+            },
+        });
+    }
+}
 export class OpencodeClient extends _HeyApiClient {
     /**
      * Respond to a permission request
@@ -403,4 +418,5 @@ export class OpencodeClient extends _HeyApiClient {
     find = new Find({ client: this._client });
     file = new File({ client: this._client });
     tui = new Tui({ client: this._client });
+    auth = new Auth({ client: this._client });
 }

package/dist/gen/types.gen.d.ts

@@ -13,14 +13,12 @@ export type Event = ({
 } & EventMessagePartRemoved) | ({
     type: "storage.write";
 } & EventStorageWrite) | ({
-    type: "file.edited";
-} & EventFileEdited) | ({
-    type: "server.connected";
-} & EventServerConnected) | ({
     type: "permission.updated";
 } & EventPermissionUpdated) | ({
     type: "permission.replied";
 } & EventPermissionReplied) | ({
+    type: "file.edited";
+} & EventFileEdited) | ({
     type: "session.updated";
 } & EventSessionUpdated) | ({
     type: "session.deleted";
@@ -29,25 +27,27 @@ export type Event = ({
 } & EventSessionIdle) | ({
     type: "session.error";
 } & EventSessionError) | ({
+    type: "server.connected";
+} & EventServerConnected) | ({
     type: "file.watcher.updated";
 } & EventFileWatcherUpdated) | ({
     type: "ide.installed";
 } & EventIdeInstalled);
 export type EventInstallationUpdated = {
-    type: string;
+    type: "installation.updated";
     properties: {
         version: string;
     };
 };
 export type EventLspClientDiagnostics = {
-    type: string;
+    type: "lsp.client.diagnostics";
     properties: {
         serverID: string;
         path: string;
     };
 };
 export type EventMessageUpdated = {
-    type: string;
+    type: "message.updated";
     properties: {
         info: Message;
     };
@@ -60,7 +60,7 @@ export type Message = ({
 export type UserMessage = {
     id: string;
     sessionID: string;
-    role: string;
+    role: "user";
     time: {
         created: number;
     };
@@ -68,7 +68,7 @@ export type UserMessage = {
 export type AssistantMessage = {
     id: string;
     sessionID: string;
-    role: string;
+    role: "assistant";
     time: {
         created: number;
         completed?: number;
@@ -103,39 +103,39 @@ export type AssistantMessage = {
     };
 };
 export type ProviderAuthError = {
-    name: string;
+    name: "ProviderAuthError";
     data: {
         providerID: string;
         message: string;
     };
 };
 export type UnknownError = {
-    name: string;
+    name: "UnknownError";
     data: {
         message: string;
     };
 };
 export type MessageOutputLengthError = {
-    name: string;
+    name: "MessageOutputLengthError";
     data: {
         [key: string]: unknown;
     };
 };
 export type MessageAbortedError = {
-    name: string;
+    name: "MessageAbortedError";
     data: {
         [key: string]: unknown;
     };
 };
 export type EventMessageRemoved = {
-    type: string;
+    type: "message.removed";
     properties: {
         sessionID: string;
         messageID: string;
     };
 };
 export type EventMessagePartUpdated = {
-    type: string;
+    type: "message.part.updated";
     properties: {
         part: Part;
     };
@@ -163,7 +163,7 @@ export type TextPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "text";
     text: string;
     synthetic?: boolean;
     time?: {
@@ -175,7 +175,7 @@ export type ReasoningPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "reasoning";
     text: string;
     metadata?: {
         [key: string]: unknown;
@@ -189,7 +189,7 @@ export type FilePart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "file";
     mime: string;
     filename?: string;
     url: string;
@@ -202,7 +202,7 @@ export type FilePartSource = ({
 } & SymbolSource);
 export type FileSource = {
     text: FilePartSourceText;
-    type: string;
+    type: "file";
     path: string;
 };
 export type FilePartSourceText = {
@@ -212,7 +212,7 @@ export type FilePartSourceText = {
 };
 export type SymbolSource = {
     text: FilePartSourceText;
-    type: string;
+    type: "symbol";
     path: string;
     range: Range;
     name: string;
@@ -232,7 +232,7 @@ export type ToolPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "tool";
     callID: string;
     tool: string;
     state: ToolState;
@@ -247,10 +247,10 @@ export type ToolState = ({
     status: "error";
 } & ToolStateError);
 export type ToolStatePending = {
-    status: string;
+    status: "pending";
 };
 export type ToolStateRunning = {
-    status: string;
+    status: "running";
     input?: unknown;
     title?: string;
     metadata?: {
@@ -261,7 +261,7 @@ export type ToolStateRunning = {
     };
 };
 export type ToolStateCompleted = {
-    status: string;
+    status: "completed";
     input: {
         [key: string]: unknown;
     };
@@ -276,7 +276,7 @@ export type ToolStateCompleted = {
     };
 };
 export type ToolStateError = {
-    status: string;
+    status: "error";
     input: {
         [key: string]: unknown;
     };
@@ -290,13 +290,13 @@ export type StepStartPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "step-start";
 };
 export type StepFinishPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "step-finish";
     cost: number;
     tokens: {
         input: number;
@@ -312,14 +312,14 @@ export type SnapshotPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "snapshot";
     snapshot: string;
 };
 export type PatchPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "patch";
     hash: string;
     files: Array<string>;
 };
@@ -327,7 +327,7 @@ export type AgentPart = {
     id: string;
     sessionID: string;
     messageID: string;
-    type: string;
+    type: "agent";
     name: string;
     source?: {
         value: string;
@@ -336,7 +336,7 @@ export type AgentPart = {
     };
 };
 export type EventMessagePartRemoved = {
-    type: string;
+    type: "message.part.removed";
     properties: {
         sessionID: string;
         messageID: string;
@@ -344,26 +344,14 @@ export type EventMessagePartRemoved = {
     };
 };
 export type EventStorageWrite = {
-    type: string;
+    type: "storage.write";
     properties: {
         key: string;
         content?: unknown;
     };
 };
-export type EventFileEdited = {
-    type: string;
-    properties: {
-        file: string;
-    };
-};
-export type EventServerConnected = {
-    type: string;
-    properties: {
-        [key: string]: unknown;
-    };
-};
 export type EventPermissionUpdated = {
-    type: string;
+    type: "permission.updated";
     properties: Permission;
 };
 export type Permission = {
@@ -382,15 +370,21 @@ export type Permission = {
     };
 };
 export type EventPermissionReplied = {
-    type: string;
+    type: "permission.replied";
     properties: {
         sessionID: string;
         permissionID: string;
         response: string;
     };
 };
+export type EventFileEdited = {
+    type: "file.edited";
+    properties: {
+        file: string;
+    };
+};
 export type EventSessionUpdated = {
-    type: string;
+    type: "session.updated";
     properties: {
         info: Session;
     };
@@ -415,19 +409,19 @@ export type Session = {
     };
 };
 export type EventSessionDeleted = {
-    type: string;
+    type: "session.deleted";
     properties: {
         info: Session;
     };
 };
 export type EventSessionIdle = {
-    type: string;
+    type: "session.idle";
     properties: {
         sessionID: string;
     };
 };
 export type EventSessionError = {
-    type: string;
+    type: "session.error";
     properties: {
         sessionID?: string;
         error?: ({
@@ -441,15 +435,21 @@ export type EventSessionError = {
         } & MessageAbortedError);
     };
 };
+export type EventServerConnected = {
+    type: "server.connected";
+    properties: {
+        [key: string]: unknown;
+    };
+};
 export type EventFileWatcherUpdated = {
-    type: string;
+    type: "file.watcher.updated";
     properties: {
         file: string;
-        event: string;
+        event: "rename" | "change";
     };
 };
 export type EventIdeInstalled = {
-    type: string;
+    type: "ide.installed";
     properties: {
         ide: string;
     };
@@ -477,6 +477,9 @@ export type Config = {
      * Theme name to use for the interface
      */
     theme?: string;
+    /**
+     * Custom keybind configurations
+     */
     keybinds?: KeybindsConfig;
     plugin?: Array<string>;
     snapshot?: boolean;
@@ -588,7 +591,7 @@ export type Config = {
     };
     lsp?: {
         [key: string]: {
-            disabled: boolean;
+            disabled: true;
         } | {
             command: Array<string>;
             extensions?: Array<string>;
@@ -605,13 +608,16 @@ export type Config = {
      * Additional instruction files or patterns to include
      */
     instructions?: Array<string>;
+    /**
+     * @deprecated Always uses stretch layout.
+     */
     layout?: LayoutConfig;
     permission?: {
-        edit?: string;
-        bash?: string | {
-            [key: string]: string;
+        edit?: "ask" | "allow" | "deny";
+        bash?: ("ask" | "allow" | "deny") | {
+            [key: string]: "ask" | "allow" | "deny";
         };
-        webfetch?: string;
+        webfetch?: "ask" | "allow" | "deny";
     };
     experimental?: {
         hook?: {
@@ -811,22 +817,22 @@ export type AgentConfig = {
      * Description of when to use the agent
      */
     description?: string;
-    mode?: string;
+    mode?: "subagent" | "primary" | "all";
     permission?: {
-        edit?: string;
-        bash?: string | {
-            [key: string]: string;
+        edit?: "ask" | "allow" | "deny";
+        bash?: ("ask" | "allow" | "deny") | {
+            [key: string]: "ask" | "allow" | "deny";
         };
-        webfetch?: string;
+        webfetch?: "ask" | "allow" | "deny";
     };
     [key: string]: unknown | string | number | {
         [key: string]: boolean;
-    } | boolean | string | {
-        edit?: string;
-        bash?: string | {
-            [key: string]: string;
+    } | boolean | ("subagent" | "primary" | "all") | {
+        edit?: "ask" | "allow" | "deny";
+        bash?: ("ask" | "allow" | "deny") | {
+            [key: string]: "ask" | "allow" | "deny";
         };
-        webfetch?: string;
+        webfetch?: "ask" | "allow" | "deny";
     } | undefined;
 };
 export type Provider = {
@@ -865,7 +871,7 @@ export type McpLocalConfig = {
     /**
      * Type of MCP server connection
      */
-    type: string;
+    type: "local";
     /**
      * Command and arguments to run the MCP server
      */
@@ -885,7 +891,7 @@ export type McpRemoteConfig = {
     /**
      * Type of MCP server connection
      */
-    type: string;
+    type: "remote";
     /**
      * URL of the remote MCP server
      */
@@ -909,7 +915,7 @@ export type _Error = {
 };
 export type TextPartInput = {
     id?: string;
-    type: string;
+    type: "text";
     text: string;
     synthetic?: boolean;
     time?: {
@@ -919,7 +925,7 @@ export type TextPartInput = {
 };
 export type FilePartInput = {
     id?: string;
-    type: string;
+    type: "file";
     mime: string;
     filename?: string;
     url: string;
@@ -927,7 +933,7 @@ export type FilePartInput = {
 };
 export type AgentPartInput = {
     id?: string;
-    type: string;
+    type: "agent";
     name: string;
     source?: {
         value: string;
@@ -952,15 +958,15 @@ export type File = {
 export type Agent = {
     name: string;
     description?: string;
-    mode: string;
+    mode: "subagent" | "primary" | "all";
     topP?: number;
     temperature?: number;
     permission: {
-        edit: string;
+        edit: "ask" | "allow" | "deny";
         bash: {
-            [key: string]: string;
+            [key: string]: "ask" | "allow" | "deny";
         };
-        webfetch?: string;
+        webfetch?: "ask" | "allow" | "deny";
     };
     model?: {
         modelID: string;
@@ -974,6 +980,28 @@ export type Agent = {
         [key: string]: unknown;
     };
 };
+export type Auth = ({
+    type: "oauth";
+} & OAuth) | ({
+    type: "api";
+} & ApiAuth) | ({
+    type: "wellknown";
+} & WellKnownAuth);
+export type OAuth = {
+    type: "oauth";
+    refresh: string;
+    access: string;
+    expires: number;
+};
+export type ApiAuth = {
+    type: "api";
+    key: string;
+};
+export type WellKnownAuth = {
+    type: "wellknown";
+    key: string;
+    token: string;
+};
 export type EventSubscribeData = {
     body?: never;
     path?: never;
@@ -1609,6 +1637,28 @@ export type TuiExecuteCommandResponses = {
     200: boolean;
 };
 export type TuiExecuteCommandResponse = TuiExecuteCommandResponses[keyof TuiExecuteCommandResponses];
+export type AuthSetData = {
+    body?: Auth;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: "/auth/{id}";
+};
+export type AuthSetErrors = {
+    /**
+     * Bad request
+     */
+    400: _Error;
+};
+export type AuthSetError = AuthSetErrors[keyof AuthSetErrors];
+export type AuthSetResponses = {
+    /**
+     * Successfully set authentication credentials
+     */
+    200: boolean;
+};
+export type AuthSetResponse = AuthSetResponses[keyof AuthSetResponses];
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };

package/dist/index.d.ts

@@ -2,3 +2,11 @@ import { type Config } from "./gen/client/types.js";
 import { OpencodeClient } from "./gen/sdk.gen.js";
 export * from "./gen/types.gen.js";
 export declare function createOpencodeClient(config?: Config): OpencodeClient;
+export type ServerConfig = {
+    host?: string;
+    port?: number;
+};
+export declare function createOpencodeServer(config?: ServerConfig): Promise<{
+    url: string;
+    close(): void;
+}>;

package/dist/index.js

@@ -1,7 +1,22 @@
 import { createClient } from "./gen/client/client.js";
 import { OpencodeClient } from "./gen/sdk.gen.js";
 export * from "./gen/types.gen.js";
+import { spawn } from "child_process";
 export function createOpencodeClient(config) {
     const client = createClient(config);
     return new OpencodeClient({ client });
 }
+export async function createOpencodeServer(config) {
+    config = Object.assign({
+        host: "127.0.0.1",
+        port: 4096,
+    }, config ?? {});
+    const proc = spawn(`opencode`, [`serve`, `--host=${config.host}`, `--port=${config.port}`]);
+    const url = `http://${config.host}:${config.port}`;
+    return {
+        url,
+        close() {
+            proc.kill();
+        },
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@opencode-ai/sdk",
-  "version": "0.4.45",
+  "version": "0.5.1",
   "type": "module",
   "scripts": {
     "typecheck": "tsc --noEmit"