react-native-applovin-max 8.2.0 → 9.1.0

package/src/types/Privacy.ts

@@ -1,25 +1,32 @@
+/**
+ * Provides methods to manage user privacy settings for AppLovin MAX.
+ */
 export type PrivacyType = {
     /**
-     * Sets whether or not the user provided consent for information-sharing with AppLovin.
+     * Sets whether the user has granted consent for data collection and sharing.
      *
-     * @param hasUserConsent true if the user provided consent for information sharing.
+     * @param hasUserConsent - `true` if the user has provided consent.
      */
     setHasUserConsent(hasUserConsent: boolean): void;
 
     /**
-     * Checks if user set consent for information sharing.
+     * Checks whether the user has granted consent for information sharing.
+     *
+     * @returns A promise that resolves to `true` if the user has granted consent.
      */
     hasUserConsent(): Promise<boolean>;
 
     /**
-     * Sets whether or not the user opted out of the sale of their personal information.
+     * Sets whether the user has opted out of the sale of their personal information.
      *
-     * @param doNotSell true if the user opted out of the sale of their personal information.
+     * @param doNotSell - `true` if the user opted out of personal data sale.
      */
     setDoNotSell(doNotSell: boolean): void;
 
     /**
-     * Checks if the user opted out of the sale of their personal information.
+     * Checks whether the user has opted out of the sale of their personal information.
+     *
+     * @returns A promise that resolves to `true` if the user has opted out.
      */
     isDoNotSell(): Promise<boolean>;
 };

package/src/types/RewardedAd.ts

@@ -2,18 +2,20 @@ import type { AdEventListener } from './AdEvent';
 import type { AdRewardInfo } from './AdInfo';
 import type { FullscreenAdType } from './FullscreenAd';
 
+/**
+ * Defines the interface for managing rewarded ads.
+ * Extends {@link FullscreenAdType} with reward-specific callbacks.
+ */
 export type RewardedAdType = FullscreenAdType & {
     /**
-     * Adds the specified event listener to receive {@link AdRewardInfo} when {@link RewardedAd}
-     * rewards the user.
+     * Registers a listener for when a reward is granted to the user.
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdRewardInfo}.
      */
     addAdReceivedRewardEventListener(listener: AdEventListener<AdRewardInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdRewardInfo} when {@link RewardedAd} rewards
-     * the user.
+     * Unregisters the reward event listener.
      */
     removeAdReceivedRewardEventListener(): void;
 };

package/src/types/ViewAd.ts

