react-native-clarity 2.3.0 → 3.0.0

package/lib/module/index.js

@@ -1,29 +1,33 @@
 import { NativeModules, Platform } from 'react-native';
-const LINKING_ERROR = `The package 'react-native-clarity' doesn't seem to be linked. Make sure: \n\n` +
-// Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) + TODO: add back when iOS is supported.
-'- You rebuilt the app after installing the package\n' + '- You are not using Expo Go\n';
+const LINKING_ERROR = `The package 'react-native-clarity' doesn't seem to be linked. Make sure: \n\n` + Platform.select({
+  ios: "- You have run 'pod install --repo-update'\n",
+  default: ''
+}) + '- You rebuilt the app after installing the package\n' + '- You are not using Expo Go\n';
 const Clarity = NativeModules.Clarity;
 const SupportedPlatforms = ['android'];
 
-/**
- * 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      [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.
- * @param maximumDailyNetworkUsageInMB [OPTIONAL default = null] Maximum daily network usage for Clarity (null = No limit). When the limit is reached, Clarity will turn on lean mode.
+/**
+ * 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      [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.
+ *                          Note: iOS currently does not support allowedDomains feature.
+ * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
+ * @param maximumDailyNetworkUsageInMB [OPTIONAL default = null] Maximum daily network usage for Clarity (null = No limit). When the limit is reached, Clarity will turn on lean mode.
+ *                                      Note: iOS currently does not support limiting network usage.
+ * @param enableIOS_experimental [OPTIONAL default = false] Experimental flag to enable Clarity on iOS platform.
  */
 
-/**
- * The level of logging to show in the device logcat stream.
+/**
+ * The level of logging to show in the device logcat stream.
  */
 export let LogLevel = /*#__PURE__*/function (LogLevel) {
   LogLevel["Verbose"] = "Verbose";
@@ -34,15 +38,26 @@ export let LogLevel = /*#__PURE__*/function (LogLevel) {
   LogLevel["None"] = "None";
   return LogLevel;
 }({});
+function isClarityUnavailable() {
+  if (!SupportedPlatforms.includes(Platform.OS)) {
+    console.warn('Clarity supports ' + SupportedPlatforms.join(', ') + ' only for now.');
+    return true;
+  }
+  if (Clarity === null) {
+    console.error('Clarity did not initialize properly.', LINKING_ERROR);
+    return true;
+  }
+  return false;
+}
 
-/**
- * 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.
-*/
+/**
+ * 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.");
+  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
@@ -51,16 +66,15 @@ export function initialize(projectId, config) {
     logLevel = LogLevel.None,
     allowMeteredNetworkUsage = false,
     enableWebViewCapture = true,
-    allowedDomains = ["*"],
+    allowedDomains = ['*'],
     disableOnLowEndDevices = false,
-    maximumDailyNetworkUsageInMB = null
+    maximumDailyNetworkUsageInMB = null,
+    enableIOS_experimental = false
   } = config ?? {};
-  if (!SupportedPlatforms.includes(Platform.OS)) {
-    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return;
+  if (enableIOS_experimental === true && !SupportedPlatforms.includes('ios')) {
+    SupportedPlatforms.push('ios');
   }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
+  if (isClarityUnavailable()) {
     return;
   }
 
@@ -70,160 +84,115 @@ export function initialize(projectId, config) {
   Clarity.initialize(projectId, userId, logLevel, allowMeteredNetworkUsage, enableWebViewCapture, allowedDomains, disableOnLowEndDevices, enableDailyNetworkUsageLimit, refinedMaximumDailyNetworkUsageInMB);
 }
 
-/**
- * Pauses the Clarity capturing processes until the next resume() is called.
+/**
+ * Pauses the Clarity capturing processes until the next resume() is called.
  */
 export function pause() {
-  if (!SupportedPlatforms.includes(Platform.OS)) {
-    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return;
-  }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
-  Clarity.pause();
+  return Clarity.pause();
 }
 
-/**
- * Resumes the Clarity capturing processes if they are not already resumed.
- * Note: Clarity starts capturing data right on initialization.
+/**
+ * Resumes the Clarity capturing processes if they are not already resumed.
+ * Note: Clarity starts capturing data right on initialization.
  */
 export function resume() {
-  if (!SupportedPlatforms.includes(Platform.OS)) {
-    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return;
-  }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
-  Clarity.resume();
+  return Clarity.resume();
 }
 
-/**
- * Returns true if Clarity has been paused by the user.
+/**
+ * Returns true if Clarity has been paused by the user.
  */
 export function isPaused() {
-  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);
+  if (isClarityUnavailable()) {
     return Promise.resolve(undefined);
   }
   return Clarity.isPaused();
 }
 
