react-native-applovin-max 4.1.6 → 5.0.0

package/src/index.js

@@ -1,283 +1,62 @@
-import { NativeModules, NativeEventEmitter } from "react-native";
+import { NativeModules } from "react-native";
 import AdView, { AdFormat, AdViewPosition } from "./AppLovinMAXAdView";
 import { TargetingData, AdContentRating, UserGender } from "./TargetingData";
 import NativeAdView from "./NativeAdView";
+import EventListeners from "./AppLovinMAXEventListeners";
 
 const { AppLovinMAX } = NativeModules;
 
-const VERSION = "4.1.6";
-
-/**
- * This enum represents whether or not the consent dialog should be shown for this user.
- * The state where no such determination could be made is represented by `Unknown`.
- */
-const ConsentDialogState = {
-  /**
-   * The consent dialog state could not be determined. This is likely due to SDK failing to initialize.
-   */
-  UNKNOWN: 0,
-
-  /**
-   * This user should be shown a consent dialog.
-   */
-  APPLIES: 1,
-
-  /**
-   * This user should not be shown a consent dialog.
-   */
-  DOES_NOT_APPLY: 2,
-};
-
-const emitter = new NativeEventEmitter(AppLovinMAX);
-const subscriptions = {};
-
-const addEventListener = (event, handler) => {
-  let subscription = emitter.addListener(event, handler);
-  let currentSubscription = subscriptions[event];
-  if (currentSubscription) {
-    currentSubscription.remove();
-  }
-  subscriptions[event] = subscription;
-};
-
-const removeEventListener = (event) => {
-  let currentSubscription = subscriptions[event];
-  if (currentSubscription) {
-    currentSubscription.remove();
-    delete subscriptions[event];
-  }
-};
-
-const logUninitializedAccessError = (callingMethod) => {
-  console.warn( "ERROR: Failed to execute " + callingMethod + "() - please ensure the AppLovin MAX React Native module has been initialized by calling 'AppLovinMAX.initialize(...);'!" );
-}
+const VERSION = "5.0.0";
 
 /*---------*/
 /* BANNERS */
 /*---------*/
 
-const createBanner = (adUnitId, bannerPosition) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('createBanner');
-    return;
-  }
-  AppLovinMAX.createBanner(adUnitId, bannerPosition);
-}
-
-const createBannerWithOffsets = (adUnitId, bannerPosition, xOffset, yOffset) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('createBannerWithOffsets');
-    return;
-  }
-  AppLovinMAX.createBannerWithOffsets(adUnitId, bannerPosition, xOffset, yOffset);
-}
-
-const setBannerBackgroundColor = (adUnitId, hexColorCode) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setBannerBackgroundColor');
-    return;
-  }
-  AppLovinMAX.setBannerBackgroundColor(adUnitId, hexColorCode);
-}
-
-const setBannerPlacement = (adUnitId, placement) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setBannerPlacement');
-    return;
-  }
-  AppLovinMAX.setBannerPlacement(adUnitId, placement);
-}
-
-const setBannerWidth = (adUnitId, width) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setBannerWidth');
-    return;
-  }
-  AppLovinMAX.setBannerWidth(adUnitId, width);
-}
-
-const updateBannerPosition = (adUnitId, bannerPosition) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('updateBannerPosition');
-    return;
-  }
-  AppLovinMAX.updateBannerPosition(adUnitId, bannerPosition);
-}
-
-const updateBannerOffsets = (adUnitId, xOffset, yOffset) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('updateBannerOffsets');
-    return;
-  }
-  AppLovinMAX.updateBannerOffsets(adUnitId, xOffset, yOffset);
-}
-
 const setBannerExtraParameter = (adUnitId, key, value) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setBannerExtraParameter');
-    return;
-  }
-  AppLovinMAX.setBannerExtraParameter(adUnitId, key, value);
-}
-
-const startBannerAutoRefresh = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('startBannerAutoRefresh');
-    return;
-  }
-  AppLovinMAX.startBannerAutoRefresh(adUnitId);
-}
-
-const stopBannerAutoRefresh = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('stopBannerAutoRefresh');
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setBannerExtraParameter() supports only string values: " + value);
     return;
   }
-  AppLovinMAX.stopBannerAutoRefresh(adUnitId);
-}
 
-const showBanner = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('showBanner');
-    return;
-  }
-  AppLovinMAX.showBanner(adUnitId);
+  AppLovinMAX.setBannerExtraParameter(adUnitId, key, value);
 }
 
