@supyagent/sdk 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -10,6 +10,8 @@ interface ToolMetadata {
     bodyDefaults?: Record<string, string>;
     category?: string;
     tags?: string[];
+    /** Whether the user has the required integration connected. Present on all tool discovery endpoints. */
+    connected?: boolean;
 }
 /** A single tool as returned by the /api/v1/tools endpoint */
 interface OpenAITool {
@@ -96,6 +98,20 @@ interface SkillsResult {
     /** Tool objects: loadSkill and apiCall */
     tools: Record<string, ai.Tool>;
 }
+/** A tool with a relevance score, returned by search endpoints */
+interface ScoredTool extends OpenAITool {
+    score: number;
+}
+/** Response from search endpoints (/tools/search, /tools/names) */
+interface ToolSearchResponse {
+    tools: ScoredTool[];
+    total: number;
+}
+/** Response from filter endpoints (/tools/provider, /tools/service) */
+interface ToolListResponse {
+    tools: OpenAITool[];
+    total: number;
+}
 /** A connected account (end-user of the partner) */
 interface ConnectedAccount {
     id: string;
@@ -190,12 +206,24 @@ interface ScopedClient {
     tools(options?: ToolFilterOptions): Promise<Record<string, ai.Tool>>;
     skills(options?: SkillsOptions): Promise<SkillsResult>;
     me(options?: MeOptions): Promise<MeResponse>;
+    /** Fuzzy search across tool names and descriptions. Returns scored results. */
+    searchTools(query: string): Promise<ToolSearchResponse>;
+    /** Get all tools for a specific provider (e.g. "google", "slack"). */
+    toolsByProvider(provider: string): Promise<ToolListResponse>;
+    /** Get all tools for a specific service (e.g. "gmail", "calendar"). */
+    toolsByService(service: string): Promise<ToolListResponse>;
 }
 /** The supyagent client interface */
 interface SupyagentClient {
     tools(options?: ToolFilterOptions): Promise<Record<string, ai.Tool>>;
     skills(options?: SkillsOptions): Promise<SkillsResult>;
     me(options?: MeOptions): Promise<MeResponse>;
+    /** Fuzzy search across tool names and descriptions. Returns scored results. */
+    searchTools(query: string): Promise<ToolSearchResponse>;
+    /** Get all tools for a specific provider (e.g. "google", "slack"). */
+    toolsByProvider(provider: string): Promise<ToolListResponse>;
+    /** Get all tools for a specific service (e.g. "gmail", "calendar"). */
+    toolsByService(service: string): Promise<ToolListResponse>;
     accounts: AccountsClient;
     /** Returns a client scoped to a connected account. All requests include X-Account-Id. */
     asAccount(externalId: string): ScopedClient;
@@ -328,4 +356,194 @@ declare function createLoadSkillTool(skills: ParsedSkill[]): ai.Tool<unknown, {
  */
 declare function createApiCallTool(baseUrl: string, apiKey: string, accountId?: string): ai.Tool<unknown, any>;
 
-export { type AccountIntegration, type AccountIntegrationDetail, type AccountsClient, type BashToolOptions, type BashToolResult, type ConnectOptions, type ConnectSession, type ConnectSessionStatus, type ConnectedAccount, type ConnectedAccountWithIntegrations, type CreateAccountOptions, type ListAccountsOptions, type ListAccountsResponse, type MeOptions, type MeResponse, type OpenAITool, type ParsedSkill, type ParsedSkillsDocument, type ScopedClient, type SkillsOptions, type SkillsResult, type SupyagentClient, type SupyagentOptions, type ToolFilterOptions, type ToolMetadata, type ToolsResponse, type UpdateAccountOptions, type ViewImageToolOptions, type ViewImageToolResult, buildSkillsSystemPrompt, createApiCallTool, createBashTool, createLoadSkillTool, createViewImageTool, findSkill, parseSkillsMarkdown, supyagent };
+interface EditFileToolOptions {
+    /** Base directory for resolving relative paths. Defaults to `process.cwd()`. */
+    cwd?: string;
+    /** Maximum file size in bytes that can be edited. Defaults to 1MB. */
+    maxFileSize?: number;
+}
+interface EditFileToolResult {
+    path: string;
+    replacements: number;
+}
+/**
+ * Create an editFile tool that patches files using search-and-replace.
+ *
+ * Unlike a full-file write, this lets the LLM send only the changed sections,
+ * saving tokens and reducing the risk of accidentally dropping content.
+ *
+ * @example
+ * ```ts
+ * import { createEditFileTool } from '@supyagent/sdk';
+ *
+ * const tools = {
+ *   editFile: createEditFileTool({ cwd: '/path/to/project' }),
+ * };
+ * ```
+ */
+declare function createEditFileTool(options?: EditFileToolOptions): ai.Tool<unknown, EditFileToolResult | {
+    error: string;
+    currentContent?: string;
+}>;
+
+interface GrepToolOptions {
+    /** Base directory for searching. Defaults to `process.cwd()`. */
+    cwd?: string;
+    /** Timeout in milliseconds. Defaults to 15000 (15s). */
+    timeout?: number;
+    /** Maximum output length in characters. Defaults to 30000. */
+    maxOutput?: number;
+}
+interface GrepToolResult {
+    matches: string;
+    matchCount: number;
+    truncated: boolean;
+}
+/**
+ * Create a grep tool for searching file contents by pattern.
+ *
+ * Uses `grep -rn` (or `rg` if available) under the hood.
+ * Returns matching lines with file paths and line numbers.
+ *
+ * @example
+ * ```ts
+ * import { createGrepTool } from '@supyagent/sdk';
+ *
+ * const tools = {
+ *   grep: createGrepTool({ cwd: '/path/to/project' }),
+ * };
+ * ```
+ */
+declare function createGrepTool(options?: GrepToolOptions): ai.Tool<unknown, GrepToolResult | {
+    error: string;
+}>;
+
+interface FindToolOptions {
+    /** Base directory for searching. Defaults to `process.cwd()`. */
+    cwd?: string;
+    /** Timeout in milliseconds. Defaults to 15000 (15s). */
+    timeout?: number;
+    /** Maximum output length in characters. Defaults to 30000. */
+    maxOutput?: number;
+}
+interface FindToolResult {
+    files: string[];
+    count: number;
+    truncated: boolean;
+}
+/**
+ * Create a find tool for discovering files by name or glob pattern.
+ *
+ * Uses `find` under the hood with common ignore patterns
+ * (node_modules, .git, dist, etc.) pre-configured.
+ *
+ * @example
+ * ```ts
+ * import { createFindTool } from '@supyagent/sdk';
+ *
+ * const tools = {
+ *   find: createFindTool({ cwd: '/path/to/project' }),
+ * };
+ * ```
+ */
+declare function createFindTool(options?: FindToolOptions): ai.Tool<unknown, FindToolResult | {
+    error: string;
+}>;
+
+interface ReadFileRangeToolOptions {
+    /** Base directory for resolving relative paths. Defaults to `process.cwd()`. */
+    cwd?: string;
+    /** Maximum number of lines that can be requested at once. Defaults to 200. */
+    maxLines?: number;
+}
+interface ReadFileRangeToolResult {
+    path: string;
+    content: string;
+    startLine: number;
+    endLine: number;
+    totalLines: number;
+}
+/**
+ * Create a readFileRange tool that reads specific line ranges from files.
+ *
+ * More token-efficient than reading entire files — especially useful
+ * after a grep to read context around a match.
+ *
+ * @example
+ * ```ts
+ * import { createReadFileRangeTool } from '@supyagent/sdk';
+ *
+ * const tools = {
+ *   readFileRange: createReadFileRangeTool({ cwd: '/path/to/project' }),
+ * };
+ * ```
+ */
+declare function createReadFileRangeTool(options?: ReadFileRangeToolOptions): ai.Tool<unknown, ReadFileRangeToolResult | {
+    error: string;
+}>;
+
+interface AppendFileToolOptions {
+    /** Base directory for resolving relative paths. Defaults to `process.cwd()`. */
+    cwd?: string;
+}
+interface AppendFileToolResult {
+    path: string;
+    bytesAppended: number;
+}
+/**
+ * Create an appendFile tool that appends content to existing files.
+ *
+ * More token-efficient than read-concat-write for incremental file building
+ * (logs, CSVs, reports). Creates the file if it doesn't exist.
+ *
+ * @example
+ * ```ts
+ * import { createAppendFileTool } from '@supyagent/sdk';
+ *
+ * const tools = {
+ *   appendFile: createAppendFileTool({ cwd: '/path/to/project' }),
+ * };
+ * ```
+ */
+declare function createAppendFileTool(options?: AppendFileToolOptions): ai.Tool<unknown, AppendFileToolResult | {
+    error: string;
+}>;
+
+interface HttpRequestToolOptions {
+    /** Default timeout in milliseconds. Defaults to 30000 (30s). */
+    timeout?: number;
+    /** Maximum response body size in characters. Defaults to 100000. */
+    maxResponseSize?: number;
+    /** Default headers to include in every request. */
+    defaultHeaders?: Record<string, string>;
+}
+interface HttpRequestToolResult {
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    body: string;
+    durationMs: number;
+    truncated: boolean;
+}
+/**
+ * Create an httpRequest tool for making HTTP requests.
+ *
+ * Supports GET, POST, PUT, PATCH, DELETE with headers, body, and
+ * parsed JSON responses. Cleaner than composing curl commands via bash.
+ *
+ * @example
+ * ```ts
+ * import { createHttpRequestTool } from '@supyagent/sdk';
+ *
+ * const tools = {
+ *   httpRequest: createHttpRequestTool({
+ *     defaultHeaders: { 'Authorization': 'Bearer ...' },
+ *   }),
+ * };
+ * ```
+ */
+declare function createHttpRequestTool(options?: HttpRequestToolOptions): ai.Tool<unknown, HttpRequestToolResult | {
+    error: string;
+}>;
+
+export { type AccountIntegration, type AccountIntegrationDetail, type AccountsClient, type AppendFileToolOptions, type AppendFileToolResult, type BashToolOptions, type BashToolResult, type ConnectOptions, type ConnectSession, type ConnectSessionStatus, type ConnectedAccount, type ConnectedAccountWithIntegrations, type CreateAccountOptions, type EditFileToolOptions, type EditFileToolResult, type FindToolOptions, type FindToolResult, type GrepToolOptions, type GrepToolResult, type HttpRequestToolOptions, type HttpRequestToolResult, type ListAccountsOptions, type ListAccountsResponse, type MeOptions, type MeResponse, type OpenAITool, type ParsedSkill, type ParsedSkillsDocument, type ReadFileRangeToolOptions, type ReadFileRangeToolResult, type ScopedClient, type ScoredTool, type SkillsOptions, type SkillsResult, type SupyagentClient, type SupyagentOptions, type ToolFilterOptions, type ToolListResponse, type ToolMetadata, type ToolSearchResponse, type ToolsResponse, type UpdateAccountOptions, type ViewImageToolOptions, type ViewImageToolResult, buildSkillsSystemPrompt, createApiCallTool, createAppendFileTool, createBashTool, createEditFileTool, createFindTool, createGrepTool, createHttpRequestTool, createLoadSkillTool, createReadFileRangeTool, createViewImageTool, findSkill, parseSkillsMarkdown, supyagent };