[MOB-10946] Update JWT in ts

example/src/hooks/useIterableApp.tsx

@@ -14,6 +14,7 @@ import {
   IterableConfig,
   IterableInAppShowResponse,
   IterableLogLevel,
+  IterableRetryBackoff,
 } from '@iterable/react-native-sdk';
 
 import { Route } from '../constants/routes';
@@ -96,7 +97,9 @@ export const IterableAppProvider: FunctionComponent<
   const [apiKey, setApiKey] = useState<string | undefined>(
     process.env.ITBL_API_KEY
   );
-  const [userId, setUserId] = useState<string | null>(process.env.ITBL_ID ?? null);
+  const [userId, setUserId] = useState<string | null>(
+    process.env.ITBL_ID ?? null
+  );
   const [loginInProgress, setLoginInProgress] = useState<boolean>(false);
 
   const getUserId = useCallback(() => userId ?? process.env.ITBL_ID, [userId]);
@@ -124,6 +127,16 @@ export const IterableAppProvider: FunctionComponent<
 
       config.inAppDisplayInterval = 1.0; // Min gap between in-apps. No need to set this in production.
 
+      config.retryPolicy = {
+        maxRetry: 5,
+        retryInterval: 10,
+        retryBackoff: IterableRetryBackoff.LINEAR,
+      };
+
+      config.onJWTError = (authFailure) => {
+        console.error('Error fetching JWT:', authFailure);
+      };
+
       config.urlHandler = (url: string) => {
         const routeNames = [Route.Commerce, Route.Inbox, Route.User];
         for (const route of routeNames) {

package.json

@@ -84,12 +84,13 @@
     "commitlint": "^19.6.1",
     "del-cli": "^5.1.0",
     "eslint": "^8.51.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-jest": "^28.9.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-tsdoc": "^0.3.0",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",
+    "prettier-eslint": "^16.4.2",
     "react": "19.0.0",
     "react-native": "0.79.3",
     "react-native-builder-bob": "^0.40.4",

src/api/NativeRNIterableAPI.ts

@@ -116,6 +116,8 @@ export interface Spec extends TurboModule {
 
   // Auth
   passAlongAuthToken(authToken?: string | null): void;
+  onAuthFailure(authFailure: { userKey: string; failedAuthToken: string; failedRequestTime: number; failureReason: string }): void;
+  pauseAuthRetries(pauseRetry: boolean): void;
 
   // Wake app -- android only
   wakeApp(): void;

src/core/classes/Iterable.ts

@@ -1,8 +1,4 @@
-import {
-  Linking,
-  NativeEventEmitter,
-  Platform,
-} from 'react-native';
+import { Linking, NativeEventEmitter, Platform } from 'react-native';
 
 import { buildInfo } from '../../itblBuildInfo';
 
@@ -13,7 +9,8 @@ import { IterableInAppMessage } from '../../inApp/classes/IterableInAppMessage';
 import { IterableInAppCloseSource } from '../../inApp/enums/IterableInAppCloseSource';
 import { IterableInAppDeleteSource } from '../../inApp/enums/IterableInAppDeleteSource';
 import { IterableInAppLocation } from '../../inApp/enums/IterableInAppLocation';
-import { IterableAuthResponseResult, IterableEventName } from '../enums';
+import { IterableAuthResponseResult } from '../enums/IterableAuthResponseResult';
+import { IterableEventName } from '../enums/IterableEventName';
 
 // Add this type-only import to avoid circular dependency
 import type { IterableInAppManager } from '../../inApp/classes/IterableInAppManager';
@@ -25,6 +22,7 @@ import { IterableAuthResponse } from './IterableAuthResponse';
 import type { IterableCommerceItem } from './IterableCommerceItem';
 import { IterableConfig } from './IterableConfig';
 import { IterableLogger } from './IterableLogger';
+import type { IterableAuthFailure } from '../types/IterableAuthFailure';
 
 const RNEventEmitter = new NativeEventEmitter(RNIterableAPI);
 
@@ -79,8 +77,11 @@ export class Iterable {
     // Lazy initialization to avoid circular dependency
     if (!this._inAppManager) {
       // Import here to avoid circular dependency at module level
-      // eslint-disable-next-line @typescript-eslint/no-var-requires,@typescript-eslint/no-require-imports
-      const { IterableInAppManager } = require('../../inApp/classes/IterableInAppManager');
+
+      const {
+        IterableInAppManager,
+        // eslint-disable-next-line @typescript-eslint/no-var-requires,@typescript-eslint/no-require-imports
+      } = require('../../inApp/classes/IterableInAppManager');
       this._inAppManager = new IterableInAppManager();
     }
     return this._inAppManager;
@@ -357,7 +358,13 @@ export class Iterable {
     Iterable?.logger?.log('getAttributionInfo');
 
     return RNIterableAPI.getAttributionInfo().then(
-      (dict: { campaignId: number; templateId: number; messageId: string } | null) => {
+      (
+        dict: {
+          campaignId: number;
+          templateId: number;
+          messageId: string;
+        } | null
+      ) => {
         if (dict) {
           return new IterableAttributionInfo(
             dict.campaignId as number,
@@ -398,7 +405,11 @@ export class Iterable {
   static setAttributionInfo(attributionInfo?: IterableAttributionInfo) {
     Iterable?.logger?.log('setAttributionInfo');
 
-    RNIterableAPI.setAttributionInfo(attributionInfo as unknown as { [key: string]: string | number | boolean; } | null);
+    RNIterableAPI.setAttributionInfo(
+      attributionInfo as unknown as {
+        [key: string]: string | number | boolean;
+      } | null
+    );
   }
 
   /**
@@ -477,7 +488,9 @@ export class Iterable {
   static updateCart(items: IterableCommerceItem[]) {
     Iterable?.logger?.log('updateCart');
 
-    RNIterableAPI.updateCart(items as unknown as { [key: string]: string | number | boolean }[]);
+    RNIterableAPI.updateCart(
+      items as unknown as { [key: string]: string | number | boolean }[]
+    );
   }
 
   /**
@@ -529,7 +542,11 @@ export class Iterable {
   ) {
     Iterable?.logger?.log('trackPurchase');
 
-    RNIterableAPI.trackPurchase(total, items as unknown as { [key: string]: string | number | boolean }[], dataFields as { [key: string]: string | number | boolean } | undefined);
+    RNIterableAPI.trackPurchase(
+      total,
+      items as unknown as { [key: string]: string | number | boolean }[],
+      dataFields as { [key: string]: string | number | boolean } | undefined
+    );
   }
 
   /**
@@ -698,7 +715,10 @@ export class Iterable {
   static trackEvent(name: string, dataFields?: unknown) {
     Iterable?.logger?.log('trackEvent');
 
-    RNIterableAPI.trackEvent(name, dataFields as { [key: string]: string | number | boolean } | undefined);
+    RNIterableAPI.trackEvent(
+      name,
+      dataFields as { [key: string]: string | number | boolean } | undefined
+    );
   }
 
   /**
@@ -746,7 +766,10 @@ export class Iterable {
   ) {
     Iterable?.logger?.log('updateUser');
 
-    RNIterableAPI.updateUser(dataFields as { [key: string]: string | number | boolean }, mergeNestedObjects);
+    RNIterableAPI.updateUser(
+      dataFields as { [key: string]: string | number | boolean },
+      mergeNestedObjects
+    );
   }
 
   /**
@@ -911,34 +934,45 @@ export class Iterable {
   }
 
   /**
-   * Sets up event handlers for various Iterable events.
+   * A callback function that is called when an authentication failure occurs.
    *
-   * This method performs the following actions:
-   * - Removes all existing listeners to avoid duplicate listeners.
-   * - Adds listeners for URL handling, custom actions, in-app messages, and authentication.
+   * @param authFailure - The auth failure details
    *
-   * Event Handlers:
-   * - `handleUrlCalled`: Invokes the URL handler if configured, with a delay on Android to allow the activity to wake up.
-   * - `handleCustomActionCalled`: Invokes the custom action handler if configured.
-   * - `handleInAppCalled`: Invokes the in-app handler if configured and sets the in-app show response.
-   * - `handleAuthCalled`: Invokes the authentication handler if configured and handles the promise result.
-   * - `handleAuthSuccessCalled`: Sets the authentication response callback to success.
-   * - `handleAuthFailureCalled`: Sets the authentication response callback to failure.
+   * @example
+   * ```typescript
+   * Iterable.onAuthFailure({
+   *  userKey: '1234567890',
+   *  failedAuthToken: '1234567890',
+   *  failedRequestTime: 1234567890,
+   *  failureReason: IterableAuthFailureReason.AUTH_TOKEN_EXPIRED,
+   * });
+   * ```
+   */
+  static onAuthFailure(authFailure: IterableAuthFailure) {
+    Iterable?.logger?.log('onAuthFailure');
+
+    RNIterableAPI.onAuthFailure(authFailure);
+  }
+
+  /**
+   * Pause the authentication retry mechanism.
    *
-   * Helper Functions:
-   * - `callUrlHandler`: Calls the URL handler and attempts to open the URL if the handler returns false.
+   * @param pauseRetry - Whether to pause the authentication retry mechanism
    *
-   * @internal
+   * @example
+   * ```typescript
+   * Iterable.pauseAuthRetries(true);
+   * ```
    */
-  private static setupEventHandlers() {
-    //Remove all listeners to avoid duplicate listeners
-    RNEventEmitter.removeAllListeners(IterableEventName.handleUrlCalled);
-    RNEventEmitter.removeAllListeners(IterableEventName.handleInAppCalled);
-    RNEventEmitter.removeAllListeners(
-      IterableEventName.handleCustomActionCalled
-    );
-    RNEventEmitter.removeAllListeners(IterableEventName.handleAuthCalled);
+  static pauseAuthRetries(pauseRetry: boolean) {
+    Iterable?.logger?.log('pauseAuthRetries');
 
+    RNIterableAPI.pauseAuthRetries(pauseRetry);
+  }
+
+  /** * @internal
+   */
+  private static setupEventHandlers() {
     if (Iterable.savedConfig.urlHandler) {
       RNEventEmitter.addListener(IterableEventName.handleUrlCalled, (dict) => {
         const url = dict.url;
@@ -983,7 +1017,7 @@ export class Iterable {
       let authResponseCallback: IterableAuthResponseResult;
       RNEventEmitter.addListener(IterableEventName.handleAuthCalled, () => {
         // MOB-10423: Check if we can use chain operator (?.) here instead
-
+        // Asks frontend of the client/app to pass authToken
         Iterable.savedConfig.authHandler!()
           .then((promiseResult) => {
             // Promise result can be either just String OR of type AuthResponse.
@@ -1004,6 +1038,8 @@ export class Iterable {
                 } else if (
                   authResponseCallback === IterableAuthResponseResult.FAILURE
                 ) {
+                  // We are currently only reporting JWT related errors.  In
+                  // the future, we should handle other types of errors as well.
                   if ((promiseResult as IterableAuthResponse).failureCallback) {
                     (promiseResult as IterableAuthResponse).failureCallback?.();
                   }
@@ -1033,8 +1069,14 @@ export class Iterable {
       );
       RNEventEmitter.addListener(
         IterableEventName.handleAuthFailureCalled,
-        () => {
+        (authFailureResponse: IterableAuthFailure) => {
+          // Mark the flag for above listener to indicate something failed.
+          // `catch(err)` will only indicate failure on high level. No actions
+          // should be taken inside `catch(err)`.
           authResponseCallback = IterableAuthResponseResult.FAILURE;
+
+          // Call the actual JWT error with `authFailure` object.
+          Iterable.savedConfig?.onJWTError?.(authFailureResponse);
         }
       );
     }

src/core/classes/IterableConfig.ts

@@ -1,10 +1,10 @@
 import { type IterableInAppMessage } from '../../inApp/classes/IterableInAppMessage';
-import { IterableInAppShowResponse } from '../../inApp/enums';
-import {
-  IterableDataRegion,
-  IterableLogLevel,
-  IterablePushPlatform,
-} from '../enums';
+import { IterableInAppShowResponse } from '../../inApp/enums/IterableInAppShowResponse';
+import { IterableDataRegion } from '../enums/IterableDataRegion';
+import { IterableLogLevel } from '../enums/IterableLogLevel';
+import { IterablePushPlatform } from '../enums/IterablePushPlatform';
+import type { IterableAuthFailure } from '../types/IterableAuthFailure';
+import type { IterableRetryPolicy } from '../types/IterableRetryPolicy';
 import { IterableAction } from './IterableAction';
 import type { IterableActionContext } from './IterableActionContext';
 import type { IterableAuthResponse } from './IterableAuthResponse';
@@ -204,7 +204,28 @@ export class IterableConfig {
    * @returns A promise that resolves to an `IterableAuthResponse`, a `string`,
    * or `undefined`.
    */
-  authHandler?: () => Promise<IterableAuthResponse | string | undefined>;
+  authHandler?: () => Promise<
+    IterableAuthResponse | IterableAuthFailure | string | undefined
+  >;
+
+  /**
+   * A callback function that is called when the SDK encounters an error while
+   * validing the JWT.
+   *
+   * The retry for JWT should be automatically handled by the native SDK, so
+   * this is just for logging/transparency purposes.
+   *
+   * @param authFailure - The details of the auth failure.
+   *
+   * @example
+   * ```typescript
+   * const config = new IterableConfig();
+   * config.onJWTError = (authFailure) => {
+   *   console.error('Error fetching JWT:', authFailure);
+   * };
+   * ```
+   */
+  onJWTError?: (authFailure: IterableAuthFailure) => void;
 
   /**
    * Set the verbosity of Android and iOS project's log system.
@@ -213,6 +234,12 @@ export class IterableConfig {
    */
   logLevel: IterableLogLevel = IterableLogLevel.info;
 
+  /**
+   * Configuration for JWT refresh retry behavior.
+   * If not specified, the SDK will use default retry behavior.
+   */
+  retryPolicy?: IterableRetryPolicy;
+
   /**
    * Set whether the React Native SDK should print function calls to console.
    *
@@ -332,6 +359,13 @@ export class IterableConfig {
        */
       // eslint-disable-next-line eqeqeq
       authHandlerPresent: this.authHandler != undefined,
+      /**
+       * A boolean indicating if an onJWTError handler is present.
+       *
+       * TODO: Figure out if this is purposeful
+       */
+      // eslint-disable-next-line eqeqeq
+      onJWTErrorPresent: this.onJWTError != undefined,
       /** The log level for the SDK. */
       logLevel: this.logLevel,
       expiringAuthTokenRefreshPeriod: this.expiringAuthTokenRefreshPeriod,
@@ -342,6 +376,7 @@ export class IterableConfig {
       dataRegion: this.dataRegion,
       pushPlatform: this.pushPlatform,
       encryptionEnforced: this.encryptionEnforced,
+      retryPolicy: this.retryPolicy,
     };
   }
 }