-const hideBanner = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('hideBanner');
+const setBannerLocalExtraParameter = (adUnitId, key, value) => {
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setBannerLocalExtraParameter() supports only string values: " + value);
     return;
   }
-  AppLovinMAX.hideBanner(adUnitId);
-}
 
-const destroyBanner = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('destroyBanner');
-    return;
-  }
-  AppLovinMAX.destroyBanner(adUnitId);
+  AppLovinMAX.setBannerLocalExtraParameter(adUnitId, key, value);
 }
 
 /*-------*/
 /* MRECS */
 /*-------*/
 
-const createMRec = (adUnitId, mrecPosition) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('createMRec');
-    return;
-  }
-  AppLovinMAX.createMRec(adUnitId, mrecPosition);
-}
-
-const setMRecBackgroundColor = (adUnitId, hexColorCode) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setMRecBackgroundColor');
-    return;
-  }
-  AppLovinMAX.setMRecBackgroundColor(adUnitId, hexColorCode);
-}
-
-const setMRecPlacement = (adUnitId, placement) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setMRecPlacement');
-    return;
-  }
-  AppLovinMAX.setMRecPlacement(adUnitId, placement);
-}
-
-const setMRecCustomData = (adUnitId, customData) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setMRecCustomData');
-    return;
-  }
-  AppLovinMAX.setMRecCustomData(adUnitId, customData);
-}
-
-const updateMRecPosition = (adUnitId, mrecPosition) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('updateMRecPosition');
-    return;
-  }
-  AppLovinMAX.updateMRecPosition(adUnitId, mrecPosition);
-}
-
 const setMRecExtraParameter = (adUnitId, key, value) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setMRecExtraParameter');
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setMRecExtraParameter() supports only string values: " + value);
     return;
   }
-  AppLovinMAX.setMRecExtraParameter(adUnitId, key, value);
-}
 
-const startMRecAutoRefresh = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('startMRecAutoRefresh');
-    return;
-  }
-  AppLovinMAX.startMRecAutoRefresh(adUnitId);
-}
-
-const stopMRecAutoRefresh = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('stopMRecAutoRefresh');
-    return;
-  }
-  AppLovinMAX.stopMRecAutoRefresh(adUnitId);
-}
-
-const showMRec = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('showMRec');
-    return;
-  }
-  AppLovinMAX.showMRec(adUnitId);
+  AppLovinMAX.setMRecExtraParameter(adUnitId, key, value);
 }
 
-const hideMRec = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('hideMRec');
+const setMRecLocalExtraParameter = (adUnitId, key, value) => {
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setMRecLocalExtraParameter() supports only string values: " + value);
     return;
   }
-  AppLovinMAX.hideMRec(adUnitId);
-}
 
-const destroyMRec = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('destroyMRec');
-    return;
-  }
-  AppLovinMAX.destroyMRec(adUnitId);
+  AppLovinMAX.setMRecLocalExtraParameter(adUnitId, key, value);
 }
 
 /*---------------*/
 /* INTERSTITIALS */
 /*---------------*/
 
-const loadInterstitial = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('loadInterstitial');
-    return;
-  }
-  AppLovinMAX.loadInterstitial(adUnitId);
-}
-
-const isInterstitialReady = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('isInterstitialReady');
-    return false;
-  }
-  return AppLovinMAX.isInterstitialReady(adUnitId);
-}
-
 const showInterstitial = (adUnitId, ...args) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('showInterstitial');
-    return;
-  }
-
   switch (args.length) {
   case 0:
     AppLovinMAX.showInterstitial(adUnitId, null, null);
@@ -295,39 +74,28 @@ const showInterstitial = (adUnitId, ...args) => {
 };
 
 const setInterstitialExtraParameter = (adUnitId, key, value) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setInterstitialExtraParameter');
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setInterstitialExtraParameter() supports only string values: " + value);
     return;
   }
+
   AppLovinMAX.setInterstitialExtraParameter(adUnitId, key, value);
 }
 
-/*----------*/
-/* REWARDED */
-/*----------*/
-
-const loadRewardedAd = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('loadRewardedAd');
+const setInterstitialLocalExtraParameter = (adUnitId, key, value) => {
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setInterstitialLocalExtraParameter() supports only string values: " + value);
     return;
   }
-  AppLovinMAX.loadRewardedAd(adUnitId);
-}
 
-const isRewardedAdReady = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('isRewardedAdReady');
-    return false;
-  }
-  return AppLovinMAX.isRewardedAdReady(adUnitId);
+  AppLovinMAX.setInterstitialLocalExtraParameter(adUnitId, key, value);
 }
 
