@erdoai/ui 0.1.25 → 0.1.28

package/README.md

@@ -11,7 +11,7 @@ npm install @erdoai/ui
 ### Peer Dependencies
 
 ```bash
-npm install react react-dom @tanstack/react-query
+npm install react react-dom
 ```
 
 ## Quick Start
@@ -22,22 +22,17 @@ npm install react react-dom @tanstack/react-query
 
 ```tsx
 import { ErdoProvider } from '@erdoai/ui';
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-
-const queryClient = new QueryClient();
 
 function App() {
   return (
-    <QueryClientProvider client={queryClient}>
-      <ErdoProvider
-        config={{
-          baseUrl: 'https://api.erdo.ai',
-          token: 'scoped-token', // Short-lived token from createToken()
-        }}
-      >
-        <YourApp />
-      </ErdoProvider>
-    </QueryClientProvider>
+    <ErdoProvider
+      config={{
+        baseUrl: 'https://api.erdo.ai',
+        token: 'scoped-token', // Short-lived token from createToken()
+      }}
+    >
+      <YourApp />
+    </ErdoProvider>
   );
 }
 ```
@@ -261,12 +256,14 @@ await sendMessage('Analyze our sales data');
 
 ### useDatasetContents
 
-Fetch dataset contents:
+Fetch dataset contents using plain React state (no React Query required):
 
 ```tsx
-const { data, isLoading, error } = useDatasetContents('dataset-slug', 'invocation-id');
+const { data, isLoading, error, refetch } = useDatasetContents('dataset-slug', 'invocation-id');
 ```
 
+The hook uses the `DataFetcher` from the provider if available, otherwise falls back to the REST API.
+
 ### useMultipleDatasetContents
 
 Fetch multiple datasets in parallel:
@@ -308,15 +305,35 @@ Scoped tokens are short-lived tokens created via `createToken()` for end users:
 
 ### Custom Data Fetcher
 
-For custom backends or when proxying through your server:
+Provide a custom `DataFetcher` to:
+
+- **Proxy requests** through your own backend (keeping API keys server-side)
+- **Add custom authentication** headers or logic
+- **Transform data** before it reaches components
+- **Use your own API** instead of Erdo's REST endpoints
 
 ```tsx
-const customFetcher = {
+import type { DataFetcher } from '@erdoai/ui';
+
+const customFetcher: DataFetcher = {
+  // Required: fetch dataset contents for charts/tables
   fetchDatasetContents: async (slug, invocationId) => {
-    // Fetch through your server which adds authentication
     const response = await fetch(`/api/datasets/${slug}?invocationId=${invocationId}`);
     return response.json();
   },
+
+  // Optional: get dataset details for download buttons
+  getDatasetDetails: async (slug, threadId) => {
+    const response = await fetch(`/api/datasets/${slug}/details?threadId=${threadId}`);
+    if (!response.ok) return null;
+    return response.json(); // { id: string, name: string }
+  },
+
+  // Optional: download dataset as file
+  downloadDataset: async (datasetId) => {
+    const response = await fetch(`/api/datasets/${datasetId}/download`);
+    return response.blob();
+  },
 };
 
 <ErdoProvider