@react-native-firebase/analytics 20.3.0 → 20.5.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [20.5.0](https://github.com/invertase/react-native-firebase/compare/v20.4.0...v20.5.0) (2024-09-11)
+
+### Features
+
+- **analytics:** initiate on device measurement with sha256-hashed values ([#7963](https://github.com/invertase/react-native-firebase/issues/7963)) ([5ce51e1](https://github.com/invertase/react-native-firebase/commit/5ce51e1b8b225bb509b4a0d444f42fa4c5f3effc))
+
+## [20.4.0](https://github.com/invertase/react-native-firebase/compare/v20.3.0...v20.4.0) (2024-08-13)
+
+### Bug Fixes
+
+- **analytics:** update the typing for Item ([#7919](https://github.com/invertase/react-native-firebase/issues/7919)) ([c2c4576](https://github.com/invertase/react-native-firebase/commit/c2c457608c865f6d25e4b9b6689cbc00721de194))
+
 ## [20.3.0](https://github.com/invertase/react-native-firebase/compare/v20.2.1...v20.3.0) (2024-07-19)
 
 ### Bug Fixes

package/__tests__/analytics.test.ts

@@ -1,6 +1,62 @@
 import { describe, expect, it, xit } from '@jest/globals';
 
-import { firebase } from '../lib';
+import {
+  firebase,
+  getAnalytics,
+  initializeAnalytics,
+  logEvent,
+  setAnalyticsCollectionEnabled,
+  setSessionTimeoutDuration,
+  getAppInstanceId,
+  getSessionId,
+  setUserId,
+  setUserProperty,
+  setUserProperties,
+  resetAnalyticsData,
+  logAddPaymentInfo,
+  logScreenView,
+  logAddShippingInfo,
+  logAddToCart,
+  logAddToWishlist,
+  logAppOpen,
+  logBeginCheckout,
+  logCampaignDetails,
+  logEarnVirtualCurrency,
+  logGenerateLead,
+  logJoinGroup,
+  logLevelEnd,
+  logLevelStart,
+  logLevelUp,
+  logLogin,
+  logPostScore,
+  logSelectContent,
+  logPurchase,
+  logRefund,
+  logRemoveFromCart,
+  logSearch,
+  logSelectItem,
+  logSetCheckoutOption,
+  logSelectPromotion,
+  logShare,
+  logSignUp,
+  logSpendVirtualCurrency,
+  logTutorialBegin,
+  logTutorialComplete,
+  logUnlockAchievement,
+  logViewCart,
+  logViewItem,
+  logViewItemList,
+  logViewPromotion,
+  logViewSearchResults,
+  setDefaultEventParameters,
+  initiateOnDeviceConversionMeasurementWithEmailAddress,
+  initiateOnDeviceConversionMeasurementWithHashedEmailAddress,
+  initiateOnDeviceConversionMeasurementWithPhoneNumber,
+  initiateOnDeviceConversionMeasurementWithHashedPhoneNumber,
+  isSupported,
+  setConsent,
+  settings,
+} from '../lib';
 
 describe('Analytics', function () {
   describe('namespace', function () {
@@ -595,4 +651,271 @@ describe('Analytics', function () {
       );
     });
   });
+
+  describe('initiateOnDeviceConversionMeasurementWithHashedEmailAddress()', function () {
+    it('throws if not a string', function () {
+      expect(() =>
+        // @ts-ignore
+        firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedEmailAddress(true),
+      ).toThrowError(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedEmailAddress(*) 'hashedEmailAddress' expected a string value.",
+      );
+    });
+  });
+
+  describe('initiateOnDeviceConversionMeasurementWithHashedPhoneNumber()', function () {
+    it('throws if not a string', function () {
+      expect(() =>
+        // @ts-ignore
+        firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(1234),
+      ).toThrowError(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a string value.",
+      );
+    });
+
+    it('throws if hashed value is a phone number in E.164 format', function () {
+      expect(() =>
+        firebase
+          .analytics()
+          .initiateOnDeviceConversionMeasurementWithHashedPhoneNumber('+1234567890'),
+      ).toThrowError(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a sha256-hashed value of a phone number in E.164 format.",
+      );
+    });
+  });
+
+  describe('modular', function () {
+    it('`getAnalytics` function is properly exposed to end user', function () {
+      expect(getAnalytics).toBeDefined();
+    });
+
+    it('`initializeAnalytics` function is properly exposed to end user', function () {
+      expect(initializeAnalytics).toBeDefined();
+    });
+
+    it('`logEvent` function is properly exposed to end user', function () {
+      expect(logEvent).toBeDefined();
+    });
+
+    it('`setAnalyticsCollectionEnabled` function is properly exposed to end user', function () {
+      expect(setAnalyticsCollectionEnabled).toBeDefined();
+    });
+
+    it('`setSessionTimeoutDuration` function is properly exposed to end user', function () {
+      expect(setSessionTimeoutDuration).toBeDefined();
+    });
+
+    it('`getAppInstanceId` function is properly exposed to end user', function () {
+      expect(getAppInstanceId).toBeDefined();
+    });
+
+    it('`getSessionId` function is properly exposed to end user', function () {
+      expect(getSessionId).toBeDefined();
+    });
+
+    it('`setUserId` function is properly exposed to end user', function () {
+      expect(setUserId).toBeDefined();
+    });
+
+    it('`setUserProperty` function is properly exposed to end user', function () {
+      expect(setUserProperty).toBeDefined();
+    });
+
+    it('`setUserProperties` function is properly exposed to end user', function () {
+      expect(setUserProperties).toBeDefined();
+    });
+
+    it('`resetAnalyticsData` function is properly exposed to end user', function () {
+      expect(resetAnalyticsData).toBeDefined();
+    });
+
+    it('`logAddPaymentInfo` function is properly exposed to end user', function () {
+      expect(logAddPaymentInfo).toBeDefined();
+    });
+
+    it('`logScreenView` function is properly exposed to end user', function () {
+      expect(logScreenView).toBeDefined();
+    });
+
+    it('`logAddShippingInfo` function is properly exposed to end user', function () {
+      expect(logAddShippingInfo).toBeDefined();
+    });
+
+    it('`logAddToCart` function is properly exposed to end user', function () {
+      expect(logAddToCart).toBeDefined();
+    });
+
+    it('`logAddToWishlist` function is properly exposed to end user', function () {
+      expect(logAddToWishlist).toBeDefined();
+    });
+
+    it('`logAppOpen` function is properly exposed to end user', function () {
+      expect(logAppOpen).toBeDefined();
+    });
+
+    it('`logBeginCheckout` function is properly exposed to end user', function () {
+      expect(logBeginCheckout).toBeDefined();
+    });
+
+    it('`logCampaignDetails` function is properly exposed to end user', function () {
+      expect(logCampaignDetails).toBeDefined();
+    });
+
+    it('`logEarnVirtualCurrency` function is properly exposed to end user', function () {
+      expect(logEarnVirtualCurrency).toBeDefined();
+    });
+
+    it('`logGenerateLead` function is properly exposed to end user', function () {
+      expect(logGenerateLead).toBeDefined();
+    });
+
+    it('`logJoinGroup` function is properly exposed to end user', function () {
+      expect(logJoinGroup).toBeDefined();
+    });
+
+    it('`logLevelEnd` function is properly exposed to end user', function () {
+      expect(logLevelEnd).toBeDefined();
+    });
+
+    it('`logLevelStart` function is properly exposed to end user', function () {
+      expect(logLevelStart).toBeDefined();
+    });
+
+    it('`logLevelUp` function is properly exposed to end user', function () {
+      expect(logLevelUp).toBeDefined();
+    });
+
+    it('`logLogin` function is properly exposed to end user', function () {
+      expect(logLogin).toBeDefined();
+    });
+
+    it('`logPostScore` function is properly exposed to end user', function () {
+      expect(logPostScore).toBeDefined();
+    });
+
+    it('`logSelectContent` function is properly exposed to end user', function () {
+      expect(logSelectContent).toBeDefined();
+    });
+
+    it('`logPurchase` function is properly exposed to end user', function () {
+      expect(logPurchase).toBeDefined();
+    });
+
+    it('`logRefund` function is properly exposed to end user', function () {
+      expect(logRefund).toBeDefined();
+    });
+
+    it('`logRemoveFromCart` function is properly exposed to end user', function () {
+      expect(logRemoveFromCart).toBeDefined();
+    });
+
+    it('`logSearch` function is properly exposed to end user', function () {
+      expect(logSearch).toBeDefined();
+    });
+
+    it('`logSelectItem` function is properly exposed to end user', function () {
+      expect(logSelectItem).toBeDefined();
+    });
+
+    it('`logSetCheckoutOption` function is properly exposed to end user', function () {
+      expect(logSetCheckoutOption).toBeDefined();
+    });
+
+    it('`logSelectPromotion` function is properly exposed to end user', function () {
+      expect(logSelectPromotion).toBeDefined();
+    });
+
+    it('`logShare` function is properly exposed to end user', function () {
+      expect(logShare).toBeDefined();
+    });
+
+    it('`logSignUp` function is properly exposed to end user', function () {
+      expect(logSignUp).toBeDefined();
+    });
+
+    it('`logSpendVirtualCurrency` function is properly exposed to end user', function () {
+      expect(logSpendVirtualCurrency).toBeDefined();
+    });
+
+    it('`logTutorialBegin` function is properly exposed to end user', function () {
+      expect(logTutorialBegin).toBeDefined();
+    });
+
+    it('`logTutorialComplete` function is properly exposed to end user', function () {
+      expect(logTutorialComplete).toBeDefined();
+    });
+
+    it('`logUnlockAchievement` function is properly exposed to end user', function () {
+      expect(logUnlockAchievement).toBeDefined();
+    });
+
+    it('`logViewCart` function is properly exposed to end user', function () {
+      expect(logViewCart).toBeDefined();
+    });
+
+    it('`logViewItem` function is properly exposed to end user', function () {
+      expect(logViewItem).toBeDefined();
+    });
+
+    it('`logViewItemList` function is properly exposed to end user', function () {
+      expect(logViewItemList).toBeDefined();
+    });
+
+    it('`logViewPromotion` function is properly exposed to end user', function () {
+      expect(logViewPromotion).toBeDefined();
+    });
+
+    it('`logViewSearchResults` function is properly exposed to end user', function () {
+      expect(logViewSearchResults).toBeDefined();
+    });
+
+    it('`setDefaultEventParameters` function is properly exposed to end user', function () {
+      expect(setDefaultEventParameters).toBeDefined();
+    });
+
+    it('`initiateOnDeviceConversionMeasurementWithEmailAddress` function is properly exposed to end user', function () {
+      expect(initiateOnDeviceConversionMeasurementWithEmailAddress).toBeDefined();
+    });
+
+    it('`initiateOnDeviceConversionMeasurementWithHashedEmailAddress` function is properly exposed to end user', function () {
+      expect(initiateOnDeviceConversionMeasurementWithHashedEmailAddress).toBeDefined();
+    });
+
+    it('`initiateOnDeviceConversionMeasurementWithHashedEmailAddress` throws if not a string', function () {
+      expect(() =>
+        // @ts-ignore
+        initiateOnDeviceConversionMeasurementWithHashedEmailAddress(getAnalytics(), true),
+      ).toThrowError(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedEmailAddress(*) 'hashedEmailAddress' expected a string value.",
+      );
+    });
+
+    it('`initiateOnDeviceConversionMeasurementWithHashedPhoneNumber` should throw if the value is in E.164 format', function () {
+      expect(() =>
+        initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(getAnalytics(), '+1234567890'),
+      ).toThrowError(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a sha256-hashed value of a phone number in E.164 format.",
+      );
+    });
+
+    it('`initiateOnDeviceConversionMeasurementWithPhoneNumber` function is properly exposed to end user', function () {
+      expect(initiateOnDeviceConversionMeasurementWithPhoneNumber).toBeDefined();
+    });
+
+    it('`initiateOnDeviceConversionMeasurementWithHashedPhoneNumber` function is properly exposed to end user', function () {
+      expect(initiateOnDeviceConversionMeasurementWithHashedPhoneNumber).toBeDefined();
+    });
+
+    it('`isSupported` function is properly exposed to end user', function () {
+      expect(isSupported).toBeDefined();
+    });
+
+    it('`setConsent` function is properly exposed to end user', function () {
+      expect(setConsent).toBeDefined();
+    });
+
+    it('`settings` function is properly exposed to end user', function () {
+      expect(settings).toBeDefined();
+    });
+  });
 });

package/ios/RNFBAnalytics/RNFBAnalyticsModule.m

@@ -164,6 +164,20 @@ RCT_EXPORT_METHOD(initiateOnDeviceConversionMeasurementWithEmailAddress
   return resolve([NSNull null]);
 }
 
+RCT_EXPORT_METHOD(initiateOnDeviceConversionMeasurementWithHashedEmailAddress
+                  : (NSString *)hashedEmailAddress resolver
+                  : (RCTPromiseResolveBlock)resolve rejecter
+                  : (RCTPromiseRejectBlock)reject) {
+  @try {
+    NSData *emailAddress = [hashedEmailAddress dataUsingEncoding:NSUTF8StringEncoding];
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithHashedEmailAddress:emailAddress];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
 RCT_EXPORT_METHOD(initiateOnDeviceConversionMeasurementWithPhoneNumber
                   : (NSString *)phoneNumber resolver
                   : (RCTPromiseResolveBlock)resolve rejecter
@@ -177,6 +191,20 @@ RCT_EXPORT_METHOD(initiateOnDeviceConversionMeasurementWithPhoneNumber
   return resolve([NSNull null]);
 }
 
+RCT_EXPORT_METHOD(initiateOnDeviceConversionMeasurementWithHashedPhoneNumber
+                  : (NSString *)hashedPhoneNumber resolver
+                  : (RCTPromiseResolveBlock)resolve rejecter
+                  : (RCTPromiseRejectBlock)reject) {
+  @try {
+    NSData *phoneNumber = [hashedPhoneNumber dataUsingEncoding:NSUTF8StringEncoding];
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithHashedPhoneNumber:phoneNumber];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
 RCT_EXPORT_METHOD(setConsent
                   : (NSDictionary *)consentSettings resolver
                   : (RCTPromiseResolveBlock)resolve rejecter

package/lib/index.d.ts

@@ -94,7 +94,7 @@ export namespace FirebaseAnalyticsTypes {
     /**
      * The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID.
      */
-    item_location_id?: string;
+    location_id?: string;
     /**
      * The Item variant.
      */
@@ -109,6 +109,38 @@ export namespace FirebaseAnalyticsTypes {
      * See https://github.com/invertase/react-native-firebase/issues/4578#issuecomment-771703420 for more information
      */
     price?: number;
+    /**
+     * The affiliation of the item.
+     */
+    affiliation?: string;
+    /**
+     * The coupon associated with the item.
+     */
+    coupon?: string;
+    /**
+     * The creative name associated with the item.
+     */
+    creative_name?: string;
+    /**
+     * The creative slot associated with the item.
+     */
+    creative_slot?: string;
+    /**
+     * The discount applied to the item.
+     */
+    discount?: Currency;
+    /**
+     * The index of the item.
+     */
+    index?: number;
+    /**
+     * The promotion ID associated with the item.
+     */
+    promotion_id?: string;
+    /**
+     * The promotion name associated with the item.
+     */
+    promotion_name?: string;
   }
 
   export interface AddPaymentInfoEventParameters {
@@ -1723,23 +1755,51 @@ export namespace FirebaseAnalyticsTypes {
     setDefaultEventParameters(params?: { [key: string]: any }): Promise<void>;
 
     /**
-     * start privacy-sensitive on-device conversion management.
+     * Start privacy-sensitive on-device conversion management.
      * This is iOS-only.
-     * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
+     * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
      *
+     * @platform ios
      * @param emailAddress email address, properly formatted complete with domain name e.g, 'user@example.com'
      */
     initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress: string): Promise<void>;
 
     /**
-     * start privacy-sensitive on-device conversion management.
+     * Start privacy-sensitive on-device conversion management.
      * This is iOS-only.
-     * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
+     * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
+     * You need to pass the sha256-hashed of normalized email address to this function. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information.
      *
+     * @platform ios
+     * @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com'
+     */
+    initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
+      hashedEmailAddress: string,
+    ): Poromise<void>;
+
+    /**
+     * Start privacy-sensitive on-device conversion management.
+     * This is iOS-only.
+     * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
+     *
+     * @platform ios
      * @param phoneNumber phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
      */
     initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber: string): Promise<void>;
 
+    /**
+     * Start privacy-sensitive on-device conversion management.
+     * This is iOS-only.
+     * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile.
+     * You need to pass the sha256-hashed of phone number in E.164 format. See [this link](https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials) for more information.
+     *
+     * @platform ios
+     * @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
+     */
+    initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
+      hashedPhoneNumber: string,
+    ): Promise<void>;
+
     /**
      * For Consent Mode!
      *

package/lib/index.js

@@ -40,58 +40,6 @@ import fallBackModule from './web/RNFBAnalyticsModule';
 import version from './version';
 import * as structs from './structs';
 
-export {
-  getAnalytics,
-  logEvent,
-  setAnalyticsCollectionEnabled,
-  setSessionTimeoutDuration,
-  getAppInstanceId,
-  getSessionId,
-  setUserId,
-  setUserProperty,
-  setUserProperties,
-  resetAnalyticsData,
-  logAddPaymentInfo,
-  logScreenView,
-  logAddShippingInfo,
-  logAddToCart,
-  logAddToWishlist,
-  logAppOpen,
-  logBeginCheckout,
-  logCampaignDetails,
-  logEarnVirtualCurrency,
-  logGenerateLead,
-  logJoinGroup,
-  logLevelEnd,
-  logLevelStart,
-  logLevelUp,
-  logLogin,
-  logPostScore,
-  logSelectContent,
-  logPurchase,
-  logRefund,
-  logRemoveFromCart,
-  logSearch,
-  logSelectItem,
-  logSetCheckoutOption,
-  logSelectPromotion,
-  logShare,
-  logSignUp,
-  logSpendVirtualCurrency,
-  logTutorialBegin,
-  logTutorialComplete,
-  logUnlockAchievement,
-  logViewCart,
-  logViewItem,
-  logViewItemList,
-  logViewPromotion,
-  logViewSearchResults,
-  setDefaultEventParameters,
-  initiateOnDeviceConversionMeasurementWithEmailAddress,
-  initiateOnDeviceConversionMeasurementWithPhoneNumber,
-  setConsent,
-} from './modular/index';
-
 const ReservedEventNames = [
   'ad_activeview',
   'ad_click',
@@ -795,6 +743,22 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress);
   }
 
+  initiateOnDeviceConversionMeasurementWithHashedEmailAddress(hashedEmailAddress) {
+    if (!isString(hashedEmailAddress)) {
+      throw new Error(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedEmailAddress(*) 'hashedEmailAddress' expected a string value.",
+      );
+    }
+
+    if (!isIOS) {
+      return;
+    }
+
+    return this.native.initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
+      hashedEmailAddress,
+    );
+  }
+
   initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber) {
     if (!isE164PhoneNumber(phoneNumber)) {
       throw new Error(
@@ -808,6 +772,28 @@ class FirebaseAnalyticsModule extends FirebaseModule {
 
     return this.native.initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber);
   }
+
+  initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(hashedPhoneNumber) {
+    if (isE164PhoneNumber(hashedPhoneNumber)) {
+      throw new Error(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a sha256-hashed value of a phone number in E.164 format.",
+      );
+    }
+
+    if (!isString(hashedPhoneNumber)) {
+      throw new Error(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a string value.",
+      );
+    }
+
+    if (!isIOS) {
+      return;
+    }
+
+    return this.native.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
+      hashedPhoneNumber,
+    );
+  }
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/analytics';
@@ -826,6 +812,8 @@ export default createModuleNamespace({
   ModuleClass: FirebaseAnalyticsModule,
 });
 
+export * from './modular/index';
+
 // import analytics, { firebase } from '@react-native-firebase/analytics';
 // analytics().logEvent(...);
 // firebase.analytics().logEvent(...);