algoliasearch 5.1.0 → 5.2.1

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 (146) hide show
  1. package/README.md +2 -2
  2. package/builds/browser.ts +15 -48
  3. package/builds/models.ts +2 -2
  4. package/builds/node.ts +19 -58
  5. package/dist/algoliasearch/builds/browser.d.ts +13 -13
  6. package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
  7. package/dist/algoliasearch/builds/models.d.ts +2 -2
  8. package/dist/algoliasearch/builds/models.d.ts.map +1 -1
  9. package/dist/algoliasearch/builds/node.d.ts +15 -15
  10. package/dist/algoliasearch/builds/node.d.ts.map +1 -1
  11. package/dist/algoliasearch.cjs +40 -70
  12. package/dist/algoliasearch.esm.browser.js +46 -75
  13. package/dist/algoliasearch.esm.node.js +40 -70
  14. package/dist/algoliasearch.umd.js +2 -2
  15. package/dist/client-abtesting/model/aBTest.d.ts +5 -5
  16. package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
  17. package/dist/client-abtesting/model/clientMethodProps.d.ts +2 -2
  18. package/dist/client-abtesting/model/clientMethodProps.d.ts.map +1 -1
  19. package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
  20. package/dist/client-abtesting/model/customSearchParams.d.ts.map +1 -1
  21. package/dist/client-abtesting/model/effect.d.ts.map +1 -1
  22. package/dist/client-abtesting/model/variant.d.ts +5 -5
  23. package/dist/client-abtesting/model/variant.d.ts.map +1 -1
  24. package/dist/client-abtesting/src/abtestingClient.d.ts +5 -5
  25. package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
  26. package/dist/client-analytics/model/clientMethodProps.d.ts +2 -2
  27. package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
  28. package/dist/client-analytics/model/{currenciesValue.d.ts → currencyCode.d.ts} +2 -2
  29. package/dist/client-analytics/model/currencyCode.d.ts.map +1 -0
  30. package/dist/client-analytics/model/dailyRevenue.d.ts +2 -2
  31. package/dist/client-analytics/model/dailyRevenue.d.ts.map +1 -1
  32. package/dist/client-analytics/model/getRevenue.d.ts +2 -2
  33. package/dist/client-analytics/model/getRevenue.d.ts.map +1 -1
  34. package/dist/client-analytics/model/getTopHitsResponse.d.ts.map +1 -1
  35. package/dist/client-analytics/model/index.d.ts +1 -1
  36. package/dist/client-analytics/model/index.d.ts.map +1 -1
  37. package/dist/client-analytics/model/orderBy.d.ts.map +1 -1
  38. package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts +2 -2
  39. package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts.map +1 -1
  40. package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts +2 -2
  41. package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts.map +1 -1
  42. package/dist/client-analytics/src/analyticsClient.d.ts +11 -11
  43. package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
  44. package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
  45. package/dist/client-personalization/model/clientMethodProps.d.ts.map +1 -1
  46. package/dist/client-personalization/model/getUserTokenResponse.d.ts +1 -1
  47. package/dist/client-personalization/model/getUserTokenResponse.d.ts.map +1 -1
  48. package/dist/client-personalization/src/personalizationClient.d.ts +5 -5
  49. package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
  50. package/dist/client-search/model/alternativesAsExact.d.ts.map +1 -1
  51. package/dist/client-search/model/baseIndexSettings.d.ts +2 -2
  52. package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
  53. package/dist/client-search/model/baseSearchResponse.d.ts +4 -4
  54. package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
  55. package/dist/client-search/model/batchRequest.d.ts +1 -1
  56. package/dist/client-search/model/batchRequest.d.ts.map +1 -1
  57. package/dist/client-search/model/browseResponse.d.ts.map +1 -1
  58. package/dist/client-search/model/clientMethodProps.d.ts +5 -6
  59. package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
  60. package/dist/client-search/model/consequenceParams.d.ts.map +1 -1
  61. package/dist/{lite/model/facetsStats.d.ts → client-search/model/facetStats.d.ts} +2 -2
  62. package/dist/client-search/model/facetStats.d.ts.map +1 -0
  63. package/dist/client-search/model/index.d.ts +1 -1
  64. package/dist/client-search/model/index.d.ts.map +1 -1
  65. package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
  66. package/dist/client-search/model/multipleBatchRequest.d.ts.map +1 -1
  67. package/dist/client-search/model/removeWordsIfNoResults.d.ts.map +1 -1
  68. package/dist/client-search/model/searchResponse.d.ts.map +1 -1
  69. package/dist/client-search/model/searchResult.d.ts.map +1 -1
  70. package/dist/client-search/model/synonymType.d.ts.map +1 -1
  71. package/dist/client-search/src/searchClient.d.ts +16 -16
  72. package/dist/client-search/src/searchClient.d.ts.map +1 -1
  73. package/dist/lite/builds/browser.d.ts +1 -1
  74. package/dist/lite/builds/browser.d.ts.map +1 -1
  75. package/dist/lite/builds/node.d.ts +1 -1
  76. package/dist/lite/builds/node.d.ts.map +1 -1
  77. package/dist/lite/lite.cjs +2 -5
  78. package/dist/lite/lite.esm.browser.js +11 -15
  79. package/dist/lite/lite.esm.node.js +2 -5
  80. package/dist/lite/lite.umd.js +2 -2
  81. package/dist/lite/model/alternativesAsExact.d.ts.map +1 -1
  82. package/dist/lite/model/baseIndexSettings.d.ts +2 -2
  83. package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
  84. package/dist/lite/model/baseSearchResponse.d.ts +4 -4
  85. package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
  86. package/dist/lite/model/boughtTogetherQuery.d.ts.map +1 -1
  87. package/dist/lite/model/browseResponse.d.ts.map +1 -1
  88. package/dist/lite/model/clientMethodProps.d.ts +1 -1
  89. package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
  90. package/dist/lite/model/consequenceParams.d.ts.map +1 -1
  91. package/dist/{client-search/model/facetsStats.d.ts → lite/model/facetStats.d.ts} +2 -2
  92. package/dist/lite/model/facetStats.d.ts.map +1 -0
  93. package/dist/lite/model/fallbackParams.d.ts +1 -1
  94. package/dist/lite/model/fallbackParams.d.ts.map +1 -1
  95. package/dist/lite/model/index.d.ts +1 -1
  96. package/dist/lite/model/index.d.ts.map +1 -1
  97. package/dist/lite/model/recommendationsResults.d.ts.map +1 -1
  98. package/dist/lite/model/removeWordsIfNoResults.d.ts.map +1 -1
  99. package/dist/lite/model/searchParams.d.ts +1 -1
  100. package/dist/lite/model/searchParams.d.ts.map +1 -1
  101. package/dist/lite/model/searchResponse.d.ts.map +1 -1
  102. package/dist/lite/model/searchResult.d.ts.map +1 -1
  103. package/dist/lite/src/liteClient.d.ts +2 -2
  104. package/dist/lite/src/liteClient.d.ts.map +1 -1
  105. package/dist/recommend/model/alternativesAsExact.d.ts.map +1 -1
  106. package/dist/recommend/model/baseSearchResponse.d.ts +4 -4
  107. package/dist/recommend/model/baseSearchResponse.d.ts.map +1 -1
  108. package/dist/recommend/model/boughtTogetherQuery.d.ts.map +1 -1
  109. package/dist/recommend/model/clientMethodProps.d.ts +2 -2
  110. package/dist/recommend/model/clientMethodProps.d.ts.map +1 -1
  111. package/dist/recommend/model/{facetsStats.d.ts → facetStats.d.ts} +2 -2
  112. package/dist/recommend/model/facetStats.d.ts.map +1 -0
  113. package/dist/recommend/model/fallbackParams.d.ts +1 -1
  114. package/dist/recommend/model/fallbackParams.d.ts.map +1 -1
  115. package/dist/recommend/model/index.d.ts +1 -1
  116. package/dist/recommend/model/index.d.ts.map +1 -1
  117. package/dist/recommend/model/recommendModels.d.ts.map +1 -1
  118. package/dist/recommend/model/recommendationsResults.d.ts.map +1 -1
  119. package/dist/recommend/model/removeWordsIfNoResults.d.ts.map +1 -1
  120. package/dist/recommend/model/searchParams.d.ts +1 -1
  121. package/dist/recommend/model/searchParams.d.ts.map +1 -1
  122. package/dist/recommend/src/recommendClient.d.ts +6 -6
  123. package/dist/recommend/src/recommendClient.d.ts.map +1 -1
  124. package/lite/builds/browser.ts +2 -9
  125. package/lite/builds/node.ts +1 -5
  126. package/lite/model/alternativesAsExact.ts +1 -4
  127. package/lite/model/baseIndexSettings.ts +2 -2
  128. package/lite/model/baseSearchResponse.ts +4 -4
  129. package/lite/model/boughtTogetherQuery.ts +1 -2
  130. package/lite/model/browseResponse.ts +1 -4
  131. package/lite/model/clientMethodProps.ts +1 -1
  132. package/lite/model/consequenceParams.ts +1 -3
  133. package/lite/model/{facetsStats.ts → facetStats.ts} +1 -1
  134. package/lite/model/fallbackParams.ts +1 -1
  135. package/lite/model/index.ts +1 -1
  136. package/lite/model/recommendationsResults.ts +1 -3
  137. package/lite/model/removeWordsIfNoResults.ts +1 -5
  138. package/lite/model/searchParams.ts +1 -1
  139. package/lite/model/searchResponse.ts +1 -3
  140. package/lite/model/searchResult.ts +1 -3
  141. package/lite/src/liteClient.ts +17 -40
  142. package/package.json +20 -16
  143. package/dist/client-analytics/model/currenciesValue.d.ts.map +0 -1
  144. package/dist/client-search/model/facetsStats.d.ts.map +0 -1
  145. package/dist/lite/model/facetsStats.d.ts.map +0 -1
  146. package/dist/recommend/model/facetsStats.d.ts.map +0 -1
