react-native-clarity 2.3.0 → 3.0.1

package/lib/typescript/index.d.ts

@@ -1,102 +1,106 @@
-/**
- * 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.
- */
-export interface ClarityConfig {
-    userId?: string | null;
-    logLevel?: LogLevel;
-    allowMeteredNetworkUsage?: boolean;
-    enableWebViewCapture?: boolean;
-    allowedDomains?: string[];
-    disableOnLowEndDevices?: Boolean;
-    maximumDailyNetworkUsageInMB?: number;
-}
-/**
- * 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;
-/**
- * Pauses the Clarity capturing processes until the next resume() is called.
- */
-export declare function pause(): void;
-/**
- * Resumes the Clarity capturing processes if they are not already resumed.
- * Note: Clarity starts capturing data right on initialization.
- */
-export declare function resume(): void;
-/**
- * Returns true if Clarity has been paused by the user.
- */
-export declare function isPaused(): Promise<Boolean | undefined>;
-/**
- * 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 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>;
-/**
- * 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>;
+/**
+ * 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.
+ */
+export interface ClarityConfig {
+    userId?: string | null;
+    logLevel?: LogLevel;
+    allowMeteredNetworkUsage?: boolean;
+    enableWebViewCapture?: boolean;
+    allowedDomains?: string[];
+    disableOnLowEndDevices?: Boolean;
+    maximumDailyNetworkUsageInMB?: number;
+    enableIOS_experimental?: 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;
+/**
+ * Pauses the Clarity capturing processes until the next resume() is called.
+ */
+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(): Promise<boolean | undefined>;
+/**
+ * Returns true if Clarity has been paused by the user.
+ */
+export declare function isPaused(): Promise<Boolean | undefined>;
+/**
+ * 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 declare function setCustomUserId(customUserId: string): Promise<boolean | undefined>;
+/**
+ * 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): 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): 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.
+ * 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): 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.
+ * @returns a promise that resolves to the current session id.
+ */
+export declare function getCurrentSessionId(): Promise<string>;
+/**
+ * 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;;;;;;;;;;;;;;;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":"AAiBA;;;;;;;;;;;;;;;;;;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;AAyBD;;;;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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-clarity",
-  "version": "2.3.0",
+  "version": "3.0.1",
   "description": "A plugin to provide the Clarity experience for the React Native applications.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -77,7 +77,13 @@
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": "*"
+    "react-native": "*",
+    "react-native-svg": ">=14.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react-native-svg": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">= 16.0.0"

package/react-native-clarity.podspec

@@ -1,35 +1,36 @@
-require "json"
-
-package = JSON.parse(File.read(File.join(__dir__, "package.json")))
-folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
-
-Pod::Spec.new do |s|
-  s.name         = "react-native-clarity"
-  s.version      = package["version"]
-  s.summary      = package["description"]
-  s.homepage     = package["homepage"]
-  s.license      = package["license"]
-  s.authors      = package["author"]
-
-  s.platforms    = { :ios => "11.0" }
-  s.source       = { :git => "https://msasg.visualstudio.com/Clarity/_git/clarity-react-native.git", :tag => "#{s.version}" }
-
-  s.source_files = "ios/**/*.{h,m,mm}"
-
-  s.dependency "React-Core"
-
-  # Don't install the dependencies when we run `pod install` in the old architecture.
-  if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
-    s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
-    s.pod_target_xcconfig    = {
-        "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
-        "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
-        "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
-    }
-    s.dependency "React-Codegen"
-    s.dependency "RCT-Folly"
-    s.dependency "RCTRequired"
-    s.dependency "RCTTypeSafety"
-    s.dependency "ReactCommon/turbomodule/core"
-  end
-end
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-clarity"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "13.0" }
+  s.source       = { :git => "https://msasg.visualstudio.com/Clarity/_git/clarity-react-native.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm}"
+
+  s.dependency "React-Core"
+  s.dependency "Clarity", '1.0.0'
+
+  # Don't install the dependencies when we run `pod install` in the old architecture.
+  if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+    s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+    s.pod_target_xcconfig    = {
+        "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+        "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+        "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+    }
+    s.dependency "React-Codegen"
+    s.dependency "RCT-Folly"
+    s.dependency "RCTRequired"
+    s.dependency "RCTTypeSafety"
+    s.dependency "ReactCommon/turbomodule/core"
+  end
+end

package/src/index.tsx

@@ -2,13 +2,18 @@ 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.
+  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']
+const SupportedPlatforms = ['android'];
+
+let SupportWarningWasShown = false;
 
 /**
  * The configuration that will be used to customize the Clarity behaviour.
@@ -23,8 +28,11 @@ const SupportedPlatforms = ['android']
  * @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;
@@ -34,47 +42,76 @@ export interface ClarityConfig {
   allowedDomains?: string[];
   disableOnLowEndDevices?: Boolean;
   maximumDailyNetworkUsageInMB?: number;
+  enableIOS_experimental?: 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"
+  Verbose = 'Verbose',
+  Debug = 'Debug',
+  Info = 'Info',
+  Warning = 'Warning',
+  Error = 'Error',
+  None = 'None',
+}
+
+function isClarityUnavailable(): boolean {
+  if (!SupportedPlatforms.includes(Platform.OS)) {
+    let warningMessage = 'Clarity supports ' + SupportedPlatforms.join(', ') + ' only for now.';
+    if (Platform.OS === 'ios') {
+      warningMessage = `${warningMessage} To enable experimental iOS support, set the 'enableIOS_experimental' config value to true.`;
+    }
+
+    if (!SupportWarningWasShown) {
+      console.warn(warningMessage);
+      SupportWarningWasShown = true;
+    }
+
+    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.
-*/
+ */
 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.")
+  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,
+  let {
+    userId = null,
     logLevel = LogLevel.None,
     allowMeteredNetworkUsage = false,
     enableWebViewCapture = true,
-    allowedDomains = ["*"],
+    allowedDomains = ['*'],
     disableOnLowEndDevices = false,
-    maximumDailyNetworkUsageInMB = null } = config ?? {};
+    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;
   }
 
@@ -98,49 +135,31 @@ export function initialize(projectId: string, config?: ClarityConfig) {
 /**
  * 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;
+export function pause(): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
-  }
-  
-  Clarity.pause();
+  return Clarity.pause();
 }
 
 /**
  * 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;
+export function resume(): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
-  }
-  
-  Clarity.resume();
+  return Clarity.resume();
 }
 
 /**
  * Returns true if Clarity has been paused by the user.
  */
-export function isPaused(): Promise<Boolean | undefined>{
-  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);
+export function isPaused(): Promise<Boolean | undefined> {
+  if (isClarityUnavailable()) {
     return Promise.resolve(undefined);
   }
 
@@ -157,18 +176,12 @@ export function isPaused(): Promise<Boolean | undefined>{
  * </p>
  * @param customUserId   The custom user id to set.
  */
-export function setCustomUserId(customUserId: string) {
-  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;
+export function setCustomUserId(customUserId: string): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  Clarity.setCustomUserId(customUserId);
+  return Clarity.setCustomUserId(customUserId);
 }
 
 /**
@@ -178,18 +191,12 @@ export function setCustomUserId(customUserId: string) {
  * </p>
  * @param customSessionId   The custom session id to set.
  */
-export function setCustomSessionId(customSessionId: string) {
-  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;
+export function setCustomSessionId(customSessionId: string): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  Clarity.setCustomSessionId(customSessionId);
+  return Clarity.setCustomSessionId(customSessionId);
 }
 
 /**
@@ -197,18 +204,12 @@ export function setCustomSessionId(customSessionId: string) {
  * @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;
-  }
-
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+export function setCustomTag(key: string, value: string): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  Clarity.setCustomTag(key, value);
+  return Clarity.setCustomTag(key, value);
 }
 
 /**
@@ -218,18 +219,14 @@ export function setCustomTag(key: string, value: string) {
  * 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;
-  }
-
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
+export function setCurrentScreenName(
+  screenName: string | null
+): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  Clarity.setCurrentScreenName(screenName);
+  return Clarity.setCurrentScreenName(screenName);
 }
 
 /**
@@ -238,14 +235,8 @@ export function setCurrentScreenName(screenName: string | null) {
  * @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");
+  if (isClarityUnavailable()) {
+    return Promise.resolve('Undefined');
   }
 
   return Clarity.getCurrentSessionId();
@@ -258,14 +249,8 @@ export function getCurrentSessionId(): Promise<string> {
  * @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");
+  if (isClarityUnavailable()) {
+    return Promise.resolve('Undefined');
   }
 
   return Clarity.getCurrentSessionUrl();

package/ios/Clarity.mm

@@ -1,15 +0,0 @@
-#import "Clarity.h"
-
-@implementation Clarity
-RCT_EXPORT_MODULE()
-
-// Don't compile this code when we build for the old architecture.
-#ifdef RCT_NEW_ARCH_ENABLED
-- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
-    (const facebook::react::ObjCTurboModule::InitParams &)params
-{
-    return std::make_shared<facebook::react::NativeClaritySpecJSI>(params);
-}
-#endif
-
-@end