@glomopay/react-native-sdk 3.0.1 → 4.0.0

package/src/use-standard-checkout.tsx

@@ -10,25 +10,9 @@ import { initializeSegment } from "./config/segment";
 import { resolveServerConfig, type GlomoServer } from "./config/base";
 import { isValidPublicKey, isValidOrderId, isValidUrl, isValidPaymentPayload, safeCallback } from "./utils/validation";
 import { checkDeviceCompliance, isComplianceCheckAvailable } from "./utils/device-compliance";
-import {
-    trackStandardStartAttempt,
-    trackStandardStartSuccess,
-    trackStandardStartFailure,
-    trackStandardWindowOpen,
-    trackStandardWindowClose,
-    trackStandardPaymentSuccess,
-    trackStandardPaymentFailure,
-    trackStandardPaymentTerminate,
-    trackStandardConnectionError,
-    trackStandardSdkError,
-    trackStandardInvalidMessageReceived,
-    trackStandardBankTransferSubmitted,
-    trackStandardPayViaBankCompleted,
-    trackStandardPayViaBankBankConnectionSuccessful,
-    type SdkError,
-} from "./utils/analytics";
-
-import { type GlomoBankTransferPayload, type GlomoPayViaBankConnectionPayload } from "./types/checkout";
+import { type SdkError, type CheckoutAnalyticsTrackers, standardCheckoutTrackers } from "./utils/analytics";
+
+import { ASYNC_PAYMENT_EVENTS, type GlomoUserJourneyCompletedPayload } from "./types/checkout";
 import { type StandardCheckoutStatus, type GlomoStandardCheckoutPayload } from "./types/standard-checkout";
 
 /** Android-only WebView permission request, not yet in react-native-webview type definitions */
@@ -47,10 +31,8 @@ export interface UseStandardCheckoutOptions {
     onPaymentFailure: (payload: GlomoStandardCheckoutPayload) => void;
     onConnectionError?: (error: unknown) => void;
     onPaymentTerminate?: () => void;
-    onSdkError?: (error: Array<SdkError>) => void;
-    onBankTransferSubmitted?: (payload: GlomoBankTransferPayload | null | undefined) => void;
-    onPayViaBankCompleted?: (payload: { status: string }) => void;
-    onPayViaBankBankConnectionSuccessful?: (payload: GlomoPayViaBankConnectionPayload | null | undefined) => void;
+    onSdkError: (error: Array<SdkError>) => void;
+    onUserJourneyCompleted?: (payload: GlomoUserJourneyCompletedPayload) => void;
     onUserRefusedCameraPermissions?: () => void;
     devMode?: boolean;
 }
@@ -79,6 +61,16 @@ export interface UseStandardCheckoutReturn {
     injectedFlow?: string;
 }
 
