@metamask-previews/notification-services-controller 24.3.0-preview-6fc64deac → 24.3.0-preview-c4108f3eb

package/dist/shared/notification-api-type-guards.d.cts

@@ -0,0 +1,16 @@
+import type { UnprocessedRawNotification, OnChainNotification, PlatformNotification } from "../NotificationServicesController/types/notification-api/index.cjs";
+/**
+ * Narrows a v4 API notification to an on-chain notification.
+ *
+ * @param notification - Unprocessed v4 API notification.
+ * @returns Whether the notification is an on-chain notification.
+ */
+export declare function isOnChainNotification(notification: UnprocessedRawNotification): notification is OnChainNotification;
+/**
+ * Narrows a v4 API notification to a platform notification.
+ *
+ * @param notification - Unprocessed v4 API notification.
+ * @returns Whether the notification is a platform notification.
+ */
+export declare function isPlatformNotification(notification: UnprocessedRawNotification): notification is PlatformNotification;
+//# sourceMappingURL=notification-api-type-guards.d.cts.map

package/dist/shared/notification-api-type-guards.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-api-type-guards.d.cts","sourceRoot":"","sources":["../../src/shared/notification-api-type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACrB,2EAAiE;AAElE;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,0BAA0B,GACvC,YAAY,IAAI,mBAAmB,CAErC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,YAAY,EAAE,0BAA0B,GACvC,YAAY,IAAI,oBAAoB,CAEtC"}

package/dist/shared/notification-api-type-guards.d.mts

@@ -0,0 +1,16 @@
+import type { UnprocessedRawNotification, OnChainNotification, PlatformNotification } from "../NotificationServicesController/types/notification-api/index.mjs";
+/**
+ * Narrows a v4 API notification to an on-chain notification.
+ *
+ * @param notification - Unprocessed v4 API notification.
+ * @returns Whether the notification is an on-chain notification.
+ */
+export declare function isOnChainNotification(notification: UnprocessedRawNotification): notification is OnChainNotification;
+/**
+ * Narrows a v4 API notification to a platform notification.
+ *
+ * @param notification - Unprocessed v4 API notification.
+ * @returns Whether the notification is a platform notification.
+ */
+export declare function isPlatformNotification(notification: UnprocessedRawNotification): notification is PlatformNotification;
+//# sourceMappingURL=notification-api-type-guards.d.mts.map

package/dist/shared/notification-api-type-guards.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-api-type-guards.d.mts","sourceRoot":"","sources":["../../src/shared/notification-api-type-guards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACrB,2EAAiE;AAElE;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,0BAA0B,GACvC,YAAY,IAAI,mBAAmB,CAErC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,YAAY,EAAE,0BAA0B,GACvC,YAAY,IAAI,oBAAoB,CAEtC"}

package/dist/shared/notification-api-type-guards.mjs

@@ -0,0 +1,19 @@
+/**
+ * Narrows a v4 API notification to an on-chain notification.
+ *
+ * @param notification - Unprocessed v4 API notification.
+ * @returns Whether the notification is an on-chain notification.
+ */
+export function isOnChainNotification(notification) {
+    return notification.notification_type === 'wallet_activity';
+}
+/**
+ * Narrows a v4 API notification to a platform notification.
+ *
+ * @param notification - Unprocessed v4 API notification.
+ * @returns Whether the notification is a platform notification.
+ */
+export function isPlatformNotification(notification) {
+    return !isOnChainNotification(notification);
+}
+//# sourceMappingURL=notification-api-type-guards.mjs.map

package/dist/shared/notification-api-type-guards.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-api-type-guards.mjs","sourceRoot":"","sources":["../../src/shared/notification-api-type-guards.ts"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,YAAwC;IAExC,OAAO,YAAY,CAAC,iBAAiB,KAAK,iBAAiB,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,YAAwC;IAExC,OAAO,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAC9C,CAAC","sourcesContent":["import type {\n  UnprocessedRawNotification,\n  OnChainNotification,\n  PlatformNotification,\n} from '../NotificationServicesController/types/notification-api';\n\n/**\n * Narrows a v4 API notification to an on-chain notification.\n *\n * @param notification - Unprocessed v4 API notification.\n * @returns Whether the notification is an on-chain notification.\n */\nexport function isOnChainNotification(\n  notification: UnprocessedRawNotification,\n): notification is OnChainNotification {\n  return notification.notification_type === 'wallet_activity';\n}\n\n/**\n * Narrows a v4 API notification to a platform notification.\n *\n * @param notification - Unprocessed v4 API notification.\n * @returns Whether the notification is a platform notification.\n */\nexport function isPlatformNotification(\n  notification: UnprocessedRawNotification,\n): notification is PlatformNotification {\n  return !isOnChainNotification(notification);\n}\n"]}

