@metamask-previews/notification-services-controller 29.0.2-preview-122ecfd → 29.0.2-preview-247ba396c

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `fetchMetamaskNotificationsCategories()` controller method that fetches the notification categories manifest from `GET /api/v4/notifications/categories`, stores the result in new `metamaskNotificationsCategories` state, and exposes it through the messenger as `NotificationServicesController:fetchMetamaskNotificationsCategories` ([#9984](https://github.com/MetaMask/core/pull/9984))
+- Add `metamaskNotificationsCategories` state field (`NotificationsCategory[]`) for the server-driven notification settings taxonomy ([#9984](https://github.com/MetaMask/core/pull/9984))
+- Add `isFetchingMetamaskNotificationsCategories` state flag that reflects whether the categories request is in flight ([#9984](https://github.com/MetaMask/core/pull/9984))
+- Export `NotificationsCategory` type from the notification-api schema ([#9984](https://github.com/MetaMask/core/pull/9984))
+
 ### Changed
 
 - Bump `lodash-es` from `^4.17.21` to `^4.18.1` ([#10447](https://github.com/MetaMask/core/pull/10447))

package/dist/NotificationServicesController/NotificationServicesController-method-action-types.d.ts

@@ -193,8 +193,23 @@ export type NotificationServicesControllerSendPerpPlaceOrderNotificationAction =
     type: `NotificationServicesController:sendPerpPlaceOrderNotification`;
     handler: NotificationServicesController['sendPerpPlaceOrderNotification'];
 };
+/**
+ * Fetches the list of MetaMask notification categories from the notifications API,
+ * stores the result in controller state, and returns the categories.
+ *
+ * This method sets the categories-loading flag while the request is in flight
+ * so the UI can reflect the loading state. If the request fails, it logs the
+ * error and throws a generic failure error.
+ *
+ * @returns A promise that resolves to the fetched notification categories.
+ * @throws {Error} If the categories request fails.
+ */
+export type NotificationServicesControllerFetchMetamaskNotificationsCategoriesAction = {
+    type: `NotificationServicesController:fetchMetamaskNotificationsCategories`;
+    handler: NotificationServicesController['fetchMetamaskNotificationsCategories'];
+};
 /**
  * Union of all NotificationServicesController action types.
  */
-export type NotificationServicesControllerMethodActions = NotificationServicesControllerInitAction | NotificationServicesControllerEnablePushNotificationsAction | NotificationServicesControllerDisablePushNotificationsAction | NotificationServicesControllerCheckAccountsPresenceAction | NotificationServicesControllerSetFeatureAnnouncementsEnabledAction | NotificationServicesControllerCreateOnChainTriggersAction | NotificationServicesControllerEnableMetamaskNotificationsAction | NotificationServicesControllerDisableNotificationServicesAction | NotificationServicesControllerDisableAccountsAction | NotificationServicesControllerEnableAccountsAction | NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction | NotificationServicesControllerGetNotificationsByTypeAction | NotificationServicesControllerDeleteNotificationByIdAction | NotificationServicesControllerDeleteNotificationsByIdAction | NotificationServicesControllerMarkMetamaskNotificationsAsReadAction | NotificationServicesControllerUpdateMetamaskNotificationsListAction | NotificationServicesControllerSendPerpPlaceOrderNotificationAction;
+export type NotificationServicesControllerMethodActions = NotificationServicesControllerInitAction | NotificationServicesControllerEnablePushNotificationsAction | NotificationServicesControllerDisablePushNotificationsAction | NotificationServicesControllerCheckAccountsPresenceAction | NotificationServicesControllerSetFeatureAnnouncementsEnabledAction | NotificationServicesControllerCreateOnChainTriggersAction | NotificationServicesControllerEnableMetamaskNotificationsAction | NotificationServicesControllerDisableNotificationServicesAction | NotificationServicesControllerDisableAccountsAction | NotificationServicesControllerEnableAccountsAction | NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction | NotificationServicesControllerGetNotificationsByTypeAction | NotificationServicesControllerDeleteNotificationByIdAction | NotificationServicesControllerDeleteNotificationsByIdAction | NotificationServicesControllerMarkMetamaskNotificationsAsReadAction | NotificationServicesControllerUpdateMetamaskNotificationsListAction | NotificationServicesControllerSendPerpPlaceOrderNotificationAction | NotificationServicesControllerFetchMetamaskNotificationsCategoriesAction;
 //# sourceMappingURL=NotificationServicesController-method-action-types.d.ts.map

package/dist/NotificationServicesController/NotificationServicesController-method-action-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NotificationServicesController-method-action-types.d.ts","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAE1F,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,8BAA8B,CAAC,MAAM,CAAC,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,8BAA8B,CAAC,yBAAyB,CAAC,CAAC;CACpE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4DAA4D,GAAG;IACzE,IAAI,EAAE,yDAAyD,CAAC;IAChE,OAAO,EAAE,8BAA8B,CAAC,0BAA0B,CAAC,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,kEAAkE,GAC5E;IACE,IAAI,EAAE,+DAA+D,CAAC;IACtE,OAAO,EAAE,8BAA8B,CAAC,gCAAgC,CAAC,CAAC;CAC3E,CAAC;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,8BAA8B,CAAC,6BAA6B,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,8BAA8B,CAAC,6BAA6B,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uEAAuE,GACjF;IACE,IAAI,EAAE,oEAAoE,CAAC;IAC3E,OAAO,EAAE,8BAA8B,CAAC,qCAAqC,CAAC,CAAC;CAChF,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,8BAA8B,CAAC,yBAAyB,CAAC,CAAC;CACpE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mEAAmE,GAC7E;IACE,IAAI,EAAE,gEAAgE,CAAC;IACvE,OAAO,EAAE,8BAA8B,CAAC,iCAAiC,CAAC,CAAC;CAC5E,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,MAAM,mEAAmE,GAC7E;IACE,IAAI,EAAE,gEAAgE,CAAC;IACvE,OAAO,EAAE,8BAA8B,CAAC,iCAAiC,CAAC,CAAC;CAC5E,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,MAAM,kEAAkE,GAC5E;IACE,IAAI,EAAE,+DAA+D,CAAC;IACtE,OAAO,EAAE,8BAA8B,CAAC,gCAAgC,CAAC,CAAC;CAC3E,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,2CAA2C,GACnD,wCAAwC,GACxC,2DAA2D,GAC3D,4DAA4D,GAC5D,yDAAyD,GACzD,kEAAkE,GAClE,yDAAyD,GACzD,+DAA+D,GAC/D,+DAA+D,GAC/D,mDAAmD,GACnD,kDAAkD,GAClD,uEAAuE,GACvE,0DAA0D,GAC1D,0DAA0D,GAC1D,2DAA2D,GAC3D,mEAAmE,GACnE,mEAAmE,GACnE,kEAAkE,CAAC"}
+{"version":3,"file":"NotificationServicesController-method-action-types.d.ts","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAE1F,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,8BAA8B,CAAC,MAAM,CAAC,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,8BAA8B,CAAC,yBAAyB,CAAC,CAAC;CACpE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4DAA4D,GAAG;IACzE,IAAI,EAAE,yDAAyD,CAAC;IAChE,OAAO,EAAE,8BAA8B,CAAC,0BAA0B,CAAC,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,kEAAkE,GAC5E;IACE,IAAI,EAAE,+DAA+D,CAAC;IACtE,OAAO,EAAE,8BAA8B,CAAC,gCAAgC,CAAC,CAAC;CAC3E,CAAC;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,8BAA8B,CAAC,6BAA6B,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,8BAA8B,CAAC,6BAA6B,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,8BAA8B,CAAC,gBAAgB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uEAAuE,GACjF;IACE,IAAI,EAAE,oEAAoE,CAAC;IAC3E,OAAO,EAAE,8BAA8B,CAAC,qCAAqC,CAAC,CAAC;CAChF,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,8BAA8B,CAAC,yBAAyB,CAAC,CAAC;CACpE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mEAAmE,GAC7E;IACE,IAAI,EAAE,gEAAgE,CAAC;IACvE,OAAO,EAAE,8BAA8B,CAAC,iCAAiC,CAAC,CAAC;CAC5E,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,MAAM,mEAAmE,GAC7E;IACE,IAAI,EAAE,gEAAgE,CAAC;IACvE,OAAO,EAAE,8BAA8B,CAAC,iCAAiC,CAAC,CAAC;CAC5E,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,MAAM,kEAAkE,GAC5E;IACE,IAAI,EAAE,+DAA+D,CAAC;IACtE,OAAO,EAAE,8BAA8B,CAAC,gCAAgC,CAAC,CAAC;CAC3E,CAAC;AAEJ;;;;;;;;;;GAUG;AACH,MAAM,MAAM,wEAAwE,GAClF;IACE,IAAI,EAAE,qEAAqE,CAAC;IAC5E,OAAO,EAAE,8BAA8B,CAAC,sCAAsC,CAAC,CAAC;CACjF,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,2CAA2C,GACnD,wCAAwC,GACxC,2DAA2D,GAC3D,4DAA4D,GAC5D,yDAAyD,GACzD,kEAAkE,GAClE,yDAAyD,GACzD,+DAA+D,GAC/D,+DAA+D,GAC/D,mDAAmD,GACnD,kDAAkD,GAClD,uEAAuE,GACvE,0DAA0D,GAC1D,0DAA0D,GAC1D,2DAA2D,GAC3D,mEAAmE,GACnE,mEAAmE,GACnE,kEAAkE,GAClE,wEAAwE,CAAC"}

package/dist/NotificationServicesController/NotificationServicesController-method-action-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"NotificationServicesController-method-action-types.js","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NotificationServicesController } from './NotificationServicesController.js';\n\nexport type NotificationServicesControllerInitAction = {\n  type: `NotificationServicesController:init`;\n  handler: NotificationServicesController['init'];\n};\n\n/**\n * Public method to expose enabling push notifications\n */\nexport type NotificationServicesControllerEnablePushNotificationsAction = {\n  type: `NotificationServicesController:enablePushNotifications`;\n  handler: NotificationServicesController['enablePushNotifications'];\n};\n\n/**\n * Public method to expose disabling push notifications\n */\nexport type NotificationServicesControllerDisablePushNotificationsAction = {\n  type: `NotificationServicesController:disablePushNotifications`;\n  handler: NotificationServicesController['disablePushNotifications'];\n};\n\nexport type NotificationServicesControllerCheckAccountsPresenceAction = {\n  type: `NotificationServicesController:checkAccountsPresence`;\n  handler: NotificationServicesController['checkAccountsPresence'];\n};\n\n/**\n * Sets the enabled state of feature announcements.\n *\n * **Action** - used in the notification settings to enable/disable feature announcements.\n *\n * @param featureAnnouncementsEnabled - A boolean value indicating the desired enabled state of the feature announcements.\n * @async\n * @throws {Error} If fails to update\n */\nexport type NotificationServicesControllerSetFeatureAnnouncementsEnabledAction =\n  {\n    type: `NotificationServicesController:setFeatureAnnouncementsEnabled`;\n    handler: NotificationServicesController['setFeatureAnnouncementsEnabled'];\n  };\n\n/**\n * This creates/re-creates on-chain triggers defined in User Storage.\n *\n * **Action** - Used during Sign In / Enabling of notifications.\n *\n * Notification preferences are initialized only when\n * {@link AuthenticatedUserStorageService} has no stored preferences yet.\n * Existing preferences are left as-is.\n *\n * @param opts - optional options to mutate this functionality\n * @param opts.hasMarketingConsent - The user's marketing-consent flag.\n * Used only during initialization to seed marketing push notifications.\n * @param opts.productAnnouncementEnabled - The user's product-announcement flag.\n * Used only during initialization to seed marketing in-app notifications.\n * @param opts.registerPushNotifications - Whether to attempt FCM/device push registration.\n * @returns The updated or newly created user storage.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerCreateOnChainTriggersAction = {\n  type: `NotificationServicesController:createOnChainTriggers`;\n  handler: NotificationServicesController['createOnChainTriggers'];\n};\n\n/**\n * Enables all MetaMask notifications for the user.\n * This is identical flow when initializing notifications for the first time.\n *\n * @param opts - Optional options to mutate this functionality.\n * @throws {Error} If there is an error during the process of enabling notifications.\n */\nexport type NotificationServicesControllerEnableMetamaskNotificationsAction = {\n  type: `NotificationServicesController:enableMetamaskNotifications`;\n  handler: NotificationServicesController['enableMetamaskNotifications'];\n};\n\n/**\n * Disables all MetaMask notifications for the user.\n * This method ensures that the user is authenticated, retrieves all linked accounts,\n * and disables on-chain triggers for each account. It also sets the global notification\n * settings for MetaMask, feature announcements to false.\n *\n * @throws {Error} If the user is not authenticated or if there is an error during the process.\n */\nexport type NotificationServicesControllerDisableNotificationServicesAction = {\n  type: `NotificationServicesController:disableNotificationServices`;\n  handler: NotificationServicesController['disableNotificationServices'];\n};\n\n/**\n * Disables wallet-activity subscriptions for the given accounts.\n *\n * This only writes the Trigger API. The device's FCM links stay in place,\n * because those links deliver every notification source for an address.\n *\n * **Action** - When a user disables wallet activity for a given account.\n *\n * @param accounts - The accounts whose wallet-activity subscriptions are disabled.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerDisableAccountsAction = {\n  type: `NotificationServicesController:disableAccounts`;\n  handler: NotificationServicesController['disableAccounts'];\n};\n\n/**\n * Enables wallet-activity subscriptions for the given accounts.\n *\n * This only writes the Trigger API. Linking the device token is handled\n * when the account is added or when notifications are enabled.\n *\n * **Action** - When a user enables wallet activity for an account.\n *\n * @param accounts - List of accounts to subscribe.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerEnableAccountsAction = {\n  type: `NotificationServicesController:enableAccounts`;\n  handler: NotificationServicesController['enableAccounts'];\n};\n\n/**\n * Fetches the list of metamask notifications.\n * This includes OnChain notifications; Feature Announcements; and Snap Notifications.\n *\n * **Action** - When a user views the notification list page/dropdown\n *\n * @param previewToken - the preview token to use if needed\n * @returns A promise that resolves to the list of notifications.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction =\n  {\n    type: `NotificationServicesController:fetchAndUpdateMetamaskNotifications`;\n    handler: NotificationServicesController['fetchAndUpdateMetamaskNotifications'];\n  };\n\n/**\n * Gets the specified type of notifications from state.\n *\n * @param type - The trigger type.\n * @returns An array of notifications of the passed in type.\n * @throws Throws an error if an invalid trigger type is passed.\n */\nexport type NotificationServicesControllerGetNotificationsByTypeAction = {\n  type: `NotificationServicesController:getNotificationsByType`;\n  handler: NotificationServicesController['getNotificationsByType'];\n};\n\n/**\n * Used to delete a notification by id.\n *\n * Note: This function should only be used for notifications that are stored\n * in this controller directly, currently only snaps notifications.\n *\n * @param id - The id of the notification to delete.\n */\nexport type NotificationServicesControllerDeleteNotificationByIdAction = {\n  type: `NotificationServicesController:deleteNotificationById`;\n  handler: NotificationServicesController['deleteNotificationById'];\n};\n\n/**\n * Used to batch delete notifications by id.\n *\n * Note: This function should only be used for notifications that are stored\n * in this controller directly, currently only snaps notifications.\n *\n * @param ids - The ids of the notifications to delete.\n */\nexport type NotificationServicesControllerDeleteNotificationsByIdAction = {\n  type: `NotificationServicesController:deleteNotificationsById`;\n  handler: NotificationServicesController['deleteNotificationsById'];\n};\n\n/**\n * Marks specified metamask notifications as read.\n *\n * @param notifications - An array of notifications to be marked as read. Each notification should include its type and read status.\n * @returns A promise that resolves when the operation is complete.\n */\nexport type NotificationServicesControllerMarkMetamaskNotificationsAsReadAction =\n  {\n    type: `NotificationServicesController:markMetamaskNotificationsAsRead`;\n    handler: NotificationServicesController['markMetamaskNotificationsAsRead'];\n  };\n\n/**\n * Updates the list of MetaMask notifications by adding a new notification at the beginning of the list.\n * This method ensures that the most recent notification is displayed first in the UI.\n *\n * @param notification - The new notification object to be added to the list.\n * @returns A promise that resolves when the notification list has been successfully updated.\n */\nexport type NotificationServicesControllerUpdateMetamaskNotificationsListAction =\n  {\n    type: `NotificationServicesController:updateMetamaskNotificationsList`;\n    handler: NotificationServicesController['updateMetamaskNotificationsList'];\n  };\n\n/**\n * Creates an perp order notification subscription.\n * Requires notifications and auth to be enabled to start receiving this notifications\n *\n * @param input perp input\n */\nexport type NotificationServicesControllerSendPerpPlaceOrderNotificationAction =\n  {\n    type: `NotificationServicesController:sendPerpPlaceOrderNotification`;\n    handler: NotificationServicesController['sendPerpPlaceOrderNotification'];\n  };\n\n/**\n * Union of all NotificationServicesController action types.\n */\nexport type NotificationServicesControllerMethodActions =\n  | NotificationServicesControllerInitAction\n  | NotificationServicesControllerEnablePushNotificationsAction\n  | NotificationServicesControllerDisablePushNotificationsAction\n  | NotificationServicesControllerCheckAccountsPresenceAction\n  | NotificationServicesControllerSetFeatureAnnouncementsEnabledAction\n  | NotificationServicesControllerCreateOnChainTriggersAction\n  | NotificationServicesControllerEnableMetamaskNotificationsAction\n  | NotificationServicesControllerDisableNotificationServicesAction\n  | NotificationServicesControllerDisableAccountsAction\n  | NotificationServicesControllerEnableAccountsAction\n  | NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction\n  | NotificationServicesControllerGetNotificationsByTypeAction\n  | NotificationServicesControllerDeleteNotificationByIdAction\n  | NotificationServicesControllerDeleteNotificationsByIdAction\n  | NotificationServicesControllerMarkMetamaskNotificationsAsReadAction\n  | NotificationServicesControllerUpdateMetamaskNotificationsListAction\n  | NotificationServicesControllerSendPerpPlaceOrderNotificationAction;\n"]}
+{"version":3,"file":"NotificationServicesController-method-action-types.js","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NotificationServicesController } from './NotificationServicesController.js';\n\nexport type NotificationServicesControllerInitAction = {\n  type: `NotificationServicesController:init`;\n  handler: NotificationServicesController['init'];\n};\n\n/**\n * Public method to expose enabling push notifications\n */\nexport type NotificationServicesControllerEnablePushNotificationsAction = {\n  type: `NotificationServicesController:enablePushNotifications`;\n  handler: NotificationServicesController['enablePushNotifications'];\n};\n\n/**\n * Public method to expose disabling push notifications\n */\nexport type NotificationServicesControllerDisablePushNotificationsAction = {\n  type: `NotificationServicesController:disablePushNotifications`;\n  handler: NotificationServicesController['disablePushNotifications'];\n};\n\nexport type NotificationServicesControllerCheckAccountsPresenceAction = {\n  type: `NotificationServicesController:checkAccountsPresence`;\n  handler: NotificationServicesController['checkAccountsPresence'];\n};\n\n/**\n * Sets the enabled state of feature announcements.\n *\n * **Action** - used in the notification settings to enable/disable feature announcements.\n *\n * @param featureAnnouncementsEnabled - A boolean value indicating the desired enabled state of the feature announcements.\n * @async\n * @throws {Error} If fails to update\n */\nexport type NotificationServicesControllerSetFeatureAnnouncementsEnabledAction =\n  {\n    type: `NotificationServicesController:setFeatureAnnouncementsEnabled`;\n    handler: NotificationServicesController['setFeatureAnnouncementsEnabled'];\n  };\n\n/**\n * This creates/re-creates on-chain triggers defined in User Storage.\n *\n * **Action** - Used during Sign In / Enabling of notifications.\n *\n * Notification preferences are initialized only when\n * {@link AuthenticatedUserStorageService} has no stored preferences yet.\n * Existing preferences are left as-is.\n *\n * @param opts - optional options to mutate this functionality\n * @param opts.hasMarketingConsent - The user's marketing-consent flag.\n * Used only during initialization to seed marketing push notifications.\n * @param opts.productAnnouncementEnabled - The user's product-announcement flag.\n * Used only during initialization to seed marketing in-app notifications.\n * @param opts.registerPushNotifications - Whether to attempt FCM/device push registration.\n * @returns The updated or newly created user storage.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerCreateOnChainTriggersAction = {\n  type: `NotificationServicesController:createOnChainTriggers`;\n  handler: NotificationServicesController['createOnChainTriggers'];\n};\n\n/**\n * Enables all MetaMask notifications for the user.\n * This is identical flow when initializing notifications for the first time.\n *\n * @param opts - Optional options to mutate this functionality.\n * @throws {Error} If there is an error during the process of enabling notifications.\n */\nexport type NotificationServicesControllerEnableMetamaskNotificationsAction = {\n  type: `NotificationServicesController:enableMetamaskNotifications`;\n  handler: NotificationServicesController['enableMetamaskNotifications'];\n};\n\n/**\n * Disables all MetaMask notifications for the user.\n * This method ensures that the user is authenticated, retrieves all linked accounts,\n * and disables on-chain triggers for each account. It also sets the global notification\n * settings for MetaMask, feature announcements to false.\n *\n * @throws {Error} If the user is not authenticated or if there is an error during the process.\n */\nexport type NotificationServicesControllerDisableNotificationServicesAction = {\n  type: `NotificationServicesController:disableNotificationServices`;\n  handler: NotificationServicesController['disableNotificationServices'];\n};\n\n/**\n * Disables wallet-activity subscriptions for the given accounts.\n *\n * This only writes the Trigger API. The device's FCM links stay in place,\n * because those links deliver every notification source for an address.\n *\n * **Action** - When a user disables wallet activity for a given account.\n *\n * @param accounts - The accounts whose wallet-activity subscriptions are disabled.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerDisableAccountsAction = {\n  type: `NotificationServicesController:disableAccounts`;\n  handler: NotificationServicesController['disableAccounts'];\n};\n\n/**\n * Enables wallet-activity subscriptions for the given accounts.\n *\n * This only writes the Trigger API. Linking the device token is handled\n * when the account is added or when notifications are enabled.\n *\n * **Action** - When a user enables wallet activity for an account.\n *\n * @param accounts - List of accounts to subscribe.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerEnableAccountsAction = {\n  type: `NotificationServicesController:enableAccounts`;\n  handler: NotificationServicesController['enableAccounts'];\n};\n\n/**\n * Fetches the list of metamask notifications.\n * This includes OnChain notifications; Feature Announcements; and Snap Notifications.\n *\n * **Action** - When a user views the notification list page/dropdown\n *\n * @param previewToken - the preview token to use if needed\n * @returns A promise that resolves to the list of notifications.\n * @throws {Error} Throws an error if unauthenticated or from other operations.\n */\nexport type NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction =\n  {\n    type: `NotificationServicesController:fetchAndUpdateMetamaskNotifications`;\n    handler: NotificationServicesController['fetchAndUpdateMetamaskNotifications'];\n  };\n\n/**\n * Gets the specified type of notifications from state.\n *\n * @param type - The trigger type.\n * @returns An array of notifications of the passed in type.\n * @throws Throws an error if an invalid trigger type is passed.\n */\nexport type NotificationServicesControllerGetNotificationsByTypeAction = {\n  type: `NotificationServicesController:getNotificationsByType`;\n  handler: NotificationServicesController['getNotificationsByType'];\n};\n\n/**\n * Used to delete a notification by id.\n *\n * Note: This function should only be used for notifications that are stored\n * in this controller directly, currently only snaps notifications.\n *\n * @param id - The id of the notification to delete.\n */\nexport type NotificationServicesControllerDeleteNotificationByIdAction = {\n  type: `NotificationServicesController:deleteNotificationById`;\n  handler: NotificationServicesController['deleteNotificationById'];\n};\n\n/**\n * Used to batch delete notifications by id.\n *\n * Note: This function should only be used for notifications that are stored\n * in this controller directly, currently only snaps notifications.\n *\n * @param ids - The ids of the notifications to delete.\n */\nexport type NotificationServicesControllerDeleteNotificationsByIdAction = {\n  type: `NotificationServicesController:deleteNotificationsById`;\n  handler: NotificationServicesController['deleteNotificationsById'];\n};\n\n/**\n * Marks specified metamask notifications as read.\n *\n * @param notifications - An array of notifications to be marked as read. Each notification should include its type and read status.\n * @returns A promise that resolves when the operation is complete.\n */\nexport type NotificationServicesControllerMarkMetamaskNotificationsAsReadAction =\n  {\n    type: `NotificationServicesController:markMetamaskNotificationsAsRead`;\n    handler: NotificationServicesController['markMetamaskNotificationsAsRead'];\n  };\n\n/**\n * Updates the list of MetaMask notifications by adding a new notification at the beginning of the list.\n * This method ensures that the most recent notification is displayed first in the UI.\n *\n * @param notification - The new notification object to be added to the list.\n * @returns A promise that resolves when the notification list has been successfully updated.\n */\nexport type NotificationServicesControllerUpdateMetamaskNotificationsListAction =\n  {\n    type: `NotificationServicesController:updateMetamaskNotificationsList`;\n    handler: NotificationServicesController['updateMetamaskNotificationsList'];\n  };\n\n/**\n * Creates an perp order notification subscription.\n * Requires notifications and auth to be enabled to start receiving this notifications\n *\n * @param input perp input\n */\nexport type NotificationServicesControllerSendPerpPlaceOrderNotificationAction =\n  {\n    type: `NotificationServicesController:sendPerpPlaceOrderNotification`;\n    handler: NotificationServicesController['sendPerpPlaceOrderNotification'];\n  };\n\n/**\n * Fetches the list of MetaMask notification categories from the notifications API,\n * stores the result in controller state, and returns the categories.\n *\n * This method sets the categories-loading flag while the request is in flight\n * so the UI can reflect the loading state. If the request fails, it logs the\n * error and throws a generic failure error.\n *\n * @returns A promise that resolves to the fetched notification categories.\n * @throws {Error} If the categories request fails.\n */\nexport type NotificationServicesControllerFetchMetamaskNotificationsCategoriesAction =\n  {\n    type: `NotificationServicesController:fetchMetamaskNotificationsCategories`;\n    handler: NotificationServicesController['fetchMetamaskNotificationsCategories'];\n  };\n\n/**\n * Union of all NotificationServicesController action types.\n */\nexport type NotificationServicesControllerMethodActions =\n  | NotificationServicesControllerInitAction\n  | NotificationServicesControllerEnablePushNotificationsAction\n  | NotificationServicesControllerDisablePushNotificationsAction\n  | NotificationServicesControllerCheckAccountsPresenceAction\n  | NotificationServicesControllerSetFeatureAnnouncementsEnabledAction\n  | NotificationServicesControllerCreateOnChainTriggersAction\n  | NotificationServicesControllerEnableMetamaskNotificationsAction\n  | NotificationServicesControllerDisableNotificationServicesAction\n  | NotificationServicesControllerDisableAccountsAction\n  | NotificationServicesControllerEnableAccountsAction\n  | NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction\n  | NotificationServicesControllerGetNotificationsByTypeAction\n  | NotificationServicesControllerDeleteNotificationByIdAction\n  | NotificationServicesControllerDeleteNotificationsByIdAction\n  | NotificationServicesControllerMarkMetamaskNotificationsAsReadAction\n  | NotificationServicesControllerUpdateMetamaskNotificationsListAction\n  | NotificationServicesControllerSendPerpPlaceOrderNotificationAction\n  | NotificationServicesControllerFetchMetamaskNotificationsCategoriesAction;\n"]}

package/dist/NotificationServicesController/NotificationServicesController.d.ts

@@ -1,5 +1,5 @@
 import type { AuthenticatedUserStorageServiceGetNotificationPreferencesAction, AuthenticatedUserStorageServicePutNotificationPreferencesAction, PerpsPreference, SocialAIPreference } from '@metamask/authenticated-user-storage';
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
+import type { ControllerGetStateAction, ControllerStateChangedEvent } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
 import type { KeyringControllerStateChangeEvent, KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent } from '@metamask/keyring-controller';
 import type { Messenger } from '@metamask/messenger';
@@ -7,6 +7,7 @@ import type { AuthenticationController } from '@metamask/profile-sync-controller
 import type { NotificationServicesPushControllerStateChangeEvent, NotificationServicesPushControllerOnNewNotificationEvent } from '../NotificationServicesPushController/index.js';
 import type { NotificationServicesPushControllerMethodActions } from '../NotificationServicesPushController/NotificationServicesPushController-method-action-types.js';
 import { TRIGGER_TYPES } from './constants/notification-schema.js';
+import type { NotificationsCategory } from './index.js';
 import type { NotificationServicesControllerMethodActions } from './NotificationServicesController-method-action-types.js';
 import type { ENV } from './services/api-notifications.js';
 import type { INotification, MarkAsReadNotificationsParam } from './types/notification/notification.js';
@@ -42,6 +43,10 @@ export type NotificationServicesControllerState = {
      * List of read metamask notifications
      */
     metamaskNotificationsReadList: string[];
+    /**
+     * List of notification categories
+     */
+    metamaskNotificationsCategories: NotificationsCategory[];
     /**
      * Flag that indicates that the creating notifications is in progress
      */
@@ -52,6 +57,11 @@ export type NotificationServicesControllerState = {
      * when fetching notifications
      */
     isFetchingMetamaskNotifications: boolean;
+    /**
+     * Flag that indicates that fetching notification categories
+     * is in progress. Used for readiness checks for categories consumers
+     */
+    isFetchingMetamaskNotificationsCategories: boolean;
     /**
      * Flag that indicates that the updating notifications for a specific address is in progress
      */
@@ -100,7 +110,7 @@ export { DEFAULT_AGENTIC_CLI_PREFERENCES, DEFAULT_PRICE_ALERT_PREFERENCES, } fro
 export type NotificationServicesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, NotificationServicesControllerState>;
 export type Actions = NotificationServicesControllerGetStateAction | NotificationServicesControllerMethodActions;
 type AllowedActions = KeyringControllerGetStateAction | AuthenticationController.AuthenticationControllerGetBearerTokenAction | AuthenticationController.AuthenticationControllerIsSignedInAction | AuthenticationController.AuthenticationControllerPerformSignInAction | AuthenticatedUserStorageServiceGetNotificationPreferencesAction | AuthenticatedUserStorageServicePutNotificationPreferencesAction | NotificationServicesPushControllerMethodActions;
-export type NotificationServicesControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, NotificationServicesControllerState>;
+export type NotificationServicesControllerStateChangeEvent = ControllerStateChangedEvent<typeof controllerName, NotificationServicesControllerState>;
 export type NotificationListUpdatedEvent = {
     type: `${typeof controllerName}:notificationsListUpdated`;
     payload: [INotification[]];
@@ -282,5 +292,17 @@ export declare class NotificationServicesController extends BaseController<typeo
      * @param input perp input
      */
     sendPerpPlaceOrderNotification(input: OrderInput): Promise<void>;
+    /**
+     * Fetches the list of MetaMask notification categories from the notifications API,
+     * stores the result in controller state, and returns the categories.
+     *
+     * This method sets the categories-loading flag while the request is in flight
+     * so the UI can reflect the loading state. If the request fails, it logs the
+     * error and throws a generic failure error.
+     *
+     * @returns A promise that resolves to the fetched notification categories.
+     * @throws {Error} If the categories request fails.
+     */
+    fetchMetamaskNotificationsCategories(): Promise<NotificationsCategory[]>;
 }
 //# sourceMappingURL=NotificationServicesController.d.ts.map

package/dist/NotificationServicesController/NotificationServicesController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NotificationServicesController.d.ts","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,+DAA+D,EAC/D,+DAA+D,EAE/D,eAAe,EACf,kBAAkB,EACnB,MAAM,sCAAsC,CAAC;AAK9C,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAK3D,OAAO,KAAK,EACV,iCAAiC,EACjC,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAE7B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAKlF,OAAO,KAAK,EACV,kDAAkD,EAClD,wDAAwD,EACzD,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EAAE,+CAA+C,EAAE,MAAM,iGAAiG,CAAC;AACvK,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE,OAAO,KAAK,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AAK3H,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAS3D,OAAO,KAAK,EACV,aAAa,EACb,4BAA4B,EAC7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAGzD,QAAA,MAAM,cAAc,mCAAmC,CAAC;AAExD,eAAO,MAAM,gCAAgC,OAAO,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,wBAAwB,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,kCAAkC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,yBAAyB,EAAE,aAAa,EAAE,CAAC;IAE3C;;OAEG;IACH,6BAA6B,EAAE,MAAM,EAAE,CAAC;IACxC;;OAEG;IACH,+BAA+B,EAAE,OAAO,CAAC;IACzC;;;;OAIG;IACH,+BAA+B,EAAE,OAAO,CAAC;IACzC;;OAEG;IACH,sCAAsC,EAAE,MAAM,EAAE,CAAC;IACjD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;CACrC,CAAC;AAiEF,eAAO,MAAM,YAAY,EAAE,mCAW1B,CAAC;AAEF,MAAM,MAAM,wDAAwD,GAAG;IACrE;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;OAMG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,0DAA0D,GACpE,wDAAwD,CAAC;AAE3D,MAAM,MAAM,gEAAgE,GAC1E,wDAAwD,CAAC;AAM3D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,eAGvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,QAAQ,CAAC,kBAAkB,CAKtE,CAAC;AAEF,OAAO,EACL,+BAA+B,EAC/B,+BAA+B,GAChC,MAAM,sCAAsC,CAAC;AAyF9C,MAAM,MAAM,4CAA4C,GACtD,wBAAwB,CACtB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAGJ,MAAM,MAAM,OAAO,GACf,4CAA4C,GAC5C,2CAA2C,CAAC;AAGhD,KAAK,cAAc,GAEf,+BAA+B,GAE/B,wBAAwB,CAAC,4CAA4C,GACrE,wBAAwB,CAAC,wCAAwC,GACjE,wBAAwB,CAAC,2CAA2C,GAEpE,+DAA+D,GAC/D,+DAA+D,GAE/D,+CAA+C,CAAC;AAGpD,MAAM,MAAM,8CAA8C,GACxD,0BAA0B,CACxB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAEJ,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;CAC5B,CAAC;AAGF,MAAM,MAAM,MAAM,GACd,8CAA8C,GAC9C,4BAA4B,GAC5B,4BAA4B,CAAC;AAGjC,KAAK,aAAa,GAEd,iCAAiC,GACjC,0BAA0B,GAC1B,4BAA4B,GAE5B,wDAAwD,GACxD,kDAAkD,CAAC;AAGvD,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,CACvB,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,WAAW,GAAG,QAAQ,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,cAAc,CAChE,OAAO,cAAc,EACrB,mCAAmC,EACnC,uCAAuC,CACxC;;IAkTC;;;;;;;;;;OAUG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,GACJ,EAAE;QACD,SAAS,EAAE,uCAAuC,CAAC;QACnD,KAAK,CAAC,EAAE,OAAO,CAAC,mCAAmC,CAAC,CAAC;QACrD,GAAG,EAAE;YACH,oBAAoB,EAAE,sBAAsB,CAAC;YAC7C,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC;YACtB,GAAG,CAAC,EAAE,GAAG,CAAC;SACX,CAAC;KACH,EAkBA;IAED,IAAI,IAAI,IAAI,CAaX;IAkID;;OAEG;IACU,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAiBpD;IAED;;OAEG;IACU,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC,CAErD;IAEY,qBAAqB,CAChC,QAAQ,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAmClC;IAED;;;;;;;;OAQG;IACU,8BAA8B,CACzC,2BAA2B,EAAE,OAAO,GACnC,OAAO,CAAC,IAAI,CAAC,CASf;IAED;;;;;;;;;;;;;;;;;OAiBG;IACU,qBAAqB,CAChC,IAAI,GAAE,0DAA+D,GACpE,OAAO,CAAC,IAAI,CAAC,CAuGf;IAED;;;;;;OAMG;IACU,2BAA2B,CACtC,IAAI,GAAE,gEAAqE,GAC1E,OAAO,CAAC,IAAI,CAAC,CAWf;IAED;;;;;;;OAOG;IACU,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC,CAwBxD;IAED;;;;;;;;;;OAUG;IACU,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAe9D;IAED;;;;;;;;;;OAUG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB7D;IAED;;;;;;;;;OASG;IACU,mCAAmC,CAC9C,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,aAAa,EAAE,CAAC,CA2F1B;IAED;;;;;;OAMG;IACI,sBAAsB,CAAC,IAAI,EAAE,aAAa,GAAG,aAAa,EAAE,CAQlE;IAED;;;;;;;OAOG;IACU,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2B7D;IAED;;;;;;;OAOG;IACU,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CASjE;IAED;;;;;OAKG;IACU,+BAA+B,CAC1C,aAAa,EAAE,4BAA4B,GAC1C,OAAO,CAAC,IAAI,CAAC,CA0Gf;IAED;;;;;;OAMG;IACU,+BAA+B,CAC1C,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC,CAgCf;IAED;;;;;OAKG;IACU,8BAA8B,CACzC,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,IAAI,CAAC,CAOf;CACF"}
+{"version":3,"file":"NotificationServicesController.d.ts","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,+DAA+D,EAC/D,+DAA+D,EAE/D,eAAe,EACf,kBAAkB,EACnB,MAAM,sCAAsC,CAAC;AAK9C,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAK3D,OAAO,KAAK,EACV,iCAAiC,EACjC,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAE7B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAKlF,OAAO,KAAK,EACV,kDAAkD,EAClD,wDAAwD,EACzD,MAAM,gDAAgD,CAAC;AACxD,OAAO,KAAK,EAAE,+CAA+C,EAAE,MAAM,iGAAiG,CAAC;AACvK,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACnE,OAAO,KAAK,EAEV,qBAAqB,EACtB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AAK3H,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAU3D,OAAO,KAAK,EACV,aAAa,EACb,4BAA4B,EAC7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAGzD,QAAA,MAAM,cAAc,mCAAmC,CAAC;AAExD,eAAO,MAAM,gCAAgC,OAAO,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,wBAAwB,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,kCAAkC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,yBAAyB,EAAE,aAAa,EAAE,CAAC;IAE3C;;OAEG;IACH,6BAA6B,EAAE,MAAM,EAAE,CAAC;IACxC;;OAEG;IACH,+BAA+B,EAAE,qBAAqB,EAAE,CAAC;IACzD;;OAEG;IACH,+BAA+B,EAAE,OAAO,CAAC;IACzC;;;;OAIG;IACH,+BAA+B,EAAE,OAAO,CAAC;IACzC;;;OAGG;IACH,yCAAyC,EAAE,OAAO,CAAC;IACnD;;OAEG;IACH,sCAAsC,EAAE,MAAM,EAAE,CAAC;IACjD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;CACrC,CAAC;AA6EF,eAAO,MAAM,YAAY,EAAE,mCAa1B,CAAC;AAEF,MAAM,MAAM,wDAAwD,GAAG;IACrE;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;OAMG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,0DAA0D,GACpE,wDAAwD,CAAC;AAE3D,MAAM,MAAM,gEAAgE,GAC1E,wDAAwD,CAAC;AAM3D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,eAGvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,QAAQ,CAAC,kBAAkB,CAKtE,CAAC;AAEF,OAAO,EACL,+BAA+B,EAC/B,+BAA+B,GAChC,MAAM,sCAAsC,CAAC;AA0F9C,MAAM,MAAM,4CAA4C,GACtD,wBAAwB,CACtB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAGJ,MAAM,MAAM,OAAO,GACf,4CAA4C,GAC5C,2CAA2C,CAAC;AAGhD,KAAK,cAAc,GAEf,+BAA+B,GAE/B,wBAAwB,CAAC,4CAA4C,GACrE,wBAAwB,CAAC,wCAAwC,GACjE,wBAAwB,CAAC,2CAA2C,GAEpE,+DAA+D,GAC/D,+DAA+D,GAE/D,+CAA+C,CAAC;AAGpD,MAAM,MAAM,8CAA8C,GACxD,2BAA2B,CACzB,OAAO,cAAc,EACrB,mCAAmC,CACpC,CAAC;AAEJ,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;CAC5B,CAAC;AAGF,MAAM,MAAM,MAAM,GACd,8CAA8C,GAC9C,4BAA4B,GAC5B,4BAA4B,CAAC;AAGjC,KAAK,aAAa,GAEd,iCAAiC,GACjC,0BAA0B,GAC1B,4BAA4B,GAE5B,wDAAwD,GACxD,kDAAkD,CAAC;AAGvD,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,CACvB,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,WAAW,GAAG,QAAQ,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,cAAc,CAChE,OAAO,cAAc,EACrB,mCAAmC,EACnC,uCAAuC,CACxC;;IAkTC;;;;;;;;;;OAUG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,GACJ,EAAE;QACD,SAAS,EAAE,uCAAuC,CAAC;QACnD,KAAK,CAAC,EAAE,OAAO,CAAC,mCAAmC,CAAC,CAAC;QACrD,GAAG,EAAE;YACH,oBAAoB,EAAE,sBAAsB,CAAC;YAC7C,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC;YACtB,GAAG,CAAC,EAAE,GAAG,CAAC;SACX,CAAC;KACH,EAkBA;IAED,IAAI,IAAI,IAAI,CAaX;IAmJD;;OAEG;IACU,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAiBpD;IAED;;OAEG;IACU,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC,CAErD;IAEY,qBAAqB,CAChC,QAAQ,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAmClC;IAED;;;;;;;;OAQG;IACU,8BAA8B,CACzC,2BAA2B,EAAE,OAAO,GACnC,OAAO,CAAC,IAAI,CAAC,CASf;IAED;;;;;;;;;;;;;;;;;OAiBG;IACU,qBAAqB,CAChC,IAAI,GAAE,0DAA+D,GACpE,OAAO,CAAC,IAAI,CAAC,CAuGf;IAED;;;;;;OAMG;IACU,2BAA2B,CACtC,IAAI,GAAE,gEAAqE,GAC1E,OAAO,CAAC,IAAI,CAAC,CAWf;IAED;;;;;;;OAOG;IACU,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC,CAwBxD;IAED;;;;;;;;;;OAUG;IACU,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAe9D;IAED;;;;;;;;;;OAUG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB7D;IAED;;;;;;;;;OASG;IACU,mCAAmC,CAC9C,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,aAAa,EAAE,CAAC,CA2F1B;IAED;;;;;;OAMG;IACI,sBAAsB,CAAC,IAAI,EAAE,aAAa,GAAG,aAAa,EAAE,CAQlE;IAED;;;;;;;OAOG;IACU,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2B7D;IAED;;;;;;;OAOG;IACU,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CASjE;IAED;;;;;OAKG;IACU,+BAA+B,CAC1C,aAAa,EAAE,4BAA4B,GAC1C,OAAO,CAAC,IAAI,CAAC,CA0Gf;IAED;;;;;;OAMG;IACU,+BAA+B,CAC1C,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC,CAgCf;IAED;;;;;OAKG;IACU,8BAA8B,CACzC,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,IAAI,CAAC,CAOf;IAED;;;;;;;;;;OAUG;IACU,oCAAoC,IAAI,OAAO,CAC1D,qBAAqB,EAAE,CACxB,CAiBA;CACF"}

package/dist/NotificationServicesController/NotificationServicesController.js

@@ -6,7 +6,7 @@ import { debounce } from 'lodash-es';
 import log from 'loglevel';
 import { TRIGGER_TYPES } from './constants/notification-schema.js';
 import { processAndFilterNotifications, safeProcessNotification, } from './processors/process-notifications.js';
-import { getAPINotifications, getNotificationsApiConfigCached, markNotificationsAsRead, updateOnChainNotifications, } from './services/api-notifications.js';
+import { getAPINotifications, getNotificationsApiConfigCached, getNotificationsCategories, markNotificationsAsRead, updateOnChainNotifications, } from './services/api-notifications.js';
 import { getFeatureAnnouncementNotifications } from './services/feature-announcements.js';
 import { createPerpOrderNotification } from './services/perp-notifications.js';
 // Unique name for the controller
@@ -49,6 +49,12 @@ const metadata = {
         includeInDebugSnapshot: true,
         usedInUi: true,
     },
+    metamaskNotificationsCategories: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
     isUpdatingMetamaskNotifications: {
         includeInStateLogs: false,
         persist: false,
@@ -73,6 +79,12 @@ const metadata = {
         includeInDebugSnapshot: false,
         usedInUi: true,
     },
+    isFetchingMetamaskNotificationsCategories: {
+        includeInStateLogs: false,
+        persist: false,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
 };
 export const defaultState = {
     subscriptionAccountsSeen: [],
@@ -81,10 +93,12 @@ export const defaultState = {
     isFeatureAnnouncementsEnabled: false,
     metamaskNotificationsList: [],
     metamaskNotificationsReadList: [],
+    metamaskNotificationsCategories: [],
     isUpdatingMetamaskNotifications: false,
     isFetchingMetamaskNotifications: false,
     isUpdatingMetamaskNotificationsAccount: [],
     isCheckingAccountsPresence: false,
+    isFetchingMetamaskNotificationsCategories: false,
 };
 const locallyPersistedNotificationTypes = new Set([
     TRIGGER_TYPES.SNAP,
@@ -172,6 +186,7 @@ const MESSENGER_EXPOSED_METHODS = [
     'disableAccounts',
     'enableAccounts',
     'fetchAndUpdateMetamaskNotifications',
+    'fetchMetamaskNotificationsCategories',
     'getNotificationsByType',
     'deleteNotificationById',
     'deleteNotificationsById',
@@ -558,6 +573,20 @@ export class NotificationServicesController extends BaseController {
                 state.isUpdatingMetamaskNotificationsAccount.filter((existingAccount) => !accounts.includes(existingAccount));
         });
     }
+    /**
+     * Updates the state to indicate whether fetching of MetaMask notification categories is in progress.
+     *
+     * This method is used to set the `isFetchingMetamaskNotificationsCategories` state, which can be utilized
+     * to show or hide loading indicators in the UI when notifications categories are being fetched.
+     *
+     * @param isFetchingNotificationCategories - A boolean value representing the fetching state.
+     */
+    #setIsFetchingNotificationsCategories(isFetchingNotificationCategories) {
+        this.update((state) => {
+            state.isFetchingMetamaskNotificationsCategories =
+                isFetchingNotificationCategories;
+        });
+    }
     /**
      * Public method to expose enabling push notifications
      */
@@ -1058,5 +1087,33 @@ export class NotificationServicesController extends BaseController {
             // Do Nothing
         }
     }
+    /**
+     * Fetches the list of MetaMask notification categories from the notifications API,
+     * stores the result in controller state, and returns the categories.
+     *
+     * This method sets the categories-loading flag while the request is in flight
+     * so the UI can reflect the loading state. If the request fails, it logs the
+     * error and throws a generic failure error.
+     *
+     * @returns A promise that resolves to the fetched notification categories.
+     * @throws {Error} If the categories request fails.
+     */
+    async fetchMetamaskNotificationsCategories() {
+        this.#setIsFetchingNotificationsCategories(true);
+        try {
+            const categories = await getNotificationsCategories();
+            this.update((state) => {
+                state.metamaskNotificationsCategories = categories;
+            });
+            return categories;
+        }
+        catch (error) {
+            log.error('Failed to fetch notifications categories', error);
+            throw new Error('Failed to fetch notifications categories');
+        }
+        finally {
+            this.#setIsFetchingNotificationsCategories(false);
+        }
+    }
 }
 //# sourceMappingURL=NotificationServicesController.js.map