@flopay/react 1.13.4 → 1.14.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as _flopay_shared from '@flopay/shared';
-import { InlineSessionDraft, CheckoutButtonMethod, CheckoutProduct, CheckoutItem, CheckoutSubscription, ThemeId, FloPayAppearance, ButtonsLayoutTheme, ButtonsLayoutStyles, PaymentResult, CheckoutSession, FloPayError, DeclineEvent, InlineSessionPatch, GatewayEnvironment, PayPalProviderObjectType, PayPalApprovalPresentation, TokenizedBody, TelemetryPresentationMode, TelemetryTerminalReason, FloInstrumentEvent, WalletPresentation, BeforeButtonClickEvent, CheckoutMode, AVSFieldConfig, CardCaptureAdapter, VaultCardThemeColors } from '@flopay/shared';
-export { BeforeButtonClickEvent, CheckoutButtonMethod, DeclineEvent, FloInstrumentEvent, InlineSessionDraft, InlineSessionPatch, SentryEventLike, SentryStackFrameLike, WalletPresentation, dropThirdPartyOnlyError } from '@flopay/shared';
+import { InlineSessionDraft, CheckoutButtonMethod, CheckoutProduct, CheckoutItem, CheckoutSubscription, ThemeId, FloPayAppearance, ButtonsLayoutTheme, ButtonsLayoutStyles, PaymentResult, CheckoutSession, FloPayError, DeclineEvent, InlineSessionPatch, GatewayEnvironment, PayPalProviderObjectType, PayPalApprovalPresentation, TokenizedBody, FloPayPaymentCancelEvent, TelemetryPresentationMode, TelemetryTerminalReason, FloInstrumentEvent, WalletPresentation, BeforeButtonClickEvent, CheckoutMode, AVSFieldConfig, CardCaptureAdapter, VaultCardThemeColors } from '@flopay/shared';
+export { BeforeButtonClickEvent, CheckoutButtonMethod, DeclineEvent, FloInstrumentEvent, FloPayPaymentCancelEvent, InlineSessionDraft, InlineSessionPatch, SentryEventLike, SentryStackFrameLike, WalletPresentation, dropThirdPartyOnlyError } from '@flopay/shared';
 import React from 'react';
 export { FloPayCardSetup, FloPayCardSetupCancelEvent, FloPayCardSetupCompleteEvent, FloPayCardSetupDeclineEvent, FloPayCardSetupError, FloPayCardSetupProps } from './card-setup-entry.cjs';
 import { F as FloPayPaymentMethodSetupProps } from './payment-method-setup-surface-DWGNLM0I.cjs';
