react-native-userleap 2.19.2 → 2.21.0

package/android/build.gradle

@@ -70,11 +70,12 @@ repositories {
 }
 dependencies {
     implementation 'com.facebook.react:react-native:+'  // From node_modules
-    
+    implementation "androidx.webkit:webkit:1.8.0"
+
     // Use conditional logic for local vs Maven
     if (findProject(':userleap-android-sdk') != null) {
         implementation project(':userleap-android-sdk')
     } else {
-        implementation ("com.userleap:userleap-android-sdk:2.21.2") // update this version on android updates
+        implementation ("com.userleap:userleap-android-sdk:2.23.0") // update this version on android updates
     }
 }

package/android/src/main/java/com/userleap/reactnative/UserLeapModule.java

@@ -1,23 +1,38 @@
 package com.userleap.reactnative;
 
 import android.app.Activity;
+import android.util.Log;
 
 import androidx.fragment.app.FragmentActivity;
 
+import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.Callback;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.WritableMap;
+import com.facebook.react.modules.core.DeviceEventManagerModule;
 
+import com.userleap.EventListener;
+import com.userleap.EventName;
+import com.userleap.EventPayload;
+import com.userleap.SprigEvent;
+import com.userleap.SprigSurveyResult;
 import com.userleap.SurveyState;
 import com.userleap.UserLeap;
 
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.util.EnumSet;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import javax.annotation.Nullable;
@@ -25,19 +40,38 @@ import javax.annotation.Nullable;
 import kotlin.Unit;
 import kotlin.jvm.functions.Function1;
 