@@ -1,11 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import {
4
- createAuth,
5
- createTransporter,
6
- getAlgoliaAgent,
7
- shuffle,
8
- } from '@algolia/client-common';
3
+ import { createAuth, createTransporter, getAlgoliaAgent, shuffle } from '@algolia/client-common';
9
4
  import type {
10
5
  CreateClientOptions,
11
6
  Headers,
@@ -27,7 +22,7 @@ import type { SearchMethodParams } from '../model/searchMethodParams';
27
22
  import type { SearchResponse } from '../model/searchResponse';
28
23
  import type { SearchResponses } from '../model/searchResponses';
29
24
 
30
- export const apiClientVersion = '5.1.0';
25
+ export const apiClientVersion = '5.2.1';
31
26
 
32
27
  function getDefaultHosts(appId: string): Host[] {
33
28
  return (
@@ -60,7 +55,7 @@ function getDefaultHosts(appId: string): Host[] {
60
55
  accept: 'readWrite',
61
56
  protocol: 'https',
62
57
  },
63
- ])
58
+ ]),
64
59
  );
65
60
  }
66
61
 
@@ -104,10 +99,7 @@ export function createLiteClient({
104
99
  * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
105
100
  */
106
101
  clearCache(): Promise<void> {
107
- return Promise.all([
108
- transporter.requestsCache.clear(),
109
- transporter.responsesCache.clear(),
110
- ]).then(() => undefined);
102
+ return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => undefined);
111
103
  },
112
104
 
113
105
  /**
@@ -126,7 +118,6 @@ export function createLiteClient({
126
118
  addAlgoliaAgent(segment: string, version?: string): void {
127
119
  transporter.algoliaAgent.add({ segment, version });
128
120
  },
129
-
130
121
  /**
131
122
  * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
132
123
  * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
@@ -137,11 +128,9 @@ export function createLiteClient({
137
128
  */
138
129
  searchForHits<T>(
139
130
  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
140
- requestOptions?: RequestOptions
131
+ requestOptions?: RequestOptions,
141
132
  ): Promise<{ results: Array<SearchResponse<T>> }> {
142
- return this.search(searchMethodParams, requestOptions) as Promise<{
143
- results: Array<SearchResponse<T>>;
144
- }>;
133
+ return this.search(searchMethodParams, requestOptions) as Promise<{ results: Array<SearchResponse<T>> }>;
145
134
  },
146
135
 
147
136
  /**
@@ -154,7 +143,7 @@ export function createLiteClient({
154
143
  */
155
144
  searchForFacets(
156
145
  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
157
- requestOptions?: RequestOptions
146
+ requestOptions?: RequestOptions,
158
147
  ): Promise<{ results: SearchForFacetValuesResponse[] }> {
159
148
  return this.search(searchMethodParams, requestOptions) as Promise<{
160
149
  results: SearchForFacetValuesResponse[];
@@ -171,12 +160,10 @@ export function createLiteClient({
171
160
  */
172
161
  customPost(
173
162
  { path, parameters, body }: CustomPostProps,
174
- requestOptions?: RequestOptions
175
- ): Promise<Record<string, any>> {
163
+ requestOptions?: RequestOptions,
164
+ ): Promise<Record<string, unknown>> {
176
165
  if (!path) {
177
- throw new Error(
178
- 'Parameter `path` is required when calling `customPost`.'
179
- );
166
+ throw new Error('Parameter `path` is required when calling `customPost`.');
180
167
  }
181
168
 
182
169
  const requestPath = '/{path}'.replace('{path}', path);
@@ -204,10 +191,8 @@ export function createLiteClient({
204
191
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
205
192
  */
206
193
  getRecommendations(
207
- getRecommendationsParams:
208
- | GetRecommendationsParams
209
- | LegacyGetRecommendationsParams,
210
- requestOptions?: RequestOptions
194
+ getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams,
195
+ requestOptions?: RequestOptions,
211
196
  ): Promise<GetRecommendationsResponse> {
212
197
  if (getRecommendationsParams && Array.isArray(getRecommendationsParams)) {
213
198
  const newSignatureRequest: GetRecommendationsParams = {
@@ -219,15 +204,11 @@ export function createLiteClient({
219
204
  }
220
205
 
221
206
  if (!getRecommendationsParams) {
222
- throw new Error(
223
- 'Parameter `getRecommendationsParams` is required when calling `getRecommendations`.'
224
- );
207
+ throw new Error('Parameter `getRecommendationsParams` is required when calling `getRecommendations`.');
225
208
  }
226
209
 
227
210
  if (!getRecommendationsParams.requests) {
228
- throw new Error(
229
- 'Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.'
230
- );
211
+ throw new Error('Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.');
231
212
  }
232
213
 
233
214
  const requestPath = '/1/indexes/*/recommendations';
@@ -258,7 +239,7 @@ export function createLiteClient({
258
239
  */
259
240
  search<T>(
260
241
  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
261
- requestOptions?: RequestOptions
242
+ requestOptions?: RequestOptions,
262
243
  ): Promise<SearchResponses<T>> {
263
244
  if (searchMethodParams && Array.isArray(searchMethodParams)) {
264
245
  const newSignatureRequest: SearchMethodParams = {
@@ -286,15 +267,11 @@ export function createLiteClient({
286
267
  }
287
268
 
288
269
  if (!searchMethodParams) {
289
- throw new Error(
290
- 'Parameter `searchMethodParams` is required when calling `search`.'
291
- );
270
+ throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
292
271
  }
293
272
 
294
273
  if (!searchMethodParams.requests) {
295
- throw new Error(
296
- 'Parameter `searchMethodParams.requests` is required when calling `search`.'
297
- );
274
+ throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
298
275
  }
299
276
 
300
277
  const requestPath = '/1/indexes/*/queries';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "algoliasearch",
3
- "version": "5.1.0",
3
+ "version": "5.2.1",
4
4
  "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -16,13 +16,15 @@
16
16
  "import": "./dist/algoliasearch.esm.node.js",
17
17
  "module": "./dist/algoliasearch.esm.node.js",
18
18
  "require": "./dist/algoliasearch.cjs",
19
- "default": "./dist/algoliasearch.cjs"
19
+ "default": "./dist/algoliasearch.cjs",
20
+ "types": "./dist/algoliasearch/builds/node.d.ts"
20
21
  },
21
22
  "default": {
22
23
  "umd": "./dist/algoliasearch.umd.js",
23
24
  "module": "./dist/algoliasearch.esm.browser.js",
24
25
  "import": "./dist/algoliasearch.esm.browser.js",
25
- "default": "./dist/algoliasearch.umd.js"
26
+ "default": "./dist/algoliasearch.umd.js",
27
+ "types": "./dist/algoliasearch/builds/browser.d.ts"
26
28
  }
27
29
  },
28
30
  "./lite": {
@@ -31,13 +33,15 @@
31
33
  "import": "./dist/lite/lite.esm.node.js",
32
34
  "module": "./dist/lite/lite.esm.node.js",
33
35
  "require": "./dist/lite/lite.cjs",
34
- "default": "./dist/lite/lite.cjs"
36
+ "default": "./dist/lite/lite.cjs",
37
+ "types": "./dist/lite/builds/node.d.ts"
35
38
  },
36
39
  "default": {
37
40
  "umd": "./dist/lite/lite.umd.js",
38
41
  "module": "./dist/lite/lite.esm.browser.js",
39
42
  "import": "./dist/lite/lite.esm.browser.js",
40
- "default": "./dist/lite/lite.umd.js"
43
+ "default": "./dist/lite/lite.umd.js",
44
+ "types": "./dist/lite/builds/browser.d.ts"
41
45
  }
42
46
  }
43
47
  },
@@ -63,22 +67,22 @@
63
67
  "test": "jest"
64
68
  },
65
69
  "dependencies": {
66
- "@algolia/client-abtesting": "5.1.0",
67
- "@algolia/client-analytics": "5.1.0",
68
- "@algolia/client-common": "5.1.0",
69
- "@algolia/client-personalization": "5.1.0",
70
- "@algolia/client-search": "5.1.0",
71
- "@algolia/recommend": "5.1.0",
72
- "@algolia/requester-browser-xhr": "5.1.0",
73
- "@algolia/requester-node-http": "5.1.0"
70
+ "@algolia/client-abtesting": "5.2.1",
71
+ "@algolia/client-analytics": "5.2.1",
72
+ "@algolia/client-common": "5.2.1",
73
+ "@algolia/client-personalization": "5.2.1",
74
+ "@algolia/client-search": "5.2.1",
75
+ "@algolia/recommend": "5.2.1",
76
+ "@algolia/requester-browser-xhr": "5.2.1",
77
+ "@algolia/requester-node-http": "5.2.1"
74
78
  },
75
79
  "devDependencies": {
76
- "@babel/preset-env": "7.25.3",
80
+ "@babel/preset-env": "7.25.4",
77
81
  "@babel/preset-typescript": "7.24.7",
78
82
  "@types/jest": "29.5.12",
79
- "@types/node": "22.2.0",
83
+ "@types/node": "22.5.0",
80
84
  "jest": "29.7.0",
81
- "rollup": "4.20.0",
85
+ "rollup": "4.21.0",
82
86
  "typescript": "5.5.4"
83
87
  },
84
88
  "engines": {
@@ -1 +0,0 @@
1
- {"version":3,"file":"currenciesValue.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/currenciesValue.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../../../client-search/model/facetsStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../../lite/model/facetsStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../../../recommend/model/facetsStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}