@opencode-ai/sdk 0.1.0-alpha.2 → 0.1.0-alpha.20

package/src/internal/utils/path.ts

@@ -12,25 +12,43 @@ export function encodeURIPath(str: string) {
   return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
 }
 
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
 export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
   function path(statics: readonly string[], ...params: readonly unknown[]): string {
     // If there are no params, no processing is needed.
     if (statics.length === 1) return statics[0]!;
 
     let postPath = false;
+    const invalidSegments = [];
     const path = statics.reduce((previousValue, currentValue, index) => {
       if (/[?#]/.test(currentValue)) {
         postPath = true;
       }
-      return (
-        previousValue +
-        currentValue +
-        (index === params.length ? '' : (postPath ? encodeURIComponent : pathEncoder)(String(params[index])))
-      );
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
     }, '');
 
     const pathOnly = path.split(/[?#]/, 1)[0]!;
-    const invalidSegments = [];
     const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
     let match;
 
@@ -39,9 +57,12 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
       invalidSegments.push({
         start: match.index,
         length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
       });
     }
 
+    invalidSegments.sort((a, b) => a.start - b.start);
+
     if (invalidSegments.length > 0) {
       let lastEnd = 0;
       const underline = invalidSegments.reduce((acc, segment) => {
@@ -51,7 +72,11 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new OpencodeError(`Path parameters result in path with invalid segments:\n${path}\n${underline}`);
+      throw new OpencodeError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
     }
 
     return path;

package/src/resources/app.ts

@@ -0,0 +1,196 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class AppResource extends APIResource {
+  /**
+   * Get app info
+   */
+  get(options?: RequestOptions): APIPromise<App> {
+    return this._client.get('/app', options);
+  }
+
+  /**
+   * Initialize the app
+   */
+  init(options?: RequestOptions): APIPromise<AppInitResponse> {
+    return this._client.post('/app/init', options);
+  }
+
+  /**
+   * Write a log entry to the server logs
+   */
+  log(body: AppLogParams, options?: RequestOptions): APIPromise<AppLogResponse> {
+    return this._client.post('/log', { body, ...options });
+  }
+
+  /**
+   * List all modes
+   */
+  modes(options?: RequestOptions): APIPromise<AppModesResponse> {
+    return this._client.get('/mode', options);
+  }
+
+  /**
+   * List all providers
+   */
+  providers(options?: RequestOptions): APIPromise<AppProvidersResponse> {
+    return this._client.get('/config/providers', options);
+  }
+}
+
+export interface App {
+  git: boolean;
+
+  hostname: string;
+
+  path: App.Path;
+
+  time: App.Time;
+}
+
+export namespace App {
+  export interface Path {
+    config: string;
+
+    cwd: string;
+
+    data: string;
+
+    root: string;
+
+    state: string;
+  }
+
+  export interface Time {
+    initialized?: number;
+  }
+}
+
+/**
+ * Log level
+ */
+export type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
+
+export interface Mode {
+  name: string;
+
+  tools: { [key: string]: boolean };
+
+  model?: Mode.Model;
+
+  prompt?: string;
+}
+
+export namespace Mode {
+  export interface Model {
+    modelID: string;
+
+    providerID: string;
+  }
+}
+
+export interface Model {
+  id: string;
+
+  attachment: boolean;
+
+  cost: Model.Cost;
+
+  limit: Model.Limit;
+
+  name: string;
+
+  options: { [key: string]: unknown };
+
+  reasoning: boolean;
+
+  release_date: string;
+
+  temperature: boolean;
+
+  tool_call: boolean;
+}
+
+export namespace Model {
+  export interface Cost {
+    input: number;
+
+    output: number;
+
+    cache_read?: number;
+
+    cache_write?: number;
+  }
+
+  export interface Limit {
+    context: number;
+
+    output: number;
+  }
+}
+
+export interface Provider {
+  id: string;
+
+  env: Array<string>;
+
+  models: { [key: string]: Model };
+
+  name: string;
+
+  api?: string;
+
+  npm?: string;
+}
+
+export type AppInitResponse = boolean;
+
+export type AppLogResponse = boolean;
+
+export type AppModesResponse = Array<Mode>;
+
+export interface AppProvidersResponse {
+  default: { [key: string]: string };
+
+  providers: Array<Provider>;
+}
+
+export interface AppLogParams {
+  /**
+   * Log level
+   */
+  level: 'debug' | 'info' | 'error' | 'warn';
+
+  /**
+   * Log message
+   */
+  message: string;
+
+  /**
+   * Service name for the log entry
+   */
+  service: string;
+
+  /**
+   * Additional metadata for the log entry
+   */
+  extra?: { [key: string]: unknown };
+}
+
+export declare namespace AppResource {
+  export {
+    type App as App,
+    type LogLevel as LogLevel,
+    type Mode as Mode,
+    type Model as Model,
+    type Provider as Provider,
+    type AppInitResponse as AppInitResponse,
+    type AppLogResponse as AppLogResponse,
+    type AppModesResponse as AppModesResponse,
+    type AppProvidersResponse as AppProvidersResponse,
+    type AppLogParams as AppLogParams,
+  };
+}

package/src/resources/config.ts

@@ -0,0 +1,431 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as ConfigAPI from './config';
+import * as AppAPI from './app';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class ConfigResource extends APIResource {
+  /**
+   * Get config info
+   */
+  get(options?: RequestOptions): APIPromise<Config> {
+    return this._client.get('/config', options);
+  }
+}
+
+export interface Config {
+  /**
+   * JSON schema reference for configuration validation
+   */
+  $schema?: string;
+
+  /**
+   * @deprecated Use 'share' field instead. Share newly created sessions
+   * automatically
+   */
+  autoshare?: boolean;
+
+  /**
+   * Automatically update to the latest version
+   */
+  autoupdate?: boolean;
+
+  /**
+   * Disable providers that are loaded automatically
+   */
+  disabled_providers?: Array<string>;
+
+  experimental?: Config.Experimental;
+
+  /**
+   * Additional instruction files or patterns to include
+   */
+  instructions?: Array<string>;
+
+  /**
+   * Custom keybind configurations
+   */
+  keybinds?: KeybindsConfig;
+
+  /**
+   * Layout to use for the TUI
+   */
+  layout?: LayoutConfig;
+
+  /**
+   * Minimum log level to write to log files
+   */
+  log_level?: AppAPI.LogLevel;
+
+  /**
+   * MCP (Model Context Protocol) server configurations
+   */
+  mcp?: { [key: string]: McpLocalConfig | McpRemoteConfig };
+
+  /**
+   * Modes configuration, see https://opencode.ai/docs/modes
+   */
+  mode?: Config.Mode;
+
+  /**
+   * Model to use in the format of provider/model, eg anthropic/claude-2
+   */
+  model?: string;
+
+  /**
+   * Custom provider configurations and model overrides
+   */
+  provider?: { [key: string]: Config.Provider };
+
+  /**
+   * Control sharing behavior: 'auto' enables automatic sharing, 'disabled' disables
+   * all sharing
+   */
+  share?: 'auto' | 'disabled';
+
+  /**
+   * Theme name to use for the interface
+   */
+  theme?: string;
+
+  /**
+   * Custom username to display in conversations instead of system username
+   */
+  username?: string;
+}
+
+export namespace Config {
+  export interface Experimental {
+    hook?: Experimental.Hook;
+  }
+
+  export namespace Experimental {
+    export interface Hook {
+      file_edited?: { [key: string]: Array<Hook.FileEdited> };
+
+      session_completed?: Array<Hook.SessionCompleted>;
+    }
+
+    export namespace Hook {
+      export interface FileEdited {
+        command: Array<string>;
+
+        environment?: { [key: string]: string };
+      }
+
+      export interface SessionCompleted {
+        command: Array<string>;
+
+        environment?: { [key: string]: string };
+      }
+    }
+  }
+
+  /**
+   * Modes configuration, see https://opencode.ai/docs/modes
+   */
+  export interface Mode {
+    build?: ConfigAPI.ModeConfig;
+
+    plan?: ConfigAPI.ModeConfig;
+
+    [k: string]: ConfigAPI.ModeConfig | undefined;
+  }
+
+  export interface Provider {
+    models: { [key: string]: Provider.Models };
+
+    id?: string;
+
+    api?: string;
+
+    env?: Array<string>;
+
+    name?: string;
+
+    npm?: string;
+
+    options?: { [key: string]: unknown };
+  }
+
+  export namespace Provider {
+    export interface Models {
+      id?: string;
+
+      attachment?: boolean;
+
+      cost?: Models.Cost;
+
+      limit?: Models.Limit;
+
+      name?: string;
+
+      options?: { [key: string]: unknown };
+
+      reasoning?: boolean;
+
+      release_date?: string;
+
+      temperature?: boolean;
+
+      tool_call?: boolean;
+    }
+
+    export namespace Models {
+      export interface Cost {
+        input: number;
+
+        output: number;
+
+        cache_read?: number;
+
+        cache_write?: number;
+      }
+
+      export interface Limit {
+        context: number;
+
+        output: number;
+      }
+    }
+  }
+}
+
+export interface KeybindsConfig {
+  /**
+   * Exit the application
+   */
+  app_exit: string;
+
+  /**
+   * Show help dialog
+   */
+  app_help: string;
+
+  /**
+   * Open external editor
+   */
+  editor_open: string;
+
+  /**
+   * Close file
+   */
+  file_close: string;
+
+  /**
+   * Split/unified diff
+   */
+  file_diff_toggle: string;
+
+  /**
+   * List files
+   */
+  file_list: string;
+
+  /**
+   * Search file
+   */
+  file_search: string;
+
+  /**
+   * Clear input field
+   */
+  input_clear: string;
+
+  /**
+   * Insert newline in input
+   */
+  input_newline: string;
+
+  /**
+   * Paste from clipboard
+   */
+  input_paste: string;
+
+  /**
+   * Submit input
+   */
+  input_submit: string;
+
+  /**
+   * Leader key for keybind combinations
+   */
+  leader: string;
+
+  /**
+   * Copy message
+   */
+  messages_copy: string;
+
+  /**
+   * Navigate to first message
+   */
+  messages_first: string;
+
+  /**
+   * Scroll messages down by half page
+   */
+  messages_half_page_down: string;
+
+  /**
+   * Scroll messages up by half page
+   */
+  messages_half_page_up: string;
+
+  /**
+   * Navigate to last message
+   */
+  messages_last: string;
+
+  /**
+   * Toggle layout
+   */
+  messages_layout_toggle: string;
+
+  /**
+   * Navigate to next message
+   */
+  messages_next: string;
+
+  /**
+   * Scroll messages down by one page
+   */
+  messages_page_down: string;
+
+  /**
+   * Scroll messages up by one page
+   */
+  messages_page_up: string;
+
+  /**
+   * Navigate to previous message
+   */
+  messages_previous: string;
+
+  /**
+   * Revert message
+   */
+  messages_revert: string;
+
+  /**
+   * List available models
+   */
+  model_list: string;
+
+  /**
+   * Create/update AGENTS.md
+   */
+  project_init: string;
+
+  /**
+   * Compact the session
+   */
+  session_compact: string;
+
+  /**
+   * Export session to editor
+   */
+  session_export: string;
+
+  /**
+   * Interrupt current session
+   */
+  session_interrupt: string;
+
+  /**
+   * List all sessions
+   */
+  session_list: string;
+
+  /**
+   * Create a new session
+   */
+  session_new: string;
+
+  /**
+   * Share current session
+   */
+  session_share: string;
+
+  /**
+   * Unshare current session
+   */
+  session_unshare: string;
+
+  /**
+   * Switch mode
+   */
+  switch_mode: string;
+
+  /**
+   * List available themes
+   */
+  theme_list: string;
+
+  /**
+   * Toggle tool details
+   */
+  tool_details: string;
+}
+
+export type LayoutConfig = 'auto' | 'stretch';
+
+export interface McpLocalConfig {
+  /**
+   * Command and arguments to run the MCP server
+   */
+  command: Array<string>;
+
+  /**
+   * Type of MCP server connection
+   */
+  type: 'local';
+
+  /**
+   * Enable or disable the MCP server on startup
+   */
+  enabled?: boolean;
+
+  /**
+   * Environment variables to set when running the MCP server
+   */
+  environment?: { [key: string]: string };
+}
+
+export interface McpRemoteConfig {
+  /**
+   * Type of MCP server connection
+   */
+  type: 'remote';
+
+  /**
+   * URL of the remote MCP server
+   */
+  url: string;
+
+  /**
+   * Enable or disable the MCP server on startup
+   */
+  enabled?: boolean;
+}
+
+export interface ModeConfig {
+  model?: string;
+
+  prompt?: string;
+
+  tools?: { [key: string]: boolean };
+}
+
+export declare namespace ConfigResource {
+  export {
+    type Config as Config,
+    type KeybindsConfig as KeybindsConfig,
+    type LayoutConfig as LayoutConfig,
+    type McpLocalConfig as McpLocalConfig,
+    type McpRemoteConfig as McpRemoteConfig,
+    type ModeConfig as ModeConfig,
+  };
+}