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

package/src/index.tsx

@@ -0,0 +1,213 @@
+import {
+  NativeModules,
+  NativeEventEmitter,
+  EmitterSubscription,
+  Platform,
+} from 'react-native';
+
+import { CourierInboxListener } from './models/CourierInboxListener';
+import { InboxMessage } from './models/InboxMessage';
+export { CourierInboxView } from './views/CourierInboxView';
+
+const LINKING_ERROR =
+  `The package '@trycourier/courier-react-native' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n';
+
+const CourierReactNativeModules = NativeModules.CourierReactNativeModule
+  ? NativeModules.CourierReactNativeModule
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
+
+const CourierEventEmitter = new NativeEventEmitter(
+  NativeModules.CourierReactNativeModule
+);
+
+class Courier {
+
+  private static _sharedInstance: Courier;
+  private _isDebugging = false;
+  private debugListener: EmitterSubscription | undefined;
+
+  public constructor() {
+
+    // Sets the initial SDK values
+    // Defaults to React Native level debugging
+    // and will show all foreground notification styles in iOS
+    this.setDefaults();
+  }
+
+  // Returns the public shared instance
+  public static get shared(): Courier {
+
+    if (!this._sharedInstance) {
+      this._sharedInstance = new Courier();
+    }
+
+    return this._sharedInstance;
+
+  }
+
+  private async setDefaults() {
+    try {
+      await Promise.all([
+        this.setIsDebugging(__DEV__),
+        // this.iOSForegroundPresentationOptions({
+        //   options: ['sound', 'badge', 'list', 'banner'],
+        // }),
+      ]);
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  /**
+   * Tells native Courier SDKs to show or hide logs.
+   * Defaults to the React __DEV__ mode
+   * @example Courier.setIsDebugging(true)
+   */
+  public async setIsDebugging(isDebugging: boolean): Promise<boolean> {
+
+    // Remove the existing listener if needed
+    this.debugListener?.remove();
+
+    // Set a new listener
+    // listener needs to be registered first to catch the event
+    if (isDebugging) {
+      this.debugListener = CourierEventEmitter.addListener('courierDebugEvent', event => {
+        console.log('\x1b[36m%s\x1b[0m', 'COURIER', event);
+      });
+    }
+
+    this._isDebugging = await CourierReactNativeModules.setDebugMode(isDebugging);
+
+    return this._isDebugging;
+
+  }
+
+  get isDebugging(): boolean {
+    return this._isDebugging;
+  }
+
+  /**
+   * Returns the current user id stored in local native storage
+   * @example const userId = await Courier.userId
+   */
+  get userId(): Promise<string | undefined> {
+    return CourierReactNativeModules.getUserId();
+  }
+
+  /**
+   * Signs user in and persists signin in between sessions
+   * using native level storage apis
+   * 
+   * @example
+   * ```
+   *await Courier.signIn({
+      accessToken: YOUR_COURIER_GENERATED_JWT,
+      clientKey: YOUR_CLIENT_KEY,
+      userId: YOUR_USER_ID,
+    })
+   * ```
+   * Your access token should be generated using this endpoint
+   * that is requested from your backend
+   * https://www.courier.com/docs/reference/auth/issue-token/
+   */
+  public signIn(props: { accessToken: string, clientKey?: string, userId: string }): Promise<void> {
+    return CourierReactNativeModules.signIn(props.accessToken, props.clientKey ?? null, props.userId);
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public readMessage(props: { messageId: string }): Promise<void> {
+    return CourierReactNativeModules.readMessage(props.messageId);
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public unreadMessage(props: { messageId: string }): Promise<void> {
+    return CourierReactNativeModules.unreadMessage(props.messageId);
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public readAllInboxMessages(): Promise<void> {
+    return CourierReactNativeModules.readAllInboxMessages();
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public addInboxListener(props: { onInitialLoad?: () => void, onError?: (error: string) => void, onMessagesChanged?: (messages: InboxMessage[], unreadMessageCount: number, totalMessageCount: number, canPaginate: boolean) => void }): CourierInboxListener {
+
+    // Create the initial listeners
+    const inboxListener = new CourierInboxListener();
+
+    if (props.onInitialLoad) {
+      inboxListener.onInitialLoad = CourierEventEmitter.addListener('inboxInitialLoad', () => {
+        props.onInitialLoad!()
+      });
+    }
+
+    if (props.onError) {
+      inboxListener.onError = CourierEventEmitter.addListener('inboxError', event => {
+        props.onError!(event)
+      });
+    }
+
+    if (props.onMessagesChanged) {
+      inboxListener.onMessagesChanged = CourierEventEmitter.addListener('inboxMessagesChanged', event => {
+        props.onMessagesChanged!(
+          event.messages,
+          event.unreadMessageCount,
+          event.totalMessageCount,
+          event.canPaginate,
+        )
+      });
+    }
+
+    inboxListener.listenerId = CourierReactNativeModules.addInboxListener(null);
+
+    return inboxListener;
+
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public removeInboxListener(props: { listenerId: string }): string {
+    return CourierReactNativeModules.removeInboxListener(props.listenerId);
+  }
+
+  /**
+   * TODO
+   * @param props 
+   * @returns 
+   */
+  public async refreshInbox(): Promise<void> {
+    return CourierReactNativeModules.refreshInbox();
+  }
+  
+}
+
+export default Courier;

package/src/models/CourierInboxListener.tsx

@@ -0,0 +1,25 @@
+import { EmitterSubscription } from "react-native";
+import Courier from "@trycourier/courier-react-native";
+
+export class CourierInboxListener {
+
+  public listenerId?: string
+  public onInitialLoad?: EmitterSubscription
+  public onError?: EmitterSubscription
+  public onMessagesChanged?: EmitterSubscription
+
+  public remove() {
+
+    // Remove the native inbox listener
+    if (this.listenerId) {
+      Courier.shared.removeInboxListener({ listenerId: this.listenerId });
+    }
+
+    // Remove the emitters
+    this.onInitialLoad?.remove();
+    this.onError?.remove();
+    this.onMessagesChanged?.remove();
+
+  }
+
+}

package/src/models/CourierInboxTheme.tsx

@@ -0,0 +1,30 @@
+export interface CourierInboxFont {
+  family?: string
+  size?: number
+  color?: string
+}
+
+export interface CourierInboxButtonStyles {
+  font?: CourierInboxFont
+  backgroundColor?: string
+  cornerRadius?: number
+}
+
+export default interface CourierInboxTheme {
+  unreadIndicatorBarColor?: string
+  loadingIndicatorColor?: string
+  titleFont?: CourierInboxFont
+  timeFont?: CourierInboxFont
+  bodyFont?: CourierInboxFont
+  detailTitleFont?: CourierInboxFont
+  buttonStyles?: CourierInboxButtonStyles
+  iOS?: {
+    messageAnimationStyle?: 'fade' | 'right' | 'left' | 'top' | 'bottom' | 'none' | 'middle' | 'automatic',
+    cellStyles?: {
+      separatorStyle?: 'none' | 'singleLine' | 'singleLineEtched',
+      separatorInsets?: { top?: number, left?: number, bottom?: number, right?: number },
+      separatorColor?: string,
+      selectionStyle?: 'none' | 'blue' | 'gray' | 'default'
+    }
+  }
+}

package/src/models/InboxAction.tsx

@@ -0,0 +1,5 @@
+export interface InboxAction {
+  content?: string | null;
+  href?: string | null;
+  data?: { [key: string]: any } | null;
+}

package/src/models/InboxMessage.tsx

@@ -0,0 +1,16 @@
+import { InboxAction } from "./InboxAction";
+
+export interface InboxMessage {
+  messageId: string;
+  title?: string | null;
+  body?: string | null;
+  preview?: string | null;
+  created?: string | null;
+  actions?: InboxAction[] | null;
+  data?: { [key: string]: any } | null;
+  read?: boolean | null;
+  opened?: boolean | null;
+  archived?: boolean | null
+  subtitle?: string | null;
+  time?: string;
+}

package/src/views/CourierInboxView.tsx

@@ -0,0 +1,85 @@
+import React from "react";
+import { Platform, requireNativeComponent, UIManager, ViewStyle } from "react-native";
+import CourierInboxTheme from "src/models/CourierInboxTheme";
+import { InboxAction } from "src/models/InboxAction";
+import { InboxMessage } from "src/models/InboxMessage";
+
+type CourierInboxViewProps = {
+  lightTheme?: CourierInboxTheme;
+  darkTheme?: CourierInboxTheme;
+  onClickInboxMessageAtIndex?: (message: InboxMessage, index: number) => void;
+  onClickInboxActionForMessageAtIndex?: (action: InboxAction, message: InboxMessage, index: number) => void;
+  onScrollInbox?: (offsetY: number, offsetX: number) => void;
+  style?: ViewStyle;
+};
+
+const ComponentName = 'CourierReactNativeView';
+
+const LINKING_ERROR =
+  `The package '@trycourier/courier-react-native' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n';
+
+const CourierInbox =
+  UIManager.getViewManagerConfig(ComponentName) != null
+    ? requireNativeComponent<CourierInboxViewProps>(ComponentName)
+    : () => {
+        throw new Error(LINKING_ERROR);
+      };
+
+export const CourierInboxView = (props: CourierInboxViewProps) => {
+
+  const onClickInboxMessageAtIndex = (event: any) => {
+
+    // Parse the native event data
+    if (props.onClickInboxMessageAtIndex) {
+
+      const index = event.nativeEvent["index"]
+      const message = event.nativeEvent["message"] as InboxMessage
+
+      props.onClickInboxMessageAtIndex(message, index)
+
+    }
+
+  }
+
+  const onClickInboxActionForMessageAtIndex = (event: any) => {
+
+    // Parse the native event data
+    if (props.onClickInboxActionForMessageAtIndex) {
+
+      const index = event.nativeEvent["index"]
+      const action = event.nativeEvent["action"] as InboxAction
+      const message = event.nativeEvent["message"] as InboxMessage
+
+      props.onClickInboxActionForMessageAtIndex(action, message, index)
+
+    }
+
+  }
+
+  const onScrollInbox = (event: any) => {
+
+    // Parse the native event data
+    if (props.onScrollInbox) {
+
+      const contentOffset = event.nativeEvent["contentOffset"]
+      props.onScrollInbox(contentOffset["y"], contentOffset["x"])
+
+    }
+
+  }
+
+  return (
+    <CourierInbox 
+      lightTheme={props.lightTheme} 
+      darkTheme={props.darkTheme}
+      onClickInboxMessageAtIndex={onClickInboxMessageAtIndex}
+      onClickInboxActionForMessageAtIndex={onClickInboxActionForMessageAtIndex}
+      onScrollInbox={onScrollInbox}
+      style={props.style}
+    />
+  )
+
+}

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -1,2 +0,0 @@
-#Thu Oct 27 14:07:59 EDT 2022
-gradle.version=7.1

