@metamask/notification-services-controller 22.0.0 → 23.0.0

package/CHANGELOG.md

@@ -7,6 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [23.0.0]
+
+### Added
+
+- Expose missing public `NotificationServicesController` methods through its messenger ([#8176](https://github.com/MetaMask/core/pull/8176))
+  - The following actions are now available:
+    - `NotificationServicesController:init`
+    - `NotificationServicesController:enablePushNotification`
+    - `NotificationServicesController:disablePushNotification`
+    - `NotificationServicesController:checkAccountsPresence`
+    - `NotificationServicesController:setFeatureAnnouncementsEnabled`
+    - `NotificationServicesController:createOnChainTriggers`
+    - `NotificationServicesController:enableMetamaskNotifications`
+    - `NotificationServicesController:disableAccounts`
+    - `NotificationServicesController:enableAccounts`
+    - `NotificationServicesController:fetchAndUpdateMetamaskNotifications`
+    - `NotificationServicesController:deleteNotificationById`
+    - `NotificationServicesController:markMetamaskNotificationsAsRead`
+    - `NotificationServicesController:sendPerpPlaceOrderNotification`
+  - Corresponding action types (e.g. `NotificationServicesControllerEnablePushNotificationAction`) are available as well.
+
+### Changed
+
+- **BREAKING:** Standardize names of `NotificationServicesController` and `NotificationServicesPushController` messenger action types ([#8176](https://github.com/MetaMask/core/pull/8176))
+  - All existing types for messenger actions have been renamed so they end in `Action` (e.g. `NotificationServicesControllerUpdateMetamaskNotificationsList` -> `NotificationServicesControllerUpdateMetamaskNotificationsListAction`). You will need to update imports appropriately.
+  - The `NotificationServicesPushController` action `NotificationServicesPushControllerSubscribeToNotificationsAction` has been renamed to `NotificationServicesPushControllerSubscribeToPushNotificationsAction` so it matches the method name.
+  - These changes only affect the types. The action type strings themselves have not changed, so you do not need to update the list of actions you pass when initializing `NotificationServicesController` and `NotificationServicesPushController` messengers.
+- Register notification accounts from all keyrings instead of only the first HD keyring, so notification setup now includes addresses from HD, hardware, imported, and snap keyrings ([#8108](https://github.com/MetaMask/core/pull/8108))
+- Add push token unlink support for account removal by deleting `/api/v2/token` links for `{ address, platform }` pairs when notification accounts are disabled (for example during SRP removal) ([#8108](https://github.com/MetaMask/core/pull/8108))
+
+## [22.1.0]
+
+### Changed
+
+- Debounce `KeyringController:stateChange` handler to reduce redundant notification subscription calls during rapid account syncing ([#7980](https://github.com/MetaMask/core/pull/7980))
+- Filter out Product Account announcements notifications older than 3 months ([#7884](https://github.com/MetaMask/core/pull/7884))
+- Bump `@metamask/controller-utils` from `^11.18.0` to `^11.19.0` ([#7995](https://github.com/MetaMask/core/pull/7995))
+- Bump `@metamask/profile-sync-controller` from `^27.1.0` to `^28.0.0` ([#8162](https://github.com/MetaMask/core/pull/8162))
+
 ## [22.0.0]
 
 ### Changed
@@ -21,6 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Note, however, that the versions specified in the client's `package.json` always "win", and you are expected to keep them up to date so as not to break controller and service intercommunication.
 - Modified background push utilities to handle more edgecases and not throw errors ([#7275](https://github.com/MetaMask/core/pull/7275))
 - Bump `@metamask/controller-utils` from `^11.16.0` to `^11.18.0` ([#7534](https://github.com/MetaMask/core/pull/7534), [#7583](https://github.com/MetaMask/core/pull/7583))
+- Filter feature announcements older than 3 months ([#7884](https://github.com/MetaMask/core/pull/7884))
 - Move notifications networks metadata to backend ([#7840](https://github.com/MetaMask/core/pull/7840))
 
 ### Removed
@@ -657,7 +697,9 @@ 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@22.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@23.0.0...HEAD
+[23.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@22.1.0...@metamask/notification-services-controller@23.0.0
+[22.1.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@22.0.0...@metamask/notification-services-controller@22.1.0
 [22.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@21.0.0...@metamask/notification-services-controller@22.0.0
 [21.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@20.0.0...@metamask/notification-services-controller@21.0.0
 [20.0.0]: https://github.com/MetaMask/core/compare/@metamask/notification-services-controller@19.0.0...@metamask/notification-services-controller@20.0.0

package/dist/NotificationServicesController/NotificationServicesController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NotificationServicesController-method-action-types.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationServicesController-method-action-types.cjs","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { NotificationServicesController } from './NotificationServicesController';\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 * @param opts - optional options to mutate this functionality\n * @param opts.resetNotifications - this will not use the users stored preferences, and instead re-create notification triggers\n * It will help in case uses get into a corrupted state or wants to wipe their notifications.\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 * @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 * Deletes on-chain triggers associated with a specific account/s.\n * This method performs several key operations:\n * 1. Validates Auth\n * 2. Deletes accounts\n * (note) We do not need to look through push notifications as we've deleted triggers\n *\n * **Action** - When a user disables notifications for a given account in settings.\n *\n * @param accounts - The account for which on-chain triggers are to be deleted.\n * @returns A promise that resolves to void or an object containing a success message.\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 * Updates/Creates on-chain triggers for a specific account.\n *\n * This method performs several key operations:\n * 1. Validates Auth & Storage\n * 2. Finds and creates any missing triggers associated with the account\n * 3. Enables any related push notifications\n * 4. Updates Storage to reflect new state.\n *\n * **Action** - When a user enables notifications for an account\n *\n * @param accounts - List of accounts you want to update.\n * @returns A promise that resolves to the updated user storage.\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"]}

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

@@ -0,0 +1,198 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { NotificationServicesController } from "./NotificationServicesController.cjs";
+export type NotificationServicesControllerInitAction = {
+    type: `NotificationServicesController:init`;
+    handler: NotificationServicesController['init'];
+};
+/**
+ * Public method to expose enabling push notifications
+ */
+export type NotificationServicesControllerEnablePushNotificationsAction = {
+    type: `NotificationServicesController:enablePushNotifications`;
+    handler: NotificationServicesController['enablePushNotifications'];
+};
+/**
+ * Public method to expose disabling push notifications
+ */
+export type NotificationServicesControllerDisablePushNotificationsAction = {
+    type: `NotificationServicesController:disablePushNotifications`;
+    handler: NotificationServicesController['disablePushNotifications'];
+};
+export type NotificationServicesControllerCheckAccountsPresenceAction = {
+    type: `NotificationServicesController:checkAccountsPresence`;
+    handler: NotificationServicesController['checkAccountsPresence'];
+};
+/**
+ * Sets the enabled state of feature announcements.
+ *
+ * **Action** - used in the notification settings to enable/disable feature announcements.
+ *
+ * @param featureAnnouncementsEnabled - A boolean value indicating the desired enabled state of the feature announcements.
+ * @async
+ * @throws {Error} If fails to update
+ */
+export type NotificationServicesControllerSetFeatureAnnouncementsEnabledAction = {
+    type: `NotificationServicesController:setFeatureAnnouncementsEnabled`;
+    handler: NotificationServicesController['setFeatureAnnouncementsEnabled'];
+};
+/**
+ * This creates/re-creates on-chain triggers defined in User Storage.
+ *
+ * **Action** - Used during Sign In / Enabling of notifications.
+ *
+ * @param opts - optional options to mutate this functionality
+ * @param opts.resetNotifications - this will not use the users stored preferences, and instead re-create notification triggers
+ * It will help in case uses get into a corrupted state or wants to wipe their notifications.
+ * @returns The updated or newly created user storage.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerCreateOnChainTriggersAction = {
+    type: `NotificationServicesController:createOnChainTriggers`;
+    handler: NotificationServicesController['createOnChainTriggers'];
+};
+/**
+ * Enables all MetaMask notifications for the user.
+ * This is identical flow when initializing notifications for the first time.
+ *
+ * @throws {Error} If there is an error during the process of enabling notifications.
+ */
+export type NotificationServicesControllerEnableMetamaskNotificationsAction = {
+    type: `NotificationServicesController:enableMetamaskNotifications`;
+    handler: NotificationServicesController['enableMetamaskNotifications'];
+};
+/**
+ * Disables all MetaMask notifications for the user.
+ * This method ensures that the user is authenticated, retrieves all linked accounts,
+ * and disables on-chain triggers for each account. It also sets the global notification
+ * settings for MetaMask, feature announcements to false.
+ *
+ * @throws {Error} If the user is not authenticated or if there is an error during the process.
+ */
+export type NotificationServicesControllerDisableNotificationServicesAction = {
+    type: `NotificationServicesController:disableNotificationServices`;
+    handler: NotificationServicesController['disableNotificationServices'];
+};
+/**
+ * Deletes on-chain triggers associated with a specific account/s.
+ * This method performs several key operations:
+ * 1. Validates Auth
+ * 2. Deletes accounts
+ * (note) We do not need to look through push notifications as we've deleted triggers
+ *
+ * **Action** - When a user disables notifications for a given account in settings.
+ *
+ * @param accounts - The account for which on-chain triggers are to be deleted.
+ * @returns A promise that resolves to void or an object containing a success message.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerDisableAccountsAction = {
+    type: `NotificationServicesController:disableAccounts`;
+    handler: NotificationServicesController['disableAccounts'];
+};
+/**
+ * Updates/Creates on-chain triggers for a specific account.
+ *
+ * This method performs several key operations:
+ * 1. Validates Auth & Storage
+ * 2. Finds and creates any missing triggers associated with the account
+ * 3. Enables any related push notifications
+ * 4. Updates Storage to reflect new state.
+ *
+ * **Action** - When a user enables notifications for an account
+ *
+ * @param accounts - List of accounts you want to update.
+ * @returns A promise that resolves to the updated user storage.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerEnableAccountsAction = {
+    type: `NotificationServicesController:enableAccounts`;
+    handler: NotificationServicesController['enableAccounts'];
+};
+/**
+ * Fetches the list of metamask notifications.
+ * This includes OnChain notifications; Feature Announcements; and Snap Notifications.
+ *
+ * **Action** - When a user views the notification list page/dropdown
+ *
+ * @param previewToken - the preview token to use if needed
+ * @returns A promise that resolves to the list of notifications.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction = {
+    type: `NotificationServicesController:fetchAndUpdateMetamaskNotifications`;
+    handler: NotificationServicesController['fetchAndUpdateMetamaskNotifications'];
+};
+/**
+ * Gets the specified type of notifications from state.
+ *
+ * @param type - The trigger type.
+ * @returns An array of notifications of the passed in type.
+ * @throws Throws an error if an invalid trigger type is passed.
+ */
+export type NotificationServicesControllerGetNotificationsByTypeAction = {
+    type: `NotificationServicesController:getNotificationsByType`;
+    handler: NotificationServicesController['getNotificationsByType'];
+};
+/**
+ * Used to delete a notification by id.
+ *
+ * Note: This function should only be used for notifications that are stored
+ * in this controller directly, currently only snaps notifications.
+ *
+ * @param id - The id of the notification to delete.
+ */
+export type NotificationServicesControllerDeleteNotificationByIdAction = {
+    type: `NotificationServicesController:deleteNotificationById`;
+    handler: NotificationServicesController['deleteNotificationById'];
+};
+/**
+ * Used to batch delete notifications by id.
+ *
+ * Note: This function should only be used for notifications that are stored
+ * in this controller directly, currently only snaps notifications.
+ *
+ * @param ids - The ids of the notifications to delete.
+ */
+export type NotificationServicesControllerDeleteNotificationsByIdAction = {
+    type: `NotificationServicesController:deleteNotificationsById`;
+    handler: NotificationServicesController['deleteNotificationsById'];
+};
+/**
+ * Marks specified metamask notifications as read.
+ *
+ * @param notifications - An array of notifications to be marked as read. Each notification should include its type and read status.
+ * @returns A promise that resolves when the operation is complete.
+ */
+export type NotificationServicesControllerMarkMetamaskNotificationsAsReadAction = {
+    type: `NotificationServicesController:markMetamaskNotificationsAsRead`;
+    handler: NotificationServicesController['markMetamaskNotificationsAsRead'];
+};
+/**
+ * Updates the list of MetaMask notifications by adding a new notification at the beginning of the list.
+ * This method ensures that the most recent notification is displayed first in the UI.
+ *
+ * @param notification - The new notification object to be added to the list.
+ * @returns A promise that resolves when the notification list has been successfully updated.
+ */
+export type NotificationServicesControllerUpdateMetamaskNotificationsListAction = {
+    type: `NotificationServicesController:updateMetamaskNotificationsList`;
+    handler: NotificationServicesController['updateMetamaskNotificationsList'];
+};
+/**
+ * Creates an perp order notification subscription.
+ * Requires notifications and auth to be enabled to start receiving this notifications
+ *
+ * @param input perp input
+ */
+export type NotificationServicesControllerSendPerpPlaceOrderNotificationAction = {
+    type: `NotificationServicesController:sendPerpPlaceOrderNotification`;
+    handler: NotificationServicesController['sendPerpPlaceOrderNotification'];
+};
+/**
+ * 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;
+//# sourceMappingURL=NotificationServicesController-method-action-types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationServicesController-method-action-types.d.cts","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,6CAAyC;AAEvF,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;;;;;;;;;;GAUG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;GAKG;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;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;;;;;;;;;;GAcG;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"}

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

@@ -0,0 +1,198 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { NotificationServicesController } from "./NotificationServicesController.mjs";
+export type NotificationServicesControllerInitAction = {
+    type: `NotificationServicesController:init`;
+    handler: NotificationServicesController['init'];
+};
+/**
+ * Public method to expose enabling push notifications
+ */
+export type NotificationServicesControllerEnablePushNotificationsAction = {
+    type: `NotificationServicesController:enablePushNotifications`;
+    handler: NotificationServicesController['enablePushNotifications'];
+};
+/**
+ * Public method to expose disabling push notifications
+ */
+export type NotificationServicesControllerDisablePushNotificationsAction = {
+    type: `NotificationServicesController:disablePushNotifications`;
+    handler: NotificationServicesController['disablePushNotifications'];
+};
+export type NotificationServicesControllerCheckAccountsPresenceAction = {
+    type: `NotificationServicesController:checkAccountsPresence`;
+    handler: NotificationServicesController['checkAccountsPresence'];
+};
+/**
+ * Sets the enabled state of feature announcements.
+ *
+ * **Action** - used in the notification settings to enable/disable feature announcements.
+ *
+ * @param featureAnnouncementsEnabled - A boolean value indicating the desired enabled state of the feature announcements.
+ * @async
+ * @throws {Error} If fails to update
+ */
+export type NotificationServicesControllerSetFeatureAnnouncementsEnabledAction = {
+    type: `NotificationServicesController:setFeatureAnnouncementsEnabled`;
+    handler: NotificationServicesController['setFeatureAnnouncementsEnabled'];
+};
+/**
+ * This creates/re-creates on-chain triggers defined in User Storage.
+ *
+ * **Action** - Used during Sign In / Enabling of notifications.
+ *
+ * @param opts - optional options to mutate this functionality
+ * @param opts.resetNotifications - this will not use the users stored preferences, and instead re-create notification triggers
+ * It will help in case uses get into a corrupted state or wants to wipe their notifications.
+ * @returns The updated or newly created user storage.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerCreateOnChainTriggersAction = {
+    type: `NotificationServicesController:createOnChainTriggers`;
+    handler: NotificationServicesController['createOnChainTriggers'];
+};
+/**
+ * Enables all MetaMask notifications for the user.
+ * This is identical flow when initializing notifications for the first time.
+ *
+ * @throws {Error} If there is an error during the process of enabling notifications.
+ */
+export type NotificationServicesControllerEnableMetamaskNotificationsAction = {
+    type: `NotificationServicesController:enableMetamaskNotifications`;
+    handler: NotificationServicesController['enableMetamaskNotifications'];
+};
+/**
+ * Disables all MetaMask notifications for the user.
+ * This method ensures that the user is authenticated, retrieves all linked accounts,
+ * and disables on-chain triggers for each account. It also sets the global notification
+ * settings for MetaMask, feature announcements to false.
+ *
+ * @throws {Error} If the user is not authenticated or if there is an error during the process.
+ */
+export type NotificationServicesControllerDisableNotificationServicesAction = {
+    type: `NotificationServicesController:disableNotificationServices`;
+    handler: NotificationServicesController['disableNotificationServices'];
+};
+/**
+ * Deletes on-chain triggers associated with a specific account/s.
+ * This method performs several key operations:
+ * 1. Validates Auth
+ * 2. Deletes accounts
+ * (note) We do not need to look through push notifications as we've deleted triggers
+ *
+ * **Action** - When a user disables notifications for a given account in settings.
+ *
+ * @param accounts - The account for which on-chain triggers are to be deleted.
+ * @returns A promise that resolves to void or an object containing a success message.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerDisableAccountsAction = {
+    type: `NotificationServicesController:disableAccounts`;
+    handler: NotificationServicesController['disableAccounts'];
+};
+/**
+ * Updates/Creates on-chain triggers for a specific account.
+ *
+ * This method performs several key operations:
+ * 1. Validates Auth & Storage
+ * 2. Finds and creates any missing triggers associated with the account
+ * 3. Enables any related push notifications
+ * 4. Updates Storage to reflect new state.
+ *
+ * **Action** - When a user enables notifications for an account
+ *
+ * @param accounts - List of accounts you want to update.
+ * @returns A promise that resolves to the updated user storage.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerEnableAccountsAction = {
+    type: `NotificationServicesController:enableAccounts`;
+    handler: NotificationServicesController['enableAccounts'];
+};
+/**
+ * Fetches the list of metamask notifications.
+ * This includes OnChain notifications; Feature Announcements; and Snap Notifications.
+ *
+ * **Action** - When a user views the notification list page/dropdown
+ *
+ * @param previewToken - the preview token to use if needed
+ * @returns A promise that resolves to the list of notifications.
+ * @throws {Error} Throws an error if unauthenticated or from other operations.
+ */
+export type NotificationServicesControllerFetchAndUpdateMetamaskNotificationsAction = {
+    type: `NotificationServicesController:fetchAndUpdateMetamaskNotifications`;
+    handler: NotificationServicesController['fetchAndUpdateMetamaskNotifications'];
+};
+/**
+ * Gets the specified type of notifications from state.
+ *
+ * @param type - The trigger type.
+ * @returns An array of notifications of the passed in type.
+ * @throws Throws an error if an invalid trigger type is passed.
+ */
+export type NotificationServicesControllerGetNotificationsByTypeAction = {
+    type: `NotificationServicesController:getNotificationsByType`;
+    handler: NotificationServicesController['getNotificationsByType'];
+};
+/**
+ * Used to delete a notification by id.
+ *
+ * Note: This function should only be used for notifications that are stored
+ * in this controller directly, currently only snaps notifications.
+ *
+ * @param id - The id of the notification to delete.
+ */
+export type NotificationServicesControllerDeleteNotificationByIdAction = {
+    type: `NotificationServicesController:deleteNotificationById`;
+    handler: NotificationServicesController['deleteNotificationById'];
+};
+/**
+ * Used to batch delete notifications by id.
+ *
+ * Note: This function should only be used for notifications that are stored
+ * in this controller directly, currently only snaps notifications.
+ *
+ * @param ids - The ids of the notifications to delete.
+ */
+export type NotificationServicesControllerDeleteNotificationsByIdAction = {
+    type: `NotificationServicesController:deleteNotificationsById`;
+    handler: NotificationServicesController['deleteNotificationsById'];
+};
+/**
+ * Marks specified metamask notifications as read.
+ *
+ * @param notifications - An array of notifications to be marked as read. Each notification should include its type and read status.
+ * @returns A promise that resolves when the operation is complete.
+ */
+export type NotificationServicesControllerMarkMetamaskNotificationsAsReadAction = {
+    type: `NotificationServicesController:markMetamaskNotificationsAsRead`;
+    handler: NotificationServicesController['markMetamaskNotificationsAsRead'];
+};
+/**
+ * Updates the list of MetaMask notifications by adding a new notification at the beginning of the list.
+ * This method ensures that the most recent notification is displayed first in the UI.
+ *
+ * @param notification - The new notification object to be added to the list.
+ * @returns A promise that resolves when the notification list has been successfully updated.
+ */
+export type NotificationServicesControllerUpdateMetamaskNotificationsListAction = {
+    type: `NotificationServicesController:updateMetamaskNotificationsList`;
+    handler: NotificationServicesController['updateMetamaskNotificationsList'];
+};
+/**
+ * Creates an perp order notification subscription.
+ * Requires notifications and auth to be enabled to start receiving this notifications
+ *
+ * @param input perp input
+ */
+export type NotificationServicesControllerSendPerpPlaceOrderNotificationAction = {
+    type: `NotificationServicesController:sendPerpPlaceOrderNotification`;
+    handler: NotificationServicesController['sendPerpPlaceOrderNotification'];
+};
+/**
+ * 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;
+//# sourceMappingURL=NotificationServicesController-method-action-types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationServicesController-method-action-types.d.mts","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,6CAAyC;AAEvF,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;;;;;;;;;;GAUG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;GAKG;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;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;;;;;;;;;;GAcG;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"}

package/dist/NotificationServicesController/NotificationServicesController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=NotificationServicesController-method-action-types.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationServicesController-method-action-types.mjs","sourceRoot":"","sources":["../../src/NotificationServicesController/NotificationServicesController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { NotificationServicesController } from './NotificationServicesController';\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 * @param opts - optional options to mutate this functionality\n * @param opts.resetNotifications - this will not use the users stored preferences, and instead re-create notification triggers\n * It will help in case uses get into a corrupted state or wants to wipe their notifications.\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 * @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 * Deletes on-chain triggers associated with a specific account/s.\n * This method performs several key operations:\n * 1. Validates Auth\n * 2. Deletes accounts\n * (note) We do not need to look through push notifications as we've deleted triggers\n *\n * **Action** - When a user disables notifications for a given account in settings.\n *\n * @param accounts - The account for which on-chain triggers are to be deleted.\n * @returns A promise that resolves to void or an object containing a success message.\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 * Updates/Creates on-chain triggers for a specific account.\n *\n * This method performs several key operations:\n * 1. Validates Auth & Storage\n * 2. Finds and creates any missing triggers associated with the account\n * 3. Enables any related push notifications\n * 4. Updates Storage to reflect new state.\n *\n * **Action** - When a user enables notifications for an account\n *\n * @param accounts - List of accounts you want to update.\n * @returns A promise that resolves to the updated user storage.\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"]}