Bridge initialize and setPushToken to RN layer (#98)

* Add an initialize method to react native layer

* Add set push token to RN layer

* Updated to latest versions of native SDKs

* Elaboration on example app initialize/setPushToken, use a consistent value for example API key

* SCREAMING_SNAKE_CASE

---------

Co-authored-by: Evan Masseau <>

Author: evan-masseau

Diff for: .github/actions/setup/action.yml

@@ -22,6 +22,6 @@ runs:
           ${{ runner.os }}-yarn-
 
     - name: Install dependencies
-      if: steps.yarn-cache.outputs.cache-hit != 'true'
+      if: steps.yarn-cache.outputs.cache-hit != 'true' || ${{ github.run_attempt > 1 }}
       run: yarn install --immutable
       shell: bash

Diff for: .github/workflows/android-ci.yml

@@ -40,19 +40,19 @@ jobs:
           fi
 
       - name: Install JDK
-        if: env.turbo_cache_hit != 1
+        if: env.turbo_cache_hit != 1 || ${{ github.run_attempt > 1 }}
         uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           java-version: '17'
 
       - name: Finalize Android SDK
-        if: env.turbo_cache_hit != 1
+        if: env.turbo_cache_hit != 1 || ${{ github.run_attempt > 1 }}
         run: |
           /bin/bash -c "yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses > /dev/null"
 
       - name: Cache Gradle
-        if: env.turbo_cache_hit != 1
+        if: env.turbo_cache_hit != 1 || ${{ github.run_attempt > 1 }}
         uses: actions/cache@v4
         with:
           path: |

Diff for: android/build.gradle

@@ -102,6 +102,7 @@ repositories {
   google()
 }
 
+def klaviyoAndroidSdkVersion = getExtOrDefault("klaviyoAndroidSdkVersion")
 def kotlin_version = getExtOrDefault("kotlinVersion")
 def localProperties = new Properties()
 if (rootProject.file("local.properties").canRead()) {
@@ -126,8 +127,8 @@ dependencies {
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   // Klaviyo Android SDK
-  api "com.github.klaviyo.klaviyo-android-sdk:analytics:2.0.0"
-  api "com.github.klaviyo.klaviyo-android-sdk:push-fcm:2.0.0"
+  api "com.github.klaviyo.klaviyo-android-sdk:analytics:$klaviyoAndroidSdkVersion"
+  api "com.github.klaviyo.klaviyo-android-sdk:push-fcm:$klaviyoAndroidSdkVersion"
 
   // We used reflection to enumerate keywords in the Klaviyo Android SDK dynamically
   implementation "org.jetbrains.kotlin:kotlin-reflect:1.8.21"

Diff for: android/gradle.properties

@@ -11,6 +11,7 @@ org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryErro
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
 #Tue Dec 19 15:08:27 EST 2023
+KlaviyoReactNativeSdk_klaviyoAndroidSdkVersion=2.1.0
 KlaviyoReactNativeSdk_compileSdkVersion=31
 KlaviyoReactNativeSdk_kotlinVersion=1.8.0
 KlaviyoReactNativeSdk_minSdkVersion=23

Diff for: android/src/main/java/com/klaviyoreactnativesdk/KlaviyoReactNativeSdkModule.kt

@@ -45,6 +45,11 @@ class KlaviyoReactNativeSdkModule internal constructor(private val context: Reac
       }
     }
 
+    @ReactMethod
+    override fun initialize(apiKey: String) {
+      Klaviyo.initialize(apiKey, context)
+    }
+
     @ReactMethod
     override fun setProfile(profile: ReadableMap) {
       val parsedProfile = Profile()
@@ -57,6 +62,7 @@ class KlaviyoReactNativeSdkModule internal constructor(private val context: Reac
                 parsedProfile[key] = value
               }
             }
+
           else ->
             if (value is Serializable) {
               parsedProfile[key] = value
@@ -110,6 +116,16 @@ class KlaviyoReactNativeSdkModule internal constructor(private val context: Reac
       Klaviyo.resetProfile()
     }
 
+    @ReactMethod
+    override fun setPushToken(token: String) {
+      Klaviyo.setPushToken(token)
+    }
+
+    @ReactMethod
+    override fun getPushToken(callback: Callback) {
+      callback.invoke(Klaviyo.getPushToken())
+    }
+
     @ReactMethod
     override fun createEvent(event: ReadableMap) {
       val klaviyoEvent =

Diff for: android/src/oldarch/KlaviyoReactNativeSdkSpec.kt

@@ -7,6 +7,8 @@ import com.facebook.react.bridge.ReadableMap
 
 abstract class KlaviyoReactNativeSdkSpec internal constructor(context: ReactApplicationContext) :
   ReactContextBaseJavaModule(context) {
+    abstract fun initialize(apiKey: String)
+
     abstract fun setProfile(profile: ReadableMap)
 
     abstract fun setExternalId(externalId: String)
@@ -28,5 +30,9 @@ abstract class KlaviyoReactNativeSdkSpec internal constructor(context: ReactAppl
 
     abstract fun resetProfile()
 
+    abstract fun setPushToken(token: String)
+
+    abstract fun getPushToken(callback: Callback)
+
     abstract fun createEvent(event: ReadableMap)
   }

Diff for: example/android/app/src/main/java/com/klaviyoreactnativesdkexample/MainApplication.kt

@@ -14,6 +14,10 @@ import com.facebook.soloader.SoLoader
 import com.klaviyo.analytics.Klaviyo
 
 class MainApplication : Application(), ReactApplication {
+  companion object {
+    const val USE_NATIVE_IMPLEMENTATION = true
+  }
+
   override val reactNativeHost: ReactNativeHost =
     object : DefaultReactNativeHost(this) {
       override fun getPackages(): List<ReactPackage> {
@@ -36,8 +40,11 @@ class MainApplication : Application(), ReactApplication {
   override fun onCreate() {
     super.onCreate()
     SoLoader.init(this, false)
-    Klaviyo.initialize(BuildConfig.PUBLIC_API_KEY, this)
-    registerActivityLifecycleCallbacks(Klaviyo.lifecycleCallbacks)
+
+    if (USE_NATIVE_IMPLEMENTATION) {
+      // If initializing from the native layer:
+      Klaviyo.initialize(BuildConfig.PUBLIC_API_KEY, this)
+    }
 
     if (BuildConfig.IS_NEW_ARCHITECTURE_ENABLED) {
       // If you opted-in for the New Architecture, we load the native entry point for this app.

Diff for: example/android/gradle.properties

@@ -42,4 +42,4 @@ hermesEnabled=true
 
 # Public API Key for your Company
 # or override this from an untracked local.properties file
-publicApiKey=YOUR_PUBLIC_API_KEY
+publicApiKey=YOUR_PUBLIC_KLAVIYO_API_KEY

Diff for: example/android/local.properties.template

@@ -4,4 +4,4 @@
 # Only the base template should be checked in to VCS.
 # Copy this file to `local.properties` to set your local overrides
 
-publicApiKey=YOUR_PUBLIC_API_KEY
+publicApiKey=YOUR_PUBLIC_KLAVIYO_API_KEY

Diff for: example/ios/KlaviyoReactNativeSdkExample/AppDelegate.mm

@@ -9,29 +9,42 @@ @implementation AppDelegate
 // Change to NO if you don't want debug alerts or logs.
 BOOL isDebug = YES;
 
+// Change to NO if you prefer to initialize and handle push tokens in the React Native layer
+BOOL useNativeImplementation = YES;
 
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
   self.moduleName = @"KlaviyoReactNativeSdkExample";
   self.initialProps = @{};
-  
+
   // Installation Step 2: Set the UNUserNotificationCenter delegate to self
   [UNUserNotificationCenter currentNotificationCenter].delegate = self;
 
-  // Installation Step 3: Initilize the SDK with public key. 
-  [PushNotificationsHelper initializeSDK: @"YOUR_COMPANY_API_KEY_HERE"];
-  
-  // Installation Step 4: Request push permission from the user
-  [PushNotificationsHelper requestPushPermission];
+  if (useNativeImplementation) {
+    // Installation Step 3: Initialize the SDK with public key.
+    // Exclude if initializing from react native layer
+    [PushNotificationsHelper initializeSDK: @"YOUR_PUBLIC_KLAVIYO_API_KEY"];
+
+    // Installation Step 4: Request push permission from the user
+    // Exclude if handling permissions from react native layer
+    [PushNotificationsHelper requestPushPermission];
+  } else {
+    // Initialize cross-platform push library, e.g. Firebase
+  }
 
   return [super application:application didFinishLaunchingWithOptions:launchOptions];
 }
 
 // Installation Step 6: Implement this delegate to receive and set the push token
 - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
-  // Installation Step 7: set the push token to Klaviyo SDK
-  [PushNotificationsHelper setPushTokenWithToken:deviceToken];
-  
+  if (useNativeImplementation) {
+    // Installation Step 7: set the push token to Klaviyo SDK
+    // Exclude if handling push tokens from react native layer
+    [PushNotificationsHelper setPushTokenWithToken:deviceToken];
+  } else {
+    // Provide token to cross-platform push library, e.g. firebase
+  }
+
   if (isDebug) {
       NSString *token = [self stringFromDeviceToken:deviceToken];
       NSLog(@"Device Token: %@", token);
@@ -49,20 +62,20 @@ - (void)application:(UIApplication *)application didFailToRegisterForRemoteNotif
 // when the app is in the background
 // NOTE: this delegate will NOT be called if Installation Step 2 is not done.
 - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler {
-  // Installation Step 10: call `handleReceivingPushWithResponse` method and pass in the below arguments. Note that handleReceivingPushWithResponse calls our SDK and is
-  // something that has to be implemented in your app as well.
-  // furthur, if you want to intercept urls instead of them being routed to the system and system calling `application:openURL:options:` you can implement the `deepLinkHandler` below
+  // Installation Step 10: call `handleReceivingPushWithResponse` method and pass in the below arguments.
+  // Note that handleReceivingPushWithResponse calls our SDK and is something that has to be implemented in your app as well.
+  // Further, if you want to intercept urls instead of them being routed to the system and system calling `application:openURL:options:` you can implement the `deepLinkHandler` below
   [PushNotificationsHelper handleReceivingPushWithResponse:response completionHandler:completionHandler deepLinkHandler:^(NSURL * _Nonnull url) {
     NSLog(@"URL is %@", url);
     [RCTLinkingManager application:UIApplication.sharedApplication openURL: url options: @{}];
   }];
-  
+
   if (isDebug) {
     UIAlertController *alert = [UIAlertController
                                 alertControllerWithTitle:@"Push Notification"
                                 message:@"handled background notifications"
                                 preferredStyle:UIAlertControllerStyleAlert];
-    [alert addAction:[UIAlertAction 
+    [alert addAction:[UIAlertAction
                       actionWithTitle:@"OK"
                       style:UIAlertActionStyleDefault
                       handler:nil]];

Diff for: example/ios/KlaviyoReactNativeSdkExample/PushNotificationsHelper.swift

@@ -19,7 +19,7 @@ class PushNotificationsHelper: NSObject {
         if let error = error {
           print("AuthError", "error while trying to authorize push", error)
         } else {
-          // Installation Step 5: register for remote notifications after requesting permission on the main thread 
+          // Installation Step 5: register for remote notifications after requesting permission on the main thread
           DispatchQueue.main.async {
             UIApplication.shared.registerForRemoteNotifications()
           }

Diff for: example/ios/Podfile.lock

@@ -73,9 +73,9 @@ PODS:
     - hermes-engine/Pre-built (= 0.73.1)
   - hermes-engine/Pre-built (0.73.1)
   - klaviyo-react-native-sdk (0.1.2):
-    - KlaviyoSwift (= 3.0.2)
+    - KlaviyoSwift (= 3.0.3)
     - React-Core
-  - KlaviyoSwift (3.0.2):
+  - KlaviyoSwift (3.0.3):
     - AnyCodable-FlightSchool
   - libevent (2.1.12)
   - OpenSSL-Universal (1.1.1100)
@@ -1333,8 +1333,8 @@ SPEC CHECKSUMS:
   fmt: ff9d55029c625d3757ed641535fd4a75fedc7ce9
   glog: c5d68082e772fa1c511173d6b30a9de2c05a69a2
   hermes-engine: 34df9d5034e90bd9bf1505e1ca198760373935af
-  klaviyo-react-native-sdk: bb23fe38c4794e14613f0e1013acb8ffcf1834ba
-  KlaviyoSwift: b3454b6c177b67b72b0afa1b77f6bf6281e9c754
+  klaviyo-react-native-sdk: 2f9cd36e7fed062a0d76484a383f4a5dc3472183
+  KlaviyoSwift: 9318efaa92f5435d63aa093e3e9d49af947b7685
   libevent: 4049cae6c81cdb3654a443be001fb9bdceff7913
   OpenSSL-Universal: ebc357f1e6bc71fa463ccb2fe676756aff50e88c
   RCT-Folly: 7169b2b1c44399c76a47b5deaaba715eeeb476c0
@@ -1383,4 +1383,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 4b9faf5e512fab6e8d87beb30570ec4d3bd884b9
 
-COCOAPODS: 1.14.3
+COCOAPODS: 1.15.2

Diff for: example/src/AppViewInterface.ts

@@ -1,8 +1,10 @@
 import {
+  initialize,
   getEmail,
   getExternalId,
   getPhoneNumber,
   resetProfile,
+  setPushToken,
   sendRandomEvent,
   setEmail,
   setExternalId,
@@ -18,6 +20,11 @@ export interface AppViewInterface {
 }
 
 export const appViews: AppViewInterface[] = [
+  {
+    title: 'Click to initialize',
+    color: '#841584',
+    onPress: initialize,
+  },
   {
     title: 'Click to set the full profile',
     color: '#841584',
@@ -48,6 +55,11 @@ export const appViews: AppViewInterface[] = [
     color: '#ffcccb',
     onPress: resetProfile,
   },
+  {
+    title: 'Click to set a FAKE push token',
+    color: '#ffcccb',
+    onPress: setPushToken,
+  },
   {
     title: 'Click to get current email',
     color: '#841584',

Diff for: example/src/KlaviyoReactWrapper.ts

@@ -14,6 +14,15 @@ import {
   getRandomMetric,
 } from './RandomGenerators';
 
+export const initialize = async () => {
+  try {
+    // If initializing from RN Layer: (replace with your public key)
+    Klaviyo.initialize('YOUR_PUBLIC_KLAVIYO_API_KEY');
+  } catch (e: any) {
+    console.log(e.message, e.code);
+  }
+};
+
 export const setEmail = async () => {
   try {
     Klaviyo.setEmail(generateRandomEmails());
@@ -76,6 +85,16 @@ export const resetProfile = async () => {
   }
 };
 
+export const setPushToken = async () => {
+  try {
+    // If handling push tokens from the react native layer
+    // You would need a cross-platform push library to fetch the device token, e.g. firebase
+    Klaviyo.setPushToken('FAKE_PUSH_TOKEN');
+  } catch (e: any) {
+    console.log(e.message, e.code);
+  }
+};
+
 export const setProfileAttribute = async () => {
   try {
     Klaviyo.setProfileAttribute('CUSTOM', generateRandomName(12));

Diff for: ios/KlaviyoBridge.swift

@@ -42,6 +42,11 @@ public class KlaviyoBridge: NSObject {
       ProfileProperty.allCases.getDictionaryFromEnum()
   }
 
+  @objc
+  public static func initialize(_ apiKey: String) {
+      KlaviyoSDK().initialize(with: apiKey)
+  }
+
   @objc
   public static func setProfile(
       _ profileDict: [String: AnyObject]
@@ -107,6 +112,11 @@ public class KlaviyoBridge: NSObject {
       return KlaviyoSDK().phoneNumber ?? ""
   }
 
+  @objc
+  public static func setPushToken(_ value: String) {
+    KlaviyoSDK().set(pushToken: value)
+  }
+
   @objc
   public static func resetProfile() {
     KlaviyoSDK().resetProfile()

Diff for: ios/KlaviyoReactNativeSdk.mm

@@ -17,7 +17,10 @@ - (NSDictionary *)constantsToExport {
     };
 }
 
-//MARK: Setters
+RCT_EXPORT_METHOD(initialize: (NSString *)apiKey)
+{
+    [KlaviyoBridge initialize: apiKey];
+}
 
 RCT_EXPORT_METHOD(setProfile: (NSDictionary *)profileDict)
 {
@@ -54,6 +57,11 @@ - (NSDictionary *)constantsToExport {
     callback(@[phoneNumber]);
 }
 
+RCT_EXPORT_METHOD(setPushToken: (NSString *)pushToken)
+{
+    [KlaviyoBridge setPushToken: pushToken];
+}
+
 RCT_EXPORT_METHOD(resetProfile)
 {
     [KlaviyoBridge resetProfile];

Diff for: klaviyo-react-native-sdk.podspec

@@ -3,7 +3,7 @@ require "json"
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
 Pod::Spec.new do |s|
-  s.name         =  package["name"]
+  s.name         = package["name"]
   s.version      = package["version"]
   s.summary      = package["description"]
   s.homepage     = package["homepage"]
@@ -17,5 +17,5 @@ Pod::Spec.new do |s|
   s.pod_target_xcconfig = { "DEFINES_MODULE" => "YES" }
 
   s.dependency "React-Core"
-  s.dependency "KlaviyoSwift", "3.0.2"
+  s.dependency "KlaviyoSwift", "3.0.3"
 end