@adadapted/react-native-sdk 3.2.0 → 3.4.0

package/src/index.tsx

@@ -3,7 +3,6 @@
  */
 import * as React from "react";
 import {
-    AppState,
     DeviceEventEmitter,
     EmitterSubscription,
     Linking,
@@ -13,7 +12,7 @@ import {
 import * as adadaptedApiRequests from "./api/adadaptedApiRequests";
 import {
     AdSession,
-    DetailedListItem,
+    AdZoneDetailedListItemInfo,
     KeywordIntercepts,
     KeywordSearchTerm,
     ListManagerEvent,
@@ -100,7 +99,7 @@ export enum PayloadApiEnv {
 }
 
 /**
- * Interface defining inputs to the {@link Sdk.initialize} method.
+ * Interface defining inputs to the {@link Sdk.initialize: AdadaptedReactNativeSdk} method.
  */
 export interface InitializeProps {
     /**
@@ -132,19 +131,19 @@ export interface InitializeProps {
     onAdZonesRefreshed?(): void;
     /**
      * Callback that gets triggered when an "add to list" item/items are clicked.
-     * @param items - The array of items to "add to list".
+     * @param detail - details about the list items to add to cart.
      */
-    onAddToListTriggered?(items: DetailedListItem[]): void;
+    onAddToListTriggered?(detail: AdZoneDetailedListItemInfo): void;
     /**
      * Callback that gets triggered when an "add to list"
      * occurs by means of an "out of app" data payload.
-     * @param payloads - All payloads the client must go through.
+     * @param detail - Details about payloads clients must go through.
      */
     onOutOfAppPayloadAvailable?(payloads: OutOfAppDataPayload[]): void;
     /**
-     * Change the optional ad zone visibility default setting.
+     * Ad zones that contain off-screen ads.
      */
-    defaultToInvisibleAdZone?: boolean;
+    offScreenAdZone?: [number];
 }
 
 /**
@@ -220,7 +219,7 @@ export interface AdZoneInfo {
     /**
      * The ad zone component.
      */
-    adZone: JSX.Element;
+    adZone: React.JSX.Element;
 }
 
 /**
@@ -272,6 +271,10 @@ export class AdadaptedReactNativeSdk {
      * The available ad zones.
      */
     private adZones: AdZoneInfo[] | undefined;
+    /**
+     * The available off-screen ad zones.
+     */
+    private offScreenAdZones: AdZoneInfo[] = [];
     /**
      * The touch sensitivity of the Ad Zone in both the X and Y directions.
      * This is used to determine the click/press sensitivity when the
@@ -306,11 +309,11 @@ export class AdadaptedReactNativeSdk {
     /**
      * If provided, triggers when an "add to list" item is
      * clicked in an ad zone.
-     * @param items - The array of items to "add to list".
+     * @param detail - The array of items to "add to list".
      * @param isExternalPayload - If true, the items are from an external payload.
      */
     private onAddToListTriggered: (
-        items: DetailedListItem[],
+        detail: AdZoneDetailedListItemInfo,
         isExternalPayload?: boolean
     ) => void | undefined;
     /**
@@ -330,13 +333,9 @@ export class AdadaptedReactNativeSdk {
      */
     private AppStateOnEventListener: EmitterSubscription | undefined;
     /**
-     * Track ad zone visibility for off-screen ads.
-     */
-    private isAdZoneVisible: boolean = true;
-    /**
-     * Optional default ad zone visibility for off-screen ads.
+     * Ad zones that contain off-screen ads.
      */
-    private defaultAdZoneVisibility: boolean | undefined;
+    private offScreenAdZone: [number] | undefined;
     /**
      * Gets the Session ID.
      * @returns the Session ID.
@@ -361,6 +360,14 @@ export class AdadaptedReactNativeSdk {
         return this.adZones;
     }
 
+    /**
+     * Gets the list of available off-screen Ad Zones.
+     * @returns all available off-screen ad zones.
+     */
+    public getOffScreenAdZones(): AdZoneInfo[] | undefined {
+        return this.offScreenAdZones;
+    }
+
     /**
      * @inheritDoc
      */
@@ -423,19 +430,67 @@ export class AdadaptedReactNativeSdk {
                                 this.xyAdZoneDragDistanceAllowed || 25
                             }
                             adZoneData={adZones[adZoneId]}
-                            onAddToListTriggered={(items) => {
-                                safeInvoke(this.onAddToListTriggered, items);
+                            onAddToListTriggered={(details) => {
+                                safeInvoke(this.onAddToListTriggered, {
+                                    zoneId: adZoneId,
+                                    items: details,
+                                });
                             }}
-                            isAdZoneVisible={!this.onAdZoneVisibilityChanged}
-                            defaultToInvisibleAdZone={
-                                this.defaultAdZoneVisibility
-                            }
+                            isAdZoneVisible={true}
+                            offScreenAdZone={false}
                         />
                     ),
                 });
             }
         }