-import android.util.Log;
-
-import com.userleap.EventListener;
-import com.userleap.EventName;
-import com.userleap.SprigEvent;
-import com.userleap.SprigLoggingLevel;
-import com.userleap.UserLeap;
-
-import kotlin.Unit;
-import kotlin.jvm.functions.Function1;
-
 public class UserLeapModule extends ReactContextBaseJavaModule {
 
+    private static final String TAG = "UserLeapModule";
+
+    /**
+     * Lifecycle events we forward to React Native via DeviceEventEmitter.
+     * Excluded:
+     *   - LOGGING_EVENT: handled separately via logcat
+     *   - REPLAY_CAPTURE: internal Web SDK plumbing, not meaningful to RN consumers
+     *   - REPLAY_EVENTS_UPLOADED_COMPLETED: deprecated alias for REPLAY_EVENTS_UPLOAD_COMPLETED
+     */
+    private static final Set<EventName> FORWARDED_EVENTS = EnumSet.of(
+            EventName.SDK_READY,
+            EventName.VISITOR_ID_UPDATED,
+            EventName.SURVEY_HEIGHT,
+            EventName.SURVEY_STATE_RETURNED,
+            EventName.SURVEY_WILL_PRESENT,
+            EventName.SURVEY_PRESENTED,
+            EventName.SURVEY_APPEARED,
+            EventName.QUESTION_ANSWERED,
+            EventName.SURVEY_CLOSE_REQUESTED,
+            EventName.SURVEY_WILL_CLOSE,
+            EventName.SURVEY_CLOSED,
+            EventName.SURVEY_COMPLETED,
+            EventName.REPLAY_CAPTURE_STARTED,
+            EventName.REPLAY_CAPTURE_STOPPED,
+            EventName.REPLAY_CAPTURE_COMPLETED,
+            EventName.REPLAY_RENDERING_COMPLETED,
+            EventName.REPLAY_UPLOAD_COMPLETED,
+            EventName.REPLAY_EVENTS_UPLOAD_COMPLETED
+    );
+
     private final ReactApplicationContext reactContext;
 
     public UserLeapModule(ReactApplicationContext reactContext) {
@@ -50,6 +84,157 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
         return "UserLeapBindings";
     }
 
+    // ---------------------------------------------------------------------------
+    // Required stubs for RN's NativeEventEmitter on the JS side.
+    // ---------------------------------------------------------------------------
+
+    @ReactMethod
+    public void addListener(String eventName) {
+        // No-op: listeners are registered once in configure() for the SDK lifetime.
+    }
+
+    @ReactMethod
+    public void removeListeners(int count) {
+        // No-op: listeners are registered once in configure() for the SDK lifetime.
+    }
+
+    // ---------------------------------------------------------------------------
+    // Lifecycle event registration
+    // ---------------------------------------------------------------------------
+
+    private void registerForAllLifecycleEvents() {
+        for (EventName eventName : FORWARDED_EVENTS) {
+            UserLeap.INSTANCE.addEventListener(eventName, new EventListener() {
+                @Override
+                public void onEvent(SprigEvent event) {
+                    sendSprigEvent(event);
+                }
+            });
+        }
+    }
+
+    private void sendSprigEvent(SprigEvent event) {
+        if (!reactContext.hasActiveCatalystInstance()) {
+            return;
+        }
+
+        WritableMap params = jsonObjectToWritableMap(event.getData());
+        String eventName = toCamelCase(event.getName().name());
+
+        reactContext
+                .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
+                .emit(eventName, params);
+    }
+
+    // ---------------------------------------------------------------------------
+    // Bridge helpers
+    // ---------------------------------------------------------------------------
+
+    /**
+     * Converts UPPER_SNAKE_CASE to camelCase to match the iOS event naming
+     * convention expected by the JS layer.
+     * e.g. "SURVEY_WILL_PRESENT" -> "surveyWillPresent"
+     */
+    private String toCamelCase(String upperSnakeCase) {
+        String[] parts = upperSnakeCase.toLowerCase().split("_");
+        StringBuilder sb = new StringBuilder(parts[0]);
+        for (int i = 1; i < parts.length; i++) {
+            sb.append(Character.toUpperCase(parts[i].charAt(0)));
+            sb.append(parts[i].substring(1));
+        }
+        return sb.toString();
+    }
+
+    /**
+     * Shallow-converts a JSONObject to a WritableMap for passing across the RN bridge.
+     */
+    private WritableMap jsonObjectToWritableMap(@Nullable JSONObject json) {
+        WritableMap map = Arguments.createMap();
+        if (json == null) {
+            return map;
+        }
+        Iterator<String> keys = json.keys();
+        while (keys.hasNext()) {
+            String key = keys.next();
+            try {
+                Object value = json.get(key);
+                if (value instanceof String) {
+                    map.putString(key, (String) value);
+                } else if (value instanceof Boolean) {
+                    map.putBoolean(key, (Boolean) value);
+                } else if (value instanceof Integer) {
+                    map.putInt(key, (Integer) value);
+                } else if (value instanceof Double) {
+                    map.putDouble(key, (Double) value);
+                } else if (value instanceof JSONObject) {
+                    map.putMap(key, jsonObjectToWritableMap((JSONObject) value));
+                } else if (value == JSONObject.NULL) {
+                    map.putNull(key);
+                } else {
+                    map.putString(key, value.toString());
+                }
+            } catch (JSONException e) {
+                Log.w(TAG, "Failed to convert key '" + key + "' from SprigEvent data", e);
+            }
+        }
+        return map;
+    }
+
+    /**
+     * Converts a SprigSurveyResult to a WritableMap for passing across the RN bridge.
+     * Returns { surveyState: string, surveyId: int }
+     */
+    private WritableMap surveyResultToWritableMap(SprigSurveyResult surveyResult) {
+        WritableMap resultMap = Arguments.createMap();
+        resultMap.putString("surveyState", surveyResult.getSurveyState().name());
+        if (surveyResult.getSurveyId() != null) {
+            resultMap.putInt("surveyId", surveyResult.getSurveyId());
+        } else {
+            resultMap.putInt("surveyId", 0);
+        }
+        return resultMap;
+    }
+
+    /**
+     * Wraps a RN Callback as a Function1<SprigSurveyResult, Unit> for the EventPayload API.
+     * Returns null if the callback is null.
+     */
+    private @Nullable Function1<SprigSurveyResult, Unit> wrapResultCallback(@Nullable final Callback callback) {
+        if (callback == null) {
+            return null;
+        }
+        return new Function1<SprigSurveyResult, Unit>() {
+            @Override
+            public Unit invoke(SprigSurveyResult surveyResult) {
+                callback.invoke(surveyResultToWritableMap(surveyResult));
+                return null;
+            }
+        };
+    }
+
+    private Map<String, String> stringifyMap(ReadableMap map) {
+        Map<String, String> stringifiedMap = new HashMap<>();
+        if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.N) {
+            stringifiedMap = map.toHashMap().entrySet().stream()
+                    .filter(m -> m.getKey() != null && m.getValue() != null)
+                    .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().toString()));
+        }
+        return stringifiedMap;
+    }
+
+    private @Nullable FragmentActivity getFragmentActivity() {
+        Activity activity = getCurrentActivity();
+        if (activity instanceof FragmentActivity) {
+            return (FragmentActivity) activity;
+        } else {
+            return null;
+        }
+    }
+
+    // ---------------------------------------------------------------------------
+    // SDK properties
+    // ---------------------------------------------------------------------------
+
     @ReactMethod(isBlockingSynchronousMethod = true)
     public int visitorIdentifier() {
         final Integer visitorIdentifierObject = UserLeap.INSTANCE.getVisitorIdentifier();
@@ -67,15 +252,16 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
         return UserLeap.INSTANCE.getSdkVersion();
     }
 
+    // ---------------------------------------------------------------------------
+    // Configuration
+    // ---------------------------------------------------------------------------
+
     @ReactMethod
     public void configure(String environment, ReadableMap configuration) {
-
         UserLeap.INSTANCE.addEventListener(EventName.LOGGING_EVENT, new EventListener() {
             @Override
             public void onEvent(SprigEvent event) {
-
                 String tag = "SprigLoggingEvent";
-
                 switch (event.getLogLevel()) {
                     case INFO:
                         Log.i(tag, event.getLogMessage());
@@ -94,14 +280,20 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
             }
         });
 
+        registerForAllLifecycleEvents();
+
         UserLeap.INSTANCE.configure(
-            reactContext,
-            environment,
-            stringifyMap(configuration),
-            getFragmentActivity()
+                reactContext,
+                environment,
+                stringifyMap(configuration),
+                getFragmentActivity()
         );
     }
 
+    // ---------------------------------------------------------------------------
+    // Deprecated track methods (return SurveyState string)
+    // ---------------------------------------------------------------------------
+
     @ReactMethod
     public void track(String event, final Callback surveyStateCallback) {
         trackAndIdentify(event, null, null, surveyStateCallback);
@@ -109,19 +301,17 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
 
     @ReactMethod
     public void trackWithProperties(String event, String userId, String partnerAnonymousId, ReadableMap properties, final Callback surveyStateCallback) {
-         if (surveyStateCallback == null) {
+        if (surveyStateCallback == null) {
             UserLeap.INSTANCE.track(event, userId, partnerAnonymousId, stringifyMap(properties));
-         } else {
+        } else {
             UserLeap.INSTANCE.track(event, userId, partnerAnonymousId, stringifyMap(properties), new Function1<SurveyState, Unit>() {
                 @Override
                 public Unit invoke(SurveyState surveyState) {
-                    if (surveyStateCallback!=null) {
-                        surveyStateCallback.invoke(surveyState.name());
-                    }
+                    surveyStateCallback.invoke(surveyState.name());
                     return null;
                 }
-            }); 
-         }
+            });
+        }
     }
 
     @ReactMethod
