react-native-google-mobile-ads 13.6.0 → 14.0.0

package/plugin/__tests__/fixtures/app-without-params.json

@@ -0,0 +1,11 @@
+{
+  "name": "example",
+  "slug": "example",
+  "android": {
+    "package": "com.example"
+  },
+  "ios": {
+    "bundleIdentifier": "com.example"
+  },
+  "plugins": [["../../build"]]
+}

package/plugin/__tests__/fixtures/app.json

@@ -0,0 +1,24 @@
+{
+  "name": "example",
+  "slug": "example",
+  "android": {
+    "package": "com.example"
+  },
+  "ios": {
+    "bundleIdentifier": "com.example"
+  },
+  "plugins": [
+    [
+      "../../build",
+      {
+        "androidAppId": "TestAppId",
+        "iosAppId": "TestIosId",
+        "delayAppMeasurementInit": true,
+        "optimizeInitialization": true,
+        "optimizeAdLoading": true,
+        "skAdNetworkItems": ["TestSkAdNetworkItem1", "TestSkAdNetworkItem2"],
+        "userTrackingUsageDescription": "TestUserTrackingUsageDescription"
+      }
+    ]
+  ]
+}

package/plugin/__tests__/fixtures/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "scripts": {
+    "start": "expo start --dev-client",
+    "android": "expo run:android",
+    "ios": "expo run:ios"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.12.9"
+  },
+  "dependencies": {
+    "expo": "~47.0.14",
+    "expo-splash-screen": "~0.17.5",
+    "expo-status-bar": "~1.4.2",
+    "react": "18.1.0",
+    "react-native": "0.70.8"
+  }
+}

package/plugin/__tests__/plugin.test.ts

@@ -0,0 +1,96 @@
+import { exec } from 'child_process';
+import path from 'path';
+import fs from 'fs/promises';
+import util from 'util';
+
+const execAsync = util.promisify(exec);
+
+describe('Expo Config Plugin Tests', () => {
+  const fixturesPath = path.join(__dirname, 'fixtures');
+  const testAppPath = path.join(__dirname, 'build');
+  const infoPlistPath = path.join(testAppPath, 'ios', 'example', 'Info.plist');
+  const androidManifestPath = path.join(
+    testAppPath,
+    'android',
+    'app',
+    'src',
+    'main',
+    'AndroidManifest.xml',
+  );
+
+  beforeEach(async () => {
+    await fs.rm(testAppPath, { recursive: true, force: true });
+    await fs.mkdir(testAppPath);
+    await fs.copyFile(path.join(fixturesPath, 'app.json'), path.join(testAppPath, 'app.json'));
+    await fs.copyFile(
+      path.join(fixturesPath, 'package.json'),
+      path.join(testAppPath, 'package.json'),
+    );
+  });
+
+  it('Technically requires no parameters', async () => {
+    await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+  });
+
+  it('Warns about missing androidAppId', async () => {
+    await fs.copyFile(
+      path.join(fixturesPath, 'app-without-params.json'),
+      path.join(testAppPath, 'app.json'),
+    );
+
+    const { stderr } = await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+    expect(stderr).toMatch(/No 'androidAppId' was provided/);
+  });
+
+  it('Warns about missing iosAppId', async () => {
+    await fs.copyFile(
+      path.join(fixturesPath, 'app-without-params.json'),
+      path.join(testAppPath, 'app.json'),
+    );
+
+    const { stderr } = await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+    expect(stderr).toMatch(/No 'iosAppId' was provided/);
+  });
+
+  it('Optimizes initialization on Android by default', async () => {
+    await fs.copyFile(
+      path.join(fixturesPath, 'app-without-params.json'),
+      path.join(testAppPath, 'app.json'),
+    );
+
+    await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+
+    const androidManifest = await fs.readFile(androidManifestPath, 'utf8');
+    expect(androidManifest).toContain(
+      '<meta-data android:name="com.google.android.gms.ads.flag.OPTIMIZE_INITIALIZATION" android:value="true" tools:replace="android:value"/>',
+    );
+  });
+
+  it('Optimizes ad loading on Android by default', async () => {
+    await fs.copyFile(
+      path.join(fixturesPath, 'app-without-params.json'),
+      path.join(testAppPath, 'app.json'),
+    );
+
+    await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+
+    const androidManifest = await fs.readFile(androidManifestPath, 'utf8');
+    expect(androidManifest).toContain(
+      '<meta-data android:name="com.google.android.gms.ads.flag.OPTIMIZE_AD_LOADING" android:value="true" tools:replace="android:value"/>',
+    );
+  });
+
+  it('Should modify AndroidManifest.xml', async () => {
+    await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+
+    const androidManifest = await fs.readFile(androidManifestPath, 'utf8');
+    expect(androidManifest).toMatchSnapshot();
+  });
+
+  it('Should modify Info.plist', async () => {
+    await execAsync(`yarn expo prebuild --no-install ${testAppPath}`);
+
+    const infoPlist = await fs.readFile(infoPlistPath, 'utf8');
+    expect(infoPlist).toMatchSnapshot();
+  });
+});