+        return adZoneInfoList;
+    }
+
+    /**
+     * Creates all off-screen Ad Zone Info objects based on provided off-screen Ad Zones.
+     * @param adZones - The object of available zones.
+     * @returns the array of off-screen Ad Zone Info objects.
+     */
+    private generateOffScreenAdZones(adZones: {
+        [key: number]: Zone;
+    }): AdZoneInfo[] {
+        const adZoneInfoList: AdZoneInfo[] = [];
 
+        for (const adZoneId in adZones) {
+            if (Object.prototype.hasOwnProperty.call(adZones, adZoneId)) {
+                if (
+                    this.offScreenAdZone &&
+                    this.offScreenAdZone.length > 0 &&
+                    this.offScreenAdZone.includes(Number(adZoneId))
+                ) {
+                    adZoneInfoList.push({
+                        zoneId: adZones[adZoneId].id,
+                        adZone: (
+                            <AdZone
+                                key={adZoneId}
+                                appId={this.appId}
+                                sessionId={this.sessionId!}
+                                udid={this.deviceInfo!.udid}
+                                deviceOs={this.deviceOs!}
+                                apiEnv={this.apiEnv}
+                                xyDragDistanceAllowed={
+                                    this.xyAdZoneDragDistanceAllowed || 25
+                                }
+                                adZoneData={adZones[adZoneId]}
+                                onAddToListTriggered={(items) => {
+                                    safeInvoke(this.onAddToListTriggered, {
+                                        zoneId: adZoneId,
+                                        items,
+                                    });
+                                }}
+                                isAdZoneVisible={false}
+                                offScreenAdZone={true}
+                            />
+                        ),
+                    });
+                }
+            }
+        }
         return adZoneInfoList;
     }
 
