@react-native-firebase/analytics 23.7.0 → 23.8.1

package/lib/{index.js → namespaced.ts}

@@ -14,7 +14,6 @@
  * limitations under the License.
  *
  */
-
 import {
   isAlphaNumericUnderscore,
   isE164PhoneNumber,
@@ -27,20 +26,62 @@ import {
   isUndefined,
 } from '@react-native-firebase/app/lib/common';
 
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
+
 import {
   createModuleNamespace,
   FirebaseModule,
   getFirebaseRoot,
 } from '@react-native-firebase/app/lib/internal';
+
+// Internal types are now available through module declarations in app package
 import { setReactNativeModule } from '@react-native-firebase/app/lib/internal/nativeModule';
 import { isBoolean } from '@react-native-firebase/app/lib/common';
 
 import { validateStruct, validateCompound } from './struct';
-import fallBackModule from './web/RNFBAnalyticsModule';
-import version from './version';
+import { RNFBAnalyticsModule } from './web/RNFBAnalyticsModule';
+import { version } from './version';
 import * as structs from './structs';
-
-const ReservedEventNames = [
+import {
+  type Statics,
+  type AnalyticsCallOptions,
+  type ConsentSettings,
+  type AddPaymentInfoEventParameters,
+  type ScreenViewParameters,
+  type AddShippingInfoParameters,
+  type AddToCartEventParameters,
+  type AddToWishlistEventParameters,
+  type BeginCheckoutEventParameters,
+  type CampaignDetailsEventParameters,
+  type EarnVirtualCurrencyEventParameters,
+  type GenerateLeadEventParameters,
+  type JoinGroupEventParameters,
+  type LevelEndEventParameters,
+  type LevelStartEventParameters,
+  type LevelUpEventParameters,
+  type LoginEventParameters,
+  type PostScoreEventParameters,
+  type SelectContentEventParameters,
+  type PurchaseEventParameters,
+  type RefundEventParameters,
+  type RemoveFromCartEventParameters,
+  type SearchEventParameters,
+  type SelectItemEventParameters,
+  type SetCheckoutOptionEventParameters,
+  type SelectPromotionEventParameters,
+  type ShareEventParameters,
+  type SignUpEventParameters,
+  type SpendVirtualCurrencyEventParameters,
+  type UnlockAchievementEventParameters,
+  type ViewCartEventParameters,
+  type ViewItemEventParameters,
+  type ViewItemListEventParameters,
+  type ViewPromotionEventParameters,
+  type ViewSearchResultsParameters,
+  type Analytics,
+} from './types/analytics';
+
+const ReservedEventNames: readonly string[] = [
   'ad_activeview',
   'ad_click',
   'ad_exposure',
@@ -73,16 +114,20 @@ const ReservedEventNames = [
   'session_start',
   'session_start_with_rollout',
   'user_engagement',
-];
+] as const;
 
-const statics = {};
+const statics: Partial<Statics> = {};
 
 const namespace = 'analytics';
 
 const nativeModuleName = 'RNFBAnalyticsModule';
 
 class FirebaseAnalyticsModule extends FirebaseModule {
-  logEvent(name, params = {}, options = {}) {
+  logEvent(
+    name: string,
+    params: { [key: string]: any } = {},
+    options: AnalyticsCallOptions = { global: false },
+  ): Promise<void> {
     if (!isString(name)) {
       throw new Error("firebase.analytics().logEvent(*) 'name' expected a string value.");
     }
@@ -92,7 +137,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     }
 
     // check name is not a reserved event name
-    if (isOneOf(name, ReservedEventNames)) {
+    if (isOneOf(name, ReservedEventNames as any[])) {
       throw new Error(
         `firebase.analytics().logEvent(*) 'name' the event name '${name}' is reserved and can not be used.`,
       );
@@ -120,7 +165,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.logEvent(name, params);
   }
 
-  setAnalyticsCollectionEnabled(enabled) {
+  setAnalyticsCollectionEnabled(enabled: boolean): Promise<void> {
     if (!isBoolean(enabled)) {
       throw new Error(
         "firebase.analytics().setAnalyticsCollectionEnabled(*) 'enabled' expected a boolean value.",
@@ -130,7 +175,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setAnalyticsCollectionEnabled(enabled);
   }
 
-  setSessionTimeoutDuration(milliseconds = 1800000) {
+  setSessionTimeoutDuration(milliseconds: number = 1800000): Promise<void> {
     if (!isNumber(milliseconds)) {
       throw new Error(
         "firebase.analytics().setSessionTimeoutDuration(*) 'milliseconds' expected a number value.",
@@ -146,15 +191,15 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setSessionTimeoutDuration(milliseconds);
   }
 
-  getAppInstanceId() {
+  getAppInstanceId(): Promise<string | null> {
     return this.native.getAppInstanceId();
   }
 
-  getSessionId() {
+  getSessionId(): Promise<number | null> {
     return this.native.getSessionId();
   }
 
-  setUserId(id) {
+  setUserId(id: string | null): Promise<void> {
     if (!isNull(id) && !isString(id)) {
       throw new Error("firebase.analytics().setUserId(*) 'id' expected a string value.");
     }
@@ -162,7 +207,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setUserId(id);
   }
 
-  setUserProperty(name, value) {
+  setUserProperty(name: string, value: string | null): Promise<void> {
     if (!isString(name)) {
       throw new Error("firebase.analytics().setUserProperty(*) 'name' expected a string value.");
     }
@@ -176,7 +221,10 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setUserProperty(name, value);
   }
 
-  setUserProperties(properties, options = {}) {
+  setUserProperties(
+    properties: { [key: string]: string | null },
+    options: AnalyticsCallOptions = { global: false },
+  ): Promise<void> {
     if (!isObject(properties)) {
       throw new Error(
         "firebase.analytics().setUserProperties(*) 'properties' expected an object of key/value pairs.",
@@ -197,7 +245,9 @@ class FirebaseAnalyticsModule extends FirebaseModule {
 
     const entries = Object.entries(properties);
     for (let i = 0; i < entries.length; i++) {
-      const [key, value] = entries[i];
+      const entry = entries[i];
+      if (!entry) continue;
+      const [key, value] = entry;
       if (!isNull(value) && !isString(value)) {
         throw new Error(
           `firebase.analytics().setUserProperties(*) 'properties' value for parameter '${key}' is invalid, expected a string.`,
@@ -208,11 +258,11 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setUserProperties(properties);
   }
 
-  resetAnalyticsData() {
+  resetAnalyticsData(): Promise<void> {
     return this.native.resetAnalyticsData();
   }
 
-  setConsent(consentSettings) {
+  setConsent(consentSettings: ConsentSettings): Promise<void> {
     if (!isObject(consentSettings)) {
       throw new Error(
         'firebase.analytics().setConsent(*): The supplied arg must be an object of key/values.',
@@ -221,7 +271,9 @@ class FirebaseAnalyticsModule extends FirebaseModule {
 
     const entries = Object.entries(consentSettings);
     for (let i = 0; i < entries.length; i++) {
-      const [key, value] = entries[i];
+      const entry = entries[i];
+      if (!entry) continue;
+      const [key, value] = entry;
       if (!isBoolean(value)) {
         throw new Error(
           `firebase.analytics().setConsent(*) 'consentSettings' value for parameter '${key}' is invalid, expected a boolean.`,
@@ -235,7 +287,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
   /** -------------------
    *        EVENTS
    * -------------------- */
-  logAddPaymentInfo(object = {}) {
+  logAddPaymentInfo(object: AddPaymentInfoEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logAddPaymentInfo(*): The supplied arg must be an object of key/values.',
@@ -250,7 +302,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logScreenView(object) {
+  logScreenView(object: ScreenViewParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logScreenView(*): The supplied arg must be an object of key/values.',
@@ -263,7 +315,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logAddShippingInfo(object = {}) {
+  logAddShippingInfo(object: AddShippingInfoParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logAddShippingInfo(*): The supplied arg must be an object of key/values.',
@@ -282,7 +334,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logAddToCart(object = {}) {
+  logAddToCart(object: AddToCartEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logAddToCart(*): The supplied arg must be an object of key/values.',
@@ -297,7 +349,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logAddToWishlist(object = {}) {
+  logAddToWishlist(object: AddToWishlistEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logAddToWishlist(*): The supplied arg must be an object of key/values.',
@@ -312,11 +364,11 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logAppOpen() {
+  logAppOpen(): Promise<void> {
     return this.logEvent('app_open');
   }
 
-  logBeginCheckout(object = {}) {
+  logBeginCheckout(object: BeginCheckoutEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logBeginCheckout(*): The supplied arg must be an object of key/values.',
@@ -331,7 +383,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logCampaignDetails(object) {
+  logCampaignDetails(object: CampaignDetailsEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logCampaignDetails(*): The supplied arg must be an object of key/values.',
@@ -348,7 +400,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logEarnVirtualCurrency(object) {
+  logEarnVirtualCurrency(object: EarnVirtualCurrencyEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logEarnVirtualCurrency(*): The supplied arg must be an object of key/values.',
@@ -365,7 +417,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logGenerateLead(object = {}) {
+  logGenerateLead(object: GenerateLeadEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logGenerateLead(*): The supplied arg must be an object of key/values.',
@@ -380,7 +432,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logJoinGroup(object) {
+  logJoinGroup(object: JoinGroupEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logJoinGroup(*): The supplied arg must be an object of key/values.',
@@ -393,7 +445,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logLevelEnd(object) {
+  logLevelEnd(object: LevelEndEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logLevelEnd(*): The supplied arg must be an object of key/values.',
@@ -406,7 +458,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logLevelStart(object) {
+  logLevelStart(object: LevelStartEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logLevelStart(*): The supplied arg must be an object of key/values.',
@@ -419,7 +471,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logLevelUp(object) {
+  logLevelUp(object: LevelUpEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logLevelUp(*): The supplied arg must be an object of key/values.',
@@ -432,7 +484,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logLogin(object) {
+  logLogin(object: LoginEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logLogin(*): The supplied arg must be an object of key/values.',
@@ -445,7 +497,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logPostScore(object) {
+  logPostScore(object: PostScoreEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logPostScore(*): The supplied arg must be an object of key/values.',
@@ -458,7 +510,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSelectContent(object) {
+  logSelectContent(object: SelectContentEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSelectContent(*): The supplied arg must be an object of key/values.',
@@ -471,7 +523,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logPurchase(object = {}) {
+  logPurchase(object: PurchaseEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logPurchase(*): The supplied arg must be an object of key/values.',
@@ -486,7 +538,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logRefund(object = {}) {
+  logRefund(object: RefundEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logRefund(*): The supplied arg must be an object of key/values.',
@@ -501,7 +553,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logRemoveFromCart(object = {}) {
+  logRemoveFromCart(object: RemoveFromCartEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logRemoveFromCart(*): The supplied arg must be an object of key/values.',
@@ -516,7 +568,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSearch(object) {
+  logSearch(object: SearchEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSearch(*): The supplied arg must be an object of key/values.',
@@ -529,7 +581,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSelectItem(object = {}) {
+  logSelectItem(object: SelectItemEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSelectItem(*): The supplied arg must be an object of key/values.',
@@ -542,7 +594,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSetCheckoutOption(object) {
+  logSetCheckoutOption(object: SetCheckoutOptionEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSetCheckoutOption(*): The supplied arg must be an object of key/values.',
@@ -559,7 +611,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSelectPromotion(object) {
+  logSelectPromotion(object: SelectPromotionEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSelectPromotion(*): The supplied arg must be an object of key/values.',
@@ -576,7 +628,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logShare(object) {
+  logShare(object: ShareEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logShare(*): The supplied arg must be an object of key/values.',
@@ -589,7 +641,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSignUp(object) {
+  logSignUp(object: SignUpEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSignUp(*): The supplied arg must be an object of key/values.',
@@ -602,7 +654,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logSpendVirtualCurrency(object) {
+  logSpendVirtualCurrency(object: SpendVirtualCurrencyEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logSpendVirtualCurrency(*): The supplied arg must be an object of key/values.',
@@ -619,15 +671,15 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logTutorialBegin() {
+  logTutorialBegin(): Promise<void> {
     return this.logEvent('tutorial_begin');
   }
 
-  logTutorialComplete() {
+  logTutorialComplete(): Promise<void> {
     return this.logEvent('tutorial_complete');
   }
 
-  logUnlockAchievement(object) {
+  logUnlockAchievement(object: UnlockAchievementEventParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logUnlockAchievement(*): The supplied arg must be an object of key/values.',
@@ -644,7 +696,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logViewCart(object = {}) {
+  logViewCart(object: ViewCartEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logViewCart(*): The supplied arg must be an object of key/values.',
@@ -659,7 +711,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logViewItem(object = {}) {
+  logViewItem(object: ViewItemEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logViewItem(*): The supplied arg must be an object of key/values.',
@@ -673,7 +725,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logViewItemList(object = {}) {
+  logViewItemList(object: ViewItemListEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logViewItemList(*): The supplied arg must be an object of key/values.',
@@ -686,7 +738,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  logViewPromotion(object = {}) {
+  logViewPromotion(object: ViewPromotionEventParameters = {}): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logViewPromotion(*): The supplied arg must be an object of key/values.',
@@ -702,7 +754,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
    * Unsupported in "Enhanced Ecommerce reports":
    * https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event#public-static-final-string-view_search_results
    */
-  logViewSearchResults(object) {
+  logViewSearchResults(object: ViewSearchResultsParameters): Promise<void> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.analytics().logViewSearchResults(*): The supplied arg must be an object of key/values.',
@@ -719,7 +771,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  setDefaultEventParameters(params) {
+  setDefaultEventParameters(params?: { [key: string]: any }): Promise<void> {
     if (!isObject(params) && !isNull(params) && !isUndefined(params)) {
       throw new Error(
         "firebase.analytics().setDefaultEventParameters(*) 'params' expected an object value when it is defined.",
@@ -729,7 +781,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     return this.native.setDefaultEventParameters(params);
   }
 
-  initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress) {
+  initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress: string): Promise<void> {
     if (!isString(emailAddress)) {
       throw new Error(
         "firebase.analytics().initiateOnDeviceConversionMeasurementWithEmailAddress(*) 'emailAddress' expected a string value.",
@@ -737,13 +789,15 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     }
 
     if (!isIOS) {
-      return;
+      return Promise.resolve();
     }
 
     return this.native.initiateOnDeviceConversionMeasurementWithEmailAddress(emailAddress);
   }
 
-  initiateOnDeviceConversionMeasurementWithHashedEmailAddress(hashedEmailAddress) {
+  initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
+    hashedEmailAddress: string,
+  ): Promise<void> {
     if (!isString(hashedEmailAddress)) {
       throw new Error(
         "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedEmailAddress(*) 'hashedEmailAddress' expected a string value.",
@@ -751,7 +805,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     }
 
     if (!isIOS) {
-      return;
+      return Promise.resolve();
     }
 
     return this.native.initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
@@ -759,7 +813,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     );
   }
 
-  initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber) {
+  initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber: string): Promise<void> {
     if (!isE164PhoneNumber(phoneNumber)) {
       throw new Error(
         "firebase.analytics().initiateOnDeviceConversionMeasurementWithPhoneNumber(*) 'phoneNumber' expected a string value in E.164 format.",
@@ -767,13 +821,15 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     }
 
     if (!isIOS) {
-      return;
+      return Promise.resolve();
     }
 
     return this.native.initiateOnDeviceConversionMeasurementWithPhoneNumber(phoneNumber);
   }
 
-  initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(hashedPhoneNumber) {
+  initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
+    hashedPhoneNumber: string,
+  ): Promise<void> {
     if (isE164PhoneNumber(hashedPhoneNumber)) {
       throw new Error(
         "firebase.analytics().initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(*) 'hashedPhoneNumber' expected a sha256-hashed value of a phone number in E.164 format.",
@@ -787,7 +843,7 @@ class FirebaseAnalyticsModule extends FirebaseModule {
     }
 
     if (!isIOS) {
-      return;
+      return Promise.resolve();
     }
 
     return this.native.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
@@ -797,11 +853,16 @@ class FirebaseAnalyticsModule extends FirebaseModule {
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/analytics';
-export const SDK_VERSION = version;
+export const SDK_VERSION: string = version;
 
 // import analytics from '@react-native-firebase/analytics';
 // analytics().logEvent(...);
-export default createModuleNamespace({
+
+// import analytics, { firebase } from '@react-native-firebase/analytics';
+// analytics().logEvent(...);
+// firebase.analytics().logEvent(...);
+
+const analyticsNamespace = createModuleNamespace({
   statics,
   version,
   namespace,
@@ -812,12 +873,24 @@ export default createModuleNamespace({
   ModuleClass: FirebaseAnalyticsModule,
 });
 
-export * from './modular/index';
+type AnalyticsNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
+  Analytics,
+  Statics
+> & {
+  analytics: ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<Analytics, Statics>;
+  firebase: ReactNativeFirebase.Module;
+  app(name?: string): ReactNativeFirebase.FirebaseApp;
+};
 
-// import analytics, { firebase } from '@react-native-firebase/analytics';
-// analytics().logEvent(...);
-// firebase.analytics().logEvent(...);
-export const firebase = getFirebaseRoot();
+export default analyticsNamespace as unknown as AnalyticsNamespace;
 
 // Register the interop module for non-native platforms.
-setReactNativeModule(nativeModuleName, fallBackModule);
+setReactNativeModule(nativeModuleName, RNFBAnalyticsModule as unknown as Record<string, unknown>);
+
+export const firebase =
+  getFirebaseRoot() as unknown as ReactNativeFirebase.FirebaseNamespacedExport<
+    'analytics',
+    Analytics,
+    Statics,
+    false
+  >;

package/lib/struct.ts

@@ -0,0 +1,61 @@
+/*
+ *  Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this library except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+import { isUndefined } from '@react-native-firebase/app/lib/common/validate';
+import { create, StructError } from 'superstruct';
+
+export const validateStruct = (
+  value: Record<string, any> = {},
+  struct: any,
+  prefix = '',
+): Record<string, any> => {
+  // skip superstruct create in release for performance reasons
+  if (!__DEV__) {
+    return value;
+  }
+  try {
+    return create(value, struct) as Record<string, any>;
+  } catch (e) {
+    const { path, message } = e as StructError;
+
+    const key = path[0];
+
+    if (message === undefined) {
+      throw new Error(`${prefix} unknown property '${key}'.`);
+    }
+    (e as StructError).message = `${prefix} ${message}`;
+
+    throw e;
+  }
+};
+
+export const validateCompound = (
+  source: Record<string, any> = {},
+  a: string,
+  b: string,
+  prefix = '',
+): void => {
+  const sourceA = source[a];
+  const sourceB = source[b];
+  if (
+    (isUndefined(sourceA) && !isUndefined(sourceB)) ||
+    (!isUndefined(sourceA) && isUndefined(sourceB))
+  ) {
+    throw new Error(
+      `${prefix} if you supply the '${a}' parameter, you must also supply the '${b}' parameter.`,
+    );
+  }
+};

package/lib/{structs.js → structs.ts}

@@ -187,9 +187,9 @@ export const SelectPromotion = object({
   promotion_name: string(),
 });
 
-export const SetCheckoutOption = object({
-  checkout_step: number(),
-  checkout_option: string(),
+export const SetCheckoutOption = type({
+  checkout_step: optional(number()),
+  checkout_option: optional(string()),
 });
 
 export const Share = object({