@algolia/recommend 5.0.0-alpha.7 → 5.0.0-alpha.70

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 (188) 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/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/aroundRadius.d.ts +5 -5
  10. package/dist/model/aroundRadius.d.ts.map +1 -1
  11. package/dist/model/aroundRadiusAll.d.ts +1 -1
  12. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  13. package/dist/model/baseRecommendRequest.d.ts +17 -17
  14. package/dist/model/baseRecommendRequest.d.ts.map +1 -1
  15. package/dist/model/baseRecommendationRequest.d.ts +8 -8
  16. package/dist/model/baseRecommendationRequest.d.ts.map +1 -1
  17. package/dist/model/baseSearchParams.d.ts +3 -3
  18. package/dist/model/baseSearchParams.d.ts.map +1 -1
  19. package/dist/model/baseSearchParamsWithoutQuery.d.ts +122 -122
  20. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  21. package/dist/model/baseSearchResponse.d.ts +103 -101
  22. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  23. package/dist/model/baseSearchResponseRedirect.d.ts +8 -0
  24. package/dist/model/baseSearchResponseRedirect.d.ts.map +1 -0
  25. package/dist/model/baseTrendingRequest.d.ts +12 -12
  26. package/dist/model/baseTrendingRequest.d.ts.map +1 -1
  27. package/dist/model/clientMethodProps.d.ts +60 -60
  28. package/dist/model/clientMethodProps.d.ts.map +1 -1
  29. package/dist/model/distinct.d.ts +4 -4
  30. package/dist/model/distinct.d.ts.map +1 -1
  31. package/dist/model/errorBase.d.ts +6 -6
  32. package/dist/model/errorBase.d.ts.map +1 -1
  33. package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
  34. package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
  35. package/dist/model/facetFilters.d.ts +5 -5
  36. package/dist/model/facetFilters.d.ts.map +1 -1
  37. package/dist/model/facetOrdering.d.ts +12 -12
  38. package/dist/model/facetOrdering.d.ts.map +1 -1
  39. package/dist/model/facets.d.ts +9 -9
  40. package/dist/model/facets.d.ts.map +1 -1
  41. package/dist/model/facetsStats.d.ts +18 -18
  42. package/dist/model/facetsStats.d.ts.map +1 -1
  43. package/dist/model/getRecommendationsParams.d.ts +10 -10
  44. package/dist/model/getRecommendationsParams.d.ts.map +1 -1
  45. package/dist/model/getRecommendationsResponse.d.ts +4 -4
  46. package/dist/model/getRecommendationsResponse.d.ts.map +1 -1
  47. package/dist/model/highlightResult.d.ts +2 -2
  48. package/dist/model/highlightResult.d.ts.map +1 -1
  49. package/dist/model/highlightResultOption.d.ts +19 -19
  50. package/dist/model/highlightResultOption.d.ts.map +1 -1
  51. package/dist/model/ignorePlurals.d.ts +4 -4
  52. package/dist/model/ignorePlurals.d.ts.map +1 -1
  53. package/dist/model/index.d.ts +58 -53
  54. package/dist/model/index.d.ts.map +1 -1
  55. package/dist/model/indexSettingsAsSearchParams.d.ts +164 -160
  56. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  57. package/dist/model/indexSettingsAsSearchParamsSemanticSearch.d.ts +10 -0
  58. package/dist/model/indexSettingsAsSearchParamsSemanticSearch.d.ts.map +1 -0
  59. package/dist/model/matchLevel.d.ts +4 -4
  60. package/dist/model/matchLevel.d.ts.map +1 -1
  61. package/dist/model/matchedGeoLocation.d.ts +14 -14
  62. package/dist/model/matchedGeoLocation.d.ts.map +1 -1
  63. package/dist/model/mixedSearchFilters.d.ts +1 -1
  64. package/dist/model/mixedSearchFilters.d.ts.map +1 -1
  65. package/dist/model/mode.d.ts +5 -0
  66. package/dist/model/mode.d.ts.map +1 -0
  67. package/dist/model/numericFilters.d.ts +5 -5
  68. package/dist/model/numericFilters.d.ts.map +1 -1
  69. package/dist/model/optionalFilters.d.ts +5 -5
  70. package/dist/model/optionalFilters.d.ts.map +1 -1
  71. package/dist/model/personalization.d.ts +14 -14
  72. package/dist/model/personalization.d.ts.map +1 -1
  73. package/dist/model/queryType.d.ts +4 -4
  74. package/dist/model/queryType.d.ts.map +1 -1
  75. package/dist/model/rankingInfo.d.ts +50 -50
  76. package/dist/model/rankingInfo.d.ts.map +1 -1
  77. package/dist/model/reRankingApplyFilter.d.ts +5 -5
  78. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  79. package/dist/model/recommendHit.d.ts +26 -26
  80. package/dist/model/recommendHit.d.ts.map +1 -1
  81. package/dist/model/recommendHits.d.ts +4 -4
  82. package/dist/model/recommendHits.d.ts.map +1 -1
  83. package/dist/model/recommendationModels.d.ts +4 -4
  84. package/dist/model/recommendationModels.d.ts.map +1 -1
  85. package/dist/model/recommendationRequest.d.ts +3 -3
  86. package/dist/model/recommendationRequest.d.ts.map +1 -1
  87. package/dist/model/recommendationsRequest.d.ts +3 -3
  88. package/dist/model/recommendationsRequest.d.ts.map +1 -1
  89. package/dist/model/recommendationsResponse.d.ts +3 -3
  90. package/dist/model/recommendationsResponse.d.ts.map +1 -1
  91. package/dist/model/redirectRuleIndexMetadata.d.ts +21 -0
  92. package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  93. package/dist/model/redirectRuleIndexMetadataData.d.ts +7 -0
  94. package/dist/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  95. package/dist/model/removeStopWords.d.ts +4 -4
  96. package/dist/model/removeStopWords.d.ts.map +1 -1
  97. package/dist/model/removeWordsIfNoResults.d.ts +4 -4
  98. package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
  99. package/dist/model/renderingContent.d.ts +7 -7
  100. package/dist/model/renderingContent.d.ts.map +1 -1
  101. package/dist/model/searchParamsObject.d.ts +3 -3
  102. package/dist/model/searchParamsObject.d.ts.map +1 -1
  103. package/dist/model/searchParamsQuery.d.ts +6 -6
  104. package/dist/model/searchParamsQuery.d.ts.map +1 -1
  105. package/dist/model/snippetResult.d.ts +2 -2
  106. package/dist/model/snippetResult.d.ts.map +1 -1
  107. package/dist/model/snippetResultOption.d.ts +11 -11
  108. package/dist/model/snippetResultOption.d.ts.map +1 -1
  109. package/dist/model/sortRemainingBy.d.ts +4 -4
  110. package/dist/model/sortRemainingBy.d.ts.map +1 -1
  111. package/dist/model/tagFilters.d.ts +5 -5
  112. package/dist/model/tagFilters.d.ts.map +1 -1
  113. package/dist/model/trendingModels.d.ts +4 -4
  114. package/dist/model/trendingModels.d.ts.map +1 -1
  115. package/dist/model/trendingRequest.d.ts +3 -3
  116. package/dist/model/trendingRequest.d.ts.map +1 -1
  117. package/dist/model/typoTolerance.d.ts +5 -5
  118. package/dist/model/typoTolerance.d.ts.map +1 -1
  119. package/dist/model/typoToleranceEnum.d.ts +1 -1
  120. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  121. package/dist/model/value.d.ts +8 -8
  122. package/dist/model/value.d.ts.map +1 -1
  123. package/dist/recommend.cjs.js +235 -235
  124. package/dist/recommend.esm.browser.js +418 -468
  125. package/dist/recommend.esm.node.js +235 -235
  126. package/dist/recommend.umd.js +2 -2
  127. package/dist/src/recommendClient.d.ts +81 -81
  128. package/dist/src/recommendClient.d.ts.map +1 -1
  129. package/model/advancedSyntaxFeatures.ts +1 -1
  130. package/model/alternativesAsExact.ts +1 -1
  131. package/model/aroundRadius.ts +1 -1
  132. package/model/aroundRadiusAll.ts +1 -1
  133. package/model/baseRecommendRequest.ts +1 -1
  134. package/model/baseRecommendationRequest.ts +1 -1
  135. package/model/baseSearchParams.ts +1 -1
  136. package/model/baseSearchParamsWithoutQuery.ts +1 -1
  137. package/model/baseSearchResponse.ts +4 -1
  138. package/model/baseSearchResponseRedirect.ts +10 -0
  139. package/model/baseTrendingRequest.ts +1 -1
  140. package/model/clientMethodProps.ts +1 -1
  141. package/model/distinct.ts +1 -1
  142. package/model/errorBase.ts +1 -1
  143. package/model/exactOnSingleWordQuery.ts +1 -1
  144. package/model/facetFilters.ts +1 -1
  145. package/model/facetOrdering.ts +1 -1
  146. package/model/facets.ts +1 -1
  147. package/model/facetsStats.ts +1 -1
  148. package/model/getRecommendationsParams.ts +1 -1
  149. package/model/getRecommendationsResponse.ts +1 -1
  150. package/model/highlightResult.ts +1 -1
  151. package/model/highlightResultOption.ts +1 -1
  152. package/model/ignorePlurals.ts +1 -1
  153. package/model/index.ts +6 -1
  154. package/model/indexSettingsAsSearchParams.ts +12 -6
  155. package/model/indexSettingsAsSearchParamsSemanticSearch.ts +11 -0
  156. package/model/matchLevel.ts +1 -1
  157. package/model/matchedGeoLocation.ts +1 -1
  158. package/model/mixedSearchFilters.ts +1 -1
  159. package/model/mode.ts +6 -0
  160. package/model/numericFilters.ts +1 -1
  161. package/model/optionalFilters.ts +1 -1
  162. package/model/personalization.ts +1 -1
  163. package/model/queryType.ts +1 -1
  164. package/model/rankingInfo.ts +1 -1
  165. package/model/reRankingApplyFilter.ts +1 -1
  166. package/model/recommendHit.ts +1 -1
  167. package/model/recommendHits.ts +1 -1
  168. package/model/recommendationModels.ts +1 -1
  169. package/model/recommendationRequest.ts +1 -1
  170. package/model/recommendationsRequest.ts +1 -1
  171. package/model/recommendationsResponse.ts +1 -1
  172. package/model/redirectRuleIndexMetadata.ts +27 -0
  173. package/model/redirectRuleIndexMetadataData.ts +8 -0
  174. package/model/removeStopWords.ts +1 -1
  175. package/model/removeWordsIfNoResults.ts +1 -1
  176. package/model/renderingContent.ts +1 -1
  177. package/model/searchParamsObject.ts +1 -1
  178. package/model/searchParamsQuery.ts +1 -1
  179. package/model/snippetResult.ts +1 -1
  180. package/model/snippetResultOption.ts +1 -1
  181. package/model/sortRemainingBy.ts +1 -1
  182. package/model/tagFilters.ts +1 -1
  183. package/model/trendingModels.ts +1 -1
  184. package/model/trendingRequest.ts +1 -1
  185. package/model/typoTolerance.ts +1 -1
  186. package/model/typoToleranceEnum.ts +1 -1
  187. package/model/value.ts +1 -1
  188. package/package.json +31 -13
