@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.100

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 (531) hide show
  1. package/dist/builds/browser.d.ts +5 -5
  2. package/dist/builds/browser.d.ts.map +1 -1
  3. package/dist/builds/node.d.ts +5 -5
  4. package/dist/builds/node.d.ts.map +1 -1
  5. package/dist/{client-search.cjs.js → client-search.cjs} +2116 -1869
  6. package/dist/client-search.esm.browser.js +2356 -2137
  7. package/dist/client-search.esm.node.js +2117 -1868
  8. package/dist/client-search.umd.js +2 -2
  9. package/dist/model/acl.d.ts +4 -1
  10. package/dist/model/acl.d.ts.map +1 -1
  11. package/dist/model/action.d.ts +4 -4
  12. package/dist/model/action.d.ts.map +1 -1
  13. package/dist/model/addApiKeyResponse.d.ts +10 -10
  14. package/dist/model/addApiKeyResponse.d.ts.map +1 -1
  15. package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
  16. package/dist/model/advancedSyntaxFeatures.d.ts.map +1 -1
  17. package/dist/model/alternativesAsExact.d.ts +1 -1
  18. package/dist/model/alternativesAsExact.d.ts.map +1 -1
  19. package/dist/model/anchoring.d.ts +4 -4
  20. package/dist/model/anchoring.d.ts.map +1 -1
  21. package/dist/model/apiKey.d.ts +38 -38
  22. package/dist/model/apiKey.d.ts.map +1 -1
  23. package/dist/model/aroundPrecision.d.ts +6 -0
  24. package/dist/model/aroundPrecision.d.ts.map +1 -0
  25. package/dist/model/aroundPrecisionFromValueInner.d.ts +5 -0
  26. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -0
  27. package/dist/model/aroundRadius.d.ts +5 -5
  28. package/dist/model/aroundRadius.d.ts.map +1 -1
  29. package/dist/model/aroundRadiusAll.d.ts +1 -1
  30. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  31. package/dist/model/assignUserIdParams.d.ts +9 -9
  32. package/dist/model/assignUserIdParams.d.ts.map +1 -1
  33. package/dist/model/attributeToUpdate.d.ts +3 -0
  34. package/dist/model/attributeToUpdate.d.ts.map +1 -0
  35. package/dist/model/automaticFacetFilter.d.ts +17 -17
  36. package/dist/model/automaticFacetFilter.d.ts.map +1 -1
  37. package/dist/model/automaticFacetFilters.d.ts +5 -5
  38. package/dist/model/automaticFacetFilters.d.ts.map +1 -1
  39. package/dist/model/baseGetApiKeyResponse.d.ts +11 -0
  40. package/dist/model/baseGetApiKeyResponse.d.ts.map +1 -0
  41. package/dist/model/baseIndexSettings.d.ts +66 -58
  42. package/dist/model/baseIndexSettings.d.ts.map +1 -1
  43. package/dist/model/baseSearchParams.d.ts +3 -3
  44. package/dist/model/baseSearchParams.d.ts.map +1 -1
  45. package/dist/model/baseSearchParamsWithoutQuery.d.ts +118 -122
  46. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  47. package/dist/model/baseSearchResponse.d.ts +105 -101
  48. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  49. package/dist/model/batchAssignUserIdsParams.d.ts +13 -13
  50. package/dist/model/batchAssignUserIdsParams.d.ts.map +1 -1
  51. package/dist/model/batchDictionaryEntriesParams.d.ts +14 -14
  52. package/dist/model/batchDictionaryEntriesParams.d.ts.map +1 -1
  53. package/dist/model/batchDictionaryEntriesRequest.d.ts +6 -6
  54. package/dist/model/batchDictionaryEntriesRequest.d.ts.map +1 -1
  55. package/dist/model/batchParams.d.ts +7 -7
  56. package/dist/model/batchParams.d.ts.map +1 -1
  57. package/dist/model/batchRequest.d.ts +9 -0
  58. package/dist/model/batchRequest.d.ts.map +1 -0
  59. package/dist/model/batchResponse.d.ts +10 -10
  60. package/dist/model/batchResponse.d.ts.map +1 -1
  61. package/dist/model/batchWriteParams.d.ts +7 -7
  62. package/dist/model/batchWriteParams.d.ts.map +1 -1
  63. package/dist/model/browseParams.d.ts +4 -0
  64. package/dist/model/browseParams.d.ts.map +1 -0
  65. package/dist/model/browseParamsObject.d.ts +4 -0
  66. package/dist/model/browseParamsObject.d.ts.map +1 -0
  67. package/dist/model/browseResponse.d.ts +4 -4
  68. package/dist/model/browseResponse.d.ts.map +1 -1
  69. package/dist/model/builtInOperation.d.ts +11 -11
  70. package/dist/model/builtInOperation.d.ts.map +1 -1
  71. package/dist/model/builtInOperationType.d.ts +4 -4
  72. package/dist/model/builtInOperationType.d.ts.map +1 -1
  73. package/dist/model/clientMethodProps.d.ts +706 -703
  74. package/dist/model/clientMethodProps.d.ts.map +1 -1
  75. package/dist/model/condition.d.ts +16 -16
  76. package/dist/model/condition.d.ts.map +1 -1
  77. package/dist/model/consequence.d.ts +25 -25
  78. package/dist/model/consequence.d.ts.map +1 -1
  79. package/dist/model/consequenceHide.d.ts +9 -9
  80. package/dist/model/consequenceHide.d.ts.map +1 -1
  81. package/dist/model/consequenceParams.d.ts +4 -4
  82. package/dist/model/consequenceParams.d.ts.map +1 -1
  83. package/dist/model/consequenceQuery.d.ts +5 -5
  84. package/dist/model/consequenceQuery.d.ts.map +1 -1
  85. package/dist/model/consequenceQueryObject.d.ts +11 -11
  86. package/dist/model/consequenceQueryObject.d.ts.map +1 -1
  87. package/dist/model/createdAtResponse.d.ts +9 -9
  88. package/dist/model/createdAtResponse.d.ts.map +1 -1
  89. package/dist/model/cursor.d.ts +7 -0
  90. package/dist/model/cursor.d.ts.map +1 -0
  91. package/dist/model/deleteApiKeyResponse.d.ts +6 -6
  92. package/dist/model/deleteApiKeyResponse.d.ts.map +1 -1
  93. package/dist/model/deleteByParams.d.ts +27 -0
  94. package/dist/model/deleteByParams.d.ts.map +1 -0
  95. package/dist/model/deleteSourceResponse.d.ts +6 -6
  96. package/dist/model/deleteSourceResponse.d.ts.map +1 -1
  97. package/dist/model/deletedAtResponse.d.ts +13 -13
  98. package/dist/model/deletedAtResponse.d.ts.map +1 -1
  99. package/dist/model/dictionaryAction.d.ts +4 -4
  100. package/dist/model/dictionaryAction.d.ts.map +1 -1
  101. package/dist/model/dictionaryEntry.d.ts +27 -27
  102. package/dist/model/dictionaryEntry.d.ts.map +1 -1
  103. package/dist/model/dictionaryEntryState.d.ts +4 -4
  104. package/dist/model/dictionaryEntryState.d.ts.map +1 -1
  105. package/dist/model/dictionaryLanguage.d.ts +9 -9
  106. package/dist/model/dictionaryLanguage.d.ts.map +1 -1
  107. package/dist/model/dictionarySettingsParams.d.ts +7 -7
  108. package/dist/model/dictionarySettingsParams.d.ts.map +1 -1
  109. package/dist/model/dictionaryType.d.ts +1 -1
  110. package/dist/model/dictionaryType.d.ts.map +1 -1
  111. package/dist/model/distinct.d.ts +5 -0
  112. package/dist/model/distinct.d.ts.map +1 -0
  113. package/dist/model/edit.d.ts +12 -12
  114. package/dist/model/edit.d.ts.map +1 -1
  115. package/dist/model/editType.d.ts +4 -4
  116. package/dist/model/editType.d.ts.map +1 -1
  117. package/dist/model/errorBase.d.ts +6 -6
  118. package/dist/model/errorBase.d.ts.map +1 -1
  119. package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
  120. package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
  121. package/dist/model/exhaustive.d.ts +26 -0
  122. package/dist/model/exhaustive.d.ts.map +1 -0
  123. package/dist/model/facetFilters.d.ts +5 -5
  124. package/dist/model/facetFilters.d.ts.map +1 -1
  125. package/dist/model/facetHits.d.ts +14 -14
  126. package/dist/model/facetHits.d.ts.map +1 -1
  127. package/dist/model/facetOrdering.d.ts +12 -12
  128. package/dist/model/facetOrdering.d.ts.map +1 -1
  129. package/dist/model/facets.d.ts +9 -9
  130. package/dist/model/facets.d.ts.map +1 -1
  131. package/dist/model/facetsStats.d.ts +18 -18
  132. package/dist/model/facetsStats.d.ts.map +1 -1
  133. package/dist/model/fetchedIndex.d.ts +46 -46
  134. package/dist/model/fetchedIndex.d.ts.map +1 -1
  135. package/dist/model/getApiKeyResponse.d.ts +4 -0
  136. package/dist/model/getApiKeyResponse.d.ts.map +1 -0
  137. package/dist/model/getDictionarySettingsResponse.d.ts +4 -4
  138. package/dist/model/getDictionarySettingsResponse.d.ts.map +1 -1
  139. package/dist/model/getLogsResponse.d.ts +4 -4
  140. package/dist/model/getLogsResponse.d.ts.map +1 -1
  141. package/dist/model/getObjectsParams.d.ts +7 -7
  142. package/dist/model/getObjectsParams.d.ts.map +1 -1
  143. package/dist/model/getObjectsRequest.d.ts +18 -0
  144. package/dist/model/getObjectsRequest.d.ts.map +1 -0
  145. package/dist/model/getObjectsResponse.d.ts +6 -6
  146. package/dist/model/getObjectsResponse.d.ts.map +1 -1
  147. package/dist/model/getTaskResponse.d.ts +4 -4
  148. package/dist/model/getTaskResponse.d.ts.map +1 -1
  149. package/dist/model/getTopUserIdsResponse.d.ts +10 -10
  150. package/dist/model/getTopUserIdsResponse.d.ts.map +1 -1
  151. package/dist/model/hasPendingMappingsResponse.d.ts +10 -10
  152. package/dist/model/hasPendingMappingsResponse.d.ts.map +1 -1
  153. package/dist/model/highlightResult.d.ts +2 -2
  154. package/dist/model/highlightResult.d.ts.map +1 -1
  155. package/dist/model/highlightResultOption.d.ts +19 -19
  156. package/dist/model/highlightResultOption.d.ts.map +1 -1
  157. package/dist/model/hit.d.ts +22 -22
  158. package/dist/model/hit.d.ts.map +1 -1
  159. package/dist/model/ignorePlurals.d.ts +4 -4
  160. package/dist/model/ignorePlurals.d.ts.map +1 -1
  161. package/dist/model/index.d.ts +163 -152
  162. package/dist/model/index.d.ts.map +1 -1
  163. package/dist/model/indexSettings.d.ts +6 -6
  164. package/dist/model/indexSettings.d.ts.map +1 -1
  165. package/dist/model/indexSettingsAsSearchParams.d.ts +162 -158
  166. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  167. package/dist/model/languages.d.ts +9 -9
  168. package/dist/model/languages.d.ts.map +1 -1
  169. package/dist/model/listApiKeysResponse.d.ts +7 -7
  170. package/dist/model/listApiKeysResponse.d.ts.map +1 -1
  171. package/dist/model/listClustersResponse.d.ts +9 -9
  172. package/dist/model/listClustersResponse.d.ts.map +1 -1
  173. package/dist/model/listIndicesResponse.d.ts +11 -11
  174. package/dist/model/listIndicesResponse.d.ts.map +1 -1
  175. package/dist/model/listUserIdsResponse.d.ts +10 -10
  176. package/dist/model/listUserIdsResponse.d.ts.map +1 -1
  177. package/dist/model/log.d.ts +63 -63
  178. package/dist/model/log.d.ts.map +1 -1
  179. package/dist/model/logQuery.d.ts +14 -14
  180. package/dist/model/logQuery.d.ts.map +1 -1
  181. package/dist/model/logType.d.ts +1 -1
  182. package/dist/model/logType.d.ts.map +1 -1
  183. package/dist/model/matchLevel.d.ts +4 -4
  184. package/dist/model/matchLevel.d.ts.map +1 -1
  185. package/dist/model/matchedGeoLocation.d.ts +14 -14
  186. package/dist/model/matchedGeoLocation.d.ts.map +1 -1
  187. package/dist/model/mixedSearchFilters.d.ts +1 -1
  188. package/dist/model/mixedSearchFilters.d.ts.map +1 -1
  189. package/dist/model/mode.d.ts +5 -0
  190. package/dist/model/mode.d.ts.map +1 -0
  191. package/dist/model/multipleBatchRequest.d.ts +13 -0
  192. package/dist/model/multipleBatchRequest.d.ts.map +1 -0
  193. package/dist/model/multipleBatchResponse.d.ts +10 -10
  194. package/dist/model/multipleBatchResponse.d.ts.map +1 -1
  195. package/dist/model/numericFilters.d.ts +5 -5
  196. package/dist/model/numericFilters.d.ts.map +1 -1
  197. package/dist/model/operationIndexParams.d.ts +13 -13
  198. package/dist/model/operationIndexParams.d.ts.map +1 -1
  199. package/dist/model/operationType.d.ts +4 -4
  200. package/dist/model/operationType.d.ts.map +1 -1
  201. package/dist/model/optionalFilters.d.ts +5 -5
  202. package/dist/model/optionalFilters.d.ts.map +1 -1
  203. package/dist/model/params.d.ts +12 -12
  204. package/dist/model/params.d.ts.map +1 -1
  205. package/dist/model/personalization.d.ts +14 -14
  206. package/dist/model/personalization.d.ts.map +1 -1
  207. package/dist/model/promote.d.ts +3 -3
  208. package/dist/model/promote.d.ts.map +1 -1
  209. package/dist/model/promoteObjectID.d.ts +13 -13
  210. package/dist/model/promoteObjectID.d.ts.map +1 -1
  211. package/dist/model/promoteObjectIDs.d.ts +13 -13
  212. package/dist/model/promoteObjectIDs.d.ts.map +1 -1
  213. package/dist/model/queryType.d.ts +4 -4
  214. package/dist/model/queryType.d.ts.map +1 -1
  215. package/dist/model/rankingInfo.d.ts +50 -50
  216. package/dist/model/rankingInfo.d.ts.map +1 -1
  217. package/dist/model/reRankingApplyFilter.d.ts +5 -5
  218. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  219. package/dist/model/redirect.d.ts +8 -0
  220. package/dist/model/redirect.d.ts.map +1 -0
  221. package/dist/model/redirectRuleIndexMetadata.d.ts +21 -0
  222. package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  223. package/dist/model/redirectRuleIndexMetadataData.d.ts +7 -0
  224. package/dist/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  225. package/dist/model/removeStopWords.d.ts +4 -4
  226. package/dist/model/removeStopWords.d.ts.map +1 -1
  227. package/dist/model/removeUserIdResponse.d.ts +6 -6
  228. package/dist/model/removeUserIdResponse.d.ts.map +1 -1
  229. package/dist/model/removeWordsIfNoResults.d.ts +4 -4
  230. package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
  231. package/dist/model/renderingContent.d.ts +7 -7
  232. package/dist/model/renderingContent.d.ts.map +1 -1
  233. package/dist/model/replaceSourceResponse.d.ts +6 -6
  234. package/dist/model/replaceSourceResponse.d.ts.map +1 -1
  235. package/dist/model/rule.d.ts +29 -29
  236. package/dist/model/rule.d.ts.map +1 -1
  237. package/dist/model/saveObjectResponse.d.ts +14 -11
  238. package/dist/model/saveObjectResponse.d.ts.map +1 -1
  239. package/dist/model/saveSynonymResponse.d.ts +14 -14
  240. package/dist/model/saveSynonymResponse.d.ts.map +1 -1
  241. package/dist/model/scopeType.d.ts +1 -1
  242. package/dist/model/scopeType.d.ts.map +1 -1
  243. package/dist/model/searchDictionaryEntriesParams.d.ts +21 -21
  244. package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
  245. package/dist/model/searchForFacetValuesRequest.d.ts +14 -14
  246. package/dist/model/searchForFacetValuesRequest.d.ts.map +1 -1
  247. package/dist/model/searchForFacetValuesResponse.d.ts +12 -4
  248. package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
  249. package/dist/model/searchForFacets.d.ts +3 -3
  250. package/dist/model/searchForFacets.d.ts.map +1 -1
  251. package/dist/model/searchForFacetsOptions.d.ts +20 -20
  252. package/dist/model/searchForFacetsOptions.d.ts.map +1 -1
  253. package/dist/model/searchForHits.d.ts +3 -3
  254. package/dist/model/searchForHits.d.ts.map +1 -1
  255. package/dist/model/searchForHitsOptions.d.ts +12 -12
  256. package/dist/model/searchForHitsOptions.d.ts.map +1 -1
  257. package/dist/model/searchHits.d.ts +12 -4
  258. package/dist/model/searchHits.d.ts.map +1 -1
  259. package/dist/model/searchMethodParams.d.ts +6 -6
  260. package/dist/model/searchMethodParams.d.ts.map +1 -1
  261. package/dist/model/searchParams.d.ts +3 -3
  262. package/dist/model/searchParams.d.ts.map +1 -1
  263. package/dist/model/searchParamsObject.d.ts +3 -3
  264. package/dist/model/searchParamsObject.d.ts.map +1 -1
  265. package/dist/model/searchParamsQuery.d.ts +6 -6
  266. package/dist/model/searchParamsQuery.d.ts.map +1 -1
  267. package/dist/model/searchParamsString.d.ts +6 -6
  268. package/dist/model/searchParamsString.d.ts.map +1 -1
  269. package/dist/model/searchQuery.d.ts +3 -3
  270. package/dist/model/searchQuery.d.ts.map +1 -1
  271. package/dist/model/searchResponse.d.ts +3 -3
  272. package/dist/model/searchResponse.d.ts.map +1 -1
  273. package/dist/model/searchResponses.d.ts +4 -4
  274. package/dist/model/searchResponses.d.ts.map +1 -1
  275. package/dist/model/searchResult.d.ts +4 -0
  276. package/dist/model/searchResult.d.ts.map +1 -0
  277. package/dist/model/searchRulesParams.d.ts +31 -31
  278. package/dist/model/searchRulesParams.d.ts.map +1 -1
  279. package/dist/model/searchRulesResponse.d.ts +19 -19
  280. package/dist/model/searchRulesResponse.d.ts.map +1 -1
  281. package/dist/model/searchStrategy.d.ts +4 -1
  282. package/dist/model/searchStrategy.d.ts.map +1 -1
  283. package/dist/model/searchSynonymsParams.d.ts +16 -6
  284. package/dist/model/searchSynonymsParams.d.ts.map +1 -1
  285. package/dist/model/searchSynonymsResponse.d.ts +11 -11
  286. package/dist/model/searchSynonymsResponse.d.ts.map +1 -1
  287. package/dist/model/searchTypeDefault.d.ts +4 -4
  288. package/dist/model/searchTypeDefault.d.ts.map +1 -1
  289. package/dist/model/searchTypeFacet.d.ts +4 -4
  290. package/dist/model/searchTypeFacet.d.ts.map +1 -1
  291. package/dist/model/searchUserIdsParams.d.ts +21 -21
  292. package/dist/model/searchUserIdsParams.d.ts.map +1 -1
  293. package/dist/model/searchUserIdsResponse.d.ts +26 -26
  294. package/dist/model/searchUserIdsResponse.d.ts.map +1 -1
  295. package/dist/model/semanticSearch.d.ts +10 -0
  296. package/dist/model/semanticSearch.d.ts.map +1 -0
  297. package/dist/model/snippetResult.d.ts +2 -2
  298. package/dist/model/snippetResult.d.ts.map +1 -1
  299. package/dist/model/snippetResultOption.d.ts +11 -11
  300. package/dist/model/snippetResultOption.d.ts.map +1 -1
  301. package/dist/model/sortRemainingBy.d.ts +4 -4
  302. package/dist/model/sortRemainingBy.d.ts.map +1 -1
  303. package/dist/model/source.d.ts +13 -13
  304. package/dist/model/source.d.ts.map +1 -1
  305. package/dist/model/standardEntries.d.ts +17 -17
  306. package/dist/model/standardEntries.d.ts.map +1 -1
  307. package/dist/model/synonymHit.d.ts +35 -37
  308. package/dist/model/synonymHit.d.ts.map +1 -1
  309. package/dist/model/synonymType.d.ts +4 -4
  310. package/dist/model/synonymType.d.ts.map +1 -1
  311. package/dist/model/tagFilters.d.ts +5 -5
  312. package/dist/model/tagFilters.d.ts.map +1 -1
  313. package/dist/model/taskStatus.d.ts +4 -1
  314. package/dist/model/taskStatus.d.ts.map +1 -1
  315. package/dist/model/timeRange.d.ts +10 -10
  316. package/dist/model/timeRange.d.ts.map +1 -1
  317. package/dist/model/typoTolerance.d.ts +5 -5
  318. package/dist/model/typoTolerance.d.ts.map +1 -1
  319. package/dist/model/typoToleranceEnum.d.ts +1 -1
  320. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  321. package/dist/model/updateApiKeyResponse.d.ts +10 -10
  322. package/dist/model/updateApiKeyResponse.d.ts.map +1 -1
  323. package/dist/model/updatedAtResponse.d.ts +13 -13
  324. package/dist/model/updatedAtResponse.d.ts.map +1 -1
  325. package/dist/model/updatedAtWithObjectIdResponse.d.ts +17 -17
  326. package/dist/model/updatedAtWithObjectIdResponse.d.ts.map +1 -1
  327. package/dist/model/updatedRuleResponse.d.ts +14 -14
  328. package/dist/model/updatedRuleResponse.d.ts.map +1 -1
  329. package/dist/model/userHighlightResult.d.ts +5 -11
  330. package/dist/model/userHighlightResult.d.ts.map +1 -1
  331. package/dist/model/userHit.d.ts +24 -24
  332. package/dist/model/userHit.d.ts.map +1 -1
  333. package/dist/model/userId.d.ts +21 -21
  334. package/dist/model/userId.d.ts.map +1 -1
  335. package/dist/model/value.d.ts +8 -8
  336. package/dist/model/value.d.ts.map +1 -1
  337. package/dist/src/searchClient.d.ts +845 -673
  338. package/dist/src/searchClient.d.ts.map +1 -1
  339. package/index.js +1 -1
  340. package/model/acl.ts +5 -1
  341. package/model/action.ts +2 -2
  342. package/model/addApiKeyResponse.ts +4 -3
  343. package/model/advancedSyntaxFeatures.ts +1 -1
  344. package/model/alternativesAsExact.ts +1 -1
  345. package/model/anchoring.ts +2 -2
  346. package/model/apiKey.ts +17 -10
  347. package/model/aroundPrecision.ts +8 -0
  348. package/model/aroundPrecisionFromValueInner.ts +7 -0
  349. package/model/aroundRadius.ts +2 -2
  350. package/model/aroundRadiusAll.ts +1 -1
  351. package/model/assignUserIdParams.ts +2 -2
  352. package/model/attributeToUpdate.ts +5 -0
  353. package/model/automaticFacetFilter.ts +3 -1
  354. package/model/automaticFacetFilters.ts +1 -1
  355. package/model/baseGetApiKeyResponse.ts +13 -0
  356. package/model/baseIndexSettings.ts +38 -15
  357. package/model/baseSearchParams.ts +1 -1
  358. package/model/baseSearchParamsWithoutQuery.ts +69 -42
  359. package/model/baseSearchResponse.ts +61 -31
  360. package/model/batchAssignUserIdsParams.ts +4 -3
  361. package/model/batchDictionaryEntriesParams.ts +5 -4
  362. package/model/batchDictionaryEntriesRequest.ts +2 -1
  363. package/model/batchParams.ts +4 -4
  364. package/model/batchRequest.ts +12 -0
  365. package/model/batchResponse.ts +4 -3
  366. package/model/batchWriteParams.ts +4 -4
  367. package/model/browseParams.ts +6 -0
  368. package/model/browseParamsObject.ts +6 -0
  369. package/model/browseResponse.ts +4 -4
  370. package/model/builtInOperation.ts +3 -2
  371. package/model/builtInOperationType.ts +2 -2
  372. package/model/clientMethodProps.ts +169 -166
  373. package/model/condition.ts +4 -1
  374. package/model/consequence.ts +10 -6
  375. package/model/consequenceHide.ts +3 -3
  376. package/model/consequenceParams.ts +1 -1
  377. package/model/consequenceQuery.ts +1 -1
  378. package/model/consequenceQueryObject.ts +2 -1
  379. package/model/createdAtResponse.ts +3 -3
  380. package/model/cursor.ts +8 -0
  381. package/model/deleteApiKeyResponse.ts +2 -2
  382. package/model/deleteByParams.ts +36 -0
  383. package/model/deleteSourceResponse.ts +2 -2
  384. package/model/deletedAtResponse.ts +5 -4
  385. package/model/dictionaryAction.ts +1 -1
  386. package/model/dictionaryEntry.ts +12 -7
  387. package/model/dictionaryEntryState.ts +2 -2
  388. package/model/dictionaryLanguage.ts +3 -3
  389. package/model/dictionarySettingsParams.ts +2 -2
  390. package/model/dictionaryType.ts +1 -1
  391. package/model/distinct.ts +6 -0
  392. package/model/edit.ts +3 -1
  393. package/model/editType.ts +1 -1
  394. package/model/errorBase.ts +1 -1
  395. package/model/exactOnSingleWordQuery.ts +2 -2
  396. package/model/exhaustive.ts +31 -0
  397. package/model/facetFilters.ts +2 -2
  398. package/model/facetHits.ts +6 -4
  399. package/model/facetOrdering.ts +4 -3
  400. package/model/facets.ts +2 -2
  401. package/model/facetsStats.ts +8 -5
  402. package/model/fetchedIndex.ts +13 -3
  403. package/model/getApiKeyResponse.ts +6 -0
  404. package/model/getDictionarySettingsResponse.ts +1 -1
  405. package/model/getLogsResponse.ts +1 -1
  406. package/model/getObjectsParams.ts +4 -4
  407. package/model/getObjectsRequest.ts +21 -0
  408. package/model/getObjectsResponse.ts +4 -4
  409. package/model/getTaskResponse.ts +1 -1
  410. package/model/getTopUserIdsResponse.ts +3 -3
  411. package/model/hasPendingMappingsResponse.ts +4 -3
  412. package/model/highlightResult.ts +5 -2
  413. package/model/highlightResultOption.ts +5 -2
  414. package/model/hit.ts +7 -3
  415. package/model/ignorePlurals.ts +2 -2
  416. package/model/index.ts +21 -10
  417. package/model/indexSettings.ts +2 -2
  418. package/model/indexSettingsAsSearchParams.ts +92 -44
  419. package/model/languages.ts +4 -2
  420. package/model/listApiKeysResponse.ts +4 -4
  421. package/model/listClustersResponse.ts +3 -3
  422. package/model/listIndicesResponse.ts +4 -3
  423. package/model/listUserIdsResponse.ts +3 -3
  424. package/model/log.ts +22 -8
  425. package/model/logQuery.ts +4 -2
  426. package/model/logType.ts +1 -1
  427. package/model/matchLevel.ts +1 -1
  428. package/model/matchedGeoLocation.ts +3 -1
  429. package/model/mixedSearchFilters.ts +1 -1
  430. package/model/mode.ts +6 -0
  431. package/model/multipleBatchRequest.ts +17 -0
  432. package/model/multipleBatchResponse.ts +6 -5
  433. package/model/numericFilters.ts +2 -2
  434. package/model/operationIndexParams.ts +5 -3
  435. package/model/operationType.ts +2 -2
  436. package/model/optionalFilters.ts +2 -2
  437. package/model/params.ts +5 -2
  438. package/model/personalization.ts +3 -1
  439. package/model/promote.ts +1 -1
  440. package/model/promoteObjectID.ts +5 -4
  441. package/model/promoteObjectIDs.ts +5 -4
  442. package/model/queryType.ts +2 -2
  443. package/model/rankingInfo.ts +13 -1
  444. package/model/reRankingApplyFilter.ts +2 -2
  445. package/model/redirect.ts +10 -0
  446. package/model/redirectRuleIndexMetadata.ts +27 -0
  447. package/model/redirectRuleIndexMetadataData.ts +8 -0
  448. package/model/removeStopWords.ts +2 -2
  449. package/model/removeUserIdResponse.ts +2 -2
  450. package/model/removeWordsIfNoResults.ts +2 -2
  451. package/model/renderingContent.ts +2 -2
  452. package/model/replaceSourceResponse.ts +2 -2
  453. package/model/rule.ts +11 -6
  454. package/model/saveObjectResponse.ts +10 -5
  455. package/model/saveSynonymResponse.ts +6 -4
  456. package/model/scopeType.ts +1 -1
  457. package/model/searchDictionaryEntriesParams.ts +9 -6
  458. package/model/searchForFacetValuesRequest.ts +5 -3
  459. package/model/searchForFacetValuesResponse.ts +11 -1
  460. package/model/searchForFacets.ts +1 -1
  461. package/model/searchForFacetsOptions.ts +8 -4
  462. package/model/searchForHits.ts +1 -1
  463. package/model/searchForHitsOptions.ts +3 -2
  464. package/model/searchHits.ts +13 -3
  465. package/model/searchMethodParams.ts +2 -1
  466. package/model/searchParams.ts +1 -1
  467. package/model/searchParamsObject.ts +1 -1
  468. package/model/searchParamsQuery.ts +2 -2
  469. package/model/searchParamsString.ts +2 -2
  470. package/model/searchQuery.ts +1 -1
  471. package/model/searchResponse.ts +3 -2
  472. package/model/searchResponses.ts +4 -4
  473. package/model/searchResult.ts +8 -0
  474. package/model/searchRulesParams.ts +15 -9
  475. package/model/searchRulesResponse.ts +4 -1
  476. package/model/searchStrategy.ts +4 -1
  477. package/model/searchSynonymsParams.ts +16 -2
  478. package/model/searchSynonymsResponse.ts +4 -3
  479. package/model/searchTypeDefault.ts +2 -2
  480. package/model/searchTypeFacet.ts +2 -2
  481. package/model/searchUserIdsParams.ts +8 -5
  482. package/model/searchUserIdsResponse.ts +10 -6
  483. package/model/semanticSearch.ts +11 -0
  484. package/model/snippetResult.ts +5 -2
  485. package/model/snippetResultOption.ts +3 -2
  486. package/model/sortRemainingBy.ts +2 -2
  487. package/model/source.ts +5 -4
  488. package/model/standardEntries.ts +7 -5
  489. package/model/synonymHit.ts +14 -9
  490. package/model/synonymType.ts +2 -2
  491. package/model/tagFilters.ts +2 -2
  492. package/model/taskStatus.ts +4 -1
  493. package/model/timeRange.ts +2 -1
  494. package/model/typoTolerance.ts +2 -2
  495. package/model/typoToleranceEnum.ts +1 -1
  496. package/model/updateApiKeyResponse.ts +4 -3
  497. package/model/updatedAtResponse.ts +5 -4
  498. package/model/updatedAtWithObjectIdResponse.ts +7 -5
  499. package/model/updatedRuleResponse.ts +6 -4
  500. package/model/userHighlightResult.ts +4 -9
  501. package/model/userHit.ts +7 -2
  502. package/model/userId.ts +6 -3
  503. package/model/value.ts +2 -1
  504. package/package.json +32 -13
  505. package/dist/model/attributeOrBuiltInOperation.d.ts +0 -3
  506. package/dist/model/attributeOrBuiltInOperation.d.ts.map +0 -1
  507. package/dist/model/baseBrowseResponse.d.ts +0 -7
  508. package/dist/model/baseBrowseResponse.d.ts.map +0 -1
  509. package/dist/model/batchOperation.d.ts +0 -9
  510. package/dist/model/batchOperation.d.ts.map +0 -1
  511. package/dist/model/browseRequest.d.ts +0 -11
  512. package/dist/model/browseRequest.d.ts.map +0 -1
  513. package/dist/model/createdAtObject.d.ts +0 -7
  514. package/dist/model/createdAtObject.d.ts.map +0 -1
  515. package/dist/model/key.d.ts +0 -4
  516. package/dist/model/key.d.ts.map +0 -1
  517. package/dist/model/multipleBatchOperation.d.ts +0 -13
  518. package/dist/model/multipleBatchOperation.d.ts.map +0 -1
  519. package/dist/model/multipleGetObjectsParams.d.ts +0 -18
  520. package/dist/model/multipleGetObjectsParams.d.ts.map +0 -1
  521. package/dist/model/synonymHitHighlightResult.d.ts +0 -12
  522. package/dist/model/synonymHitHighlightResult.d.ts.map +0 -1
  523. package/model/attributeOrBuiltInOperation.ts +0 -5
  524. package/model/baseBrowseResponse.ts +0 -8
  525. package/model/batchOperation.ts +0 -11
  526. package/model/browseRequest.ts +0 -12
  527. package/model/createdAtObject.ts +0 -8
  528. package/model/key.ts +0 -6
  529. package/model/multipleBatchOperation.ts +0 -15
  530. package/model/multipleGetObjectsParams.ts +0 -19
  531. package/model/synonymHitHighlightResult.ts +0 -14
