@metamask-previews/notification-services-controller 10.0.0-preview-7dcef379 → 10.0.0-preview-f9611039

package/dist/NotificationServicesController/utils/utils.d.mts

@@ -1,3 +1,143 @@
+import type { TRIGGER_TYPES } from "../constants/notification-schema.mjs";
+import type { UserStorage } from "../types/user-storage/user-storage.mjs";
+export type NotificationTrigger = {
+    id: string;
+    chainId: string;
+    kind: string;
+    address: string;
+    enabled: boolean;
+};
+type MapTriggerFn<Result> = (trigger: NotificationTrigger) => Result | undefined;
+type TraverseTriggerOpts<Result> = {
+    address?: string;
+    mapTrigger?: MapTriggerFn<Result>;
+};
+/**
+ * Create a completely new user storage object with the given accounts and state.
+ * This method initializes the user storage with a version key and iterates over each account to populate it with triggers.
+ * Each trigger is associated with supported chains, and for each chain, a unique identifier (UUID) is generated.
+ * The trigger object contains a kind (`k`) indicating the type of trigger and an enabled state (`e`).
+ * The kind and enabled state are stored with abbreviated keys to reduce the JSON size.
+ *
+ * This is used primarily for creating a new user storage (e.g. when first signing in/enabling notification profile syncing),
+ * caution is needed in case you need to remove triggers that you don't want (due to notification setting filters)
+ *
+ * @param accounts - An array of account objects, each optionally containing an address.
+ * @param state - A boolean indicating the initial enabled state for all triggers in the user storage.
+ * @param shouldClean - prop to clean the initialized UserStorage (removing any invalid addresses). Only false for testing purposes.
+ * @returns A `UserStorage` object populated with triggers for each account and chain.
+ */
+export declare function initializeUserStorage(accounts: {
+    address?: string;
+}[], state: boolean, shouldClean?: boolean): UserStorage;
+/**
+ * This is a fallback to ensure that we are not adding non-hex addresses, and the shape is valid.
+ * Any invalid shapes will be removed.
+ * NOTE - this method mutates and returns the cleaned User Storage.
+ *
+ * @param userStorage - notification user storage field we are to clean.
+ * @returns a cleaned version of user storage.
+ */
+export declare function cleanUserStorage(userStorage: UserStorage): UserStorage;
+/**
+ * Iterates over user storage to find and optionally transform notification triggers.
+ * This method allows for flexible retrieval and transformation of triggers based on provided options.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param options - Optional parameters to filter and map triggers:
+ * - `address`: If provided, only triggers for this address are considered.
+ * - `mapTrigger`: A function to transform each trigger. If not provided, triggers are returned as is.
+ * @returns An array of triggers, potentially transformed by the `mapTrigger` function.
+ */
+export declare function traverseUserStorageTriggers<ResultTriggers = NotificationTrigger>(userStorage: UserStorage, options?: TraverseTriggerOpts<ResultTriggers>): ResultTriggers[];
+/**
+ * Verifies the presence of specified accounts and their chains in the user storage.
+ * This method checks if each provided account exists in the user storage and if all its supported chains are present.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param accounts - An array of account addresses to check for presence.
+ * @returns A record where each key is an account address and each value is a boolean indicating whether the account and all its supported chains are present in the user storage.
+ */
+export declare function checkAccountsPresence(userStorage: UserStorage, accounts: string[]): Record<string, boolean>;
+/**
+ * Infers and returns an array of enabled notification trigger kinds from the user storage.
+ * This method counts the occurrences of each kind of trigger and returns the kinds that are present.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @returns An array of trigger kinds (`TRIGGER_TYPES`) that are enabled in the user storage.
+ */
+export declare function inferEnabledKinds(userStorage: UserStorage): TRIGGER_TYPES[];
+/**
+ * Retrieves all UUIDs associated with a specific account address from the user storage.
+ * This function utilizes `traverseUserStorageTriggers` with a mapping function to extract
+ * just the UUIDs of the notification triggers for the given address.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param address - The specific account address to retrieve UUIDs for.
+ * @returns An array of UUID strings associated with the given account address.
+ */
+export declare function getUUIDsForAccount(userStorage: UserStorage, address: string): string[];
+/**
+ * Retrieves all UUIDs from the user storage, regardless of the account address or chain ID.
+ * This method leverages `traverseUserStorageTriggers` with a specific mapping function (`triggerToId`)
+ * to extract only the UUIDs from all notification triggers present in the user storage.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @returns An array of UUID strings from all notification triggers in the user storage.
+ */
+export declare function getAllUUIDs(userStorage: UserStorage): string[];
+/**
+ * Retrieves UUIDs for notification triggers that match any of the specified kinds.
+ * This method filters triggers based on their kind and returns an array of UUIDs for those that match the allowed kinds.
+ * It utilizes `traverseUserStorageTriggers` with a custom mapping function that checks if a trigger's kind is in the allowed list.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param allowedKinds - An array of kinds (as strings) to filter the triggers by.
+ * @returns An array of UUID strings for triggers that match the allowed kinds.
+ */
+export declare function getUUIDsForKinds(userStorage: UserStorage, allowedKinds: string[]): string[];
+/**
+ * Retrieves notification triggers for a specific account address that match any of the specified kinds.
+ * This method filters triggers both by the account address and their kind, returning triggers that match the allowed kinds for the specified address.
+ * It leverages `traverseUserStorageTriggers` with a custom mapping function to filter and return only the relevant triggers.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param address - The specific account address for which to retrieve triggers.
+ * @param allowedKinds - An array of trigger kinds (`TRIGGER_TYPES`) to filter the triggers by.
+ * @returns An array of `NotificationTrigger` objects that match the allowed kinds for the specified account address.
+ */
+export declare function getUUIDsForAccountByKinds(userStorage: UserStorage, address: string, allowedKinds: TRIGGER_TYPES[]): NotificationTrigger[];
+/**
+ * Upserts (updates or inserts) notification triggers for a given account across all supported chains.
+ * This method ensures that each supported trigger type exists for each chain associated with the account.
+ * If a trigger type does not exist for a chain, it creates a new trigger with a unique UUID.
+ *
+ * @param _account - The account address for which to upsert triggers. The address is normalized to lowercase.
+ * @param userStorage - The user storage object to be updated with new or existing triggers.
+ * @returns The updated user storage object with upserted triggers for the specified account.
+ */
+export declare function upsertAddressTriggers(_account: string, userStorage: UserStorage): UserStorage;
+/**
+ * Upserts (updates or inserts) notification triggers of a specific type across all accounts and chains in user storage.
+ * This method ensures that a trigger of the specified type exists for each account and chain. If a trigger of the specified type
+ * does not exist for an account and chain, it creates a new trigger with a unique UUID.
+ *
+ * @param triggerType - The type of trigger to upsert across all accounts and chains.
+ * @param userStorage - The user storage object to be updated with new or existing triggers of the specified type.
+ * @returns The updated user storage object with upserted triggers of the specified type for all accounts and chains.
+ */
+export declare function upsertTriggerTypeTriggers(triggerType: TRIGGER_TYPES, userStorage: UserStorage): UserStorage;
+/**
+ * Toggles the enabled status of a user storage trigger.
+ *
+ * @param userStorage - The user storage object.
+ * @param address - The user's address.
+ * @param chainId - The chain ID.
+ * @param uuid - The unique identifier for the trigger.
+ * @param enabled - The new enabled status.
+ * @returns The updated user storage object.
+ */
+export declare function toggleUserStorageTriggerStatus(userStorage: UserStorage, address: string, chainId: string, uuid: string, enabled: boolean): UserStorage;
 /**
  * Performs an API call with automatic retries on failure.
  *
@@ -8,4 +148,5 @@
  * @returns A Promise that resolves to the response of the fetch request.
  */
 export declare function makeApiCall<Body>(bearerToken: string, endpoint: string, method: 'POST' | 'DELETE', body: Body): Promise<Response>;
