@react-native-firebase/analytics 17.2.0 → 17.3.1

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [17.3.1](https://github.com/invertase/react-native-firebase/compare/v17.3.0...v17.3.1) (2023-02-23)
+
+**Note:** Version bump only for package @react-native-firebase/analytics
+
+## [17.3.0](https://github.com/invertase/react-native-firebase/compare/v17.2.0...v17.3.0) (2023-02-15)
+
+### Features
+
+- **analytics:** Expose modular API that matches the Firebase web JS SDK v9 API ([#6816](https://github.com/invertase/react-native-firebase/issues/6816)) ([a42551a](https://github.com/invertase/react-native-firebase/commit/a42551aadb98ba6fdd18dde627b436e667d0a014))
+
 ## [17.2.0](https://github.com/invertase/react-native-firebase/compare/v17.1.0...v17.2.0) (2023-02-15)
 
 **Note:** Version bump only for package @react-native-firebase/analytics

package/lib/index.d.ts

@@ -630,6 +630,160 @@ export namespace FirebaseAnalyticsTypes {
 
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   export interface Statics {}
+  /**
+   * Analytics instance initialization options. Web only.
+   */
+  export interface AnalyticsSettings {
+    config?: GtagConfigParams | EventParams;
+  }
+  /**
+   * Additional options that can be passed to Analytics method calls such as logEvent. Web only.
+   */
+  export interface AnalyticsCallOptions {
+    /**
+     * If true, this config or event call applies globally to all Google Analytics properties on the page. Web only.
+     */
+    global: boolean;
+  }
+  /**
+   * A set of common Google Analytics config settings recognized by gtag.js. Web only.
+   */
+  export interface GtagConfigParams {
+    /**
+     * Whether or not a page view should be sent.
+     * If set to true (default), a page view is automatically sent upon initialization
+     * of analytics.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view | Page views }
+     */
+    send_page_view?: boolean;
+    /**
+     * The title of the page.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view | Page views }
+     */
+    page_title?: string;
+    /**
+     * The URL of the page.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view | Page views }
+     */
+    page_location?: string;
+    /**
+     * Defaults to `auto`.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id | Cookies and user identification }
+     */
+    cookie_domain?: string;
+    /**
+     * Defaults to 63072000 (two years, in seconds).
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id | Cookies and user identification }
+     */
+    cookie_expires?: number;
+    /**
+     * Defaults to `_ga`.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id | Cookies and user identification }
+     */
+    cookie_prefix?: string;
+    /**
+     * If set to true, will update cookies on each page load.
+     * Defaults to true.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id | Cookies and user identification }
+     */
+    cookie_update?: boolean;
+    /**
+     * Appends additional flags to the cookie when set.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/cookies-user-id | Cookies and user identification }
+     */
+    cookie_flags?: string;
+    /**
+     * If set to false, disables all advertising features with `gtag.js`.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/display-features | Disable advertising features }
+     */
+    allow_google_signals?: boolean;
+    /**
+     * If set to false, disables all advertising personalization with `gtag.js`.
+     * See {@link https://developers.google.com/analytics/devguides/collection/ga4/display-features | Disable advertising features }
+     */
+    allow_ad_personalization_signals?: boolean;
+    [key: string]: unknown;
+  }
+  /**
+   * Standard gtag.js event parameters. For more information, see the GA4 reference documentation. Web only.
+   */
+  export interface EventParams {
+    checkout_option?: string;
+    checkout_step?: number;
+    item_id?: string;
+    content_type?: string;
+    coupon?: string;
+    currency?: string;
+    description?: string;
+    fatal?: boolean;
+    items?: Item[];
+    method?: string;
+    number?: string;
+    promotions?: Promotion[];
+    screen_name?: string;
+    /**
+     * Firebase-specific. Use to log a `screen_name` to Firebase Analytics.
+     */
+    firebase_screen?: string;
+    /**
+     * Firebase-specific. Use to log a `screen_class` to Firebase Analytics.
+     */
+    firebase_screen_class?: string;
+    search_term?: string;
+    shipping?: Currency;
+    tax?: Currency;
+    transaction_id?: string;
+    value?: number;
+    event_label?: string;
+    event_category?: string;
+    shipping_tier?: string;
+    item_list_id?: string;
+    item_list_name?: string;
+    promotion_id?: string;
+    promotion_name?: string;
+    payment_type?: string;
+    affiliation?: string;
+    page_title?: string;
+    page_location?: string;
+    page_path?: string;
+    [key: string]: unknown;
+  }
+
+  /**
+   * Consent status settings for each consent type.
+   * For more information, see
+   * {@link https://developers.google.com/tag-platform/tag-manager/templates/consent-apis
+   * | the GA4 reference documentation for consent state and consent types}.
+   */
+  export interface ConsentSettings {
+    /** Enables storage, such as cookies, related to advertising */
+    ad_storage?: ConsentStatusString;
+    /** Enables storage, such as cookies, related to analytics (for example, visit duration) */
+    analytics_storage?: ConsentStatusString;
+    /**
+     * Enables storage that supports the functionality of the website or app such as language settings
+     */
+    functionality_storage?: ConsentStatusString;
+    /** Enables storage related to personalization such as video recommendations */
+    personalization_storage?: ConsentStatusString;
+    /**
+     * Enables storage related to security such as authentication functionality, fraud prevention,
+     * and other user protection.
+     */
+    security_storage?: ConsentStatusString;
+    [key: string]: unknown;
+  }
+
+  /**
+   * Specifies custom options for your Firebase Analytics instance.
+   * You must set these before initializing `firebase.analytics()`.
+   */
+  export interface SettingsOptions {
+    /** Sets custom name for `gtag` function. */
+    gtagName?: string;
+    /** Sets custom name for `dataLayer` array used by `gtag.js`. */
+    dataLayerName?: string;
+  }
 
   /**
    * The Firebase Analytics service interface.
@@ -665,8 +819,13 @@ export namespace FirebaseAnalyticsTypes {
      *
      * @param name Event name must not conflict with any Reserved Events.
      * @param params Parameters to be sent and displayed with the event.
+     * @param options Additional options that can be passed. Web only.
      */
-    logEvent(name: string, params?: { [key: string]: any }): Promise<void>;
+    logEvent(
+      name: string,
+      params?: { [key: string]: any },
+      options?: AnalyticsCallOptions,
+    ): Promise<void>;
 
     /**
      * If true, allows the device to collect analytical data and send it to
@@ -757,8 +916,12 @@ export namespace FirebaseAnalyticsTypes {
      *
      * @react-native-firebase
      * @param properties Set a property value to null to remove it.
+     * @param options Additional options that can be passed. Web only.
      */
-    setUserProperties(properties: { [key: string]: string | null }): Promise<void>;
+    setUserProperties(
+      properties: { [key: string]: string | null },
+      options?: AnalyticsCallOptions,
+    ): Promise<void>;
 
     /**
      * Clears all analytics data for this instance from the device and resets the app instance ID.

package/lib/index.js

@@ -37,6 +37,55 @@ import { isBoolean } from '@react-native-firebase/app/lib/common';
 import version from './version';
 import * as structs from './structs';
 
+export {
+  getAnalytics,
+  logEvent,
+  setAnalyticsCollectionEnabled,
+  setSessionTimeoutDuration,
+  getAppInstanceId,
+  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,
+} from '../modular/index';
+
 const ReservedEventNames = [
   'ad_activeview',
   'ad_click',
@@ -79,7 +128,7 @@ const namespace = 'analytics';
 const nativeModuleName = 'RNFBAnalyticsModule';
 
 class FirebaseAnalyticsModule extends FirebaseModule {
-  logEvent(name, params = {}) {
+  logEvent(name, params = {}, options = {}) {
     if (!isString(name)) {
       throw new Error("firebase.analytics().logEvent(*) 'name' expected a string value.");
     }
@@ -102,6 +151,18 @@ class FirebaseAnalyticsModule extends FirebaseModule {
       );
     }
 
+    if (!isUndefined(options)) {
+      if (!isObject(options)) {
+        throw new Error(
+          "firebase.analytics().logEvent(_, _, *) 'options' expected an object value.",
+        );
+      }
+
+      if (!isUndefined(options.global) && !isBoolean(options.global)) {
+        throw new Error("'options.global' property expected a boolean.");
+      }
+    }
+
     return this.native.logEvent(name, params);
   }
 
@@ -157,13 +218,25 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setUserProperty(name, value);
   }
 
-  setUserProperties(properties) {
+  setUserProperties(properties, options = {}) {
     if (!isObject(properties)) {
       throw new Error(
         "firebase.analytics().setUserProperties(*) 'properties' expected an object of key/value pairs.",
       );
     }
 
+    if (!isUndefined(options)) {
+      if (!isObject(options)) {
+        throw new Error(
+          "firebase.analytics().logEvent(_, _, *) 'options' expected an object value.",
+        );
+      }
+
+      if (!isUndefined(options.global) && !isBoolean(options.global)) {
+        throw new Error("'options.global' property expected a boolean.");
+      }
+    }
+
     const entries = Object.entries(properties);
     for (let i = 0; i < entries.length; i++) {
       const [key, value] = entries[i];

package/lib/version.js

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

package/modular/index.js

@@ -0,0 +1,596 @@
+import { firebase } from '..';
+
+/**
+ * Returns a Analytics instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ * @returns {Analytics}
+ */
+export function getAnalytics(app) {
+  if (app) {
+    return firebase.app(app.name).analytics();
+  }
+
+  return firebase.app().analytics();
+}
+
+/**
+ * Returns a Analytics instance for the given app.
+ * @param app - FirebaseApp.
+ * @param options - `AnalyticsSettings`. Web only.
+ * @returns {Analytics}
+ */
+// eslint-disable-next-line
+export function initializeAnalytics(app, options) {
+  // options is specifically for web. Implement when it becomes available.
+  return firebase.app(app.name).analytics();
+}
+
+/**
+ * Log a custom event with optional params. Note that there are various limits that applied
+ * to event parameters (total parameter count, etc), but analytics applies the limits during
+ * cloud processing, the errors will not be seen as Promise rejections when you call logEvent.
+ * While integrating this API in your app you are strongly encouraged to enable
+ * [DebugView](https://firebase.google.com/docs/analytics/debugview) -
+ * any errors in your events will show up in the firebase web console with links to relevant documentation
+ *
+ * @param analytics Analytics instance.
+ * @param name Event name must not conflict with any Reserved Events.
+ * @param params Parameters to be sent and displayed with the event.
+ * @param options Additional options that can be passed. Web only.
+ */
+export function logEvent(analytics, name, eventParams = {}, options = {}) {
+  return analytics.logEvent(name, eventParams, options);
+}
+
+/**
+ * If true, allows the device to collect analytical data and send it to
+ * Firebase. Useful for GDPR.
+ *
+ * @param analytics Analytics instance.
+ * @param enabled A boolean value representing whether Analytics collection is enabled or disabled. Analytics collection is enabled by default.
+ */
+export function setAnalyticsCollectionEnabled(analytics, enabled) {
+  return analytics.setAnalyticsCollectionEnabled(enabled);
+}
+/**
+ * Sets the duration of inactivity that terminates the current session.
+ *
+ * @param analytics Analytics instance.
+ * @param milliseconds The default value is 1800000 (30 minutes).
+ */
+export function setSessionTimeoutDuration(analytics, milliseconds = 1800000) {
+  return analytics.setSessionTimeoutDuration(milliseconds);
+}
+/**
+ * Retrieve the app instance id of the application.
+ *
+ * @param analytics Analytics instance.
+ * @returns Returns the app instance id or null on android if FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED and null on iOS if ConsentType.analyticsStorage has been set to ConsentStatus.denied.
+ */
+export function getAppInstanceId(analytics) {
+  return analytics.getAppInstanceId();
+}
+/**
+ * Gives a user a unique identification.
+ *
+ * @param analytics Analytics instance.
+ * @param id Set to null to remove a previously assigned ID from analytics
+ * events
+ */
+export function setUserId(analytics, id) {
+  return analytics.setUserId(id);
+}
+/**
+ * Sets a key/value pair of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.
+ *
+ * @param analytics Analytics instance.
+ * @param name A user property identifier.
+ * @param value Set to null to remove a previously assigned ID from analytics events.
+ */
+export function setUserProperty(analytics, name, value) {
+  return analytics.setUserProperty(name, value);
+}
+/**
+ * Sets multiple key/value pairs of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.
+ *
+ * > When you set user properties, be sure to never include personally identifiable information such as names, social security numbers, or email addresses, even in hashed form.
+ *
+ * @param analytics Analytics instance.
+ * @param properties Set a property value to null to remove it.
+ * @param options `AnalyticsCallOptions`. Additional options that can be passed. Web only.
+ */
+export function setUserProperties(analytics, properties, options = {}) {
+  return analytics.setUserProperties(properties, options);
+}
+/**
+ * Clears all analytics data for this instance from the device and resets the app instance ID.
+ *
+ * @param analytics Analytics instance.
+ */
+export function resetAnalyticsData(analytics) {
+  return analytics.resetAnalyticsData();
+}
+/**
+ * E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user. Note: This is different from the in-app purchase event, which is reported
+ * automatically for Google Play-based apps.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `purchase`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.AddPaymentInfoEventParameters}.
+ */
+export function logAddPaymentInfo(analytics, object = {}) {
+  return analytics.logAddPaymentInfo(object);
+}
+/**
+ * Sets or clears the screen name and class the user is currently viewing
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ScreenViewParameters}.
+ */
+export function logScreenView(analytics, object = {}) {
+  return analytics.logScreenView(object);
+}
+/**
+ * Add Payment Info event. This event signifies that a user has submitted their payment information to your app.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `add_payment_info`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.AddShippingInfoParameters}.
+ */
+export function logAddShippingInfo(analytics, object = {}) {
+  return analytics.logAddShippingInfo(object);
+}
+/**
+ * E-Commerce Add To Cart event.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `add_to_cart`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.AddToCartEventParameters}.
+ */
+export function logAddToCart(analytics, object = {}) {
+  return analytics.logAddToCart(object);
+}
+/**
+ * E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist.
+ * Use this event to identify popular gift items in your app.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `add_to_wishlist
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.AddToWishlistEventParameters}.
+ */
+export function logAddToWishlist(analytics, object = {}) {
+  return analytics.logAddToWishlist(object);
+}
+/**
+ * App Open event. By logging this event when an App is moved to the foreground, developers can
+ * understand how often users leave and return during the course of a Session. Although Sessions
+ * are automatically reported, this event can provide further clarification around the continuous
+ * engagement of app-users.
+ *
+ * @param analytics Analytics instance.
+ */
+export function logAppOpen(analytics) {
+  return analytics.logAppOpen();
+}
+/**
+ * E-Commerce Begin Checkout event. This event signifies that a user has begun the process of
+ * checking out.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `begin_checkout`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.BeginCheckoutEventParameters}.
+ */
+export function logBeginCheckout(analytics, object = {}) {
+  return analytics.logBeginCheckout(object);
+}
+/**
+ * Log this event to supply the referral details of a re-engagement campaign.
+ *
+ * Logged event name: `campaign_details`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.CampaignDetailsEventParameters}.
+ */
+export function logCampaignDetails(analytics, object = {}) {
+  return analytics.logCampaignDetails(object);
+}
+/**
+ * Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log this along with
+ * {@link analytics.logSpendVirtualCurrency} to better understand your virtual economy.
+ *
+ * Logged event name: `earn_virtual_currency`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.EarnVirtualCurrencyEventParameters}.
+ */
+export function logEarnVirtualCurrency(analytics, object = {}) {
+  return analytics.logEarnVirtualCurrency(object);
+}
+/**
+ * Generate Lead event. Log this event when a lead has been generated in the app to understand
+ * the efficacy of your install and re-engagement campaigns.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `generate_lead`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.GenerateLeadEventParameters}.
+ */
+export function logGenerateLead(analytics, object = {}) {
+  return analytics.logGenerateLead(object);
+}
+/**
+ * Join Group event. Log this event when a user joins a group such as a guild, team or family.
+ * Use this event to analyze how popular certain groups or social features are in your app
+ *
+ * Logged event name: `join_group`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.JoinGroupEventParameters}.
+ */
+export function logJoinGroup(analytics, object = {}) {
+  return analytics.logJoinGroup(object);
+}
+/**
+ * Level End event.
+ *
+ * Logged event name: `level_end`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.LevelEndEventParameters}.
+ */
+export function logLevelEnd(analytics, object = {}) {
+  return analytics.logLevelEnd(object);
+}
+/**
+ * Level Start event.
+ *
+ * Logged event name: `level_start`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.LevelStartEventParameters}.
+ */
+export function logLevelStart(analytics, object = {}) {
+  return analytics.logLevelStart(object);
+}
+/**
+ * Level Up event. This event signifies that a player has leveled up in your gaming app.
+ * It can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass.
+ *
+ * Logged event name: `level_up`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.LevelUpEventParameters}.
+ */
+export function logLevelUp(analytics, object = {}) {
+  return analytics.logLevelUp(object);
+}
+/**
+ * Login event. Apps with a login feature can report this event to signify that a user has logged in.
+ *
+ * Logged event name: `login`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.LoginEventParameters}.
+ */
+export function logLogin(analytics, object = {}) {
+  return analytics.logLogin(object);
+}
+/**
+ * Post Score event. Log this event when the user posts a score in your gaming app. This event can
+ * help you understand how users are actually performing in your game and it can help you correlate
+ * high scores with certain audiences or behaviors.
+ *
+ * Logged event name: `post_score`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.PostScoreEventParameters}.
+ */
+export function logPostScore(analytics, object = {}) {
+  return analytics.logPostScore(object);
+}
+/**
+ * Select Content event. This general purpose event signifies that a user has selected some
+ * content of a certain type in an app. The content can be any object in your app. This event
+ * can help you identify popular content and categories of content in your app.
+ *
+ * Logged event name: `select_content`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SelectContentEventParameters}.
+ */
+export function logSelectContent(analytics, object = {}) {
+  return analytics.logSelectContent(object);
+}
+/**
+ * E-Commerce Purchase event. This event signifies that an item(s) was purchased by a user. Note: This is different from the in-app purchase event, which is reported
+ * automatically for Google Play-based apps.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `purchase`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.PurchaseEventParameters}.
+ */
+export function logPurchase(analytics, object = {}) {
+  return analytics.logPurchase(object);
+}
+/**
+ * E-Commerce Refund event. This event signifies that a refund was issued.
+ *
+ * Logged event name: `remove_from_cart`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.RefundEventParameters}.
+ */
+export function logRefund(analytics, object = {}) {
+  return analytics.logRefund(object);
+}
+/**
+ * Remove from cart event.
+ *
+ * Logged event name: `remove_from_cart`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.RemoveFromCartEventParameters}.
+ */
+export function logRemoveFromCart(analytics, object = {}) {
+  return analytics.logRemoveFromCart(object);
+}
+/**
+ * Search event. Apps that support search features can use this event to contextualize search
+ * operations by supplying the appropriate, corresponding parameters. This event can help you
+ * identify the most popular content in your app.
+ *
+ * Logged event name: `search`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SearchEventParameters}.
+ */
+export function logSearch(analytics, object = {}) {
+  return analytics.logSearch(object);
+}
+/**
+ * Select Item event. This event signifies that an item was selected by a user from a list.
+ * Use the appropriate parameters to contextualize the event.
+ * Use this event to discover the most popular items selected.
+ *
+ * Logged event name: `select_item`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SelectItemEventParameters}.
+ */
+export function logSelectItem(analytics, object = {}) {
+  return analytics.logSelectItem(object);
+}
+/**
+ * Set checkout option event.
+ *
+ * Logged event name: `set_checkout_option`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SetCheckoutOptionEventParameters}.
+ */
+export function logSetCheckoutOption(analytics, object = {}) {
+  return analytics.logSetCheckoutOption(object);
+}
+/**
+ * Select promotion event. This event signifies that a user has selected a promotion offer. Use the
+ * appropriate parameters to contextualize the event, such as the item(s) for which the promotion applies.
+ *
+ * Logged event name: `select_promotion`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SelectPromotionEventParameters}.
+ */
+export function logSelectPromotion(analytics, object = {}) {
+  return analytics.logSelectPromotion(object);
+}
+/**
+ * Share event. Apps with social features can log the Share event to identify the most viral content.
+ *
+ * Logged event name: `share`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ShareEventParameters}.
+ */
+export function logShare(analytics, object = {}) {
+  return analytics.logShare(object);
+}
+/**
+ * Sign Up event. This event indicates that a user has signed up for an account in your app.
+ * The parameter signifies the method by which the user signed up. Use this event to understand
+ * the different behaviors between logged in and logged out users.
+ *
+ * Logged event name: `sign_up`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SignUpEventParameters}.
+ */
+export function logSignUp(analytics, object = {}) {
+  return analytics.logSignUp(object);
+}
+/**
+ * Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can
+ * help you identify which virtual goods are the most popular objects of purchase.
+ *
+ * Logged event name: `spend_virtual_currency`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.SpendVirtualCurrencyEventParameters}.
+ */
+export function logSpendVirtualCurrency(analytics, object = {}) {
+  return analytics.logSpendVirtualCurrency(object);
+}
+/**
+ * Tutorial Begin event. This event signifies the start of the on-boarding process in your app.
+ * Use this in a funnel with {@link analytics#logTutorialComplete} to understand how many users
+ * complete this process and move on to the full app experience.
+ *
+ * Logged event name: `tutorial_begin`
+ *
+ * @param analytics Analytics instance.
+ */
+export function logTutorialBegin(analytics) {
+  return analytics.logTutorialBegin();
+}
+/**
+ * Tutorial End event. Use this event to signify the user's completion of your app's on-boarding process.
+ * Add this to a funnel with {@link analytics#logTutorialBegin} to understand how many users
+ * complete this process and move on to the full app experience.
+ *
+ * Logged event name: `tutorial_complete`
+ *
+ * @param analytics Analytics instance.
+ */
+export function logTutorialComplete(analytics) {
+  return analytics.logTutorialComplete();
+}
+/**
+ * Unlock Achievement event. Log this event when the user has unlocked an achievement in your game.
+ * Since achievements generally represent the breadth of a gaming experience, this event can help
+ * you understand how many users are experiencing all that your game has to offer.
+ *
+ * Logged event name: `unlock_achievement`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.UnlockAchievementEventParameters}.
+ */
+export function logUnlockAchievement(analytics, object = {}) {
+  return analytics.logUnlockAchievement(object);
+}
+/**
+ * E-commerce View Cart event. This event signifies that a user has viewed their cart. Use this to analyze your purchase funnel.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `view_cart`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ViewCartEventParameters}.
+ */
+export function logViewCart(analytics, object = {}) {
+  return analytics.logViewCart(object);
+}
+/**
+ * View Item event. This event signifies that some content was shown to the user. This content
+ * may be a product, a screen or just a simple image or text. Use the appropriate parameters
+ * to contextualize the event. Use this event to discover the most popular items viewed in your app.
+ *
+ * If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.
+ *
+ * Logged event name: `view_item`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ViewItemEventParameters}.
+ */
+export function logViewItem(analytics, object = {}) {
+  return analytics.logViewItem(object);
+}
+/**
+ * View Item List event. Log this event when the user has been presented with a list of items of a certain category.
+ *
+ * Logged event name: `view_item_list`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ViewItemListEventParameters}.
+ */
+export function logViewItemList(analytics, object = {}) {
+  return analytics.logViewItemList(object);
+}
+
+export function logViewPromotion(analytics, object = {}) {
+  return analytics.logViewPromotion(object);
+}
+/**
+ * View Search Results event. Log this event when the user has been presented with the results of a search.
+ *
+ * Logged event name: `view_search_results`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ViewSearchResultsParameters}.
+ */
+export function logViewSearchResults(analytics, object = {}) {
+  return analytics.logViewSearchResults(object);
+}
+/**
+ * Adds parameters that will be set on every event logged from the SDK, including automatic ones.
+ *
+ * @param analytics Analytics instance.
+ * @param params Parameters to be added to the map of parameters added to every event.
+ * They will be added to the map of default event parameters, replacing any existing
+ * parameter with the same name. Valid parameter values are String, long, and double.
+ * Setting a key's value to null will clear that parameter. Passing in a null bundle
+ * will clear all parameters.
+ * For Web, the values passed persist on the current page and are passed with all
+ * subsequent events.
+ */
+export function setDefaultEventParameters(analytics, params = {}) {
+  return analytics.setDefaultEventParameters(params);
+}
+/**
+ * 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 analytics Analytics instance.
+ * @param emailAddress email address, properly formatted complete with domain name e.g, 'user@example.com'
+ */
+export function initiateOnDeviceConversionMeasurementWithEmailAddress(analytics, emailAddress) {
+  return analytics.initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress);
+}
+
+/**
+ * Checks four different things.
+ * 1. Checks if it's not a browser extension environment.
+ * 2. Checks if cookies are enabled in current browser.
+ * 3. Checks if IndexedDB is supported by the browser environment.
+ * 4. Checks if the current browser context is valid for using IndexedDB.open().
+ * @returns {Promise<boolean>}
+ */
+export function isSupported() {
+  // always return "true" for now until Web implementation. Web only.
+  return Promise.resolve(true);
+}
+/**
+ * Sets the applicable end user consent state for this web app across all gtag
+ * references once Firebase Analytics is initialized. Web only.
+ * @param analytics Analytics instance.
+ * @param consentSettings See {@link analytics.ConsentSettings}.
+ * @returns {void}
+ */
+// eslint-disable-next-line
+export function setConsent(consentSettings) {
+  // Returns nothing until Web implemented.
+}
+
+/**
+ * Configures Firebase Analytics to use custom gtag or dataLayer names.
+ * Intended to be used if gtag.js script has been installed on this page
+ * independently of Firebase Analytics, and is using non-default names for
+ * either the gtag function or for dataLayer. Must be called before calling
+ * `getAnalytics()` or it won't have any effect. Web only.
+ * @param options See {@link analytics.SettingsOptions}.
+ * @returns {void}
+ */
+// eslint-disable-next-line
+export function settings(options) {
+  // Returns nothing until Web implemented.
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "17.2.0",
+  "version": "17.3.1",
   "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": "17.2.0"
+    "@react-native-firebase/app": "17.3.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "57666670bd7fa4121a6598c639c4b2a24b9d181c"
+  "gitHead": "8c57bbb3d9c397fc472b78e9853b671ed41e30ca"
 }