@@ -4,159 +4,155 @@ import type { LocalExtraParameterValue } from './AdProps';
 import type { AdViewPosition } from '../AdView';
 
 /**
- * Define a view-based ad (i.e. Banner / MREC)
+ * Defines the interface for view-based ads such as Banners and MRECs.
  */
 export type ViewAdType = {
     /**
-     * Destroys the banner/MREC.
+     * Destroys the banner or MREC ad.
      *
-     * @param adUnitId The ad unit ID of the ad to destroy.
+     * @param adUnitId - The ad unit ID of the ad to destroy.
      */
     destroyAd(adUnitId: string): void;
 
     /**
-     * Shows the banner/MREC.
+     * Displays the banner or MREC ad.
      *
-     * @param adUnitId The ad unit ID of the ad to show.
+     * @param adUnitId - The ad unit ID of the ad to show.
      */
     showAd(adUnitId: string): void;
 
     /**
-     * Hides the banner/MREC.
+     * Hides the banner or MREC ad.
      *
-     * @param adUnitId The ad unit ID of the ad to hide.
+     * @param adUnitId - The ad unit ID of the ad to hide.
      */
     hideAd(adUnitId: string): void;
 
     /**
-     * Sets a placement to tie the showing ad’s events to.
+     * Sets a placement to associate with the showing ad’s events.
      *
-     * @param adUnitId The ad unit ID of the ad to set a placement for.
-     * @param placement The placement to tie the showing ad's events to.
+     * @param adUnitId - The ad unit ID.
+     * @param placement - The placement name.
      */
     setPlacement(adUnitId: string, placement: string | null): void;
 
     /**
-     * Sets custom data to tie the showing ad’s events to.
+     * Sets custom data to associate with the showing ad’s events.
      *
-     * @param adUnitId The ad unit ID of the ad to set custom data for.
-     * @param customData The custom data to tie the showing ad's events to. Maximum size is 8KB.
+     * @param adUnitId - The ad unit ID.
+     * @param customData - Optional custom string (max 8 KB).
      */
     setCustomData(adUnitId: string, customData: string | null): void;
 
     /**
-     * Updates the banner/mrec position.
+     * Updates the position of the banner or MREC.
      *
-     * @param adUnitId The ad unit ID of the ad to update the position of.
-     * @param bannerPosition {@link AdViewPosition} position.
+     * @param adUnitId - The ad unit ID.
+     * @param bannerPosition - The new position on screen.
      */
     updatePosition(adUnitId: string, bannerPosition: AdViewPosition): void;
 
     /**
-     * Sets an extra key/value parameter for the ad.
+     * Sets an extra parameter for the ad.
      *
-     * @param adUnitId The ad unit ID of the ad to set a parameter for.
-     * @param key Key parameter.
-     * @param value Value parameter.
+     * @param adUnitId - The ad unit ID.
+     * @param key - Parameter name.
+     * @param value - Parameter value (or `null` to clear it).
      */
     setExtraParameter(adUnitId: string, key: string, value: string | null): void;
 
     /**
-     * Set a local extra parameter to pass to the adapter instances.
+     * Sets a local extra parameter to be passed to the mediation adapter.
      *
-     * @param adUnitId The ad unit ID of the ad to set a local parameter for.
-     * @param key Key parameter.
-     * @param value Value parameter.
+     * @param adUnitId - The ad unit ID.
+     * @param key - Parameter name.
+     * @param value - Parameter value (string, number, boolean, object, or null).
      */
     setLocalExtraParameter(adUnitId: string, key: string, value: LocalExtraParameterValue): void;
 
     /**
-     * Starts or resumes auto-refreshing of the banner/mrec.
+     * Starts or resumes auto-refresh for the ad.
      *
-     * @param adUnitId The ad unit ID of the ad to start or resume auto-refreshing.
+     * @param adUnitId - The ad unit ID.
      */
     startAutoRefresh(adUnitId: string): void;
 
     /**
-     * Pauses auto-refreshing of the banner/mrec.
+     * Pauses auto-refresh for the ad.
      *
-     * @param adUnitId The ad unit ID of the ad to stop auto-refreshing.
+     * @param adUnitId - The ad unit ID.
      */
     stopAutoRefresh(adUnitId: string): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad loads a new ad.
+     * Registers a listener for when a new ad is successfully loaded.
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdInfo}.
      */
     addAdLoadedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when a view-base ad loads a new ad.
+     * Unregisters the ad loaded listener.
      */
     removeAdLoadedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when a view-base ad
-     * could not load a new ad.
+     * Registers a listener for when ad loading fails.
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdLoadFailedInfo}.
      */
     addAdLoadFailedEventListener(listener: AdEventListener<AdLoadFailedInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdLoadFailedInfo} when a view-base ad could not
-     * load a new ad.
+     * Unregisters the ad load failure listener.
      */
     removeAdLoadFailedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the user clicks the ad.
+     * Registers a listener for ad click events.
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdInfo}.
      */
     addAdClickedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the user clicks the ad.
+     * Unregisters the ad click listener.
      */
     removeAdClickedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad collapses the ad.
+     * Registers a listener for when the ad collapses (e.g. after expansion).
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdInfo}.
      */
     addAdCollapsedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when a view-base ad collapses the ad.
+     * Unregisters the ad collapsed listener.
      */
     removeAdCollapsedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad expands the ad.
+     * Registers a listener for when the ad expands.
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdInfo}.
      */
     addAdExpandedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when a view-base ad expands the ad.
+     * Unregisters the ad expanded listener.
      */
     removeAdExpandedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad pays
-     * ad revenue to the publisher.
+     * Registers a listener for when the ad pays revenue to the publisher.
      *
-     * @param listener Listener to be notified.
+     * @param listener - Callback to be notified with {@link AdInfo}.
      */
     addAdRevenuePaidListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when when a view-base ad pays ad
-     * revenue to the publisher.
+     * Unregisters the ad revenue paid listener.
      */
     removeAdRevenuePaidListener(): void;
 };

package/android/src/main/java/com/applovin/reactnative/AppLovinMAXAdViewManager.java