@@ -0,0 +1,27 @@
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 { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
4
+
5
+ export type RedirectRuleIndexMetadata = {
6
+ /**
7
+ * Source index for the redirect rule.
8
+ */
9
+ source: string;
10
+
11
+ /**
12
+ * Destination index for the redirect rule.
13
+ */
14
+ dest: string;
15
+
16
+ /**
17
+ * Reason for the redirect rule.
18
+ */
19
+ reason: string;
20
+
21
+ /**
22
+ * Status for the redirect rule.
23
+ */
24
+ succeed: boolean;
25
+
26
+ data: RedirectRuleIndexMetadataData;
27
+ };
@@ -0,0 +1,8 @@
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
+ * Data for the redirect rule.
5
+ */
6
+ export type RedirectRuleIndexMetadataData = {
7
+ ruleObjectID: string;
8
+ };
@@ -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
  /**
4
4
  * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
@@ -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
  /**
4
4
  * Selects a strategy to remove words from the query when it doesn\'t match any hits.
@@ -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 { FacetOrdering } from './facetOrdering';
4
4
 
@@ -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 { BaseSearchParams } from './baseSearchParams';
4
4
  import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
@@ -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
  export type SearchParamsQuery = {
4
4
  /**
@@ -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 { SnippetResultOption } from './snippetResultOption';
4
4
 
@@ -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 { MatchLevel } from './matchLevel';
4
4
 
@@ -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
  /**
4
4
  * How to display the remaining items. - `count`: facet count (descending). - `alpha`: alphabetical (ascending). - `hidden`: show only pinned values.
@@ -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 { MixedSearchFilters } from './mixedSearchFilters';
4
4
 
@@ -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
  /**
4
4
  * The trending model to use.
@@ -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 { BaseRecommendRequest } from './baseRecommendRequest';
4
4
  import type { BaseTrendingRequest } from './baseTrendingRequest';
@@ -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 { TypoToleranceEnum } from './typoToleranceEnum';
4
4
 
@@ -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';
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
 
package/package.json CHANGED
@@ -1,16 +1,32 @@
1
1
  {
2
2
  "name": "@algolia/recommend",
3
- "version": "5.0.0-alpha.7",
3
+ "version": "5.0.0-alpha.70",
4
4
  "description": "JavaScript client for recommend",
5
5
  "repository": "algolia/algoliasearch-client-javascript",
6
6
  "license": "MIT",
7
7
  "author": "Algolia",
8
- "main": "index.js",
9
- "jsdelivr": "dist/recommend.umd.js",
10
- "unpkg": "dist/recommend.umd.js",
11
- "module": "dist/recommend.esm.node.js",
12
- "browser": "dist/recommend.umd.js",
13
- "types": "index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "node": {
11
+ "import": "./dist/recommend.esm.node.js",
12
+ "module": "./dist/recommend.esm.node.js",
13
+ "require": "./dist/recommend.cjs.js",
14
+ "default": "./dist/recommend.cjs.js"
15
+ },
16
+ "default": {
17
+ "umd": "./dist/recommend.umd.js",
18
+ "module": "./dist/recommend.esm.browser.js",
19
+ "import": "./dist/recommend.esm.browser.js",
20
+ "default": "./dist/recommend.umd.js"
21
+ }
22
+ },
23
+ "./src/*": "./src/*.ts",
24
+ "./model": "./model/index.ts"
25
+ },
26
+ "jsdelivr": "./dist/recommend.umd.js",
27
+ "unpkg": "./dist/recommend.umd.js",
28
+ "browser": "./dist/recommend.umd.js",
29
+ "types": "./index.d.ts",
14
30
  "files": [
15
31
  "dist",
16
32
  "model",
@@ -18,16 +34,18 @@
18
34
  "index.d.ts"
19
35
  ],
20
36
  "scripts": {
21
- "clean": "rm -rf ./dist"
37
+ "build": "yarn clean && rollup --config",
38
+ "clean": "rm -rf ./dist || true"
22
39
  },
23
40
  "dependencies": {
24
- "@algolia/client-common": "5.0.0-alpha.7",
25
- "@algolia/requester-browser-xhr": "5.0.0-alpha.7",
26
- "@algolia/requester-node-http": "5.0.0-alpha.7"
41
+ "@algolia/client-common": "5.0.0-alpha.70",
42
+ "@algolia/requester-browser-xhr": "5.0.0-alpha.70",
43
+ "@algolia/requester-node-http": "5.0.0-alpha.70"
27
44
  },
28
45
  "devDependencies": {
29
- "@types/node": "16.11.47",
30
- "typescript": "4.7.4"
46
+ "@types/node": "18.16.16",
47
+ "rollup": "2.79.1",
48
+ "typescript": "5.0.4"
31
49
  },
32
50
  "engines": {
33
51
  "node": ">= 14.0.0"