@constructor-io/constructorio-client-javascript 2.34.9 → 2.35.1

package/lib/modules/quizzes.js

@@ -46,22 +46,31 @@ function createQuizUrl(quizId, parameters, options, path) {
     throw new Error('quizId is a required parameter of type string');
   }
 
-  if (path === 'finalize' && ((0, _typeof2["default"])(parameters.answers) !== 'object' || !Array.isArray(parameters.answers) || parameters.answers.length === 0)) {
+  if (path === 'results' && ((0, _typeof2["default"])(parameters.answers) !== 'object' || !Array.isArray(parameters.answers) || parameters.answers.length === 0)) {
     throw new Error('answers is a required parameter of type array');
   }
 
   if (parameters) {
     var section = parameters.section,
         answers = parameters.answers,
-        versionId = parameters.versionId; // Pull section from parameters
+        quizSessionId = parameters.quizSessionId,
+        quizVersionId = parameters.quizVersionId,
+        page = parameters.page,
+        resultsPerPage = parameters.resultsPerPage,
+        filters = parameters.filters; // Pull section from parameters
 
     if (section) {
       queryParams.section = section;
-    } // Pull version_id from parameters
+    } // Pull quiz_version_id from parameters
 
 
-    if (versionId) {
-      queryParams.version_id = versionId;
+    if (quizVersionId) {
+      queryParams.quiz_version_id = quizVersionId;
+    } // Pull quiz_session_id from parameters
+
+
+    if (quizSessionId) {
+      queryParams.quiz_session_id = quizSessionId;
     } // Pull a (answers) from parameters and transform
 
 
@@ -71,6 +80,20 @@ function createQuizUrl(quizId, parameters, options, path) {
           return (0, _toConsumableArray2["default"])(ans).join(',');
         })
       }));
+    } // Pull page from parameters
+
+
+    if (!helpers.isNil(page)) {
+      queryParams.page = page;
+    } // Pull results per page from parameters
+
+
+    if (!helpers.isNil(resultsPerPage)) {
+      queryParams.num_results_per_page = resultsPerPage;
+    }
+
+    if (filters) {
+      queryParams.filters = filters;
     }
   }
 
