@algolia/client-search 5.0.0-alpha.99 → 5.0.0-beta.10

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 (291) hide show
  1. package/LICENSE +21 -0
  2. package/dist/builds/browser.d.ts +91 -3
  3. package/dist/builds/browser.d.ts.map +1 -1
  4. package/dist/builds/node.d.ts +109 -3
  5. package/dist/builds/node.d.ts.map +1 -1
  6. package/dist/client-search.cjs +544 -219
  7. package/dist/client-search.esm.browser.js +494 -228
  8. package/dist/client-search.esm.node.js +545 -220
  9. package/dist/client-search.umd.js +2 -2
  10. package/dist/model/acl.d.ts +1 -1
  11. package/dist/model/action.d.ts +1 -1
  12. package/dist/model/addApiKeyResponse.d.ts +1 -1
  13. package/dist/model/anchoring.d.ts +1 -1
  14. package/dist/model/apiKey.d.ts +8 -8
  15. package/dist/model/apiKeyOperation.d.ts +2 -0
  16. package/dist/model/apiKeyOperation.d.ts.map +1 -0
  17. package/dist/model/aroundPrecision.d.ts +1 -1
  18. package/dist/model/aroundPrecisionFromValueInner.d.ts +9 -0
  19. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  20. package/dist/model/aroundRadius.d.ts +1 -1
  21. package/dist/model/aroundRadiusAll.d.ts +3 -0
  22. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  23. package/dist/model/automaticFacetFilter.d.ts +4 -4
  24. package/dist/model/automaticFacetFilters.d.ts +1 -1
  25. package/dist/model/baseGetApiKeyResponse.d.ts +1 -1
  26. package/dist/model/baseIndexSettings.d.ts +23 -18
  27. package/dist/model/baseIndexSettings.d.ts.map +1 -1
  28. package/dist/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  29. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  30. package/dist/model/baseSearchResponse.d.ts +8 -20
  31. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  32. package/dist/model/batchDictionaryEntriesParams.d.ts +3 -3
  33. package/dist/model/batchResponse.d.ts +2 -2
  34. package/dist/model/browsePagination.d.ts +19 -0
  35. package/dist/model/browsePagination.d.ts.map +1 -0
  36. package/dist/model/browseResponse.d.ts +2 -1
  37. package/dist/model/browseResponse.d.ts.map +1 -1
  38. package/dist/model/builtInOperation.d.ts +2 -2
  39. package/dist/model/builtInOperationType.d.ts +1 -1
  40. package/dist/model/clientMethodProps.d.ts +137 -70
  41. package/dist/model/clientMethodProps.d.ts.map +1 -1
  42. package/dist/model/condition.d.ts +7 -3
  43. package/dist/model/condition.d.ts.map +1 -1
  44. package/dist/model/consequence.d.ts +5 -5
  45. package/dist/model/consequenceHide.d.ts +2 -2
  46. package/dist/model/consequenceQuery.d.ts +1 -1
  47. package/dist/model/consequenceQueryObject.d.ts +2 -2
  48. package/dist/model/createdAtResponse.d.ts +1 -1
  49. package/dist/model/cursor.d.ts +1 -1
  50. package/dist/model/deleteApiKeyResponse.d.ts +1 -1
  51. package/dist/model/deleteByParams.d.ts +4 -4
  52. package/dist/model/deleteSourceResponse.d.ts +1 -1
  53. package/dist/model/deletedAtResponse.d.ts +2 -2
  54. package/dist/model/dictionaryEntry.d.ts +6 -8
  55. package/dist/model/dictionaryEntry.d.ts.map +1 -1
  56. package/dist/model/dictionaryEntryState.d.ts +1 -1
  57. package/dist/model/dictionaryLanguage.d.ts +2 -2
  58. package/dist/model/dictionarySettingsParams.d.ts +1 -1
  59. package/dist/model/distinct.d.ts +1 -1
  60. package/dist/model/edit.d.ts +1 -1
  61. package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
  62. package/dist/model/facetFilters.d.ts +2 -3
  63. package/dist/model/facetFilters.d.ts.map +1 -1
  64. package/dist/model/facetHits.d.ts +2 -2
  65. package/dist/model/facetOrdering.d.ts +2 -2
  66. package/dist/model/facets.d.ts +2 -2
  67. package/dist/model/fetchedIndex.d.ts +5 -1
  68. package/dist/model/fetchedIndex.d.ts.map +1 -1
  69. package/dist/model/getObjectsRequest.d.ts +3 -3
  70. package/dist/model/getObjectsResponse.d.ts +1 -1
  71. package/dist/model/hasPendingMappingsResponse.d.ts +1 -1
  72. package/dist/model/highlightResult.d.ts +1 -1
  73. package/dist/model/highlightResult.d.ts.map +1 -1
  74. package/dist/model/highlightResultOption.d.ts +3 -3
  75. package/dist/model/hit.d.ts +4 -4
  76. package/dist/model/ignorePlurals.d.ts +3 -2
  77. package/dist/model/ignorePlurals.d.ts.map +1 -1
  78. package/dist/model/index.d.ts +8 -1
  79. package/dist/model/index.d.ts.map +1 -1
  80. package/dist/model/indexSettings.d.ts +1 -1
  81. package/dist/model/indexSettingsAsSearchParams.d.ts +32 -35
  82. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  83. package/dist/model/log.d.ts +11 -11
  84. package/dist/model/logQuery.d.ts +1 -1
  85. package/dist/model/matchLevel.d.ts +1 -1
  86. package/dist/model/mode.d.ts +1 -1
  87. package/dist/model/multipleBatchRequest.d.ts +1 -1
  88. package/dist/model/multipleBatchResponse.d.ts +2 -2
  89. package/dist/model/numericFilters.d.ts +2 -3
  90. package/dist/model/numericFilters.d.ts.map +1 -1
  91. package/dist/model/operationIndexParams.d.ts +2 -2
  92. package/dist/model/operationType.d.ts +1 -1
  93. package/dist/model/optionalFilters.d.ts +2 -3
  94. package/dist/model/optionalFilters.d.ts.map +1 -1
  95. package/dist/model/params.d.ts +1 -1
  96. package/dist/model/promoteObjectID.d.ts +2 -2
  97. package/dist/model/promoteObjectIDs.d.ts +2 -2
  98. package/dist/model/queryType.d.ts +1 -1
  99. package/dist/model/rankingInfo.d.ts +13 -10
  100. package/dist/model/rankingInfo.d.ts.map +1 -1
  101. package/dist/model/reRankingApplyFilter.d.ts +2 -3
  102. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  103. package/dist/model/redirect.d.ts +1 -1
  104. package/dist/model/redirectURL.d.ts +7 -0
  105. package/dist/model/redirectURL.d.ts.map +1 -0
  106. package/dist/model/removeStopWords.d.ts +3 -2
  107. package/dist/model/removeStopWords.d.ts.map +1 -1
  108. package/dist/model/removeUserIdResponse.d.ts +1 -1
  109. package/dist/model/removeWordsIfNoResults.d.ts +1 -1
  110. package/dist/model/renderingContent.d.ts +3 -1
  111. package/dist/model/renderingContent.d.ts.map +1 -1
  112. package/dist/model/replaceAllObjectsResponse.d.ts +11 -0
  113. package/dist/model/replaceAllObjectsResponse.d.ts.map +1 -0
  114. package/dist/model/replaceSourceResponse.d.ts +1 -1
  115. package/dist/model/rule.d.ts +5 -5
  116. package/dist/model/saveObjectResponse.d.ts +3 -3
  117. package/dist/model/saveSynonymResponse.d.ts +2 -2
  118. package/dist/model/searchDictionaryEntriesParams.d.ts +5 -7
  119. package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
  120. package/dist/model/searchDictionaryEntriesResponse.d.ts +20 -0
  121. package/dist/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
  122. package/dist/model/searchForFacetValuesRequest.d.ts +1 -1
  123. package/dist/model/searchForFacetValuesResponse.d.ts +4 -1
  124. package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
  125. package/dist/model/searchForFacetsOptions.d.ts +2 -2
  126. package/dist/model/searchForHitsOptions.d.ts +1 -1
  127. package/dist/model/searchHits.d.ts +6 -3
  128. package/dist/model/searchHits.d.ts.map +1 -1
  129. package/dist/model/searchPagination.d.ts +19 -0
  130. package/dist/model/searchPagination.d.ts.map +1 -0
  131. package/dist/model/searchParamsObject.d.ts +3 -0
  132. package/dist/model/searchParamsObject.d.ts.map +1 -1
  133. package/dist/model/searchParamsQuery.d.ts +1 -1
  134. package/dist/model/searchResponse.d.ts +2 -1
  135. package/dist/model/searchResponse.d.ts.map +1 -1
  136. package/dist/model/searchRulesParams.d.ts +4 -8
  137. package/dist/model/searchRulesParams.d.ts.map +1 -1
  138. package/dist/model/searchRulesResponse.d.ts +2 -2
  139. package/dist/model/searchStrategy.d.ts +1 -1
  140. package/dist/model/searchSynonymsParams.d.ts +2 -2
  141. package/dist/model/searchSynonymsResponse.d.ts +2 -2
  142. package/dist/model/searchUserIdsParams.d.ts +1 -1
  143. package/dist/model/searchUserIdsResponse.d.ts +3 -3
  144. package/dist/model/securedApiKeyRestrictions.d.ts +25 -0
  145. package/dist/model/securedApiKeyRestrictions.d.ts.map +1 -0
  146. package/dist/model/semanticSearch.d.ts +2 -2
  147. package/dist/model/snippetResult.d.ts +1 -1
  148. package/dist/model/snippetResult.d.ts.map +1 -1
  149. package/dist/model/snippetResultOption.d.ts +2 -2
  150. package/dist/model/sortRemainingBy.d.ts +1 -1
  151. package/dist/model/supportedLanguage.d.ts +5 -0
  152. package/dist/model/supportedLanguage.d.ts.map +1 -0
  153. package/dist/model/tagFilters.d.ts +2 -3
  154. package/dist/model/tagFilters.d.ts.map +1 -1
  155. package/dist/model/taskStatus.d.ts +1 -1
  156. package/dist/model/timeRange.d.ts +2 -2
  157. package/dist/model/typoTolerance.d.ts +1 -1
  158. package/dist/model/typoToleranceEnum.d.ts +3 -0
  159. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  160. package/dist/model/updateApiKeyResponse.d.ts +1 -1
  161. package/dist/model/updatedAtResponse.d.ts +2 -2
  162. package/dist/model/updatedAtWithObjectIdResponse.d.ts +3 -3
  163. package/dist/model/updatedRuleResponse.d.ts +3 -3
  164. package/dist/model/userHit.d.ts +1 -1
  165. package/dist/model/userId.d.ts +1 -1
  166. package/dist/model/value.d.ts +5 -1
  167. package/dist/model/value.d.ts.map +1 -1
  168. package/dist/src/searchClient.d.ts +385 -208
  169. package/dist/src/searchClient.d.ts.map +1 -1
  170. package/model/acl.ts +1 -1
  171. package/model/action.ts +1 -1
  172. package/model/addApiKeyResponse.ts +1 -1
  173. package/model/anchoring.ts +1 -1
  174. package/model/apiKey.ts +8 -8
  175. package/model/{mixedSearchFilters.ts → apiKeyOperation.ts} +1 -1
  176. package/model/aroundPrecision.ts +1 -1
  177. package/model/aroundPrecisionFromValueInner.ts +9 -0
  178. package/model/aroundRadius.ts +1 -1
  179. package/model/aroundRadiusAll.ts +3 -0
  180. package/model/automaticFacetFilter.ts +4 -4
  181. package/model/automaticFacetFilters.ts +1 -1
  182. package/model/baseGetApiKeyResponse.ts +1 -1
  183. package/model/baseIndexSettings.ts +25 -18
  184. package/model/baseSearchParamsWithoutQuery.ts +26 -30
  185. package/model/baseSearchResponse.ts +9 -24
  186. package/model/batchDictionaryEntriesParams.ts +3 -3
  187. package/model/batchResponse.ts +2 -2
  188. package/model/browsePagination.ts +23 -0
  189. package/model/browseResponse.ts +2 -0
  190. package/model/builtInOperation.ts +2 -2
  191. package/model/builtInOperationType.ts +1 -1
  192. package/model/clientMethodProps.ts +156 -70
  193. package/model/condition.ts +8 -3
  194. package/model/consequence.ts +5 -5
  195. package/model/consequenceHide.ts +2 -2
  196. package/model/consequenceQuery.ts +1 -1
  197. package/model/consequenceQueryObject.ts +2 -2
  198. package/model/createdAtResponse.ts +1 -1
  199. package/model/cursor.ts +1 -1
  200. package/model/deleteApiKeyResponse.ts +1 -1
  201. package/model/deleteByParams.ts +4 -4
  202. package/model/deleteSourceResponse.ts +1 -1
  203. package/model/deletedAtResponse.ts +2 -2
  204. package/model/dictionaryEntry.ts +6 -8
  205. package/model/dictionaryEntryState.ts +1 -1
  206. package/model/dictionaryLanguage.ts +2 -2
  207. package/model/dictionarySettingsParams.ts +1 -1
  208. package/model/distinct.ts +1 -1
  209. package/model/edit.ts +1 -1
  210. package/model/exactOnSingleWordQuery.ts +1 -1
  211. package/model/facetFilters.ts +2 -4
  212. package/model/facetHits.ts +2 -2
  213. package/model/facetOrdering.ts +2 -2
  214. package/model/facets.ts +2 -2
  215. package/model/fetchedIndex.ts +6 -1
  216. package/model/getObjectsRequest.ts +3 -3
  217. package/model/getObjectsResponse.ts +1 -1
  218. package/model/hasPendingMappingsResponse.ts +1 -1
  219. package/model/highlightResult.ts +1 -0
  220. package/model/highlightResultOption.ts +3 -3
  221. package/model/hit.ts +4 -4
  222. package/model/ignorePlurals.ts +4 -2
  223. package/model/index.ts +8 -1
  224. package/model/indexSettings.ts +1 -1
  225. package/model/indexSettingsAsSearchParams.ts +32 -36
  226. package/model/log.ts +11 -11
  227. package/model/logQuery.ts +1 -1
  228. package/model/matchLevel.ts +1 -1
  229. package/model/mode.ts +1 -1
  230. package/model/multipleBatchRequest.ts +1 -1
  231. package/model/multipleBatchResponse.ts +2 -2
  232. package/model/numericFilters.ts +2 -4
  233. package/model/operationIndexParams.ts +2 -2
  234. package/model/operationType.ts +1 -1
  235. package/model/optionalFilters.ts +2 -4
  236. package/model/params.ts +1 -1
  237. package/model/promoteObjectID.ts +2 -2
  238. package/model/promoteObjectIDs.ts +2 -2
  239. package/model/queryType.ts +1 -1
  240. package/model/rankingInfo.ts +13 -10
  241. package/model/reRankingApplyFilter.ts +2 -4
  242. package/model/redirect.ts +1 -1
  243. package/model/redirectURL.ts +8 -0
  244. package/model/removeStopWords.ts +4 -2
  245. package/model/removeUserIdResponse.ts +1 -1
  246. package/model/removeWordsIfNoResults.ts +1 -1
  247. package/model/renderingContent.ts +4 -1
  248. package/model/replaceAllObjectsResponse.ts +15 -0
  249. package/model/replaceSourceResponse.ts +1 -1
  250. package/model/rule.ts +5 -5
  251. package/model/saveObjectResponse.ts +3 -3
  252. package/model/saveSynonymResponse.ts +2 -2
  253. package/model/searchDictionaryEntriesParams.ts +6 -7
  254. package/model/searchDictionaryEntriesResponse.ts +25 -0
  255. package/model/searchForFacetValuesRequest.ts +1 -1
  256. package/model/searchForFacetValuesResponse.ts +4 -1
  257. package/model/searchForFacetsOptions.ts +2 -2
  258. package/model/searchForHitsOptions.ts +1 -1
  259. package/model/searchHits.ts +6 -3
  260. package/model/searchPagination.ts +23 -0
  261. package/model/searchParamsObject.ts +3 -0
  262. package/model/searchParamsQuery.ts +1 -1
  263. package/model/searchResponse.ts +3 -1
  264. package/model/searchRulesParams.ts +4 -9
  265. package/model/searchRulesResponse.ts +2 -2
  266. package/model/searchStrategy.ts +1 -1
  267. package/model/searchSynonymsParams.ts +2 -2
  268. package/model/searchSynonymsResponse.ts +2 -2
  269. package/model/searchUserIdsParams.ts +1 -1
  270. package/model/searchUserIdsResponse.ts +3 -3
  271. package/model/securedApiKeyRestrictions.ts +32 -0
  272. package/model/semanticSearch.ts +2 -2
  273. package/model/snippetResult.ts +2 -1
  274. package/model/snippetResultOption.ts +2 -2
  275. package/model/sortRemainingBy.ts +1 -1
  276. package/model/supportedLanguage.ts +74 -0
  277. package/model/tagFilters.ts +2 -4
  278. package/model/taskStatus.ts +1 -1
  279. package/model/timeRange.ts +2 -2
  280. package/model/typoTolerance.ts +1 -1
  281. package/model/typoToleranceEnum.ts +3 -0
  282. package/model/updateApiKeyResponse.ts +1 -1
  283. package/model/updatedAtResponse.ts +2 -2
  284. package/model/updatedAtWithObjectIdResponse.ts +3 -3
  285. package/model/updatedRuleResponse.ts +3 -3
  286. package/model/userHit.ts +1 -1
  287. package/model/userId.ts +1 -1
  288. package/model/value.ts +6 -1
  289. package/package.json +11 -8
  290. package/dist/model/mixedSearchFilters.d.ts +0 -2
  291. package/dist/model/mixedSearchFilters.d.ts.map +0 -1
