react-native-applovin-max 8.2.0 → 9.1.0

package/src/AdView.tsx

@@ -1,76 +1,47 @@
 import * as React from 'react';
 import { useEffect, useState, useRef, useCallback, useImperativeHandle, useReducer, forwardRef } from 'react';
-import { NativeModules, requireNativeComponent, StyleSheet, UIManager, findNodeHandle, useWindowDimensions, View } from 'react-native';
-import type { ViewProps, ViewStyle, StyleProp, NativeMethods, DimensionValue } from 'react-native';
-import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo } from './types/AdInfo';
-import type { AdNativeEvent } from './types/AdEvent';
-import type { AdViewProps, AdViewHandler, NativeUIComponentAdViewOptions, AdViewId } from './types/AdViewProps';
+import { StyleSheet, useWindowDimensions, View } from 'react-native';
+import type { NativeSyntheticEvent, ViewProps, ViewStyle, StyleProp, DimensionValue } from 'react-native';
+import AppLovinMAX from './specs/NativeAppLovinMAXModule';
+import AdViewComponent, { Commands } from './specs/AppLovinMAXAdViewNativeComponent';
+import type { AdInfoEvent, AdLoadFailedEvent, AdDisplayFailedEvent } from './specs/AppLovinMAXAdViewNativeComponent';
 import { addEventListener, removeEventListener } from './EventEmitter';
+import type { AdInfo, AdLoadFailedInfo } from './types/AdInfo';
+import type { AdViewProps, AdViewHandler, NativeUIComponentAdViewOptions, AdViewId } from './types/AdViewProps';
+import { makeExtraParametersArray, makeLocalExtraParametersArray } from './Utils';
 
-const { AppLovinMAX } = NativeModules;
-
-const {
-    BANNER_AD_FORMAT_LABEL,
-    MREC_AD_FORMAT_LABEL,
-
-    TOP_CENTER_POSITION,
-    TOP_LEFT_POSITION,
-    TOP_RIGHT_POSITION,
-    CENTERED_POSITION,
-    CENTER_LEFT_POSITION,
-    CENTER_RIGHT_POSITION,
-    BOTTOM_LEFT_POSITION,
-    BOTTOM_CENTER_POSITION,
-    BOTTOM_RIGHT_POSITION,
-
-    ON_NATIVE_UI_COMPONENT_ADVIEW_AD_LOADED_EVENT,
-    ON_NATIVE_UI_COMPONENT_ADVIEW_AD_LOAD_FAILED_EVENT,
-} = AppLovinMAX.getConstants();
+const { ON_NATIVE_UI_COMPONENT_ADVIEW_AD_LOADED_EVENT, ON_NATIVE_UI_COMPONENT_ADVIEW_AD_LOAD_FAILED_EVENT } = AppLovinMAX.getConstants();
 
 /**
- * Defines a format of an ad.
+ * Defines the format of an ad.
  */
 export enum AdFormat {
     /**
      * Banner ad.
      */
-    BANNER = BANNER_AD_FORMAT_LABEL,
+    BANNER = 'BANNER',
 
     /**
      * MREC ad.
      */
-    MREC = MREC_AD_FORMAT_LABEL,
+    MREC = 'MREC',
 }
 
 /**
- * Defines a position of a banner or MREC ad.
+ * Defines the position for rendering a banner or MREC ad within its container.
  */
 export enum AdViewPosition {
-    TOP_CENTER = TOP_CENTER_POSITION,
-    TOP_LEFT = TOP_LEFT_POSITION,
-    TOP_RIGHT = TOP_RIGHT_POSITION,
-    CENTERED = CENTERED_POSITION,
-    CENTER_LEFT = CENTER_LEFT_POSITION,
-    CENTER_RIGHT = CENTER_RIGHT_POSITION,
-    BOTTOM_LEFT = BOTTOM_LEFT_POSITION,
-    BOTTOM_CENTER = BOTTOM_CENTER_POSITION,
-    BOTTOM_RIGHT = BOTTOM_RIGHT_POSITION,
+    TOP_CENTER = 'top_center',
+    TOP_LEFT = 'top_left',
+    TOP_RIGHT = 'top_right',
+    CENTERED = 'centered',
+    CENTER_LEFT = 'center_left',
+    CENTER_RIGHT = 'center_right',
+    BOTTOM_LEFT = 'bottom_left',
+    BOTTOM_CENTER = 'bottom_center',
+    BOTTOM_RIGHT = 'bottom_right',
 }
 
