@reverbia/sdk 1.0.0-next.20260109140427 → 1.0.0-next.20260109150925

package/dist/expo/index.d.mts

@@ -554,6 +554,7 @@ type BaseSendMessageResult = {
 };
 /**
  * Base options for useChat hook
+ * @inline
  */
 type BaseUseChatOptions = {
     getToken?: () => Promise<string | null>;
@@ -623,6 +624,9 @@ type SendMessageArgs = BaseSendMessageArgs & {
     searchContext?: string;
 };
 type SendMessageResult = BaseSendMessageResult;
+/**
+ * @inline
+ */
 type UseChatOptions = BaseUseChatOptions;
 type UseChatResult = BaseUseChatResult & {
     sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
@@ -731,6 +735,9 @@ interface StoredMemory extends MemoryItem {
 interface StoredMemoryWithSimilarity extends StoredMemory {
     similarity: number;
 }
+/**
+ * @inline
+ */
 interface BaseUseMemoryStorageOptions {
     database: Database;
     completionsModel?: string;
@@ -871,27 +878,93 @@ interface UpdateMessageOptions {
  * @inline
  */
 interface BaseUseChatStorageOptions {
+    /** WatermelonDB database instance for storing conversations and messages */
     database: Database;
+    /** ID of an existing conversation to load and continue */
     conversationId?: string;
+    /** Automatically create a new conversation if none is set (default: true) */
     autoCreateConversation?: boolean;
+    /** Title for auto-created conversations (default: "New conversation") */
     defaultConversationTitle?: string;
+    /** Function to retrieve the auth token for API requests */
     getToken?: () => Promise<string | null>;
+    /** Base URL for the chat API endpoint */
     baseUrl?: string;
+    /** Callback invoked with each streamed response chunk */
     onData?: (chunk: string) => void;
+    /** Callback invoked when the response completes successfully */
     onFinish?: (response: LlmapiResponseResponse) => void;
+    /** Callback invoked when an error occurs during the request */
     onError?: (error: Error) => void;
 }
+/**
+ * Base arguments for sending a message with automatic storage.
+ *
+ * These arguments control both the AI request and how the message
+ * is persisted to the local database.
+ * @inline
+ */
 interface BaseSendMessageWithStorageArgs {
+    /**
+     * The text content of the message to send to the AI.
+     */
     content: string;
+    /**
+     * The model identifier to use for this request (e.g., "gpt-4o", "claude-sonnet-4-20250514").
+     * If not specified, uses the default model configured on the server.
+     */
     model?: string;
+    /**
+     * Pre-built message array to send instead of using conversation history.
+     * When provided, `includeHistory` is ignored and these messages are used directly.
+     * Useful for custom message construction or when you need full control over context.
+     */
     messages?: LlmapiMessage[];
+    /**
+     * Whether to automatically include previous messages from the conversation as context.
+     * When true, fetches stored messages and prepends them to the request.
+     * Ignored if `messages` is provided.
+     * @default true
+     */
     includeHistory?: boolean;
+    /**
+     * Maximum number of historical messages to include when `includeHistory` is true.
+     * Only the most recent N messages are included to manage context window size.
+     * @default 50
+     */
     maxHistoryMessages?: number;
+    /**
+     * File attachments to include with the message (images, documents, etc.).
+     * Files with image MIME types and URLs are sent as image content parts.
+     * File metadata is stored with the message (URLs are stripped if they're data URIs).
+     */
     files?: FileMetadata[];
+    /**
+     * Per-request callback invoked with each streamed response chunk.
+     * Overrides the hook-level `onData` callback for this request only.
+     * Use this to update UI as the response streams in.
+     */
     onData?: (chunk: string) => void;
+    /**
+     * Additional context from memory/RAG system to include in the request.
+     * Typically contains retrieved relevant information from past conversations.
+     */
     memoryContext?: string;
+    /**
+     * Additional context from search results to include in the request.
+     * Typically contains relevant information from web or document searches.
+     */
     searchContext?: string;
+    /**
+     * Search sources to attach to the stored message for citation/reference.
+     * These are combined with any sources extracted from the assistant's response.
+     */
     sources?: SearchSource[];
+    /**
+     * Activity phases for tracking the request lifecycle in the UI.
+     * Each phase represents a step like "Searching", "Thinking", "Generating".
+     * The final phase is automatically marked as completed when stored.
+     */
     thoughtProcess?: ActivityPhase[];
     /**
      * Whether to store the response server-side.
@@ -909,33 +982,43 @@ interface BaseSendMessageWithStorageArgs {
     serverConversation?: string;
     /**
      * Controls randomness in the response (0.0 to 2.0).
+     * Lower values make output more deterministic, higher values more creative.
      */
     temperature?: number;
     /**
      * Maximum number of tokens to generate in the response.
+     * Use this to limit response length and control costs.
      */
     maxOutputTokens?: number;
     /**
      * Array of tool definitions available to the model.
+     * Tools enable the model to call functions, search, execute code, etc.
      */
     tools?: LlmapiTool[];
     /**
-     * Controls which tool to use: "auto", "any", "none", "required", or a specific tool name.
+     * Controls which tool the model should use:
+     * - "auto": Model decides whether to use a tool (default)
+     * - "any": Model must use one of the provided tools
+     * - "none": Model cannot use any tools
+     * - "required": Model must use a tool
+     * - Specific tool name: Model must use that specific tool
      */
     toolChoice?: string;
     /**
      * Reasoning configuration for o-series and other reasoning models.
-     * Controls reasoning effort and summary output.
+     * Controls reasoning effort level and whether to include reasoning summary.
      */
     reasoning?: LlmapiResponseReasoning;
     /**
      * Extended thinking configuration for Anthropic models (Claude).
-     * Enables the model to think through complex problems step by step.
+     * Enables the model to think through complex problems step by step
+     * before generating the final response.
      */
     thinking?: LlmapiThinkingOptions;
     /**
      * Per-request callback for thinking/reasoning chunks.
      * Called with delta chunks as the model "thinks" through a problem.
+     * Use this to display thinking progress in the UI.
      */
     onThinking?: (chunk: string) => void;
 }
@@ -1003,8 +1086,10 @@ declare class Conversation extends Model {
  * Options for useChatStorage hook (Expo version)
  *
  * Uses the base options without React-specific features (no local chat, no tools).
+ * @inline
  */
-type UseChatStorageOptions = BaseUseChatStorageOptions;
+interface UseChatStorageOptions extends BaseUseChatStorageOptions {
+}
 /**
  * Arguments for sendMessage with storage (Expo version)
  *
@@ -1080,6 +1165,9 @@ interface UseChatStorageResult extends BaseUseChatStorageResult {
  */
 declare function useChatStorage(options: UseChatStorageOptions): UseChatStorageResult;
 
+/**
+ * @inline
+ */
 type UseImageGenerationOptions = {
     /**
      * Custom function to get auth token for API calls
@@ -1117,6 +1205,9 @@ type UseImageGenerationResult = {
  */
 declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
 
+/**
+ * @inline
+ */
 type UseModelsOptions = {
     /**
      * Custom function to get auth token for API calls
@@ -1176,8 +1267,10 @@ declare class Memory extends Model {
  * Options for useMemoryStorage hook (Expo version)
  *
  * Uses the base options.
+ * @inline
  */
-type UseMemoryStorageOptions = BaseUseMemoryStorageOptions;
+interface UseMemoryStorageOptions extends BaseUseMemoryStorageOptions {
+}
 /**
  * Result returned by useMemoryStorage hook (Expo version)
  *
@@ -1305,4 +1398,4 @@ declare const sdkMigrations: Readonly<{
  */
 declare const sdkModelClasses: Class<Model$1>[];
 
-export { Conversation as ChatConversation, Message as ChatMessage, type ChatRole, type CreateConversationOptions, type CreateMemoryOptions, type CreateMessageOptions, type FileMetadata, type MemoryItem, type MemoryType, type SearchSource, type SendMessageWithStorageArgs, type SendMessageWithStorageResult, type ChatCompletionUsage as StoredChatCompletionUsage, type StoredConversation, type StoredMemory, Memory as StoredMemoryModel, type StoredMemoryWithSimilarity, type StoredMessage, type StoredMessageWithSimilarity, type UpdateMemoryOptions, type UseChatStorageOptions, type UseChatStorageResult, type UseMemoryStorageOptions, type UseMemoryStorageResult, type UseModelsOptions, type UseModelsResult, chatStorageMigrations, chatStorageSchema, generateCompositeKey, generateConversationId, generateUniqueKey, memoryStorageSchema, sdkMigrations, sdkModelClasses, sdkSchema, useChat, useChatStorage, useImageGeneration, useMemoryStorage, useModels };
+export { Conversation as ChatConversation, Message as ChatMessage, type ChatRole, type CreateConversationOptions, type CreateMemoryOptions, type CreateMessageOptions, type FileMetadata, type MemoryItem, type MemoryType, type SearchSource, type SendMessageWithStorageArgs, type SendMessageWithStorageResult, type ChatCompletionUsage as StoredChatCompletionUsage, type StoredConversation, type StoredMemory, Memory as StoredMemoryModel, type StoredMemoryWithSimilarity, type StoredMessage, type StoredMessageWithSimilarity, type UpdateMemoryOptions, type UseChatStorageOptions, type UseChatStorageResult, type UseImageGenerationResult, type UseMemoryStorageOptions, type UseMemoryStorageResult, type UseModelsOptions, type UseModelsResult, chatStorageMigrations, chatStorageSchema, generateCompositeKey, generateConversationId, generateUniqueKey, memoryStorageSchema, sdkMigrations, sdkModelClasses, sdkSchema, useChat, useChatStorage, useImageGeneration, useMemoryStorage, useModels };

package/dist/expo/index.d.ts

@@ -554,6 +554,7 @@ type BaseSendMessageResult = {
 };
 /**
  * Base options for useChat hook
+ * @inline
  */
 type BaseUseChatOptions = {
     getToken?: () => Promise<string | null>;
@@ -623,6 +624,9 @@ type SendMessageArgs = BaseSendMessageArgs & {
     searchContext?: string;
 };
 type SendMessageResult = BaseSendMessageResult;
+/**
+ * @inline
+ */
 type UseChatOptions = BaseUseChatOptions;
 type UseChatResult = BaseUseChatResult & {
     sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
@@ -731,6 +735,9 @@ interface StoredMemory extends MemoryItem {
 interface StoredMemoryWithSimilarity extends StoredMemory {
     similarity: number;
 }
+/**
+ * @inline
+ */
 interface BaseUseMemoryStorageOptions {
     database: Database;
     completionsModel?: string;
@@ -871,27 +878,93 @@ interface UpdateMessageOptions {
  * @inline
  */
 interface BaseUseChatStorageOptions {
+    /** WatermelonDB database instance for storing conversations and messages */
     database: Database;
+    /** ID of an existing conversation to load and continue */
     conversationId?: string;
+    /** Automatically create a new conversation if none is set (default: true) */
     autoCreateConversation?: boolean;
+    /** Title for auto-created conversations (default: "New conversation") */
     defaultConversationTitle?: string;
+    /** Function to retrieve the auth token for API requests */
     getToken?: () => Promise<string | null>;
+    /** Base URL for the chat API endpoint */
     baseUrl?: string;
+    /** Callback invoked with each streamed response chunk */
     onData?: (chunk: string) => void;
+    /** Callback invoked when the response completes successfully */
     onFinish?: (response: LlmapiResponseResponse) => void;
+    /** Callback invoked when an error occurs during the request */
     onError?: (error: Error) => void;
 }
+/**
+ * Base arguments for sending a message with automatic storage.
+ *
+ * These arguments control both the AI request and how the message
+ * is persisted to the local database.
+ * @inline
+ */
 interface BaseSendMessageWithStorageArgs {
+    /**
+     * The text content of the message to send to the AI.
+     */
     content: string;
+    /**
+     * The model identifier to use for this request (e.g., "gpt-4o", "claude-sonnet-4-20250514").
+     * If not specified, uses the default model configured on the server.
+     */
     model?: string;
+    /**
+     * Pre-built message array to send instead of using conversation history.
+     * When provided, `includeHistory` is ignored and these messages are used directly.
+     * Useful for custom message construction or when you need full control over context.
+     */
     messages?: LlmapiMessage[];
+    /**
+     * Whether to automatically include previous messages from the conversation as context.
+     * When true, fetches stored messages and prepends them to the request.
+     * Ignored if `messages` is provided.
+     * @default true
+     */
     includeHistory?: boolean;
+    /**
+     * Maximum number of historical messages to include when `includeHistory` is true.
+     * Only the most recent N messages are included to manage context window size.
+     * @default 50
+     */
     maxHistoryMessages?: number;
+    /**
+     * File attachments to include with the message (images, documents, etc.).
+     * Files with image MIME types and URLs are sent as image content parts.
+     * File metadata is stored with the message (URLs are stripped if they're data URIs).
+     */
     files?: FileMetadata[];
+    /**
+     * Per-request callback invoked with each streamed response chunk.
+     * Overrides the hook-level `onData` callback for this request only.
+     * Use this to update UI as the response streams in.
+     */
     onData?: (chunk: string) => void;
+    /**
+     * Additional context from memory/RAG system to include in the request.
+     * Typically contains retrieved relevant information from past conversations.
+     */
     memoryContext?: string;
+    /**
+     * Additional context from search results to include in the request.
+     * Typically contains relevant information from web or document searches.
+     */
     searchContext?: string;
+    /**
+     * Search sources to attach to the stored message for citation/reference.
+     * These are combined with any sources extracted from the assistant's response.
+     */
     sources?: SearchSource[];
+    /**
+     * Activity phases for tracking the request lifecycle in the UI.
+     * Each phase represents a step like "Searching", "Thinking", "Generating".
+     * The final phase is automatically marked as completed when stored.
+     */
     thoughtProcess?: ActivityPhase[];
     /**
      * Whether to store the response server-side.
@@ -909,33 +982,43 @@ interface BaseSendMessageWithStorageArgs {
     serverConversation?: string;
     /**
      * Controls randomness in the response (0.0 to 2.0).
+     * Lower values make output more deterministic, higher values more creative.
      */
     temperature?: number;
     /**
      * Maximum number of tokens to generate in the response.
+     * Use this to limit response length and control costs.
      */
     maxOutputTokens?: number;
     /**
      * Array of tool definitions available to the model.
+     * Tools enable the model to call functions, search, execute code, etc.
      */
     tools?: LlmapiTool[];
     /**
-     * Controls which tool to use: "auto", "any", "none", "required", or a specific tool name.
+     * Controls which tool the model should use:
+     * - "auto": Model decides whether to use a tool (default)
+     * - "any": Model must use one of the provided tools
+     * - "none": Model cannot use any tools
+     * - "required": Model must use a tool
+     * - Specific tool name: Model must use that specific tool
      */
     toolChoice?: string;
     /**
      * Reasoning configuration for o-series and other reasoning models.
-     * Controls reasoning effort and summary output.
+     * Controls reasoning effort level and whether to include reasoning summary.
      */
     reasoning?: LlmapiResponseReasoning;
     /**
      * Extended thinking configuration for Anthropic models (Claude).
-     * Enables the model to think through complex problems step by step.
+     * Enables the model to think through complex problems step by step
+     * before generating the final response.
      */
     thinking?: LlmapiThinkingOptions;
     /**
      * Per-request callback for thinking/reasoning chunks.
      * Called with delta chunks as the model "thinks" through a problem.
+     * Use this to display thinking progress in the UI.
      */
     onThinking?: (chunk: string) => void;
 }
@@ -1003,8 +1086,10 @@ declare class Conversation extends Model {
  * Options for useChatStorage hook (Expo version)
  *
  * Uses the base options without React-specific features (no local chat, no tools).
+ * @inline
  */
-type UseChatStorageOptions = BaseUseChatStorageOptions;
+interface UseChatStorageOptions extends BaseUseChatStorageOptions {
+}
 /**
  * Arguments for sendMessage with storage (Expo version)
  *
@@ -1080,6 +1165,9 @@ interface UseChatStorageResult extends BaseUseChatStorageResult {
  */
 declare function useChatStorage(options: UseChatStorageOptions): UseChatStorageResult;
 
+/**
+ * @inline
+ */
 type UseImageGenerationOptions = {
     /**
      * Custom function to get auth token for API calls
@@ -1117,6 +1205,9 @@ type UseImageGenerationResult = {
  */
 declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
 
+/**
+ * @inline
+ */
 type UseModelsOptions = {
     /**
      * Custom function to get auth token for API calls
@@ -1176,8 +1267,10 @@ declare class Memory extends Model {
  * Options for useMemoryStorage hook (Expo version)
  *
  * Uses the base options.
+ * @inline
  */
-type UseMemoryStorageOptions = BaseUseMemoryStorageOptions;
+interface UseMemoryStorageOptions extends BaseUseMemoryStorageOptions {
+}
 /**
  * Result returned by useMemoryStorage hook (Expo version)
  *
@@ -1305,4 +1398,4 @@ declare const sdkMigrations: Readonly<{
  */
 declare const sdkModelClasses: Class<Model$1>[];
 
-export { Conversation as ChatConversation, Message as ChatMessage, type ChatRole, type CreateConversationOptions, type CreateMemoryOptions, type CreateMessageOptions, type FileMetadata, type MemoryItem, type MemoryType, type SearchSource, type SendMessageWithStorageArgs, type SendMessageWithStorageResult, type ChatCompletionUsage as StoredChatCompletionUsage, type StoredConversation, type StoredMemory, Memory as StoredMemoryModel, type StoredMemoryWithSimilarity, type StoredMessage, type StoredMessageWithSimilarity, type UpdateMemoryOptions, type UseChatStorageOptions, type UseChatStorageResult, type UseMemoryStorageOptions, type UseMemoryStorageResult, type UseModelsOptions, type UseModelsResult, chatStorageMigrations, chatStorageSchema, generateCompositeKey, generateConversationId, generateUniqueKey, memoryStorageSchema, sdkMigrations, sdkModelClasses, sdkSchema, useChat, useChatStorage, useImageGeneration, useMemoryStorage, useModels };
+export { Conversation as ChatConversation, Message as ChatMessage, type ChatRole, type CreateConversationOptions, type CreateMemoryOptions, type CreateMessageOptions, type FileMetadata, type MemoryItem, type MemoryType, type SearchSource, type SendMessageWithStorageArgs, type SendMessageWithStorageResult, type ChatCompletionUsage as StoredChatCompletionUsage, type StoredConversation, type StoredMemory, Memory as StoredMemoryModel, type StoredMemoryWithSimilarity, type StoredMessage, type StoredMessageWithSimilarity, type UpdateMemoryOptions, type UseChatStorageOptions, type UseChatStorageResult, type UseImageGenerationResult, type UseMemoryStorageOptions, type UseMemoryStorageResult, type UseModelsOptions, type UseModelsResult, chatStorageMigrations, chatStorageSchema, generateCompositeKey, generateConversationId, generateUniqueKey, memoryStorageSchema, sdkMigrations, sdkModelClasses, sdkSchema, useChat, useChatStorage, useImageGeneration, useMemoryStorage, useModels };