@domu-ai/kiban-sdk 1.146.0 → 1.146.1

package/README.md

@@ -1,6 +1,6 @@
 # @domu-ai/kiban-sdk
 
-Generated TypeScript SDK for Kiban APIs.
+Generated TypeScript SDK for Kiban APIs with TanStack Query hooks.
 
 ## Installation
 
@@ -8,28 +8,51 @@ Generated TypeScript SDK for Kiban APIs.
 npm install @domu-ai/kiban-sdk
 ```
 
-## Usage
+TanStack Query is an optional peer dependency. Install it if you want to use the generated hooks:
+
+```bash
+npm install @tanstack/react-query
+```
+
+## Setup
 
 ```ts
-import { getSuccessData, setApiBaseUrl, setAuthToken } from "@domu-ai/kiban-sdk";
-import { publicAuthMeGet } from "@domu-ai/kiban-sdk/public";
-import { dashboardCampaignsGet } from "@domu-ai/kiban-sdk/dashboard";
+import { setApiBaseUrl, setAuthToken } from "@domu-ai/kiban-sdk";
 
 setApiBaseUrl("https://kiban.domu.ai");
 setAuthToken(() => myToken);
+```
+
+## React Query Hooks
+
+```tsx
+import { useDashboardCampaignsGet } from "@domu-ai/kiban-sdk/dashboard";
+
+function CampaignList() {
+  const { data, isLoading } = useDashboardCampaignsGet();
+  if (isLoading) return <p>Loading...</p>;
+  if (data?.status === 200) return <ul>{/* render data.data.data */}</ul>;
+}
+```
+
+## Plain Fetch Functions
+
+```ts
+import { getSuccessData } from "@domu-ai/kiban-sdk";
+import { publicAuthMeGet } from "@domu-ai/kiban-sdk/public";
+import { dashboardCampaignsGet } from "@domu-ai/kiban-sdk/dashboard";
 
 const me = getSuccessData(await publicAuthMeGet(), "Get authenticated user");
 const campaigns = getSuccessData(
   await dashboardCampaignsGet(),
   "List dashboard campaigns",
 );
-
-console.log(me);
-console.log(campaigns.data);
 ```
 
-Additional entrypoints:
+## Entrypoints
 
-- `@domu-ai/kiban-sdk/public`
-- `@domu-ai/kiban-sdk/internal`
-- `@domu-ai/kiban-sdk/dashboard`
+- `@domu-ai/kiban-sdk` — public API (default) + utilities
+- `@domu-ai/kiban-sdk/public` — public API
+- `@domu-ai/kiban-sdk/internal` — internal API
+- `@domu-ai/kiban-sdk/dashboard` — dashboard API
+- `@domu-ai/kiban-sdk/fetcher` — fetcher utilities