@@ -1,6 +1,5 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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 type { SynonymHitHighlightResult } from './synonymHitHighlightResult';
4
3
  import type { SynonymType } from './synonymType';
5
4
 
6
5
  /**
@@ -8,33 +7,39 @@ import type { SynonymType } from './synonymType';
8
7
  */
9
8
  export type SynonymHit = {
10
9
  /**
11
- * Unique identifier of the synonym object to be created or updated.
10
+ * Unique identifier of a synonym object.
12
11
  */
13
12
  objectID: string;
13
+
14
14
  type: SynonymType;
15
+
15
16
  /**
16
- * Words or phrases to be considered equivalent.
17
+ * Words or phrases considered equivalent.
17
18
  */
18
19
  synonyms?: string[];
20
+
19
21
  /**
20
- * Word or phrase to appear in query strings (for onewaysynonym).
22
+ * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
21
23
  */
22
24
  input?: string;
25
+
23
26
  /**
24
- * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
27
+ * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
25
28
  */
26
29
  word?: string;
30
+
27
31
  /**
28
32
  * Words to be matched in records.
29
33
  */
30
34
  corrections?: string[];
35
+
31
36
  /**
32
- * Token to be put inside records.
37
+ * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
33
38
  */
34
39
  placeholder?: string;
40
+
35
41
  /**
36
- * List of query words that will match the token.
42
+ * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
37
43
  */
38
44
  replacements?: string[];
39
- _highlightResult?: SynonymHitHighlightResult;
40
45
  };
