@react-native-firebase/analytics 12.9.3 → 13.0.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [13.0.0](https://github.com/invertase/react-native-firebase/compare/v12.9.3...v13.0.0) (2021-10-31)
+
+### Bug Fixes
+
+- **analytics:** allow custom event parameters for screen_view events ([#5811](https://github.com/invertase/react-native-firebase/issues/5811)) ([02e888e](https://github.com/invertase/react-native-firebase/commit/02e888e782f2b0243f0324f63018ea8b27a68abc)), closes [#4594](https://github.com/invertase/react-native-firebase/issues/4594)
+- rename default branch to main ([25e1d3d](https://github.com/invertase/react-native-firebase/commit/25e1d3d5a1a8311588938dc9d8fdf71d11cd9963))
+
+- fix(analytics)!: add missing reserved event names (#5630) ([2c1958e](https://github.com/invertase/react-native-firebase/commit/2c1958e7eec13afe47d7d46a4bf003258e4c0c26)), closes [#5630](https://github.com/invertase/react-native-firebase/issues/5630)
+
+### BREAKING CHANGES
+
+- some reserved words that were accepted before will throw exceptions now that the list is complete - do not use reserved words for analytics events
+
 ## [12.9.3](https://github.com/invertase/react-native-firebase/compare/v12.9.2...v12.9.3) (2021-10-22)
 
 **Note:** Version bump only for package @react-native-firebase/analytics

package/__tests__/analytics.test.ts

@@ -137,6 +137,13 @@ describe('Analytics', function () {
           'firebase.analytics().logScreenView(*):',
         );
       });
+      it('accepts arbitrary custom event parameters while rejecting defined parameters with wrong types', function () {
+        expect(() => firebase.analytics().logScreenView({ foo: 'bar' })).not.toThrow();
+        expect(() =>
+          // @ts-ignore test
+          firebase.analytics().logScreenView({ screen_name: 123, foo: 'bar' }),
+        ).toThrowError('firebase.analytics().logScreenView(*):');
+      });
     });
 
     describe('logAddPaymentInfo()', function () {

package/lib/index.d.ts

@@ -344,6 +344,10 @@ export namespace FirebaseAnalyticsTypes {
      * Current class associated with the view the user is currently viewing.
      */
     screen_class?: string;
+    /**
+     * Custom event parameters.
+     */
+    [key: string]: any;
   }
 
   export interface RefundEventParameters {

package/lib/index.js

@@ -37,7 +37,13 @@ import version from './version';
 import * as structs from './structs';
 
 const ReservedEventNames = [
+  'ad_activeview',
+  'ad_click',
+  'ad_exposure',
+  'ad_impression',
+  'ad_query',
   'ad_reward',
+  'adunit_exposure',
   'app_background',
   'app_clear_data',
   // 'app_exception',
@@ -53,6 +59,7 @@ const ReservedEventNames = [
   'dynamic_link_first_open',
   'error',
   'first_open',
+  'first_visit',
   'in_app_purchase',
   'notification_dismiss',
   'notification_foreground',

package/lib/structs.js

@@ -32,7 +32,7 @@ const Item = struct({
   price: 'number?',
 });
 
-export const ScreenView = struct({
+export const ScreenView = struct.interface({
   screen_class: 'string?',
   screen_name: 'string?',
 });

package/lib/version.js

@@ -1,2 +1,2 @@
 // generated by genversion
-module.exports = '12.9.3';
+module.exports = '13.0.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "12.9.3",
+  "version": "13.0.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",
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/invertase/react-native-firebase/tree/master/packages/analytics"
+    "url": "https://github.com/invertase/react-native-firebase/tree/main/packages/analytics"
   },
   "license": "Apache-2.0",
   "keywords": [
@@ -22,10 +22,10 @@
     "analytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "12.9.3"
+    "@react-native-firebase/app": "13.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9f00ac9011a710400097302b8263e5c8cf7a6575"
+  "gitHead": "4e8e81cca023023332dceeb590f886430ae59016"
 }