react-native-applovin-max 5.7.1 → 6.0.0

package/src/EventEmitter.ts

@@ -0,0 +1,27 @@
+import { NativeModules, NativeEventEmitter } from "react-native";
+import type { EventSubscription } from "react-native";
+import type { AdEventObject, AdEventListener } from "./types/AdEvent";
+
+const { AppLovinMAX } = NativeModules;
+
+// Note that this is a singleton in ES6 module
+const emitter = new NativeEventEmitter(AppLovinMAX);
+
+const subscriptions: Record<string, EventSubscription> = { };
+
+export const addEventListener = <T extends AdEventObject>(event: string, handler: AdEventListener<T>) => {
+    let subscription: EventSubscription = emitter.addListener(event, handler);
+    let currentSubscription = subscriptions[event];
+    if (currentSubscription) {
+        currentSubscription.remove();
+    }
+    subscriptions[event] = subscription;
+}
+
+export const removeEventListener = (event: string) => {
+    let currentSubscription = subscriptions[event];
+    if (currentSubscription) {
+        currentSubscription.remove();
+        delete subscriptions[event];
+    }
+}

package/src/InterstitialAd.ts

@@ -0,0 +1,128 @@
+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";
+
+const { AppLovinMAX } = NativeModules;
+
+const {
+    ON_INTERSTITIAL_LOADED_EVENT,
+    ON_INTERSTITIAL_LOAD_FAILED_EVENT,
+    ON_INTERSTITIAL_CLICKED_EVENT,
+    ON_INTERSTITIAL_DISPLAYED_EVENT,
+    ON_INTERSTITIAL_AD_FAILED_TO_DISPLAY_EVENT,
+    ON_INTERSTITIAL_HIDDEN_EVENT,
+    ON_INTERSTITIAL_AD_REVENUE_PAID,
+} = AppLovinMAX.getConstants();
+
+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 => {
+    AppLovinMAX.showInterstitial(adUnitId, placement ?? null, customData ?? null);
+}
+
+const setExtraParameter = (adUnitId: string, key: string, value: any): void => {
+    AppLovinMAX.setInterstitialExtraParameter(adUnitId, key, value);
+}
+
+const setLocalExtraParameter = (adUnitId: string, key: string, value: any): 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));
+}
+
+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,
+    loadAd,
+    showAd,
+
+    setExtraParameter,
+    setLocalExtraParameter,
+
+    addAdLoadedEventListener,
+    removeAdLoadedEventListener,
+
+    addAdLoadFailedEventListener,
+    removeAdLoadFailedEventListener,
+
+    addAdClickedEventListener,
+    removeAdClickedEventListener,
+
+    addAdDisplayedEventListener,
+    removeAdDisplayedEventListener,
+
+    addAdFailedToDisplayEventListener,
+    removeAdFailedToDisplayEventListener,
+
+    addAdHiddenEventListener,
+    removeAdHiddenEventListener,
+
+    addAdRevenuePaidListener,
+    removeAdRevenuePaidListener,
+}
+
+export default InterstitialAd;

package/src/MRecAd.ts

@@ -0,0 +1,147 @@
+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";
+
+const { AppLovinMAX } = NativeModules;
+
+const {
+    ON_MREC_AD_LOADED_EVENT,
+    ON_MREC_AD_LOAD_FAILED_EVENT,
+    ON_MREC_AD_CLICKED_EVENT,
+    ON_MREC_AD_COLLAPSED_EVENT,
+    ON_MREC_AD_EXPANDED_EVENT,
+    ON_MREC_AD_REVENUE_PAID,
+} = AppLovinMAX.getConstants();
+
+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 => {
+    AppLovinMAX.setMRecExtraParameter(adUnitId, key, value);
+}
+
+const setLocalExtraParameter = (adUnitId: string, key: string, value: any): 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,
+    destroyAd,
+
+    showAd,
+    hideAd,
+
+    setPlacement,
+    setCustomData,
+
+    updatePosition,
+
+    setExtraParameter,
+    setLocalExtraParameter,
+
+    startAutoRefresh,
+    stopAutoRefresh,
+
+    addAdLoadedEventListener,
+    removeAdLoadedEventListener,
+
+    addAdLoadFailedEventListener,
+    removeAdLoadFailedEventListener,
+
+    addAdClickedEventListener,
+    removeAdClickedEventListener,
+
+    addAdCollapsedEventListener,
+    removeAdCollapsedEventListener,
+
+    addAdExpandedEventListener,
+    removeAdExpandedEventListener,
+
+    addAdRevenuePaidListener,
+    removeAdRevenuePaidListener,
+}
+
+export default MRecAd;