@@ -139,50 +329,46 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
         }
     }
 
-    @ReactMethod
-    public void setEmailAddress(String emailAddress) {
-        UserLeap.INSTANCE.setEmailAddress(emailAddress);
-    }
-
-    @ReactMethod
-    public void setVisitorAttribute(String key, String value) {
-        UserLeap.INSTANCE.setVisitorAttribute(key, value);
-    }
-
-    @ReactMethod
-    public void setVisitorAttributes(ReadableMap attributes) {
-        UserLeap.INSTANCE.setVisitorAttributes(stringifyMap(attributes));
-    }
+    // ---------------------------------------------------------------------------
+    // New track methods (return SprigSurveyResult via EventPayload)
+    // ---------------------------------------------------------------------------
 
     @ReactMethod
-    public void setVisitorAttributesAndIdentify(ReadableMap attributes, String userId, String partnerAnonymousId) {
-        UserLeap.INSTANCE.setVisitorAttributes(stringifyMap(attributes), userId, partnerAnonymousId);
-    }
-
-    @ReactMethod
-    public void removeVisitorAttributes(ReadableArray attributes) {
-        if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.N) {
-            List<String> attributeStrings = attributes.toArrayList().stream()
-                    .map(object -> Objects.toString(object, null))
-                    .collect(Collectors.toList());
-            UserLeap.INSTANCE.removeVisitorAttributes(attributeStrings);
-        }
+    public void trackEvent(String event, final Callback surveyStateCallback) {
+        trackEventAndIdentify(event, null, null, surveyStateCallback);
     }
 
     @ReactMethod
-    public void setPreviewKey(String previewKey) {
-        UserLeap.INSTANCE.setPreviewKey(previewKey);
+    public void trackEventWithProperties(String event, String userId, String partnerAnonymousId, ReadableMap properties, final Callback surveyStateCallback) {
+        EventPayload payload = new EventPayload(
+                event,
+                userId,
+                partnerAnonymousId,
+                stringifyMap(properties),
+                wrapResultCallback(surveyStateCallback),
+                null, // shouldShowSurveyCallback
+                null  // deprecated callback
+        );
+        UserLeap.INSTANCE.track(payload);
     }
 
     @ReactMethod
-    public void setUserIdentifier(String identifier) {
-        UserLeap.INSTANCE.setUserIdentifier(identifier);
+    public void trackEventAndIdentify(String event, String userId, String partnerAnonymousId, final Callback surveyStateCallback) {
+        EventPayload payload = new EventPayload(
+                event,
+                userId,
+                partnerAnonymousId,
+                null, // properties
+                wrapResultCallback(surveyStateCallback),
+                null, // shouldShowSurveyCallback
+                null  // deprecated callback
+        );
+        UserLeap.INSTANCE.track(payload);
     }
 
-    @ReactMethod
-    public void logout() {
-        UserLeap.INSTANCE.logout();
-    }
+    // ---------------------------------------------------------------------------
+    // Track and present
+    // ---------------------------------------------------------------------------
 
     @ReactMethod
     public void trackAndPresent(String event) {
@@ -194,6 +380,10 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
         UserLeap.INSTANCE.trackAndPresent(event, userId, partnerAnonymousId, getFragmentActivity());
     }
 
+    // ---------------------------------------------------------------------------
+    // Survey presentation
+    // ---------------------------------------------------------------------------
+
     @ReactMethod
     public void presentSurvey() {
         UserLeap.INSTANCE.presentSurvey(null);
@@ -214,23 +404,52 @@ public class UserLeapModule extends ReactContextBaseJavaModule {
         UserLeap.INSTANCE.unpauseDisplayingSurveys();
     }
 
-    private @Nullable
-    FragmentActivity getFragmentActivity() {
-        Activity activity = getCurrentActivity();
-        if (activity instanceof FragmentActivity) {
-            return (FragmentActivity) activity;
-        } else {
-            return null;
-        }
+    // ---------------------------------------------------------------------------
+    // User identity & attributes
+    // ---------------------------------------------------------------------------
+
+    @ReactMethod
+    public void setEmailAddress(String emailAddress) {
+        UserLeap.INSTANCE.setEmailAddress(emailAddress);
     }
 
-    private Map<String, String> stringifyMap(ReadableMap map) {
-        Map<String,String> stringifiedMap = new HashMap<>();
+    @ReactMethod
+    public void setVisitorAttribute(String key, String value) {
+        UserLeap.INSTANCE.setVisitorAttribute(key, value);
+    }
+
+    @ReactMethod
+    public void setVisitorAttributes(ReadableMap attributes) {
+        UserLeap.INSTANCE.setVisitorAttributes(stringifyMap(attributes));
+    }
+
+    @ReactMethod
+    public void setVisitorAttributesAndIdentify(ReadableMap attributes, String userId, String partnerAnonymousId) {
+        UserLeap.INSTANCE.setVisitorAttributes(stringifyMap(attributes), userId, partnerAnonymousId);
+    }
+
+    @ReactMethod
+    public void removeVisitorAttributes(ReadableArray attributes) {
         if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.N) {
-            stringifiedMap = map.toHashMap().entrySet().stream()
-                 .filter(m -> m.getKey() != null && m.getValue() !=null)
-                 .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().toString()));
+            List<String> attributeStrings = attributes.toArrayList().stream()
+                    .map(object -> Objects.toString(object, null))
+                    .collect(Collectors.toList());
+            UserLeap.INSTANCE.removeVisitorAttributes(attributeStrings);
         }
-        return stringifiedMap;
     }
-}
+
+    @ReactMethod
+    public void setPreviewKey(String previewKey) {
+        UserLeap.INSTANCE.setPreviewKey(previewKey);
+    }
+
+    @ReactMethod
+    public void setUserIdentifier(String identifier) {
+        UserLeap.INSTANCE.setUserIdentifier(identifier);
+    }
+
+    @ReactMethod
+    public void logout() {
+        UserLeap.INSTANCE.logout();
+    }
+}

