Version 2.0.0 Staging Branch (#217)

* Bump plist, package.json, xml to 1.3.0

* Chore | Yarn lockfile (#223)

* Had to run a yarn install to update lockfile (and husky i guess... still don't really know what husky is other than a dog)

* Husky got removed from dev dependencies causing new setups to be unable to add pre-commit hooks

* Required now

---------

Co-authored-by: Evan Masseau <>

* IAF | Update to the pending native releases (#222)

* Get the code compiling

* Use configure-sdk script to set to latest native SDK commit hashes for pending releases.

* Fix the config script to add all three pods. Update again

* pods must be added inside this block, so i added a comment to target the command to.
with this, the ios sample compiles

---------

Co-authored-by: Evan Masseau <>

* Disable local copy on switch to remote!

* Fix configure local script for swift SDK (#226)

* Was too fixated on the git branch/commit path, didn't notice I hadn't fixed the local SDK script

* comments

---------

Co-authored-by: Evan Masseau <>

* IAF | Android pre-release updates (#228)

* Android cleanup

* forgot to switch to latest android sdk commit for compiling in CI

---------

Co-authored-by: Evan Masseau <>

* Bump example to the latest swift sdk.

* IAF | Android constants fix (#229)

ProfileKey class now has a companion object inside, which broke our constants extractor. This fixes it so that we're filtering down by type <ProfileKey>

Co-authored-by: Evan Masseau <>

* Export FormConfiguration type (#232)

* SDK Version bumps: React to 2.0.0, Android to 4.0.0, Swift to 5.0.0 (#231)

* bump to major versions

* add in ios, fix some script errors since I didn't fully test this one (oops)

* Update to use final release numbers

* Rerun with published pods

* use bundler

---------

Co-authored-by: Evan Masseau <>
Co-authored-by: Isobelle Lim <[email protected]>

* Update README and add MIGRATION_GUIDE (#230)

* Update README and add MIGRATION_GUIDE

* generalize useEffect callout

* Bump to major version

* Undo version bumps

* Update to match iOS/Android READMEs

---------

Co-authored-by: Evan C Masseau <[email protected]>
Co-authored-by: Evan Masseau <>

Author: belleklaviyo

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - master
+      - rel/*
 
 permissions:
   contents: write

.husky/pre-commit

@@ -51,6 +51,12 @@ call_lefthook()
     elif command -v mint >/dev/null 2>&1
     then
       mint run csjones/lefthook-plugin "$@"
+    elif uv run lefthook -h >/dev/null 2>&1
+    then
+      uv run lefthook "$@"
+    elif mise exec -- lefthook -h >/dev/null 2>&1
+    then
+      mise exec -- lefthook "$@"
     else
       echo "Can't find lefthook in PATH"
     fi

.husky/prepare-commit-msg

@@ -51,6 +51,12 @@ call_lefthook()
     elif command -v mint >/dev/null 2>&1
     then
       mint run csjones/lefthook-plugin "$@"
+    elif uv run lefthook -h >/dev/null 2>&1
+    then
+      uv run lefthook "$@"
+    elif mise exec -- lefthook -h >/dev/null 2>&1
+    then
+      mise exec -- lefthook "$@"
     else
       echo "Can't find lefthook in PATH"
     fi

MIGRATION_GUIDE.md

@@ -0,0 +1,22 @@
+# React Native SDK Migration Guide
+
+This guide outlines how developers can migrate from older versions of our SDK to newer ones.
+
+## Migrating to v2.0.0
+
+### In-App Forms
+
+As a result of changes summarized below, you may wish to revisit the logic of when you call `registerForInAppForms()` when upgrading from 1.2.0, particularly if you were registering than once per application session. Consult the [README](./README.md#in-app-forms) for the latest integration instructions.
+
+#### Updated behaviors
+
+- In version 1.2.0, calling `registerForInAppForms()` functioned like a "fetch" that would check if a form was available and if yes, display it. Version 2.0.0 changes this behavior so that `registerForInAppForms()` sets up a persistent listener that will be ready to display a form if and when one is targeted to the current profile.
+- A deep link from an In-App Form will now be issued _after_ the form has closed, instead of during the close animation in order to prevent a race condition if the host application expects the form to be closed before handling the deep link.
+
+#### Configurable In-App Form session timeout
+
+Introduced a configurable session timeout for In-App Forms, which defaults to 60 minutes, as an optional argument to `registerForInAppForms()`.
+
+#### New `unregisterFromInAppForms()` method
+
+Because the `registerForInAppForms()` method now functions as a persistent listener rather than a "fetch", we've introduced an [`unregisterFromInAppForms()` method](./README.md#unregister-from-in-app-forms) so you can stop listening for In-App Forms at appropriate times, such as when a user logs out.

README.md

@@ -37,7 +37,8 @@
   - [In-App Forms](#in-app-forms)
     - [Prerequisites](#prerequisites-1)
     - [Setup](#setup-1)
-    - [Behavior](#behavior)
+      - [In-App Forms Session Configuration](#in-app-forms-session-configuration)
+    - [Unregistering from In-App Forms](#unregistering-from-in-app-forms)
   - [Troubleshooting](#troubleshooting)
   - [Contributing](#contributing)
   - [License](#license)
@@ -498,16 +499,28 @@ Klaviyo messages can also include key-value pairs (custom data) for both standar
 
 ## In-App Forms
 
-[In-app forms](https://help.klaviyo.com/hc/en-us/articles/34567685177883) are messages displayed to mobile app users while they are actively using an app. You can create new in-app forms in a drag-and-drop editor in the Sign-Up Forms tab in Klaviyo. Follow the instructions in this section to integrate forms with your app. The SDK will display forms according to their targeting and behavior settings and collect delivery and engagement analytics automatically.
+[In-App Forms](https://help.klaviyo.com/hc/en-us/articles/34567685177883) are messages displayed to mobile app users while they are actively using an app. You can create new In-App Forms in a drag-and-drop editor in the Sign-Up Forms tab in Klaviyo. Follow the instructions in this section to integrate forms with your app. The SDK will display forms according to their targeting and behavior settings and collect delivery and engagement analytics automatically.
+
+Beginning with version 2.0.0, In-App Forms supports advanced targeting and segmentation. In your Klaviyo account, you can configure forms to target or exclude specific lists or segments, and the form will only be shown to users matching those criteria, based on their profile identifiers set via the Klaviyo SDK API.
 
 ### Prerequisites
 
 - Using Version 1.2.0 and higher
 - Import the Klaviyo module
+- We strongly recommend using the latest version of the SDK to ensure compatibility with the latest In-App Forms features. The minimum SDK version supporting In-App Forms is 1.2.0, and a feature matrix is provided below. Forms that leverage unsupported features will not appear in your app until you update to a version that supports those features.
+- Please read the [migration guide](MIGRATION_GUIDE.md) if you are upgrading from 1.2.0 to understanding changes to In-App Forms behavior.
+
+| Feature            | Minimum SDK Version |
+| ------------------ | ------------------- |
+| Basic In-App Forms | 1.2.0+              |
+| Time Delay         | 2.0.0               |
+| Audience Targeting | 2.0.0               |
 
 ### Setup
 
-To display in-app forms, add the following code to your application
+To configure your app to display In-App Forms, call `Klaviyo.registerForInAppForms()` after initializing the SDK with your public API key. Once registered, the SDK may launch an overlay view at any time to present a form according to its targeting and behavior settings configured in your Klaviyo account.
+
+For the best user experience, we recommend registering after any splash screen or loading animations have completed. Depending on your app's architecture, this might be in a particular Screen's useEffect.
 
 ```
 import { Klaviyo } from "klaviyo-react-native-sdk";
@@ -517,20 +530,32 @@ import { Klaviyo } from "klaviyo-react-native-sdk";
 Klaviyo.registerForInAppForms();
 ```
 
-### Behavior
+#### In-App Forms Session Configuration
+
+A "session" is considered to be a logical unit of user engagement with the app, defined as a series of foreground interactions that occur within a continuous or near-continuous time window. This is an important concept for In-App Forms, as we want to ensure that a user will not see a form multiple times within a single session.
+
+A session will time out after a specified period of inactivity. When a user launches the app, if the time between the previous interaction with the app and the current one exceeds the specified timeout, we will consider this a new session.
+
+This timeout has a default value of 3600 seconds (1 hour), but it can be customized. To do so, pass an `FormConfiguration` object to the `registerForInAppForms()` method. For example, to set a session timeout of 30 minutes:
+
+```
+import { Klaviyo } from "klaviyo-react-native-sdk";
+
+let config: FormConfiguration = { sessionTimeoutDuration: 1800 }
+Klaviyo.registerForInAppForms(config);
+```
 
-Once `registerForInAppForms()` is called, the SDK will load form data for your account and display no more than one form within 15 seconds, based on form targeting and behavior settings.
+### Unregistering from In-App Forms
 
-You can call `registerForInAppForms()` any time after initializing with your public API key to control when and where in your app's UI a form can appear. It is safe to register multiple times per application session. The SDK will internally prevent multiple forms appearing at once.
+If at any point you need to prevent the SDK from displaying In-App Forms, e.g. when the user logs out, you may call:
 
-Consider how often you want to register for forms. For example, registering from a lifecycle event is advisable so that the user has multiple opportunities to see your messaging if they are browsing your app for a prolonged period. However, be advised the form will be shown as soon as it is ready, so you may still need to condition this based on the user's context within your application. Future versions of this product will provide more control in this regard.
+```
+import { Klaviyo } from "klaviyo-react-native-sdk";
 
-| Callback                                                                                             | Description                                                             |
-| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| `const handleAppStateChange = async (nextAppState: string) => {  Klaviyo.registerForInAppForms(); }` | Anytime the app is foregrounded, check for forms and show if available. |
-| `function App(): JSX.Element { useEffect(() => {  Klaviyo.registerForInAppForms(); }};`              | Show a form upon initial app launch.                                    |
+Klaviyo.unregisterFromInAppForms(config);
+```
 
-**Note**: At this time, when device orientation changes any currently visible form is closed and will not be re-displayed automatically.
+Note that after unregistering, the next call to `registerForInAppForms()` will be considered a new session by the SDK.
 
 ## Troubleshooting
 

android/gradle.properties

@@ -11,14 +11,9 @@ 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=3.3.1
+KlaviyoReactNativeSdk_klaviyoAndroidSdkVersion=4.0.0
 KlaviyoReactNativeSdk_kotlinVersion=1.8.0
 KlaviyoReactNativeSdk_minSdkVersion=23
 KlaviyoReactNativeSdk_targetSdkVersion=31
 KlaviyoReactNativeSdk_compileSdkVersion=31
 KlaviyoReactNativeSdk_ndkversion=21.4.7075529
-
-# For local SDK development: set to true in your local.properties file
-# you must set separately for the example app and the library
-localCompositeBuild=false
-localSdkPath=../../klaviyo-android-sdk

android/settings.gradle

@@ -1,28 +1,30 @@
 // Substitute the jitpack SDK dependency for your local instance of the project
-// Enabling here allows you to develop against a local android SDK for kotlin files in the library module
-if (file("local.properties").canRead()) {
-    def localProperties = new Properties()
-    localProperties.load(new FileInputStream(file("local.properties")))
-    localCompositeBuild = localProperties["localCompositeBuild"] ?: localCompositeBuild
-    localSdkPath = localProperties["localSdkPath"] ?: localSdkPath
-}
+// Enabling here allows you to build the example app against a local android SDK
+def localPropertiesFile = file("local.properties")
+
+if (localPropertiesFile.exists() && localPropertiesFile.canRead()) {
+  def localProperties = new Properties()
+  localProperties.load(new FileInputStream(localPropertiesFile))
+  def localCompositeBuild = localProperties["localCompositeBuild"] == "true"
+  def localSdkPath = localProperties["localSdkPath"] as String
 
-if (localCompositeBuild == "true") {
+  if (localCompositeBuild) {
     def sdkDirectory = new File(localSdkPath)
 
     if (!sdkDirectory.exists()) {
-        throw new GradleException("Local Klaviyo Android SDK directory does not exist: " + sdkDirectory.getAbsolutePath())
+      throw new GradleException("Local Klaviyo Android SDK directory does not exist: " + sdkDirectory.getAbsolutePath())
     } else {
-        print("Configuring composite project with local Klaviyo Android SDK for library.")
+      print("Configuring composite project with local Klaviyo Android SDK for library.")
     }
 
     includeBuild(sdkDirectory) {
-        dependencySubstitution {
-            // substitute remote dependency with local module
-            substitute module("com.github.klaviyo.klaviyo-android-sdk:core") using project(":sdk:core")
-            substitute module("com.github.klaviyo.klaviyo-android-sdk:analytics") using project(":sdk:analytics")
-            substitute module("com.github.klaviyo.klaviyo-android-sdk:forms") using project(":sdk:forms")
-            substitute module("com.github.klaviyo.klaviyo-android-sdk:push-fcm") using project(":sdk:push-fcm")
-        }
+      dependencySubstitution {
+        // substitute remote dependency with local module
+        substitute module("com.github.klaviyo.klaviyo-android-sdk:core") using project(":sdk:core")
+        substitute module("com.github.klaviyo.klaviyo-android-sdk:analytics") using project(":sdk:analytics")
+        substitute module("com.github.klaviyo.klaviyo-android-sdk:forms") using project(":sdk:forms")
+        substitute module("com.github.klaviyo.klaviyo-android-sdk:push-fcm") using project(":sdk:push-fcm")
+      }
     }
-}
+  }
+}

android/src/main/java/com/klaviyoreactnativesdk/KlaviyoReactNativeSdkModule.kt

@@ -15,9 +15,12 @@ import com.klaviyo.analytics.model.Profile
 import com.klaviyo.analytics.model.ProfileKey
 import com.klaviyo.core.Registry
 import com.klaviyo.core.utils.AdvancedAPI
+import com.klaviyo.forms.InAppFormsConfig
 import com.klaviyo.forms.registerForInAppForms
+import com.klaviyo.forms.unregisterFromInAppForms
 import java.io.Serializable
 import kotlin.reflect.KVisibility
+import kotlin.time.Duration.Companion.seconds
 
 class KlaviyoReactNativeSdkModule(
   private val reactContext: ReactApplicationContext,
@@ -44,7 +47,7 @@ class KlaviyoReactNativeSdkModule(
     T::class
       .nestedClasses
       .filter {
-        it.visibility == KVisibility.PUBLIC && it.objectInstance != null
+        it.visibility == KVisibility.PUBLIC && it.objectInstance is T
       }.associate {
         it.simpleName.toString() to (it.objectInstance as T).name
       }
@@ -60,16 +63,28 @@ class KlaviyoReactNativeSdkModule(
   }
 
   @ReactMethod
-  fun registerForInAppForms() {
+  fun registerForInAppForms(configuration: ReadableMap?) {
     UiThreadUtil.runOnUiThread {
       try {
-        Klaviyo.registerForInAppForms()
+        val timeout = configuration?.getDouble("sessionTimeoutDuration")?.seconds
+        Klaviyo.registerForInAppForms(
+          InAppFormsConfig(
+            sessionTimeoutDuration = timeout ?: InAppFormsConfig.DEFAULT_SESSION_TIMEOUT,
+          ),
+        )
       } catch (e: Exception) {
         Registry.log.error("Android unable to register for in app forms on main thread", e)
       }
     }
   }
 
+  @ReactMethod
+  fun unregisterFromInAppForms() {
+    UiThreadUtil.runOnUiThread {
+      Klaviyo.unregisterFromInAppForms()
+    }
+  }
+
   @ReactMethod
   fun setProfile(profile: ReadableMap) {
     val parsedProfile = Profile()

android/src/main/res/values/strings.xml

@@ -1,4 +1,4 @@
 <resources>
-  <string name="klaviyo_sdk_version_override">1.2.0</string>
+  <string name="klaviyo_sdk_version_override">2.0.0</string>
   <string name="klaviyo_sdk_name_override">react_native</string>
 </resources>

bump-version.sh

@@ -5,7 +5,7 @@ read -rp "Enter the new React SDK version: " new_version
 
 # Update SDK version in package.json
 if [[ -f "package.json" ]]; then
-  sed -i '' "0,/\"version\": \".*\"/s//\"version\": \"$new_version\"/" package.json
+  jq --arg newVersion "$new_version" '.version = $newVersion' package.json > tmp.json && mv tmp.json package.json
   echo "Updated SDK version in package.json."
 else
   echo "Error: package.json not found."
@@ -52,7 +52,8 @@ read -rp "Enter the Swift SDK version: " swift_version
 podspec_file="klaviyo-react-native-sdk.podspec"
 if [[ -f "$podspec_file" ]]; then
   sed -i '' "s/\"KlaviyoSwift\", \".*\"/\"KlaviyoSwift\", \"$swift_version\"/" "$podspec_file"
-  echo "Updated KlaviyoSwift version in $podspec_file."
+  sed -i '' "s/\"KlaviyoForms\", \".*\"/\"KlaviyoForms\", \"$swift_version\"/" "$podspec_file"
+  echo "Updated KlaviyoSwift and KlaviyoForms version in $podspec_file."
 else
   echo "Error: $podspec_file not found."
   exit 1