@react-native-firebase/analytics 14.11.0 → 15.1.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [15.1.0](https://github.com/invertase/react-native-firebase/compare/v15.0.0...v15.1.0) (2022-06-28)
+
+### Features
+
+- **analytics, ios:** implement on-device conversion ([a1df996](https://github.com/invertase/react-native-firebase/commit/a1df996b36f2b5eb68c6443c49c5185437573fba)), closes [/firebase.google.com/support/release-notes/ios#analytics_1](https://github.com//firebase.google.com/support/release-notes/ios/issues/analytics_1) [#6321](https://github.com/invertase/react-native-firebase/issues/6321)
+
+# [15.0.0](https://github.com/invertase/react-native-firebase/compare/v14.11.1...v15.0.0) (2022-06-20)
+
+**Note:** Version bump only for package @react-native-firebase/analytics
+
+## [14.11.1](https://github.com/invertase/react-native-firebase/compare/v14.11.0...v14.11.1) (2022-06-17)
+
+### Bug Fixes
+
+- **analytics:** allow manual tracking of ad_impression ([931468a](https://github.com/invertase/react-native-firebase/commit/931468ac2380b8a3449456f941caaa7ca8902d5a)), closes [#6307](https://github.com/invertase/react-native-firebase/issues/6307) [#6312](https://github.com/invertase/react-native-firebase/issues/6312)
+
 # [14.11.0](https://github.com/invertase/react-native-firebase/compare/v14.10.1...v14.11.0) (2022-05-27)
 
 **Note:** Version bump only for package @react-native-firebase/analytics

package/RNFBAnalytics.podspec

@@ -49,6 +49,18 @@ Pod::Spec.new do |s|
     s.dependency          'Firebase/Analytics', firebase_sdk_version
   end
 
+  # Special pod for on-device conversion
+  if defined?($RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion) && ($RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion == true)
+    Pod::UI.puts "#{s.name}: GoogleAppMeasurementOnDeviceConversion pod added"
+
+    # Releasing as non-breaking change as it is optional but it raises minimum requirements, validate just in case
+    if (Gem::Version.new(firebase_sdk_version) < Gem::Version.new("9.0.0"))
+      raise "GoogleAppMeasurementOnDeviceConversion requires firebase-ios-sdk 9.0.0 or greater."
+    end
+
+    s.dependency          'GoogleAppMeasurementOnDeviceConversion', firebase_sdk_version
+  end
+
   if defined?($RNFirebaseAsStaticFramework)
     Pod::UI.puts "#{s.name}: Using overridden static_framework value of '#{$RNFirebaseAsStaticFramework}'"
     s.static_framework = $RNFirebaseAsStaticFramework

package/__tests__/analytics.test.ts

@@ -521,4 +521,15 @@ describe('Analytics', function () {
       );
     });
   });
+
+  describe('initiateOnDeviceConversionMeasurementWithEmailAddress()', function () {
+    it('throws if not a string', function () {
+      expect(() =>
+        // @ts-ignore
+        firebase.analytics().initiateOnDeviceConversionMeasurementWithEmailAddress(true),
+      ).toThrowError(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithEmailAddress(*) 'emailAddress' expected a string value.",
+      );
+    });
+  });
 });

package/ios/RNFBAnalytics/RNFBAnalyticsModule.m

@@ -138,6 +138,19 @@ RCT_EXPORT_METHOD(setDefaultEventParameters
   return resolve([NSNull null]);
 }
 
+RCT_EXPORT_METHOD(initiateOnDeviceConversionMeasurementWithEmailAddress
+                  : (NSString *)emailAddress resolver
+                  : (RCTPromiseResolveBlock)resolve rejecter
+                  : (RCTPromiseRejectBlock)reject) {
+  @try {
+    [FIRAnalytics initiateOnDeviceConversionMeasurementWithEmailAddress:emailAddress];
+  } @catch (NSException *exception) {
+    return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+  }
+
+  return resolve([NSNull null]);
+}
+
 #pragma mark -
 #pragma mark Private methods
 

package/lib/index.d.ts

@@ -1502,6 +1502,15 @@ export namespace FirebaseAnalyticsTypes {
      * will clear all parameters.
      */
     setDefaultEventParameters(params?: { [key: string]: any }): 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
+     *
+     * @param emailAddress email address, properly formatted complete with domain name e.g, 'user@example.com'
+     */
+    initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress: string): Promise<void>;
   }
 }
 

package/lib/index.js

@@ -17,6 +17,7 @@
 
 import {
   isAlphaNumericUnderscore,
+  isIOS,
   isNull,
   isNumber,
   isObject,
@@ -40,7 +41,7 @@ const ReservedEventNames = [
   'ad_activeview',
   'ad_click',
   'ad_exposure',
-  'ad_impression',
+  // 'ad_impression', // manual ad_impression logging is allowed, See #6307
   'ad_query',
   'ad_reward',
   'adunit_exposure',
@@ -676,6 +677,20 @@ class FirebaseAnalyticsModule extends FirebaseModule {
 
     return this.native.setDefaultEventParameters(params);
   }
+
+  initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress) {
+    if (!isString(emailAddress)) {
+      throw new Error(
+        "firebase.analytics().initiateOnDeviceConversionMeasurementWithEmailAddress(*) 'emailAddress' expected a string value.",
+      );
+    }
+
+    if (!isIOS) {
+      return;
+    }
+
+    return this.native.initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress);
+  }
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/analytics';

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "14.11.0",
+  "version": "15.1.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": "14.11.0"
+    "@react-native-firebase/app": "15.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ee740f80501fdd2ea5184515c4840340fca55e63"
+  "gitHead": "f9a50496bddab6a4bb740cd18dd7407d219fbda2"
 }