react-native-applovin-max 6.0.0 → 6.0.2

package/src/InterstitialAd.ts

@@ -1,7 +1,8 @@
-import { NativeModules } from "react-native";
-import { addEventListener, removeEventListener } from "./EventEmitter"
-import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo } from "./types/AdInfo";
-import type { InterstitialAdType } from "./types/InterstitialAd";
+import { NativeModules } from 'react-native';
+import { addEventListener, removeEventListener } from './EventEmitter';
+import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo } from './types/AdInfo';
+import type { LocalExtraParameterValue } from './types/AdProps';
+import type { InterstitialAdType } from './types/InterstitialAd';
 
 const { AppLovinMAX } = NativeModules;
 
@@ -17,83 +18,81 @@ const {
 
 const isAdReady = (adUnitId: string): Promise<boolean> => {
     return AppLovinMAX.isInterstitialReady(adUnitId);
-}
+};
 
 const loadAd = (adUnitId: string): void => {
     AppLovinMAX.loadInterstitial(adUnitId);
-}
+};
 
-const showAd = (
-    adUnitId: string,
-    placement?: string | null,
-    customData?: string | null
-): void => {
+const showAd = (adUnitId: string, placement?: string | null, customData?: string | null): void => {
     AppLovinMAX.showInterstitial(adUnitId, placement ?? null, customData ?? null);
-}
+};
 
-const setExtraParameter = (adUnitId: string, key: string, value: any): void => {
+const setExtraParameter = (adUnitId: string, key: string, value: string | null): void => {
     AppLovinMAX.setInterstitialExtraParameter(adUnitId, key, value);
-}
+};
 
-const setLocalExtraParameter = (adUnitId: string, key: string, value: any): void => {
+const setLocalExtraParameter = (adUnitId: string, key: string, value: LocalExtraParameterValue): void => {
     AppLovinMAX.setInterstitialLocalExtraParameter(adUnitId, { [key]: value });
-}
+};
 
 const addAdLoadedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_INTERSTITIAL_LOADED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdLoadedEventListener = () => {
     removeEventListener(ON_INTERSTITIAL_LOADED_EVENT);
-}
+};
 
 const addAdLoadFailedEventListener = (listener: (errorInfo: AdLoadFailedInfo) => void) => {
     addEventListener(ON_INTERSTITIAL_LOAD_FAILED_EVENT, (errorInfo: AdLoadFailedInfo) => listener(errorInfo));
-}
+};
 
 const removeAdLoadFailedEventListener = () => {
     removeEventListener(ON_INTERSTITIAL_LOAD_FAILED_EVENT);
-}
+};
 
 const addAdClickedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_INTERSTITIAL_CLICKED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdClickedEventListener = () => {
     removeEventListener(ON_INTERSTITIAL_CLICKED_EVENT);
-}
+};
 
 const addAdDisplayedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_INTERSTITIAL_DISPLAYED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdDisplayedEventListener = () => {
     removeEventListener(ON_INTERSTITIAL_DISPLAYED_EVENT);
-}
+};
 
 const addAdFailedToDisplayEventListener = (listener: (errorInfo: AdDisplayFailedInfo) => void) => {
-    addEventListener(ON_INTERSTITIAL_AD_FAILED_TO_DISPLAY_EVENT, (errorInfo: AdDisplayFailedInfo) => listener(errorInfo));
-}
+    addEventListener(ON_INTERSTITIAL_AD_FAILED_TO_DISPLAY_EVENT, (errorInfo: AdDisplayFailedInfo) =>
+        listener(errorInfo)
+    );
+};
 
 const removeAdFailedToDisplayEventListener = () => {
     removeEventListener(ON_INTERSTITIAL_AD_FAILED_TO_DISPLAY_EVENT);
-}
+};
 
 const addAdHiddenEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_INTERSTITIAL_HIDDEN_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdHiddenEventListener = () => {
     removeEventListener(ON_INTERSTITIAL_HIDDEN_EVENT);
-}
+};
 
 const addAdRevenuePaidListener = (listener: (adInfo: AdRevenueInfo) => void) => {
     addEventListener(ON_INTERSTITIAL_AD_REVENUE_PAID, (adInfo: AdRevenueInfo) => listener(adInfo));
-}
+};
 
 const removeAdRevenuePaidListener = () => {
     removeEventListener(ON_INTERSTITIAL_AD_REVENUE_PAID);
-}
+};
 
 export const InterstitialAd: InterstitialAdType = {
     isAdReady,
@@ -123,6 +122,6 @@ export const InterstitialAd: InterstitialAdType = {
 
     addAdRevenuePaidListener,
     removeAdRevenuePaidListener,
-}
+};
 
 export default InterstitialAd;