@@ -466,6 +521,9 @@ export class AdadaptedReactNativeSdk {
                 .then((response) => {
                     this.sessionInfo = response.data;
                     this.adZones = this.generateAdZones(response.data.zones);
+                    this.offScreenAdZones = this.generateOffScreenAdZones(
+                        response.data.zones
+                    );
 
                     // Call the user defined callback indicating
                     // the session data has been refreshed.
@@ -576,13 +634,15 @@ export class AdadaptedReactNativeSdk {
      */
     private handleDeepLink(event: any): void {
         const searchStr = "data=";
-        const dataIndex: number = event["url"].indexOf(searchStr);
+        const dataIndex: number = event.url.indexOf(searchStr);
 
         if (dataIndex !== -1) {
-            const encodedData = event.url.substr(dataIndex + searchStr.length);
+            const encodedData: string = event.url.substr(
+                `${dataIndex}${searchStr.length}`
+            );
             const payloadData = JSON.parse(base64.decode(encodedData));
-            const payloadId = payloadData["payload_id"];
-            const itemDataList = payloadData["detailed_list_items"];
+            const payloadId = payloadData.payload_id;
+            const itemDataList = payloadData.detailed_list_items;
 
             if (itemDataList && itemDataList.length > 0) {
                 const finalItemList: OutOfAppDataPayload[] = [];
@@ -592,13 +652,13 @@ export class AdadaptedReactNativeSdk {
                         payload_id: payloadId,
                         detailed_list_items: [
                             {
-                                product_title: itemData["product_title"],
-                                product_brand: itemData["product_brand"],
-                                product_category: itemData["product_category"],
-                                product_barcode: itemData["product_barcode"],
-                                product_discount: itemData["product_discount"],
-                                product_image: itemData["product_image"],
-                                product_sku: itemData["product_sku"],
+                                product_title: itemData.product_title,
+                                product_brand: itemData.product_brand,
+                                product_category: itemData.product_category,
+                                product_barcode: itemData.product_barcode,
+                                product_discount: itemData.product_discount,
+                                product_image: itemData.product_image,
+                                product_sku: itemData.product_sku,
                             },
                         ],
                     });
@@ -642,16 +702,13 @@ export class AdadaptedReactNativeSdk {
                             payload_id: payload.payload_id,
                             detailed_list_items: [
                                 {
-                                    product_title: itemData["product_title"],
-                                    product_brand: itemData["product_brand"],
-                                    product_category:
-                                        itemData["product_category"],
-                                    product_barcode:
-                                        itemData["product_barcode"],
-                                    product_discount:
-                                        itemData["product_discount"],
-                                    product_image: itemData["product_image"],
-                                    product_sku: itemData["product_sku"],
+                                    product_title: itemData.product_title,
+                                    product_brand: itemData.product_brand,
+                                    product_category: itemData.product_category,
+                                    product_barcode: itemData.product_barcode,
+                                    product_discount: itemData.product_discount,
+                                    product_image: itemData.product_image,
+                                    product_sku: itemData.product_sku,
                                 },
                             ],
                         });
@@ -668,10 +725,9 @@ export class AdadaptedReactNativeSdk {
 
     /**
      * Notify the ad zone of visibility status change for off-screen ads.
+     * @param isVisible - Ad Zone visibility tracking.
      */
-    public onAdZoneVisibilityChanged(): void {
-        const isVisible = !this.isAdZoneVisible;
-        this.isAdZoneVisible = isVisible;
+    public onAdZoneVisibilityChanged(isVisible: boolean): void {
         DeviceEventEmitter.emit("visibility-event", isVisible);
     }
 
@@ -735,10 +791,9 @@ export class AdadaptedReactNativeSdk {
             this.onOutOfAppPayloadAvailable = props.onOutOfAppPayloadAvailable;
         }
 
-        // If provided for off-screen ads, set the ad zone visibility for ad tracking.
-        if (props.defaultToInvisibleAdZone) {
-            this.defaultAdZoneVisibility = props.defaultToInvisibleAdZone;
-            this.onAdZoneVisibilityChanged();
+        // If provided set any off-screen ad zones.
+        if (props.offScreenAdZone) {
+            this.offScreenAdZone = props.offScreenAdZone;
         }
 
         return new Promise<void>((resolve, reject) => {
@@ -796,6 +851,10 @@ export class AdadaptedReactNativeSdk {
                             this.adZones = this.generateAdZones(
                                 response.data.zones
                             );
+                            this.offScreenAdZones =
+                                this.generateOffScreenAdZones(
+                                    response.data.zones
+                                );
 
                             // Start the session data refresh timer.
                             this.onRefreshAdZones();
@@ -821,18 +880,18 @@ export class AdadaptedReactNativeSdk {
                             this.getPayloadItemData();
 
                             // Initialize an event listener to intercept deep links while the app is running.
-
-                            this.deepLinkOnEventListener = Linking.addEventListener(
-                                "url",
-                                this.handleDeepLink
-                            );
-
-                            // Initialize an event listener to intercept App state changes.
-
-                            this.AppStateOnEventListener = AppState.addEventListener(
-                                "change",
-                                this.handleAppStateChange
-                            );
+                            this.deepLinkOnEventListener =
+                                Linking.addEventListener(
+                                    "url",
+                                    this.handleDeepLink
+                                );
+
+                            // // Initialize an event listener to intercept App state changes.
+                            // this.AppStateOnEventListener =
+                            //     AppState.addEventListener(
+                            //         "change",
+                            //         this.handleAppStateChange
+                            //     );
 
                             resolve();
                         })
@@ -858,8 +917,14 @@ export class AdadaptedReactNativeSdk {
 
         this.keywordInterceptSearchValue = searchTerm;
 
-        if (!this.deviceInfo || !this.sessionId) {
-            console.error("AdAdapted SDK has not been initialized.");
+        if (!this.deviceInfo) {
+            console.error(
+                "AdAdapted SDK has not been initialized with device info."
+            );
+        } else if (!this.sessionId) {
+            console.error(
+                "AdAdapted SDK has not been initialized with session id."
+            );
         } else if (!this.keywordIntercepts) {
             console.error("No available keyword intercepts.");
         } else if (
@@ -951,8 +1016,14 @@ export class AdadaptedReactNativeSdk {
     public reportKeywordInterceptTermSelected(termId: string): void {
         const termObj = this.getKeywordInterceptTerm(termId);
 
-        if (!this.deviceInfo || !this.sessionId) {
-            console.error("AdAdapted SDK has not been initialized.");
+        if (!this.deviceInfo) {
+            console.error(
+                "AdAdapted SDK has not been initialized with device info."
+            );
+        } else if (!this.sessionId) {
+            console.error(
+                "AdAdapted SDK has not been initialized with session id."
+            );
         } else if (!this.keywordIntercepts) {
             console.error("No available keyword intercepts.");
         } else if (!termId || !termObj) {
@@ -1004,8 +1075,14 @@ export class AdadaptedReactNativeSdk {
             }
         }
 
-        if (!this.deviceInfo || !this.sessionId) {
-            console.error("AdAdapted SDK has not been initialized.");
+        if (!this.deviceInfo) {
+            console.error(
+                "AdAdapted SDK has not been initialized with device info."
+            );
+        } else if (!this.sessionId) {
+            console.error(
+                "AdAdapted SDK has not been initialized with session id."
+            );
         } else if (!this.keywordIntercepts) {
             console.error("No available keyword intercepts.");
         } else if (!termIds || termIds.length === 0 || termObjs.length === 0) {

package/src/util.ts

@@ -14,6 +14,8 @@ export function safeInvoke<R>(func: (() => R) | nil): R | undefined;
  * See main definition above.
  * @param func - The function to call.
  * @param arg1 - Function argument.
+ * @returns The return value of the executed function, or undefined if
+ *      the function is null/undefined
  */
 export function safeInvoke<A1, R>(
     func: ((arg1: A1) => R) | nil,
@@ -24,6 +26,8 @@ export function safeInvoke<A1, R>(
  * @param func - The function to call.
  * @param arg1 - Function argument.
  * @param arg2 - Function argument.
+ * @returns The return value of the executed function, or undefined if
+ *      the function is null/undefined
  */
 export function safeInvoke<A1, A2, R>(
     func: ((arg1: A1, arg2: A2) => R) | nil,
@@ -36,6 +40,8 @@ export function safeInvoke<A1, A2, R>(
  * @param arg1 - Function argument.
  * @param arg2 - Function argument.
  * @param arg3 - Function argument.
+ * @returns The return value of the executed function, or undefined if
+ *      the function is null/undefined
  */
 export function safeInvoke<A1, A2, A3, R>(
     func: ((arg1: A1, arg2: A2, arg3: A3) => R) | nil,
@@ -50,6 +56,8 @@ export function safeInvoke<A1, A2, A3, R>(
  * @param arg2 - Function argument.
  * @param arg3 - Function argument.
  * @param arg4 - Function argument.
+ * @returns The return value of the executed function, or undefined if
+ *      the function is null/undefined
  */
 export function safeInvoke<A1, A2, A3, A4, R>(
     func: ((arg1: A1, arg2: A2, arg3: A3, arg4: A4) => R) | nil,
@@ -66,6 +74,8 @@ export function safeInvoke<A1, A2, A3, A4, R>(
  * @param arg3 - Function argument.
  * @param arg4 - Function argument.
  * @param arg5 - Function argument.
+ * @returns The return value of the executed function, or undefined if
+ *      the function is null/undefined
  */
 export function safeInvoke<A1, A2, A3, A4, A5, R>(
     func: ((arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5) => R) | nil,
@@ -84,6 +94,8 @@ export function safeInvoke<A1, A2, A3, A4, A5, R>(
  * @param arg4 - Function argument.
  * @param arg5 - Function argument.
  * @param arg6 - Function argument.
+ * @returns The return value of the executed function, or undefined if
+ *      the function is null/undefined
  */
 export function safeInvoke<A1, A2, A3, A4, A5, A6, R>(
     func:
@@ -105,6 +117,7 @@ export function safeInvoke<A1, A2, A3, A4, A5, A6, R>(
 // eslint-disable-next-line @typescript-eslint/ban-types
 export function safeInvoke(func: Function | nil, ...args: any[]): any {
     if (func) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         return func(...args);
     }
 }

package/lib/typescript/example/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/typescript/example/src/App.d.ts

@@ -1,9 +0,0 @@
-/**
- * Test app component for testing the
- * {@link AdadaptedReactNativeSdk} package/module.
- */
-import { FC } from "react";
-/**
- * Creates the main component for the App.
- */
-export declare const App: FC;

package/lib/typescript/jest.setup.d.ts

@@ -1,5 +0,0 @@
-/**
- * Global imports and initialization for Jest unit tests.
- * @module
- */
-import "raf/polyfill";