@react-native-firebase/analytics 24.0.0 → 24.1.0

package/lib/modular.ts

@@ -948,10 +948,10 @@ export function initiateOnDeviceConversionMeasurementWithEmailAddress(
  * 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
+ * {@link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials}
  *
  * @param analytics Analytics instance.
  * @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com'
- * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials
  */
 export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
   analytics: Analytics,
@@ -988,10 +988,10 @@ export function initiateOnDeviceConversionMeasurementWithPhoneNumber(
  * 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
+ * {@link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials}
  *
  * @param analytics Analytics instance.
  * @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
- * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials
  */
 export function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
   analytics: Analytics,
@@ -1031,9 +1031,10 @@ export function setConsent(analytics: Analytics, consentSettings: ConsentSetting
 /**
  * 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 {SettingsOptions} options - See SettingsOptions.
+ * @param {SettingsOptions} _options - See SettingsOptions - currently unused.
  * @returns {void}
  */
+
 export function settings(_options: SettingsOptions): void {
   // Returns nothing until Web implemented.
 }

package/lib/structs.ts

@@ -14,7 +14,7 @@
  *  limitations under the License.
  */
 
-import { object, string, number, array, optional, define, type } from 'superstruct';
+import { object, string, number, boolean, array, optional, define, type } from 'superstruct';
 
 const ShortDate = define(
   'ShortDate',
@@ -36,6 +36,7 @@ const Item = type({
   item_variant: optional(string()),
   quantity: optional(number()),
   price: optional(number()),
+  index: optional(number()),
 });
 
 export const ScreenView = type({
@@ -104,7 +105,7 @@ export const JoinGroup = object({
 
 export const LevelEnd = object({
   level: number(),
-  success: optional(string()),
+  success: optional(boolean()),
 });
 
 export const LevelStart = object({

package/lib/types/analytics.ts

@@ -282,7 +282,7 @@ export interface LevelEndEventParameters {
   /**
    * The result of an operation.
    */
-  success?: string;
+  success?: boolean;
 }
 
 export interface LevelStartEventParameters {

package/lib/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '24.0.0';
+export const version = '24.1.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/analytics",
-  "version": "24.0.0",
+  "version": "24.1.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": "./dist/module/index.js",
@@ -8,8 +8,10 @@
   "scripts": {
     "build": "genversion --esm --semi lib/version.ts",
     "build:clean": "rimraf android/build && rimraf ios/build",
+    "build:plugin": "rimraf plugin/build && tsc --build plugin",
+    "lint:plugin": "eslint \"plugin/src/**/*.{ts,js}\"",
     "compile": "bob build",
-    "prepare": "yarn run build && yarn compile"
+    "prepare": "yarn run build && yarn run build:plugin && yarn compile"
   },
   "repository": {
     "type": "git",
@@ -23,7 +25,8 @@
     "analytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "24.0.0"
+    "@react-native-firebase/app": "24.1.0",
+    "expo": ">=47.0.0"
   },
   "publishConfig": {
     "access": "public",
@@ -33,7 +36,14 @@
     "superstruct": "^2.0.2"
   },
   "devDependencies": {
-    "react-native-builder-bob": "^0.40.17"
+    "expo": "^55.0.5",
+    "react-native-builder-bob": "^0.40.17",
+    "typescript": "^5.9.3"
+  },
+  "peerDependenciesMeta": {
+    "expo": {
+      "optional": true
+    }
   },
   "exports": {
     ".": {
@@ -41,6 +51,7 @@
       "types": "./dist/typescript/lib/index.d.ts",
       "default": "./dist/module/index.js"
     },
+    "./app.plugin.js": "./app.plugin.js",
     "./package.json": "./package.json"
   },
   "react-native-builder-bob": {
@@ -65,5 +76,5 @@
     "node_modules/",
     "dist/"
   ],
-  "gitHead": "46c48499190be2dc9b9792d39c251db29495a607"
+  "gitHead": "804a51fd265453f2385adb0ac96a6abf992c0316"
 }

package/plugin/build/index.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+import { PluginConfigType } from './pluginConfig';
+declare const _default: ConfigPlugin<PluginConfigType>;
+export default _default;

package/plugin/build/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("@expo/config-plugins");
+const ios_1 = require("./ios");
+/**
+ * A config plugin for configuring `@react-native-firebase/analytics`
+ */
+const withRnFirebaseAnalytics = (config, props) => {
+    return (0, config_plugins_1.withPlugins)(config, [
+        // iOS
+        [ios_1.withIosWithoutAdIdSupport, props],
+        [ios_1.withIosGoogleAppMeasurementOnDeviceConversion, props],
+    ]);
+};
+const pak = require('../../package.json');
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withRnFirebaseAnalytics, pak.name, pak.version);

package/plugin/build/ios/index.d.ts

@@ -0,0 +1,2 @@
+import { withIosWithoutAdIdSupport, withIosGoogleAppMeasurementOnDeviceConversion } from './podfile';
+export { withIosWithoutAdIdSupport, withIosGoogleAppMeasurementOnDeviceConversion };

package/plugin/build/ios/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withIosGoogleAppMeasurementOnDeviceConversion = exports.withIosWithoutAdIdSupport = void 0;
+const podfile_1 = require("./podfile");
+Object.defineProperty(exports, "withIosWithoutAdIdSupport", { enumerable: true, get: function () { return podfile_1.withIosWithoutAdIdSupport; } });
+Object.defineProperty(exports, "withIosGoogleAppMeasurementOnDeviceConversion", { enumerable: true, get: function () { return podfile_1.withIosGoogleAppMeasurementOnDeviceConversion; } });

package/plugin/build/ios/podfile.d.ts

@@ -0,0 +1,6 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+import { PluginConfigType } from '../pluginConfig';
+export declare function setAnalyticsPodfileWithoutAdIdSupport(src: string, enabled?: boolean): string;
+export declare function setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion(src: string, enabled?: boolean): string;
+export declare const withIosGoogleAppMeasurementOnDeviceConversion: ConfigPlugin<PluginConfigType>;
+export declare const withIosWithoutAdIdSupport: ConfigPlugin<PluginConfigType>;

package/plugin/build/ios/podfile.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withIosWithoutAdIdSupport = exports.withIosGoogleAppMeasurementOnDeviceConversion = void 0;
+exports.setAnalyticsPodfileWithoutAdIdSupport = setAnalyticsPodfileWithoutAdIdSupport;
+exports.setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion = setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion;
+const config_plugins_1 = require("@expo/config-plugins");
+const generateCode_1 = require("@expo/config-plugins/build/utils/generateCode");
+const TAG = '@react-native-firebase/analytics-withoutAdIdSupport';
+const ANCHOR = /prepare_react_native_project!/;
+const FLAG = '$RNFirebaseAnalyticsWithoutAdIdSupport = true';
+const TAG_ODM = '@react-native-firebase/analytics-googleAppMeasurementOnDeviceConversion';
+const FLAG_ODM = '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true';
+function setAnalyticsPodfileFlag(src, tag, flag, enabled = false) {
+    if (!enabled) {
+        return (0, generateCode_1.removeGeneratedContents)(src, tag) ?? src;
+    }
+    return (0, generateCode_1.mergeContents)({
+        src,
+        newSrc: flag,
+        tag,
+        anchor: ANCHOR,
+        offset: 1,
+        comment: '#',
+    }).contents;
+}
+function setAnalyticsPodfileWithoutAdIdSupport(src, enabled = false) {
+    return setAnalyticsPodfileFlag(src, TAG, FLAG, enabled);
+}
+function setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion(src, enabled = false) {
+    return setAnalyticsPodfileFlag(src, TAG_ODM, FLAG_ODM, enabled);
+}
+const withIosGoogleAppMeasurementOnDeviceConversion = (config, props) => {
+    return (0, config_plugins_1.withPodfile)(config, config => {
+        config.modResults.contents = setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion(config.modResults.contents, props?.ios?.googleAppMeasurementOnDeviceConversion === true);
+        return config;
+    });
+};
+exports.withIosGoogleAppMeasurementOnDeviceConversion = withIosGoogleAppMeasurementOnDeviceConversion;
+const withIosWithoutAdIdSupport = (config, props) => {
+    return (0, config_plugins_1.withPodfile)(config, config => {
+        config.modResults.contents = setAnalyticsPodfileWithoutAdIdSupport(config.modResults.contents, props?.ios?.withoutAdIdSupport === true);
+        return config;
+    });
+};
+exports.withIosWithoutAdIdSupport = withIosWithoutAdIdSupport;

package/plugin/build/pluginConfig.d.ts

@@ -0,0 +1,10 @@
+export interface PluginConfigType {
+    ios?: PluginConfigTypeIos;
+}
+export interface PluginConfigTypeIos {
+    withoutAdIdSupport?: boolean;
+    /**
+     * @platform ios iOS
+     */
+    googleAppMeasurementOnDeviceConversion?: boolean;
+}

package/plugin/build/pluginConfig.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/plugin/src/index.ts

@@ -0,0 +1,18 @@
+import { ConfigPlugin, withPlugins, createRunOncePlugin } from '@expo/config-plugins';
+
+import { withIosWithoutAdIdSupport, withIosGoogleAppMeasurementOnDeviceConversion } from './ios';
+import { PluginConfigType } from './pluginConfig';
+
+/**
+ * A config plugin for configuring `@react-native-firebase/analytics`
+ */
+const withRnFirebaseAnalytics: ConfigPlugin<PluginConfigType> = (config, props) => {
+  return withPlugins(config, [
+    // iOS
+    [withIosWithoutAdIdSupport, props],
+    [withIosGoogleAppMeasurementOnDeviceConversion, props],
+  ]);
+};
+
+const pak = require('../../package.json');
+export default createRunOncePlugin(withRnFirebaseAnalytics, pak.name, pak.version);

package/plugin/src/ios/index.ts

@@ -0,0 +1,6 @@
+import {
+  withIosWithoutAdIdSupport,
+  withIosGoogleAppMeasurementOnDeviceConversion,
+} from './podfile';
+
+export { withIosWithoutAdIdSupport, withIosGoogleAppMeasurementOnDeviceConversion };

package/plugin/src/ios/podfile.ts

@@ -0,0 +1,72 @@
+import { ConfigPlugin, withPodfile } from '@expo/config-plugins';
+import {
+  mergeContents,
+  removeGeneratedContents,
+} from '@expo/config-plugins/build/utils/generateCode';
+
+import { PluginConfigType } from '../pluginConfig';
+
+const TAG = '@react-native-firebase/analytics-withoutAdIdSupport';
+const ANCHOR = /prepare_react_native_project!/;
+const FLAG = '$RNFirebaseAnalyticsWithoutAdIdSupport = true';
+const TAG_ODM = '@react-native-firebase/analytics-googleAppMeasurementOnDeviceConversion';
+const FLAG_ODM = '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true';
+
+function setAnalyticsPodfileFlag(
+  src: string,
+  tag: string,
+  flag: string,
+  enabled: boolean = false,
+): string {
+  if (!enabled) {
+    return removeGeneratedContents(src, tag) ?? src;
+  }
+
+  return mergeContents({
+    src,
+    newSrc: flag,
+    tag,
+    anchor: ANCHOR,
+    offset: 1,
+    comment: '#',
+  }).contents;
+}
+
+export function setAnalyticsPodfileWithoutAdIdSupport(
+  src: string,
+  enabled: boolean = false,
+): string {
+  return setAnalyticsPodfileFlag(src, TAG, FLAG, enabled);
+}
+
+export function setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion(
+  src: string,
+  enabled: boolean = false,
+): string {
+  return setAnalyticsPodfileFlag(src, TAG_ODM, FLAG_ODM, enabled);
+}
+
+export const withIosGoogleAppMeasurementOnDeviceConversion: ConfigPlugin<PluginConfigType> = (
+  config,
+  props,
+) => {
+  return withPodfile(config, config => {
+    config.modResults.contents = setAnalyticsPodfileGoogleAppMeasurementOnDeviceConversion(
+      config.modResults.contents,
+      props?.ios?.googleAppMeasurementOnDeviceConversion === true,
+    );
+
+    return config;
+  });
+};
+
+export const withIosWithoutAdIdSupport: ConfigPlugin<PluginConfigType> = (config, props) => {
+  return withPodfile(config, config => {
+    config.modResults.contents = setAnalyticsPodfileWithoutAdIdSupport(
+      config.modResults.contents,
+      props?.ios?.withoutAdIdSupport === true,
+    );
+
+    return config;
+  });
+};

package/plugin/src/pluginConfig.ts

@@ -0,0 +1,11 @@
+export interface PluginConfigType {
+  ios?: PluginConfigTypeIos;
+}
+
+export interface PluginConfigTypeIos {
+  withoutAdIdSupport?: boolean;
+  /**
+   * @platform ios iOS
+   */
+  googleAppMeasurementOnDeviceConversion?: boolean;
+}

package/plugin/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@tsconfig/node-lts/tsconfig",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["./src"]
+}

package/plugin/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/index.ts","./src/pluginConfig.ts","./src/ios/index.ts","./src/ios/podfile.ts"],"version":"5.9.3"}

package/typedoc.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/modular.ts", "lib/types/analytics.ts"],
+  "tsconfig": "tsconfig.json",
+  "intentionallyNotExported": [
+    "_AddPaymentInfoEventParameters",
+    "_AddShippingInfoEventParameters",
+    "_AddShippingInfoParameters",
+    "_AddToCartEventParameters",
+    "_AddToWishlistEventParameters",
+    "_AnalyticsCallOptions",
+    "_AnalyticsSettings",
+    "_BeginCheckoutEventParameters",
+    "_CampaignDetailsEventParameters",
+    "_ConsentSettings",
+    "_EarnVirtualCurrencyEventParameters",
+    "_EventParams",
+    "_GenerateLeadEventParameters",
+    "_GtagConfigParams",
+    "_Item",
+    "_JoinGroupEventParameters",
+    "_LevelEndEventParameters",
+    "_LevelStartEventParameters",
+    "_LevelUpEventParameters",
+    "_LoginEventParameters",
+    "_PostScoreEventParameters",
+    "_PurchaseEventParameters",
+    "_RefundEventParameters",
+    "_RemoveFromCartEventParameters",
+    "_ScreenViewParameters",
+    "_SearchEventParameters",
+    "_SelectContentEventParameters",
+    "_SelectItemEventParameters",
+    "_SelectPromotionEventParameters",
+    "_SetCheckoutOptionEventParameters",
+    "_SettingsOptions",
+    "_ShareEventParameters",
+    "_SignUpEventParameters",
+    "_SpendVirtualCurrencyEventParameters",
+    "_Statics",
+    "_UnlockAchievementEventParameters",
+    "_ViewCartEventParameters",
+    "_ViewItemEventParameters",
+    "_ViewItemListEventParameters",
+    "_ViewPromotionEventParameters",
+    "_ViewSearchResultsParameters"
+  ]
+}