@constructor-io/constructorio-client-javascript 2.69.2 → 2.71.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/quizzes.js

@@ -54,7 +54,8 @@ function createQuizUrl(quizId, parameters, options, path) {
       resultsPerPage = parameters.resultsPerPage,
       filters = parameters.filters,
       fmtOptions = parameters.fmtOptions,
-      hiddenFields = parameters.hiddenFields;
+      hiddenFields = parameters.hiddenFields,
+      skipTracking = parameters.skipTracking;
 
     // Pull section from parameters
     if (section) {
@@ -104,6 +105,9 @@ function createQuizUrl(quizId, parameters, options, path) {
         };
       }
     }
+    if (skipTracking) {
+      queryParams.skip_tracking = skipTracking;
+    }
   }
   queryParams._dt = Date.now();
   queryParams = helpers.cleanParams(queryParams);
@@ -136,6 +140,7 @@ var Quizzes = /*#__PURE__*/function () {
    * @param {array} [parameters.answers] - An array of answers in the format [[1,2], [1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true"/"false", "seen" or an empty string ("") if skipped
    * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
    * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
+   * @param {boolean} [parameters.skipTracking] - If true, tracking for this question will be skipped. This is useful for preloading the first question of a quiz
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/lib/modules/search.js

@@ -179,13 +179,13 @@ var Search = /*#__PURE__*/function () {
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
    * @param {string} [parameters.section='Products'] - The section name for results
-   * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details
+   * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params for details
    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
-   * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
-   * @param {object} [parameters.filterMatchTypes] - An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
+   * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params
+   * @param {object} [parameters.filterMatchTypes] - An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -257,12 +257,12 @@ var Search = /*#__PURE__*/function () {
      * @param {number} [parameters.offset] - The number of results to skip from the beginning (Can't be used together with page)
      * @param {number} [parameters.resultsPerPage] - The number of results per page to return
      * @param {string} [parameters.section='Products'] - The section name for results
-     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details
+     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/v1-search-get-natural-language-search-results#query-params for details
      * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
      * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
      * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
      * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
-     * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
+     * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-natural-language-search-results#query-params
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}

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

@@ -32,8 +32,10 @@ export interface IdOptions extends Record<string, any> {
   cookie_days_to_live?: number;
   on_node?: boolean;
   session_is_new?: boolean;
-  client_id_storage_location?: string;
-  session_id_storage_location?: string;
+  // defaults to 'cookie'
+  client_id_storage_location?: 'cookie' | 'local';
+  // defaults to 'local'
+  session_id_storage_location?: 'cookie' | 'local';
 }
 
 export interface EventDispatcherOptions {
@@ -47,6 +49,7 @@ export interface ConstructorClientOptions {
   serviceUrl?: string;
   quizzesServiceUrl?: string;
   agentServiceUrl?: string;
+  mediaServiceUrl?: string;
   assistantServiceUrl?: string;
   sessionId?: number;
   clientId?: string;

package/lib/types/quizzes.d.ts

@@ -21,6 +21,10 @@ export interface QuizzesParameters {
   quizSessionId?: string;
 }
 
+export interface NextQuestionQuizzesParameters extends QuizzesParameters {
+  skipTracking?: boolean;
+}
+
 export interface QuizResultsFmtOptions {
   hidden_fields?: string[];
   fields?: string[];
@@ -42,7 +46,7 @@ declare class Quizzes {
 
   getQuizNextQuestion(
     quizId: string,
-    parameters?: QuizzesParameters,
+    parameters?: NextQuestionQuizzesParameters,
     networkParameters?: NetworkParameters
   ): Promise<NextQuestionResponse>;
 

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.71.0';

package/package.json

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