react-native-clarity 2.2.1 → 3.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,16 @@ 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'];
 
 /**
  * The configuration that will be used to customize the Clarity behaviour.
@@ -23,8 +26,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 +40,69 @@ 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)) {
+    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.
-*/
+ */
 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;
   }
 
@@ -95,6 +123,40 @@ export function initialize(projectId: string, config?: ClarityConfig) {
   );
 }
 
+/**
+ * Pauses the Clarity capturing processes until the next resume() is called.
+ */
+export function pause(): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
+  }
+
+  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(): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
+  }
+
+  return Clarity.resume();
+}
+
+/**
+ * Returns true if Clarity has been paused by the user.
+ */
+export function isPaused(): Promise<Boolean | undefined> {
+  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
@@ -105,18 +167,12 @@ export function initialize(projectId: string, config?: ClarityConfig) {
  * </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);
 }
 
 /**
@@ -126,18 +182,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);
 }
 
 /**
@@ -145,18 +195,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;
+export function setCustomTag(key: string, value: string): Promise<boolean | undefined> {
+  if (isClarityUnavailable()) {
+    return Promise.resolve(undefined);
   }
 
-  if (Clarity === null) {
-    console.error("Clarity did not initialize properly.", LINKING_ERROR);
-    return;
-  }
-
-  Clarity.setCustomTag(key, value);
+  return Clarity.setCustomTag(key, value);
 }
 
 /**
@@ -166,18 +210,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);
 }
 
 /**
@@ -186,14 +226,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();
@@ -206,14 +240,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

package/ios/Clarity.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-</Workspace>