@javascriptcommon/react-native-google-mobile-ads 16.3.3

package/__tests__/nativeEventEmitter.test.ts

@@ -0,0 +1,72 @@
+import { GoogleMobileAdsNativeEventEmitter } from '../src/internal/GoogleMobileAdsNativeEventEmitter';
+import NativeAppModule from '../src/specs/modules/NativeAppModule';
+
+describe('GoogleMobileAdsNativeEventEmitter', function () {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('NativeAppModule TurboModule', function () {
+    it('should be defined', function () {
+      expect(NativeAppModule).toBeDefined();
+    });
+
+    it('should have eventsNotifyReady method', function () {
+      expect(NativeAppModule.eventsNotifyReady).toBeDefined();
+    });
+
+    it('should have eventsAddListener method', function () {
+      expect(NativeAppModule.eventsAddListener).toBeDefined();
+    });
+
+    it('should have eventsRemoveListener method', function () {
+      expect(NativeAppModule.eventsRemoveListener).toBeDefined();
+    });
+  });
+
+  describe('addListener', function () {
+    it('calls eventsNotifyReady on first listener', function () {
+      const emitter = GoogleMobileAdsNativeEventEmitter;
+      // Reset ready state for testing
+      (emitter as any).ready = false;
+
+      const listener = jest.fn();
+      emitter.addListener('test_event', listener);
+
+      expect(NativeAppModule.eventsNotifyReady).toHaveBeenCalledWith(true);
+      expect(NativeAppModule.eventsAddListener).toHaveBeenCalledWith('test_event');
+    });
+
+    it('does not call eventsNotifyReady on subsequent listeners', function () {
+      const emitter = GoogleMobileAdsNativeEventEmitter;
+      // Set ready state to true
+      (emitter as any).ready = true;
+
+      jest.clearAllMocks();
+
+      const listener = jest.fn();
+      emitter.addListener('another_event', listener);
+
+      expect(NativeAppModule.eventsNotifyReady).not.toHaveBeenCalled();
+      expect(NativeAppModule.eventsAddListener).toHaveBeenCalledWith('another_event');
+    });
+
+    it('returns a subscription with remove function', function () {
+      const emitter = GoogleMobileAdsNativeEventEmitter;
+      const listener = jest.fn();
+      const subscription = emitter.addListener('remove_test', listener);
+
+      expect(subscription).toBeDefined();
+      expect(typeof subscription.remove).toBe('function');
+    });
+  });
+
+  describe('removeAllListeners', function () {
+    it('calls eventsRemoveListener with all flag', function () {
+      const emitter = GoogleMobileAdsNativeEventEmitter;
+      emitter.removeAllListeners('cleanup_event');
+
+      expect(NativeAppModule.eventsRemoveListener).toHaveBeenCalledWith('cleanup_event', true);
+    });
+  });
+});

package/__tests__/requestOptions.test.tsx

@@ -0,0 +1,82 @@
+import { validateAdRequestOptions } from '../src/validateAdRequestOptions';
+
+describe('Admob RequestOptions', () => {
+  describe('publisherProvidedSignals', () => {
+    it('throws if publisherProvidedSignals is not an object', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          publisherProvidedSignals: 'not-an-object',
+        }),
+      ).toThrow("'options.publisherProvidedSignals' expected an object of key/value pairs");
+    });
+
+    it('throws if a publisherProvidedSignals value is not an array', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          publisherProvidedSignals: { IAB_CONTENT_2_2: 'not-an-array' },
+        }),
+      ).toThrow("'options.publisherProvidedSignals.IAB_CONTENT_2_2' expected an array of numbers");
+    });
+
+    it('sets publisherProvidedSignals if valid', () => {
+      const result = validateAdRequestOptions({
+        publisherProvidedSignals: { IAB_CONTENT_2_2: [533, 483, 1020] },
+      });
+      expect(result.publisherProvidedSignals).toEqual({
+        IAB_CONTENT_2_2: [533, 483, 1020],
+      });
+    });
+
+    it('passes through multiple signal keys', () => {
+      const pps = {
+        IAB_CONTENT_2_2: [533, 483],
+        IAB_AUDIENCE_1_1: [6, 7],
+      };
+      const result = validateAdRequestOptions({ publisherProvidedSignals: pps });
+      expect(result.publisherProvidedSignals).toEqual(pps);
+    });
+
+    it('does not set publisherProvidedSignals if not provided', () => {
+      const result = validateAdRequestOptions({});
+      expect(result.publisherProvidedSignals).toBeUndefined();
+    });
+  });
+
+  describe('publisherProvidedId', () => {
+    it('throws if publisherProvidedId is not a string', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          publisherProvidedId: 123,
+        }),
+      ).toThrow("'options.publisherProvidedId' expected a string value");
+    });
+
+    it('sets publisherProvidedId if valid', () => {
+      const result = validateAdRequestOptions({
+        publisherProvidedId: 'user-abc-123',
+      });
+      expect(result.publisherProvidedId).toBe('user-abc-123');
+    });
+  });
+
+  describe('customTargeting', () => {
+    it('throws if customTargeting is not an object', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          customTargeting: 'not-an-object',
+        }),
+      ).toThrow("'options.customTargeting' expected an object of key/value pairs");
+    });
+
+    it('sets customTargeting if valid', () => {
+      const result = validateAdRequestOptions({
+        customTargeting: { key: 'value' },
+      });
+      expect(result.customTargeting).toEqual({ key: 'value' });
+    });
+  });
+});

