@attentive-mobile/attentive-react-native-sdk 2.0.0-beta.5 → 2.0.0-beta.7

package/src/NativeAttentiveReactNativeSdk.ts

@@ -1,5 +1,5 @@
-import type { TurboModule } from "react-native/Libraries/TurboModule/RCTExport";
-import { TurboModuleRegistry, NativeModules } from "react-native";
+import type { TurboModule } from 'react-native/Libraries/TurboModule/RCTExport'
+import { TurboModuleRegistry, NativeModules } from 'react-native'
 
 export interface Spec extends TurboModule {
   initialize: (
@@ -7,10 +7,10 @@ export interface Spec extends TurboModule {
     mode: string,
     skipFatigueOnCreatives: boolean,
     enableDebugger: boolean
-  ) => void;
-  triggerCreative: (creativeId?: string) => void;
-  destroyCreative: () => void;
-  updateDomain: (domain: string) => void;
+  ) => void
+  triggerCreative: (creativeId?: string) => void
+  destroyCreative: () => void
+  updateDomain: (domain: string) => void
   identify: (
     phone?: string,
     email?: string,
@@ -18,52 +18,52 @@ export interface Spec extends TurboModule {
     shopifyId?: string,
     clientUserId?: string,
     customIdentifiers?: Object
-  ) => void;
-  clearUser: () => void;
+  ) => void
+  clearUser: () => void
   recordAddToCartEvent: (
     items: Array<{
-      productId: string;
-      productVariantId: string;
-      price: string;
-      currency: string;
-      productImage?: string;
-      name?: string;
-      quantity?: number;
-      category?: string;
+      productId: string
+      productVariantId: string
+      price: string
+      currency: string
+      productImage?: string
+      name?: string
+      quantity?: number
+      category?: string
     }>,
     deeplink?: string
-  ) => void;
+  ) => void
   recordProductViewEvent: (
     items: Array<{
-      productId: string;
-      productVariantId: string;
-      price: string;
-      currency: string;
-      productImage?: string;
-      name?: string;
-      quantity?: number;
-      category?: string;
+      productId: string
+      productVariantId: string
+      price: string
+      currency: string
+      productImage?: string
+      name?: string
+      quantity?: number
+      category?: string
     }>,
     deeplink?: string
-  ) => void;
+  ) => void
   recordPurchaseEvent: (
     items: Array<{
-      productId: string;
-      productVariantId: string;
-      price: string;
-      currency: string;
-      productImage?: string;
-      name?: string;
-      quantity?: number;
-      category?: string;
+      productId: string
+      productVariantId: string
+      price: string
+      currency: string
+      productImage?: string
+      name?: string
+      quantity?: number
+      category?: string
     }>,
     orderId: string,
     cartId?: string,
     cartCoupon?: string
-  ) => void;
-  recordCustomEvent: (type: string, properties: Object) => void;
-  invokeAttentiveDebugHelper: () => void;
-  exportDebugLogs: () => Promise<string>;
+  ) => void
+  recordCustomEvent: (type: string, properties: Object) => void
+  invokeAttentiveDebugHelper: () => void
+  exportDebugLogs: () => Promise<string>
 
   // Push Notification Methods
   /**
@@ -71,7 +71,7 @@ export interface Spec extends TurboModule {
    * On iOS, triggers the system permission dialog.
    * On Android 13+, requests POST_NOTIFICATIONS; on older versions, no-op.
    */
-  registerForPushNotifications: () => void;
+  registerForPushNotifications: () => void
 
   /**
    * Get the current push notification authorization status.
@@ -79,7 +79,7 @@ export interface Spec extends TurboModule {
    * On iOS, use PushNotificationIOS.checkPermissions instead; this method is for Android parity.
    * @returns Promise resolving to 'authorized' | 'denied' | 'notDetermined'
    */
-  getPushAuthorizationStatus: () => Promise<string>;
+  getPushAuthorizationStatus: () => Promise<string>
 
   /**
    * Register the device token received from APNs (simple version without callback).
@@ -87,7 +87,7 @@ export interface Spec extends TurboModule {
    * @param token - The hex-encoded device token string
    * @param authorizationStatus - Current push authorization status
    */
