@nozle-js/react 0.10.0 → 0.10.2

package/dist/index.d.cts

@@ -71,6 +71,7 @@ interface CheckoutSubscriptionResult {
 interface CompletedCheckoutResult extends CheckoutSubscriptionResult {
     type: "completed";
     status: string;
+    /** `credits` or `none`. */
     payment_source?: string;
     subscription_id?: string;
     plan_code?: string;
@@ -84,7 +85,9 @@ interface ScheduledCheckoutResult extends CheckoutSubscriptionResult {
     subscription_id?: string;
     plan_code?: string;
     effective_at?: string;
-    pending_subscription_id?: string;
+    /** `upgrade` or `downgrade`. */
+    transition_direction?: string;
+    transition_policy?: string;
 }
 interface RazorpayCheckoutResult {
     type: "razorpay";
@@ -94,20 +97,40 @@ interface RazorpayCheckoutResult {
     amount_cents: number;
     currency: string;
     expires_at?: string;
+    /** Set for an invoice checkout. A paid upgrade returns `plan_upgrade_intent_id` instead. */
     invoice_id?: string;
+    plan_upgrade_intent_id?: string;
+    external_entity_id?: string;
+    external_subscription_id?: string;
     customer_id?: string;
     recurring?: boolean;
     mandate_max_amount_cents?: number;
 }
+/**
+ * The checkout is not ready to collect payment yet: Razorpay while the order is
+ * being created, and Stripe when a quoted upgrade is replayed while its webhook is
+ * still pending. Recover with the checkout status call using `checkout_id`.
+ */
 interface ProcessingCheckoutResult {
     type: "processing";
     checkout_id: string;
     status: string;
+    amount_cents?: number;
+    currency?: string;
+    expires_at?: string;
+    invoice_id?: string;
+    plan_upgrade_intent_id?: string;
 }
+/** A Razorpay payment link. The customer is redirected to `payment_url`. */
 interface HostedCheckoutResult {
     type: "hosted";
     payment_url: string;
     checkout_id?: string;
+    amount_cents?: number;
+    currency?: string;
+    expires_at?: string;
+    invoice_id?: string;
+    plan_upgrade_intent_id?: string;
 }
 interface RazorpayVerification {
     razorpay_order_id: string;
@@ -129,13 +152,19 @@ type VerifyCheckout = (checkoutId: string, verification: RazorpayVerification) =
 type GetCheckoutStatus = (checkoutId: string) => Promise<CheckoutStatus>;
 type CheckoutResult = {
     type: "stripe";
+    /** Not returned by plan and invoice checkout, which never issue a Stripe-hosted URL. */
     url?: string;
+    /** Embedded Checkout Session secret (`cs_...`). */
     clientSecret?: string;
     client_secret?: string;
+    /** Not returned by Nozle. Pass your Stripe publishable key to `Checkout`. */
     publishable_key?: string;
+    /** Not returned by Nozle. */
     stripe_account?: string;
     checkout_id?: string;
     invoice_id?: string;
+    /** Set instead of `invoice_id` for a paid upgrade. */
+    plan_upgrade_intent_id?: string;
     amount_cents?: number;
     currency?: string;
     external_entity_id?: string;
@@ -291,6 +320,7 @@ interface Plan$1 {
 declare function usePlans(): {
     plans: Plan$1[];
     isLoading: boolean;
+    error: Error | null;
 };
 
 interface UseCheckoutResult$1 {
@@ -444,7 +474,11 @@ interface StripeCheckoutProps {
     submitLabel?: string;
     /** Called with the paymentIntentId when payment succeeds without redirect */
     onSuccess?: (paymentIntentId: string) => void;
-    /** Called when an embedded Checkout Session completes without a redirect. */
+    /**
+     * Called when an embedded Checkout Session completes without a redirect. It does
+     * not fire when the session redirects to `returnUrl`: show success from the return
+     * page, or reload billing status there.
+     */
     onComplete?: () => void;
     /** Called with the error when payment fails */
     onError?: (error: Error) => void;

package/dist/index.d.ts

@@ -71,6 +71,7 @@ interface CheckoutSubscriptionResult {
 interface CompletedCheckoutResult extends CheckoutSubscriptionResult {
     type: "completed";
     status: string;
+    /** `credits` or `none`. */
     payment_source?: string;
     subscription_id?: string;
     plan_code?: string;
@@ -84,7 +85,9 @@ interface ScheduledCheckoutResult extends CheckoutSubscriptionResult {
     subscription_id?: string;
     plan_code?: string;
     effective_at?: string;
-    pending_subscription_id?: string;
+    /** `upgrade` or `downgrade`. */
+    transition_direction?: string;
+    transition_policy?: string;
 }
 interface RazorpayCheckoutResult {
     type: "razorpay";
@@ -94,20 +97,40 @@ interface RazorpayCheckoutResult {
     amount_cents: number;
     currency: string;
     expires_at?: string;
+    /** Set for an invoice checkout. A paid upgrade returns `plan_upgrade_intent_id` instead. */
     invoice_id?: string;
+    plan_upgrade_intent_id?: string;
+    external_entity_id?: string;
+    external_subscription_id?: string;
     customer_id?: string;
     recurring?: boolean;
     mandate_max_amount_cents?: number;
 }
+/**
+ * The checkout is not ready to collect payment yet: Razorpay while the order is
+ * being created, and Stripe when a quoted upgrade is replayed while its webhook is
+ * still pending. Recover with the checkout status call using `checkout_id`.
+ */
 interface ProcessingCheckoutResult {
     type: "processing";
     checkout_id: string;
     status: string;
+    amount_cents?: number;
+    currency?: string;
+    expires_at?: string;
+    invoice_id?: string;
+    plan_upgrade_intent_id?: string;
 }
+/** A Razorpay payment link. The customer is redirected to `payment_url`. */
 interface HostedCheckoutResult {
     type: "hosted";
     payment_url: string;
     checkout_id?: string;
+    amount_cents?: number;
+    currency?: string;
+    expires_at?: string;
+    invoice_id?: string;
+    plan_upgrade_intent_id?: string;
 }
 interface RazorpayVerification {
     razorpay_order_id: string;
@@ -129,13 +152,19 @@ type VerifyCheckout = (checkoutId: string, verification: RazorpayVerification) =
 type GetCheckoutStatus = (checkoutId: string) => Promise<CheckoutStatus>;
 type CheckoutResult = {
     type: "stripe";
+    /** Not returned by plan and invoice checkout, which never issue a Stripe-hosted URL. */
     url?: string;
+    /** Embedded Checkout Session secret (`cs_...`). */
     clientSecret?: string;
     client_secret?: string;
+    /** Not returned by Nozle. Pass your Stripe publishable key to `Checkout`. */
     publishable_key?: string;
+    /** Not returned by Nozle. */
     stripe_account?: string;
     checkout_id?: string;
     invoice_id?: string;
+    /** Set instead of `invoice_id` for a paid upgrade. */
+    plan_upgrade_intent_id?: string;
     amount_cents?: number;
     currency?: string;
     external_entity_id?: string;
@@ -291,6 +320,7 @@ interface Plan$1 {
 declare function usePlans(): {
     plans: Plan$1[];
     isLoading: boolean;
+    error: Error | null;
 };
 
 interface UseCheckoutResult$1 {
@@ -444,7 +474,11 @@ interface StripeCheckoutProps {
     submitLabel?: string;
     /** Called with the paymentIntentId when payment succeeds without redirect */
     onSuccess?: (paymentIntentId: string) => void;
-    /** Called when an embedded Checkout Session completes without a redirect. */
+    /**
+     * Called when an embedded Checkout Session completes without a redirect. It does
+     * not fire when the session redirects to `returnUrl`: show success from the return
+     * page, or reload billing status there.
+     */
     onComplete?: () => void;
     /** Called with the error when payment fails */
     onError?: (error: Error) => void;

package/dist/index.js

@@ -2866,8 +2866,12 @@ function usePlans() {
   const { client } = useBillingContext();
   const [plans, setPlans] = useState([]);
   const [isLoading, setIsLoading] = useState(true);
+  const [error, setError] = useState(null);
   useEffect(() => {
     let cancelled = false;
+    setIsLoading(true);
+    setError(null);
+    setPlans([]);
     if (!client) {
       setIsLoading(false);
       return;
@@ -2876,6 +2880,12 @@ function usePlans() {
       if (!response.ok) throw new Error(`HTTP ${response.status}`);
       const data = await response.json();
       if (!cancelled) setPlans(data.plans ?? []);
+    }).catch((cause) => {
+      if (!cancelled) {
+        setError(
+          cause instanceof Error ? cause : new Error("Failed to load plans")
+        );
+      }
     }).finally(() => {
       if (!cancelled) setIsLoading(false);
     });
@@ -2883,7 +2893,7 @@ function usePlans() {
       cancelled = true;
     };
   }, [client]);
-  return { plans, isLoading };
+  return { plans, isLoading, error };
 }
 function useCheckout2() {
   const { createCheckout } = useBillingContext();
@@ -3214,10 +3224,11 @@ function PricingTable({
     }
     let cancelled = false;
     client.catalogFetch("/api/v1/plans").then(async (res) => {
-      if (!cancelled && res.ok) {
-        const data = await res.json();
-        setPlans(data.plans || []);
-      }
+      if (!res.ok) throw new Error(`HTTP ${res.status}`);
+      const data = await res.json();
+      if (!cancelled) setPlans(data.plans || []);
+    }).catch((cause) => {
+      if (!cancelled) setCheckoutError(`Plans could not be loaded: ${cause instanceof Error ? cause.message : "unknown error"}`);
     }).finally(() => {
       if (!cancelled) setLoading(false);
     });