@react-native-firebase/analytics 18.3.2 → 18.4.0

package/{modular → lib/modular}/index.js

@@ -1,9 +1,14 @@
 import { firebase } from '..';
 
+/**
+ * @typedef {import("..").FirebaseApp} FirebaseApp
+ * @typedef {import("..").FirebaseAnalyticsTypes.Module} FirebaseAnalytics
+ */
+
 /**
  * Returns a Analytics instance for the given app.
  * @param app - FirebaseApp. Optional.
- * @returns {Analytics}
+ * @returns {FirebaseAnalytics}
  */
 export function getAnalytics(app) {
   if (app) {
@@ -17,7 +22,7 @@ export function getAnalytics(app) {
  * Returns a Analytics instance for the given app.
  * @param app - FirebaseApp.
  * @param options - `AnalyticsSettings`. Web only.
- * @returns {Analytics}
+ * @returns {FirebaseAnalytics}
  */
 // eslint-disable-next-line
 export function initializeAnalytics(app, options) {
@@ -52,6 +57,7 @@ export function logEvent(analytics, name, eventParams = {}, options = {}) {
 export function setAnalyticsCollectionEnabled(analytics, enabled) {
   return analytics.setAnalyticsCollectionEnabled(enabled);
 }
+
 /**
  * Sets the duration of inactivity that terminates the current session.
  *
@@ -61,6 +67,7 @@ export function setAnalyticsCollectionEnabled(analytics, enabled) {
 export function setSessionTimeoutDuration(analytics, milliseconds = 1800000) {
   return analytics.setSessionTimeoutDuration(milliseconds);
 }
+
 /**
  * Retrieve the app instance id of the application.
  *
@@ -70,6 +77,7 @@ export function setSessionTimeoutDuration(analytics, milliseconds = 1800000) {
 export function getAppInstanceId(analytics) {
   return analytics.getAppInstanceId();
 }
+
 /**
  * Retrieves the session id from the client.
  * On iOS, Firebase SDK may return an error that is handled internally and may take many minutes to return a valid value. Check native debug logs for more details.
@@ -90,6 +98,7 @@ export function getSessionId(analytics) {
 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.
  *
@@ -100,6 +109,7 @@ export function setUserId(analytics, id) {
 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.
  *
@@ -112,6 +122,7 @@ export function setUserProperty(analytics, name, value) {
 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.
  *
@@ -120,6 +131,7 @@ export function setUserProperties(analytics, properties, options = {}) {
 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.
@@ -134,6 +146,7 @@ export function resetAnalyticsData(analytics) {
 export function logAddPaymentInfo(analytics, object = {}) {
   return analytics.logAddPaymentInfo(object);
 }
+
 /**
  * Sets or clears the screen name and class the user is currently viewing
  *
@@ -143,6 +156,7 @@ export function logAddPaymentInfo(analytics, object = {}) {
 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.
  *
@@ -156,6 +170,7 @@ export function logScreenView(analytics, object = {}) {
 export function logAddShippingInfo(analytics, object = {}) {
   return analytics.logAddShippingInfo(object);
 }
+
 /**
  * E-Commerce Add To Cart event.
  *
@@ -169,6 +184,7 @@ export function logAddShippingInfo(analytics, object = {}) {
 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.
@@ -183,6 +199,7 @@ export function logAddToCart(analytics, object = {}) {
 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
@@ -194,6 +211,7 @@ export function logAddToWishlist(analytics, object = {}) {
 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.
@@ -208,6 +226,7 @@ export function logAppOpen(analytics) {
 export function logBeginCheckout(analytics, object = {}) {
   return analytics.logBeginCheckout(object);
 }
+
 /**
  * Log this event to supply the referral details of a re-engagement campaign.
  *
@@ -219,6 +238,7 @@ export function logBeginCheckout(analytics, object = {}) {
 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.
@@ -231,6 +251,7 @@ export function logCampaignDetails(analytics, object = {}) {
 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.
@@ -245,6 +266,7 @@ export function logEarnVirtualCurrency(analytics, object = {}) {
 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
@@ -257,6 +279,7 @@ export function logGenerateLead(analytics, object = {}) {
 export function logJoinGroup(analytics, object = {}) {
   return analytics.logJoinGroup(object);
 }
+
 /**
  * Level End event.
  *
@@ -268,6 +291,7 @@ export function logJoinGroup(analytics, object = {}) {
 export function logLevelEnd(analytics, object = {}) {
   return analytics.logLevelEnd(object);
 }
+
 /**
  * Level Start event.
  *
@@ -279,6 +303,7 @@ export function logLevelEnd(analytics, object = {}) {
 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.
@@ -291,6 +316,7 @@ export function logLevelStart(analytics, object = {}) {
 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.
  *
@@ -302,6 +328,7 @@ export function logLevelUp(analytics, object = {}) {
 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
@@ -315,6 +342,7 @@ export function logLogin(analytics, object = {}) {
 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
@@ -328,6 +356,7 @@ export function logPostScore(analytics, object = {}) {
 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.
@@ -342,6 +371,7 @@ export function logSelectContent(analytics, object = {}) {
 export function logPurchase(analytics, object = {}) {
   return analytics.logPurchase(object);
 }
+
 /**
  * E-Commerce Refund event. This event signifies that a refund was issued.
  *
@@ -353,6 +383,7 @@ export function logPurchase(analytics, object = {}) {
 export function logRefund(analytics, object = {}) {
   return analytics.logRefund(object);
 }
+
 /**
  * Remove from cart event.
  *
@@ -364,6 +395,7 @@ export function logRefund(analytics, object = {}) {
 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
@@ -377,6 +409,7 @@ export function logRemoveFromCart(analytics, object = {}) {
 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.
@@ -390,6 +423,7 @@ export function logSearch(analytics, object = {}) {
 export function logSelectItem(analytics, object = {}) {
   return analytics.logSelectItem(object);
 }
+
 /**
  * Set checkout option event.
  *
@@ -401,6 +435,7 @@ export function logSelectItem(analytics, object = {}) {
 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.
@@ -413,6 +448,7 @@ export function logSetCheckoutOption(analytics, object = {}) {
 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.
  *
@@ -424,6 +460,7 @@ export function logSelectPromotion(analytics, object = {}) {
 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
@@ -437,6 +474,7 @@ export function logShare(analytics, object = {}) {
 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.
@@ -449,6 +487,7 @@ export function logSignUp(analytics, object = {}) {
 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
@@ -461,6 +500,7 @@ export function logSpendVirtualCurrency(analytics, object = {}) {
 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
@@ -473,6 +513,7 @@ export function logTutorialBegin(analytics) {
 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
@@ -486,6 +527,7 @@ export function logTutorialComplete(analytics) {
 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.
  *
@@ -499,6 +541,7 @@ export function logUnlockAchievement(analytics, object = {}) {
 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
@@ -514,6 +557,7 @@ export function logViewCart(analytics, object = {}) {
 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.
  *
@@ -526,9 +570,18 @@ export function logViewItemList(analytics, object = {}) {
   return analytics.logViewItemList(object);
 }
 
+/**
+ * View Promotion event. This event signifies that a promotion was shown to a user.
+ *
+ * Logged event name: `view_promotion`
+ *
+ * @param analytics Analytics instance.
+ * @param params See {@link analytics.ViewPromotionEventParameters}.
+ */
 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.
  *
@@ -540,6 +593,7 @@ export function logViewPromotion(analytics, object = {}) {
 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.
  *
@@ -555,6 +609,7 @@ export function logViewSearchResults(analytics, object = {}) {
 export function setDefaultEventParameters(analytics, params = {}) {
   return analytics.setDefaultEventParameters(params);
 }
+
 /**
  * start privacy-sensitive on-device conversion management.
  * This is iOS-only.
@@ -579,6 +634,7 @@ 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.

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "18.3.2",
+  "version": "18.4.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": "18.3.2"
+    "@react-native-firebase/app": "18.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f323891622441c9d59a25ef37b19534db512b372"
+  "gitHead": "5f6460a87970d8b6013530de980bc760ddc70f90"
 }