@algolia/recommend 5.0.0-alpha.110 → 5.0.0-alpha.112

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 (192) hide show
  1. package/dist/builds/browser.d.ts +1 -1
  2. package/dist/builds/node.d.ts +1 -1
  3. package/dist/model/autoFacetFilter.d.ts +14 -0
  4. package/dist/model/autoFacetFilter.d.ts.map +1 -0
  5. package/dist/model/baseRecommendRequest.d.ts +6 -4
  6. package/dist/model/baseRecommendRequest.d.ts.map +1 -1
  7. package/dist/model/baseSearchParamsWithoutQuery.d.ts +5 -4
  8. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  9. package/dist/model/boughtTogetherQuery.d.ts +4 -0
  10. package/dist/model/boughtTogetherQuery.d.ts.map +1 -0
  11. package/dist/model/clientMethodProps.d.ts +5 -5
  12. package/dist/model/condition.d.ts +5 -12
  13. package/dist/model/condition.d.ts.map +1 -1
  14. package/dist/model/consequence.d.ts +9 -17
  15. package/dist/model/consequence.d.ts.map +1 -1
  16. package/dist/model/deletedAtResponse.d.ts +1 -1
  17. package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
  18. package/dist/model/fallbackParams.d.ts +3 -0
  19. package/dist/model/fallbackParams.d.ts.map +1 -0
  20. package/dist/model/fbtModel.d.ts +5 -0
  21. package/dist/model/fbtModel.d.ts.map +1 -0
  22. package/dist/model/frequentlyBoughtTogether.d.ts +9 -0
  23. package/dist/model/frequentlyBoughtTogether.d.ts.map +1 -0
  24. package/dist/model/getRecommendationsParams.d.ts +2 -2
  25. package/dist/model/hideConsequenceObject.d.ts +10 -0
  26. package/dist/model/hideConsequenceObject.d.ts.map +1 -0
  27. package/dist/model/index.d.ts +20 -23
  28. package/dist/model/index.d.ts.map +1 -1
  29. package/dist/model/indexSettingsAsSearchParams.d.ts +10 -10
  30. package/dist/model/lookingSimilar.d.ts +11 -0
  31. package/dist/model/lookingSimilar.d.ts.map +1 -0
  32. package/dist/model/lookingSimilarModel.d.ts +5 -0
  33. package/dist/model/lookingSimilarModel.d.ts.map +1 -0
  34. package/dist/model/lookingSimilarQuery.d.ts +4 -0
  35. package/dist/model/lookingSimilarQuery.d.ts.map +1 -0
  36. package/dist/model/paramsConsequence.d.ts +19 -0
  37. package/dist/model/paramsConsequence.d.ts.map +1 -0
  38. package/dist/model/promoteConsequenceObject.d.ts +14 -0
  39. package/dist/model/promoteConsequenceObject.d.ts.map +1 -0
  40. package/dist/model/reRankingApplyFilter.d.ts +1 -1
  41. package/dist/model/recommendRule.d.ts +24 -0
  42. package/dist/model/recommendRule.d.ts.map +1 -0
  43. package/dist/model/recommendRuleMetadata.d.ts +10 -0
  44. package/dist/model/recommendRuleMetadata.d.ts.map +1 -0
  45. package/dist/model/recommendationsHits.d.ts +0 -8
  46. package/dist/model/recommendationsHits.d.ts.map +1 -1
  47. package/dist/model/recommendationsRequest.d.ts +4 -2
  48. package/dist/model/recommendationsRequest.d.ts.map +1 -1
  49. package/dist/model/recommendedForYou.d.ts +7 -0
  50. package/dist/model/recommendedForYou.d.ts.map +1 -0
  51. package/dist/model/recommendedForYouModel.d.ts +1 -1
  52. package/dist/model/recommendedForYouQuery.d.ts +2 -2
  53. package/dist/model/recommendedForYouQuery.d.ts.map +1 -1
  54. package/dist/model/relatedModel.d.ts +5 -0
  55. package/dist/model/relatedModel.d.ts.map +1 -0
  56. package/dist/model/relatedProducts.d.ts +11 -0
  57. package/dist/model/relatedProducts.d.ts.map +1 -0
  58. package/dist/model/relatedQuery.d.ts +4 -0
  59. package/dist/model/relatedQuery.d.ts.map +1 -0
  60. package/dist/model/removeWordsIfNoResults.d.ts +1 -1
  61. package/dist/model/searchParams.d.ts +3 -0
  62. package/dist/model/searchParams.d.ts.map +1 -0
  63. package/dist/model/searchParamsObject.d.ts +3 -0
  64. package/dist/model/searchParamsObject.d.ts.map +1 -1
  65. package/dist/model/searchRecommendRulesParams.d.ts +16 -4
  66. package/dist/model/searchRecommendRulesParams.d.ts.map +1 -1
  67. package/dist/model/searchRecommendRulesResponse.d.ts +3 -3
  68. package/dist/model/searchRecommendRulesResponse.d.ts.map +1 -1
  69. package/dist/model/sortRemainingBy.d.ts +1 -1
  70. package/dist/model/trendingFacetHit.d.ts +2 -2
  71. package/dist/model/trendingFacets.d.ts +11 -0
  72. package/dist/model/trendingFacets.d.ts.map +1 -0
  73. package/dist/model/trendingFacetsModel.d.ts +1 -1
  74. package/dist/model/trendingFacetsQuery.d.ts +2 -2
  75. package/dist/model/trendingFacetsQuery.d.ts.map +1 -1
  76. package/dist/model/trendingItems.d.ts +15 -0
  77. package/dist/model/trendingItems.d.ts.map +1 -0
  78. package/dist/model/trendingItemsModel.d.ts +1 -1
  79. package/dist/model/trendingItemsQuery.d.ts +2 -2
  80. package/dist/model/trendingItemsQuery.d.ts.map +1 -1
  81. package/dist/recommend.cjs +11 -11
  82. package/dist/recommend.esm.browser.js +13 -16
  83. package/dist/recommend.esm.node.js +11 -11
  84. package/dist/recommend.umd.js +2 -2
  85. package/dist/src/recommendClient.d.ts +13 -13
  86. package/dist/src/recommendClient.d.ts.map +1 -1
  87. package/model/autoFacetFilter.ts +16 -0
  88. package/model/baseRecommendRequest.ts +8 -4
  89. package/model/baseSearchParamsWithoutQuery.ts +5 -4
  90. package/model/{recommendationsQuery.ts → boughtTogetherQuery.ts} +3 -3
  91. package/model/clientMethodProps.ts +5 -5
  92. package/model/condition.ts +5 -16
  93. package/model/consequence.ts +9 -19
  94. package/model/deletedAtResponse.ts +1 -1
  95. package/model/exactOnSingleWordQuery.ts +1 -1
  96. package/model/{editType.ts → fallbackParams.ts} +3 -4
  97. package/model/fbtModel.ts +6 -0
  98. package/model/{consequenceHide.ts → frequentlyBoughtTogether.ts} +5 -4
  99. package/model/getRecommendationsParams.ts +2 -2
  100. package/model/{promoteObjectID.ts → hideConsequenceObject.ts} +3 -8
  101. package/model/index.ts +20 -23
  102. package/model/indexSettingsAsSearchParams.ts +10 -10
  103. package/model/lookingSimilar.ts +15 -0
  104. package/model/lookingSimilarModel.ts +6 -0
  105. package/model/lookingSimilarQuery.ts +6 -0
  106. package/model/paramsConsequence.ts +23 -0
  107. package/model/promoteConsequenceObject.ts +16 -0
  108. package/model/reRankingApplyFilter.ts +1 -1
  109. package/model/{ruleResponse.ts → recommendRule.ts} +7 -10
  110. package/model/{ruleResponseMetadata.ts → recommendRuleMetadata.ts} +5 -2
  111. package/model/recommendationsHits.ts +0 -10
  112. package/model/recommendationsRequest.ts +6 -2
  113. package/model/{baseRecommendedForYouQuery.ts → recommendedForYou.ts} +3 -5
  114. package/model/recommendedForYouModel.ts +1 -1
  115. package/model/recommendedForYouQuery.ts +2 -3
  116. package/model/relatedModel.ts +6 -0
  117. package/model/relatedProducts.ts +15 -0
  118. package/model/relatedQuery.ts +6 -0
  119. package/model/removeWordsIfNoResults.ts +1 -1
  120. package/model/{recommendationModels.ts → searchParams.ts} +3 -4
  121. package/model/searchParamsObject.ts +3 -0
  122. package/model/searchRecommendRulesParams.ts +19 -4
  123. package/model/searchRecommendRulesResponse.ts +3 -3
  124. package/model/sortRemainingBy.ts +1 -1
  125. package/model/trendingFacetHit.ts +2 -2
  126. package/model/{baseTrendingFacetsQuery.ts → trendingFacets.ts} +7 -4
  127. package/model/trendingFacetsModel.ts +1 -1
  128. package/model/trendingFacetsQuery.ts +2 -3
  129. package/model/trendingItems.ts +20 -0
  130. package/model/trendingItemsModel.ts +1 -1
  131. package/model/trendingItemsQuery.ts +2 -2
  132. package/package.json +7 -7
  133. package/dist/model/anchoring.d.ts +0 -5
  134. package/dist/model/anchoring.d.ts.map +0 -1
  135. package/dist/model/automaticFacetFilter.d.ts +0 -18
  136. package/dist/model/automaticFacetFilter.d.ts.map +0 -1
  137. package/dist/model/automaticFacetFilters.d.ts +0 -6
  138. package/dist/model/automaticFacetFilters.d.ts.map +0 -1
  139. package/dist/model/baseRecommendationsQuery.d.ts +0 -12
  140. package/dist/model/baseRecommendationsQuery.d.ts.map +0 -1
  141. package/dist/model/baseRecommendedForYouQuery.d.ts +0 -8
  142. package/dist/model/baseRecommendedForYouQuery.d.ts.map +0 -1
  143. package/dist/model/baseRecommendedForYouQueryParameters.d.ts +0 -7
  144. package/dist/model/baseRecommendedForYouQueryParameters.d.ts.map +0 -1
  145. package/dist/model/baseTrendingFacetsQuery.d.ts +0 -9
  146. package/dist/model/baseTrendingFacetsQuery.d.ts.map +0 -1
  147. package/dist/model/baseTrendingItemsQuery.d.ts +0 -16
  148. package/dist/model/baseTrendingItemsQuery.d.ts.map +0 -1
  149. package/dist/model/consequenceHide.d.ts +0 -10
  150. package/dist/model/consequenceHide.d.ts.map +0 -1
  151. package/dist/model/consequenceParams.d.ts +0 -5
  152. package/dist/model/consequenceParams.d.ts.map +0 -1
  153. package/dist/model/consequenceQuery.d.ts +0 -6
  154. package/dist/model/consequenceQuery.d.ts.map +0 -1
  155. package/dist/model/consequenceQueryObject.d.ts +0 -12
  156. package/dist/model/consequenceQueryObject.d.ts.map +0 -1
  157. package/dist/model/edit.d.ts +0 -13
  158. package/dist/model/edit.d.ts.map +0 -1
  159. package/dist/model/editType.d.ts +0 -5
  160. package/dist/model/editType.d.ts.map +0 -1
  161. package/dist/model/params.d.ts +0 -13
  162. package/dist/model/params.d.ts.map +0 -1
  163. package/dist/model/promote.d.ts +0 -4
  164. package/dist/model/promote.d.ts.map +0 -1
  165. package/dist/model/promoteObjectID.d.ts +0 -14
  166. package/dist/model/promoteObjectID.d.ts.map +0 -1
  167. package/dist/model/promoteObjectIDs.d.ts +0 -14
  168. package/dist/model/promoteObjectIDs.d.ts.map +0 -1
  169. package/dist/model/recommendationModels.d.ts +0 -5
  170. package/dist/model/recommendationModels.d.ts.map +0 -1
  171. package/dist/model/recommendationsQuery.d.ts +0 -4
  172. package/dist/model/recommendationsQuery.d.ts.map +0 -1
  173. package/dist/model/recommendedForYouQueryParameters.d.ts +0 -4
  174. package/dist/model/recommendedForYouQueryParameters.d.ts.map +0 -1
  175. package/dist/model/ruleResponse.d.ts +0 -27
  176. package/dist/model/ruleResponse.d.ts.map +0 -1
  177. package/dist/model/ruleResponseMetadata.d.ts +0 -7
  178. package/dist/model/ruleResponseMetadata.d.ts.map +0 -1
  179. package/model/anchoring.ts +0 -6
  180. package/model/automaticFacetFilter.ts +0 -21
  181. package/model/automaticFacetFilters.ts +0 -8
  182. package/model/baseRecommendationsQuery.ts +0 -17
  183. package/model/baseRecommendedForYouQueryParameters.ts +0 -8
  184. package/model/baseTrendingItemsQuery.ts +0 -22
  185. package/model/consequenceParams.ts +0 -9
  186. package/model/consequenceQuery.ts +0 -8
  187. package/model/consequenceQueryObject.ts +0 -15
  188. package/model/edit.ts +0 -17
  189. package/model/params.ts +0 -18
  190. package/model/promote.ts +0 -6
  191. package/model/promoteObjectIDs.ts +0 -16
  192. package/model/recommendedForYouQueryParameters.ts +0 -7
