@constructor-io/constructorio-client-javascript 2.29.13 → 2.30.0

package/README.md

@@ -40,7 +40,7 @@ var constructorio = new ConstructorIOClient({
 After instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: `search`, `browse`, `autocomplete`, `recommendations` and `tracker`.
 
 #### Dispatched events
-The `search`, `browse` and `recommendations` module may dispatch custom events on `window` with response data when a request has been completed. The event name follows the following structure: `cio.client.[moduleName].[methodName].completed`. Example consuming code can be found below:
+The `search`, `browse`, `recommendations` and `autocomplete` modules may dispatch custom events on `window` with response data when a request has been completed. The event name follows the following structure: `cio.client.[moduleName].[methodName].completed`. Example consuming code can be found below:
 
 ```javascript
 window.addEventListener('cio.client.search.getSearchResults.completed', (event) => {

package/lib/constructorio.js

@@ -25,7 +25,9 @@ var EventDispatcher = require('./utils/event-dispatcher');
 var helpers = require('./utils/helpers');
 
 var _require = require('../package.json'),
-    packageVersion = _require.version; // Compute package version string
+    packageVersion = _require.version;
+
+var Quizzes = require('./modules/quizzes'); // Compute package version string
 
 
 var computePackageVersion = function computePackageVersion() {
@@ -72,6 +74,7 @@ var ConstructorIO = /*#__PURE__*/function () {
    * @property {object} autocomplete - Interface to {@link module:autocomplete}
    * @property {object} recommendations - Interface to {@link module:recommendations}
    * @property {object} tracker - Interface to {@link module:tracker}
+   * @property {object} quizzes - Interface to {@link module:quizzes}
    * @returns {class}
    */
   function ConstructorIO() {
@@ -142,7 +145,8 @@ var ConstructorIO = /*#__PURE__*/function () {
     this.browse = new Browse(this.options);
     this.autocomplete = new Autocomplete(this.options);
     this.recommendations = new Recommendations(this.options);
-    this.tracker = new Tracker(this.options); // Dispatch initialization event
+    this.tracker = new Tracker(this.options);
+    this.quizzes = new Quizzes(this.options); // Dispatch initialization event
 
     new EventDispatcher(options.eventDispatcher).queue('instantiated', this.options);
   }

package/lib/modules/quizzes.js

@@ -66,7 +66,7 @@ function createQuizUrl(quizId, parameters, options, path) {
 
     if (versionId) {
       queryParams.version_id = versionId;
-    } // Pull a from parameters and transform
+    } // Pull a (answers) from parameters and transform
 
 
     if (a) {
@@ -103,31 +103,31 @@ var Quizzes = /*#__PURE__*/function () {
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
   /**
-   * Retrieve next quiz from api
+   * Retrieve next question from API
    *
-   * @function getNextQuiz
-   * @description Retrieve next quiz from Constructor.io API
-   * @param {string} id - The id of the quiz
+   * @function getNextQuestion
+   * @description Retrieve next question from Constructor.io API
+   * @param {string} id - The identifier of the quiz
    * @param {string} [parameters] - Additional parameters to refine result set
-   * @param {string} [parameters.section] - Section for customer's product catalog (optional)
-   * @param {array} [parameters.a] - An array for answers in the format [[1,2],[1]]
-   * @param {string} [parameters.version_id] - Specific version id for the quiz.
+   * @param {string} [parameters.section] - Product catalog section
+   * @param {array} [parameters.a] - An array of answers in the format [[1,2],[1]]
+   * @param {string} [parameters.versionId] - Version identifier for the quiz
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://quizzes.cnstrc.com/api/#/quizzes/QuizzesController_getNextQuestion
+   * @see https://docs.constructor.io/rest_api/quiz/using_quizzes/#answering-a-quiz
    * @example
-   * constructorio.search.getNextQuiz('quizId', {
+   * constructorio.quizzes.getNextQuestion('quizId', {
    *    a: [[1,2],[1]],
-   *    section: "123",
-   *    version_id: "123"
+   *    section: '123',
+   *    versionId: '123'
    * });
    */
 
 
   (0, _createClass2["default"])(Quizzes, [{
-    key: "getNextQuiz",
-    value: function getNextQuiz(quizId, parameters) {
+    key: "getNextQuestion",
+    value: function getNextQuestion(quizId, parameters) {
       var _this = this;
 
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -165,30 +165,30 @@ var Quizzes = /*#__PURE__*/function () {
       });
     }
     /**
-     * Retrieves filter expression and recommendation URL from given answers.
+     * Retrieves filter expression and recommendation URL from given answers
      *
-     * @function getFinalizeQuiz
+     * @function getQuizResults
      * @description Retrieve quiz recommendation and filter expression from Constructor.io API
-     * @param {string} id - The id of the quiz
+     * @param {string} id - The identifier of the quiz
      * @param {string} [parameters] - Additional parameters to refine result set
-     * @param {string} [parameters.section] - Section for customer's product catalog (optional)
-     * @param {array} [parameters.a] - An array for answers in the format [[1,2],[1]]
-     * @param {string} [parameters.version_id] - Specific version id for the quiz.
+     * @param {string} [parameters.section] - Product catalog section
+     * @param {array} [parameters.a] - An array of answers in the format [[1,2],[1]]
+     * @param {string} [parameters.versionId] - Specific version identifier for the quiz
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}
-     * @see https://quizzes.cnstrc.com/api/#/quizzes/QuizzesController_getQuizResult
+     * @see https://docs.constructor.io/rest_api/quiz/using_quizzes/#completing-the-quiz
      * @example
-     * constructorio.search.getFinalizeQuiz('quizId', {
+     * constructorio.quizzes.getQuizResults('quizId', {
      *    a: [[1,2],[1]],
-     *    section: "123",
-     *    version_id: "123"
+     *    section: '123',
+     *    versionId: '123'
      * });
      */
 
   }, {
-    key: "getFinalizeQuiz",
-    value: function getFinalizeQuiz(quizId, parameters) {
+    key: "getQuizResults",
+    value: function getQuizResults(quizId, parameters) {
       var _this2 = this;
 
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -217,12 +217,12 @@ var Quizzes = /*#__PURE__*/function () {
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
         if (json.version_id) {
-          _this2.eventDispatcher.queue('quizzes.getFinalizeQuiz.completed', json);
+          _this2.eventDispatcher.queue('quizzes.getQuizResults.completed', json);
 
           return json;
         }
 
-        throw new Error('getFinalizeQuiz response data is malformed');
+        throw new Error('getQuizResults response data is malformed');
       });
     }
   }]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.29.13",
+  "version": "2.30.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {