@metamask-previews/notification-services-controller 0.0.0-preview-b09c2ed

package/dist/types/NotificationServicesPushController/utils/get-notification-data.d.ts

@@ -0,0 +1,42 @@
+import { BigNumber } from 'bignumber.js';
+type FormatOptions = {
+    decimalPlaces?: number;
+    shouldEllipse?: boolean;
+};
+/**
+ * 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 declare function calcTokenAmount(value: string, decimals: number): BigNumber;
+/**
+ * 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 declare const getLeadingZeroCount: (num: number | string) => number;
+/**
+ * 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 declare const formatAmount: (numericAmount: number, opts?: FormatOptions) => string;
+export declare const getAmount: (amount: string, decimals: string, options?: FormatOptions) => string;
+export {};
+//# sourceMappingURL=get-notification-data.d.ts.map

package/dist/types/NotificationServicesPushController/utils/get-notification-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-notification-data.d.ts","sourceRoot":"","sources":["../../../../src/NotificationServicesPushController/utils/get-notification-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,KAAK,aAAa,GAAG;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAKF;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,aAG9D;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,QAAS,MAAM,GAAG,MAAM,WAIvD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,kBAAmB,MAAM,SAAS,aAAa,WA+BvE,CAAC;AAEF,eAAO,MAAM,SAAS,WACZ,MAAM,YACJ,MAAM,YACN,aAAa,WAYxB,CAAC"}

package/dist/types/NotificationServicesPushController/utils/get-notification-message.d.ts

@@ -0,0 +1,67 @@
+import type { Types } from '../../NotificationServicesController';
+import { Constants } from '../../NotificationServicesController';
+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.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-notification-message.d.ts","sourceRoot":"","sources":["../../../../src/NotificationServicesPushController/utils/get-notification-message.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;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/types/NotificationServicesPushController/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './get-notification-data';
+export * from './get-notification-message';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/NotificationServicesPushController/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/NotificationServicesPushController/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * as NotificationServicesController from './NotificationServicesController';
+export * as NotificationsServicesPushController from './NotificationServicesPushController';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,8BAA8B,MAAM,kCAAkC,CAAC;AACnF,OAAO,KAAK,mCAAmC,MAAM,sCAAsC,CAAC"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@metamask-previews/notification-services-controller",
+  "version": "0.0.0-preview-b09c2ed",
+  "description": "Manages New MetaMask decentralized Notification system",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/notification-services-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsup --config ../../tsup.config.ts --tsconfig ./tsconfig.build.json --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/notification-services-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/notification-services-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest --reporters=jest-silent-reporter",
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@contentful/rich-text-html-renderer": "^16.5.2",
+    "@metamask/base-controller": "^6.0.0",
+    "@metamask/controller-utils": "^11.0.0",
+    "@metamask/keyring-controller": "^17.1.0",
+    "@metamask/profile-sync-controller": "^0.0.0",
+    "bignumber.js": "^4.1.0",
+    "contentful": "^10.3.6",
+    "firebase": "^10.11.0",
+    "loglevel": "^1.8.1",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^3.0.4",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jest": "^27.4.1",
+    "@types/readable-stream": "^2.3.0",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "jest-environment-jsdom": "^27.5.1",
+    "nock": "^13.3.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~4.9.5"
+  },
+  "peerDependencies": {
+    "@metamask/keyring-controller": "^17.0.0",
+    "@metamask/profile-sync-controller": "^0.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}