@@ -1,149 +0,0 @@
-package com.applovin.reactnative;
-
-import com.facebook.react.bridge.ReadableArray;
-import com.facebook.react.bridge.ReadableMap;
-import com.facebook.react.common.MapBuilder;
-import com.facebook.react.uimanager.SimpleViewManager;
-import com.facebook.react.uimanager.ThemedReactContext;
-import com.facebook.react.uimanager.annotations.ReactProp;
-
-import java.util.Map;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
-/**
- * Created by Thomas So on September 26 2020
- */
-class AppLovinMAXAdViewManager
-    extends SimpleViewManager<AppLovinMAXAdView>
-{
-    private static final int COMMAND_LOAD_AD = 1;
-
-    public AppLovinMAXAdViewManager() { }
-
-    @NonNull
-    @Override
-    public String getName()
-    {
-        return "AppLovinMAXAdView";
-    }
-
-    @Nullable
-    @Override
-    public Map<String, Object> getExportedCustomDirectEventTypeConstants()
-    {
-        // mapping Android events to JavaScript events
-        return MapBuilder.<String, Object>builder()
-            .put( AppLovinMAXAdEvents.ON_AD_LOADED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_LOADED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_LOAD_FAILED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_LOAD_FAILED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_DISPLAY_FAILED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_DISPLAY_FAILED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_CLICKED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_CLICKED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_EXPANDED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_EXPANDED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_COLLAPSED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_COLLAPSED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_REVENUE_PAID_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_REVENUE_PAID_EVENT ) )
-            .build();
-    }
-
-    @Nullable
-    @Override
-    public Map<String, Integer> getCommandsMap()
-    {
-        return MapBuilder.of(
-            "loadAd", COMMAND_LOAD_AD
-        );
-    }
-
-    @Override
-    public void receiveCommand(@NonNull final AppLovinMAXAdView view, final int commandId, @Nullable final ReadableArray args)
-    {
-        if ( commandId == COMMAND_LOAD_AD )
-        {
-            view.loadAd();
-        }
-    }
-
-    @NonNull
-    @Override
-    protected AppLovinMAXAdView createViewInstance(@NonNull final ThemedReactContext reactContext)
-    {
-        // NOTE: Do not set frame or backgroundColor as RN will overwrite the values set by your custom class in order to match your JavaScript component's layout props - hence wrapper
-        return new AppLovinMAXAdView( reactContext );
-    }
-
-    @ReactProp(name = "adUnitId")
-    public void setAdUnitId(final AppLovinMAXAdView view, final String adUnitId)
-    {
-        view.setAdUnitId( adUnitId );
-    }
-
-    @ReactProp(name = "adFormat")
-    public void setAdFormat(final AppLovinMAXAdView view, final String adFormatStr)
-    {
-        view.setAdFormat( adFormatStr );
-    }
-
-    @ReactProp(name = "adViewId")
-    public void setAdViewId(final AppLovinMAXAdView view, final int adViewId)
-    {
-        view.setAdViewId( adViewId );
-    }
-
-    @ReactProp(name = "placement")
-    public void setPlacement(final AppLovinMAXAdView view, @Nullable final String placement)
-    {
-        view.setPlacement( placement );
-    }
-
-    @ReactProp(name = "customData")
-    public void setCustomData(final AppLovinMAXAdView view, @Nullable final String customData)
-    {
-        view.setCustomData( customData );
-    }
-
-    @ReactProp(name = "adaptiveBannerEnabled")
-    public void setAdaptiveBannerEnabled(final AppLovinMAXAdView view, final boolean enabled)
-    {
-        view.setAdaptiveBannerEnabled( enabled );
-    }
-
-    @ReactProp(name = "autoRefresh")
-    public void setAutoRefresh(final AppLovinMAXAdView view, final boolean enabled)
-    {
-        view.setAutoRefreshEnabled( enabled );
-    }
-
-    @ReactProp(name = "loadOnMount")
-    public void setLoadOnMount(final AppLovinMAXAdView view, final boolean enabled)
-    {
-        view.setLoadOnMount( enabled );
-    }
-
-    @ReactProp(name = "extraParameters")
-    public void setExtraParameters(final AppLovinMAXAdView view, @Nullable final ReadableMap value)
-    {
-        view.setExtraParameters( value );
-    }
-
-    @ReactProp(name = "localExtraParameters")
-    public void setLocalExtraParameters(final AppLovinMAXAdView view, @Nullable final ReadableMap value)
-    {
-        view.setLocalExtraParameters( value );
-    }
-
-    @Override
-    public void onAfterUpdateTransaction(@NonNull final AppLovinMAXAdView view)
-    {
-        super.onAfterUpdateTransaction( view );
-
-        view.onSetProps();
-    }
-
-    @Override
-    public void onDropViewInstance(AppLovinMAXAdView view)
-    {
-        view.destroy();
-
-        super.onDropViewInstance( view );
-    }
-}

package/android/src/main/java/com/applovin/reactnative/AppLovinMAXNativeAdViewManager.java

