[MALI-1400] Create interfaces for managing notifications and badge nu…

…mbers (#286)

* [MALI-1400] Create interfaces for managing notifications and badge numbers

* Prettier fix

* Prettier fix

js-miniapp-bridge/src/common-bridge.ts

@@ -32,6 +32,12 @@ import { HostThemeColor } from './types/host-color-scheme';
 import { MAAnalyticsInfo } from './types/analytics/analytics';
 import { UniversalBridgeInfo } from './types/universal-bridge';
 import { CookieInfo } from './types/cookie-info';
+import { NotificationBridge } from './notification-bridge';
+import {
+  NotificationDetailedInfo,
+  NotificationInfo,
+  NotificationInfoType,
+} from './types/notification/notification-info';
 
 /** @internal */
 const mabMessageQueue: Callback[] = [];
@@ -81,10 +87,12 @@ export class MiniAppBridge {
   platform: string;
   isSecureStorageReady = false;
   secureStorageLoadError: MiniAppError | null = null;
+  private notificationBridge: NotificationBridge;
 
   constructor(executor: PlatformExecutor) {
     this.executor = executor;
     this.platform = executor.getPlatform();
+    this.notificationBridge = new NotificationBridge(executor);
 
     if (window) {
       window.addEventListener(
@@ -840,6 +848,22 @@ export class MiniAppBridge {
       );
     });
   }
+
+  shouldClearNotifications(notificationType: NotificationInfoType) {
+    this.notificationBridge.shouldClearNotifications(notificationType);
+  }
+
+  shouldUpdateBadgeNumber(notificationInfo: NotificationInfo) {
+    this.notificationBridge.shouldUpdateBadgeNumber(notificationInfo);
+  }
+
+  shouldUpdateNotificationInfo(
+    notificationDetailedInfo: NotificationDetailedInfo
+  ) {
+    this.notificationBridge.shouldUpdateNotificationInfo(
+      notificationDetailedInfo
+    );
+  }
 }
 
 /**

js-miniapp-bridge/src/index.ts

@@ -63,6 +63,12 @@ import {
   ProductPrice,
 } from './types/in-app-purchase';
 import { CookieInfo } from './types/cookie-info';
+import {
+  NotificationDetailedInfo,
+  NotificationInfo,
+  NotificationInfoType,
+  NotificationInfoPriority,
+} from './types/notification/notification-info';
 
 export {
   MiniAppBridge,
@@ -113,4 +119,8 @@ export {
   MAAnalyticsEventType,
   UniversalBridgeInfo,
   CookieInfo,
+  NotificationInfo,
+  NotificationDetailedInfo,
+  NotificationInfoType,
+  NotificationInfoPriority,
 };

js-miniapp-bridge/src/notification-bridge.ts

@@ -0,0 +1,66 @@
+import { PlatformExecutor } from './common-bridge';
+import {
+  NotificationDetailedInfo,
+  NotificationInfo,
+  NotificationInfoType,
+} from './types/notification/notification-info';
+
+export class NotificationBridge {
+  executor: PlatformExecutor;
+  platform: string;
+
+  constructor(executor: PlatformExecutor) {
+    this.executor = executor;
+    this.platform = executor.getPlatform();
+  }
+
+  /**
+   * This method is used to clear any notifications in the Host application
+   * @param {notificationType} NotificationInfoType
+   * @see {shouldClearNotifications}
+   */
+  shouldClearNotifications(notificationType: NotificationInfoType) {
+    return new Promise<string>((resolve, reject) => {
+      return this.executor.exec(
+        'shouldClearNotifications',
+        { notificationType },
+        result => resolve(result),
+        error => reject(error)
+      );
+    });
+  }
+
+  /**
+   * This method is used to to update badge number for a specific notification info
+   * @param {notificationInfo} NotificationInfo
+   * @see {shouldUpdateBadgeNumber}
+   */
+  shouldUpdateBadgeNumber(notificationInfo: NotificationInfo) {
+    return new Promise<string>((resolve, reject) => {
+      return this.executor.exec(
+        'shouldUpdateBadgeNumber',
+        { notificationInfo },
+        result => resolve(result),
+        error => reject(error)
+      );
+    });
+  }
+
+  /**
+   * This method is used to share the notification detailed information to Host app
+   * @param {notificationDetailedInfo} NotificationDetailedInfo
+   * @see {shouldUpdateNotificationInfo}
+   */
+  shouldUpdateNotificationInfo(
+    notificationDetailedInfo: NotificationDetailedInfo
+  ) {
+    return new Promise<string>((resolve, reject) => {
+      return this.executor.exec(
+        'shouldUpdateNotificationInfo',
+        { notificationDetailedInfo },
+        result => resolve(result),
+        error => reject(error)
+      );
+    });
+  }
+}

js-miniapp-bridge/src/types/notification/notification-info.ts

@@ -0,0 +1,44 @@
+export enum NotificationInfoType {
+  CALLS,
+  MESSAGES,
+  HOME,
+  MAIL,
+  PROFILE,
+  SUPPORT,
+  CUSTOM,
+}
+
+export enum NotificationInfoPriority {
+  CRITICAL,
+  MAJOR,
+  MINOR,
+  NORMAL,
+  OFFERS,
+  MAINTENANCE,
+}
+
+/**
+ * Notification Info
+ */
+export interface NotificationInfo {
+  badgeNumber?: number;
+  notificationInfoType?: NotificationInfoType;
+  notificationInfoPriority?: NotificationInfoPriority;
+  clearAfterRead?: boolean;
+}
+
+/**
+ * Notification DetailedInfo
+ */
+export interface NotificationDetailedInfo {
+  title?: string;
+  body?: string;
+  icon?: string;
+  url?: string;
+  timestamp?: Date;
+  additionalData?: string;
+  badgeNumber?: number;
+  notificationInfoType?: NotificationInfoType;
+  notificationInfoPriority?: NotificationInfoPriority;
+  clearAfterRead?: boolean;
+}