react-native-clarity 2.3.0 → 3.0.1

package/LICENSE

@@ -1,20 +1,20 @@
-MIT License
-
-Copyright (c) 2022 Microsoft - Clarity
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Microsoft - Clarity
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -8,12 +8,15 @@ 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.
+### Notes
+
+- The Clarity package depends on native code to run, therefore you have to ship a new build after integrating the package.
+- **For `react-native-svg` Users**: Clarity is currently incompatible with `react-native-svg` version 13.x due to a known bug that causes user interaction and playback issues. To ensure proper functionality, please upgrade to `react-native-svg` version 14 or later.
 
 ## Usage
 
 ```js
-import { LogLevel, initialize, setCustomUserId,  setCustomSessionId, setCustomTag, setCurrentScreenName, getCurrentSessionId } from 'react-native-clarity';
+import { LogLevel, initialize, setCustomUserId,  setCustomSessionId, setCustomTag, setCurrentScreenName, getCurrentSessionId, getCurrentSessionUrl } from 'react-native-clarity';
 
 // Initialize Clarity.
 const clarityConfig = {
@@ -101,10 +104,12 @@ function initialize(projectId: string, config?: ClarityConfig)
  * @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.
  */
-
 interface ClarityConfig {
   userId?: string | null;
   logLevel?: LogLevel;
@@ -113,6 +118,7 @@ interface ClarityConfig {
   allowedDomains?: string[];
   disableOnLowEndDevices?: Boolean;
   maximumDailyNetworkUsageInMB?: number;
+  enableIOS_experimental?: boolean;
 }
 ```
 

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:2.3.0"
+  implementation "com.microsoft.clarity:clarity:2.4.0"
 }
 
 if (isNewArchitectureEnabled()) {

package/android/src/main/AndroidManifest.xml

@@ -1,4 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.microsoft.clarity.reactnative">
-
-</manifest>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.microsoft.clarity.reactnative">
+
+</manifest>

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

@@ -1,17 +1,17 @@
-package com.microsoft.clarity.reactnative
-
-import com.facebook.react.ReactPackage
-import com.facebook.react.bridge.JavaScriptModule
-import com.facebook.react.bridge.NativeModule
-import com.facebook.react.bridge.ReactApplicationContext
-import com.facebook.react.uimanager.ViewManager
-
-class ClarityPackage : ReactPackage {
-  override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
-    return listOf(ClarityModule(reactContext))
-  }
-
-  override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
-    return emptyList()
-  }
-}
+package com.microsoft.clarity.reactnative
+
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.JavaScriptModule
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
+
+class ClarityPackage : ReactPackage {
+  override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
+    return listOf(ClarityModule(reactContext))
+  }
+
+  override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
+    return emptyList()
+  }
+}

package/ios/Clarity.h

@@ -1,12 +1,12 @@
-
-#ifdef RCT_NEW_ARCH_ENABLED
-#import "RNClaritySpec.h"
-
-@interface Clarity : NSObject <NativeClaritySpec>
-#else
-#import <React/RCTBridgeModule.h>
-
-@interface Clarity : NSObject <RCTBridgeModule>
-#endif
-
-@end
+
+#ifdef RCT_NEW_ARCH_ENABLED
+#import "RNClaritySpec.h"
+
+@interface Clarity : NSObject <NativeClaritySpec>
+#else
+#import <React/RCTBridgeModule.h>
+
+@interface Clarity : NSObject <RCTBridgeModule>
+#endif
+
+@end

package/ios/Clarity.m

@@ -0,0 +1,131 @@
+#import "Clarity.h"
+#import <React/RCTLog.h>
+
+@import Clarity;
+
+@implementation Clarity
+RCT_EXPORT_MODULE()
+
+RCT_EXPORT_METHOD(initialize:(NSString *)projectId
+                  userId:(NSString *)userId
+                  logLevel:(NSString *)logLevel
+                  allowMeteredNetworkUsage:(BOOL)allowMeteredNetworkUsage
+                  enableWebViewCapture:(BOOL)enableWebViewCapture
+                  allowedDomains:(NSArray *)allowedDomains
+                  disableOnLowEndDevices:(BOOL)disableOnLowEndDevices
+                  enableDailyNetworkUsageLimit:(BOOL)enableDailyNetworkUsageLimit
+                  maximumDailyNetworkUsageInMB:(double)maximumDailyNetworkUsageInMB
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    dispatch_async(dispatch_get_main_queue(), ^{
+        ClarityConfig* config = [[ClarityConfig alloc]
+                                 initWithProjectId:projectId
+                                 userId:userId
+                                 logLevel:[self convertLogLevelToEnum:logLevel]
+                                 allowMeteredNetworkUsage:allowMeteredNetworkUsage
+                                 enableWebViewCapture:enableWebViewCapture
+                                 disableOnLowEndDevices:disableOnLowEndDevices
+                                 applicationFramework:ApplicationFrameworkReactNative];
+
+        [ClaritySDK initializeWithConfig:config];
+    });
+
+    resolve(@(true));
+}
+
+RCT_EXPORT_METHOD(pause:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    [ClaritySDK pause];
+    resolve(@([ClaritySDK isPaused]));
+}
+
+RCT_EXPORT_METHOD(resume:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    [ClaritySDK resume];
+    resolve(@((BOOL)(![ClaritySDK isPaused])));
+}
+
+RCT_EXPORT_METHOD(isPaused:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve(@([ClaritySDK isPaused]));
+}
+
+RCT_EXPORT_METHOD(setCustomUserId:(NSString *)customUserId
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve(@([ClaritySDK setCustomUserId:customUserId]));
+}
+
+RCT_EXPORT_METHOD(setCustomSessionId:(NSString *)customSessionId
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve(@([ClaritySDK setCustomSessionId:customSessionId]));
+}
+
+RCT_EXPORT_METHOD(getCurrentSessionId:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([ClaritySDK getCurrentSessionId]);
+}
+
+RCT_EXPORT_METHOD(setCustomTag:(NSString *)key value:(NSString *)value
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve(@([ClaritySDK setCustomTagWithKey:key value:value]));
+}
+
+RCT_EXPORT_METHOD(setCurrentScreenName:(NSString *)currentScreenName
+                  resolver:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve(@([ClaritySDK setCurrentScreenNameWithName:currentScreenName]));
+}
+
+RCT_EXPORT_METHOD(getCurrentSessionUrl:(RCTPromiseResolveBlock)resolve
+                  rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([ClaritySDK getCurrentSessionUrl]);
+}
+
+- (LogLevel)convertLogLevelToEnum:(NSString*)logLevel
+{
+    if ([logLevel isEqual:@"Verbose"]) {
+        return LogLevelVerbose;
+    }
+
+    if ([logLevel isEqual:@"Debug"]) {
+        return LogLevelDebug;
+    }
+
+    if ([logLevel isEqual:@"Info"]) {
+        return LogLevelInfo;
+    }
+
+    if ([logLevel isEqual:@"Warning"]) {
+        return LogLevelWarning;
+    }
+
+    if ([logLevel isEqual:@"Error"]) {
+        return LogLevelError;
+    }
+
+    return LogLevelNone;
+}
+
+// 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