package/dist/shared/to-raw-notification.cjs

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toRawAPINotification = void 0;
+const notification_schema_1 = require("../NotificationServicesController/constants/notification-schema.cjs");
+const notification_api_type_guards_1 = require("./notification-api-type-guards.cjs");
 /**
  * A true "raw notification" does not have some fields that exist on this type. E.g. the `type` field.
  * This is retro-actively added when we fetch notifications to be able to easily type-discriminate notifications.
@@ -10,12 +12,8 @@ exports.toRawAPINotification = void 0;
  * @returns a complete raw onchain notification
  */
 function toRawAPINotification(data) {
-    const exhaustedAllCases = (_) => {
-        const type = data?.notification_type;
-        throw new Error(`toRawAPINotification - No processor found for notification kind ${type}`);
-    };
-    if (data.notification_type === 'on-chain') {
-        if (!data?.payload?.data?.kind) {
+    if ((0, notification_api_type_guards_1.isOnChainNotification)(data)) {
+        if (!data.payload.data?.kind) {
             throw new Error('toRawAPINotification - No kind found for on-chain notification');
         }
         return {
@@ -23,13 +21,10 @@ function toRawAPINotification(data) {
             type: data.payload.data.kind,
         };
     }
-    if (data.notification_type === 'platform') {
-        return {
-            ...data,
-            type: data.notification_type,
-        };
-    }
-    return exhaustedAllCases(data);
+    return {
+        ...data,
+        type: notification_schema_1.TRIGGER_TYPES.PLATFORM,
+    };
 }
 exports.toRawAPINotification = toRawAPINotification;
 //# sourceMappingURL=to-raw-notification.cjs.map

package/dist/shared/to-raw-notification.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"to-raw-notification.cjs","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":";;;AAOA;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,IAAgC;IAEhC,MAAM,iBAAiB,GAAG,CAAC,CAAQ,EAAS,EAAE;QAC5C,MAAM,IAAI,GAAW,IAAI,EAAE,iBAAiB,CAAC;QAC7C,MAAM,IAAI,KAAK,CACb,mEAAmE,IAAI,EAAE,CAC1E,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,IAAI,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QAC1C,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI;SACH,CAAC;IAC9B,CAAC;IAED,IAAI,IAAI,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QAC1C,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,iBAAiB;SACF,CAAC;IAC/B,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AA9BD,oDA8BC","sourcesContent":["import type {\n  UnprocessedRawNotification,\n  NormalisedAPINotification,\n  OnChainRawNotification,\n  PlatformRawNotification,\n} from 'src/NotificationServicesController/types/notification-api';\n\n/**\n * A true \"raw notification\" does not have some fields that exist on this type. E.g. the `type` field.\n * This is retro-actively added when we fetch notifications to be able to easily type-discriminate notifications.\n * We use this to ensure that the correct missing fields are added to the raw shapes\n *\n * @param data - raw onchain notification\n * @returns a complete raw onchain notification\n */\nexport function toRawAPINotification(\n  data: UnprocessedRawNotification,\n): NormalisedAPINotification {\n  const exhaustedAllCases = (_: never): never => {\n    const type: string = data?.notification_type;\n    throw new Error(\n      `toRawAPINotification - No processor found for notification kind ${type}`,\n    );\n  };\n\n  if (data.notification_type === 'on-chain') {\n    if (!data?.payload?.data?.kind) {\n      throw new Error(\n        'toRawAPINotification - No kind found for on-chain notification',\n      );\n    }\n    return {\n      ...data,\n      type: data.payload.data.kind,\n    } as OnChainRawNotification;\n  }\n\n  if (data.notification_type === 'platform') {\n    return {\n      ...data,\n      type: data.notification_type,\n    } as PlatformRawNotification;\n  }\n\n  return exhaustedAllCases(data);\n}\n"]}
+{"version":3,"file":"to-raw-notification.cjs","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":";;;AAOA,6GAAgG;AAChG,qFAAuE;AAEvE;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,IAAgC;IAEhC,IAAI,IAAA,oDAAqB,EAAC,IAAI,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI;SACH,CAAC;IAC9B,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,IAAI,EAAE,mCAAa,CAAC,QAAQ;KACF,CAAC;AAC/B,CAAC;AAnBD,oDAmBC","sourcesContent":["import type {\n  UnprocessedRawNotification,\n  NormalisedAPINotification,\n  OnChainRawNotification,\n  PlatformRawNotification,\n} from 'src/NotificationServicesController/types/notification-api';\n\nimport { TRIGGER_TYPES } from '../NotificationServicesController/constants/notification-schema';\nimport { isOnChainNotification } from './notification-api-type-guards';\n\n/**\n * A true \"raw notification\" does not have some fields that exist on this type. E.g. the `type` field.\n * This is retro-actively added when we fetch notifications to be able to easily type-discriminate notifications.\n * We use this to ensure that the correct missing fields are added to the raw shapes\n *\n * @param data - raw onchain notification\n * @returns a complete raw onchain notification\n */\nexport function toRawAPINotification(\n  data: UnprocessedRawNotification,\n): NormalisedAPINotification {\n  if (isOnChainNotification(data)) {\n    if (!data.payload.data?.kind) {\n      throw new Error(\n        'toRawAPINotification - No kind found for on-chain notification',\n      );\n    }\n    return {\n      ...data,\n      type: data.payload.data.kind,\n    } as OnChainRawNotification;\n  }\n\n  return {\n    ...data,\n    type: TRIGGER_TYPES.PLATFORM,\n  } as PlatformRawNotification;\n}\n"]}

package/dist/shared/to-raw-notification.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"to-raw-notification.d.cts","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,yBAAyB,EAG1B,kEAAkE;AAEnE;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,0BAA0B,GAC/B,yBAAyB,CA4B3B"}
+{"version":3,"file":"to-raw-notification.d.cts","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,yBAAyB,EAG1B,kEAAkE;AAKnE;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,0BAA0B,GAC/B,yBAAyB,CAiB3B"}

package/dist/shared/to-raw-notification.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"to-raw-notification.d.mts","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,yBAAyB,EAG1B,kEAAkE;AAEnE;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,0BAA0B,GAC/B,yBAAyB,CA4B3B"}
+{"version":3,"file":"to-raw-notification.d.mts","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,yBAAyB,EAG1B,kEAAkE;AAKnE;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,0BAA0B,GAC/B,yBAAyB,CAiB3B"}

