react-native-clarity 1.0.1 → 2.1.0

package/README.md

@@ -8,64 +8,101 @@ A ReactNative plugin that allows integrating Clarity with your application.
 npm install react-native-clarity
 ```
 
+**Note**: The Clarity package depends on native code to run, therefore you have to ship a new build after integrating the package.
+
 ## Usage
 
 ```js
-import { initialize, setCustomUserId, getCurrentSessionId, setCurrentScreenName, setCustomTag } from 'react-native-clarity';
+import { LogLevel, initialize, setCustomUserId,  setCustomSessionId, setCustomTag, setCurrentScreenName, getCurrentSessionId } from 'react-native-clarity';
 
 // Initialize Clarity.
-initialize("<ProjectId>");
+const clarityConfig = {
+  logLevel: LogLevel.Verbose,
+  allowMeteredNetworkUsage: true
+};
+
+initialize('<ProjectId>', clarityConfig);
 
 // Set custom user id.
-setCustomUserId("react@native.com");
+setCustomUserId("<CustomUserId>");
+
+// Set custom session id.
+setCustomSessionId("<CustomSessionId>");
 
 // Set custom tag.
 setCustomTag("key", "value");
 
-// Get current session id to correlate with other tools.
-getCurrentSessionId().then((id) => {...});
-
 // Setting the current screen name when using React Navigation