-  registerDeviceToken: (token: string, authorizationStatus: string) => void;
+  registerDeviceToken: (token: string, authorizationStatus: string) => void
 
   /**
    * Register the device token received from APNs with a callback.
@@ -100,8 +100,13 @@ export interface Spec extends TurboModule {
   registerDeviceTokenWithCallback: (
     token: string,
     authorizationStatus: string,
-    callback: (data?: Object, url?: string, response?: Object, error?: Object) => void
-  ) => void;
+    callback: (
+      data?: Object,
+      url?: string,
+      response?: Object,
+      error?: Object
+    ) => void
+  ) => void
 
   /**
    * Handle regular/direct app open (not from a push notification).
@@ -109,7 +114,7 @@ export interface Spec extends TurboModule {
    * This should be called after device token registration to track app opens.
    * @param authorizationStatus - Current push authorization status
    */
-  handleRegularOpen: (authorizationStatus: string) => void;
+  handleRegularOpen: (authorizationStatus: string) => void
 
   /**
    * Handle when a push notification is opened by the user.
@@ -122,14 +127,14 @@ export interface Spec extends TurboModule {
     userInfo: Object,
     applicationState: string,
     authorizationStatus: string
-  ) => void;
+  ) => void
 
   /**
    * Handle when a push notification arrives while the app is in foreground.
    * iOS only - Android is a no-op.
    * @param userInfo - The notification payload
    */
-  handleForegroundNotification: (userInfo: Object) => void;
+  handleForegroundNotification: (userInfo: Object) => void
 
   /**
    * Handle a push notification when the app is in the foreground (active state).
@@ -138,7 +143,7 @@ export interface Spec extends TurboModule {
    * @param userInfo - The notification payload
    * @param authorizationStatus - Current push authorization status
    */
-  handleForegroundPush: (userInfo: Object, authorizationStatus: string) => void;
+  handleForegroundPush: (userInfo: Object, authorizationStatus: string) => void
 
   /**
    * Handle when a push notification is opened by the user (app in background/inactive state).
@@ -147,15 +152,27 @@ export interface Spec extends TurboModule {
    * @param userInfo - The notification payload
    * @param authorizationStatus - Current push authorization status
    */
-  handlePushOpen: (userInfo: Object, authorizationStatus: string) => void;
+  handlePushOpen: (userInfo: Object, authorizationStatus: string) => void
+
+  /**
+   * Returns the push notification payload that launched the app from a killed state
+   * (i.e. the user tapped a notification when the app was not running), then clears it
+   * so it is only delivered once.
+   *
+   * Android only — on iOS use `PushNotificationIOS.getInitialNotification()` instead.
+   *
+   * @returns Promise resolving to a notification data map, or null if the app was not
+   *          launched from a push notification tap.
+   */
+  getInitialPushNotification: () => Promise<Object | null>
 }
 
 // Try to load via TurboModule first (new architecture)
 // Fall back to NativeModules for old architecture
-const isTurboModuleEnabled = (global as any).__turboModuleProxy != null;
+const isTurboModuleEnabled = (global as any).__turboModuleProxy != null
 
 const AttentiveReactNativeSdkModule = isTurboModuleEnabled
-  ? TurboModuleRegistry.get<Spec>("AttentiveReactNativeSdk")
-  : NativeModules.AttentiveReactNativeSdk;
+  ? TurboModuleRegistry.get<Spec>('AttentiveReactNativeSdk')
+  : NativeModules.AttentiveReactNativeSdk
 
-export default AttentiveReactNativeSdkModule as Spec | null;
+export default AttentiveReactNativeSdkModule as Spec | null

package/src/index.tsx

