all files / firebase/modules/notifications/ index.js

57.58% Statements 38/66
21.43% Branches 6/28
59.09% Functions 13/22
57.58% Lines 38/66
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
/**
 * @flow
 * Notifications representation wrapper
 */
import { SharedEventEmitter } from '../../utils/events';
import { getLogger } from '../../utils/log';
import ModuleBase from '../../utils/ModuleBase';
import { getNativeModule } from '../../utils/native';
import { isFunction, isObject } from '../../utils';
import AndroidAction from './AndroidAction';
import AndroidChannel from './AndroidChannel';
import AndroidChannelGroup from './AndroidChannelGroup';
import AndroidNotifications from './AndroidNotifications';
import AndroidRemoteInput from './AndroidRemoteInput';
import Notification from './Notification';
import {
  BadgeIconType,
  Category,
  Defaults,
  GroupAlert,
  Importance,
  Priority,
  SemanticAction,
  Visibility,
} from './types';
 
import type App from '../core/app';
import type { NotificationOpen } from './Notification';
import type {
  NativeNotification,
  NativeNotificationOpen,
  Schedule,
} from './types';
 
type OnNotification = Notification => any;
 
type OnNotificationObserver = {
  next: OnNotification,
};
 
type OnNotificationOpened = NotificationOpen => any;
 
type OnNotificationOpenedObserver = {
  next: NotificationOpen,
};
 
const NATIVE_EVENTS = [
  'notifications_notification_displayed',
  'notifications_notification_opened',
  'notifications_notification_received',
];
 
export const MODULE_NAME = 'RNFirebaseNotifications';
export const NAMESPACE = 'notifications';
 
// iOS 8/9 scheduling
// fireDate: Date;
// timeZone: TimeZone;
// repeatInterval: NSCalendar.Unit;
// repeatCalendar: Calendar;
// region: CLRegion;
// regionTriggersOnce: boolean;
 
// iOS 10 scheduling
// TODO
 
// Android scheduling
// TODO
 
/**
 * @class Notifications
 */
export default class Notifications extends ModuleBase {
  _android: AndroidNotifications;
 
  constructor(app: App) {
    super(app, {
      events: NATIVE_EVENTS,
      moduleName: MODULE_NAME,
      multiApp: false,
      namespace: NAMESPACE,
    });
    this._android = new AndroidNotifications(this);
 
    SharedEventEmitter.addListener(
      // sub to internal native event - this fans out to
      // public event name: onNotificationDisplayed
      'notifications_notification_displayed',
      (notification: NativeNotification) => {
        SharedEventEmitter.emit(
          'onNotificationDisplayed',
          new Notification(notification)
        );
      }
    );
 
    SharedEventEmitter.addListener(
      // sub to internal native event - this fans out to
      // public event name: onNotificationOpened
      'notifications_notification_opened',
      (notificationOpen: NativeNotificationOpen) => {
        SharedEventEmitter.emit('onNotificationOpened', {
          action: notificationOpen.action,
          notification: new Notification(notificationOpen.notification),
          results: notificationOpen.results,
        });
      }
    );
 
    SharedEventEmitter.addListener(
      // sub to internal native event - this fans out to
      // public event name: onNotification
      'notifications_notification_received',
      (notification: NativeNotification) => {
        SharedEventEmitter.emit(
          'onNotification',
          new Notification(notification)
        );
      }
    );
  }
 
  get android(): AndroidNotifications {
    return this._android;
  }
 
  /**
   * Cancel all notifications
   */
  cancelAllNotifications(): void {
    getNativeModule(this).cancelAllNotifications();
  }
 
  /**
   * Cancel a notification by id.
   * @param notificationId
   */
  cancelNotification(notificationId: string): void {
    if (!notificationId) {
      throw new Error(
        'Notifications: cancelNotification expects a `notificationId`'
      );
    }
    getNativeModule(this).cancelNotification(notificationId);
  }
 
  /**
   * Display a notification
   * @param notification
   * @returns {*}
   */
  displayNotification(notification: Notification): Promise<void> {
    Iif (!(notification instanceof Notification)) {
      throw new Error(
        `Notifications:displayNotification expects a 'Notification' but got type ${typeof notification}`
      );
    }
    return getNativeModule(this).displayNotification(notification.build());
  }
 
  getBadge(): Promise<number> {
    return getNativeModule(this).getBadge();
  }
 
