react-native-google-mobile-ads 4.1.0

package/package.json

@@ -0,0 +1,143 @@
+{
+  "name": "react-native-google-mobile-ads",
+  "version": "4.1.0",
+  "author": "Invertase <oss@invertase.io> (http://invertase.io)",
+  "description": "React Native Google Mobile Ads is an easy way to monetize mobile apps with targeted, in-app advertising.",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "react-native": "src/index.ts",
+  "types": "lib/typescript/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/invertase/react-native-google-mobile-ads"
+  },
+  "license": "Apache-2.0",
+  "keywords": [
+    "react",
+    "react-native",
+    "admob",
+    "mobile ads",
+    "google ads",
+    "gdpr",
+    "banner ad",
+    "rewarded ad",
+    "interstitial",
+    "ad consent"
+  ],
+  "files": [
+    "/__tests__/",
+    "/android/",
+    "/docs/",
+    "/ios/",
+    "/lib/",
+    "/src/",
+    "/docs.json",
+    "/RNGoogleMobileAds.podspec",
+    "/babel.config.js",
+    "/jest.config.js",
+    "/jest.setup.ts",
+    "/ios_config.sh",
+    "/react-native.config.js"
+  ],
+  "sdkVersions": {
+    "ios": {
+      "googleAds": "8.13.0"
+    },
+    "android": {
+      "minSdk": 16,
+      "targetSdk": 30,
+      "compileSdk": 31,
+      "buildTools": "31.0.0",
+      "googleAds": "19.8.0"
+    }
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
+  },
+  "scripts": {
+    "prepare": "yarn build",
+    "build": "genversion --es6 --semi src/version.ts && bob build",
+    "build:clean": "rimraf android/build && rimraf ios/build && rimraf lib",
+    "lint:code": "yarn lint:js && yarn lint:android && yarn lint:ios:check",
+    "lint:js": "eslint src/ --ext .js,.jsx,.ts,.tsx --max-warnings=0",
+    "lint:android": "google-java-format --set-exit-if-changed --replace --glob=\"android/**/*.java\"",
+    "lint:ios:check": "clang-format --glob=\"ios/**/*.{h,cpp,m,mm}\" --style=Google -n -Werror",
+    "lint:ios:fix": "clang-format -i --glob=\"ios/**/*.{h,cpp,m,mm}\" --style=Google",
+    "lint:markdown:check": "prettier --check \"docs/**/*.md[x]\"",
+    "lint:markdown:fix": "prettier --write \"docs/**/*.md\"",
+    "lint:report": "eslint --output-file=eslint-report.json --format=json . --ext .js,.jsx,.ts,.tsx",
+    "lint:spellcheck": "spellchecker --quiet --files=\"docs/**/*.md\" --dictionaries=\"./.spellcheck.dict.txt\" --reports=\"spelling.json\" --plugins spell indefinite-article repeated-words syntax-mentions syntax-urls frontmatter",
+    "tsc:compile": "tsc --project . --noEmit",
+    "lint": "yarn lint:code && yarn tsc:compile",
+    "tests:jest": "jest",
+    "tests:jest-watch": "jest --watch",
+    "tests:jest-coverage": "jest --coverage",
+    "tests:packager": "cd example && yarn react-native start",
+    "tests:packager:reset-cache": "cd example && yarn react-native start --reset-cache",
+    "tests:android:build": "cd example && yarn detox build --configuration android.emu.debug",
+    "tests:android:build-release": "cd example && yarn detox build --configuration android.emu.release",
+    "tests:android:test": "cd example && yarn detox test --configuration android.emu.debug --loglevel trace",
+    "tests:android:test:debug": "cd example && yarn detox test --configuration android.emu.debug --inspect",
+    "tests:android:test-reuse": "cd example && yarn detox test --configuration android.emu.debug --reuse",
+    "tests:android:test-cover": "cd example && ./node_modules/.bin/nyc yarn detox test --loglevel trace --configuration android.emu.debug",
+    "tests:android:test-cover-reuse": "cd example && ./node_modules/.bin/nyc yarn detox test --configuration android.emu.debug --reuse",
+    "tests:ios:build": "cd example && yarn detox build --configuration ios.sim.debug",
+    "tests:ios:build-release": "cd example && yarn detox build --configuration ios.sim.release",
+    "tests:ios:test": "cd example && yarn detox test --configuration ios.sim.debug --loglevel warn",
+    "tests:ios:test:debug": "cd example && yarn detox test --configuration ios.sim.debug --loglevel warn --inspect",
+    "tests:ios:test-reuse": "cd example && yarn detox test --configuration ios.sim.debug --reuse --loglevel warn",
+    "tests:ios:test-cover": "cd example && ./node_modules/.bin/nyc yarn detox test --configuration ios.sim.debug",
+    "tests:ios:test-cover-reuse": "cd example && node_modules/.bin/nyc yarn detox test --configuration ios.sim.debug --reuse --loglevel warn",
+    "tests:ios:pod:install": "cd example && cd ios && rm -rf example.xcworkspace && rm -f Podfile.lock && pod install --repo-update && cd .."
+  },
+  "devDependencies": {
+    "@babel/core": "^7.16.0",
+    "@babel/preset-env": "^7.16.4",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^8.0.2",
+    "@semantic-release/npm": "^8.0.3",
+    "@semantic-release/release-notes-generator": "^10.0.3",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^16.11.12",
+    "@types/react": "^17.0.37",
+    "@types/react-native": "^0.66.8",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
+    "babel-jest": "^27.4.2",
+    "clang-format": "^1.6.0",
+    "codecov": "^3.8.3",
+    "conventional-changelog-cli": "^2.0.34",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-jest": "^25.3.0",
+    "eslint-plugin-mocha": "^10.0.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.27.1",
+    "genversion": "^3.0.2",
+    "google-java-format": "^1.0.1",
+    "inquirer": "^8.2.0",
+    "jest": "^27.4.3",
+    "lerna": "4.0.0",
+    "prettier": "^2.5.1",
+    "react": "^17.0.2",
+    "react-native": "0.66.3",
+    "react-native-builder-bob": "^0.18.2",
+    "rimraf": "^3.0.2",
+    "semantic-release": "^18.0.1",
+    "shelljs": "^0.8.3",
+    "ts-jest": "^27.1.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/react-native.config.js

@@ -0,0 +1,19 @@
+module.exports = {
+  dependency: {
+    platforms: {
+      android: {
+        packageImportPath: 'import io.invertase.googlemobileads.ReactNativeGoogleMobileAdsPackage;',
+      },
+      ios: {
+        scriptPhases: [
+          {
+            name: '[RNGoogleMobileAds] Configuration',
+            path: './ios_config.sh',
+            execution_position: 'after_compile',
+            input_files: ['$(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)'],
+          },
+        ],
+      },
+    },
+  },
+};

package/src/AdEventType.ts

@@ -0,0 +1,68 @@
+/*
+ * 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.
+ *
+ */
+
+export enum AdEventType {
+  /**
+   * When an ad has loaded. At this point, the ad is ready to be shown to the user.
+   *
+   * #### Example
+   *
+   * ```js
+   * import { AdEventType } from 'react-native-google-mobile-ads';
+   *
+   * advert.onAdEvent((type,error,data) => {
+   *   if (type === AdEventType.LOADED) {
+   *     advert.show();
+   *   }
+   * });
+   * ```
+   */
+  LOADED = 'loaded',
+
+  /**
+   * The ad has thrown an error. See the error parameter the listener callback for more information.
+   *
+   * #### Example
+   *
+   * ```js
+   * import { AdEventType } from 'react-native-google-mobile-ads';
+   *
+   * advert.onAdEvent((type, error, data) => {
+   *   if (type === AdEventType.ERROR) {
+   *     console.log('Ad error:', error);
+   *   }
+   * });
+   * ```
+   */
+  ERROR = 'error',
+
+  /**
+   * The ad opened and is currently visible to the user. This event is fired after the `show()`
+   * method has been called.
+   */
+  OPENED = 'opened',
+
+  /**
+   * The user clicked the advert.
+   */
+  CLICKED = 'clicked',
+
+  /**
+   * The user closed the ad and has returned back to your application.
+   */
+  CLOSED = 'closed',
+}

package/src/AdsConsent.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 {
+  hasOwnProperty,
+  isArray,
+  isBoolean,
+  isObject,
+  isString,
+  isUndefined,
+  isValidUrl,
+} from './common';
+import { NativeModules } from 'react-native';
+import { AdsConsentDebugGeography } from './AdsConsentDebugGeography';
+import { AdsConsentStatus } from './AdsConsentStatus';
+import { AdsConsentInterface } from './types/AdsConsent.interface';
+
+const native = NativeModules.RNGoogleAdsConsentModule;
+
+export const AdsConsent: AdsConsentInterface = {
+  /**
+   *
+   * @param publisherIds
+   * @returns {*}
+   */
+  requestInfoUpdate(publisherIds) {
+    if (!isArray(publisherIds)) {
+      throw new Error(
+        "AdsConsent.requestInfoUpdate(*) 'publisherIds' expected an array of string values.",
+      );
+    }
+
+    if (publisherIds.length === 0) {
+      throw new Error(
+        "AdsConsent.requestInfoUpdate(*) 'publisherIds' list of publisher IDs cannot be empty.",
+      );
+    }
+
+    for (let i = 0; i < publisherIds.length; i++) {
+      if (!isString(publisherIds[i])) {
+        throw new Error(
+          `AdsConsent.requestInfoUpdate(*) 'publisherIds[${i}]' expected a string value.`,
+        );
+      }
+    }
+
+    return native.requestInfoUpdate(publisherIds);
+  },
+
+  /**
+   *
+   * @param options
+   * @returns {*}
+   */
+  showForm(options) {
+    if (!isUndefined(options) && !isObject(options)) {
+      throw new Error("AdsConsent.showForm(*) 'options' expected an object value.");
+    }
+
+    if (!isValidUrl(options.privacyPolicy)) {
+      throw new Error(
+        "AdsConsent.showForm(*) 'options.privacyPolicy' expected a valid HTTP or HTTPS URL.",
+      );
+    }
+
+    if (hasOwnProperty(options, 'withPersonalizedAds') && !isBoolean(options.withPersonalizedAds)) {
+      throw new Error(
+        "AdsConsent.showForm(*) 'options.withPersonalizedAds' expected a boolean value.",
+      );
+    }
+
+    if (
+      hasOwnProperty(options, 'withNonPersonalizedAds') &&
+      !isBoolean(options.withNonPersonalizedAds)
+    ) {
+      throw new Error(
+        "AdsConsent.showForm(*) 'options.withNonPersonalizedAds' expected a boolean value.",
+      );
+    }
+
+    if (hasOwnProperty(options, 'withAdFree') && !isBoolean(options.withAdFree)) {
+      throw new Error("AdsConsent.showForm(*) 'options.withAdFree' expected a boolean value.");
+    }
+
+    if (!options.withPersonalizedAds && !options.withNonPersonalizedAds && !options.withAdFree) {
+      throw new Error(
+        "AdsConsent.showForm(*) 'options' form requires at least one option to be enabled.",
+      );
+    }
+
+    return native.showForm(options);
+  },
+
+  /**
+   *
+   */
+  getAdProviders() {
+    return native.getAdProviders();
+  },
+
+  /**
+   *
+   * @param geography
+   */
+  setDebugGeography(geography) {
+    if (
+      geography !== AdsConsentDebugGeography.DISABLED &&
+      geography !== AdsConsentDebugGeography.EEA &&
+      geography !== AdsConsentDebugGeography.NOT_EEA
+    ) {
+      throw new Error(
+        "AdsConsent.setDebugGeography(*) 'geography' expected one of AdsConsentDebugGeography.DISABLED, AdsConsentDebugGeography.EEA or AdsConsentDebugGeography.NOT_EEA.",
+      );
+    }
+
+    return native.setDebugGeography(geography);
+  },
+
+  /**
+   *
+   */
+  getStatus() {
+    return native.getStatus();
+  },
+
+  /**
+   *
+   * @param status
+   */
+  setStatus(status) {
+    if (
+      status !== AdsConsentStatus.UNKNOWN &&
+      status !== AdsConsentStatus.NON_PERSONALIZED &&
+      status !== AdsConsentStatus.PERSONALIZED
+    ) {
+      throw new Error(
+        "AdsConsent.setStatus(*) 'status' expected one of AdsConsentStatus.UNKNOWN, AdsConsentStatus.NON_PERSONALIZED or AdsConsentStatus.PERSONALIZED.",
+      );
+    }
+
+    return native.setStatus(status);
+  },
+
+  /**
+   *
+   * @param tag
+   */
+  setTagForUnderAgeOfConsent(tag) {
+    if (!isBoolean(tag)) {
+      throw new Error("AdsConsent.setTagForUnderAgeOfConsent(*) 'tag' expected a boolean value.");
+    }
+
+    return native.setTagForUnderAgeOfConsent(tag);
+  },
+
+  /**
+   *
+   * @param deviceIds
+   */
+  addTestDevices(deviceIds) {
+    if (!isArray(deviceIds)) {
+      throw new Error(
+        "AdsConsent.addTestDevices(*) 'deviceIds' expected an array of string values.",
+      );
+    }
+
+    for (let i = 0; i < deviceIds.length; i++) {
+      if (!isString(deviceIds[i])) {
+        throw new Error(
+          "AdsConsent.addTestDevices(*) 'deviceIds' expected an array of string values.",
+        );
+      }
+    }
+
+    return native.addTestDevices(deviceIds);
+  },
+};

package/src/AdsConsentDebugGeography.ts

@@ -0,0 +1,38 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * AdsConsentDebugGeography enum.
+ *
+ * Used to set a mock location when testing the `AdsConsent` helper.
+ */
+export enum AdsConsentDebugGeography {
+  /**
+   * Disable any debug geography.
+   */
+  DISABLED = 0,
+
+  /**
+   * Sets the location to within the EEA.
+   */
+  EEA = 1,
+
+  /**
+   * Sets the location to outside of the EEA.
+   */
+  NOT_EEA = 2,
+}

package/src/AdsConsentStatus.ts

@@ -0,0 +1,36 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * AdsConsentStatus enum.
+ */
+export enum AdsConsentStatus {
+  /**
+   * The consent status is unknown and the user must provide consent to show ads if they are within the EEA or location is also unknown.
+   */
+  UNKNOWN = 0,
+
+  /**
+   * The user has accepted non-personalized ads.
+   */
+  NON_PERSONALIZED = 1,
+
+  /**
+   * The user has accepted personalized ads.
+   */
+  PERSONALIZED = 2,
+}

package/src/BannerAdSize.ts

@@ -0,0 +1,59 @@
+/*
+ * 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.
+ *
+ *
+ */
+
+export enum BannerAdSize {
+  /**
+   * Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels).
+   */
+  BANNER = 'BANNER',
+
+  /**
+   * Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels).
+   */
+  FULL_BANNER = 'FULL_BANNER',
+
+  /**
+   * Large banner ad size (320x100 density-independent pixels).
+   */
+  LARGE_BANNER = 'LARGE_BANNER',
+
+  /**
+   * Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels).
+   */
+  LEADERBOARD = 'LEADERBOARD',
+
+  /**
+   * Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels).
+   */
+  MEDIUM_RECTANGLE = 'MEDIUM_RECTANGLE',
+
+  /**
+   * A (next generation) dynamically sized banner that is full-width and auto-height.
+   */
+  ADAPTIVE_BANNER = 'ADAPTIVE_BANNER',
+
+  /**
+   * A dynamically sized banner that matches its parent's width and expands/contracts its height to match the ad's content after loading completes.
+   */
+  FLUID = 'FLUID',
+
+  /**
+   * IAB wide skyscraper ad size (160x600 density-independent pixels). This size is currently not supported by the Google Mobile Ads network; this is intended for mediation ad networks only.
+   */
+  WIDE_SKYSCRAPER = 'WIDE_SKYSCRAPER',
+}

package/src/MaxAdContentRating.ts

@@ -0,0 +1,38 @@
+/*
+ * 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.
+ *
+ */
+
+export enum MaxAdContentRating {
+  /**
+   * "General audiences." Content suitable for all audiences, including families and children.
+   */
+  G = 'G',
+
+  /**
+   * "Parental guidance." Content suitable for most audiences with parental guidance, including topics like non-realistic, cartoonish violence.
+   */
+  PG = 'PG',
+
+  /**
+   * T: "Teen." Content suitable for teen and older audiences, including topics such as general health, social networks, scary imagery, and fight sports.
+   */
+  T = 'T',
+
+  /**
+   * "Mature audiences." Content suitable only for mature audiences; includes topics such as alcohol, gambling, sexual content, and weapons.
+   */
+  MA = 'MA',
+}

package/src/MobileAds.ts

@@ -0,0 +1,84 @@
+import { Module } from './internal';
+import { validateAdRequestConfiguration } from './validateAdRequestConfiguration';
+import { version } from './version';
+import { MobileAdsModuleInterface } from './types/MobileAdsModule.interface';
+import { RequestConfiguration } from './types/RequestConfiguration';
+import { App, Config } from './types/Module.interface';
+
+const namespace = 'google_mobile_ads';
+
+const nativeModuleName = [
+  'RNGoogleMobileAdsModule',
+  'RNGoogleMobileAdsAppOpenModule',
+  'RNGoogleMobileAdsInterstitialModule',
+  'RNGoogleMobileAdsRewardedModule',
+];
+
+type Event = {
+  adUnitId: string;
+  requestId: number;
+};
+
+class MobileAdsModule extends Module implements MobileAdsModuleInterface {
+  constructor(app: App, config: Config) {
+    super(app, config);
+
+    this.emitter.addListener('google_mobile_ads_app_open_event', (event: Event) => {
+      this.emitter.emit(
+        `google_mobile_ads_app_open_event:${event.adUnitId}:${event.requestId}`,
+        event,
+      );
+    });
+
+    this.emitter.addListener('google_mobile_ads_interstitial_event', (event: Event) => {
+      this.emitter.emit(
+        `google_mobile_ads_interstitial_event:${event.adUnitId}:${event.requestId}`,
+        event,
+      );
+    });
+
+    this.emitter.addListener('google_mobile_ads_rewarded_event', (event: Event) => {
+      this.emitter.emit(
+        `google_mobile_ads_rewarded_event:${event.adUnitId}:${event.requestId}`,
+        event,
+      );
+    });
+  }
+
+  initialize() {
+    return this.native.initialize();
+  }
+
+  setRequestConfiguration(requestConfiguration: RequestConfiguration) {
+    let config;
+    try {
+      config = validateAdRequestConfiguration(requestConfiguration);
+    } catch (e) {
+      if (e instanceof Error) {
+        throw new Error(`googleMobileAds.setRequestConfiguration(*) ${e.message}`);
+      }
+    }
+
+    return this.native.setRequestConfiguration(config);
+  }
+}
+
+const MobileAdsInstance = new MobileAdsModule(
+  { name: 'AppName' },
+  {
+    version,
+    namespace,
+    nativeModuleName,
+    nativeEvents: [
+      'google_mobile_ads_app_open_event',
+      'google_mobile_ads_interstitial_event',
+      'google_mobile_ads_rewarded_event',
+    ],
+  },
+);
+
+export const MobileAds = () => {
+  return MobileAdsInstance;
+};
+
+export default MobileAds;