package/__tests__/rewarded.test.tsx

@@ -0,0 +1,4 @@
+describe('Admob Rewarded', () => {
+  // eslint-disable-next-line jest/no-disabled-tests
+  test.skip('skip', () => {});
+});

package/__tests__/showOptions.test.tsx

@@ -0,0 +1,4 @@
+describe('Admob Show Options', () => {
+  // eslint-disable-next-line jest/no-disabled-tests
+  test.skip('skip', () => {});
+});

package/android/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/android/app-json.gradle

@@ -0,0 +1,69 @@
+import groovy.json.JsonOutput
+import groovy.json.JsonSlurper
+
+String fileName = "app.json"
+String jsonRoot = "react-native-google-mobile-ads"
+String jsonRaw = "GOOGLE_MOBILE_ADS_JSON_RAW"
+
+File jsonFile = null
+File parentDir = rootProject.projectDir
+
+for (int i = 0; i <= 3; i++) {
+  if (parentDir == null) break
+  parentDir = parentDir.parentFile
+  if (parentDir != null) {
+    jsonFile = new File(parentDir, fileName)
+    if (jsonFile.exists()) break
+  }
+}
+
+if (jsonFile != null && jsonFile.exists()) {
+  rootProject.logger.info ":${project.name} ${fileName} found at ${jsonFile.toString()}"
+  Object json = null
+
+  try {
+    json = new JsonSlurper().parseText(jsonFile.text)
+  } catch (Exception ignored) {
+    rootProject.logger.warn ":${project.name} failed to parse ${fileName} found at ${jsonFile.toString()}."
+    rootProject.logger.warn ignored.toString()
+  }
+
+  if (json && json[jsonRoot]) {
+    String jsonStr = JsonOutput.toJson(JsonOutput.toJson(json[jsonRoot]))
+
+    rootProject.ext.googleMobileAdsJson = [
+      raw: json[jsonRoot],
+      isFlagEnabled: { key, defaultValue ->
+        if (json[jsonRoot] == null || json[jsonRoot][key] == null) return defaultValue
+        return json[jsonRoot][key] == true ? true : false
+      },
+      getStringValue: { key, defaultValue ->
+        if (json[jsonRoot] == null) return defaultValue
+        return json[jsonRoot][key] ? json[jsonRoot][key] : defaultValue
+      }
+    ]
+
+    rootProject.logger.info ":${project.name} found ${jsonRoot} json root in ${fileName}, creating app build config"
+    android {
+      defaultConfig {
+        buildConfigField "String", jsonRaw, jsonStr
+      }
+    }
+  } else {
+    rootProject.ext.googleAdsJson = false
+    rootProject.logger.info ":${project.name} ${fileName} found with no ${jsonRoot} config, skipping"
+    android {
+      defaultConfig {
+        buildConfigField "String", jsonRaw, '"{}"'
+      }
+    }
+  }
+} else {
+  rootProject.ext.googleMobileAdsJson = false
+  rootProject.logger.info ":${project.name} no ${fileName} found, skipping"
+  android {
+    defaultConfig {
+      buildConfigField "String", jsonRaw, '"{}"'
+    }
+  }
+}