+export {};
 //# sourceMappingURL=utils.d.mts.map

package/dist/NotificationServicesController/utils/utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../../src/NotificationServicesController/utils/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,IAAI,EACpC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GAAG,QAAQ,EACzB,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,QAAQ,CAAC,CAWnB"}
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../../src/NotificationServicesController/utils/utils.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,6CAAyC;AAEtE,OAAO,KAAK,EAAE,WAAW,EAAE,+CAA2C;AAEtE,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,KAAK,YAAY,CAAC,MAAM,IAAI,CAC1B,OAAO,EAAE,mBAAmB,KACzB,MAAM,GAAG,SAAS,CAAC;AAExB,KAAK,mBAAmB,CAAC,MAAM,IAAI;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;CACnC,CAAC;AAuBF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,EAChC,KAAK,EAAE,OAAO,EACd,WAAW,UAAO,GACjB,WAAW,CAkCb;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,eAaxD;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,GAAG,mBAAmB,EAEpC,WAAW,EAAE,WAAW,EACxB,OAAO,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAC5C,cAAc,EAAE,CAkClB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,MAAM,EAAE,GACjB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAYzB;AA+CD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,aAAa,EAAE,CAU3E;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,MAAM,EAAE,CAKV;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAI9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,MAAM,EAAE,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,aAAa,EAAE,GAC5B,mBAAmB,EAAE,CAWvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,GACvB,WAAW,CA8Bb;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,aAAa,EAC1B,WAAW,EAAE,WAAW,GACvB,WAAW,CA0Bb;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC5C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,GACf,WAAW,CAMb;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,IAAI,EACpC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GAAG,QAAQ,EACzB,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,QAAQ,CAAC,CAWnB"}

package/dist/NotificationServicesController/utils/utils.mjs

