@flopay/react 1.3.3 → 1.4.0

package/dist/index.d.cts

@@ -66,6 +66,8 @@ interface FloPayCheckoutProps {
     createSession?: InlineSessionDraft;
     /** Billing API base URL. Defaults to the shared `BILLING_API_URL` constant. */
     billingApiUrl?: string;
+    /** Flo-owned privacy-safe telemetry is enabled by default; set `false` to opt out. */
+    telemetry?: boolean;
     /** Visual appearance for payment elements. */
     appearance?: FloPayAppearance;
     /** Locale for payment elements (default: 'auto'). */
@@ -233,7 +235,7 @@ interface FloPayCheckoutProps {
  * />
  * ```
  */
-declare function FloPayCheckout({ sessionId: sessionIdProp, nonce: nonceProp, createSession: createSessionParams, billingApiUrl, appearance: appearanceOverride, locale, loading: loadingNode, error: errorNode, onComplete, onError, onDecline, onFullNameChange, onCountryChange, onZipChange, showPayPal, showStripe, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, children, checkoutMode: checkoutModeProp, confirmLabel, renderConfirmButton, onSessionCompleted, }: FloPayCheckoutProps): React.ReactElement;
+declare function FloPayCheckout({ sessionId: sessionIdProp, nonce: nonceProp, createSession: createSessionParams, billingApiUrl, telemetry, appearance: appearanceOverride, locale, loading: loadingNode, error: errorNode, onComplete, onError, onDecline, onFullNameChange, onCountryChange, onZipChange, showPayPal, showStripe, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, children, checkoutMode: checkoutModeProp, confirmLabel, renderConfirmButton, onSessionCompleted, }: FloPayCheckoutProps): React.ReactElement;
 
 /**
  * Returns the current `FloPay` instance, or `null` if the provider
@@ -787,6 +789,7 @@ declare function PayPalButton({ sessionId, nonce, billingApiUrl, email, userId,
 interface DirectPayPalTokenizedOverrides {
     accountPatch?: InlineSessionPatch['account'];
     sessionId?: string;
+    nonce?: string;
 }
 /**
  * Internal handler signature aligned with `SplitCardForm`'s tokenized-body
@@ -801,6 +804,7 @@ interface DirectPayPalBeforeButtonClickResult {
     proceed: boolean;
     accountPatch?: InlineSessionPatch['account'];
     sessionId?: string;
+    nonce?: string;
 }
 /**
  * Click-time gate. Mirrors `RunBeforeButtonClick` in `SplitCardForm`: lets the
@@ -808,6 +812,10 @@ interface DirectPayPalBeforeButtonClickResult {
  * them abort the click entirely by returning `proceed: false`.
  */
 type DirectPayPalRunBeforeButtonClick = (method: CheckoutButtonMethod) => Promise<DirectPayPalBeforeButtonClickResult>;
+type DirectPayPalTechnicalFailureHandler = (method: 'paypal', err: unknown, options?: {
+    code?: string;
+    popupBlocked?: boolean;
+}) => void;
 interface DirectPayPalButtonProps {
     /** Checkout session ID. */
     sessionId: string;
@@ -840,6 +848,8 @@ interface DirectPayPalButtonProps {
     onErrorChange?: (error: string | null) => void;
     /** Decline emitter (mirrors SplitCardForm semantics). */
     onDecline?: (decline: DeclineEvent) => void;
+    /** Called for post-click technical failures before PayPal authorization completes. */
+    onTechnicalFailure?: DirectPayPalTechnicalFailureHandler;
     /** External processing state. */
     isProcessing?: boolean;
     /** Notify the parent of the loading state for placeholder swapping. */
@@ -871,6 +881,8 @@ interface DirectPayPalButtonProps {
      * binding takes effect (PayPal's render() options aren't live-updatable).
      */
     existingOrderId?: string;
+    /** Flo-owned privacy-safe telemetry is enabled by default; set `false` to opt out. */
+    telemetry?: boolean;
     /**
      * When true, renders an on-screen lifecycle tracer panel above the button
      * (mount, loadScript, eligibility, render, errors). Intended for debugging
@@ -879,15 +891,8 @@ interface DirectPayPalButtonProps {
      */
     debug?: boolean;
 }
-/**
- * Direct PayPal renderer powered by the official PayPal JS SDK.
- *
- * Renders inside Facebook / Instagram / Meta in-app browsers where Stripe's
- * PayPal ExpressCheckoutElement breaks. Selection between this and the Stripe-
- * rendered PayPal happens at the caller site based on whether the session
- * advertises `gateways.paypal.publishableKey`.
- */
-declare function DirectPayPalButton({ sessionId, nonce, billingApiUrl, email, clientId, environment, currency, isSubscription, onTokenizedBody, onComplete, onErrorChange, onDecline, isProcessing, onLoadStateChange, onButtonClick, runBeforeButtonClick, session, existingOrderId, debug, }: DirectPayPalButtonProps): React.ReactElement | null;
+/** Public direct-PayPal surface: telemetry accepts only the boolean opt-out. */
+declare function DirectPayPalButton(props: DirectPayPalButtonProps): React.ReactElement | null;
 
 interface FloPayAutomaticPaymentSuccessEvent {
     result: PaymentResult;

package/dist/index.d.ts

@@ -66,6 +66,8 @@ interface FloPayCheckoutProps {
     createSession?: InlineSessionDraft;
     /** Billing API base URL. Defaults to the shared `BILLING_API_URL` constant. */
     billingApiUrl?: string;
+    /** Flo-owned privacy-safe telemetry is enabled by default; set `false` to opt out. */
+    telemetry?: boolean;
     /** Visual appearance for payment elements. */
     appearance?: FloPayAppearance;
     /** Locale for payment elements (default: 'auto'). */
@@ -233,7 +235,7 @@ interface FloPayCheckoutProps {
  * />
  * ```
  */
-declare function FloPayCheckout({ sessionId: sessionIdProp, nonce: nonceProp, createSession: createSessionParams, billingApiUrl, appearance: appearanceOverride, locale, loading: loadingNode, error: errorNode, onComplete, onError, onDecline, onFullNameChange, onCountryChange, onZipChange, showPayPal, showStripe, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, children, checkoutMode: checkoutModeProp, confirmLabel, renderConfirmButton, onSessionCompleted, }: FloPayCheckoutProps): React.ReactElement;
+declare function FloPayCheckout({ sessionId: sessionIdProp, nonce: nonceProp, createSession: createSessionParams, billingApiUrl, telemetry, appearance: appearanceOverride, locale, loading: loadingNode, error: errorNode, onComplete, onError, onDecline, onFullNameChange, onCountryChange, onZipChange, showPayPal, showStripe, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, children, checkoutMode: checkoutModeProp, confirmLabel, renderConfirmButton, onSessionCompleted, }: FloPayCheckoutProps): React.ReactElement;
 
 /**
  * Returns the current `FloPay` instance, or `null` if the provider
@@ -787,6 +789,7 @@ declare function PayPalButton({ sessionId, nonce, billingApiUrl, email, userId,
 interface DirectPayPalTokenizedOverrides {
     accountPatch?: InlineSessionPatch['account'];
     sessionId?: string;
+    nonce?: string;
 }
 /**
  * Internal handler signature aligned with `SplitCardForm`'s tokenized-body
@@ -801,6 +804,7 @@ interface DirectPayPalBeforeButtonClickResult {
     proceed: boolean;
     accountPatch?: InlineSessionPatch['account'];
     sessionId?: string;
+    nonce?: string;
 }
 /**
  * Click-time gate. Mirrors `RunBeforeButtonClick` in `SplitCardForm`: lets the
@@ -808,6 +812,10 @@ interface DirectPayPalBeforeButtonClickResult {
  * them abort the click entirely by returning `proceed: false`.
  */
 type DirectPayPalRunBeforeButtonClick = (method: CheckoutButtonMethod) => Promise<DirectPayPalBeforeButtonClickResult>;
+type DirectPayPalTechnicalFailureHandler = (method: 'paypal', err: unknown, options?: {
+    code?: string;
+    popupBlocked?: boolean;
+}) => void;
 interface DirectPayPalButtonProps {
     /** Checkout session ID. */
     sessionId: string;
@@ -840,6 +848,8 @@ interface DirectPayPalButtonProps {
     onErrorChange?: (error: string | null) => void;
     /** Decline emitter (mirrors SplitCardForm semantics). */
     onDecline?: (decline: DeclineEvent) => void;
+    /** Called for post-click technical failures before PayPal authorization completes. */
+    onTechnicalFailure?: DirectPayPalTechnicalFailureHandler;
     /** External processing state. */
     isProcessing?: boolean;
     /** Notify the parent of the loading state for placeholder swapping. */
@@ -871,6 +881,8 @@ interface DirectPayPalButtonProps {
      * binding takes effect (PayPal's render() options aren't live-updatable).
      */
     existingOrderId?: string;
+    /** Flo-owned privacy-safe telemetry is enabled by default; set `false` to opt out. */
+    telemetry?: boolean;
     /**
      * When true, renders an on-screen lifecycle tracer panel above the button
      * (mount, loadScript, eligibility, render, errors). Intended for debugging
@@ -879,15 +891,8 @@ interface DirectPayPalButtonProps {
      */
     debug?: boolean;
 }
-/**
- * Direct PayPal renderer powered by the official PayPal JS SDK.
- *
- * Renders inside Facebook / Instagram / Meta in-app browsers where Stripe's
- * PayPal ExpressCheckoutElement breaks. Selection between this and the Stripe-
- * rendered PayPal happens at the caller site based on whether the session
- * advertises `gateways.paypal.publishableKey`.
- */
-declare function DirectPayPalButton({ sessionId, nonce, billingApiUrl, email, clientId, environment, currency, isSubscription, onTokenizedBody, onComplete, onErrorChange, onDecline, isProcessing, onLoadStateChange, onButtonClick, runBeforeButtonClick, session, existingOrderId, debug, }: DirectPayPalButtonProps): React.ReactElement | null;
+/** Public direct-PayPal surface: telemetry accepts only the boolean opt-out. */
+declare function DirectPayPalButton(props: DirectPayPalButtonProps): React.ReactElement | null;
 
 interface FloPayAutomaticPaymentSuccessEvent {
     result: PaymentResult;