@algolia/recommend 5.2.2 → 5.2.4-beta.2

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 (221) hide show
  1. package/README.md +2 -2
  2. package/dist/browser.d.ts +1300 -0
  3. package/dist/builds/browser.js +398 -0
  4. package/dist/builds/browser.js.map +1 -0
  5. package/dist/builds/browser.min.js +2 -0
  6. package/dist/builds/browser.min.js.map +1 -0
  7. package/dist/builds/browser.umd.js +12 -0
  8. package/dist/builds/node.cjs +416 -0
  9. package/dist/builds/node.cjs.map +1 -0
  10. package/dist/builds/node.js +396 -0
  11. package/dist/builds/node.js.map +1 -0
  12. package/dist/node.d.cts +1300 -0
  13. package/dist/node.d.ts +1300 -0
  14. package/dist/src/recommendClient.cjs +385 -0
  15. package/dist/src/recommendClient.cjs.map +1 -0
  16. package/dist/src/recommendClient.js +359 -0
  17. package/dist/src/recommendClient.js.map +1 -0
  18. package/index.d.ts +1 -1
  19. package/index.js +1 -1
  20. package/model/booleanString.ts +3 -0
  21. package/model/ignorePlurals.ts +2 -1
  22. package/model/index.ts +1 -0
  23. package/package.json +27 -27
  24. package/dist/builds/browser.d.ts +0 -24
  25. package/dist/builds/browser.d.ts.map +0 -1
  26. package/dist/builds/node.d.ts +0 -24
  27. package/dist/builds/node.d.ts.map +0 -1
  28. package/dist/model/advancedSyntaxFeatures.d.ts +0 -2
  29. package/dist/model/advancedSyntaxFeatures.d.ts.map +0 -1
  30. package/dist/model/alternativesAsExact.d.ts +0 -2
  31. package/dist/model/alternativesAsExact.d.ts.map +0 -1
  32. package/dist/model/aroundPrecision.d.ts +0 -6
  33. package/dist/model/aroundPrecision.d.ts.map +0 -1
  34. package/dist/model/aroundRadius.d.ts +0 -6
  35. package/dist/model/aroundRadius.d.ts.map +0 -1
  36. package/dist/model/aroundRadiusAll.d.ts +0 -5
  37. package/dist/model/aroundRadiusAll.d.ts.map +0 -1
  38. package/dist/model/autoFacetFilter.d.ts +0 -14
  39. package/dist/model/autoFacetFilter.d.ts.map +0 -1
  40. package/dist/model/baseRecommendRequest.d.ts +0 -17
  41. package/dist/model/baseRecommendRequest.d.ts.map +0 -1
  42. package/dist/model/baseSearchParams.d.ts +0 -4
  43. package/dist/model/baseSearchParams.d.ts.map +0 -1
  44. package/dist/model/baseSearchParamsWithoutQuery.d.ts +0 -116
  45. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +0 -1
  46. package/dist/model/baseSearchResponse.d.ts +0 -94
  47. package/dist/model/baseSearchResponse.d.ts.map +0 -1
  48. package/dist/model/boughtTogetherQuery.d.ts +0 -4
  49. package/dist/model/boughtTogetherQuery.d.ts.map +0 -1
  50. package/dist/model/clientMethodProps.d.ts +0 -135
  51. package/dist/model/clientMethodProps.d.ts.map +0 -1
  52. package/dist/model/condition.d.ts +0 -14
  53. package/dist/model/condition.d.ts.map +0 -1
  54. package/dist/model/consequence.d.ts +0 -18
  55. package/dist/model/consequence.d.ts.map +0 -1
  56. package/dist/model/deletedAtResponse.d.ts +0 -14
  57. package/dist/model/deletedAtResponse.d.ts.map +0 -1
  58. package/dist/model/distinct.d.ts +0 -5
  59. package/dist/model/distinct.d.ts.map +0 -1
  60. package/dist/model/errorBase.d.ts +0 -7
  61. package/dist/model/errorBase.d.ts.map +0 -1
  62. package/dist/model/exactOnSingleWordQuery.d.ts +0 -5
  63. package/dist/model/exactOnSingleWordQuery.d.ts.map +0 -1
  64. package/dist/model/exhaustive.d.ts +0 -26
  65. package/dist/model/exhaustive.d.ts.map +0 -1
  66. package/dist/model/facetFilters.d.ts +0 -5
  67. package/dist/model/facetFilters.d.ts.map +0 -1
  68. package/dist/model/facetOrdering.d.ts +0 -13
  69. package/dist/model/facetOrdering.d.ts.map +0 -1
  70. package/dist/model/facetStats.d.ts +0 -19
  71. package/dist/model/facetStats.d.ts.map +0 -1
  72. package/dist/model/facets.d.ts +0 -10
  73. package/dist/model/facets.d.ts.map +0 -1
  74. package/dist/model/fallbackParams.d.ts +0 -3
  75. package/dist/model/fallbackParams.d.ts.map +0 -1
  76. package/dist/model/fbtModel.d.ts +0 -5
  77. package/dist/model/fbtModel.d.ts.map +0 -1
  78. package/dist/model/frequentlyBoughtTogether.d.ts +0 -9
  79. package/dist/model/frequentlyBoughtTogether.d.ts.map +0 -1
  80. package/dist/model/getRecommendTaskResponse.d.ts +0 -5
  81. package/dist/model/getRecommendTaskResponse.d.ts.map +0 -1
  82. package/dist/model/getRecommendationsParams.d.ts +0 -11
  83. package/dist/model/getRecommendationsParams.d.ts.map +0 -1
  84. package/dist/model/getRecommendationsResponse.d.ts +0 -5
  85. package/dist/model/getRecommendationsResponse.d.ts.map +0 -1
  86. package/dist/model/hideConsequenceObject.d.ts +0 -10
  87. package/dist/model/hideConsequenceObject.d.ts.map +0 -1
  88. package/dist/model/highlightResult.d.ts +0 -5
  89. package/dist/model/highlightResult.d.ts.map +0 -1
  90. package/dist/model/highlightResultOption.d.ts +0 -20
  91. package/dist/model/highlightResultOption.d.ts.map +0 -1
  92. package/dist/model/ignorePlurals.d.ts +0 -6
  93. package/dist/model/ignorePlurals.d.ts.map +0 -1
  94. package/dist/model/index.d.ts +0 -94
  95. package/dist/model/index.d.ts.map +0 -1
  96. package/dist/model/indexSettingsAsSearchParams.d.ts +0 -160
  97. package/dist/model/indexSettingsAsSearchParams.d.ts.map +0 -1
  98. package/dist/model/lookingSimilar.d.ts +0 -11
  99. package/dist/model/lookingSimilar.d.ts.map +0 -1
  100. package/dist/model/lookingSimilarModel.d.ts +0 -5
  101. package/dist/model/lookingSimilarModel.d.ts.map +0 -1
  102. package/dist/model/lookingSimilarQuery.d.ts +0 -4
  103. package/dist/model/lookingSimilarQuery.d.ts.map +0 -1
  104. package/dist/model/matchLevel.d.ts +0 -5
  105. package/dist/model/matchLevel.d.ts.map +0 -1
  106. package/dist/model/matchedGeoLocation.d.ts +0 -15
  107. package/dist/model/matchedGeoLocation.d.ts.map +0 -1
  108. package/dist/model/mode.d.ts +0 -5
  109. package/dist/model/mode.d.ts.map +0 -1
  110. package/dist/model/numericFilters.d.ts +0 -5
  111. package/dist/model/numericFilters.d.ts.map +0 -1
  112. package/dist/model/optionalFilters.d.ts +0 -5
  113. package/dist/model/optionalFilters.d.ts.map +0 -1
  114. package/dist/model/paramsConsequence.d.ts +0 -19
  115. package/dist/model/paramsConsequence.d.ts.map +0 -1
  116. package/dist/model/personalization.d.ts +0 -15
  117. package/dist/model/personalization.d.ts.map +0 -1
  118. package/dist/model/promoteConsequenceObject.d.ts +0 -14
  119. package/dist/model/promoteConsequenceObject.d.ts.map +0 -1
  120. package/dist/model/queryType.d.ts +0 -5
  121. package/dist/model/queryType.d.ts.map +0 -1
  122. package/dist/model/range.d.ts +0 -14
  123. package/dist/model/range.d.ts.map +0 -1
  124. package/dist/model/rankingInfo.d.ts +0 -54
  125. package/dist/model/rankingInfo.d.ts.map +0 -1
  126. package/dist/model/reRankingApplyFilter.d.ts +0 -5
  127. package/dist/model/reRankingApplyFilter.d.ts.map +0 -1
  128. package/dist/model/recommendHit.d.ts +0 -27
  129. package/dist/model/recommendHit.d.ts.map +0 -1
  130. package/dist/model/recommendModels.d.ts +0 -2
  131. package/dist/model/recommendModels.d.ts.map +0 -1
  132. package/dist/model/recommendRule.d.ts +0 -24
  133. package/dist/model/recommendRule.d.ts.map +0 -1
  134. package/dist/model/recommendationsHit.d.ts +0 -4
  135. package/dist/model/recommendationsHit.d.ts.map +0 -1
  136. package/dist/model/recommendationsHits.d.ts +0 -5
  137. package/dist/model/recommendationsHits.d.ts.map +0 -1
  138. package/dist/model/recommendationsRequest.d.ts +0 -8
  139. package/dist/model/recommendationsRequest.d.ts.map +0 -1
  140. package/dist/model/recommendationsResults.d.ts +0 -5
  141. package/dist/model/recommendationsResults.d.ts.map +0 -1
  142. package/dist/model/recommendedForYou.d.ts +0 -7
  143. package/dist/model/recommendedForYou.d.ts.map +0 -1
  144. package/dist/model/recommendedForYouModel.d.ts +0 -5
  145. package/dist/model/recommendedForYouModel.d.ts.map +0 -1
  146. package/dist/model/recommendedForYouQuery.d.ts +0 -4
  147. package/dist/model/recommendedForYouQuery.d.ts.map +0 -1
  148. package/dist/model/redirect.d.ts +0 -8
  149. package/dist/model/redirect.d.ts.map +0 -1
  150. package/dist/model/redirectRuleIndexData.d.ts +0 -7
  151. package/dist/model/redirectRuleIndexData.d.ts.map +0 -1
  152. package/dist/model/redirectRuleIndexMetadata.d.ts +0 -21
  153. package/dist/model/redirectRuleIndexMetadata.d.ts.map +0 -1
  154. package/dist/model/redirectURL.d.ts +0 -7
  155. package/dist/model/redirectURL.d.ts.map +0 -1
  156. package/dist/model/relatedModel.d.ts +0 -5
  157. package/dist/model/relatedModel.d.ts.map +0 -1
  158. package/dist/model/relatedProducts.d.ts +0 -11
  159. package/dist/model/relatedProducts.d.ts.map +0 -1
  160. package/dist/model/relatedQuery.d.ts +0 -4
  161. package/dist/model/relatedQuery.d.ts.map +0 -1
  162. package/dist/model/removeStopWords.d.ts +0 -6
  163. package/dist/model/removeStopWords.d.ts.map +0 -1
  164. package/dist/model/removeWordsIfNoResults.d.ts +0 -5
  165. package/dist/model/removeWordsIfNoResults.d.ts.map +0 -1
  166. package/dist/model/renderingContent.d.ts +0 -10
  167. package/dist/model/renderingContent.d.ts.map +0 -1
  168. package/dist/model/ruleMetadata.d.ts +0 -10
  169. package/dist/model/ruleMetadata.d.ts.map +0 -1
  170. package/dist/model/searchPagination.d.ts +0 -19
  171. package/dist/model/searchPagination.d.ts.map +0 -1
  172. package/dist/model/searchParams.d.ts +0 -3
  173. package/dist/model/searchParams.d.ts.map +0 -1
  174. package/dist/model/searchParamsObject.d.ts +0 -7
  175. package/dist/model/searchParamsObject.d.ts.map +0 -1
  176. package/dist/model/searchParamsQuery.d.ts +0 -7
  177. package/dist/model/searchParamsQuery.d.ts.map +0 -1
  178. package/dist/model/searchRecommendRulesParams.d.ts +0 -38
  179. package/dist/model/searchRecommendRulesParams.d.ts.map +0 -1
  180. package/dist/model/searchRecommendRulesResponse.d.ts +0 -20
  181. package/dist/model/searchRecommendRulesResponse.d.ts.map +0 -1
  182. package/dist/model/semanticSearch.d.ts +0 -10
  183. package/dist/model/semanticSearch.d.ts.map +0 -1
  184. package/dist/model/snippetResult.d.ts +0 -5
  185. package/dist/model/snippetResult.d.ts.map +0 -1
  186. package/dist/model/snippetResultOption.d.ts +0 -12
  187. package/dist/model/snippetResultOption.d.ts.map +0 -1
  188. package/dist/model/sortRemainingBy.d.ts +0 -5
  189. package/dist/model/sortRemainingBy.d.ts.map +0 -1
  190. package/dist/model/supportedLanguage.d.ts +0 -5
  191. package/dist/model/supportedLanguage.d.ts.map +0 -1
  192. package/dist/model/tagFilters.d.ts +0 -5
  193. package/dist/model/tagFilters.d.ts.map +0 -1
  194. package/dist/model/taskStatus.d.ts +0 -5
  195. package/dist/model/taskStatus.d.ts.map +0 -1
  196. package/dist/model/trendingFacetHit.d.ts +0 -18
  197. package/dist/model/trendingFacetHit.d.ts.map +0 -1
  198. package/dist/model/trendingFacets.d.ts +0 -11
  199. package/dist/model/trendingFacets.d.ts.map +0 -1
  200. package/dist/model/trendingFacetsModel.d.ts +0 -5
  201. package/dist/model/trendingFacetsModel.d.ts.map +0 -1
  202. package/dist/model/trendingFacetsQuery.d.ts +0 -4
  203. package/dist/model/trendingFacetsQuery.d.ts.map +0 -1
  204. package/dist/model/trendingItems.d.ts +0 -15
  205. package/dist/model/trendingItems.d.ts.map +0 -1
  206. package/dist/model/trendingItemsModel.d.ts +0 -5
  207. package/dist/model/trendingItemsModel.d.ts.map +0 -1
  208. package/dist/model/trendingItemsQuery.d.ts +0 -4
  209. package/dist/model/trendingItemsQuery.d.ts.map +0 -1
  210. package/dist/model/typoTolerance.d.ts +0 -6
  211. package/dist/model/typoTolerance.d.ts.map +0 -1
  212. package/dist/model/typoToleranceEnum.d.ts +0 -5
  213. package/dist/model/typoToleranceEnum.d.ts.map +0 -1
  214. package/dist/model/value.d.ts +0 -13
  215. package/dist/model/value.d.ts.map +0 -1
  216. package/dist/recommend.cjs +0 -394
  217. package/dist/recommend.esm.browser.js +0 -1079
  218. package/dist/recommend.esm.node.js +0 -391
  219. package/dist/recommend.umd.js +0 -2
  220. package/dist/src/recommendClient.d.ts +0 -132
  221. package/dist/src/recommendClient.d.ts.map +0 -1
package/README.md CHANGED
@@ -19,7 +19,7 @@
19
19
  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20
20
  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21
21
  <a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22
- <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/" target="_blank">FAQ</a> •
22
+ <a href="https://www.algolia.com/doc/libraries/javascript/v5/" target="_blank">FAQ</a> •
23
23
  <a href="https://alg.li/support" target="_blank">Support</a>
24
24
  </p>
25
25
 
@@ -62,7 +62,7 @@ For full documentation, visit the **[Algolia JavaScript API Client](https://www.
62
62
 
63
63
  ## ❓ Troubleshooting
64
64
 
65
- Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
65
+ Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
66
66
 
67
67
  ## 📄 License
68
68