package/android/build.gradle

@@ -0,0 +1,149 @@
+import io.invertase.gradle.common.PackageJson
+
+buildscript {
+  ext.getExtOrDefault = {name, version ->
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : version
+  }
+
+  // The Android Gradle plugin is only required when opening the android folder stand-alone.
+  // This avoids unnecessary downloads and potential conflicts when the library is included as a
+  // module dependency in an application project.
+  if (project == rootProject) {
+    repositories {
+      google()
+      mavenCentral()
+    }
+
+    dependencies {
+      classpath("com.android.tools.build:gradle:7.0.4")
+      classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion', '1.8.22')}"
+    }
+  } else {
+    repositories {
+      mavenCentral()
+    }
+
+    dependencies {
+      classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion', '1.8.22')}"
+    }
+  }
+}
+
+plugins {
+  id "io.invertase.gradle.build" version "1.5"
+}
+apply plugin: 'kotlin-android'
+
+def packageJson = PackageJson.getForProject(project)
+def googleMobileAdsVersion = packageJson['sdkVersions']['android']['googleMobileAds']
+def googleUmpVersion = packageJson['sdkVersions']['android']['googleUmp']
+def jsonMinSdk = packageJson['sdkVersions']['android']['minSdk']
+def jsonTargetSdk = packageJson['sdkVersions']['android']['targetSdk']
+def jsonCompileSdk = packageJson['sdkVersions']['android']['compileSdk']
+def jsonBuildTools = packageJson['sdkVersions']['android']['buildTools']
+def isNewArchitectureEnabled() {
+    return project.hasProperty("newArchEnabled") && project.newArchEnabled == "true"
+}
+
+if (isNewArchitectureEnabled()) {
+    apply plugin: "com.facebook.react"
+}
+
+project.ext {
+  set('react-native', [
+    versions: [
+      android : [
+        minSdk    : jsonMinSdk,
+        targetSdk : jsonTargetSdk,
+        compileSdk: jsonCompileSdk,
+        // optional as gradle.buildTools comes with one by default
+        // overriding here though to match the version RN uses
+        buildTools: jsonBuildTools
+      ],
+
+      googleMobileAds: [
+        sdk: googleMobileAdsVersion,
+      ],
+
+      ads     : [
+        consent: googleUmpVersion,
+      ],
+    ],
+  ])
+}
+
+apply from: file("./app-json.gradle")
+
+def appJSONGoogleMobileAdsAppIDString = ""
+def appJSONGoogleMobileAdsDelayAppMeasurementInitBool = false
+def appJSONGoogleMobileAdsOptimizeInitializationBool = true
+def appJSONGoogleMobileAdsOptimizeAdLoadingBool = true
+
+if (rootProject.ext.has("googleMobileAdsJson") && rootProject.ext.googleMobileAdsJson) {
+  appJSONGoogleMobileAdsAppIDString = rootProject.ext.googleMobileAdsJson.getStringValue("android_app_id", "")
+  appJSONGoogleMobileAdsDelayAppMeasurementInitBool = rootProject.ext.googleMobileAdsJson.isFlagEnabled("delay_app_measurement_init", false)
+  appJSONGoogleMobileAdsOptimizeInitializationBool = rootProject.ext.googleMobileAdsJson.isFlagEnabled("optimize_initialization", true)
+  appJSONGoogleMobileAdsOptimizeAdLoadingBool = rootProject.ext.googleMobileAdsJson.isFlagEnabled("optimize_ad_loading", true)
+}
+
+if (!appJSONGoogleMobileAdsAppIDString) {
+  println "\n\n\n"
+  println "**************************************************************************************************************"
+  println "\n\n\n"
+  println "WARNING: react-native-google-mobile-ads requires an 'android_app_id' property inside a 'react-native-google-mobile-ads' key in your app.json."
+  println "         No android_app_id property was found in this location. The native Google Mobile Ads SDK will crash on startup without it."
+  println "         You can safely ignore this warning if you are using our Expo config plugin."
+  println "\n\n\n"
+  println "**************************************************************************************************************"
+  println "\n\n\n"
+}
+
+android {
+  defaultConfig {
+    multiDexEnabled true
+    manifestPlaceholders = [
+      appJSONGoogleMobileAdsAppID                  : appJSONGoogleMobileAdsAppIDString,
+      appJSONGoogleMobileAdsDelayAppMeasurementInit: appJSONGoogleMobileAdsDelayAppMeasurementInitBool,
+      appJSONGoogleMobileAdsOptimizeInitialization : appJSONGoogleMobileAdsOptimizeInitializationBool,
+      appJSONGoogleMobileAdsOptimizeAdLoading      : appJSONGoogleMobileAdsOptimizeAdLoadingBool
+    ]
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+
+    sourceSets {
+      main {
+        if (isNewArchitectureEnabled()) {
+          java.srcDirs += ['src/newarch']
+        } else {
+          java.srcDirs += ['src/oldarch']
+        }
+      }
+    }
+  }
+  lintOptions {
+    disable 'GradleCompatible'
+    abortOnError false
+  }
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+}
+
+repositories {
+  google()
+  mavenCentral()
+}
+
+dependencies {
+  // GMA Next-Gen SDK (Android only). Replaces the legacy play-services-ads.
+  // iOS keeps using the classic Google-Mobile-Ads-SDK pod (see *.podspec / sdkVersions.ios).
+  implementation("com.google.android.libraries.ads.mobile.sdk:ads-mobile-sdk:1.2.1")
+  // UMP (consent) is a separate SDK and is unaffected by the Next-Gen migration.
+  api "com.google.android.ump:user-messaging-platform:${googleUmpVersion}"
+}
+
+ReactNative.shared.applyPackageVersion()
+ReactNative.shared.applyDefaultExcludes()
+ReactNative.module.applyAndroidVersions()
+ReactNative.module.applyReactNativeDependency("api")
+