package/src/Privacy.ts

@@ -0,0 +1,6 @@
+import { NativeModules } from "react-native";
+import type { PrivacyType } from "./types/Privacy";
+
+const { AppLovinMAX } = NativeModules;
+
+export const Privacy: PrivacyType = AppLovinMAX;

package/src/RewardedAd.ts

@@ -0,0 +1,144 @@
+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";
+
+const { AppLovinMAX } = NativeModules;
+
+const {
+    ON_REWARDED_AD_LOADED_EVENT,
+    ON_REWARDED_AD_LOAD_FAILED_EVENT,
+    ON_REWARDED_AD_CLICKED_EVENT,
+    ON_REWARDED_AD_DISPLAYED_EVENT,
+    ON_REWARDED_AD_FAILED_TO_DISPLAY_EVENT,
+    ON_REWARDED_AD_HIDDEN_EVENT,
+    ON_REWARDED_AD_RECEIVED_REWARD_EVENT,
+    ON_REWARDED_AD_REVENUE_PAID,
+} = AppLovinMAX.getConstants();
+
+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 => {
+    AppLovinMAX.showRewardedAd(adUnitId, placement ?? null, customData ?? null);
+}
+
+const setExtraParameter = (adUnitId: string, key: string, value: any): void => {
+    AppLovinMAX.setRewardedAdExtraParameter(adUnitId, key, value);
+}
+
+const setLocalExtraParameter = (adUnitId: string, key: string, value: any): 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,
+    loadAd,
+    showAd,
+
+    setExtraParameter,
+    setLocalExtraParameter,
+
+    addAdLoadedEventListener,
+    removeAdLoadedEventListener,
+
+    addAdLoadFailedEventListener,
+    removeAdLoadFailedEventListener,
+
+    addAdClickedEventListener,
+    removeAdClickedEventListener,
+
+    addAdDisplayedEventListener,
+    removeAdDisplayedEventListener,
+
+    addAdFailedToDisplayEventListener,
+    removeAdFailedToDisplayEventListener,
+
+    addAdHiddenEventListener,
+    removeAdHiddenEventListener,
+
+    addAdRevenuePaidListener,
+    removeAdRevenuePaidListener,
+
+    // Rewarded specific APIs
+    
+    addAdReceivedRewardEventListener,
+    removeAdReceivedRewardEventListener,
+}
+
+export default RewardedAd;

package/src/TargetingData.ts