package/index.d.ts

@@ -4,15 +4,68 @@ declare namespace UserLeap {
         DISABLED: string;
         NO_SURVEY: string;
     };
+
+    const LifecycleEvent: {
+        sdkReady: number;
+        visitorIdUpdated: number;
+        surveyHeight: number;
+        surveyWillPresent: number;
+        surveyPresented: number;
+        surveyAppeared: number;
+        surveyCloseRequested: number;
+        surveyWillClose: number;
+        surveyClosed: number;
+        replayCapture: number;
+        replayCaptureStarted: number;
+        replayCaptureStopped: number;
+        replayCaptureCompleted: number;
+        replayRenderingCompleted: number;
+        replayUploadCompleted: number;
+        replayEventsUploadCompleted: number;
+        loggingEvent: number;
+        surveyCompleted: number;
+        surveyStateReturned: number;
+    };
+
+    // Usage: UserLeap.EventEmitter.addListener('surveyPresented', callback)
+    const EventEmitter: any;
+
     function visitorIdentifier(): number;
     function visitorIdentifierString(): string;
     function sdkVersion(): string;
     function configure(environment: string, configuration?: {[key: string]: any}): void;
     function setPreviewKey(previewKey: string): void;
     function presentSurvey(): void;
+    /**
+    * @deprecated This function is outdated. Use `trackEvent()` instead.
+    */
     function track(event: string, surveyStateCallback: ((surveyState: string) => void)): void;
+    /**
+    * @deprecated This function is outdated. Use `trackEventWithProperties()` instead.
+    */
     function trackWithProperties(event: string, userId: string | undefined, partnerAnonymousId: string | undefined, properties: {[key: string]: any}, surveyStateCallback: ((surveyState: string) => void)): void;
+    /**
+    * @deprecated This function is outdated. Use `trackEventAndIdentify()` instead.
+    */
     function trackAndIdentify(event: string, userId: string | undefined, partnerAnonymousId: string | undefined, surveyStateCallback: ((surveyState: string) => void)): void;
+    function trackEvent(
+        event: string,
+        surveyResultCallback: (result: { surveyState: string; surveyId: number }) => void
+    ): void;
+    function trackEventWithProperties(
+        event: string,
+        userId: string | undefined,
+        partnerAnonymousId: string | undefined,
+        properties: { [key: string]: any },
+        surveyResultCallback: (result: { surveyState: string; surveyId: number }) => void
+    ): void;
+
+    function trackEventAndIdentify(
+        event: string,
+        userId: string | undefined,
+        partnerAnonymousId: string | undefined,
+        surveyResultCallback: (result: { surveyState: string; surveyId: number }) => void
+    ): void;
     function setEmailAddress(emailAddress: string): void;
     function setVisitorAttribute(key: string, value: string): void;
     function setVisitorAttributes(attributes: {[key: string]: string}): void;
@@ -25,8 +78,5 @@ declare namespace UserLeap {
     function unpauseDisplayingSurveys(): void;
     function trackAndPresent(event: string): void;
     function trackIdentifyAndPresent(event: string, userId: string | undefined, partnerAnonymousId: string | undefined): void;
-    // Uncomment for UI testing
-    // function renderSnapshotForUITest(name: string, maskingLevel: string)
-    
 }
 export default UserLeap;

package/index.js

@@ -1,4 +1,4 @@
-import { Platform, NativeModules } from "react-native";
+import { Platform, NativeModules, NativeEventEmitter } from "react-native";
 
 import { version } from "./package.json";
 
@@ -8,6 +8,30 @@ const SurveyState = {
   NO_SURVEY: "NO_SURVEY",
 };
 
