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

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 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 quiz from api
+   *
+   * @function getNextQuiz
+   * @description Retrieve next quiz from Constructor.io API
+   * @param {string} id - The id 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 {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
+   * @example
+   * constructorio.search.getNextQuiz('quizId', {
+   *    a: [[1,2],[1]],
+   *    section: "123",
+   *    version_id: "123"
+   * });
+   */
+
+
+  (0, _createClass2["default"])(Quizzes, [{
+    key: "getNextQuiz",
+    value: function getNextQuiz(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 getFinalizeQuiz
+     * @description Retrieve quiz recommendation and filter expression from Constructor.io API
+     * @param {string} id - The id 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 {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
+     * @example
+     * constructorio.search.getFinalizeQuiz('quizId', {
+     *    a: [[1,2],[1]],
+     *    section: "123",
+     *    version_id: "123"
+     * });
+     */
+
+  }, {
+    key: "getFinalizeQuiz",
+    value: function getFinalizeQuiz(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.getFinalizeQuiz.completed', json);
+
+          return json;
+        }
+
+        throw new Error('getFinalizeQuiz response data is malformed');
+      });
+    }
+  }]);
+  return Quizzes;
+}();
+
+module.exports = Quizzes;

package/lib/modules/recommendations.js

@@ -117,7 +117,7 @@ var Recommendations = /*#__PURE__*/function () {
    * @param {number} [parameters.numResults] - The number of results to return
    * @param {string} [parameters.section] - The section to return results from
    * @param {string} [parameters.term] - The term to use to refine results (strategy specific)
-   * @param {object} [parameters.filters] - Key / value mapping of filters used to refine results (strategy specific)
+   * @param {object} [parameters.filters] - Key / value mapping of filters used to refine results
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)

package/lib/utils/botlist.js

@@ -1,4 +1,6 @@
 "use strict";
 
 /* eslint-disable no-useless-escape */
