@constructor-io/constructorio-client-javascript 2.73.0 → 2.74.0

package/lib/modules/tracker.js

@@ -1315,10 +1315,7 @@ var Tracker = /*#__PURE__*/function () {
       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 baseUrl = helpers.getBehaviorUrl(this.options.mediaServiceUrl);
         var requestPath = "".concat(baseUrl.toString(), "v2/ad_behavioral_action/display_ad_view?");
         var bodyParams = {};
         var bannerAdId = parameters.bannerAdId,
@@ -1346,6 +1343,60 @@ var Tracker = /*#__PURE__*/function () {
       return new Error('parameters are required of type object');
     }
 
+    /**
+     * Send media impression click event to API
+     *
+     * @function trackMediaImpressionClick
+     * @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 clicked a media banner
+     * @example
+     * constructorio.tracker.trackMediaImpressionClick(
+     *     {
+     *         bannerAdId: 'banner_ad_id',
+     *         placementId: 'placement_id',
+     *     },
+     * );
+     */
+  }, {
+    key: "trackMediaImpressionClick",
+    value: function trackMediaImpressionClick(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      // Ensure required parameters are provided
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        var baseUrl = helpers.getBehaviorUrl(this.options.mediaServiceUrl);
+        var requestPath = "".concat(baseUrl.toString(), "v2/ad_behavioral_action/display_ad_click?");
+        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/quizzes.d.ts

@@ -127,7 +127,7 @@ export interface QuizResultData extends Record<string, any> {
   variations: Record<string, any>[];
 }
 
-export type Question = SelectQuestion | FilterValueQuestion | OpenQuestion | CoverQuestion;
+export type Question = SelectQuestion | FilterValueQuestion | OpenQuestion | CoverQuestion | FreeFormQuestion;
 
 export interface BaseQuestion extends Record<string, any> {
   id: number;
@@ -158,6 +158,11 @@ export interface CoverQuestion extends BaseQuestion {
   type: 'cover';
 }
 
+export interface FreeFormQuestion extends BaseQuestion {
+  type: 'free_form';
+  input_placeholder?: Nullable<string>;
+}
+
 export interface QuizResult extends Record<string, any> {
   filter_expression: Record<string, any>;
   results_url: string;

package/lib/types/tracker.d.ts

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

package/lib/utils/helpers.js

@@ -338,6 +338,13 @@ var utils = {
   },
   truncateString: function truncateString(string, maxLength) {
     return string.slice(0, maxLength);
+  },
+  getBehaviorUrl: function getBehaviorUrl(mediaServiceUrl) {
+    var baseUrl = new URL(mediaServiceUrl);
+    if (!baseUrl.hostname.startsWith('behavior')) {
+      baseUrl.hostname = "behavior.".concat(baseUrl.hostname);
+    }
+    return baseUrl;
   }
 };
 module.exports = utils;

package/lib/version.js

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

package/package.json

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