@constructor-io/constructorio-client-javascript 2.44.0 → 2.45.0

package/lib/modules/recommendations.js

@@ -44,7 +44,8 @@ function createRecommendationsUrl(podId, parameters, options) {
       term = parameters.term,
       filters = parameters.filters,
       variationsMap = parameters.variationsMap,
-      hiddenFields = parameters.hiddenFields;
+      hiddenFields = parameters.hiddenFields,
+      preFilterExpression = parameters.preFilterExpression;
 
     // Pull num results number from parameters
     if (!helpers.isNil(numResults)) {
@@ -86,6 +87,11 @@ function createRecommendationsUrl(podId, parameters, options) {
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
     }
+
+    // Pull pre_filter_expression from parameters
+    if (preFilterExpression) {
+      queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
+    }
   }
   queryParams = helpers.cleanParams(queryParams);
   var queryString = helpers.stringify(queryParams);
@@ -119,6 +125,7 @@ var Recommendations = /*#__PURE__*/function () {
    * @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
    * @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} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections#add-items-dynamically
    * @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

@@ -1054,7 +1054,11 @@ var Tracker = /*#__PURE__*/function () {
      *
      * @function trackPurchase
      * @param {object} parameters - Additional parameters to be sent with request
-     * @param {object[]} parameters.items - List of product item objects
+     * @param {Array.<{itemId: string | undefined,
+     * variationId: string | undefined,
+     * itemName: string | undefined,
+     * count: number | undefined,
+     * price: number | undefined}>} parameters.items - List of product item objects
      * @param {number} parameters.revenue - The subtotal (excluding taxes, shipping, etc.) of the entire order
      * @param {string} [parameters.orderId] - Unique order identifier
      * @param {string} [parameters.section="Products"] - Index section
@@ -1066,7 +1070,7 @@ var Tracker = /*#__PURE__*/function () {
      * @example
      * constructorio.tracker.trackPurchase(
      *     {
-     *         items: [{ itemId: 'KMH876' }, { itemId: 'KMH140' }],
+     *         items: [{ itemId: 'KMH876', price: 1, count: 1}, { itemId: 'KMH140', price: 1, count: 1s }],
      *         revenue: 12.00,
      *         orderId: 'OUNXBG2HMA',
      *         section: 'Products',

package/lib/types/index.d.ts

@@ -231,3 +231,8 @@ export interface ItemTracked {
   itemId?: string;
   variationId?: string;
 }
+
+export interface ItemTrackedPurchase extends ItemTracked {
+  count?: number;
+  price?: number;
+}

package/lib/types/tracker.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter = require('events');
-import { ConstructorClientOptions, ItemTracked, NetworkParameters } from '.';
+import { ConstructorClientOptions, ItemTracked, ItemTrackedPurchase, NetworkParameters } from '.';
 import RequestQueue = require('../utils/request-queue');
 
 export default Tracker;
@@ -114,7 +114,7 @@ declare class Tracker {
 
   trackPurchase(
     parameters: {
-      items: ItemTracked & {quantity: number}[];
+      items: ItemTrackedPurchase[];
       revenue: number;
       orderId?: string;
       section?: string;

package/package.json

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