@metamask/notification-services-controller 0.18.0 → 0.19.0

package/dist/NotificationServicesPushController/NotificationServicesPushController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"NotificationServicesPushController.mjs","sourceRoot":"","sources":["../../src/NotificationServicesPushController/NotificationServicesPushController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAMA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,IAAG,iBAAiB;;AAG3B,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,qCAAiC;AAC1E,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,8BAA8B,EAC/B,gCAA4B;AAG7B,MAAM,cAAc,GAAG,oCAAoC,CAAC;AAwE5D,MAAM,CAAC,MAAM,YAAY,GAA4C;IACnE,QAAQ,EAAE,EAAE;CACb,CAAC;AACF,MAAM,QAAQ,GAA2D;IACvE,QAAQ,EAAE;QACR,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;CACF,CAAC;AAgCF;;;;;;;;GAQG;AACH,MAAqB,kCAAmC,SAAQ,cAI/D;IAOC,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,GAMP;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAtBL,sEAAqD,SAAS,EAAC;QAE/D,0DAA0B;QAE1B,6DAA0B;QAoBxB,uBAAA,IAAI,2CAAQ,GAAG,MAAA,CAAC;QAChB,uBAAA,IAAI,8CAAW,MAAM,MAAA,CAAC;QAEtB,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAmCD,KAAK,CAAC,4BAA4B;QAChC,IAAI,uBAAA,IAAI,mEAAyB,EAAE;YACjC,uBAAA,IAAI,mEAAyB,MAA7B,IAAI,CAA2B,CAAC;YAChC,uBAAA,IAAI,+DAA4B,SAAS,MAAA,CAAC;SAC3C;QAED,IAAI;YACF,uBAAA,IAAI,+DAA4B,MAAM,yBAAyB,CAAC;gBAC9D,GAAG,EAAE,uBAAA,IAAI,+CAAK;gBACd,oBAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;oBAChC,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,uDAAuD,EACvD,CAAC,CACF,CAAC;oBACF,MAAM,uBAAA,IAAI,kDAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC;gBACD,mBAAmB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC5B,IAAI,CAAC,EAAE;wBACL,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,4DAA4D,EAC5D,CAAC,CACF,CAAC;qBACH;oBAED,uBAAA,IAAI,kDAAQ,CAAC,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC/C,CAAC;aACF,CAAC,MAAA,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,8EAA8E;SAC/E;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,uBAAuB,CAAC,KAAe,EAAE,QAAiB;QAC9D,IAAI,CAAC,uBAAA,IAAI,kDAAQ,CAAC,aAAa,EAAE;YAC/B,OAAO;SACR;QAED,+CAA+C;QAC/C,IAAI;YACF,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC,KAAK,CAC7D,GAAG,EAAE,CAAC,IAAI,CACX,CAAC;YAEF,uEAAuE;YACvE,IAAI,WAAW,EAAE;gBACf,8BAA8B;gBAC9B,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC;oBAC/C,WAAW;oBACX,QAAQ,EAAE,KAAK;oBACf,GAAG,EAAE,uBAAA,IAAI,+CAAK;oBACd,QAAQ;oBACR,cAAc;oBACd,QAAQ,EAAE,uBAAA,IAAI,kDAAQ,CAAC,QAAQ;iBAChC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;gBAErB,IAAI,QAAQ,EAAE;oBACZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAC5B,CAAC,CAAC,CAAC;iBACJ;aACF;SACF;QAAC,MAAM;YACN,sCAAsC;SACvC;QAED,yDAAyD;QACzD,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAAC,KAAe;QAC5C,IAAI,CAAC,uBAAA,IAAI,kDAAQ,CAAC,aAAa,EAAE;YAC/B,OAAO;SACR;QAED,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC;QAC1D,IAAI,2BAAoC,CAAC;QAEzC,IAAI;YACF,8DAA8D;YAC9D,2BAA2B,GAAG,MAAM,2BAA2B,CAAC;gBAC9D,WAAW;gBACX,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,uBAAA,IAAI,+CAAK;gBACd,cAAc;gBACd,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;aAC9B,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,YAAY,GAAG,yCACnB,KACF,EAAE,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;QAED,sCAAsC;QACtC,IAAI,CAAC,2BAA2B,EAAE;YAChC,OAAO;SACR;QAED,sCAAsC;QACtC,uBAAA,IAAI,mEAAyB,EAAE,KAA/B,IAAI,CAA6B,CAAC;QAElC,eAAe;QACf,IAAI,2BAA2B,EAAE;YAC/B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;YACtB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,8BAA8B,CAAC,KAAe;QAClD,IAAI,CAAC,uBAAA,IAAI,kDAAQ,CAAC,aAAa,EAAE;YAC/B,OAAO;SACR;QAED,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC;QAE1D,IAAI;YACF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,8BAA8B,CAAC;gBACxD,WAAW;gBACX,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,uBAAA,IAAI,+CAAK;gBACd,cAAc;gBACd,cAAc;gBACd,QAAQ,EAAE,uBAAA,IAAI,kDAAQ,CAAC,QAAQ;gBAC/B,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;aAC9B,CAAC,CAAC;YAEH,0CAA0C;YAC1C,IAAI,QAAQ,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC5B,CAAC,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,YAAY,GAAG,qDACnB,KACF,EAAE,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;IACH,CAAC;CACF;;IAzMG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4DAA4D,EAC5D,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACxC,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,6DAA6D,EAC7D,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CACzC,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,mEAAmE,EACnE,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/C,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,iEAAiE,EACjE,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7C,CAAC;AACJ,CAAC,gEAED,KAAK;IACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACjD,yCAAyC,CAC1C,CAAC;IACF,IAAI,CAAC,WAAW,EAAE;QAChB,GAAG,CAAC,KAAK,CACP,oEAAoE,CACrE,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;eAlEkB,kCAAkC","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\nimport log from 'loglevel';\n\nimport type { Types } from '../NotificationServicesController';\nimport { createRegToken, deleteRegToken } from './services/push/push-web';\nimport {\n  activatePushNotifications,\n  deactivatePushNotifications,\n  listenToPushNotifications,\n  updateTriggerPushNotifications,\n} from './services/services';\nimport type { PushNotificationEnv } from './types';\n\nconst controllerName = 'NotificationServicesPushController';\n\nexport type NotificationServicesPushControllerState = {\n  fcmToken: string;\n};\n\nexport type NotificationServicesPushControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    NotificationServicesPushControllerState\n  >;\n\nexport type NotificationServicesPushControllerEnablePushNotificationsAction = {\n  type: `${typeof controllerName}:enablePushNotifications`;\n  handler: NotificationServicesPushController['enablePushNotifications'];\n};\nexport type NotificationServicesPushControllerDisablePushNotificationsAction = {\n  type: `${typeof controllerName}:disablePushNotifications`;\n  handler: NotificationServicesPushController['disablePushNotifications'];\n};\nexport type NotificationServicesPushControllerUpdateTriggerPushNotificationsAction =\n  {\n    type: `${typeof controllerName}:updateTriggerPushNotifications`;\n    handler: NotificationServicesPushController['updateTriggerPushNotifications'];\n  };\nexport type NotificationServicesPushControllerSubscribeToNotificationsAction = {\n  type: `${typeof controllerName}:subscribeToPushNotifications`;\n  handler: NotificationServicesPushController['subscribeToPushNotifications'];\n};\n\nexport type Actions =\n  | NotificationServicesPushControllerGetStateAction\n  | NotificationServicesPushControllerEnablePushNotificationsAction\n  | NotificationServicesPushControllerDisablePushNotificationsAction\n  | NotificationServicesPushControllerUpdateTriggerPushNotificationsAction\n  | NotificationServicesPushControllerSubscribeToNotificationsAction;\n\nexport type AllowedActions =\n  AuthenticationController.AuthenticationControllerGetBearerToken;\n\nexport type NotificationServicesPushControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    NotificationServicesPushControllerState\n  >;\n\nexport type NotificationServicesPushControllerOnNewNotificationEvent = {\n  type: `${typeof controllerName}:onNewNotifications`;\n  payload: [Types.INotification];\n};\n\nexport type NotificationServicesPushControllerPushNotificationClickedEvent = {\n  type: `${typeof controllerName}:pushNotificationClicked`;\n  payload: [Types.INotification];\n};\n\nexport type Events =\n  | NotificationServicesPushControllerStateChangeEvent\n  | NotificationServicesPushControllerOnNewNotificationEvent\n  | NotificationServicesPushControllerPushNotificationClickedEvent;\n\nexport type AllowedEvents = never;\n\nexport type NotificationServicesPushControllerMessenger =\n  RestrictedControllerMessenger<\n    typeof controllerName,\n    Actions | AllowedActions,\n    Events | AllowedEvents,\n    AllowedActions['type'],\n    AllowedEvents['type']\n  >;\n\nexport const defaultState: NotificationServicesPushControllerState = {\n  fcmToken: '',\n};\nconst metadata: StateMetadata<NotificationServicesPushControllerState> = {\n  fcmToken: {\n    persist: true,\n    anonymous: true,\n  },\n};\n\ntype ControllerConfig = {\n  /**\n   * Config to turn on/off push notifications.\n   * This is currently linked to MV3 builds on extension.\n   */\n  isPushEnabled: boolean;\n\n  /**\n   * Must handle when a push notification is received.\n   * You must call `registration.showNotification` or equivalent to show the notification on web/mobile\n   */\n  onPushNotificationReceived: (\n    notification: Types.INotification,\n  ) => void | Promise<void>;\n\n  /**\n   * Must handle when a push notification is clicked.\n   * You must call `event.notification.close();` or equivalent for closing and opening notification in a new window.\n   */\n  onPushNotificationClicked: (\n    event: NotificationEvent,\n    notification?: Types.INotification,\n  ) => void;\n\n  /**\n   * determine the config used for push notification services\n   */\n  platform: 'extension' | 'mobile';\n};\n\n/**\n * Manages push notifications for the application, including enabling, disabling, and updating triggers for push notifications.\n * This controller integrates with Firebase Cloud Messaging (FCM) to handle the registration and management of push notifications.\n * It is responsible for registering and unregistering the service worker that listens for push notifications,\n * managing the FCM token, and communicating with the server to register or unregister the device for push notifications.\n * Additionally, it provides functionality to update the server with new UUIDs that should trigger push notifications.\n *\n * @augments {BaseController<typeof controllerName, NotificationServicesPushControllerState, NotificationServicesPushControllerMessenger>}\n */\nexport default class NotificationServicesPushController extends BaseController<\n  typeof controllerName,\n  NotificationServicesPushControllerState,\n  NotificationServicesPushControllerMessenger\n> {\n  #pushListenerUnsubscribe: (() => void) | undefined = undefined;\n\n  #env: PushNotificationEnv;\n\n  #config: ControllerConfig;\n\n  constructor({\n    messenger,\n    state,\n    env,\n    config,\n  }: {\n    messenger: NotificationServicesPushControllerMessenger;\n    state: NotificationServicesPushControllerState;\n    env: PushNotificationEnv;\n    config: ControllerConfig;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    this.#env = env;\n    this.#config = config;\n\n    this.#registerMessageHandlers();\n  }\n\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:enablePushNotifications',\n      this.enablePushNotifications.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:disablePushNotifications',\n      this.disablePushNotifications.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:updateTriggerPushNotifications',\n      this.updateTriggerPushNotifications.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:subscribeToPushNotifications',\n      this.subscribeToPushNotifications.bind(this),\n    );\n  }\n\n  async #getAndAssertBearerToken() {\n    const bearerToken = await this.messagingSystem.call(\n      'AuthenticationController:getBearerToken',\n    );\n    if (!bearerToken) {\n      log.error(\n        'Failed to enable push notifications: BearerToken token is missing.',\n      );\n      throw new Error('BearerToken token is missing');\n    }\n\n    return bearerToken;\n  }\n\n  async subscribeToPushNotifications() {\n    if (this.#pushListenerUnsubscribe) {\n      this.#pushListenerUnsubscribe();\n      this.#pushListenerUnsubscribe = undefined;\n    }\n\n    try {\n      this.#pushListenerUnsubscribe = await listenToPushNotifications({\n        env: this.#env,\n        listenToPushReceived: async (n) => {\n          this.messagingSystem.publish(\n            'NotificationServicesPushController:onNewNotifications',\n            n,\n          );\n          await this.#config.onPushNotificationReceived(n);\n        },\n        listenToPushClicked: (e, n) => {\n          if (n) {\n            this.messagingSystem.publish(\n              'NotificationServicesPushController:pushNotificationClicked',\n              n,\n            );\n          }\n\n          this.#config.onPushNotificationClicked(e, n);\n        },\n      });\n    } catch (e) {\n      // Do nothing, we are silently failing if push notification registration fails\n    }\n  }\n\n  /**\n   * Enables push notifications for the application.\n   *\n   * This method sets up the necessary infrastructure for handling push notifications by:\n   * 1. Registering the service worker to listen for messages.\n   * 2. Fetching the Firebase Cloud Messaging (FCM) token from Firebase.\n   * 3. Sending the FCM token to the server responsible for sending notifications, to register the device.\n   *\n   * @param UUIDs - An array of UUIDs to enable push notifications for.\n   * @param fcmToken - The optional FCM token to use for push notifications.\n   */\n  async enablePushNotifications(UUIDs: string[], fcmToken?: string) {\n    if (!this.#config.isPushEnabled) {\n      return;\n    }\n\n    // Handle creating new reg token (if available)\n    try {\n      const bearerToken = await this.#getAndAssertBearerToken().catch(\n        () => null,\n      );\n\n      // If there is a bearer token, lets try to refresh/create new reg token\n      if (bearerToken) {\n        // Activate Push Notifications\n        const regToken = await activatePushNotifications({\n          bearerToken,\n          triggers: UUIDs,\n          env: this.#env,\n          fcmToken,\n          createRegToken,\n          platform: this.#config.platform,\n        }).catch(() => null);\n\n        if (regToken) {\n          this.update((state) => {\n            state.fcmToken = regToken;\n          });\n        }\n      }\n    } catch {\n      // Do nothing, we are silently failing\n    }\n\n    // New token created, (re)subscribe to push notifications\n    await this.subscribeToPushNotifications();\n  }\n\n  /**\n   * Disables push notifications for the application.\n   * This method handles the process of disabling push notifications by:\n   * 1. Unregistering the service worker to stop listening for messages.\n   * 2. Sending a request to the server to unregister the device using the FCM token.\n   * 3. Removing the FCM token from the state to complete the process.\n   *\n   * @param UUIDs - An array of UUIDs for which push notifications should be disabled.\n   */\n  async disablePushNotifications(UUIDs: string[]) {\n    if (!this.#config.isPushEnabled) {\n      return;\n    }\n\n    const bearerToken = await this.#getAndAssertBearerToken();\n    let isPushNotificationsDisabled: boolean;\n\n    try {\n      // Send a request to the server to unregister the token/device\n      isPushNotificationsDisabled = await deactivatePushNotifications({\n        bearerToken,\n        triggers: UUIDs,\n        env: this.#env,\n        deleteRegToken,\n        regToken: this.state.fcmToken,\n      });\n    } catch (error) {\n      const errorMessage = `Failed to disable push notifications: ${\n        error as string\n      }`;\n      log.error(errorMessage);\n      throw new Error(errorMessage);\n    }\n\n    // Remove the FCM token from the state\n    if (!isPushNotificationsDisabled) {\n      return;\n    }\n\n    // Unsubscribe from push notifications\n    this.#pushListenerUnsubscribe?.();\n\n    // Update State\n    if (isPushNotificationsDisabled) {\n      this.update((state) => {\n        state.fcmToken = '';\n      });\n    }\n  }\n\n  /**\n   * Updates the triggers for push notifications.\n   * This method is responsible for updating the server with the new set of UUIDs that should trigger push notifications.\n   * It uses the current FCM token and a BearerToken for authentication.\n   *\n   * @param UUIDs - An array of UUIDs that should trigger push notifications.\n   */\n  async updateTriggerPushNotifications(UUIDs: string[]) {\n    if (!this.#config.isPushEnabled) {\n      return;\n    }\n\n    const bearerToken = await this.#getAndAssertBearerToken();\n\n    try {\n      const { fcmToken } = await updateTriggerPushNotifications({\n        bearerToken,\n        triggers: UUIDs,\n        env: this.#env,\n        createRegToken,\n        deleteRegToken,\n        platform: this.#config.platform,\n        regToken: this.state.fcmToken,\n      });\n\n      // update the state with the new FCM token\n      if (fcmToken) {\n        this.update((state) => {\n          state.fcmToken = fcmToken;\n        });\n      }\n    } catch (error) {\n      const errorMessage = `Failed to update triggers for push notifications: ${\n        error as string\n      }`;\n      log.error(errorMessage);\n      throw new Error(errorMessage);\n    }\n  }\n}\n"]}
+{"version":3,"file":"NotificationServicesPushController.mjs","sourceRoot":"","sources":["../../src/NotificationServicesPushController/NotificationServicesPushController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAMA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,IAAG,iBAAiB;;AAG3B,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,qCAAiC;AAC1E,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,8BAA8B,EAC/B,gCAA4B;AAG7B,MAAM,cAAc,GAAG,oCAAoC,CAAC;AAuE5D,MAAM,CAAC,MAAM,YAAY,GAA4C;IACnE,QAAQ,EAAE,EAAE;CACb,CAAC;AACF,MAAM,QAAQ,GAA2D;IACvE,QAAQ,EAAE;QACR,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;CACF,CAAC;AAgCF;;;;;;;;GAQG;AACH,MAAqB,kCAAmC,SAAQ,cAI/D;IAOC,YAAY,EACV,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,GAMP;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAtBL,sEAAqD,SAAS,EAAC;QAE/D,0DAA0B;QAE1B,6DAA0B;QAoBxB,uBAAA,IAAI,2CAAQ,GAAG,MAAA,CAAC;QAChB,uBAAA,IAAI,8CAAW,MAAM,MAAA,CAAC;QAEtB,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAmCD,KAAK,CAAC,4BAA4B;QAChC,IAAI,uBAAA,IAAI,mEAAyB,EAAE;YACjC,uBAAA,IAAI,mEAAyB,MAA7B,IAAI,CAA2B,CAAC;YAChC,uBAAA,IAAI,+DAA4B,SAAS,MAAA,CAAC;SAC3C;QAED,IAAI;YACF,uBAAA,IAAI,+DAA4B,MAAM,yBAAyB,CAAC;gBAC9D,GAAG,EAAE,uBAAA,IAAI,+CAAK;gBACd,oBAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;oBAChC,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,uDAAuD,EACvD,CAAC,CACF,CAAC;oBACF,MAAM,uBAAA,IAAI,kDAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC;gBACD,mBAAmB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC5B,IAAI,CAAC,EAAE;wBACL,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,4DAA4D,EAC5D,CAAC,CACF,CAAC;qBACH;oBAED,uBAAA,IAAI,kDAAQ,CAAC,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC/C,CAAC;aACF,CAAC,MAAA,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,8EAA8E;SAC/E;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,uBAAuB,CAAC,KAAe,EAAE,QAAiB;QAC9D,IAAI,CAAC,uBAAA,IAAI,kDAAQ,CAAC,aAAa,EAAE;YAC/B,OAAO;SACR;QAED,+CAA+C;QAC/C,IAAI;YACF,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC,KAAK,CAC7D,GAAG,EAAE,CAAC,IAAI,CACX,CAAC;YAEF,uEAAuE;YACvE,IAAI,WAAW,EAAE;gBACf,8BAA8B;gBAC9B,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC;oBAC/C,WAAW;oBACX,QAAQ,EAAE,KAAK;oBACf,GAAG,EAAE,uBAAA,IAAI,+CAAK;oBACd,QAAQ;oBACR,cAAc;oBACd,QAAQ,EAAE,uBAAA,IAAI,kDAAQ,CAAC,QAAQ;iBAChC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;gBAErB,IAAI,QAAQ,EAAE;oBACZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAC5B,CAAC,CAAC,CAAC;iBACJ;aACF;SACF;QAAC,MAAM;YACN,sCAAsC;SACvC;QAED,yDAAyD;QACzD,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAAC,KAAe;QAC5C,IAAI,CAAC,uBAAA,IAAI,kDAAQ,CAAC,aAAa,EAAE;YAC/B,OAAO;SACR;QAED,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC;QAC1D,IAAI,2BAAoC,CAAC;QAEzC,IAAI;YACF,8DAA8D;YAC9D,2BAA2B,GAAG,MAAM,2BAA2B,CAAC;gBAC9D,WAAW;gBACX,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,uBAAA,IAAI,+CAAK;gBACd,cAAc;gBACd,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;aAC9B,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,YAAY,GAAG,yCACnB,KACF,EAAE,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;QAED,sCAAsC;QACtC,IAAI,CAAC,2BAA2B,EAAE;YAChC,OAAO;SACR;QAED,sCAAsC;QACtC,uBAAA,IAAI,mEAAyB,EAAE,KAA/B,IAAI,CAA6B,CAAC;QAElC,eAAe;QACf,IAAI,2BAA2B,EAAE;YAC/B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;YACtB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,8BAA8B,CAAC,KAAe;QAClD,IAAI,CAAC,uBAAA,IAAI,kDAAQ,CAAC,aAAa,EAAE;YAC/B,OAAO;SACR;QAED,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,kHAAyB,MAA7B,IAAI,CAA2B,CAAC;QAE1D,IAAI;YACF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,8BAA8B,CAAC;gBACxD,WAAW;gBACX,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,uBAAA,IAAI,+CAAK;gBACd,cAAc;gBACd,cAAc;gBACd,QAAQ,EAAE,uBAAA,IAAI,kDAAQ,CAAC,QAAQ;gBAC/B,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;aAC9B,CAAC,CAAC;YAEH,0CAA0C;YAC1C,IAAI,QAAQ,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC5B,CAAC,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,YAAY,GAAG,qDACnB,KACF,EAAE,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;SAC/B;IACH,CAAC;CACF;;IAzMG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4DAA4D,EAC5D,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACxC,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,6DAA6D,EAC7D,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CACzC,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,mEAAmE,EACnE,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/C,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,iEAAiE,EACjE,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7C,CAAC;AACJ,CAAC,gEAED,KAAK;IACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACjD,yCAAyC,CAC1C,CAAC;IACF,IAAI,CAAC,WAAW,EAAE;QAChB,GAAG,CAAC,KAAK,CACP,oEAAoE,CACrE,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;eAlEkB,kCAAkC","sourcesContent":["import type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\nimport log from 'loglevel';\n\nimport type { Types } from '../NotificationServicesController';\nimport { createRegToken, deleteRegToken } from './services/push/push-web';\nimport {\n  activatePushNotifications,\n  deactivatePushNotifications,\n  listenToPushNotifications,\n  updateTriggerPushNotifications,\n} from './services/services';\nimport type { PushNotificationEnv } from './types';\n\nconst controllerName = 'NotificationServicesPushController';\n\nexport type NotificationServicesPushControllerState = {\n  fcmToken: string;\n};\n\nexport type NotificationServicesPushControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    NotificationServicesPushControllerState\n  >;\n\nexport type NotificationServicesPushControllerEnablePushNotificationsAction = {\n  type: `${typeof controllerName}:enablePushNotifications`;\n  handler: NotificationServicesPushController['enablePushNotifications'];\n};\nexport type NotificationServicesPushControllerDisablePushNotificationsAction = {\n  type: `${typeof controllerName}:disablePushNotifications`;\n  handler: NotificationServicesPushController['disablePushNotifications'];\n};\nexport type NotificationServicesPushControllerUpdateTriggerPushNotificationsAction =\n  {\n    type: `${typeof controllerName}:updateTriggerPushNotifications`;\n    handler: NotificationServicesPushController['updateTriggerPushNotifications'];\n  };\nexport type NotificationServicesPushControllerSubscribeToNotificationsAction = {\n  type: `${typeof controllerName}:subscribeToPushNotifications`;\n  handler: NotificationServicesPushController['subscribeToPushNotifications'];\n};\n\nexport type Actions =\n  | NotificationServicesPushControllerGetStateAction\n  | NotificationServicesPushControllerEnablePushNotificationsAction\n  | NotificationServicesPushControllerDisablePushNotificationsAction\n  | NotificationServicesPushControllerUpdateTriggerPushNotificationsAction\n  | NotificationServicesPushControllerSubscribeToNotificationsAction;\n\nexport type AllowedActions =\n  AuthenticationController.AuthenticationControllerGetBearerToken;\n\nexport type NotificationServicesPushControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    NotificationServicesPushControllerState\n  >;\n\nexport type NotificationServicesPushControllerOnNewNotificationEvent = {\n  type: `${typeof controllerName}:onNewNotifications`;\n  payload: [Types.INotification];\n};\n\nexport type NotificationServicesPushControllerPushNotificationClickedEvent = {\n  type: `${typeof controllerName}:pushNotificationClicked`;\n  payload: [Types.INotification];\n};\n\nexport type Events =\n  | NotificationServicesPushControllerStateChangeEvent\n  | NotificationServicesPushControllerOnNewNotificationEvent\n  | NotificationServicesPushControllerPushNotificationClickedEvent;\n\nexport type AllowedEvents = never;\n\nexport type NotificationServicesPushControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  Events | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\nexport const defaultState: NotificationServicesPushControllerState = {\n  fcmToken: '',\n};\nconst metadata: StateMetadata<NotificationServicesPushControllerState> = {\n  fcmToken: {\n    persist: true,\n    anonymous: true,\n  },\n};\n\ntype ControllerConfig = {\n  /**\n   * Config to turn on/off push notifications.\n   * This is currently linked to MV3 builds on extension.\n   */\n  isPushEnabled: boolean;\n\n  /**\n   * Must handle when a push notification is received.\n   * You must call `registration.showNotification` or equivalent to show the notification on web/mobile\n   */\n  onPushNotificationReceived: (\n    notification: Types.INotification,\n  ) => void | Promise<void>;\n\n  /**\n   * Must handle when a push notification is clicked.\n   * You must call `event.notification.close();` or equivalent for closing and opening notification in a new window.\n   */\n  onPushNotificationClicked: (\n    event: NotificationEvent,\n    notification?: Types.INotification,\n  ) => void;\n\n  /**\n   * determine the config used for push notification services\n   */\n  platform: 'extension' | 'mobile';\n};\n\n/**\n * Manages push notifications for the application, including enabling, disabling, and updating triggers for push notifications.\n * This controller integrates with Firebase Cloud Messaging (FCM) to handle the registration and management of push notifications.\n * It is responsible for registering and unregistering the service worker that listens for push notifications,\n * managing the FCM token, and communicating with the server to register or unregister the device for push notifications.\n * Additionally, it provides functionality to update the server with new UUIDs that should trigger push notifications.\n *\n * @augments {BaseController<typeof controllerName, NotificationServicesPushControllerState, NotificationServicesPushControllerMessenger>}\n */\nexport default class NotificationServicesPushController extends BaseController<\n  typeof controllerName,\n  NotificationServicesPushControllerState,\n  NotificationServicesPushControllerMessenger\n> {\n  #pushListenerUnsubscribe: (() => void) | undefined = undefined;\n\n  #env: PushNotificationEnv;\n\n  #config: ControllerConfig;\n\n  constructor({\n    messenger,\n    state,\n    env,\n    config,\n  }: {\n    messenger: NotificationServicesPushControllerMessenger;\n    state: NotificationServicesPushControllerState;\n    env: PushNotificationEnv;\n    config: ControllerConfig;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    this.#env = env;\n    this.#config = config;\n\n    this.#registerMessageHandlers();\n  }\n\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:enablePushNotifications',\n      this.enablePushNotifications.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:disablePushNotifications',\n      this.disablePushNotifications.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:updateTriggerPushNotifications',\n      this.updateTriggerPushNotifications.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      'NotificationServicesPushController:subscribeToPushNotifications',\n      this.subscribeToPushNotifications.bind(this),\n    );\n  }\n\n  async #getAndAssertBearerToken() {\n    const bearerToken = await this.messagingSystem.call(\n      'AuthenticationController:getBearerToken',\n    );\n    if (!bearerToken) {\n      log.error(\n        'Failed to enable push notifications: BearerToken token is missing.',\n      );\n      throw new Error('BearerToken token is missing');\n    }\n\n    return bearerToken;\n  }\n\n  async subscribeToPushNotifications() {\n    if (this.#pushListenerUnsubscribe) {\n      this.#pushListenerUnsubscribe();\n      this.#pushListenerUnsubscribe = undefined;\n    }\n\n    try {\n      this.#pushListenerUnsubscribe = await listenToPushNotifications({\n        env: this.#env,\n        listenToPushReceived: async (n) => {\n          this.messagingSystem.publish(\n            'NotificationServicesPushController:onNewNotifications',\n            n,\n          );\n          await this.#config.onPushNotificationReceived(n);\n        },\n        listenToPushClicked: (e, n) => {\n          if (n) {\n            this.messagingSystem.publish(\n              'NotificationServicesPushController:pushNotificationClicked',\n              n,\n            );\n          }\n\n          this.#config.onPushNotificationClicked(e, n);\n        },\n      });\n    } catch (e) {\n      // Do nothing, we are silently failing if push notification registration fails\n    }\n  }\n\n  /**\n   * Enables push notifications for the application.\n   *\n   * This method sets up the necessary infrastructure for handling push notifications by:\n   * 1. Registering the service worker to listen for messages.\n   * 2. Fetching the Firebase Cloud Messaging (FCM) token from Firebase.\n   * 3. Sending the FCM token to the server responsible for sending notifications, to register the device.\n   *\n   * @param UUIDs - An array of UUIDs to enable push notifications for.\n   * @param fcmToken - The optional FCM token to use for push notifications.\n   */\n  async enablePushNotifications(UUIDs: string[], fcmToken?: string) {\n    if (!this.#config.isPushEnabled) {\n      return;\n    }\n\n    // Handle creating new reg token (if available)\n    try {\n      const bearerToken = await this.#getAndAssertBearerToken().catch(\n        () => null,\n      );\n\n      // If there is a bearer token, lets try to refresh/create new reg token\n      if (bearerToken) {\n        // Activate Push Notifications\n        const regToken = await activatePushNotifications({\n          bearerToken,\n          triggers: UUIDs,\n          env: this.#env,\n          fcmToken,\n          createRegToken,\n          platform: this.#config.platform,\n        }).catch(() => null);\n\n        if (regToken) {\n          this.update((state) => {\n            state.fcmToken = regToken;\n          });\n        }\n      }\n    } catch {\n      // Do nothing, we are silently failing\n    }\n\n    // New token created, (re)subscribe to push notifications\n    await this.subscribeToPushNotifications();\n  }\n\n  /**\n   * Disables push notifications for the application.\n   * This method handles the process of disabling push notifications by:\n   * 1. Unregistering the service worker to stop listening for messages.\n   * 2. Sending a request to the server to unregister the device using the FCM token.\n   * 3. Removing the FCM token from the state to complete the process.\n   *\n   * @param UUIDs - An array of UUIDs for which push notifications should be disabled.\n   */\n  async disablePushNotifications(UUIDs: string[]) {\n    if (!this.#config.isPushEnabled) {\n      return;\n    }\n\n    const bearerToken = await this.#getAndAssertBearerToken();\n    let isPushNotificationsDisabled: boolean;\n\n    try {\n      // Send a request to the server to unregister the token/device\n      isPushNotificationsDisabled = await deactivatePushNotifications({\n        bearerToken,\n        triggers: UUIDs,\n        env: this.#env,\n        deleteRegToken,\n        regToken: this.state.fcmToken,\n      });\n    } catch (error) {\n      const errorMessage = `Failed to disable push notifications: ${\n        error as string\n      }`;\n      log.error(errorMessage);\n      throw new Error(errorMessage);\n    }\n\n    // Remove the FCM token from the state\n    if (!isPushNotificationsDisabled) {\n      return;\n    }\n\n    // Unsubscribe from push notifications\n    this.#pushListenerUnsubscribe?.();\n\n    // Update State\n    if (isPushNotificationsDisabled) {\n      this.update((state) => {\n        state.fcmToken = '';\n      });\n    }\n  }\n\n  /**\n   * Updates the triggers for push notifications.\n   * This method is responsible for updating the server with the new set of UUIDs that should trigger push notifications.\n   * It uses the current FCM token and a BearerToken for authentication.\n   *\n   * @param UUIDs - An array of UUIDs that should trigger push notifications.\n   */\n  async updateTriggerPushNotifications(UUIDs: string[]) {\n    if (!this.#config.isPushEnabled) {\n      return;\n    }\n\n    const bearerToken = await this.#getAndAssertBearerToken();\n\n    try {\n      const { fcmToken } = await updateTriggerPushNotifications({\n        bearerToken,\n        triggers: UUIDs,\n        env: this.#env,\n        createRegToken,\n        deleteRegToken,\n        platform: this.#config.platform,\n        regToken: this.state.fcmToken,\n      });\n\n      // update the state with the new FCM token\n      if (fcmToken) {\n        this.update((state) => {\n          state.fcmToken = fcmToken;\n        });\n      }\n    } catch (error) {\n      const errorMessage = `Failed to update triggers for push notifications: ${\n        error as string\n      }`;\n      log.error(errorMessage);\n      throw new Error(errorMessage);\n    }\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/notification-services-controller",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Manages New MetaMask decentralized Notification system",
   "keywords": [
     "MetaMask",
@@ -101,8 +101,8 @@
   "dependencies": {
     "@contentful/rich-text-html-renderer": "^16.5.2",
     "@metamask/base-controller": "^7.1.1",
-    "@metamask/controller-utils": "^11.4.5",
-    "@metamask/utils": "^11.0.1",
+    "@metamask/controller-utils": "^11.5.0",
+    "@metamask/utils": "^11.1.0",
     "bignumber.js": "^9.1.2",
     "firebase": "^11.2.0",
     "loglevel": "^1.8.1",
@@ -113,7 +113,7 @@
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/keyring-controller": "^19.0.5",
-    "@metamask/profile-sync-controller": "^5.0.0",
+    "@metamask/profile-sync-controller": "^6.0.0",
     "@types/jest": "^27.4.1",
     "@types/readable-stream": "^2.3.0",
     "contentful": "^10.15.0",
@@ -128,7 +128,7 @@
   },
   "peerDependencies": {
     "@metamask/keyring-controller": "^19.0.0",
-    "@metamask/profile-sync-controller": "^5.0.0"
+    "@metamask/profile-sync-controller": "^6.0.0"
   },
   "engines": {
     "node": "^18.18 || >=20"