Merge branch 'jwt/MOB-12231-create-an-iterableapi-class-for-api-calls' into jwt/MOB-12298-new-improve-logger

Author: lposen

src/core/classes/IterableAuthManager.ts

@@ -1,5 +1,5 @@
-import RNIterableAPI from '../../api';
 import { IterableAuthResponse } from './IterableAuthResponse';
+import { IterableApi } from './IterableApi';
 
 /**
  * Manages the authentication for the Iterable SDK.
@@ -22,7 +22,7 @@ export class IterableAuthManager {
    * ```
    */
   pauseAuthRetries(pauseRetry: boolean) {
-    return RNIterableAPI.pauseAuthRetries(pauseRetry);
+    return IterableApi.pauseAuthRetries(pauseRetry);
   }
 
   /**
@@ -33,6 +33,6 @@ export class IterableAuthManager {
   passAlongAuthToken(
     authToken: string | null | undefined
   ): Promise<IterableAuthResponse | string | undefined> {
-    return RNIterableAPI.passAlongAuthToken(authToken);
+    return IterableApi.passAlongAuthToken(authToken);
   }
 }

src/inApp/classes/IterableInAppManager.ts

@@ -1,5 +1,4 @@
-import { RNIterableAPI } from '../../api';
-import { IterableLogger } from '../../core/classes/IterableLogger';
+import { IterableApi } from '../../core/classes/IterableApi';
 import type {
   IterableInAppDeleteSource,
   IterableInAppLocation,
@@ -14,6 +13,20 @@ 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 inAppManager = new IterableInAppManager();
+ *
+ * inAppManager.getMessages().then(messages => {
+ *   console.log('Messages:', messages);
+ * });
+ *
+ * // You can also access an instance on `Iterable.inAppManager.inAppManager`
+ * Iterable.inAppManager.getMessages().then(messages => {
+ *   console.log('Messages:', messages);
+ * });
+ * ```
  */
 export class IterableInAppManager {
   /**
@@ -33,9 +46,7 @@ export class IterableInAppManager {
    * @returns A Promise that resolves to an array of in-app messages.
    */
   getMessages(): Promise<IterableInAppMessage[]> {
-    IterableLogger?.log('InAppManager.getMessages');
-
-    return RNIterableAPI.getInAppMessages() as unknown as Promise<
+    return IterableApi.getInAppMessages() as unknown as Promise<
       IterableInAppMessage[]
     >;
   }
@@ -58,9 +69,7 @@ export class IterableInAppManager {
    * @returns A Promise that resolves to an array of messages marked as `saveToInbox`.
    */
   getInboxMessages(): Promise<IterableInAppMessage[]> {
-    IterableLogger?.log('InAppManager.getInboxMessages');
-
-    return RNIterableAPI.getInboxMessages() as unknown as Promise<
+    return IterableApi.getInboxMessages() as unknown as Promise<
       IterableInAppMessage[]
     >;
   }
@@ -87,9 +96,7 @@ export class IterableInAppManager {
     message: IterableInAppMessage,
     consume: boolean
   ): Promise<string | null> {
-    IterableLogger?.log('InAppManager.show');
-
-    return RNIterableAPI.showMessage(message.messageId, consume);
+    return IterableApi.showMessage(message.messageId, consume);
   }
 
   /**
@@ -115,9 +122,7 @@ export class IterableInAppManager {
     location: IterableInAppLocation,
     source: IterableInAppDeleteSource
   ): void {
-    IterableLogger?.log('InAppManager.remove');
-
-    return RNIterableAPI.removeMessage(message.messageId, location, source);
+    return IterableApi.removeMessage(message.messageId, location, source);
   }
 
   /**
@@ -132,9 +137,7 @@ export class IterableInAppManager {
    * ```
    */
   setReadForMessage(message: IterableInAppMessage, read: boolean) {
-    IterableLogger?.log('InAppManager.setRead');
-
-    RNIterableAPI.setReadForMessage(message.messageId, read);
+    return IterableApi.setReadForMessage(message.messageId, read);
   }
 
   /**
@@ -152,11 +155,7 @@ export class IterableInAppManager {
   getHtmlContentForMessage(
     message: IterableInAppMessage
   ): Promise<IterableHtmlInAppContent> {
-    IterableLogger?.log('InAppManager.getHtmlContentForMessage');
-
-    return RNIterableAPI.getHtmlInAppContentForMessage(
-      message.messageId
-    ) as unknown as Promise<IterableHtmlInAppContent>;
+    return IterableApi.getHtmlInAppContentForMessage(message.messageId);
   }
 
   /**
@@ -174,8 +173,6 @@ export class IterableInAppManager {
    * ```
    */
   setAutoDisplayPaused(paused: boolean) {
-    IterableLogger?.log('InAppManager.setAutoDisplayPaused');
-
-    RNIterableAPI.setAutoDisplayPaused(paused);
+    return IterableApi.setAutoDisplayPaused(paused);
   }
 }

src/inbox/classes/IterableInboxDataModel.ts

@@ -1,5 +1,4 @@
-import { RNIterableAPI } from '../../api';
-import { IterableLogger } from '../../core/classes/IterableLogger';
+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> {
-    IterableLogger?.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) {
-    IterableLogger?.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) {
-    IterableLogger?.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,9 +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);
   }
 
   /**
@@ -164,7 +157,7 @@ export class IterableInboxDataModel {
    */
   async endSession(visibleRows: IterableInboxImpressionRowInfo[] = []) {
     await this.updateVisibleRows(visibleRows);
-    RNIterableAPI.endSession();
+    return IterableApi.endSession();
   }
 
   /**
@@ -180,9 +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);
   }
 
   /**