-/**
- * 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
- * you can filter on it on the dashboard side. If you need the most efficient
- * filtering on the dashboard, use the userId parameter if possible.
- * <p>
- * Note: custom user id cannot be null or empty, or consists only of whitespaces.
- * </p>
- * @param customUserId   The custom user id to set.
+/**
+ * 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
+ * you can filter on it on the dashboard side. If you need the most efficient
+ * filtering on the dashboard, use the userId parameter if possible.
+ * <p>
+ * Note: custom user id cannot be null or empty, or consists only of whitespaces.
+ * </p>
+ * @param customUserId   The custom user id to set.
  */
 export function setCustomUserId(customUserId) {
-  if (!SupportedPlatforms.includes(Platform.OS)) {
-    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return;
-  }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
-  Clarity.setCustomUserId(customUserId);
+  return Clarity.setCustomUserId(customUserId);
 }
 
-/**
- * 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.
+/**
+ * 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 setCustomSessionId(customSessionId) {
-  if (!SupportedPlatforms.includes(Platform.OS)) {
-    console.warn("Clarity supports " + SupportedPlatforms.join(", ") + " only for now.");
-    return;
-  }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
-  Clarity.setCustomSessionId(customSessionId);
+  return Clarity.setCustomSessionId(customSessionId);
 }
 
-/**
- * Sets a custom tag for the current session.
- * @param key   The tag key to set.
- * @param value   The tag value to set.
+/**
+ * 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;
-  }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
-  Clarity.setCustomTag(key, value);
+  return Clarity.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.
+/**
+ * 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;
-  }
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
-  Clarity.setCurrentScreenName(screenName);
+  return 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.
+/**
+ * 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");
+  if (isClarityUnavailable()) {
+    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.
+/**
+ * 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");
+  if (isClarityUnavailable()) {
+    return Promise.resolve('Undefined');
   }
   return Clarity.getCurrentSessionUrl();
 }

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","Clarity","SupportedPlatforms","LogLevel","initialize","projectId","config","Error","userId","logLevel","None","allowMeteredNetworkUsage","enableWebViewCapture","allowedDomains","disableOnLowEndDevices","maximumDailyNetworkUsageInMB","includes","OS","console","warn","join","error","enableDailyNetworkUsageLimit","refinedMaximumDailyNetworkUsageInMB","pause","resume","isPaused","Promise","resolve","undefined","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","key","value","setCurrentScreenName","screenName","getCurrentSessionId","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;AACA;;AAWA;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,KAAK;IAC9BC,4BAA4B,GAAG;EAAK,CAAC,GAAGT,MAAM,IAAI,CAAC,CAAC;EAEtD,IAAI,CAACJ,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;;EAEA;EACA,IAAIsB,4BAA4B,GAAGP,4BAA4B,IAAI,IAAI;EACvE,IAAIQ,mCAAmC,GAAGR,4BAA4B,IAAI,CAAC;EAE3Ed,OAAO,CAACG,UAAU,CAChBC,SAAS,EACTG,MAAM,EACNC,QAAQ,EACRE,wBAAwB,EACxBC,oBAAoB,EACpBC,cAAc,EACdC,sBAAsB,EACtBQ,4BAA4B,EAC5BC,mCACF,CAAC;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAAA,EAAE;EACrB,IAAI,CAACtB,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACuB,KAAK,CAAC,CAAC;AACjB;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAAA,EAAE;EACtB,IAAI,CAACvB,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACwB,MAAM,CAAC,CAAC;AAClB;;AAEA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAAA,EAAgC;EACtD,IAAI,CAACxB,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOO,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,IAAI5B,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE,OAAO2B,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO5B,OAAO,CAACyB,QAAQ,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,eAAeA,CAACC,YAAoB,EAAE;EACpD,IAAI,CAAC7B,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAAC6B,eAAe,CAACC,YAAY,CAAC;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,eAAuB,EAAE;EAC1D,IAAI,CAAC/B,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAAC+B,kBAAkB,CAACC,eAAe,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAE;EACvD,IAAI,CAAClC,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACiC,YAAY,CAACC,GAAG,EAAEC,KAAK,CAAC;AAClC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAACC,UAAyB,EAAE;EAC9D,IAAI,CAACpC,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF;EACF;EAEA,IAAInB,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE;EACF;EAEAC,OAAO,CAACoC,oBAAoB,CAACC,UAAU,CAAC;AAC1C;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAoB;EACrD,IAAI,CAACrC,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOO,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,IAAI3B,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE,OAAO2B,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAO3B,OAAO,CAACsC,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAAA,EAAoB;EACtD,IAAI,CAACtC,kBAAkB,CAACc,QAAQ,CAACjB,QAAQ,CAACkB,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CAAC,mBAAmB,GAAGjB,kBAAkB,CAACkB,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACpF,OAAOO,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,IAAI3B,OAAO,KAAK,IAAI,EAAE;IACpBiB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAErB,aAAa,CAAC;IACpE,OAAO2B,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAO3B,OAAO,CAACuC,oBAAoB,CAAC,CAAC;AACvC"}
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","Clarity","SupportedPlatforms","LogLevel","isClarityUnavailable","includes","OS","console","warn","join","error","initialize","projectId","config","Error","userId","logLevel","None","allowMeteredNetworkUsage","enableWebViewCapture","allowedDomains","disableOnLowEndDevices","maximumDailyNetworkUsageInMB","enableIOS_experimental","push","enableDailyNetworkUsageLimit","refinedMaximumDailyNetworkUsageInMB","pause","Promise","resolve","undefined","resume","isPaused","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","key","value","setCurrentScreenName","screenName","getCurrentSessionId","getCurrentSessionUrl"],"sourceRoot":"..\\..\\src","sources":["index.tsx"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GACjB,+EAA+E,GAC/ED,QAAQ,CAACE,MAAM,CAAC;EACdC,GAAG,EAAE,8CAA8C;EACnDC,OAAO,EAAE;AACX,CAAC,CAAC,GACF,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,OAAO,GAAGN,aAAa,CAACM,OAAO;AAErC,MAAMC,kBAAkB,GAAG,CAAC,SAAS,CAAC;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA,WAAYC,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AASpB,SAASC,oBAAoBA,CAAA,EAAY;EACvC,IAAI,CAACF,kBAAkB,CAACG,QAAQ,CAACT,QAAQ,CAACU,EAAE,CAAC,EAAE;IAC7CC,OAAO,CAACC,IAAI,CACV,mBAAmB,GAAGN,kBAAkB,CAACO,IAAI,CAAC,IAAI,CAAC,GAAG,gBACxD,CAAC;IACD,OAAO,IAAI;EACb;EAEA,IAAIR,OAAO,KAAK,IAAI,EAAE;IACpBM,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEb,aAAa,CAAC;IACpE,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASc,UAAUA,CAACC,SAAiB,EAAEC,MAAsB,EAAE;EACpE,IACE,OAAOD,SAAS,KAAK,QAAQ,IAC7B,EAAE,OAAOC,MAAM,KAAK,QAAQ,IAAI,OAAOA,MAAM,KAAK,WAAW,CAAC,EAC9D;IACA,MAAMC,KAAK,CACT,gFACF,CAAC;EACH;;EAEA;EACA,IAAI;IACFC,MAAM,GAAG,IAAI;IACbC,QAAQ,GAAGb,QAAQ,CAACc,IAAI;IACxBC,wBAAwB,GAAG,KAAK;IAChCC,oBAAoB,GAAG,IAAI;IAC3BC,cAAc,GAAG,CAAC,GAAG,CAAC;IACtBC,sBAAsB,GAAG,KAAK;IAC9BC,4BAA4B,GAAG,IAAI;IACnCC,sBAAsB,GAAG;EAC3B,CAAC,GAAGV,MAAM,IAAI,CAAC,CAAC;EAEhB,IAAIU,sBAAsB,KAAK,IAAI,IAAI,CAACrB,kBAAkB,CAACG,QAAQ,CAAC,KAAK,CAAC,EAAE;IAC1EH,kBAAkB,CAACsB,IAAI,CAAC,KAAK,CAAC;EAChC;EAEA,IAAIpB,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;;EAEA;EACA,IAAIqB,4BAA4B,GAAGH,4BAA4B,IAAI,IAAI;EACvE,IAAII,mCAAmC,GAAGJ,4BAA4B,IAAI,CAAC;EAE3ErB,OAAO,CAACU,UAAU,CAChBC,SAAS,EACTG,MAAM,EACNC,QAAQ,EACRE,wBAAwB,EACxBC,oBAAoB,EACpBC,cAAc,EACdC,sBAAsB,EACtBI,4BAA4B,EAC5BC,mCACF,CAAC;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAAA,EAAiC;EACpD,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAAC0B,KAAK,CAAC,CAAC;AACxB;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASI,MAAMA,CAAA,EAAiC;EACrD,IAAI3B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAAC8B,MAAM,CAAC,CAAC;AACzB;;AAEA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAAA,EAAiC;EACvD,IAAI5B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAAC+B,QAAQ,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,YAAoB,EAAgC;EAClF,IAAI9B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAACgC,eAAe,CAACC,YAAY,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,eAAuB,EAAgC;EACxF,IAAIhC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAACkC,kBAAkB,CAACC,eAAe,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAgC;EACrF,IAAInC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAACoC,YAAY,CAACC,GAAG,EAAEC,KAAK,CAAC;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAClCC,UAAyB,EACK;EAC9B,IAAIrC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAACC,SAAS,CAAC;EACnC;EAEA,OAAO7B,OAAO,CAACuC,oBAAoB,CAACC,UAAU,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAoB;EACrD,IAAItC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAO5B,OAAO,CAACyC,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAAA,EAAoB;EACtD,IAAIvC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOwB,OAAO,CAACC,OAAO,CAAC,WAAW,CAAC;EACrC;EAEA,OAAO5B,OAAO,CAAC0C,oBAAoB,CAAC,CAAC;AACvC","ignoreList":[]}

package/lib/typescript/index.d.ts

@@ -11,8 +11,11 @@
  * @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.
+ *                          Note: iOS currently does not support allowedDomains feature.
  * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Clarity on low-end devices.
  * @param maximumDailyNetworkUsageInMB [OPTIONAL default = null] Maximum daily network usage for Clarity (null = No limit). When the limit is reached, Clarity will turn on lean mode.
+ *                                      Note: iOS currently does not support limiting network usage.
+ * @param enableIOS_experimental [OPTIONAL default = false] Experimental flag to enable Clarity on iOS platform.
  */
 export interface ClarityConfig {
     userId?: string | null;
@@ -22,6 +25,7 @@ export interface ClarityConfig {
     allowedDomains?: string[];
     disableOnLowEndDevices?: Boolean;
     maximumDailyNetworkUsageInMB?: number;
+    enableIOS_experimental?: boolean;
 }
 /**
  * The level of logging to show in the device logcat stream.
@@ -38,17 +42,17 @@ export declare enum 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 declare function initialize(projectId: string, config?: ClarityConfig): void;
 /**
  * Pauses the Clarity capturing processes until the next resume() is called.
  */
-export declare function pause(): void;
+export declare function pause(): Promise<boolean | undefined>;
 /**
  * Resumes the Clarity capturing processes if they are not already resumed.
  * Note: Clarity starts capturing data right on initialization.
  */
-export declare function resume(): void;
+export declare function resume(): Promise<boolean | undefined>;
 /**
  * Returns true if Clarity has been paused by the user.
  */
@@ -63,7 +67,7 @@ export declare function isPaused(): Promise<Boolean | undefined>;
  * </p>
  * @param customUserId   The custom user id to set.
  */
-export declare function setCustomUserId(customUserId: string): void;
+export declare function setCustomUserId(customUserId: string): Promise<boolean | undefined>;
 /**
  * Sets a custom session id that can be used to identify the session.
  * <p>
@@ -71,13 +75,13 @@ export declare function setCustomUserId(customUserId: string): void;
  * </p>
  * @param customSessionId   The custom session id to set.
  */
-export declare function setCustomSessionId(customSessionId: string): void;
+export declare function setCustomSessionId(customSessionId: string): Promise<boolean | undefined>;
 /**
  * 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;
+export declare function setCustomTag(key: string, value: string): Promise<boolean | undefined>;
 /**
  * For React Native applications only, this function is used to set the current screen name
  * in case the ReactNative Navigation package is used.
@@ -85,7 +89,7 @@ export declare function setCustomTag(key: string, value: string): void;
  * 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;
+export declare function setCurrentScreenName(screenName: string | null): Promise<boolean | undefined>;
 /**
  * Returns the active session id. This can be used to correlate the Clarity session with other
  * analytics tools that the developer may be using.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAYA;;;;;;;;;;;;;;;GAeG;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;IACjC,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC;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,QAwCnE;AAED;;GAEG;AACH,wBAAgB,KAAK,SAYpB;AAED;;;GAGG;AACH,wBAAgB,MAAM,SAYrB;AAED;;GAEG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAYvD;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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;;;;GAkBG;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;IACjC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,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;AAkBD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,QA6CnE;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAMpD;AAED;;;GAGG;AACH,wBAAgB,MAAM,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAMrD;AAED;;GAEG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAMvD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAMlF;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAMxF;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAMrF;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GAAG,IAAI,GACxB,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAM9B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAMrD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAMtD"}