react-native-google-mobile-ads 14.7.2 → 14.8.1

package/src/ads/native-ad/NativeAdView.tsx

@@ -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 React, { useRef } from 'react';
+import { ViewProps } from 'react-native';
+import { NativeAd } from './NativeAd';
+import { NativeAdContext } from './NativeAdContext';
+import GoogleMobileAdsNativeView from '../../specs/components/GoogleMobileAdsNativeViewNativeComponent';
+
+export type NativeAdViewProps = ViewProps & {
+  nativeAd: NativeAd;
+};
+
+export const NativeAdView = (props: NativeAdViewProps) => {
+  const { nativeAd, children, ...viewProps } = props;
+  const ref = useRef<React.ElementRef<typeof GoogleMobileAdsNativeView>>(null);
+  return (
+    <GoogleMobileAdsNativeView
+      {...viewProps}
+      ref={ref}
+      responseId={nativeAd.responseId}
+      removeClippedSubviews={false}
+    >
+      <NativeAdContext.Provider value={{ nativeAd, viewRef: ref }}>
+        {children}
+      </NativeAdContext.Provider>
+    </GoogleMobileAdsNativeView>
+  );
+};

package/src/ads/native-ad/NativeAsset.tsx

@@ -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 React, { ReactElement, useContext, useEffect, useRef } from 'react';
+import { findNodeHandle } from 'react-native';
+import { NativeAdContext } from './NativeAdContext';
+import { Commands } from '../../specs/components/GoogleMobileAdsNativeViewNativeComponent';
+import { composeRefs, getElementRef } from '../../common/ref';
+
+export enum NativeAssetType {
+  ADVERTISER = 'advertiser',
+  BODY = 'body',
+  CALL_TO_ACTION = 'callToAction',
+  HEADLINE = 'headline',
+  PRICE = 'price',
+  STORE = 'store',
+  STAR_RATING = 'starRating',
+  ICON = 'icon',
+  IMAGE = 'image',
+}
+
+export type NativeAssetProps = {
+  assetType: NativeAssetType;
+  children: ReactElement;
+};
+
+export const NativeAsset = (props: NativeAssetProps) => {
+  const { assetType, children } = props;
+  const { viewRef } = useContext(NativeAdContext);
+  const ref = useRef<React.Component>(null);
+
+  useEffect(() => {
+    if (!viewRef.current) {
+      return;
+    }
+    const node = ref.current;
+    const reactTag = findNodeHandle(node);
+    if (reactTag) {
+      Commands.registerAsset(viewRef.current, assetType, reactTag);
+    }
+  }, [viewRef]);
+
+  if (!React.isValidElement(children)) {
+    return null;
+  }
+
+  const childrenRef = getElementRef(children);
+  return React.cloneElement(children, {
+    // @ts-ignore
+    ref: composeRefs(ref, childrenRef),
+  }) as ReactElement;
+};

package/src/ads/native-ad/NativeMediaView.tsx

