@firebase/analytics-compat - npm Package Compare versions

Comparing version 0.2.15-canary.4db3d3e7b to 0.2.15-canary.612335d76

dist/esm/index.esm2017.js

@@ -6,3 +6,3 @@ import firebase from '@firebase/app-compat';
 const name = "@firebase/analytics-compat";
-const version = "0.2.15-canary.4db3d3e7b";
+const version = "0.2.15-canary.612335d76";
 
@@ -9,0 +9,0 @@ /**

dist/esm/src/constants.d.ts

@@ -0,0 +0,0 @@ /**

dist/esm/src/index.d.ts

@@ -0,0 +0,0 @@ /**

dist/esm/src/service.d.ts

@@ -0,0 +0,0 @@ /**

dist/esm/src/service.test.d.ts

 export {};

dist/index.cjs.js

@@ -14,3 +14,3 @@ 'use strict';
 const name = "@firebase/analytics-compat";
-const version = "0.2.15-canary.4db3d3e7b";
+const version = "0.2.15-canary.612335d76";
 
@@ -17,0 +17,0 @@ /**

dist/src/constants.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/index.d.ts

@@ -34,6 +34,37 @@ /**
 declare module "@firebase/analytics" {
-    function getAnalytics(app?: FirebaseAppCompat): Analytics;
-    function getGoogleAnalyticsClientId(analyticsInstance: FirebaseAnalytics): Promise<string>;
-    function initializeAnalytics(app: FirebaseAppCompat, options?: AnalyticsSettings): Analytics;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'add_payment_info', eventParams?: {
+    /**
+     * Returns an {@link Analytics} instance for the given app.
+     *
+     * @public
+     *
+     * @param app - The {@link @firebase/app#FirebaseApp} to use.
+     */
+    export declare function getAnalytics(app?: FirebaseAppCompat): Analytics;
+    /**
+     * Retrieves a unique Google Analytics identifier for the web client.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/config#client_id | client_id}.
+     *
+     * @public
+     *
+     * @param app - The {@link @firebase/app#FirebaseApp} to use.
+     */
+    export declare function getGoogleAnalyticsClientId(analyticsInstance: FirebaseAnalytics): Promise<string>;
+    /**
+     * Returns an {@link Analytics} instance for the given app.
+     *
+     * @public
+     *
+     * @param app - The {@link @firebase/app#FirebaseApp} to use.
+     */
+    export declare function initializeAnalytics(app: FirebaseAppCompat, options?: AnalyticsSettings): Analytics;
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'add_payment_info', eventParams?: {
         coupon?: EventParams['coupon'];
@@ -46,3 +77,12 @@ currency?: EventParams['currency'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'add_shipping_info', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'add_shipping_info', eventParams?: {
         coupon?: EventParams['coupon'];
@@ -55,3 +95,12 @@ currency?: EventParams['currency'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
         currency?: EventParams['currency'];
@@ -62,3 +111,12 @@ value?: EventParams['value'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'begin_checkout', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'begin_checkout', eventParams?: {
         currency?: EventParams['currency'];
@@ -70,3 +128,12 @@ coupon?: EventParams['coupon'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'checkout_progress', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'checkout_progress', eventParams?: {
         currency?: EventParams['currency'];
@@ -80,3 +147,12 @@ coupon?: EventParams['coupon'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'exception', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * See
+     * {@link https://developers.google.com/analytics/devguides/collection/ga4/exceptions
+     * | Measure exceptions}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'exception', eventParams?: {
         description?: EventParams['description'];
@@ -86,3 +162,12 @@ fatal?: EventParams['fatal'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'generate_lead', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'generate_lead', eventParams?: {
         value?: EventParams['value'];
@@ -92,7 +177,25 @@ currency?: EventParams['currency'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'login', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'login', eventParams?: {
         method?: EventParams['method'];
         [key: string]: any;
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'page_view', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * See
+     * {@link https://developers.google.com/analytics/devguides/collection/ga4/views
+     * | Page views}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'page_view', eventParams?: {
         page_title?: string;
@@ -103,3 +206,12 @@ page_location?: string;
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'purchase' | 'refund', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'purchase' | 'refund', eventParams?: {
         value?: EventParams['value'];
@@ -115,3 +227,11 @@ currency?: EventParams['currency'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'screen_view', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * See {@link https://firebase.google.com/docs/analytics/screenviews
+     * | Track Screenviews}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'screen_view', eventParams?: {
         firebase_screen: EventParams['firebase_screen'];
@@ -121,7 +241,25 @@ firebase_screen_class: EventParams['firebase_screen_class'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'search' | 'view_search_results', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'search' | 'view_search_results', eventParams?: {
         search_term?: EventParams['search_term'];
         [key: string]: any;
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'select_content', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'select_content', eventParams?: {
         content_type?: EventParams['content_type'];
@@ -131,3 +269,12 @@ item_id?: EventParams['item_id'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'select_item', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'select_item', eventParams?: {
         items?: EventParams['items'];
@@ -138,3 +285,12 @@ item_list_name?: EventParams['item_list_name'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
         items?: EventParams['items'];
@@ -145,3 +301,12 @@ promotion_id?: EventParams['promotion_id'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'set_checkout_option', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'set_checkout_option', eventParams?: {
         checkout_step?: EventParams['checkout_step'];
@@ -151,3 +316,12 @@ checkout_option?: EventParams['checkout_option'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'share', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'share', eventParams?: {
         method?: EventParams['method'];
@@ -158,7 +332,25 @@ content_type?: EventParams['content_type'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'sign_up', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'sign_up', eventParams?: {
         method?: EventParams['method'];
         [key: string]: any;
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'timing_complete', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'timing_complete', eventParams?: {
         name: string;
@@ -170,3 +362,12 @@ value: number;
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'view_cart' | 'view_item', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'view_cart' | 'view_item', eventParams?: {
         currency?: EventParams['currency'];
@@ -177,3 +378,12 @@ items?: EventParams['items'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'view_item_list', eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent(analyticsInstance: FirebaseAnalytics, eventName: 'view_item_list', eventParams?: {
         items?: EventParams['items'];
@@ -184,9 +394,51 @@ item_list_name?: EventParams['item_list_name'];
     }, options?: AnalyticsCallOptions): void;
-    function logEvent<T extends string>(analyticsInstance: FirebaseAnalytics, eventName: CustomEventName<T>, eventParams?: {
+    /**
+     * Sends a Google Analytics event with given `eventParams`. This method
+     * automatically associates this logged event with this Firebase web
+     * app instance on this device.
+     * @public
+     * List of recommended event parameters can be found in
+     * {@link https://developers.google.com/gtagjs/reference/ga4-events
+     * | the GA4 reference documentation}.
+     */
+    export declare function logEvent<T extends string>(analyticsInstance: FirebaseAnalytics, eventName: CustomEventName<T>, eventParams?: {
         [key: string]: any;
     }, options?: AnalyticsCallOptions): void;
-    function setAnalyticsCollectionEnabled(analyticsInstance: FirebaseAnalytics, enabled: boolean): void;
-    function setCurrentScreen(analyticsInstance: FirebaseAnalytics, screenName: string, options?: AnalyticsCallOptions): void;
-    function setUserId(analyticsInstance: FirebaseAnalytics, id: string | null, options?: AnalyticsCallOptions): void;
-    function setUserProperties(analyticsInstance: FirebaseAnalytics, properties: CustomParams, options?: AnalyticsCallOptions): void;
+    /**
+     * Sets whether Google Analytics collection is enabled for this app on this device.
+     * Sets global `window['ga-disable-analyticsId'] = true;`
+     *
+     * @public
+     *
+     * @param analyticsInstance - The {@link Analytics} instance.
+     * @param enabled - If true, enables collection, if false, disables it.
+     */
+    export declare function setAnalyticsCollectionEnabled(analyticsInstance: FirebaseAnalytics, enabled: boolean): void;
+    /**
+     * Use gtag `config` command to set `screen_name`.
+     *
+     * @public
+     *
+     * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+     * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
+     *
+     * @param analyticsInstance - The {@link Analytics} instance.
+     * @param screenName - Screen name to set.
+     */
+    export declare function setCurrentScreen(analyticsInstance: FirebaseAnalytics, screenName: string, options?: AnalyticsCallOptions): void;
+    /**
+     * Use gtag `config` command to set `user_id`.
+     *
+     * @public
+     *
+     * @param analyticsInstance - The {@link Analytics} instance.
+     * @param id - User ID to set.
+     */
+    export declare function setUserId(analyticsInstance: FirebaseAnalytics, id: string | null, options?: AnalyticsCallOptions): void;
+    /**
+     * Use gtag `config` command to set all params specified.
+     *
+     * @public
+     */
+    export declare function setUserProperties(analyticsInstance: FirebaseAnalytics, properties: CustomParams, options?: AnalyticsCallOptions): void;
 }

dist/src/service.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/service.test.d.ts

 export {};

package.json

 {
   "name": "@firebase/analytics-compat",
-  "version": "0.2.15-canary.4db3d3e7b",
+  "version": "0.2.15-canary.612335d76",
   "description": "",
@@ -22,10 +22,10 @@ "author": "Firebase <[e-mail]> (https://firebase.google.com/)",
   "peerDependencies": {
-    "@firebase/app-compat": "0.2.45-canary.4db3d3e7b"
+    "@firebase/app-compat": "0.2.45-canary.612335d76"
   },
   "devDependencies": {
-    "@firebase/app-compat": "0.2.45-canary.4db3d3e7b",
+    "@firebase/app-compat": "0.2.45-canary.612335d76",
     "rollup": "2.79.1",
     "@rollup/plugin-json": "4.1.0",
     "rollup-plugin-typescript2": "0.31.2",
-    "typescript": "4.7.4"
+    "typescript": "5.5.4"
   },
@@ -56,6 +56,6 @@ "repository": {
   "dependencies": {
-    "@firebase/component": "0.6.10-canary.4db3d3e7b",
-    "@firebase/analytics": "0.10.9-canary.4db3d3e7b",
-    "@firebase/analytics-types": "0.8.2-canary.4db3d3e7b",
-    "@firebase/util": "1.10.1-canary.4db3d3e7b",
+    "@firebase/component": "0.6.10-canary.612335d76",
+    "@firebase/analytics": "0.10.9-canary.612335d76",
+    "@firebase/analytics-types": "0.8.2-canary.612335d76",
+    "@firebase/util": "1.10.1-canary.612335d76",
     "tslib": "^2.1.0"
@@ -62,0 +62,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

60907

increased by19.83%

Lines of code

915

increased by38.01%

Dependency changes

• + Added@firebase/analytics@0.10.9-canary.612335d76(transitive)

• + Added@firebase/analytics-types@0.8.2-canary.612335d76(transitive)

• + Added@firebase/app@0.10.15-canary.612335d76(transitive)

• + Added@firebase/app-compat@0.2.45-canary.612335d76(transitive)

• + Added@firebase/component@0.6.10-canary.612335d76(transitive)

• + Added@firebase/installations@0.6.10-canary.612335d76(transitive)

• + Added@firebase/logger@0.4.3-canary.612335d76(transitive)

• + Added@firebase/util@1.10.1-canary.612335d76(transitive)

• - Removed@firebase/analytics@0.10.9-canary.4db3d3e7b(transitive)

• - Removed@firebase/analytics-types@0.8.2-canary.4db3d3e7b(transitive)

• - Removed@firebase/app@0.10.15-canary.4db3d3e7b(transitive)

• - Removed@firebase/app-compat@0.2.45-canary.4db3d3e7b(transitive)

• - Removed@firebase/component@0.6.10-canary.4db3d3e7b(transitive)

• - Removed@firebase/installations@0.6.10-canary.4db3d3e7b(transitive)

• - Removed@firebase/logger@0.4.3-canary.4db3d3e7b(transitive)

• - Removed@firebase/util@1.10.1-canary.4db3d3e7b(transitive)

• Updated@firebase/analytics@0.10.9-canary.612335d76

• Updated@firebase/analytics-types@0.8.2-canary.612335d76

• Updated@firebase/component@0.6.10-canary.612335d76

• Updated@firebase/util@1.10.1-canary.612335d76