@@ -3,15 +3,15 @@
3
3
  */
4
4
  export type UpdatedAtWithObjectIdResponse = {
5
5
  /**
6
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
6
+ * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
7
7
  */
8
8
  taskID?: number;
9
9
  /**
10
- * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
10
+ * Date and time when the object was updated, in RFC 3339 format.
11
11
  */
12
12
  updatedAt?: string;
13
13
  /**
14
- * Unique object identifier.
14
+ * Unique record identifier.
15
15
  */
16
16
  objectID?: string;
17
17
  };
@@ -1,14 +1,14 @@
1
1
  export type UpdatedRuleResponse = {
2
2
  /**
3
- * Unique object identifier.
3
+ * Unique identifier of a rule object.
4
4
  */
5
5
  objectID: string;
6
6
  /**
7
- * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
7
+ * Date and time when the object was updated, in RFC 3339 format.
8
8
  */
9
9
  updatedAt: string;
10
10
  /**
11
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
11
+ * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
12
12
  */
13
13
  taskID: number;
14
14
  };
@@ -1,7 +1,7 @@
1
1
  import type { UserHighlightResult } from './userHighlightResult';
2
2
  export type UserHit = {
3
3
  /**
4
- * UserID of the user.
4
+ * Unique identifier of the user who makes the search request.
5
5
  */
6
6
  userID: string;
7
7
  /**
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export type UserId = {
5
5
  /**
6
- * UserID of the user.
6
+ * Unique identifier of the user who makes the search request.
7
7
  */
8
8
  userID: string;
9
9
  /**
@@ -1,9 +1,13 @@
1
1
  import type { SortRemainingBy } from './sortRemainingBy';
2
2
  export type Value = {
3
3
  /**
4
- * Pinned order of facet lists.
4
+ * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
5
5
  */
6
6
  order?: string[];
7
7
  sortRemainingBy?: SortRemainingBy;
8
+ /**
9
+ * Hide facet values.
10
+ */
11
+ hide?: string[];
8
12
  };
9
13
  //# sourceMappingURL=value.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}
1
+ {"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}