@botsrated/ai-sdk 0.1.0 → 0.1.2

package/README.md

@@ -3,32 +3,49 @@
 [AI SDK](https://ai-sdk.dev) tools for [BotsRated](https://botsrated.com) (beta). Use them as a
 pre-payment check before an agent pays an x402 seller.
 
-**Status: prepared, not yet published to npm.** It depends on `@botsrated/x402-preflight` (`../x402-client`),
-which is also unpublished.
+**Status: published on npm as [`@botsrated/ai-sdk`](https://www.npmjs.com/package/@botsrated/ai-sdk) (0.1.2).** It depends on
+[`@botsrated/x402-preflight`](https://www.npmjs.com/package/@botsrated/x402-preflight) `^0.1.2`. Docs: https://botsrated.com/docs/ai-sdk
+
+```bash
+npm install @botsrated/ai-sdk ai zod
+```
 
 ```ts
-import { generateText, isStepCount } from "ai";
+import { generateText, stepCountIs } from "ai";
 import { botsratedTools } from "@botsrated/ai-sdk";
 
 const { text } = await generateText({
   model: "openai/gpt-5-mini",
   prompt: "Before paying https://blockrun.ai/api/v1/chat/completions (payTo 0xe903...1aBf), check it.",
   tools: botsratedTools(),            // { botsratedPreflight } – free
-  stopWhen: isStepCount(3),
+  stopWhen: stepCountIs(3),          // AI SDK 7 also exports isStepCount(3)
 });
 ```
 
+`botsratedTools()` returns the AI SDK's `ToolSet` type, so it type-checks as `tools:` (or spread into one) under
+strict TypeScript on AI SDK 5, 6 and 7 (0.1.1 did not on AI SDK 7; fixed in 0.1.2). The single tools are also
+exported as `botsratedPreflight(client)` and `botsratedCheck(client)`. `stepCountIs` works on AI SDK 5, 6 and 7. `isStepCount` is the AI SDK 7 name (AI SDK 7 needs Node 22+).
+
 Opt-in paid check, capped by a budget:
 
 ```ts
-import { x402Client, wrapFetchWithPayment } from "@x402/fetch";
+import { x402Client } from "@x402/core/client";
+import { registerExactEvmScheme } from "@x402/evm/exact/client";
 import { BotsRatedClient, botsratedTools } from "@botsrated/ai-sdk";
 
-const client = new BotsRatedClient({ paid: { budgetUsd: 0.02, fetchWithPayment: wrapFetchWithPayment(fetch, x402) } });
+const x402 = new x402Client();
+registerExactEvmScheme(x402, { signer }); // your signer, e.g. a viem account
+const client = new BotsRatedClient({ paid: { budgetUsd: 0.02, x402Client: x402 } });
 const tools = botsratedTools(client); // { botsratedPreflight, botsratedCheck ($0.001 each after 100 free/day, stops at $0.02) }
 ```
 
+The client validates BotsRated's 402 and signs only a copy rebuilt from allowlisted fields: a one-shot
+EIP-3009 USDC payment on Base to BotsRated's payTo at the published price. A quote asking for Permit2
+(`extra.assetTransferMethod`), carrying payment extensions such as `erc20ApprovalGasSponsoring`, or a
+`maxTimeoutSeconds` above 600 is refused before anything is signed.
+
 To guard every x402 payment, not only those the model calls a tool for, register
 `createPrePaymentGuard().beforePaymentCreation` from `@botsrated/x402-preflight` on your `x402Client`.
 
-Tests: `npm test`. They include a `generateText` run with `MockLanguageModelV3`.
+Tests: `npm test` (includes a `generateText` run with `MockLanguageModelV3`) and `npm run typecheck`
+(compiles the tools-registry usage example under strict TypeScript).