fix(analytics): allow custom event parameters for screen_view events (#…

…5811) * fix(analytics): allow custom event parameters for screen_view events Fixes #4594. * style(lint): fix prettier error Co-authored-by: Mike Hardy <github@mikehardy.net>
invertase · Oct 25, 2021 · 02e888e · 02e888e · vercel · Oct 25, 2021
1 parent 89b104a
commit 02e888e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/packages/analytics/__tests__/analytics.test.ts b/packages/analytics/__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 () {

diff --git a/packages/analytics/lib/index.d.ts b/packages/analytics/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 {

diff --git a/packages/analytics/lib/structs.js b/packages/analytics/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?',
 });