@constructor-io/constructorio-client-javascript 2.35.1 → 2.35.3
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.
package/lib/modules/browse.js
CHANGED
|
@@ -242,7 +242,7 @@ var Browse = /*#__PURE__*/function () {
|
|
|
242
242
|
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
|
|
243
243
|
* @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
|
|
244
244
|
* @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
|
|
245
|
-
* @param {object} [parameters.
|
|
245
|
+
* @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/browse/queries/
|
|
246
246
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
247
247
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
248
248
|
* @returns {Promise}
|
package/lib/modules/quizzes.js
CHANGED
|
@@ -74,7 +74,7 @@ function createQuizUrl(quizId, parameters, options, path) {
|
|
|
74
74
|
} // Pull a (answers) from parameters and transform
|
|
75
75
|
|
|
76
76
|
|
|
77
|
-
if (answers) {
|
|
77
|
+
if (answers && answers.length) {
|
|
78
78
|
answersParamString = "&".concat(helpers.stringify({
|
|
79
79
|
a: answers.map(function (ans) {
|
|
80
80
|
return (0, _toConsumableArray2["default"])(ans).join(',');
|
package/lib/modules/search.js
CHANGED
|
@@ -186,7 +186,7 @@ var Search = /*#__PURE__*/function () {
|
|
|
186
186
|
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
|
|
187
187
|
* @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
|
|
188
188
|
* @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
|
|
189
|
-
* @param {object} [parameters.
|
|
189
|
+
* @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries/
|
|
190
190
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
191
191
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
192
192
|
* @returns {Promise}
|
|
@@ -274,7 +274,7 @@ var Search = /*#__PURE__*/function () {
|
|
|
274
274
|
* @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
|
|
275
275
|
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
|
|
276
276
|
* @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
|
|
277
|
-
* @param {object} [parameters.
|
|
277
|
+
* @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries/
|
|
278
278
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
279
279
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
280
280
|
* @returns {Promise}
|
package/lib/types/browse.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ import {
|
|
|
4
4
|
Facet,
|
|
5
5
|
Feature,
|
|
6
6
|
FilterExpression,
|
|
7
|
+
FmtOptions,
|
|
7
8
|
Group,
|
|
8
9
|
NetworkParameters,
|
|
9
10
|
RequestFeature,
|
|
@@ -23,12 +24,12 @@ export interface IBrowseParameters {
|
|
|
23
24
|
sortBy?: string;
|
|
24
25
|
sortOrder?: string;
|
|
25
26
|
section?: string;
|
|
26
|
-
fmtOptions?:
|
|
27
|
+
fmtOptions?: FmtOptions;
|
|
27
28
|
preFilterExpression: FilterExpression;
|
|
28
29
|
hiddenFields?: string[];
|
|
29
30
|
hiddenFacets?: string[];
|
|
30
31
|
variationsMap?: Record<string, any>;
|
|
31
|
-
|
|
32
|
+
qsParam?: Record<string, any>;
|
|
32
33
|
}
|
|
33
34
|
|
|
34
35
|
declare class Browse {
|
package/lib/types/index.d.ts
CHANGED
|
@@ -96,11 +96,6 @@ export interface Feature extends Record<string, any> {
|
|
|
96
96
|
} | null;
|
|
97
97
|
}
|
|
98
98
|
|
|
99
|
-
export interface FmtOption extends Record<string, any> {
|
|
100
|
-
groups_start: string;
|
|
101
|
-
groups_max_depth: number;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
99
|
export type Facet = RangeFacet | OptionFacet;
|
|
105
100
|
|
|
106
101
|
export interface BaseFacet extends Record<string, any> {
|
|
@@ -149,7 +144,10 @@ export interface BaseGroup extends Record<string, any> {
|
|
|
149
144
|
group_id: string;
|
|
150
145
|
}
|
|
151
146
|
|
|
152
|
-
export interface FmtOptions extends Record<string, any> {
|
|
147
|
+
export interface FmtOptions extends Record<string, any> {
|
|
148
|
+
groups_max_depth?: number;
|
|
149
|
+
groups_start?: 'current' | 'top';
|
|
150
|
+
}
|
|
153
151
|
|
|
154
152
|
export type Nullable<T> = T | null;
|
|
155
153
|
|
package/lib/types/quizzes.d.ts
CHANGED
|
@@ -50,7 +50,7 @@ declare class Quizzes {
|
|
|
50
50
|
export interface NextQuestionResponse extends Record<string, any> {
|
|
51
51
|
next_question: Question;
|
|
52
52
|
is_last_question?: boolean;
|
|
53
|
-
|
|
53
|
+
quiz_version_id?: string;
|
|
54
54
|
quiz_id?: string;
|
|
55
55
|
quiz_session_id?: string;
|
|
56
56
|
}
|
package/lib/types/search.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import {
|
|
|
3
3
|
Facet,
|
|
4
4
|
Feature,
|
|
5
5
|
FilterExpression,
|
|
6
|
-
|
|
6
|
+
FmtOptions,
|
|
7
7
|
Group,
|
|
8
8
|
NetworkParameters,
|
|
9
9
|
RequestFeature,
|
|
@@ -23,11 +23,12 @@ export interface SearchParameters {
|
|
|
23
23
|
sortBy?: string;
|
|
24
24
|
sortOrder?: string;
|
|
25
25
|
section?: string;
|
|
26
|
-
fmtOptions?:
|
|
26
|
+
fmtOptions?: FmtOptions;
|
|
27
27
|
preFilterExpression: FilterExpression;
|
|
28
28
|
hiddenFields?: string[];
|
|
29
29
|
hiddenFacets?: string[];
|
|
30
30
|
variationsMap?: Record<string, any>;
|
|
31
|
+
qsParam?: Record<string, any>;
|
|
31
32
|
}
|
|
32
33
|
declare class Search {
|
|
33
34
|
constructor(options: ConstructorClientOptions);
|
|
@@ -75,7 +76,7 @@ export interface SearchRequestType extends Record<string, any> {
|
|
|
75
76
|
section: string;
|
|
76
77
|
blacklist_rules: boolean;
|
|
77
78
|
term: string;
|
|
78
|
-
fmt_options:
|
|
79
|
+
fmt_options: FmtOptions;
|
|
79
80
|
sort_by: string;
|
|
80
81
|
sort_order: string;
|
|
81
82
|
features: Partial<RequestFeature>;
|