@attentive-mobile/attentive-react-native-sdk 2.0.0-beta.8 → 2.0.2

package/README.md

@@ -9,6 +9,18 @@ This project uses **npm** as the preferred package manager for consistency and a
 
 **Note on package managers:** Modern npm (v7+) has significantly improved performance and features, making it the recommended choice for React Native projects. Both npm and yarn work well with React Native, but this project standardizes on npm for development workflows.
 
+## Requirements
+
+| Tool | Version |
+|------|---------|
+| Node.js | >= 18.0.0 |
+| React Native | >= 0.74 |
+| Ruby | >= 3.3 |
+| CocoaPods | ~> 1.16 |
+| Xcode | >= 15 |
+| Android SDK | API 24+ |
+| JDK | 17 |
+
 ## Installation
 
 Run `npm install @attentive-mobile/attentive-react-native-sdk` from your app's root directory.
@@ -22,23 +34,23 @@ __*** NOTE: Please refrain from using any private or undocumented classes or met
 ### Import the SDK
 
 ```typescript
-import { Attentive, <other types you need here> } from 'attentive-react-native-sdk';
+import { initialize, identify, triggerCreative, recordPurchaseEvent, /* ... */ } from '@attentive-mobile/attentive-react-native-sdk';
 ```
 
 ### Create the AttentiveConfig
 
 ```typescript
-// Create an AttentiveConfiguration with your attentive domain, in production mode
-const config : AttentiveConfiguration = {
+// Create an AttentiveSdkConfiguration with your attentive domain, in production mode
+const config: AttentiveSdkConfiguration = {
   attentiveDomain: 'YOUR_ATTENTIVE_DOMAIN',
-  mode: Mode.Production,
+  mode: 'production',
 }
 ```
 ```typescript
 // Alternatively, use "debug" mode. When in debug mode, the Creative will not be shown, but instead a popup will show with debug information about your creative and any reason the Creative wouldn't show.
-const config : AttentiveConfiguration = {
+const config: AttentiveSdkConfiguration = {
   attentiveDomain: 'YOUR_ATTENTIVE_DOMAIN',
-  mode: Mode.Debug,
+  mode: 'debug',
 }
 ```
 