package/dist/shared/to-raw-notification.mjs

@@ -1,3 +1,5 @@
+import { TRIGGER_TYPES } from "../NotificationServicesController/constants/notification-schema.mjs";
+import { isOnChainNotification } from "./notification-api-type-guards.mjs";
 /**
  * A true "raw notification" does not have some fields that exist on this type. E.g. the `type` field.
  * This is retro-actively added when we fetch notifications to be able to easily type-discriminate notifications.
@@ -7,12 +9,8 @@
  * @returns a complete raw onchain notification
  */
 export function toRawAPINotification(data) {
-    const exhaustedAllCases = (_) => {
-        const type = data?.notification_type;
-        throw new Error(`toRawAPINotification - No processor found for notification kind ${type}`);
-    };
-    if (data.notification_type === 'on-chain') {
-        if (!data?.payload?.data?.kind) {
+    if (isOnChainNotification(data)) {
+        if (!data.payload.data?.kind) {
             throw new Error('toRawAPINotification - No kind found for on-chain notification');
         }
         return {
@@ -20,12 +18,9 @@ export function toRawAPINotification(data) {
             type: data.payload.data.kind,
         };
     }
-    if (data.notification_type === 'platform') {
-        return {
-            ...data,
-            type: data.notification_type,
-        };
-    }
-    return exhaustedAllCases(data);
+    return {
+        ...data,
+        type: TRIGGER_TYPES.PLATFORM,
+    };
 }
 //# sourceMappingURL=to-raw-notification.mjs.map

package/dist/shared/to-raw-notification.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"to-raw-notification.mjs","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAgC;IAEhC,MAAM,iBAAiB,GAAG,CAAC,CAAQ,EAAS,EAAE;QAC5C,MAAM,IAAI,GAAW,IAAI,EAAE,iBAAiB,CAAC;QAC7C,MAAM,IAAI,KAAK,CACb,mEAAmE,IAAI,EAAE,CAC1E,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,IAAI,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QAC1C,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI;SACH,CAAC;IAC9B,CAAC;IAED,IAAI,IAAI,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QAC1C,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,iBAAiB;SACF,CAAC;IAC/B,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC","sourcesContent":["import type {\n  UnprocessedRawNotification,\n  NormalisedAPINotification,\n  OnChainRawNotification,\n  PlatformRawNotification,\n} from 'src/NotificationServicesController/types/notification-api';\n\n/**\n * A true \"raw notification\" does not have some fields that exist on this type. E.g. the `type` field.\n * This is retro-actively added when we fetch notifications to be able to easily type-discriminate notifications.\n * We use this to ensure that the correct missing fields are added to the raw shapes\n *\n * @param data - raw onchain notification\n * @returns a complete raw onchain notification\n */\nexport function toRawAPINotification(\n  data: UnprocessedRawNotification,\n): NormalisedAPINotification {\n  const exhaustedAllCases = (_: never): never => {\n    const type: string = data?.notification_type;\n    throw new Error(\n      `toRawAPINotification - No processor found for notification kind ${type}`,\n    );\n  };\n\n  if (data.notification_type === 'on-chain') {\n    if (!data?.payload?.data?.kind) {\n      throw new Error(\n        'toRawAPINotification - No kind found for on-chain notification',\n      );\n    }\n    return {\n      ...data,\n      type: data.payload.data.kind,\n    } as OnChainRawNotification;\n  }\n\n  if (data.notification_type === 'platform') {\n    return {\n      ...data,\n      type: data.notification_type,\n    } as PlatformRawNotification;\n  }\n\n  return exhaustedAllCases(data);\n}\n"]}
+{"version":3,"file":"to-raw-notification.mjs","sourceRoot":"","sources":["../../src/shared/to-raw-notification.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,4EAAwE;AAChG,OAAO,EAAE,qBAAqB,EAAE,2CAAuC;AAEvE;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAgC;IAEhC,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI;SACH,CAAC;IAC9B,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,IAAI,EAAE,aAAa,CAAC,QAAQ;KACF,CAAC;AAC/B,CAAC","sourcesContent":["import type {\n  UnprocessedRawNotification,\n  NormalisedAPINotification,\n  OnChainRawNotification,\n  PlatformRawNotification,\n} from 'src/NotificationServicesController/types/notification-api';\n\nimport { TRIGGER_TYPES } from '../NotificationServicesController/constants/notification-schema';\nimport { isOnChainNotification } from './notification-api-type-guards';\n\n/**\n * A true \"raw notification\" does not have some fields that exist on this type. E.g. the `type` field.\n * This is retro-actively added when we fetch notifications to be able to easily type-discriminate notifications.\n * We use this to ensure that the correct missing fields are added to the raw shapes\n *\n * @param data - raw onchain notification\n * @returns a complete raw onchain notification\n */\nexport function toRawAPINotification(\n  data: UnprocessedRawNotification,\n): NormalisedAPINotification {\n  if (isOnChainNotification(data)) {\n    if (!data.payload.data?.kind) {\n      throw new Error(\n        'toRawAPINotification - No kind found for on-chain notification',\n      );\n    }\n    return {\n      ...data,\n      type: data.payload.data.kind,\n    } as OnChainRawNotification;\n  }\n\n  return {\n    ...data,\n    type: TRIGGER_TYPES.PLATFORM,\n  } as PlatformRawNotification;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/notification-services-controller",
-  "version": "24.3.0-preview-6fc64deac",
+  "version": "24.3.0-preview-c4108f3eb",
   "description": "Manages New MetaMask decentralized Notification system",
   "keywords": [
     "Ethereum",