@adadapted/react-native-sdk 3.3.0 → 3.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adadapted/react-native-sdk",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "description": "The AdAdapted react-native SDK.",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
@@ -51,12 +51,12 @@
   "homepage": "https://gitlab.com/adadapted/adadapted-react-native-sdk#readme",
   "dependencies": {
     "@react-native-community/eslint-config": "^3.2.0",
-    "axios": "1.4.0",
+    "axios": "^1.7.9",
     "react-native-base64": "0.2.1",
     "type-zoo": "3.4.1"
   },
   "peerDependencies": {
-    "react": "*",
+    "react": ">=18",
     "react-native": "*",
     "react-native-webview": "*"
   },
@@ -66,14 +66,13 @@
     "@babel/preset-env": "7.22.5",
     "@babel/preset-react": "7.22.5",
     "@babel/preset-typescript": "7.22.5",
+    "@react-native/typescript-config": "0.74.88",
     "@types/jest": "29.5.2",
-    "@types/react": "18.2.12",
-    "@types/react-dom": "18.2.6",
-    "@types/react-native": "0.72.2",
+    "@types/react": "18.3.1",
     "@types/react-native-base64": "0.2.0",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "5.60.0",
-    "eslint": "^8.44.0",
+    "eslint": "^8.19.0",
     "eslint-config-standard-with-typescript": "^36.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "27.2.2",
@@ -82,16 +81,13 @@
     "eslint-plugin-prefer-arrow": "1.2.3",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^5.1.0",
     "eslint-plugin-react-native": "^4.0.0",
-    "jest": "29.5.0",
+    "jest": "^29.6.3",
     "prettier": "2.8.8",
-    "react": "18.2.0",
-    "react-native": "0.72.0",
-    "react-native-builder-bob": "^0.23.2",
-    "react-native-webview": "13.2.2",
-    "react-router-native": "6.14.0",
+    "react-native-builder-bob": "0.33.3",
     "ts-jest": "29.1.0",
-    "typescript": "^5.0.4"
+    "typescript": "5.0.4"
   },
   "jest": {
     "preset": "react-native",

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

@@ -566,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",
+    }
+}