@closeloop/sdk 0.1.6 → 0.1.8

package/README.md

@@ -28,7 +28,7 @@ const client = new CloseLoop({
 // Verify credits before processing
 const verification = await client.credits.verify({
   walletAddress: "0x1234...",
-  planId: "plan_abc123",
+  productId: "prod_01",
   amount: 1
 })
 
@@ -38,7 +38,7 @@ if (verification.hasEnoughCredits) {
   // Consume the credit
   await client.credits.consume({
     walletAddress: "0x1234...",
-    planId: "plan_abc123",
+    productId: "prod_01",
     amount: 1,
     consumedBy: "my-service"
   })
@@ -51,7 +51,6 @@ if (verification.hasEnoughCredits) {
 - ⚡ **Fast** - Lightweight with minimal dependencies
 - 🔄 **Atomic operations** - Verify and consume in one call
 - 🪝 **Webhook support** - Secure signature verification with schema validation
-- 📦 **Framework helpers** - Next.js middleware with rate limiting docs
 - ✅ **Validated** - All inputs validated with Zod schemas
 
 ## API Reference
@@ -65,12 +64,12 @@ Check if a user has enough credits without consuming them:
 ```typescript
 const result = await client.credits.verify({
   walletAddress: "0x...",
-  planId: "plan_id",
+  productId: "prod_id",
   amount: 10
 })
 
-console.log(result.hasEnoughCredits) // true
-console.log(result.remainingCredits) // 100
+console.log(result.hasEnough) // true
+console.log(result.totalRemaining) // 100
 console.log(result.expiresAt) // "2024-12-31T23:59:59Z" or null
 ```
 
@@ -81,7 +80,7 @@ Deduct credits from a user's balance:
 ```typescript
 const result = await client.credits.consume({
   walletAddress: "0x...",
-  planId: "plan_id",
+  productId: "prod_id",
   amount: 1,
   consumedBy: "ai-generation", // Optional: track what used the credits
   metadata: { requestId: "req_123" }, // Optional: attach metadata
@@ -89,7 +88,7 @@ const result = await client.credits.consume({
 })
 
 console.log(result.success) // true
-console.log(result.remainingCredits) // 99
+console.log(result.totalRemaining) // 99
 console.log(result.transactionId) // "tx_abc123"
 ```
 
@@ -103,7 +102,7 @@ import { InsufficientCreditsError, CreditsExpiredError } from "@closeloop/sdk"
 try {
   const result = await client.credits.verifyAndConsume({
     walletAddress: "0x...",
-    planId: "plan_id",
+    productId: "prod_id",
     amount: 5,
     consumedBy: "batch-processing"
   })
@@ -117,22 +116,6 @@ try {
 }
 ```
 
-#### Batch Consume
-
-Consume credits for multiple users in one request:
-
-```typescript
-const result = await client.credits.batchConsume({
-  operations: [
-    { walletAddress: "0x1234...", planId: "plan_a", amount: 1 },
-    { walletAddress: "0x5678...", planId: "plan_b", amount: 2 }
-  ],
-  atomic: false // Allow partial success
-})
-
-console.log(`Success: ${result.successCount}, Failed: ${result.failedCount}`)
-```
-
 ### Balance Queries
 
 #### Get Specific Balance
@@ -140,7 +123,7 @@ console.log(`Success: ${result.successCount}, Failed: ${result.failedCount}`)
 ```typescript
 const balance = await client.balances.get({
   walletAddress: "0x...",
-  planId: "plan_id"
+  productId: "prod_id"
 })
 
 if (balance) {
@@ -159,8 +142,9 @@ const { balances, nextCursor, totalCount } = await client.balances.list({
   limit: 10
 })
 
+
 for (const balance of balances) {
-  console.log(`${balance.planName}: ${balance.remainingCredits} credits`)
+  console.log(`${balance.productName}: ${balance.remainingCredits} credits`)
 }
 
 // Paginate
@@ -189,12 +173,14 @@ for (const tx of transactions) {
 #### Get Aggregated Stats
 
 ```typescript
-const stats = await client.balances.stats("0x...")
+const stats = await client.balances.stats({
+  walletAddress: "0x...",
+  productId: "prod_id"
+})
 
 console.log(`Total: ${stats.totalCredits}`)
 console.log(`Used: ${stats.totalUsed}`)
 console.log(`Remaining: ${stats.totalRemaining}`)
-console.log(`Active Balances: ${stats.activeBalances}`)
 ```
 
 ### Webhook Verification
@@ -213,8 +199,8 @@ app.post("/webhook", (req, res) => {
 
     // Type-safe event handling
     if (client.webhooks.isPaymentSuccess(event)) {
-      const { type, walletAddress, planId, amount } = event.data
-      console.log(`${walletAddress} purchased plan ${planId} for $${amount} (${type})`)
+      const { type, walletAddress, productId, amount } = event.data
+      console.log(`${walletAddress} purchased plan ${productId} for $${amount} (${type})`)
     }
 
     if (client.webhooks.isCreditsLow(event)) {
@@ -234,134 +220,6 @@ app.post("/webhook", (req, res) => {
 })
 ```
 
-```typescript
-// Next.js App Router
-export async function POST(request: Request) {
-  const payload = await request.text()
-  const signature = request.headers.get("x-closeloop-signature")!
-
-  try {
-    const event = client.webhooks.verify({
-      payload,
-      signature,
-      secret: process.env.WEBHOOK_SECRET!
-    })
-
-    // Handle event...
-    return Response.json({ received: true })
-  } catch {
-    return Response.json({ error: "Invalid signature" }, { status: 400 })
-  }
-}
-```
-
-## Next.js Integration
-
-### Proxy (Next.js 16+)
-
-Protect routes by verifying credits:
-
-```typescript
-// proxy.ts (Next.js 16+)
-import { NextRequest, NextResponse } from "next/server"
-import { CloseLoop } from "@closeloop/sdk"
-
-const client = new CloseLoop({ apiKey: process.env.CLOSELOOP_API_KEY! })
-
-// Define routes that require credit verification
-const creditProtectedRoutes = ["/api/ai", "/api/generate"]
-
-export default async function proxy(req: NextRequest) {
-  const path = req.nextUrl.pathname
-  const isCreditProtectedRoute = creditProtectedRoutes.some(route => 
-    path.startsWith(route)
-  )
-
-  if (!isCreditProtectedRoute) {
-    return NextResponse.next()
-  }
-
-  // Get wallet address from header or session
-  const walletAddress = req.headers.get("x-wallet-address")
-
-  if (!walletAddress) {
-    return NextResponse.json(
-      { error: "Wallet address required" },
-      { status: 401 }
-    )
-  }
-
-  // Verify credits before allowing the request
-  const verification = await client.credits.verify({
-    walletAddress,
-    planId: "plan_abc123",
-    amount: 1
-  })
-
-  if (!verification.hasEnoughCredits) {
-    return NextResponse.json(
-      { error: "Insufficient credits" },
-      { status: 402 }
-    )
-  }
-
-  return NextResponse.next()
-}
-
-export const config = {
-  matcher: ["/((?!_next/static|_next/image|.*\\.png$).*)"]
-}
-```
-
-### Route Handler
-
-Verify and consume credits atomically in API routes:
-
-```typescript
-// app/api/ai/route.ts (Next.js 16+)
-import { NextRequest, NextResponse } from "next/server"
-import { CloseLoop, InsufficientCreditsError } from "@closeloop/sdk"
-
-const client = new CloseLoop({ apiKey: process.env.CLOSELOOP_API_KEY! })
-
-export async function POST(request: NextRequest) {
-  const wallet = request.headers.get("x-wallet-address")
-  
-  if (!wallet) {
-    return NextResponse.json(
-      { error: "Wallet address required" },
-      { status: 401 }
-    )
-  }
-  
-  // Verify and consume credits atomically
-  try {
-    const result = await client.credits.verifyAndConsume({
-      walletAddress: wallet,
-      planId: "plan_abc123",
-      amount: 1,
-      consumedBy: "ai-text-generation"
-    })
-    
-    // Process request after credit verification
-    const aiResult = await processAIRequest()
-    
-    return NextResponse.json({
-      ...aiResult,
-      remainingCredits: result.remainingCredits
-    })
-  } catch (error) {
-    if (error instanceof InsufficientCreditsError) {
-      return NextResponse.json(
-        { error: "Insufficient credits", remaining: error.remainingCredits },
-        { status: 402 }
-      )
-    }
-    throw error
-  }
-}
-```
-
 ## Error Handling
 
 All errors extend `CloseLoopError`:
@@ -416,81 +274,10 @@ try {
 All inputs are validated using Zod schemas before being sent to the API:
 
 - **Wallet addresses**: Must be valid Ethereum addresses (`0x` + 40 hex chars)
-- **Plan IDs**: Non-empty strings with max 100 characters
+- **Product IDs**: Non-empty strings with max 100 characters
 - **Credit amounts**: Positive integers up to 1 billion
 - **Metadata**: Sanitized to prevent prototype pollution attacks
 
-### Rate Limiting
-
-The proxy does **not** include rate limiting. We strongly recommend combining it with a rate limiter:
-
-```typescript
-// proxy.ts - With rate limiting (RECOMMENDED)
-import { NextRequest, NextResponse } from "next/server"
-import { CloseLoop } from "@closeloop/sdk"
-import { Ratelimit } from "@upstash/ratelimit"
-import { Redis } from "@upstash/redis"
-
-const client = new CloseLoop({ apiKey: process.env.CLOSELOOP_API_KEY! })
-
-const ratelimit = new Ratelimit({
-  redis: Redis.fromEnv(),
-  limiter: Ratelimit.slidingWindow(10, "10 s"),
-})
-
-const creditProtectedRoutes = ["/api/ai", "/api/generate"]
-
-export default async function proxy(request: NextRequest) {
-  const path = request.nextUrl.pathname
-  const isCreditProtectedRoute = creditProtectedRoutes.some(route =>
-    path.startsWith(route)
-  )
-
-  if (!isCreditProtectedRoute) {
-    return NextResponse.next()
-  }
-
-  // Rate limit by IP first
-  const ip = request.headers.get("x-forwarded-for") ?? "127.0.0.1"
-  const { success } = await ratelimit.limit(ip)
-
-  if (!success) {
-    return NextResponse.json(
-      { error: "Rate limit exceeded" },
-      { status: 429 }
-    )
-  }
-
-  // Then verify credits
-  const walletAddress = request.headers.get("x-wallet-address")
-  if (!walletAddress) {
-    return NextResponse.json(
-      { error: "Wallet address required" },
-      { status: 401 }
-    )
-  }
-
-  const verification = await client.credits.verify({
-    walletAddress,
-    planId: "plan_abc123",
-    amount: 1
-  })
-
-  if (!verification.hasEnoughCredits) {
-    return NextResponse.json(
-      { error: "Insufficient credits" },
-      { status: 402 }
-    )
-  }
-
-  return NextResponse.next()
-}
-
-export const config = {
-  matcher: ["/((?!_next/static|_next/image|.*\\.png$).*)"]
-}
-```
-
 ### Webhook Security
 
 - HMAC-SHA256 signatures with timing-safe comparison
@@ -511,8 +298,6 @@ import type {
   VerifyCreditsResponse,
   ConsumeCreditsParams,
   ConsumeCreditsResponse,
-  BatchConsumeParams,
-  BatchConsumeResponse,
   
   // Balances
   CreditBalance,
@@ -553,7 +338,6 @@ const client = new CloseLoop({
 ## Requirements
 
 - Node.js 18.0.0 or higher
-- Next.js 14.0.0 or higher (for Next.js helpers)
 
 ## License