@nozle-js/react 0.7.1 → 0.9.0

package/dist/index.d.cts

@@ -17,20 +17,60 @@ interface ScheduledCheckoutResult {
     subscription_id?: string;
     plan_code?: string;
 }
+interface RazorpayCheckoutResult {
+    type: 'razorpay';
+    checkout_id: string;
+    key_id: string;
+    order_id: string;
+    amount_cents: number;
+    currency: string;
+    expires_at?: string;
+    invoice_id?: string;
+    customer_id?: string;
+    recurring?: boolean;
+    mandate_max_amount_cents?: number;
+}
+interface ProcessingCheckoutResult {
+    type: 'processing';
+    checkout_id: string;
+    status: string;
+}
+interface HostedCheckoutResult {
+    type: 'hosted';
+    payment_url: string;
+    checkout_id?: string;
+}
+interface RazorpayVerification {
+    razorpay_order_id: string;
+    razorpay_payment_id: string;
+    razorpay_signature: string;
+}
+interface CheckoutStatus {
+    checkout_id: string;
+    provider: 'razorpay';
+    status: 'processing' | 'awaiting_payment' | 'succeeded' | 'failed' | 'expired' | 'needs_review';
+    fulfillment_status: 'pending' | 'processing' | 'succeeded';
+    amount_cents?: number;
+    currency?: string;
+    invoice_id?: string | null;
+    checkout?: CheckoutResult;
+}
+/** Call your authenticated merchant backend, which calls Nozle using its secret key. */
+type VerifyCheckout = (checkoutId: string, verification: RazorpayVerification) => Promise<CheckoutStatus>;
+type GetCheckoutStatus = (checkoutId: string) => Promise<CheckoutStatus>;
 type CheckoutResult = {
     type: 'stripe';
     url?: string;
     clientSecret?: string;
     client_secret?: string;
-} | {
-    type: 'razorpay';
-    orderId: string;
-} | CompletedCheckoutResult | ScheduledCheckoutResult | {
+} | RazorpayCheckoutResult | ProcessingCheckoutResult | HostedCheckoutResult | CompletedCheckoutResult | ScheduledCheckoutResult | {
     url: string;
 };
 interface CreateCheckoutInput {
     planCode: string;
     returnUrl: string;
+    idempotencyKey?: string;
+    registerMandate?: boolean;
 }
 type CreateCheckout = (input: CreateCheckoutInput) => Promise<CheckoutResult>;
 interface NozleClient {
@@ -41,15 +81,19 @@ interface NozleClient {
 interface BillingContextValue {
     client: NozleClient;
     createCheckout?: CreateCheckout;
+    verifyCheckout?: VerifyCheckout;
+    getCheckoutStatus?: GetCheckoutStatus;
 }
 declare const BillingContext: React__default.Context<BillingContextValue | null>;
 interface BillingProviderProps {
     publishableKey: string;
     createCheckout?: CreateCheckout;
+    verifyCheckout?: VerifyCheckout;
+    getCheckoutStatus?: GetCheckoutStatus;
     baseUrl?: string;
     children: ReactNode;
 }
-declare function BillingProvider({ publishableKey, createCheckout, baseUrl, children, }: BillingProviderProps): React__default.ReactElement;
+declare function BillingProvider({ publishableKey, createCheckout, verifyCheckout, getCheckoutStatus, baseUrl, children, }: BillingProviderProps): React__default.ReactElement;
 declare function useOptionalBillingContext(): BillingContextValue | null;
 declare function useBillingContext(): BillingContextValue;
 declare function useNozleClient(): NozleClient;
@@ -156,39 +200,55 @@ interface PlanComparisonProps {
  */
 declare function PlanComparison({ plans, features, }: PlanComparisonProps): React__default.ReactElement;
 
-interface CheckoutButtonProps {
+interface RazorpayActions {
+    verifyCheckout?: VerifyCheckout;
+    getCheckoutStatus?: GetCheckoutStatus;
+    onSuccess?: (paymentId: string) => void;
+    onProcessing?: (status: CheckoutStatus) => void;
+    onDismiss?: () => void;
+    onError?: (error: Error) => void;
+}
+interface RazorpayOptions {
+    key: string;
+    order_id: string;
+    amount: number;
+    currency: string;
+    customer_id?: string;
+    recurring?: '1';
+    handler: (response: RazorpayVerification) => void;
+    modal: {
+        ondismiss: () => void;
+    };
+}
+interface RazorpayInstance {
+    open(): void;
+    close(): void;
+    on(event: string, callback: () => void): void;
+}
+declare global {
+    interface Window {
+        Razorpay?: new (options: RazorpayOptions) => RazorpayInstance;
+    }
+}
+
+interface CheckoutButtonProps extends Omit<RazorpayActions, 'verifyCheckout' | 'getCheckoutStatus'> {
     planCode: string;
     returnUrl?: string;
     label?: string;
     className?: string;
     style?: React__default.CSSProperties;
     onError?: (error: Error) => void;
+    /** @deprecated The server supplies the public Razorpay key in the checkout response. */
     razorpayKeyId?: string;
+    registerMandate?: boolean;
     onStripeClientSecret?: (clientSecret: string) => void;
     onSuccess?: (paymentId: string) => void;
     onComplete?: (result: CompletedCheckoutResult) => void;
     onScheduled?: (result: ScheduledCheckoutResult) => void;
 }
-interface RazorpayOptions {
-    key: string;
-    order_id: string;
-    handler: (response: {
-        razorpay_payment_id: string;
-    }) => void;
-    modal?: {
-        ondismiss?: () => void;
-    };
-}
-declare global {
-    interface Window {
-        Razorpay: new (options: RazorpayOptions) => {
-            open(): void;
-        };
-    }
-}
-declare function CheckoutButton({ planCode, returnUrl, label, className, style, onError, razorpayKeyId, onStripeClientSecret, onSuccess, onComplete, onScheduled, }: CheckoutButtonProps): React__default.ReactElement;
+declare function CheckoutButton({ planCode, returnUrl, label, className, style, onError, razorpayKeyId, registerMandate, onProcessing, onDismiss, onStripeClientSecret, onSuccess, onComplete, onScheduled, }: CheckoutButtonProps): React__default.ReactElement;
 
-interface CheckoutProps {
+interface StripeCheckoutProps {
     /** Stripe PaymentIntent client secret */
     clientSecret: string;
     /** Stripe publishable key */
@@ -223,7 +283,17 @@ interface UseCheckoutResult {
     error: Error | null;
 }
 declare function useCheckout(): UseCheckoutResult;
-declare function Checkout({ clientSecret, publishableKey, stripeAccount, returnUrl, submitLabel, onSuccess, onComplete, onError, onReady, className, style, children, }: CheckoutProps): React__default.JSX.Element;
+interface ProviderCheckoutProps {
+    checkout: CheckoutResult;
+    submitLabel?: string;
+    onSuccess?: (paymentId: string) => void;
+    onComplete?: () => void;
+    onProcessing?: (status: CheckoutStatus) => void;
+    onError?: (error: Error) => void;
+    className?: string;
+}
+type CheckoutProps = StripeCheckoutProps | ProviderCheckoutProps;
+declare function Checkout(props: CheckoutProps): React__default.JSX.Element;
 
 interface ProrationPreview {
     credit: number;
@@ -457,4 +527,4 @@ interface PaymentMethodDisplayProps {
 }
 declare function PaymentMethodDisplay({ paymentMethod, onUpdatePaymentMethod, updateHref, }: PaymentMethodDisplayProps): React.JSX.Element;
 
-export { BillingContext, type BillingContextValue, BillingProvider, type BillingProviderProps, type Plan$1 as CatalogPlan, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type ComparisonFeature, type CompletedCheckoutResult, type CreateCheckout, type CreateCheckoutInput, FeatureGate, type FeatureGateProps, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, type Plan, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PricingPlan, PricingTable, type PricingTableProps, type ProrationPreview, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, getUsageMeterColor, useBillingContext, useCheckout, useCheckout$1 as useCheckoutSession, useNozleClient, useOptionalBillingContext, usePlans };
+export { BillingContext, type BillingContextValue, BillingProvider, type BillingProviderProps, type Plan$1 as CatalogPlan, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type CheckoutStatus, type ComparisonFeature, type CompletedCheckoutResult, type CreateCheckout, type CreateCheckoutInput, FeatureGate, type FeatureGateProps, type GetCheckoutStatus, type HostedCheckoutResult, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, type Plan, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PricingPlan, PricingTable, type PricingTableProps, type ProcessingCheckoutResult, type ProrationPreview, type RazorpayCheckoutResult, type RazorpayVerification, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, type VerifyCheckout, getUsageMeterColor, useBillingContext, useCheckout, useCheckout$1 as useCheckoutSession, useNozleClient, useOptionalBillingContext, usePlans };

package/dist/index.d.ts

@@ -17,20 +17,60 @@ interface ScheduledCheckoutResult {
     subscription_id?: string;
     plan_code?: string;
 }
+interface RazorpayCheckoutResult {
+    type: 'razorpay';
+    checkout_id: string;
+    key_id: string;
+    order_id: string;
+    amount_cents: number;
+    currency: string;
+    expires_at?: string;
+    invoice_id?: string;
+    customer_id?: string;
+    recurring?: boolean;
+    mandate_max_amount_cents?: number;
+}
+interface ProcessingCheckoutResult {
+    type: 'processing';
+    checkout_id: string;
+    status: string;
+}
+interface HostedCheckoutResult {
+    type: 'hosted';
+    payment_url: string;
+    checkout_id?: string;
+}
+interface RazorpayVerification {
+    razorpay_order_id: string;
+    razorpay_payment_id: string;
+    razorpay_signature: string;
+}
+interface CheckoutStatus {
+    checkout_id: string;
+    provider: 'razorpay';
+    status: 'processing' | 'awaiting_payment' | 'succeeded' | 'failed' | 'expired' | 'needs_review';
+    fulfillment_status: 'pending' | 'processing' | 'succeeded';
+    amount_cents?: number;
+    currency?: string;
+    invoice_id?: string | null;
+    checkout?: CheckoutResult;
+}
+/** Call your authenticated merchant backend, which calls Nozle using its secret key. */
+type VerifyCheckout = (checkoutId: string, verification: RazorpayVerification) => Promise<CheckoutStatus>;
+type GetCheckoutStatus = (checkoutId: string) => Promise<CheckoutStatus>;
 type CheckoutResult = {
     type: 'stripe';
     url?: string;
     clientSecret?: string;
     client_secret?: string;
-} | {
-    type: 'razorpay';
-    orderId: string;
-} | CompletedCheckoutResult | ScheduledCheckoutResult | {
+} | RazorpayCheckoutResult | ProcessingCheckoutResult | HostedCheckoutResult | CompletedCheckoutResult | ScheduledCheckoutResult | {
     url: string;
 };
 interface CreateCheckoutInput {
     planCode: string;
     returnUrl: string;
+    idempotencyKey?: string;
+    registerMandate?: boolean;
 }
 type CreateCheckout = (input: CreateCheckoutInput) => Promise<CheckoutResult>;
 interface NozleClient {
@@ -41,15 +81,19 @@ interface NozleClient {
 interface BillingContextValue {
     client: NozleClient;
     createCheckout?: CreateCheckout;
+    verifyCheckout?: VerifyCheckout;
+    getCheckoutStatus?: GetCheckoutStatus;
 }
 declare const BillingContext: React__default.Context<BillingContextValue | null>;
 interface BillingProviderProps {
     publishableKey: string;
     createCheckout?: CreateCheckout;
+    verifyCheckout?: VerifyCheckout;
+    getCheckoutStatus?: GetCheckoutStatus;
     baseUrl?: string;
     children: ReactNode;
 }
-declare function BillingProvider({ publishableKey, createCheckout, baseUrl, children, }: BillingProviderProps): React__default.ReactElement;
+declare function BillingProvider({ publishableKey, createCheckout, verifyCheckout, getCheckoutStatus, baseUrl, children, }: BillingProviderProps): React__default.ReactElement;
 declare function useOptionalBillingContext(): BillingContextValue | null;
 declare function useBillingContext(): BillingContextValue;
 declare function useNozleClient(): NozleClient;
@@ -156,39 +200,55 @@ interface PlanComparisonProps {
  */
 declare function PlanComparison({ plans, features, }: PlanComparisonProps): React__default.ReactElement;
 
-interface CheckoutButtonProps {
+interface RazorpayActions {
+    verifyCheckout?: VerifyCheckout;
+    getCheckoutStatus?: GetCheckoutStatus;
+    onSuccess?: (paymentId: string) => void;
+    onProcessing?: (status: CheckoutStatus) => void;
+    onDismiss?: () => void;
+    onError?: (error: Error) => void;
+}
+interface RazorpayOptions {
+    key: string;
+    order_id: string;
+    amount: number;
+    currency: string;
+    customer_id?: string;
+    recurring?: '1';
+    handler: (response: RazorpayVerification) => void;
+    modal: {
+        ondismiss: () => void;
+    };
+}
+interface RazorpayInstance {
+    open(): void;
+    close(): void;
+    on(event: string, callback: () => void): void;
+}
+declare global {
+    interface Window {
+        Razorpay?: new (options: RazorpayOptions) => RazorpayInstance;
+    }
+}
+
+interface CheckoutButtonProps extends Omit<RazorpayActions, 'verifyCheckout' | 'getCheckoutStatus'> {
     planCode: string;
     returnUrl?: string;
     label?: string;
     className?: string;
     style?: React__default.CSSProperties;
     onError?: (error: Error) => void;
+    /** @deprecated The server supplies the public Razorpay key in the checkout response. */
     razorpayKeyId?: string;
+    registerMandate?: boolean;
     onStripeClientSecret?: (clientSecret: string) => void;
     onSuccess?: (paymentId: string) => void;
     onComplete?: (result: CompletedCheckoutResult) => void;
     onScheduled?: (result: ScheduledCheckoutResult) => void;
 }
-interface RazorpayOptions {
-    key: string;
-    order_id: string;
-    handler: (response: {
-        razorpay_payment_id: string;
-    }) => void;
-    modal?: {
-        ondismiss?: () => void;
-    };
-}
-declare global {
-    interface Window {
-        Razorpay: new (options: RazorpayOptions) => {
-            open(): void;
-        };
-    }
-}
-declare function CheckoutButton({ planCode, returnUrl, label, className, style, onError, razorpayKeyId, onStripeClientSecret, onSuccess, onComplete, onScheduled, }: CheckoutButtonProps): React__default.ReactElement;
+declare function CheckoutButton({ planCode, returnUrl, label, className, style, onError, razorpayKeyId, registerMandate, onProcessing, onDismiss, onStripeClientSecret, onSuccess, onComplete, onScheduled, }: CheckoutButtonProps): React__default.ReactElement;
 
-interface CheckoutProps {
+interface StripeCheckoutProps {
     /** Stripe PaymentIntent client secret */
     clientSecret: string;
     /** Stripe publishable key */
@@ -223,7 +283,17 @@ interface UseCheckoutResult {
     error: Error | null;
 }
 declare function useCheckout(): UseCheckoutResult;
-declare function Checkout({ clientSecret, publishableKey, stripeAccount, returnUrl, submitLabel, onSuccess, onComplete, onError, onReady, className, style, children, }: CheckoutProps): React__default.JSX.Element;
+interface ProviderCheckoutProps {
+    checkout: CheckoutResult;
+    submitLabel?: string;
+    onSuccess?: (paymentId: string) => void;
+    onComplete?: () => void;
+    onProcessing?: (status: CheckoutStatus) => void;
+    onError?: (error: Error) => void;
+    className?: string;
+}
+type CheckoutProps = StripeCheckoutProps | ProviderCheckoutProps;
+declare function Checkout(props: CheckoutProps): React__default.JSX.Element;
 
 interface ProrationPreview {
     credit: number;
@@ -457,4 +527,4 @@ interface PaymentMethodDisplayProps {
 }
 declare function PaymentMethodDisplay({ paymentMethod, onUpdatePaymentMethod, updateHref, }: PaymentMethodDisplayProps): React.JSX.Element;
 
-export { BillingContext, type BillingContextValue, BillingProvider, type BillingProviderProps, type Plan$1 as CatalogPlan, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type ComparisonFeature, type CompletedCheckoutResult, type CreateCheckout, type CreateCheckoutInput, FeatureGate, type FeatureGateProps, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, type Plan, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PricingPlan, PricingTable, type PricingTableProps, type ProrationPreview, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, getUsageMeterColor, useBillingContext, useCheckout, useCheckout$1 as useCheckoutSession, useNozleClient, useOptionalBillingContext, usePlans };
+export { BillingContext, type BillingContextValue, BillingProvider, type BillingProviderProps, type Plan$1 as CatalogPlan, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type CheckoutStatus, type ComparisonFeature, type CompletedCheckoutResult, type CreateCheckout, type CreateCheckoutInput, FeatureGate, type FeatureGateProps, type GetCheckoutStatus, type HostedCheckoutResult, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, type Plan, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PricingPlan, PricingTable, type PricingTableProps, type ProcessingCheckoutResult, type ProrationPreview, type RazorpayCheckoutResult, type RazorpayVerification, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, type VerifyCheckout, getUsageMeterColor, useBillingContext, useCheckout, useCheckout$1 as useCheckoutSession, useNozleClient, useOptionalBillingContext, usePlans };