package/src/MRecAd.ts

@@ -1,8 +1,9 @@
-import { NativeModules } from "react-native";
-import { addEventListener, removeEventListener } from "./EventEmitter"
-import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo } from "./types/AdInfo";
-import type { MRecAdType } from "./types/MRecAd";
-import type { AdViewPosition } from "./AdView";
+import { NativeModules } from 'react-native';
+import { addEventListener, removeEventListener } from './EventEmitter';
+import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo } from './types/AdInfo';
+import type { LocalExtraParameterValue } from './types/AdProps';
+import type { MRecAdType } from './types/MRecAd';
+import type { AdViewPosition } from './AdView';
 
 const { AppLovinMAX } = NativeModules;
 
@@ -17,95 +18,95 @@ const {
 
 const createAd = (adUnitId: string, position: AdViewPosition): void => {
     AppLovinMAX.createMRec(adUnitId, position);
-}
+};
 
 const destroyAd = (adUnitId: string): void => {
     AppLovinMAX.destroyMRec(adUnitId);
-}
+};
 
 const showAd = (adUnitId: string): void => {
     AppLovinMAX.showMRec(adUnitId);
-}
+};
 
 const hideAd = (adUnitId: string): void => {
     AppLovinMAX.hideMRec(adUnitId);
-}
+};
 
 const setPlacement = (adUnitId: string, placement: string | null): void => {
     AppLovinMAX.setMRecPlacement(adUnitId, placement);
-}
+};
 
 const setCustomData = (adUnitId: string, customData: string | null): void => {
     AppLovinMAX.setMRecCustomData(adUnitId, customData);
-}
+};
 
 const updatePosition = (adUnitId: string, bannerPosition: AdViewPosition): void => {
     AppLovinMAX.updateMRecPosition(adUnitId, bannerPosition);
-}
+};
 
-const setExtraParameter = (adUnitId: string, key: string, value: any): void => {
+const setExtraParameter = (adUnitId: string, key: string, value: string | null): void => {
     AppLovinMAX.setMRecExtraParameter(adUnitId, key, value);
-}
+};
 
-const setLocalExtraParameter = (adUnitId: string, key: string, value: any): void => {
+const setLocalExtraParameter = (adUnitId: string, key: string, value: LocalExtraParameterValue): void => {
     AppLovinMAX.setMRecLocalExtraParameter(adUnitId, { [key]: value });
-}
+};
 
 const startAutoRefresh = (adUnitId: string): void => {
     AppLovinMAX.startMRecAutoRefresh(adUnitId);
-}
+};
 
 const stopAutoRefresh = (adUnitId: string): void => {
     AppLovinMAX.stopMRecAutoRefresh(adUnitId);
-}
+};
 
 const addAdLoadedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_MREC_AD_LOADED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdLoadedEventListener = () => {
     removeEventListener(ON_MREC_AD_LOADED_EVENT);
-}
+};
 
 const addAdLoadFailedEventListener = (listener: (errorInfo: AdLoadFailedInfo) => void) => {
     addEventListener(ON_MREC_AD_LOAD_FAILED_EVENT, (errorInfo: AdLoadFailedInfo) => listener(errorInfo));
-}
+};
 
 const removeAdLoadFailedEventListener = () => {
     removeEventListener(ON_MREC_AD_LOAD_FAILED_EVENT);
-}
+};
 
 const addAdClickedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_MREC_AD_CLICKED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdClickedEventListener = () => {
     removeEventListener(ON_MREC_AD_CLICKED_EVENT);
-}
+};
 
 const addAdCollapsedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_MREC_AD_COLLAPSED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdCollapsedEventListener = () => {
     removeEventListener(ON_MREC_AD_COLLAPSED_EVENT);
-}
+};
 
 const addAdExpandedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_MREC_AD_EXPANDED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdExpandedEventListener = () => {
     removeEventListener(ON_MREC_AD_EXPANDED_EVENT);
-}
+};
 
 const addAdRevenuePaidListener = (listener: (adInfo: AdRevenueInfo) => void) => {
     addEventListener(ON_MREC_AD_REVENUE_PAID, (adInfo: AdRevenueInfo) => listener(adInfo));
-}
+};
 
 const removeAdRevenuePaidListener = () => {
     removeEventListener(ON_MREC_AD_REVENUE_PAID);
-}
+};
 
 export const MRecAd: MRecAdType = {
     createAd,
@@ -142,6 +143,6 @@ export const MRecAd: MRecAdType = {
 
     addAdRevenuePaidListener,
     removeAdRevenuePaidListener,
-}
+};
 
 export default MRecAd;

