@r-cli/sdk 1.0.112 → 1.0.114

package/package.json

@@ -1,14 +1,19 @@
 {
   "name": "@r-cli/sdk",
-  "version": "1.0.112",
+  "version": "1.0.114",
   "description": "SDK for Claude Tools with tool, query, and createSdkMcpServer exports",
   "type": "module",
   "main": "./sdk.mjs",
+  "types": "./sdk.d.ts",
   "exports": {
-    ".": "./sdk.mjs"
+    ".": {
+      "import": "./sdk.mjs",
+      "types": "./sdk.d.ts"
+    }
   },
   "files": [
     "sdk.mjs",
+    "sdk.d.ts",
     "README.md"
   ],
   "keywords": [
@@ -31,4 +36,3 @@
     "access": "public"
   }
 }
-

package/sdk.d.ts

@@ -0,0 +1,206 @@
+/**
+ * JSON Schema type for tool input/output schemas
+ */
+export interface JsonSchema {
+  type: "object";
+  properties?: Record<string, unknown>;
+  required?: string[];
+  [key: string]: unknown;
+}
+
+/**
+ * Tool definition
+ */
+export interface ToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: JsonSchema;
+  handler: (args: Record<string, unknown>) => Promise<unknown> | unknown;
+}
+
+/**
+ * MCP Server instance returned by createSdkMcpServer
+ */
+export interface McpServerInstance {
+  type: "sdk";
+  name: string;
+  instance: unknown; // McpServer instance
+}
+
+/**
+ * Options for createSdkMcpServer
+ */
+export interface CreateSdkMcpServerOptions {
+  name: string;
+  version?: string;
+  tools?: ToolDefinition[];
+}
+
+/**
+ * Options for canUseTool callback
+ */
+export interface CanUseToolOptions {
+  signal: AbortSignal;
+  suggestions?: string[];
+}
+
+/**
+ * Hook callback function
+ */
+export type HookCallback = (
+  input: unknown,
+  toolUseID: string,
+  options: { signal: AbortSignal }
+) => Promise<unknown> | unknown;
+
+/**
+ * Hook matcher configuration
+ */
+export interface HookMatcher {
+  matcher: unknown;
+  hooks: HookCallback[];
+}
+
+/**
+ * Hooks configuration - maps event names to arrays of matchers
+ */
+export type HooksConfig = Record<string, HookMatcher[]>;
+
+/**
+ * Query options
+ */
+export interface QueryOptions {
+  abortController?: AbortController;
+  additionalDirectories?: string[];
+  allowedTools?: string[];
+  appendSystemPrompt?: string;
+  canUseTool?: (
+    toolName: string,
+    input: Record<string, unknown>,
+    options: CanUseToolOptions
+  ) => Promise<boolean> | boolean;
+  continue?: boolean;
+  customSystemPrompt?: string;
+  cwd?: string;
+  disallowedTools?: string[];
+  env?: Record<string, string>;
+  executable?: string;
+  executableArgs?: string[];
+  extraArgs?: Record<string, unknown>;
+  fallbackModel?: string;
+  hooks?: HooksConfig;
+  includePartialMessages?: boolean;
+  maxTurns?: number;
+  mcpServers?: Record<string, McpServerInstance | unknown>;
+  model?: string;
+  pathToClaudeCodeExecutable?: string;
+  permissionMode?: string;
+  permissionPromptToolName?: string;
+  resume?: unknown;
+  stderr?: NodeJS.WriteStream;
+  strictMcpConfig?: boolean;
+}
+
+/**
+ * Query function parameters
+ */
+export interface QueryParams {
+  prompt: string | AsyncIterable<string>;
+  options?: QueryOptions;
+}
+
+/**
+ * SDK message type (simplified - actual implementation may have more specific types)
+ */
+export type SdkMessage = unknown;
+
+/**
+ * Query instance returned by query function
+ * 
+ * The Query instance is an async iterable, so you can use it in for-await-of loops:
+ * ```typescript
+ * for await (const message of query({ prompt: "..." })) {
+ *   // process message
+ * }
+ * ```
+ */
+export interface QueryInstance extends AsyncIterable<SdkMessage> {
+  /**
+   * Stream input messages to the query
+   * @param stream - Async iterable of messages to stream
+   */
+  streamInput(stream: AsyncIterable<string>): Promise<void>;
+  
+  /**
+   * Interrupt the current query operation
+   */
+  interrupt(): Promise<void>;
+  
+  /**
+   * Set the permission mode
+   * @param mode - Permission mode string
+   */
+  setPermissionMode(mode: string): Promise<void>;
+  
+  /**
+   * Set the model to use
+   * @param model - Model name/identifier
+   */
+  setModel(model: string): Promise<void>;
+  
+  /**
+   * Get supported commands (only available in streaming mode)
+   * @returns Array of supported command names
+   */
+  supportedCommands(): Promise<string[]>;
+  
+  /**
+   * Get supported models (only available in streaming mode)
+   * @returns Array of supported model names
+   */
+  supportedModels(): Promise<string[]>;
+  
+  /**
+   * Async iterator methods
+   */
+  next(value?: unknown): Promise<IteratorResult<SdkMessage>>;
+  return(value?: unknown): Promise<IteratorResult<SdkMessage>>;
+  throw(e?: unknown): Promise<IteratorResult<SdkMessage>>;
+  
+  /**
+   * Async iterator symbol
+   */
+  [Symbol.asyncIterator](): AsyncIterator<SdkMessage>;
+}
+
+/**
+ * Creates a tool definition
+ * @param name - Tool name
+ * @param description - Tool description
+ * @param inputSchema - JSON schema for tool input
+ * @param handler - Handler function that processes tool calls
+ * @returns Tool definition object
+ */
+export function tool(
+  name: string,
+  description: string,
+  inputSchema: JsonSchema,
+  handler: (args: Record<string, unknown>) => Promise<unknown> | unknown
+): ToolDefinition;
+
+/**
+ * Creates an SDK MCP server
+ * @param options - Server configuration options
+ * @returns MCP server instance
+ */
+export function createSdkMcpServer(
+  options: CreateSdkMcpServerOptions
+): McpServerInstance;
+
+/**
+ * Creates a query instance for tool operations
+ * @param params - Query parameters including prompt and options
+ * @returns Query instance
+ */
+export function query(params: QueryParams): QueryInstance;
+