@dodopayments/fastify 0.1.1 → 0.1.3

package/README.md

@@ -18,21 +18,38 @@ npm install @dodopayments/fastify
 
 ## Quick Start
 
-
 ### 1. Checkout
 
 ```typescript
-import { Checkout } from '@dodopayments/fastify';
+// route.ts
+import { Checkout } from "@dodopayments/fastify";
+import Fastify from "fastify";
 
-const fastify = Fastify({})
+const fastify = Fastify({});
 const checkoutGet = Checkout({
-    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
-    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
-    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
-    type: 'static'
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+  type: "static",
 });
 
-fastify.get('/api/checkout', checkoutGet.getHandler);
+const checkoutPost = Checkout({
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+  type: "dynamic",
+});
+
+const checkoutSession = Checkout({
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+  type: "session",
+});
+
+fastify.get("/api/checkout", checkoutGet.getHandler);
+fastify.post("/api/checkout", checkoutPost.postHandler);
+fastify.post("/api/checkout-session", checkoutSession.postHandler);
 ```
 
 ---
@@ -42,13 +59,12 @@ fastify.get('/api/checkout', checkoutGet.getHandler);
 ```typescript
 import { CustomerPortal } from "@dodopayments/fastify";
 
-const fastify = Fastify({})
+const fastify = Fastify({});
 const customerPortalHandler = CustomerPortal({
-    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
-    environment: process.env.DODO_PAYMENTS_ENVIRONMENT
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
 });
-fastify.get('/api/customer-portal', customerPortalHandler);
-
+fastify.get("/api/customer-portal", customerPortalHandler);
 ```
 
 #### Query Parameters
@@ -63,22 +79,27 @@ Returns 400 if `customer_id` is missing.
 ### 3. Webhook Route Handler
 
 ```typescript
-
-import Fastify from 'fastify'
-import { Webhooks } from '@dodopayments/fastify'
-
-const fastify = Fastify({})
-fastify.addContentTypeParser('application/json', { parseAs: 'string' }, function (req, body, done) {
-    done(null, body)
-})
-fastify.post('/api/webhooks', Webhooks({
-  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
-  onPayload: async (payload) => {
-    // Handle Payload Here
-    console.log(payload)
-  }
-}));
-
+import Fastify from "fastify";
+import { Webhooks } from "@dodopayments/fastify";
+
+const fastify = Fastify({});
+fastify.addContentTypeParser(
+  "application/json",
+  { parseAs: "string" },
+  function (req, body, done) {
+    done(null, body);
+  },
+);
+fastify.post(
+  "/api/webhooks",
+  Webhooks({
+    webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
+    onPayload: async (payload) => {
+      // Handle Payload Here
+      console.log(payload);
+    },
+  }),
+);
 ```
 
 ---
@@ -139,8 +160,16 @@ const checkoutPost = Checkout({
     type: 'dynamic'
 });
 
+const checkoutSession = Checkout({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+    type: 'session'
+});
+
 fastify.get('/api/checkout', checkoutGet.getHandler);
-fastify.post('/api/checkout', checkoutGet.postHandler);
+fastify.post('/api/checkout', checkoutPost.postHandler);
+fastify.post('/api/checkout-session', checkoutSession.postHandler);
 
 
 Config Options:
@@ -151,7 +180,7 @@ Config Options:
 
     environment: "test_mode" or "live_mode"
 
-    type: "static" (GET) or "dynamic" (POST)
+    type: "static" (GET), "dynamic" (POST), or "session" (POST)
 
 GET (static checkout) expects query parameters:
 
@@ -159,12 +188,23 @@ GET (static checkout) expects query parameters:
 
     quantity, customer fields (fullName, email, etc.), and metadata (metadata_*) are optional.
 
-POST (dynamic checkout) expects a JSON body with payment details (one-time or subscription). Reference the docs for the full POST schema:
+    Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}
+
+POST (dynamic checkout) expects a JSON body with payment details (one-time or subscription). Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}. Reference the docs for the full POST schema:
 
     One-time payments: https://docs.dodopayments.com/api-reference/payments/post-payments
 
     Subscriptions: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions
 
+POST (checkout sessions) - (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:
+
+    One-time payments: https://docs.dodopayments.com/api-reference/payments/post-payments
+
+    Subscriptions: 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
+
 If Customer Portal Route Handler is selected:
 
 Purpose: This route allows customers to manage their subscriptions via the Dodo Payments portal.
@@ -252,11 +292,12 @@ Make sure to define these environment variables in your project:
 DODO_PAYMENTS_API_KEY=your-api-key
 DODO_PAYMENTS_RETURN_URL=https://yourapp.com/success
 DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
-DODO_PAYMENTS_ENVIRONMENT="test"or"live"
+DODO_PAYMENTS_ENVIRONMENT="test_mode" or "live_mode""
 
 Use these inside your code as:
 
 process.env.DODO_PAYMENTS_API_KEY
 process.env.DODO_PAYMENTS_WEBHOOK_KEY
 
-Security Note: Do NOT commit secrets to version control. Use .env files locally and secrets managers in deployment environments (e.g., AWS, Vercel, Heroku, etc.).
+Security Note: Do NOT commit secrets to version control. Use .env files locally and secrets managers in deployment environments (e.g., AWS, Vercel, Heroku, etc.).
+```

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,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,EAEL,qBAAqB,EAGtB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,QAAQ,GAAI,QAAQ,qBAAqB;0BAEjB,cAAc,SAAS,YAAY;2BA4BlC,cAAc,SAAS,YAAY;CAuBxE,CAAC"}
+{"version":3,"file":"checkout.d.ts","sourceRoot":"","sources":["../../src/checkout/checkout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,EAEL,qBAAqB,EAItB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,QAAQ,GAAI,QAAQ,qBAAqB;0BAEjB,cAAc,SAAS,YAAY;2BAgClC,cAAc,SAAS,YAAY;CAwDxE,CAAC"}

package/dist/customer-portal/customer-portal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customer-portal.d.ts","sourceRoot":"","sources":["../../src/customer-portal/customer-portal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvD,OAAqB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE3D,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,aAAa,EACb,aAAa,GAAG,aAAa,CAC9B,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,+BAG5B,oBAAoB,eACc,cAAc,SAAS,YAAY,mBAoCvE,CAAC"}
+{"version":3,"file":"customer-portal.d.ts","sourceRoot":"","sources":["../../src/customer-portal/customer-portal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvD,OAAqB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE3D,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,aAAa,EACb,aAAa,GAAG,aAAa,CAC9B,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,+BAG5B,oBAAoB,eACc,cAAc,SAAS,YAAY,mBAuCvE,CAAC"}