packages/shared/lib/helpers/desktopNotification.ts

   1 import noop from '@proton/utils/noop';
   2
   3 import type { ElectronNotification } from '../desktop/desktopTypes';
   4 import { invokeInboxDesktopIPC } from '../desktop/ipcHelpers';
   5
   6 export enum Status {
   7     DENIED = 'denied',
   8     DEFAULT = 'default',
   9     GRANTED = 'granted',
  10 }
  11
  12 let notifications: Notification[] = [];
  13
  14 export const hasNotificationSupport = (): boolean => 'Notification' in window;
  15 export const hasPermission = (): boolean => Notification.permission === Status.GRANTED;
  16 export const hasDenied = (): boolean => Notification.permission === Status.DENIED;
  17
  18 const addNotification = (notification: Notification) => {
  19     notifications.push(notification);
  20 };
  21
  22 const removeNotification = (notification: Notification) => {
  23     notifications = notifications.filter((n) => n !== notification);
  24 };
  25
  26 const setupNotificationHandlers = (notification: Notification, onClick?: () => void) => {
  27     notification.onclose = () => removeNotification(notification);
  28     notification.onclick = () => {
  29         onClick?.();
  30         notification.close();
  31     };
  32 };
  33
  34 export const getStatus = (): Status => {
  35     if (!hasNotificationSupport()) {
  36         return Status.DEFAULT;
  37     }
  38
  39     if (hasPermission()) {
  40         return Status.GRANTED;
  41     }
  42
  43     if (hasDenied()) {
  44         return Status.DENIED;
  45     }
  46
  47     return Status.DEFAULT;
  48 };
  49
  50 export const isEnabled = (): boolean => {
  51     if (hasNotificationSupport()) {
  52         return hasPermission();
  53     }
  54     return false;
  55 };
  56
  57 export const clear = () => {
  58     notifications.forEach((notification) => notification.close());
  59     notifications = [];
  60 };
  61
  62 export const request = async (onGranted: () => void = noop, onDenied: () => void = noop) => {
  63     if (!hasNotificationSupport() || hasDenied()) {
  64         onDenied();
  65         return;
  66     }
  67
  68     if (hasPermission()) {
  69         onGranted();
  70         return;
  71     }
  72
  73     const permission = await Notification.requestPermission();
  74
  75     if (permission === Status.GRANTED) {
  76         onGranted();
  77     } else {
  78         onDenied();
  79     }
  80 };
  81
  82 const createWebNotification = (title: string, options?: NotificationOptions, onClick?: () => void) => {
  83     if (!isEnabled()) {
  84         return;
  85     }
  86
  87     const notification = new Notification(title, options);
  88
  89     addNotification(notification);
  90
  91     setupNotificationHandlers(notification, onClick);
  92
  93     return notification;
  94 };
  95
  96 export const createElectronNotification = (payload: ElectronNotification) => {
  97     return invokeInboxDesktopIPC({ type: 'showNotification', payload });
  98 };
  99
 100 interface NotificationParams extends NotificationOptions {
 101     onClick?: () => void;
 102 }
 103
 104 export const create = async (title = '', params: NotificationParams = {}) => {
 105     await request();
 106     if (!isEnabled()) {
 107         return; // Exit if permission wasn't granted
 108     }
 109
 110     return createWebNotification(title, params, params.onClick);
 111 };