@evervault/react-native 2.4.0 → 2.5.0

package/build/ThreeDSecure/event.d.ts

@@ -0,0 +1,11 @@
+import { ThreeDSecureSession } from "./types";
+export type ThreeDSecureEventType = "requestChallenge";
+export declare class ThreeDSecureEvent {
+    readonly type: ThreeDSecureEventType;
+    readonly session: ThreeDSecureSession;
+    private _defaultPrevented;
+    constructor(type: ThreeDSecureEventType, session: ThreeDSecureSession, _defaultPrevented?: boolean);
+    preventDefault(): void;
+    get defaultPrevented(): boolean;
+}
+//# sourceMappingURL=event.d.ts.map

package/build/ThreeDSecure/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC;AAEvD,qBAAa,iBAAiB;aAEV,IAAI,EAAE,qBAAqB;aAC3B,OAAO,EAAE,mBAAmB;IAC5C,OAAO,CAAC,iBAAiB;gBAFT,IAAI,EAAE,qBAAqB,EAC3B,OAAO,EAAE,mBAAmB,EACpC,iBAAiB,GAAE,OAAe;IAGrC,cAAc;IAIrB,IAAW,gBAAgB,YAE1B;CACF"}

package/build/ThreeDSecure/session.d.ts

@@ -1,6 +1,6 @@
-import { ThreeDSecureCallbacks, ThreeDSecureSessionsParams, ThreeDSecureSession } from "./types";
+import { ThreeDSecureSessionsParams, ThreeDSecureSession, ThreeDSecureOptions } from "./types";
 export declare function stopPolling(intervalRef: React.MutableRefObject<NodeJS.Timeout | null>, setIsVisible: (show: boolean) => void): void;
-export declare function startSession(session: ThreeDSecureSession, callbacks: ThreeDSecureCallbacks | undefined, intervalRef: React.MutableRefObject<NodeJS.Timeout | null>, setIsVisible: (show: boolean) => void): Promise<void>;
-export declare function pollSession(session: ThreeDSecureSession, callbacks: ThreeDSecureCallbacks | undefined, intervalRef: React.MutableRefObject<NodeJS.Timeout | null>, setIsVisible: (show: boolean) => void, interval?: number): void;
-export declare function threeDSecureSession({ sessionId, appId, callbacks, intervalRef, setIsVisible, }: ThreeDSecureSessionsParams): ThreeDSecureSession;
+export declare function startSession(session: ThreeDSecureSession, options: ThreeDSecureOptions | undefined, intervalRef: React.MutableRefObject<NodeJS.Timeout | null>, setIsVisible: (show: boolean) => void): Promise<void>;
+export declare function pollSession(session: ThreeDSecureSession, options: ThreeDSecureOptions | undefined, intervalRef: React.MutableRefObject<NodeJS.Timeout | null>, setIsVisible: (show: boolean) => void, interval?: number): void;
+export declare function threeDSecureSession({ sessionId, appId, options, intervalRef, setIsVisible, }: ThreeDSecureSessionsParams): ThreeDSecureSession;
 //# sourceMappingURL=session.d.ts.map

package/build/ThreeDSecure/session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/session.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,mBAAmB,EAEpB,MAAM,SAAS,CAAC;AAGjB,wBAAgB,WAAW,CACzB,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,EAC1D,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,QAQtC;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,mBAAmB,EAC5B,SAAS,EAAE,qBAAqB,GAAG,SAAS,EAC5C,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,EAC1D,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,iBAyBtC;AAED,wBAAgB,WAAW,CACzB,OAAO,EAAE,mBAAmB,EAC5B,SAAS,EAAE,qBAAqB,GAAG,SAAS,EAC5C,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,EAC1D,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,EACrC,QAAQ,SAAO,QAoBhB;AAED,wBAAgB,mBAAmB,CAAC,EAClC,SAAS,EACT,KAAK,EACL,SAAS,EACT,WAAW,EACX,YAAY,GACb,EAAE,0BAA0B,GAAG,mBAAmB,CA+ClD"}
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/session.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,0BAA0B,EAC1B,mBAAmB,EAEnB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAIjB,wBAAgB,WAAW,CACzB,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,EAC1D,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,QAQtC;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,mBAAmB,GAAG,SAAS,EACxC,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,EAC1D,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,iBA+CtC;AAED,wBAAgB,WAAW,CACzB,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,mBAAmB,GAAG,SAAS,EACxC,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,EAC1D,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,EACrC,QAAQ,SAAO,QAgDhB;AAED,wBAAgB,mBAAmB,CAAC,EAClC,SAAS,EACT,KAAK,EACL,OAAO,EACP,WAAW,EACX,YAAY,GACb,EAAE,0BAA0B,GAAG,mBAAmB,CA+ClD"}

package/build/ThreeDSecure/types.d.ts

@@ -1,8 +1,14 @@
+import { ThreeDSecureEvent } from "./event";
 export interface ThreeDSecureCallbacks {
     /**
      * The error event will be fired if the component fails to load.
      */
     onError?(error: Error): void;
+    /**
+     * The 'requestChallenge' event will be fired if the 3DS authentication process requires a challenge.
+     * If you'd like to fail the authentication, you should call `preventDefault` on the passed event.
+     */
+    onRequestChallenge?(event: ThreeDSecureEvent): void;
     /**
      * The 'failure' event will be fired if the 3DS authentication process fails. You should use this event to handle the failure and inform the user and prompt them to try again.
      * If the user cancels the 3DS authentication process this event will be fired.
@@ -15,6 +21,12 @@ export interface ThreeDSecureCallbacks {
      */
     onSuccess?(): void;
 }
+export interface ThreeDSecureOptions extends ThreeDSecureCallbacks {
+    /**
+     * If set to `true` (or a function that returns `true`), the authentication will fail if a challenge is required.
+     */
+    failOnChallenge?: boolean | (() => Promise<boolean>);
+}
 export interface ThreeDSecureInitialState {
     session: ThreeDSecureSession | null;
     isVisible: boolean;
@@ -35,7 +47,7 @@ export interface ThreeDSecureSessionResponse {
 }
 export interface ThreeDSecureSessionsParams {
     appId: string;
-    callbacks?: ThreeDSecureCallbacks;
+    options?: ThreeDSecureOptions;
     intervalRef: React.MutableRefObject<NodeJS.Timeout | null>;
     sessionId: string;
     setIsVisible: (show: boolean) => void;
@@ -50,8 +62,8 @@ export interface ThreeDSecureState extends ThreeDSecureInitialState {
      * The `start()` function is used to kick off the 3DS authentication process.
      *
      * @param sessionId The 3DS session ID. A 3DS session can be created using the [Evervault API](https://docs.evervault.com/api-reference#createThreeDSSession).
-     * @param callbacks The callbacks to be called when the 3DS authentication process is finished.
+     * @param options The options to be used for the 3DS authentication process.
      */
-    start(sessionId: string, callbacks?: ThreeDSecureCallbacks): void;
+    start(sessionId: string, options?: ThreeDSecureOptions): void;
 }
 //# sourceMappingURL=types.d.ts.map

package/build/ThreeDSecure/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,SAAS,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,IAAI,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACpC,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,GAAG,IAAI,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAC;AAEtE,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;;;;OAKG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;CACnE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,kBAAkB,CAAC,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,SAAS,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,IAAI,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACpC,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,GAAG,IAAI,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAC;AAEtE,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;;;;OAKG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC/D"}

package/build/ThreeDSecure/useThreeDSecure.d.ts

@@ -1,3 +1,6 @@
 import { ThreeDSecureState } from "./types";
-export declare function useThreeDSecure(): ThreeDSecureState;
+export interface UseThreeDSecureOptions {
+    failOnChallenge?: boolean | (() => Promise<boolean>);
+}
+export declare function useThreeDSecure(options?: UseThreeDSecureOptions): ThreeDSecureState;
 //# sourceMappingURL=useThreeDSecure.d.ts.map

package/build/ThreeDSecure/useThreeDSecure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useThreeDSecure.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/useThreeDSecure.ts"],"names":[],"mappings":"AAGA,OAAO,EAAuB,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGjE,wBAAgB,eAAe,IAAI,iBAAiB,CAwCnD"}
+{"version":3,"file":"useThreeDSecure.d.ts","sourceRoot":"","sources":["../../src/ThreeDSecure/useThreeDSecure.ts"],"names":[],"mappings":"AAGA,OAAO,EAGL,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAGjB,MAAM,WAAW,sBAAsB;IACrC,eAAe,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;CACtD;AAED,wBAAgB,eAAe,CAC7B,OAAO,CAAC,EAAE,sBAAsB,GAC/B,iBAAiB,CA+CnB"}

package/build/index.cjs.js

@@ -7603,6 +7603,23 @@ const defaultStyles = reactNative.StyleSheet.create({
     },
 });
 
+class ThreeDSecureEvent {
+    type;
+    session;
+    _defaultPrevented;
+    constructor(type, session, _defaultPrevented = false) {
+        this.type = type;
+        this.session = session;
+        this._defaultPrevented = _defaultPrevented;
+    }
+    preventDefault() {
+        this._defaultPrevented = true;
+    }
+    get defaultPrevented() {
+        return this._defaultPrevented;
+    }
+}
+
 function stopPolling(intervalRef, setIsVisible) {
     setIsVisible(false);
     if (intervalRef.current) {
@@ -7610,55 +7627,91 @@ function stopPolling(intervalRef, setIsVisible) {
         intervalRef.current = null;
     }
 }
-async function startSession(session, callbacks, intervalRef, setIsVisible) {
+async function startSession(session, options, intervalRef, setIsVisible) {
     try {
         const sessionState = await session.get();
+        function fail() {
+            stopPolling(intervalRef, setIsVisible);
+            options?.onFailure?.(new Error("3DS session failed"));
+        }
         switch (sessionState.status) {
-            case "success":
+            case "success": {
                 stopPolling(intervalRef, setIsVisible);
-                callbacks?.onSuccess?.();
+                options?.onSuccess?.();
                 break;
-            case "failure":
-                stopPolling(intervalRef, setIsVisible);
-                callbacks?.onFailure?.(new Error("3DS session failed"));
+            }
+            case "failure": {
+                fail();
                 break;
-            case "action-required":
+            }
+            case "action-required": {
+                const failOnChallenge = typeof options?.failOnChallenge === "function"
+                    ? await options.failOnChallenge()
+                    : options?.failOnChallenge ?? false;
+                if (failOnChallenge) {
+                    fail();
+                    break;
+                }
+                const event = new ThreeDSecureEvent("requestChallenge", session);
+                options?.onRequestChallenge?.(event);
+                if (event.defaultPrevented) {
+                    fail();
+                    break;
+                }
                 setIsVisible(true);
-                pollSession(session, callbacks, intervalRef, setIsVisible);
-                break;
-            default:
-                break;
+                pollSession(session, options, intervalRef, setIsVisible);
+            }
         }
     }
     catch (error) {
         console.error("Error checking session state", error);
-        callbacks?.onError?.(new Error("Failed to check 3DS session state"));
+        options?.onError?.(new Error("Failed to check 3DS session state"));
     }
 }
-function pollSession(session, callbacks, intervalRef, setIsVisible, interval = 3000) {
+function pollSession(session, options, intervalRef, setIsVisible, interval = 3000) {
+    function fail() {
+        stopPolling(intervalRef, setIsVisible);
+        options?.onFailure?.(new Error("3DS session failed"));
+    }
     intervalRef.current = setInterval(async () => {
         try {
             const pollResponse = await session.get();
-            if (pollResponse.status === "success") {
-                stopPolling(intervalRef, setIsVisible);
-                callbacks?.onSuccess?.();
-            }
-            else if (pollResponse.status === "failure") {
-                stopPolling(intervalRef, setIsVisible);
-                callbacks?.onFailure?.(new Error("3DS session failed"));
-            }
-            else {
-                setIsVisible(true);
+            switch (pollResponse.status) {
+                case "success": {
+                    stopPolling(intervalRef, setIsVisible);
+                    options?.onSuccess?.();
+                    break;
+                }
+                case "failure": {
+                    fail();
+                    break;
+                }
+                case "action-required": {
+                    const failOnChallenge = typeof options?.failOnChallenge === "function"
+                        ? await options.failOnChallenge()
+                        : options?.failOnChallenge ?? false;
+                    if (failOnChallenge) {
+                        fail();
+                        break;
+                    }
+                    const event = new ThreeDSecureEvent("requestChallenge", session);
+                    options?.onRequestChallenge?.(event);
+                    if (event.defaultPrevented) {
+                        fail();
+                        break;
+                    }
+                    setIsVisible(true);
+                }
             }
         }
         catch (error) {
             stopPolling(intervalRef, setIsVisible);
             console.error("Error polling session", error);
-            callbacks?.onError?.(new Error("Error polling 3DS session"));
+            options?.onError?.(new Error("Error polling 3DS session"));
         }
     }, interval);
 }
-function threeDSecureSession({ sessionId, appId, callbacks, intervalRef, setIsVisible, }) {
+function threeDSecureSession({ sessionId, appId, options, intervalRef, setIsVisible, }) {
     async function get() {
         try {
             const response = await fetch(`https://${EV_API_DOMAIN}/frontend/3ds/browser-sessions/${sessionId}`, {
@@ -7684,7 +7737,7 @@ function threeDSecureSession({ sessionId, appId, callbacks, intervalRef, setIsVi
                 },
                 body: JSON.stringify({ outcome: "cancelled" }),
             });
-            callbacks?.onFailure?.(new Error("3DS session cancelled by user"));
+            options?.onFailure?.(new Error("3DS session cancelled by user"));
             stopPolling(intervalRef, setIsVisible);
         }
         catch (error) {
@@ -7699,22 +7752,27 @@ function threeDSecureSession({ sessionId, appId, callbacks, intervalRef, setIsVi
     };
 }
 
-function useThreeDSecure() {
+function useThreeDSecure(options) {
     const { appId } = useEvervault();
     const intervalRef = React.useRef(null);
     const [session, setSession] = React.useState(null);
     const [isVisible, setIsVisible] = React.useState(false);
-    const start = React.useCallback((sessionId, callbacks) => {
+    const failOnChallenge = options?.failOnChallenge ?? false;
+    const start = React.useCallback((sessionId, options) => {
+        const startOptions = {
+            ...options,
+            failOnChallenge: options?.failOnChallenge ?? failOnChallenge,
+        };
         const session = threeDSecureSession({
             sessionId,
             appId,
-            callbacks,
+            options: startOptions,
             intervalRef,
             setIsVisible,
         });
         setSession(session);
-        startSession(session, callbacks, intervalRef, setIsVisible);
-    }, [appId]);
+        startSession(session, startOptions, intervalRef, setIsVisible);
+    }, [appId, failOnChallenge]);
     const cancel = React.useCallback(async () => {
         if (session) {
             await session.cancel();