@constructor-io/constructorio-client-javascript 2.30.0-beta.0 → 2.30.1

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

@@ -0,0 +1,232 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
+/* eslint-disable object-curly-newline, no-underscore-dangle */
+var qs = require('qs');
+
+var fetchPonyfill = require('fetch-ponyfill');
+
+var Promise = require('es6-promise');
+
+var EventDispatcher = require('../utils/event-dispatcher');
+
+var helpers = require('../utils/helpers'); // Create URL from supplied quizId and parameters
+
+
+function createQuizUrl(quizId, parameters, options, path) {
+  var apiKey = options.apiKey,
+      clientId = options.clientId,
+      sessionId = options.sessionId,
+      segments = options.segments,
+      userId = options.userId,
+      version = options.version;
+  var serviceUrl = 'https://quizzes.cnstrc.com';
+  var queryParams = {
+    c: version
+  };
+  var answersParamString = '';
+  queryParams.key = apiKey;
+  queryParams.i = clientId;
+  queryParams.s = sessionId; // Pull user segments from options
+
+  if (segments && segments.length) {
+    queryParams.us = segments;
+  } // Pull user id from options
+
+
+  if (userId) {
+    queryParams.ui = userId;
+  } // Validate quiz id is provided
+
+
+  if (!quizId || typeof quizId !== 'string') {
+    throw new Error('quizId is a required parameter of type string');
+  }
+
+  if (path === 'finalize' && ((0, _typeof2["default"])(parameters.a) !== 'object' || !Array.isArray(parameters.a) || parameters.a.length === 0)) {
+    throw new Error('a is a required parameter of type array');
+  }
+
+  if (parameters) {
+    var section = parameters.section,
+        a = parameters.a,
+        versionId = parameters.versionId; // Pull section from parameters
+
+    if (section) {
+      queryParams.section = section;
+    } // Pull version_id from parameters
+
+
+    if (versionId) {
+      queryParams.version_id = versionId;
+    } // Pull a (answers) from parameters and transform
+
+
+    if (a) {
+      a.forEach(function (ans) {
+        answersParamString += "&".concat(qs.stringify({
+          a: ans
+        }, {
+          arrayFormat: 'comma'
+        }));
+      });
+    }
+  }
+
+  queryParams._dt = Date.now();
+  queryParams = helpers.cleanParams(queryParams);
+  var queryString = qs.stringify(queryParams, {
+    indices: false
+  });
+  return "".concat(serviceUrl, "/v1/quizzes/").concat(encodeURIComponent(quizId), "/").concat(encodeURIComponent(path), "/?").concat(queryString).concat(answersParamString);
+}
+/**
+ * Interface to quiz related API calls
+ *
+ * @module quizzes
+ * @inner
+ * @returns {object}
+ */
+
+
+var Quizzes = /*#__PURE__*/function () {
+  function Quizzes(options) {
+    (0, _classCallCheck2["default"])(this, Quizzes);
+    this.options = options || {};
+    this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
+  }
+  /**
+   * Retrieve next question from API
+   *
+   * @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] - 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://docs.constructor.io/rest_api/quiz/using_quizzes/#answering-a-quiz
+   * @example
+   * constructorio.quizzes.getNextQuestion('quizId', {
+   *    a: [[1,2],[1]],
+   *    section: '123',
+   *    versionId: '123'
+   * });
+   */
+
+
+  (0, _createClass2["default"])(Quizzes, [{
+    key: "getNextQuestion",
+    value: function getNextQuestion(quizId, parameters) {
+      var _this = this;
+
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var requestUrl;
+      var fetch = this.options && this.options.fetch || fetchPonyfill({
+        Promise: Promise
+      }).fetch;
+      var controller = new AbortController();
+      var signal = controller.signal;
+
+      try {
+        requestUrl = createQuizUrl(quizId, parameters, this.options, 'next');
+      } 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.version_id) {
+          _this.eventDispatcher.queue('quizzes.getNextQuiz.completed', json);
+
+          return json;
+        }
+
+        throw new Error('getNextQuiz response data is malformed');
+      });
+    }
+    /**
+     * Retrieves filter expression and recommendation URL from given answers
+     *
+     * @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.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://docs.constructor.io/rest_api/quiz/using_quizzes/#completing-the-quiz
+     * @example
+     * constructorio.quizzes.getQuizResults('quizId', {
+     *    a: [[1,2],[1]],
+     *    section: '123',
+     *    versionId: '123'
+     * });
+     */
+
+  }, {
+    key: "getQuizResults",
+    value: function getQuizResults(quizId, parameters) {
+      var _this2 = this;
+
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var requestUrl;
+      var fetch = this.options && this.options.fetch || fetchPonyfill({
+        Promise: Promise
+      }).fetch;
+      var controller = new AbortController();
+      var signal = controller.signal;
+
+      try {
+        requestUrl = createQuizUrl(quizId, parameters, this.options, 'finalize');
+      } 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.version_id) {
+          _this2.eventDispatcher.queue('quizzes.getQuizResults.completed', json);
+
+          return json;
+        }
+
+        throw new Error('getQuizResults response data is malformed');
+      });
+    }
+  }]);
+  return Quizzes;
+}();
+
+module.exports = Quizzes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.30.0-beta.0",
+  "version": "2.30.1",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {
@@ -62,12 +62,12 @@
   },
   "dependencies": {
     "@constructor-io/constructorio-id": "^2.4.10",
-    "crc-32": "^1.2.0",
+    "crc-32": "^1.2.2",
     "es6-promise": "^4.2.8",
     "events": "^3.0.0",
     "fetch-ponyfill": "^7.1.0",
-    "qs": "6.7.2",
-    "store2": "^2.9.0"
+    "qs": "6.11.0",
+    "store2": "^2.14.2"
   },
   "peerDependencies": {
     "@babel/runtime": "^7.19.0"