@adadapted/react-native-sdk 3.1.12 → 3.2.0

package/lib/commonjs/api/adadaptedApiTypes.js

@@ -86,6 +86,7 @@ let ReportedEventType;
 exports.ReportedEventType = ReportedEventType;
 (function (ReportedEventType) {
   ReportedEventType["IMPRESSION"] = "impression";
+  ReportedEventType["INVISIBLE_IMPRESSION"] = "invisible_impression";
   ReportedEventType["INTERACTION"] = "interaction";
   ReportedEventType["NOT_MATCHED"] = "not_matched";
   ReportedEventType["MATCHED"] = "matched";

package/lib/commonjs/api/adadaptedApiTypes.js.map

@@ -1 +1 @@
-{"version":3,"names":["ListManagerEventSource","ListManagerEventName","AdActionType","ReportedEventType","PayloadStatus"],"sources":["adadaptedApiTypes.ts"],"sourcesContent":["// =============================================================================\n// API TYPE MODELS\n// =============================================================================\n/**\n * The definition of an ad session data object.\n */\nexport interface AdSession {\n    /**\n     * The session ID.\n     */\n    session_id: string;\n    /**\n     * If true, ads will be served.\n     */\n    will_serve_ads: boolean;\n    /**\n     * If true, there are active campaigns.\n     */\n    active_campaigns: boolean;\n    /**\n     * How often to refresh session/ad data?\n     */\n    polling_interval_ms: number;\n    /**\n     * The time at which the session will expire.\n     */\n    session_expires_at: number;\n    /**\n     * All ad zones.\n     */\n    zones: { [key: number]: Zone };\n}\n\n/**\n * The definition of a zone.\n */\nexport interface Zone {\n    /**\n     * The zone ID.\n     */\n    id: string;\n    /**\n     * ?\n     */\n    land_height: number;\n    /**\n     * ?\n     */\n    land_width: number;\n    /**\n     * ?\n     */\n    port_height: number;\n    /**\n     * ?\n     */\n    port_width: number;\n    /**\n     * The available ads.\n     */\n    ads: Ad[];\n}\n\n/**\n * The definition of an Ad.\n */\nexport interface Ad {\n    /**\n     * The ad ID.\n     */\n    ad_id: string;\n    /**\n     * The impression ID.\n     */\n    impression_id: string;\n    /**\n     * The type of ad this is.\n     */\n    type: string;\n    /**\n     * How often the ad refreshes? Swaps out for another?\n     * Length of time in seconds.\n     */\n    refresh_time: number;\n    /**\n     * The URL for the ad image to display.\n     */\n    creative_url: string;\n    /**\n     * The tracking pixel to include in the zone view for this ad?\n     */\n    tracking_html: string;\n    /**\n     * ?\n     */\n    action_path: string;\n    /**\n     * ?\n     */\n    action_type: AdActionType;\n    /**\n     * If true, the ad will be hidden after interaction.\n     */\n    hide_after_interaction: boolean;\n    /**\n     * ?\n     */\n    payload: AdPayload;\n}\n\n/**\n * The definition of an Ad Payload.\n */\nexport interface AdPayload {\n    /**\n     * The array of list items.\n     */\n    detailed_list_items: DetailedListItem[];\n}\n\n/**\n * The definition of an \"out of app\" data payload.\n */\nexport interface OutOfAppDataPayload {\n    /**\n     * The payload ID associated to the provided list items.\n     */\n    payload_id: string;\n    /**\n     * The payload message.\n     */\n    payload_message?: string;\n    /**\n     * The payload image.\n     */\n    payload_image?: string;\n    /**\n     * The campaign ID.\n     */\n    campaign_id?: string;\n    /**\n     * The app ID.\n     */\n    app_id?: string;\n    /**\n     * Expiration time in seconds.\n     */\n    expire_seconds?: number;\n    /**\n     * The array of list items.\n     */\n    detailed_list_items: DetailedListItem[];\n}\n\n/**\n * The definition of a Detailed List Item.\n */\nexport interface DetailedListItem {\n    /**\n     * The barcode of the product.\n     */\n    product_barcode: string;\n    /**\n     * The brand of the product.\n     */\n    product_brand: string;\n    /**\n     * The category of the product.\n     */\n    product_category: string;\n    /**\n     * The discount given for the product.\n     */\n    product_discount: string;\n    /**\n     * The image used for display of the product.\n     */\n    product_image: string;\n    /**\n     * The SKU of the product.\n     */\n    product_sku: string;\n    /**\n     * The name/title of the product.\n     */\n    product_title: string;\n    /**\n     * The tracking ID.\n     */\n    tracking_id?: string;\n}\n\n/**\n * The definition of a Keyword Intercepts object.\n */\nexport interface KeywordIntercepts {\n    /**\n     * The search ID.\n     * Automatically assigned by the API.\n     */\n    search_id: string;\n    /**\n     * The minimum number of characters required to perform\n     * a search against all available search terms.\n     */\n    min_match_length: number;\n    /**\n     * All available search terms.\n     */\n    terms: KeywordSearchTerm[];\n}\n\n/**\n * The definition of a Keyword Search Term.\n */\nexport interface KeywordSearchTerm {\n    /**\n     * The search term ID.\n     */\n    term_id: string;\n    /**\n     * The search term to validate a search string against.\n     */\n    term: string;\n    /**\n     * The display string a client can use to display in a list.\n     */\n    replacement: string;\n    /**\n     * The display priority of this item.\n     * Compare this to other {@link KeywordSearchTerm} items to determine\n     * the final priority order during display.\n     * The lower the number, the higher the priority.\n     */\n    priority: number;\n}\n\n/**\n * The definition of a Reported Ad Event.\n */\nexport interface ReportedAdEvent {\n    /**\n     * The add ID.\n     */\n    ad_id: string;\n    /**\n     * The impression ID.\n     */\n    impression_id: string;\n    /**\n     * The event type to report\n     */\n    event_type: ReportedEventType;\n    /**\n     * The timestamp at which the event occurred.\n     */\n    created_at: number;\n}\n\n/**\n * The definition of a Reported Intercept Event.\n */\nexport interface ReportedInterceptEvent {\n    /**\n     * The intercept search ID.\n     */\n    search_id: string;\n    /**\n     * The term ID.\n     */\n    term_id: string;\n    /**\n     * The term.\n     */\n    term: string;\n    /**\n     * The user input provided that ultimately\n     * resulted in the event triggering.\n     */\n    user_input: string;\n    /**\n     * The event type to report\n     */\n    event_type: ReportedEventType;\n    /**\n     * The timestamp at which the event occurred.\n     */\n    created_at: number;\n}\n\n/**\n * Interface defining the structure of an event to send when using List Manager.\n */\nexport interface ListManagerEvent {\n    /**\n     * The source of the list manager event.\n     */\n    event_source: ListManagerEventSource;\n    /**\n     * The timestamp this event occurred (unix time).\n     */\n    event_timestamp: number;\n    /**\n     * The event name.\n     */\n    event_name: ListManagerEventName;\n    /**\n     * The parameter the event is triggered for.\n     */\n    event_params: ListManagerEventParam;\n}\n\n/**\n * Interface defining the structure of a payload tracking event.\n */\nexport interface PayloadTrackingEvent {\n    /**\n     * The source of the list manager event.\n     */\n    payload_id: string;\n    /**\n     * The status to report.\n     */\n    status: PayloadStatus;\n    /**\n     * The timestamp this event occurred (unix time).\n     */\n    event_timestamp: number;\n}\n\n/**\n * Interface defining the structure of an Event Param for List Manager.\n */\nexport interface ListManagerEventParam {\n    /**\n     * The item name being reported.\n     */\n    item_name: string;\n    /**\n     * The list name being reported.\n     */\n    list_name?: string;\n}\n\n/**\n * Enumeration that defines the possible values for a List Manager Event Source.\n */\nexport enum ListManagerEventSource {\n    /**\n     * The event was triggered from the app.\n     */\n    APP = \"app\",\n}\n\n/**\n * Enumeration that defines the possible values for a List Manager Event Name.\n */\nexport enum ListManagerEventName {\n    /**\n     * The user added an item to their list.\n     */\n    ADDED_TO_LIST = \"user_added_to_list\",\n    /**\n     * The user crossed off an item from their list.\n     */\n    CROSSED_OFF_LIST = \"user_crossed_off_list\",\n    /**\n     * The user deleted an item from their list.\n     */\n    DELETED_FROM_LIST = \"user_deleted_from_list\",\n}\n\n/**\n * Enum defining the available ad action types.\n */\nexport enum AdActionType {\n    /**\n     * Used for Add To List.\n     */\n    CONTENT = \"c\",\n    /**\n     * Used for opening URLs in an external browser.\n     */\n    EXTERNAL = \"e\",\n    /**\n     * Used for opening URLs in a web view within the app.\n     * NOTE: This one should probably be deprecated with the new\n     *       platform redesign, since its not as obvious what it does.\n     */\n    LINK = \"l\",\n    /**\n     * Used for opening app store URLs in the app store.\n     */\n    APP = \"a\",\n    /**\n     * ?\n     */\n    NONE = \"n\",\n}\n\n/**\n * Enum defining the different types of events that can be reported.\n */\nexport enum ReportedEventType {\n    /**\n     * Occurs when an ad is displayed to the user.\n     */\n    IMPRESSION = \"impression\",\n    /**\n     * Occurs when the user interacts with an ad.\n     */\n    INTERACTION = \"interaction\",\n    /**\n     * Occurs when the user's search term did not\n     * match an available keyword intercept term.\n     */\n    NOT_MATCHED = \"not_matched\",\n    /**\n     * Occurs when the user's search term has matched a keyword intercept term.\n     */\n    MATCHED = \"matched\",\n    /**\n     * Occurs when the user was presented a keyword intercept term.\n     */\n    PRESENTED = \"presented\",\n    /**\n     * Occurs when the user has selected a keyword intercept term.\n     */\n    SELECTED = \"selected\",\n}\n\n/**\n * Enumeration defining the possible payload acknowledgment status values.\n */\nexport enum PayloadStatus {\n    /**\n     * The delivered status.\n     */\n    DELIVERED = \"delivered\",\n    /**\n     * The rejected status.\n     */\n    REJECTED = \"rejected\",\n}\n\n// =============================================================================\n// REQUEST MODELS\n// =============================================================================\n/**\n * The base request inputs that most requests will use.\n */\nexport interface BaseRequestInputs {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    app_id: string;\n    /**\n     * The unique device ID.\n     */\n    udid: string;\n    /**\n     * The current session ID.\n     */\n    session_id: string;\n}\n\n/**\n * Interface for the request of the Initialize Session API call.\n */\nexport interface InitializeSessionRequest {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    app_id: string;\n    /**\n     * The unique device ID of the users device.\n     */\n    udid: string;\n    /**\n     * The bundle ID.\n     */\n    bundle_id?: string;\n    /**\n     * The bundle version.\n     */\n    bundle_version?: string;\n    /**\n     * The name of the device.\n     */\n    device_name?: string;\n    /**\n     * The unique device ID of the users device.\n     */\n    device_udid?: string;\n    /**\n     * The OS of the device.\n     */\n    device_os?: string;\n    /**\n     * The OS version of the device.\n     */\n    device_osv?: string;\n    /**\n     * The locale the device is currently set for.\n     */\n    device_locale?: string;\n    /**\n     * The timezone the device is currently set for.\n     */\n    device_timezone?: string;\n    /**\n     * The device carrier name.\n     */\n    device_carrier?: string;\n    /**\n     * The height of the devices screen in pixels.\n     */\n    device_height?: number;\n    /**\n     * The width of the devices screen in pixels.\n     */\n    device_width?: number;\n    /**\n     * The density of the devices screen.\n     */\n    device_density?: string;\n    /**\n     * If true, the device allows for ad retargeting.\n     */\n    allow_retargeting?: boolean;\n    /**\n     * ?\n     */\n    created_at?: number;\n    /**\n     * The AdAdapted SDK version number.\n     */\n    sdk_version?: string;\n    /**\n     * ?\n     */\n    params?: { [key: string]: string };\n}\n\n/**\n * Interface for the request of the Refresh Session Data API call.\n */\nexport interface RefreshSessionDataRequest {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    aid: string;\n    /**\n     * The unique device ID.\n     */\n    uid: string;\n    /**\n     * The current session ID.\n     */\n    sid: string;\n}\n\n/**\n * Interface for the request that reports an ad event.\n */\nexport interface ReportAdEventRequest extends BaseRequestInputs {\n    /**\n     * Events to report.\n     */\n    events: ReportedAdEvent[];\n}\n\n/**\n * Interface for the request of the Refresh Session Data API call.\n */\nexport interface KeywordInterceptsRequest {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    aid: string;\n    /**\n     * The unique device ID.\n     */\n    uid: string;\n    /**\n     * The current session ID.\n     */\n    sid: string;\n}\n\n/**\n * Interface for the request that reports an intercept event.\n */\nexport interface ReportInterceptEventRequest extends BaseRequestInputs {\n    /**\n     * Events to report.\n     */\n    events: ReportedInterceptEvent[];\n}\n\n/**\n * Interface for the request that reports List Manager data.\n */\nexport interface ReportListManagerDataRequest extends BaseRequestInputs {\n    /**\n     * The events to report.\n     */\n    events: ListManagerEvent[];\n}\n\n/**\n * Interface for the request that reports Payload tracking data.\n */\nexport interface ReportPayloadDataRequest extends BaseRequestInputs {\n    /**\n     * The payload tracking events.\n     */\n    tracking: PayloadTrackingEvent[];\n}\n\n/**\n * Interface for the request that gets Payload server data.\n */\nexport interface RetrievePayloadItemDataRequest extends BaseRequestInputs {}\n\n// =============================================================================\n// RESPONSE MODELS\n// =============================================================================\n/**\n * Interface for the response of the Campaign API request.\n */\nexport interface InitializeSessionResponse extends AdSession {}\n\n/**\n * Interface for the response of the Campaign API request.\n */\nexport interface RefreshSessionDataResponse extends AdSession {}\n\n/**\n * Interface for the response of the Report Ad Event API request.\n */\nexport interface ReportAdEventResponse {\n    /**\n     * Array that contains response strings of \"Ok\" or \"Failed\" based\n     * on the same order of the events sent to the request.\n     */\n    results: string[];\n}\n\n/**\n * Interface for the response of the Keyword Intercepts API request.\n */\nexport interface KeywordInterceptsResponse extends KeywordIntercepts {}\n\n/**\n * Interface for the response of the Report Intercept Event API request.\n */\nexport interface ReportInterceptEventResponse {\n    /**\n     * Array that contains response strings of \"Ok\" or \"Failed\" based\n     * on the same order of the events sent to the request.\n     */\n    results: string[];\n}\n\n/**\n * Interface for the response of the Retrieve Payload Item Data API request.\n */\nexport interface RetrievePayloadItemDataResponse {\n    /**\n     * Array containing all current payloads for the provided user.\n     */\n    payloads: OutOfAppDataPayload[];\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AA4BA;AACA;AACA;AA4BA;AACA;AACA;AA6CA;AACA;AACA;AAQA;AACA;AACA;AAgCA;AACA;AACA;AAoCA;AACA;AACA;AAkBA;AACA;AACA;AAuBA;AACA;AACA;AAoBA;AACA;AACA;AA6BA;AACA;AACA;AAoBA;AACA;AACA;AAgBA;AACA;AACA;AAYA;AACA;AACA;AAFA,IAGYA,sBAAsB;AAOlC;AACA;AACA;AAFA;AAAA,WAPYA,sBAAsB;EAAtBA,sBAAsB;AAAA,GAAtBA,sBAAsB,sCAAtBA,sBAAsB;AAAA,IAUtBC,oBAAoB;AAehC;AACA;AACA;AAFA;AAAA,WAfYA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;AAAA,GAApBA,oBAAoB,oCAApBA,oBAAoB;AAAA,IAkBpBC,YAAY;AAyBxB;AACA;AACA;AAFA;AAAA,WAzBYA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;AAAA,GAAZA,YAAY,4BAAZA,YAAY;AAAA,IA4BZC,iBAAiB;AA4B7B;AACA;AACA;AAFA;AAAA,WA5BYA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;AAAA,GAAjBA,iBAAiB,iCAAjBA,iBAAiB;AAAA,IA+BjBC,aAAa,EAWzB;AACA;AACA;AACA;AACA;AACA;AAFA;AAAA,WAdYA,aAAa;EAAbA,aAAa;EAAbA,aAAa;AAAA,GAAbA,aAAa,6BAAbA,aAAa"}
+{"version":3,"names":["ListManagerEventSource","ListManagerEventName","AdActionType","ReportedEventType","PayloadStatus"],"sources":["adadaptedApiTypes.ts"],"sourcesContent":["// =============================================================================\n// API TYPE MODELS\n// =============================================================================\n/**\n * The definition of an ad session data object.\n */\nexport interface AdSession {\n    /**\n     * The session ID.\n     */\n    session_id: string;\n    /**\n     * If true, ads will be served.\n     */\n    will_serve_ads: boolean;\n    /**\n     * If true, there are active campaigns.\n     */\n    active_campaigns: boolean;\n    /**\n     * How often to refresh session/ad data?\n     */\n    polling_interval_ms: number;\n    /**\n     * The time at which the session will expire.\n     */\n    session_expires_at: number;\n    /**\n     * All ad zones.\n     */\n    zones: { [key: number]: Zone };\n}\n\n/**\n * The definition of a zone.\n */\nexport interface Zone {\n    /**\n     * The zone ID.\n     */\n    id: string;\n    /**\n     * ?\n     */\n    land_height: number;\n    /**\n     * ?\n     */\n    land_width: number;\n    /**\n     * ?\n     */\n    port_height: number;\n    /**\n     * ?\n     */\n    port_width: number;\n    /**\n     * The available ads.\n     */\n    ads: Ad[];\n}\n\n/**\n * The definition of an Ad.\n */\nexport interface Ad {\n    /**\n     * The ad ID.\n     */\n    ad_id: string;\n    /**\n     * The impression ID.\n     */\n    impression_id: string;\n    /**\n     * The type of ad this is.\n     */\n    type: string;\n    /**\n     * How often the ad refreshes? Swaps out for another?\n     * Length of time in seconds.\n     */\n    refresh_time: number;\n    /**\n     * The URL for the ad image to display.\n     */\n    creative_url: string;\n    /**\n     * The tracking pixel to include in the zone view for this ad?\n     */\n    tracking_html: string;\n    /**\n     * ?\n     */\n    action_path: string;\n    /**\n     * ?\n     */\n    action_type: AdActionType;\n    /**\n     * If true, the ad will be hidden after interaction.\n     */\n    hide_after_interaction: boolean;\n    /**\n     * ?\n     */\n    payload: AdPayload;\n    /**\n     * Track impression status.\n     */\n    impression_tracked?: boolean;\n}\n\n/**\n * The definition of an Ad Payload.\n */\nexport interface AdPayload {\n    /**\n     * The array of list items.\n     */\n    detailed_list_items: DetailedListItem[];\n}\n\n/**\n * The definition of an \"out of app\" data payload.\n */\nexport interface OutOfAppDataPayload {\n    /**\n     * The payload ID associated to the provided list items.\n     */\n    payload_id: string;\n    /**\n     * The payload message.\n     */\n    payload_message?: string;\n    /**\n     * The payload image.\n     */\n    payload_image?: string;\n    /**\n     * The campaign ID.\n     */\n    campaign_id?: string;\n    /**\n     * The app ID.\n     */\n    app_id?: string;\n    /**\n     * Expiration time in seconds.\n     */\n    expire_seconds?: number;\n    /**\n     * The array of list items.\n     */\n    detailed_list_items: DetailedListItem[];\n}\n\n/**\n * The definition of a Detailed List Item.\n */\nexport interface DetailedListItem {\n    /**\n     * The barcode of the product.\n     */\n    product_barcode: string;\n    /**\n     * The brand of the product.\n     */\n    product_brand: string;\n    /**\n     * The category of the product.\n     */\n    product_category: string;\n    /**\n     * The discount given for the product.\n     */\n    product_discount: string;\n    /**\n     * The image used for display of the product.\n     */\n    product_image: string;\n    /**\n     * The SKU of the product.\n     */\n    product_sku: string;\n    /**\n     * The name/title of the product.\n     */\n    product_title: string;\n    /**\n     * The tracking ID.\n     */\n    tracking_id?: string;\n}\n\n/**\n * The definition of a Keyword Intercepts object.\n */\nexport interface KeywordIntercepts {\n    /**\n     * The search ID.\n     * Automatically assigned by the API.\n     */\n    search_id: string;\n    /**\n     * The minimum number of characters required to perform\n     * a search against all available search terms.\n     */\n    min_match_length: number;\n    /**\n     * All available search terms.\n     */\n    terms: KeywordSearchTerm[];\n}\n\n/**\n * The definition of a Keyword Search Term.\n */\nexport interface KeywordSearchTerm {\n    /**\n     * The search term ID.\n     */\n    term_id: string;\n    /**\n     * The search term to validate a search string against.\n     */\n    term: string;\n    /**\n     * The display string a client can use to display in a list.\n     */\n    replacement: string;\n    /**\n     * The display priority of this item.\n     * Compare this to other {@link KeywordSearchTerm} items to determine\n     * the final priority order during display.\n     * The lower the number, the higher the priority.\n     */\n    priority: number;\n}\n\n/**\n * The definition of a Reported Ad Event.\n */\nexport interface ReportedAdEvent {\n    /**\n     * The add ID.\n     */\n    ad_id: string;\n    /**\n     * The impression ID.\n     */\n    impression_id: string;\n    /**\n     * The event type to report\n     */\n    event_type: ReportedEventType;\n    /**\n     * The timestamp at which the event occurred.\n     */\n    created_at: number;\n}\n\n/**\n * The definition of a Reported Intercept Event.\n */\nexport interface ReportedInterceptEvent {\n    /**\n     * The intercept search ID.\n     */\n    search_id: string;\n    /**\n     * The term ID.\n     */\n    term_id: string;\n    /**\n     * The term.\n     */\n    term: string;\n    /**\n     * The user input provided that ultimately\n     * resulted in the event triggering.\n     */\n    user_input: string;\n    /**\n     * The event type to report\n     */\n    event_type: ReportedEventType;\n    /**\n     * The timestamp at which the event occurred.\n     */\n    created_at: number;\n}\n\n/**\n * Interface defining the structure of an event to send when using List Manager.\n */\nexport interface ListManagerEvent {\n    /**\n     * The source of the list manager event.\n     */\n    event_source: ListManagerEventSource;\n    /**\n     * The timestamp this event occurred (unix time).\n     */\n    event_timestamp: number;\n    /**\n     * The event name.\n     */\n    event_name: ListManagerEventName;\n    /**\n     * The parameter the event is triggered for.\n     */\n    event_params: ListManagerEventParam;\n}\n\n/**\n * Interface defining the structure of a payload tracking event.\n */\nexport interface PayloadTrackingEvent {\n    /**\n     * The source of the list manager event.\n     */\n    payload_id: string;\n    /**\n     * The status to report.\n     */\n    status: PayloadStatus;\n    /**\n     * The timestamp this event occurred (unix time).\n     */\n    event_timestamp: number;\n}\n\n/**\n * Interface defining the structure of an Event Param for List Manager.\n */\nexport interface ListManagerEventParam {\n    /**\n     * The item name being reported.\n     */\n    item_name: string;\n    /**\n     * The list name being reported.\n     */\n    list_name?: string;\n}\n\n/**\n * Enumeration that defines the possible values for a List Manager Event Source.\n */\nexport enum ListManagerEventSource {\n    /**\n     * The event was triggered from the app.\n     */\n    APP = \"app\",\n}\n\n/**\n * Enumeration that defines the possible values for a List Manager Event Name.\n */\nexport enum ListManagerEventName {\n    /**\n     * The user added an item to their list.\n     */\n    ADDED_TO_LIST = \"user_added_to_list\",\n    /**\n     * The user crossed off an item from their list.\n     */\n    CROSSED_OFF_LIST = \"user_crossed_off_list\",\n    /**\n     * The user deleted an item from their list.\n     */\n    DELETED_FROM_LIST = \"user_deleted_from_list\",\n}\n\n/**\n * Enum defining the available ad action types.\n */\nexport enum AdActionType {\n    /**\n     * Used for Add To List.\n     */\n    CONTENT = \"c\",\n    /**\n     * Used for opening URLs in an external browser.\n     */\n    EXTERNAL = \"e\",\n    /**\n     * Used for opening URLs in a web view within the app.\n     * NOTE: This one should probably be deprecated with the new\n     *       platform redesign, since its not as obvious what it does.\n     */\n    LINK = \"l\",\n    /**\n     * Used for opening app store URLs in the app store.\n     */\n    APP = \"a\",\n    /**\n     * ?\n     */\n    NONE = \"n\",\n}\n\n/**\n * Enum defining the different types of events that can be reported.\n */\nexport enum ReportedEventType {\n    /**\n     * Occurs when an ad is displayed to the user.\n     */\n    IMPRESSION = \"impression\",\n    /**\n     * Occurs when an ad is not viewable before timimg out.\n     */\n    INVISIBLE_IMPRESSION = \"invisible_impression\",\n    /**\n     * Occurs when the user interacts with an ad.\n     */\n    INTERACTION = \"interaction\",\n    /**\n     * Occurs when the user's search term did not\n     * match an available keyword intercept term.\n     */\n    NOT_MATCHED = \"not_matched\",\n    /**\n     * Occurs when the user's search term has matched a keyword intercept term.\n     */\n    MATCHED = \"matched\",\n    /**\n     * Occurs when the user was presented a keyword intercept term.\n     */\n    PRESENTED = \"presented\",\n    /**\n     * Occurs when the user has selected a keyword intercept term.\n     */\n    SELECTED = \"selected\",\n}\n\n/**\n * Enumeration defining the possible payload acknowledgment status values.\n */\nexport enum PayloadStatus {\n    /**\n     * The delivered status.\n     */\n    DELIVERED = \"delivered\",\n    /**\n     * The rejected status.\n     */\n    REJECTED = \"rejected\",\n}\n\n// =============================================================================\n// REQUEST MODELS\n// =============================================================================\n/**\n * The base request inputs that most requests will use.\n */\nexport interface BaseRequestInputs {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    app_id: string;\n    /**\n     * The unique device ID.\n     */\n    udid: string;\n    /**\n     * The current session ID.\n     */\n    session_id: string;\n}\n\n/**\n * Interface for the request of the Initialize Session API call.\n */\nexport interface InitializeSessionRequest {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    app_id: string;\n    /**\n     * The unique device ID of the users device.\n     */\n    udid: string;\n    /**\n     * The bundle ID.\n     */\n    bundle_id?: string;\n    /**\n     * The bundle version.\n     */\n    bundle_version?: string;\n    /**\n     * The name of the device.\n     */\n    device_name?: string;\n    /**\n     * The unique device ID of the users device.\n     */\n    device_udid?: string;\n    /**\n     * The OS of the device.\n     */\n    device_os?: string;\n    /**\n     * The OS version of the device.\n     */\n    device_osv?: string;\n    /**\n     * The locale the device is currently set for.\n     */\n    device_locale?: string;\n    /**\n     * The timezone the device is currently set for.\n     */\n    device_timezone?: string;\n    /**\n     * The device carrier name.\n     */\n    device_carrier?: string;\n    /**\n     * The height of the devices screen in pixels.\n     */\n    device_height?: number;\n    /**\n     * The width of the devices screen in pixels.\n     */\n    device_width?: number;\n    /**\n     * The density of the devices screen.\n     */\n    device_density?: string;\n    /**\n     * If true, the device allows for ad retargeting.\n     */\n    allow_retargeting?: boolean;\n    /**\n     * ?\n     */\n    created_at?: number;\n    /**\n     * The AdAdapted SDK version number.\n     */\n    sdk_version?: string;\n    /**\n     * ?\n     */\n    params?: { [key: string]: string };\n}\n\n/**\n * Interface for the request of the Refresh Session Data API call.\n */\nexport interface RefreshSessionDataRequest {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    aid: string;\n    /**\n     * The unique device ID.\n     */\n    uid: string;\n    /**\n     * The current session ID.\n     */\n    sid: string;\n}\n\n/**\n * Interface for the request that reports an ad event.\n */\nexport interface ReportAdEventRequest extends BaseRequestInputs {\n    /**\n     * Events to report.\n     */\n    events: ReportedAdEvent[];\n}\n\n/**\n * Interface for the request of the Refresh Session Data API call.\n */\nexport interface KeywordInterceptsRequest {\n    /**\n     * The app ID provided by the client using the API.\n     */\n    aid: string;\n    /**\n     * The unique device ID.\n     */\n    uid: string;\n    /**\n     * The current session ID.\n     */\n    sid: string;\n}\n\n/**\n * Interface for the request that reports an intercept event.\n */\nexport interface ReportInterceptEventRequest extends BaseRequestInputs {\n    /**\n     * Events to report.\n     */\n    events: ReportedInterceptEvent[];\n}\n\n/**\n * Interface for the request that reports List Manager data.\n */\nexport interface ReportListManagerDataRequest extends BaseRequestInputs {\n    /**\n     * The events to report.\n     */\n    events: ListManagerEvent[];\n}\n\n/**\n * Interface for the request that reports Payload tracking data.\n */\nexport interface ReportPayloadDataRequest extends BaseRequestInputs {\n    /**\n     * The payload tracking events.\n     */\n    tracking: PayloadTrackingEvent[];\n}\n\n/**\n * Interface for the request that gets Payload server data.\n */\nexport interface RetrievePayloadItemDataRequest extends BaseRequestInputs {}\n\n// =============================================================================\n// RESPONSE MODELS\n// =============================================================================\n/**\n * Interface for the response of the Campaign API request.\n */\nexport interface InitializeSessionResponse extends AdSession {}\n\n/**\n * Interface for the response of the Campaign API request.\n */\nexport interface RefreshSessionDataResponse extends AdSession {}\n\n/**\n * Interface for the response of the Report Ad Event API request.\n */\nexport interface ReportAdEventResponse {\n    /**\n     * Array that contains response strings of \"Ok\" or \"Failed\" based\n     * on the same order of the events sent to the request.\n     */\n    results: string[];\n}\n\n/**\n * Interface for the response of the Keyword Intercepts API request.\n */\nexport interface KeywordInterceptsResponse extends KeywordIntercepts {}\n\n/**\n * Interface for the response of the Report Intercept Event API request.\n */\nexport interface ReportInterceptEventResponse {\n    /**\n     * Array that contains response strings of \"Ok\" or \"Failed\" based\n     * on the same order of the events sent to the request.\n     */\n    results: string[];\n}\n\n/**\n * Interface for the response of the Retrieve Payload Item Data API request.\n */\nexport interface RetrievePayloadItemDataResponse {\n    /**\n     * Array containing all current payloads for the provided user.\n     */\n    payloads: OutOfAppDataPayload[];\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AA4BA;AACA;AACA;AA4BA;AACA;AACA;AAiDA;AACA;AACA;AAQA;AACA;AACA;AAgCA;AACA;AACA;AAoCA;AACA;AACA;AAkBA;AACA;AACA;AAuBA;AACA;AACA;AAoBA;AACA;AACA;AA6BA;AACA;AACA;AAoBA;AACA;AACA;AAgBA;AACA;AACA;AAYA;AACA;AACA;AAFA,IAGYA,sBAAsB;AAOlC;AACA;AACA;AAFA;AAAA,WAPYA,sBAAsB;EAAtBA,sBAAsB;AAAA,GAAtBA,sBAAsB,sCAAtBA,sBAAsB;AAAA,IAUtBC,oBAAoB;AAehC;AACA;AACA;AAFA;AAAA,WAfYA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;AAAA,GAApBA,oBAAoB,oCAApBA,oBAAoB;AAAA,IAkBpBC,YAAY;AAyBxB;AACA;AACA;AAFA;AAAA,WAzBYA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;AAAA,GAAZA,YAAY,4BAAZA,YAAY;AAAA,IA4BZC,iBAAiB;AAgC7B;AACA;AACA;AAFA;AAAA,WAhCYA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;AAAA,GAAjBA,iBAAiB,iCAAjBA,iBAAiB;AAAA,IAmCjBC,aAAa,EAWzB;AACA;AACA;AACA;AACA;AACA;AAFA;AAAA,WAdYA,aAAa;EAAbA,aAAa;EAAbA,aAAa;AAAA,GAAbA,aAAa,6BAAbA,aAAa"}

package/lib/commonjs/components/AdZone.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.AdZone = void 0;
+exports.AdZone = AdZone;
 var React = _interopRequireWildcard(require("react"));
 var _reactNative = require("react-native");
 var adadaptedApiRequests = _interopRequireWildcard(require("../api/adadaptedApiRequests"));
@@ -12,197 +12,229 @@ var _reactNativeWebview = require("react-native-webview");
 var _util = require("../util");
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+/**
+ * Component for creating an {@link AdZone}.
+ * @module
+ */
+
+/**
+ * Timer used for cycling through ads in the zone
+ * based on the ad "refresh time" for each ad.
+ */
+let cycleAdTimer;
+
 /**
  * Creates the AdZone component.
+ * @param props - properties passed to AdZone.
+ * @returns an AdZone JSX Element.
  */
-class AdZone extends React.Component {
-  /**
-   * Timer used for cycling through ads in the zone
-   * based on the ad "refresh time" for each ad.
-   */
+function AdZone(props) {
+  // Generates a random number between 0 and (number of available ads - 1).
+  const startingAdIndex = Math.floor(Math.random() * props.adZoneData.ads.length);
 
   /**
-   * @inheritDoc
+   * Tracks the current ad index being shown.
    */
-  constructor(props, context) {
-    super(props, context);
-
-    // Generates a random number between 0 and (number of available ads - 1).
-    _defineProperty(this, "cycleAdTimer", void 0);
-    const startingAdIndex = Math.floor(Math.random() * this.props.adZoneData.ads.length);
-    this.state = {
-      adIndexShown: startingAdIndex,
-      touchStartCoords: undefined
-    };
-  }
-
+  const [adIndexShown, setAdIndexShown] = (0, React.useState)(startingAdIndex);
   /**
-   * @inheritDoc
+   * Tracks the coordinates when the user started touching the Ad View.
    */
-  componentDidMount() {
-    this.initializeAd();
-  }
-
+  const [touchStartCoords, setTouchStartCoords] = (0, React.useState)({
+    x: 0,
+    y: 0
+  });
   /**
-   * @inheritDoc
+   * Track ad visibility (for off-screen ads).
    */
-  componentWillUnmount() {
-    if (this.cycleAdTimer) {
-      clearTimeout(this.cycleAdTimer);
+  const [isAdVisible, setIsAdVisibile] = (0, React.useState)(props.defaultToInvisibleAdZone ? false : true);
+
+  // - Define all useEffect triggers.
+  (0, React.useEffect)(() => {
+    _reactNative.DeviceEventEmitter.addListener("visibility-event", event => {
+      setIsAdVisibile(event);
+    });
+    _reactNative.DeviceEventEmitter.addListener("acknowledge", itemName => {
+      acknowledge(itemName);
+    });
+    return () => {
+      clearTimeout(cycleAdTimer);
+      _reactNative.DeviceEventEmitter.removeAllListeners("visibility-event");
+      _reactNative.DeviceEventEmitter.removeAllListeners("acknowledge");
+    };
+  }, []);
+  (0, React.useEffect)(() => {
+    startAdTimer();
+    if (isAdVisible) {
+      sendAdImpression();
     }
-  }
+  }, [adIndexShown]);
+  (0, React.useEffect)(() => {
+    if (isAdVisible) {
+      sendAdImpression();
+    }
+  }, [isAdVisible]);
 
   /**
-   * @inheritDoc
+   * Generates all component related styles.
+   * @returns the styles needed for the component.
    */
-  render() {
-    // Generate the styles each render in case the ad is updated with
-    // new settings that need to be reflected in the styles of the view.
-    const styles = this.generateStyles();
-    const currentAd = this.props.adZoneData.ads[this.state.adIndexShown] || undefined;
-    const finalMainViewStyle = styles.mainView;
-    if (!currentAd || !currentAd.creative_url) {
-      // If there is no ad to display, make the view take up no space.
-      finalMainViewStyle.width = 0;
-      finalMainViewStyle.height = 0;
-    }
-    return /*#__PURE__*/React.createElement(_reactNative.View, {
-      style: finalMainViewStyle
-    }, currentAd && currentAd.creative_url ? /*#__PURE__*/React.createElement(_reactNativeWebview.WebView, {
-      source: {
-        uri: currentAd.creative_url
-      },
-      androidLayerType: "hardware",
-      automaticallyAdjustContentInsets: false,
-      style: styles.webView,
-      onTouchStart: e => {
-        this.setState({
-          touchStartCoords: {
-            x: e.nativeEvent.pageX,
-            y: e.nativeEvent.pageY
-          }
-        });
+  function generateStyles() {
+    return _reactNative.StyleSheet.create({
+      mainView: {
+        width: "100%",
+        height: "100%"
       },
-      onTouchEnd: e => {
-        if (this.state.touchStartCoords) {
-          const touchEndCoords = {
-            x: e.nativeEvent.pageX,
-            y: e.nativeEvent.pageY
-          };
-          if (Math.abs(this.state.touchStartCoords.x - touchEndCoords.x) < this.props.xyDragDistanceAllowed && Math.abs(this.state.touchStartCoords.y - touchEndCoords.y) < this.props.xyDragDistanceAllowed) {
-            this.onAdZoneSelected(currentAd);
-          }
-
-          // Make sure to reset the start coords
-          this.setState({
-            touchStartCoords: undefined
-          });
-        }
+      webView: {
+        width: "100%",
+        height: "100%"
       }
-    }) : undefined);
+    });
+  }
+
+  // Generate the styles each render in case the ad is updated with
+  // new settings that need to be reflected in the styles of the view.
+  const styles = generateStyles();
+  const currentAd = props.adZoneData.ads[adIndexShown] || undefined;
+  const finalMainViewStyle = styles.mainView;
+  if (!currentAd || !currentAd.creative_url) {
+    // If there is no ad to display, make the view take up no space.
+    finalMainViewStyle.width = "0";
+    finalMainViewStyle.height = "0";
   }
 
   /**
    * Triggers when the user selects the ad zone.
-   * @param currentAd - The ad currently displayed.
+   * @param currentlyDisplayedAd - The ad currently displayed.
    */
-  onAdZoneSelected(currentAd) {
+  function onAdZoneSelected(currentlyDisplayedAd) {
     // Determine the "action type" and perform that specific action.
-    if (currentAd.action_type === _adadaptedApiTypes.AdActionType.EXTERNAL && currentAd.action_path) {
+    if (currentlyDisplayedAd.action_type === _adadaptedApiTypes.AdActionType.EXTERNAL && currentlyDisplayedAd.action_path) {
       // Action Type: EXTERNAL
-      _reactNative.Linking.openURL(currentAd.action_path).then();
-    } else if (currentAd.action_type === _adadaptedApiTypes.AdActionType.CONTENT && currentAd.payload && currentAd.payload.detailed_list_items) {
-      (0, _util.safeInvoke)(this.props.onAddToListTriggered, currentAd.payload.detailed_list_items);
+      _reactNative.Linking.openURL(currentlyDisplayedAd.action_path).then();
+    } else if (currentlyDisplayedAd.action_type === _adadaptedApiTypes.AdActionType.CONTENT && currentlyDisplayedAd.payload && currentlyDisplayedAd.payload.detailed_list_items) {
+      (0, _util.safeInvoke)(props.onAddToListTriggered, currentlyDisplayedAd.payload.detailed_list_items);
     }
-    this.triggerReportAdEvent(currentAd, _adadaptedApiTypes.ReportedEventType.INTERACTION);
-    if (this.cycleAdTimer) {
-      clearTimeout(this.cycleAdTimer);
+    cycleDisplayedAd();
+  }
+
+  /**
+   * Call to acknowledge ATL item(s) added to user list.
+   * @param itemName - Detailed list item title from ad that was clicked.
+   */
+  function acknowledge(itemName) {
+    if (props.adZoneData.ads) {
+      props.adZoneData.ads.forEach(ad => {
+        ad.payload.detailed_list_items.forEach(item => {
+          if (item.product_title === itemName) {
+            triggerReportAdEvent(ad, _adadaptedApiTypes.ReportedEventType.INTERACTION);
+          }
+        });
+      });
     }
-    this.cycleDisplayedAd();
   }
 
   /**
    * Triggered when we need to report an ad event to the API.
-   * @param currentAd - The ad to send an event for.
+   * @param ad - The ad to send an event for.
    * @param eventType - The event type for the reported event.
    */
-  triggerReportAdEvent(currentAd, eventType) {
+  function triggerReportAdEvent(ad, eventType) {
     // The event timestamp has to be sent as a unix timestamp.
     const currentTs = Math.round(new Date().getTime() / 1000);
 
     // Log the taken action/event with the API.
     adadaptedApiRequests.reportAdEvent({
-      app_id: this.props.appId,
-      session_id: this.props.sessionId,
-      udid: this.props.udid,
+      app_id: props.appId,
+      session_id: props.sessionId,
+      udid: props.udid,
       events: [{
-        ad_id: currentAd.ad_id,
-        impression_id: currentAd.impression_id,
+        ad_id: ad.ad_id,
+        impression_id: ad.impression_id,
         event_type: eventType,
         created_at: currentTs
       }]
-    }, this.props.deviceOs, this.props.apiEnv).then(() => {
+    }, props.deviceOs, props.apiEnv).then(() => {
       // Do nothing with the response for now...
     });
   }
 
   /**
    * Generates a new timer for cycling to the next ad.
-   * @param timerLength - The length of time(in milliseconds) to initialize
-   *      the timer with.
    */
-  createAdTimer(timerLength) {
-    if (this.props.adZoneData.ads.length > 0) {
-      this.cycleAdTimer = setTimeout(() => {
-        this.cycleDisplayedAd();
-      }, timerLength);
+  function startAdTimer() {
+    clearTimeout(cycleAdTimer);
+    if (props.adZoneData.ads.length > 0) {
+      const refreshTime = props.adZoneData.ads[adIndexShown].refresh_time * 1000;
+      cycleAdTimer = setTimeout(cycleDisplayedAd, refreshTime);
     }
   }
 
   /**
    * Cycles to the next ad to display in the current available sequence of ads.
    */
-  cycleDisplayedAd() {
+  function cycleDisplayedAd() {
     // Start by determining the next ad index to display.
     let nextAdIndex = 0;
-    if (this.state.adIndexShown < this.props.adZoneData.ads.length - 1) {
-      nextAdIndex = this.state.adIndexShown + 1;
+    const lastAd = props.adZoneData.ads[adIndexShown];
+    if (adIndexShown < props.adZoneData.ads.length - 1) {
+      nextAdIndex = adIndexShown + 1;
     }
-    this.setState({
-      adIndexShown: nextAdIndex
-    }, () => {
-      this.initializeAd();
-    });
+    if (nextAdIndex !== adIndexShown && lastAd.impression_tracked) {
+      // Reset ad impression tracking status.
+      lastAd.impression_tracked = false;
+    } else {
+      // Send invisible ad impression if ad was not visible before end of timer cycle.
+      triggerReportAdEvent(lastAd, _adadaptedApiTypes.ReportedEventType.INVISIBLE_IMPRESSION);
+    }
+    setAdIndexShown(nextAdIndex);
   }
 
   /**
-   * Performs all ad initialization tasks when a new ad is being displayed.
+   * Send ad tracking impression.
    */
-  initializeAd() {
-    // Create the new timer based on the new ad index.
-    this.createAdTimer(this.props.adZoneData.ads[this.state.adIndexShown].refresh_time * 1000);
+  function sendAdImpression() {
+    const ad = props.adZoneData.ads[adIndexShown];
 
     // Trigger an impression event for the ad.
-    this.triggerReportAdEvent(this.props.adZoneData.ads[this.state.adIndexShown], _adadaptedApiTypes.ReportedEventType.IMPRESSION);
+    if (!ad.impression_tracked) {
+      triggerReportAdEvent(ad, _adadaptedApiTypes.ReportedEventType.IMPRESSION);
+      ad.impression_tracked = true;
+    }
   }
 
-  /**
-   * Generates all component related styles.
-   * @returns the styles needed for the component.
-   */
-  generateStyles() {
-    return _reactNative.StyleSheet.create({
-      mainView: {
-        width: "100%",
-        height: "100%"
-      },
-      webView: {
-        width: "100%",
-        height: "100%"
+  // Returned JSX.
+  return /*#__PURE__*/React.createElement(_reactNative.View, {
+    style: finalMainViewStyle
+  }, currentAd && currentAd.creative_url ? /*#__PURE__*/React.createElement(_reactNativeWebview.WebView, {
+    source: {
+      uri: currentAd.creative_url
+    },
+    androidLayerType: "hardware",
+    automaticallyAdjustContentInsets: false,
+    style: styles.webView,
+    onTouchStart: e => {
+      setTouchStartCoords({
+        x: e.nativeEvent.pageX,
+        y: e.nativeEvent.pageY
+      });
+    },
+    onTouchEnd: e => {
+      if (touchStartCoords) {
+        const touchEndCoords = {
+          x: e.nativeEvent.pageX,
+          y: e.nativeEvent.pageY
+        };
+        if (Math.abs(touchStartCoords.x - touchEndCoords.x) < props.xyDragDistanceAllowed && Math.abs(touchStartCoords.y - touchEndCoords.y) < props.xyDragDistanceAllowed) {
+          onAdZoneSelected(currentAd);
+        }
+
+        // Make sure to reset the start coords
+        setTouchStartCoords({
+          x: 0,
+          y: 0
+        });
       }
-    });
-  }
+    }
+  }) : undefined);
 }
-exports.AdZone = AdZone;
 //# sourceMappingURL=AdZone.js.map

package/lib/commonjs/components/AdZone.js.map

@@ -1 +1 @@
-{"version":3,"names":["AdZone","React","Component","constructor","props","context","startingAdIndex","Math","floor","random","adZoneData","ads","length","state","adIndexShown","touchStartCoords","undefined","componentDidMount","initializeAd","componentWillUnmount","cycleAdTimer","clearTimeout","render","styles","generateStyles","currentAd","finalMainViewStyle","mainView","creative_url","width","height","uri","webView","e","setState","x","nativeEvent","pageX","y","pageY","touchEndCoords","abs","xyDragDistanceAllowed","onAdZoneSelected","action_type","AdActionType","EXTERNAL","action_path","Linking","openURL","then","CONTENT","payload","detailed_list_items","safeInvoke","onAddToListTriggered","triggerReportAdEvent","ReportedEventType","INTERACTION","cycleDisplayedAd","eventType","currentTs","round","Date","getTime","adadaptedApiRequests","reportAdEvent","app_id","appId","session_id","sessionId","udid","events","ad_id","impression_id","event_type","created_at","deviceOs","apiEnv","createAdTimer","timerLength","setTimeout","nextAdIndex","refresh_time","IMPRESSION","StyleSheet","create"],"sources":["AdZone.tsx"],"sourcesContent":["/**\n * Component for creating an {@link AdZone}.\n * @module\n */\nimport * as React from \"react\";\nimport { Linking, StyleSheet, View, ViewStyle } from \"react-native\";\nimport * as adadaptedApiRequests from \"../api/adadaptedApiRequests\";\nimport {\n    Ad,\n    AdActionType,\n    DetailedListItem,\n    ReportedEventType,\n    Zone,\n} from \"../api/adadaptedApiTypes\";\nimport { WebView } from \"react-native-webview\";\nimport { ApiEnv, DeviceOS } from \"../index\";\nimport { safeInvoke } from \"../util\";\n\n/**\n * Props interface for {@link AdZone}.\n */\ninterface Props {\n    /**\n     * The app ID.\n     */\n    appId: string;\n    /**\n     * The session ID.\n     */\n    sessionId: string;\n    /**\n     * The UDID.\n     */\n    udid: string;\n    /**\n     * The touch sensitivity of the Ad Zone in both the X and Y directions.\n     * This is used to determine the click/press sensitivity when the\n     * Ad Zone is being touched by the user as a regular touch or while\n     * scrolling the view. If the amount of touch \"drag\" distance in either\n     * X or Y direction is less than this value, we will treat the action as\n     * a click/press on the Ad Zone.\n     */\n    xyDragDistanceAllowed: number;\n    /**\n     * The device OS used for API requests.\n     */\n    deviceOs: DeviceOS;\n    /**\n     * The API environment to use when making an API request.\n     */\n    apiEnv: ApiEnv;\n    /**\n     * The ad zone data.\n     */\n    adZoneData: Zone;\n    /**\n     * Callback that gets triggered when an \"add to list\" item/items are clicked.\n     * @param items - The array of items to \"add to list\".\n     */\n    onAddToListTriggered?(items: DetailedListItem[]): void;\n}\n\n/**\n * State interface for {@link AdZone}.\n */\ninterface State {\n    /**\n     * Tracks the current ad index being shown.\n     */\n    adIndexShown: number;\n    /**\n     * Tracks the coordinates when the user started touching the Ad View.\n     */\n    touchStartCoords: TouchCoordinates | undefined;\n}\n\n/**\n * Interface for tracking \"touch\" coordinates.\n */\ninterface TouchCoordinates {\n    /**\n     * The X coordinate for the touch.\n     */\n    x: number;\n    /**\n     * The Y coordinate for the touch.\n     */\n    y: number;\n}\n\n/**\n * Defines the style typing for the component.\n */\ninterface StyleDef {\n    /**\n     * Styles for the main View element.\n     */\n    mainView: ViewStyle;\n    /**\n     * Styles for the WebView element.\n     */\n    webView: ViewStyle;\n}\n\n/**\n * Creates the AdZone component.\n */\nexport class AdZone extends React.Component<Props, State> {\n    /**\n     * Timer used for cycling through ads in the zone\n     * based on the ad \"refresh time\" for each ad.\n     */\n    private cycleAdTimer: ReturnType<typeof setTimeout> | undefined;\n\n    /**\n     * @inheritDoc\n     */\n    constructor(props: Props, context?: any) {\n        super(props, context);\n\n        // Generates a random number between 0 and (number of available ads - 1).\n        const startingAdIndex = Math.floor(\n            Math.random() * this.props.adZoneData.ads.length\n        );\n\n        this.state = {\n            adIndexShown: startingAdIndex,\n            touchStartCoords: undefined,\n        };\n    }\n\n    /**\n     * @inheritDoc\n     */\n    public componentDidMount(): void {\n        this.initializeAd();\n    }\n\n    /**\n     * @inheritDoc\n     */\n    public componentWillUnmount(): void {\n        if (this.cycleAdTimer) {\n            clearTimeout(this.cycleAdTimer);\n        }\n    }\n\n    /**\n     * @inheritDoc\n     */\n    public render(): JSX.Element {\n        // Generate the styles each render in case the ad is updated with\n        // new settings that need to be reflected in the styles of the view.\n        const styles = this.generateStyles();\n        const currentAd: Ad | undefined =\n            this.props.adZoneData.ads[this.state.adIndexShown] || undefined;\n        const finalMainViewStyle = styles.mainView;\n\n        if (!currentAd || !currentAd.creative_url) {\n            // If there is no ad to display, make the view take up no space.\n            finalMainViewStyle.width = 0;\n            finalMainViewStyle.height = 0;\n        }\n\n        return (\n            <View style={finalMainViewStyle}>\n                {currentAd && currentAd.creative_url ? (\n                    <WebView\n                        source={{\n                            uri: currentAd.creative_url,\n                        }}\n                        androidLayerType=\"hardware\"\n                        automaticallyAdjustContentInsets={false}\n                        style={styles.webView}\n                        onTouchStart={(e) => {\n                            this.setState({\n                                touchStartCoords: {\n                                    x: e.nativeEvent.pageX,\n                                    y: e.nativeEvent.pageY,\n                                },\n                            });\n                        }}\n                        onTouchEnd={(e) => {\n                            if (this.state.touchStartCoords) {\n                                const touchEndCoords: TouchCoordinates = {\n                                    x: e.nativeEvent.pageX,\n                                    y: e.nativeEvent.pageY,\n                                };\n\n                                if (\n                                    Math.abs(\n                                        this.state.touchStartCoords.x -\n                                            touchEndCoords.x\n                                    ) < this.props.xyDragDistanceAllowed &&\n                                    Math.abs(\n                                        this.state.touchStartCoords.y -\n                                            touchEndCoords.y\n                                    ) < this.props.xyDragDistanceAllowed\n                                ) {\n                                    this.onAdZoneSelected(currentAd);\n                                }\n\n                                // Make sure to reset the start coords\n                                this.setState({\n                                    touchStartCoords: undefined,\n                                });\n                            }\n                        }}\n                    />\n                ) : undefined}\n            </View>\n        );\n    }\n\n    /**\n     * Triggers when the user selects the ad zone.\n     * @param currentAd - The ad currently displayed.\n     */\n    private onAdZoneSelected(currentAd: Ad): void {\n        // Determine the \"action type\" and perform that specific action.\n        if (\n            currentAd.action_type === AdActionType.EXTERNAL &&\n            currentAd.action_path\n        ) {\n            // Action Type: EXTERNAL\n            Linking.openURL(currentAd.action_path).then();\n        } else if (\n            currentAd.action_type === AdActionType.CONTENT &&\n            currentAd.payload &&\n            currentAd.payload.detailed_list_items\n        ) {\n            safeInvoke(\n                this.props.onAddToListTriggered,\n                currentAd.payload.detailed_list_items\n            );\n        }\n\n        this.triggerReportAdEvent(currentAd, ReportedEventType.INTERACTION);\n        if (this.cycleAdTimer) {\n            clearTimeout(this.cycleAdTimer);\n        }\n        this.cycleDisplayedAd();\n    }\n\n    /**\n     * Triggered when we need to report an ad event to the API.\n     * @param currentAd - The ad to send an event for.\n     * @param eventType - The event type for the reported event.\n     */\n    private triggerReportAdEvent(\n        currentAd: Ad,\n        eventType: ReportedEventType\n    ): void {\n        // The event timestamp has to be sent as a unix timestamp.\n        const currentTs = Math.round(new Date().getTime() / 1000);\n\n        // Log the taken action/event with the API.\n        adadaptedApiRequests\n            .reportAdEvent(\n                {\n                    app_id: this.props.appId,\n                    session_id: this.props.sessionId,\n                    udid: this.props.udid,\n                    events: [\n                        {\n                            ad_id: currentAd.ad_id,\n                            impression_id: currentAd.impression_id,\n                            event_type: eventType,\n                            created_at: currentTs,\n                        },\n                    ],\n                },\n                this.props.deviceOs,\n                this.props.apiEnv\n            )\n            .then(() => {\n                // Do nothing with the response for now...\n            });\n    }\n\n    /**\n     * Generates a new timer for cycling to the next ad.\n     * @param timerLength - The length of time(in milliseconds) to initialize\n     *      the timer with.\n     */\n    private createAdTimer(timerLength: number): void {\n        if (this.props.adZoneData.ads.length > 0) {\n            this.cycleAdTimer = setTimeout(() => {\n                this.cycleDisplayedAd();\n            }, timerLength);\n        }\n    }\n\n    /**\n     * Cycles to the next ad to display in the current available sequence of ads.\n     */\n    private cycleDisplayedAd(): void {\n        // Start by determining the next ad index to display.\n        let nextAdIndex = 0;\n\n        if (this.state.adIndexShown < this.props.adZoneData.ads.length - 1) {\n            nextAdIndex = this.state.adIndexShown + 1;\n        }\n\n        this.setState(\n            {\n                adIndexShown: nextAdIndex,\n            },\n            () => {\n                this.initializeAd();\n            }\n        );\n    }\n\n    /**\n     * Performs all ad initialization tasks when a new ad is being displayed.\n     */\n    private initializeAd(): void {\n        // Create the new timer based on the new ad index.\n        this.createAdTimer(\n            this.props.adZoneData.ads[this.state.adIndexShown].refresh_time *\n                1000\n        );\n\n        // Trigger an impression event for the ad.\n        this.triggerReportAdEvent(\n            this.props.adZoneData.ads[this.state.adIndexShown],\n            ReportedEventType.IMPRESSION\n        );\n    }\n\n    /**\n     * Generates all component related styles.\n     * @returns the styles needed for the component.\n     */\n    private generateStyles(): StyleDef {\n        return StyleSheet.create({\n            mainView: {\n                width: \"100%\",\n                height: \"100%\",\n            },\n            webView: {\n                width: \"100%\",\n                height: \"100%\",\n            },\n        });\n    }\n}\n"],"mappings":";;;;;;AAIA;AACA;AACA;AACA;AAOA;AAEA;AAAqC;AAAA;AAAA;AAwFrC;AACA;AACA;AACO,MAAMA,MAAM,SAASC,KAAK,CAACC,SAAS,CAAe;EACtD;AACJ;AACA;AACA;;EAGI;AACJ;AACA;EACIC,WAAW,CAACC,KAAY,EAAEC,OAAa,EAAE;IACrC,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;;IAErB;IAAA;IACA,MAAMC,eAAe,GAAGC,IAAI,CAACC,KAAK,CAC9BD,IAAI,CAACE,MAAM,EAAE,GAAG,IAAI,CAACL,KAAK,CAACM,UAAU,CAACC,GAAG,CAACC,MAAM,CACnD;IAED,IAAI,CAACC,KAAK,GAAG;MACTC,YAAY,EAAER,eAAe;MAC7BS,gBAAgB,EAAEC;IACtB,CAAC;EACL;;EAEA;AACJ;AACA;EACWC,iBAAiB,GAAS;IAC7B,IAAI,CAACC,YAAY,EAAE;EACvB;;EAEA;AACJ;AACA;EACWC,oBAAoB,GAAS;IAChC,IAAI,IAAI,CAACC,YAAY,EAAE;MACnBC,YAAY,CAAC,IAAI,CAACD,YAAY,CAAC;IACnC;EACJ;;EAEA;AACJ;AACA;EACWE,MAAM,GAAgB;IACzB;IACA;IACA,MAAMC,MAAM,GAAG,IAAI,CAACC,cAAc,EAAE;IACpC,MAAMC,SAAyB,GAC3B,IAAI,CAACrB,KAAK,CAACM,UAAU,CAACC,GAAG,CAAC,IAAI,CAACE,KAAK,CAACC,YAAY,CAAC,IAAIE,SAAS;IACnE,MAAMU,kBAAkB,GAAGH,MAAM,CAACI,QAAQ;IAE1C,IAAI,CAACF,SAAS,IAAI,CAACA,SAAS,CAACG,YAAY,EAAE;MACvC;MACAF,kBAAkB,CAACG,KAAK,GAAG,CAAC;MAC5BH,kBAAkB,CAACI,MAAM,GAAG,CAAC;IACjC;IAEA,oBACI,oBAAC,iBAAI;MAAC,KAAK,EAAEJ;IAAmB,GAC3BD,SAAS,IAAIA,SAAS,CAACG,YAAY,gBAChC,oBAAC,2BAAO;MACJ,MAAM,EAAE;QACJG,GAAG,EAAEN,SAAS,CAACG;MACnB,CAAE;MACF,gBAAgB,EAAC,UAAU;MAC3B,gCAAgC,EAAE,KAAM;MACxC,KAAK,EAAEL,MAAM,CAACS,OAAQ;MACtB,YAAY,EAAGC,CAAC,IAAK;QACjB,IAAI,CAACC,QAAQ,CAAC;UACVnB,gBAAgB,EAAE;YACdoB,CAAC,EAAEF,CAAC,CAACG,WAAW,CAACC,KAAK;YACtBC,CAAC,EAAEL,CAAC,CAACG,WAAW,CAACG;UACrB;QACJ,CAAC,CAAC;MACN,CAAE;MACF,UAAU,EAAGN,CAAC,IAAK;QACf,IAAI,IAAI,CAACpB,KAAK,CAACE,gBAAgB,EAAE;UAC7B,MAAMyB,cAAgC,GAAG;YACrCL,CAAC,EAAEF,CAAC,CAACG,WAAW,CAACC,KAAK;YACtBC,CAAC,EAAEL,CAAC,CAACG,WAAW,CAACG;UACrB,CAAC;UAED,IACIhC,IAAI,CAACkC,GAAG,CACJ,IAAI,CAAC5B,KAAK,CAACE,gBAAgB,CAACoB,CAAC,GACzBK,cAAc,CAACL,CAAC,CACvB,GAAG,IAAI,CAAC/B,KAAK,CAACsC,qBAAqB,IACpCnC,IAAI,CAACkC,GAAG,CACJ,IAAI,CAAC5B,KAAK,CAACE,gBAAgB,CAACuB,CAAC,GACzBE,cAAc,CAACF,CAAC,CACvB,GAAG,IAAI,CAAClC,KAAK,CAACsC,qBAAqB,EACtC;YACE,IAAI,CAACC,gBAAgB,CAAClB,SAAS,CAAC;UACpC;;UAEA;UACA,IAAI,CAACS,QAAQ,CAAC;YACVnB,gBAAgB,EAAEC;UACtB,CAAC,CAAC;QACN;MACJ;IAAE,EACJ,GACFA,SAAS,CACV;EAEf;;EAEA;AACJ;AACA;AACA;EACY2B,gBAAgB,CAAClB,SAAa,EAAQ;IAC1C;IACA,IACIA,SAAS,CAACmB,WAAW,KAAKC,+BAAY,CAACC,QAAQ,IAC/CrB,SAAS,CAACsB,WAAW,EACvB;MACE;MACAC,oBAAO,CAACC,OAAO,CAACxB,SAAS,CAACsB,WAAW,CAAC,CAACG,IAAI,EAAE;IACjD,CAAC,MAAM,IACHzB,SAAS,CAACmB,WAAW,KAAKC,+BAAY,CAACM,OAAO,IAC9C1B,SAAS,CAAC2B,OAAO,IACjB3B,SAAS,CAAC2B,OAAO,CAACC,mBAAmB,EACvC;MACE,IAAAC,gBAAU,EACN,IAAI,CAAClD,KAAK,CAACmD,oBAAoB,EAC/B9B,SAAS,CAAC2B,OAAO,CAACC,mBAAmB,CACxC;IACL;IAEA,IAAI,CAACG,oBAAoB,CAAC/B,SAAS,EAAEgC,oCAAiB,CAACC,WAAW,CAAC;IACnE,IAAI,IAAI,CAACtC,YAAY,EAAE;MACnBC,YAAY,CAAC,IAAI,CAACD,YAAY,CAAC;IACnC;IACA,IAAI,CAACuC,gBAAgB,EAAE;EAC3B;;EAEA;AACJ;AACA;AACA;AACA;EACYH,oBAAoB,CACxB/B,SAAa,EACbmC,SAA4B,EACxB;IACJ;IACA,MAAMC,SAAS,GAAGtD,IAAI,CAACuD,KAAK,CAAC,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE,GAAG,IAAI,CAAC;;IAEzD;IACAC,oBAAoB,CACfC,aAAa,CACV;MACIC,MAAM,EAAE,IAAI,CAAC/D,KAAK,CAACgE,KAAK;MACxBC,UAAU,EAAE,IAAI,CAACjE,KAAK,CAACkE,SAAS;MAChCC,IAAI,EAAE,IAAI,CAACnE,KAAK,CAACmE,IAAI;MACrBC,MAAM,EAAE,CACJ;QACIC,KAAK,EAAEhD,SAAS,CAACgD,KAAK;QACtBC,aAAa,EAAEjD,SAAS,CAACiD,aAAa;QACtCC,UAAU,EAAEf,SAAS;QACrBgB,UAAU,EAAEf;MAChB,CAAC;IAET,CAAC,EACD,IAAI,CAACzD,KAAK,CAACyE,QAAQ,EACnB,IAAI,CAACzE,KAAK,CAAC0E,MAAM,CACpB,CACA5B,IAAI,CAAC,MAAM;MACR;IAAA,CACH,CAAC;EACV;;EAEA;AACJ;AACA;AACA;AACA;EACY6B,aAAa,CAACC,WAAmB,EAAQ;IAC7C,IAAI,IAAI,CAAC5E,KAAK,CAACM,UAAU,CAACC,GAAG,CAACC,MAAM,GAAG,CAAC,EAAE;MACtC,IAAI,CAACQ,YAAY,GAAG6D,UAAU,CAAC,MAAM;QACjC,IAAI,CAACtB,gBAAgB,EAAE;MAC3B,CAAC,EAAEqB,WAAW,CAAC;IACnB;EACJ;;EAEA;AACJ;AACA;EACYrB,gBAAgB,GAAS;IAC7B;IACA,IAAIuB,WAAW,GAAG,CAAC;IAEnB,IAAI,IAAI,CAACrE,KAAK,CAACC,YAAY,GAAG,IAAI,CAACV,KAAK,CAACM,UAAU,CAACC,GAAG,CAACC,MAAM,GAAG,CAAC,EAAE;MAChEsE,WAAW,GAAG,IAAI,CAACrE,KAAK,CAACC,YAAY,GAAG,CAAC;IAC7C;IAEA,IAAI,CAACoB,QAAQ,CACT;MACIpB,YAAY,EAAEoE;IAClB,CAAC,EACD,MAAM;MACF,IAAI,CAAChE,YAAY,EAAE;IACvB,CAAC,CACJ;EACL;;EAEA;AACJ;AACA;EACYA,YAAY,GAAS;IACzB;IACA,IAAI,CAAC6D,aAAa,CACd,IAAI,CAAC3E,KAAK,CAACM,UAAU,CAACC,GAAG,CAAC,IAAI,CAACE,KAAK,CAACC,YAAY,CAAC,CAACqE,YAAY,GAC3D,IAAI,CACX;;IAED;IACA,IAAI,CAAC3B,oBAAoB,CACrB,IAAI,CAACpD,KAAK,CAACM,UAAU,CAACC,GAAG,CAAC,IAAI,CAACE,KAAK,CAACC,YAAY,CAAC,EAClD2C,oCAAiB,CAAC2B,UAAU,CAC/B;EACL;;EAEA;AACJ;AACA;AACA;EACY5D,cAAc,GAAa;IAC/B,OAAO6D,uBAAU,CAACC,MAAM,CAAC;MACrB3D,QAAQ,EAAE;QACNE,KAAK,EAAE,MAAM;QACbC,MAAM,EAAE;MACZ,CAAC;MACDE,OAAO,EAAE;QACLH,KAAK,EAAE,MAAM;QACbC,MAAM,EAAE;MACZ;IACJ,CAAC,CAAC;EACN;AACJ;AAAC"}
+{"version":3,"names":["cycleAdTimer","AdZone","props","startingAdIndex","Math","floor","random","adZoneData","ads","length","adIndexShown","setAdIndexShown","useState","touchStartCoords","setTouchStartCoords","x","y","isAdVisible","setIsAdVisibile","defaultToInvisibleAdZone","useEffect","DeviceEventEmitter","addListener","event","itemName","acknowledge","clearTimeout","removeAllListeners","startAdTimer","sendAdImpression","generateStyles","StyleSheet","create","mainView","width","height","webView","styles","currentAd","undefined","finalMainViewStyle","creative_url","onAdZoneSelected","currentlyDisplayedAd","action_type","AdActionType","EXTERNAL","action_path","Linking","openURL","then","CONTENT","payload","detailed_list_items","safeInvoke","onAddToListTriggered","cycleDisplayedAd","forEach","ad","item","product_title","triggerReportAdEvent","ReportedEventType","INTERACTION","eventType","currentTs","round","Date","getTime","adadaptedApiRequests","reportAdEvent","app_id","appId","session_id","sessionId","udid","events","ad_id","impression_id","event_type","created_at","deviceOs","apiEnv","refreshTime","refresh_time","setTimeout","nextAdIndex","lastAd","impression_tracked","INVISIBLE_IMPRESSION","IMPRESSION","uri","e","nativeEvent","pageX","pageY","touchEndCoords","abs","xyDragDistanceAllowed"],"sources":["AdZone.tsx"],"sourcesContent":["/**\n * Component for creating an {@link AdZone}.\n * @module\n */\nimport * as React from \"react\";\nimport {\n    DeviceEventEmitter,\n    Linking,\n    StyleSheet,\n    View,\n    ViewStyle,\n} from \"react-native\";\nimport * as adadaptedApiRequests from \"../api/adadaptedApiRequests\";\nimport {\n    Ad,\n    AdActionType,\n    DetailedListItem,\n    ReportedEventType,\n    Zone,\n} from \"../api/adadaptedApiTypes\";\nimport { WebView } from \"react-native-webview\";\nimport { ApiEnv, DeviceOS } from \"../index\";\nimport { safeInvoke } from \"../util\";\nimport { useEffect, useState } from \"react\";\n\n/**\n * Props interface for {@link AdZone}.\n */\ninterface Props {\n    /**\n     * The app ID.\n     */\n    appId: string;\n    /**\n     * The session ID.\n     */\n    sessionId: string;\n    /**\n     * The UDID.\n     */\n    udid: string;\n    /**\n     * The touch sensitivity of the Ad Zone in both the X and Y directions.\n     * This is used to determine the click/press sensitivity when the\n     * Ad Zone is being touched by the user as a regular touch or while\n     * scrolling the view. If the amount of touch \"drag\" distance in either\n     * X or Y direction is less than this value, we will treat the action as\n     * a click/press on the Ad Zone.\n     */\n    xyDragDistanceAllowed: number;\n    /**\n     * The device OS used for API requests.\n     */\n    deviceOs: DeviceOS;\n    /**\n     * The API environment to use when making an API request.\n     */\n    apiEnv: ApiEnv;\n    /**\n     * The ad zone data.\n     */\n    adZoneData: Zone;\n    /**\n     * Callback that gets triggered when an \"add to list\" item/items are clicked.\n     * @param items - The array of items to \"add to list\".\n     */\n    onAddToListTriggered?(items: DetailedListItem[]): void;\n    /**\n     * Track the ad zone visibility in parent component.\n     */\n    isAdZoneVisible?: boolean;\n    /**\n     * Set default ad zone visibility to false.\n     */\n    defaultToInvisibleAdZone?: boolean;\n}\n\n/**\n * Interface for tracking \"touch\" coordinates.\n */\ninterface TouchCoordinates {\n    /**\n     * The X coordinate for the touch.\n     */\n    x: number;\n    /**\n     * The Y coordinate for the touch.\n     */\n    y: number;\n}\n\n/**\n * Defines the style typing for the component.\n */\ninterface StyleDef {\n    /**\n     * Styles for the main View element.\n     */\n    mainView: ViewStyle;\n    /**\n     * Styles for the WebView element.\n     */\n    webView: ViewStyle;\n}\n/**\n * Timer used for cycling through ads in the zone\n * based on the ad \"refresh time\" for each ad.\n */\nlet cycleAdTimer: ReturnType<typeof setTimeout> | undefined;\n\n/**\n * Creates the AdZone component.\n * @param props - properties passed to AdZone.\n * @returns an AdZone JSX Element.\n */\nexport function AdZone(props: Props): JSX.Element {\n    // Generates a random number between 0 and (number of available ads - 1).\n    const startingAdIndex = Math.floor(\n        Math.random() * props.adZoneData.ads.length\n    );\n\n    /**\n     * Tracks the current ad index being shown.\n     */\n    const [adIndexShown, setAdIndexShown] = useState(startingAdIndex);\n    /**\n     * Tracks the coordinates when the user started touching the Ad View.\n     */\n    const [touchStartCoords, setTouchStartCoords] = useState({ x: 0, y: 0 });\n    /**\n     * Track ad visibility (for off-screen ads).\n     */\n    const [isAdVisible, setIsAdVisibile] = useState(\n        props.defaultToInvisibleAdZone ? false : true\n    );\n\n    // - Define all useEffect triggers.\n    useEffect(() => {\n        DeviceEventEmitter.addListener(\"visibility-event\", (event) => {\n            setIsAdVisibile(event);\n        });\n        DeviceEventEmitter.addListener(\"acknowledge\", (itemName) => {\n            acknowledge(itemName);\n        });\n        return () => {\n            clearTimeout(cycleAdTimer);\n            DeviceEventEmitter.removeAllListeners(\"visibility-event\");\n            DeviceEventEmitter.removeAllListeners(\"acknowledge\");\n        };\n    }, []);\n\n    useEffect(() => {\n        startAdTimer();\n        if (isAdVisible) {\n            sendAdImpression();\n        }\n    }, [adIndexShown]);\n\n    useEffect(() => {\n        if (isAdVisible) {\n            sendAdImpression();\n        }\n    }, [isAdVisible]);\n\n    /**\n     * Generates all component related styles.\n     * @returns the styles needed for the component.\n     */\n    function generateStyles(): StyleDef {\n        return StyleSheet.create({\n            mainView: {\n                width: \"100%\",\n                height: \"100%\",\n            },\n            webView: {\n                width: \"100%\",\n                height: \"100%\",\n            },\n        });\n    }\n\n    // Generate the styles each render in case the ad is updated with\n    // new settings that need to be reflected in the styles of the view.\n    const styles = generateStyles();\n    const currentAd: Ad | undefined =\n        props.adZoneData.ads[adIndexShown] || undefined;\n    const finalMainViewStyle = styles.mainView;\n\n    if (!currentAd || !currentAd.creative_url) {\n        // If there is no ad to display, make the view take up no space.\n        finalMainViewStyle.width = \"0\";\n        finalMainViewStyle.height = \"0\";\n    }\n\n    /**\n     * Triggers when the user selects the ad zone.\n     * @param currentlyDisplayedAd - The ad currently displayed.\n     */\n    function onAdZoneSelected(currentlyDisplayedAd: Ad): void {\n        // Determine the \"action type\" and perform that specific action.\n        if (\n            currentlyDisplayedAd.action_type === AdActionType.EXTERNAL &&\n            currentlyDisplayedAd.action_path\n        ) {\n            // Action Type: EXTERNAL\n            Linking.openURL(currentlyDisplayedAd.action_path).then();\n        } else if (\n            currentlyDisplayedAd.action_type === AdActionType.CONTENT &&\n            currentlyDisplayedAd.payload &&\n            currentlyDisplayedAd.payload.detailed_list_items\n        ) {\n            safeInvoke(\n                props.onAddToListTriggered,\n                currentlyDisplayedAd.payload.detailed_list_items\n            );\n        }\n\n        cycleDisplayedAd();\n    }\n\n    /**\n     * Call to acknowledge ATL item(s) added to user list.\n     * @param itemName - Detailed list item title from ad that was clicked.\n     */\n    function acknowledge(itemName: string): void {\n        if (props.adZoneData.ads) {\n            props.adZoneData.ads.forEach((ad) => {\n                ad.payload.detailed_list_items.forEach((item) => {\n                    if (item.product_title === itemName) {\n                        triggerReportAdEvent(ad, ReportedEventType.INTERACTION);\n                    }\n                });\n            });\n        }\n    }\n\n    /**\n     * Triggered when we need to report an ad event to the API.\n     * @param ad - The ad to send an event for.\n     * @param eventType - The event type for the reported event.\n     */\n    function triggerReportAdEvent(ad: Ad, eventType: ReportedEventType): void {\n        // The event timestamp has to be sent as a unix timestamp.\n        const currentTs = Math.round(new Date().getTime() / 1000);\n\n        // Log the taken action/event with the API.\n        adadaptedApiRequests\n            .reportAdEvent(\n                {\n                    app_id: props.appId,\n                    session_id: props.sessionId,\n                    udid: props.udid,\n                    events: [\n                        {\n                            ad_id: ad.ad_id,\n                            impression_id: ad.impression_id,\n                            event_type: eventType,\n                            created_at: currentTs,\n                        },\n                    ],\n                },\n                props.deviceOs,\n                props.apiEnv\n            )\n            .then(() => {\n                // Do nothing with the response for now...\n            });\n    }\n\n    /**\n     * Generates a new timer for cycling to the next ad.\n     */\n    function startAdTimer(): void {\n        clearTimeout(cycleAdTimer);\n\n        if (props.adZoneData.ads.length > 0) {\n            const refreshTime: number =\n                props.adZoneData.ads[adIndexShown].refresh_time * 1000;\n            cycleAdTimer = setTimeout(cycleDisplayedAd, refreshTime);\n        }\n    }\n\n    /**\n     * Cycles to the next ad to display in the current available sequence of ads.\n     */\n    function cycleDisplayedAd(): void {\n        // Start by determining the next ad index to display.\n        let nextAdIndex = 0;\n        const lastAd = props.adZoneData.ads[adIndexShown];\n\n        if (adIndexShown < props.adZoneData.ads.length - 1) {\n            nextAdIndex = adIndexShown + 1;\n        }\n\n        if (nextAdIndex !== adIndexShown && lastAd.impression_tracked) {\n            // Reset ad impression tracking status.\n            lastAd.impression_tracked = false;\n        } else {\n            // Send invisible ad impression if ad was not visible before end of timer cycle.\n            triggerReportAdEvent(\n                lastAd,\n                ReportedEventType.INVISIBLE_IMPRESSION\n            );\n        }\n\n        setAdIndexShown(nextAdIndex);\n    }\n\n    /**\n     * Send ad tracking impression.\n     */\n    function sendAdImpression(): void {\n        const ad = props.adZoneData.ads[adIndexShown];\n\n        // Trigger an impression event for the ad.\n        if (!ad.impression_tracked) {\n            triggerReportAdEvent(ad, ReportedEventType.IMPRESSION);\n            ad.impression_tracked = true;\n        }\n    }\n\n    // Returned JSX.\n    return (\n        <View style={finalMainViewStyle}>\n            {currentAd && currentAd.creative_url ? (\n                <WebView\n                    source={{\n                        uri: currentAd.creative_url,\n                    }}\n                    androidLayerType=\"hardware\"\n                    automaticallyAdjustContentInsets={false}\n                    style={styles.webView}\n                    onTouchStart={(e) => {\n                        setTouchStartCoords({\n                            x: e.nativeEvent.pageX,\n                            y: e.nativeEvent.pageY,\n                        });\n                    }}\n                    onTouchEnd={(e) => {\n                        if (touchStartCoords) {\n                            const touchEndCoords: TouchCoordinates = {\n                                x: e.nativeEvent.pageX,\n                                y: e.nativeEvent.pageY,\n                            };\n\n                            if (\n                                Math.abs(\n                                    touchStartCoords.x - touchEndCoords.x\n                                ) < props.xyDragDistanceAllowed &&\n                                Math.abs(\n                                    touchStartCoords.y - touchEndCoords.y\n                                ) < props.xyDragDistanceAllowed\n                            ) {\n                                onAdZoneSelected(currentAd);\n                            }\n\n                            // Make sure to reset the start coords\n                            setTouchStartCoords({ x: 0, y: 0 });\n                        }\n                    }}\n                />\n            ) : undefined}\n        </View>\n    );\n}\n"],"mappings":";;;;;;AAIA;AACA;AAOA;AACA;AAOA;AAEA;AAAqC;AAAA;AAtBrC;AACA;AACA;AACA;;AAqGA;AACA;AACA;AACA;AACA,IAAIA,YAAuD;;AAE3D;AACA;AACA;AACA;AACA;AACO,SAASC,MAAM,CAACC,KAAY,EAAe;EAC9C;EACA,MAAMC,eAAe,GAAGC,IAAI,CAACC,KAAK,CAC9BD,IAAI,CAACE,MAAM,EAAE,GAAGJ,KAAK,CAACK,UAAU,CAACC,GAAG,CAACC,MAAM,CAC9C;;EAED;AACJ;AACA;EACI,MAAM,CAACC,YAAY,EAAEC,eAAe,CAAC,GAAG,IAAAC,cAAQ,EAACT,eAAe,CAAC;EACjE;AACJ;AACA;EACI,MAAM,CAACU,gBAAgB,EAAEC,mBAAmB,CAAC,GAAG,IAAAF,cAAQ,EAAC;IAAEG,CAAC,EAAE,CAAC;IAAEC,CAAC,EAAE;EAAE,CAAC,CAAC;EACxE;AACJ;AACA;EACI,MAAM,CAACC,WAAW,EAAEC,eAAe,CAAC,GAAG,IAAAN,cAAQ,EAC3CV,KAAK,CAACiB,wBAAwB,GAAG,KAAK,GAAG,IAAI,CAChD;;EAED;EACA,IAAAC,eAAS,EAAC,MAAM;IACZC,+BAAkB,CAACC,WAAW,CAAC,kBAAkB,EAAGC,KAAK,IAAK;MAC1DL,eAAe,CAACK,KAAK,CAAC;IAC1B,CAAC,CAAC;IACFF,+BAAkB,CAACC,WAAW,CAAC,aAAa,EAAGE,QAAQ,IAAK;MACxDC,WAAW,CAACD,QAAQ,CAAC;IACzB,CAAC,CAAC;IACF,OAAO,MAAM;MACTE,YAAY,CAAC1B,YAAY,CAAC;MAC1BqB,+BAAkB,CAACM,kBAAkB,CAAC,kBAAkB,CAAC;MACzDN,+BAAkB,CAACM,kBAAkB,CAAC,aAAa,CAAC;IACxD,CAAC;EACL,CAAC,EAAE,EAAE,CAAC;EAEN,IAAAP,eAAS,EAAC,MAAM;IACZQ,YAAY,EAAE;IACd,IAAIX,WAAW,EAAE;MACbY,gBAAgB,EAAE;IACtB;EACJ,CAAC,EAAE,CAACnB,YAAY,CAAC,CAAC;EAElB,IAAAU,eAAS,EAAC,MAAM;IACZ,IAAIH,WAAW,EAAE;MACbY,gBAAgB,EAAE;IACtB;EACJ,CAAC,EAAE,CAACZ,WAAW,CAAC,CAAC;;EAEjB;AACJ;AACA;AACA;EACI,SAASa,cAAc,GAAa;IAChC,OAAOC,uBAAU,CAACC,MAAM,CAAC;MACrBC,QAAQ,EAAE;QACNC,KAAK,EAAE,MAAM;QACbC,MAAM,EAAE;MACZ,CAAC;MACDC,OAAO,EAAE;QACLF,KAAK,EAAE,MAAM;QACbC,MAAM,EAAE;MACZ;IACJ,CAAC,CAAC;EACN;;EAEA;EACA;EACA,MAAME,MAAM,GAAGP,cAAc,EAAE;EAC/B,MAAMQ,SAAyB,GAC3BpC,KAAK,CAACK,UAAU,CAACC,GAAG,CAACE,YAAY,CAAC,IAAI6B,SAAS;EACnD,MAAMC,kBAAkB,GAAGH,MAAM,CAACJ,QAAQ;EAE1C,IAAI,CAACK,SAAS,IAAI,CAACA,SAAS,CAACG,YAAY,EAAE;IACvC;IACAD,kBAAkB,CAACN,KAAK,GAAG,GAAG;IAC9BM,kBAAkB,CAACL,MAAM,GAAG,GAAG;EACnC;;EAEA;AACJ;AACA;AACA;EACI,SAASO,gBAAgB,CAACC,oBAAwB,EAAQ;IACtD;IACA,IACIA,oBAAoB,CAACC,WAAW,KAAKC,+BAAY,CAACC,QAAQ,IAC1DH,oBAAoB,CAACI,WAAW,EAClC;MACE;MACAC,oBAAO,CAACC,OAAO,CAACN,oBAAoB,CAACI,WAAW,CAAC,CAACG,IAAI,EAAE;IAC5D,CAAC,MAAM,IACHP,oBAAoB,CAACC,WAAW,KAAKC,+BAAY,CAACM,OAAO,IACzDR,oBAAoB,CAACS,OAAO,IAC5BT,oBAAoB,CAACS,OAAO,CAACC,mBAAmB,EAClD;MACE,IAAAC,gBAAU,EACNpD,KAAK,CAACqD,oBAAoB,EAC1BZ,oBAAoB,CAACS,OAAO,CAACC,mBAAmB,CACnD;IACL;IAEAG,gBAAgB,EAAE;EACtB;;EAEA;AACJ;AACA;AACA;EACI,SAAS/B,WAAW,CAACD,QAAgB,EAAQ;IACzC,IAAItB,KAAK,CAACK,UAAU,CAACC,GAAG,EAAE;MACtBN,KAAK,CAACK,UAAU,CAACC,GAAG,CAACiD,OAAO,CAAEC,EAAE,IAAK;QACjCA,EAAE,CAACN,OAAO,CAACC,mBAAmB,CAACI,OAAO,CAAEE,IAAI,IAAK;UAC7C,IAAIA,IAAI,CAACC,aAAa,KAAKpC,QAAQ,EAAE;YACjCqC,oBAAoB,CAACH,EAAE,EAAEI,oCAAiB,CAACC,WAAW,CAAC;UAC3D;QACJ,CAAC,CAAC;MACN,CAAC,CAAC;IACN;EACJ;;EAEA;AACJ;AACA;AACA;AACA;EACI,SAASF,oBAAoB,CAACH,EAAM,EAAEM,SAA4B,EAAQ;IACtE;IACA,MAAMC,SAAS,GAAG7D,IAAI,CAAC8D,KAAK,CAAC,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE,GAAG,IAAI,CAAC;;IAEzD;IACAC,oBAAoB,CACfC,aAAa,CACV;MACIC,MAAM,EAAErE,KAAK,CAACsE,KAAK;MACnBC,UAAU,EAAEvE,KAAK,CAACwE,SAAS;MAC3BC,IAAI,EAAEzE,KAAK,CAACyE,IAAI;MAChBC,MAAM,EAAE,CACJ;QACIC,KAAK,EAAEnB,EAAE,CAACmB,KAAK;QACfC,aAAa,EAAEpB,EAAE,CAACoB,aAAa;QAC/BC,UAAU,EAAEf,SAAS;QACrBgB,UAAU,EAAEf;MAChB,CAAC;IAET,CAAC,EACD/D,KAAK,CAAC+E,QAAQ,EACd/E,KAAK,CAACgF,MAAM,CACf,CACAhC,IAAI,CAAC,MAAM;MACR;IAAA,CACH,CAAC;EACV;;EAEA;AACJ;AACA;EACI,SAAStB,YAAY,GAAS;IAC1BF,YAAY,CAAC1B,YAAY,CAAC;IAE1B,IAAIE,KAAK,CAACK,UAAU,CAACC,GAAG,CAACC,MAAM,GAAG,CAAC,EAAE;MACjC,MAAM0E,WAAmB,GACrBjF,KAAK,CAACK,UAAU,CAACC,GAAG,CAACE,YAAY,CAAC,CAAC0E,YAAY,GAAG,IAAI;MAC1DpF,YAAY,GAAGqF,UAAU,CAAC7B,gBAAgB,EAAE2B,WAAW,CAAC;IAC5D;EACJ;;EAEA;AACJ;AACA;EACI,SAAS3B,gBAAgB,GAAS;IAC9B;IACA,IAAI8B,WAAW,GAAG,CAAC;IACnB,MAAMC,MAAM,GAAGrF,KAAK,CAACK,UAAU,CAACC,GAAG,CAACE,YAAY,CAAC;IAEjD,IAAIA,YAAY,GAAGR,KAAK,CAACK,UAAU,CAACC,GAAG,CAACC,MAAM,GAAG,CAAC,EAAE;MAChD6E,WAAW,GAAG5E,YAAY,GAAG,CAAC;IAClC;IAEA,IAAI4E,WAAW,KAAK5E,YAAY,IAAI6E,MAAM,CAACC,kBAAkB,EAAE;MAC3D;MACAD,MAAM,CAACC,kBAAkB,GAAG,KAAK;IACrC,CAAC,MAAM;MACH;MACA3B,oBAAoB,CAChB0B,MAAM,EACNzB,oCAAiB,CAAC2B,oBAAoB,CACzC;IACL;IAEA9E,eAAe,CAAC2E,WAAW,CAAC;EAChC;;EAEA;AACJ;AACA;EACI,SAASzD,gBAAgB,GAAS;IAC9B,MAAM6B,EAAE,GAAGxD,KAAK,CAACK,UAAU,CAACC,GAAG,CAACE,YAAY,CAAC;;IAE7C;IACA,IAAI,CAACgD,EAAE,CAAC8B,kBAAkB,EAAE;MACxB3B,oBAAoB,CAACH,EAAE,EAAEI,oCAAiB,CAAC4B,UAAU,CAAC;MACtDhC,EAAE,CAAC8B,kBAAkB,GAAG,IAAI;IAChC;EACJ;;EAEA;EACA,oBACI,oBAAC,iBAAI;IAAC,KAAK,EAAEhD;EAAmB,GAC3BF,SAAS,IAAIA,SAAS,CAACG,YAAY,gBAChC,oBAAC,2BAAO;IACJ,MAAM,EAAE;MACJkD,GAAG,EAAErD,SAAS,CAACG;IACnB,CAAE;IACF,gBAAgB,EAAC,UAAU;IAC3B,gCAAgC,EAAE,KAAM;IACxC,KAAK,EAAEJ,MAAM,CAACD,OAAQ;IACtB,YAAY,EAAGwD,CAAC,IAAK;MACjB9E,mBAAmB,CAAC;QAChBC,CAAC,EAAE6E,CAAC,CAACC,WAAW,CAACC,KAAK;QACtB9E,CAAC,EAAE4E,CAAC,CAACC,WAAW,CAACE;MACrB,CAAC,CAAC;IACN,CAAE;IACF,UAAU,EAAGH,CAAC,IAAK;MACf,IAAI/E,gBAAgB,EAAE;QAClB,MAAMmF,cAAgC,GAAG;UACrCjF,CAAC,EAAE6E,CAAC,CAACC,WAAW,CAACC,KAAK;UACtB9E,CAAC,EAAE4E,CAAC,CAACC,WAAW,CAACE;QACrB,CAAC;QAED,IACI3F,IAAI,CAAC6F,GAAG,CACJpF,gBAAgB,CAACE,CAAC,GAAGiF,cAAc,CAACjF,CAAC,CACxC,GAAGb,KAAK,CAACgG,qBAAqB,IAC/B9F,IAAI,CAAC6F,GAAG,CACJpF,gBAAgB,CAACG,CAAC,GAAGgF,cAAc,CAAChF,CAAC,CACxC,GAAGd,KAAK,CAACgG,qBAAqB,EACjC;UACExD,gBAAgB,CAACJ,SAAS,CAAC;QAC/B;;QAEA;QACAxB,mBAAmB,CAAC;UAAEC,CAAC,EAAE,CAAC;UAAEC,CAAC,EAAE;QAAE,CAAC,CAAC;MACvC;IACJ;EAAE,EACJ,GACFuB,SAAS,CACV;AAEf"}

package/lib/commonjs/index.js

@@ -151,6 +151,14 @@ class AdadaptedReactNativeSdk {
    * AppState event listener.
    */
 
+  /**
+   * Track ad zone visibility for off-screen ads.
+   */
+
+  /**
+   * Optional default ad zone visibility for off-screen ads.
+   */
+
   /**
    * Gets the Session ID.
    * @returns the Session ID.
@@ -197,6 +205,8 @@ class AdadaptedReactNativeSdk {
     _defineProperty(this, "onOutOfAppPayloadAvailable", void 0);
     _defineProperty(this, "deepLinkOnEventListener", void 0);
     _defineProperty(this, "AppStateOnEventListener", void 0);
+    _defineProperty(this, "isAdZoneVisible", true);
+    _defineProperty(this, "defaultAdZoneVisibility", void 0);
     this.apiEnv = ApiEnv.Prod;
     this.listManagerApiEnv = ListManagerApiEnv.Prod;
     this.payloadApiEnv = PayloadApiEnv.Prod;
@@ -250,7 +260,9 @@ class AdadaptedReactNativeSdk {
             adZoneData: adZones[adZoneId],
             onAddToListTriggered: items => {
               (0, _util.safeInvoke)(this.onAddToListTriggered, items);
-            }
+            },
+            isAdZoneVisible: !this.onAdZoneVisibilityChanged,
+            defaultToInvisibleAdZone: this.defaultAdZoneVisibility
           })
         });
       }
@@ -303,7 +315,6 @@ class AdadaptedReactNativeSdk {
       uid: this.deviceInfo.udid
     }, this.deviceOs, this.apiEnv).then(response => {
       this.keywordIntercepts = response.data;
-      this.performKeywordSearch("mil");
     });
   }
 
@@ -441,6 +452,23 @@ class AdadaptedReactNativeSdk {
     });
   }
 
+  /**
+   * Notify the ad zone of visibility status change for off-screen ads.
+   */
+  onAdZoneVisibilityChanged() {
+    const isVisible = !this.isAdZoneVisible;
+    this.isAdZoneVisible = isVisible;
+    _reactNative.DeviceEventEmitter.emit("visibility-event", isVisible);
+  }
+
+  /**
+   * Notify the adZone to send ad interaction report.
+   * @param itemName - Detailed list item title from ad that was clicked.
+   */
+  acknowledge(itemName) {
+    _reactNative.DeviceEventEmitter.emit("acknowledge", itemName);
+  }
+
   /**
    * Initializes the session for the AdAdapted API and sets up the SDK.
    * @param props - The props used to initialize the SDK.
@@ -492,6 +520,12 @@ class AdadaptedReactNativeSdk {
     if (props.onOutOfAppPayloadAvailable) {
       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();
+    }
     return new Promise((resolve, reject) => {
       this.getDeviceInformation().then(deviceInfoObj => {
         const deviceInfo = JSON.parse(deviceInfoObj);