package/src/Privacy.ts

@@ -1,5 +1,5 @@
-import { NativeModules } from "react-native";
-import type { PrivacyType } from "./types/Privacy";
+import { NativeModules } from 'react-native';
+import type { PrivacyType } from './types/Privacy';
 
 const { AppLovinMAX } = NativeModules;
 

package/src/RewardedAd.ts

@@ -1,7 +1,8 @@
-import { NativeModules } from "react-native";
-import { addEventListener, removeEventListener } from "./EventEmitter"
-import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdRewardInfo } from "./types/AdInfo";
-import type { RewardedAdType } from "./types/RewardedAd";
+import { NativeModules } from 'react-native';
+import { addEventListener, removeEventListener } from './EventEmitter';
+import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdRewardInfo } from './types/AdInfo';
+import type { LocalExtraParameterValue } from './types/AdProps';
+import type { RewardedAdType } from './types/RewardedAd';
 
 const { AppLovinMAX } = NativeModules;
 
@@ -18,93 +19,89 @@ const {
 
 const isAdReady = (adUnitId: string): Promise<boolean> => {
     return AppLovinMAX.isRewardedAdReady(adUnitId);
-}
+};
 
 const loadAd = (adUnitId: string): void => {
     AppLovinMAX.loadRewardedAd(adUnitId);
-}
+};
 
-const showAd = (
-    adUnitId: string,
-    placement?: string | null,
-    customData?: string | null
-): void => {
+const showAd = (adUnitId: string, placement?: string | null, customData?: string | null): void => {
     AppLovinMAX.showRewardedAd(adUnitId, placement ?? null, customData ?? null);
-}
+};
 
-const setExtraParameter = (adUnitId: string, key: string, value: any): void => {
+const setExtraParameter = (adUnitId: string, key: string, value: string | null): void => {
     AppLovinMAX.setRewardedAdExtraParameter(adUnitId, key, value);
-}
+};
 
-const setLocalExtraParameter = (adUnitId: string, key: string, value: any): void => {
+const setLocalExtraParameter = (adUnitId: string, key: string, value: LocalExtraParameterValue): void => {
     AppLovinMAX.setRewardedAdLocalExtraParameter(adUnitId, { [key]: value });
-}
+};
 
 const addAdLoadedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_REWARDED_AD_LOADED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdLoadedEventListener = () => {
     removeEventListener(ON_REWARDED_AD_LOADED_EVENT);
-}
+};
 
 const addAdLoadFailedEventListener = (listener: (errorInfo: AdLoadFailedInfo) => void) => {
     addEventListener(ON_REWARDED_AD_LOAD_FAILED_EVENT, (errorInfo: AdLoadFailedInfo) => listener(errorInfo));
-}
+};
 
 const removeAdLoadFailedEventListener = () => {
     removeEventListener(ON_REWARDED_AD_LOAD_FAILED_EVENT);
-}
+};
 
 const addAdClickedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_REWARDED_AD_CLICKED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdClickedEventListener = () => {
     removeEventListener(ON_REWARDED_AD_CLICKED_EVENT);
-}
+};
 
 const addAdDisplayedEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_REWARDED_AD_DISPLAYED_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdDisplayedEventListener = () => {
     removeEventListener(ON_REWARDED_AD_DISPLAYED_EVENT);
-}
+};
 
 const addAdFailedToDisplayEventListener = (listener: (errorInfo: AdDisplayFailedInfo) => void) => {
     addEventListener(ON_REWARDED_AD_FAILED_TO_DISPLAY_EVENT, (errorInfo: AdDisplayFailedInfo) => listener(errorInfo));
-}
+};
 
 const removeAdFailedToDisplayEventListener = () => {
     removeEventListener(ON_REWARDED_AD_FAILED_TO_DISPLAY_EVENT);
-}
+};
 
 const addAdHiddenEventListener = (listener: (adInfo: AdInfo) => void) => {
     addEventListener(ON_REWARDED_AD_HIDDEN_EVENT, (adInfo: AdInfo) => listener(adInfo));
-}
+};
 
 const removeAdHiddenEventListener = () => {
     removeEventListener(ON_REWARDED_AD_HIDDEN_EVENT);
-}
+};
 
 const addAdRevenuePaidListener = (listener: (adInfo: AdRevenueInfo) => void) => {
     addEventListener(ON_REWARDED_AD_REVENUE_PAID, (adInfo: AdRevenueInfo) => listener(adInfo));
-}
+};
 
 const removeAdRevenuePaidListener = () => {
     removeEventListener(ON_REWARDED_AD_REVENUE_PAID);
-}
+};
 
 // Rewarded specific APIs
 
 const addAdReceivedRewardEventListener = (listener: (adInfo: AdRewardInfo) => void) => {
     addEventListener(ON_REWARDED_AD_RECEIVED_REWARD_EVENT, (adInfo: AdRewardInfo) => listener(adInfo));
-}
+};
 
 const removeAdReceivedRewardEventListener = () => {
     removeEventListener(ON_REWARDED_AD_RECEIVED_REWARD_EVENT);
-}
+};
 
 export const RewardedAd: RewardedAdType = {
     isAdReady,
@@ -136,9 +133,9 @@ export const RewardedAd: RewardedAdType = {
     removeAdRevenuePaidListener,
 
     // Rewarded specific APIs
-    
+
     addAdReceivedRewardEventListener,
     removeAdReceivedRewardEventListener,
-}
+};
 
 export default RewardedAd;