+/**
+ * Internal options for useStandardCheckout.
+ * Used by subscription checkout to inject subscription-specific analytics trackers.
+ * Not exported to merchants.
+ */
+export interface UseStandardCheckoutInternalOptions {
+    analyticsTrackers?: CheckoutAnalyticsTrackers;
+    _skipOrderIdValidation?: boolean;
+}
+
 /** The main SDK hook for the GlomoPay Standard Checkout flow */
 export function useStandardCheckout(
     {
@@ -90,14 +82,15 @@ export function useStandardCheckout(
         onConnectionError,
         onPaymentTerminate,
         onSdkError,
-        onBankTransferSubmitted,
-        onPayViaBankCompleted,
-        onPayViaBankBankConnectionSuccessful,
+        onUserJourneyCompleted,
         onUserRefusedCameraPermissions,
         devMode = false,
     }: UseStandardCheckoutOptions,
-    mockMode: boolean
+    mockMode: boolean,
+    internalOptions?: UseStandardCheckoutInternalOptions
 ): UseStandardCheckoutReturn {
+    // Resolving analytics trackers - defaults to standard, subscription flow overrides
+    const trackers = internalOptions?.analyticsTrackers ?? standardCheckoutTrackers;
     // Refs for the WebViews
     const mainWebViewRef = useRef<WebView>(null);
     const flowWebViewRef = useRef<WebView>(null);
@@ -204,7 +197,14 @@ export function useStandardCheckout(
                     // Calling onConnectionError callback if provided
                     safeCallback(onConnectionError, [nativeEvent], "onConnectionError", devMode);
                     // Tracking connection error
-                    trackStandardConnectionError(orderId, nativeEvent?.code, publicKey, devMode, mockMode, checkoutUrl);
+                    trackers.trackConnectionError(
+                        orderId,
+                        nativeEvent?.code,
+                        publicKey,
+                        devMode,
+                        mockMode,
+                        checkoutUrl
+                    );
                 } else {
                     if (devMode) {
                         console.error("[Glomo-RN-SDK Standard] WebView error:", nativeEvent);
@@ -216,7 +216,7 @@ export function useStandardCheckout(
                 }
             }
         },
-        [devMode, onConnectionError, checkoutUrl, orderId, publicKey, mockMode]
+        [devMode, onConnectionError, checkoutUrl, orderId, publicKey, mockMode, trackers]
     );
 
     // Handler for the WebView HTTP errors
@@ -252,7 +252,7 @@ export function useStandardCheckout(
                         console.warn("[Glomo-RN-SDK Standard] Invalid message data from MainWebView");
                     }
                     // Tracking invalid message received
-                    trackStandardInvalidMessageReceived(
+                    trackers.trackInvalidMessageReceived(
                         "main",
                         data,
                         checkoutUrl,
@@ -289,7 +289,7 @@ export function useStandardCheckout(
                         setFlowWebViewUrl(url);
                         setShowFlowWebView(true);
                         // Tracking window.open interception
-                        trackStandardWindowOpen("main", url, orderId, publicKey, devMode, mockMode, checkoutUrl);
+                        trackers.trackWindowOpen("main", url, orderId, publicKey, devMode, mockMode, checkoutUrl);
                     } else {
                         if (devMode) {
                             console.log(
@@ -310,7 +310,7 @@ export function useStandardCheckout(
                     setShowFlowWebView(false);
                     setFlowWebViewUrl("");
                     // Tracking window.close interception
-                    trackStandardWindowClose("main", orderId, publicKey, devMode, mockMode, checkoutUrl);
+                    trackers.trackWindowClose("main", orderId, publicKey, devMode, mockMode, checkoutUrl);
                     return;
                 }
 
@@ -334,7 +334,7 @@ export function useStandardCheckout(
                             setStatus("payment_successful");
                             safeCallback(onPaymentSuccess, [payload], "onPaymentSuccess", devMode);
                             // Tracking payment success callback
-                            trackStandardPaymentSuccess(
+                            trackers.trackPaymentSuccess(
                                 payload.orderId,
                                 payload.paymentId,
                                 publicKey,
@@ -365,7 +365,7 @@ export function useStandardCheckout(
                             setStatus("payment_failed");
                             safeCallback(onPaymentFailure, [payload], "onPaymentFailure", devMode);
                             // Tracking payment failure callback
-                            trackStandardPaymentFailure(
+                            trackers.trackPaymentFailure(
                                 payload.orderId,
                                 payload.paymentId,
                                 publicKey,
@@ -391,50 +391,14 @@ export function useStandardCheckout(
                         setShowFlowWebView(false);
                         setFlowWebViewUrl("");
                         setStatus("bank_transfer_submitted");
-                        safeCallback(
-                            onBankTransferSubmitted,
-                            [
-                                {
-                                    orderId: payload?.orderId ?? "",
-                                    senderAccountNumber: payload?.senderAccountNumber ?? "",
-                                    transactionReference: payload?.transactionReference ?? "",
-                                },
-                            ],
-                            "onBankTransferSubmitted",
-                            devMode
-                        );
-                        trackStandardBankTransferSubmitted(orderId, publicKey, devMode, mockMode, checkoutUrl);
-                        return;
-                    }
-
-                    // Handling pay via bank - bank connection successful event (informational, no status change)
-                    if (messageType === "pay_via_bank.bank.connection_successful") {
-                        const payload = messageData?.payload;
-                        if (devMode) {
-                            console.log("[Glomo-RN-SDK Standard] Pay via bank - bank connection successful:", payload);
-                        }
-                        safeCallback(
-                            onPayViaBankBankConnectionSuccessful,
-                            [
-                                {
-                                    bankIdentifier: payload?.bankIdentifier ?? "",
-                                    cooldownPeriodInMinutes: payload?.cooldownPeriodInMinutes ?? 0,
-                                    bankName: payload?.bankName ?? "",
-                                    bankImageSrc: payload?.bankImageSrc ?? "",
-                                    bankImageAlt: payload?.bankImageAlt ?? "",
-                                },
-                            ],
-                            "onPayViaBankBankConnectionSuccessful",
-                            devMode
-                        );
-                        trackStandardPayViaBankBankConnectionSuccessful(
-                            orderId,
-                            publicKey,
-                            payload?.bankIdentifier ?? "",
-                            devMode,
-                            mockMode,
-                            checkoutUrl
-                        );
+                        const journeyPayload: GlomoUserJourneyCompletedPayload = {
+                            journeyType: ASYNC_PAYMENT_EVENTS.BANK_TRANSFER_SUBMITTED,
+                            orderId: payload?.orderId,
+                            senderAccountNumber: payload?.senderAccountNumber,
+                            transactionReference: payload?.transactionReference,
+                        };
+                        safeCallback(onUserJourneyCompleted, [journeyPayload], "onUserJourneyCompleted", devMode);
+                        trackers.trackBankTransferSubmitted(orderId, publicKey, devMode, mockMode, checkoutUrl);
                         return;
                     }
 
@@ -464,13 +428,13 @@ export function useStandardCheckout(
                         setShowCheckout(false);
                         setFlowWebViewUrl("");
                         setStatus("pay_via_bank_completed");
-                        safeCallback(
-                            onPayViaBankCompleted,
-                            [{ status: payload?.status ?? "unknown" }],
-                            "onPayViaBankCompleted",
-                            devMode
-                        );
-                        trackStandardPayViaBankCompleted(
+                        const journeyPayload: GlomoUserJourneyCompletedPayload = {
+                            journeyType: ASYNC_PAYMENT_EVENTS.PAY_VIA_BANK_COMPLETED,
+                            orderId: payload?.orderId,
+                            status: payload?.status ?? "unknown",
+                        };
+                        safeCallback(onUserJourneyCompleted, [journeyPayload], "onUserJourneyCompleted", devMode);
+                        trackers.trackPayViaBankCompleted(
                             orderId,
                             publicKey,
                             payload?.status ?? "unknown",
@@ -491,7 +455,7 @@ export function useStandardCheckout(
                         setFlowWebViewUrl("");
                         safeCallback(onPaymentTerminate, [], "onPaymentTerminate", devMode);
                         // Tracking payment terminate callback
-                        trackStandardPaymentTerminate(
+                        trackers.trackPaymentTerminate(
                             orderId,
                             "checkout_closed",
                             publicKey,
@@ -512,14 +476,13 @@ export function useStandardCheckout(
             onPaymentSuccess,
             onPaymentFailure,
             onPaymentTerminate,
-            onBankTransferSubmitted,
-            onPayViaBankCompleted,
-            onPayViaBankBankConnectionSuccessful,
+            onUserJourneyCompleted,
             devMode,
             mockMode,
             orderId,
             publicKey,
             checkoutUrl,
+            trackers,
         ]
     );
 
@@ -538,7 +501,7 @@ export function useStandardCheckout(
                         console.warn("[Glomo-RN-SDK Standard] Invalid message data from FlowWebView");
                     }
                     // Tracking invalid message received
-                    trackStandardInvalidMessageReceived(
+                    trackers.trackInvalidMessageReceived(
                         "flow",
                         data,
                         flowWebViewUrl,
@@ -573,7 +536,7 @@ export function useStandardCheckout(
                         }
                         setFlowWebViewUrl(url);
                         // Tracking window.open interception
-                        trackStandardWindowOpen("flow", url, orderId, publicKey, devMode, mockMode, checkoutUrl);
+                        trackers.trackWindowOpen("flow", url, orderId, publicKey, devMode, mockMode, checkoutUrl);
                     } else {
                         if (devMode) {
                             console.log(
@@ -594,7 +557,7 @@ export function useStandardCheckout(
                     setShowFlowWebView(false);
                     setFlowWebViewUrl("");
                     // Tracking window.close interception
-                    trackStandardWindowClose("flow", orderId, publicKey, devMode, mockMode, checkoutUrl);
+                    trackers.trackWindowClose("flow", orderId, publicKey, devMode, mockMode, checkoutUrl);
                     return;
                 }
 
@@ -618,7 +581,7 @@ export function useStandardCheckout(
                             setStatus("payment_successful");
                             safeCallback(onPaymentSuccess, [payload], "onPaymentSuccess", devMode);
                             // Tracking payment success callback
-                            trackStandardPaymentSuccess(
+                            trackers.trackPaymentSuccess(
                                 payload.orderId,
                                 payload.paymentId,
                                 publicKey,
@@ -652,7 +615,7 @@ export function useStandardCheckout(
                             setStatus("payment_failed");
                             safeCallback(onPaymentFailure, [payload], "onPaymentFailure", devMode);
                             // Tracking payment failure callback
-                            trackStandardPaymentFailure(
+                            trackers.trackPaymentFailure(
                                 payload.orderId,
                                 payload.paymentId,
                                 publicKey,
@@ -671,40 +634,6 @@ export function useStandardCheckout(
                         return;
                     }
 
-                    // Handling pay via bank - bank connection successful event from the flow WebView
-                    if (messageType === "pay_via_bank.bank.connection_successful") {
-                        const payload = messageData?.payload;
-                        if (devMode) {
-                            console.log(
-                                "[Glomo-RN-SDK Standard] Pay via bank - bank connection successful via FlowWebView:",
-                                payload
-                            );
-                        }
-                        safeCallback(
-                            onPayViaBankBankConnectionSuccessful,
-                            [
-                                {
-                                    bankIdentifier: payload?.bankIdentifier ?? "",
-                                    cooldownPeriodInMinutes: payload?.cooldownPeriodInMinutes ?? 0,
-                                    bankName: payload?.bankName ?? "",
-                                    bankImageSrc: payload?.bankImageSrc ?? "",
-                                    bankImageAlt: payload?.bankImageAlt ?? "",
-                                },
-                            ],
-                            "onPayViaBankBankConnectionSuccessful",
-                            devMode
-                        );
-                        trackStandardPayViaBankBankConnectionSuccessful(
-                            orderId,
-                            publicKey,
-                            payload?.bankIdentifier ?? "",
-                            devMode,
-                            mockMode,
-                            checkoutUrl
-                        );
-                        return;
-                    }
-
                     // Handling glomoCheckoutJourneyTerminate from the flow WebView (pay via bank completion)
                     if (messageType === "glomoCheckoutJourneyTerminate") {
                         // Deduplication - both main and flow WebViews can emit this event
@@ -726,13 +655,13 @@ export function useStandardCheckout(
                         setShowCheckout(false);
                         setFlowWebViewUrl("");
                         setStatus("pay_via_bank_completed");
-                        safeCallback(
-                            onPayViaBankCompleted,
-                            [{ status: payload?.status ?? "unknown" }],
-                            "onPayViaBankCompleted",
-                            devMode
-                        );
-                        trackStandardPayViaBankCompleted(
+                        const journeyPayload: GlomoUserJourneyCompletedPayload = {
+                            journeyType: ASYNC_PAYMENT_EVENTS.PAY_VIA_BANK_COMPLETED,
+                            orderId: payload?.orderId,
+                            status: payload?.status ?? "unknown",
+                        };
+                        safeCallback(onUserJourneyCompleted, [journeyPayload], "onUserJourneyCompleted", devMode);
+                        trackers.trackPayViaBankCompleted(
                             orderId,
                             publicKey,
                             payload?.status ?? "unknown",
@@ -752,14 +681,14 @@ export function useStandardCheckout(
         [
             onPaymentSuccess,
             onPaymentFailure,
-            onPayViaBankCompleted,
-            onPayViaBankBankConnectionSuccessful,
+            onUserJourneyCompleted,
             devMode,
             mockMode,
             orderId,
             publicKey,
             flowWebViewUrl,
             checkoutUrl,
+            trackers,
         ]
     );
 
@@ -797,13 +726,13 @@ export function useStandardCheckout(
             safeCallback(onPaymentTerminate, [], "onPaymentTerminate", devMode);
             // Tracking payment terminate callback (user dismiss/back button)
             const terminateSource = Platform.OS === "ios" ? "user_dismiss" : "back_button";
-            trackStandardPaymentTerminate(orderId, terminateSource, publicKey, devMode, mockMode, checkoutUrl);
+            trackers.trackPaymentTerminate(orderId, terminateSource, publicKey, devMode, mockMode, checkoutUrl);
         } catch (error) {
             if (devMode) {
                 console.error("[Glomo-RN-SDK Standard] Error in handleModalBackButton:", error);
             }
         }
-    }, [showFlowWebView, devMode, onPaymentTerminate, status, orderId, publicKey, mockMode, checkoutUrl]);
+    }, [showFlowWebView, devMode, onPaymentTerminate, status, orderId, publicKey, mockMode, checkoutUrl, trackers]);
 
     /** Closes the flow WebView and returns to the main checkout */
     const handleFlowBack = useCallback(() => {
@@ -812,8 +741,8 @@ export function useStandardCheckout(
         }
         setShowFlowWebView(false);
         setFlowWebViewUrl("");
-        trackStandardWindowClose("flow", orderId, publicKey, devMode, mockMode, checkoutUrl);
-    }, [devMode, orderId, publicKey, mockMode, checkoutUrl]);
+        trackers.trackWindowClose("flow", orderId, publicKey, devMode, mockMode, checkoutUrl);
+    }, [devMode, orderId, publicKey, mockMode, checkoutUrl, trackers]);
 
     /**
      * Handler for WebView permission requests (e.g. camera access for bank authentication).
@@ -931,7 +860,7 @@ export function useStandardCheckout(
         }
 
         // Tracking start attempt with current status
-        trackStandardStartAttempt(status, orderId, publicKey, devMode, mockMode, checkoutUrl, jailbreakDetectionInfo);
+        trackers.trackStartAttempt(status, orderId, publicKey, devMode, mockMode, checkoutUrl, jailbreakDetectionInfo);
 
         if (deviceComplianceCheck === true) {
             // Device detected as compromised
@@ -946,7 +875,7 @@ export function useStandardCheckout(
             ];
             safeCallback(onSdkError, [errors], "onSdkError", devMode);
             // Tracking start() failure
-            trackStandardStartFailure(
+            trackers.trackStartFailure(
                 "device_forbidden",
                 orderId,
                 publicKey,
@@ -974,8 +903,8 @@ export function useStandardCheckout(
                 },
             ];
             safeCallback(onSdkError, [errors], "onSdkError", devMode);
-            trackStandardSdkError(errors, orderId, publicKey, devMode, mockMode, checkoutUrl);
-            trackStandardStartFailure(
+            trackers.trackSdkError(errors, orderId, publicKey, devMode, mockMode, checkoutUrl);
+            trackers.trackStartFailure(
                 "validation_error",
                 orderId,
                 publicKey,
@@ -1000,7 +929,7 @@ export function useStandardCheckout(
             errors.push(error);
         }
 
-        if (!isValidOrderId(orderId)) {
+        if (!internalOptions?._skipOrderIdValidation && !isValidOrderId(orderId)) {
             const error: SdkError = {
                 type: "validation_error",
                 message: "Invalid orderId: must start with 'order_' and be a valid string",
@@ -1030,8 +959,8 @@ export function useStandardCheckout(
             }
             safeCallback(onSdkError, [errors], "onSdkError", devMode);
             // Tracking start() failure
-            trackStandardSdkError(errors, orderId, publicKey, devMode, mockMode, checkoutUrl);
-            trackStandardStartFailure(
+            trackers.trackSdkError(errors, orderId, publicKey, devMode, mockMode, checkoutUrl);
+            trackers.trackStartFailure(
                 "validation_error",
                 orderId,
                 publicKey,
@@ -1051,7 +980,7 @@ export function useStandardCheckout(
                 );
             }
             // Tracking start() failure
-            trackStandardStartFailure(
+            trackers.trackStartFailure(
                 "payment_successful",
                 orderId,
                 publicKey,
@@ -1076,7 +1005,7 @@ export function useStandardCheckout(
                 console.log(`[Glomo-RN-SDK Standard] Cannot start checkout. Unknown status: ${status}.`);
             }
             // Tracking start() failure
-            trackStandardStartFailure(
+            trackers.trackStartFailure(
                 "invalid_status",
                 orderId,
                 publicKey,
@@ -1094,7 +1023,7 @@ export function useStandardCheckout(
                 console.error("[Glomo-RN-SDK Standard] Cannot start checkout. Invalid checkout URL.");
             }
             // Tracking start() failure
-            trackStandardStartFailure(
+            trackers.trackStartFailure(
                 "invalid_url",
                 orderId,
                 publicKey,
@@ -1118,12 +1047,24 @@ export function useStandardCheckout(
         setStatus("payment_in_progress");
 
         // Tracking successful start
-        trackStandardStartSuccess(orderId, publicKey, devMode, mockMode, checkoutUrl, jailbreakDetectionInfo);
+        trackers.trackStartSuccess(orderId, publicKey, devMode, mockMode, checkoutUrl, jailbreakDetectionInfo);
 
         // Opening the checkout modal
         setShowCheckout(true);
         return true;
-    }, [devMode, status, publicKey, orderId, baseCheckoutUrl, checkoutUrl, mockMode, onSdkError, server]);
+    }, [
+        devMode,
+        status,
+        publicKey,
+        orderId,
+        baseCheckoutUrl,
+        checkoutUrl,
+        mockMode,
+        onSdkError,
+        server,
+        trackers,
+        internalOptions,
+    ]);
 
     // Initializing Segment analytics
     useEffect(() => {