@metamask-previews/notification-services-controller 23.1.1-preview-ccdc8dcd5 → 23.1.1-preview-e5cef32c6

package/dist/NotificationServicesController/NotificationServicesController.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_locale, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_env, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getBearerToken, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
+var _NotificationServicesController_instances, _NotificationServicesController_keyringController, _NotificationServicesController_auth, _NotificationServicesController_pushNotifications, _NotificationServicesController_accounts, _NotificationServicesController_locale, _NotificationServicesController_featureAnnouncementEnv, _NotificationServicesController_env, _NotificationServicesController_clearLoadingStates, _NotificationServicesController_assertAuthEnabled, _NotificationServicesController_enableAuth, _NotificationServicesController_getBearerToken, _NotificationServicesController_registerWalletActivityAddresses, _NotificationServicesController_setIsUpdatingMetamaskNotifications, _NotificationServicesController_setIsFetchingMetamaskNotifications, _NotificationServicesController_setIsCheckingAccountsPresence, _NotificationServicesController_updateUpdatingAccountsState, _NotificationServicesController_clearUpdatingAccountsState;
 function $importDefault(module) {
     if (module?.__esModule) {
         return module.default;
@@ -25,7 +25,7 @@ import $log from "loglevel";
 const log = $importDefault($log);
 import { TRIGGER_TYPES } from "./constants/notification-schema.mjs";
 import { processAndFilterNotifications, safeProcessNotification } from "./processors/process-notifications.mjs";
-import { getAPINotifications, getNotificationsApiConfigCached, markNotificationsAsRead, updateOnChainNotifications } from "./services/api-notifications.mjs";
+import { getAPINotifications, getNotificationsApiConfigCached, markNotificationsAsRead } from "./services/api-notifications.mjs";
 import { getFeatureAnnouncementNotifications } from "./services/feature-announcements.mjs";
 import { createPerpOrderNotification } from "./services/perp-notifications.mjs";
 // Unique name for the controller
@@ -108,6 +108,84 @@ export const defaultState = {
 const locallyPersistedNotificationTypes = new Set([
     TRIGGER_TYPES.SNAP,
 ]);
+/**
+ * Hardcoded default Perps notification preferences. Applied when notification
+ * preferences are initialized for the first time.
+ */
+export const DEFAULT_PERPS_PREFERENCES = {
+    inAppNotificationsEnabled: true,
+    pushNotificationsEnabled: true,
+};
+/**
+ * Hardcoded default Social AI notification preferences. Applied when
+ * notification preferences are initialized for the first time.
+ */
+export const DEFAULT_SOCIAL_AI_PREFERENCES = {
+    inAppNotificationsEnabled: true,
+    pushNotificationsEnabled: true,
+    txAmountLimit: 500,
+    mutedTraderProfileIds: [],
+};
+/**
+ * Builds wallet-activity preferences from the keyring's current accounts.
+ *
+ * @param accounts - The keyring accounts to build wallet-activity entries for.
+ * @returns An array of wallet-activity account entries (lower-cased addresses).
+ */
+const buildWalletActivityAccounts = (accounts) => accounts.map(({ address, enabled }) => {
+    const lowercased = address.toLowerCase();
+    return {
+        address: lowercased,
+        enabled,
+    };
+});
+/**
+ * Builds wallet-activity initialization from the Trigger API. If Trigger has no
+ * enabled entries for the current keyring accounts, this is a first-time
+ * notification setup and all current accounts should start enabled.
+ *
+ * @param bearerToken - JWT used to query Trigger API.
+ * @param accounts - The keyring accounts to initialize.
+ * @param env - The environment to use for the Trigger API call.
+ * @returns Wallet-activity account initialization entries.
+ */
+const buildWalletActivityAccountsFromTriggerConfig = async (bearerToken, accounts, env) => {
+    const triggerConfig = await getNotificationsApiConfigCached(bearerToken, accounts, env);
+    const triggerConfigByAddress = new Map(triggerConfig.map(({ address, enabled }) => [
+        address.toLowerCase(),
+        enabled,
+    ]));
+    const hasEnabledTriggerAccount = accounts.some((address) => triggerConfigByAddress.get(address.toLowerCase()) === true);
+    return accounts.map((address) => ({
+        address,
+        enabled: hasEnabledTriggerAccount
+            ? (triggerConfigByAddress.get(address.toLowerCase()) ?? false)
+            : true,
+    }));
+};
+/**
+ * Builds a fresh `NotificationPreferences` blob using hardcoded defaults for
+ * Perps and Social AI, the supplied wallet-activity accounts and the user's
+ * marketing/product-announcement flags.
+ *
+ * @param walletActivityAccounts - The wallet-activity account config to initialize.
+ * @param hasMarketingConsent - Whether marketing push notifications should be enabled.
+ * @param productAnnouncementEnabled - Whether marketing in-app notifications should be enabled.
+ * @returns A complete `NotificationPreferences` object.
+ */
+const buildFreshPreferences = (walletActivityAccounts, hasMarketingConsent, productAnnouncementEnabled) => ({
+    walletActivity: {
+        inAppNotificationsEnabled: true,
+        pushNotificationsEnabled: true,
+        accounts: buildWalletActivityAccounts(walletActivityAccounts),
+    },
+    marketing: {
+        inAppNotificationsEnabled: productAnnouncementEnabled,
+        pushNotificationsEnabled: hasMarketingConsent,
+    },
+    perps: { ...DEFAULT_PERPS_PREFERENCES },
+    socialAI: { ...DEFAULT_SOCIAL_AI_PREFERENCES },
+});
 const MESSENGER_EXPOSED_METHODS = [
     'init',
     'enablePushNotifications',
@@ -377,14 +455,12 @@ export class NotificationServicesController extends BaseController {
      */
     async enablePushNotifications() {
         try {
-            const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-            const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
-            const addressesWithNotifications = await getNotificationsApiConfigCached(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
-            const addresses = addressesWithNotifications
-                .filter((addressConfig) => Boolean(addressConfig.enabled))
-                .map((addressConfig) => addressConfig.address);
-            if (addresses.length > 0) {
-                await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(addresses);
+            const preferences = await this.messenger.call('AuthenticatedUserStorageService:getNotificationPreferences');
+            const enabledAddresses = (preferences?.walletActivity.accounts ?? [])
+                .filter((account) => account.enabled)
+                .map((account) => account.address);
+            if (enabledAddresses.length > 0) {
+                await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").enablePushNotifications(enabledAddresses);
             }
         }
         catch {
@@ -400,13 +476,15 @@ export class NotificationServicesController extends BaseController {
     async checkAccountsPresence(accounts) {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsCheckingAccountsPresence).call(this, true);
-            // Retrieve user storage
-            const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-            const addressesWithNotifications = await getNotificationsApiConfigCached(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
+            const preferences = await this.messenger.call('AuthenticatedUserStorageService:getNotificationPreferences');
+            const enabledByAddress = new Map((preferences?.walletActivity.accounts ?? []).map((account) => [
+                account.address.toLowerCase(),
+                account.enabled,
+            ]));
             const result = {};
-            addressesWithNotifications.forEach((a) => {
-                result[a.address] = a.enabled;
-            });
+            for (const address of accounts) {
+                result[address] = enabledByAddress.get(address.toLowerCase()) ?? false;
+            }
             return result;
         }
         catch (error) {
@@ -442,9 +520,15 @@ export class NotificationServicesController extends BaseController {
      *
      * **Action** - Used during Sign In / Enabling of notifications.
      *
+     * Notification preferences are initialized only when
+     * {@link AuthenticatedUserStorageService} has no stored preferences yet.
+     * Existing preferences are left as-is.
+     *
      * @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.
+     * @param opts.hasMarketingConsent - The user's marketing-consent flag.
+     * Used only during initialization to seed marketing push notifications.
+     * @param opts.productAnnouncementEnabled - The user's product-announcement flag.
+     * Used only during initialization to seed marketing in-app notifications.
      * @returns The updated or newly created user storage.
      * @throws {Error} Throws an error if unauthenticated or from other operations.
      */
@@ -453,19 +537,23 @@ export class NotificationServicesController extends BaseController {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
             const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
             const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
-            // 1. See if has enabled notifications before
-            const addressesWithNotifications = await getNotificationsApiConfigCached(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
-            // Notifications API can return array with addresses set to false
-            // So assert that at least one address is enabled
-            let accountsWithNotifications = addressesWithNotifications
-                .filter((addressConfig) => Boolean(addressConfig.enabled))
-                .map((addressConfig) => addressConfig.address);
-            // 2. Enable Notifications (if no accounts subscribed or we are resetting)
-            if (accountsWithNotifications.length === 0 || opts?.resetNotifications) {
-                await updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: true })), __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
-                accountsWithNotifications = accounts;
+            // 1. Read existing AUS notification preferences and initialize only if absent.
+            const preferences = await this.messenger.call('AuthenticatedUserStorageService:getNotificationPreferences');
+            const hasMarketingConsent = Boolean(opts?.hasMarketingConsent);
+            const productAnnouncementEnabled = Boolean(opts?.productAnnouncementEnabled);
+            let nextPreferences;
+            if (preferences === null) {
+                const walletActivityAccounts = await buildWalletActivityAccountsFromTriggerConfig(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
+                nextPreferences = buildFreshPreferences(walletActivityAccounts, hasMarketingConsent, productAnnouncementEnabled);
             }
-            // 3. Lazily enable push notifications (FCM may take some time, so keeps UI unblocked)
+            if (nextPreferences) {
+                await this.messenger.call('AuthenticatedUserStorageService:putNotificationPreferences', nextPreferences, __classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f").platform);
+            }
+            const effectivePreferences = nextPreferences ?? preferences;
+            const accountsWithNotifications = (effectivePreferences?.walletActivity.accounts ?? [])
+                .filter((account) => account.enabled)
+                .map((account) => account.address);
+            // 2. Lazily enable push notifications (FCM may take some time, so keeps UI unblocked)
             __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f")
                 .enablePushNotifications(accountsWithNotifications)
                 .catch(() => {
@@ -498,13 +586,14 @@ export class NotificationServicesController extends BaseController {
      * Enables all MetaMask notifications for the user.
      * This is identical flow when initializing notifications for the first time.
      *
+     * @param opts - Optional settings for first-time AUS notification preferences initialization.
      * @throws {Error} If there is an error during the process of enabling notifications.
      */
-    async enableMetamaskNotifications() {
+    async enableMetamaskNotifications(opts) {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_setIsUpdatingMetamaskNotifications).call(this, true);
             await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_enableAuth).call(this);
-            await this.createOnChainTriggers();
+            await this.createOnChainTriggers(opts);
         }
         catch (error) {
             log.error('Unable to enable notifications', error);
@@ -559,10 +648,9 @@ export class NotificationServicesController extends BaseController {
     async disableAccounts(accounts) {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_updateUpdatingAccountsState).call(this, accounts);
-            // Get and Validate BearerToken and User Storage Key
-            const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-            // Delete these UUIDs (Mutates User Storage)
-            await updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: false })), __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
+            // Sign-in gate.
+            await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
+            await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_registerWalletActivityAddresses).call(this, accounts.map((address) => ({ address, enabled: false })));
             await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").deletePushNotificationLinks(accounts);
         }
         catch {
@@ -590,8 +678,9 @@ export class NotificationServicesController extends BaseController {
     async enableAccounts(accounts) {
         try {
             __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_updateUpdatingAccountsState).call(this, accounts);
-            const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-            await updateOnChainNotifications(bearerToken, accounts.map((address) => ({ address, enabled: true })), __classPrivateFieldGet(this, _NotificationServicesController_env, "f"));
+            // Sign-in gate.
+            await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
+            await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_registerWalletActivityAddresses).call(this, accounts.map((address) => ({ address, enabled: true })));
             await __classPrivateFieldGet(this, _NotificationServicesController_pushNotifications, "f").addPushNotificationLinks(accounts);
         }
         catch (error) {
@@ -627,10 +716,10 @@ export class NotificationServicesController extends BaseController {
             if (isGlobalNotifsEnabled) {
                 try {
                     const { bearerToken } = await __classPrivateFieldGet(this, _NotificationServicesController_instances, "m", _NotificationServicesController_getBearerToken).call(this);
-                    const { accounts } = __classPrivateFieldGet(this, _NotificationServicesController_accounts, "f").listAccounts();
-                    const addressesWithNotifications = (await getNotificationsApiConfigCached(bearerToken, accounts, __classPrivateFieldGet(this, _NotificationServicesController_env, "f")))
-                        .filter((addressConfig) => Boolean(addressConfig.enabled))
-                        .map((addressConfig) => addressConfig.address);
+                    const preferences = await this.messenger.call('AuthenticatedUserStorageService:getNotificationPreferences');
+                    const addressesWithNotifications = (preferences?.walletActivity.accounts ?? [])
+                        .filter((account) => account.enabled)
+                        .map((account) => account.address);
                     const notifications = await getAPINotifications(bearerToken, addressesWithNotifications, __classPrivateFieldGet(this, _NotificationServicesController_locale, "f").call(this), __classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f").platform, __classPrivateFieldGet(this, _NotificationServicesController_env, "f")).catch(() => []);
                     rawOnChainNotifications.push(...notifications);
                 }
@@ -855,6 +944,53 @@ _NotificationServicesController_keyringController = new WeakMap(), _Notification
         throw new Error('Missing BearerToken');
     }
     return { bearerToken };
+}, _NotificationServicesController_registerWalletActivityAddresses = 
+/**
+ * Updates the `walletActivity.accounts` entries in the user's
+ * notification-preferences blob in {@link AuthenticatedUserStorageService}.
+ *
+ * `putNotificationPreferences` replaces the entire blob, so we read the
+ * current preferences, merge the supplied updates into
+ * `walletActivity.accounts`, and write the result back. This helper is only
+ * meant to be used for incremental updates (enable/disable individual
+ * accounts) after the preferences blob has already been initialized via
+ * {@link createOnChainTriggers}; callers should not rely on it to perform
+ * first-time initialization.
+ *
+ * @param updates - Addresses to register, each with the desired `enabled` flag
+ */
+async function _NotificationServicesController_registerWalletActivityAddresses(updates) {
+    if (updates.length === 0) {
+        return;
+    }
+    const currentPreferences = await this.messenger
+        .call('AuthenticatedUserStorageService:getNotificationPreferences')
+        .catch((error) => {
+        log.error('Failed to get notification preferences. Re-initializing them instead.', error);
+        // TODO: return null once validation error captured
+        // return null;
+        throw error;
+    });
+    if (!currentPreferences) {
+        log.warn('Preferences blob not yet initialized; run `createOnChainTriggers` first.');
+        return;
+    }
+    const accountsByAddress = new Map(currentPreferences.walletActivity.accounts.map((account) => [
+        account.address.toLowerCase(),
+        { ...account, address: account.address.toLowerCase() },
+    ]));
+    for (const update of updates) {
+        const address = update.address.toLowerCase();
+        accountsByAddress.set(address, { address, enabled: update.enabled });
+    }
+    const nextPreferences = {
+        ...currentPreferences,
+        walletActivity: {
+            ...currentPreferences.walletActivity,
+            accounts: [...accountsByAddress.values()],
+        },
+    };
+    await this.messenger.call('AuthenticatedUserStorageService:putNotificationPreferences', nextPreferences, __classPrivateFieldGet(this, _NotificationServicesController_featureAnnouncementEnv, "f").platform);
 }, _NotificationServicesController_setIsUpdatingMetamaskNotifications = function _NotificationServicesController_setIsUpdatingMetamaskNotifications(isUpdatingMetamaskNotifications) {
     this.update((state) => {
         state.isUpdatingMetamaskNotifications = isUpdatingMetamaskNotifications;