@reverbia/sdk 1.0.0-next.20251212012743 → 1.0.0-next.20251212092701

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -379,6 +379,8 @@ type UseChatResult = BaseUseChatResult & {
379
379
  * - `sendMessage`: An async function to send chat messages
380
380
  * - `stop`: A function to abort the current request
381
381
  *
382
+ * @category Hooks
383
+ *
382
384
  * @example
383
385
  * ```tsx
384
386
  * const { isLoading, sendMessage, stop } = useChat({
@@ -430,6 +432,7 @@ type UseImageGenerationResult = {
430
432
  };
431
433
  /**
432
434
  * React hook for generating images using the LLM API.
435
+ * @category Hooks
433
436
  */
434
437
  declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
435
438
 
@@ -460,6 +463,7 @@ type UseModelsResult = {
460
463
  /**
461
464
  * React hook for fetching available LLM models.
462
465
  * Automatically fetches all available models.
466
+ * @category Hooks
463
467
  */
464
468
  declare function useModels(options?: UseModelsOptions): UseModelsResult;
465
469
 
@@ -379,6 +379,8 @@ type UseChatResult = BaseUseChatResult & {
379
379
  * - `sendMessage`: An async function to send chat messages
380
380
  * - `stop`: A function to abort the current request
381
381
  *
382
+ * @category Hooks
383
+ *
382
384
  * @example
383
385
  * ```tsx
384
386
  * const { isLoading, sendMessage, stop } = useChat({
@@ -430,6 +432,7 @@ type UseImageGenerationResult = {
430
432
  };
431
433
  /**
432
434
  * React hook for generating images using the LLM API.
435
+ * @category Hooks
433
436
  */
434
437
  declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
435
438
 
@@ -460,6 +463,7 @@ type UseModelsResult = {
460
463
  /**
461
464
  * React hook for fetching available LLM models.
462
465
  * Automatically fetches all available models.
466
+ * @category Hooks
463
467
  */
464
468
  declare function useModels(options?: UseModelsOptions): UseModelsResult;
465
469
 
@@ -15,6 +15,8 @@
15
15
  *
16
16
  * export default withReverbia(nextConfig);
17
17
  * ```
18
+ *
19
+ * @module
18
20
  */
19
21
  declare const withReverbia: (nextConfig?: any) => any;
20
22
 
@@ -15,6 +15,8 @@
15
15
  *
16
16
  * export default withReverbia(nextConfig);
17
17
  * ```
18
+ *
19
+ * @module
18
20
  */
19
21
  declare const withReverbia: (nextConfig?: any) => any;
20
22
 
@@ -524,6 +524,8 @@ type UseChatResult = BaseUseChatResult & {
524
524
  * @param options.toolSelectorModel - The model to use for tool selection.
525
525
  * @param options.onToolExecution - Callback function to be called when a tool is executed.
526
526
  *
527
+ * @category Hooks
528
+ *
527
529
  * @returns An object containing:
528
530
  * - `isLoading`: A boolean indicating whether a request is currently in progress
529
531
  * - `isSelectingTool`: A boolean indicating whether tool selection is in progress
@@ -612,6 +614,7 @@ declare function requestEncryptionKey(walletAddress: string, signMessage: SignMe
612
614
  * Hook that provides on-demand encryption key management.
613
615
  * @param signMessage - Function to sign a message (from Privy's useSignMessage)
614
616
  * @returns Functions to request encryption keys
617
+ * @category Hooks
615
618
  */
616
619
  declare function useEncryption(signMessage: SignMessageFn): {
617
620
  requestEncryptionKey: (walletAddress: string) => Promise<void>;
@@ -749,6 +752,7 @@ type UseMemoryResult = {
749
752
  /**
750
753
  * Standalone hook for extracting memories from user messages.
751
754
  * Can be composed with other hooks like useChat, useFiles, etc.
755
+ * @category Hooks
752
756
  */
753
757
  declare function useMemory(options?: UseMemoryOptions): UseMemoryResult;
754
758
 
@@ -757,6 +761,10 @@ interface PdfFile {
757
761
  mediaType?: string;
758
762
  filename?: string;
759
763
  }
764
+ /**
765
+ * React hook for extracting text from PDF files.
766
+ * @category Hooks
767
+ */
760
768
  declare function usePdf(): {
761
769
  extractPdfContext: (files: PdfFile[]) => Promise<string | null>;
762
770
  isProcessing: boolean;
@@ -768,6 +776,10 @@ interface OCRFile {
768
776
  filename?: string;
769
777
  language?: string;
770
778
  }
779
+ /**
780
+ * React hook for extracting text from images using OCR.
781
+ * @category Hooks
782
+ */
771
783
  declare function useOCR(): {
772
784
  extractOCRContext: (files: OCRFile[]) => Promise<string | null>;
773
785
  isProcessing: boolean;
@@ -801,6 +813,7 @@ type UseModelsResult = {
801
813
  /**
802
814
  * React hook for fetching available LLM models.
803
815
  * Automatically fetches all available models.
816
+ * @category Hooks
804
817
  */
805
818
  declare function useModels(options?: UseModelsOptions): UseModelsResult;
806
819
 
@@ -852,6 +865,7 @@ type UseSearchResult = {
852
865
  *
853
866
  * @param options - Configuration options for the search hook
854
867
  * @returns Object containing search function, results, loading state, and error
868
+ * @category Hooks
855
869
  *
856
870
  * @example
857
871
  * ```tsx
@@ -899,6 +913,7 @@ type UseImageGenerationResult = {
899
913
  };
900
914
  /**
901
915
  * React hook for generating images using the LLM API.
916
+ * @category Hooks
902
917
  */
903
918
  declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
904
919
 
@@ -524,6 +524,8 @@ type UseChatResult = BaseUseChatResult & {
524
524
  * @param options.toolSelectorModel - The model to use for tool selection.
525
525
  * @param options.onToolExecution - Callback function to be called when a tool is executed.
526
526
  *
527
+ * @category Hooks
528
+ *
527
529
  * @returns An object containing:
528
530
  * - `isLoading`: A boolean indicating whether a request is currently in progress
529
531
  * - `isSelectingTool`: A boolean indicating whether tool selection is in progress
@@ -612,6 +614,7 @@ declare function requestEncryptionKey(walletAddress: string, signMessage: SignMe
612
614
  * Hook that provides on-demand encryption key management.
613
615
  * @param signMessage - Function to sign a message (from Privy's useSignMessage)
614
616
  * @returns Functions to request encryption keys
617
+ * @category Hooks
615
618
  */
616
619
  declare function useEncryption(signMessage: SignMessageFn): {
617
620
  requestEncryptionKey: (walletAddress: string) => Promise<void>;
@@ -749,6 +752,7 @@ type UseMemoryResult = {
749
752
  /**
750
753
  * Standalone hook for extracting memories from user messages.
751
754
  * Can be composed with other hooks like useChat, useFiles, etc.
755
+ * @category Hooks
752
756
  */
753
757
  declare function useMemory(options?: UseMemoryOptions): UseMemoryResult;
754
758
 
@@ -757,6 +761,10 @@ interface PdfFile {
757
761
  mediaType?: string;
758
762
  filename?: string;
759
763
  }
764
+ /**
765
+ * React hook for extracting text from PDF files.
766
+ * @category Hooks
767
+ */
760
768
  declare function usePdf(): {
761
769
  extractPdfContext: (files: PdfFile[]) => Promise<string | null>;
762
770
  isProcessing: boolean;
@@ -768,6 +776,10 @@ interface OCRFile {
768
776
  filename?: string;
769
777
  language?: string;
770
778
  }
779
+ /**
780
+ * React hook for extracting text from images using OCR.
781
+ * @category Hooks
782
+ */
771
783
  declare function useOCR(): {
772
784
  extractOCRContext: (files: OCRFile[]) => Promise<string | null>;
773
785
  isProcessing: boolean;
@@ -801,6 +813,7 @@ type UseModelsResult = {
801
813
  /**
802
814
  * React hook for fetching available LLM models.
803
815
  * Automatically fetches all available models.
816
+ * @category Hooks
804
817
  */
805
818
  declare function useModels(options?: UseModelsOptions): UseModelsResult;
806
819
 
@@ -852,6 +865,7 @@ type UseSearchResult = {
852
865
  *
853
866
  * @param options - Configuration options for the search hook
854
867
  * @returns Object containing search function, results, loading state, and error
868
+ * @category Hooks
855
869
  *
856
870
  * @example
857
871
  * ```tsx
@@ -899,6 +913,7 @@ type UseImageGenerationResult = {
899
913
  };
900
914
  /**
901
915
  * React hook for generating images using the LLM API.
916
+ * @category Hooks
902
917
  */
903
918
  declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
904
919
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reverbia/sdk",
3
- "version": "1.0.0-next.20251212012743",
3
+ "version": "1.0.0-next.20251212092701",
4
4
  "description": "",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",
@@ -56,7 +56,7 @@
56
56
  "test": "vitest run",
57
57
  "build": "tsup",
58
58
  "prepublishOnly": "pnpm build",
59
- "docs": "typedoc src/client/index.ts",
59
+ "docs": "typedoc",
60
60
  "generate": "pnpm run spec && pnpm run docs"
61
61
  },
62
62
  "repository": {