@metamask/notification-services-controller 18.3.1 → 20.0.0

package/dist/NotificationServicesController/NotificationServicesController.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getBearerToken, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
+var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_locale, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getBearerToken, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
 function $importDefault(module) {
     if (module?.__esModule) {
         return module.default;
@@ -24,8 +24,8 @@ import $log from "loglevel";
 const log = $importDefault($log);
 import { TRIGGER_TYPES } from "./constants/notification-schema.mjs";
 import { processAndFilterNotifications, safeProcessNotification } from "./processors/process-notifications.mjs";
-import * as FeatureNotifications from "./services/feature-announcements.mjs";
-import * as OnChainNotifications from "./services/onchain-notifications.mjs";
+import { getAPINotifications, getNotificationsApiConfigCached, markNotificationsAsRead, updateOnChainNotifications } from "./services/api-notifications.mjs";
+import { getFeatureAnnouncementNotifications } from "./services/feature-announcements.mjs";
 import { createPerpOrderNotification } from "./services/perp-notifications.mjs";
 // Unique name for the controller
 const controllerName = 'NotificationServicesController';
@@ -33,61 +33,61 @@ const metadata = {
     subscriptionAccountsSeen: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: true,
+        includeInDebugSnapshot: true,
         usedInUi: true,
     },
     isMetamaskNotificationsFeatureSeen: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     isNotificationServicesEnabled: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     isFeatureAnnouncementsEnabled: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     metamaskNotificationsList: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: true,
+        includeInDebugSnapshot: true,
         usedInUi: true,
     },
     metamaskNotificationsReadList: {
         includeInStateLogs: false,
         persist: true,
-        anonymous: true,
+        includeInDebugSnapshot: true,
         usedInUi: true,
     },
     isUpdatingMetamaskNotifications: {
         includeInStateLogs: false,
         persist: false,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     isFetchingMetamaskNotifications: {
         includeInStateLogs: false,
         persist: false,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     isUpdatingMetamaskNotificationsAccount: {
         includeInStateLogs: false,
         persist: false,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     isCheckingAccountsPresence: {
         includeInStateLogs: false,
         persist: false,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
 };
@@ -118,7 +118,7 @@ class NotificationServicesController extends BaseController {
      * @param args.state - Initial state to set on this controller.
      * @param args.env - environment variables for a given controller.
      * @param args.env.featureAnnouncements - env variables for feature announcements.
-     * @param args.env.isPushIntegrated - toggle push notifications on/off if client has integrated them.
+     * @param args.env.locale - users locale for better dynamic server notifications
      */
     constructor({ messenger, state, env, }) {
         super({
@@ -131,29 +131,29 @@ class NotificationServicesController extends BaseController {
         _NotificationServicesController_keyringController.set(this, {
             isUnlocked: false,
             setupLockedStateSubscriptions: (onUnlock) => {
-                const { isUnlocked } = this.messagingSystem.call('KeyringController:getState');
+                const { isUnlocked } = this.messenger.call('KeyringController:getState');
                 __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = isUnlocked;
-                this.messagingSystem.subscribe('KeyringController:unlock', () => {
+                this.messenger.subscribe('KeyringController:unlock', () => {
                     __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = true;
                     // messaging system cannot await promises
                     // we don't need to wait for a result on this.
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     onUnlock();
                 });
-                this.messagingSystem.subscribe('KeyringController:lock', () => {
+                this.messenger.subscribe('KeyringController:lock', () => {
                     __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = false;
                 });
             },
         });
         _NotificationServicesController_auth.set(this, {
             getBearerToken: async () => {
-                return await this.messagingSystem.call('AuthenticationController:getBearerToken');
+                return await this.messenger.call('AuthenticationController:getBearerToken');
             },
             isSignedIn: () => {
-                return this.messagingSystem.call('AuthenticationController:isSignedIn');
+                return this.messenger.call('AuthenticationController:isSignedIn');
             },
             signIn: async () => {
-                return await this.messagingSystem.call('AuthenticationController:performSignIn');
+                return await this.messenger.call('AuthenticationController:performSignIn');
             },
         });
         _NotificationServicesController_pushNotifications.set(this, {
@@ -162,11 +162,11 @@ class NotificationServicesController extends BaseController {
             // To ensure we subscribe to the most up-to-date notifications
             isSetup: false,
             subscribeToPushNotifications: async () => {
-                await this.messagingSystem.call('NotificationServicesPushController:subscribeToPushNotifications');
+                await this.messenger.call('NotificationServicesPushController:subscribeToPushNotifications');
             },
             enablePushNotifications: async (addresses) => {
                 try {
-                    await this.messagingSystem.call('NotificationServicesPushController:enablePushNotifications', addresses);
+                    await this.messenger.call('NotificationServicesPushController:enablePushNotifications', addresses);
                 }
                 catch (e) {
                     log.error('Silently failed to enable push notifications', e);
@@ -174,14 +174,14 @@ class NotificationServicesController extends BaseController {
             },
             disablePushNotifications: async () => {
                 try {
-                    await this.messagingSystem.call('NotificationServicesPushController:disablePushNotifications');
+                    await this.messenger.call('NotificationServicesPushController:disablePushNotifications');
                 }
                 catch (e) {
                     log.error('Silently failed to disable push notifications', e);
                 }
             },
             subscribe: () => {
-                this.messagingSystem.subscribe('NotificationServicesPushController:onNewNotifications', (notification) => {
+                this.messenger.subscribe('NotificationServicesPushController:onNewNotifications', (notification) => {
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     this.updateMetamaskNotificationsList(notification);
                 });
@@ -215,7 +215,7 @@ class NotificationServicesController extends BaseController {
             // Flag to ensure we only setup once
             isNotificationAccountsSetup: false,
             getNotificationAccounts: () => {
-                const { keyrings } = this.messagingSystem.call('KeyringController:getState');
+                const { keyrings } = this.messenger.call('KeyringController:getState');
                 const firstHDKeyring = keyrings.find((k) => k.type === KeyringTypes.hd.toString());
                 const keyringAccounts = firstHDKeyring?.accounts ?? null;
                 return keyringAccounts;
@@ -278,7 +278,7 @@ class NotificationServicesController extends BaseController {
              * And call effects to subscribe/unsubscribe to notifications.
              */
             subscribe: () => {
-                this.messagingSystem.subscribe('KeyringController:stateChange', async (totalAccounts, prevTotalAccounts) => {
+                this.messenger.subscribe('KeyringController:stateChange', async (totalAccounts, prevTotalAccounts) => {
                     const hasTotalAccountsChanged = totalAccounts !== prevTotalAccounts;
                     if (!this.state.isNotificationServicesEnabled ||
                         !hasTotalAccountsChanged) {
@@ -299,8 +299,10 @@ class NotificationServicesController extends BaseController {
                 });
             },
         });
+        _NotificationServicesController_locale.set(this, void 0);
         _NotificationServicesController_featureAnnouncementEnv.set(this, void 0);
         __classPrivateFieldSet(this, _NotificationServicesController_featureAnnouncementEnv, env.featureAnnouncements, "f");
+        __classPrivateFieldSet(this, _NotificationServicesController_locale, env.locale ?? (() => 'en'), "f");
         __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_registerMessageHandlers).call(this);
         __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_clearLoadingStates).call(this);
     }
@@ -322,7 +324,7 @@ class NotificationServicesController extends BaseController {
         try {
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
             const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
-            const addressesWithNotifications = await OnChainNotifications.getOnChainNotificationsConfigCached(bearerToken, accounts);
+            const addressesWithNotifications = await getNotificationsApiConfigCached(bearerToken, accounts);
             const addresses = addressesWithNotifications
                 .filter((a) => Boolean(a.enabled))
                 .map((a) => a.address);
@@ -345,7 +347,7 @@ class NotificationServicesController extends BaseController {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsCheckingAccountsPresence).call(this, true);
             // Retrieve user storage
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-            const addressesWithNotifications = await OnChainNotifications.getOnChainNotificationsConfigCached(bearerToken, accounts);
+            const addressesWithNotifications = await getNotificationsApiConfigCached(bearerToken, accounts);
             const result = {};
             addressesWithNotifications.forEach((a) => {
                 result[a.address] = a.enabled;
@@ -397,7 +399,7 @@ class NotificationServicesController extends BaseController {
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
             const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
             // 1. See if has enabled notifications before
-            const addressesWithNotifications = await OnChainNotifications.getOnChainNotificationsConfigCached(bearerToken, accounts);
+            const addressesWithNotifications = await getNotificationsApiConfigCached(bearerToken, accounts);
             // Notifications API can return array with addresses set to false
             // So assert that at least one address is enabled
             let accountsWithNotifications = addressesWithNotifications
@@ -405,7 +407,7 @@ class NotificationServicesController extends BaseController {
                 .map((a) => a.address);
             // 2. Enable Notifications (if no accounts subscribed or we are resetting)
             if (accountsWithNotifications.length === 0 || opts?.resetNotifications) {
-                await OnChainNotifications.updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: true })));
+                await updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: true })));
                 accountsWithNotifications = accounts;
             }
             // 3. Lazily enable push notifications (FCM may take some time, so keeps UI unblocked)
@@ -497,7 +499,7 @@ class NotificationServicesController extends BaseController {
             // Get and Validate BearerToken and User Storage Key
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
             // Delete these UUIDs (Mutates User Storage)
-            await OnChainNotifications.updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: false })));
+            await updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: false })));
         }
         catch (err) {
             log.error('Failed to delete OnChain triggers', err);
@@ -526,7 +528,7 @@ class NotificationServicesController extends BaseController {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_updateUpdatingAccountsState).call(this, accounts);
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-            await OnChainNotifications.updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: true })));
+            await updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: true })));
         }
         catch (err) {
             log.error('Failed to update OnChain triggers', err);
@@ -554,7 +556,7 @@ class NotificationServicesController extends BaseController {
             const isGlobalNotifsEnabled = this.state.isNotificationServicesEnabled;
             // Raw Feature Notifications
             const rawAnnouncements = isGlobalNotifsEnabled && this.state.isFeatureAnnouncementsEnabled
-                ? await FeatureNotifications.getFeatureAnnouncementNotifications(__classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f"), previewToken).catch(() => [])
+                ? await getFeatureAnnouncementNotifications(__classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f"), previewToken).catch(() => [])
                 : [];
             // Raw On Chain Notifications
             const rawOnChainNotifications = [];
@@ -562,10 +564,10 @@ class NotificationServicesController extends BaseController {
                 try {
                     const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
                     const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
-                    const addressesWithNotifications = (await OnChainNotifications.getOnChainNotificationsConfigCached(bearerToken, accounts))
+                    const addressesWithNotifications = (await getNotificationsApiConfigCached(bearerToken, accounts))
                         .filter((a) => Boolean(a.enabled))
                         .map((a) => a.address);
-                    const notifications = await OnChainNotifications.getOnChainNotifications(bearerToken, addressesWithNotifications).catch(() => []);
+                    const notifications = await getAPINotifications(bearerToken, addressesWithNotifications, __classPrivateFieldGet(this, _NotificationServicesController_locale, "f").call(this), __classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f").platform).catch(() => []);
                     rawOnChainNotifications.push(...notifications);
                 }
                 catch {
@@ -588,7 +590,7 @@ class NotificationServicesController extends BaseController {
             this.update((state) => {
                 state.metamaskNotificationsList = metamaskNotifications;
             });
-            this.messagingSystem.publish(`${controllerName}:notificationsListUpdated`, this.state.metamaskNotificationsList);
+            this.messenger.publish(`${controllerName}:notificationsListUpdated`, this.state.metamaskNotificationsList);
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsFetchingMetamaskNotifications).call(this, false);
             return metamaskNotifications;
         }
@@ -642,7 +644,7 @@ class NotificationServicesController extends BaseController {
         for (const id of ids) {
             await this.deleteNotificationById(id);
         }
-        this.messagingSystem.publish(`${controllerName}:notificationsListUpdated`, this.state.metamaskNotificationsList);
+        this.messenger.publish(`${controllerName}:notificationsListUpdated`, this.state.metamaskNotificationsList);
     }
     /**
      * Marks specified metamask notifications as read.
@@ -675,7 +677,7 @@ class NotificationServicesController extends BaseController {
                 const bearerToken = await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").getBearerToken();
                 if (bearerToken) {
                     onchainNotificationIds = onChainNotifications.map((notification) => notification.id);
-                    await OnChainNotifications.markNotificationsAsRead(bearerToken, onchainNotificationIds).catch(() => {
+                    await markNotificationsAsRead(bearerToken, onchainNotificationIds).catch(() => {
                         onchainNotificationIds = [];
                         log.warn('Unable to mark onchain notifications as read');
                     });
@@ -718,7 +720,7 @@ class NotificationServicesController extends BaseController {
                 return notification;
             });
         });
-        this.messagingSystem.publish(`${controllerName}:markNotificationsAsRead`, this.state.metamaskNotificationsList);
+        this.messenger.publish(`${controllerName}:markNotificationsAsRead`, this.state.metamaskNotificationsList);
     }
     /**
      * Updates the list of MetaMask notifications by adding a new notification at the beginning of the list.
@@ -743,7 +745,7 @@ class NotificationServicesController extends BaseController {
                     ];
                 }
             });
-            this.messagingSystem.publish(`${controllerName}:notificationsListUpdated`, this.state.metamaskNotificationsList);
+            this.messenger.publish(`${controllerName}:notificationsListUpdated`, this.state.metamaskNotificationsList);
         }
     }
     /**
@@ -762,11 +764,11 @@ class NotificationServicesController extends BaseController {
         }
     }
 }
-_NotificationServicesController_keyringController = new WeakMap(), _NotificationServicesController_auth = new WeakMap(), _NotificationServicesController_pushNotifications = new WeakMap(), _NotificationServicesController_accounts = new WeakMap(), _NotificationServicesController_featureAnnouncementEnv = new WeakMap(), _NotificationServicesController_instances = new WeakSet(), _NotificationServicesController_registerMessageHandlers = function _NotificationServicesController_registerMessageHandlers() {
-    this.messagingSystem.registerActionHandler(`${controllerName}:updateMetamaskNotificationsList`, this.updateMetamaskNotificationsList.bind(this));
-    this.messagingSystem.registerActionHandler(`${controllerName}:disableNotificationServices`, this.disableNotificationServices.bind(this));
-    this.messagingSystem.registerActionHandler(`${controllerName}:getNotificationsByType`, this.getNotificationsByType.bind(this));
-    this.messagingSystem.registerActionHandler(`${controllerName}:deleteNotificationsById`, this.deleteNotificationsById.bind(this));
+_NotificationServicesController_keyringController = new WeakMap(), _NotificationServicesController_auth = new WeakMap(), _NotificationServicesController_pushNotifications = new WeakMap(), _NotificationServicesController_accounts = new WeakMap(), _NotificationServicesController_locale = new WeakMap(), _NotificationServicesController_featureAnnouncementEnv = new WeakMap(), _NotificationServicesController_instances = new WeakSet(), _NotificationServicesController_registerMessageHandlers = function _NotificationServicesController_registerMessageHandlers() {
+    this.messenger.registerActionHandler(`${controllerName}:updateMetamaskNotificationsList`, this.updateMetamaskNotificationsList.bind(this));
+    this.messenger.registerActionHandler(`${controllerName}:disableNotificationServices`, this.disableNotificationServices.bind(this));
+    this.messenger.registerActionHandler(`${controllerName}:getNotificationsByType`, this.getNotificationsByType.bind(this));
+    this.messenger.registerActionHandler(`${controllerName}:deleteNotificationsById`, this.deleteNotificationsById.bind(this));
 }, _NotificationServicesController_clearLoadingStates = function _NotificationServicesController_clearLoadingStates() {
     this.update((state) => {
         state.isUpdatingMetamaskNotifications = false;