+const LifecycleEvent = {
+    sdkReady: 0,
+    visitorIdUpdated: 1,
+    surveyHeight: 2,
+    surveyWillPresent: 3,
+    surveyPresented: 4,
+    surveyAppeared: 5,
+    surveyCloseRequested: 6,
+    surveyWillClose: 7,
+    surveyClosed: 8,
+    replayCapture: 9,
+    replayCaptureStarted: 10,
+    replayCaptureStopped: 11,
+    replayCaptureCompleted: 12,
+    replayRenderingCompleted: 13,
+    replayUploadCompleted: 14,
+    replayEventsUploadCompleted: 15,
+    loggingEvent: 16,
+    surveyCompleted: 17,
+    surveyStateReturned: 18
+}
+
+const UserLeapEventEmitter = new NativeEventEmitter(NativeModules.UserLeapBindings);
+
 const stringifyAttributes = (attributes) => {
   if (!(attributes instanceof Object && attributes.constructor === Object))
     return {};
@@ -35,7 +59,7 @@ const visitorIdentifier = () => {
 
 const sdkVersion = () => {
   if (Platform.OS === "ios") {
-    if (String(Platform.Version) >= "10.3") {
+    if (String(Platform.Version) >= "15.0") {
       return NativeModules.UserLeapBindings.sdkVersion();
     }
   } else {
@@ -81,12 +105,18 @@ const presentSurvey = () => {
   }
 };
 
+/**
+* @deprecated This function is outdated. Use `trackEvent()` instead.
+*/
 const track = (event, surveyStateCallback) => {
   if (isValidPlatform()) {
     NativeModules.UserLeapBindings.track(event, surveyStateCallback);
   }
 };
 
+/**
+* @deprecated This function is outdated. Use `trackEventWithProperties()` instead.
+*/
 const trackWithProperties = (
   event,
   userId,
@@ -105,6 +135,9 @@ const trackWithProperties = (
   }
 };
 
+/**
+* @deprecated This function is outdated. Use `trackEventAndIdentify()` instead.
+*/
 const trackAndIdentify = (
   event,
   userId,
@@ -121,6 +154,46 @@ const trackAndIdentify = (
   }
 };
 
+const trackEvent = (event, surveyResultCallback) => {
+  if (isValidPlatform()) {
+    NativeModules.UserLeapBindings.trackEvent(event, surveyResultCallback);
+  }
+};
+
+const trackEventWithProperties = (
+  event,
+  userId,
+  partnerAnonymousId,
+  properties,
+  surveyResultCallback
+) => {
+  if (isValidPlatform()) {
+    NativeModules.UserLeapBindings.trackEventWithProperties(
+      event,
+      userId,
+      partnerAnonymousId,
+      properties,
+      surveyResultCallback
+    );
+  }
+};
+
+const trackEventAndIdentify = (
+  event,
+  userId,
+  partnerAnonynmousId,
+  surveyResultCallback
+) => {
+  if (isValidPlatform()) {
+    NativeModules.UserLeapBindings.trackEventAndIdentify(
+      event,
+      userId,
+      partnerAnonynmousId,
+      surveyResultCallback
+    );
+  }
+};
+
 const setEmailAddress = (emailAddress) => {
   if (isValidPlatform()) {
     NativeModules.UserLeapBindings.setEmailAddress(emailAddress);
@@ -207,15 +280,7 @@ const trackIdentifyAndPresent = (event, userId, partnerAnonynmousId) => {
   }
 };
 
-// Uncomment for UI testing
-// const renderSnapshotForUITest = (name, maskingLevel) => {
-//   if (isValidPlatform()) {
-//     NativeModules.UserLeapBindings.renderSnapshotForUITest(name, maskingLevel);
-//   }
-// }
-
 const UserLeap = {
-  SurveyState,
   visitorIdentifier,
   visitorIdentifierString,
   sdkVersion,
@@ -225,6 +290,9 @@ const UserLeap = {
   track,
   trackWithProperties,
   trackAndIdentify,
+  trackEvent,
+  trackEventWithProperties,
+  trackEventAndIdentify,
   setEmailAddress,
   setVisitorAttribute,
   setVisitorAttributes,
@@ -237,8 +305,10 @@ const UserLeap = {
   dismissActiveSurvey,
   pauseDisplayingSurveys,
   unpauseDisplayingSurveys,
-  // Uncomment for UI testing
-  // renderSnapshotForUITest,
 };
 
+UserLeap.LifecycleEvent = LifecycleEvent;
+UserLeap.SurveyState = SurveyState;
+UserLeap.EventEmitter = UserLeapEventEmitter;
+
 export default UserLeap;

package/ios/UserLeapBindings.h

@@ -1,6 +1,7 @@
 #import <React/RCTBridgeModule.h>
+#import <React/RCTEventEmitter.h>
 @import UserLeapKit;
 
-@interface UserLeapBindings : NSObject <RCTBridgeModule, _SGRNExtractor>
+@interface UserLeapBindings : RCTEventEmitter <RCTBridgeModule, _SGRNExtractor>
 @property (nonatomic, weak) RCTBridge *bridge;
 @end

package/ios/UserLeapBindings.m

@@ -18,6 +18,13 @@
     return dispatch_get_main_queue();
 }
 
+-(NSDictionary *) parseSurveyResult:(SprigSurveyResult *)result {
+    SurveyState state = [result surveyState];
+    NSString *surveyStateString = [self getSurveyState:state];
+    NSInteger surveyId = [result surveyId];
+    return @{@"surveyState": surveyStateString, @"surveyId": @(surveyId)};
+}
+
 - (NSString *)getSurveyState:(SurveyState)surveyState
 {
     NSString *surveyStateBinding = @"NO_SURVEY";
@@ -31,10 +38,18 @@
         case SurveyStateNoSurvey:
             surveyStateBinding = @"NO_SURVEY";
             break;
+        case SurveyStatePreviousSurveyReady:
+            surveyStateBinding = @"PREVIOUS_SURVEY_READY";
+            break;
     }
     return surveyStateBinding;
 }
 
+/// These are required by RCTEventEmitter.
+- (NSArray<NSString *> *)supportedEvents {
+    return [LifecycleEventUtil allNameStrings];
+}
+
 RCT_EXPORT_MODULE()
 
 RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(visitorIdentifier)
@@ -56,8 +71,35 @@ RCT_EXPORT_METHOD(configure:(NSString *)environmentId configuration:(NSDictionar
 {
     [[UserLeap shared] configureWithEnvironment:environmentId configuration:configuration];
     [[UserLeap shared] _passWithRnExtractor:self];
+    
+    /// Register for all the LifeCycle events.
+    [self registerForAllLifecycleEvents];
+}
+
+- (void)registerForAllLifecycleEvents {
+    
+    for (NSNumber *eventVal in [LifecycleEventUtil all]) {
+        [[UserLeap shared] registerEventListenerFor:[eventVal intValue] listener:^(NSDictionary<NSString *,id> * eventData) {
+            
+            NSString *type = eventData[LifecycleEventDataKey.eventType];
+            if (!type) {
+                return;
+            }
+            
+            LifecycleEvent lifecycleEvent = [LifecycleEventUtil fromString:type];
+            if (lifecycleEvent != LifecycleEventUnknown) {
+                
+                /// Always make sure the type exists in the supportedEvents; sending an unsupported event will crash the app.
+                NSString *lifecycleEventName = [LifecycleEventUtil stringName:lifecycleEvent];
+                if ([[self supportedEvents] containsObject: lifecycleEventName]) {
+                    [self sendEventWithName:lifecycleEventName body:eventData];
+                }
+            }
+        }];
+    }
 }
 
+
 RCT_EXPORT_METHOD(setPreviewKey:(NSString *)previewKey)
 {
     [[UserLeap shared] setPreviewKey:previewKey];
@@ -68,6 +110,7 @@ RCT_EXPORT_METHOD(presentSurvey)
     [[UserLeap shared] presentSurveyFrom:RCTPresentedViewController()];
 }
 
+/// Use trackEvent instead of track
 RCT_EXPORT_METHOD(track:(NSString *)eventName
                   surveyStateCallback:(RCTResponseSenderBlock)callback)
 {
@@ -80,33 +123,50 @@ RCT_EXPORT_METHOD(track:(NSString *)eventName
     }
 }
 
+RCT_EXPORT_METHOD(trackEvent:(NSString *)eventName
+                  surveyResultCallback:(RCTResponseSenderBlock)callback)
+{
+    EventPayload *payload = [[EventPayload alloc] initWithEventName:eventName userId:nil partnerAnonymousId:nil properties:nil handler:nil resultHandler:^(SprigSurveyResult * result) {
+            if (callback != nil) {
+                callback(@[[self parseSurveyResult:result]]);
+            }
+        }];
+    [[UserLeap shared] trackWithPayload: payload];
+}
+
+/// Use trackEventWithProperties instead of trackWithProperties
 RCT_EXPORT_METHOD(trackWithProperties:(NSString *)eventName
                   userId:(NSString * _Nullable)userId
                   partnerAnonymousId:(NSString * _Nullable)partnerAnonymousId
                   properties: (NSDictionary *)properties
                   surveyStateCallback:(RCTResponseSenderBlock)callback)
 {
-    if (callback != nil) {
         [[UserLeap shared] trackWithEventName:eventName userId:userId partnerAnonymousId:partnerAnonymousId properties:properties handler:^(enum SurveyState surveyState) {
-            NSString *surveyStateBinding = @"NO_SURVEY";
-            switch(surveyState) {
-                case SurveyStateDisabled:
-                    surveyStateBinding = @"DISABLED";
-                    break;
-                case SurveyStateReady:
-                    surveyStateBinding = @"READY";
-                    break;
-                case SurveyStateNoSurvey:
-                    surveyStateBinding = @"NO_SURVEY";
-                    break;
+            callback(@[[self getSurveyState:surveyState]]);
+        }];
+    
+}
+
+RCT_EXPORT_METHOD(trackEventWithProperties:(NSString *)eventName
+                  userId:(NSString * _Nullable)userId
+                  partnerAnonymousId:(NSString * _Nullable)partnerAnonymousId
+                  properties: (NSDictionary *)properties
+                  surveyResultCallback:(RCTResponseSenderBlock)callback)
+{
+    EventPayload *payload = [[EventPayload alloc] initWithEventName:eventName
+                                                             userId:userId
+                                                 partnerAnonymousId:partnerAnonymousId
+                                                         properties:properties
+                                                            handler:nil
+                                                      resultHandler:^(SprigSurveyResult * result) {
+            if (callback != nil) {
+                callback(@[[self parseSurveyResult:result]]);
             }
-            callback(@[surveyStateBinding]);
         }];
-    } else {
-        [[UserLeap shared] trackWithEventName:eventName userId:userId partnerAnonymousId:partnerAnonymousId properties:properties handler:nil];
-    }
+    [[UserLeap shared] trackWithPayload: payload];
 }
 
+/// Use trackEventAndIdentify instead of trackAndIdentify
 RCT_EXPORT_METHOD(trackAndIdentify:(NSString *)eventName
                   userId:(NSString *)userId
                   partnerAnonymousId:(NSString *)partnerAnonymousId
@@ -119,7 +179,24 @@ RCT_EXPORT_METHOD(trackAndIdentify:(NSString *)eventName
     } else {
         [[UserLeap shared] trackWithEventName:eventName userId:userId partnerAnonymousId:partnerAnonymousId handler:nil];
     }
-    
+}
+
+RCT_EXPORT_METHOD(trackEventAndIdentify:(NSString *)eventName
+                  userId:(NSString *)userId
+                  partnerAnonymousId:(NSString *)partnerAnonymousId
+                  surveyResultCallback:(RCTResponseSenderBlock)callback)
+{
+    EventPayload *payload = [[EventPayload alloc] initWithEventName:eventName
+                                                             userId:userId
+                                                 partnerAnonymousId:partnerAnonymousId
+                                                         properties:nil
+                                                            handler:nil
+                                                      resultHandler:^(SprigSurveyResult * result) {
+            if (callback != nil) {
+                callback(@[[self parseSurveyResult:result]]);
+            }
+        }];
+    [[UserLeap shared] trackWithPayload: payload];
 }
 
 RCT_EXPORT_METHOD(setEmailAddress:(NSString *)emailAddress)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-userleap",
-  "version": "2.19.2",
+  "version": "2.21.0",
   "description": "React Native module for UserLeap",
   "main": "index.js",
   "types": "index.d.ts",
@@ -43,4 +43,4 @@
     "react-native": "0.74.7",
     "react-test-renderer": "18.2.0"
   }
-}
+}

package/react-native-userleap.podspec

@@ -19,5 +19,5 @@ Pod::Spec.new do |s|
   s.requires_arc = true
 
   s.dependency "React"
-  s.dependency "UserLeapKit", "4.26.2"
+  s.dependency "UserLeapKit", "4.29.0"
 end

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +0,0 @@
-distributionBase=GRADLE_USER_HOME
-distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
-networkTimeout=10000
-validateDistributionUrl=true
-zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists

package/android/gradlew

@@ -1,251 +0,0 @@
-#!/bin/sh
-
-#
-# Copyright © 2015-2021 the original authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# SPDX-License-Identifier: Apache-2.0
-#
-
-##############################################################################
-#
-#   Gradle start up script for POSIX generated by Gradle.
-#
-#   Important for running:
-#
-#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
-#       noncompliant, but you have some other compliant shell such as ksh or
-#       bash, then to run this script, type that shell name before the whole
-#       command line, like:
-#
-#           ksh Gradle
-#
-#       Busybox and similar reduced shells will NOT work, because this script
-#       requires all of these POSIX shell features:
-#         * functions;
-#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
-#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
-#         * compound commands having a testable exit status, especially «case»;
-#         * various built-in commands including «command», «set», and «ulimit».
-#
-#   Important for patching:
-#
-#   (2) This script targets any POSIX shell, so it avoids extensions provided
-#       by Bash, Ksh, etc; in particular arrays are avoided.
-#
-#       The "traditional" practice of packing multiple parameters into a
-#       space-separated string is a well documented source of bugs and security
-#       problems, so this is (mostly) avoided, by progressively accumulating
-#       options in "$@", and eventually passing that to Java.
-#
-#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
-#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
-#       see the in-line comments for details.
-#
-#       There are tweaks for specific operating systems such as AIX, CygWin,
-#       Darwin, MinGW, and NonStop.
-#
-#   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
-#       within the Gradle project.
-#
-#       You can find Gradle at https://github.com/gradle/gradle/.
-#
-##############################################################################
-
-# Attempt to set APP_HOME
-
-# Resolve links: $0 may be a link
-app_path=$0
-
-# Need this for daisy-chained symlinks.
-while
-    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
-    [ -h "$app_path" ]
-do
-    ls=$( ls -ld "$app_path" )
-    link=${ls#*' -> '}
-    case $link in             #(
-      /*)   app_path=$link ;; #(
-      *)    app_path=$APP_HOME$link ;;
-    esac
-done
-
-# This is normally unused
-# shellcheck disable=SC2034
-APP_BASE_NAME=${0##*/}
-# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
-
-# Use the maximum available, or set MAX_FD != -1 to use that value.
-MAX_FD=maximum
-
-warn () {
-    echo "$*"
-} >&2
-
-die () {
-    echo
-    echo "$*"
-    echo
-    exit 1
-} >&2
-
-# OS specific support (must be 'true' or 'false').
-cygwin=false
-msys=false
-darwin=false
-nonstop=false
-case "$( uname )" in                #(
-  CYGWIN* )         cygwin=true  ;; #(
-  Darwin* )         darwin=true  ;; #(
-  MSYS* | MINGW* )  msys=true    ;; #(
-  NONSTOP* )        nonstop=true ;;
-esac
-
-CLASSPATH="\\\"\\\""
-
-
-# Determine the Java command to use to start the JVM.
-if [ -n "$JAVA_HOME" ] ; then
-    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
-        # IBM's JDK on AIX uses strange locations for the executables
-        JAVACMD=$JAVA_HOME/jre/sh/java
-    else
-        JAVACMD=$JAVA_HOME/bin/java
-    fi
-    if [ ! -x "$JAVACMD" ] ; then
-        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-    fi
-else
-    JAVACMD=java
-    if ! command -v java >/dev/null 2>&1
-    then
-        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-    fi
-fi
-
-# Increase the maximum file descriptors if we can.
-if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
-    case $MAX_FD in #(
-      max*)
-        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC2039,SC3045
-        MAX_FD=$( ulimit -H -n ) ||
-            warn "Could not query maximum file descriptor limit"
-    esac
-    case $MAX_FD in  #(
-      '' | soft) :;; #(
-      *)
-        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC2039,SC3045
-        ulimit -n "$MAX_FD" ||
-            warn "Could not set maximum file descriptor limit to $MAX_FD"
-    esac
-fi
-
-# Collect all arguments for the java command, stacking in reverse order:
-#   * args from the command line
-#   * the main class name
-#   * -classpath
-#   * -D...appname settings
-#   * --module-path (only if needed)
-#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
-
-# For Cygwin or MSYS, switch paths to Windows format before running java
-if "$cygwin" || "$msys" ; then
-    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
-    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
-
-    JAVACMD=$( cygpath --unix "$JAVACMD" )
-
-    # Now convert the arguments - kludge to limit ourselves to /bin/sh
-    for arg do
-        if
-            case $arg in                                #(
-              -*)   false ;;                            # don't mess with options #(
-              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
-                    [ -e "$t" ] ;;                      #(
-              *)    false ;;
-            esac
-        then
-            arg=$( cygpath --path --ignore --mixed "$arg" )
-        fi
-        # Roll the args list around exactly as many times as the number of
-        # args, so each arg winds up back in the position where it started, but
-        # possibly modified.
-        #
-        # NB: a `for` loop captures its iteration list before it begins, so
-        # changing the positional parameters here affects neither the number of
-        # iterations, nor the values presented in `arg`.
-        shift                   # remove old arg
-        set -- "$@" "$arg"      # push replacement arg
-    done
-fi
-
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
-
-# Collect all arguments for the java command:
-#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
-#     and any embedded shellness will be escaped.
-#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
-#     treated as '${Hostname}' itself on the command line.
-
-set -- \
-        "-Dorg.gradle.appname=$APP_BASE_NAME" \
-        -classpath "$CLASSPATH" \
-        -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
-        "$@"
-
-# Stop when "xargs" is not available.
-if ! command -v xargs >/dev/null 2>&1
-then
-    die "xargs is not available"
-fi
-
-# Use "xargs" to parse quoted args.
-#
-# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
-#
-# In Bash we could simply go:
-#
-#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
-#   set -- "${ARGS[@]}" "$@"
-#
-# but POSIX shell has neither arrays nor command substitution, so instead we
-# post-process each arg (as a line of input to sed) to backslash-escape any
-# character that might be a shell metacharacter, then use eval to reverse
-# that process (while maintaining the separation between arguments), and wrap
-# the whole thing up as a single "set" statement.
-#
-# This will of course break if any of these variables contains a newline or
-# an unmatched quote.
-#
-
-eval "set -- $(
-        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
-        xargs -n1 |
-        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
-        tr '\n' ' '
-    )" '"$@"'
-
-exec "$JAVACMD" "$@"