  getInitialNotification(): Promise<NotificationOpen> {
    return getNativeModule(this)
      .getInitialNotification()
      .then((notificationOpen: NativeNotificationOpen) => {
        Iif (notificationOpen) {
          return {
            action: notificationOpen.action,
            notification: new Notification(notificationOpen.notification),
            results: notificationOpen.results,
          };
        }
        return null;
      });
  }
 
  /**
   * Returns an array of all scheduled notifications
   * @returns {Promise.<Array>}
   */
  getScheduledNotifications(): Promise<Notification[]> {
    return getNativeModule(this).getScheduledNotifications();
  }
 
  onNotification(
    nextOrObserver: OnNotification | OnNotificationObserver
  ): () => any {
    let listener;
    Eif (isFunction(nextOrObserver)) {
      listener = nextOrObserver;
    } else if (isObject(nextOrObserver) && isFunction(nextOrObserver.next)) {
      listener = nextOrObserver.next;
    } else {
      throw new Error(
        'Notifications.onNotification failed: First argument must be a function or observer object with a `next` function.'
      );
    }
 
    getLogger(this).info('Creating onNotification listener');
    SharedEventEmitter.addListener('onNotification', listener);
 
    return () => {
      getLogger(this).info('Removing onNotification listener');
      SharedEventEmitter.removeListener('onNotification', listener);
    };
  }
 
  onNotificationDisplayed(
    nextOrObserver: OnNotification | OnNotificationObserver
  ): () => any {
    let listener;
    Eif (isFunction(nextOrObserver)) {
      listener = nextOrObserver;
    } else if (isObject(nextOrObserver) && isFunction(nextOrObserver.next)) {
      listener = nextOrObserver.next;
    } else {
      throw new Error(
        'Notifications.onNotificationDisplayed failed: First argument must be a function or observer object with a `next` function.'
      );
    }
 
    getLogger(this).info('Creating onNotificationDisplayed listener');
    SharedEventEmitter.addListener('onNotificationDisplayed', listener);
 
    return () => {
      getLogger(this).info('Removing onNotificationDisplayed listener');
      SharedEventEmitter.removeListener('onNotificationDisplayed', listener);
    };
  }
 
  onNotificationOpened(
    nextOrObserver: OnNotificationOpened | OnNotificationOpenedObserver
  ): () => any {
    let listener;
    Eif (isFunction(nextOrObserver)) {
      listener = nextOrObserver;
    } else if (isObject(nextOrObserver) && isFunction(nextOrObserver.next)) {
      listener = nextOrObserver.next;
    } else {
      throw new Error(
        'Notifications.onNotificationOpened failed: First argument must be a function or observer object with a `next` function.'
      );
    }
 
    getLogger(this).info('Creating onNotificationOpened listener');
    SharedEventEmitter.addListener('onNotificationOpened', listener);
 
    return () => {
      getLogger(this).info('Removing onNotificationOpened listener');
      SharedEventEmitter.removeListener('onNotificationOpened', listener);
    };
  }
 
  /**
   * Remove all delivered notifications.
   */
  removeAllDeliveredNotifications(): void {
    getNativeModule(this).removeAllDeliveredNotifications();
  }
 
  /**
   * Remove a delivered notification.
   * @param notificationId
   */
  removeDeliveredNotification(notificationId: string): void {
    if (!notificationId) {
      throw new Error(
        'Notifications: removeDeliveredNotification expects a `notificationId`'
      );
    }
    getNativeModule(this).removeDeliveredNotification(notificationId);
  }
 
  /**
   * Schedule a notification
   * @param notification
   * @returns {*}
   */
  scheduleNotification(
    notification: Notification,
    schedule: Schedule
  ): Promise<void> {
    Iif (!(notification instanceof Notification)) {
      throw new Error(
        `Notifications:scheduleNotification expects a 'Notification' but got type ${typeof notification}`
      );
    }
    const nativeNotification = notification.build();
    nativeNotification.schedule = schedule;
    return getNativeModule(this).scheduleNotification(nativeNotification);
  }
 
  setBadge(badge: number): void {
    getNativeModule(this).setBadge(badge);
  }
}
 
export const statics = {
  Android: {
    Action: AndroidAction,
    BadgeIconType,
    Category,
    Channel: AndroidChannel,
    ChannelGroup: AndroidChannelGroup,
    Defaults,
    GroupAlert,
    Importance,
    Priority,
    RemoteInput: AndroidRemoteInput,
    SemanticAction,
    Visibility,
  },
  Notification,
};