-type AdViewNativeEvents = {
-    onAdLoadedEvent(event: AdNativeEvent<AdInfo>): void;
-    onAdLoadFailedEvent(event: AdNativeEvent<AdLoadFailedInfo>): void;
-    onAdDisplayFailedEvent(event: AdNativeEvent<AdDisplayFailedInfo>): void;
-    onAdClickedEvent(event: AdNativeEvent<AdInfo>): void;
-    onAdExpandedEvent(event: AdNativeEvent<AdInfo>): void;
-    onAdCollapsedEvent(event: AdNativeEvent<AdInfo>): void;
-    onAdRevenuePaidEvent(event: AdNativeEvent<AdInfo>): void;
-};
-
-const AdViewComponent = requireNativeComponent<AdViewProps & ViewProps & AdViewNativeEvents>('AppLovinMAXAdView');
-
-type AdViewType = React.Component<AdViewProps> & NativeMethods;
-
 type SizeKey = 'width' | 'height';
 type SizeRecord = Partial<Record<SizeKey, DimensionValue>>;
 
@@ -80,61 +51,53 @@ const ADVIEW_SIZE = {
     mrec: { width: 300, height: 250 },
 };
 
-// Returns 'auto' for unspecified width / height
+// Extracts width and height from the style prop, defaulting to 'auto' when unspecified.
 const getOutlineViewSize = (style: StyleProp<ViewStyle>): [DimensionValue, DimensionValue] => {
     const viewStyle = StyleSheet.flatten(style) || {};
     return [viewStyle.width ?? 'auto', viewStyle.height ?? 'auto'];
 };
 