@@ -1,3 +1,340 @@
+import { isValidHexAddress } from "@metamask/controller-utils";
+import { v4 as uuidv4 } from "uuid";
+import { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "../constants/constants.mjs";
+import { TRIGGERS } from "../constants/notification-schema.mjs";
+/**
+ * Extracts and returns the ID from a notification trigger.
+ * This utility function is primarily used as a mapping function in `traverseUserStorageTriggers`
+ * to convert a full trigger object into its ID string.
+ *
+ * @param trigger - The notification trigger from which the ID is extracted.
+ * @returns The ID of the provided notification trigger.
+ */
+const triggerToId = (trigger) => trigger.id;
+/**
+ * A utility function that returns the input trigger without any transformation.
+ * This function is used as the default mapping function in `traverseUserStorageTriggers`
+ * when no custom mapping function is provided.
+ *
+ * @param trigger - The notification trigger to be returned as is.
+ * @returns The same notification trigger that was passed in.
+ */
+const triggerIdentity = (trigger) => trigger;
+/**
+ * Create a completely new user storage object with the given accounts and state.
+ * This method initializes the user storage with a version key and iterates over each account to populate it with triggers.
+ * Each trigger is associated with supported chains, and for each chain, a unique identifier (UUID) is generated.
+ * The trigger object contains a kind (`k`) indicating the type of trigger and an enabled state (`e`).
+ * The kind and enabled state are stored with abbreviated keys to reduce the JSON size.
+ *
+ * This is used primarily for creating a new user storage (e.g. when first signing in/enabling notification profile syncing),
+ * caution is needed in case you need to remove triggers that you don't want (due to notification setting filters)
+ *
+ * @param accounts - An array of account objects, each optionally containing an address.
+ * @param state - A boolean indicating the initial enabled state for all triggers in the user storage.
+ * @param shouldClean - prop to clean the initialized UserStorage (removing any invalid addresses). Only false for testing purposes.
+ * @returns A `UserStorage` object populated with triggers for each account and chain.
+ */
+export function initializeUserStorage(accounts, state, shouldClean = true) {
+    const userStorage = {
+        [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,
+    };
+    accounts.forEach((account) => {
+        const address = account.address?.toLowerCase();
+        if (!address) {
+            return;
+        }
+        if (!userStorage[address]) {
+            userStorage[address] = {};
+        }
+        Object.entries(TRIGGERS).forEach(([trigger, { supported_chains: supportedChains }]) => {
+            supportedChains.forEach((chain) => {
+                if (!userStorage[address]?.[chain]) {
+                    userStorage[address][chain] = {};
+                }
+                userStorage[address][chain][uuidv4()] = {
+                    k: trigger,
+                    e: state, // use 'e' instead of 'enabled' to reduce the json weight
+                };
+            });
+        });
+    });
+    if (shouldClean) {
+        cleanUserStorage(userStorage);
+    }
+    return userStorage;
+}
+/**
+ * This is a fallback to ensure that we are not adding non-hex addresses, and the shape is valid.
+ * Any invalid shapes will be removed.
+ * NOTE - this method mutates and returns the cleaned User Storage.
+ *
+ * @param userStorage - notification user storage field we are to clean.
+ * @returns a cleaned version of user storage.
+ */
+export function cleanUserStorage(userStorage) {
+    const addresses = new Set();
+    traverseUserStorageTriggers(userStorage, {
+        mapTrigger: (t) => addresses.add(t.address),
+    });
+    addresses.forEach((addr) => {
+        if (!isValidHexAddress(addr)) {
+            delete userStorage[addr];
+        }
+    });
+    return userStorage;
+}
+/**
+ * Iterates over user storage to find and optionally transform notification triggers.
+ * This method allows for flexible retrieval and transformation of triggers based on provided options.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param options - Optional parameters to filter and map triggers:
+ * - `address`: If provided, only triggers for this address are considered.
+ * - `mapTrigger`: A function to transform each trigger. If not provided, triggers are returned as is.
+ * @returns An array of triggers, potentially transformed by the `mapTrigger` function.
+ */
+export function traverseUserStorageTriggers(userStorage, options) {
+    const triggers = [];
+    const mapTrigger = options?.mapTrigger ?? triggerIdentity;
+    for (const address in userStorage) {
+        if (address === USER_STORAGE_VERSION_KEY) {
+            continue;
+        }
+        if (options?.address && address !== options.address) {
+            continue;
+        }
+        for (const chainId in userStorage[address]) {
+            if (chainId in userStorage[address]) {
+                for (const uuid in userStorage[address][chainId]) {
+                    if (uuid) {
+                        const mappedTrigger = mapTrigger({
+                            id: uuid,
+                            kind: userStorage[address]?.[chainId]?.[uuid]?.k,
+                            chainId,
+                            address,
+                            enabled: userStorage[address]?.[chainId]?.[uuid]?.e ?? false,
+                        });
+                        if (mappedTrigger) {
+                            triggers.push(mappedTrigger);
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return triggers;
+}
+/**
+ * Verifies the presence of specified accounts and their chains in the user storage.
+ * This method checks if each provided account exists in the user storage and if all its supported chains are present.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param accounts - An array of account addresses to check for presence.
+ * @returns A record where each key is an account address and each value is a boolean indicating whether the account and all its supported chains are present in the user storage.
+ */
+export function checkAccountsPresence(userStorage, accounts) {
+    const presenceRecord = {};
+    // Initialize presence record for all accounts as false
+    accounts.forEach((account) => {
+        presenceRecord[account.toLowerCase()] = isAccountEnabled(account, userStorage);
+    });
+    return presenceRecord;
+}
+/**
+ * Internal method to check if a given account should be marked as enabled by introspecting user storage
+ * Introspection: check if account exists; and also see if has all triggers in schema enabled
+ *
+ * @param accountAddress - address to check in user storage
+ * @param userStorage - user storage object to traverse/introspect
+ * @returns boolean if the account is enabled or disabled
+ */
+function isAccountEnabled(accountAddress, userStorage) {
+    const accountObject = userStorage[accountAddress?.toLowerCase()];
+    // If the account address is not present in the userStorage, return true
+    if (!accountObject) {
+        return false;
+    }
+    // Check if all available chains are present
+    for (const [triggerKind, triggerConfig] of Object.entries(TRIGGERS)) {
+        for (const chain of triggerConfig.supported_chains) {
+            if (!accountObject[chain]) {
+                return false;
+            }
+            const triggerExists = Object.values(accountObject[chain]).some((obj) => obj.k === triggerKind);
+            if (!triggerExists) {
+                return false;
+            }
+            // Check if any trigger is disabled
+            for (const uuid in accountObject[chain]) {
+                if (!accountObject[chain][uuid].e) {
+                    return false;
+                }
+            }
+        }
+    }
+    return true;
+}
+/**
+ * Infers and returns an array of enabled notification trigger kinds from the user storage.
+ * This method counts the occurrences of each kind of trigger and returns the kinds that are present.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @returns An array of trigger kinds (`TRIGGER_TYPES`) that are enabled in the user storage.
+ */
+export function inferEnabledKinds(userStorage) {
+    const allSupportedKinds = new Set();
+    traverseUserStorageTriggers(userStorage, {
+        mapTrigger: (t) => {
+            allSupportedKinds.add(t.kind);
+        },
+    });
+    return Array.from(allSupportedKinds);
+}
+/**
+ * Retrieves all UUIDs associated with a specific account address from the user storage.
+ * This function utilizes `traverseUserStorageTriggers` with a mapping function to extract
+ * just the UUIDs of the notification triggers for the given address.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param address - The specific account address to retrieve UUIDs for.
+ * @returns An array of UUID strings associated with the given account address.
+ */
+export function getUUIDsForAccount(userStorage, address) {
+    return traverseUserStorageTriggers(userStorage, {
+        address,
+        mapTrigger: triggerToId,
+    });
+}
+/**
+ * Retrieves all UUIDs from the user storage, regardless of the account address or chain ID.
+ * This method leverages `traverseUserStorageTriggers` with a specific mapping function (`triggerToId`)
+ * to extract only the UUIDs from all notification triggers present in the user storage.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @returns An array of UUID strings from all notification triggers in the user storage.
+ */
+export function getAllUUIDs(userStorage) {
+    return traverseUserStorageTriggers(userStorage, {
+        mapTrigger: triggerToId,
+    });
+}
+/**
+ * Retrieves UUIDs for notification triggers that match any of the specified kinds.
+ * This method filters triggers based on their kind and returns an array of UUIDs for those that match the allowed kinds.
+ * It utilizes `traverseUserStorageTriggers` with a custom mapping function that checks if a trigger's kind is in the allowed list.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param allowedKinds - An array of kinds (as strings) to filter the triggers by.
+ * @returns An array of UUID strings for triggers that match the allowed kinds.
+ */
+export function getUUIDsForKinds(userStorage, allowedKinds) {
+    const kindsSet = new Set(allowedKinds);
+    return traverseUserStorageTriggers(userStorage, {
+        mapTrigger: (t) => (kindsSet.has(t.kind) ? t.id : undefined),
+    });
+}
+/**
+ * Retrieves notification triggers for a specific account address that match any of the specified kinds.
+ * This method filters triggers both by the account address and their kind, returning triggers that match the allowed kinds for the specified address.
+ * It leverages `traverseUserStorageTriggers` with a custom mapping function to filter and return only the relevant triggers.
+ *
+ * @param userStorage - The user storage object containing notification triggers.
+ * @param address - The specific account address for which to retrieve triggers.
+ * @param allowedKinds - An array of trigger kinds (`TRIGGER_TYPES`) to filter the triggers by.
+ * @returns An array of `NotificationTrigger` objects that match the allowed kinds for the specified account address.
+ */
+export function getUUIDsForAccountByKinds(userStorage, address, allowedKinds) {
+    const allowedKindsSet = new Set(allowedKinds);
+    return traverseUserStorageTriggers(userStorage, {
+        address,
+        mapTrigger: (trigger) => {
+            if (allowedKindsSet.has(trigger.kind)) {
+                return trigger;
+            }
+            return undefined;
+        },
+    });
+}
+/**
+ * Upserts (updates or inserts) notification triggers for a given account across all supported chains.
+ * This method ensures that each supported trigger type exists for each chain associated with the account.
+ * If a trigger type does not exist for a chain, it creates a new trigger with a unique UUID.
+ *
+ * @param _account - The account address for which to upsert triggers. The address is normalized to lowercase.
+ * @param userStorage - The user storage object to be updated with new or existing triggers.
+ * @returns The updated user storage object with upserted triggers for the specified account.
+ */
+export function upsertAddressTriggers(_account, userStorage) {
+    // Ensure the account exists in userStorage
+    const account = _account.toLowerCase();
+    userStorage[account] = userStorage[account] || {};
+    // Iterate over each trigger and its supported chains
+    for (const [trigger, { supported_chains: supportedChains }] of Object.entries(TRIGGERS)) {
+        for (const chain of supportedChains) {
+            // Ensure the chain exists for the account
+            userStorage[account][chain] = userStorage[account][chain] || {};
+            // Check if the trigger exists for the chain
+            const existingTrigger = Object.values(userStorage[account][chain]).find((obj) => obj.k === trigger);
+            if (!existingTrigger) {
+                // If the trigger doesn't exist, create a new one with a new UUID
+                const uuid = uuidv4();
+                userStorage[account][chain][uuid] = {
+                    k: trigger,
+                    e: false,
+                };
+            }
+        }
+    }
+    return userStorage;
+}
+/**
+ * Upserts (updates or inserts) notification triggers of a specific type across all accounts and chains in user storage.
+ * This method ensures that a trigger of the specified type exists for each account and chain. If a trigger of the specified type
+ * does not exist for an account and chain, it creates a new trigger with a unique UUID.
+ *
+ * @param triggerType - The type of trigger to upsert across all accounts and chains.
+ * @param userStorage - The user storage object to be updated with new or existing triggers of the specified type.
+ * @returns The updated user storage object with upserted triggers of the specified type for all accounts and chains.
+ */
+export function upsertTriggerTypeTriggers(triggerType, userStorage) {
+    // Iterate over each account in userStorage
+    Object.entries(userStorage).forEach(([account, chains]) => {
+        if (account === USER_STORAGE_VERSION_KEY) {
+            return;
+        }
+        // Iterate over each chain for the account
+        Object.entries(chains).forEach(([chain, triggers]) => {
+            // Check if the trigger type exists for the chain
+            const existingTrigger = Object.values(triggers).find((obj) => obj.k === triggerType);
+            if (!existingTrigger) {
+                // If the trigger type doesn't exist, create a new one with a new UUID
+                const uuid = uuidv4();
+                userStorage[account][chain][uuid] = {
+                    k: triggerType,
+                    e: false,
+                };
+            }
+        });
+    });
+    return userStorage;
+}
+/**
+ * Toggles the enabled status of a user storage trigger.
+ *
+ * @param userStorage - The user storage object.
+ * @param address - The user's address.
+ * @param chainId - The chain ID.
+ * @param uuid - The unique identifier for the trigger.
+ * @param enabled - The new enabled status.
+ * @returns The updated user storage object.
+ */
+export function toggleUserStorageTriggerStatus(userStorage, address, chainId, uuid, enabled) {
+    if (userStorage?.[address]?.[chainId]?.[uuid]) {
+        userStorage[address][chainId][uuid].e = enabled;
+    }
+    return userStorage;
+}
 /**
  * Performs an API call with automatic retries on failure.
  *

package/dist/NotificationServicesController/utils/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../../src/NotificationServicesController/utils/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,WAAmB,EACnB,QAAgB,EAChB,MAAyB,EACzB,IAAU;IAEV,MAAM,OAAO,GAAgB;QAC3B,MAAM;QACN,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,WAAW,EAAE;SACvC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC3B,CAAC;IAEF,OAAO,MAAM,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC","sourcesContent":["/**\n * Performs an API call with automatic retries on failure.\n *\n * @param bearerToken - The JSON Web Token for authorization.\n * @param endpoint - The URL of the API endpoint to call.\n * @param method - The HTTP method ('POST' or 'DELETE').\n * @param body - The body of the request. It should be an object that can be serialized to JSON.\n * @returns A Promise that resolves to the response of the fetch request.\n */\nexport async function makeApiCall<Body>(\n  bearerToken: string,\n  endpoint: string,\n  method: 'POST' | 'DELETE',\n  body: Body,\n): Promise<Response> {\n  const options: RequestInit = {\n    method,\n    headers: {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${bearerToken}`,\n    },\n    body: JSON.stringify(body),\n  };\n\n  return await fetch(endpoint, options);\n}\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../../src/NotificationServicesController/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mCAAmC;AAC/D,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,aAAa;AAEpC,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACrB,mCAA+B;AAEhC,OAAO,EAAE,QAAQ,EAAE,6CAAyC;AAoB5D;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG,CAAC,OAA4B,EAAU,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;AAEzE;;;;;;;GAOG;AACH,MAAM,eAAe,GAAG,CAAC,OAA4B,EAAuB,EAAE,CAC5E,OAAO,CAAC;AAEV;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAgC,EAChC,KAAc,EACd,WAAW,GAAG,IAAI;IAElB,MAAM,WAAW,GAAgB;QAC/B,CAAC,wBAAwB,CAAC,EAAE,oBAAoB;KACjD,CAAC;IAEF,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;QAC/C,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QACD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACzB,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SAC3B;QAED,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAC9B,CAAC,CAAC,OAAO,EAAE,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,EAAE,EAAE;YACnD,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAChC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE;oBAClC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;iBAClC;gBAED,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG;oBACtC,CAAC,EAAE,OAAwB;oBAC3B,CAAC,EAAE,KAAK,EAAE,yDAAyD;iBACpE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,WAAW,EAAE;QACf,gBAAgB,CAAC,WAAW,CAAC,CAAC;KAC/B;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAAwB;IACvD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,2BAA2B,CAAC,WAAW,EAAE;QACvC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC;KAC5C,CAAC,CAAC;IAEH,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,2BAA2B,CAGzC,WAAwB,EACxB,OAA6C;IAE7C,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,MAAM,UAAU,GACd,OAAO,EAAE,UAAU,IAAK,eAAgD,CAAC;IAE3E,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;QACjC,IAAI,OAAO,KAAM,wBAA8C,EAAE;YAC/D,SAAS;SACV;QACD,IAAI,OAAO,EAAE,OAAO,IAAI,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE;YACnD,SAAS;SACV;QAED,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE;YAC1C,IAAI,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE;gBACnC,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE;oBAChD,IAAI,IAAI,EAAE;wBACR,MAAM,aAAa,GAAG,UAAU,CAAC;4BAC/B,EAAE,EAAE,IAAI;4BACR,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;4BAChD,OAAO;4BACP,OAAO;4BACP,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK;yBAC7D,CAAC,CAAC;wBACH,IAAI,aAAa,EAAE;4BACjB,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;yBAC9B;qBACF;iBACF;aACF;SACF;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,WAAwB,EACxB,QAAkB;IAElB,MAAM,cAAc,GAA4B,EAAE,CAAC;IAEnD,uDAAuD;IACvD,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,gBAAgB,CACtD,OAAO,EACP,WAAW,CACZ,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,cAAsB,EACtB,WAAwB;IAExB,MAAM,aAAa,GAAG,WAAW,CAAC,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC;IAEjE,wEAAwE;IACxE,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IAED,4CAA4C;IAC5C,KAAK,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACnE,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,gBAAgB,EAAE;YAClD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;gBACzB,OAAO,KAAK,CAAC;aACd;YAED,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAC5D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,KAAM,WAA6B,CAClD,CAAC;YACF,IAAI,CAAC,aAAa,EAAE;gBAClB,OAAO,KAAK,CAAC;aACd;YAED,mCAAmC;YACnC,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;gBACvC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;oBACjC,OAAO,KAAK,CAAC;iBACd;aACF;SACF;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAwB;IACxD,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAiB,CAAC;IAEnD,2BAA2B,CAAC,WAAW,EAAE;QACvC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;YAChB,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAqB,CAAC,CAAC;QACjD,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAwB,EACxB,OAAe;IAEf,OAAO,2BAA2B,CAAC,WAAW,EAAE;QAC9C,OAAO;QACP,UAAU,EAAE,WAAW;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,WAAwB;IAClD,OAAO,2BAA2B,CAAC,WAAW,EAAE;QAC9C,UAAU,EAAE,WAAW;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,WAAwB,EACxB,YAAsB;IAEtB,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;IAEvC,OAAO,2BAA2B,CAAC,WAAW,EAAE;QAC9C,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;KAC7D,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,yBAAyB,CACvC,WAAwB,EACxB,OAAe,EACf,YAA6B;IAE7B,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9C,OAAO,2BAA2B,CAAC,WAAW,EAAE;QAC9C,OAAO;QACP,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE;YACtB,IAAI,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,IAAqB,CAAC,EAAE;gBACtD,OAAO,OAAO,CAAC;aAChB;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAgB,EAChB,WAAwB;IAExB,2CAA2C;IAC3C,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACvC,WAAW,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAElD,qDAAqD;IACrD,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAC3E,QAAQ,CACT,EAAE;QACD,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE;YACnC,0CAA0C;YAC1C,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAEhE,4CAA4C;YAC5C,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,KAAM,OAAyB,CAC9C,CAAC;YAEF,IAAI,CAAC,eAAe,EAAE;gBACpB,iEAAiE;gBACjE,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;gBACtB,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG;oBAClC,CAAC,EAAE,OAAwB;oBAC3B,CAAC,EAAE,KAAK;iBACT,CAAC;aACH;SACF;KACF;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,yBAAyB,CACvC,WAA0B,EAC1B,WAAwB;IAExB,2CAA2C;IAC3C,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE;QACxD,IAAI,OAAO,KAAM,wBAA8C,EAAE;YAC/D,OAAO;SACR;QAED,0CAA0C;QAC1C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACnD,iDAAiD;YACjD,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAClD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,WAAW,CAC/B,CAAC;YAEF,IAAI,CAAC,eAAe,EAAE;gBACpB,sEAAsE;gBACtE,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;gBACtB,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG;oBAClC,CAAC,EAAE,WAAW;oBACd,CAAC,EAAE,KAAK;iBACT,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,8BAA8B,CAC5C,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,IAAY,EACZ,OAAgB;IAEhB,IAAI,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;QAC7C,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;KACjD;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,WAAmB,EACnB,QAAgB,EAChB,MAAyB,EACzB,IAAU;IAEV,MAAM,OAAO,GAAgB;QAC3B,MAAM;QACN,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,WAAW,EAAE;SACvC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC3B,CAAC;IAEF,OAAO,MAAM,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC","sourcesContent":["import { isValidHexAddress } from '@metamask/controller-utils';\nimport { v4 as uuidv4 } from 'uuid';\n\nimport {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from '../constants/constants';\nimport type { TRIGGER_TYPES } from '../constants/notification-schema';\nimport { TRIGGERS } from '../constants/notification-schema';\nimport type { UserStorage } from '../types/user-storage/user-storage';\n\nexport type NotificationTrigger = {\n  id: string;\n  chainId: string;\n  kind: string;\n  address: string;\n  enabled: boolean;\n};\n\ntype MapTriggerFn<Result> = (\n  trigger: NotificationTrigger,\n) => Result | undefined;\n\ntype TraverseTriggerOpts<Result> = {\n  address?: string;\n  mapTrigger?: MapTriggerFn<Result>;\n};\n\n/**\n * Extracts and returns the ID from a notification trigger.\n * This utility function is primarily used as a mapping function in `traverseUserStorageTriggers`\n * to convert a full trigger object into its ID string.\n *\n * @param trigger - The notification trigger from which the ID is extracted.\n * @returns The ID of the provided notification trigger.\n */\nconst triggerToId = (trigger: NotificationTrigger): string => trigger.id;\n\n/**\n * A utility function that returns the input trigger without any transformation.\n * This function is used as the default mapping function in `traverseUserStorageTriggers`\n * when no custom mapping function is provided.\n *\n * @param trigger - The notification trigger to be returned as is.\n * @returns The same notification trigger that was passed in.\n */\nconst triggerIdentity = (trigger: NotificationTrigger): NotificationTrigger =>\n  trigger;\n\n/**\n * Create a completely new user storage object with the given accounts and state.\n * This method initializes the user storage with a version key and iterates over each account to populate it with triggers.\n * Each trigger is associated with supported chains, and for each chain, a unique identifier (UUID) is generated.\n * The trigger object contains a kind (`k`) indicating the type of trigger and an enabled state (`e`).\n * The kind and enabled state are stored with abbreviated keys to reduce the JSON size.\n *\n * This is used primarily for creating a new user storage (e.g. when first signing in/enabling notification profile syncing),\n * caution is needed in case you need to remove triggers that you don't want (due to notification setting filters)\n *\n * @param accounts - An array of account objects, each optionally containing an address.\n * @param state - A boolean indicating the initial enabled state for all triggers in the user storage.\n * @param shouldClean - prop to clean the initialized UserStorage (removing any invalid addresses). Only false for testing purposes.\n * @returns A `UserStorage` object populated with triggers for each account and chain.\n */\nexport function initializeUserStorage(\n  accounts: { address?: string }[],\n  state: boolean,\n  shouldClean = true,\n): UserStorage {\n  const userStorage: UserStorage = {\n    [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,\n  };\n\n  accounts.forEach((account) => {\n    const address = account.address?.toLowerCase();\n    if (!address) {\n      return;\n    }\n    if (!userStorage[address]) {\n      userStorage[address] = {};\n    }\n\n    Object.entries(TRIGGERS).forEach(\n      ([trigger, { supported_chains: supportedChains }]) => {\n        supportedChains.forEach((chain) => {\n          if (!userStorage[address]?.[chain]) {\n            userStorage[address][chain] = {};\n          }\n\n          userStorage[address][chain][uuidv4()] = {\n            k: trigger as TRIGGER_TYPES, // use 'k' instead of 'kind' to reduce the json weight\n            e: state, // use 'e' instead of 'enabled' to reduce the json weight\n          };\n        });\n      },\n    );\n  });\n\n  if (shouldClean) {\n    cleanUserStorage(userStorage);\n  }\n  return userStorage;\n}\n\n/**\n * This is a fallback to ensure that we are not adding non-hex addresses, and the shape is valid.\n * Any invalid shapes will be removed.\n * NOTE - this method mutates and returns the cleaned User Storage.\n *\n * @param userStorage - notification user storage field we are to clean.\n * @returns a cleaned version of user storage.\n */\nexport function cleanUserStorage(userStorage: UserStorage) {\n  const addresses = new Set<string>();\n  traverseUserStorageTriggers(userStorage, {\n    mapTrigger: (t) => addresses.add(t.address),\n  });\n\n  addresses.forEach((addr) => {\n    if (!isValidHexAddress(addr)) {\n      delete userStorage[addr];\n    }\n  });\n\n  return userStorage;\n}\n\n/**\n * Iterates over user storage to find and optionally transform notification triggers.\n * This method allows for flexible retrieval and transformation of triggers based on provided options.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @param options - Optional parameters to filter and map triggers:\n * - `address`: If provided, only triggers for this address are considered.\n * - `mapTrigger`: A function to transform each trigger. If not provided, triggers are returned as is.\n * @returns An array of triggers, potentially transformed by the `mapTrigger` function.\n */\nexport function traverseUserStorageTriggers<\n  ResultTriggers = NotificationTrigger,\n>(\n  userStorage: UserStorage,\n  options?: TraverseTriggerOpts<ResultTriggers>,\n): ResultTriggers[] {\n  const triggers: ResultTriggers[] = [];\n  const mapTrigger =\n    options?.mapTrigger ?? (triggerIdentity as MapTriggerFn<ResultTriggers>);\n\n  for (const address in userStorage) {\n    if (address === (USER_STORAGE_VERSION_KEY as unknown as string)) {\n      continue;\n    }\n    if (options?.address && address !== options.address) {\n      continue;\n    }\n\n    for (const chainId in userStorage[address]) {\n      if (chainId in userStorage[address]) {\n        for (const uuid in userStorage[address][chainId]) {\n          if (uuid) {\n            const mappedTrigger = mapTrigger({\n              id: uuid,\n              kind: userStorage[address]?.[chainId]?.[uuid]?.k,\n              chainId,\n              address,\n              enabled: userStorage[address]?.[chainId]?.[uuid]?.e ?? false,\n            });\n            if (mappedTrigger) {\n              triggers.push(mappedTrigger);\n            }\n          }\n        }\n      }\n    }\n  }\n\n  return triggers;\n}\n\n/**\n * Verifies the presence of specified accounts and their chains in the user storage.\n * This method checks if each provided account exists in the user storage and if all its supported chains are present.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @param accounts - An array of account addresses to check for presence.\n * @returns A record where each key is an account address and each value is a boolean indicating whether the account and all its supported chains are present in the user storage.\n */\nexport function checkAccountsPresence(\n  userStorage: UserStorage,\n  accounts: string[],\n): Record<string, boolean> {\n  const presenceRecord: Record<string, boolean> = {};\n\n  // Initialize presence record for all accounts as false\n  accounts.forEach((account) => {\n    presenceRecord[account.toLowerCase()] = isAccountEnabled(\n      account,\n      userStorage,\n    );\n  });\n\n  return presenceRecord;\n}\n\n/**\n * Internal method to check if a given account should be marked as enabled by introspecting user storage\n * Introspection: check if account exists; and also see if has all triggers in schema enabled\n *\n * @param accountAddress - address to check in user storage\n * @param userStorage - user storage object to traverse/introspect\n * @returns boolean if the account is enabled or disabled\n */\nfunction isAccountEnabled(\n  accountAddress: string,\n  userStorage: UserStorage,\n): boolean {\n  const accountObject = userStorage[accountAddress?.toLowerCase()];\n\n  // If the account address is not present in the userStorage, return true\n  if (!accountObject) {\n    return false;\n  }\n\n  // Check if all available chains are present\n  for (const [triggerKind, triggerConfig] of Object.entries(TRIGGERS)) {\n    for (const chain of triggerConfig.supported_chains) {\n      if (!accountObject[chain]) {\n        return false;\n      }\n\n      const triggerExists = Object.values(accountObject[chain]).some(\n        (obj) => obj.k === (triggerKind as TRIGGER_TYPES),\n      );\n      if (!triggerExists) {\n        return false;\n      }\n\n      // Check if any trigger is disabled\n      for (const uuid in accountObject[chain]) {\n        if (!accountObject[chain][uuid].e) {\n          return false;\n        }\n      }\n    }\n  }\n\n  return true;\n}\n\n/**\n * Infers and returns an array of enabled notification trigger kinds from the user storage.\n * This method counts the occurrences of each kind of trigger and returns the kinds that are present.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @returns An array of trigger kinds (`TRIGGER_TYPES`) that are enabled in the user storage.\n */\nexport function inferEnabledKinds(userStorage: UserStorage): TRIGGER_TYPES[] {\n  const allSupportedKinds = new Set<TRIGGER_TYPES>();\n\n  traverseUserStorageTriggers(userStorage, {\n    mapTrigger: (t) => {\n      allSupportedKinds.add(t.kind as TRIGGER_TYPES);\n    },\n  });\n\n  return Array.from(allSupportedKinds);\n}\n\n/**\n * Retrieves all UUIDs associated with a specific account address from the user storage.\n * This function utilizes `traverseUserStorageTriggers` with a mapping function to extract\n * just the UUIDs of the notification triggers for the given address.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @param address - The specific account address to retrieve UUIDs for.\n * @returns An array of UUID strings associated with the given account address.\n */\nexport function getUUIDsForAccount(\n  userStorage: UserStorage,\n  address: string,\n): string[] {\n  return traverseUserStorageTriggers(userStorage, {\n    address,\n    mapTrigger: triggerToId,\n  });\n}\n\n/**\n * Retrieves all UUIDs from the user storage, regardless of the account address or chain ID.\n * This method leverages `traverseUserStorageTriggers` with a specific mapping function (`triggerToId`)\n * to extract only the UUIDs from all notification triggers present in the user storage.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @returns An array of UUID strings from all notification triggers in the user storage.\n */\nexport function getAllUUIDs(userStorage: UserStorage): string[] {\n  return traverseUserStorageTriggers(userStorage, {\n    mapTrigger: triggerToId,\n  });\n}\n\n/**\n * Retrieves UUIDs for notification triggers that match any of the specified kinds.\n * This method filters triggers based on their kind and returns an array of UUIDs for those that match the allowed kinds.\n * It utilizes `traverseUserStorageTriggers` with a custom mapping function that checks if a trigger's kind is in the allowed list.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @param allowedKinds - An array of kinds (as strings) to filter the triggers by.\n * @returns An array of UUID strings for triggers that match the allowed kinds.\n */\nexport function getUUIDsForKinds(\n  userStorage: UserStorage,\n  allowedKinds: string[],\n): string[] {\n  const kindsSet = new Set(allowedKinds);\n\n  return traverseUserStorageTriggers(userStorage, {\n    mapTrigger: (t) => (kindsSet.has(t.kind) ? t.id : undefined),\n  });\n}\n\n/**\n * Retrieves notification triggers for a specific account address that match any of the specified kinds.\n * This method filters triggers both by the account address and their kind, returning triggers that match the allowed kinds for the specified address.\n * It leverages `traverseUserStorageTriggers` with a custom mapping function to filter and return only the relevant triggers.\n *\n * @param userStorage - The user storage object containing notification triggers.\n * @param address - The specific account address for which to retrieve triggers.\n * @param allowedKinds - An array of trigger kinds (`TRIGGER_TYPES`) to filter the triggers by.\n * @returns An array of `NotificationTrigger` objects that match the allowed kinds for the specified account address.\n */\nexport function getUUIDsForAccountByKinds(\n  userStorage: UserStorage,\n  address: string,\n  allowedKinds: TRIGGER_TYPES[],\n): NotificationTrigger[] {\n  const allowedKindsSet = new Set(allowedKinds);\n  return traverseUserStorageTriggers(userStorage, {\n    address,\n    mapTrigger: (trigger) => {\n      if (allowedKindsSet.has(trigger.kind as TRIGGER_TYPES)) {\n        return trigger;\n      }\n      return undefined;\n    },\n  });\n}\n\n/**\n * Upserts (updates or inserts) notification triggers for a given account across all supported chains.\n * This method ensures that each supported trigger type exists for each chain associated with the account.\n * If a trigger type does not exist for a chain, it creates a new trigger with a unique UUID.\n *\n * @param _account - The account address for which to upsert triggers. The address is normalized to lowercase.\n * @param userStorage - The user storage object to be updated with new or existing triggers.\n * @returns The updated user storage object with upserted triggers for the specified account.\n */\nexport function upsertAddressTriggers(\n  _account: string,\n  userStorage: UserStorage,\n): UserStorage {\n  // Ensure the account exists in userStorage\n  const account = _account.toLowerCase();\n  userStorage[account] = userStorage[account] || {};\n\n  // Iterate over each trigger and its supported chains\n  for (const [trigger, { supported_chains: supportedChains }] of Object.entries(\n    TRIGGERS,\n  )) {\n    for (const chain of supportedChains) {\n      // Ensure the chain exists for the account\n      userStorage[account][chain] = userStorage[account][chain] || {};\n\n      // Check if the trigger exists for the chain\n      const existingTrigger = Object.values(userStorage[account][chain]).find(\n        (obj) => obj.k === (trigger as TRIGGER_TYPES),\n      );\n\n      if (!existingTrigger) {\n        // If the trigger doesn't exist, create a new one with a new UUID\n        const uuid = uuidv4();\n        userStorage[account][chain][uuid] = {\n          k: trigger as TRIGGER_TYPES,\n          e: false,\n        };\n      }\n    }\n  }\n\n  return userStorage;\n}\n\n/**\n * Upserts (updates or inserts) notification triggers of a specific type across all accounts and chains in user storage.\n * This method ensures that a trigger of the specified type exists for each account and chain. If a trigger of the specified type\n * does not exist for an account and chain, it creates a new trigger with a unique UUID.\n *\n * @param triggerType - The type of trigger to upsert across all accounts and chains.\n * @param userStorage - The user storage object to be updated with new or existing triggers of the specified type.\n * @returns The updated user storage object with upserted triggers of the specified type for all accounts and chains.\n */\nexport function upsertTriggerTypeTriggers(\n  triggerType: TRIGGER_TYPES,\n  userStorage: UserStorage,\n): UserStorage {\n  // Iterate over each account in userStorage\n  Object.entries(userStorage).forEach(([account, chains]) => {\n    if (account === (USER_STORAGE_VERSION_KEY as unknown as string)) {\n      return;\n    }\n\n    // Iterate over each chain for the account\n    Object.entries(chains).forEach(([chain, triggers]) => {\n      // Check if the trigger type exists for the chain\n      const existingTrigger = Object.values(triggers).find(\n        (obj) => obj.k === triggerType,\n      );\n\n      if (!existingTrigger) {\n        // If the trigger type doesn't exist, create a new one with a new UUID\n        const uuid = uuidv4();\n        userStorage[account][chain][uuid] = {\n          k: triggerType,\n          e: false,\n        };\n      }\n    });\n  });\n\n  return userStorage;\n}\n\n/**\n * Toggles the enabled status of a user storage trigger.\n *\n * @param userStorage - The user storage object.\n * @param address - The user's address.\n * @param chainId - The chain ID.\n * @param uuid - The unique identifier for the trigger.\n * @param enabled - The new enabled status.\n * @returns The updated user storage object.\n */\nexport function toggleUserStorageTriggerStatus(\n  userStorage: UserStorage,\n  address: string,\n  chainId: string,\n  uuid: string,\n  enabled: boolean,\n): UserStorage {\n  if (userStorage?.[address]?.[chainId]?.[uuid]) {\n    userStorage[address][chainId][uuid].e = enabled;\n  }\n\n  return userStorage;\n}\n\n/**\n * Performs an API call with automatic retries on failure.\n *\n * @param bearerToken - The JSON Web Token for authorization.\n * @param endpoint - The URL of the API endpoint to call.\n * @param method - The HTTP method ('POST' or 'DELETE').\n * @param body - The body of the request. It should be an object that can be serialized to JSON.\n * @returns A Promise that resolves to the response of the fetch request.\n */\nexport async function makeApiCall<Body>(\n  bearerToken: string,\n  endpoint: string,\n  method: 'POST' | 'DELETE',\n  body: Body,\n): Promise<Response> {\n  const options: RequestInit = {\n    method,\n    headers: {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${bearerToken}`,\n    },\n    body: JSON.stringify(body),\n  };\n\n  return await fetch(endpoint, options);\n}\n"]}

package/dist/NotificationServicesPushController/NotificationServicesPushController.cjs

@@ -96,9 +96,9 @@ class NotificationServicesPushController extends base_controller_1.BaseControlle
      * 2. Fetching the Firebase Cloud Messaging (FCM) token from Firebase.
      * 3. Sending the FCM token to the server responsible for sending notifications, to register the device.
      *
-     * @param addresses - An array of addresses to enable push notifications for.
+     * @param UUIDs - An array of UUIDs to enable push notifications for.
      */
-    async enablePushNotifications(addresses) {
+    async enablePushNotifications(UUIDs) {
         if (!__classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").isPushFeatureEnabled) {
             return;
         }
@@ -113,15 +113,12 @@ class NotificationServicesPushController extends base_controller_1.BaseControlle
                 // Activate Push Notifications
                 const fcmToken = await (0, services_1.activatePushNotifications)({
                     bearerToken,
-                    addresses,
+                    triggers: UUIDs,
                     env: __classPrivateFieldGet(this, _NotificationServicesPushController_env, "f"),
                     createRegToken: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").pushService.createRegToken,
-                    regToken: {
-                        platform: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").platform,
-                        locale: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").getLocale?.() ?? 'en',
-                        oldToken: this.state.fcmToken,
-                    },
-                });
+                    platform: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").platform,
+                    locale: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").getLocale?.() ?? 'en',
+                }).catch(() => null);
                 if (fcmToken) {
                     __classPrivateFieldGet(this, _NotificationServicesPushController_instances, "m", _NotificationServicesPushController_updatePushState).call(this, { type: 'enable', fcmToken });
                 }
@@ -177,13 +174,12 @@ class NotificationServicesPushController extends base_controller_1.BaseControlle
     }
     /**
      * Updates the triggers for push notifications.
-     * This method is responsible for updating the server with the new set of addresses that should trigger push notifications.
+     * This method is responsible for updating the server with the new set of UUIDs that should trigger push notifications.
      * It uses the current FCM token and a BearerToken for authentication.
      *
-     * @param addresses - An array of addresses that should trigger push notifications.
-     * @deprecated - this is not used anymore and will most likely be removed
+     * @param UUIDs - An array of UUIDs that should trigger push notifications.
      */
-    async updateTriggerPushNotifications(addresses) {
+    async updateTriggerPushNotifications(UUIDs) {
         if (!__classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").isPushFeatureEnabled) {
             return;
         }
@@ -192,16 +188,14 @@ class NotificationServicesPushController extends base_controller_1.BaseControlle
         });
         try {
             const bearerToken = await __classPrivateFieldGet(this, _NotificationServicesPushController_instances, "m", _NotificationServicesPushController_getAndAssertBearerToken).call(this);
-            const fcmToken = await (0, services_1.activatePushNotifications)({
+            const { fcmToken } = await (0, services_1.updateTriggerPushNotifications)({
                 bearerToken,
-                addresses,
+                triggers: UUIDs,
                 env: __classPrivateFieldGet(this, _NotificationServicesPushController_env, "f"),
                 createRegToken: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").pushService.createRegToken,
-                regToken: {
-                    platform: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").platform,
-                    locale: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").getLocale?.() ?? 'en',
-                    oldToken: this.state.fcmToken,
-                },
+                deleteRegToken: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").pushService.deleteRegToken,
+                platform: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").platform,
+                locale: __classPrivateFieldGet(this, _NotificationServicesPushController_config, "f").getLocale?.() ?? 'en',
             });
             // update the state with the new FCM token
             if (fcmToken) {
@@ -246,9 +240,8 @@ _NotificationServicesPushController_pushListenerUnsubscribe = new WeakMap(), _No
     }
     if (command.type === 'disable') {
         this.update((state) => {
-            // Note we do not want to clear the old FCM token
-            // We can send it as an old token to our backend to cleanup next time turned on
             state.isPushEnabled = false;
+            state.fcmToken = '';
             state.isUpdatingFCMToken = false;
         });
     }