@@ -47,9 +59,9 @@ const config : AttentiveConfiguration = {
 The SDK includes debugging helpers to show what data is being sent and received. Enable debugging by setting `enableDebugger: true`:
 
 ```typescript
-const config : AttentiveConfiguration = {
+const config: AttentiveSdkConfiguration = {
   attentiveDomain: 'YOUR_ATTENTIVE_DOMAIN',
-  mode: Mode.Debug,
+  mode: 'debug',
   enableDebugger: true, // Shows debug overlays for events and creatives
 }
 ```
@@ -61,7 +73,7 @@ When enabled, debug overlays will automatically appear when:
 You can also manually invoke the debug helper:
 
 ```typescript
-Attentive.invokeAttentiveDebugHelper();
+invokeAttentiveDebugHelper();
 ```
 
 See [DEBUGGING.md](./DEBUGGING.md) for detailed information about debugging features.
@@ -76,7 +88,7 @@ On iOS, call `initialize` from TypeScript as early as possible (e.g. the root `A
 
 ```typescript
 // Called once per app session, before any other SDK operations.
-Attentive.initialize(config);
+initialize(config);
 ```
 
 #### Android — Initialize from Native Code
@@ -109,6 +121,7 @@ class MainApplication : Application(), ReactApplication {
             .applicationContext(this)
             .domain("YOUR_ATTENTIVE_DOMAIN")
             .mode(AttentiveConfig.Mode.PRODUCTION) // or Mode.DEBUG for testing
+            .notificationIconId(R.drawable.ic_stat_notification)
             .skipFatigueOnCreatives(false)
             .logLevel(AttentiveLogLevel.VERBOSE)
             .build()
@@ -120,6 +133,30 @@ class MainApplication : Application(), ReactApplication {
 }
 ```
 
+##### Android notification small icon
+
+Android requires push notifications to use a small status-bar icon. If `notificationIconId` is not set, the Attentive Android SDK uses its default fallback icon. To use your app's branding, add a notification small icon resource to your host app and pass its resource ID during native initialization.
+
+Add the icon to your Android app's drawable resources:
+
+```text
+android/app/src/main/res/drawable/ic_stat_notification.png
+```
+
+Use a white-only transparent PNG designed for Android notification status bars. Do not use the full-color launcher icon from `mipmap-*`, because Android masks small notification icons and it can render poorly.
+
+Then add the icon to your existing `AttentiveConfig.Builder()` chain in `MainApplication.kt` before `build()`:
+
+```text
+android/app/src/main/java/<your-package>/MainApplication.kt
+```
+
+```kotlin
+.notificationIconId(R.drawable.ic_stat_notification)
+```
+
+`MainApplication.kt` is host-app code, not generated by this SDK at runtime. If `R.drawable.ic_stat_notification` does not resolve, confirm the drawable file name matches exactly and that you are referencing your app module's `R` class.
+
 After the native initialization, all other SDK operations (`identify`, `recordAddToCartEvent`, `recordPurchaseEvent`, etc.) are called from TypeScript as normal on both platforms.
 
 > **Tip:** If you see `[AttentiveSDK] recordAddToCartEvent failed — SDK may not be initialized` in your Android logcat, it means `AttentiveSdk.initialize()` was not called from native code before the event was recorded. Check your `Application.onCreate()` setup.
@@ -128,22 +165,22 @@ After the native initialization, all other SDK operations (`identify`, `recordAd
 
 ```typescript
 // This will remove the creative along with its web view
-Attentive.destroyCreative();
+destroyCreative();
 ```
 
 
 ### Identify the current user
 ```typescript
 // Before loading the creative or sending events, if you have any user identifiers, they will need to be registered. Each identifier is optional. It is okay to skip this step if you have no identifiers about the user yet.
-const identifiers : UserIdentifiers = {
-  'phone': '+15556667777',
-  'email': 'some_email@gmailfake.com',
-  'klaviyoId': 'userKlaviyoId',
-  'shopifyId': 'userShopifyId',
-  'clientUserId': 'userClientUserId',
-  'customIdentifiers': { 'customIdKey': 'customIdValue' }
+const identifiers: UserIdentifiers = {
+  phone: '+15556667777',
+  email: 'some_email@gmailfake.com',
+  klaviyoId: 'userKlaviyoId',
+  shopifyId: 'userShopifyId',
+  clientUserId: 'userClientUserId',
+  customIdentifiers: { customIdKey: 'customIdValue' }
 };
-Attentive.identify(identifiers);
+identify(identifiers);
 ```
 
 The more identifiers that are passed to `identify`, the better the SDK will function. Here is the list of possible identifiers:
@@ -160,46 +197,34 @@ The more identifiers that are passed to `identify`, the better the SDK will func
 
 ```typescript
 // Trigger the Creative. This will show the Creative as a pop-up over the rest of the app.
-Attentive.triggerCreative();
+triggerCreative();
 ```
 
 ### Record user events
 
-The SDK currently supports `PurchaseEvent`, `AddToCartEvent`, `ProductViewEvent`, and `CustomEvent`.
+The SDK currently supports `Purchase`, `AddToCart`, `ProductView`, and `CustomEvent`.
 
 ```typescript
 // Construct one or more "Item"s, which represents the product(s) purchased
-const items : Item[] = [
-        {
-          productId: '555',
-          productVariantId: '777',
-          price: {
-            price: '14.99',
-            currency: 'USD',
-          },
-        },
-      ];
-
-// Construct an "Order", which represents the order for the purchase
-const order : Order = {
-  orderId: '88888'
-}
-
-// (Optional) Construct a "Cart", which represents the cart this Purchase was made from
-const cart : Cart = {
-  cartId: '555555',
-  cartCoupon: 'SOME-DISCOUNT'
-}
-
-// Construct a PurchaseEvent, which ties together the preceding objects
-const purchaseEvent : PurchaseEvent = {
+const items: Item[] = [
+  {
+    productId: '555',
+    productVariantId: '777',
+    price: '14.99',
+    currency: 'USD',
+  },
+];
+
+// Construct a Purchase event
+const purchase: Purchase = {
   items: items,
-  order: order,
-  cart: cart
+  orderId: '88888',
+  cartId: '555555',        // optional
+  cartCoupon: 'SOME-DISCOUNT', // optional
 }
 
 // Record the PurchaseEvent
-Attentive.recordPurchaseEvent(purchaseEvent);
+recordPurchaseEvent(purchase);
 ```
 
 The process is similar for the other events. See [eventTypes.tsx](https://github.com/attentive-mobile/attentive-react-native-sdk/blob/main/src/eventTypes.tsx) for all events.
@@ -208,12 +233,12 @@ The process is similar for the other events. See [eventTypes.tsx](https://github
 
 ```typescript
 // If new identifiers are available for the user, register them
-Attentive.identify({email: 'theusersemail@gmail.com'});
+identify({email: 'theusersemail@gmail.com'});
 ```
 
 ```typescript
-Attentive.identify({email: 'theusersemail@gmail.com'});
-Attentive.identify({phone: '+15556667777'};)
+identify({email: 'theusersemail@gmail.com'});
+identify({phone: '+15556667777'});
 // The SDK will have these two identifiers:
 //   email: 'theusersemail@gmail.com'
 //   phone: '+15556667777'
@@ -281,57 +306,45 @@ identify({ email: 'user@example.com', clientUserId: 'id-123' });
 
 #### Push notifications on Android (FCM)
 
-On Android, FCM token registration and push notification handling are managed natively in Kotlin/Java. This gives you full control over the Firebase Messaging lifecycle and ensures events are tracked before the React Native bridge initialises.
+The Attentive Android SDK registers its own `FirebaseMessagingService` automatically — **you do not need to create a subclass**. As long as your app is registered with Firebase and includes a valid `google-services.json`, the SDK handles FCM token registration and foreground push delivery for you. Follow the [Firebase Android setup guide](https://firebase.google.com/docs/cloud-messaging/android/client) to add FCM to your project.
 
-Add Firebase Cloud Messaging to your app following the [Firebase Android setup guide](https://firebase.google.com/docs/cloud-messaging/android/client), then handle token registration and notification events in your native `FirebaseMessagingService`:
+##### If you already have a FirebaseMessagingService subclass
+
+If your app has an existing `FirebaseMessagingService` subclass for other purposes, route Attentive messages through to the SDK:
 
 ```kotlin
 import com.attentive.androidsdk.AttentiveSdk
 import com.google.firebase.messaging.FirebaseMessagingService
 import com.google.firebase.messaging.RemoteMessage
 
-class AttentiveMessagingService : FirebaseMessagingService() {
-
-    override fun onNewToken(token: String) {
-        super.onNewToken(token)
-        // Register the FCM token with the Attentive SDK
-        AttentiveSdk.registerDeviceToken(token)
-    }
+class YourFirebaseMessagingService : FirebaseMessagingService() {
 
     override fun onMessageReceived(remoteMessage: RemoteMessage) {
         super.onMessageReceived(remoteMessage)
-        // Handle foreground push delivery
-        AttentiveSdk.handleForegroundPush(remoteMessage.data)
+        if (AttentiveSdk.isAttentiveFirebaseMessage(remoteMessage)) {
+            AttentiveSdk.sendNotification(remoteMessage)
+        }
+        // Handle your own messages below...
     }
 }
 ```
 
-For notification opens (when the user taps a push notification), handle the intent in your main `Activity`:
+##### Notification opens (singleTask apps)
+
+React Native apps use `singleTask` launch mode by default. When a push notification is tapped while the app is in the background, Android delivers the intent via `onNewIntent()` rather than recreating the activity. Override `onNewIntent` in your `MainActivity` so the SDK can detect the notification tap:
 
 ```kotlin
-import com.attentive.androidsdk.AttentiveSdk
+import android.content.Intent
 
 class MainActivity : ReactActivity() {
 
-    override fun onResume() {
-        super.onResume()
-        intent?.let { AttentiveSdk.handlePushOpen(it) }
+    override fun onNewIntent(intent: Intent?) {
+        super.onNewIntent(intent)
+        intent?.let { setIntent(it) }
     }
 }
 ```
 
-Declare the service in your `AndroidManifest.xml`:
-
-```xml
-<service
-    android:name=".AttentiveMessagingService"
-    android:exported="false">
-    <intent-filter>
-        <action android:name="com.google.firebase.MESSAGING_EVENT" />
-    </intent-filter>
-</service>
-```
-
 Refer to the [Attentive Android SDK documentation](https://github.com/attentive-mobile/attentive-android-sdk) for the full list of native APIs available for push notification integration.
 
 ---

package/attentive-react-native-sdk.podspec

@@ -1,7 +1,6 @@
 require "json"
 
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
-folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
 
 Pod::Spec.new do |s|
   s.name         = "attentive-react-native-sdk"
@@ -15,23 +14,10 @@ Pod::Spec.new do |s|
   s.source       = { :git => "https://github.com/attentive-mobile/attentive-react-native-sdk.git", :tag => "#{s.version}" }
 
   s.source_files = "ios/**/*.{h,m,mm,swift}"
+  s.public_header_files = "ios/AttentiveReactNativeSdk.h"
 
   s.dependency 'attentive-ios-sdk', '2.0.13'
   s.swift_versions = ['5']
-  s.dependency "React-Core"
 
-  # Don't install the dependencies when we run `pod install` in the old architecture.
-  if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
-    s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
-    s.pod_target_xcconfig    = {
-        "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\" \"$(PODS_ROOT)/Headers/Public/React-NativeModulesApple\" \"$(PODS_ROOT)/Headers/Private/React-NativeModulesApple\" \"$(PODS_ROOT)/Headers/Private/React-Codegen/react/renderer/components\" \"${PODS_CONFIGURATION_BUILD_DIR}/React-Codegen/React_Codegen.framework/Headers\"",
-        "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
-        "CLANG_CXX_LANGUAGE_STANDARD" => "c++20"
-    }
-    s.dependency "React-Codegen"
-    s.dependency "RCT-Folly"
-    s.dependency "RCTRequired"
-    s.dependency "RCTTypeSafety"
-    s.dependency "ReactCommon/turbomodule/core"
-  end
+  install_modules_dependencies(s)
 end

package/ios/AttentiveReactNativeSdk.h

@@ -5,14 +5,7 @@
 //  Created by Wyatt Davis on 2/13/23.
 //
 
-#ifdef RCT_NEW_ARCH_ENABLED
-#import "AttentiveReactNativeSdkSpec.h"
-
-@interface AttentiveReactNativeSdk : NSObject <NativeAttentiveReactNativeSdkSpec>
-#else
 #import <React/RCTBridgeModule.h>
 
 @interface AttentiveReactNativeSdk : NSObject <RCTBridgeModule>
-#endif
-
 @end

package/ios/AttentiveReactNativeSdk.mm

@@ -4,17 +4,31 @@
 //
 //  Created by Wyatt Davis on 2/13/23.
 //
+//  NOTE: This file contains both new arch and old arch implementations. Only the new arch path
+//  (RCT_NEW_ARCH_ENABLED) is functional. The old arch #else branch does not compile and is
+//  retained as scaffolding for future old arch support work (MSDK-350).
+//
 
 #import "AttentiveReactNativeSdk.h"
 #import <UserNotifications/UserNotifications.h>
 
-#if __has_include(<AttentiveReactNativeSdk-Swift.h>)
+#ifdef RCT_NEW_ARCH_ENABLED
+#import "AttentiveReactNativeSdkSpec.h"
+#endif
+
+#if __has_include(<attentive_react_native_sdk/attentive_react_native_sdk-Swift.h>)
+#import <attentive_react_native_sdk/attentive_react_native_sdk-Swift.h>
+#elif __has_include(<AttentiveReactNativeSdk-Swift.h>)
 #import "AttentiveReactNativeSdk-Swift.h"
 #else
-// Load the headers from the attentive-ios-sdk Pod
 #import "attentive_react_native_sdk-Swift.h"
 #endif
 
+#ifdef RCT_NEW_ARCH_ENABLED
+@interface AttentiveReactNativeSdk () <NativeAttentiveReactNativeSdkSpec>
+@end
+#endif
+
 @implementation AttentiveReactNativeSdk {
     ATTNNativeSDK* _sdk;
 }
@@ -190,8 +204,9 @@ customIdentifiers:(NSDictionary *)customIdentifiers {
 }
 
 #else
-// Old Architecture implementation with dictionary parameters.
-// Initialize is invoked only from TypeScript (e.g. Bonni App); native must not auto-initialize.
+// Old Architecture implementation — currently does not compile (missing RCT_EXPORT_METHOD macros,
+// bridge module registration, etc.). Kept here as a starting point for restoring old arch support
+// in a future ticket (MSDK-350).
 - (void)initialize:(NSDictionary*)configuration {
     _sdk = [[ATTNNativeSDK alloc] initWithDomain:configuration[@"attentiveDomain"]
                                             mode:configuration[@"mode"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@attentive-mobile/attentive-react-native-sdk",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.2",
   "description": "React Native Module for the Attentive SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -16,6 +16,10 @@
     "*.podspec",
     "!lib/typescript/example",
     "!ios/build",
+    "!ios/Pods",
+    "!ios/Podfile.lock",
+    "!ios/*.xcworkspace",
+    "!**/xcuserdata",
     "!android/build",
     "!android/gradle",
     "!android/gradlew",
@@ -111,7 +115,7 @@
   "release-it": {
     "git": {
       "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
+      "tagName": "${version}"
     },
     "npm": {
       "publish": true