@@ -103,7 +126,8 @@ var Quizzes = /*#__PURE__*/function () {
    * @param {string} [parameters] - Additional parameters to refine result set
    * @param {string} [parameters.section] - Product catalog section
    * @param {array} [parameters.answers] - An array of answers in the format [[1,2],[1]]
-   * @param {string} [parameters.versionId] - Version identifier for the quiz
+   * @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.io/rest_api/quiz/using_quizzes/#quiz-versioning
+   * @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.io/rest_api/quiz/using_quizzes/#quiz-sessions
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -112,7 +136,8 @@ var Quizzes = /*#__PURE__*/function () {
    * constructorio.quizzes.getQuizNextQuestion('quizId', {
    *    answers: [[1,2],[1]],
    *    section: '123',
-   *    versionId: '123'
+   *    quizVersionId: '123',
+   *    quizSessionId: '1234',
    * });
    */
 
@@ -145,7 +170,7 @@ var Quizzes = /*#__PURE__*/function () {
 
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
-        if (json.version_id) {
+        if (json.quiz_version_id) {
           _this.eventDispatcher.queue('quizzes.getQuizNextQuestion.completed', json);
 
           return json;
@@ -160,10 +185,14 @@ var Quizzes = /*#__PURE__*/function () {
      * @function getQuizResults
      * @description Retrieve quiz recommendation and filter expression from Constructor.io API
      * @param {string} id - The identifier of the quiz
-     * @param {string} [parameters] - Additional parameters to refine result set
+     * @param {string} parameters - Additional parameters to refine result set
+     * @param {array} parameters.answers - An array of answers in the format [[1,2],[1]]
      * @param {string} [parameters.section] - Product catalog section
-     * @param {array} [parameters.answers] - An array of answers in the format [[1,2],[1]]
-     * @param {string} [parameters.versionId] - Specific version identifier for the quiz
+     * @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.io/rest_api/quiz/using_quizzes/#quiz-versioning
+     * @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.io/rest_api/quiz/using_quizzes/#quiz-sessions
+     * @param {number} [parameters.page] - The page number of the results
+     * @param {number} [parameters.resultsPerPage] - The number of results per page to return
+     * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}
@@ -172,7 +201,8 @@ var Quizzes = /*#__PURE__*/function () {
      * constructorio.quizzes.getQuizResults('quizId', {
      *    answers: [[1,2],[1]],
      *    section: '123',
-     *    versionId: '123'
+     *    quizVersionId: '123',
+     *    quizSessionId: '234'
      * });
      */
 
@@ -188,7 +218,7 @@ var Quizzes = /*#__PURE__*/function () {
       var signal = controller.signal;
 
       try {
-        requestUrl = createQuizUrl(id, parameters, this.options, 'finalize');
+        requestUrl = createQuizUrl(id, parameters, this.options, 'results');
       } catch (e) {
         return Promise.reject(e);
       } // Handle network timeout if specified
@@ -204,7 +234,7 @@ var Quizzes = /*#__PURE__*/function () {
 
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
-        if (json.version_id) {
+        if (json.quiz_version_id) {
           _this2.eventDispatcher.queue('quizzes.getQuizResults.completed', json);
 
           return json;

package/lib/types/index.d.ts

@@ -93,7 +93,7 @@ export interface Feature extends Record<string, any> {
     name: string;
     display_name: string;
     [key: string]: any;
-  };
+  } | null;
 }
 
 export interface FmtOption extends Record<string, any> {

package/lib/types/quizzes.d.ts

@@ -1,12 +1,31 @@
 import { Nullable } from './index.d';
-import { ConstructorClientOptions, NetworkParameters } from '.';
+import {
+  ConstructorClientOptions,
+  Facet,
+  Feature,
+  Group,
+  NetworkParameters,
+  RequestFeature,
+  RequestFeatureVariant,
+  SortOption,
+  FilterExpression,
+  ResultSources,
+} from '.';
 
 export default Quizzes;
 
 export interface QuizzesParameters {
   section?: string;
   answers?: any[];
-  versionId?: string;
+  quizVersionId?: string;
+  quizSessionId?: string;
+}
+
+export interface QuizzesResultsParameters extends QuizzesParameters {
+  answers: any[];
+  page?: number;
+  resultsPerPage?: number;
+  filters?: Record<string, any>;
 }
 
 declare class Quizzes {
@@ -22,7 +41,7 @@ declare class Quizzes {
 
   getQuizResults(
     id: string,
-    parameters?: QuizzesParameters,
+    parameters?: QuizzesResultsParameters,
     networkParameters?: NetworkParameters
   ): Promise<QuizResultsResponse>;
 }
@@ -32,10 +51,50 @@ export interface NextQuestionResponse extends Record<string, any> {
   next_question: Question;
   is_last_question?: boolean;
   version_id?: string;
+  quiz_id?: string;
+  quiz_session_id?: string;
 }
+
 export interface QuizResultsResponse extends Record<string, any> {
-  result: Partial<QuizResult>;
-  version_id?: string;
+  request?: {
+    filters?: Record<string, any>;
+    fmt_options: Record<string, any>;
+    num_results_per_page: number;
+    page: number;
+    section: string;
+    sort_by: string;
+    sort_order: string;
+    features: Partial<RequestFeature>;
+    feature_variants: Partial<RequestFeatureVariant>;
+    collection_filter_expression: FilterExpression;
+    term: string;
+  };
+  response?: {
+    result_sources: Partial<ResultSources>;
+    facets: Partial<Facet>[];
+    groups: Partial<Group>[];
+    results: Partial<QuizResultData>[];
+    sort_options: Partial<SortOption>[];
+    refined_content: Record<string, any>[];
+    total_num_results: number;
+    features: Partial<Feature>[];
+  };
+  result_id?: string;
+  quiz_version_id: string;
+  quiz_session_id: string;
+  quiz_id: string;
+}
+
+export interface QuizResultData extends Record<string, any> {
+  matched_terms: string[];
+  data: {
+    id: string;
+    [key: string]: any;
+  };
+  value: string;
+  is_slotted: false;
+  labels: Record<string, any>;
+  variations: Record<string, any>[];
 }
 
 export type Question = SelectQuestion | OpenQuestion | CoverQuestion

package/lib/types/types.d.ts

@@ -0,0 +1,126 @@
+import EventDispatcher from './event-dispatcher';
+
+export interface ConstructorClientOptions {
+	apiKey: string;
+	version?: string;
+	serviceUrl?: string;
+	// session id is of type string in jsdocs but of type number in code usage
+	sessionId?: string;
+	clientId?: string;
+	userId?: string;
+	segments?: string[];
+	testCells?: Record<string, string>;
+	fetch?: any;
+	trackingSendDelay?: number;
+	sendTrackingEvents?: boolean;
+	sendReferrerWithTrackingEvents?: boolean;
+	eventDispatcher?: EventDispatcher;
+	beaconMode?: boolean;
+	networkParameters?: {
+		timeout: number;
+	};
+}
+
+export interface RequestFeature extends Record<string, any> {
+	query_items: boolean;
+	auto_generated_refined_query_rules: boolean;
+	manual_searchandizing: boolean;
+	personalization: boolean;
+	filter_items: boolean;
+}
+
+export interface RequestFeatureVariant extends Record<string, any> {
+	query_items: string;
+	auto_generated_refined_query_rules: string;
+	manual_searchandizing: string | null;
+	personalization: string;
+	filter_items: string;
+}
+
+export type ErrorData = {
+	message: string;
+	[key: string]: any;
+};
+
+export interface ResultSources extends Record<string, any> {
+	token_match: { count: number; [key: string]: any };
+	embeddings_match: { count: number; [key: string]: any };
+}
+
+export interface SortOption extends Record<string, any> {
+	sort_by: string;
+	display_name: string;
+	sort_order: string;
+	status: string;
+}
+
+export interface Feature extends Record<string, any> {
+	feature_name: string;
+	display_name: string;
+	enabled: boolean;
+	variant: {
+		name: string;
+		display_name: string;
+		[key: string]: any;
+	};
+}
+
+export interface FmtOption extends Record<string, any> {
+	groups_start: string;
+	groups_max_depth: number;
+}
+
+type Facet = RangeFacet | OptionFacet;
+
+export interface BaseFacet extends Record<string, any> {
+	data: Record<string, any>;
+	status: Record<string, any>;
+	display_name: string;
+	name: string;
+	hidden: boolean;
+}
+
+export interface RangeFacet extends BaseFacet, Record<string, any> {
+	max: number;
+	min: number;
+	type: "range";
+}
+
+export interface OptionFacet extends BaseFacet, Record<string, any> {
+	options: FacetOption[];
+	type: "multiple" | "single" | "hierarchical";
+}
+
+export interface FacetOption extends Record<string, any> {
+	count: number;
+	display_name: string;
+	value: string;
+	options?: FacetOption[];
+	range?: ["-inf" | number, "inf" | number];
+	status: string;
+}
+
+export interface Group extends BaseGroup, Record<string, any> {
+	count: number;
+	data: Record<string, any>;
+	parents: BaseGroup[];
+	children: Group[];
+}
+
+export interface Collection extends Record<string, any> {
+	collection_id: string,
+	display_name: string,
+	data: Record<string, any>
+}
+
+export interface BaseGroup extends Record<string, any> {
+	display_name: string;
+	group_id: string;
+}
+
+export interface FmtOptions extends Record<string, any> {
+	
+}
+
+export type Nullable<T> = T | null;
+

package/package.json

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