[MOB-12231] refactor-classes-to-reduce-circular-dependencies

src/core/classes/IterableAuthManager.ts

@@ -0,0 +1,39 @@
+import { defaultLogger } from '../constants/defaults';
+import { IterableLogger } from './IterableLogger';
+import { IterableApi } from './IterableApi';
+
+/**
+ * Manages the authentication for the Iterable SDK.
+ *
+ * @example
+ * ```typescript
+ * const config = new IterableConfig();
+ * const logger = new IterableLogger(config);
+ * const authManager = new IterableAuthManager(logger);
+ * ```
+ */
+export class IterableAuthManager {
+  /**
+   * The logger for the Iterable SDK.
+   */
+  static logger: IterableLogger = defaultLogger;
+
+  constructor(logger: IterableLogger) {
+    IterableAuthManager.logger = logger;
+  }
+
+  /**
+   * Pause the authentication retry mechanism.
+   *
+   * @param pauseRetry - Whether to pause the authentication retry mechanism
+   *
+   * @example
+   * ```typescript
+   * const authManager = new IterableAuthManager();
+   * authManager.pauseAuthRetries(true);
+   * ```
+   */
+  pauseAuthRetries(pauseRetry: boolean) {
+    return IterableApi.pauseAuthRetries(pauseRetry);
+  }
+}

src/core/classes/IterableLogger.ts

@@ -5,6 +5,8 @@ import { IterableConfig } from './IterableConfig';
  *
  * This class is responsible for logging messages based on the configuration provided.
  *
+ * TODO: add a logLevel property to the IterableLogger class to control the level of logging.
+ *
  * @remarks
  * The logging behavior is controlled by the `logReactNativeSdkCalls` property
  * in {@link IterableConfig}.