package/android/gradlew.bat

@@ -1,94 +0,0 @@
-@rem
-@rem Copyright 2015 the original author or authors.
-@rem
-@rem Licensed under the Apache License, Version 2.0 (the "License");
-@rem you may not use this file except in compliance with the License.
-@rem You may obtain a copy of the License at
-@rem
-@rem      https://www.apache.org/licenses/LICENSE-2.0
-@rem
-@rem Unless required by applicable law or agreed to in writing, software
-@rem distributed under the License is distributed on an "AS IS" BASIS,
-@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-@rem See the License for the specific language governing permissions and
-@rem limitations under the License.
-@rem
-@rem SPDX-License-Identifier: Apache-2.0
-@rem
-
-@if "%DEBUG%"=="" @echo off
-@rem ##########################################################################
-@rem
-@rem  Gradle startup script for Windows
-@rem
-@rem ##########################################################################
-
-@rem Set local scope for the variables with windows NT shell
-if "%OS%"=="Windows_NT" setlocal
-
-set DIRNAME=%~dp0
-if "%DIRNAME%"=="" set DIRNAME=.
-@rem This is normally unused
-set APP_BASE_NAME=%~n0
-set APP_HOME=%DIRNAME%
-
-@rem Resolve any "." and ".." in APP_HOME to make it shorter.
-for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
-
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
-
-@rem Find java.exe
-if defined JAVA_HOME goto findJavaFromJavaHome
-
-set JAVA_EXE=java.exe
-%JAVA_EXE% -version >NUL 2>&1
-if %ERRORLEVEL% equ 0 goto execute
-
-echo. 1>&2
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
-echo. 1>&2
-echo Please set the JAVA_HOME variable in your environment to match the 1>&2
-echo location of your Java installation. 1>&2
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto execute
-
-echo. 1>&2
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
-echo. 1>&2
-echo Please set the JAVA_HOME variable in your environment to match the 1>&2
-echo location of your Java installation. 1>&2
-
-goto fail
-
-:execute
-@rem Setup the command line
-
-set CLASSPATH=
-
-
-@rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
-
-:end
-@rem End local scope for the variables with windows NT shell
-if %ERRORLEVEL% equ 0 goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-set EXIT_CODE=%ERRORLEVEL%
-if %EXIT_CODE% equ 0 set EXIT_CODE=1
-if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
-exit /b %EXIT_CODE%
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega