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

package/lib/typescript/index.d.ts

@@ -1,7 +1,15 @@
 import { CourierInboxListener } from './models/CourierInboxListener';
+import { CourierPushListener } from './models/CourierPushListener';
+import { CourierAuthenticationListener } from './models/CourierAuthenticationListener';
 import { InboxMessage } from './models/InboxMessage';
 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';
 declare class Courier {
+    readonly PUSH_NOTIFICATION_CLICKED = "pushNotificationClicked";
+    readonly PUSH_NOTIFICATION_DELIVERED = "pushNotificationDelivered";
     private static _sharedInstance;
     private _isDebugging;
     private debugListener;
@@ -13,13 +21,63 @@ declare class Courier {
      * Defaults to the React __DEV__ mode
      * @example Courier.setIsDebugging(true)
      */
-    setIsDebugging(isDebugging: boolean): Promise<boolean>;
+    setIsDebugging(isDebugging: boolean): boolean;
     get isDebugging(): boolean;
+    /**
+     * TODO
+     * @param props
+     * @returns
+     */
+    iOSForegroundPresentationOptions(props: {
+        options: ('sound' | 'badge' | 'list' | 'banner')[];
+    }): string;
+    /**
+     * Sets the current Apple Push Notification Service (APNS) token
+     * using Courier token management apis
+     * @example const apnsToken = await Courier.apnsToken
+     */
+    get apnsToken(): string | undefined;
+    /**
+     * Sets the current Firebase Cloud Messaging (FCM) token
+     * using Courier token management apis
+     * @example const fcmToken = await Courier.fcmToken
+     */
+    get fcmToken(): string | undefined;
+    /**
+     * Sets the current Firebase Cloud Messaging (FCM) token
+     * using Courier token management apis
+     * @example await setFcmToken('asdf...asdf')
+     */
+    setFcmToken(props: {
+        token: string;
+    }): Promise<void>;
+    /**
+     * Gets notification permission status at a system level.
+     * @example const permissionStatus = await Courier.getNotificationPermissionStatus()
+     */
+    getNotificationPermissionStatus(): Promise<string>;
+    /**
+     * 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()
+     */
+    requestNotificationPermission(): Promise<string>;
+    /**
+     * @example
+    TODO
+    * @returns  function that can be used to unsubscribe from registered listeners
+    */
+    addPushNotificationListener(props: {
+        onPushNotificationClicked?: (push: any) => void;
+        onPushNotificationDelivered?: (push: any) => void;
+    }): CourierPushListener;
     /**
      * Returns the current user id stored in local native storage
      * @example const userId = await Courier.userId
      */
-    get userId(): Promise<string | undefined>;
+    get userId(): string | undefined;
     /**
      * Signs user in and persists signin in between sessions
      * using native level storage apis
@@ -41,6 +99,28 @@ declare class Courier {
         clientKey?: string;
         userId: string;
     }): Promise<void>;
+    /**
+     * TODO
+     * @param props
+     * @returns
+     */
+    signOut(): Promise<void>;
+    /**
+     * TODO
+     * @param props
+     * @returns
+     */
+    addAuthenticationListener(props: {
+        onUserChanged: (userId?: string) => void;
+    }): CourierAuthenticationListener;
+    /**
+     * TODO
+     * @param props
+     * @returns
+     */
+    removeAuthenticationListener(props: {
+        listenerId: string;
+    }): string;
     /**
      * TODO
      * @param props
@@ -87,6 +167,20 @@ declare class Courier {
      * @returns
      */
     refreshInbox(): Promise<void>;
+    /**
+     * TODO
+     * @param props
+     * @returns
+     */
+    fetchNextPageOfMessages(): Promise<InboxMessage[]>;
+    /**
+     * TODO
+     * @param props
+     * @returns
+     */
+    setInboxPaginationLimit(props: {
+        limit: number;
+    }): void;
 }
 export default Courier;
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAuB5D,cAAM,OAAO;IAEX,OAAO,CAAC,MAAM,CAAC,eAAe,CAAU;IACxC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAkC;;IAWvD,WAAkB,MAAM,IAAI,OAAO,CAQlC;YAEa,WAAW;IAazB;;;;OAIG;IACU,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBnE,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAExC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,KAAK,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhG;;;;OAIG;IACI,WAAW,CAAC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE;;;;OAIG;IACI,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;OAIG;IACI,gBAAgB,CAAC,KAAK,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;QAAC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;KAAE,GAAG,oBAAoB;IAkC5P;;;;OAIG;IACI,mBAAmB,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAIjE;;;;OAIG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAI3C;AAED,eAAe,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AASA,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAuBvF,cAAM,OAAO;IAEX,QAAQ,CAAC,yBAAyB,6BAA6B;IAC/D,QAAQ,CAAC,2BAA2B,+BAA+B;IAEnE,OAAO,CAAC,MAAM,CAAC,eAAe,CAAU;IACxC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAkC;;IAWvD,WAAkB,MAAM,IAAI,OAAO,CAQlC;YAEa,WAAW;IAKzB;;;;OAIG;IACI,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO;IAqBpD,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;OAIG;IACI,gCAAgC,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAA;KAAE,GAAG,MAAM;IAY9G;;;;OAIG;IACF,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAGnC;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED;;;;OAIG;IACI,WAAW,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D;;;OAGG;IACI,+BAA+B,IAAI,OAAO,CAAC,MAAM,CAAC;IAIzD;;;;;;OAMG;IACI,6BAA6B,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvD;;;;MAIE;IACK,2BAA2B,CAAC,KAAK,EAAE;QAAE,yBAAyB,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;QAAC,2BAA2B,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;KAAE,GAAG,mBAAmB;IA8DtK;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,KAAK,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhG;;;;OAIG;IACK,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIhC;;;;OAIG;IACK,yBAAyB,CAAC,KAAK,EAAE;QAAE,aAAa,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,GAAG,6BAA6B;IAcrH;;;;OAIG;IACI,4BAA4B,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAI1E;;;;OAIG;IACI,WAAW,CAAC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE;;;;OAIG;IACI,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;OAIG;IACI,gBAAgB,CAAC,KAAK,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;QAAC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;KAAE,GAAG,oBAAoB;IAkC5P;;;;OAIG;IACI,mBAAmB,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAIjE;;;;OAIG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1C;;;;OAIG;IACW,uBAAuB,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAIhE;;;;OAIG;IACK,uBAAuB,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;CAIhE;AAED,eAAe,OAAO,CAAC"}

package/lib/typescript/models/CourierAuthenticationListener.d.ts

@@ -0,0 +1,7 @@
+import { EmitterSubscription } from "react-native";
+export declare class CourierAuthenticationListener {
+    listenerId?: string;
+    onUserChanged?: EmitterSubscription;
+    remove(): void;
+}
+//# sourceMappingURL=CourierAuthenticationListener.d.ts.map

package/lib/typescript/models/CourierAuthenticationListener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CourierAuthenticationListener.d.ts","sourceRoot":"","sources":["../../../src/models/CourierAuthenticationListener.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGnD,qBAAa,6BAA6B;IAEjC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,mBAAmB,CAAA;IAEnC,MAAM;CAUd"}

package/lib/typescript/models/CourierPushListener.d.ts

@@ -0,0 +1,7 @@
+import { EmitterSubscription } from "react-native";
+export declare class CourierPushListener {
+    onNotificationClickedListener?: EmitterSubscription;
+    onNotificationDeliveredListener?: EmitterSubscription;
+    remove(): void;
+}
+//# sourceMappingURL=CourierPushListener.d.ts.map

package/lib/typescript/models/CourierPushListener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CourierPushListener.d.ts","sourceRoot":"","sources":["../../../src/models/CourierPushListener.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,qBAAa,mBAAmB;IAEvB,6BAA6B,CAAC,EAAE,mBAAmB,CAAA;IACnD,+BAA+B,CAAC,EAAE,mBAAmB,CAAA;IAErD,MAAM;CAKd"}

package/lib/typescript/views/CourierInboxView.d.ts

@@ -4,8 +4,10 @@ import CourierInboxTheme from "src/models/CourierInboxTheme";
 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;

package/lib/typescript/views/CourierInboxView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CourierInboxView.d.ts","sourceRoot":"","sources":["../../../src/views/CourierInboxView.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAA+C,SAAS,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,KAAK,qBAAqB,GAAG;IAC3B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,0BAA0B,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5E,mCAAmC,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1G,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3D,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAiBF,eAAO,MAAM,gBAAgB,UAAW,qBAAqB,sBAsD5D,CAAA"}
+{"version":3,"file":"CourierInboxView.d.ts","sourceRoot":"","sources":["../../../src/views/CourierInboxView.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAA+C,SAAS,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,KAAK,qBAAqB,GAAG;IAC3B,KAAK,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,iBAAiB,CAAC;QAC1B,IAAI,CAAC,EAAE,iBAAiB,CAAA;KACzB,CAAC;IACF,0BAA0B,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5E,mCAAmC,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1G,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3D,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAiBF,eAAO,MAAM,gBAAgB,UAAW,qBAAqB,sBAqD5D,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier-react-native",
-  "version": "2.0.0-beta1",
+  "version": "2.0.0-beta3",
   "description": "Inbox & Push Notifications for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/hooks/useCourier.tsx

@@ -0,0 +1,291 @@
+import React, { createContext, ReactNode, useContext, useEffect, useState } from 'react';
+import { InboxMessage } from 'src/models/InboxMessage';
+import Courier, { CourierPushListener, CourierInboxListener, CourierAuthenticationListener } from '..';
+
+let authListener: CourierAuthenticationListener | undefined = undefined
+let pushListener: CourierPushListener | undefined = undefined
+let inboxListener: CourierInboxListener | undefined = undefined
+
+interface CourierContextType {
+  auth?: {
+    isLoading: boolean;
+    error?: string;
+    userId?: string;
+    signIn: (props: { accessToken: string, clientKey?: string, userId: string }) => Promise<void>;
+    signOut: () => Promise<void>;
+  }
+  push?: {
+    delivered: any;
+    clicked: any;
+    tokens: {
+      apns?: string,
+      fcm?: string;
+    },
+    notificationPermissionStatus?: string;
+    requestNotificationPermission: () => Promise<void>;
+  }
+  inbox?: {
+    isLoading: boolean;
+    error?: string;
+    messages: InboxMessage[];
+    unreadMessageCount: number;
+    totalMessageCount: number;
+    canPaginate: boolean;
+    setPaginationLimit: (limit: number) => void;
+    fetchNextPageOfMessages: () => Promise<InboxMessage[]>;
+    refresh: () => Promise<void>;
+    isRefreshing: boolean;
+    readAllMessages: () => Promise<void>;
+    readMessage: (messageId: string) => Promise<void>;
+    unreadMessage: (messageId: string) => Promise<void>;
+  }
+}
+
+const CourierContext = createContext<CourierContextType | undefined>(undefined);
+
+export const CourierProvider: React.FC<{ listeners: ('auth' | 'push' | 'inbox')[], children: ReactNode }> = ({ listeners, children }) => {
+
+  // Auth
+  const [auth_userId, auth_setUserId] = useState<string | undefined>(undefined);
+  const [auth_isLoading, auth_setIsLoading] = useState<boolean>(false);
+  const [auth_error, auth_setError] = useState<string | undefined>(undefined);
+
+  // Push
+  const [push_pushNotificationDelivered, inbox_setPushNotificationDelivered] = useState<any>(undefined);
+  const [push_pushNotificationClicked, inbox_setPushNotificationClicked] = useState<any>(undefined);
+  const [push_apnsToken, push_setApnsToken] = useState<string | undefined>(undefined);
+  const [push_fcmToken, push_setFcmToken] = useState<string | undefined>(undefined);
+  const [push_notificationPermission, push_setNotificationPermission] = useState<string | undefined>(undefined);
+
+  // Inbox
+  const [inbox_isLoading, inbox_setIsLoading] = useState<boolean>(false);
+  const [inbox_isRefreshing, inbox_setIsRefreshing] = useState<boolean>(false);
+  const [inbox_error, inbox_setError] = useState<string | undefined>(undefined);
+  const [inbox_messages, inbox_setMessages] = useState<InboxMessage[]>([]);
+  const [inbox_unreadMessageCount, inbox_setUnreadMessageCount] = useState<number>(0);
+  const [inbox_totalMessageCount, inbox_setTotalMessageCount] = useState<number>(0);
+  const [inbox_canPaginate, inbox_setCanPaginate] = useState<boolean>(false);
+
+  useEffect(() => {
+
+    // Get the initial values
+    const userId = Courier.shared.userId;
+    auth_setUserId(userId);
+
+    // Permissions
+    syncNotificationPermissions();
+
+    // Push tokens
+    syncTokens();
+
+  }, [])
+
+  useEffect(() => {
+
+    authListener?.remove();
+    pushListener?.remove();
+    inboxListener?.remove();
+
+    // Push
+    if (listeners.includes('auth')) {
+
+      authListener = Courier.shared.addAuthenticationListener({
+        onUserChanged: (userId) => {
+          auth_setUserId(userId);
+        }
+      })
+
+    }
+
+    // Push
+    if (listeners.includes('push')) {
+
+      pushListener = Courier.shared.addPushNotificationListener({
+        onPushNotificationDelivered: (push) => inbox_setPushNotificationDelivered(push),
+        onPushNotificationClicked: (push) => inbox_setPushNotificationClicked(push)
+      });
+
+    }
+
+    // Inbox
+    if (listeners.includes('inbox')) {
+
+      inboxListener = Courier.shared.addInboxListener({
+        onInitialLoad: () => {
+          inbox_setIsLoading(true);
+          inbox_setError(undefined);
+        },
+        onError: (error) => {
+          inbox_setIsLoading(false);
+          inbox_setError(error);
+        },
+        onMessagesChanged: (messages, unreadMessageCount, totalMessageCount, canPaginate) => {
+          inbox_setIsLoading(false);
+          inbox_setError(undefined);
+          inbox_setMessages(messages);
+          inbox_setUnreadMessageCount(unreadMessageCount);
+          inbox_setTotalMessageCount(totalMessageCount);
+          inbox_setCanPaginate(canPaginate);
+        }
+      });
+
+    }
+
+    return () => {
+      authListener?.remove();
+      pushListener?.remove();
+      inboxListener?.remove();
+    }
+
+  }, [listeners]);
+
+  const signIn = async (props: { accessToken: string, clientKey?: string, userId: string }): Promise<void> => {
+    
+    auth_setIsLoading(true);
+    auth_setError(undefined);
+
+    try {
+      await Courier.shared.signIn(props)
+    } catch (error) {
+      auth_setError(error as string);
+    }
+
+    auth_setIsLoading(false);
+
+  };
+
+  const signOut = async (): Promise<void> => {
+    
+    auth_setIsLoading(true);
+    auth_setError(undefined);
+
+    try {
+      await Courier.shared.signOut();
+    } catch (error) {
+      auth_setError(error as string);
+    }
+
+    auth_setIsLoading(false);
+
+  };
+
+  const syncNotificationPermissions = async () => {
+
+    const status = await Courier.shared.getNotificationPermissionStatus();
+    push_setNotificationPermission(status);
+
+  }
+
+  const syncTokens = () => {
+
+    // APNS
+    const apnsToken = Courier.shared.apnsToken;
+    push_setApnsToken(apnsToken);
+
+    const fcmToken = Courier.shared.fcmToken;
+    push_setFcmToken(fcmToken);
+
+  }
+
+  const requestNotificationPermission = async () => {
+    const status = await Courier.shared.requestNotificationPermission();
+    push_setNotificationPermission(status);
+  };
+
+  const setPaginationLimit = (limit: number) => {
+    Courier.shared.setInboxPaginationLimit({ limit });
+  };
+
+  const fetchNextPageOfMessages = (): Promise<InboxMessage[]> => {
+    return Courier.shared.fetchNextPageOfMessages();
+  };
+
+  const refresh = async () => {
+    inbox_setIsRefreshing(true);
+    await Courier.shared.refreshInbox();
+    inbox_setIsRefreshing(false);
+  };
+
+  const readAllMessages = () => {
+
+    // Skip if no user is found
+    if (!Courier.shared.userId) {
+      return Promise.resolve();
+    }
+
+    // Read the messages
+    return Courier.shared.readAllInboxMessages();
+
+  };
+
+  const readMessage = (messageId: string) => {
+    return Courier.shared.readMessage({ messageId });
+  };
+
+  const unreadMessage = (messageId: string) => {
+    return Courier.shared.unreadMessage({ messageId });
+  };
+
+  return (
+    <CourierContext.Provider value={{
+      auth: {
+        isLoading: auth_isLoading,
+        error: auth_error,
+        userId: auth_userId,
+        signIn,
+        signOut
+      },
+      push: {
+        delivered: push_pushNotificationDelivered,
+        clicked: push_pushNotificationClicked,
+        tokens: {
+          fcm: push_fcmToken,
+          apns: push_apnsToken,
+        },
+        notificationPermissionStatus: push_notificationPermission,
+        requestNotificationPermission,
+      },
+      inbox: {
+        isLoading: inbox_isLoading,
+        error: inbox_error,
+        messages: inbox_messages,
+        unreadMessageCount: inbox_unreadMessageCount,
+        totalMessageCount: inbox_totalMessageCount,
+        canPaginate: inbox_canPaginate,
+        setPaginationLimit,
+        fetchNextPageOfMessages,
+        refresh,
+        isRefreshing: inbox_isRefreshing,
+        readAllMessages,
+        readMessage,
+        unreadMessage,
+      }
+    }}>
+      {children}
+    </CourierContext.Provider>
+  );
+  
+};
+
+interface UseCourierProps {
+  inbox?: {
+    paginationLimit?: number;
+  }
+}
+
+export const useCourier = (props: UseCourierProps = {}): CourierContextType => {
+
+  const context = useContext(CourierContext);
+
+  if (!context) {
+    throw new Error('useCourier must be used within an CourierProvider');
+  }
+
+  // Set the initial pagination limit if needed
+  if (props.inbox?.paginationLimit) {
+    context.inbox?.setPaginationLimit(props.inbox?.paginationLimit)
+  }
+
+  return context;
+
+};