@@ -0,0 +1,44 @@
+/*
+ * 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 React, { useContext } from 'react';
+import { ViewProps } from 'react-native';
+import GoogleMobileAdsMediaView from '../../specs/components/GoogleMobileAdsMediaViewNativeComponent';
+import { NativeAsset } from './NativeAsset';
+import { NativeAdContext } from './NativeAdContext';
+
+export type NativeMediaViewProps = ViewProps & {
+  resizeMode?: 'cover' | 'contain' | 'stretch';
+};
+
+export const NativeMediaView = (props: NativeMediaViewProps) => {
+  const { resizeMode, style, ...viewProps } = props;
+  const { nativeAd } = useContext(NativeAdContext);
+  const { responseId, mediaContent } = nativeAd;
+
+  return (
+    // @ts-ignore
+    <NativeAsset assetType={'media'}>
+      <GoogleMobileAdsMediaView
+        {...viewProps}
+        responseId={responseId}
+        resizeMode={resizeMode}
+        style={[{ aspectRatio: mediaContent?.aspectRatio }, style]}
+      />
+    </NativeAsset>
+  );
+};

package/src/common/ref.ts

@@ -0,0 +1,44 @@
+import React from 'react';
+
+type PossibleRef<T> = React.Ref<T> | undefined;
+interface ElementWithRef extends React.ReactElement {
+  ref?: PossibleRef<unknown>;
+}
+
+/**
+ * Access the ref using the method that doesn't yield a warning.
+ *
+ * Before React 19 accessing `element.props.ref` will throw a warning and suggest using `element.ref`
+ * After React 19 accessing `element.ref` does the opposite.
+ * https://github.com/facebook/react/pull/28348
+ */
+export function getElementRef(element: React.ReactElement): PossibleRef<unknown> {
+  // React <=18 in DEV
+  let getter = Object.getOwnPropertyDescriptor(element.props, 'ref')?.get;
+  let mayWarn = getter && 'isReactWarning' in getter && getter.isReactWarning;
+  if (mayWarn) {
+    return (element as ElementWithRef).ref;
+  }
+
+  // React 19 in DEV
+  getter = Object.getOwnPropertyDescriptor(element, 'ref')?.get;
+  mayWarn = getter && 'isReactWarning' in getter && getter.isReactWarning;
+  if (mayWarn) {
+    return element.props.ref;
+  }
+
+  // Not DEV
+  return element.props.ref || (element as ElementWithRef).ref;
+}
+
+export function composeRefs<T>(...refs: PossibleRef<T>[]) {
+  return (value: T) => {
+    refs.forEach(ref => {
+      if (typeof ref === 'function') {
+        ref(value);
+      } else if (ref !== null && ref !== undefined) {
+        (ref as React.MutableRefObject<T>).current = value;
+      }
+    });
+  };
+}

package/src/index.ts

@@ -37,6 +37,7 @@ export { TestIds } from './TestIds';
 export { AdEventType } from './AdEventType';
 export { BannerAdSize, GAMBannerAdSize } from './BannerAdSize';
 export { GAMAdEventType } from './GAMAdEventType';
+export { NativeAdEventType } from './NativeAdEventType';
 export { RewardedAdEventType } from './RewardedAdEventType';
 export { AdsConsent } from './AdsConsent';
 export { AppOpenAd } from './ads/AppOpenAd';
@@ -44,6 +45,10 @@ export { InterstitialAd } from './ads/InterstitialAd';
 export { RewardedAd } from './ads/RewardedAd';
 export { RewardedInterstitialAd } from './ads/RewardedInterstitialAd';
 export { BannerAd } from './ads/BannerAd';
+export { NativeAd } from './ads/native-ad/NativeAd';
+export { NativeAdView } from './ads/native-ad/NativeAdView';
+export { NativeMediaView } from './ads/native-ad/NativeMediaView';
+export { NativeAsset, NativeAssetType } from './ads/native-ad/NativeAsset';
 export { GAMBannerAd } from './ads/GAMBannerAd';
 export { GAMInterstitialAd } from './ads/GAMInterstitialAd';
 export { useAppOpenAd } from './hooks/useAppOpenAd';

package/src/specs/components/GoogleMobileAdsBannerViewNativeComponent.ts

