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

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/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 {
@@ -160,6 +162,9 @@ export interface FmtOptions extends Record<string, any> {
   groups_max_depth?: number;
   groups_start?: 'current' | 'top' | `group_id:${string}`;
   fields?: string[]; // Array of metadata field to be returned in the data response
+  hidden_fields?: string[];
+  show_hidden_fields?: boolean;
+  variations_return_type?: 'default' | 'all' | 'matched';
 }
 
 export type Nullable<T> = T | null;

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/version.js

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

package/package.json

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