@dodopayments/hono 0.1.2 → 0.2.0

package/README.md

@@ -18,22 +18,43 @@ npm install @dodopayments/hono
 
 ## Quick Start
 
-
 ### 1. Checkout
 
 ```typescript
-import { Checkout } from '@dodopayments/hono';
-import { Hono } from 'hono'
+// route.ts
+import { Checkout } from "@dodopayments/hono";
+import Hono from "hono";
+
+const app = new Hono();
 
-const app = new Hono()
 app.get(
   "/api/checkout",
   Checkout({
     bearerToken: process.env.DODO_PAYMENTS_API_KEY,
     environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
     returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
-    type: 'static'
-  })
+    type: "static",
+  }),
+);
+
+app.post(
+  "/api/checkout",
+  Checkout({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+    type: "dynamic",
+  }),
+);
+
+app.post(
+  "/api/checkout",
+  Checkout({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+    type: "session",
+  }),
 );
 ```
 
@@ -43,18 +64,16 @@ app.get(
 
 ```typescript
 import { CustomerPortal } from "@dodopayments/hono";
-import { Hono } from 'hono'
+import { Hono } from "hono";
 
-const app = new Hono()
+const app = new Hono();
 app.get(
   "/api/customer-portal",
   CustomerPortal({
     bearerToken: process.env.DODO_PAYMENTS_API_KEY,
-    environment: process.env.DODO_PAYMENTS_ENVIRONMENT
-  })
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+  }),
 );
-
-
 ```
 
 #### Query Parameters
@@ -69,23 +88,20 @@ Returns 400 if `customer_id` is missing.
 ### 3. Webhook Route Handler
 
 ```typescript
+import { Hono } from "hono";
+import { Webhooks } from "@dodopayments/hono";
 
-import { Hono } from 'hono'
-import { Webhooks } from '@dodopayments/hono'
-
-const app = new Hono()
+const app = new Hono();
 app.post(
   "/api/webhooks",
   Webhooks({
     webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
     onPayload: async (payload) => {
       // Handle Payload Here
-      console.log(payload)
-    }
-  })
+      console.log(payload);
+    },
+  }),
 );
-
-
 ```
 
 ---
@@ -149,7 +165,7 @@ app.post(
     bearerToken: process.env.DODO_PAYMENTS_API_KEY,
     environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
     returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
-    type: 'dynamic'
+    type: 'session' // or 'dynamic' for dynamic link
   })
 );
 
@@ -162,7 +178,7 @@ Config Options:
 
     environment: "test_mode" or "live_mode"
 
-    type: "static" (GET) or "dynamic" (POST)
+    type: "static" (GET) or "dynamic" (POST) or "session" (POST)
 
 GET (static checkout) expects query parameters:
 
@@ -176,6 +192,20 @@ POST (dynamic checkout) expects a JSON body with payment details (one-time or su
 
     Subscriptions: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions
 
+POST (checkout sessions) - (Recommended) A more customizable checkout experience:
+
+    Expects a JSON body with product_cart array and customer details.
+
+    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
+
+    Returns: {"checkout_url": "https://checkout.dodopayments.com/session/..."}
+
+
 If Customer Portal Route Handler is selected:
 
 Purpose: This route allows customers to manage their subscriptions via the Dodo Payments portal.
@@ -264,11 +294,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

@@ -1,4 +1,6 @@
 import { Context } from "hono";
 import { CheckoutHandlerConfig } from "@dodopayments/core/checkout";
-export declare const Checkout: (config: CheckoutHandlerConfig) => (c: Context) => Promise<(Response & import("hono").TypedResponse<any, 400, "text">) | (Response & import("hono").TypedResponse<undefined, 302, "redirect">)>;
+export declare const Checkout: (config: CheckoutHandlerConfig) => (c: Context) => Promise<(Response & import("hono").TypedResponse<any, 400, "text">) | (Response & import("hono").TypedResponse<{
+    checkout_url: string;
+}, import("hono/utils/http-status").ContentfulStatusCode, "json">)>;
 //# sourceMappingURL=checkout.d.ts.map

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,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAEL,qBAAqB,EAGtB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,QAAQ,GAAI,QAAQ,qBAAqB,MAmD5C,GAAG,OAAO,iJAMnB,CAAC"}
+{"version":3,"file":"checkout.d.ts","sourceRoot":"","sources":["../../src/checkout/checkout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAEL,qBAAqB,EAItB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,QAAQ,GAAI,QAAQ,qBAAqB,MAkF5C,GAAG,OAAO;;mEAMnB,CAAC"}

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

@@ -1,5 +1,5 @@
 import { Context } from "hono";
 import { ClientOptions } from "dodopayments";
 export type CustomerPortalConfig = Pick<ClientOptions, "environment" | "bearerToken">;
-export declare const CustomerPortal: ({ bearerToken, environment, }: CustomerPortalConfig) => (c: Context) => Promise<(Response & import("hono").TypedResponse<undefined, 302, "redirect">) | (Response & import("hono").TypedResponse<"Missing customerId in query parameters", 400, "text">) | (Response & import("hono").TypedResponse<`Failed to create customer portal session: ${any}`, 500, "text">)>;
+export declare const CustomerPortal: ({ bearerToken, environment, }: CustomerPortalConfig) => (c: Context) => Promise<(Response & import("hono").TypedResponse<"Missing customerId in query parameters", 400, "text">) | (Response & import("hono").TypedResponse<undefined, 302, "redirect">) | (Response & import("hono").TypedResponse<`Failed to create customer portal session: ${any}`, 500, "text">)>;
 //# sourceMappingURL=customer-portal.d.ts.map