@adadapted/react-native-sdk 3.4.0 → 3.5.0

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

@@ -2,71 +2,9 @@
  * The AdadaptedReactNativeSdk package/module definition.
  */
 import * as React from "react";
-import { AdZoneDetailedListItemInfo, KeywordSearchTerm, OutOfAppDataPayload } from "./api/adadaptedApiTypes";
-/**
- * Enum representing possible device operating systems.
- */
-export declare enum DeviceOS {
-    /**
-     * Represents the Android operating system.
-     */
-    ANDROID = "android",
-    /**
-     * Represents the iOS operating system.
-     */
-    IOS = "ios"
-}
-/**
- * Enum defining the different API environments.
- */
-export declare enum ApiEnv {
-    /**
-     * The production API environment.
-     */
-    Prod = "https://ads.adadapted.com",
-    /**
-     * The development API environment.
-     */
-    Dev = "https://sandbox.adadapted.com",
-    /**
-     * Used only for unit testing/mock data.
-     */
-    Mock = "MOCK_DATA"
-}
-/**
- * Enum defining the different API environments for List Manager.
- */
-export declare enum ListManagerApiEnv {
-    /**
-     * The production API environment.
-     */
-    Prod = "https://ec.adadapted.com",
-    /**
-     * The development API environment.
-     */
-    Dev = "https://sandec.adadapted.com",
-    /**
-     * Used only for unit testing/mocking data.
-     */
-    Mock = "MOCK_DATA"
-}
-/**
- * Enum defining the different API environments for the Payload Server.
- */
-export declare enum PayloadApiEnv {
-    /**
-     * The production API environment.
-     */
-    Prod = "https://payload.adadapted.com",
-    /**
-     * The development API environment.
-     */
-    Dev = "https://sandpayload.adadapted.com",
-    /**
-     * Used only for unit testing/mocking data.
-     */
-    Mock = "MOCK_DATA"
-}
+import { DetailedListItem, KeywordSearchTerm, OutOfAppDataPayload } from "./api/adadaptedApiTypes";
+import { DeviceTypes } from "./componentTypes/Device";
+import { EnvironmentTypes } from "./componentTypes/Environment";
 /**
  * Interface defining inputs to the {@link Sdk.initialize: AdadaptedReactNativeSdk} method.
  */