package/android/lint.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+  <!-- Disable the given check in this project -->
+  <issue id="GradleCompatible" severity="ignore" />
+</lint>

package/android/settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'react-native-google-mobile-ads'

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="io.invertase.googlemobileads">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+
+    <application>
+      <meta-data
+        android:name="com.google.android.gms.ads.APPLICATION_ID"
+        android:value="${appJSONGoogleMobileAdsAppID}"/>
+      <meta-data
+        android:name="com.google.android.gms.ads.DELAY_APP_MEASUREMENT_INIT"
+        android:value="${appJSONGoogleMobileAdsDelayAppMeasurementInit}"/>
+      <meta-data
+        android:name="com.google.android.gms.ads.flag.OPTIMIZE_INITIALIZATION"
+        android:value="${appJSONGoogleMobileAdsOptimizeInitialization}"/>
+      <meta-data
+        android:name="com.google.android.gms.ads.flag.OPTIMIZE_AD_LOADING"
+        android:value="${appJSONGoogleMobileAdsOptimizeAdLoading}"/>
+    </application>
+</manifest>

package/android/src/main/java/io/invertase/googlemobileads/OnNativeEvent.kt

@@ -0,0 +1,23 @@
+package io.invertase.googlemobileads
+
+import com.facebook.react.bridge.WritableMap
+import com.facebook.react.uimanager.events.Event
+
+class OnNativeEvent(viewId: Int, private val event: WritableMap) : Event<OnNativeEvent>(viewId) {
+
+    override fun getEventName(): String {
+        return EVENT_NAME
+    }
+
+    override fun getCoalescingKey(): Short = 0
+
+    override fun canCoalesce(): Boolean = false
+
+    override fun getEventData(): WritableMap? {
+        return event
+    }
+
+    companion object {
+        const val EVENT_NAME = "topNativeEvent"
+    }
+}

package/android/src/main/java/io/invertase/googlemobileads/ReactNativeAppModule.java

