@reverbia/sdk 1.0.0-next.20251124100226 → 1.0.0-next.20251125084024

package/dist/react/index.d.mts

@@ -81,6 +81,13 @@ type LlmapiRole = string;
 type SendMessageArgs = {
     messages: LlmapiMessage[];
     model: string;
+    /**
+     * Per-request callback for data chunks. Called in addition to the global
+     * `onData` callback if provided in `useChat` options.
+     *
+     * @param chunk - The content delta from the current chunk
+     */
+    onData?: (chunk: string) => void;
 };
 type SendMessageResult = {
     data: LlmapiChatCompletionResponse;
@@ -91,32 +98,72 @@ type SendMessageResult = {
 };
 type UseChatOptions = {
     getToken?: () => Promise<string | null>;
+    /**
+     * Callback function to be called when a new data chunk is received.
+     */
+    onData?: (chunk: string) => void;
+    /**
+     * Callback function to be called when the chat completion finishes successfully.
+     */
+    onFinish?: (response: LlmapiChatCompletionResponse) => void;
+    /**
+     * Callback function to be called when an unexpected error is encountered.
+     *
+     * **Note:** This callback is NOT called for aborted requests (via `stop()` or
+     * component unmount). Aborts are intentional actions and are not considered
+     * errors. To detect aborts, check the `error` field in the `sendMessage` result:
+     * `result.error === "Request aborted"`.
+     *
+     * @param error - The error that occurred (never an AbortError)
+     */
+    onError?: (error: Error) => void;
 };
 type UseChatResult = {
     isLoading: boolean;
     sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
+    /**
+     * Aborts the current streaming request if one is in progress.
+     *
+     * When a request is aborted, `sendMessage` will return with
+     * `{ data: null, error: "Request aborted" }`. The `onError` callback
+     * will NOT be called, as aborts are intentional actions, not errors.
+     */
+    stop: () => void;
 };
 /**
  * A React hook for managing chat completions with authentication.
  *
  * This hook provides a convenient way to send chat messages to the LLM API
  * with automatic token management and loading state handling.
+ * Streaming is enabled by default for better user experience.
  *
  * @param options - Optional configuration object
  * @param options.getToken - An async function that returns an authentication token.
  *   This token will be used as a Bearer token in the Authorization header.
  *   If not provided, `sendMessage` will return an error.
+ * @param options.onData - Callback function to be called when a new data chunk is received.
+ * @param options.onFinish - Callback function to be called when the chat completion finishes successfully.
+ * @param options.onError - Callback function to be called when an unexpected error
+ *   is encountered. Note: This is NOT called for aborted requests (see `stop()`).
  *
  * @returns An object containing:
  *   - `isLoading`: A boolean indicating whether a request is currently in progress
  *   - `sendMessage`: An async function to send chat messages
+ *   - `stop`: A function to abort the current request
  *
  * @example
  * ```tsx
- * const { isLoading, sendMessage } = useChat({
+ * const { isLoading, sendMessage, stop } = useChat({
  *   getToken: async () => {
  *     // Get your auth token from your auth provider
  *     return await getAuthToken();
+ *   },
+ *   onFinish: (response) => {
+ *     console.log("Chat finished:", response);
+ *   },
+ *   onError: (error) => {
+ *     // This is only called for unexpected errors, not aborts
+ *     console.error("Chat error:", error);
  *   }
  * });
  *
@@ -127,11 +174,18 @@ type UseChatResult = {
  *   });
  *
  *   if (result.error) {
- *     console.error(result.error);
+ *     if (result.error === "Request aborted") {
+ *       console.log("Request was aborted");
+ *     } else {
+ *       console.error("Error:", result.error);
+ *     }
  *   } else {
- *     console.log(result.data);
+ *     console.log("Success:", result.data);
  *   }
  * };
+ *
+ * // To stop generation:
+ * // stop();
  * ```
  */
 declare function useChat(options?: UseChatOptions): UseChatResult;

package/dist/react/index.d.ts

@@ -81,6 +81,13 @@ type LlmapiRole = string;
 type SendMessageArgs = {
     messages: LlmapiMessage[];
     model: string;
+    /**
+     * Per-request callback for data chunks. Called in addition to the global
+     * `onData` callback if provided in `useChat` options.
+     *
+     * @param chunk - The content delta from the current chunk
+     */
+    onData?: (chunk: string) => void;
 };
 type SendMessageResult = {
     data: LlmapiChatCompletionResponse;
@@ -91,32 +98,72 @@ type SendMessageResult = {
 };
 type UseChatOptions = {
     getToken?: () => Promise<string | null>;
+    /**
+     * Callback function to be called when a new data chunk is received.
+     */
+    onData?: (chunk: string) => void;
+    /**
+     * Callback function to be called when the chat completion finishes successfully.
+     */
+    onFinish?: (response: LlmapiChatCompletionResponse) => void;
+    /**
+     * Callback function to be called when an unexpected error is encountered.
+     *
+     * **Note:** This callback is NOT called for aborted requests (via `stop()` or
+     * component unmount). Aborts are intentional actions and are not considered
+     * errors. To detect aborts, check the `error` field in the `sendMessage` result:
+     * `result.error === "Request aborted"`.
+     *
+     * @param error - The error that occurred (never an AbortError)
+     */
+    onError?: (error: Error) => void;
 };
 type UseChatResult = {
     isLoading: boolean;
     sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
+    /**
+     * Aborts the current streaming request if one is in progress.
+     *
+     * When a request is aborted, `sendMessage` will return with
+     * `{ data: null, error: "Request aborted" }`. The `onError` callback
+     * will NOT be called, as aborts are intentional actions, not errors.
+     */
+    stop: () => void;
 };
 /**
  * A React hook for managing chat completions with authentication.
  *
  * This hook provides a convenient way to send chat messages to the LLM API
  * with automatic token management and loading state handling.
+ * Streaming is enabled by default for better user experience.
  *
  * @param options - Optional configuration object
  * @param options.getToken - An async function that returns an authentication token.
  *   This token will be used as a Bearer token in the Authorization header.
  *   If not provided, `sendMessage` will return an error.
+ * @param options.onData - Callback function to be called when a new data chunk is received.
+ * @param options.onFinish - Callback function to be called when the chat completion finishes successfully.
+ * @param options.onError - Callback function to be called when an unexpected error
+ *   is encountered. Note: This is NOT called for aborted requests (see `stop()`).
  *
  * @returns An object containing:
  *   - `isLoading`: A boolean indicating whether a request is currently in progress
  *   - `sendMessage`: An async function to send chat messages
+ *   - `stop`: A function to abort the current request
  *
  * @example
  * ```tsx
- * const { isLoading, sendMessage } = useChat({
+ * const { isLoading, sendMessage, stop } = useChat({
  *   getToken: async () => {
  *     // Get your auth token from your auth provider
  *     return await getAuthToken();
+ *   },
+ *   onFinish: (response) => {
+ *     console.log("Chat finished:", response);
+ *   },
+ *   onError: (error) => {
+ *     // This is only called for unexpected errors, not aborts
+ *     console.error("Chat error:", error);
  *   }
  * });
  *
@@ -127,11 +174,18 @@ type UseChatResult = {
  *   });
  *
  *   if (result.error) {
- *     console.error(result.error);
+ *     if (result.error === "Request aborted") {
+ *       console.log("Request was aborted");
+ *     } else {
+ *       console.error("Error:", result.error);
+ *     }
  *   } else {
- *     console.log(result.data);
+ *     console.log("Success:", result.data);
  *   }
  * };
+ *
+ * // To stop generation:
+ * // stop();
  * ```
  */
 declare function useChat(options?: UseChatOptions): UseChatResult;