package/plugin/build/index.d.ts

@@ -0,0 +1,12 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+type PluginParameters = {
+    androidAppId?: string;
+    iosAppId?: string;
+    delayAppMeasurementInit?: boolean;
+    optimizeInitialization?: boolean;
+    optimizeAdLoading?: boolean;
+    skAdNetworkItems?: string[];
+    userTrackingUsageDescription?: string;
+};
+declare const withReactNativeGoogleMobileAds: ConfigPlugin<PluginParameters>;
+export default withReactNativeGoogleMobileAds;

package/plugin/build/index.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("@expo/config-plugins");
+function addReplacingMainApplicationMetaDataItem(manifest, itemName, itemValue) {
+    config_plugins_1.AndroidConfig.Manifest.ensureToolsAvailable(manifest);
+    const newItem = {
+        $: {
+            'android:name': itemName,
+            'android:value': itemValue,
+            'tools:replace': 'android:value',
+        },
+    };
+    const mainApplication = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(manifest);
+    mainApplication['meta-data'] = mainApplication['meta-data'] ?? [];
+    mainApplication['meta-data'].push(newItem);
+    return manifest;
+}
+const withAndroidAppId = (config, androidAppId) => {
+    if (androidAppId === undefined)
+        return config;
+    return (0, config_plugins_1.withAndroidManifest)(config, config => {
+        addReplacingMainApplicationMetaDataItem(config.modResults, 'com.google.android.gms.ads.APPLICATION_ID', androidAppId);
+        return config;
+    });
+};
+const withAndroidAppMeasurementInitDelayed = (config, delayAppMeasurementInit) => {
+    if (delayAppMeasurementInit === undefined)
+        return config;
+    return (0, config_plugins_1.withAndroidManifest)(config, config => {
+        addReplacingMainApplicationMetaDataItem(config.modResults, 'com.google.android.gms.ads.DELAY_APP_MEASUREMENT_INIT', delayAppMeasurementInit.toString());
+        return config;
+    });
+};
+const withAndroidInitializationOptimized = (config, optimizeInitialization = true) => {
+    return (0, config_plugins_1.withAndroidManifest)(config, config => {
+        addReplacingMainApplicationMetaDataItem(config.modResults, 'com.google.android.gms.ads.flag.OPTIMIZE_INITIALIZATION', optimizeInitialization.toString());
+        return config;
+    });
+};
+const withAndroidAdLoadingOptimized = (config, optimizeAdLoading = true) => {
+    return (0, config_plugins_1.withAndroidManifest)(config, config => {
+        addReplacingMainApplicationMetaDataItem(config.modResults, 'com.google.android.gms.ads.flag.OPTIMIZE_AD_LOADING', optimizeAdLoading.toString());
+        return config;
+    });
+};
+const withIosAppId = (config, iosAppId) => {
+    if (iosAppId === undefined)
+        return config;
+    return (0, config_plugins_1.withInfoPlist)(config, config => {
+        config.modResults.GADApplicationIdentifier = iosAppId;
+        return config;
+    });
+};
+const withIosAppMeasurementInitDelayed = (config, delayAppMeasurementInit = false) => {
+    return (0, config_plugins_1.withInfoPlist)(config, config => {
+        config.modResults.GADDelayAppMeasurementInit = delayAppMeasurementInit;
+        return config;
+    });
+};
+const withIosSkAdNetworkItems = (config, skAdNetworkItems) => {
+    if (skAdNetworkItems === undefined)
+        return config;
+    return (0, config_plugins_1.withInfoPlist)(config, config => {
+        config.modResults.SKAdNetworkItems = config.modResults.SKAdNetworkItems ?? [];
+        const existingIdentifiers = config.modResults.SKAdNetworkItems.map((item) => item.SKAdNetworkIdentifier);
+        const missingIdentifiers = skAdNetworkItems.filter(skAdNetworkItem => !existingIdentifiers.includes(skAdNetworkItem));
+        config.modResults.SKAdNetworkItems.push(...missingIdentifiers.map(identifier => ({
+            SKAdNetworkIdentifier: identifier,
+        })));
+        return config;
+    });
+};
+const withIosUserTrackingUsageDescription = (config, userTrackingUsageDescription) => {
+    if (userTrackingUsageDescription === undefined)
+        return config;
+    return (0, config_plugins_1.withInfoPlist)(config, config => {
+        config.modResults.NSUserTrackingUsageDescription = userTrackingUsageDescription;
+        return config;
+    });
+};
+const withReactNativeGoogleMobileAds = (config, { androidAppId, delayAppMeasurementInit, optimizeInitialization, optimizeAdLoading, iosAppId, skAdNetworkItems, userTrackingUsageDescription, } = {}) => {
+    if (androidAppId === undefined) {
+        console.warn("No 'androidAppId' was provided. The native Google Mobile Ads SDK will crash on Android without it.");
+    }
+    if (iosAppId === undefined) {
+        console.warn("No 'iosAppId' was provided. The native Google Mobile Ads SDK will crash on iOS without it.");
+    }
+    return (0, config_plugins_1.withPlugins)(config, [
+        // Android
+        [withAndroidAppId, androidAppId],
+        [withAndroidAppMeasurementInitDelayed, delayAppMeasurementInit],
+        [withAndroidInitializationOptimized, optimizeInitialization],
+        [withAndroidAdLoadingOptimized, optimizeAdLoading],
+        // iOS
+        [withIosAppId, iosAppId],
+        [withIosAppMeasurementInitDelayed, delayAppMeasurementInit],
+        [withIosSkAdNetworkItems, skAdNetworkItems],
+        [withIosUserTrackingUsageDescription, userTrackingUsageDescription],
+    ]);
+};
+exports.default = withReactNativeGoogleMobileAds;