@@ -177,6 +177,11 @@ interface DirectPayPalButtonProps {
     onErrorChange?: (error: string | null) => void;
     /** Decline emitter (mirrors SplitCardForm semantics). */
     onDecline?: (decline: DeclineEvent) => void;
+    /**
+     * Called once when the buyer closes or leaves PayPal without approving (pop-up
+     * or app switch). Never called for an approval, a decline or a technical failure.
+     */
+    onCancel?: (event: FloPayPaymentCancelEvent) => void;
     /** Called for post-click technical failures before PayPal authorization completes. */
     onTechnicalFailure?: DirectPayPalTechnicalFailureHandler;
     /** External processing state. */
@@ -266,6 +271,12 @@ interface FloPayCheckoutProps {
     onInstrument?: (event: FloInstrumentEvent) => void;
     /** Called when a payment is declined or the authentication step fails. */
     onDecline?: (decline: DeclineEvent) => void;
+    /**
+     * Called once when the buyer closes or leaves the direct PayPal button's
+     * PayPal window without approving. Never called for an approval, a decline
+     * or a technical failure, nor for Stripe-rendered PayPal.
+     */
+    onCancel?: (event: FloPayPaymentCancelEvent) => void;
     /** Called when the AVS country dropdown changes. */
     onCountryChange?: (country: string) => void;
     /** Called when the AVS ZIP/postcode input changes. */
@@ -456,7 +467,7 @@ interface FloPayCheckoutProps {
  * />
  * ```
  */
-declare function FloPayCheckout({ sessionId: sessionIdProp, nonce: nonceProp, createSession: createSessionParams, billingApiUrl, telemetry, appearance: appearanceOverride, locale, loading: loadingNode, error: errorNode, onComplete, onError, onInstrument, onDecline, onCountryChange, onZipChange, showPayPal, showStripe, walletPresentation, enabledPaymentMethods: enabledPaymentMethodsProp, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, initialPayPalOrderId, 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, onInstrument, onDecline, onCancel, onCountryChange, onZipChange, showPayPal, showStripe, walletPresentation, enabledPaymentMethods: enabledPaymentMethodsProp, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, initialPayPalOrderId, children, checkoutMode: checkoutModeProp, confirmLabel, renderConfirmButton, onSessionCompleted, }: FloPayCheckoutProps): React.ReactElement;
 
 /**
  * Renders every payment method a setup session advertises — the hosted card
@@ -560,6 +571,11 @@ interface SplitCardFormProps {
     onError?: (error: FloPayError) => void;
     /** Called when a payment is declined or the authentication step fails. */
     onDecline?: (decline: DeclineEvent) => void;
+    /**
+     * Called once when the buyer closes or leaves the direct PayPal button's
+     * PayPal window without approving. Not called for Stripe-rendered PayPal.
+     */
+    onCancel?: (event: FloPayPaymentCancelEvent) => void;
     /**
      * **Override**: If provided, delegates backend submission to the caller.
      * When omitted, processes internally (calls processPayment + handles 3DS).

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _flopay_shared from '@flopay/shared';
-import { InlineSessionDraft, CheckoutButtonMethod, CheckoutProduct, CheckoutItem, CheckoutSubscription, ThemeId, FloPayAppearance, ButtonsLayoutTheme, ButtonsLayoutStyles, PaymentResult, CheckoutSession, FloPayError, DeclineEvent, InlineSessionPatch, GatewayEnvironment, PayPalProviderObjectType, PayPalApprovalPresentation, TokenizedBody, TelemetryPresentationMode, TelemetryTerminalReason, FloInstrumentEvent, WalletPresentation, BeforeButtonClickEvent, CheckoutMode, AVSFieldConfig, CardCaptureAdapter, VaultCardThemeColors } from '@flopay/shared';
-export { BeforeButtonClickEvent, CheckoutButtonMethod, DeclineEvent, FloInstrumentEvent, InlineSessionDraft, InlineSessionPatch, SentryEventLike, SentryStackFrameLike, WalletPresentation, dropThirdPartyOnlyError } from '@flopay/shared';
+import { InlineSessionDraft, CheckoutButtonMethod, CheckoutProduct, CheckoutItem, CheckoutSubscription, ThemeId, FloPayAppearance, ButtonsLayoutTheme, ButtonsLayoutStyles, PaymentResult, CheckoutSession, FloPayError, DeclineEvent, InlineSessionPatch, GatewayEnvironment, PayPalProviderObjectType, PayPalApprovalPresentation, TokenizedBody, FloPayPaymentCancelEvent, TelemetryPresentationMode, TelemetryTerminalReason, FloInstrumentEvent, WalletPresentation, BeforeButtonClickEvent, CheckoutMode, AVSFieldConfig, CardCaptureAdapter, VaultCardThemeColors } from '@flopay/shared';
+export { BeforeButtonClickEvent, CheckoutButtonMethod, DeclineEvent, FloInstrumentEvent, FloPayPaymentCancelEvent, InlineSessionDraft, InlineSessionPatch, SentryEventLike, SentryStackFrameLike, WalletPresentation, dropThirdPartyOnlyError } from '@flopay/shared';
 import React from 'react';
 export { FloPayCardSetup, FloPayCardSetupCancelEvent, FloPayCardSetupCompleteEvent, FloPayCardSetupDeclineEvent, FloPayCardSetupError, FloPayCardSetupProps } from './card-setup-entry.js';
 import { F as FloPayPaymentMethodSetupProps } from './payment-method-setup-surface-B9TI-00C.js';
@@ -177,6 +177,11 @@ interface DirectPayPalButtonProps {
     onErrorChange?: (error: string | null) => void;
     /** Decline emitter (mirrors SplitCardForm semantics). */
     onDecline?: (decline: DeclineEvent) => void;
+    /**
+     * Called once when the buyer closes or leaves PayPal without approving (pop-up
+     * or app switch). Never called for an approval, a decline or a technical failure.
+     */
+    onCancel?: (event: FloPayPaymentCancelEvent) => void;
     /** Called for post-click technical failures before PayPal authorization completes. */
     onTechnicalFailure?: DirectPayPalTechnicalFailureHandler;
     /** External processing state. */
@@ -266,6 +271,12 @@ interface FloPayCheckoutProps {
     onInstrument?: (event: FloInstrumentEvent) => void;
     /** Called when a payment is declined or the authentication step fails. */
     onDecline?: (decline: DeclineEvent) => void;
+    /**
+     * Called once when the buyer closes or leaves the direct PayPal button's
+     * PayPal window without approving. Never called for an approval, a decline
+     * or a technical failure, nor for Stripe-rendered PayPal.
+     */
+    onCancel?: (event: FloPayPaymentCancelEvent) => void;
     /** Called when the AVS country dropdown changes. */
     onCountryChange?: (country: string) => void;
     /** Called when the AVS ZIP/postcode input changes. */
@@ -456,7 +467,7 @@ interface FloPayCheckoutProps {
  * />
  * ```
  */
-declare function FloPayCheckout({ sessionId: sessionIdProp, nonce: nonceProp, createSession: createSessionParams, billingApiUrl, telemetry, appearance: appearanceOverride, locale, loading: loadingNode, error: errorNode, onComplete, onError, onInstrument, onDecline, onCountryChange, onZipChange, showPayPal, showStripe, walletPresentation, enabledPaymentMethods: enabledPaymentMethodsProp, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, initialPayPalOrderId, 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, onInstrument, onDecline, onCancel, onCountryChange, onZipChange, showPayPal, showStripe, walletPresentation, enabledPaymentMethods: enabledPaymentMethodsProp, showApplePay, showGooglePay, debug, layout, theme, buttonsTheme, buttonsStyles, cardButtonContent, cardBackButtonContent, cardTitleContent, showSecurityFooter: _showSecurityFooter, onButtonClick, onBeforeButtonClick, enableAVS, cardFieldOrder, cardPreFormSlot, avsLayout, submitLabel, className, initialErrorMessage, initialPayPalOrderId, children, checkoutMode: checkoutModeProp, confirmLabel, renderConfirmButton, onSessionCompleted, }: FloPayCheckoutProps): React.ReactElement;
 
 /**
  * Renders every payment method a setup session advertises — the hosted card
@@ -560,6 +571,11 @@ interface SplitCardFormProps {
     onError?: (error: FloPayError) => void;
     /** Called when a payment is declined or the authentication step fails. */
     onDecline?: (decline: DeclineEvent) => void;
+    /**
+     * Called once when the buyer closes or leaves the direct PayPal button's
+     * PayPal window without approving. Not called for Stripe-rendered PayPal.
+     */
+    onCancel?: (event: FloPayPaymentCancelEvent) => void;
     /**
      * **Override**: If provided, delegates backend submission to the caller.
      * When omitted, processes internally (calls processPayment + handles 3DS).