@@ -1,7 +1,7 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  /**
4
- * Type of the synonym object.
4
+ * Synonym type.
5
5
  */
6
6
  export type SynonymType =
7
7
  | 'altcorrection1'
@@ -1,8 +1,8 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  import type { MixedSearchFilters } from './mixedSearchFilters';
4
4
 
5
5
  /**
6
- * Filter hits by tags.
6
+ * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
7
7
  */
8
8
  export type TagFilters = MixedSearchFilters[] | string;
@@ -1,3 +1,6 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
+ /**
4
+ * _published_ if the task has been processed, _notPublished_ otherwise.
5
+ */
3
6
  export type TaskStatus = 'notPublished' | 'published';
@@ -1,10 +1,11 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  export type TimeRange = {
4
4
  /**
5
5
  * Lower bound of the time range (Unix timestamp).
6
6
  */
7
7
  from: number;
8
+
8
9
  /**
9
10
  * Upper bound of the time range (Unix timestamp).
10
11
  */
@@ -1,8 +1,8 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  import type { TypoToleranceEnum } from './typoToleranceEnum';
4
4
 
5
5
  /**
6
- * Controls whether typo tolerance is enabled and how it is applied.
6
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
7
7
  */
8
8
  export type TypoTolerance = TypoToleranceEnum | boolean;
@@ -1,3 +1,3 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  export type TypoToleranceEnum = 'min' | 'strict';
@@ -1,12 +1,13 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  export type UpdateApiKeyResponse = {
4
4
  /**
5
- * Key string.
5
+ * API key.
6
6
  */
7
7
  key: string;
8
+
8
9
  /**
9
- * Date of last update (ISO-8601 format).
10
+ * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
10
11
  */
11
12
  updatedAt: string;
12
13
  };
@@ -1,15 +1,16 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  /**
4
- * The response with a taskID and an updatedAt timestamp.
4
+ * Response, taskID, and update timestamp.
5
5
  */
6
6
  export type UpdatedAtResponse = {
7
7
  /**
8
- * TaskID of the task to wait for.
8
+ * 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`.
9
9
  */
10
10
  taskID: number;
11
+
11
12
  /**
12
- * Date of last update (ISO-8601 format).
13
+ * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
13
14
  */
14
15
  updatedAt: string;
15
16
  };
@@ -1,19 +1,21 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  /**
4
- * The response with a taskID, an objectID and an updatedAt timestamp.
4
+ * Response, taskID, unique object identifier, and an update timestamp.
5
5
  */
6
6
  export type UpdatedAtWithObjectIdResponse = {
7
7
  /**
8
- * TaskID of the task to wait for.
8
+ * 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`.
9
9
  */
10
10
  taskID?: number;
11
+
11
12
  /**
12
- * Date of last update (ISO-8601 format).
13
+ * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
13
14
  */
14
15
  updatedAt?: string;
16
+
15
17
  /**
16
- * Unique identifier of the object.
18
+ * Unique object identifier.
17
19
  */
18
20
  objectID?: string;
19
21
  };
@@ -1,16 +1,18 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  export type UpdatedRuleResponse = {
4
4
  /**
5
- * Unique identifier of the object.
5
+ * Unique object identifier.
6
6
  */
7
7
  objectID: string;
8
+
8
9
  /**
9
- * Date of last update (ISO-8601 format).
10
+ * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
10
11
  */
11
12
  updatedAt: string;
13
+
12
14
  /**
13
- * TaskID of the task to wait for.
15
+ * 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`.
14
16
  */
15
17
  taskID: number;
16
18
  };
@@ -1,14 +1,9 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  import type { HighlightResult } from './highlightResult';
4
4
 
5
5
  export type UserHighlightResult = {
6
- /**
7
- * Show highlighted section and words matched on a query.
8
- */
9
- userID: Record<string, HighlightResult>;
10
- /**
11
- * Show highlighted section and words matched on a query.
12
- */
13
- clusterName: Record<string, HighlightResult>;
6
+ userID: HighlightResult;
7
+
8
+ clusterName: HighlightResult;
14
9
  };
package/model/userHit.ts CHANGED
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  import type { UserHighlightResult } from './userHighlightResult';
4
4
 
@@ -7,21 +7,26 @@ export type UserHit = {
7
7
  * UserID of the user.
8
8
  */
9
9
  userID: string;
10
+
10
11
  /**
11
- * Name of the cluster.
12
+ * Cluster name.
12
13
  */
13
14
  clusterName: string;
15
+
14
16
  /**
15
17
  * Number of records in the cluster.
16
18
  */
17
19
  nbRecords: number;
20
+
18
21
  /**
19
22
  * Data size taken by all the users assigned to the cluster.
20
23
  */
21
24
  dataSize: number;
25
+
22
26
  /**
23
27
  * UserID of the requested user. Same as userID.
24
28
  */
25
29
  objectID: string;
30
+
26
31
  _highlightResult: UserHighlightResult;
27
32
  };
package/model/userId.ts CHANGED
@@ -1,21 +1,24 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  /**
4
- * A userID.
4
+ * Unique user ID.
5
5
  */
6
6
  export type UserId = {
7
7
  /**
8
8
  * UserID of the user.
9
9
  */
10
10
  userID: string;
11
+
11
12
  /**
12
- * Cluster on which the user is assigned.
13
+ * Cluster to which the user is assigned.
13
14
  */
14
15
  clusterName: string;
16
+
15
17
  /**
16
18
  * Number of records belonging to the user.
17
19
  */
18
20
  nbRecords: number;
21
+
19
22
  /**
20
23
  * Data size used by the user.
21
24
  */
package/model/value.ts CHANGED
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
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
3
  import type { SortRemainingBy } from './sortRemainingBy';
4
4
 
@@ -7,5 +7,6 @@ export type Value = {
7
7
  * Pinned order of facet lists.
8
8
  */
9
9
  order?: string[];
10
+
10
11
  sortRemainingBy?: SortRemainingBy;
11
12
  };
package/package.json CHANGED
@@ -1,16 +1,33 @@
1
1
  {
2
2
  "name": "@algolia/client-search",
3
- "version": "5.0.0-alpha.1",
3
+ "version": "5.0.0-alpha.100",
4
4
  "description": "JavaScript client for client-search",
5
5
  "repository": "algolia/algoliasearch-client-javascript",
6
6
  "license": "MIT",
7
7
  "author": "Algolia",
8
- "main": "index.js",
9
- "jsdelivr": "dist/client-search.umd.js",
10
- "unpkg": "dist/client-search.umd.js",
11
- "module": "dist/client-search.esm.node.js",
12
- "browser": "dist/client-search.umd.js",
13
- "types": "index.d.ts",
8
+ "type": "module",
9
+ "exports": {
10
+ ".": {
11
+ "node": {
12
+ "import": "./dist/client-search.esm.node.js",
13
+ "module": "./dist/client-search.esm.node.js",
14
+ "require": "./dist/client-search.cjs",
15
+ "default": "./dist/client-search.cjs"
16
+ },
17
+ "default": {
18
+ "umd": "./dist/client-search.umd.js",
19
+ "module": "./dist/client-search.esm.browser.js",
20
+ "import": "./dist/client-search.esm.browser.js",
21
+ "default": "./dist/client-search.umd.js"
22
+ }
23
+ },
24
+ "./src/*": "./src/*.ts",
25
+ "./model": "./model/index.ts"
26
+ },
27
+ "jsdelivr": "./dist/client-search.umd.js",
28
+ "unpkg": "./dist/client-search.umd.js",
29
+ "browser": "./dist/client-search.umd.js",
30
+ "types": "./index.d.ts",
14
31
  "files": [
15
32
  "dist",
16
33
  "model",
@@ -18,16 +35,18 @@
18
35
  "index.d.ts"
19
36
  ],
20
37
  "scripts": {
21
- "clean": "rm -rf ./dist"
38
+ "build": "yarn clean && rollup --config",
39
+ "clean": "rm -rf ./dist || true"
22
40
  },
23
41
  "dependencies": {
24
- "@algolia/client-common": "5.0.0-alpha.1",
25
- "@algolia/requester-browser-xhr": "5.0.0-alpha.1",
26
- "@algolia/requester-node-http": "5.0.0-alpha.1"
42
+ "@algolia/client-common": "5.0.0-alpha.101",
43
+ "@algolia/requester-browser-xhr": "5.0.0-alpha.101",
44
+ "@algolia/requester-node-http": "5.0.0-alpha.101"
27
45
  },
28
46
  "devDependencies": {
29
- "@types/node": "16.11.45",
30
- "typescript": "4.7.4"
47
+ "@types/node": "20.11.0",
48
+ "rollup": "4.9.6",
49
+ "typescript": "5.3.3"
31
50
  },
32
51
  "engines": {
33
52
  "node": ">= 14.0.0"
@@ -1,3 +0,0 @@
1
- import type { BuiltInOperation } from './builtInOperation';
2
- export declare type AttributeOrBuiltInOperation = BuiltInOperation | string;
3
- //# sourceMappingURL=attributeOrBuiltInOperation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"attributeOrBuiltInOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/attributeOrBuiltInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,2BAA2B,GAAG,gBAAgB,GAAG,MAAM,CAAC"}
@@ -1,7 +0,0 @@
1
- export declare type BaseBrowseResponse = {
2
- /**
3
- * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
4
- */
5
- cursor: string;
6
- };
7
- //# sourceMappingURL=baseBrowseResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseBrowseResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/baseBrowseResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
@@ -1,9 +0,0 @@
1
- import type { Action } from './action';
2
- export declare type BatchOperation = {
3
- action?: Action;
4
- /**
5
- * Arguments to the operation (depends on the type of the operation).
6
- */
7
- body?: Record<string, any>;
8
- };
9
- //# sourceMappingURL=batchOperation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"batchOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/batchOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC"}
@@ -1,11 +0,0 @@
1
- export declare type BrowseRequest = {
2
- /**
3
- * Search parameters as URL-encoded query string.
4
- */
5
- params?: string;
6
- /**
7
- * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
8
- */
9
- cursor?: string;
10
- };
11
- //# sourceMappingURL=browseRequest.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"browseRequest.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/browseRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
@@ -1,7 +0,0 @@
1
- export declare type CreatedAtObject = {
2
- /**
3
- * Date of creation (ISO-8601 format).
4
- */
5
- createdAt: string;
6
- };
7
- //# sourceMappingURL=createdAtObject.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createdAtObject.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/createdAtObject.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { ApiKey } from './apiKey';
2
- import type { CreatedAtObject } from './createdAtObject';
3
- export declare type Key = ApiKey & CreatedAtObject;
4
- //# sourceMappingURL=key.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}
@@ -1,13 +0,0 @@
1
- import type { Action } from './action';
2
- export declare type MultipleBatchOperation = {
3
- action?: Action;
4
- /**
5
- * Arguments to the operation (depends on the type of the operation).
6
- */
7
- body?: Record<string, any>;
8
- /**
9
- * Index to target for this operation.
10
- */
11
- indexName?: string;
12
- };
13
- //# sourceMappingURL=multipleBatchOperation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"multipleBatchOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/multipleBatchOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}
@@ -1,18 +0,0 @@
1
- /**
2
- * GetObjects operation on an index.
3
- */
4
- export declare type MultipleGetObjectsParams = {
5
- /**
6
- * List of attributes to retrieve. By default, all retrievable attributes are returned.
7
- */
8
- attributesToRetrieve?: string[];
9
- /**
10
- * ID of the object within that index.
11
- */
12
- objectID: string;
13
- /**
14
- * Name of the index containing the object.
15
- */
16
- indexName: string;
17
- };
18
- //# sourceMappingURL=multipleGetObjectsParams.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"multipleGetObjectsParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/multipleGetObjectsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,12 +0,0 @@
1
- import type { HighlightResult } from './highlightResult';
2
- /**
3
- * Highlighted results.
4
- */
5
- export declare type SynonymHitHighlightResult = {
6
- /**
7
- * Show highlighted section and words matched on a query.
8
- */
9
- type?: Record<string, HighlightResult>;
10
- synonyms?: Array<Record<string, HighlightResult>>;
11
- };
12
- //# sourceMappingURL=synonymHitHighlightResult.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"synonymHitHighlightResult.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/synonymHitHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACvC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CACnD,CAAC"}
@@ -1,5 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- import type { BuiltInOperation } from './builtInOperation';
4
-
5
- export type AttributeOrBuiltInOperation = BuiltInOperation | string;
@@ -1,8 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- export type BaseBrowseResponse = {
4
- /**
5
- * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
6
- */
7
- cursor: string;
8
- };
@@ -1,11 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- import type { Action } from './action';
4
-
5
- export type BatchOperation = {
6
- action?: Action;
7
- /**
8
- * Arguments to the operation (depends on the type of the operation).
9
- */
10
- body?: Record<string, any>;
11
- };
@@ -1,12 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- export type BrowseRequest = {
4
- /**
5
- * Search parameters as URL-encoded query string.
6
- */
7
- params?: string;
8
- /**
9
- * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
10
- */
11
- cursor?: string;
12
- };
@@ -1,8 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- export type CreatedAtObject = {
4
- /**
5
- * Date of creation (ISO-8601 format).
6
- */
7
- createdAt: string;
8
- };
package/model/key.ts DELETED
@@ -1,6 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- import type { ApiKey } from './apiKey';
4
- import type { CreatedAtObject } from './createdAtObject';
5
-
6
- export type Key = ApiKey & CreatedAtObject;
@@ -1,15 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- import type { Action } from './action';
4
-
5
- export type MultipleBatchOperation = {
6
- action?: Action;
7
- /**
8
- * Arguments to the operation (depends on the type of the operation).
9
- */
10
- body?: Record<string, any>;
11
- /**
12
- * Index to target for this operation.
13
- */
14
- indexName?: string;
15
- };
@@ -1,19 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- /**
4
- * GetObjects operation on an index.
5
- */
6
- export type MultipleGetObjectsParams = {
7
- /**
8
- * List of attributes to retrieve. By default, all retrievable attributes are returned.
9
- */
10
- attributesToRetrieve?: string[];
11
- /**
12
- * ID of the object within that index.
13
- */
14
- objectID: string;
15
- /**
16
- * Name of the index containing the object.
17
- */
18
- indexName: string;
19
- };
@@ -1,14 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- import type { HighlightResult } from './highlightResult';
4
-
5
- /**
6
- * Highlighted results.
7
- */
8
- export type SynonymHitHighlightResult = {
9
- /**
10
- * Show highlighted section and words matched on a query.
11
- */
12
- type?: Record<string, HighlightResult>;
13
- synonyms?: Array<Record<string, HighlightResult>>;
14
- };