@@ -1,163 +0,0 @@
-package com.applovin.reactnative;
-
-import com.facebook.react.bridge.ReadableArray;
-import com.facebook.react.bridge.ReadableMap;
-import com.facebook.react.common.MapBuilder;
-import com.facebook.react.uimanager.ThemedReactContext;
-import com.facebook.react.uimanager.ViewGroupManager;
-import com.facebook.react.uimanager.annotations.ReactProp;
-
-import java.util.Map;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
-public class AppLovinMAXNativeAdViewManager
-    extends ViewGroupManager<AppLovinMAXNativeAdView>
-{
-    public static final String REACT_CLASS = "AppLovinMAXNativeAdView";
-
-    public final int COMMAND_LOAD_AD = 1;
-
-    public AppLovinMAXNativeAdViewManager() { }
-
-    @NonNull
-    @Override
-    protected AppLovinMAXNativeAdView createViewInstance(@NonNull final ThemedReactContext reactContext)
-    {
-        return new AppLovinMAXNativeAdView( reactContext );
-    }
-
-    @NonNull
-    @Override
-    public String getName()
-    {
-        return REACT_CLASS;
-    }
-
-    /// Callback to JavaScript
-
-    @Nullable
-    @Override
-    public Map<String, Object> getExportedCustomDirectEventTypeConstants()
-    {
-        // mapping Android events to JavaScript events
-        return MapBuilder.<String, Object>builder()
-            .put( AppLovinMAXAdEvents.ON_AD_LOADED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_LOADED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_LOAD_FAILED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_LOAD_FAILED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_CLICKED_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_CLICKED_EVENT ) )
-            .put( AppLovinMAXAdEvents.ON_AD_REVENUE_PAID_EVENT, MapBuilder.of( "registrationName", AppLovinMAXAdEvents.ON_AD_REVENUE_PAID_EVENT ) )
-            .build();
-    }
-
-    /// Call from JavaScript
-
-    @Nullable
-    @Override
-    public Map<String, Integer> getCommandsMap()
-    {
-        return MapBuilder.of(
-            "loadAd", COMMAND_LOAD_AD
-        );
-    }
-
-    // NOTE: the method is deprecated but the new version won't work
-    @Override
-    public void receiveCommand(@NonNull final AppLovinMAXNativeAdView root, final int commandId, @Nullable final ReadableArray args)
-    {
-        if ( commandId == COMMAND_LOAD_AD )
-        {
-            root.loadAd();
-        }
-    }
-
-    /// Property Setters
-
-    @ReactProp(name = "adUnitId")
-    public void setAdUnitId(final AppLovinMAXNativeAdView view, final String value)
-    {
-        view.setAdUnitId( value );
-    }
-
-    @ReactProp(name = "placement")
-    public void setPlacement(final AppLovinMAXNativeAdView view, @Nullable final String value)
-    {
-        view.setPlacement( value );
-    }
-
-    @ReactProp(name = "customData")
-    public void setCustomData(final AppLovinMAXNativeAdView view, @Nullable final String value)
-    {
-        view.setCustomData( value );
-    }
-
-    @ReactProp(name = "extraParameters")
-    public void setExtraParameters(final AppLovinMAXNativeAdView view, @Nullable final ReadableMap value)
-    {
-        view.setExtraParameters( value );
-    }
-
-    @ReactProp(name = "localExtraParameters")
-    public void setLocalExtraParameters(final AppLovinMAXNativeAdView view, @Nullable final ReadableMap value)
-    {
-        view.setLocalExtraParameters( value );
-    }
-
-    @ReactProp(name = "titleView")
-    public void setTitleView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setTitleView( value );
-    }
-
-    @ReactProp(name = "advertiserView")
-    public void setAdvertiserView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setAdvertiserView( value );
-    }
-
-    @ReactProp(name = "bodyView")
-    public void setBodyView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setBodyView( value );
-    }
-
-    @ReactProp(name = "callToActionView")
-    public void setCallToActionView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setCallToActionView( value );
-    }
-
-    @ReactProp(name = "iconView")
-    public void setIconView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setIconView( value );
-    }
-
-    @ReactProp(name = "optionsView")
-    public void setOptionsView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setOptionsView( value );
-    }
-
-    @ReactProp(name = "mediaView")
-    public void setMediaView(final AppLovinMAXNativeAdView view, final int value)
-    {
-        view.setMediaView( value );
-    }
-
-    @Override
-    public void onAfterUpdateTransaction(@NonNull final AppLovinMAXNativeAdView view)
-    {
-        super.onAfterUpdateTransaction( view );
-
-        view.onSetProps();
-    }
-
-    @Override
-    public void onDropViewInstance(@NonNull final AppLovinMAXNativeAdView view)
-    {
-        view.destroy();
-
-        super.onDropViewInstance( view );
-    }
-}