+
+/* cspell:disable */
 module.exports = ['Googlebot\/', 'Googlebot-Mobile', 'Googlebot-Image', 'Googlebot-News', 'Googlebot-Video', 'AdsBot-Google([^-]|$)', 'AdsBot-Google-Mobile', 'Feedfetcher-Google', 'Mediapartners-Google', 'Mediapartners \\(Googlebot\\)', 'APIs-Google', 'bingbot', 'Slurp', '[wW]get', 'curl', 'LinkedInBot', 'Python-urllib', 'python-requests', 'libwww', 'httpunit', 'nutch', 'Go-http-client', 'phpcrawl', 'msnbot', 'jyxobot', 'FAST-WebCrawler', 'FAST Enterprise Crawler', 'BIGLOTRON', 'Teoma', 'convera', 'seekbot', 'Gigabot', 'Gigablast', 'exabot', 'ia_archiver', 'GingerCrawler', 'webmon ', 'HTTrack', 'grub\\.org', 'UsineNouvelleCrawler', 'antibot', 'netresearchserver', 'speedy', 'fluffy', 'bibnum\\.bnf', 'findlink', 'msrbot', 'panscient', 'yacybot', 'AISearchBot', 'ips-agent', 'tagoobot', 'MJ12bot', 'woriobot', 'yanga', 'buzzbot', 'mlbot', 'YandexBot', 'yandex\\.com\/bots', 'purebot', 'Linguee Bot', 'CyberPatrol', 'voilabot', 'Baiduspider', 'citeseerxbot', 'spbot', 'twengabot', 'postrank', 'turnitinbot', 'scribdbot', 'page2rss', 'sitebot', 'linkdex', 'Adidxbot', 'blekkobot', 'ezooms', 'dotbot', 'Mail\\.RU_Bot', 'discobot', 'heritrix', 'findthatfile', 'europarchive\\.org', 'NerdByNature\\.Bot', 'sistrix crawler', 'Ahrefs(Bot|SiteAudit)', 'fuelbot', 'CrunchBot', 'centurybot9', 'IndeedBot', 'mappydata', 'woobot', 'ZoominfoBot', 'PrivacyAwareBot', 'Multiviewbot', 'SWIMGBot', 'Grobbot', 'eright', 'Apercite', 'semanticbot', 'Aboundex', 'domaincrawler', 'wbsearchbot', 'summify', 'CCBot', 'edisterbot', 'seznambot', 'ec2linkfinder', 'gslfbot', 'aiHitBot', 'intelium_bot', 'facebookexternalhit', 'Yeti', 'RetrevoPageAnalyzer', 'lb-spider', 'Sogou', 'lssbot', 'careerbot', 'wotbox', 'wocbot', 'ichiro', 'DuckDuckBot', 'lssrocketcrawler', 'drupact', 'webcompanycrawler', 'acoonbot', 'openindexspider', 'gnam gnam spider', 'web-archive-net\\.com\\.bot', 'backlinkcrawler', 'coccoc', 'integromedb', 'content crawler spider', 'toplistbot', 'it2media-domain-crawler', 'ip-web-crawler\\.com', 'siteexplorer\\.info', 'elisabot', 'proximic', 'changedetection', 'arabot', 'WeSEE:Search', 'niki-bot', 'CrystalSemanticsBot', 'rogerbot', '360Spider', 'psbot', 'InterfaxScanBot', 'CC Metadata Scaper', 'g00g1e\\.net', 'GrapeshotCrawler', 'urlappendbot', 'brainobot', 'fr-crawler', 'binlar', 'SimpleCrawler', 'Twitterbot', 'cXensebot', 'smtbot', 'bnf\\.fr_bot', 'A6-Indexer', 'ADmantX', 'Facebot', 'OrangeBot\/', 'memorybot', 'AdvBot', 'MegaIndex', 'SemanticScholarBot', 'ltx71', 'nerdybot', 'xovibot', 'BUbiNG', 'Qwantify', 'archive\\.org_bot', 'Applebot', 'TweetmemeBot', 'crawler4j', 'findxbot', 'S[eE][mM]rushBot', 'yoozBot', 'lipperhey', 'Y!J', 'Domain Re-Animator Bot', 'AddThis', 'Screaming Frog SEO Spider', 'MetaURI', 'Scrapy', 'Livelap[bB]ot', 'OpenHoseBot', 'CapsuleChecker', 'collection@infegy\\.com', 'IstellaBot', 'DeuSu\/', 'betaBot', 'Cliqzbot\/', 'MojeekBot\/', 'netEstate NE Crawler', 'SafeSearch microdata crawler', 'Gluten Free Crawler\/', 'Sonic', 'Sysomos', 'Trove', 'deadlinkchecker', 'Slack-ImgProxy', 'Embedly', 'RankActiveLinkBot', 'iskanie', 'SafeDNSBot', 'SkypeUriPreview', 'Veoozbot', 'Slackbot', 'redditbot', 'datagnionbot', 'Google-Adwords-Instant', 'adbeat_bot', 'WhatsApp', 'contxbot', 'pinterest', 'electricmonk', 'GarlikCrawler', 'BingPreview\/', 'vebidoobot', 'FemtosearchBot', 'Yahoo Link Preview', 'MetaJobBot', 'DomainStatsBot', 'mindUpBot', 'Daum\/', 'Jugendschutzprogramm-Crawler', 'Xenu Link Sleuth', 'Pcore-HTTP', 'moatbot', 'KosmioBot', 'pingdom', 'PhantomJS', 'Gowikibot', 'PiplBot', 'Discordbot', 'TelegramBot', 'Jetslide', 'newsharecounts', 'James BOT', 'Barkrowler', 'TinEye', 'SocialRankIOBot', 'trendictionbot', 'Ocarinabot', 'epicbot', 'Primalbot', 'DuckDuckGo-Favicons-Bot', 'GnowitNewsbot', 'Leikibot', 'LinkArchiver', 'YaK\/', 'PaperLiBot', 'Digg Deeper', 'dcrawl', 'Snacktory', 'AndersPinkBot', 'Fyrebot', 'EveryoneSocialBot', 'Mediatoolkitbot', 'Luminator-robots', 'ExtLinksBot', 'SurveyBot', 'NING\/', 'okhttp', 'Nuzzel', 'omgili', 'PocketParser', 'YisouSpider', 'um-LN', 'ToutiaoSpider', 'MuckRack', "Jamie's Spider", 'AHC\/', 'NetcraftSurveyAgent', 'Laserlikebot', 'Apache-HttpClient', 'AppEngine-Google', 'Jetty', 'Upflow', 'Thinklab', 'Traackr\\.com', 'Twurly', 'Mastodon', 'http_get', 'DnyzBot', 'botify', '007ac9 Crawler', 'BehloolBot', 'BrandVerity', 'check_http', 'BDCbot', 'ZumBot', 'EZID', 'ICC-Crawler', 'ArchiveBot', '^LCC ', 'filterdb\\.iss\\.net\/crawler', 'BLP_bbot', 'BomboraBot', 'Buck\/', 'Companybook-Crawler', 'Genieo', 'magpie-crawler', 'MeltwaterNews', 'Moreover', 'newspaper\/', 'ScoutJet', '(^| )sentry\/', 'StorygizeBot', 'UptimeRobot', 'OutclicksBot', 'seoscanners', 'Hatena', 'Google Web Preview', 'MauiBot', 'AlphaBot', 'SBL-BOT', 'IAS crawler', 'adscanner', 'Netvibes', 'acapbot', 'Baidu-YunGuanCe', 'bitlybot', 'blogmuraBot', 'Bot\\.AraTurka\\.com', 'bot-pge\\.chlooe\\.com', 'BoxcarBot', 'BTWebClient', 'ContextAd Bot', 'Digincore bot', 'Disqus', 'Feedly', 'Fetch\/', 'Fever', 'Flamingo_SearchEngine', 'FlipboardProxy', 'g2reader-bot', 'imrbot', 'K7MLWCBot', 'Kemvibot', 'Landau-Media-Spider', 'linkapediabot', 'vkShare', 'Siteimprove\\.com', 'BLEXBot\/', 'DareBoost', 'ZuperlistBot\/', 'Miniflux\/', 'Feedspotbot\/', 'Diffbot\/', 'SEOkicks', 'tracemyfile', 'Nimbostratus-Bot'];

package/lib/utils/request-queue.js

@@ -96,7 +96,7 @@ var RequestQueue = /*#__PURE__*/function () {
             method: 'GET'
           };
         } // If events older than `requestTTL` exist in queue, clear request queue
-        // - Prevents issue where stale items are sent in perputity
+        // - Prevents issue where stale items are sent in perpetuity
         // - No request should go unsent for longer than `requestTTL`
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.29.11",
+  "version": "2.29.13",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {
@@ -40,6 +40,7 @@
     "@babel/plugin-transform-runtime": "^7.16.4",
     "@babel/preset-env": "^7.15.8",
     "@babel/register": "^7.15.3",
+    "@cspell/eslint-plugin": "^6.8.2",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "dotenv": "^8.6.0",
@@ -67,5 +68,8 @@
     "fetch-ponyfill": "^7.1.0",
     "qs": "6.7.2",
     "store2": "^2.9.0"
+  },
+  "peerDependencies": {
+    "@babel/runtime": "^7.19.0"
   }
 }