@metamask-previews/notification-services-controller 0.5.0-preview-367cb1da → 0.5.0-preview-cf09c0a

package/dist/NotificationServicesPushController/utils/get-notification-data.mjs

@@ -1,14 +1,78 @@
-import {
-  calcTokenAmount,
-  formatAmount,
-  getAmount,
-  getLeadingZeroCount
-} from "../../chunk-ODI2BTKS.mjs";
-import "../../chunk-U5UIDVOO.mjs";
-export {
-  calcTokenAmount,
-  formatAmount,
-  getAmount,
-  getLeadingZeroCount
+import $bignumberjs from "bignumber.js";
+const { BigNumber } = $bignumberjs;
+const defaultFormatOptions = {
+    decimalPlaces: 4,
+};
+/**
+ * Calculates the token amount based on the given value and decimals.
+ *
+ * @param value - The value to calculate the token amount from.
+ * @param decimals - The number of decimals to use for the calculation.
+ * @returns The calculated token amount.
+ */
+export function calcTokenAmount(value, decimals) {
+    const multiplier = Math.pow(10, Number(decimals || 0));
+    return new BigNumber(String(value)).div(multiplier);
+}
+/**
+ * Calculates the number of leading zeros in the fractional part of a number.
+ *
+ * This function converts a number or a string representation of a number into
+ * its decimal form and then counts the number of leading zeros present in the
+ * fractional part of the number. This is useful for determining the precision
+ * of very small numbers.
+ *
+ * @param num - The number to analyze, which can be in the form
+ * of a number or a string.
+ * @returns The count of leading zeros in the fractional part of the number.
+ */
+export const getLeadingZeroCount = (num) => {
+    const numToString = new BigNumber(num, 10).toString(10);
+    const fractionalPart = numToString.split('.')[1] ?? '';
+    return fractionalPart.match(/^0*/u)?.[0]?.length || 0;
+};
+/**
+ * This formats a number using Intl
+ * It abbreviates large numbers (using K, M, B, T)
+ * And abbreviates small numbers in 2 ways:
+ * - Will format to the given number of decimal places
+ * - Will format up to 4 decimal places
+ * - Will ellipse the number if longer than given decimal places
+ *
+ * @param numericAmount - The number to format
+ * @param opts - The options to use when formatting
+ * @returns The formatted number
+ */
+export const formatAmount = (numericAmount, opts) => {
+    // create options with defaults
+    const options = { ...defaultFormatOptions, ...opts };
+    const leadingZeros = getLeadingZeroCount(numericAmount);
+    const isDecimal = numericAmount.toString().includes('.') || leadingZeros > 0;
+    const isLargeNumber = numericAmount > 999;
+    const handleShouldEllipse = (decimalPlaces) => Boolean(options?.shouldEllipse) && leadingZeros >= decimalPlaces;
+    if (isLargeNumber) {
+        return Intl.NumberFormat('en-US', {
+            notation: 'compact',
+            compactDisplay: 'short',
+            maximumFractionDigits: 2,
+        }).format(numericAmount);
+    }
+    if (isDecimal) {
+        const ellipse = handleShouldEllipse(options.decimalPlaces);
+        const formattedValue = Intl.NumberFormat('en-US', {
+            minimumFractionDigits: ellipse ? options.decimalPlaces : undefined,
+            maximumFractionDigits: options.decimalPlaces,
+        }).format(numericAmount);
+        return ellipse ? `${formattedValue}...` : formattedValue;
+    }
+    // Default to showing the raw amount
+    return numericAmount.toString();
+};
+export const getAmount = (amount, decimals, options) => {
+    if (!amount || !decimals) {
+        return '';
+    }
+    const numericAmount = calcTokenAmount(amount, parseFloat(decimals)).toNumber();
+    return formatAmount(numericAmount, options);
 };
 //# sourceMappingURL=get-notification-data.mjs.map

package/dist/NotificationServicesPushController/utils/get-notification-data.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"get-notification-data.mjs","sourceRoot":"","sources":["../../../src/NotificationServicesPushController/utils/get-notification-data.ts"],"names":[],"mappings":";;AAMA,MAAM,oBAAoB,GAAG;IAC3B,aAAa,EAAE,CAAC;CACjB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,QAAgB;IAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAoB,EAAE,EAAE;IAC1D,MAAM,WAAW,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACvD,OAAO,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,aAAqB,EAAE,IAAoB,EAAE,EAAE;IAC1E,+BAA+B;IAC/B,MAAM,OAAO,GAAG,EAAE,GAAG,oBAAoB,EAAE,GAAG,IAAI,EAAE,CAAC;IAErD,MAAM,YAAY,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,aAAa,GAAG,GAAG,CAAC;IAE1C,MAAM,mBAAmB,GAAG,CAAC,aAAqB,EAAE,EAAE,CACpD,OAAO,CAAC,OAAO,EAAE,aAAa,CAAC,IAAI,YAAY,IAAI,aAAa,CAAC;IAEnE,IAAI,aAAa,EAAE;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;YAChC,QAAQ,EAAE,SAAS;YACnB,cAAc,EAAE,OAAO;YACvB,qBAAqB,EAAE,CAAC;SACzB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;KAC1B;IAED,IAAI,SAAS,EAAE;QACb,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;YAChD,qBAAqB,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;YAClE,qBAAqB,EAAE,OAAO,CAAC,aAAa;SAC7C,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEzB,OAAO,OAAO,CAAC,CAAC,CAAC,GAAG,cAAc,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC;KAC1D;IAED,oCAAoC;IACpC,OAAO,aAAa,CAAC,QAAQ,EAAE,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,MAAc,EACd,QAAgB,EAChB,OAAuB,EACvB,EAAE;IACF,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE;QACxB,OAAO,EAAE,CAAC;KACX;IAED,MAAM,aAAa,GAAG,eAAe,CACnC,MAAM,EACN,UAAU,CAAC,QAAQ,CAAC,CACrB,CAAC,QAAQ,EAAE,CAAC;IAEb,OAAO,YAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC,CAAC","sourcesContent":["import { BigNumber } from 'bignumber.js';\n\ntype FormatOptions = {\n  decimalPlaces?: number;\n  shouldEllipse?: boolean;\n};\nconst defaultFormatOptions = {\n  decimalPlaces: 4,\n};\n\n/**\n * Calculates the token amount based on the given value and decimals.\n *\n * @param value - The value to calculate the token amount from.\n * @param decimals - The number of decimals to use for the calculation.\n * @returns The calculated token amount.\n */\nexport function calcTokenAmount(value: string, decimals: number) {\n  const multiplier = Math.pow(10, Number(decimals || 0));\n  return new BigNumber(String(value)).div(multiplier);\n}\n\n/**\n * Calculates the number of leading zeros in the fractional part of a number.\n *\n * This function converts a number or a string representation of a number into\n * its decimal form and then counts the number of leading zeros present in the\n * fractional part of the number. This is useful for determining the precision\n * of very small numbers.\n *\n * @param num - The number to analyze, which can be in the form\n * of a number or a string.\n * @returns The count of leading zeros in the fractional part of the number.\n */\nexport const getLeadingZeroCount = (num: number | string) => {\n  const numToString = new BigNumber(num, 10).toString(10);\n  const fractionalPart = numToString.split('.')[1] ?? '';\n  return fractionalPart.match(/^0*/u)?.[0]?.length || 0;\n};\n\n/**\n * This formats a number using Intl\n * It abbreviates large numbers (using K, M, B, T)\n * And abbreviates small numbers in 2 ways:\n * - Will format to the given number of decimal places\n * - Will format up to 4 decimal places\n * - Will ellipse the number if longer than given decimal places\n *\n * @param numericAmount - The number to format\n * @param opts - The options to use when formatting\n * @returns The formatted number\n */\nexport const formatAmount = (numericAmount: number, opts?: FormatOptions) => {\n  // create options with defaults\n  const options = { ...defaultFormatOptions, ...opts };\n\n  const leadingZeros = getLeadingZeroCount(numericAmount);\n  const isDecimal = numericAmount.toString().includes('.') || leadingZeros > 0;\n  const isLargeNumber = numericAmount > 999;\n\n  const handleShouldEllipse = (decimalPlaces: number) =>\n    Boolean(options?.shouldEllipse) && leadingZeros >= decimalPlaces;\n\n  if (isLargeNumber) {\n    return Intl.NumberFormat('en-US', {\n      notation: 'compact',\n      compactDisplay: 'short',\n      maximumFractionDigits: 2,\n    }).format(numericAmount);\n  }\n\n  if (isDecimal) {\n    const ellipse = handleShouldEllipse(options.decimalPlaces);\n    const formattedValue = Intl.NumberFormat('en-US', {\n      minimumFractionDigits: ellipse ? options.decimalPlaces : undefined,\n      maximumFractionDigits: options.decimalPlaces,\n    }).format(numericAmount);\n\n    return ellipse ? `${formattedValue}...` : formattedValue;\n  }\n\n  // Default to showing the raw amount\n  return numericAmount.toString();\n};\n\nexport const getAmount = (\n  amount: string,\n  decimals: string,\n  options?: FormatOptions,\n) => {\n  if (!amount || !decimals) {\n    return '';\n  }\n\n  const numericAmount = calcTokenAmount(\n    amount,\n    parseFloat(decimals),\n  ).toNumber();\n\n  return formatAmount(numericAmount, options);\n};\n"]}

package/dist/NotificationServicesPushController/utils/get-notification-message.cjs

@@ -0,0 +1,190 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOnChainPushNotificationMessage = exports.isOnChainNotification = exports.createOnChainPushNotificationMessages = void 0;
+const NotificationServicesController_1 = require("../../NotificationServicesController/index.cjs");
+const get_notification_data_1 = require("./get-notification-data.cjs");
+/**
+ * On Chain Push Notification Messages.
+ * This is a list of all the push notifications we support. Update this for synced notifications on mobile and extension
+ *
+ * @param translationKeys - all translations supported
+ * @returns A translation push message object.
+ */
+const createOnChainPushNotificationMessages = (translationKeys) => {
+    const t = (...args) => {
+        const [key, ...otherArgs] = args;
+        // Coerce types for the translation function
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const fn = translationKeys[key];
+        return fn(...otherArgs);
+    };
+    return {
+        erc20_sent: {
+            title: t('pushPlatformNotificationsFundsSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsSentDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = n?.data?.token?.symbol;
+                const tokenAmount = n?.data?.token?.amount;
+                const tokenDecimals = n?.data?.token?.decimals;
+                if (!symbol || !tokenAmount || !tokenDecimals) {
+                    return null;
+                }
+                const amount = (0, get_notification_data_1.getAmount)(tokenAmount, tokenDecimals, {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsSentDescription', amount, symbol);
+            },
+        },
+        eth_sent: {
+            title: t('pushPlatformNotificationsFundsSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsSentDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = getChainSymbol(n?.chain_id);
+                const tokenAmount = n?.data?.amount?.eth;
+                if (!symbol || !tokenAmount) {
+                    return null;
+                }
+                const amount = (0, get_notification_data_1.formatAmount)(parseFloat(tokenAmount), {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsSentDescription', amount, symbol);
+            },
+        },
+        erc20_received: {
+            title: t('pushPlatformNotificationsFundsReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsReceivedDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = n?.data?.token?.symbol;
+                const tokenAmount = n?.data?.token?.amount;
+                const tokenDecimals = n?.data?.token?.decimals;
+                if (!symbol || !tokenAmount || !tokenDecimals) {
+                    return null;
+                }
+                const amount = (0, get_notification_data_1.getAmount)(tokenAmount, tokenDecimals, {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsReceivedDescription', amount, symbol);
+            },
+        },
+        eth_received: {
+            title: t('pushPlatformNotificationsFundsReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsReceivedDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = getChainSymbol(n?.chain_id);
+                const tokenAmount = n?.data?.amount?.eth;
+                if (!symbol || !tokenAmount) {
+                    return null;
+                }
+                const amount = (0, get_notification_data_1.formatAmount)(parseFloat(tokenAmount), {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsReceivedDescription', amount, symbol);
+            },
+        },
+        metamask_swap_completed: {
+            title: t('pushPlatformNotificationsSwapCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsSwapCompletedDescription'),
+        },
+        erc721_sent: {
+            title: t('pushPlatformNotificationsNftSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftSentDescription'),
+        },
+        erc1155_sent: {
+            title: t('pushPlatformNotificationsNftSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftSentDescription'),
+        },
+        erc721_received: {
+            title: t('pushPlatformNotificationsNftReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftReceivedDescription'),
+        },
+        erc1155_received: {
+            title: t('pushPlatformNotificationsNftReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftReceivedDescription'),
+        },
+        rocketpool_stake_completed: {
+            title: t('pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription'),
+        },
+        rocketpool_unstake_completed: {
+            title: t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription'),
+        },
+        lido_stake_completed: {
+            title: t('pushPlatformNotificationsStakingLidoStakeCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoStakeCompletedDescription'),
+        },
+        lido_stake_ready_to_be_withdrawn: {
+            title: t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription'),
+        },
+        lido_withdrawal_requested: {
+            title: t('pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription'),
+        },
+        lido_withdrawal_completed: {
+            title: t('pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription'),
+        },
+    };
+};
+exports.createOnChainPushNotificationMessages = createOnChainPushNotificationMessages;
+/**
+ * Retrieves the symbol associated with a given chain ID.
+ *
+ * @param chainId - The ID of the chain.
+ * @returns The symbol associated with the chain ID, or null if not found.
+ */
+function getChainSymbol(chainId) {
+    return NotificationServicesController_1.Constants.CHAIN_SYMBOLS[chainId] ?? null;
+}
+/**
+ * Checks if the given value is an OnChainRawNotification object.
+ *
+ * @param n - The value to check.
+ * @returns True if the value is an OnChainRawNotification object, false otherwise.
+ */
+function isOnChainNotification(n) {
+    const assumed = n;
+    // We don't have a validation/parsing library to check all possible types of an on chain notification
+    // It is safe enough just to check "some" fields, and catch any errors down the line if the shape is bad.
+    const isValidEnoughToBeOnChainNotification = [
+        assumed?.id,
+        assumed?.data,
+        assumed?.trigger_id,
+    ].every((field) => field !== undefined);
+    return isValidEnoughToBeOnChainNotification;
+}
+exports.isOnChainNotification = isOnChainNotification;
+/**
+ * Creates a push notification message based on the given on-chain raw notification.
+ *
+ * @param n - processed notification.
+ * @param translations - translates keys into text
+ * @returns The push notification message object, or null if the notification is invalid.
+ */
+function createOnChainPushNotificationMessage(n, translations) {
+    if (!n?.type) {
+        return null;
+    }
+    const notificationMessage = (0, exports.createOnChainPushNotificationMessages)(translations)[n.type];
+    if (!notificationMessage) {
+        return null;
+    }
+    let description = null;
+    try {
+        description =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            notificationMessage?.getDescription?.(n) ??
+                notificationMessage.defaultDescription ??
+                null;
+    }
+    catch (e) {
+        description = notificationMessage.defaultDescription ?? null;
+    }
+    return {
+        title: notificationMessage.title ?? '',
+        description: description ?? '', // Fallback to empty string if null
+    };
+}
+exports.createOnChainPushNotificationMessage = createOnChainPushNotificationMessage;
+//# sourceMappingURL=get-notification-message.cjs.map

package/dist/NotificationServicesPushController/utils/get-notification-message.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-notification-message.cjs","sourceRoot":"","sources":["../../../src/NotificationServicesPushController/utils/get-notification-message.ts"],"names":[],"mappings":";;;AAEA,mGAAiE;AACjE,uEAAkE;AAkDlE;;;;;;GAMG;AACI,MAAM,qCAAqC,GAAG,CACnD,eAAgC,EACP,EAAE;IAI3B,MAAM,CAAC,GAAkB,CAAC,GAAG,IAAI,EAAE,EAAE;QACnC,MAAM,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;QAEjC,4CAA4C;QAC5C,8DAA8D;QAC9D,MAAM,EAAE,GAAQ,eAAe,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC;IAC1B,CAAC,CAAC;IAEF,OAAO;QACL,UAAU,EAAE;YACV,KAAK,EAAE,CAAC,CAAC,yCAAyC,CAAC;YACnD,kBAAkB,EAAE,CAAC,CACnB,sDAAsD,CACvD;YACD,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE;gBACpB,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC;gBACtC,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC;gBAC3C,MAAM,aAAa,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC;gBAC/C,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,EAAE;oBAC7C,OAAO,IAAI,CAAC;iBACb;gBAED,MAAM,MAAM,GAAG,IAAA,iCAAS,EAAC,WAAW,EAAE,aAAa,EAAE;oBACnD,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAC;gBACH,OAAO,CAAC,CACN,+CAA+C,EAC/C,MAAM,EACN,MAAM,CACP,CAAC;YACJ,CAAC;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,CAAC,CAAC,yCAAyC,CAAC;YACnD,kBAAkB,EAAE,CAAC,CACnB,sDAAsD,CACvD;YACD,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE;gBACpB,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC3C,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC;gBACzC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE;oBAC3B,OAAO,IAAI,CAAC;iBACb;gBAED,MAAM,MAAM,GAAG,IAAA,oCAAY,EAAC,UAAU,CAAC,WAAW,CAAC,EAAE;oBACnD,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAC;gBACH,OAAO,CAAC,CACN,+CAA+C,EAC/C,MAAM,EACN,MAAM,CACP,CAAC;YACJ,CAAC;SACF;QACD,cAAc,EAAE;YACd,KAAK,EAAE,CAAC,CAAC,6CAA6C,CAAC;YACvD,kBAAkB,EAAE,CAAC,CACnB,0DAA0D,CAC3D;YACD,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE;gBACpB,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC;gBACtC,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC;gBAC3C,MAAM,aAAa,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC;gBAC/C,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,IAAI,CAAC,aAAa,EAAE;oBAC7C,OAAO,IAAI,CAAC;iBACb;gBAED,MAAM,MAAM,GAAG,IAAA,iCAAS,EAAC,WAAW,EAAE,aAAa,EAAE;oBACnD,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAC;gBACH,OAAO,CAAC,CACN,mDAAmD,EACnD,MAAM,EACN,MAAM,CACP,CAAC;YACJ,CAAC;SACF;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,CAAC,CAAC,6CAA6C,CAAC;YACvD,kBAAkB,EAAE,CAAC,CACnB,0DAA0D,CAC3D;YACD,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE;gBACpB,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC3C,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC;gBACzC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE;oBAC3B,OAAO,IAAI,CAAC;iBACb;gBAED,MAAM,MAAM,GAAG,IAAA,oCAAY,EAAC,UAAU,CAAC,WAAW,CAAC,EAAE;oBACnD,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAC;gBACH,OAAO,CAAC,CACN,mDAAmD,EACnD,MAAM,EACN,MAAM,CACP,CAAC;YACJ,CAAC;SACF;QACD,uBAAuB,EAAE;YACvB,KAAK,EAAE,CAAC,CAAC,6CAA6C,CAAC;YACvD,kBAAkB,EAAE,CAAC,CACnB,mDAAmD,CACpD;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,CAAC,CAAC,uCAAuC,CAAC;YACjD,kBAAkB,EAAE,CAAC,CAAC,6CAA6C,CAAC;SACrE;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,CAAC,CAAC,uCAAuC,CAAC;YACjD,kBAAkB,EAAE,CAAC,CAAC,6CAA6C,CAAC;SACrE;QACD,eAAe,EAAE;YACf,KAAK,EAAE,CAAC,CAAC,2CAA2C,CAAC;YACrD,kBAAkB,EAAE,CAAC,CAAC,iDAAiD,CAAC;SACzE;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,CAAC,CAAC,2CAA2C,CAAC;YACrD,kBAAkB,EAAE,CAAC,CAAC,iDAAiD,CAAC;SACzE;QACD,0BAA0B,EAAE;YAC1B,KAAK,EAAE,CAAC,CAAC,+DAA+D,CAAC;YACzE,kBAAkB,EAAE,CAAC,CACnB,qEAAqE,CACtE;SACF;QACD,4BAA4B,EAAE;YAC5B,KAAK,EAAE,CAAC,CACN,iEAAiE,CAClE;YACD,kBAAkB,EAAE,CAAC,CACnB,uEAAuE,CACxE;SACF;QACD,oBAAoB,EAAE;YACpB,KAAK,EAAE,CAAC,CAAC,yDAAyD,CAAC;YACnE,kBAAkB,EAAE,CAAC,CACnB,+DAA+D,CAChE;SACF;QACD,gCAAgC,EAAE;YAChC,KAAK,EAAE,CAAC,CACN,kEAAkE,CACnE;YACD,kBAAkB,EAAE,CAAC,CACnB,wEAAwE,CACzE;SACF;QACD,yBAAyB,EAAE;YACzB,KAAK,EAAE,CAAC,CAAC,8DAA8D,CAAC;YACxE,kBAAkB,EAAE,CAAC,CACnB,oEAAoE,CACrE;SACF;QACD,yBAAyB,EAAE;YACzB,KAAK,EAAE,CAAC,CAAC,8DAA8D,CAAC;YACxE,kBAAkB,EAAE,CAAC,CACnB,oEAAoE,CACrE;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAzKW,QAAA,qCAAqC,yCAyKhD;AAEF;;;;;GAKG;AACH,SAAS,cAAc,CAAC,OAAe;IACrC,OAAO,0CAAS,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,CAAU;IAEV,MAAM,OAAO,GAAG,CAAiC,CAAC;IAElD,qGAAqG;IACrG,yGAAyG;IACzG,MAAM,oCAAoC,GAAG;QAC3C,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,UAAU;KACpB,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;IACxC,OAAO,oCAAoC,CAAC;AAC9C,CAAC;AAbD,sDAaC;AAED;;;;;;GAMG;AACH,SAAgB,oCAAoC,CAClD,CAAsB,EACtB,YAA6B;IAE7B,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE;QACZ,OAAO,IAAI,CAAC;KACb;IACD,MAAM,mBAAmB,GACvB,IAAA,6CAAqC,EAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAE9D,IAAI,CAAC,mBAAmB,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,IAAI,WAAW,GAAkB,IAAI,CAAC;IACtC,IAAI;QACF,WAAW;YACT,8DAA8D;YAC9D,mBAAmB,EAAE,cAAc,EAAE,CAAC,CAAQ,CAAC;gBAC/C,mBAAmB,CAAC,kBAAkB;gBACtC,IAAI,CAAC;KACR;IAAC,OAAO,CAAC,EAAE;QACV,WAAW,GAAG,mBAAmB,CAAC,kBAAkB,IAAI,IAAI,CAAC;KAC9D;IAED,OAAO;QACL,KAAK,EAAE,mBAAmB,CAAC,KAAK,IAAI,EAAE;QACtC,WAAW,EAAE,WAAW,IAAI,EAAE,EAAE,mCAAmC;KACpE,CAAC;AACJ,CAAC;AA7BD,oFA6BC","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport type { Types } from '../../NotificationServicesController';\nimport { Constants } from '../../NotificationServicesController';\nimport { getAmount, formatAmount } from './get-notification-data';\n\nexport type TranslationKeys = {\n  pushPlatformNotificationsFundsSentTitle: () => string;\n  pushPlatformNotificationsFundsSentDescriptionDefault: () => string;\n  pushPlatformNotificationsFundsSentDescription: (\n    ...args: [string, string]\n  ) => string;\n  pushPlatformNotificationsFundsReceivedTitle: () => string;\n  pushPlatformNotificationsFundsReceivedDescriptionDefault: () => string;\n  pushPlatformNotificationsFundsReceivedDescription: (\n    ...args: [string, string]\n  ) => string;\n  pushPlatformNotificationsSwapCompletedTitle: () => string;\n  pushPlatformNotificationsSwapCompletedDescription: () => string;\n  pushPlatformNotificationsNftSentTitle: () => string;\n  pushPlatformNotificationsNftSentDescription: () => string;\n  pushPlatformNotificationsNftReceivedTitle: () => string;\n  pushPlatformNotificationsNftReceivedDescription: () => string;\n  pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle: () => string;\n  pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription: () => string;\n  pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle: () => string;\n  pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription: () => string;\n  pushPlatformNotificationsStakingLidoStakeCompletedTitle: () => string;\n  pushPlatformNotificationsStakingLidoStakeCompletedDescription: () => string;\n  pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle: () => string;\n  pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription: () => string;\n  pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle: () => string;\n  pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription: () => string;\n  pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle: () => string;\n  pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription: () => string;\n};\n\ntype PushNotificationMessage = {\n  title: string;\n  description: string;\n};\n\ntype NotificationMessage<N extends Types.INotification> = {\n  title: string | null;\n  defaultDescription: string | null;\n  getDescription?: (n: N) => string | null;\n};\n\ntype NotificationMessageDict = {\n  [K in Constants.TRIGGER_TYPES]?: NotificationMessage<\n    Extract<Types.INotification, { type: K }>\n  >;\n};\n\n/**\n * On Chain Push Notification Messages.\n * This is a list of all the push notifications we support. Update this for synced notifications on mobile and extension\n *\n * @param translationKeys - all translations supported\n * @returns A translation push message object.\n */\nexport const createOnChainPushNotificationMessages = (\n  translationKeys: TranslationKeys,\n): NotificationMessageDict => {\n  type TranslationFn = <K extends keyof TranslationKeys>(\n    ...args: [K, ...Parameters<TranslationKeys[K]>]\n  ) => string;\n  const t: TranslationFn = (...args) => {\n    const [key, ...otherArgs] = args;\n\n    // Coerce types for the translation function\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const fn: any = translationKeys[key];\n    return fn(...otherArgs);\n  };\n\n  return {\n    erc20_sent: {\n      title: t('pushPlatformNotificationsFundsSentTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsFundsSentDescriptionDefault',\n      ),\n      getDescription: (n) => {\n        const symbol = n?.data?.token?.symbol;\n        const tokenAmount = n?.data?.token?.amount;\n        const tokenDecimals = n?.data?.token?.decimals;\n        if (!symbol || !tokenAmount || !tokenDecimals) {\n          return null;\n        }\n\n        const amount = getAmount(tokenAmount, tokenDecimals, {\n          shouldEllipse: true,\n        });\n        return t(\n          'pushPlatformNotificationsFundsSentDescription',\n          amount,\n          symbol,\n        );\n      },\n    },\n    eth_sent: {\n      title: t('pushPlatformNotificationsFundsSentTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsFundsSentDescriptionDefault',\n      ),\n      getDescription: (n) => {\n        const symbol = getChainSymbol(n?.chain_id);\n        const tokenAmount = n?.data?.amount?.eth;\n        if (!symbol || !tokenAmount) {\n          return null;\n        }\n\n        const amount = formatAmount(parseFloat(tokenAmount), {\n          shouldEllipse: true,\n        });\n        return t(\n          'pushPlatformNotificationsFundsSentDescription',\n          amount,\n          symbol,\n        );\n      },\n    },\n    erc20_received: {\n      title: t('pushPlatformNotificationsFundsReceivedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsFundsReceivedDescriptionDefault',\n      ),\n      getDescription: (n) => {\n        const symbol = n?.data?.token?.symbol;\n        const tokenAmount = n?.data?.token?.amount;\n        const tokenDecimals = n?.data?.token?.decimals;\n        if (!symbol || !tokenAmount || !tokenDecimals) {\n          return null;\n        }\n\n        const amount = getAmount(tokenAmount, tokenDecimals, {\n          shouldEllipse: true,\n        });\n        return t(\n          'pushPlatformNotificationsFundsReceivedDescription',\n          amount,\n          symbol,\n        );\n      },\n    },\n    eth_received: {\n      title: t('pushPlatformNotificationsFundsReceivedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsFundsReceivedDescriptionDefault',\n      ),\n      getDescription: (n) => {\n        const symbol = getChainSymbol(n?.chain_id);\n        const tokenAmount = n?.data?.amount?.eth;\n        if (!symbol || !tokenAmount) {\n          return null;\n        }\n\n        const amount = formatAmount(parseFloat(tokenAmount), {\n          shouldEllipse: true,\n        });\n        return t(\n          'pushPlatformNotificationsFundsReceivedDescription',\n          amount,\n          symbol,\n        );\n      },\n    },\n    metamask_swap_completed: {\n      title: t('pushPlatformNotificationsSwapCompletedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsSwapCompletedDescription',\n      ),\n    },\n    erc721_sent: {\n      title: t('pushPlatformNotificationsNftSentTitle'),\n      defaultDescription: t('pushPlatformNotificationsNftSentDescription'),\n    },\n    erc1155_sent: {\n      title: t('pushPlatformNotificationsNftSentTitle'),\n      defaultDescription: t('pushPlatformNotificationsNftSentDescription'),\n    },\n    erc721_received: {\n      title: t('pushPlatformNotificationsNftReceivedTitle'),\n      defaultDescription: t('pushPlatformNotificationsNftReceivedDescription'),\n    },\n    erc1155_received: {\n      title: t('pushPlatformNotificationsNftReceivedTitle'),\n      defaultDescription: t('pushPlatformNotificationsNftReceivedDescription'),\n    },\n    rocketpool_stake_completed: {\n      title: t('pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription',\n      ),\n    },\n    rocketpool_unstake_completed: {\n      title: t(\n        'pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle',\n      ),\n      defaultDescription: t(\n        'pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription',\n      ),\n    },\n    lido_stake_completed: {\n      title: t('pushPlatformNotificationsStakingLidoStakeCompletedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsStakingLidoStakeCompletedDescription',\n      ),\n    },\n    lido_stake_ready_to_be_withdrawn: {\n      title: t(\n        'pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle',\n      ),\n      defaultDescription: t(\n        'pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription',\n      ),\n    },\n    lido_withdrawal_requested: {\n      title: t('pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription',\n      ),\n    },\n    lido_withdrawal_completed: {\n      title: t('pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle'),\n      defaultDescription: t(\n        'pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription',\n      ),\n    },\n  };\n};\n\n/**\n * Retrieves the symbol associated with a given chain ID.\n *\n * @param chainId - The ID of the chain.\n * @returns The symbol associated with the chain ID, or null if not found.\n */\nfunction getChainSymbol(chainId: number) {\n  return Constants.CHAIN_SYMBOLS[chainId] ?? null;\n}\n\n/**\n * Checks if the given value is an OnChainRawNotification object.\n *\n * @param n - The value to check.\n * @returns True if the value is an OnChainRawNotification object, false otherwise.\n */\nexport function isOnChainNotification(\n  n: unknown,\n): n is Types.OnChainRawNotification {\n  const assumed = n as Types.OnChainRawNotification;\n\n  // We don't have a validation/parsing library to check all possible types of an on chain notification\n  // It is safe enough just to check \"some\" fields, and catch any errors down the line if the shape is bad.\n  const isValidEnoughToBeOnChainNotification = [\n    assumed?.id,\n    assumed?.data,\n    assumed?.trigger_id,\n  ].every((field) => field !== undefined);\n  return isValidEnoughToBeOnChainNotification;\n}\n\n/**\n * Creates a push notification message based on the given on-chain raw notification.\n *\n * @param n - processed notification.\n * @param translations - translates keys into text\n * @returns The push notification message object, or null if the notification is invalid.\n */\nexport function createOnChainPushNotificationMessage(\n  n: Types.INotification,\n  translations: TranslationKeys,\n): PushNotificationMessage | null {\n  if (!n?.type) {\n    return null;\n  }\n  const notificationMessage =\n    createOnChainPushNotificationMessages(translations)[n.type];\n\n  if (!notificationMessage) {\n    return null;\n  }\n\n  let description: string | null = null;\n  try {\n    description =\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      notificationMessage?.getDescription?.(n as any) ??\n      notificationMessage.defaultDescription ??\n      null;\n  } catch (e) {\n    description = notificationMessage.defaultDescription ?? null;\n  }\n\n  return {\n    title: notificationMessage.title ?? '', // Ensure title is always a string\n    description: description ?? '', // Fallback to empty string if null\n  };\n}\n"]}

package/dist/{types/NotificationServicesPushController/utils/get-notification-message.d.ts → NotificationServicesPushController/utils/get-notification-message.d.cts}

@@ -1,5 +1,5 @@
-import type { Types } from '../../NotificationServicesController';
-import { Constants } from '../../NotificationServicesController';
+import type { Types } from "../../NotificationServicesController/index.cjs";
+import { Constants } from "../../NotificationServicesController/index.cjs";
 export type TranslationKeys = {
     pushPlatformNotificationsFundsSentTitle: () => string;
     pushPlatformNotificationsFundsSentDescriptionDefault: () => string;
@@ -64,4 +64,4 @@ export declare function isOnChainNotification(n: unknown): n is Types.OnChainRaw
  */
 export declare function createOnChainPushNotificationMessage(n: Types.INotification, translations: TranslationKeys): PushNotificationMessage | null;
 export {};
-//# sourceMappingURL=get-notification-message.d.ts.map
+//# sourceMappingURL=get-notification-message.d.cts.map

package/dist/NotificationServicesPushController/utils/get-notification-message.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-notification-message.d.cts","sourceRoot":"","sources":["../../../src/NotificationServicesPushController/utils/get-notification-message.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,uDAA6C;AAClE,OAAO,EAAE,SAAS,EAAE,uDAA6C;AAGjE,MAAM,MAAM,eAAe,GAAG;IAC5B,uCAAuC,EAAE,MAAM,MAAM,CAAC;IACtD,oDAAoD,EAAE,MAAM,MAAM,CAAC;IACnE,6CAA6C,EAAE,CAC7C,GAAG,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,KACtB,MAAM,CAAC;IACZ,2CAA2C,EAAE,MAAM,MAAM,CAAC;IAC1D,wDAAwD,EAAE,MAAM,MAAM,CAAC;IACvE,iDAAiD,EAAE,CACjD,GAAG,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,KACtB,MAAM,CAAC;IACZ,2CAA2C,EAAE,MAAM,MAAM,CAAC;IAC1D,iDAAiD,EAAE,MAAM,MAAM,CAAC;IAChE,qCAAqC,EAAE,MAAM,MAAM,CAAC;IACpD,2CAA2C,EAAE,MAAM,MAAM,CAAC;IAC1D,yCAAyC,EAAE,MAAM,MAAM,CAAC;IACxD,+CAA+C,EAAE,MAAM,MAAM,CAAC;IAC9D,6DAA6D,EAAE,MAAM,MAAM,CAAC;IAC5E,mEAAmE,EAAE,MAAM,MAAM,CAAC;IAClF,+DAA+D,EAAE,MAAM,MAAM,CAAC;IAC9E,qEAAqE,EAAE,MAAM,MAAM,CAAC;IACpF,uDAAuD,EAAE,MAAM,MAAM,CAAC;IACtE,6DAA6D,EAAE,MAAM,MAAM,CAAC;IAC5E,gEAAgE,EAAE,MAAM,MAAM,CAAC;IAC/E,sEAAsE,EAAE,MAAM,MAAM,CAAC;IACrF,4DAA4D,EAAE,MAAM,MAAM,CAAC;IAC3E,kEAAkE,EAAE,MAAM,MAAM,CAAC;IACjF,4DAA4D,EAAE,MAAM,MAAM,CAAC;IAC3E,kEAAkE,EAAE,MAAM,MAAM,CAAC;CAClF,CAAC;AAEF,KAAK,uBAAuB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,mBAAmB,CAAC,CAAC,SAAS,KAAK,CAAC,aAAa,IAAI;IACxD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,KAAK,uBAAuB,GAAG;KAC5B,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,mBAAmB,CAClD,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAC1C;CACF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC,oBAC/B,eAAe,KAC/B,uBAuKF,CAAC;AAYF;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,CAAC,EAAE,OAAO,GACT,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAWnC;AAED;;;;;;GAMG;AACH,wBAAgB,oCAAoC,CAClD,CAAC,EAAE,KAAK,CAAC,aAAa,EACtB,YAAY,EAAE,eAAe,GAC5B,uBAAuB,GAAG,IAAI,CA0BhC"}

package/dist/NotificationServicesPushController/utils/get-notification-message.d.mts

@@ -0,0 +1,67 @@
+import type { Types } from "../../NotificationServicesController/index.mjs";
+import { Constants } from "../../NotificationServicesController/index.mjs";
+export type TranslationKeys = {
+    pushPlatformNotificationsFundsSentTitle: () => string;
+    pushPlatformNotificationsFundsSentDescriptionDefault: () => string;
+    pushPlatformNotificationsFundsSentDescription: (...args: [string, string]) => string;
+    pushPlatformNotificationsFundsReceivedTitle: () => string;
+    pushPlatformNotificationsFundsReceivedDescriptionDefault: () => string;
+    pushPlatformNotificationsFundsReceivedDescription: (...args: [string, string]) => string;
+    pushPlatformNotificationsSwapCompletedTitle: () => string;
+    pushPlatformNotificationsSwapCompletedDescription: () => string;
+    pushPlatformNotificationsNftSentTitle: () => string;
+    pushPlatformNotificationsNftSentDescription: () => string;
+    pushPlatformNotificationsNftReceivedTitle: () => string;
+    pushPlatformNotificationsNftReceivedDescription: () => string;
+    pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle: () => string;
+    pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription: () => string;
+    pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle: () => string;
+    pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription: () => string;
+    pushPlatformNotificationsStakingLidoStakeCompletedTitle: () => string;
+    pushPlatformNotificationsStakingLidoStakeCompletedDescription: () => string;
+    pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle: () => string;
+    pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription: () => string;
+    pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle: () => string;
+    pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription: () => string;
+    pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle: () => string;
+    pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription: () => string;
+};
+type PushNotificationMessage = {
+    title: string;
+    description: string;
+};
+type NotificationMessage<N extends Types.INotification> = {
+    title: string | null;
+    defaultDescription: string | null;
+    getDescription?: (n: N) => string | null;
+};
+type NotificationMessageDict = {
+    [K in Constants.TRIGGER_TYPES]?: NotificationMessage<Extract<Types.INotification, {
+        type: K;
+    }>>;
+};
+/**
+ * On Chain Push Notification Messages.
+ * This is a list of all the push notifications we support. Update this for synced notifications on mobile and extension
+ *
+ * @param translationKeys - all translations supported
+ * @returns A translation push message object.
+ */
+export declare const createOnChainPushNotificationMessages: (translationKeys: TranslationKeys) => NotificationMessageDict;
+/**
+ * Checks if the given value is an OnChainRawNotification object.
+ *
+ * @param n - The value to check.
+ * @returns True if the value is an OnChainRawNotification object, false otherwise.
+ */
+export declare function isOnChainNotification(n: unknown): n is Types.OnChainRawNotification;
+/**
+ * Creates a push notification message based on the given on-chain raw notification.
+ *
+ * @param n - processed notification.
+ * @param translations - translates keys into text
+ * @returns The push notification message object, or null if the notification is invalid.
+ */
+export declare function createOnChainPushNotificationMessage(n: Types.INotification, translations: TranslationKeys): PushNotificationMessage | null;
+export {};
+//# sourceMappingURL=get-notification-message.d.mts.map

package/dist/NotificationServicesPushController/utils/get-notification-message.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-notification-message.d.mts","sourceRoot":"","sources":["../../../src/NotificationServicesPushController/utils/get-notification-message.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,uDAA6C;AAClE,OAAO,EAAE,SAAS,EAAE,uDAA6C;AAGjE,MAAM,MAAM,eAAe,GAAG;IAC5B,uCAAuC,EAAE,MAAM,MAAM,CAAC;IACtD,oDAAoD,EAAE,MAAM,MAAM,CAAC;IACnE,6CAA6C,EAAE,CAC7C,GAAG,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,KACtB,MAAM,CAAC;IACZ,2CAA2C,EAAE,MAAM,MAAM,CAAC;IAC1D,wDAAwD,EAAE,MAAM,MAAM,CAAC;IACvE,iDAAiD,EAAE,CACjD,GAAG,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,KACtB,MAAM,CAAC;IACZ,2CAA2C,EAAE,MAAM,MAAM,CAAC;IAC1D,iDAAiD,EAAE,MAAM,MAAM,CAAC;IAChE,qCAAqC,EAAE,MAAM,MAAM,CAAC;IACpD,2CAA2C,EAAE,MAAM,MAAM,CAAC;IAC1D,yCAAyC,EAAE,MAAM,MAAM,CAAC;IACxD,+CAA+C,EAAE,MAAM,MAAM,CAAC;IAC9D,6DAA6D,EAAE,MAAM,MAAM,CAAC;IAC5E,mEAAmE,EAAE,MAAM,MAAM,CAAC;IAClF,+DAA+D,EAAE,MAAM,MAAM,CAAC;IAC9E,qEAAqE,EAAE,MAAM,MAAM,CAAC;IACpF,uDAAuD,EAAE,MAAM,MAAM,CAAC;IACtE,6DAA6D,EAAE,MAAM,MAAM,CAAC;IAC5E,gEAAgE,EAAE,MAAM,MAAM,CAAC;IAC/E,sEAAsE,EAAE,MAAM,MAAM,CAAC;IACrF,4DAA4D,EAAE,MAAM,MAAM,CAAC;IAC3E,kEAAkE,EAAE,MAAM,MAAM,CAAC;IACjF,4DAA4D,EAAE,MAAM,MAAM,CAAC;IAC3E,kEAAkE,EAAE,MAAM,MAAM,CAAC;CAClF,CAAC;AAEF,KAAK,uBAAuB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,mBAAmB,CAAC,CAAC,SAAS,KAAK,CAAC,aAAa,IAAI;IACxD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,KAAK,uBAAuB,GAAG;KAC5B,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,mBAAmB,CAClD,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAC1C;CACF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC,oBAC/B,eAAe,KAC/B,uBAuKF,CAAC;AAYF;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,CAAC,EAAE,OAAO,GACT,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAWnC;AAED;;;;;;GAMG;AACH,wBAAgB,oCAAoC,CAClD,CAAC,EAAE,KAAK,CAAC,aAAa,EACtB,YAAY,EAAE,eAAe,GAC5B,uBAAuB,GAAG,IAAI,CA0BhC"}

package/dist/NotificationServicesPushController/utils/get-notification-message.mjs

@@ -1,39 +1,184 @@
-import {
-  createOnChainPushNotificationMessage,
-  createOnChainPushNotificationMessages,
-  isOnChainNotification
-} from "../../chunk-WGBEAP2F.mjs";
-import "../../chunk-ODI2BTKS.mjs";
-import "../../chunk-7PWKQSM2.mjs";
-import "../../chunk-B4ECJJ5C.mjs";
-import "../../chunk-U74Q3BRP.mjs";
-import "../../chunk-G52DNXFH.mjs";
-import "../../chunk-7RM3YNTD.mjs";
-import "../../chunk-PNCS6GEX.mjs";
-import "../../chunk-4QXAPVW3.mjs";
-import "../../chunk-JQ7WKFCI.mjs";
-import "../../chunk-IDO4JFV5.mjs";
-import "../../chunk-A2RPVX47.mjs";
-import "../../chunk-4BTNTREI.mjs";
-import "../../chunk-QB5IFRLA.mjs";
-import "../../chunk-LZMC2QML.mjs";
-import "../../chunk-77QIITUL.mjs";
-import "../../chunk-2P5WP5NT.mjs";
-import "../../chunk-5FAAZCBK.mjs";
-import "../../chunk-WE4RFGT7.mjs";
-import "../../chunk-MG5QDUDI.mjs";
-import "../../chunk-BONB66A2.mjs";
-import "../../chunk-C62SK2KY.mjs";
-import "../../chunk-D42BBXBM.mjs";
-import "../../chunk-OHFX4S6R.mjs";
-import "../../chunk-YUMIJSUD.mjs";
-import "../../chunk-53F3SYYM.mjs";
-import "../../chunk-DINCLRZT.mjs";
-import "../../chunk-6ZDVTRRT.mjs";
-import "../../chunk-U5UIDVOO.mjs";
-export {
-  createOnChainPushNotificationMessage,
-  createOnChainPushNotificationMessages,
-  isOnChainNotification
+import { Constants } from "../../NotificationServicesController/index.mjs";
+import { getAmount, formatAmount } from "./get-notification-data.mjs";
+/**
+ * On Chain Push Notification Messages.
+ * This is a list of all the push notifications we support. Update this for synced notifications on mobile and extension
+ *
+ * @param translationKeys - all translations supported
+ * @returns A translation push message object.
+ */
+export const createOnChainPushNotificationMessages = (translationKeys) => {
+    const t = (...args) => {
+        const [key, ...otherArgs] = args;
+        // Coerce types for the translation function
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const fn = translationKeys[key];
+        return fn(...otherArgs);
+    };
+    return {
+        erc20_sent: {
+            title: t('pushPlatformNotificationsFundsSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsSentDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = n?.data?.token?.symbol;
+                const tokenAmount = n?.data?.token?.amount;
+                const tokenDecimals = n?.data?.token?.decimals;
+                if (!symbol || !tokenAmount || !tokenDecimals) {
+                    return null;
+                }
+                const amount = getAmount(tokenAmount, tokenDecimals, {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsSentDescription', amount, symbol);
+            },
+        },
+        eth_sent: {
+            title: t('pushPlatformNotificationsFundsSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsSentDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = getChainSymbol(n?.chain_id);
+                const tokenAmount = n?.data?.amount?.eth;
+                if (!symbol || !tokenAmount) {
+                    return null;
+                }
+                const amount = formatAmount(parseFloat(tokenAmount), {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsSentDescription', amount, symbol);
+            },
+        },
+        erc20_received: {
+            title: t('pushPlatformNotificationsFundsReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsReceivedDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = n?.data?.token?.symbol;
+                const tokenAmount = n?.data?.token?.amount;
+                const tokenDecimals = n?.data?.token?.decimals;
+                if (!symbol || !tokenAmount || !tokenDecimals) {
+                    return null;
+                }
+                const amount = getAmount(tokenAmount, tokenDecimals, {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsReceivedDescription', amount, symbol);
+            },
+        },
+        eth_received: {
+            title: t('pushPlatformNotificationsFundsReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsFundsReceivedDescriptionDefault'),
+            getDescription: (n) => {
+                const symbol = getChainSymbol(n?.chain_id);
+                const tokenAmount = n?.data?.amount?.eth;
+                if (!symbol || !tokenAmount) {
+                    return null;
+                }
+                const amount = formatAmount(parseFloat(tokenAmount), {
+                    shouldEllipse: true,
+                });
+                return t('pushPlatformNotificationsFundsReceivedDescription', amount, symbol);
+            },
+        },
+        metamask_swap_completed: {
+            title: t('pushPlatformNotificationsSwapCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsSwapCompletedDescription'),
+        },
+        erc721_sent: {
+            title: t('pushPlatformNotificationsNftSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftSentDescription'),
+        },
+        erc1155_sent: {
+            title: t('pushPlatformNotificationsNftSentTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftSentDescription'),
+        },
+        erc721_received: {
+            title: t('pushPlatformNotificationsNftReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftReceivedDescription'),
+        },
+        erc1155_received: {
+            title: t('pushPlatformNotificationsNftReceivedTitle'),
+            defaultDescription: t('pushPlatformNotificationsNftReceivedDescription'),
+        },
+        rocketpool_stake_completed: {
+            title: t('pushPlatformNotificationsStakingRocketpoolStakeCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingRocketpoolStakeCompletedDescription'),
+        },
+        rocketpool_unstake_completed: {
+            title: t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingRocketpoolUnstakeCompletedDescription'),
+        },
+        lido_stake_completed: {
+            title: t('pushPlatformNotificationsStakingLidoStakeCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoStakeCompletedDescription'),
+        },
+        lido_stake_ready_to_be_withdrawn: {
+            title: t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoStakeReadyToBeWithdrawnDescription'),
+        },
+        lido_withdrawal_requested: {
+            title: t('pushPlatformNotificationsStakingLidoWithdrawalRequestedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoWithdrawalRequestedDescription'),
+        },
+        lido_withdrawal_completed: {
+            title: t('pushPlatformNotificationsStakingLidoWithdrawalCompletedTitle'),
+            defaultDescription: t('pushPlatformNotificationsStakingLidoWithdrawalCompletedDescription'),
+        },
+    };
 };
+/**
+ * Retrieves the symbol associated with a given chain ID.
+ *
+ * @param chainId - The ID of the chain.
+ * @returns The symbol associated with the chain ID, or null if not found.
+ */
+function getChainSymbol(chainId) {
+    return Constants.CHAIN_SYMBOLS[chainId] ?? null;
+}
+/**
+ * Checks if the given value is an OnChainRawNotification object.
+ *
+ * @param n - The value to check.
+ * @returns True if the value is an OnChainRawNotification object, false otherwise.
+ */
+export function isOnChainNotification(n) {
+    const assumed = n;
+    // We don't have a validation/parsing library to check all possible types of an on chain notification
+    // It is safe enough just to check "some" fields, and catch any errors down the line if the shape is bad.
+    const isValidEnoughToBeOnChainNotification = [
+        assumed?.id,
+        assumed?.data,
+        assumed?.trigger_id,
+    ].every((field) => field !== undefined);
+    return isValidEnoughToBeOnChainNotification;
+}
+/**
+ * Creates a push notification message based on the given on-chain raw notification.
+ *
+ * @param n - processed notification.
+ * @param translations - translates keys into text
+ * @returns The push notification message object, or null if the notification is invalid.
+ */
+export function createOnChainPushNotificationMessage(n, translations) {
+    if (!n?.type) {
+        return null;
+    }
+    const notificationMessage = createOnChainPushNotificationMessages(translations)[n.type];
+    if (!notificationMessage) {
+        return null;
+    }
+    let description = null;
+    try {
+        description =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            notificationMessage?.getDescription?.(n) ??
+                notificationMessage.defaultDescription ??
+                null;
+    }
+    catch (e) {
+        description = notificationMessage.defaultDescription ?? null;
+    }
+    return {
+        title: notificationMessage.title ?? '',
+        description: description ?? '', // Fallback to empty string if null
+    };
+}
 //# sourceMappingURL=get-notification-message.mjs.map