Utils | Added configure-sdk and bump-version scripts (#219)

* Enabled development against local copy of klaviyo-android-sdk via composite builds.

* Added configure-sdk.sh script to manage switching between local and remote SDK targets for android.

* Added iOS config to the script

* Aaaand a bump-version script to walk you through a version update

---------

Co-authored-by: Evan Masseau <>

Author: evan-masseau

android/build.gradle

@@ -8,7 +8,8 @@ buildscript {
   }
 
   dependencies {
-    classpath "com.android.tools.build:gradle:7.3.1"
+    // Android Gradle Plugin. Best to keep in sync with the klaviyo-android-sdk AGP version
+    classpath "com.android.tools.build:gradle:8.8.0"
     // noinspection DifferentKotlinGradleVersion
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }
@@ -95,7 +96,7 @@ def klaviyoAndroidSdkVersion = getExtOrDefault("klaviyoAndroidSdkVersion")
 def kotlin_version = getExtOrDefault("kotlinVersion")
 def localProperties = new Properties()
 if (rootProject.file("local.properties").canRead()) {
-    localProperties.load(new FileInputStream(rootProject.file("local.properties")))
+  localProperties.load(new FileInputStream(rootProject.file("local.properties")))
 }
 def reactNativeAndroidVersion = localProperties['reactNativeAndroidVersion'] ?: ""
 
@@ -113,6 +114,7 @@ dependencies {
     //noinspection GradleDynamicVersion
     implementation "com.facebook.react:react-native:+"
   }
+
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   // Klaviyo Android SDK

android/gradle.properties

@@ -17,3 +17,8 @@ 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/local.properties.template

@@ -6,3 +6,8 @@
 ## Used for local SDK development, so that gradle can locate the
 # correct RN version outside the context of an application
 reactNativeAndroidVersion=0.78.0
+
+# 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

@@ -0,0 +1,28 @@
+// 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
+}
+
+if (localCompositeBuild == "true") {
+    def sdkDirectory = new File(localSdkPath)
+
+    if (!sdkDirectory.exists()) {
+        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.")
+    }
+
+    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")
+        }
+    }
+}

bump-version.sh

@@ -0,0 +1,92 @@
+#!/bin/bash
+
+# Prompt for the new React SDK version
+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
+  echo "Updated SDK version in package.json."
+else
+  echo "Error: package.json not found."
+  exit 1
+fi
+
+# Update klaviyo_sdk_version in iOS plist file
+plist_file="ios/klaviyo-sdk-configuration.plist"
+if [[ -f "$plist_file" ]]; then
+  /usr/libexec/PlistBuddy -c "Set :klaviyo_sdk_version $new_version" "$plist_file"
+  echo "Updated klaviyo_sdk_version in $plist_file."
+else
+  echo "Error: $plist_file not found."
+  exit 1
+fi
+
+# Update klaviyo_sdk_version_override in Android strings.xml
+android_strings="android/src/main/res/values/strings.xml"
+if [[ -f "$android_strings" ]]; then
+  sed -i '' "s/<string name=\"klaviyo_sdk_version_override\">.*<\/string>/<string name=\"klaviyo_sdk_version_override\">$new_version<\/string>/" "$android_strings"
+  echo "Updated klaviyo_sdk_version_override in $android_strings."
+else
+  echo "Error: $android_strings not found."
+  exit 1
+fi
+
+# Prompt for the Android SDK version
+read -rp "Enter the Android SDK version: " android_version
+
+# Update Android SDK version in gradle.properties
+gradle_properties="./android/gradle.properties"
+if [[ -f "$gradle_properties" ]]; then
+  sed -i '' "s/KlaviyoReactNativeSdk_klaviyoAndroidSdkVersion=.*/KlaviyoReactNativeSdk_klaviyoAndroidSdkVersion=$android_version/" "$gradle_properties"
+  echo "Updated Android SDK version in $gradle_properties."
+else
+  echo "Error: $gradle_properties not found."
+  exit 1
+fi
+
+# Prompt for the Swift SDK version
+read -rp "Enter the Swift SDK version: " swift_version
+
+# Update Swift SDK version in the podspec
+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."
+else
+  echo "Error: $podspec_file not found."
+  exit 1
+fi
+
+# Run yarn install or npm install in the example app directory
+example_dir="example"
+if [[ -d "$example_dir" ]]; then
+  echo "Running yarn install in $example_dir..."
+  cd "$example_dir" || exit
+  if ! yarn install; then
+    echo "yarn install failed. Trying npm install..."
+    npm install || { echo "Error: Failed to install dependencies."; exit 1; }
+  fi
+  cd - || exit
+else
+  echo "Error: $example_dir not found."
+  exit 1
+fi
+
+# Run bundle install and pod update in the iOS directory
+ios_dir="$example_dir/ios"
+if [[ -d "$ios_dir" ]]; then
+  cd "$ios_dir" || exit
+  if [[ -f "Gemfile" ]]; then
+    echo "Running bundle install..."
+    bundle install || { echo "Error: Failed to run bundle install."; exit 1; }
+  fi
+  echo "Running pod update for KlaviyoSwift..."
+  bundle exec pod update KlaviyoSwift || { echo "Error: Failed to update pods."; exit 1; }
+  cd - || exit
+else
+  echo "Error: $ios_dir not found."
+  exit 1
+fi
+
+echo "All tasks completed successfully."