@@ -1,3 +1,20 @@
+/*
+ * 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 type * as React from 'react';
 import type { HostComponent, ViewProps } from 'react-native';
 import type { BubblingEventHandler, Float } from 'react-native/Libraries/Types/CodegenTypes';

package/src/specs/components/GoogleMobileAdsMediaViewNativeComponent.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 type { HostComponent, ViewProps } from 'react-native';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+
+export interface NativeProps extends ViewProps {
+  responseId: string;
+  resizeMode?: string;
+}
+
+type NativeViewComponentType = HostComponent<NativeProps>;
+
+export default codegenNativeComponent<NativeProps>(
+  'RNGoogleMobileAdsMediaView',
+) as NativeViewComponentType;

package/src/specs/components/GoogleMobileAdsNativeViewNativeComponent.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 type * as React from 'react';
+import type { HostComponent, ViewProps } from 'react-native';
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+import codegenNativeCommands from 'react-native/Libraries/Utilities/codegenNativeCommands';
+import type { Int32 } from 'react-native/Libraries/Types/CodegenTypes';
+
+export interface NativeProps extends ViewProps {
+  responseId: string;
+}
+
+type NativeViewComponentType = HostComponent<NativeProps>;
+
+interface NativeCommands {
+  registerAsset: (
+    viewRef: React.ElementRef<NativeViewComponentType>,
+    assetType: string,
+    reactTag: Int32,
+  ) => void;
+}
+
+export const Commands: NativeCommands = codegenNativeCommands<NativeCommands>({
+  supportedCommands: ['registerAsset'],
+});
+
+export default codegenNativeComponent<NativeProps>(
+  'RNGoogleMobileAdsNativeView',
+) as NativeViewComponentType;

package/src/specs/modules/NativeGoogleMobileAdsModule.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +17,7 @@
 
 import type { TurboModule } from 'react-native';
 import { TurboModuleRegistry } from 'react-native';
-import { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
+import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
 
 import { AdapterStatus } from '../../types';
 

package/src/specs/modules/NativeGoogleMobileAdsNativeModule.ts

@@ -0,0 +1,64 @@
+/*
+ * 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 type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+import type {
+  Double,
+  Float,
+  UnsafeObject,
+  EventEmitter,
+} from 'react-native/Libraries/Types/CodegenTypes';
+
+export type NativeAdProps = {
+  responseId: string;
+  advertiser: string | null;
+  body: string;
+  callToAction: string;
+  headline: string;
+  price: string | null;
+  store: string | null;
+  starRating: Double | null;
+  icon: NativeAdImage | null;
+  images: Array<NativeAdImage> | null;
+  mediaContent: NativeMediaContent;
+  extras: UnsafeObject | null;
+};
+
+export type NativeAdImage = {
+  url: string;
+  scale: Double;
+};
+
+export type NativeMediaContent = {
+  aspectRatio: Float;
+  hasVideoContent: boolean;
+  duration: Float;
+};
+
+export type NativeAdEventPayload = {
+  responseId: string;
+  type: string;
+};
+
+export interface Spec extends TurboModule {
+  load(adUnitId: string, requestOptions: UnsafeObject): Promise<NativeAdProps>;
+  destroy(responseId: string): void;
+  readonly onAdEvent: EventEmitter<NativeAdEventPayload>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('RNGoogleMobileAdsNativeModule');

package/src/types/NativeAdRequestOptions.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 { RequestOptions } from './RequestOptions';
+
+export enum NativeMediaAspectRatio {
+  ANY = 1,
+  LANDSCAPE = 2,
+  PORTRAIT = 3,
+  SQUARE = 4,
+}
+
+export enum NativeAdChoicesPlacement {
+  TOP_LEFT = 0,
+  TOP_RIGHT = 1,
+  BOTTOM_RIGHT = 2,
+  BOTTOM_LEFT = 3,
+}
+
+export interface NativeAdRequestOptions extends RequestOptions {
+  /**
+   * Specifies a preference for the aspect ratio of ad creatives.
+   * Setting this option does not guarantee that all ad creatives will meet the preference specified.
+   * - When unset, the returned ad can have any media aspect ratio.
+   * - When set, you will be able to improve the user experience by specifying the preferred type of aspect ratio.
+   */
+  aspectRatio?: NativeMediaAspectRatio;
+  /**
+   * Chooses which corner to render the AdChoices icon.
+   * - If unset, the AdChoices icon position is set to the top right.
+   * - If set, AdChoices is placed at the custom position as requested.
+   */
+  adChoicesPlacement?: NativeAdChoicesPlacement;
+  /**
+   * Disables or enables a video's starting audio.
+   * - The start muted behavior is enabled by default.
+   * - When disabled, your app requests the video should begin with audio.
+   * - When enabled, your app requests that the video should begin with audio muted.
+   */
+  startVideoMuted?: boolean;
+}

package/src/types/index.ts

@@ -26,3 +26,4 @@ export * from './RequestConfiguration';
 export * from './RequestOptions';
 export * from './RewardedAdReward';
 export * from './AppEvent';
+export * from './NativeAdRequestOptions';

package/src/version.ts

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