@@ -0,0 +1,168 @@
+import { NativeModules } from "react-native";
+
+const { AppLovinMAX } = NativeModules;
+
+type NativeTargetingDataType = {
+    setTargetingDataYearOfBirth(value: number): void;
+    getTargetingDataYearOfBirth(): Promise<number>;
+    setTargetingDataGender(value: string): void;
+    getTargetingDataGender(): Promise<string>;
+    setTargetingDataMaximumAdContentRating(value: number): void;
+    getTargetingDataMaximumAdContentRating(): Promise<number>;
+    setTargetingDataEmail(value: string | null): void;
+    getTargetingDataEmail(): Promise<string | null>;
+    setTargetingDataPhoneNumber(value: string | null): void;
+    getTargetingDataPhoneNumber(): Promise<string | null>;
+    setTargetingDataKeywords(value: string[] | null): void;
+    getTargetingDataKeywords(): Promise<string[] | null>;
+    setTargetingDataInterests(value: string[] | null): void;
+    getTargetingDataInterests(): Promise<string[] | null>;
+    clearAllTargetingData(): void;
+};
+
+const nativeMethods: NativeTargetingDataType = AppLovinMAX;
+
+/**
+ * This enumeration represents content ratings for the ads shown to users.
+ */
+export enum AdContentRating {
+    None = 0,
+    AllAudiences = 1,
+    EveryoneOverTwelve = 2,
+    MatureAudiences = 3,
+}
+
+/**
+ * This enumeration represents gender.
+ */
+export enum UserGender {
+    Unknown = 'U',
+    Female = 'F',
+    Male = 'M',
+    Other = 'O',
+}
+
+/**
+ * This class allows you to provide user or app data that will improve how we target ads.
+ */
+export const TargetingData = {
+
+    /**
+     *  Sets the year of birth of the user.  Sets 0 to clear this value.
+     */
+    set yearOfBirth(value: number) {
+        nativeMethods.setTargetingDataYearOfBirth(value);
+    },
+
+    /**
+     *  Gets the year of birth of the user.
+     */
+    get yearOfBirth(): Promise<number> {
+        return nativeMethods.getTargetingDataYearOfBirth();
+    },
+
+    /**
+     * Sets the gender of the user.  Sets {UserGender.Unknown} to clear this value.
+     */
+    set gender(value: UserGender) {
+        if (value === UserGender.Unknown ||
+            value === UserGender.Female ||
+            value === UserGender.Male ||
+            value === UserGender.Other) {
+            nativeMethods.setTargetingDataGender(value);
+        }
+    },
+
+    /**
+     * Gets the gender of the user.
+     */
+    get gender(): 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.
+     */
+    set maximumAdContentRating(value: AdContentRating) {
+        if (value === AdContentRating.None ||
+            value === AdContentRating.AllAudiences ||
+            value === AdContentRating.EveryoneOverTwelve ||
+            value === AdContentRating.MatureAudiences) {
+            nativeMethods.setTargetingDataMaximumAdContentRating(value);
+        }
+    },
+
+    /**
+     * Gets the maximum ad content rating shown to the user.
+     */
+    get maximumAdContentRating(): Promise<AdContentRating> {
+        return nativeMethods.getTargetingDataMaximumAdContentRating().then((value: number) => {
+            return value as AdContentRating;
+        });
+    },
+
+    /**
+     * Sets the email of the user.  Sets null to clear this value.
+     */
+    set email(value: string | null) {
+        nativeMethods.setTargetingDataEmail(value);
+    },
+
+    /**
+     * Gets the email of the user.
+     */
+    get email(): Promise<string | null> {
+        return nativeMethods.getTargetingDataEmail();
+    },
+
+    /**
+     * Sets the phone number of the user.  Sets null to clear this value.
+     */
+    set phoneNumber(value: string | null) {
+        nativeMethods.setTargetingDataPhoneNumber(value);
+    },
+
+    /**
+     * Gets the phone number of the user.
+     */
+    get phoneNumber(): Promise<string | null> {
+        return nativeMethods.getTargetingDataPhoneNumber();
+    },
+
+    /**
+     * Sets the keywords describing the application.  Sets null to clear this value.
+     */
+    set keywords(value: string[] | null) {
+        nativeMethods.setTargetingDataKeywords(value);
+    },
+
+    /**
+     * Gets the keywords describing the application.
+     */
+    get keywords(): Promise<string[] | null> {
+        return nativeMethods.getTargetingDataKeywords();
+    },
+
+    /**
+     * Sets the interests of the user.  Sets null to clear this value.
+     */
+    set interests(value: string[] | null) {
+        nativeMethods.setTargetingDataInterests(value);
+    },
+
+    /**
+     * Gets the interests of the user.
+     */
+    get interests(): Promise<string[] | null> {
+        return nativeMethods.getTargetingDataInterests();
+    },
+
+    /**
+     *  Clear all saved data from this class.
+     */
+    clearAll(): void {
+        nativeMethods.clearAllTargetingData();
+    },
+}

package/src/index.ts

@@ -0,0 +1,21 @@
+export { default, AppLovinMAX } from "./AppLovinMAX";
+export { Privacy } from "./Privacy";
+export { TargetingData, AdContentRating, UserGender } from "./TargetingData";
+export { InterstitialAd } from "./InterstitialAd";
+export { RewardedAd } from "./RewardedAd";
+export { AppOpenAd } from "./AppOpenAd";
+export { BannerAd } from "./BannerAd";
+export { MRecAd } from "./MRecAd";
+export { AdView, AdFormat, AdViewPosition } from "./AdView";
+export { NativeAdView } from "./nativeAd/NativeAdView";
+export {
+    TitleView,
+    AdvertiserView,
+    BodyView,
+    CallToActionView,
+    IconView,
+    OptionsView,
+    MediaView,
+    StarRatingView,
+} from "./nativeAd/NativeAdViewComponents";
+export * from "./types";