@constructor-io/constructorio-client-javascript 2.69.2 → 2.70.0

package/lib/constructorio.js

@@ -43,6 +43,7 @@ var ConstructorIO = /*#__PURE__*/function () {
    * @param {string} [parameters.serviceUrl='https://ac.cnstrc.com'] - API URL endpoint
    * @param {string} [parameters.quizzesServiceUrl='https://quizzes.cnstrc.com'] - Quizzes API URL endpoint
    * @param {string} [parameters.agentServiceUrl='https://agent.cnstrc.com'] - AI Shopping Agent API URL endpoint
+   * @param {string} [parameters.mediaServiceUrl='https://media-cnstrc.com'] - Media API URL endpoint
    * @param {string} [parameters.assistantServiceUrl='https://assistant.cnstrc.com'] - AI Shopping Assistant API URL endpoint @deprecated This parameter is deprecated and will be removed in a future version. Use parameters.agentServiceUrl instead.
    * @param {array} [parameters.segments] - User segments
    * @param {object} [parameters.testCells] - User test cells
@@ -78,6 +79,7 @@ var ConstructorIO = /*#__PURE__*/function () {
       quizzesServiceUrl = options.quizzesServiceUrl,
       agentServiceUrl = options.agentServiceUrl,
       assistantServiceUrl = options.assistantServiceUrl,
+      mediaServiceUrl = options.mediaServiceUrl,
       segments = options.segments,
       testCells = options.testCells,
       clientId = options.clientId,
@@ -122,6 +124,7 @@ var ConstructorIO = /*#__PURE__*/function () {
       quizzesServiceUrl: quizzesServiceUrl && quizzesServiceUrl.replace(/\/$/, '') || 'https://quizzes.cnstrc.com',
       agentServiceUrl: agentServiceUrl && agentServiceUrl.replace(/\/$/, '') || 'https://agent.cnstrc.com',
       assistantServiceUrl: assistantServiceUrl && assistantServiceUrl.replace(/\/$/, '') || 'https://assistant.cnstrc.com',
+      mediaServiceUrl: mediaServiceUrl && mediaServiceUrl.replace(/\/$/, '') || 'https://media-cnstrc.com',
       sessionId: sessionId || session_id,
       clientId: clientId || client_id,
       userId: userId,

package/lib/modules/tracker.js

@@ -1281,6 +1281,63 @@ var Tracker = /*#__PURE__*/function () {
       return new Error('parameters are required of type object');
     }
 
+    /**
+     * Send media impression view event to API
+     *
+     * @function trackMediaImpressionView
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.bannerAdId - Banner ad identifier
+     * @param {string} parameters.placementId - Placement identifier
+     * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User viewed a media banner
+     * @example
+     * constructorio.tracker.trackMediaImpressionView(
+     *     {
+     *         bannerAdId: 'banner_ad_id',
+     *         placementId: 'placement_id',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackMediaImpressionView",
+    value: function trackMediaImpressionView(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      // Ensure parameters are provided (required)
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        var baseUrl = new URL(this.options.mediaServiceUrl);
+        if (!baseUrl.hostname.startsWith('behavior')) {
+          baseUrl.hostname = "behavior.".concat(baseUrl.hostname);
+        }
+        var requestPath = "".concat(baseUrl.toString(), "v2/ad_behavioral_action/display_ad_view?");
+        var bodyParams = {};
+        var bannerAdId = parameters.bannerAdId,
+          placementId = parameters.placementId,
+          analyticsTags = parameters.analyticsTags;
+        if (!helpers.isNil(bannerAdId)) {
+          bodyParams.banner_ad_id = bannerAdId;
+        }
+        if (!helpers.isNil(placementId)) {
+          bodyParams.placement_id = placementId;
+        }
+        if (!helpers.isNil(analyticsTags)) {
+          bodyParams.analytics_tags = analyticsTags;
+        }
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
+        var requestMethod = 'POST';
+        var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+          requestMethod: requestMethod
+        }));
+        this.requests.queue(requestURL, requestMethod, requestBody, networkParameters);
+        this.requests.send();
+        return true;
+      }
+      this.requests.send();
+      return new Error('parameters are required of type object');
+    }
+
     /**
      * Send recommendation click event to API
      *

package/lib/types/index.d.ts

@@ -47,6 +47,7 @@ export interface ConstructorClientOptions {
   serviceUrl?: string;
   quizzesServiceUrl?: string;
   agentServiceUrl?: string;
+  mediaServiceUrl?: string;
   assistantServiceUrl?: string;
   sessionId?: number;
   clientId?: string;

package/lib/types/tracker.d.ts

@@ -437,5 +437,12 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
+  trackMediaImpressionView(parameters: {
+      bannerAdId: string;
+      placementId: string;
+      analyticsTags?: Record<string, string>;
+    }, networkParameters?: NetworkParameters
+  ): true | Error;
+
   on(messageType: string, callback: Function): true | Error;
 }

package/lib/version.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = exports["default"] = '2.69.2';
+var _default = exports["default"] = '2.70.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.69.2",
+  "version": "2.70.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/index.d.ts",