-import { ..., useFocusEffect } from '@react-navigation/native';
+import { NavigationContainer useNavigationContainerRef } from '@react-navigation/native';
 
 const HomeScreen = ({...}) => {
-  useFocusEffect(
-    React.useCallback(() => {
-      setCurrentScreenName("Home");
-
-      // To clear the current screen name when the screen goes out of focus:
-      return () => { setCurrentScreenName(undefined); }
-    }, [])
+  const navigationRef = useNavigationContainerRef();
+  const routeNameRef = React.useRef();
+  
+  return (
+    <NavigationContainer
+      ref={navigationRef}
+      onReady={() => {
+        routeNameRef.current = navigationRef.getCurrentRoute().name;
+        setCurrentScreenName(routeNameRef.current);
+      }}
+      onStateChange={() => {
+        const previousRouteName = routeNameRef.current;
+        const currentRouteName = navigationRef.getCurrentRoute().name;
+
+        if (previousRouteName !== currentRouteName) {
+          routeNameRef.current = currentRouteName;
+          setCurrentScreenName(currentRouteName);
+        }
+      }}
+    >
+      {/* ... */}
+    </NavigationContainer>
   );
-  ...
 };
+
+// Get current session id to correlate with other tools.
+getCurrentSessionId().then((id) => {...});
+
+// Get current session url to correlate with other tools.
+getCurrentSessionUrl().then((url) => {...});
 ```
 
 ### Initialization arguments
 
-```js
+```ts
 /**
- * Initializes the Clarity plugin with the provided parameters.
+ * Initializes the Clarity SDK if the API level is supported.
  *
- * @param projectId     The Clarity project id to send data to.
- * @param userId        A custom identifier for the current user. If passed as undefined, the user id
+ * @param projectId     [REQUIRED] The Clarity project id to send data to.
+ * @param config     [OPTIONAL] The clarity config, if not provided default values are used.
+*/
+function initialize(projectId: string, config?: ClarityConfig)
+
+/**
+ * The configuration that will be used to customize the Clarity behaviour.
+ *
+ * @param userId        [OPTIONAL default = null] A custom identifier for the current user. If passed as null, the user id
  *                      will be auto generated. The user id in general is sticky across sessions.
  *                      The provided user id must follow these conditions:
  *                          1. Cannot be an empty string.
  *                          2. Should be base36 and smaller than "1Z141Z4".
- * @param logLevel      The level of logging to show in the device logcat stream ("Verbose", "Debug", "Info", "Warning", "Error", "None").
- * @param allowMeteredNetworkUsage  Allows uploading session data to the servers on device metered network.
- * @param enableWebViewCapture    Allows Clarity to capture the web views DOM content.
- * @param allowedDomains    The whitelisted domains to allow Clarity to capture their DOM content.
+ * @param logLevel      [OPTIONAL default = LogLevel.None] The level of logging to show in the device logcat stream.
+ * @param allowMeteredNetworkUsage  [OPTIONAL default = false] Allows uploading session data to the servers on device metered network.
+ * @param enableWebViewCapture    [OPTIONAL default = true] Allows Clarity to capture the web views DOM content.
+ * @param allowedDomains    [OPTIONAL default = ["*"]] The whitelisted domains to allow Clarity to capture their DOM content.
  *                          If it contains "*" as an element, all domains will be captured.
+ * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
  */
-function initialize(
-  projectId: string,
-  userId?: string,
-  logLevel: string = "None",
-  allowMeteredNetworkUsage: boolean = false,
-  enableWebViewCapture: boolean = true,
-  allowedDomains: string[] = ["*"])
+
+interface ClarityConfig {
+  userId?: string | null;
+  logLevel?: LogLevel;
+  allowMeteredNetworkUsage?: boolean;
+  enableWebViewCapture?: boolean;
+  allowedDomains?: string[];
+  disableOnLowEndDevices?: Boolean;
+}
 ```
 
 ## License

package/android/build.gradle

@@ -69,7 +69,7 @@ def kotlin_version = getExtOrDefault("kotlinVersion")
 dependencies {
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation "com.microsoft.clarity:clarity:1.3.3"
+  implementation "com.microsoft.clarity:clarity:2.1.1"
 }
 
 if (isNewArchitectureEnabled()) {

package/android/gradle.properties

@@ -1,7 +1,7 @@
 #make sure these are acutally used
 Clarity_kotlinVersion=1.7.0
 Clarity_minSdkVersion=21
-Clarity_targetSdkVersion=33
-Clarity_compileSdkVersion=33
+Clarity_targetSdkVersion=34
+Clarity_compileSdkVersion=34
 Clarity_ndkversion=21.4.7075529
 android.useAndroidX=true

package/android/src/main/java/com/microsoft/clarity/reactnative/ClarityModule.kt

@@ -21,8 +21,11 @@ class ClarityModule(reactContext: ReactApplicationContext) :
         allowMeteredNetworkUsage: Boolean,
         enableWebViewCapture: Boolean,
         allowedDomains: ReadableArray,
+        disableOnLowEndDevices: Boolean,
         promise: Promise
     ) {
+        val allowedActivities = listOf<String>(); //not supported
+        val disallowedActivities = listOf<String>(); //not supported
         val config = ClarityConfig(
             projectId,
             userId,
@@ -30,7 +33,10 @@ class ClarityModule(reactContext: ReactApplicationContext) :
             allowMeteredNetworkUsage,
             enableWebViewCapture,
             readableArrayToList(allowedDomains),
-            ApplicationFramework.ReactNative
+            ApplicationFramework.ReactNative,
+            allowedActivities,
+            disallowedActivities,
+            disableOnLowEndDevices
         )
 
         promise.resolve(Clarity.initialize(currentActivity, config))
@@ -41,21 +47,32 @@ class ClarityModule(reactContext: ReactApplicationContext) :
         promise.resolve(Clarity.setCustomUserId(customUserId))
     }
 
+    @ReactMethod
+    fun setCustomSessionId(customSessionId: String, promise: Promise) {
+        promise.resolve(Clarity.setCustomSessionId(customSessionId))
+    }
+
     @ReactMethod
     fun getCurrentSessionId(promise: Promise) {
         promise.resolve(Clarity.getCurrentSessionId())
     }
 
+    @ReactMethod
+    fun setCustomTag(key: String?, value: String?, promise: Promise) {
+        promise.resolve(Clarity.setCustomTag(key, value))
+    }
+
     @ReactMethod
     fun setCurrentScreenName(screenName: String?, promise: Promise) {
         promise.resolve(Clarity.setCurrentScreenName(screenName))
     }
 
     @ReactMethod
-    fun setCustomTag(key: String?, value: String?, promise: Promise) {
-        promise.resolve(Clarity.setCustomTag(key, value))
+    fun getCurrentSessionUrl(promise: Promise) {
+        promise.resolve(Clarity.getCurrentSessionUrl())
     }
 
+
     private fun readableArrayToList(arr: ReadableArray): List<String> {
         val ret = mutableListOf<String>()
 

package/lib/commonjs/index.js

@@ -3,9 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.LogLevel = void 0;
 exports.getCurrentSessionId = getCurrentSessionId;
+exports.getCurrentSessionUrl = getCurrentSessionUrl;
 exports.initialize = initialize;
 exports.setCurrentScreenName = setCurrentScreenName;
+exports.setCustomSessionId = setCustomSessionId;
 exports.setCustomTag = setCustomTag;
 exports.setCustomUserId = setCustomUserId;
 var _reactNative = require("react-native");
@@ -16,25 +19,52 @@ const Clarity = _reactNative.NativeModules.Clarity;
 const SupportedPlatforms = ['android'];
 
 /**
- * Initializes the Clarity plugin with the provided parameters.
+ * The configuration that will be used to customize the Clarity behaviour.
  *
- * @param projectId     The Clarity project id to send data to.
- * @param userId        A custom identifier for the current user. If passed as undefined, the user id
+ * @param userId        [OPTIONAL default = null] A custom identifier for the current user. If passed as null, the user id
  *                      will be auto generated. The user id in general is sticky across sessions.
  *                      The provided user id must follow these conditions:
  *                          1. Cannot be an empty string.
  *                          2. Should be base36 and smaller than "1Z141Z4".
- * @param logLevel      The level of logging to show in the device logcat stream ("Verbose", "Debug", "Info", "Warning", "Error", "None").
- * @param allowMeteredNetworkUsage  Allows uploading session data to the servers on device metered network.
- * @param enableWebViewCapture    Allows Clarity to capture the web views DOM content.
- * @param allowedDomains    The whitelisted domains to allow Clarity to capture their DOM content.
+ * @param logLevel      [OPTIONAL default = LogLevel.None] The level of logging to show in the device logcat stream.
+ * @param allowMeteredNetworkUsage  [OPTIONAL default = false] Allows uploading session data to the servers on device metered network.
+ * @param enableWebViewCapture    [OPTIONAL default = true] Allows Clarity to capture the web views DOM content.
+ * @param allowedDomains    [OPTIONAL default = ["*"]] The whitelisted domains to allow Clarity to capture their DOM content.
  *                          If it contains "*" as an element, all domains will be captured.
+ * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
  */
-function initialize(projectId, userId) {
-  let logLevel = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "None";
-  let allowMeteredNetworkUsage = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
-  let enableWebViewCapture = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
-  let allowedDomains = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : ["*"];
+/**
+ * The level of logging to show in the device logcat stream.
+ */
+let LogLevel = /*#__PURE__*/function (LogLevel) {
+  LogLevel["Verbose"] = "Verbose";
+  LogLevel["Debug"] = "Debug";
+  LogLevel["Info"] = "Info";
+  LogLevel["Warning"] = "Warning";
+  LogLevel["Error"] = "Error";
+  LogLevel["None"] = "None";
+  return LogLevel;
+}({});
+/**
+ * Initializes the Clarity SDK if the API level is supported.
+ * @param projectId     [REQUIRED] The Clarity project id to send data to.
+ * @param config   [OPTIONAL] The clarity config, if not provided default values are used.
+*/
+exports.LogLevel = LogLevel;
+function initialize(projectId, config) {
+  if (typeof projectId !== "string" || !(typeof config === "object" || typeof config === "undefined")) {
+    throw Error("Invalid Clarity initialization arguments. Please check the docs for assitance.");
+  }
+
+  // applying default values
+  let {
+    userId = null,
+    logLevel = LogLevel.None,
+    allowMeteredNetworkUsage = false,
+    enableWebViewCapture = true,
+    allowedDomains = ["*"],
+    disableOnLowEndDevices = false
+  } = config ?? {};
   if (!SupportedPlatforms.includes(_reactNative.Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -43,7 +73,7 @@ function initialize(projectId, userId) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
     return;
   }
-  Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains);
+  Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains, disableOnLowEndDevices);
 }
 
 /**
@@ -69,26 +99,30 @@ function setCustomUserId(customUserId) {
 }
 
 /**
- * Returns the active session id. This can be used to correlate the Clarity session with other
- * analytics tools that the developer may be using.
- * @returns a promise that resolves to the current session id.
+ * Sets a custom session id that can be used to identify the session.
+ * <p>
+ * Note: custom session id cannot be null or empty, or consists only of whitespaces.
+ * </p>
+ * @param customSessionId   The custom session id to set.
  */
-function getCurrentSessionId() {
+function setCustomSessionId(customSessionId) {
   if (!SupportedPlatforms.includes(_reactNative.Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return new Promise(resolve => {
-      resolve("Undefined");
-    });
+    return;
   }
   if (Clarity === null) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return new Promise(resolve => {
-      resolve("Undefined");
-    });
+    return;
   }
-  return Clarity.getCurrentSessionId();
+  Clarity.setCustomSessionId(customSessionId);
 }
-function setCurrentScreenName(screenName) {
+
+/**
+ * Sets a custom tag for the current session.
+ * @param key   The tag key to set.
+ * @param value   The tag value to set.
+ */
+function setCustomTag(key, value) {
   if (!SupportedPlatforms.includes(_reactNative.Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -97,9 +131,17 @@ function setCurrentScreenName(screenName) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
     return;
   }
-  Clarity.setCurrentScreenName(screenName);
+  Clarity.setCustomTag(key, value);
 }
-function setCustomTag(key, value) {
+
+/**
+ * For React Native applications only, this function is used to set the current screen name
+ * in case the ReactNative Navigation package is used.
+ * This will allow you to split and analyze your data on the screen names.
+ * You can it set to `null` to remove the latest set value.
+ * @param screenName   The current screen name to set.
+ */
+function setCurrentScreenName(screenName) {
   if (!SupportedPlatforms.includes(_reactNative.Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -108,6 +150,41 @@ function setCustomTag(key, value) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
     return;
   }
-  Clarity.setCustomTag(key, value);
+  Clarity.setCurrentScreenName(screenName);
+}
+
+/**
+ * Returns the active session id. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ * @returns a promise that resolves to the current session id.
+ */
+function getCurrentSessionId() {
+  if (!SupportedPlatforms.includes(_reactNative.Platform.OS)) {
+    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
+    return Promise.resolve("Undefined");
+  }
+  if (Clarity === null) {
+    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+    return Promise.resolve("Undefined");
+  }
+  return Clarity.getCurrentSessionId();
+}
+
+/**
+ * Returns the active session url. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ *
+ * @returns a promise that resolves to the current session url if there is an active one.
+ */
+function getCurrentSessionUrl() {
+  if (!SupportedPlatforms.includes(_reactNative.Platform.OS)) {
+    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
+    return Promise.resolve("Undefined");
+  }
+  if (Clarity === null) {
+    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+    return Promise.resolve("Undefined");
+  }
+  return Clarity.getCurrentSessionUrl();
 }
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_reactNative","require","LINKING_ERROR","Clarity","NativeModules","SupportedPlatforms","initialize","projectId","userId","logLevel","arguments","length","undefined","allowMeteredNetworkUsage","enableWebViewCapture","allowedDomains","includes","Platform","OS","console","warn","join","error","setCustomUserId","customUserId","getCurrentSessionId","Promise","resolve","setCurrentScreenName","screenName","setCustomTag","key","value"],"sourceRoot":"..\\..\\src","sources":["index.tsx"],"mappings":";;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAEA,MAAMC,aAAa,GAChB,+EAA8E;AAC/E;AACA,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,OAAO,GAAGC,0BAAa,CAACD,OAAO;AAErC,MAAME,kBAAkB,GAAG,CAAC,SAAS,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,UAAUA,CACxBC,SAAiB,EACjBC,MAAe,EAImB;EAAA,IAHlCC,QAAgB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,MAAM;EAAA,IACzBG,wBAAiC,GAAAH,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;EAAA,IACzCI,oBAA6B,GAAAJ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,IAAI;EAAA,IACpCK,cAAwB,GAAAL,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,GAAG,CAAC;EAChC,IAAI,CAACL,kBAAkB,CAACW,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGf,kBAAkB,CAACgB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACG,UAAU,CAACC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,EAAEI,wBAAwB,EAAEC,oBAAoB,EAAEC,cAAc,CAAC;AACjH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASQ,eAAeA,CAACC,YAAoB,EAAE;EACpD,IAAI,CAACnB,kBAAkB,CAACW,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGf,kBAAkB,CAACgB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACoB,eAAe,CAACC,YAAY,CAAC;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,mBAAmBA,CAAA,EAAoB;EACrD,IAAI,CAACpB,kBAAkB,CAACW,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGf,kBAAkB,CAACgB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAO,IAAIK,OAAO,CAAEC,OAAO,IAAK;MAC9BA,OAAO,CAAC,WAAW,CAAC;IACtB,CAAC,CAAC;EACJ;EAEA,IAAIxB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE,OAAO,IAAIwB,OAAO,CAAEC,OAAO,IAAK;MAC9BA,OAAO,CAAC,WAAW,CAAC;IACtB,CAAC,CAAC;EACJ;EAEA,OAAOxB,OAAO,CAACsB,mBAAmB,CAAC,CAAC;AACtC;AAEO,SAASG,oBAAoBA,CAACC,UAAkB,EAAE;EACvD,IAAI,CAACxB,kBAAkB,CAACW,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGf,kBAAkB,CAACgB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACyB,oBAAoB,CAACC,UAAU,CAAC;AAC1C;AAEO,SAASC,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAE;EACvD,IAAI,CAAC3B,kBAAkB,CAACW,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGf,kBAAkB,CAACgB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAAC2B,YAAY,CAACC,GAAG,EAAEC,KAAK,CAAC;AAClC"}
+{"version":3,"names":["_reactNative","require","LINKING_ERROR","Clarity","NativeModules","SupportedPlatforms","LogLevel","exports","initialize","projectId","config","Error","userId","logLevel","None","allowMeteredNetworkUsage","enableWebViewCapture","allowedDomains","disableOnLowEndDevices","includes","Platform","OS","console","warn","join","error","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","key","value","setCurrentScreenName","screenName","getCurrentSessionId","Promise","resolve","getCurrentSessionUrl"],"sourceRoot":"..\\..\\src","sources":["index.tsx"],"mappings":";;;;;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAEA,MAAMC,aAAa,GAChB,+EAA8E;AAC/E;AACA,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,OAAO,GAAGC,0BAAa,CAACD,OAAO;AAErC,MAAME,kBAAkB,GAAG,CAAC,SAAS,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAUA;AACA;AACA;AAFA,IAGYC,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AASpB;AACA;AACA;AACA;AACA;AAJAC,OAAA,CAAAD,QAAA,GAAAA,QAAA;AAKO,SAASE,UAAUA,CAACC,SAAiB,EAAEC,MAAsB,EAAE;EAEpE,IAAI,OAAOD,SAAS,KAAK,QAAQ,IAAI,EAAE,OAAOC,MAAM,KAAK,QAAQ,IAAI,OAAOA,MAAM,KAAK,WAAW,CAAC,EAAE;IACnG,MAAMC,KAAK,CAAC,gFAAgF,CAAC;EAC/F;;EAEA;EACA,IAAI;IAAEC,MAAM,GAAG,IAAI;IACjBC,QAAQ,GAAGP,QAAQ,CAACQ,IAAI;IACxBC,wBAAwB,GAAG,KAAK;IAChCC,oBAAoB,GAAG,IAAI;IAC3BC,cAAc,GAAG,CAAC,GAAG,CAAC;IACtBC,sBAAsB,GAAG;EAAM,CAAC,GAAGR,MAAM,IAAI,CAAC,CAAC;EAEjD,IAAI,CAACL,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIrB,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACK,UAAU,CAACC,SAAS,EAAEG,MAAM,EAAEC,QAAQ,EAAEE,wBAAwB,EAAEC,oBAAoB,EAAEC,cAAc,EAAEC,sBAAsB,CAAC;AACzI;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASQ,eAAeA,CAACC,YAAoB,EAAE;EACpD,IAAI,CAACtB,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIrB,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACuB,eAAe,CAACC,YAAY,CAAC;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,kBAAkBA,CAACC,eAAuB,EAAE;EAC1D,IAAI,CAACxB,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIrB,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACyB,kBAAkB,CAACC,eAAe,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAE;EACvD,IAAI,CAAC3B,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIrB,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAAC2B,YAAY,CAACC,GAAG,EAAEC,KAAK,CAAC;AAClC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,oBAAoBA,CAACC,UAAyB,EAAE;EAC9D,IAAI,CAAC7B,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIrB,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAAC8B,oBAAoB,CAACC,UAAU,CAAC;AAC1C;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,mBAAmBA,CAAA,EAAoB;EACrD,IAAI,CAAC9B,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOY,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,IAAIlC,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE,OAAOkC,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAOlC,OAAO,CAACgC,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASG,oBAAoBA,CAAA,EAAoB;EACtD,IAAI,CAACjC,kBAAkB,CAACc,QAAQ,CAACC,qBAAQ,CAACC,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGlB,kBAAkB,CAACmB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOY,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,IAAIlC,OAAO,KAAK,IAAI,EAAE;IACpBmB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEvB,aAAa,CAAC;IACpE,OAAOkC,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAOlC,OAAO,CAACmC,oBAAoB,CAAC,CAAC;AACvC"}

package/lib/module/index.js

@@ -6,25 +6,53 @@ const Clarity = NativeModules.Clarity;
 const SupportedPlatforms = ['android'];
 
 /**
- * Initializes the Clarity plugin with the provided parameters.
+ * The configuration that will be used to customize the Clarity behaviour.
  *
- * @param projectId     The Clarity project id to send data to.
- * @param userId        A custom identifier for the current user. If passed as undefined, the user id
+ * @param userId        [OPTIONAL default = null] A custom identifier for the current user. If passed as null, the user id
  *                      will be auto generated. The user id in general is sticky across sessions.
  *                      The provided user id must follow these conditions:
  *                          1. Cannot be an empty string.
  *                          2. Should be base36 and smaller than "1Z141Z4".
- * @param logLevel      The level of logging to show in the device logcat stream ("Verbose", "Debug", "Info", "Warning", "Error", "None").
- * @param allowMeteredNetworkUsage  Allows uploading session data to the servers on device metered network.
- * @param enableWebViewCapture    Allows Clarity to capture the web views DOM content.
- * @param allowedDomains    The whitelisted domains to allow Clarity to capture their DOM content.
+ * @param logLevel      [OPTIONAL default = LogLevel.None] The level of logging to show in the device logcat stream.
+ * @param allowMeteredNetworkUsage  [OPTIONAL default = false] Allows uploading session data to the servers on device metered network.
+ * @param enableWebViewCapture    [OPTIONAL default = true] Allows Clarity to capture the web views DOM content.
+ * @param allowedDomains    [OPTIONAL default = ["*"]] The whitelisted domains to allow Clarity to capture their DOM content.
  *                          If it contains "*" as an element, all domains will be captured.
+ * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
  */
-export function initialize(projectId, userId) {
-  let logLevel = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "None";
-  let allowMeteredNetworkUsage = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
-  let enableWebViewCapture = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
-  let allowedDomains = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : ["*"];
+
+/**
+ * The level of logging to show in the device logcat stream.
+ */
+export let LogLevel = /*#__PURE__*/function (LogLevel) {
+  LogLevel["Verbose"] = "Verbose";
+  LogLevel["Debug"] = "Debug";
+  LogLevel["Info"] = "Info";
+  LogLevel["Warning"] = "Warning";
+  LogLevel["Error"] = "Error";
+  LogLevel["None"] = "None";
+  return LogLevel;
+}({});
+
+/**
+ * Initializes the Clarity SDK if the API level is supported.
+ * @param projectId     [REQUIRED] The Clarity project id to send data to.
+ * @param config   [OPTIONAL] The clarity config, if not provided default values are used.
+*/
+export function initialize(projectId, config) {
+  if (typeof projectId !== "string" || !(typeof config === "object" || typeof config === "undefined")) {
+    throw Error("Invalid Clarity initialization arguments. Please check the docs for assitance.");
+  }
+
+  // applying default values
+  let {
+    userId = null,
+    logLevel = LogLevel.None,
+    allowMeteredNetworkUsage = false,
+    enableWebViewCapture = true,
+    allowedDomains = ["*"],
+    disableOnLowEndDevices = false
+  } = config ?? {};
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -33,7 +61,7 @@ export function initialize(projectId, userId) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
     return;
   }
-  Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains);
+  Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains, disableOnLowEndDevices);
 }
 
 /**
@@ -59,26 +87,30 @@ export function setCustomUserId(customUserId) {
 }
 
 /**
- * Returns the active session id. This can be used to correlate the Clarity session with other
- * analytics tools that the developer may be using.
- * @returns a promise that resolves to the current session id.
+ * Sets a custom session id that can be used to identify the session.
+ * <p>
+ * Note: custom session id cannot be null or empty, or consists only of whitespaces.
+ * </p>
+ * @param customSessionId   The custom session id to set.
  */
-export function getCurrentSessionId() {
+export function setCustomSessionId(customSessionId) {
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return new Promise(resolve => {
-      resolve("Undefined");
-    });
+    return;
   }
   if (Clarity === null) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return new Promise(resolve => {
-      resolve("Undefined");
-    });
+    return;
   }
-  return Clarity.getCurrentSessionId();
+  Clarity.setCustomSessionId(customSessionId);
 }
-export function setCurrentScreenName(screenName) {
+
+/**
+ * Sets a custom tag for the current session.
+ * @param key   The tag key to set.
+ * @param value   The tag value to set.
+ */
+export function setCustomTag(key, value) {
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -87,9 +119,17 @@ export function setCurrentScreenName(screenName) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
     return;
   }
-  Clarity.setCurrentScreenName(screenName);
+  Clarity.setCustomTag(key, value);
 }
-export function setCustomTag(key, value) {
+
+/**
+ * For React Native applications only, this function is used to set the current screen name
+ * in case the ReactNative Navigation package is used.
+ * This will allow you to split and analyze your data on the screen names.
+ * You can it set to `null` to remove the latest set value.
+ * @param screenName   The current screen name to set.
+ */
+export function setCurrentScreenName(screenName) {
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -98,6 +138,41 @@ export function setCustomTag(key, value) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
     return;
   }
-  Clarity.setCustomTag(key, value);
+  Clarity.setCurrentScreenName(screenName);
+}
+
+/**
+ * Returns the active session id. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ * @returns a promise that resolves to the current session id.
+ */
+export function getCurrentSessionId() {
+  if (!SupportedPlatforms.includes(Platform.OS)) {
+    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
+    return Promise.resolve("Undefined");
+  }
+  if (Clarity === null) {
+    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+    return Promise.resolve("Undefined");
+  }
+  return Clarity.getCurrentSessionId();
+}
+
+/**
+ * Returns the active session url. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ *
+ * @returns a promise that resolves to the current session url if there is an active one.
+ */
+export function getCurrentSessionUrl() {
+  if (!SupportedPlatforms.includes(Platform.OS)) {
+    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
+    return Promise.resolve("Undefined");
+  }
+  if (Clarity === null) {
+    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+    return Promise.resolve("Undefined");
+  }
+  return Clarity.getCurrentSessionUrl();
 }
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","Clarity","SupportedPlatforms","initialize","projectId","userId","logLevel","arguments","length","undefined","allowMeteredNetworkUsage","enableWebViewCapture","allowedDomains","includes","OS","console","warn","join","error","setCustomUserId","customUserId","getCurrentSessionId","Promise","resolve","setCurrentScreenName","screenName","setCustomTag","key","value"],"sourceRoot":"..\\..\\src","sources":["index.tsx"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GAChB,+EAA8E;AAC/E;AACA,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,OAAO,GAAGH,aAAa,CAACG,OAAO;AAErC,MAAMC,kBAAkB,GAAG,CAAC,SAAS,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CACxBC,SAAiB,EACjBC,MAAe,EAImB;EAAA,IAHlCC,QAAgB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,MAAM;EAAA,IACzBG,wBAAiC,GAAAH,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;EAAA,IACzCI,oBAA6B,GAAAJ,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,IAAI;EAAA,IACpCK,cAAwB,GAAAL,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,GAAG,CAAC;EAChC,IAAI,CAACL,kBAAkB,CAACW,QAAQ,CAACd,QAAQ,CAACe,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGd,kBAAkB,CAACe,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIhB,OAAO,KAAK,IAAI,EAAE;IACpBc,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAElB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACE,UAAU,CAACC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,EAAEI,wBAAwB,EAAEC,oBAAoB,EAAEC,cAAc,CAAC;AACjH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,eAAeA,CAACC,YAAoB,EAAE;EACpD,IAAI,CAAClB,kBAAkB,CAACW,QAAQ,CAACd,QAAQ,CAACe,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGd,kBAAkB,CAACe,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIhB,OAAO,KAAK,IAAI,EAAE;IACpBc,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAElB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACkB,eAAe,CAACC,YAAY,CAAC;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAoB;EACrD,IAAI,CAACnB,kBAAkB,CAACW,QAAQ,CAACd,QAAQ,CAACe,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGd,kBAAkB,CAACe,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAO,IAAIK,OAAO,CAAEC,OAAO,IAAK;MAC9BA,OAAO,CAAC,WAAW,CAAC;IACtB,CAAC,CAAC;EACJ;EAEA,IAAItB,OAAO,KAAK,IAAI,EAAE;IACpBc,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAElB,aAAa,CAAC;IACpE,OAAO,IAAIsB,OAAO,CAAEC,OAAO,IAAK;MAC9BA,OAAO,CAAC,WAAW,CAAC;IACtB,CAAC,CAAC;EACJ;EAEA,OAAOtB,OAAO,CAACoB,mBAAmB,CAAC,CAAC;AACtC;AAEA,OAAO,SAASG,oBAAoBA,CAACC,UAAkB,EAAE;EACvD,IAAI,CAACvB,kBAAkB,CAACW,QAAQ,CAACd,QAAQ,CAACe,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGd,kBAAkB,CAACe,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIhB,OAAO,KAAK,IAAI,EAAE;IACpBc,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAElB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACuB,oBAAoB,CAACC,UAAU,CAAC;AAC1C;AAEA,OAAO,SAASC,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAE;EACvD,IAAI,CAAC1B,kBAAkB,CAACW,QAAQ,CAACd,QAAQ,CAACe,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGd,kBAAkB,CAACe,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIhB,OAAO,KAAK,IAAI,EAAE;IACpBc,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAElB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACyB,YAAY,CAACC,GAAG,EAAEC,KAAK,CAAC;AAClC"}
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","Clarity","SupportedPlatforms","LogLevel","initialize","projectId","config","Error","userId","logLevel","None","allowMeteredNetworkUsage","enableWebViewCapture","allowedDomains","disableOnLowEndDevices","includes","OS","console","warn","join","error","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","key","value","setCurrentScreenName","screenName","getCurrentSessionId","Promise","resolve","getCurrentSessionUrl"],"sourceRoot":"..\\..\\src","sources":["index.tsx"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GAChB,+EAA8E;AAC/E;AACA,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,OAAO,GAAGH,aAAa,CAACG,OAAO;AAErC,MAAMC,kBAAkB,GAAG,CAAC,SAAS,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA,WAAYC,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;;AASpB;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACC,SAAiB,EAAEC,MAAsB,EAAE;EAEpE,IAAI,OAAOD,SAAS,KAAK,QAAQ,IAAI,EAAE,OAAOC,MAAM,KAAK,QAAQ,IAAI,OAAOA,MAAM,KAAK,WAAW,CAAC,EAAE;IACnG,MAAMC,KAAK,CAAC,gFAAgF,CAAC;EAC/F;;EAEA;EACA,IAAI;IAAEC,MAAM,GAAG,IAAI;IACjBC,QAAQ,GAAGN,QAAQ,CAACO,IAAI;IACxBC,wBAAwB,GAAG,KAAK;IAChCC,oBAAoB,GAAG,IAAI;IAC3BC,cAAc,GAAG,CAAC,GAAG,CAAC;IACtBC,sBAAsB,GAAG;EAAM,CAAC,GAAGR,MAAM,IAAI,CAAC,CAAC;EAEjD,IAAI,CAACJ,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACG,UAAU,CAACC,SAAS,EAAEG,MAAM,EAAEC,QAAQ,EAAEE,wBAAwB,EAAEC,oBAAoB,EAAEC,cAAc,EAAEC,sBAAsB,CAAC;AACzI;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,eAAeA,CAACC,YAAoB,EAAE;EACpD,IAAI,CAACpB,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACoB,eAAe,CAACC,YAAY,CAAC;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,eAAuB,EAAE;EAC1D,IAAI,CAACtB,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACsB,kBAAkB,CAACC,eAAe,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAE;EACvD,IAAI,CAACzB,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACwB,YAAY,CAACC,GAAG,EAAEC,KAAK,CAAC;AAClC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAACC,UAAyB,EAAE;EAC9D,IAAI,CAAC3B,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAIlB,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAAC2B,oBAAoB,CAACC,UAAU,CAAC;AAC1C;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAoB;EACrD,IAAI,CAAC5B,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOY,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,IAAI/B,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE,OAAO+B,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAO/B,OAAO,CAAC6B,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,oBAAoBA,CAAA,EAAoB;EACtD,IAAI,CAAC/B,kBAAkB,CAACa,QAAQ,CAAChB,QAAQ,CAACiB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGhB,kBAAkB,CAACiB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOY,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,IAAI/B,OAAO,KAAK,IAAI,EAAE;IACpBgB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEpB,aAAa,CAAC;IACpE,OAAO+B,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAO/B,OAAO,CAACgC,oBAAoB,CAAC,CAAC;AACvC"}

package/lib/typescript/index.d.ts

@@ -1,19 +1,43 @@
 /**
- * Initializes the Clarity plugin with the provided parameters.
+ * The configuration that will be used to customize the Clarity behaviour.
  *
- * @param projectId     The Clarity project id to send data to.
- * @param userId        A custom identifier for the current user. If passed as undefined, the user id
+ * @param userId        [OPTIONAL default = null] A custom identifier for the current user. If passed as null, the user id
  *                      will be auto generated. The user id in general is sticky across sessions.
  *                      The provided user id must follow these conditions:
  *                          1. Cannot be an empty string.
  *                          2. Should be base36 and smaller than "1Z141Z4".
- * @param logLevel      The level of logging to show in the device logcat stream ("Verbose", "Debug", "Info", "Warning", "Error", "None").
- * @param allowMeteredNetworkUsage  Allows uploading session data to the servers on device metered network.
- * @param enableWebViewCapture    Allows Clarity to capture the web views DOM content.
- * @param allowedDomains    The whitelisted domains to allow Clarity to capture their DOM content.
+ * @param logLevel      [OPTIONAL default = LogLevel.None] The level of logging to show in the device logcat stream.
+ * @param allowMeteredNetworkUsage  [OPTIONAL default = false] Allows uploading session data to the servers on device metered network.
+ * @param enableWebViewCapture    [OPTIONAL default = true] Allows Clarity to capture the web views DOM content.
+ * @param allowedDomains    [OPTIONAL default = ["*"]] The whitelisted domains to allow Clarity to capture their DOM content.
  *                          If it contains "*" as an element, all domains will be captured.
+ * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
  */
-export declare function initialize(projectId: string, userId?: string, logLevel?: string, allowMeteredNetworkUsage?: boolean, enableWebViewCapture?: boolean, allowedDomains?: string[]): void;
+export interface ClarityConfig {
+    userId?: string | null;
+    logLevel?: LogLevel;
+    allowMeteredNetworkUsage?: boolean;
+    enableWebViewCapture?: boolean;
+    allowedDomains?: string[];
+    disableOnLowEndDevices?: Boolean;
+}
+/**
+ * The level of logging to show in the device logcat stream.
+ */
+export declare enum LogLevel {
+    Verbose = "Verbose",
+    Debug = "Debug",
+    Info = "Info",
+    Warning = "Warning",
+    Error = "Error",
+    None = "None"
+}
+/**
+ * Initializes the Clarity SDK if the API level is supported.
+ * @param projectId     [REQUIRED] The Clarity project id to send data to.
+ * @param config   [OPTIONAL] The clarity config, if not provided default values are used.
+*/
+export declare function initialize(projectId: string, config?: ClarityConfig): void;
 /**
  * Sets a custom user id that can be used to identify the user. It has less
  * restrictions than the userId parameter. You can pass any string and
@@ -25,12 +49,39 @@ export declare function initialize(projectId: string, userId?: string, logLevel?
  * @param customUserId   The custom user id to set.
  */
 export declare function setCustomUserId(customUserId: string): void;
+/**
+ * Sets a custom session id that can be used to identify the session.
+ * <p>
+ * Note: custom session id cannot be null or empty, or consists only of whitespaces.
+ * </p>
+ * @param customSessionId   The custom session id to set.
+ */
+export declare function setCustomSessionId(customSessionId: string): void;
+/**
+ * Sets a custom tag for the current session.
+ * @param key   The tag key to set.
+ * @param value   The tag value to set.
+ */
+export declare function setCustomTag(key: string, value: string): void;
+/**
+ * For React Native applications only, this function is used to set the current screen name
+ * in case the ReactNative Navigation package is used.
+ * This will allow you to split and analyze your data on the screen names.
+ * You can it set to `null` to remove the latest set value.
+ * @param screenName   The current screen name to set.
+ */
+export declare function setCurrentScreenName(screenName: string | null): void;
 /**
  * Returns the active session id. This can be used to correlate the Clarity session with other
  * analytics tools that the developer may be using.
  * @returns a promise that resolves to the current session id.
  */
 export declare function getCurrentSessionId(): Promise<string>;
-export declare function setCurrentScreenName(screenName: string): void;
-export declare function setCustomTag(key: string, value: string): void;
+/**
+ * Returns the active session url. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ *
+ * @returns a promise that resolves to the current session url if there is an active one.
+ */
+export declare function getCurrentSessionUrl(): Promise<string>;
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,GAAE,MAAe,EACzB,wBAAwB,GAAE,OAAe,EACzC,oBAAoB,GAAE,OAAc,EACpC,cAAc,GAAE,MAAM,EAAU,QAYjC;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,QAYnD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAgBrD;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,QAYtD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAYtD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,QAAQ;IAClB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED;;;;EAIE;AACF,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,QAyBnE;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,QAYnD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,QAYzD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAYtD;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,QAY7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAYrD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAYtD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-clarity",
-  "version": "1.0.1",
+  "version": "2.1.0",
   "description": "A plugin to provide the Clarity experience for the React Native applications.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -34,7 +34,7 @@
     "release": "release-it",
     "example": "yarn --cwd example",
     "bootstrap": "yarn example && yarn install && yarn example pods",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build"
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build *.tgz"
   },
   "keywords": [
     "react-native",

package/src/index.tsx

@@ -11,27 +11,60 @@ const Clarity = NativeModules.Clarity;
 const SupportedPlatforms = ['android']
 
 /**
- * Initializes the Clarity plugin with the provided parameters.
+ * The configuration that will be used to customize the Clarity behaviour.
  *
- * @param projectId     The Clarity project id to send data to.
- * @param userId        A custom identifier for the current user. If passed as undefined, the user id
+ * @param userId        [OPTIONAL default = null] A custom identifier for the current user. If passed as null, the user id
  *                      will be auto generated. The user id in general is sticky across sessions.
  *                      The provided user id must follow these conditions:
  *                          1. Cannot be an empty string.
  *                          2. Should be base36 and smaller than "1Z141Z4".
- * @param logLevel      The level of logging to show in the device logcat stream ("Verbose", "Debug", "Info", "Warning", "Error", "None").
- * @param allowMeteredNetworkUsage  Allows uploading session data to the servers on device metered network.
- * @param enableWebViewCapture    Allows Clarity to capture the web views DOM content.
- * @param allowedDomains    The whitelisted domains to allow Clarity to capture their DOM content.
+ * @param logLevel      [OPTIONAL default = LogLevel.None] The level of logging to show in the device logcat stream.
+ * @param allowMeteredNetworkUsage  [OPTIONAL default = false] Allows uploading session data to the servers on device metered network.
+ * @param enableWebViewCapture    [OPTIONAL default = true] Allows Clarity to capture the web views DOM content.
+ * @param allowedDomains    [OPTIONAL default = ["*"]] The whitelisted domains to allow Clarity to capture their DOM content.
  *                          If it contains "*" as an element, all domains will be captured.
+ * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
  */
-export function initialize(
-  projectId: string,
-  userId?: string,
-  logLevel: string = "None",
-  allowMeteredNetworkUsage: boolean = false,
-  enableWebViewCapture: boolean = true,
-  allowedDomains: string[] = ["*"]) {
+export interface ClarityConfig {
+  userId?: string | null;
+  logLevel?: LogLevel;
+  allowMeteredNetworkUsage?: boolean;
+  enableWebViewCapture?: boolean;
+  allowedDomains?: string[];
+  disableOnLowEndDevices?: Boolean;
+}
+
+/**
+ * The level of logging to show in the device logcat stream.
+ */
+export enum LogLevel {
+  Verbose = "Verbose",
+  Debug = "Debug",
+  Info = "Info",
+  Warning = "Warning",
+  Error = "Error",
+  None = "None"
+}
+
+/**
+ * Initializes the Clarity SDK if the API level is supported.
+ * @param projectId     [REQUIRED] The Clarity project id to send data to.
+ * @param config   [OPTIONAL] The clarity config, if not provided default values are used.
+*/
+export function initialize(projectId: string, config?: ClarityConfig) {
+
+  if (typeof projectId !== "string" || !(typeof config === "object" || typeof config === "undefined")) {
+    throw Error("Invalid Clarity initialization arguments. Please check the docs for assitance.")
+  }
+
+  // applying default values
+  let { userId = null,
+    logLevel = LogLevel.None,
+    allowMeteredNetworkUsage = false,
+    enableWebViewCapture = true,
+    allowedDomains = ["*"],
+    disableOnLowEndDevices = false } = config ?? {};
+
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -42,7 +75,7 @@ export function initialize(
     return;
   }
 
-  Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains);
+  Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains, disableOnLowEndDevices);
 }
 
 /**
@@ -70,29 +103,32 @@ export function setCustomUserId(customUserId: string) {
 }
 
 /**
- * Returns the active session id. This can be used to correlate the Clarity session with other
- * analytics tools that the developer may be using.
- * @returns a promise that resolves to the current session id.
+ * Sets a custom session id that can be used to identify the session.
+ * <p>
+ * Note: custom session id cannot be null or empty, or consists only of whitespaces.
+ * </p>
+ * @param customSessionId   The custom session id to set.
  */
-export function getCurrentSessionId(): Promise<string> {
+export function setCustomSessionId(customSessionId: string) {
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return new Promise((resolve) => {
-      resolve("Undefined");
-    });
+    return;
   }
 
   if (Clarity === null) {
     console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return new Promise((resolve) => {
-      resolve("Undefined");
-    });
+    return;
   }
 
-  return Clarity.getCurrentSessionId();
+  Clarity.setCustomSessionId(customSessionId);
 }
 
-export function setCurrentScreenName(screenName: string) {
+/**
+ * Sets a custom tag for the current session.
+ * @param key   The tag key to set.
+ * @param value   The tag value to set.
+ */
+export function setCustomTag(key: string, value: string) {
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -103,10 +139,17 @@ export function setCurrentScreenName(screenName: string) {
     return;
   }
 
-  Clarity.setCurrentScreenName(screenName);
+  Clarity.setCustomTag(key, value);
 }
 
-export function setCustomTag(key: string, value: string) {
+/**
+ * For React Native applications only, this function is used to set the current screen name
+ * in case the ReactNative Navigation package is used.
+ * This will allow you to split and analyze your data on the screen names.
+ * You can it set to `null` to remove the latest set value.
+ * @param screenName   The current screen name to set.
+ */
+export function setCurrentScreenName(screenName: string | null) {
   if (!SupportedPlatforms.includes(Platform.OS)) {
     console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
     return;
@@ -117,5 +160,44 @@ export function setCustomTag(key: string, value: string) {
     return;
   }
 
-  Clarity.setCustomTag(key, value);
+  Clarity.setCurrentScreenName(screenName);
+}
+
+/**
+ * Returns the active session id. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ * @returns a promise that resolves to the current session id.
+ */
+export function getCurrentSessionId(): Promise<string> {
+  if (!SupportedPlatforms.includes(Platform.OS)) {
+    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
+    return Promise.resolve("Undefined");
+  }
+
+  if (Clarity === null) {
+    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+    return Promise.resolve("Undefined");
+  }
+
+  return Clarity.getCurrentSessionId();
+}
+
+/**
+ * Returns the active session url. This can be used to correlate the Clarity session with other
+ * analytics tools that the developer may be using.
+ *
+ * @returns a promise that resolves to the current session url if there is an active one.
+ */
+export function getCurrentSessionUrl(): Promise<string> {
+  if (!SupportedPlatforms.includes(Platform.OS)) {
+    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
+    return Promise.resolve("Undefined");
+  }
+
+  if (Clarity === null) {
+    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+    return Promise.resolve("Undefined");
+  }
+
+  return Clarity.getCurrentSessionUrl();
 }