remove events constants for interface instead

Author: fadi-george

__test__/support/environment/TestEnvironmentHelpers.ts

@@ -6,7 +6,6 @@ import { SubscriptionType } from 'src/shared/subscriptions/constants';
 import { CoreModuleDirector } from '../../../src/core/CoreModuleDirector';
 import NotificationsNamespace from '../../../src/onesignal/NotificationsNamespace';
 import OneSignal from '../../../src/onesignal/OneSignal';
-import { ONESIGNAL_EVENTS } from '../../../src/onesignal/OneSignalEvents';
 import User from '../../../src/onesignal/User';
 import UserNamespace from '../../../src/onesignal/UserNamespace';
 import Context from '../../../src/page/models/Context';
@@ -23,7 +22,6 @@ declare const global: {
 
 export function initOSGlobals(config: TestEnvironmentConfig = {}) {
   global.OneSignal = OneSignal;
-  global.OneSignal.EVENTS = ONESIGNAL_EVENTS;
   global.OneSignal.config = TestContext.getFakeMergedConfig(config);
   global.OneSignal._context = new Context(global.OneSignal.config);
   global.OneSignal._initialized = true;

__test__/unit/events/eventsUnique.test.ts

@@ -32,7 +32,7 @@ describe('Register for push', () => {
     const promise = OneSignal.User.PushSubscription.optIn();
 
     expect(spy).not.toHaveBeenCalled();
-    OneSignalEvent._trigger(OneSignal.EVENTS.SDK_INITIALIZED);
+    OneSignalEvent._trigger('initializeInternal');
     await promise;
     expect(OneSignal._initialized).toBe(true);
     expect(spy).toHaveBeenCalledTimes(1);

__test__/unit/push/registerForPush.test.ts

@@ -30,13 +30,10 @@ export default class NotificationsNamespace extends EventListenerBase {
     this._permission = permissionNative === 'granted';
 
     if (typeof OneSignal !== 'undefined') {
-      OneSignal._emitter.on(
-        OneSignal.EVENTS.NOTIFICATION_PERMISSION_CHANGED_AS_STRING,
-        (permissionNative: NotificationPermission) => {
-          this._permissionNative = permissionNative;
-          this._permission = permissionNative === 'granted';
-        },
-      );
+      OneSignal._emitter.on('permissionChangeAsString', (permissionNative) => {
+        this._permissionNative = permissionNative;
+        this._permission = permissionNative === 'granted';
+      });
     }
   }
 

src/onesignal/NotificationsNamespace.ts

@@ -678,7 +678,7 @@ describe('OneSignal - No Consent Required', () => {
 
         test('login then accept web push permissions - it should make two user calls', async () => {
           const { promise, resolve } = Promise.withResolvers();
-          OneSignal._emitter.on(OneSignal.EVENTS.SUBSCRIPTION_CHANGED, resolve);
+          OneSignal._emitter.on('change', resolve);
           setGetUserResponse();
           setCreateUserResponse({
             onesignalId: ONESIGNAL_ID,

src/onesignal/OneSignal.test.ts

@@ -43,14 +43,11 @@ import Emitter from '../shared/libraries/Emitter';
 import Log from '../shared/libraries/Log';
 import DebugNamespace from './DebugNamesapce';
 import NotificationsNamespace from './NotificationsNamespace';
-import { ONESIGNAL_EVENTS } from './OneSignalEvents';
 import { SessionNamespace } from './SessionNamespace';
 import SlidedownNamespace from './SlidedownNamespace';
 import UserNamespace from './UserNamespace';
 
 export default class OneSignal {
-  static EVENTS = ONESIGNAL_EVENTS;
-
   static _consentGiven = false;
 
   private static async _initializeCoreModuleAndOSNamespaces() {
@@ -176,14 +173,11 @@ export default class OneSignal {
       OneSignal._initAlreadyCalled = true;
 
       OneSignal._emitter.on(
-        OneSignal.EVENTS.NOTIFICATION_PERMISSION_CHANGED_AS_STRING,
+        'permissionChangeAsString',
         checkAndTriggerSubscriptionChanged,
       );
-      OneSignal._emitter.on(
-        OneSignal.EVENTS.SUBSCRIPTION_CHANGED,
-        _onSubscriptionChanged,
-      );
-      OneSignal._emitter.on(OneSignal.EVENTS.SDK_INITIALIZED, onSdkInitialized);
+      OneSignal._emitter.on('change', _onSubscriptionChanged);
+      OneSignal._emitter.on('initializeInternal', onSdkInitialized);
 
       window.addEventListener('focus', () => {
         // Checks if permission changed every time a user focuses on the page,

src/onesignal/OneSignal.ts

@@ -12,7 +12,8 @@ import {
   onInternalSubscriptionSet,
 } from 'src/shared/listeners';
 import { IDManager } from 'src/shared/managers/IDManager';
-import type { SubscriptionChangeEvent } from '../page/models/SubscriptionChangeEvent';
+import type { EventsMap } from 'src/shared/services/types';
+import type { UserSubscription } from 'src/shared/subscriptions/types';
 import { EventListenerBase } from '../page/userModel/EventListenerBase';
 import Log from '../shared/libraries/Log';
 import { isCompleteSubscriptionObject } from '../shared/managers/utils';
@@ -56,20 +57,14 @@ export default class PushSubscriptionNamespace extends EventListenerBase {
         Log._error(e);
       });
 
-    OneSignal._emitter.on(
-      OneSignal.EVENTS.SUBSCRIPTION_CHANGED,
-      async (change: SubscriptionChangeEvent | undefined) => {
-        this._id = change?.current.id;
-        this._token = change?.current.token;
-      },
-    );
-
-    OneSignal._emitter.on(
-      OneSignal.EVENTS.NOTIFICATION_PERMISSION_CHANGED_AS_STRING,
-      async (permission: NotificationPermission) => {
-        this._permission = permission;
-      },
-    );
+    OneSignal._emitter.on('change', async (change) => {
+      this._id = change?.current.id;
+      this._token = change?.current.token;
+    });
+
+    OneSignal._emitter.on('permissionChangeAsString', async (permission) => {
+      this._permission = permission;
+    });
   }
 
   get id(): string | null | undefined {
@@ -110,14 +105,14 @@ export default class PushSubscriptionNamespace extends EventListenerBase {
 
   addEventListener(
     event: 'change',
-    listener: (change: SubscriptionChangeEvent) => void,
+    listener: (change: EventsMap['change']) => void,
   ): void {
     OneSignal._emitter.on(event, listener);
   }
 
   removeEventListener(
     event: 'change',
-    listener: (change: SubscriptionChangeEvent) => void,
+    listener: (change: EventsMap['change']) => void,
   ): void {
     OneSignal._emitter.off(event, listener);
   }

src/onesignal/OneSignalEvents.ts

@@ -1,3 +1,5 @@
+import type { UserEventsMap } from 'src/shared/services/types';
+import type { UserSubscription } from 'src/shared/subscriptions/types';
 import type { UserChangeEvent } from '../page/models/UserChangeEvent';
 import { EventListenerBase } from '../page/userModel/EventListenerBase';
 import Emitter from '../shared/libraries/Emitter';
@@ -10,7 +12,7 @@ export default class UserNamespace extends EventListenerBase {
 
   readonly PushSubscription = new PushSubscriptionNamespace(false);
 
-  static _emitter = new Emitter();
+  static _emitter = new Emitter<UserEventsMap>();
 
   constructor(
     initialize: boolean,
@@ -111,7 +113,7 @@ export default class UserNamespace extends EventListenerBase {
 
   addEventListener(
     event: 'change',
-    listener: (userChange: UserChangeEvent) => void,
+    listener: (userChange: UserEventsMap['change']) => void,
   ): void {
     UserNamespace._emitter.on(event, listener);
   }

src/onesignal/PushSubscriptionNamespace.ts

@@ -18,15 +18,13 @@ import Log from '../../shared/libraries/Log';
 import OneSignalEvent from '../../shared/services/OneSignalEvent';
 import { once } from '../../shared/utils/utils';
 import { DismissPrompt } from '../models/Dismiss';
-import type { SubscriptionChangeEvent } from '../models/SubscriptionChangeEvent';
 import { ResourceLoadState } from '../services/DynamicResourceLoader';
 import Badge from './Badge';
 import Button from './Button';
 import Dialog from './Dialog';
 import Launcher from './Launcher';
 import Message from './Message';
 import {
-  BellEvent,
   BellState,
   type BellStateValue,
   MESSAGE_TIMEOUT,
@@ -173,7 +171,7 @@ export default class Bell {
 
   private _installEventHooks() {
     // Install event hooks
-    OneSignal._emitter.on(BellEvent._SubscribeClick, () => {
+    OneSignal._emitter.on('notifyButtonSubscribeClick', () => {
       const subscribeButton = this._dialog._subscribeButton;
       if (subscribeButton) {
         subscribeButton.disabled = true;
@@ -206,7 +204,7 @@ export default class Bell {
         });
     });
 
-    OneSignal._emitter.on(BellEvent._UnsubscribeClick, () => {
+    OneSignal._emitter.on('notifyButtonUnsubscribeClick', () => {
       const unsubscribeButton = this._dialog._unsubscribeButton;
       if (unsubscribeButton) {
         unsubscribeButton.disabled = true;
@@ -234,7 +232,7 @@ export default class Bell {
         });
     });
 
-    OneSignal._emitter.on(BellEvent._Hovering, () => {
+    OneSignal._emitter.on('notifyButtonHovering', () => {
       this._hovering = true;
       this._launcher._activateIfInactive();
 
@@ -278,7 +276,7 @@ export default class Bell {
         });
     });
 
-    OneSignal._emitter.on(BellEvent._Hovered, () => {
+    OneSignal._emitter.on('notifyButtonHover', () => {
       // If a message is displayed (and not a tip), don't control it. Visitors have no control over messages
       if (this._message._contentType === MessageType._Message) {
         return;
@@ -317,34 +315,31 @@ export default class Bell {
       }
     });
 
-    OneSignal._emitter.on(
-      OneSignal.EVENTS.SUBSCRIPTION_CHANGED,
-      async (isSubscribed: SubscriptionChangeEvent) => {
-        if (isSubscribed.current.optedIn) {
-          if (this._badge._shown && this._options.prenotify) {
-            this._badge._hide();
-          }
-          if (this._dialog._notificationIcons === null) {
-            const icons = await getNotificationIcons();
-            this._dialog._notificationIcons = icons;
-          }
+    OneSignal._emitter.on('change', async (isSubscribed) => {
+      if (isSubscribed?.current.optedIn) {
+        if (this._badge._shown && this._options.prenotify) {
+          this._badge._hide();
         }
-
-        const permission =
-          await OneSignal._context._permissionManager._getPermissionStatus();
-        let bellState: BellStateValue;
-        if (isSubscribed.current.optedIn) {
-          bellState = BellState._Subscribed;
-        } else if (permission === 'denied') {
-          bellState = BellState._Blocked;
-        } else {
-          bellState = BellState._Unsubscribed;
+        if (this._dialog._notificationIcons === null) {
+          const icons = await getNotificationIcons();
+          this._dialog._notificationIcons = icons;
         }
-        this._setState(bellState, this._ignoreSubscriptionState);
-      },
-    );
+      }
+
+      const permission =
+        await OneSignal._context._permissionManager._getPermissionStatus();
+      let bellState: BellStateValue;
+      if (isSubscribed?.current.optedIn) {
+        bellState = BellState._Subscribed;
+      } else if (permission === 'denied') {
+        bellState = BellState._Blocked;
+      } else {
+        bellState = BellState._Unsubscribed;
+      }
+      this._setState(bellState, this._ignoreSubscriptionState);
+    });
 
-    OneSignal._emitter.on(BellEvent._StateChanged, (state) => {
+    OneSignal._emitter.on('notifyButtonStateChange', (state) => {
       if (!this._launcher._element) {
         // Notify button doesn't exist
         return;
@@ -359,12 +354,9 @@ export default class Bell {
       }
     });
 
-    OneSignal._emitter.on(
-      OneSignal.EVENTS.NOTIFICATION_PERMISSION_CHANGED_AS_STRING,
-      () => {
-        this._updateState();
-      },
-    );
+    OneSignal._emitter.on('permissionChangeAsString', () => {
+      this._updateState();
+    });
   }
 
   private _addDefaultClasses() {
@@ -721,7 +713,7 @@ export default class Bell {
     const lastState = this._state;
     this._state = newState;
     if (lastState !== newState && !silent) {
-      OneSignalEvent._trigger(BellEvent._StateChanged, {
+      OneSignalEvent._trigger('notifyButtonStateChange', {
         from: lastState,
         to: newState,
       });