@constructor-io/constructorio-client-javascript 2.67.6 → 2.68.1

package/lib/modules/quizzes.js

@@ -276,6 +276,52 @@ var Quizzes = /*#__PURE__*/function () {
         throw new Error('getQuizResultsConfig response data is malformed');
       });
     }
+
+    /**
+     * Retrieves all questions for a particular quiz
+     *
+     * @function getQuizAllQuestions
+     * @description Retrieve all questions for a particular quiz from Constructor.io API
+     * @param {string} quizId - The identifier of the quiz
+     * @param {object} 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.com/reference/configuration-quizzes
+     * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request or with getQuizResultsConfig and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {Promise}
+     * @example
+     * constructorio.quizzes.getQuizAllQuestions('quizId', {
+     *    quizVersionId: '123',
+     * });
+     */
+  }, {
+    key: "getQuizAllQuestions",
+    value: function getQuizAllQuestions(quizId, parameters) {
+      var _this4 = 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, 'all_questions');
+      } catch (e) {
+        return Promise.reject(e);
+      }
+
+      // Handle network timeout if specified
+      helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+      return fetch(requestUrl, {
+        signal: signal
+      }).then(helpers.convertResponseToJson).then(function (json) {
+        if (json.quiz_version_id) {
+          _this4.eventDispatcher.queue('quizzes.getQuizAllQuestions.completed', json);
+          return json;
+        }
+        throw new Error('getQuizAllQuestions response data is malformed');
+      });
+    }
   }]);
 }();
 module.exports = Quizzes;

package/lib/types/quizzes.d.ts

@@ -68,6 +68,14 @@ export interface NextQuestionResponse extends Record<string, any> {
   total_questions: number;
 }
 
+export interface AllQuestionsResponse extends Record<string, any> {
+  questions: Question[];
+  quiz_version_id?: string;
+  quiz_id?: string;
+  quiz_session_id?: string;
+  total_questions: number;
+}
+
 export interface QuizResultsResponse extends Record<string, any> {
   request?: {
     filters?: Record<string, any>;
@@ -129,7 +137,7 @@ export interface BaseQuestion extends Record<string, any> {
 export interface FilterValueQuestion extends BaseQuestion {
   type: 'single_filter_value' |'multiple_filter_values';
   filter_name: string;
-  options: QuestionOption[];
+  options: FilterQuestionOption[];
 }
 
 export interface SelectQuestion extends BaseQuestion {
@@ -151,8 +159,7 @@ export interface QuizResult extends Record<string, any> {
   results_url: string;
 }
 
-export interface QuestionOption extends Record<string, any> {
-  id: number;
+export interface BaseQuestionOption extends Record<string, any> {
   value: string;
   attribute: Nullable<{
     name: string;
@@ -161,6 +168,14 @@ export interface QuestionOption extends Record<string, any> {
   images?: Nullable<QuestionImages>;
 }
 
+export interface QuestionOption extends BaseQuestionOption {
+  id: number;
+}
+
+export interface FilterQuestionOption extends BaseQuestionOption {
+  id: string;
+}
+
 export interface QuestionImages extends Record<string, any> {
   primary_url?: Nullable<string>;
   primary_alt?: Nullable<string>;

package/lib/version.js

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

package/package.json

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