Merge pull request #3 from logicwind/dev

added the setIsOptedOut and setLogger method

Author: bhavesh-lw

README.md

@@ -55,6 +55,10 @@ else{
 setVisitorId("2c534f55fba6cf6e")
 }
 
+ setIsOptedOut(true)
+
+ setLogger()
+
 trackDispatch()
 
 ```
@@ -67,6 +71,7 @@ trackDispatch()
 | Name  | Description  |
 |-----------------|-----------------|
 | createTracker | The createTracker function is used to instantiate a tracker object for Matomo analytics within a React Native application. This tracker instance allows developers to track various user interactions and events within their mobile app. |
+| startSession | The startSession method is used to start a new session explicitly within a React Native application.| 
 | trackScreen | The trackScreen method is used to track screen views within a React Native application. Screen tracking allows developers to monitor user navigation and engagement by recording when users view specific screens or pages within the app.| 
 | trackEvent | The trackEvent method is used to track custom events within a React Native application. Event tracking allows developers to monitor and analyze user interactions, such as button clicks, form submissions, or any other custom actions performed by users within the app. | 
 | trackOutlink | The trackOutlink method is used to track clicks on outbound links within a React Native application. Outbound link tracking allows developers to monitor when users click on links that navigate them away from the app to external websites or resources. | 
@@ -77,6 +82,9 @@ trackDispatch()
 | setUserId | The setUserId function is used to assign a unique identifier to a user in a React Native application. This identifier can be used to track user-specific actions, behavior, and engagement within the app. | 
 | setVisitorId | The setVisitorId function allows you to manually set a custom visitor ID for tracking purposes within a React Native application.  | 
 | trackDispatch | The trackDispatch methods for tracking events, interactions, and other analytics-related functionalities within a React Native application. However, there isn't a standard trackDispatch method in Matomo tracking libraries, including the one provided by this package | 
+| setIsOptedOut | setIsOptedOut method for disabling Matomo tracking in a React Native application. | 
+| setLogger | setLogger method use for set up logging for Matomo SDK | 
+
 
 <!-- ## Contributing
 

android/src/main/java/com/logicwind/reactnativematomotracker/ReactNativeMatomoTrackerModule.kt

@@ -30,7 +30,7 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
   fun setTracker(uri:String,siteId: Int) {
     if (tracker == null) {
       try {
-        Timber.plant(Timber.DebugTree())
+
         tracker = TrackerBuilder.createDefault(uri, siteId)
           .build(mMatomoTracker)
           Log.e(TAG, "initialized successfully! ${tracker}")
@@ -43,84 +43,128 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
   }
 
 
+
+
   // Example method
   // See https://reactnative.dev/docs/native-modules-android
+
+  @ReactMethod
+  fun startSession() {
+    tracker?.startNewSession()
+  }
+
   @ReactMethod
   fun createTracker(uri:String,siteId:Int) {
     setTracker(uri,siteId)
   }
 
   @ReactMethod
   fun trackScreen(screenName:String,title:String) {
-    TrackHelper.track().screen(screenName).title(title).with(tracker)
-
+    if (tracker != null) {
+      TrackHelper.track().screen(screenName).title(title).with(tracker)
+    }
   }
 
   @ReactMethod
   fun trackEvent(category:String,action:String,name:String,value:Float) {
-    TrackHelper.track().event(category, action).name(name).value(value).with(tracker)
-
+    if (tracker != null) {
+      TrackHelper.track().event(category, action).name(name).value(value).with(tracker)
+    }
   }
   @ReactMethod
   fun trackDispatch() {
-    tracker?.dispatch()
+    if (tracker != null) {
+      tracker?.dispatch()
+    }
   }
 
 
   @ReactMethod
   fun trackOutlink(url:String) {
     val validUrl = URL(url)
-    TrackHelper.track()
-      .outlink(validUrl)
-      .with(tracker)
+    if (tracker != null) {
+      TrackHelper.track()
+        .outlink(validUrl)
+        .with(tracker);
+    }
   }
 
   @ReactMethod
   fun trackSearch(keyword:String) {
+    if (tracker != null) {
     TrackHelper.track()
       .search(keyword)
-      .with(tracker)
+      .with(tracker);
+    }
   }
 
   @ReactMethod
   fun trackImpression(contentName:String) {
-    TrackHelper.track()
-      .impression(contentName)
-      .with(tracker)
+    if (tracker != null) {
+      TrackHelper.track()
+        .impression(contentName)
+        .with(tracker);
+    }
   }
 
 
   @ReactMethod
   fun trackInteraction(contentName:String,contentInteraction:String) {
-    TrackHelper.track()
-      .interaction(contentName, contentInteraction)
-      .with(tracker)
+    if (tracker != null) {
+      TrackHelper.track()
+        .interaction(contentName, contentInteraction)
+        .with(tracker)
+    }
   }
 
   @ReactMethod
   fun trackDownload(category: String,action: String,url: String) {
-    TrackHelper.track().event(category, action).name(url).with(tracker)
+    if (tracker != null) {
+      TrackHelper.track().event(category, action).name(url).with(tracker);
 //    TrackHelper.track().download().with(tracker);
+    }
   }
 
   @ReactMethod
   fun setUserId(id:String) {
-    tracker?.setUserId(id);
+    if (tracker != null) {
+      tracker?.setUserId(id);
+    }
   }
 
   @ReactMethod
   fun trackScreens() {
-    TrackHelper.track().screens(Application()).with(tracker);
+    if (tracker != null) {
+      TrackHelper.track().screens(Application()).with(tracker);
+    }
   }
 
   @ReactMethod
   fun trackGoal(goalId:Int,revenue:Float) {
-    TrackHelper.track().goal(goalId).revenue(revenue).with(tracker);
+    if (tracker != null) {
+      TrackHelper.track().goal(goalId).revenue(revenue).with(tracker);
+    }
   }
 
   @ReactMethod
   fun setVisitorId(visitorId:String) {
-    tracker?.setVisitorId(visitorId)
+    if (tracker != null) {
+      tracker?.setVisitorId(visitorId);
+    }
+  }
+
+  @ReactMethod
+  fun setLogger() {
+    Timber.plant(Timber.DebugTree())
+  }
+
+
+  @ReactMethod
+  fun setIsOptedOut(isOptedOut:Boolean) {
+    Log.e(TAG, "An error occurred: ${isOptedOut}")
+    if (tracker != null) {
+      tracker?.setOptOut(isOptedOut);
+    }
   }
 
 

example/ios/Podfile.lock

@@ -7,7 +7,7 @@ PODS:
   - hermes-engine (0.74.1):
     - hermes-engine/Pre-built (= 0.74.1)
   - hermes-engine/Pre-built (0.74.1)
-  - logicwind-react-native-matomo-tracker (0.1.0):
+  - logicwind-react-native-matomo-tracker (0.2.1):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -1376,7 +1376,7 @@ SPEC CHECKSUMS:
   fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120
   glog: c5d68082e772fa1c511173d6b30a9de2c05a69a2
   hermes-engine: 16b8530de1b383cdada1476cf52d1b52f0692cbc
-  logicwind-react-native-matomo-tracker: 5bd2647580668c8da39ae3f2b396d098c022de10
+  logicwind-react-native-matomo-tracker: cb7577a2f7dca6f646620a44c45f2aca91c3e65b
   MatomoTracker: 1f3772a41c27393067d0126071afe6ae1c7f739e
   RCT-Folly: 02617c592a293bd6d418e0a88ff4ee1f88329b47
   RCTDeprecation: efb313d8126259e9294dc4ee0002f44a6f676aba

example/ios/ReactNativeMatomoTrackerExample.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

example/src/App.tsx

@@ -12,8 +12,11 @@ import {
 
 import {
   createTracker,
+  setIsOptedOut,
+  setLogger,
   setUserId,
   setVisitorId,
+  startSession,
   trackDispatch,
   trackDownload,
   trackEvent,
@@ -22,24 +25,36 @@ import {
   trackOutlink,
   trackScreen,
   trackSearch,
+
 } from '@logicwind/react-native-matomo-tracker';
 
 export default function App() {
   const [result] = React.useState<number | undefined>();
 
+  const [optedOut,setOptedOut]=React.useState(false)
+
   React.useEffect(() => {
-    createTracker('your-matomo-url', 1); //Replace 1 with your matomo site id
+    createTracker("https://matomo.cappital.co/matomo.php",43) //Replace 1 with your matomo site id
   }, []);
 
   return (
     <SafeAreaView style={styles.main}>
       <ScrollView showsHorizontalScrollIndicator={false}>
         <View style={styles.container}>
           <Text>Matomo Tracking {result}</Text>
+           <Pressable
+                     style={styles.button}
+                      onPress={() => {
+                       startSession()
+                      }}
+                    >
+                      <Text style={styles.buttonText}>Start Session</Text>
+             </Pressable>
           <Pressable
             style={styles.button}
             onPress={() => {
               trackScreen('HomeScreen', 'This is test home screen');
+            
             }}
           >
             <Text style={styles.buttonText}>Track Screen</Text>
@@ -133,6 +148,25 @@ export default function App() {
             <Text style={styles.buttonText}>Set Visistor Id</Text>
           </Pressable>
 
+          <Pressable
+            style={styles.button}
+            onPress={() => {
+            setIsOptedOut(!optedOut)
+            setOptedOut(!optedOut)
+            }}
+          >
+            <Text style={styles.buttonText}>Set Is OptedOut {optedOut?"NO":"OFF"}</Text>
+          </Pressable>
+
+          <Pressable
+            style={styles.button}
+            onPress={() => {
+             setLogger()
+            }}
+          >
+            <Text style={styles.buttonText}>Set Logger</Text>
+          </Pressable>
+
           <Pressable
             style={styles.button}
             onPress={() => {

ios/ReactNativeMatomoTracker.mm

@@ -9,7 +9,7 @@ @interface RCT_EXTERN_MODULE(ReactNativeMatomoTracker, NSObject)
 
 RCT_EXTERN_METHOD(trackDispatch)
 
-RCT_EXTERN_METHOD(trackEvent:(NSString *)category withAction:(NSString *)action withName:(NSString *)name withValue:(NSString *)value)
+RCT_EXTERN_METHOD(trackEvent:(NSString *)category withAction:(NSString *)action withName:(NSString *)name withValue:(NSNumber *)value)
 
 RCT_EXTERN_METHOD(trackOutlink:(NSString *)url)
 
@@ -29,6 +29,13 @@ @interface RCT_EXTERN_MODULE(ReactNativeMatomoTracker, NSObject)
 
 RCT_EXTERN_METHOD(setVisitorId:(NSString *)id)
 
+RCT_EXTERN_METHOD(setIsOptedOut:(BOOL)isOptedOut)
+
+RCT_EXTERN_METHOD(setLogger)
+
+RCT_EXTERN_METHOD(startSession)
+
+
 + (BOOL)requiresMainQueueSetup
 {
   return NO;

ios/ReactNativeMatomoTracker.swift

@@ -21,7 +21,13 @@ class ReactNativeMatomoTracker: NSObject {
         matomoTracker = MatomoTracker(siteId: siteId, queue: queue, dispatcher: dispatcher)
 
     }
+   
 
+    @objc(startSession)
+    func startSession() {
+        matomoTracker?.startNewSession()
+     }
+
 
    @objc(trackScreen:withTitle:)
    func trackScreen(screenName: String, title: String) {
@@ -85,4 +91,17 @@ class ReactNativeMatomoTracker: NSObject {
     func setVisitorId(id:String) {
         matomoTracker?.forcedVisitorId=id
     }
+    
+    @objc(setIsOptedOut:)
+    func setIsOptedOut(isOptedOut:Bool) {
+        matomoTracker?.isOptedOut = isOptedOut;
+    }
+    
+    @objc(setLogger)
+    func setLogger() {
+        matomoTracker?.logger = DefaultLogger(minLevel: .verbose)
+
+    }
+    
+    
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logicwind/react-native-matomo-tracker",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "React-native plugin for matomo analytics",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

src/index.tsx

@@ -60,3 +60,19 @@ export function setUserId(id:String): Promise<number> {
 export function setVisitorId(visitorId:String): Promise<number> {
   return ReactNativeMatomoTracker.setVisitorId(visitorId);
 }
+
+export function setIsOptedOut(isOptedOut:boolean): Promise<number> {
+  return ReactNativeMatomoTracker.setIsOptedOut(isOptedOut);
+}
+
+export function setLogger(): Promise<number> {
+  return ReactNativeMatomoTracker.setLogger();
+}
+
+export function startSession(): Promise<number> {
+  return ReactNativeMatomoTracker.startSession();
+}
+
+
+
+