@@ -0,0 +1,152 @@
+package io.invertase.googlemobileads;
+
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableMap;
+import io.invertase.googlemobileads.common.RCTConvert;
+import io.invertase.googlemobileads.common.ReactNativeEvent;
+import io.invertase.googlemobileads.common.ReactNativeEventEmitter;
+import io.invertase.googlemobileads.common.ReactNativeJSON;
+import io.invertase.googlemobileads.common.ReactNativeMeta;
+import io.invertase.googlemobileads.common.ReactNativePreferences;
+
+public class ReactNativeAppModule extends NativeAppModuleSpec {
+  public static final String NAME = NativeAppModuleSpec.NAME;
+
+  ReactNativeAppModule(ReactApplicationContext reactContext) {
+    super(reactContext);
+  }
+
+  @Override
+  public void initialize() {
+    super.initialize();
+    ReactNativeEventEmitter.getSharedInstance().attachReactContext(getReactApplicationContext());
+  }
+
+  @Override
+  @ReactMethod
+  public void initializeApp(ReadableMap options, ReadableMap appConfig, Promise promise) {
+    promise.resolve(options);
+  }
+
+  @Override
+  @ReactMethod
+  public void setAutomaticDataCollectionEnabled(String appName, boolean enabled) {
+    // No-op for ads module
+  }
+
+  @Override
+  @ReactMethod
+  public void deleteApp(String appName, Promise promise) {
+    promise.resolve(null);
+  }
+
+  @Override
+  @ReactMethod
+  public void eventsNotifyReady(boolean ready) {
+    ReactNativeEventEmitter emitter = ReactNativeEventEmitter.getSharedInstance();
+    emitter.notifyJsReady(ready);
+  }
+
+  @Override
+  @ReactMethod
+  public void eventsGetListeners(Promise promise) {
+    ReactNativeEventEmitter emitter = ReactNativeEventEmitter.getSharedInstance();
+    promise.resolve(emitter.getListenersMap());
+  }
+
+  @Override
+  @ReactMethod
+  public void eventsPing(String eventName, ReadableMap eventBody, Promise promise) {
+    ReactNativeEventEmitter emitter = ReactNativeEventEmitter.getSharedInstance();
+    emitter.sendEvent(
+        new ReactNativeEvent(eventName, RCTConvert.readableMapToWritableMap(eventBody)));
+    promise.resolve(RCTConvert.readableMapToWritableMap(eventBody));
+  }
+
+  @Override
+  @ReactMethod
+  public void eventsAddListener(String eventName) {
+    ReactNativeEventEmitter emitter = ReactNativeEventEmitter.getSharedInstance();
+    emitter.addListener(eventName);
+  }
+
+  @Override
+  @ReactMethod
+  public void eventsRemoveListener(String eventName, boolean all) {
+    ReactNativeEventEmitter emitter = ReactNativeEventEmitter.getSharedInstance();
+    emitter.removeListener(eventName, all);
+  }
+
+  @Override
+  @ReactMethod
+  public void addListener(String eventName) {
+    // Keep: Required for RN built in Event Emitter Calls.
+  }
+
+  @Override
+  @ReactMethod
+  public void removeListeners(double count) {
+    // Keep: Required for RN built in Event Emitter Calls.
+  }
+
+  /** ------------------ META ------------------ */
+  @Override
+  @ReactMethod
+  public void metaGetAll(Promise promise) {
+    promise.resolve(ReactNativeMeta.getSharedInstance().getAll());
+  }
+
+  /** ------------------ JSON ------------------ */
+  @Override
+  @ReactMethod
+  public void jsonGetAll(Promise promise) {
+    promise.resolve(ReactNativeJSON.getSharedInstance().getAll());
+  }
+
+  /** ------------------ PREFERENCES ------------------ */
+  @Override
+  @ReactMethod
+  public void preferencesSetBool(String key, boolean value, Promise promise) {
+    ReactNativePreferences.getSharedInstance().setBooleanValue(key, value);
+    promise.resolve(null);
+  }
+
+  @Override
+  @ReactMethod
+  public void preferencesSetString(String key, String value, Promise promise) {
+    ReactNativePreferences.getSharedInstance().setStringValue(key, value);
+    promise.resolve(null);
+  }
+
+  @Override
+  @ReactMethod
+  public void preferencesGetAll(Promise promise) {
+    promise.resolve(ReactNativePreferences.getSharedInstance().getAll());
+  }
+
+  @Override
+  @ReactMethod
+  public void preferencesClearAll(Promise promise) {
+    ReactNativePreferences.getSharedInstance().clearAll();
+    promise.resolve(null);
+  }
+}