@@ -79,7 +17,7 @@ export interface InitializeProps {
      * The API environment.
      * If undefined, defaults to production.
      */
-    apiEnv?: ApiEnv;
+    apiEnv?: EnvironmentTypes.ApiEnv;
     /**
      * Optional custom advertiserId to replace IDFA - ios only.
      */
@@ -100,80 +38,19 @@ export interface InitializeProps {
     onAdZonesRefreshed?(): void;
     /**
      * Callback that gets triggered when an "add to list" item/items are clicked.
-     * @param detail - details about the list items to add to cart.
+     * @param items - The array of items to "add to list".
      */
-    onAddToListTriggered?(detail: AdZoneDetailedListItemInfo): void;
+    onAddToListTriggered?(items: DetailedListItem[]): void;
     /**
      * Callback that gets triggered when an "add to list"
      * occurs by means of an "out of app" data payload.
-     * @param detail - Details about payloads clients must go through.
+     * @param payloads - All payloads the client must go through.
      */
     onOutOfAppPayloadAvailable?(payloads: OutOfAppDataPayload[]): void;
     /**
-     * Ad zones that contain off-screen ads.
+     * Ad zone ids that contain off-screen ads.
      */
-    offScreenAdZone?: [number];
-}
-/**
- * Interface defining properties of a user's Device.
- */
-export interface DeviceInfo {
-    /**
-     * The unique device ID.
-     */
-    udid: string;
-    /**
-     * The device name.
-     */
-    deviceName: string;
-    /**
-     * The operating system name.
-     */
-    systemName: string;
-    /**
-     * The operating system version.
-     */
-    systemVersion: string;
-    /**
-     * The device model.
-     */
-    deviceModel: string;
-    /**
-     * The device screen width.
-     */
-    deviceWidth: string;
-    /**
-     * The device screen height.
-     */
-    deviceHeight: string;
-    /**
-     * The device screen density.
-     */
-    deviceScreenDensity: string;
-    /**
-     * The current device local.
-     */
-    deviceLocale: string;
-    /**
-     * The device carrier name.
-     */
-    deviceCarrier: string;
-    /**
-     * The bundle ID.
-     */
-    bundleId: string;
-    /**
-     * The bundle version.
-     */
-    bundleVersion: string;
-    /**
-     * The current device timezone.
-     */
-    deviceTimezone: string;
-    /**
-     * If true, ad tracking is enabled for the device.
-     */
-    isAdTrackingEnabled: boolean;
+    offScreenAdZoneIds?: [number];
 }
 /**
  * Interface defining a wrapper for an {@link AdZone}.
@@ -241,6 +118,10 @@ export declare class AdadaptedReactNativeSdk {
      * The available off-screen ad zones.
      */
     private offScreenAdZones;
+    /**
+     * The zone ids of the availible off-screen ad zones.
+     */
+    private offScreenAdZoneIds;
     /**
      * 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
@@ -275,7 +156,7 @@ export declare class AdadaptedReactNativeSdk {
     /**
      * If provided, triggers when an "add to list" item is
      * clicked in an ad zone.
-     * @param detail - The array of items to "add to list".
+     * @param items - The array of items to "add to list".
      * @param isExternalPayload - If true, the items are from an external payload.
      */
     private onAddToListTriggered;
@@ -294,9 +175,13 @@ export declare class AdadaptedReactNativeSdk {
      */
     private AppStateOnEventListener;
     /**
-     * Ad zones that contain off-screen ads.
+     * The current adzone visibility status.
      */
-    private offScreenAdZone;
+    private isAdZoneVisible;
+    /**
+     * The ad context object.
+     */
+    private adContext;
     /**
      * Gets the Session ID.
      * @returns the Session ID.
@@ -306,7 +191,7 @@ export declare class AdadaptedReactNativeSdk {
      * Gets the Device Info object.
      * @returns the Device Info object.
      */
-    getDeviceInfo(): DeviceInfo | undefined;
+    getDeviceInfo(): DeviceTypes.DeviceInfo | undefined;
     /**
      * Gets the list of available Ad Zones.
      * @returns all available ad zones.
@@ -317,6 +202,20 @@ export declare class AdadaptedReactNativeSdk {
      * @returns all available off-screen ad zones.
      */
     getOffScreenAdZones(): AdZoneInfo[] | undefined;
+    /**
+     * Sets an ad context to replace an ad zone's ads with contextual ads for recipes.
+     * @param adContext - Object containing the contextual term and the associted ad zone.
+     * @param adContext.contextIds - An array of contextual ad ids.
+     * @param adContext.zoneIds - An array of zone ids for applying contextual ads.
+     */
+    setAdContext(adContext: {
+        contextIds: string[];
+        zoneIds: string[];
+    }): void;
+    /**
+     * Clear the contextual ads from ad zones to return standard ads to the ad zones.
+     */
+    clearAdContext(): void;
     /**
      * @inheritDoc
      */
@@ -326,21 +225,18 @@ export declare class AdadaptedReactNativeSdk {
      * @returns a Promise of void.
      */
     private getDeviceInformation;
+    private adZoneTemplate;
     /**
      * Creates all Ad Zone Info objects based on provided Ad Zones.
      * @param adZones - The object of available zones.
+     * @param offScreenAdZone - True if an ad zone first renders out of view.
      * @returns the array of Ad Zone Info objects.
      */
     private generateAdZones;
-    /**
-     * 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;
     /**
      * Triggered when session data is initialized or refreshed. Creates
      * a timer based on the session data refresh value.
+     * @param immediateRefresh - If true the ad zones are refreshed bypassing the timer.
      */
     private onRefreshAdZones;
     /**

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B,OAAO,EAEH,0BAA0B,EAE1B,iBAAiB,EAIjB,mBAAmB,EAMtB,MAAM,yBAAyB,CAAC;AAMjC;;GAEG;AACH,oBAAY,QAAQ;IAChB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,GAAG,QAAQ;CACd;AAED;;GAEG;AACH,oBAAY,MAAM;IACd;;OAEG;IACH,IAAI,8BAA8B;IAClC;;OAEG;IACH,GAAG,kCAAkC;IACrC;;OAEG;IACH,IAAI,cAAc;CACrB;AAED;;GAEG;AACH,oBAAY,iBAAiB;IACzB;;OAEG;IACH,IAAI,6BAA6B;IACjC;;OAEG;IACH,GAAG,iCAAiC;IACpC;;OAEG;IACH,IAAI,cAAc;CACrB;AAED;;GAEG;AACH,oBAAY,aAAa;IACrB;;OAEG;IACH,IAAI,kCAAkC;IACtC;;OAEG;IACH,GAAG,sCAAsC;IACzC;;OAEG;IACH,IAAI,cAAc;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;OAOG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,IAAI,IAAI,CAAC;IAC5B;;;OAGG;IACH,oBAAoB,CAAC,CAAC,MAAM,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAChE;;;;OAIG;IACH,0BAA0B,CAAC,CAAC,QAAQ,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC;IACnE;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;CAAG;AAEjE;;GAEG;AACH,qBAAa,uBAAuB;IAChC;;OAEG;IACH,OAAO,CAAC,KAAK,CAAc;IAC3B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;IACvB;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAoB;IAC7C;;OAEG;IACH,OAAO,CAAC,aAAa,CAAgB;IACrC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAuB;IACvC;;OAEG;IACH,OAAO,CAAC,SAAS,CAAqB;IACtC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAyB;IAC3C;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAwB;IAC3C;;OAEG;IACH,OAAO,CAAC,OAAO,CAA2B;IAC1C;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAoB;IAC5C;;;;;;;OAOG;IACH,OAAO,CAAC,2BAA2B,CAAqB;IACxD;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CAAyB;IACnD;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CAA4C;IACvE;;;;OAIG;IACH,OAAO,CAAC,2BAA2B,CAAS;IAC5C;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAgC;IACzD;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB,CAGN;IACtB;;;;OAIG;IACH,OAAO,CAAC,0BAA0B,CAEZ;IACtB;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAAkC;IACjE;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAAkC;IACjE;;OAEG;IACH,OAAO,CAAC,eAAe,CAAuB;IAC9C;;;OAGG;IACI,YAAY,IAAI,MAAM,GAAG,SAAS;IAIzC;;;OAGG;IACI,aAAa,IAAI,UAAU,GAAG,SAAS;IAI9C;;;OAGG;IACI,UAAU,IAAI,UAAU,EAAE,GAAG,SAAS;IAI7C;;;OAGG;IACI,mBAAmB,IAAI,UAAU,EAAE,GAAG,SAAS;IAItD;;OAEG;;IAsBH;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAmCvB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IA2ChC;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IA4CxB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAgB5B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAI/B;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;IA4BpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAsCtB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAM5B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAwC1B;;;OAGG;IACI,yBAAyB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI;IAI1D;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI1C;;;;OAIG;IACI,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAiKxD;;;;;OAKG;IACI,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,EAAE;IA+FtE;;;;;;OAMG;IACI,kCAAkC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IA0C/D;;;;;;;;OAQG;IACI,oCAAoC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAuDpE;;;;;OAKG;IACI,sBAAsB,CACzB,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,CAAC,EAAE,MAAM,GAClB,IAAI;IAoBP;;;;;OAKG;IACI,yBAAyB,CAC5B,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,CAAC,EAAE,MAAM,GAClB,IAAI;IAoBP;;;;;OAKG;IACI,0BAA0B,CAC7B,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,CAAC,EAAE,MAAM,GAClB,IAAI;IAoBP;;;;OAIG;IACI,8BAA8B,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAuB9D;;;;OAIG;IACI,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAuB1D;;;;OAIG;IACI,OAAO,IAAI,IAAI;CAazB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B,OAAO,EAEH,gBAAgB,EAEhB,iBAAiB,EAIjB,mBAAmB,EAMtB,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;OAOG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,IAAI,IAAI,CAAC;IAC5B;;;OAGG;IACH,oBAAoB,CAAC,CAAC,KAAK,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACvD;;;;OAIG;IACH,0BAA0B,CAAC,CAAC,QAAQ,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC;IACnE;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;CAAG;AAEjE;;GAEG;AACH,qBAAa,uBAAuB;IAChC;;OAEG;IACH,OAAO,CAAC,KAAK,CAAc;IAC3B;;OAEG;IACH,OAAO,CAAC,MAAM,CAA0B;IACxC;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAqC;IAC9D;;OAEG;IACH,OAAO,CAAC,aAAa,CAAiC;IACtD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAmC;IACnD;;OAEG;IACH,OAAO,CAAC,SAAS,CAAqB;IACtC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAqC;IACvD;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAwB;IAC3C;;OAEG;IACH,OAAO,CAAC,OAAO,CAA2B;IAC1C;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAoB;IAC5C;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAgB;IAC1C;;;;;;;OAOG;IACH,OAAO,CAAC,2BAA2B,CAAqB;IACxD;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CAAyB;IACnD;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CAA4C;IACvE;;;;OAIG;IACH,OAAO,CAAC,2BAA2B,CAAS;IAC5C;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAgC;IACzD;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB,CAGN;IACtB;;;;OAIG;IACH,OAAO,CAAC,0BAA0B,CAEZ;IACtB;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAAkC;IACjE;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAAkC;IACjE;;OAEG;IACH,OAAO,CAAC,eAAe,CAAiB;IACxC;;OAEG;IACH,OAAO,CAAC,SAAS,CAKD;IAEhB;;;OAGG;IACI,YAAY,IAAI,MAAM,GAAG,SAAS;IAIzC;;;OAGG;IACI,aAAa,IAAI,WAAW,CAAC,UAAU,GAAG,SAAS;IAI1D;;;OAGG;IACI,UAAU,IAAI,UAAU,EAAE,GAAG,SAAS;IAI7C;;;OAGG;IACI,mBAAmB,IAAI,UAAU,EAAE,GAAG,SAAS;IAItD;;;;;OAKG;IACI,YAAY,CAAC,SAAS,EAAE;QAC3B,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,OAAO,EAAE,MAAM,EAAE,CAAC;KACrB,GAAG,IAAI;IAKR;;OAEG;IACI,cAAc,IAAI,IAAI;IAK7B;;OAEG;;IAsBH;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,cAAc;IA8BtB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IA8BvB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAqDxB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAgB5B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAI/B;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;IA4BpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAsCtB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAM5B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAwC1B;;;OAGG;IACI,yBAAyB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI;IAI1D;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI1C;;;;OAIG;IACI,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAuKxD;;;;;OAKG;IACI,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,EAAE;IA+FtE;;;;;;OAMG;IACI,kCAAkC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IA0C/D;;;;;;;;OAQG;IACI,oCAAoC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAuDpE;;;;;OAKG;IACI,sBAAsB,CACzB,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,CAAC,EAAE,MAAM,GAClB,IAAI;IAoBP;;;;;OAKG;IACI,yBAAyB,CAC5B,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,CAAC,EAAE,MAAM,GAClB,IAAI;IAoBP;;;;;OAKG;IACI,0BAA0B,CAC7B,SAAS,EAAE,MAAM,EAAE,EACnB,QAAQ,CAAC,EAAE,MAAM,GAClB,IAAI;IAoBP;;;;OAIG;IACI,8BAA8B,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAuB9D;;;;OAIG;IACI,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAuB1D;;;;OAIG;IACI,OAAO,IAAI,IAAI;CAazB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adadapted/react-native-sdk",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "The AdAdapted react-native SDK.",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",

package/src/api/adadaptedApiRequests.ts

@@ -19,7 +19,8 @@ import {
 } from "./adadaptedApiTypes";
 import axios, { AxiosResponse } from "axios";
 import * as adadaptedApiRequestMocks from "./adadaptedApiRequests.mock";
-import { ApiEnv, DeviceOS, ListManagerApiEnv, PayloadApiEnv } from "../index";
+import { DeviceTypes } from "../componentTypes/Device";
+import { EnvironmentTypes } from "../componentTypes/Environment";
 
 /**
  * Makes an API request to initialize the session for the AdAdapted API.
@@ -30,10 +31,10 @@ import { ApiEnv, DeviceOS, ListManagerApiEnv, PayloadApiEnv } from "../index";
  */
 export function initializeSession(
     requestData: InitializeSessionRequest,
-    deviceOS: DeviceOS,
-    apiEnv: ApiEnv
+    deviceOS: DeviceTypes.DeviceOS,
+    apiEnv: EnvironmentTypes.ApiEnv
 ): Promise<AxiosResponse<InitializeSessionResponse>> {
-    return apiEnv === ApiEnv.Mock
+    return apiEnv === EnvironmentTypes.ApiEnv.Mock
         ? adadaptedApiRequestMocks.initializeSession()
         : axios(`${apiEnv}/v/0.9.5/${deviceOS}/sessions/initialize`, {
               method: "POST",
@@ -54,13 +55,13 @@ export function initializeSession(
  */
 export function refreshSessionData(
     requestData: RefreshSessionDataRequest,
-    deviceOS: DeviceOS,
-    apiEnv: ApiEnv
+    deviceOS: DeviceTypes.DeviceOS,
+    apiEnv: EnvironmentTypes.ApiEnv
 ): Promise<AxiosResponse<RefreshSessionDataResponse>> {
-    return apiEnv === ApiEnv.Mock
+    return apiEnv === EnvironmentTypes.ApiEnv.Mock
         ? adadaptedApiRequestMocks.refreshSessionData()
         : axios(
-              `${apiEnv}/v/0.9.5/${deviceOS}/ads/retrieve?aid=${requestData.aid}&sid=${requestData.sid}&uid=${requestData.uid}`,
+              `${apiEnv}/v/0.9.5/${deviceOS}/ads/retrieve?aid=${requestData.aid}&sid=${requestData.sid}&uid=${requestData.uid}&sdk=${requestData.sdkVersion}&contextID=${requestData.adContext?.contextIds}&zoneID=${requestData.adContext?.zoneIds}`,
               {
                   method: "GET",
                   headers: {
@@ -80,10 +81,10 @@ export function refreshSessionData(
  */
 export function reportAdEvent(
     requestData: ReportAdEventRequest,
-    deviceOS: DeviceOS,
-    apiEnv: ApiEnv
+    deviceOS: DeviceTypes.DeviceOS,
+    apiEnv: EnvironmentTypes.ApiEnv
 ): Promise<AxiosResponse<ReportAdEventResponse>> {
-    return apiEnv === ApiEnv.Mock
+    return apiEnv === EnvironmentTypes.ApiEnv.Mock
         ? adadaptedApiRequestMocks.reportAdEvent()
         : axios(`${apiEnv}/v/0.9.5/${deviceOS}/ads/events`, {
               method: "POST",
@@ -104,10 +105,10 @@ export function reportAdEvent(
  */
 export function getKeywordIntercepts(
     requestData: KeywordInterceptsRequest,
-    deviceOS: DeviceOS,
-    apiEnv: ApiEnv
+    deviceOS: DeviceTypes.DeviceOS,
+    apiEnv: EnvironmentTypes.ApiEnv
 ): Promise<AxiosResponse<KeywordInterceptsResponse>> {
-    return apiEnv === ApiEnv.Mock
+    return apiEnv === EnvironmentTypes.ApiEnv.Mock
         ? adadaptedApiRequestMocks.getKeywordIntercepts()
         : axios(
               `${apiEnv}/v/0.9.5/${deviceOS}/intercepts/retrieve?aid=${requestData.aid}&sid=${requestData.sid}&uid=${requestData.uid}`,
@@ -130,10 +131,10 @@ export function getKeywordIntercepts(
  */
 export function reportInterceptEvent(
     requestData: ReportInterceptEventRequest,
-    deviceOS: DeviceOS,
-    apiEnv: ApiEnv
+    deviceOS: DeviceTypes.DeviceOS,
+    apiEnv: EnvironmentTypes.ApiEnv
 ): Promise<AxiosResponse<ReportInterceptEventResponse>> {
-    return apiEnv === ApiEnv.Mock
+    return apiEnv === EnvironmentTypes.ApiEnv.Mock
         ? adadaptedApiRequestMocks.reportInterceptEvent()
         : axios(`${apiEnv}/v/0.9.5/${deviceOS}/intercepts/events`, {
               method: "POST",
@@ -154,10 +155,10 @@ export function reportInterceptEvent(
  */
 export function reportListManagerEvents(
     requestData: ReportListManagerDataRequest,
-    deviceOS: DeviceOS,
-    apiEnv: ListManagerApiEnv
+    deviceOS: DeviceTypes.DeviceOS,
+    apiEnv: EnvironmentTypes.ListManagerApiEnv
 ): Promise<AxiosResponse<void>> {
-    return apiEnv === ListManagerApiEnv.Mock
+    return apiEnv === EnvironmentTypes.ListManagerApiEnv.Mock
         ? adadaptedApiRequestMocks.reportListManagerEvents()
         : axios(`${apiEnv}/v/1/${deviceOS}/events`, {
               method: "POST",
@@ -178,9 +179,9 @@ export function reportListManagerEvents(
  */
 export function reportPayloadContentStatus(
     requestData: ReportPayloadDataRequest,
-    apiEnv: PayloadApiEnv
+    apiEnv: EnvironmentTypes.PayloadApiEnv
 ): Promise<AxiosResponse<void>> {
-    return apiEnv === PayloadApiEnv.Mock
+    return apiEnv === EnvironmentTypes.PayloadApiEnv.Mock
         ? adadaptedApiRequestMocks.reportPayloadContentStatus()
         : axios(`${apiEnv}/v/1/tracking`, {
               method: "POST",
@@ -200,9 +201,9 @@ export function reportPayloadContentStatus(
  */
 export function retrievePayloadContent(
     requestData: RetrievePayloadItemDataRequest,
-    apiEnv: PayloadApiEnv
+    apiEnv: EnvironmentTypes.PayloadApiEnv
 ): Promise<AxiosResponse<RetrievePayloadItemDataResponse>> {
-    return apiEnv === PayloadApiEnv.Mock
+    return apiEnv === EnvironmentTypes.PayloadApiEnv.Mock
         ? adadaptedApiRequestMocks.retrievePayloadContent()
         : axios(`${apiEnv}/v/1/pickup`, {
               method: "POST",

package/src/api/adadaptedApiTypes.ts

@@ -156,11 +156,6 @@ export interface OutOfAppDataPayload {
     detailed_list_items: DetailedListItem[];
 }
 
-export interface AdZoneDetailedListItemInfo {
-    zoneId: string;
-    items: DetailedListItem[];
-}
-
 /**
  * The definition of a Detailed List Item.
  */
@@ -571,6 +566,17 @@ export interface RefreshSessionDataRequest {
      * The current session ID.
      */
     sid: string;
+    /**
+     * The current sdk version.
+     */
+    sdkVersion: string;
+    /**
+     * The context IDs and associated zone IDs.
+     */
+    adContext?: {
+        contextIds: string[] | undefined;
+        zoneIds: string[];
+    };
 }
 
 /**

package/src/componentTypes/AdZone.ts

@@ -0,0 +1,97 @@
+import { ViewStyle } from "react-native/types";
+import { Zone, DetailedListItem } from "src/api/adadaptedApiTypes";
+import { DeviceTypes } from "./Device";
+import { EnvironmentTypes } from "./Environment";
+
+/**
+ * Namespace for AdZone types.
+ */
+export namespace AdZoneTypes {
+    /**
+     * Props interface for an ad zone.
+     */
+    export interface Props {
+        /**
+         * The app ID.
+         */
+        appId: string;
+        /**
+         * The session ID.
+         */
+        sessionId: string;
+        /**
+         * The UDID.
+         */
+        udid: string;
+        /**
+         * 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
+         * Ad Zone is being touched by the user as a regular touch or while
+         * scrolling the view. If the amount of touch "drag" distance in either
+         * X or Y direction is less than this value, we will treat the action as
+         * a click/press on the Ad Zone.
+         */
+        xyDragDistanceAllowed: number;
+        /**
+         * The device OS used for API requests.
+         */
+        deviceOs: DeviceTypes.DeviceOS;
+        /**
+         * The API environment to use when making an API request.
+         */
+        apiEnv: EnvironmentTypes.ApiEnv;
+        /**
+         * The ad zone data.
+         */
+        adZoneData: Zone;
+        /**
+         * Callback that gets triggered when an "add to list" item/items are clicked.
+         * @param items - The array of items to "add to list".
+         */
+        onAddToListTriggered?(items: DetailedListItem[]): void;
+        /**
+         * An ad zone that is not visible on screen for the initial render.
+         */
+        offScreenAdZone: boolean;
+        /**
+         * Track the ad zone visibility in parent component. (for off-screen ads)
+         */
+        isAdZoneVisible?: boolean;
+        /**
+         * Flag to determine if the ad is contextual.
+         */
+        isContextualAd?: boolean;
+    }
+
+    /**
+     * Interface for tracking "touch" coordinates.
+     */
+    export interface TouchCoordinates {
+        /**
+         * The X coordinate for the touch.
+         */
+        x: number;
+        /**
+         * The Y coordinate for the touch.
+         */
+        y: number;
+    }
+
+    /**
+     * Defines the style typing for the component.
+     */
+    export interface StyleDef {
+        /**
+         * Styles for the main View element.
+         */
+        mainView: ViewStyle;
+        /**
+         * Styles for the WebView element.
+         */
+        webView: ViewStyle;
+        /**
+         * Styles for the ReportAdButton.
+         */
+        reportAd: ViewStyle;
+    }
+}

package/src/componentTypes/Device.ts

@@ -0,0 +1,79 @@
+/**
+ * Namespace for Device types.
+ */
+export namespace DeviceTypes {
+    /**
+     * Enum representing possible device operating systems.
+     */
+    export enum DeviceOS {
+        /**
+         * Represents the Android operating system.
+         */
+        ANDROID = "android",
+        /**
+         * Represents the iOS operating system.
+         */
+        IOS = "ios",
+    }
+    /**
+     * Interface defining properties of a user's Device.
+     */
+    export interface DeviceInfo {
+        /**
+         * The unique device ID.
+         */
+        udid: string;
+        /**
+         * The device name.
+         */
+        deviceName: string;
+        /**
+         * The operating system name.
+         */
+        systemName: string;
+        /**
+         * The operating system version.
+         */
+        systemVersion: string;
+        /**
+         * The device model.
+         */
+        deviceModel: string;
+        /**
+         * The device screen width.
+         */
+        deviceWidth: string;
+        /**
+         * The device screen height.
+         */
+        deviceHeight: string;
+        /**
+         * The device screen density.
+         */
+        deviceScreenDensity: string;
+        /**
+         * The current device local.
+         */
+        deviceLocale: string;
+        /**
+         * The device carrier name.
+         */
+        deviceCarrier: string;
+        /**
+         * The bundle ID.
+         */
+        bundleId: string;
+        /**
+         * The bundle version.
+         */
+        bundleVersion: string;
+        /**
+         * The current device timezone.
+         */
+        deviceTimezone: string;
+        /**
+         * If true, ad tracking is enabled for the device.
+         */
+        isAdTrackingEnabled: boolean;
+    }
+}

package/src/componentTypes/Environment.ts

@@ -0,0 +1,58 @@
+/**
+ * Namespace for environment types.
+ */
+export namespace EnvironmentTypes {
+    /**
+     * Enum defining the different API environments.
+     */
+    export enum ApiEnv {
+        /**
+         * The production API environment.
+         */
+        Prod = "https://ads.adadapted.com",
+        /**
+         * The development API environment.
+         */
+        Dev = "https://sandbox.adadapted.com",
+        /**
+         * Used only for unit testing/mock data.
+         */
+        Mock = "MOCK_DATA",
+    }
+
+    /**
+     * Enum defining the different API environments for List Manager.
+     */
+    export enum ListManagerApiEnv {
+        /**
+         * The production API environment.
+         */
+        Prod = "https://ec.adadapted.com",
+        /**
+         * The development API environment.
+         */
+        Dev = "https://sandec.adadapted.com",
+        /**
+         * Used only for unit testing/mocking data.
+         */
+        Mock = "MOCK_DATA",
+    }
+
+    /**
+     * Enum defining the different API environments for the Payload Server.
+     */
+    export enum PayloadApiEnv {
+        /**
+         * The production API environment.
+         */
+        Prod = "https://payload.adadapted.com",
+        /**
+         * The development API environment.
+         */
+        Dev = "https://sandpayload.adadapted.com",
+        /**
+         * Used only for unit testing/mocking data.
+         */
+        Mock = "MOCK_DATA",
+    }
+}