@@ -39,13 +41,13 @@ export class IterableLogger {
    *
    * @param message - The message to be logged.
    */
-  log(message: string) {
+  log(message?: unknown, ...optionalParams: unknown[]) {
     // default to `true` in the case of unit testing where `Iterable` is not initialized
     // which is most likely in a debug environment anyways
     const loggingEnabled = this.config.logReactNativeSdkCalls ?? true;
 
     if (loggingEnabled) {
-      console.log(message);
+      console.log(message, ...optionalParams);
     }
   }
 }

src/core/constants/defaults.ts

@@ -0,0 +1,9 @@
+import { IterableInAppManager } from '../../inApp/classes/IterableInAppManager';
+import { IterableAuthManager } from '../classes/IterableAuthManager';
+import { IterableConfig } from '../classes/IterableConfig';
+import { IterableLogger } from '../classes/IterableLogger';
+
+export const defaultConfig = new IterableConfig();
+export const defaultLogger = new IterableLogger(defaultConfig);
+export const defaultInAppManager = new IterableInAppManager(defaultLogger);
+export const defaultAuthManager = new IterableAuthManager(defaultLogger);

src/inApp/classes/IterableInAppManager.ts

@@ -1,11 +1,10 @@
-import { RNIterableAPI } from '../../api';
-import { Iterable } from '../../core/classes/Iterable';
-import type {
-  IterableInAppDeleteSource,
-  IterableInAppLocation,
-} from '../enums';
-import { IterableHtmlInAppContent } from './IterableHtmlInAppContent';
-import { IterableInAppMessage } from './IterableInAppMessage';
+import { IterableApi } from '../../core/classes/IterableApi';
+import { IterableLogger } from '../../core/classes/IterableLogger';
+import { defaultLogger } from '../../core/constants/defaults';
+import type { IterableInAppDeleteSource } from '../enums/IterableInAppDeleteSource';
+import type { IterableInAppLocation } from '../enums/IterableInAppLocation';
+import type { IterableHtmlInAppContent } from './IterableHtmlInAppContent';
+import type { IterableInAppMessage } from './IterableInAppMessage';
 
 /**
  * Manages in-app messages for the current user.
@@ -14,8 +13,24 @@ import { IterableInAppMessage } from './IterableInAppMessage';
  * displaying messages, removing messages, setting read status, and more.
  *
  * The `inAppManager` property of an `Iterable` instance is set to an instance of this class.
+ *
+ * @example
+ * ```typescript
+ * const config = new IterableConfig();
+ * const logger = new IterableLogger(config);
+ * const inAppManager = new IterableInAppManager(logger);
+ * ```
  */
 export class IterableInAppManager {
+  /**
+   * The logger for the Iterable SDK.
+   */
+  static logger: IterableLogger = defaultLogger;
+
+  constructor(logger: IterableLogger) {
+    IterableInAppManager.logger = logger;
+  }
+
   /**
    * Retrieve the current user's list of in-app messages stored in the local queue.
    *
@@ -33,9 +48,9 @@ export class IterableInAppManager {
    * @returns A Promise that resolves to an array of in-app messages.
    */
   getMessages(): Promise<IterableInAppMessage[]> {
-    Iterable?.logger?.log('InAppManager.getMessages');
-
-    return RNIterableAPI.getInAppMessages() as unknown as Promise<IterableInAppMessage[]>;
+    return IterableApi.getInAppMessages() as unknown as Promise<
+      IterableInAppMessage[]
+    >;
   }
 
   /**
@@ -56,9 +71,9 @@ export class IterableInAppManager {
    * @returns A Promise that resolves to an array of messages marked as `saveToInbox`.
    */
   getInboxMessages(): Promise<IterableInAppMessage[]> {
-    Iterable?.logger?.log('InAppManager.getInboxMessages');
-
-    return RNIterableAPI.getInboxMessages() as unknown as Promise<IterableInAppMessage[]>;
+    return IterableApi.getInboxMessages() as unknown as Promise<
+      IterableInAppMessage[]
+    >;
   }
 
   /**
@@ -83,9 +98,7 @@ export class IterableInAppManager {
     message: IterableInAppMessage,
     consume: boolean
   ): Promise<string | null> {
-    Iterable?.logger?.log('InAppManager.show');
-
-    return RNIterableAPI.showMessage(message.messageId, consume);
+    return IterableApi.showMessage(message.messageId, consume);
   }
 
   /**
@@ -111,9 +124,7 @@ export class IterableInAppManager {
     location: IterableInAppLocation,
     source: IterableInAppDeleteSource
   ): void {
-    Iterable?.logger?.log('InAppManager.remove');
-
-    return RNIterableAPI.removeMessage(message.messageId, location, source);
+    return IterableApi.removeMessage(message.messageId, location, source);
   }
 
   /**
@@ -128,9 +139,7 @@ export class IterableInAppManager {
    * ```
    */
   setReadForMessage(message: IterableInAppMessage, read: boolean) {
-    Iterable?.logger?.log('InAppManager.setRead');
-
-    RNIterableAPI.setReadForMessage(message.messageId, read);
+    return IterableApi.setReadForMessage(message.messageId, read);
   }
 
   /**
@@ -148,9 +157,9 @@ export class IterableInAppManager {
   getHtmlContentForMessage(
     message: IterableInAppMessage
   ): Promise<IterableHtmlInAppContent> {
-    Iterable?.logger?.log('InAppManager.getHtmlContentForMessage');
-
-    return RNIterableAPI.getHtmlInAppContentForMessage(message.messageId) as unknown as Promise<IterableHtmlInAppContent>;
+    return IterableApi.getHtmlInAppContentForMessage(
+      message.messageId
+    ) as unknown as Promise<IterableHtmlInAppContent>;
   }
 
   /**
@@ -168,8 +177,6 @@ export class IterableInAppManager {
    * ```
    */
   setAutoDisplayPaused(paused: boolean) {
-    Iterable?.logger?.log('InAppManager.setAutoDisplayPaused');
-
-    RNIterableAPI.setAutoDisplayPaused(paused);
+    return IterableApi.setAutoDisplayPaused(paused);
   }
 }

src/inbox/classes/IterableInboxDataModel.ts

@@ -1,5 +1,4 @@
-import { RNIterableAPI } from '../../api';
-import { Iterable } from '../../core/classes/Iterable';
+import { IterableApi } from '../../core/classes/IterableApi';
 import {
   IterableHtmlInAppContent,
   IterableInAppDeleteSource,
@@ -94,11 +93,7 @@ export class IterableInboxDataModel {
    * @returns  A promise that resolves to the HTML content of the specified message.
    */
   getHtmlContentForMessageId(id: string): Promise<IterableHtmlInAppContent> {
-    Iterable?.logger?.log(
-      'IterableInboxDataModel.getHtmlContentForItem messageId: ' + id
-    );
-
-    return RNIterableAPI.getHtmlInAppContentForMessage(id).then(
+    return IterableApi.getHtmlInAppContentForMessage(id).then(
       (content: IterableHtmlInAppContentRaw) => {
         return IterableHtmlInAppContent.fromDict(content);
       }
@@ -111,9 +106,7 @@ export class IterableInboxDataModel {
    * @param id - The unique identifier of the message to be marked as read.
    */
   setMessageAsRead(id: string) {
-    Iterable?.logger?.log('IterableInboxDataModel.setMessageAsRead');
-
-    RNIterableAPI.setReadForMessage(id, true);
+    return IterableApi.setReadForMessage(id, true);
   }
 
   /**
@@ -123,9 +116,11 @@ export class IterableInboxDataModel {
    * @param deleteSource - The source from which the delete action is initiated.
    */
   deleteItemById(id: string, deleteSource: IterableInAppDeleteSource) {
-    Iterable?.logger?.log('IterableInboxDataModel.deleteItemById');
-
-    RNIterableAPI.removeMessage(id, IterableInAppLocation.inbox, deleteSource);
+    return IterableApi.removeMessage(
+      id,
+      IterableInAppLocation.inbox,
+      deleteSource
+    );
   }
 
   /**
@@ -135,7 +130,7 @@ export class IterableInboxDataModel {
    * If the fetch operation fails, the promise resolves to an empty array.
    */
   async refresh(): Promise<IterableInboxRowViewModel[]> {
-    return RNIterableAPI.getInboxMessages().then(
+    return IterableApi.getInboxMessages().then(
       (messages: IterableInAppMessage[]) => {
         return this.processMessages(messages);
       },
@@ -151,7 +146,7 @@ export class IterableInboxDataModel {
    * @param visibleRows - An array of `IterableInboxImpressionRowInfo` objects representing the rows that are currently visible.
    */
   startSession(visibleRows: IterableInboxImpressionRowInfo[] = []) {
-    RNIterableAPI.startSession(visibleRows as unknown as { [key: string]: string | number | boolean }[]);
+    return IterableApi.startSession(visibleRows);
   }
 
   /**
@@ -162,7 +157,7 @@ export class IterableInboxDataModel {
    */
   async endSession(visibleRows: IterableInboxImpressionRowInfo[] = []) {
     await this.updateVisibleRows(visibleRows);
-    RNIterableAPI.endSession();
+    return IterableApi.endSession();
   }
 
   /**
@@ -178,7 +173,7 @@ export class IterableInboxDataModel {
    *                      Defaults to an empty array if not provided.
    */
   updateVisibleRows(visibleRows: IterableInboxImpressionRowInfo[] = []) {
-    RNIterableAPI.updateVisibleRows(visibleRows as unknown as { [key: string]: string | number | boolean }[]);
+    return IterableApi.updateVisibleRows(visibleRows);
   }
 
   /**