@@ -39,7 +39,12 @@ const AttentiveReactNativeSdk = (
 ) as Spec
 
 /**
- * Initialize the Attentive SDK with the provided configuration
+ * Initialize the Attentive SDK with the provided configuration.
+ * This is the only supported entry point: the app (e.g. Bonni) must call this from TypeScript
+ * once at startup; the call is forwarded to the native module on each platform (iOS/Android),
+ * which then initializes the platform Attentive SDK. Native code must not initialize the SDK
+ * on its own (e.g. in Application onCreate or AppDelegate).
+ *
  * @param configuration - Configuration object for the Attentive SDK
  */
 function initialize(configuration: AttentiveSdkConfiguration) {
@@ -380,17 +385,16 @@ function handleForegroundNotification(
 
 /**
  * Handle a push notification when the app is in the foreground (active state).
- * This is the React Native equivalent of the native iOS handleForegroundPush method.
  *
  * Call this when you receive a notification response and the app state is 'active'.
- * This is part of implementing the native iOS pattern:
- * ```swift
- * case .active:
- *   self.attentiveSdk?.handleForegroundPush(response: response, authorizationStatus: authStatus)
- * ```
  *
- * On iOS, this properly tracks foreground push notifications.
- * On Android, registers the FCM token when provided by the host app.
+ * **iOS prerequisite:** Your AppDelegate's
+ * `userNotificationCenter(_:didReceive:withCompletionHandler:)` must call
+ * `AttentiveSDKManager.shared.handleNotificationResponse(response)` so that
+ * the SDK can cache the `UNNotificationResponse` required by the native iOS SDK.
+ * Without that one line of native code, this function cannot track the event.
+ *
+ * On Android, this tracks the foreground push as a custom event.
  *
  * @param userInfo - The notification payload from the push notification
  * @param authorizationStatus - Current push authorization status
@@ -419,17 +423,16 @@ function handleForegroundPush(
 
 /**
  * Handle when a push notification is opened by the user (app in background/inactive state).
- * This is the React Native equivalent of the native iOS handlePushOpen method.
  *
  * Call this when you receive a notification response and the app state is 'background' or 'inactive'.
- * This is part of implementing the native iOS pattern:
- * ```swift
- * case .background, .inactive:
- *   self.attentiveSdk?.handlePushOpen(response: response, authorizationStatus: authStatus)
- * ```
  *
- * On iOS, this properly tracks push notification opens.
- * On Android, registers the FCM token when provided by the host app.
+ * **iOS prerequisite:** Your AppDelegate's
+ * `userNotificationCenter(_:didReceive:withCompletionHandler:)` must call
+ * `AttentiveSDKManager.shared.handleNotificationResponse(response)` so that
+ * the SDK can cache the `UNNotificationResponse` required by the native iOS SDK.
+ * Without that one line of native code, this function cannot track the event.
+ *
+ * On Android, this tracks the push open as a custom event.
  *
  * @param userInfo - The notification payload from the push notification
  * @param authorizationStatus - Current push authorization status
@@ -456,6 +459,38 @@ function handlePushOpen(
   )
 }
 
+/**
+ * Returns the push notification payload that launched the app from a killed state
+ * (i.e. the user tapped an FCM notification while the app was not running) and clears
+ * it so it is only delivered once.
+ *
+ * **Android only.** On iOS, use `PushNotificationIOS.getInitialNotification()` to
+ * achieve the same result — the Attentive iOS SDK event is tracked natively in
+ * `AppDelegate.userNotificationCenter(_:didReceive:withCompletionHandler:)` via
+ * `AttentiveSDKManager.shared`.
+ *
+ * Call this once at app startup (after `initialize()`) to detect and handle the
+ * killed-state push-open scenario:
+ *
+ * ```typescript
+ * const initial = await getInitialPushNotification()
+ * if (initial) {
+ *   const authStatus = await getPushAuthorizationStatus()
+ *   handlePushOpen(initial as PushNotificationUserInfo, authStatus)
+ * }
+ * ```
+ *
+ * @returns A promise that resolves to the notification data object, or `null` if the
+ *          app was not launched via a push notification tap.
+ */
+async function getInitialPushNotification(): Promise<Record<
+  string,
+  string
+> | null> {
+  const result = await AttentiveReactNativeSdk.getInitialPushNotification()
+  return result as Record<string, string> | null
+}
+
 export {
   initialize,
   triggerCreative,
@@ -479,6 +514,7 @@ export {
   handleForegroundNotification,
   handleForegroundPush,
   handlePushOpen,
+  getInitialPushNotification,
 }
 
 export type {