-const showRewardedAd = (adUnitId, ...args) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('showRewardedAd');
-    return;
-  }
+/*----------*/
+/* REWARDED */
+/*----------*/
 
+const showRewardedAd = (adUnitId, ...args) => {
   switch (args.length) {
   case 0:
     AppLovinMAX.showRewardedAd(adUnitId, null, null);
@@ -345,39 +113,28 @@ const showRewardedAd = (adUnitId, ...args) => {
 };
 
 const setRewardedAdExtraParameter = (adUnitId, key, value) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setRewardedAdExtraParameter');
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setRewardedAdExtraParameter() supports only string values: " + value);
     return;
   }
+
   AppLovinMAX.setRewardedAdExtraParameter(adUnitId, key, value);
 }
 
-/*----------*/
-/* APP OPEN */
-/*----------*/
-
-const loadAppOpenAd = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('loadAppOpenAd');
+const setRewardedAdLocalExtraParameter = (adUnitId, key, value) => {
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setRewardedAdLocalExtraParameter() supports only string values: " + value);
     return;
   }
-  AppLovinMAX.loadAppOpenAd(adUnitId);
-}
 
-const isAppOpenAdReady = (adUnitId) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('isAppOpenAdReady');
-    return false;
-  }
-  return AppLovinMAX.isAppOpenAdReady(adUnitId);
+  AppLovinMAX.setRewardedAdLocalExtraParameter(adUnitId, key, value);
 }
 
-const showAppOpenAd = (adUnitId, ...args) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('showAppOpenAd');
-    return;
-  }
+/*----------*/
+/* APP OPEN */
+/*----------*/
 