-const sizeBannerDimensions = async (sizeProps: SizeRecord, adaptiveBannerEnabled: boolean, screenWidth: number, bannerFormatSize: SizeRecord): Promise<SizeRecord> => {
-    const width = sizeProps.width === 'auto' ? screenWidth : sizeProps.width;
-
-    let height;
-    if (sizeProps.height === 'auto') {
-        if (adaptiveBannerEnabled) {
-            try {
-                height = await AppLovinMAX.getAdaptiveBannerHeightForWidth(screenWidth);
-            } catch (error) {
-                console.error('Error getting adaptive banner height:', error);
-                height = bannerFormatSize.height;
-            }
-        } else {
-            height = bannerFormatSize.height;
-        }
-    } else {
-        height = sizeProps.height;
-    }
-
-    return { width, height };
+const handleAdViewEvent = <T extends AdInfoEvent | AdLoadFailedEvent | AdDisplayFailedEvent>(event: NativeSyntheticEvent<T>, callback?: (adInfo: T) => void) => {
+    if (!callback) return;
+    callback(event.nativeEvent);
 };
 
 /**
- * The {@link AdView} component renders banner or MREC ads with responsive sizing.
- * - **Banners**: 320x50 on phones, 728x90 on tablets.
- * - **MRECs**: 300x250 on all devices.
+ * Renders a banner or MREC ad using a native view, with adaptive or responsive sizing.
+ *
+ * - **Banners**: 320×50 on phones, 728×90 on tablets.
+ * - **MRECs**: Fixed size of 300×250 on all devices.
+ *
+ * Internally uses {@link AppLovinMAX.isTablet()} to determine banner size on tablets.
+ * You can also use this method externally to assist with layout decisions.
  *
- * Use {@link AppLovinMAX.isTablet()} to determine device type for layout adjustments.
- * For adaptive banners, use {@link BannerAd.getAdaptiveHeightForWidth()} for precise sizing.
+ * For adaptive banners, use {@link BannerAd.getAdaptiveHeightForWidth()} to determine the appropriate height.
  *
  * **Preloading**:
- * When preloading an {@link AdView} using {@link preloadNativeUIComponentAdView},
- * the returned {@link AdViewId} must be passed to identify the preloaded instance.
+ * If you preload an ad for AdView using {@link preloadNativeUIComponentAdView},
+ * pass the returned {@link AdViewId} to this component to display the preloaded instance.
+ *
+ * **Note:** The AppLovin SDK must be initialized before using this component.
  *
  * ### Example:
- * ```js
+ * ```tsx
  * <AdView
  *   adUnitId={adUnitId}
  *   adFormat={AdFormat.BANNER}
  *   placement="my_placement"
  *   customData="my_customData"
- *   extraParameters={{"key1":"value1", "key2":"value2"}}
- *   localExtraParameters={{"key1":123", "key2":object}}
+ *   extraParameters={{ key1: "value1", key2: "value2" }}
+ *   localExtraParameters={{ key1: "value1", key2: true }}
  *   adaptiveBannerEnabled={false}
  *   autoRefresh={false}
  *   style={styles.banner}
  *   onAdLoaded={(adInfo: AdInfo) => { ... }}
  * />
  * ```
+ *
+ * For complete implementation examples, see:
+ * - https://github.com/AppLovin/AppLovin-MAX-React-Native/blob/master/example/src/NativeBannerExample.tsx
+ * - https://github.com/AppLovin/AppLovin-MAX-React-Native/blob/master/example/src/NativeMRecExample.tsx
  */
 export const AdView = forwardRef<AdViewHandler, AdViewProps & ViewProps>(function AdView(
     {
@@ -163,43 +126,25 @@ export const AdView = forwardRef<AdViewHandler, AdViewProps & ViewProps>(functio
     const { width: screenWidth } = useWindowDimensions();
     const adFormatSize = useRef<SizeRecord>({});
     const [, forceUpdate] = useReducer((x) => x + 1, 0);
-    const adViewRef = useRef<AdViewType | null>(null);
+    const adViewRef = useRef<React.ElementRef<typeof AdViewComponent> | undefined>();
     const [isInitialized, setIsInitialized] = useState<boolean>(false);
-    const sizeProps = useRef<SizeRecord>({});
     const dimensions = useRef<SizeRecord>({});
 
     const loadAd = useCallback(() => {
-        if (adViewRef.current) {
-            UIManager.dispatchViewManagerCommand(
-                findNodeHandle(adViewRef.current),
-                // @ts-ignore: Issue in RN ts defs
-                UIManager.getViewManagerConfig('AppLovinMAXAdView').Commands.loadAd,
-                undefined
-            );
-        }
+        adViewRef.current && Commands.loadAd(adViewRef.current);
     }, []);
 
     useImperativeHandle(ref, () => ({ loadAd }), [loadAd]);
 
-    const saveElement = useCallback((element: AdViewType | null) => {
-        adViewRef.current = element;
-    }, []);
-
     useEffect(() => {
         (async () => {
-            if (adFormat === AdFormat.BANNER) {
-                const isTablet = await AppLovinMAX.isTablet();
-                adFormatSize.current = isTablet
-                    ? { width: ADVIEW_SIZE.leader.width, height: ADVIEW_SIZE.leader.height }
-                    : { width: ADVIEW_SIZE.banner.width, height: ADVIEW_SIZE.banner.height };
-            } else {
-                adFormatSize.current = { width: ADVIEW_SIZE.mrec.width, height: ADVIEW_SIZE.mrec.height };
-            }
+            const isTablet = adFormat === AdFormat.BANNER ? await AppLovinMAX.isTablet() : false;
+            adFormatSize.current = adFormat === AdFormat.BANNER ? (isTablet ? ADVIEW_SIZE.leader : ADVIEW_SIZE.banner) : ADVIEW_SIZE.mrec;
 
             const initialized = await AppLovinMAX.isInitialized();
             setIsInitialized(initialized);
             if (!initialized) {
-                console.warn('AdView is mounted before the initialization of the AppLovin MAX React Native module');
+                console.warn('AdView was mounted before the AppLovin MAX React Native module was initialized.');
             }
         })();
     }, [adFormat]);
@@ -207,85 +152,55 @@ export const AdView = forwardRef<AdViewHandler, AdViewProps & ViewProps>(functio
     useEffect(() => {
         const [width, height] = getOutlineViewSize(style);
 
-        if (sizeProps.current.width === width && sizeProps.current.height === height) return;
-
-        sizeProps.current = { width, height };
+        if (dimensions.current.width === width && dimensions.current.height === height) return;
 
         (async () => {
-            if (adFormat === AdFormat.BANNER) {
-                const adaptedSize = await sizeBannerDimensions(sizeProps.current, adaptiveBannerEnabled, screenWidth, adFormatSize.current);
-
-                if (dimensions.current.width !== adaptedSize.width || dimensions.current.height !== adaptedSize.height) {
-                    dimensions.current = adaptedSize;
-                    forceUpdate();
+            const isBanner = adFormat === AdFormat.BANNER;
+            const isWidthAuto = width === 'auto';
+            const isHeightAuto = height === 'auto';
+
+            const resolvedWidth = isWidthAuto ? (isBanner ? screenWidth : adFormatSize.current.width) : width;
+
+            let resolvedHeight: DimensionValue | undefined = height;
+
+            if (isHeightAuto) {
+                if (isBanner && adaptiveBannerEnabled) {
+                    try {
+                        resolvedHeight = await AppLovinMAX.getAdaptiveBannerHeightForWidth(screenWidth);
+                    } catch (error) {
+                        console.error('Error getting adaptive banner height:', error);
+                        resolvedHeight = adFormatSize.current.height;
+                    }
+                } else {
+                    resolvedHeight = adFormatSize.current.height;
                 }
-            } else {
-                dimensions.current = {
-                    width: width === 'auto' ? adFormatSize.current.width : width,
-                    height: height === 'auto' ? adFormatSize.current.height : height,
-                };
+            }
+
+            const newSize = { width: resolvedWidth, height: resolvedHeight };
+
+            if (dimensions.current.width !== newSize.width || dimensions.current.height !== newSize.height) {
+                dimensions.current = newSize;
                 forceUpdate();
             }
         })();
     }, [adFormat, adaptiveBannerEnabled, isInitialized, screenWidth, style]);
 
-    const onAdLoadedEvent = useCallback(
-        (event: AdNativeEvent<AdInfo>) => {
-            onAdLoaded?.(event.nativeEvent);
-        },
-        [onAdLoaded]
-    );
-
-    const onAdLoadFailedEvent = useCallback(
-        (event: AdNativeEvent<AdLoadFailedInfo>) => {
-            onAdLoadFailed?.(event.nativeEvent);
-        },
-        [onAdLoadFailed]
-    );
-
-    const onAdDisplayFailedEvent = useCallback(
-        (event: AdNativeEvent<AdDisplayFailedInfo>) => {
-            onAdDisplayFailed?.(event.nativeEvent);
-        },
-        [onAdDisplayFailed]
-    );
-
-    const onAdClickedEvent = useCallback(
-        (event: AdNativeEvent<AdInfo>) => {
-            onAdClicked?.(event.nativeEvent);
-        },
-        [onAdClicked]
-    );
-
-    const onAdExpandedEvent = useCallback(
-        (event: AdNativeEvent<AdInfo>) => {
-            onAdExpanded?.(event.nativeEvent);
-        },
-        [onAdExpanded]
-    );
-
-    const onAdCollapsedEvent = useCallback(
-        (event: AdNativeEvent<AdInfo>) => {
-            onAdCollapsed?.(event.nativeEvent);
-        },
-        [onAdCollapsed]
-    );
-
-    const onAdRevenuePaidEvent = useCallback(
-        (event: AdNativeEvent<AdInfo>) => {
-            onAdRevenuePaid?.(event.nativeEvent);
-        },
-        [onAdRevenuePaid]
-    );
+    const onAdLoadedEvent = useCallback((event: NativeSyntheticEvent<AdInfoEvent>) => handleAdViewEvent(event, onAdLoaded), [onAdLoaded]);
+    const onAdLoadFailedEvent = useCallback((event: NativeSyntheticEvent<AdLoadFailedEvent>) => handleAdViewEvent(event, onAdLoadFailed), [onAdLoadFailed]);
+    const onAdDisplayFailedEvent = useCallback((event: NativeSyntheticEvent<AdDisplayFailedEvent>) => handleAdViewEvent(event, onAdDisplayFailed), [onAdDisplayFailed]);
+    const onAdClickedEvent = useCallback((event: NativeSyntheticEvent<AdInfoEvent>) => handleAdViewEvent(event, onAdClicked), [onAdClicked]);
+    const onAdExpandedEvent = useCallback((event: NativeSyntheticEvent<AdInfoEvent>) => handleAdViewEvent(event, onAdExpanded), [onAdExpanded]);
+    const onAdCollapsedEvent = useCallback((event: NativeSyntheticEvent<AdInfoEvent>) => handleAdViewEvent(event, onAdCollapsed), [onAdCollapsed]);
+    const onAdRevenuePaidEvent = useCallback((event: NativeSyntheticEvent<AdInfoEvent>) => handleAdViewEvent(event, onAdRevenuePaid), [onAdRevenuePaid]);
 
     if (!isInitialized || Object.keys(dimensions.current).length === 0) {
         // Early return if not initialized or dimensions are not set
-        return <View style={Object.assign({}, style, dimensions.current)} {...otherProps} />;
+        return <View style={style} {...otherProps} />;
     }
 
     return (
         <AdViewComponent
-            ref={saveElement}
+            ref={(element) => (adViewRef.current = element ?? undefined)}
             adUnitId={adUnitId}
             adFormat={adFormat}
             adViewId={adViewId || 0}
@@ -294,8 +209,9 @@ export const AdView = forwardRef<AdViewHandler, AdViewProps & ViewProps>(functio
             adaptiveBannerEnabled={adaptiveBannerEnabled}
             autoRefresh={autoRefresh}
             loadOnMount={loadOnMount}
-            extraParameters={extraParameters}
-            localExtraParameters={localExtraParameters}
+            extraParameters={makeExtraParametersArray(extraParameters)}
+            strLocalExtraParameters={makeLocalExtraParametersArray(localExtraParameters, 'str')}
+            boolLocalExtraParameters={makeLocalExtraParametersArray(localExtraParameters, 'bool')}
             onAdLoadedEvent={onAdLoadedEvent}
             onAdLoadFailedEvent={onAdLoadFailedEvent}
             onAdDisplayFailedEvent={onAdDisplayFailedEvent}
@@ -303,7 +219,7 @@ export const AdView = forwardRef<AdViewHandler, AdViewProps & ViewProps>(functio
             onAdExpandedEvent={onAdExpandedEvent}
             onAdCollapsedEvent={onAdCollapsedEvent}
             onAdRevenuePaidEvent={onAdRevenuePaidEvent}
-            style={Object.assign({}, style, dimensions.current)}
+            style={[style, dimensions.current]}
             {...otherProps}
         />
     );
@@ -316,14 +232,15 @@ export const AdView = forwardRef<AdViewHandler, AdViewProps & ViewProps>(functio
  * - Unmounting {@link AdView} does not destroy the preloaded component—it will be reused on the next mount.
  * - You must manually destroy the preloaded component when it is no longer needed using {@link destroyNativeUIComponentAdView}.
  *
- * @param adUnitId - The Ad Unit ID for which the ads should be preloaded.
+ * @param adUnitId - The Ad Unit ID for which ads should be preloaded.
  * @param adFormat - The ad format to preload. Must be either {@link AdFormat.BANNER} or {@link AdFormat.MREC}.
  * @param options - Optional properties to configure the native UI component (e.g., placement, custom data).
- * @returns A promise resolving to an {@link AdViewId}, which uniquely identifies the preloaded component.
+ * @returns A promise that resolves to an {@link AdViewId}, uniquely identifying the preloaded component instance.
  * @throws An error if the preload request fails.
  */
-export const preloadNativeUIComponentAdView = async (adUnitId: string, adFormat: AdFormat, options?: NativeUIComponentAdViewOptions): Promise<AdViewId> => {
-    return AppLovinMAX.preloadNativeUIComponentAdView(adUnitId, adFormat, options?.placement, options?.customData, options?.extraParameters, options?.localExtraParameters);
+export const preloadNativeUIComponentAdView = async (adUnitId: string, adFormat: AdFormat, options: NativeUIComponentAdViewOptions = {}): Promise<AdViewId> => {
+    const { placement = null, customData = null, extraParameters = {}, localExtraParameters = {} } = options;
+    return AppLovinMAX.preloadNativeUIComponentAdView(adUnitId, adFormat, placement, customData, extraParameters, localExtraParameters);
 };
 
 /**
@@ -336,12 +253,14 @@ export const preloadNativeUIComponentAdView = async (adUnitId: string, adFormat:
  * @throws An error if the destruction process fails.
  */
 export const destroyNativeUIComponentAdView = async (adViewId: AdViewId): Promise<void> => {
+    if (adViewId === undefined) {
+        return Promise.reject(new Error('adViewId is not provided'));
+    }
     return AppLovinMAX.destroyNativeUIComponentAdView(adViewId);
 };
 
 /**
- * Adds the specified event listener to receive {@link AdInfo} when a native UI component loads a
- * new ad.
+ * Adds the specified event listener to receive {@link AdInfo} when a native UI component loads a new ad.
  *
  * @param listener Listener to be notified.
  */
@@ -350,15 +269,14 @@ export const addNativeUIComponentAdViewAdLoadedEventListener = (listener: (adInf
 };
 
 /**
- * Removes the event listener to receive {@link AdInfo} when a native UI component loads a new ad.
+ * Removes the event listener registered to receive {@link AdInfo} when a native UI component loads a new ad.
  */
 export const removeNativeUIComponentAdViewAdLoadedEventListener = (): void => {
     removeEventListener(ON_NATIVE_UI_COMPONENT_ADVIEW_AD_LOADED_EVENT);
 };
 
 /**
- * Adds the specified event listener to receive {@link AdLoadFailedInfo} when a native UI component
- * could not load a new ad.
+ * Adds the specified event listener to receive {@link AdLoadFailedInfo} when a native UI component could not load a new ad.
  *
  * @param listener Listener to be notified.
  */
@@ -367,8 +285,7 @@ export const addNativeUIComponentAdViewAdLoadFailedEventListener = (listener: (e
 };
 
 /**
- * Removes the event listener to receive {@link AdLoadFailedInfo} when a native UI component could
- * not load a new ad.
+ * Removes the event listener registered to receive {@link AdLoadFailedInfo} when a native UI component could not load a new ad.
  */
 export const removeNativeUIComponentAdViewAdLoadFailedEventListener = (): void => {
     removeEventListener(ON_NATIVE_UI_COMPONENT_ADVIEW_AD_LOAD_FAILED_EVENT);

package/src/AppLovinMAX.ts

@@ -1,96 +1,101 @@
-import { NativeModules } from 'react-native';
 import type { AppLovinMAXType } from './types/AppLovinMAX';
 import type { Configuration } from './types/Configuration';
+import NativeAppLovinMAX from './specs/NativeAppLovinMAXModule';
 
-const NativeAppLovinMAX = NativeModules.AppLovinMAX;
-
-const VERSION = '8.2.0';
+const VERSION = '9.1.0';
 
 /**
- * This enum represents the user's geography used to determine the type of consent flow shown to the
- * user.
+ * Represents the user's geography, used to determine which type of consent flow to display.
  */
 export enum ConsentFlowUserGeography {
     /**
-     * User's geography is unknown.
+     * The user's geography could not be determined.
      */
     UNKNOWN = 'U',
 
     /**
-     * The user is in GDPR region.
+     * The user is located in a GDPR region.
      */
     GDPR = 'G',
 
     /**
-     * The user is in a non-GDPR region.
+     * The user is not in a GDPR region.
      */
     OTHER = 'O',
 }
 
 /**
- * AppLovin SDK-defined app tracking transparency status values (extended to include "unavailable"
- * state on iOS before iOS14).
+ * App tracking transparency status values as defined by the AppLovin SDK.
+ *
+ * These values are based on Apple's AppTrackingTransparency framework (iOS 14+).
  */
 export enum AppTrackingStatus {
     /**
-     * Device is on iOS before iOS14, AppTrackingTransparency.framework is not available.
+     * Device is running an iOS version prior to iOS 14.
+     * AppTrackingTransparency is not available.
      */
     UNAVAILABLE = 'U',
 
     /**
-     * The user has not yet received an authorization request to authorize access to app-related
-     * data that can be used for tracking the user or the device.
+     * The user has not yet responded to the tracking authorization prompt.
      */
     NOT_DETERMINED = 'N',
 
     /**
-     * Authorization to access app-related data that can be used for tracking the user or the device
-     * is restricted.
+     * Tracking is restricted (e.g. due to parental controls).
      */
     RESTRICTED = 'R',
 
     /**
-     * The user denies authorization to access app-related data that can be used for tracking the
-     * user or the device.
+     * The user denied authorization for tracking.
      */
     DENIED = 'D',
 
     /**
-     * The user authorizes access to app-related data that can be used for tracking the user or the
-     * device.
+     * The user authorized tracking access.
      */
     AUTHORIZED = 'A',
 }
 
 /**
- * Represents errors for CMP flow.
+ * Error codes returned from the Consent Management Platform (CMP) flow.
  */
 export enum CMPErrorCode {
     /**
-     * Indicates that an unspecified error has occurred.
+     * An unspecified error occurred.
      */
     UNSPECIFIED = -1,
 
     /**
-     * Indicates that the CMP has not been integrated correctly.
+     * The CMP was not integrated correctly.
      */
     INTEGRATION_ERROR = 1,
 
     /**
-     * Indicates that the CMP form is unavailable.
+     * The CMP form is unavailable.
      */
     FORM_UNAVAILABLE = 2,
 
     /**
-     * Indicates that the CMP form is not required.
+     * The CMP form is not required for this user.
      */
     FORM_NOT_REQUIRED = 3,
 }
 
-const initialize = (sdkKey: string): Promise<Configuration> => {
-    return NativeAppLovinMAX.initialize(VERSION, sdkKey);
-};
+/**
+ * Initializes the AppLovin MAX SDK with the provided SDK key.
+ *
+ * @param sdkKey - Your AppLovin SDK key.
+ * @returns A promise that resolves with the SDK configuration.
+ */
+const initialize = (sdkKey: string): Promise<Configuration> => NativeAppLovinMAX.initialize(VERSION, sdkKey);
 
+/**
+ * Retrieves the user segments.
+ *
+ * @returns A promise resolving to a Map of segment IDs to arrays of group IDs,
+ *          or `null` if no segments are available.
+ */
 const getSegments = async (): Promise<Map<number, number[]> | null> => {
     const segments = await NativeAppLovinMAX.getSegments();
 
@@ -100,21 +105,25 @@ const getSegments = async (): Promise<Map<number, number[]> | null> => {
 
     const map = new Map<number, number[]>();
 
-    for (const key in segments) {
-        if (segments.hasOwnProperty(key)) {
-            // Convert the key from a string to a number. In JavaScript, an object cannot have an
-            // integer as a key, but the Map object can have keys of any data type.
-            map.set(Number(key), segments[key]);
+    for (const [key, value] of Object.entries(segments)) {
+        // In JavaScript, object keys are always strings, so we convert them to numbers for the Map.
+        if (value) {
+            map.set(Number(key), value);
         }
     }
 
     return map;
 };
 
+// All native methods except those overridden here
 type NativeAppLovinMAXType = Omit<AppLovinMAXType, 'initialize' | 'getSegments'>;
 
 const nativeMethods: NativeAppLovinMAXType = NativeAppLovinMAX;
 
+/**
+ * Main AppLovin MAX module interface exposed to JavaScript.
+ * Wraps the native module and overrides `initialize()` and `getSegments()` for custom handling.
+ */
 export const AppLovinMAX: AppLovinMAXType = Object.create(nativeMethods, {
     initialize: {
         value: initialize,

package/src/AppOpenAd.ts

@@ -1,10 +1,8 @@
-import { NativeModules } from 'react-native';
 import { addEventListener, removeEventListener } from './EventEmitter';
 import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo } from './types/AdInfo';
 import type { LocalExtraParameterValue } from './types/AdProps';
 import type { AppOpenAdType } from './types/AppOpenAd';
-
-const { AppLovinMAX } = NativeModules;
+import AppLovinMAX from './specs/NativeAppLovinMAXModule';
 
 const {
     ON_APPOPEN_AD_LOADED_EVENT,

package/src/BannerAd.ts

@@ -1,11 +1,9 @@
-import { NativeModules } from 'react-native';
 import { addEventListener, removeEventListener } from './EventEmitter';
 import type { AdInfo, AdLoadFailedInfo } from './types/AdInfo';
 import type { LocalExtraParameterValue } from './types/AdProps';
 import type { BannerAdType } from './types/BannerAd';
 import type { AdViewPosition } from './AdView';
-
-const { AppLovinMAX } = NativeModules;
+import AppLovinMAX from './specs/NativeAppLovinMAXModule';
 
 const {
     ON_BANNER_AD_LOADED_EVENT,