@constructor-io/constructorio-client-javascript 2.64.3 → 2.65.1

package/README.md

@@ -21,7 +21,7 @@ Alternatively, a bundled version consisting of a single JavaScript file is publi
 
 ## 2. Retrieve an API key
 
-You can find this in your [Constructor.io dashboard](https://constructor.io/dashboard). Contact sales if you'd like to sign up, or support if you believe your company already has an account.
+You can find this in your [Constructor.io dashboard](https://app.constructor.io/dashboard). Contact sales if you'd like to sign up, or support if you believe your company already has an account.
 
 ## 3. Implement the Client
 

package/lib/modules/browse.js

@@ -4,8 +4,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 /* eslint-disable object-curly-newline, no-underscore-dangle, max-len, complexity */
 var EventDispatcher = require('../utils/event-dispatcher');
 var helpers = require('../utils/helpers');

package/lib/modules/quizzes.js

@@ -75,7 +75,7 @@ function createQuizUrl(quizId, parameters, options, path) {
     if (answers && answers.length) {
       answersParamString = "&".concat(helpers.stringify({
         a: answers.map(function (ans) {
-          return (0, _toConsumableArray2["default"])(ans).join(',');
+          return (0, _toConsumableArray2["default"])(ans.map(encodeURIComponent)).join(',');
         })
       }));
     }

package/lib/modules/recommendations.js

@@ -45,7 +45,8 @@ function createRecommendationsUrl(podId, parameters, options) {
       filters = parameters.filters,
       variationsMap = parameters.variationsMap,
       hiddenFields = parameters.hiddenFields,
-      preFilterExpression = parameters.preFilterExpression;
+      preFilterExpression = parameters.preFilterExpression,
+      fmtOptions = parameters.fmtOptions;
 
     // Pull num results number from parameters
     if (!helpers.isNil(numResults)) {
@@ -72,6 +73,11 @@ function createRecommendationsUrl(podId, parameters, options) {
       queryParams.filters = filters;
     }
 
+    // Pull format options from parameters
+    if (fmtOptions) {
+      queryParams.fmt_options = fmtOptions;
+    }
+
     // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
@@ -126,6 +132,7 @@ var Recommendations = /*#__PURE__*/function () {
    * @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.com/reference/shared-variations-mapping for details
    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
+   * @param {object} [parameters.fmtOptions] - An object containing options to format different aspects of the response. Please refer to https://docs.constructor.com/reference/v1-recommendations-get-pod-results for details
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)

package/lib/modules/tracker.js

@@ -5,8 +5,8 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 /* eslint-disable max-depth */
 /* eslint-disable complexity */
 /* eslint-disable max-len */
@@ -1179,6 +1179,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.resultId] - Recommendation result identifier (returned in response from Constructor)
      * @param {string} [parameters.section="Products"] - Results section
      * @param {object} [parameters.analyticsTags] - Pass additional analytics data
+     * @param {string[]|string|number} [parameters.seedItemIds] - Item ID(s) to be used as seed
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -1221,6 +1222,7 @@ var Tracker = /*#__PURE__*/function () {
           numResultsViewed = _parameters$numResult3 === void 0 ? num_results_viewed : _parameters$numResult3,
           items = parameters.items,
           analyticsTags = parameters.analyticsTags,
+          seedItemIds = parameters.seedItemIds,
           _parameters$resultCou3 = parameters.resultCount,
           resultCount = _parameters$resultCou3 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou3;
         if (!helpers.isNil(resultCount)) {
@@ -1254,6 +1256,13 @@ var Tracker = /*#__PURE__*/function () {
         if (analyticsTags) {
           bodyParams.analytics_tags = analyticsTags;
         }
+        if (typeof seedItemIds === 'number') {
+          bodyParams.seed_item_ids = [String(seedItemIds)];
+        } else if (seedItemIds !== null && seedItemIds !== void 0 && seedItemIds.length && typeof seedItemIds === 'string') {
+          bodyParams.seed_item_ids = [seedItemIds];
+        } else if (seedItemIds !== null && seedItemIds !== void 0 && seedItemIds.length && Array.isArray(seedItemIds)) {
+          bodyParams.seed_item_ids = seedItemIds;
+        }
         var requestURL = "".concat(requestPath).concat(applyParamsAsString({}, this.options));
         var requestMethod = 'POST';
         var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {

package/lib/types/quizzes.d.ts

@@ -115,7 +115,7 @@ export interface QuizResultData extends Record<string, any> {
   variations: Record<string, any>[];
 }
 
-export type Question = SelectQuestion | OpenQuestion | CoverQuestion;
+export type Question = SelectQuestion | FilterValueQuestion | OpenQuestion | CoverQuestion;
 
 export interface BaseQuestion extends Record<string, any> {
   id: number;
@@ -125,6 +125,12 @@ export interface BaseQuestion extends Record<string, any> {
   images?: Nullable<QuestionImages>;
 }
 
+export interface FilterValueQuestion extends BaseQuestion {
+  type: 'single_filter_value' |'multiple_filter_values';
+  filter_name: string;
+  options: QuestionOption[];
+}
+
 export interface SelectQuestion extends BaseQuestion {
   type: 'single' | 'multiple';
   options: QuestionOption[];

package/lib/types/recommendations.d.ts

@@ -1,4 +1,4 @@
-import { ConstructorClientOptions, NetworkParameters, VariationsMap, FilterExpression } from '.';
+import { ConstructorClientOptions, NetworkParameters, VariationsMap, FilterExpression, FmtOptions } from '.';
 import EventDispatcher from './event-dispatcher';
 
 export default Recommendations;
@@ -12,6 +12,7 @@ export interface RecommendationsParameters {
   variationsMap?: VariationsMap;
   hiddenFields?: string[];
   preFilterExpression?: FilterExpression;
+  fmtOptions?: FmtOptions;
 }
 
 declare class Recommendations {

package/lib/version.js

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

package/package.json

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