react-native-google-mobile-ads 4.1.0

package/src/common/path.ts

@@ -0,0 +1,114 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * Returns the next parent of the path e.g. /foo/bar/car -> /foo/bar
+ */
+export function pathParent(path: string) {
+  if (path.length === 0) {
+    return null;
+  }
+
+  const index = path.lastIndexOf('/');
+  if (index <= 0) {
+    return null;
+  }
+
+  return path.slice(0, index);
+}
+
+/**
+ * Joins a parent and a child path
+ */
+export function pathChild(path: string, childPath: string) {
+  const canonicalChildPath = pathPieces(childPath).join('/');
+
+  if (path.length === 0) {
+    return canonicalChildPath;
+  }
+
+  return `${path}/${canonicalChildPath}`;
+}
+
+/**
+ * Returns the last component of a path, e.g /foo/bar.jpeg -> bar.jpeg
+ */
+export function pathLastComponent(path: string) {
+  const index = path.lastIndexOf('/', path.length - 2);
+  if (index === -1) {
+    return path;
+  }
+
+  return path.slice(index + 1);
+}
+
+/**
+ * Returns all none empty pieces of the path
+ * @param path
+ * @returns {*}
+ */
+export function pathPieces(path: string) {
+  return path.split('/').filter($ => $.length > 0);
+}
+
+/**
+ * Returns whether a given path is empty
+ * @param path
+ * @returns {boolean}
+ */
+export function pathIsEmpty(path: string) {
+  return !pathPieces(path).length;
+}
+
+/**
+ * Converts a given path to a URL encoded string
+ * @param path
+ * @returns {string|string}
+ */
+export function pathToUrlEncodedString(path: string) {
+  const pieces = pathPieces(path);
+  let pathString = '';
+  for (let i = 0; i < pieces.length; i++) {
+    pathString += `/${encodeURIComponent(String(pieces[i]))}`;
+  }
+  return pathString || '/';
+}
+
+// eslint-disable-next-line no-control-regex
+export const INVALID_PATH_REGEX = /[[\].#$\u0000-\u001F\u007F]/;
+
+/**
+ * Ensures a given path is a valid Firebase path
+ * @param path
+ * @returns {boolean}
+ */
+export function isValidPath(path: unknown) {
+  return typeof path === 'string' && path.length !== 0 && !INVALID_PATH_REGEX.test(path);
+}
+
+/**
+ * Converts a file path to a standardized string path
+ * @param path
+ * @returns {*}
+ */
+export function toFilePath(path: string) {
+  let _filePath = path.replace('file://', '');
+  if (_filePath.includes('%')) {
+    _filePath = decodeURIComponent(_filePath);
+  }
+  return _filePath;
+}

package/src/common/promise.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 { isFunction } from './validate';
+
+/**
+ *
+ */
+export function promiseDefer() {
+  const deferred: {
+    promise: Promise<unknown> | null;
+    resolve: (value: unknown) => void;
+    reject: (value: unknown) => void;
+  } = { promise: null, resolve: () => {}, reject: () => {} };
+
+  deferred.promise = new Promise((resolve, reject) => {
+    deferred.resolve = resolve;
+    deferred.reject = reject;
+  });
+
+  return deferred;
+}
+
+/**
+ * @param promise
+ * @param callback
+ */
+export function promiseWithOptionalCallback(
+  promise: Promise<unknown>,
+  callback: (a: unknown, b?: unknown) => void,
+) {
+  if (!isFunction(callback)) {
+    return promise;
+  }
+
+  return promise
+    .then(result => {
+      if (callback && callback.length === 1) {
+        callback(null);
+      } else if (callback) {
+        callback(null, result);
+      }
+
+      return result;
+    })
+    .catch(error => {
+      if (callback) {
+        callback(error);
+      }
+      return Promise.reject(error);
+    });
+}

package/src/common/serialize.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 { tryJSONParse, tryJSONStringify } from './index';
+import { isObject } from './validate';
+
+export function serializeType(value: unknown) {
+  if (isObject(value)) {
+    return {
+      type: 'object',
+      value: serializeObject(value),
+    };
+  }
+
+  return {
+    type: typeof value,
+    value,
+  };
+}
+
+export function serializeObject(object: unknown) {
+  if (!isObject(object)) {
+    return object;
+  }
+
+  // json stringify then parse it calls toString on Objects / Classes
+  // that support it i.e new Date() becomes a ISO string.
+  return tryJSONParse(tryJSONStringify(object) || '');
+}

package/src/common/validate.ts

@@ -0,0 +1,205 @@
+/*
+ * 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 { Platform } from 'react-native';
+
+const AlphaNumericUnderscore = /^[a-zA-Z0-9_]+$/;
+
+export function objectKeyValuesAreStrings(object: Record<string, unknown>) {
+  if (!isObject(object)) {
+    return false;
+  }
+
+  const entries = Object.entries(object);
+
+  for (let i = 0; i < entries.length; i++) {
+    const [key, value] = entries[i];
+    if (!isString(key) || !isString(value)) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+/**
+ * Simple is null check.
+ *
+ * @param value
+ * @returns {boolean}
+ */
+export function isNull(value: unknown) {
+  return value === null;
+}
+
+/**
+ * Simple is object check.
+ *
+ * @param value
+ * @returns {boolean}
+ */
+export function isObject(value: unknown) {
+  return value ? typeof value === 'object' && !Array.isArray(value) && !isNull(value) : false;
+}
+
+/**
+ * Simple is date check
+ * https://stackoverflow.com/a/44198641
+ * @param value
+ * @returns {boolean}
+ */
+export function isDate(value: number) {
+  // use the global isNaN() and not Number.isNaN() since it will validate an Invalid Date
+  return value && Object.prototype.toString.call(value) === '[object Date]' && !isNaN(value);
+}
+
+/**
+ * Simple is function check
+ *
+ * @param value
+ * @returns {*|boolean}
+ */
+export function isFunction(value: unknown) {
+  return value ? typeof value === 'function' : false;
+}
+
+/**
+ * Simple is string check
+ * @param value
+ * @return {boolean}
+ */
+export function isString(value: unknown) {
+  return typeof value === 'string';
+}
+
+/**
+ * Simple is number check
+ * @param value
+ * @return {boolean}
+ */
+export function isNumber(value: unknown): value is number {
+  return typeof value === 'number';
+}
+
+/**
+ * Simple finite check
+ * @param value
+ * @returns {boolean}
+ */
+export function isFinite(value: unknown) {
+  return Number.isFinite(value);
+}
+
+/**
+ * Simple integer check
+ * @param value
+ * @returns {boolean}
+ */
+export function isInteger(value: unknown) {
+  return Number.isInteger(value);
+}
+
+/**
+ * Simple is boolean check
+ *
+ * @param value
+ * @return {boolean}
+ */
+export function isBoolean(value: unknown) {
+  return typeof value === 'boolean';
+}
+
+/**
+ *
+ * @param value
+ * @returns {arg is Array<unknown>}
+ */
+export function isArray(value: unknown) {
+  return Array.isArray(value);
+}
+
+/**
+ *
+ * @param value
+ * @returns {boolean}
+ */
+export function isUndefined(value: unknown): value is undefined {
+  return typeof value === 'undefined';
+}
+
+/**
+ * /^[a-zA-Z0-9_]+$/
+ *
+ * @param value
+ * @returns {boolean}
+ */
+export function isAlphaNumericUnderscore(value: string) {
+  return AlphaNumericUnderscore.test(value);
+}
+
+/**
+ * URL test
+ * @param url
+ * @returns {boolean}
+ */
+const IS_VALID_URL_REGEX = /^(http|https):\/\/[^ "]+$/;
+export function isValidUrl(url: string) {
+  return IS_VALID_URL_REGEX.test(url);
+}
+
+/**
+ * Array includes
+ *
+ * @param value
+ * @param oneOf
+ * @returns {boolean}
+ */
+export function isOneOf(value: unknown, oneOf: unknown[] = []) {
+  if (!isArray(oneOf)) {
+    return false;
+  }
+  return oneOf.includes(value);
+}
+
+export function noop() {
+  // noop-🐈
+}
+
+export function validateOptionalNativeDependencyExists(
+  firebaseJsonKey: string,
+  apiName: string,
+  nativeFnExists: boolean,
+) {
+  if (nativeFnExists) {
+    return;
+  }
+  let errorMessage =
+    "You attempted to use an optional API that's not enabled natively. \n\n To enable ";
+
+  errorMessage += apiName;
+  errorMessage += ` please set the 'react-native' -> '${firebaseJsonKey}' key to true in your firebase.json file`;
+
+  if (Platform.OS === 'android') {
+    errorMessage += ' and rebuild your Android app.';
+  } else {
+    errorMessage +=
+      ', re-run pod install and rebuild your iOS app. ' +
+      "If you're not using Pods then make sure you've have downloaded the necessary Firebase iOS SDK dependencies for this API.";
+  }
+
+  throw new Error(errorMessage);
+}

package/src/declarations.d.ts

@@ -0,0 +1,3 @@
+declare module 'react-native/Libraries/Utilities/binaryToBase64' {
+  export default function binaryToBase64(data: ArrayBuffer | Uint8Array): string;
+}

package/src/index.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { version } from './version';
+
+// import { SDK_VERSION } from 'react-native-google-mobile-ads';
+export const SDK_VERSION = version;
+
+export { default, MobileAds } from './MobileAds';
+export { AdsConsentDebugGeography } from './AdsConsentDebugGeography';
+export { AdsConsentStatus } from './AdsConsentStatus';
+export { MaxAdContentRating } from './MaxAdContentRating';
+export { TestIds } from './TestIds';
+export { AdEventType } from './AdEventType';
+export { BannerAdSize } from './BannerAdSize';
+export { RewardedAdEventType } from './RewardedAdEventType';
+export { AdsConsent } from './AdsConsent';
+export { AppOpenAd } from './ads/AppOpenAd';
+export { InterstitialAd } from './ads/InterstitialAd';
+export { RewardedAd } from './ads/RewardedAd';
+export { BannerAd } from './ads/BannerAd';

package/src/internal/GoogleMobileAdsNativeEventEmitter.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 { NativeEventEmitter, NativeModules, EmitterSubscription } from 'react-native';
+
+const { RNAppModule } = NativeModules;
+
+class GANativeEventEmitter extends NativeEventEmitter {
+  ready: boolean;
+
+  constructor() {
+    super(RNAppModule);
+    this.ready = false;
+  }
+
+  addListener(
+    eventType: string,
+    listener: (event: { appName?: string }) => void,
+    context?: Record<string, unknown>,
+  ) {
+    if (!this.ready) {
+      RNAppModule.eventsNotifyReady(true);
+      this.ready = true;
+    }
+    RNAppModule.eventsAddListener(eventType);
+
+    const subscription = super.addListener(`rnapp_${eventType}`, listener, context);
+
+    // React Native 0.65+ altered EventEmitter:
+    // - removeSubscription is gone
+    // - addListener returns an unsubscriber instead of a more complex object with eventType etc
+
+    // make sure eventType for backwards compatibility just in case
+    subscription.eventType = `rnapp_${eventType}`;
+
+    // New style is to return a remove function on the object, just in csae people call that,
+    // we will modify it to do our native unsubscription then call the original
+    const originalRemove = subscription.remove;
+    const newRemove = () => {
+      RNAppModule.eventsRemoveListener(eventType, false);
+      if (super.removeSubscription != null) {
+        // This is for RN <= 0.64 - 65 and greater no longer have removeSubscription
+        super.removeSubscription(subscription);
+      } else if (originalRemove != null) {
+        // This is for RN >= 0.65
+        originalRemove();
+      }
+    };
+    subscription.remove = newRemove;
+    return subscription;
+  }
+
+  removeAllListeners(eventType: string) {
+    RNAppModule.eventsRemoveListener(eventType, true);
+    super.removeAllListeners(`rnapp_${eventType}`);
+  }
+
+  // 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);
+    if (super.removeSubscription != null) {
+      super.removeSubscription(subscription);
+    }
+  }
+}
+
+export const GoogleMobileAdsNativeEventEmitter = new GANativeEventEmitter();

package/src/internal/Module.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 { getNativeModule } from './registry/nativeModule';
+import { SharedEventEmitter } from './SharedEventEmitter';
+import { App, Config } from '../types/Module.interface';
+import { GoogleMobileAdsNativeModule } from '../types/GoogleMobileAdsNativeModule';
+
+export class AppModule {
+  _app: App;
+  _nativeModule: unknown;
+  _config: Config;
+
+  static __extended__ = {};
+
+  constructor(app: App, config: Config) {
+    this._app = app;
+    this._nativeModule = null;
+    this._config = Object.assign({}, config);
+  }
+
+  get app() {
+    return this._app;
+  }
+
+  get emitter() {
+    return SharedEventEmitter;
+  }
+
+  eventNameForApp(...args: string[]) {
+    return `${this.app.name}-${args.join('-')}`;
+  }
+
+  get native() {
+    if (this._nativeModule) {
+      return this._nativeModule as GoogleMobileAdsNativeModule;
+    }
+    this._nativeModule = getNativeModule(this);
+    return this._nativeModule as GoogleMobileAdsNativeModule;
+  }
+}
+
+// Instance of checks don't work once compiled
+AppModule.__extended__ = {};

package/src/internal/NativeError.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 class NativeError extends Error {
+  namespace: string;
+  code: string;
+  message: string;
+  jsStack: string;
+  userInfo: { code: string; message: string };
+
+  static fromEvent(
+    errorEvent: { code: string; message: string },
+    namespace: string,
+    stack?: string,
+  ) {
+    return new NativeError({ userInfo: errorEvent }, stack || new Error().stack || '', namespace);
+  }
+
+  constructor(
+    nativeError: { userInfo: { code: string; message: string } },
+    jsStack: string,
+    namespace: string,
+  ) {
+    super();
+    const { userInfo } = nativeError;
+    this.namespace = namespace;
+    this.code = `${this.namespace}/${userInfo.code || 'unknown'}`;
+    this.message = `[${this.code}] ${userInfo.message}`;
+    this.jsStack = jsStack;
+    this.userInfo = userInfo;
+    this.stack = NativeError.getStackWithMessage(`NativeError: ${this.message}`, this.jsStack);
+  }
+
+  /**
+   * Build a stack trace that includes JS stack prior to calling the native method.
+   *
+   * @returns {string}
+   */
+  static getStackWithMessage(message: string, jsStack: string) {
+    return [message, ...jsStack.split('\n').slice(2, 13)].join('\n');
+  }
+}

package/src/internal/SharedEventEmitter.ts

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ *
+ */
+
+// @ts-ignore: Could not find a declaration file
+import Emitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
+import { EventEmitter } from 'react-native';
+
+export const SharedEventEmitter: EventEmitter = new Emitter();