@metamask/notification-services-controller 0.21.0 → 1.0.0

package/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0]
+
+### Added
+
+- added new public methods `enablePushNotifications` and `disablePushNotification` on `NotificationServicesController` ([#5120](https://github.com/MetaMask/core/pull/5120))
+- added `isPushEnabled` and `isUpdatingFCMToken` to `NotificationServicesPushController` state ([#5120](https://github.com/MetaMask/core/pull/5120))
+- added `/push-services/web` subpath export to make it easier to import web helpers ([#5120](https://github.com/MetaMask/core/pull/5120))
+
+### Changed
+
+- **BREAKING**: updated `NotificationServicesPushController` constructor config to require a push interface ([#5120](https://github.com/MetaMask/core/pull/5120))
+- Optimized API calls for creating push notification links ([#5358](https://github.com/MetaMask/core/pull/5358))
+- Bump `@metamask/utils` from `^11.1.0` to `^11.2.0` ([#5301](https://github.com/MetaMask/core/pull/5301))
+
+### Fixed
+
+- only allow hex addresses when creating notifications ([#5343](https://github.com/MetaMask/core/pull/5343))
+
 ## [0.21.0]
 
 ### Added
@@ -48,7 +66,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Bump depenency `firebase` from `^10.11.0` to `^11.2.0` ([#5196](https://github.com/MetaMask/core/pull/5196))
+- Bump `firebase` from `^10.11.0` to `^11.2.0` ([#5196](https://github.com/MetaMask/core/pull/5196))
 
 ## [0.16.0]
 
@@ -93,7 +111,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- fix: allow snap notifications to be visbible when controller is disabled ([#4890](https://github.com/MetaMask/core/pull/4890))
+- fix: allow snap notifications to be visible when controller is disabled ([#4890](https://github.com/MetaMask/core/pull/4890))
   - Most notification services are switched off when the controller is disabled, but since snaps are "local notifications", they need to be visible irrespective to the controller disabled state.
 
 ## [0.12.0]
@@ -319,7 +337,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@0.21.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@0.21.0...@metamask/notification-services-controller@1.0.0
 [0.21.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@0.20.1...@metamask/notification-services-controller@0.21.0
 [0.20.1]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@0.20.0...@metamask/notification-services-controller@0.20.1
 [0.20.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@0.19.0...@metamask/notification-services-controller@0.20.0

package/dist/NotificationServicesController/NotificationServicesController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _NotificationServicesController_instances, _NotificationServicesController_isPushIntegrated, _NotificationServicesController_isPushNotificationsSetup, _NotificationServicesController_isUnlocked, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_storage, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_getValidStorageKeyAndBearerToken, _NotificationServicesController_assertUserStorage, _NotificationServicesController_getUserStorage, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
+var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_storage, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_registerMessageHandlers, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getValidStorageKeyAndBearerToken, _NotificationServicesController_assertUserStorage, _NotificationServicesController_getUserStorage, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -130,26 +130,20 @@ class NotificationServicesController extends base_controller_1.BaseController {
             state: { ...exports.defaultState, ...state },
         });
         _NotificationServicesController_instances.add(this);
-        // Temporary boolean as push notifications are not yet enabled on mobile
-        _NotificationServicesController_isPushIntegrated.set(this, true);
-        // Flag to check is notifications have been setup when the browser/extension is initialized.
-        // We want to re-initialize push notifications when the browser/extension is refreshed
-        // To ensure we subscribe to the most up-to-date notifications
-        _NotificationServicesController_isPushNotificationsSetup.set(this, false);
-        _NotificationServicesController_isUnlocked.set(this, false);
         _NotificationServicesController_keyringController.set(this, {
+            isUnlocked: false,
             setupLockedStateSubscriptions: (onUnlock) => {
                 const { isUnlocked } = this.messagingSystem.call('KeyringController:getState');
-                __classPrivateFieldSet(this, _NotificationServicesController_isUnlocked, isUnlocked, "f");
+                __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = isUnlocked;
                 this.messagingSystem.subscribe('KeyringController:unlock', () => {
-                    __classPrivateFieldSet(this, _NotificationServicesController_isUnlocked, true, "f");
+                    __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', () => {
-                    __classPrivateFieldSet(this, _NotificationServicesController_isUnlocked, false, "f");
+                    __classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked = false;
                 });
             },
         });
@@ -176,13 +170,14 @@ class NotificationServicesController extends base_controller_1.BaseController {
             },
         });
         _NotificationServicesController_pushNotifications.set(this, {
+            // Flag to check is notifications have been setup when the browser/extension is initialized.
+            // We want to re-initialize push notifications when the browser/extension is refreshed
+            // To ensure we subscribe to the most up-to-date notifications
+            isSetup: false,
             subscribeToPushNotifications: async () => {
                 await this.messagingSystem.call('NotificationServicesPushController:subscribeToPushNotifications');
             },
             enablePushNotifications: async (UUIDs) => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 try {
                     await this.messagingSystem.call('NotificationServicesPushController:enablePushNotifications', UUIDs);
                 }
@@ -190,21 +185,15 @@ class NotificationServicesController extends base_controller_1.BaseController {
                     loglevel_1.default.error('Silently failed to enable push notifications', e);
                 }
             },
-            disablePushNotifications: async (UUIDs) => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
+            disablePushNotifications: async () => {
                 try {
-                    await this.messagingSystem.call('NotificationServicesPushController:disablePushNotifications', UUIDs);
+                    await this.messagingSystem.call('NotificationServicesPushController:disablePushNotifications');
                 }
                 catch (e) {
                     loglevel_1.default.error('Silently failed to disable push notifications', e);
                 }
             },
             updatePushNotifications: async (UUIDs) => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 try {
                     await this.messagingSystem.call('NotificationServicesPushController:updateTriggerPushNotifications', UUIDs);
                 }
@@ -213,37 +202,33 @@ class NotificationServicesController extends base_controller_1.BaseController {
                 }
             },
             subscribe: () => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 this.messagingSystem.subscribe('NotificationServicesPushController:onNewNotifications', (notification) => {
                     // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     this.updateMetamaskNotificationsList(notification);
                 });
             },
             initializePushNotifications: async () => {
-                if (!__classPrivateFieldGet(this, _NotificationServicesController_isPushIntegrated, "f")) {
-                    return;
-                }
                 if (!this.state.isNotificationServicesEnabled) {
                     return;
                 }
-                if (__classPrivateFieldGet(this, _NotificationServicesController_isPushNotificationsSetup, "f")) {
+                if (__classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").isSetup) {
                     return;
                 }
                 // If wallet is unlocked, we can create a fresh push subscription
                 // Otherwise we can subscribe to original subscription
-                if (__classPrivateFieldGet(this, _NotificationServicesController_isUnlocked, "f")) {
-                    const storage = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getUserStorage).call(this);
-                    if (!storage) {
-                        return;
+                try {
+                    if (!__classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked) {
+                        throw new Error('Keyring is locked');
                     }
-                    const uuids = Utils.getAllUUIDs(storage);
-                    await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(uuids);
-                    __classPrivateFieldSet(this, _NotificationServicesController_isPushNotificationsSetup, true, "f");
+                    await this.enablePushNotifications();
+                    __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").isSetup = true;
                 }
-                else {
-                    await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").subscribeToPushNotifications();
+                catch {
+                    await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f")
+                        .subscribeToPushNotifications()
+                        .catch(() => {
+                        // do nothing
+                    });
                 }
             },
         });
@@ -258,7 +243,9 @@ class NotificationServicesController extends base_controller_1.BaseController {
             listAccounts: async () => {
                 // Get previous and current account sets
                 const nonChecksumAccounts = await this.messagingSystem.call('KeyringController:getAccounts');
-                const accounts = nonChecksumAccounts.map((a) => (0, controller_utils_1.toChecksumHexAddress)(a));
+                const accounts = nonChecksumAccounts
+                    .map((a) => (0, controller_utils_1.toChecksumHexAddress)(a))
+                    .filter((a) => (0, controller_utils_1.isValidHexAddress)(a));
                 const currentAccountsSet = new Set(accounts);
                 const prevAccountsSet = new Set(this.state.subscriptionAccountsSeen);
                 // Invalid value you cannot have zero accounts
@@ -289,7 +276,8 @@ class NotificationServicesController extends base_controller_1.BaseController {
              * @returns result from list accounts
              */
             initialize: async () => {
-                if (__classPrivateFieldGet(this, _NotificationServicesController_isUnlocked, "f") && !__classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").isNotificationAccountsSetup) {
+                if (__classPrivateFieldGet(this, _NotificationServicesController_keyringController, "f").isUnlocked &&
+                    !__classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").isNotificationAccountsSetup) {
                     await __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
                     __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").isNotificationAccountsSetup = true;
                 }
@@ -317,7 +305,6 @@ class NotificationServicesController extends base_controller_1.BaseController {
             },
         });
         _NotificationServicesController_featureAnnouncementEnv.set(this, void 0);
-        __classPrivateFieldSet(this, _NotificationServicesController_isPushIntegrated, env.isPushIntegrated ?? true, "f");
         __classPrivateFieldSet(this, _NotificationServicesController_featureAnnouncementEnv, env.featureAnnouncements, "f");
         __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_registerMessageHandlers).call(this);
         __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_clearLoadingStates).call(this);
@@ -333,15 +320,22 @@ class NotificationServicesController extends base_controller_1.BaseController {
         __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").subscribe();
     }
     /**
-     * Retrieves the current enabled state of MetaMask notifications.
-     *
-     * This method directly returns the boolean value of `isMetamaskNotificationsEnabled`
-     * from the controller's state, indicating whether MetaMask notifications are currently enabled.
-     *
-     * @returns The enabled state of MetaMask notifications.
+     * Public method to expose enabling push notifications
      */
-    selectIsNotificationServicesEnabled() {
-        return this.state.isNotificationServicesEnabled;
+    async enablePushNotifications() {
+        await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_enableAuth).call(this);
+        const storage = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getUserStorage).call(this);
+        if (!storage) {
+            throw new Error('Unable to get triggers');
+        }
+        const uuids = Utils.getAllUUIDs(storage);
+        await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(uuids);
+    }
+    /**
+     * Public method to expose disabling push notifications
+     */
+    async disablePushNotifications() {
+        await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications();
     }
     async checkAccountsPresence(accounts) {
         try {
@@ -447,10 +441,7 @@ class NotificationServicesController extends base_controller_1.BaseController {
     async enableMetamaskNotifications() {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
-            const isSignedIn = __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").isSignedIn();
-            if (!isSignedIn) {
-                await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").signIn();
-            }
+            await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_enableAuth).call(this);
             await this.createOnChainTriggers();
         }
         catch (e) {
@@ -470,30 +461,25 @@ class NotificationServicesController extends base_controller_1.BaseController {
      * @throws {Error} If the user is not authenticated or if there is an error during the process.
      */
     async disableNotificationServices() {
+        __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
+        // Attempt Disable Push Notifications
         try {
-            __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
-            // Disable Push Notifications
-            const userStorage = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getUserStorage).call(this);
-            __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_assertUserStorage).call(this, userStorage);
-            const UUIDs = Utils.getAllUUIDs(userStorage);
-            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications(UUIDs);
-            const snapNotifications = this.state.metamaskNotificationsList.filter((notification) => notification.type === notification_schema_1.TRIGGER_TYPES.SNAP);
-            // Clear Notification States (toggles and list)
-            this.update((state) => {
-                state.isNotificationServicesEnabled = false;
-                state.isFeatureAnnouncementsEnabled = false;
-                // reassigning the notifications list with just snaps
-                // since the disable shouldn't affect snaps notifications
-                state.metamaskNotificationsList = snapNotifications;
-            });
+            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications();
         }
-        catch (e) {
-            loglevel_1.default.error('Unable to disable notifications', e);
-            throw new Error('Unable to disable notifications');
-        }
-        finally {
-            __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, false);
+        catch {
+            // Do nothing
         }
+        // Update State: remove non-permitted notifications & disable flags
+        const snapNotifications = this.state.metamaskNotificationsList.filter((notification) => notification.type === notification_schema_1.TRIGGER_TYPES.SNAP);
+        this.update((state) => {
+            state.isNotificationServicesEnabled = false;
+            state.isFeatureAnnouncementsEnabled = false;
+            // reassigning the notifications list with just snaps
+            // since the disable shouldn't affect snaps notifications
+            state.metamaskNotificationsList = snapNotifications;
+        });
+        // Finish Updating State
+        __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, false);
     }
     /**
      * Deletes on-chain triggers associated with a specific account.
@@ -526,8 +512,9 @@ class NotificationServicesController extends base_controller_1.BaseController {
             }
             // Delete these UUIDs (Mutates User Storage)
             await OnChainNotifications.deleteOnChainTriggers(userStorage, storageKey, bearerToken, UUIDs);
-            // Delete these UUIDs from the push notifications
-            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").disablePushNotifications(UUIDs);
+            // Update Push Notifications with new list of IDs
+            const remainingTriggerIds = Utils.getAllUUIDs(userStorage);
+            await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").updatePushNotifications(remainingTriggerIds);
             // Update User Storage
             await __classPrivateFieldGet(this, _NotificationServicesController_storage, "f").setNotificationStorage(JSON.stringify(userStorage));
             return userStorage;
@@ -818,10 +805,9 @@ class NotificationServicesController extends base_controller_1.BaseController {
         }
     }
 }
-_NotificationServicesController_isPushIntegrated = new WeakMap(), _NotificationServicesController_isPushNotificationsSetup = new WeakMap(), _NotificationServicesController_isUnlocked = new WeakMap(), _NotificationServicesController_keyringController = new WeakMap(), _NotificationServicesController_auth = new WeakMap(), _NotificationServicesController_storage = new WeakMap(), _NotificationServicesController_pushNotifications = new WeakMap(), _NotificationServicesController_accounts = new WeakMap(), _NotificationServicesController_featureAnnouncementEnv = new WeakMap(), _NotificationServicesController_instances = new WeakSet(), _NotificationServicesController_registerMessageHandlers = function _NotificationServicesController_registerMessageHandlers() {
+_NotificationServicesController_keyringController = new WeakMap(), _NotificationServicesController_auth = new WeakMap(), _NotificationServicesController_storage = 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}:selectIsNotificationServicesEnabled`, this.selectIsNotificationServicesEnabled.bind(this));
     this.messagingSystem.registerActionHandler(`${controllerName}:getNotificationsByType`, this.getNotificationsByType.bind(this));
     this.messagingSystem.registerActionHandler(`${controllerName}:deleteNotificationsById`, this.deleteNotificationsById.bind(this));
 }, _NotificationServicesController_clearLoadingStates = function _NotificationServicesController_clearLoadingStates() {
@@ -838,6 +824,11 @@ _NotificationServicesController_isPushIntegrated = new WeakMap(), _NotificationS
         });
         throw new Error('User is not signed in.');
     }
+}, _NotificationServicesController_enableAuth = async function _NotificationServicesController_enableAuth() {
+    const isSignedIn = __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").isSignedIn();
+    if (!isSignedIn) {
+        await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").signIn();
+    }
 }, _NotificationServicesController_getValidStorageKeyAndBearerToken = async function _NotificationServicesController_getValidStorageKeyAndBearerToken() {
     __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_assertAuthEnabled).call(this);
     const bearerToken = await __classPrivateFieldGet(this, _NotificationServicesController_auth, "f").getBearerToken();
@@ -867,6 +858,7 @@ async function _NotificationServicesController_getUserStorage() {
     }
     try {
         const userStorage = JSON.parse(userStorageString);
+        Utils.cleanUserStorage(userStorage);
         return userStorage;
     }
     catch {