@dodopayments/tanstack 0.1.1 → 0.1.3

package/README.md

@@ -27,18 +27,24 @@ All the examples below assume you're using Tanstack App Router.
 import { Checkout } from "@dodopayments/tanstack";
 import { createServerFileRoute } from "@tanstack/react-start/server";
 
-export const ServerRoute = createServerFileRoute("/api/checkout")
-  .methods({
-    GET: async ({ request }) => {
-      return Checkout({
-        bearerToken: process.env.DODO_PAYMENTS_API_KEY,
-        returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
-        environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
-        type: "static", // optional, defaults to 'static'
-      })(request)
-    }
-  })
-
+export const ServerRoute = createServerFileRoute("/api/checkout").methods({
+  GET: async ({ request }) => {
+    return Checkout({
+      bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+      returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+      environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+      type: "static", // optional, defaults to 'static'
+    })(request);
+  },
+  POST: async ({ request }) => {
+    return Checkout({
+      bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+      returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+      environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+      type: "session", // or "dynamic" for dynamic link
+    })(request);
+  },
+});
 ```
 
 ---
@@ -51,16 +57,16 @@ export const ServerRoute = createServerFileRoute("/api/checkout")
 import { CustomerPortal } from "@dodopayments/tanstack";
 import { createServerFileRoute } from "@tanstack/react-start/server";
 
-export const ServerRoute = createServerFileRoute('/api/customer-portal')
-  .methods({
-    GET: async ({ request }) => {
-      return CustomerPortal({
-        bearerToken: process.env.DODO_PAYMENTS_API_KEY,
-        environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
-      })(request)
-    }
-  })
-
+export const ServerRoute = createServerFileRoute(
+  "/api/customer-portal",
+).methods({
+  GET: async ({ request }) => {
+    return CustomerPortal({
+      bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+      environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    })(request);
+  },
+});
 ```
 
 #### Query Parameters
@@ -79,19 +85,17 @@ Returns 400 if `customer_id` is missing.
 import { Webhooks } from "@dodopayments/tanstack";
 import { createServerFileRoute } from "@tanstack/react-start/server";
 
-export const ServerRoute = createServerFileRoute('/api/webhook')
-  .methods({
-    POST: async ({ request }) => {
-      return Webhooks({
-        webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
-        onPayload: async (payload) => {
-            // Handle Payload here
-            console.log(payload)
-        }
-      })(request)
-    }
-  })
-
+export const ServerRoute = createServerFileRoute("/api/webhook").methods({
+  POST: async ({ request }) => {
+    return Webhooks({
+      webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
+      onPayload: async (payload) => {
+        // Handle Payload here
+        console.log(payload);
+      },
+    })(request);
+  },
+});
 ```
 
 ---
@@ -150,7 +154,7 @@ export const ServerRoute = createServerFileRoute("/api/checkout")
         bearerToken: process.env.DODO_PAYMENTS_API_KEY,
         returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
         environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
-        type: "dynamic", // for dynamic checkout
+        type: "session", // or "dynamic" for dynamic link
       })(request)
     }
   })
@@ -164,7 +168,7 @@ Configuration & Usage:
 
     environment: (Optional) Set to "test_mode" for testing, or omit/set to "live_mode" for production.
 
-    type: (Optional) Set to "static" for GET/static checkout, "dynamic" for POST/dynamic checkout. Defaults to "static".
+    type: (Optional) Set to "static" for GET/static checkout, "dynamic" for POST/dynamic checkout, or "session" for POST/checkout sessions.
 
 Static Checkout (GET) Query Parameters:
 
@@ -180,12 +184,23 @@ Static Checkout (GET) Query Parameters:
 
     Metadata (optional): Any query parameter starting with metadata_ (e.g., ?metadata_userId=abc123)
 
-Dynamic Checkout (POST): Parameters are sent as a JSON body. Supports both one-time and recurring payments. For a complete list of supported POST body fields, refer to:
+    Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}
+
+Dynamic Checkout (POST) - Returns JSON with checkout_url: Parameters are sent as a JSON body. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}. For a complete list of supported POST body fields, refer to:
+
+    Docs - One Time Payment Product: https://docs.dodopayments.com/api-reference/payments/post-payments
+
+    Docs - Subscription Product: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions
+
+Checkout Sessions (POST) - (Recommended) A more customizable checkout experience. Returns JSON with checkout_url: Parameters are sent as a JSON body. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://checkout.dodopayments.com/session/..."}. For a complete list of supported POST body fields, refer to:
 
     Docs - One Time Payment Product: https://docs.dodopayments.com/api-reference/payments/post-payments
 
     Docs - Subscription Product: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions
 
+  Required fields for checkout sessions:
+      product_cart (array): Array of products with product_id and quantity
+
 Error Handling: If productId is missing or other query parameters are invalid, the handler will return a 400 response.
 
 If Customer Portal Route Handler is selected:
@@ -225,7 +240,6 @@ File Creation: Create a new file at app/api/webhook/dodo-payments/route.ts in yo
 Code Snippet:
 
 // src/routes/api/webhook.ts
-// routes/api/checkout.ts
 import { Webhooks } from "@dodopayments/tanstack";
 import { createServerFileRoute } from "@tanstack/react-start/server";
 
@@ -322,7 +336,7 @@ Example .env file:
 DODO_PAYMENTS_API_KEY=your-api-key
 DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
 DODO_PAYMENTS_RETURN_URL=your-return-url
-DODO_PAYMENTS_ENVIRONMENT="test" or "live"
+DODO_PAYMENTS_ENVIRONMENT="test_mode" or "live_mode"
 
 Usage in your code:
 

package/dist/checkout/checkout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkout.d.ts","sourceRoot":"","sources":["../../src/checkout/checkout.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,qBAAqB,EAGtB,MAAM,6BAA6B,CAAC;AAErC;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,IAC7B,SAAS,OAAO,8CAwDxC"}
+{"version":3,"file":"checkout.d.ts","sourceRoot":"","sources":["../../src/checkout/checkout.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,qBAAqB,EAItB,MAAM,6BAA6B,CAAC;AAErC;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,IAC7B,SAAS,OAAO,8CAyFxC"}