@constructor-io/constructorio-node 3.8.9 → 3.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/src/modules/autocomplete.js +7 -1
  3. package/src/modules/browse.js +8 -0
  4. package/src/modules/recommendations.js +7 -1
  5. package/src/modules/search.js +7 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@constructor-io/constructorio-node",
3
- "version": "3.8.9",
3
+ "version": "3.9.0",
4
4
  "description": "Constructor.io Node.js client",
5
5
  "main": "src/constructorio.js",
6
6
  "scripts": {
package/src/modules/autocomplete.js CHANGED
@@ -47,7 +47,7 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
47
47
  }
48
48
 
49
49
  if (parameters) {
50
- const { numResults, resultsPerSection, filters, hiddenFields } = parameters;
50
+ const { numResults, resultsPerSection, filters, hiddenFields, variationsMap } = parameters;
51
51
 
52
52
  // Pull results number from parameters
53
53
  if (numResults) {
@@ -74,6 +74,11 @@ function createAutocompleteUrl(query, parameters, userParameters, options) {
74
74
  queryParams.fmt_options = { hidden_fields: hiddenFields };
75
75
  }
76
76
  }
77
+
78
+ // Pull variations map from parameters
79
+ if (variationsMap) {
80
+ queryParams.variations_map = JSON.stringify(variationsMap);
81
+ }
77
82
  }
78
83
 
79
84
  queryParams._dt = Date.now();
@@ -106,6 +111,7 @@ class Autocomplete {
106
111
  * @param {object} [parameters.filters] - Filters used to refine search
107
112
  * @param {object} [parameters.resultsPerSection] - Number of results to return (value) per section (key)
108
113
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
114
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
109
115
  * @param {object} [userParameters] - Parameters relevant to the user request
110
116
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
111
117
  * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
package/src/modules/browse.js CHANGED
@@ -34,6 +34,7 @@ function createQueryParams(parameters, userParameters, options) {
34
34
  fmtOptions,
35
35
  hiddenFields,
36
36
  hiddenFacets,
37
+ variationsMap,
37
38
  } = parameters;
38
39
 
39
40
  // Pull page from parameters
@@ -87,6 +88,11 @@ function createQueryParams(parameters, userParameters, options) {
87
88
  queryParams.fmt_options = { hidden_facets: hiddenFacets };
88
89
  }
89
90
  }
91
+
92
+ // Pull variations map from parameters
93
+ if (variationsMap) {
94
+ queryParams.variations_map = JSON.stringify(variationsMap);
95
+ }
90
96
  }
91
97
 
92
98
  // Pull test cells from options
@@ -227,6 +233,7 @@ class Browse {
227
233
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
228
234
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
229
235
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
236
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
230
237
  * @param {object} [userParameters] - Parameters relevant to the user request
231
238
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
232
239
  * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -310,6 +317,7 @@ class Browse {
310
317
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
311
318
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
312
319
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
320
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
313
321
  * @param {object} [userParameters] - Parameters relevant to the user request
314
322
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
315
323
  * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
package/src/modules/recommendations.js CHANGED
@@ -39,7 +39,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
39
39
  }
40
40
 
41
41
  if (parameters) {
42
- const { numResults, itemIds, section, term, filters } = parameters;
42
+ const { numResults, itemIds, section, term, filters, variationsMap } = parameters;
43
43
 
44
44
  // Pull num results number from parameters
45
45
  if (!helpers.isNil(numResults)) {
@@ -65,6 +65,11 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
65
65
  if (filters) {
66
66
  queryParams.filters = filters;
67
67
  }
68
+
69
+ // Pull variations map from parameters
70
+ if (variationsMap) {
71
+ queryParams.variations_map = JSON.stringify(variationsMap);
72
+ }
68
73
  }
69
74
 
70
75
  queryParams = helpers.cleanParams(queryParams);
@@ -97,6 +102,7 @@ class Recommendations {
97
102
  * @param {string} [parameters.section] - The section to return results from
98
103
  * @param {string} [parameters.term] - The term to use to refine results (strategy specific)
99
104
  * @param {object} [parameters.filters] - Filters used to refine results (strategy specific)
105
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
100
106
  * @param {object} [userParameters] - Parameters relevant to the user request
101
107
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
102
108
  * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
package/src/modules/search.js CHANGED
@@ -57,6 +57,7 @@ function createSearchUrl(query, parameters, userParameters, options) {
57
57
  fmtOptions,
58
58
  hiddenFields,
59
59
  hiddenFacets,
60
+ variationsMap,
60
61
  } = parameters;
61
62
 
62
63
  // Pull page from parameters
@@ -111,6 +112,11 @@ function createSearchUrl(query, parameters, userParameters, options) {
111
112
  queryParams.fmt_options = { hidden_facets: hiddenFacets };
112
113
  }
113
114
  }
115
+
116
+ // Pull variations map from parameters
117
+ if (variationsMap) {
118
+ queryParams.variations_map = JSON.stringify(variationsMap);
119
+ }
114
120
  }
115
121
 
116
122
  queryParams._dt = Date.now();
@@ -148,6 +154,7 @@ class Search {
148
154
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
149
155
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
150
156
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
157
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
151
158
  * @param {object} [userParameters] - Parameters relevant to the user request
152
159
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
153
160
  * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results