package/model/consequenceQueryObject.ts DELETED
@@ -1,15 +0,0 @@
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
-
3
- import type { Edit } from './edit';
4
-
5
- export type ConsequenceQueryObject = {
6
- /**
7
- * Words to remove from the search query.
8
- */
9
- remove?: string[];
10
-
11
- /**
12
- * Changes to make to the search query.
13
- */
14
- edits?: Edit[];
15
- };
package/model/edit.ts DELETED
@@ -1,17 +0,0 @@
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
-
3
- import type { EditType } from './editType';
4
-
5
- export type Edit = {
6
- type?: EditType;
7
-
8
- /**
9
- * Text or patterns to remove from the query string.
10
- */
11
- delete?: string;
12
-
13
- /**
14
- * Text to be added in place of the deleted text inside the query string.
15
- */
16
- insert?: string;
17
- };
package/model/params.ts DELETED
@@ -1,18 +0,0 @@
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
-
3
- import type { AutomaticFacetFilters } from './automaticFacetFilters';
4
- import type { ConsequenceQuery } from './consequenceQuery';
5
- import type { RenderingContent } from './renderingContent';
6
-
7
- /**
8
- * Parameters to apply to this search. You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
9
- */
10
- export type Params = {
11
- query?: ConsequenceQuery;
12
-
13
- automaticFacetFilters?: AutomaticFacetFilters;
14
-
15
- automaticOptionalFacetFilters?: AutomaticFacetFilters;
16
-
17
- renderingContent?: RenderingContent;
18
- };
package/model/promote.ts DELETED
@@ -1,6 +0,0 @@
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
-
3
- import type { PromoteObjectID } from './promoteObjectID';
4
- import type { PromoteObjectIDs } from './promoteObjectIDs';
5
-
6
- export type Promote = PromoteObjectID | PromoteObjectIDs;
package/model/promoteObjectIDs.ts DELETED
@@ -1,16 +0,0 @@
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
-
3
- /**
4
- * Records to promote.
5
- */
6
- export type PromoteObjectIDs = {
7
- /**
8
- * Object IDs of the records you want to promote. The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
9
- */
10
- objectIDs: string[];
11
-
12
- /**
13
- * Position in the search results where you want to show the promoted records.
14
- */
15
- position: number;
16
- };
package/model/recommendedForYouQueryParameters.ts DELETED
@@ -1,7 +0,0 @@
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
-
3
- import type { BaseRecommendedForYouQueryParameters } from './baseRecommendedForYouQueryParameters';
4
- import type { SearchParamsObject } from './searchParamsObject';
5
-
6
- export type RecommendedForYouQueryParameters =
7
- BaseRecommendedForYouQueryParameters & SearchParamsObject;