@react-native-firebase/analytics 18.1.0 → 18.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [18.3.0](https://github.com/invertase/react-native-firebase/compare/v18.2.0...v18.3.0) (2023-07-19)
+
+**Note:** Version bump only for package @react-native-firebase/analytics
+
+## [18.2.0](https://github.com/invertase/react-native-firebase/compare/v18.1.0...v18.2.0) (2023-07-13)
+
+### Features
+
+- **analytics, ios:** implement setSessionTimeoutDuration for ios ([b3ce13f](https://github.com/invertase/react-native-firebase/commit/b3ce13ff5f7922e4a253aa58377e5c3c436e74f0))
+- **analytics:** implement getSessionId ([566470c](https://github.com/invertase/react-native-firebase/commit/566470cfc0e919a46c0a119835187257bf046df7))
+
 ## [18.1.0](https://github.com/invertase/react-native-firebase/compare/v18.0.0...v18.1.0) (2023-06-22)
 
 **Note:** Version bump only for package @react-native-firebase/analytics

package/android/src/main/java/io/invertase/firebase/analytics/UniversalFirebaseAnalyticsModule.java

@@ -60,6 +60,10 @@ public class UniversalFirebaseAnalyticsModule extends UniversalFirebaseModule {
     return FirebaseAnalytics.getInstance(getContext()).getAppInstanceId();
   }
 
+  Task<Long> getSessionId() {
+    return FirebaseAnalytics.getInstance(getContext()).getSessionId();
+  }
+
   Task<Void> setUserId(String id) {
     return Tasks.call(
         () -> {

package/android/src/reactnative/java/io/invertase/firebase/analytics/ReactNativeFirebaseAnalyticsModule.java

@@ -93,6 +93,21 @@ public class ReactNativeFirebaseAnalyticsModule extends ReactNativeFirebaseModul
             });
   }
 
+  @ReactMethod
+  public void getSessionId(Promise promise) {
+    module
+        .getSessionId()
+        .addOnCompleteListener(
+            task -> {
+              if (task.isSuccessful()) {
+                Long result = task.getResult();
+                promise.resolve(result != null ? result.doubleValue() : null);
+              } else {
+                rejectPromiseWithExceptionMap(promise, task.getException());
+              }
+            });
+  }
+
   @ReactMethod
   public void setUserId(String id, Promise promise) {
     module

package/ios/RNFBAnalytics/RNFBAnalyticsModule.m

@@ -115,7 +115,7 @@ RCT_EXPORT_METHOD(setSessionTimeoutDuration
                   : (double)milliseconds resolver
                   : (RCTPromiseResolveBlock)resolve rejecter
                   : (RCTPromiseRejectBlock)reject) {
-  // Do nothing - this only exists in android
+  [FIRAnalytics setSessionTimeoutInterval:milliseconds / 1000];
   return resolve([NSNull null]);
 }
 
@@ -125,6 +125,19 @@ RCT_EXPORT_METHOD(getAppInstanceId
   return resolve([FIRAnalytics appInstanceID]);
 }
 
+RCT_EXPORT_METHOD(getSessionId
+                  : (RCTPromiseResolveBlock)resolve rejecter
+                  : (RCTPromiseRejectBlock)reject) {
+  [FIRAnalytics sessionIDWithCompletion:^(int64_t sessionID, NSError *_Nullable error) {
+    if (error) {
+      DLog(@"Error getting session ID: %@", error);
+      return resolve([NSNull null]);
+    } else {
+      return resolve([NSNumber numberWithLongLong:sessionID]);
+    }
+  }];
+}
+
 RCT_EXPORT_METHOD(setDefaultEventParameters
                   : (NSDictionary *)params resolver
                   : (RCTPromiseResolveBlock)resolve rejecter

package/lib/index.d.ts

@@ -869,6 +869,20 @@ export namespace FirebaseAnalyticsTypes {
      */
     getAppInstanceId(): Promise<string | null>;
 
+    /**
+     * Retrieves the session id from the client.
+     * On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
+     *
+     * #### Example
+     *
+     * ```js
+     * const sessionId = await firebase.analytics().getSessionId();
+     * ```
+     *
+     * @returns Returns the session id or null if session is expired, null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
+     */
+    getSessionId(): Promise<number | null>;
+
     /**
      * Gives a user a unique identification.
      *

package/lib/index.js

@@ -43,6 +43,7 @@ export {
   setAnalyticsCollectionEnabled,
   setSessionTimeoutDuration,
   getAppInstanceId,
+  getSessionId,
   setUserId,
   setUserProperty,
   setUserProperties,
@@ -196,6 +197,10 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.getAppInstanceId();
   }
 
+  getSessionId() {
+    return this.native.getSessionId();
+  }
+
   setUserId(id) {
     if (!isNull(id) && !isString(id)) {
       throw new Error("firebase.analytics().setUserId(*) 'id' expected a string value.");

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '18.1.0';
+module.exports = '18.3.0';

package/modular/index.js

@@ -70,6 +70,16 @@ export function setSessionTimeoutDuration(analytics, milliseconds = 1800000) {
 export function getAppInstanceId(analytics) {
   return analytics.getAppInstanceId();
 }
+/**
+ * Retrieves the session id from the client.
+ * On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
+ *
+ * @param analytics Analytics instance.
+ * @returns Returns the session id or null if session is expired, null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
+ */
+export function getSessionId(analytics) {
+  return analytics.getSessionId();
+}
 /**
  * Gives a user a unique identification.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "18.1.0",
+  "version": "18.3.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - The analytics module provides out of the box support with Google Analytics for Firebase. Integration with the Android & iOS allows for in-depth analytical insight reporting, such as device information, location, user actions and more.",
   "main": "lib/index.js",
@@ -22,10 +22,10 @@
     "analytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "18.1.0"
+    "@react-native-firebase/app": "18.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1c2dd42a9a2207a25e326be866ccc15f4d7b9c21"
+  "gitHead": "cca7053a12ea04c8476f880bd2220f44ee4ae17a"
 }