package/android/.idea/compiler.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CompilerConfiguration">
-    <bytecodeTargetLevel target="11" />
-  </component>
-</project>

package/android/.idea/gradle.xml

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GradleSettings">
-    <option name="linkedExternalProjectsSettings">
-      <GradleProjectSettings>
-        <option name="testRunner" value="GRADLE" />
-        <option name="distributionType" value="DEFAULT_WRAPPED" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="modules">
-          <set>
-            <option value="$PROJECT_DIR$" />
-          </set>
-        </option>
-      </GradleProjectSettings>
-    </option>
-  </component>
-</project>

package/android/.idea/jarRepositories.xml

@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="RemoteRepositoriesConfiguration">
-    <remote-repository>
-      <option name="id" value="central" />
-      <option name="name" value="Maven Central repository" />
-      <option name="url" value="https://repo1.maven.org/maven2" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="jboss.community" />
-      <option name="name" value="JBoss Community repository" />
-      <option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="MavenRepo" />
-      <option name="name" value="MavenRepo" />
-      <option name="url" value="https://repo.maven.apache.org/maven2/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="React Native sources" />
-      <option name="name" value="React Native sources" />
-      <option name="url" value="file:$PROJECT_DIR$/../node_modules/react-native/android/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven" />
-      <option name="name" value="maven" />
-      <option name="url" value="https://jitpack.io" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="Google" />
-      <option name="name" value="Google" />
-      <option name="url" value="https://dl.google.com/dl/android/maven2/" />
-    </remote-repository>
-  </component>
-</project>

package/android/.idea/misc.xml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="Android Studio default JDK" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/build/classes" />
-  </component>
-  <component name="ProjectType">
-    <option name="id" value="Android" />
-  </component>
-</project>

package/android/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
-  </component>
-</project>

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +0,0 @@
-distributionBase=GRADLE_USER_HOME
-distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip
-zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists