@trycourier/courier-react-native 3.2.1 → 4.0.4

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@trycourier/courier-react-native",
-  "version": "3.2.1",
-  "description": "Inbox & Push Notifications for React Native",
+  "version": "4.0.4",
+  "description": "Inbox, Push Notifications, and Preferences for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
-  "types": "lib/typescript/index.d.ts",
+  "types": "lib/typescript/src/index.d.ts",
   "react-native": "src/index",
   "source": "src/index",
   "files": [

package/src/Broadcaster.tsx

@@ -0,0 +1,32 @@
+import { NativeModule } from "react-native";
+import { NativeEventEmitter, EmitterSubscription, Platform, DeviceEventEmitter } from "react-native";
+
+export default class Broadcaster {
+
+  private emitter: NativeEventEmitter;
+
+  constructor(module: NativeModule) {
+    this.emitter = new NativeEventEmitter(module);
+  }
+
+  /**
+    * Creates an event listener for the native function
+    * @param key Key for the listener
+    * @param callback Value returned for the listener callback
+    * @returns Subscription
+    */
+  addListener(id: string, callback: (value: any) => void): EmitterSubscription | undefined {
+
+    if (Platform.OS === 'android') {
+      return DeviceEventEmitter.addListener(id, (event: any) => callback(event));
+    }
+
+    if (Platform.OS === 'ios') {
+      return this.emitter.addListener(id, (event: any) => callback(event));
+    }
+
+    return undefined;
+
+  }
+
+}

package/src/Modules.tsx

@@ -0,0 +1,28 @@
+import { NativeModules, Platform } from "react-native";
+
+export class Modules {
+
+  static readonly 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';
+
+  static readonly Client = Modules.getNativeModule(NativeModules.CourierClientModule);
+  static readonly Shared = Modules.getNativeModule(NativeModules.CourierSharedModule);
+  static readonly System = Modules.getNativeModule(NativeModules.CourierSystemModule);
+
+  static getNativeModule<T>(nativeModule: T | undefined): T {
+    return nativeModule
+      ? nativeModule
+      : new Proxy(
+          {},
+          {
+            get() {
+              throw new Error(Modules.LINKING_ERROR);
+            },
+          }
+        ) as T;
+  }
+
+}

package/src/client/BrandClient.tsx

@@ -0,0 +1,23 @@
+import { Modules } from "../Modules";
+import { CourierBrandResponse } from "..";
+
+export class BrandClient {
+
+  readonly clientId: string;
+
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Retrieves brand information for a specific brand ID.
+   * @param props - The properties for getting the brand.
+   * @param props.brandId - The ID of the brand to retrieve.
+   * @returns A promise that resolves with the CourierBrandResponse containing brand information.
+   */
+  public async getBrand(props: { brandId: string }): Promise<CourierBrandResponse> {
+    const json = await Modules.Client.getBrand(this.clientId, props.brandId);
+    return JSON.parse(json);
+  }
+
+}

package/src/client/ClientModule.tsx

@@ -0,0 +1,21 @@
+import { Modules } from "../Modules";
+import { CourierClientOptions } from "./CourierClient";
+
+export abstract class ClientModule {
+
+  readonly clientId: string;
+
+  // Constructor to create a low level CourierClient
+  constructor(options: CourierClientOptions) {
+    this.clientId = this.add(options);
+  }
+  
+  private add(options: CourierClientOptions): string {
+    return Modules.Client.addClient(options);
+  }
+
+  public remove(): string {
+    return Modules.Client.removeClient(this.clientId);
+  }
+
+}

package/src/client/CourierClient.tsx

@@ -0,0 +1,49 @@
+import { BrandClient } from "..";
+import { ClientModule } from "./ClientModule";
+import { InboxClient } from "./InboxClient";
+import { PreferenceClient } from "./PreferenceClient";
+import { TokenClient } from "./TokenClient";
+import { TrackingClient } from "./TrackingClient";
+
+export interface CourierClientOptions {
+  userId: string;
+  showLogs: boolean;
+  jwt?: string;
+  clientKey?: string;
+  connectionId?: string;
+  tenantId?: string;
+}
+
+export class CourierClient extends ClientModule {
+
+  public readonly options: CourierClientOptions;
+  public readonly tokens: TokenClient;
+  public readonly brands: BrandClient;
+  public readonly inbox: InboxClient;
+  public readonly preferences: PreferenceClient;
+  public readonly tracking: TrackingClient;
+
+  constructor(props: { userId: string, jwt?: string, clientKey?: string, connectionId?: string, tenantId?: string, showLogs?: boolean }) {
+
+    const options = {
+      userId: props.userId,
+      showLogs: props.showLogs ?? __DEV__,
+      jwt: props.jwt,
+      clientKey: props.clientKey,
+      connectionId: props.clientKey,
+      tenantId: props.tenantId,
+    };
+
+    super(options);
+
+    this.options = options
+
+    this.tokens = new TokenClient(this.clientId);
+    this.brands = new BrandClient(this.clientId);
+    this.inbox = new InboxClient(this.clientId);
+    this.preferences = new PreferenceClient(this.clientId);
+    this.tracking = new TrackingClient(this.clientId);
+    
+  }
+
+}

package/src/client/InboxClient.tsx

@@ -0,0 +1,114 @@
+import { Modules } from "../Modules";
+import { CourierGetInboxMessageResponse, CourierGetInboxMessagesResponse } from "../models/CourierInboxMessages";
+
+export class InboxClient {
+
+  readonly clientId: string;
+
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Retrieves messages from the inbox.
+   * @param props - The properties for getting messages.
+   * @param props.paginationLimit - Optional. The number of messages to retrieve per page. Defaults to 24.
+   * @param props.startCursor - Optional. The cursor to start retrieving messages from.
+   * @returns A promise that resolves with the CourierGetInboxMessagesResponse containing the messages.
+   */
+  public async getMessages(props: { paginationLimit?: number, startCursor?: string }): Promise<CourierGetInboxMessagesResponse> {
+    const json = await Modules.Client.getMessages(this.clientId, props.paginationLimit ?? 24, props.startCursor);
+    return JSON.parse(json);
+  }
+
+  /**
+   * Retrieves archived messages from the inbox.
+   * @param props - The properties for getting archived messages.
+   * @param props.paginationLimit - Optional. The number of messages to retrieve per page. Defaults to 24.
+   * @param props.startCursor - Optional. The cursor to start retrieving messages from.
+   * @returns A promise that resolves with the CourierGetInboxMessagesResponse containing the archived messages.
+   */
+  public async getArchivedMessages(props: { paginationLimit?: number, startCursor?: string }): Promise<CourierGetInboxMessagesResponse> {
+    const json = await Modules.Client.getArchivedMessages(this.clientId, props.paginationLimit ?? 24, props.startCursor);
+    return JSON.parse(json);
+  }
+
+  /**
+   * Retrieves a specific message by its ID.
+   * @param props - The properties for getting the message.
+   * @param props.messageId - The ID of the message to retrieve.
+   * @returns A promise that resolves with the CourierGetInboxMessageResponse containing the message.
+   */
+  public async getMessageById(props: { messageId: String }): Promise<CourierGetInboxMessageResponse> {
+    const json = await Modules.Client.getMessageById(this.clientId, props.messageId);
+    return JSON.parse(json);
+  }
+
+  /**
+   * Retrieves the count of unread messages in the inbox.
+   * @returns A promise that resolves with the number of unread messages.
+   */
+  public async getUnreadMessageCount(): Promise<number> {
+    return await Modules.Client.getUnreadMessageCount(this.clientId);
+  }
+
+  /**
+   * Marks a message as opened.
+   * @param props - The properties for opening the message.
+   * @param props.messageId - The ID of the message to mark as opened.
+   * @returns A promise that resolves with a number indicating the operation result.
+   */
+  public async open(props: { messageId: String }): Promise<number> {
+    return await Modules.Client.openMessage(this.clientId, props.messageId);
+  }
+
+  /**
+   * Marks a message as read.
+   * @param props - The properties for reading the message.
+   * @param props.messageId - The ID of the message to mark as read.
+   * @returns A promise that resolves with a number indicating the operation result.
+   */
+  public async read(props: { messageId: String }): Promise<number> {
+    return await Modules.Client.readMessage(this.clientId, props.messageId);
+  }
+
+  /**
+   * Marks a message as unread.
+   * @param props - The properties for marking the message as unread.
+   * @param props.messageId - The ID of the message to mark as unread.
+   * @returns A promise that resolves with a number indicating the operation result.
+   */
+  public async unread(props: { messageId: String }): Promise<number> {
+    return await Modules.Client.unreadMessage(this.clientId, props.messageId);
+  }
+
+  /**
+   * Records a click event for a message.
+   * @param props - The properties for clicking the message.
+   * @param props.messageId - The ID of the message that was clicked.
+   * @param props.trackingId - The tracking ID associated with the click event.
+   * @returns A promise that resolves with a number indicating the operation result.
+   */
+  public async click(props: { messageId: String, trackingId: string }): Promise<number> {
+    return await Modules.Client.clickMessage(this.clientId, props.messageId, props.trackingId);
+  }
+
+  /**
+   * Archives a message.
+   * @param props - The properties for archiving the message.
+   * @param props.messageId - The ID of the message to archive.
+   * @returns A promise that resolves with a number indicating the operation result.
+   */
+  public async archive(props: { messageId: String }): Promise<number> {
+    return await Modules.Client.archiveMessage(this.clientId, props.messageId);
+  }
+
+  /**
+   * Marks all messages as read.
+   * @returns A promise that resolves with a number indicating the operation result.
+   */
+  public async readAll(): Promise<number> {
+    return await Modules.Client.readAllMessages(this.clientId);
+  }
+
+}

package/src/client/PreferenceClient.tsx

@@ -0,0 +1,77 @@
+import { Modules } from "../Modules";
+import { CourierUserPreferences, CourierUserPreferencesChannel, CourierUserPreferencesStatus, CourierUserPreferencesTopic } from "../models/CourierUserPreferences";
+
+export class PreferenceClient {
+
+  readonly clientId: string;
+
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Retrieves user preferences.
+   * @param props - Optional properties for pagination.
+   * @param props.paginationCursor - Optional cursor for pagination.
+   * @returns A promise that resolves with CourierUserPreferences containing user preference items and paging information.
+   */
+  public async getUserPreferences(props?: { paginationCursor?: string }): Promise<CourierUserPreferences> {
+
+    const json = await Modules.Client.getUserPreferences(this.clientId, props?.paginationCursor);
+    
+    const rawData = JSON.parse(json);
+  
+    return {
+      items: rawData.items.map((item: any) => ({
+        defaultStatus: item.default_status as CourierUserPreferencesStatus,
+        hasCustomRouting: item.has_custom_routing,
+        customRouting: item.custom_routing.map((channel: string) => channel as CourierUserPreferencesChannel),
+        status: item.status as CourierUserPreferencesStatus,
+        topicId: item.topic_id,
+        topicName: item.topic_name,
+        sectionName: item.section_name,
+        sectionId: item.section_id
+      })),
+      paging: rawData.paging
+    };
+
+  }
+
+  /**
+   * Retrieves user preference for a specific topic.
+   * @param props - Properties for getting the user preference topic.
+   * @param props.topicId - The ID of the topic to retrieve preferences for.
+   * @returns A promise that resolves with CourierUserPreferencesTopic containing the topic preference details.
+   */
+  public async getUserPreferenceTopic(props: { topicId: string }): Promise<CourierUserPreferencesTopic> {
+    const json = await Modules.Client.getUserPreferenceTopic(this.clientId, props.topicId);
+    const rawData = JSON.parse(json);
+  
+    const convertedTopic: CourierUserPreferencesTopic = {
+      defaultStatus: rawData.default_status as CourierUserPreferencesStatus,
+      hasCustomRouting: rawData.has_custom_routing,
+      customRouting: rawData.custom_routing.map((channel: string) => channel as CourierUserPreferencesChannel),
+      status: rawData.status as CourierUserPreferencesStatus,
+      topicId: rawData.topic_id,
+      topicName: rawData.topic_name,
+      sectionName: rawData.section_name,
+      sectionId: rawData.section_id
+    };
+  
+    return convertedTopic;
+  }
+
+  /**
+   * Updates user preference for a specific topic.
+   * @param props - Properties for updating the user preference topic.
+   * @param props.topicId - The ID of the topic to update preferences for.
+   * @param props.status - The new status for the topic preference.
+   * @param props.hasCustomRouting - Whether the topic has custom routing.
+   * @param props.customRouting - Array of custom routing channels.
+   * @returns A promise that resolves when the update is complete.
+   */
+  public async putUserPreferenceTopic(props: { topicId: string, status: CourierUserPreferencesStatus, hasCustomRouting: boolean, customRouting: CourierUserPreferencesChannel[] }): Promise<void> {
+    await Modules.Client.putUserPreferenceTopic(this.clientId, props.topicId, props.status, props.hasCustomRouting, props.customRouting);
+  }
+
+}

package/src/client/TokenClient.tsx

@@ -0,0 +1,34 @@
+import { CourierDevice } from "..";
+import { Modules } from "../Modules";
+
+export class TokenClient {
+
+  readonly clientId: string;
+
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Stores a user token for a specific provider.
+   * @param props - The properties for storing the user token.
+   * @param props.token - The token to be stored.
+   * @param props.provider - The provider associated with the token.
+   * @param props.device - Optional device information.
+   * @returns A promise that resolves when the token is successfully stored.
+   */
+  public async putUserToken(props: { token: string, provider: string, device?: CourierDevice }): Promise<void> {
+    await Modules.Client.putUserToken(this.clientId, props.token, props.provider, props.device);
+  }
+
+  /**
+   * Deletes a user token.
+   * @param props - The properties for deleting the user token.
+   * @param props.token - The token to be deleted.
+   * @returns A promise that resolves when the token is successfully deleted.
+   */
+  public async deleteUserToken(props: { token: string }): Promise<void> {
+    await Modules.Client.deleteUserToken(this.clientId, props.token);
+  }
+
+}

package/src/client/TrackingClient.tsx

@@ -0,0 +1,23 @@
+import { CourierTrackingEvent } from "..";
+import { Modules } from "../Modules";
+
+export class TrackingClient {
+
+  readonly clientId: string;
+
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Posts a tracking URL with associated event data.
+   * @param props - The properties for posting the tracking URL.
+   * @param props.url - The tracking URL to be posted.
+   * @param props.event - The CourierTrackingEvent associated with the URL.
+   * @returns A promise that resolves when the tracking URL is successfully posted.
+   */
+  public async postTrackingUrl(props: { url: string, event: CourierTrackingEvent }): Promise<void> {
+    await Modules.Client.postTrackingUrl(this.clientId, props.url, props.event);
+  }
+
+}