feat!: remove challengeContainerOptions, add containerId to startChal…

…lenge (#11) BREAKING CHANGE: `challengeContainerOptions` is removed in favor of `containerId` in `startChallenge`
Basis-Theory · Feb 12, 2025 · 6b14cb1 · 6b14cb1
1 parent a66ab3e
commit 6b14cb1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 13 deletions.
diff --git a/src/challenge.ts b/src/challenge.ts
@@ -26,6 +26,7 @@ type ThreeDSChallengeRequest = {
    * @deprecated This property is deprecated and will be removed in the next major version
    */
   mode?: AcsMode;
+  containerId?: string;
 };
 interface AcsThreeDSChallengeRequest {
   messageType: 'CReq'; // Must always be set to "CReq"
@@ -64,9 +65,10 @@ function isAcsThreeDSChallengeRequest(
 const submitChallengeRequest = (
   acsURL: string,
   creq: AcsThreeDSChallengeRequest,
+  containerId?: string
 ) => {
   const container = document.getElementById(
-    CHALLENGE_REQUEST.FRAME_CONTAINER_ID
+    containerId ?? CHALLENGE_REQUEST.FRAME_CONTAINER_ID
   );
 
   const windowSize = getWindowSizeById(creq.challengeWindowSize);
@@ -146,6 +148,7 @@ const makeChallengeRequest = ({
   threeDSVersion,
   windowSize,
   mode,
+  containerId,
 }: ThreeDSChallengeRequest): Promise<ThreeDSSession | Error> => {
   if (!sessionId) {
     throw new Error('Session ID is required');
@@ -163,7 +166,7 @@ const makeChallengeRequest = ({
     if (mode === ACS_MODE.REDIRECT) {
       submitChallengeRequestRedirect(acsChallengeUrl, creq);
     } else {
-      submitChallengeRequest(acsChallengeUrl, creq);
+      submitChallengeRequest(acsChallengeUrl, creq, containerId);
     }
   } else {
     const err = `Invalid challenge request payload for session: ${sessionId}`;
@@ -184,14 +187,16 @@ export const startChallenge = async ({
   windowSize,
   mode = 'iframe',
   timeout = 60000,
+  containerId,
 }: ThreeDSChallengeRequest) => {
   await makeChallengeRequest({
     sessionId,
     acsTransactionId,
     acsChallengeUrl,
     threeDSVersion,
     windowSize,
-    mode
+    mode,
+    containerId
   }).catch((error) => {
     return Promise.reject((error as Error).message);
   });

diff --git a/src/index.ts b/src/index.ts
@@ -30,12 +30,6 @@ type ConfigOptions = {
    * Disables telemetry
    */
   disableTelemetry?: boolean;
-  challengeContainerOptions?: {
-    /**
-     * Overrides default ID of iframe container
-     */
-    id?: string;
-  };
 };
 
 const BasisTheory3ds = (() => {
@@ -45,10 +39,7 @@ const BasisTheory3ds = (() => {
         disableTelemetry: configOptions?.disableTelemetry ?? false,
       });
       createIframeContainer(METHOD_REQUEST.FRAME_CONTAINER_ID, true);
-      createIframeContainer(
-        configOptions?.challengeContainerOptions?.id ??
-          CHALLENGE_REQUEST.FRAME_CONTAINER_ID
-      );
+      createIframeContainer(CHALLENGE_REQUEST.FRAME_CONTAINER_ID);
     } catch (error) {
       logger.log.error('Unable to create iframe container', error as Error);
     }