package/src/TargetingData.ts

@@ -1,4 +1,5 @@
-import { NativeModules } from "react-native";
+import { NativeModules } from 'react-native';
+import type { TargetingDataType } from './types/TargetingData';
 
 const { AppLovinMAX } = NativeModules;
 
@@ -43,126 +44,182 @@ export enum UserGender {
 }
 
 /**
- * This class allows you to provide user or app data that will improve how we target ads.
+ * Defines additional data for the publisher to send to AppLovin.
+ *
+ * @see {@link https://support.applovin.com/hc/en-us/articles/13964925614733-Data-and-Keyword-Passing}
  */
-export const TargetingData = {
-
+export const TargetingData: TargetingDataType = {
     /**
-     *  Sets the year of birth of the user.  Sets 0 to clear this value.
+     * Sets the year of birth of the user. Set this to 0 to clear this value.
      */
-    set yearOfBirth(value: number) {
-        nativeMethods.setTargetingDataYearOfBirth(value);
+    set yearOfBirth(value: number | Promise<number>) {
+        if (typeof value === 'number') {
+            nativeMethods.setTargetingDataYearOfBirth(value);
+        } else {
+            printError('TargetingData.yearOfBirth', 'number', typeof value);
+        }
     },
 
     /**
-     *  Gets the year of birth of the user.
+     * Gets the year of birth of the user.
      */
-    get yearOfBirth(): Promise<number> {
+    get yearOfBirth(): number | Promise<number> {
         return nativeMethods.getTargetingDataYearOfBirth();
     },
 
     /**
-     * Sets the gender of the user.  Sets {UserGender.Unknown} to clear this value.
+     * Sets the gender of the user. Set this to {@link UserGender.Unknown} to clear this value.
      */
-    set gender(value: UserGender) {
-        if (value === UserGender.Unknown ||
+    set gender(value: UserGender | Promise<UserGender>) {
+        if (
+            value === UserGender.Unknown ||
             value === UserGender.Female ||
             value === UserGender.Male ||
-            value === UserGender.Other) {
+            value === UserGender.Other
+        ) {
             nativeMethods.setTargetingDataGender(value);
+        } else {
+            printError('TargetingData.gender', 'UserGender', typeof value);
         }
     },
 
     /**
      * Gets the gender of the user.
      */
-    get gender(): Promise<UserGender> {
+    get gender(): UserGender | Promise<UserGender> {
         return nativeMethods.getTargetingDataGender().then((value: string) => {
             return value as UserGender;
         });
     },
 
     /**
-     * Sets the maximum ad content rating shown to the user.  Sets {AdContentRating.None} to clear this value.
+     * Sets the maximum ad content rating shown to the user. The levels are based on IQG Media
+     * Ratings: 1=All Audiences, 2=Everyone Over 12, 3=Mature Audiences.
+     * Set this to {@link AdContentRating.None} to clear this value.
      */
-    set maximumAdContentRating(value: AdContentRating) {
-        if (value === AdContentRating.None ||
+    set maximumAdContentRating(value: AdContentRating | Promise<AdContentRating>) {
+        if (
+            value === AdContentRating.None ||
             value === AdContentRating.AllAudiences ||
             value === AdContentRating.EveryoneOverTwelve ||
-            value === AdContentRating.MatureAudiences) {
+            value === AdContentRating.MatureAudiences
+        ) {
             nativeMethods.setTargetingDataMaximumAdContentRating(value);
+        } else {
+            printError('TargetingData.maximumAdContentRating', 'AdContentRating', typeof value);
         }
     },
 
     /**
-     * Gets the maximum ad content rating shown to the user.
+     * Gets the maximum ad content rating shown to the user. The levels are based on IQG Media
+     * Ratings: 1=All Audiences, 2=Everyone Over 12, 3=Mature Audiences.
      */
-    get maximumAdContentRating(): Promise<AdContentRating> {
+    get maximumAdContentRating(): AdContentRating | Promise<AdContentRating> {
         return nativeMethods.getTargetingDataMaximumAdContentRating().then((value: number) => {
             return value as AdContentRating;
         });
     },
 
     /**
-     * Sets the email of the user.  Sets null to clear this value.
+     * Sets the email of the user. Set this to null to clear this value.
      */
-    set email(value: string | null) {
-        nativeMethods.setTargetingDataEmail(value);
+    set email(value: string | null | Promise<string | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataEmail(null);
+        } else if (typeof value === 'string') {
+            nativeMethods.setTargetingDataEmail(value as string);
+        } else {
+            printError('TargetingData.email', 'string or null', typeof value);
+        }
     },
 
     /**
      * Gets the email of the user.
      */
-    get email(): Promise<string | null> {
+    get email(): string | null | Promise<string | null> {
         return nativeMethods.getTargetingDataEmail();
     },
 
     /**
-     * Sets the phone number of the user.  Sets null to clear this value.
+     * Sets the phone number of the user. Set this to null to clear this value.
      */
-    set phoneNumber(value: string | null) {
-        nativeMethods.setTargetingDataPhoneNumber(value);
+    set phoneNumber(value: string | null | Promise<string | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataPhoneNumber(null);
+        } else if (typeof value === 'string') {
+            nativeMethods.setTargetingDataPhoneNumber(value as string);
+        } else {
+            printError('TargetingData.phoneNumber', 'string or null', typeof value);
+        }
     },
 
     /**
      * Gets the phone number of the user.
      */
-    get phoneNumber(): Promise<string | null> {
+    get phoneNumber(): string | null | Promise<string | null> {
         return nativeMethods.getTargetingDataPhoneNumber();
     },
 
     /**
-     * Sets the keywords describing the application.  Sets null to clear this value.
+     * Sets the keywords describing the application. Set this to null to clear this value.
      */
-    set keywords(value: string[] | null) {
-        nativeMethods.setTargetingDataKeywords(value);
+    set keywords(value: string[] | null | Promise<string[] | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataKeywords(null);
+        } else if (isStringArray(value)) {
+            nativeMethods.setTargetingDataKeywords(value as string[]);
+        } else {
+            printError('TargetingData.keywords', 'string[] or null', typeof value);
+        }
     },
 
     /**
      * Gets the keywords describing the application.
      */
-    get keywords(): Promise<string[] | null> {
+    get keywords(): string[] | null | Promise<string[] | null> {
         return nativeMethods.getTargetingDataKeywords();
     },
 
     /**
-     * Sets the interests of the user.  Sets null to clear this value.
+     * Sets the interests of the user. Set this to null to clear this value.
      */
-    set interests(value: string[] | null) {
-        nativeMethods.setTargetingDataInterests(value);
+    set interests(value: string[] | null | Promise<string[] | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataInterests(null);
+        } else if (isStringArray(value)) {
+            nativeMethods.setTargetingDataInterests(value as string[]);
+        } else {
+            printError('TargetingData.interests', 'string[] or null', typeof value);
+        }
     },
 
     /**
      * Gets the interests of the user.
      */
-    get interests(): Promise<string[] | null> {
+    get interests(): string[] | null | Promise<string[] | null> {
         return nativeMethods.getTargetingDataInterests();
     },
 
     /**
-     *  Clear all saved data from this class.
+     * Clears all saved data from this class.
      */
     clearAll(): void {
         nativeMethods.clearAllTargetingData();
     },
-}
+};
+
+const isStringArray = (strs: object): boolean => {
+    return Array.isArray(strs) && strs.every((value) => typeof value === 'string');
+};
+
+const printError = (fieldName: string, correctType: string, wrongType: string) => {
+    console.error(
+        'Cannot set value to ' +
+            fieldName +
+            ' with unsupported type: ' +
+            wrongType +
+            '.  Value has to be of type ' +
+            correctType +
+            '.'
+    );
+};