package/plugin/jest.config.js

@@ -0,0 +1 @@
+module.exports = require("expo-module-scripts/jest-preset-plugin");

package/plugin/src/index.ts

@@ -0,0 +1,194 @@
+import {
+  AndroidConfig,
+  ConfigPlugin,
+  withAndroidManifest,
+  withPlugins,
+  withInfoPlist,
+} from '@expo/config-plugins';
+
+type PluginParameters = {
+  androidAppId?: string;
+  iosAppId?: string;
+  delayAppMeasurementInit?: boolean;
+  optimizeInitialization?: boolean;
+  optimizeAdLoading?: boolean;
+  skAdNetworkItems?: string[];
+  userTrackingUsageDescription?: string;
+};
+
+function addReplacingMainApplicationMetaDataItem(
+  manifest: AndroidConfig.Manifest.AndroidManifest,
+  itemName: string,
+  itemValue: string,
+): AndroidConfig.Manifest.AndroidManifest {
+  AndroidConfig.Manifest.ensureToolsAvailable(manifest);
+
+  const newItem = {
+    $: {
+      'android:name': itemName,
+      'android:value': itemValue,
+      'tools:replace': 'android:value',
+    },
+  } as AndroidConfig.Manifest.ManifestMetaData;
+
+  const mainApplication = AndroidConfig.Manifest.getMainApplicationOrThrow(manifest);
+  mainApplication['meta-data'] = mainApplication['meta-data'] ?? [];
+  mainApplication['meta-data'].push(newItem);
+
+  return manifest;
+}
+
+const withAndroidAppId: ConfigPlugin<PluginParameters['androidAppId']> = (config, androidAppId) => {
+  if (androidAppId === undefined) return config;
+
+  return withAndroidManifest(config, config => {
+    addReplacingMainApplicationMetaDataItem(
+      config.modResults,
+      'com.google.android.gms.ads.APPLICATION_ID',
+      androidAppId,
+    );
+
+    return config;
+  });
+};
+
+const withAndroidAppMeasurementInitDelayed: ConfigPlugin<
+  PluginParameters['delayAppMeasurementInit']
+> = (config, delayAppMeasurementInit) => {
+  if (delayAppMeasurementInit === undefined) return config;
+
+  return withAndroidManifest(config, config => {
+    addReplacingMainApplicationMetaDataItem(
+      config.modResults,
+      'com.google.android.gms.ads.DELAY_APP_MEASUREMENT_INIT',
+      delayAppMeasurementInit.toString(),
+    );
+
+    return config;
+  });
+};
+
+const withAndroidInitializationOptimized: ConfigPlugin<
+  PluginParameters['optimizeInitialization']
+> = (config, optimizeInitialization = true) => {
+  return withAndroidManifest(config, config => {
+    addReplacingMainApplicationMetaDataItem(
+      config.modResults,
+      'com.google.android.gms.ads.flag.OPTIMIZE_INITIALIZATION',
+      optimizeInitialization.toString(),
+    );
+
+    return config;
+  });
+};
+
+const withAndroidAdLoadingOptimized: ConfigPlugin<PluginParameters['optimizeAdLoading']> = (
+  config,
+  optimizeAdLoading = true,
+) => {
+  return withAndroidManifest(config, config => {
+    addReplacingMainApplicationMetaDataItem(
+      config.modResults,
+      'com.google.android.gms.ads.flag.OPTIMIZE_AD_LOADING',
+      optimizeAdLoading.toString(),
+    );
+
+    return config;
+  });
+};
+
+const withIosAppId: ConfigPlugin<PluginParameters['iosAppId']> = (config, iosAppId) => {
+  if (iosAppId === undefined) return config;
+
+  return withInfoPlist(config, config => {
+    config.modResults.GADApplicationIdentifier = iosAppId;
+    return config;
+  });
+};
+
+const withIosAppMeasurementInitDelayed: ConfigPlugin<
+  PluginParameters['delayAppMeasurementInit']
+> = (config, delayAppMeasurementInit = false) => {
+  return withInfoPlist(config, config => {
+    config.modResults.GADDelayAppMeasurementInit = delayAppMeasurementInit;
+    return config;
+  });
+};
+
+const withIosSkAdNetworkItems: ConfigPlugin<PluginParameters['skAdNetworkItems']> = (
+  config,
+  skAdNetworkItems,
+) => {
+  if (skAdNetworkItems === undefined) return config;
+
+  return withInfoPlist(config, config => {
+    config.modResults.SKAdNetworkItems = config.modResults.SKAdNetworkItems ?? [];
+
+    const existingIdentifiers = config.modResults.SKAdNetworkItems.map(
+      (item: { SKAdNetworkIdentifier: string }) => item.SKAdNetworkIdentifier,
+    );
+
+    const missingIdentifiers = skAdNetworkItems.filter(
+      skAdNetworkItem => !existingIdentifiers.includes(skAdNetworkItem),
+    );
+
+    config.modResults.SKAdNetworkItems.push(
+      ...missingIdentifiers.map(identifier => ({
+        SKAdNetworkIdentifier: identifier,
+      })),
+    );
+
+    return config;
+  });
+};
+
+const withIosUserTrackingUsageDescription: ConfigPlugin<
+  PluginParameters['userTrackingUsageDescription']
+> = (config, userTrackingUsageDescription) => {
+  if (userTrackingUsageDescription === undefined) return config;
+
+  return withInfoPlist(config, config => {
+    config.modResults.NSUserTrackingUsageDescription = userTrackingUsageDescription;
+    return config;
+  });
+};
+
+const withReactNativeGoogleMobileAds: ConfigPlugin<PluginParameters> = (
+  config,
+  {
+    androidAppId,
+    delayAppMeasurementInit,
+    optimizeInitialization,
+    optimizeAdLoading,
+    iosAppId,
+    skAdNetworkItems,
+    userTrackingUsageDescription,
+  } = {},
+) => {
+  if (androidAppId === undefined) {
+    console.warn(
+      "No 'androidAppId' was provided. The native Google Mobile Ads SDK will crash on Android without it.",
+    );
+  }
+
+  if (iosAppId === undefined) {
+    console.warn(
+      "No 'iosAppId' was provided. The native Google Mobile Ads SDK will crash on iOS without it.",
+    );
+  }
+
+  return withPlugins(config, [
+    // Android
+    [withAndroidAppId, androidAppId],
+    [withAndroidAppMeasurementInitDelayed, delayAppMeasurementInit],
+    [withAndroidInitializationOptimized, optimizeInitialization],
+    [withAndroidAdLoadingOptimized, optimizeAdLoading],
+    // iOS
+    [withIosAppId, iosAppId],
+    [withIosAppMeasurementInitDelayed, delayAppMeasurementInit],
+    [withIosSkAdNetworkItems, skAdNetworkItems],
+    [withIosUserTrackingUsageDescription, userTrackingUsageDescription],
+  ]);
+};
+
+export default withReactNativeGoogleMobileAds;

