@trycourier/courier-react-native 2.0.0-beta1 → 2.0.0-beta3

package/src/index.tsx

@@ -3,11 +3,21 @@ import {
   NativeEventEmitter,
   EmitterSubscription,
   Platform,
+  DeviceEventEmitter,
 } from 'react-native';
 
+// Imports
 import { CourierInboxListener } from './models/CourierInboxListener';
+import { CourierPushListener } from './models/CourierPushListener';
+import { CourierAuthenticationListener } from './models/CourierAuthenticationListener';
 import { InboxMessage } from './models/InboxMessage';
+
+// Exports
 export { CourierInboxView } from './views/CourierInboxView';
+export { CourierProvider, useCourier } from './hooks/useCourier';
+export { CourierInboxListener } from './models/CourierInboxListener';
+export { CourierPushListener } from './models/CourierPushListener';
+export { CourierAuthenticationListener } from './models/CourierAuthenticationListener';
 
 const LINKING_ERROR =
   `The package '@trycourier/courier-react-native' doesn't seem to be linked. Make sure: \n\n` +
@@ -32,6 +42,9 @@ const CourierEventEmitter = new NativeEventEmitter(
 
 class Courier {
 
+  readonly PUSH_NOTIFICATION_CLICKED = 'pushNotificationClicked';
+  readonly PUSH_NOTIFICATION_DELIVERED = 'pushNotificationDelivered';
+
   private static _sharedInstance: Courier;
   private _isDebugging = false;
   private debugListener: EmitterSubscription | undefined;
@@ -56,16 +69,8 @@ class Courier {
   }
 
   private async setDefaults() {
-    try {
-      await Promise.all([
-        this.setIsDebugging(__DEV__),
-        // this.iOSForegroundPresentationOptions({
-        //   options: ['sound', 'badge', 'list', 'banner'],
-        // }),
-      ]);
-    } catch (error) {
-      console.log(error);
-    }
+    this.setIsDebugging(__DEV__);
+    this.iOSForegroundPresentationOptions({ options: ['sound', 'badge', 'list', 'banner'] });
   }
 
   /**
@@ -73,7 +78,7 @@ class Courier {
    * Defaults to the React __DEV__ mode
    * @example Courier.setIsDebugging(true)
    */
-  public async setIsDebugging(isDebugging: boolean): Promise<boolean> {
+  public setIsDebugging(isDebugging: boolean): boolean {
 
     // Remove the existing listener if needed
     this.debugListener?.remove();
@@ -86,7 +91,9 @@ class Courier {
       });
     }
 
-    this._isDebugging = await CourierReactNativeModules.setDebugMode(isDebugging);
+    CourierReactNativeModules.setDebugMode(isDebugging);
+
+    this._isDebugging = isDebugging
 
     return this._isDebugging;
 
@@ -96,12 +103,143 @@ class Courier {
     return this._isDebugging;
   }
 
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public iOSForegroundPresentationOptions(props: { options: ('sound' | 'badge' | 'list' | 'banner')[] }): string {
+
+    // Only works on iOS
+    if (Platform.OS !== 'ios') return 'unsupported';
+
+    const normalizedParams = Array.from(new Set(props.options));
+    return CourierReactNativeModules.iOSForegroundPresentationOptions({
+      options: normalizedParams,
+    });
+
+  }
+
+  /**
+   * Sets the current Apple Push Notification Service (APNS) token
+   * using Courier token management apis
+   * @example const apnsToken = await Courier.apnsToken
+   */
+   get apnsToken(): string | undefined {
+    if (Platform.OS !== 'ios') return undefined;
+    return CourierReactNativeModules.getApnsToken();
+  }
+
+  /**
+   * Sets the current Firebase Cloud Messaging (FCM) token
+   * using Courier token management apis
+   * @example const fcmToken = await Courier.fcmToken
+   */
+  get fcmToken(): string | undefined {
+    return CourierReactNativeModules.getFcmToken();
+  }
+
+  /**
+   * Sets the current Firebase Cloud Messaging (FCM) token
+   * using Courier token management apis
+   * @example await setFcmToken('asdf...asdf')
+   */
+  public setFcmToken(props: { token: string }): Promise<void> {
+    return CourierReactNativeModules.setFcmToken(props.token);
+  }
+
+  /**
+   * Gets notification permission status at a system level.
+   * @example const permissionStatus = await Courier.getNotificationPermissionStatus()
+   */
+  public getNotificationPermissionStatus(): Promise<string> {
+    return CourierReactNativeModules.getNotificationPermissionStatus();
+  }
+
+  /**
+   * Requests notification permission status at a system level.
+   * Returns the string associated with the permission status.
+   * Will return the current status and will not present a popup
+   * if the user has already been asked for permission.
+   * @example const permissionStatus = await Courier.requestNotificationPermission()
+   */
+  public requestNotificationPermission(): Promise<string> {
+    return CourierReactNativeModules.requestNotificationPermission();
+  }
+
+  /**
+   * @example 
+  TODO
+  * @returns  function that can be used to unsubscribe from registered listeners
+  */
+  public addPushNotificationListener(props: { onPushNotificationClicked?: (push: any) => void, onPushNotificationDelivered?: (push: any) => void }): CourierPushListener {
+    
+    const pushListener = new CourierPushListener();
+
+    if (Platform.OS === 'android') {
+
+      if (props.onPushNotificationClicked) {
+        pushListener.onNotificationClickedListener = DeviceEventEmitter.addListener(this.PUSH_NOTIFICATION_CLICKED, (event: any) => {
+          try {
+            props.onPushNotificationClicked!(JSON.parse(event));
+          } catch (error) {
+            console.log(error);
+          }
+        });
+      }
+
+      if (props.onPushNotificationDelivered) {
+        pushListener.onNotificationDeliveredListener = DeviceEventEmitter.addListener(this.PUSH_NOTIFICATION_DELIVERED, (event: any) => {
+          try {
+            props.onPushNotificationDelivered!(JSON.parse(event));
+          } catch (error) {
+            console.log(error);
+          }
+        });
+      }
+
+    }
+
+    if (Platform.OS === 'ios') {
+
+      if (props.onPushNotificationClicked) {
+        pushListener.onNotificationClickedListener = CourierEventEmitter.addListener(this.PUSH_NOTIFICATION_CLICKED, (event: any) => {
+          try {
+            props.onPushNotificationClicked!(JSON.parse(event));
+          } catch (error) {
+            console.log(error);
+          }
+        });
+      }
+
+      if (props.onPushNotificationDelivered) {
+        pushListener.onNotificationDeliveredListener = CourierEventEmitter.addListener(this.PUSH_NOTIFICATION_DELIVERED, (event: any) => {
+          try {
+            props.onPushNotificationDelivered!(JSON.parse(event));
+          } catch (error) {
+            console.log(error);
+          }
+        });
+      }
+
+    }
+
+    // When listener is registered
+    // Attempt to fetch the last message that was clicked
+    // This is needed for when the app is killed and the
+    // user launched the app by clicking on a notifications
+    CourierReactNativeModules.registerPushNotificationClickedOnKilledState();
+
+    return pushListener
+
+  }
+
   /**
    * Returns the current user id stored in local native storage
    * @example const userId = await Courier.userId
    */
-  get userId(): Promise<string | undefined> {
-    return CourierReactNativeModules.getUserId();
+  get userId(): string | undefined {
+    return CourierReactNativeModules.getUserId() ?? undefined
   }
 
   /**
@@ -124,6 +262,43 @@ class Courier {
     return CourierReactNativeModules.signIn(props.accessToken, props.clientKey ?? null, props.userId);
   }
 
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+   public signOut(): Promise<void> {
+    return CourierReactNativeModules.signOut();
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+   public addAuthenticationListener(props: { onUserChanged: (userId?: string) => void }): CourierAuthenticationListener {
+
+    const authListener = new CourierAuthenticationListener();
+
+    authListener.onUserChanged = CourierEventEmitter.addListener('courierAuthUserChanged', event => {
+      props.onUserChanged(event)
+    });
+
+    authListener.listenerId = CourierReactNativeModules.addAuthenticationListener();
+
+    return authListener;
+
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public removeAuthenticationListener(props: { listenerId: string }): string {
+    return CourierReactNativeModules.removeAuthenticationListener(props.listenerId);
+  }
+
   /**
    * TODO
    * @param props 
@@ -184,7 +359,7 @@ class Courier {
       });
     }
 
-    inboxListener.listenerId = CourierReactNativeModules.addInboxListener(null);
+    inboxListener.listenerId = CourierReactNativeModules.addInboxListener();
 
     return inboxListener;
 
@@ -207,6 +382,24 @@ class Courier {
   public async refreshInbox(): Promise<void> {
     return CourierReactNativeModules.refreshInbox();
   }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+   public async fetchNextPageOfMessages(): Promise<InboxMessage[]> {
+    return CourierReactNativeModules.fetchNextPageOfMessages();
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+   public setInboxPaginationLimit(props: { limit: number }): void {
+    CourierReactNativeModules.setInboxPaginationLimit(props.limit);
+  }
   
 }
 

package/src/models/CourierAuthenticationListener.tsx

@@ -0,0 +1,19 @@
+import { EmitterSubscription } from "react-native";
+import Courier from "..";
+
+export class CourierAuthenticationListener {
+
+  public listenerId?: string
+  public onUserChanged?: EmitterSubscription
+
+  public remove() {
+
+    if (this.listenerId) {
+      Courier.shared.removeInboxListener({ listenerId: this.listenerId });
+    }
+
+    this.onUserChanged?.remove();
+    
+  }
+
+}

package/src/models/CourierPushListener.tsx

@@ -0,0 +1,13 @@
+import { EmitterSubscription } from "react-native";
+
+export class CourierPushListener {
+
+  public onNotificationClickedListener?: EmitterSubscription
+  public onNotificationDeliveredListener?: EmitterSubscription
+
+  public remove() {
+    this.onNotificationClickedListener?.remove();
+    this.onNotificationDeliveredListener?.remove();
+  }
+
+}

package/src/views/CourierInboxView.tsx

@@ -5,8 +5,10 @@ import { InboxAction } from "src/models/InboxAction";
 import { InboxMessage } from "src/models/InboxMessage";
 
 type CourierInboxViewProps = {
-  lightTheme?: CourierInboxTheme;
-  darkTheme?: CourierInboxTheme;
+  theme?: { 
+    light?: CourierInboxTheme, 
+    dark?: CourierInboxTheme 
+  };
   onClickInboxMessageAtIndex?: (message: InboxMessage, index: number) => void;
   onClickInboxActionForMessageAtIndex?: (action: InboxAction, message: InboxMessage, index: number) => void;
   onScrollInbox?: (offsetY: number, offsetX: number) => void;
@@ -73,8 +75,7 @@ export const CourierInboxView = (props: CourierInboxViewProps) => {
 
   return (
     <CourierInbox 
-      lightTheme={props.lightTheme} 
-      darkTheme={props.darkTheme}
+      theme={props.theme ?? { light: undefined, dark: undefined }} 
       onClickInboxMessageAtIndex={onClickInboxMessageAtIndex}
       onClickInboxActionForMessageAtIndex={onClickInboxActionForMessageAtIndex}
       onScrollInbox={onScrollInbox}