@algolia/recommend 5.0.0-alpha.11 → 5.0.0-alpha.111

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 (316) hide show
  1. package/dist/builds/browser.d.ts +23 -5
  2. package/dist/builds/browser.d.ts.map +1 -1
  3. package/dist/builds/node.d.ts +23 -5
  4. package/dist/builds/node.d.ts.map +1 -1
  5. package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
  6. package/dist/model/advancedSyntaxFeatures.d.ts.map +1 -1
  7. package/dist/model/alternativesAsExact.d.ts +1 -1
  8. package/dist/model/alternativesAsExact.d.ts.map +1 -1
  9. package/dist/model/aroundPrecision.d.ts +6 -0
  10. package/dist/model/aroundPrecision.d.ts.map +1 -0
  11. package/dist/model/aroundPrecisionFromValueInner.d.ts +14 -0
  12. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -0
  13. package/dist/model/aroundRadius.d.ts +5 -5
  14. package/dist/model/aroundRadius.d.ts.map +1 -1
  15. package/dist/model/aroundRadiusAll.d.ts +4 -1
  16. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  17. package/dist/model/autoFacetFilter.d.ts +14 -0
  18. package/dist/model/autoFacetFilter.d.ts.map +1 -0
  19. package/dist/model/baseRecommendRequest.d.ts +16 -17
  20. package/dist/model/baseRecommendRequest.d.ts.map +1 -1
  21. package/dist/model/baseSearchParams.d.ts +3 -3
  22. package/dist/model/baseSearchParams.d.ts.map +1 -1
  23. package/dist/model/baseSearchParamsWithoutQuery.d.ts +114 -122
  24. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  25. package/dist/model/baseSearchResponse.d.ts +109 -101
  26. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  27. package/dist/model/boughtTogetherQuery.d.ts +4 -0
  28. package/dist/model/boughtTogetherQuery.d.ts.map +1 -0
  29. package/dist/model/clientMethodProps.d.ts +127 -60
  30. package/dist/model/clientMethodProps.d.ts.map +1 -1
  31. package/dist/model/condition.d.ts +14 -0
  32. package/dist/model/condition.d.ts.map +1 -0
  33. package/dist/model/consequence.d.ts +18 -0
  34. package/dist/model/consequence.d.ts.map +1 -0
  35. package/dist/model/deletedAtResponse.d.ts +14 -0
  36. package/dist/model/deletedAtResponse.d.ts.map +1 -0
  37. package/dist/model/distinct.d.ts +4 -4
  38. package/dist/model/distinct.d.ts.map +1 -1
  39. package/dist/model/errorBase.d.ts +6 -6
  40. package/dist/model/errorBase.d.ts.map +1 -1
  41. package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
  42. package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
  43. package/dist/model/exhaustive.d.ts +26 -0
  44. package/dist/model/exhaustive.d.ts.map +1 -0
  45. package/dist/model/facetFilters.d.ts +5 -5
  46. package/dist/model/facetFilters.d.ts.map +1 -1
  47. package/dist/model/facetOrdering.d.ts +12 -12
  48. package/dist/model/facetOrdering.d.ts.map +1 -1
  49. package/dist/model/facets.d.ts +9 -9
  50. package/dist/model/facets.d.ts.map +1 -1
  51. package/dist/model/facetsStats.d.ts +18 -18
  52. package/dist/model/facetsStats.d.ts.map +1 -1
  53. package/dist/model/fallbackParams.d.ts +3 -0
  54. package/dist/model/fallbackParams.d.ts.map +1 -0
  55. package/dist/model/fbtModel.d.ts +5 -0
  56. package/dist/model/fbtModel.d.ts.map +1 -0
  57. package/dist/model/frequentlyBoughtTogether.d.ts +9 -0
  58. package/dist/model/frequentlyBoughtTogether.d.ts.map +1 -0
  59. package/dist/model/getRecommendTaskResponse.d.ts +5 -0
  60. package/dist/model/getRecommendTaskResponse.d.ts.map +1 -0
  61. package/dist/model/getRecommendationsParams.d.ts +10 -10
  62. package/dist/model/getRecommendationsParams.d.ts.map +1 -1
  63. package/dist/model/getRecommendationsResponse.d.ts +4 -4
  64. package/dist/model/getRecommendationsResponse.d.ts.map +1 -1
  65. package/dist/model/hideConsequenceObject.d.ts +10 -0
  66. package/dist/model/hideConsequenceObject.d.ts.map +1 -0
  67. package/dist/model/highlightResult.d.ts +2 -2
  68. package/dist/model/highlightResult.d.ts.map +1 -1
  69. package/dist/model/highlightResultOption.d.ts +19 -19
  70. package/dist/model/highlightResultOption.d.ts.map +1 -1
  71. package/dist/model/ignorePlurals.d.ts +5 -4
  72. package/dist/model/ignorePlurals.d.ts.map +1 -1
  73. package/dist/model/index.d.ts +92 -53
  74. package/dist/model/index.d.ts.map +1 -1
  75. package/dist/model/indexSettingsAsSearchParams.d.ts +159 -160
  76. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  77. package/dist/model/lookingSimilar.d.ts +11 -0
  78. package/dist/model/lookingSimilar.d.ts.map +1 -0
  79. package/dist/model/lookingSimilarModel.d.ts +5 -0
  80. package/dist/model/lookingSimilarModel.d.ts.map +1 -0
  81. package/dist/model/lookingSimilarQuery.d.ts +4 -0
  82. package/dist/model/lookingSimilarQuery.d.ts.map +1 -0
  83. package/dist/model/matchLevel.d.ts +4 -4
  84. package/dist/model/matchLevel.d.ts.map +1 -1
  85. package/dist/model/matchedGeoLocation.d.ts +14 -14
  86. package/dist/model/matchedGeoLocation.d.ts.map +1 -1
  87. package/dist/model/mixedSearchFilters.d.ts +1 -1
  88. package/dist/model/mixedSearchFilters.d.ts.map +1 -1
  89. package/dist/model/mode.d.ts +5 -0
  90. package/dist/model/mode.d.ts.map +1 -0
  91. package/dist/model/numericFilters.d.ts +5 -5
  92. package/dist/model/numericFilters.d.ts.map +1 -1
  93. package/dist/model/optionalFilters.d.ts +5 -5
  94. package/dist/model/optionalFilters.d.ts.map +1 -1
  95. package/dist/model/paramsConsequence.d.ts +19 -0
  96. package/dist/model/paramsConsequence.d.ts.map +1 -0
  97. package/dist/model/personalization.d.ts +14 -14
  98. package/dist/model/personalization.d.ts.map +1 -1
  99. package/dist/model/promoteConsequenceObject.d.ts +14 -0
  100. package/dist/model/promoteConsequenceObject.d.ts.map +1 -0
  101. package/dist/model/queryType.d.ts +4 -4
  102. package/dist/model/queryType.d.ts.map +1 -1
  103. package/dist/model/rankingInfo.d.ts +53 -50
  104. package/dist/model/rankingInfo.d.ts.map +1 -1
  105. package/dist/model/reRankingApplyFilter.d.ts +5 -5
  106. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  107. package/dist/model/recommendHit.d.ts +26 -26
  108. package/dist/model/recommendHit.d.ts.map +1 -1
  109. package/dist/model/recommendModels.d.ts +2 -0
  110. package/dist/model/recommendModels.d.ts.map +1 -0
  111. package/dist/model/recommendRule.d.ts +24 -0
  112. package/dist/model/recommendRule.d.ts.map +1 -0
  113. package/dist/model/recommendRuleMetadata.d.ts +10 -0
  114. package/dist/model/recommendRuleMetadata.d.ts.map +1 -0
  115. package/dist/model/recommendationsHit.d.ts +4 -0
  116. package/dist/model/recommendationsHit.d.ts.map +1 -0
  117. package/dist/model/recommendationsHits.d.ts +5 -0
  118. package/dist/model/recommendationsHits.d.ts.map +1 -0
  119. package/dist/model/recommendationsRequest.d.ts +7 -3
  120. package/dist/model/recommendationsRequest.d.ts.map +1 -1
  121. package/dist/model/recommendationsResults.d.ts +4 -0
  122. package/dist/model/recommendationsResults.d.ts.map +1 -0
  123. package/dist/model/recommendedForYou.d.ts +7 -0
  124. package/dist/model/recommendedForYou.d.ts.map +1 -0
  125. package/dist/model/recommendedForYouModel.d.ts +5 -0
  126. package/dist/model/recommendedForYouModel.d.ts.map +1 -0
  127. package/dist/model/recommendedForYouQuery.d.ts +4 -0
  128. package/dist/model/recommendedForYouQuery.d.ts.map +1 -0
  129. package/dist/model/redirect.d.ts +8 -0
  130. package/dist/model/redirect.d.ts.map +1 -0
  131. package/dist/model/redirectRuleIndexMetadata.d.ts +21 -0
  132. package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  133. package/dist/model/redirectRuleIndexMetadataData.d.ts +7 -0
  134. package/dist/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  135. package/dist/model/relatedModel.d.ts +5 -0
  136. package/dist/model/relatedModel.d.ts.map +1 -0
  137. package/dist/model/relatedProducts.d.ts +11 -0
  138. package/dist/model/relatedProducts.d.ts.map +1 -0
  139. package/dist/model/relatedQuery.d.ts +4 -0
  140. package/dist/model/relatedQuery.d.ts.map +1 -0
  141. package/dist/model/removeStopWords.d.ts +5 -4
  142. package/dist/model/removeStopWords.d.ts.map +1 -1
  143. package/dist/model/removeWordsIfNoResults.d.ts +4 -4
  144. package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
  145. package/dist/model/renderingContent.d.ts +7 -7
  146. package/dist/model/renderingContent.d.ts.map +1 -1
  147. package/dist/model/searchParams.d.ts +3 -0
  148. package/dist/model/searchParams.d.ts.map +1 -0
  149. package/dist/model/searchParamsObject.d.ts +3 -3
  150. package/dist/model/searchParamsObject.d.ts.map +1 -1
  151. package/dist/model/searchParamsQuery.d.ts +6 -6
  152. package/dist/model/searchParamsQuery.d.ts.map +1 -1
  153. package/dist/model/searchRecommendRulesParams.d.ts +38 -0
  154. package/dist/model/searchRecommendRulesParams.d.ts.map +1 -0
  155. package/dist/model/searchRecommendRulesResponse.d.ts +20 -0
  156. package/dist/model/searchRecommendRulesResponse.d.ts.map +1 -0
  157. package/dist/model/semanticSearch.d.ts +10 -0
  158. package/dist/model/semanticSearch.d.ts.map +1 -0
  159. package/dist/model/snippetResult.d.ts +2 -2
  160. package/dist/model/snippetResult.d.ts.map +1 -1
  161. package/dist/model/snippetResultOption.d.ts +11 -11
  162. package/dist/model/snippetResultOption.d.ts.map +1 -1
  163. package/dist/model/sortRemainingBy.d.ts +4 -4
  164. package/dist/model/sortRemainingBy.d.ts.map +1 -1
  165. package/dist/model/supportedLanguage.d.ts +5 -0
  166. package/dist/model/supportedLanguage.d.ts.map +1 -0
  167. package/dist/model/tagFilters.d.ts +5 -5
  168. package/dist/model/tagFilters.d.ts.map +1 -1
  169. package/dist/model/taskStatus.d.ts +5 -0
  170. package/dist/model/taskStatus.d.ts.map +1 -0
  171. package/dist/model/trendingFacetHit.d.ts +18 -0
  172. package/dist/model/trendingFacetHit.d.ts.map +1 -0
  173. package/dist/model/trendingFacets.d.ts +11 -0
  174. package/dist/model/trendingFacets.d.ts.map +1 -0
  175. package/dist/model/trendingFacetsModel.d.ts +5 -0
  176. package/dist/model/trendingFacetsModel.d.ts.map +1 -0
  177. package/dist/model/trendingFacetsQuery.d.ts +4 -0
  178. package/dist/model/trendingFacetsQuery.d.ts.map +1 -0
  179. package/dist/model/trendingItems.d.ts +15 -0
  180. package/dist/model/trendingItems.d.ts.map +1 -0
  181. package/dist/model/trendingItemsModel.d.ts +5 -0
  182. package/dist/model/trendingItemsModel.d.ts.map +1 -0
  183. package/dist/model/trendingItemsQuery.d.ts +4 -0
  184. package/dist/model/trendingItemsQuery.d.ts.map +1 -0
  185. package/dist/model/typoTolerance.d.ts +5 -5
  186. package/dist/model/typoTolerance.d.ts.map +1 -1
  187. package/dist/model/typoToleranceEnum.d.ts +4 -1
  188. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  189. package/dist/model/value.d.ts +8 -8
  190. package/dist/model/value.d.ts.map +1 -1
  191. package/dist/recommend.cjs +390 -0
  192. package/dist/recommend.esm.browser.js +589 -475
  193. package/dist/recommend.esm.node.js +379 -235
  194. package/dist/recommend.umd.js +2 -2
  195. package/dist/src/recommendClient.d.ts +131 -81
  196. package/dist/src/recommendClient.d.ts.map +1 -1
  197. package/index.js +1 -1
  198. package/model/advancedSyntaxFeatures.ts +1 -1
  199. package/model/alternativesAsExact.ts +1 -1
  200. package/model/aroundPrecision.ts +8 -0
  201. package/model/aroundPrecisionFromValueInner.ts +16 -0
  202. package/model/aroundRadius.ts +2 -2
  203. package/model/aroundRadiusAll.ts +4 -1
  204. package/model/autoFacetFilter.ts +16 -0
  205. package/model/baseRecommendRequest.ts +6 -8
  206. package/model/baseSearchParams.ts +1 -1
  207. package/model/baseSearchParamsWithoutQuery.ts +36 -46
  208. package/model/baseSearchResponse.ts +42 -31
  209. package/model/boughtTogetherQuery.ts +7 -0
  210. package/model/clientMethodProps.ts +91 -19
  211. package/model/condition.ts +16 -0
  212. package/model/consequence.ts +22 -0
  213. package/model/deletedAtResponse.ts +16 -0
  214. package/model/distinct.ts +2 -2
  215. package/model/errorBase.ts +1 -1
  216. package/model/exactOnSingleWordQuery.ts +2 -2
  217. package/model/exhaustive.ts +31 -0
  218. package/model/facetFilters.ts +2 -2
  219. package/model/facetOrdering.ts +3 -3
  220. package/model/facets.ts +3 -3
  221. package/model/facetsStats.ts +5 -5
  222. package/model/fallbackParams.ts +5 -0
  223. package/model/fbtModel.ts +6 -0
  224. package/model/frequentlyBoughtTogether.ts +12 -0
  225. package/model/getRecommendTaskResponse.ts +7 -0
  226. package/model/getRecommendationsParams.ts +3 -3
  227. package/model/getRecommendationsResponse.ts +3 -3
  228. package/model/hideConsequenceObject.ts +11 -0
  229. package/model/highlightResult.ts +5 -2
  230. package/model/highlightResultOption.ts +4 -4
  231. package/model/ignorePlurals.ts +5 -3
  232. package/model/index.ts +48 -9
  233. package/model/indexSettingsAsSearchParams.ts +54 -54
  234. package/model/lookingSimilar.ts +15 -0
  235. package/model/lookingSimilarModel.ts +6 -0
  236. package/model/lookingSimilarQuery.ts +6 -0
  237. package/model/matchLevel.ts +2 -2
  238. package/model/matchedGeoLocation.ts +1 -1
  239. package/model/mixedSearchFilters.ts +1 -1
  240. package/model/mode.ts +6 -0
  241. package/model/numericFilters.ts +2 -2
  242. package/model/optionalFilters.ts +2 -2
  243. package/model/paramsConsequence.ts +23 -0
  244. package/model/personalization.ts +1 -1
  245. package/model/promoteConsequenceObject.ts +16 -0
  246. package/model/queryType.ts +2 -2
  247. package/model/rankingInfo.ts +11 -8
  248. package/model/reRankingApplyFilter.ts +2 -2
  249. package/model/recommendHit.ts +6 -6
  250. package/model/recommendModels.ts +7 -0
  251. package/model/recommendRule.ts +31 -0
  252. package/model/recommendRuleMetadata.ts +11 -0
  253. package/model/recommendationsHit.ts +6 -0
  254. package/model/recommendationsHits.ts +7 -0
  255. package/model/recommendationsRequest.ts +14 -4
  256. package/model/recommendationsResults.ts +6 -0
  257. package/model/recommendedForYou.ts +10 -0
  258. package/model/recommendedForYouModel.ts +6 -0
  259. package/model/recommendedForYouQuery.ts +6 -0
  260. package/model/redirect.ts +10 -0
  261. package/model/redirectRuleIndexMetadata.ts +27 -0
  262. package/model/redirectRuleIndexMetadataData.ts +8 -0
  263. package/model/relatedModel.ts +6 -0
  264. package/model/relatedProducts.ts +15 -0
  265. package/model/relatedQuery.ts +6 -0
  266. package/model/removeStopWords.ts +5 -3
  267. package/model/removeWordsIfNoResults.ts +2 -2
  268. package/model/renderingContent.ts +2 -2
  269. package/model/searchParams.ts +5 -0
  270. package/model/searchParamsObject.ts +1 -1
  271. package/model/searchParamsQuery.ts +2 -2
  272. package/model/searchRecommendRulesParams.ts +46 -0
  273. package/model/searchRecommendRulesResponse.ts +25 -0
  274. package/model/semanticSearch.ts +11 -0
  275. package/model/snippetResult.ts +5 -2
  276. package/model/snippetResultOption.ts +3 -3
  277. package/model/sortRemainingBy.ts +2 -2
  278. package/model/supportedLanguage.ts +74 -0
  279. package/model/tagFilters.ts +2 -2
  280. package/model/taskStatus.ts +6 -0
  281. package/model/trendingFacetHit.ts +21 -0
  282. package/model/trendingFacets.ts +15 -0
  283. package/model/trendingFacetsModel.ts +6 -0
  284. package/model/trendingFacetsQuery.ts +6 -0
  285. package/model/trendingItems.ts +20 -0
  286. package/model/trendingItemsModel.ts +6 -0
  287. package/model/trendingItemsQuery.ts +6 -0
  288. package/model/typoTolerance.ts +2 -2
  289. package/model/typoToleranceEnum.ts +4 -1
  290. package/model/value.ts +2 -2
  291. package/package.json +10 -9
  292. package/dist/model/baseRecommendationRequest.d.ts +0 -9
  293. package/dist/model/baseRecommendationRequest.d.ts.map +0 -1
  294. package/dist/model/baseTrendingRequest.d.ts +0 -13
  295. package/dist/model/baseTrendingRequest.d.ts.map +0 -1
  296. package/dist/model/recommendHits.d.ts +0 -5
  297. package/dist/model/recommendHits.d.ts.map +0 -1
  298. package/dist/model/recommendationModels.d.ts +0 -5
  299. package/dist/model/recommendationModels.d.ts.map +0 -1
  300. package/dist/model/recommendationRequest.d.ts +0 -4
  301. package/dist/model/recommendationRequest.d.ts.map +0 -1
  302. package/dist/model/recommendationsResponse.d.ts +0 -4
  303. package/dist/model/recommendationsResponse.d.ts.map +0 -1
  304. package/dist/model/trendingModels.d.ts +0 -5
  305. package/dist/model/trendingModels.d.ts.map +0 -1
  306. package/dist/model/trendingRequest.d.ts +0 -4
  307. package/dist/model/trendingRequest.d.ts.map +0 -1
  308. package/dist/recommend.cjs.js +0 -248
  309. package/model/baseRecommendationRequest.ts +0 -12
  310. package/model/baseTrendingRequest.ts +0 -17
  311. package/model/recommendHits.ts +0 -7
  312. package/model/recommendationModels.ts +0 -6
  313. package/model/recommendationRequest.ts +0 -7
  314. package/model/recommendationsResponse.ts +0 -6
  315. package/model/trendingModels.ts +0 -6
  316. package/model/trendingRequest.ts +0 -6
package/model/recommendHits.ts DELETED
@@ -1,7 +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 { RecommendHit } from './recommendHit';
4
-
5
- export type RecommendHits = {
6
- hits: RecommendHit[];
7
- };
package/model/recommendationModels.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
- /**
4
- * The recommendation model to use.
5
- */
6
- export type RecommendationModels = 'bought-together' | 'related-products';
package/model/recommendationRequest.ts DELETED
@@ -1,7 +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 { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { BaseRecommendationRequest } from './baseRecommendationRequest';
5
-
6
- export type RecommendationRequest = BaseRecommendationRequest &
7
- BaseRecommendRequest;
package/model/recommendationsResponse.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 { BaseSearchResponse } from './baseSearchResponse';
4
- import type { RecommendHits } from './recommendHits';
5
-
6
- export type RecommendationsResponse = BaseSearchResponse & RecommendHits;
package/model/trendingModels.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
- /**
4
- * The trending model to use.
5
- */
6
- export type TrendingModels = 'trending-facets' | 'trending-items';
package/model/trendingRequest.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 { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { BaseTrendingRequest } from './baseTrendingRequest';
5
-
6
- export type TrendingRequest = BaseRecommendRequest & BaseTrendingRequest;