package/plugin/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "expo-module-scripts/tsconfig.plugin",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/src/ads/BaseAd.tsx

@@ -17,7 +17,7 @@
  */
 
 import React, { useState, useEffect } from 'react';
-import { NativeSyntheticEvent, Platform } from 'react-native';
+import { DimensionValue, NativeSyntheticEvent, Platform } from 'react-native';
 import { isFunction } from '../common';
 import { RevenuePrecisions } from '../common/constants';
 import { NativeError } from '../internal/NativeError';
@@ -34,7 +34,7 @@ export const BaseAd = React.forwardRef<
   React.ElementRef<typeof GoogleMobileAdsBannerView>,
   GAMBannerAdProps
 >(({ unitId, sizes, requestOptions, manualImpressionsEnabled, ...props }, ref) => {
-  const [dimensions, setDimensions] = useState<(number | string)[]>([0, 0]);
+  const [dimensions, setDimensions] = useState<(number | DimensionValue)[]>([0, 0]);
 
   const debouncedSetDimensions = debounce(setDimensions, 100);
 
@@ -157,7 +157,7 @@ export const BaseAd = React.forwardRef<
 
   const style = sizes.includes(GAMBannerAdSize.FLUID)
     ? {
-        width: '100%',
+        width: '100%' as DimensionValue,
         height: dimensions[1],
       }
     : {

package/src/ads/GoogleMobileAdsBannerViewNativeComponent.ts

@@ -32,6 +32,8 @@ interface NativeCommands {
   load: (viewRef: React.ElementRef<ComponentType>) => void;
 }
 
+// SyntaxError "'Commands' is a reserved export and may only be used to export the result of codegenNativeCommands"
+// @ts-ignore -- migration to react-native 0.73+
 export const Commands: NativeCommands = codegenNativeCommands<NativeCommands>({
   supportedCommands: ['recordManualImpression', 'load'],
 });

package/src/internal/GoogleMobileAdsNativeEventEmitter.ts

@@ -52,8 +52,11 @@ class GANativeEventEmitter extends NativeEventEmitter {
     const originalRemove = subscription.remove;
     const newRemove = () => {
       RNAppModule.eventsRemoveListener(eventType, false);
+      // This is for RN <= 0.64 - 65 and greater no longer have removeSubscription
+      // @ts-expect-error - "Property 'removeSubscription' does not exist on type 'NativeEventEmitter"
       if (super.removeSubscription != null) {
         // This is for RN <= 0.64 - 65 and greater no longer have removeSubscription
+        // @ts-expect-error - "Property 'removeSubscription' does not exist on type 'NativeEventEmitter"
         super.removeSubscription(subscription);
       } else if (originalRemove != null) {
         // This is for RN >= 0.65
@@ -72,7 +75,11 @@ class GANativeEventEmitter extends NativeEventEmitter {
   // This is likely no longer ever called, but it is here for backwards compatibility with RN <= 0.64
   removeSubscription(subscription: EmitterSubscription) {
     RNAppModule.eventsRemoveListener(subscription.eventType.replace('rnapp_', ''), false);
+    // This is for RN <= 0.64 - 65 and greater no longer have removeSubscription
+    // @ts-expect-error - "Property 'removeSubscription' does not exist on type 'NativeEventEmitter"
     if (super.removeSubscription != null) {
+      // This is for RN <= 0.64 - 65 and greater no longer have removeSubscription
+      // @ts-expect-error - "Property 'removeSubscription' does not exist on type 'NativeEventEmitter"
       super.removeSubscription(subscription);
     }
   }

package/src/internal/SharedEventEmitter.ts

@@ -15,8 +15,6 @@
  *
  */
 
-// @ts-ignore: Could not find a declaration file
-import Emitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
-import { EventEmitter } from 'react-native';
+import EventEmitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
 
-export const SharedEventEmitter: EventEmitter = new Emitter();
+export const SharedEventEmitter: EventEmitter = new EventEmitter();

package/src/types/BannerAdProps.ts

@@ -123,7 +123,7 @@ export interface GAMBannerAdProps extends Omit<BannerAdProps, 'size'> {
    *
    * Inventory must be available for the banner sizes specified, otherwise a no-fill error will be sent to `onAdFailedToLoad`.
    */
-  sizes: typeof GAMBannerAdSize[keyof typeof GAMBannerAdSize][] | string[];
+  sizes: (typeof GAMBannerAdSize)[keyof typeof GAMBannerAdSize][] | string[];
 
   /**
    * Whether to enable the manual impression counting.

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '13.6.0';
+export const version = '14.0.0';