@constructor-io/constructorio-client-javascript 2.37.4 → 2.39.0

package/lib/modules/quizzes.js

@@ -223,6 +223,56 @@ var Quizzes = /*#__PURE__*/function () {
         throw new Error('getQuizResults response data is malformed');
       });
     }
+
+    /**
+     * Retrieves configuration for the results page of a particular quiz
+     *
+     * @function getQuizResultsConfig
+     * @description Retrieve quiz results page configuration from Constructor.io API
+     * @param {string} quizId - The identifier of the quiz
+     * @param {string} parameters - Additional parameters
+     * @param {string} [parameters.section] - Product catalog section
+     * @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 {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {Promise}
+     * @example
+     * constructorio.quizzes.getQuizResultsConfig('quizId', {
+     *    quizVersionId: '123',
+     * });
+     */
+  }, {
+    key: "getQuizResultsConfig",
+    value: function getQuizResultsConfig(quizId, parameters) {
+      var _this3 = this;
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var requestUrl;
+      var fetch = this.options.fetch;
+      var controller = new AbortController();
+      var signal = controller.signal;
+      try {
+        requestUrl = createQuizUrl(quizId, parameters, this.options, 'results_config');
+      } catch (e) {
+        return Promise.reject(e);
+      }
+
+      // Handle network timeout if specified
+      helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+      return fetch(requestUrl, {
+        signal: signal
+      }).then(function (response) {
+        if (response.ok) {
+          return response.json();
+        }
+        return helpers.throwHttpErrorFromResponse(new Error(), response);
+      }).then(function (json) {
+        if (json.quiz_version_id) {
+          _this3.eventDispatcher.queue('quizzes.getQuizResultsConfig.completed', json);
+          return json;
+        }
+        throw new Error('getQuizResultsConfig response data is malformed');
+      });
+    }
   }]);
   return Quizzes;
 }();

package/lib/types/index.d.ts

@@ -189,11 +189,14 @@ export interface Item extends Record<string, any> {
   labels: Record<string, unknown>;
   matched_terms: string[];
   data?: ItemData;
+  strategy?: { id: string };
+  variations?: { data?: ItemData, value: string }[]
 }
 
 export interface ItemData extends Record<string, any> {
   url?: string;
   id?: string;
+  variation_id?: string;
   image_url?: string;
   group_ids?: string[];
   groups?: Group[]

package/lib/types/quizzes.d.ts

@@ -44,12 +44,17 @@ declare class Quizzes {
     parameters?: QuizzesResultsParameters,
     networkParameters?: NetworkParameters
   ): Promise<QuizResultsResponse>;
+
+  getQuizResultsConfig(
+    quizId: string,
+    parameters?: Pick<QuizzesParameters, 'quizVersionId'>,
+    networkParameters?: NetworkParameters,
+  ): Promise<QuizResultsConfigResponse>;
 }
 
 /* quizzes results returned from server */
 export interface NextQuestionResponse extends Record<string, any> {
   next_question: Question;
-  is_last_question?: boolean;
   quiz_version_id?: string;
   quiz_id?: string;
   quiz_session_id?: string;
@@ -148,3 +153,23 @@ export interface QuestionImages extends Record<string, any> {
   secondary_url?: Nullable<string>;
   secondary_alt?: Nullable<string>;
 }
+
+type ResultConfigFields = {
+  is_active: boolean;
+  text: Nullable<string>
+}
+
+type ViewportResultsConfig = {
+  title: Nullable<ResultConfigFields>;
+  description: Nullable<ResultConfigFields>;
+};
+
+export interface QuizResultsConfig extends Record<string, any> {
+  desktop: ViewportResultsConfig;
+}
+
+export interface QuizResultsConfigResponse extends Record<string, any> {
+  results_config: QuizResultsConfig,
+  quiz_version_id: string;
+  quiz_id: string;
+}

package/package.json

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