+const showAppOpenAd = (adUnitId, ...args) => {
   switch (args.length) {
   case 0:
     AppLovinMAX.showAppOpenAd(adUnitId, null, null);
@@ -395,97 +152,71 @@ const showAppOpenAd = (adUnitId, ...args) => {
 };
 
 const setAppOpenAdExtraParameter = (adUnitId, key, value) => {
-  if (!AppLovinMAX.isInitialized()) {
-    logUninitializedAccessError('setAppOpenAdExtraParameter');
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setAppOpenAdExtraParameter() supports only string values: " + value);
     return;
   }
+
   AppLovinMAX.setAppOpenAdExtraParameter(adUnitId, key, value);
 }
 
-const getConsentDialogState = () => {
-  console.warn("getConsentDialogState() has been deprecated and will be removed in a future release.");
-  return AppLovinMAX.getConsentDialogState();
-};
+const setAppOpenAdLocalExtraParameter = (adUnitId, key, value) => {
+  if ((value !== null) && (value !== undefined) && (typeof value !== 'string')) {
+    console.warn("setAppOpenAdLocalExtraParameter() supports only string values: " + value);
+    return;
+  }
+
+  AppLovinMAX.setAppOpenAdLocalExtraParameter(adUnitId, key, value);
+}
 
 export default {
   ...AppLovinMAX,
+  ...EventListeners,
   AdView,
   get targetingData() {
     return TargetingData;
   },
   AdContentRating,
   UserGender,
-  ConsentDialogState,
   AdViewPosition,
   AdFormat,
   NativeAdView,
-  addEventListener,
-  removeEventListener,
-  // Use callback to avoid need for attaching listeners at top level on each re-render
-  initialize(sdkKey, callback) {
-    AppLovinMAX.initialize(VERSION, sdkKey, callback); // Inject VERSION into native code
+  initialize(sdkKey) {
+    return AppLovinMAX.initialize(VERSION, sdkKey);
   },
 
   /*---------*/
   /* BANNERS */
   /*---------*/
-  createBanner,
-  createBannerWithOffsets,
-  setBannerBackgroundColor,
-  setBannerPlacement,
-  setBannerWidth,
-  updateBannerPosition,
-  updateBannerOffsets,
   setBannerExtraParameter,
-  startBannerAutoRefresh,
-  stopBannerAutoRefresh,
-  showBanner,
-  hideBanner,
-  destroyBanner,
+  setBannerLocalExtraParameter,
 
   /*-------*/
   /* MRECS */
   /*-------*/
-  createMRec,
-  setMRecBackgroundColor,
-  setMRecPlacement,
-  setMRecCustomData,
-  updateMRecPosition,
   setMRecExtraParameter,
-  startMRecAutoRefresh,
-  stopMRecAutoRefresh,
-  showMRec,
-  hideMRec,
-  destroyMRec,
+  setMRecLocalExtraParameter,
 
   /*---------------*/
   /* INTERSTITIALS */
   /*---------------*/
-  loadInterstitial,
-  isInterstitialReady,
   showInterstitial,
   setInterstitialExtraParameter,
+  setInterstitialLocalExtraParameter,
 
   /*----------*/
   /* REWARDED */
   /*----------*/
-  loadRewardedAd,
-  isRewardedAdReady,
   showRewardedAd,
   setRewardedAdExtraParameter,
+  setRewardedAdLocalExtraParameter,
 
   /*----------*/
   /* APP OPEN */
   /*----------*/
-  loadAppOpenAd,
-  isAppOpenAdReady,
   showAppOpenAd,
   setAppOpenAdExtraParameter,
-
-  /*--------------------------------------------------*/
-  /* DEPRECATED (will be removed in a future release) */
-  /*--------------------------------------------------*/
-  getConsentDialogState,
+  setAppOpenAdLocalExtraParameter,
 
   /*----------------------*/
   /** AUTO-DECLARED APIs **/
@@ -494,28 +225,28 @@ export default {
   /*----------------*/
   /* INITIALIZATION */
   /*----------------*/
-  /* isInitialized() */
-  /* initialize(pluginVersion, sdkKey, callback) */
+  /* isInitialized(promise) */
+  /* initialize(pluginVersion, sdkKey, promise) */
 
   /*--------------*/
   /* PRIVACY APIs */
   /*--------------*/
-  /* showConsentDialog(callback) */
+  /* showConsentDialog(promise) */
   /* setHasUserConsent(hasUserConsent) */
-  /* hasUserConsent() */
+  /* hasUserConsent(promise) */
   /* setIsAgeRestrictedUser(isAgeRestrictedUser) */
-  /* isAgeRestrictedUser() */
+  /* isAgeRestrictedUser(promise) */
   /* setDoNotSell(doNotSell) */
-  /* isDoNotSell() */
+  /* isDoNotSell(promise) */
 
   /*--------------------*/
   /* GENERAL PUBLIC API */
   /*--------------------*/
   /* showMediationDebugger() */
-  /* isTablet() */
+  /* isTablet(promise) */
   /* setUserId(userId) */
   /* setMuted(muted) */
-  /* isMuted() */
+  /* isMuted(promise) */
   /* setVerboseLogging(verboseLoggingEnabled) */
   /* setTestDeviceAdvertisingIds(advertisingIds) */
   /* setCreativeDebuggerEnabled(enabled) */
@@ -525,6 +256,54 @@ export default {
   /* setTermsOfServiceUrl(urlString) */
   /* setLocationCollectionEnabled(locationCollectionEnabled) */
 
+  /*---------*/
+  /* BANNERS */
+  /*---------*/
+  /* createBanner */
+  /* createBannerWithOffsets */
+  /* setBannerBackgroundColor */
+  /* setBannerPlacement */
+  /* setBannerWidth */
+  /* updateBannerPosition */
+  /* updateBannerOffsets */
+  /* startBannerAutoRefresh */
+  /* stopBannerAutoRefresh */
+  /* showBanner */
+  /* hideBanner */
+  /* destroyBanner */
+
+  /*-------*/
+  /* MRECS */
+  /*-------*/
+  /* createMRec */
+  /* setMRecBackgroundColor */
+  /* setMRecPlacement */
+  /* setMRecCustomData */
+  /* updateMRecPosition */
+  /* startMRecAutoRefresh */
+  /* stopMRecAutoRefresh */
+  /* showMRec */
+  /* hideMRec */
+  /* destroyMRec */
+
+  /*---------------*/
+  /* INTERSTITIALS */
+  /*---------------*/
+  /* loadInterstitial */
+  /* isInterstitialReady */
+
+  /*----------*/
+  /* REWARDED */
+  /*----------*/
+  /* loadRewardedAd */
+  /* isRewardedAdReady */
+
+  /*----------*/
+  /* APP OPEN */
+  /*----------*/
+  /* loadAppOpenAd */
+  /* isAppOpenAdReady */
+
   /*----------------*/
   /* EVENT TRACKING */
   /*----------------*/
@@ -533,5 +312,5 @@ export default {
   /*---------*/
   /* BANNERS */
   /*---------*/
-  /* getAdaptiveBannerHeightForWidth(width) */
+  /* getAdaptiveBannerHeightForWidth(width, promise) */
 };