@algolia/recommend 5.0.0-beta.9 → 5.0.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 (56) hide show
  1. package/README.md +69 -0
  2. package/dist/model/aroundPrecision.d.ts +2 -2
  3. package/dist/model/aroundPrecision.d.ts.map +1 -1
  4. package/dist/model/baseSearchResponse.d.ts +0 -16
  5. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  6. package/dist/model/getRecommendationsResponse.d.ts +1 -1
  7. package/dist/model/getRecommendationsResponse.d.ts.map +1 -1
  8. package/dist/model/highlightResult.d.ts +3 -1
  9. package/dist/model/highlightResult.d.ts.map +1 -1
  10. package/dist/model/index.d.ts +4 -3
  11. package/dist/model/index.d.ts.map +1 -1
  12. package/dist/model/indexSettingsAsSearchParams.d.ts +1 -1
  13. package/dist/model/{aroundPrecisionFromValueInner.d.ts → range.d.ts} +2 -2
  14. package/dist/model/range.d.ts.map +1 -0
  15. package/dist/model/recommendRule.d.ts +2 -2
  16. package/dist/model/recommendRule.d.ts.map +1 -1
  17. package/dist/model/recommendationsResults.d.ts +2 -1
  18. package/dist/model/recommendationsResults.d.ts.map +1 -1
  19. package/dist/model/redirectRuleIndexData.d.ts +7 -0
  20. package/dist/model/redirectRuleIndexData.d.ts.map +1 -0
  21. package/dist/model/redirectRuleIndexMetadata.d.ts +2 -2
  22. package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -1
  23. package/dist/model/{recommendRuleMetadata.d.ts → ruleMetadata.d.ts} +2 -2
  24. package/dist/model/ruleMetadata.d.ts.map +1 -0
  25. package/dist/model/searchPagination.d.ts +19 -0
  26. package/dist/model/searchPagination.d.ts.map +1 -0
  27. package/dist/model/snippetResult.d.ts +3 -1
  28. package/dist/model/snippetResult.d.ts.map +1 -1
  29. package/dist/model/trendingItems.d.ts +2 -2
  30. package/dist/model/trendingItems.d.ts.map +1 -1
  31. package/dist/recommend.cjs +1 -1
  32. package/dist/recommend.esm.browser.js +1 -1
  33. package/dist/recommend.esm.node.js +1 -1
  34. package/dist/recommend.umd.js +2 -2
  35. package/dist/src/recommendClient.d.ts +1 -1
  36. package/dist/src/recommendClient.d.ts.map +1 -1
  37. package/model/aroundPrecision.ts +2 -2
  38. package/model/baseSearchResponse.ts +0 -20
  39. package/model/getRecommendationsResponse.ts +1 -1
  40. package/model/highlightResult.ts +2 -1
  41. package/model/index.ts +4 -3
  42. package/model/indexSettingsAsSearchParams.ts +1 -1
  43. package/model/{aroundPrecisionFromValueInner.ts → range.ts} +1 -1
  44. package/model/recommendRule.ts +2 -2
  45. package/model/recommendationsResults.ts +4 -1
  46. package/model/{redirectRuleIndexMetadataData.ts → redirectRuleIndexData.ts} +1 -1
  47. package/model/redirectRuleIndexMetadata.ts +2 -2
  48. package/model/{recommendRuleMetadata.ts → ruleMetadata.ts} +1 -1
  49. package/model/searchPagination.ts +23 -0
  50. package/model/snippetResult.ts +2 -1
  51. package/model/trendingItems.ts +2 -2
  52. package/package.json +7 -7
  53. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +0 -1
  54. package/dist/model/recommendRuleMetadata.d.ts.map +0 -1
  55. package/dist/model/redirectRuleIndexMetadataData.d.ts +0 -7
  56. package/dist/model/redirectRuleIndexMetadataData.d.ts.map +0 -1
package/README.md ADDED
@@ -0,0 +1,69 @@
1
+ <p align="center">
2
+ <a href="https://www.algolia.com">
3
+ <img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
4
+ </a>
5
+
6
+ <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7
+
8
+ <p align="center">
9
+ <a href="https://npmjs.org/package/@algolia/recommend"><img src="https://img.shields.io/npm/v/@algolia/recommend.svg?style=flat-square" alt="NPM version"></img></a>
10
+ <a href="http://npm-stat.com/charts.html?package=@algolia/recommend"><img src="https://img.shields.io/npm/dm/@algolia/recommend.svg?style=flat-square" alt="NPM downloads"></a>
11
+ <a href="https://www.jsdelivr.com/package/npm/@algolia/recommend"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/recommend/badge" alt="jsDelivr Downloads"></img></a>
12
+ <a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
13
+ </p>
14
+ </p>
15
+
16
+ <p align="center">
17
+ <a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
18
+ <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19
+ <a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20
+ <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
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> •
23
+ <a href="https://alg.li/support" target="_blank">Support</a>
24
+ </p>
25
+
26
+ ## ✨ Features
27
+
28
+ - Thin & **minimal low-level HTTP client** to interact with Algolia's API
29
+ - Works both on the **browser** and **node.js**
30
+ - **UMD and ESM compatible**, you can use it with any module loader
31
+ - Built with TypeScript
32
+
33
+ ## 💡 Getting Started
34
+
35
+ To get started, you first need to install @algolia/recommend (or any other available API client package).
36
+
37
+ All of our clients comes with type definition, and are available for both browser and node environments.
38
+
39
+ ```bash
40
+ yarn add @algolia/recommend
41
+ # or
42
+ npm install @algolia/recommend
43
+ ```
44
+
45
+ Without a package manager
46
+
47
+ Add the following JavaScript snippet to the <head> of your website:
48
+
49
+ ```html
50
+ <script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/recommend.umd.min.js"></script>
51
+ ```
52
+
53
+ You can now import the Algolia API client in your project and play with it.
54
+
55
+ ```js
56
+ import { recommendClient } from '@algolia/recommend';
57
+
58
+ const client = recommendClient('YOUR_APP_ID', 'YOUR_API_KEY');
59
+ ```
60
+
61
+ For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
62
+
63
+ ## ❓ Troubleshooting
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)
66
+
67
+ ## 📄 License
68
+
69
+ The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
package/dist/model/aroundPrecision.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
1
+ import type { Range } from './range';
2
2
  /**
3
3
  * Precision of a coordinate-based search in meters to group results with similar distances. The Geo ranking criterion considers all matches within the same range of distances to be equal.
4
4
  */
5
- export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
5
+ export type AroundPrecision = Range[] | number;
6
6
  //# sourceMappingURL=aroundPrecision.d.ts.map
package/dist/model/aroundPrecision.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"aroundPrecision.d.ts","sourceRoot":"","sources":["../../model/aroundPrecision.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,6BAA6B,EAAE,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"aroundPrecision.d.ts","sourceRoot":"","sources":["../../model/aroundPrecision.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC"}
package/dist/model/baseSearchResponse.d.ts CHANGED
@@ -40,10 +40,6 @@ export type BaseSearchResponse = Record<string, any> & {
40
40
  * Statistics for numerical facets.
41
41
  */
42
42
  facets_stats?: Record<string, FacetsStats>;
43
- /**
44
- * Number of hits per page.
45
- */
46
- hitsPerPage: number;
47
43
  /**
48
44
  * Index name used for the query.
49
45
  */
@@ -56,22 +52,10 @@ export type BaseSearchResponse = Record<string, any> & {
56
52
  * Warnings about the query.
57
53
  */
58
54
  message?: string;
59
- /**
60
- * Number of results (hits).
61
- */
62
- nbHits: number;
63
- /**
64
- * Number of pages of results.
65
- */
66
- nbPages: number;
67
55
  /**
68
56
  * Number of hits selected and sorted by the relevant sort algorithm.
69
57
  */
70
58
  nbSortedHits?: number;
71
- /**
72
- * Page of search results to retrieve.
73
- */
74
- page: number;
75
59
  /**
76
60
  * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
77
61
  */
package/dist/model/baseSearchResponse.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
1
+ {"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
package/dist/model/getRecommendationsResponse.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { RecommendationsResults } from './recommendationsResults';
2
2
  export type GetRecommendationsResponse = {
3
- results?: RecommendationsResults[];
3
+ results: RecommendationsResults[];
4
4
  };
5
5
  //# sourceMappingURL=getRecommendationsResponse.d.ts.map
package/dist/model/getRecommendationsResponse.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"getRecommendationsResponse.d.ts","sourceRoot":"","sources":["../../model/getRecommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACpC,CAAC"}
1
+ {"version":3,"file":"getRecommendationsResponse.d.ts","sourceRoot":"","sources":["../../model/getRecommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,sBAAsB,EAAE,CAAC;CACnC,CAAC"}
package/dist/model/highlightResult.d.ts CHANGED
@@ -1,3 +1,5 @@
1
1
  import type { HighlightResultOption } from './highlightResultOption';
2
- export type HighlightResult = HighlightResultOption | HighlightResultOption[] | Record<string, HighlightResultOption>;
2
+ export type HighlightResult = HighlightResultOption | HighlightResultOption[] | Record<string, HighlightResultOption> | {
3
+ [key: string]: HighlightResult;
4
+ };
3
5
  //# sourceMappingURL=highlightResult.d.ts.map
package/dist/model/highlightResult.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,eAAe,GACvB,qBAAqB,GACrB,qBAAqB,EAAE,GACvB,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC"}
1
+ {"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,eAAe,GACvB,qBAAqB,GACrB,qBAAqB,EAAE,GACvB,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACrC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,CAAC"}
package/dist/model/index.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  export * from './advancedSyntaxFeatures';
2
2
  export * from './alternativesAsExact';
3
3
  export * from './aroundPrecision';
4
- export * from './aroundPrecisionFromValueInner';
5
4
  export * from './aroundRadius';
6
5
  export * from './aroundRadiusAll';
7
6
  export * from './autoFacetFilter';
@@ -44,12 +43,12 @@ export * from './paramsConsequence';
44
43
  export * from './personalization';
45
44
  export * from './promoteConsequenceObject';
46
45
  export * from './queryType';
46
+ export * from './range';
47
47
  export * from './rankingInfo';
48
48
  export * from './reRankingApplyFilter';
49
49
  export * from './recommendHit';
50
50
  export * from './recommendModels';
51
51
  export * from './recommendRule';
52
- export * from './recommendRuleMetadata';
53
52
  export * from './recommendationsHit';
54
53
  export * from './recommendationsHits';
55
54
  export * from './recommendationsRequest';
@@ -58,8 +57,8 @@ export * from './recommendedForYou';
58
57
  export * from './recommendedForYouModel';
59
58
  export * from './recommendedForYouQuery';
60
59
  export * from './redirect';
60
+ export * from './redirectRuleIndexData';
61
61
  export * from './redirectRuleIndexMetadata';
62
- export * from './redirectRuleIndexMetadataData';
63
62
  export * from './redirectURL';
64
63
  export * from './relatedModel';
65
64
  export * from './relatedProducts';
@@ -67,6 +66,8 @@ export * from './relatedQuery';
67
66
  export * from './removeStopWords';
68
67
  export * from './removeWordsIfNoResults';
69
68
  export * from './renderingContent';
69
+ export * from './ruleMetadata';
70
+ export * from './searchPagination';
70
71
  export * from './searchParams';
71
72
  export * from './searchParamsObject';
72
73
  export * from './searchParamsQuery';
package/dist/model/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,YAAY,CAAC;AAC3B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
package/dist/model/indexSettingsAsSearchParams.d.ts CHANGED
@@ -85,7 +85,7 @@ export type IndexSettingsAsSearchParams = {
85
85
  */
86
86
  queryLanguages?: SupportedLanguage[];
87
87
  /**
88
- * Whether to split compound words into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.
88
+ * Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
89
89
  */
90
90
  decompoundQuery?: boolean;
91
91
  /**
package/dist/model/{aroundPrecisionFromValueInner.d.ts → range.d.ts} RENAMED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Range object with lower and upper values in meters to define custom ranges.
3
3
  */
4
- export type AroundPrecisionFromValueInner = {
4
+ export type Range = {
5
5
  /**
6
6
  * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
7
7
  */
@@ -11,4 +11,4 @@ export type AroundPrecisionFromValueInner = {
11
11
  */
12
12
  value?: number;
13
13
  };
14
- //# sourceMappingURL=aroundPrecisionFromValueInner.d.ts.map
14
+ //# sourceMappingURL=range.d.ts.map
package/dist/model/range.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"range.d.ts","sourceRoot":"","sources":["../../model/range.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
package/dist/model/recommendRule.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  import type { Condition } from './condition';
2
2
  import type { Consequence } from './consequence';
3
- import type { RecommendRuleMetadata } from './recommendRuleMetadata';
3
+ import type { RuleMetadata } from './ruleMetadata';
4
4
  /**
5
5
  * Recommend rule.
6
6
  */
7
7
  export type RecommendRule = {
8
- _metadata?: RecommendRuleMetadata;
8
+ _metadata?: RuleMetadata;
9
9
  /**
10
10
  * Unique identifier of a rule object.
11
11
  */
package/dist/model/recommendRule.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../model/recommendRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../model/recommendRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,YAAY,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
package/dist/model/recommendationsResults.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import type { BaseSearchResponse } from './baseSearchResponse';
2
2
  import type { RecommendationsHits } from './recommendationsHits';
3
- export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;
3
+ import type { SearchPagination } from './searchPagination';
4
+ export type RecommendationsResults = BaseSearchResponse & RecommendationsHits & SearchPagination;
4
5
  //# sourceMappingURL=recommendationsResults.d.ts.map
package/dist/model/recommendationsResults.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"recommendationsResults.d.ts","sourceRoot":"","sources":["../../model/recommendationsResults.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC"}
1
+ {"version":3,"file":"recommendationsResults.d.ts","sourceRoot":"","sources":["../../model/recommendationsResults.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GACrD,mBAAmB,GACnB,gBAAgB,CAAC"}
package/dist/model/redirectRuleIndexData.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Redirect rule data.
3
+ */
4
+ export type RedirectRuleIndexData = {
5
+ ruleObjectID: string;
6
+ };
7
+ //# sourceMappingURL=redirectRuleIndexData.d.ts.map
package/dist/model/redirectRuleIndexData.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"redirectRuleIndexData.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexData.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}
package/dist/model/redirectRuleIndexMetadata.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
1
+ import type { RedirectRuleIndexData } from './redirectRuleIndexData';
2
2
  export type RedirectRuleIndexMetadata = {
3
3
  /**
4
4
  * Source index for the redirect rule.
@@ -16,6 +16,6 @@ export type RedirectRuleIndexMetadata = {
16
16
  * Redirect rule status.
17
17
  */
18
18
  succeed: boolean;
19
- data: RedirectRuleIndexMetadataData;
19
+ data: RedirectRuleIndexData;
20
20
  };
21
21
  //# sourceMappingURL=redirectRuleIndexMetadata.d.ts.map
package/dist/model/redirectRuleIndexMetadata.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"redirectRuleIndexMetadata.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,IAAI,EAAE,6BAA6B,CAAC;CACrC,CAAC"}
1
+ {"version":3,"file":"redirectRuleIndexMetadata.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,IAAI,EAAE,qBAAqB,CAAC;CAC7B,CAAC"}
package/dist/model/{recommendRuleMetadata.d.ts → ruleMetadata.d.ts} RENAMED
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * Rule metadata.
3
3
  */
4
- export type RecommendRuleMetadata = {
4
+ export type RuleMetadata = {
5
5
  /**
6
6
  * Date and time when the object was updated, in RFC 3339 format.
7
7
  */
8
8
  lastUpdate?: string;
9
9
  };
10
- //# sourceMappingURL=recommendRuleMetadata.d.ts.map
10
+ //# sourceMappingURL=ruleMetadata.d.ts.map
package/dist/model/ruleMetadata.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ruleMetadata.d.ts","sourceRoot":"","sources":["../../model/ruleMetadata.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}
package/dist/model/searchPagination.d.ts ADDED
@@ -0,0 +1,19 @@
1
+ export type SearchPagination = {
2
+ /**
3
+ * Page of search results to retrieve.
4
+ */
5
+ page: number;
6
+ /**
7
+ * Number of results (hits).
8
+ */
9
+ nbHits: number;
10
+ /**
11
+ * Number of pages of results.
12
+ */
13
+ nbPages: number;
14
+ /**
15
+ * Number of hits per page.
16
+ */
17
+ hitsPerPage: number;
18
+ };
19
+ //# sourceMappingURL=searchPagination.d.ts.map
package/dist/model/searchPagination.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"searchPagination.d.ts","sourceRoot":"","sources":["../../model/searchPagination.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}
package/dist/model/snippetResult.d.ts CHANGED
@@ -1,3 +1,5 @@
1
1
  import type { SnippetResultOption } from './snippetResultOption';
2
- export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
2
+ export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[] | {
3
+ [key: string]: SnippetResult;
4
+ };
3
5
  //# sourceMappingURL=snippetResult.d.ts.map
package/dist/model/snippetResult.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,GACnB,mBAAmB,EAAE,CAAC"}
1
+ {"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,GACnB,mBAAmB,EAAE,GACrB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAAC"}
package/dist/model/trendingItems.d.ts CHANGED
@@ -4,11 +4,11 @@ export type TrendingItems = {
4
4
  /**
5
5
  * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
6
6
  */
7
- facetName: string;
7
+ facetName?: string;
8
8
  /**
9
9
  * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
10
10
  */
11
- facetValue: string;
11
+ facetValue?: string;
12
12
  model: TrendingItemsModel;
13
13
  fallbackParameters?: SearchParamsObject;
14
14
  };
package/dist/model/trendingItems.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"trendingItems.d.ts","sourceRoot":"","sources":["../../model/trendingItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,kBAAkB,CAAC;IAE1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
1
+ {"version":3,"file":"trendingItems.d.ts","sourceRoot":"","sources":["../../model/trendingItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,kBAAkB,CAAC;IAE1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
package/dist/recommend.cjs CHANGED
@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
4
4
  var requesterNodeHttp = require('@algolia/requester-node-http');
5
5
 
6
6
  // 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.
7
- const apiClientVersion = '5.0.0-beta.9';
7
+ const apiClientVersion = '5.0.2';
8
8
  function getDefaultHosts(appId) {
9
9
  return [
10
10
  {
package/dist/recommend.esm.browser.js CHANGED
@@ -687,7 +687,7 @@ function createXhrRequester() {
687
687
  }
688
688
 
689
689
  // 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.
690
- const apiClientVersion = '5.0.0-beta.9';
690
+ const apiClientVersion = '5.0.2';
691
691
  function getDefaultHosts(appId) {
692
692
  return [
693
693
  {
package/dist/recommend.esm.node.js CHANGED
@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, shuffle, DEFAULT_CONNEC
2
2
  import { createHttpRequester } from '@algolia/requester-node-http';
3
3
 
4
4
  // 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.
5
- const apiClientVersion = '5.0.0-beta.9';
5
+ const apiClientVersion = '5.0.2';
6
6
  function getDefaultHosts(appId) {
7
7
  return [
8
8
  {
package/dist/recommend.umd.js CHANGED
@@ -1,2 +1,2 @@
1
- /*! recommend.umd.js | 5.0.0-beta.9 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
2
- !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/recommend"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function a(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function o(){return JSON.parse(a().getItem(r)||"{}")}function s(e){a().setItem(r,JSON.stringify(e))}return{get:(t,r,a={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=o(),a=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(s(a),!t)return;s(Object.fromEntries(Object.entries(a).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),o()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||a.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const s=o();return s[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},a().setItem(r,JSON.stringify(s)),t})),delete:e=>Promise.resolve().then((()=>{const t=o();delete t[JSON.stringify(e)],a().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{a().removeItem(r)}))}}function r(e){const t=[...e.caches],a=t.shift();return void 0===a?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,o,s={miss:()=>Promise.resolve()})=>a.get(e,o,s).catch((()=>r({caches:t}).get(e,o,s))),set:(e,o)=>a.set(e,o).catch((()=>r({caches:t}).set(e,o))),delete:e=>a.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>a.clear().catch((()=>r({caches:t}).clear()))}}function a(e={serializable:!0}){let t={};return{get(r,a,o={miss:()=>Promise.resolve()}){const s=JSON.stringify(r);if(s in t)return Promise.resolve(e.serializable?JSON.parse(t[s]):t[s]);const n=a();return n.then((e=>o.miss(e))).then((()=>n))},set:(r,a)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(a):a,Promise.resolve(a)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const o=12e4;function s(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>o},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=o}}}function n(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var a=r.call(e,t||"default");if("object"!=typeof a)return a;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class i extends Error{constructor(e,t){super(e),n(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends i{constructor(e,t,r){super(e,r),n(this,"stackTrace",void 0),this.stackTrace=t}}class l extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.",e,"RetryError")}}class u extends c{constructor(e,t,r,a="ApiError"){super(e,r,a),n(this,"status",void 0),this.status=t}}class m extends i{constructor(e,t){super(e,"DeserializationError"),n(this,"response",void 0),this.response=t}}class d extends u{constructor(e,t,r,a){super(e,t,a,"DetailedApiError"),n(this,"error",void 0),this.error=r}}function h(e,t,r){const a=(o=r,Object.keys(o).filter((e=>void 0!==o[e])).sort().map((e=>`${e}=${encodeURIComponent("[object Array]"===Object.prototype.toString.call(o[e])?o[e].join(","):o[e]).replaceAll("+","%20")}`)).join("&"));var o;let s=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return a.length&&(s+=`?${a}`),s}function p(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function g({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:a,algoliaAgent:o,timeouts:n,requester:i,requestsCache:c,responsesCache:g}){async function f(c,g,f=!0){const w=[],y=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,g),P=function(e,t,r){const a={Accept:"application/json",...e,...t,...r},o={};return Object.keys(a).forEach((e=>{const t=a[e];o[e.toLowerCase()]=t})),o}(r,c.headers,g.headers),q="GET"===c.method?{...c.data,...g.data}:{},v={...a,...c.queryParameters,...q};if(o.value&&(v["x-algolia-agent"]=o.value),g&&g.queryParameters)for(const e of Object.keys(g.queryParameters))g.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(g.queryParameters[e])?v[e]=g.queryParameters[e].toString():v[e]=g.queryParameters[e];let b=0;const R=async(e,r)=>{const a=e.pop();if(void 0===a)throw new l(function(e){return e.map((e=>p(e)))}(w));let o=f?g.timeouts?.read||n.read:g.timeouts?.write||n.write;const q={data:y,headers:P,method:c.method,url:h(a,c.path,v),connectTimeout:r(b,g.timeouts?.connect||n.connect),responseTimeout:r(b,o)},T=t=>{const r={request:q,response:t,host:a,triesLeft:e.length};return w.push(r),r},E=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&!~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const o=T(E);return E.isTimedOut&&b++,console.log("Retryable failure",p(o)),await t.set(a,s(a,E.isTimedOut?"timed out":"down")),R(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new m(t.message,e)}}(E);throw T(E),function({content:e,status:t},r){try{const a=JSON.parse(e);return"error"in a?new d(a.message,t,a.error,r):new u(a.message,t,r)}catch(e){}return new u(e,t,r)}(E,w)},T=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(s(e))))))),a=r.filter((e=>e.isUp())),o=r.filter((e=>e.isTimedOut())),n=[...a,...o];return{hosts:n.length>0?n:e,getTimeout:(e,t)=>(0===o.length&&0===e?1:o.length+3+e)*t}}(T);return R([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:n,algoliaAgent:o,baseHeaders:r,baseQueryParameters:a,hosts:e,request:function(e,t={}){const o=e.useReadTransporter||"GET"===e.method;if(!o)return f(e,t,o);const s=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return s();const n={request:e,requestOptions:t,transporter:{queryParameters:a,headers:r}};return g.get(n,(()=>c.get(n,(()=>c.set(n,s()).then((e=>Promise.all([c.delete(n),e])),(e=>Promise.all([c.delete(n),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>g.set(n,e)})},requestsCache:c,responsesCache:g}}function f({algoliaAgents:e,client:t,version:r}){const a=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>a.add(e))),a}const w="5.0.0-beta.9";function y(e){return[{url:`${e}-dsn.algolia.net`,accept:"read",protocol:"https"},{url:`${e}.algolia.net`,accept:"write",protocol:"https"}].concat(function(e){const t=e;for(let r=e.length-1;r>0;r--){const a=Math.floor(Math.random()*(r+1)),o=e[r];t[r]=e[a],t[a]=o}return t}([{url:`${e}-1.algolianet.com`,accept:"readWrite",protocol:"https"},{url:`${e}-2.algolianet.com`,accept:"readWrite",protocol:"https"},{url:`${e}-3.algolianet.com`,accept:"readWrite",protocol:"https"}]))}e.apiClientVersion=w,e.recommendClient=function(e,o,s){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!o||"string"!=typeof o)throw new Error("`apiKey` is missing.");return function({appId:e,apiKey:t,authMode:r,algoliaAgents:a,...o}){const s=function(e,t,r="WithinHeaders"){const a={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?a:{},queryParameters:()=>"WithinQueryParameters"===r?a:{}}}(e,t,r),n=g({hosts:y(e),...o,algoliaAgent:f({algoliaAgents:a,client:"Recommend",version:w}),baseHeaders:{"content-type":"text/plain",...s.headers(),...o.baseHeaders},baseQueryParameters:{...s.queryParameters(),...o.baseQueryParameters}});return{transporter:n,appId:e,clearCache:()=>Promise.all([n.requestsCache.clear(),n.responsesCache.clear()]).then((()=>{})),get _ua(){return n.algoliaAgent.value},addAlgoliaAgent(e,t){n.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const a={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(a,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const a={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(a,r)},customPost({path:e,parameters:t,body:r},a){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const o={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,a)},customPut({path:e,parameters:t,body:r},a){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const o={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,a)},deleteRecommendRule({indexName:e,model:t,objectID:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `deleteRecommendRule`.");if(!t)throw new Error("Parameter `model` is required when calling `deleteRecommendRule`.");if(!r)throw new Error("Parameter `objectID` is required when calling `deleteRecommendRule`.");const o={method:"DELETE",path:"/1/indexes/{indexName}/{model}/recommend/rules/{objectID}".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)).replace("{objectID}",encodeURIComponent(r)),queryParameters:{},headers:{}};return n.request(o,a)},getRecommendRule({indexName:e,model:t,objectID:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `getRecommendRule`.");if(!t)throw new Error("Parameter `model` is required when calling `getRecommendRule`.");if(!r)throw new Error("Parameter `objectID` is required when calling `getRecommendRule`.");const o={method:"GET",path:"/1/indexes/{indexName}/{model}/recommend/rules/{objectID}".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)).replace("{objectID}",encodeURIComponent(r)),queryParameters:{},headers:{}};return n.request(o,a)},getRecommendStatus({indexName:e,model:t,taskID:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `getRecommendStatus`.");if(!t)throw new Error("Parameter `model` is required when calling `getRecommendStatus`.");if(!r)throw new Error("Parameter `taskID` is required when calling `getRecommendStatus`.");const o={method:"GET",path:"/1/indexes/{indexName}/{model}/task/{taskID}".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)).replace("{taskID}",encodeURIComponent(r)),queryParameters:{},headers:{}};return n.request(o,a)},getRecommendations(e,t){if(e&&Array.isArray(e)&&(e={requests:e}),!e)throw new Error("Parameter `getRecommendationsParams` is required when calling `getRecommendations`.");if(!e.requests)throw new Error("Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.");const r={method:"POST",path:"/1/indexes/*/recommendations",queryParameters:{},headers:{},data:e,useReadTransporter:!0,cacheable:!0};return n.request(r,t)},searchRecommendRules({indexName:e,model:t,searchRecommendRulesParams:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `searchRecommendRules`.");if(!t)throw new Error("Parameter `model` is required when calling `searchRecommendRules`.");const o={method:"POST",path:"/1/indexes/{indexName}/{model}/recommend/rules/search".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)),queryParameters:{},headers:{},data:r||{},useReadTransporter:!0,cacheable:!0};return n.request(o,a)}}}({appId:e,apiKey:o,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const a=(e,a)=>setTimeout((()=>{r.abort(),t({status:0,content:a,isTimedOut:!0})}),e),o=a(e.connectTimeout,"Connection timeout");let s;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===s&&(clearTimeout(o),s=a(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(o),clearTimeout(s),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(o),clearTimeout(s),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:a(),requestsCache:a({serializable:!1}),hostsCache:r({caches:[t({key:`${w}-${e}`}),a()]}),...s})}}));
1
+ /*! recommend.umd.js | 5.0.2 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
2
+ !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/recommend"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function a(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function o(){return JSON.parse(a().getItem(r)||"{}")}function s(e){a().setItem(r,JSON.stringify(e))}return{get:(t,r,a={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=o(),a=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(s(a),!t)return;s(Object.fromEntries(Object.entries(a).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),o()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||a.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const s=o();return s[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},a().setItem(r,JSON.stringify(s)),t})),delete:e=>Promise.resolve().then((()=>{const t=o();delete t[JSON.stringify(e)],a().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{a().removeItem(r)}))}}function r(e){const t=[...e.caches],a=t.shift();return void 0===a?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,o,s={miss:()=>Promise.resolve()})=>a.get(e,o,s).catch((()=>r({caches:t}).get(e,o,s))),set:(e,o)=>a.set(e,o).catch((()=>r({caches:t}).set(e,o))),delete:e=>a.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>a.clear().catch((()=>r({caches:t}).clear()))}}function a(e={serializable:!0}){let t={};return{get(r,a,o={miss:()=>Promise.resolve()}){const s=JSON.stringify(r);if(s in t)return Promise.resolve(e.serializable?JSON.parse(t[s]):t[s]);const n=a();return n.then((e=>o.miss(e))).then((()=>n))},set:(r,a)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(a):a,Promise.resolve(a)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const o=12e4;function s(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>o},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=o}}}function n(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var a=r.call(e,t||"default");if("object"!=typeof a)return a;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class i extends Error{constructor(e,t){super(e),n(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends i{constructor(e,t,r){super(e,r),n(this,"stackTrace",void 0),this.stackTrace=t}}class l extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.",e,"RetryError")}}class u extends c{constructor(e,t,r,a="ApiError"){super(e,r,a),n(this,"status",void 0),this.status=t}}class m extends i{constructor(e,t){super(e,"DeserializationError"),n(this,"response",void 0),this.response=t}}class d extends u{constructor(e,t,r,a){super(e,t,a,"DetailedApiError"),n(this,"error",void 0),this.error=r}}function h(e,t,r){const a=(o=r,Object.keys(o).filter((e=>void 0!==o[e])).sort().map((e=>`${e}=${encodeURIComponent("[object Array]"===Object.prototype.toString.call(o[e])?o[e].join(","):o[e]).replaceAll("+","%20")}`)).join("&"));var o;let s=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return a.length&&(s+=`?${a}`),s}function p(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function g({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:a,algoliaAgent:o,timeouts:n,requester:i,requestsCache:c,responsesCache:g}){async function f(c,g,f=!0){const w=[],y=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,g),P=function(e,t,r){const a={Accept:"application/json",...e,...t,...r},o={};return Object.keys(a).forEach((e=>{const t=a[e];o[e.toLowerCase()]=t})),o}(r,c.headers,g.headers),q="GET"===c.method?{...c.data,...g.data}:{},v={...a,...c.queryParameters,...q};if(o.value&&(v["x-algolia-agent"]=o.value),g&&g.queryParameters)for(const e of Object.keys(g.queryParameters))g.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(g.queryParameters[e])?v[e]=g.queryParameters[e].toString():v[e]=g.queryParameters[e];let b=0;const R=async(e,r)=>{const a=e.pop();if(void 0===a)throw new l(function(e){return e.map((e=>p(e)))}(w));let o=f?g.timeouts?.read||n.read:g.timeouts?.write||n.write;const q={data:y,headers:P,method:c.method,url:h(a,c.path,v),connectTimeout:r(b,g.timeouts?.connect||n.connect),responseTimeout:r(b,o)},T=t=>{const r={request:q,response:t,host:a,triesLeft:e.length};return w.push(r),r},E=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&!~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const o=T(E);return E.isTimedOut&&b++,console.log("Retryable failure",p(o)),await t.set(a,s(a,E.isTimedOut?"timed out":"down")),R(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new m(t.message,e)}}(E);throw T(E),function({content:e,status:t},r){try{const a=JSON.parse(e);return"error"in a?new d(a.message,t,a.error,r):new u(a.message,t,r)}catch(e){}return new u(e,t,r)}(E,w)},T=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(s(e))))))),a=r.filter((e=>e.isUp())),o=r.filter((e=>e.isTimedOut())),n=[...a,...o];return{hosts:n.length>0?n:e,getTimeout:(e,t)=>(0===o.length&&0===e?1:o.length+3+e)*t}}(T);return R([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:n,algoliaAgent:o,baseHeaders:r,baseQueryParameters:a,hosts:e,request:function(e,t={}){const o=e.useReadTransporter||"GET"===e.method;if(!o)return f(e,t,o);const s=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return s();const n={request:e,requestOptions:t,transporter:{queryParameters:a,headers:r}};return g.get(n,(()=>c.get(n,(()=>c.set(n,s()).then((e=>Promise.all([c.delete(n),e])),(e=>Promise.all([c.delete(n),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>g.set(n,e)})},requestsCache:c,responsesCache:g}}function f({algoliaAgents:e,client:t,version:r}){const a=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>a.add(e))),a}const w="5.0.2";function y(e){return[{url:`${e}-dsn.algolia.net`,accept:"read",protocol:"https"},{url:`${e}.algolia.net`,accept:"write",protocol:"https"}].concat(function(e){const t=e;for(let r=e.length-1;r>0;r--){const a=Math.floor(Math.random()*(r+1)),o=e[r];t[r]=e[a],t[a]=o}return t}([{url:`${e}-1.algolianet.com`,accept:"readWrite",protocol:"https"},{url:`${e}-2.algolianet.com`,accept:"readWrite",protocol:"https"},{url:`${e}-3.algolianet.com`,accept:"readWrite",protocol:"https"}]))}e.apiClientVersion=w,e.recommendClient=function(e,o,s){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!o||"string"!=typeof o)throw new Error("`apiKey` is missing.");return function({appId:e,apiKey:t,authMode:r,algoliaAgents:a,...o}){const s=function(e,t,r="WithinHeaders"){const a={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?a:{},queryParameters:()=>"WithinQueryParameters"===r?a:{}}}(e,t,r),n=g({hosts:y(e),...o,algoliaAgent:f({algoliaAgents:a,client:"Recommend",version:w}),baseHeaders:{"content-type":"text/plain",...s.headers(),...o.baseHeaders},baseQueryParameters:{...s.queryParameters(),...o.baseQueryParameters}});return{transporter:n,appId:e,clearCache:()=>Promise.all([n.requestsCache.clear(),n.responsesCache.clear()]).then((()=>{})),get _ua(){return n.algoliaAgent.value},addAlgoliaAgent(e,t){n.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const a={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(a,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const a={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(a,r)},customPost({path:e,parameters:t,body:r},a){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const o={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,a)},customPut({path:e,parameters:t,body:r},a){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const o={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,a)},deleteRecommendRule({indexName:e,model:t,objectID:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `deleteRecommendRule`.");if(!t)throw new Error("Parameter `model` is required when calling `deleteRecommendRule`.");if(!r)throw new Error("Parameter `objectID` is required when calling `deleteRecommendRule`.");const o={method:"DELETE",path:"/1/indexes/{indexName}/{model}/recommend/rules/{objectID}".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)).replace("{objectID}",encodeURIComponent(r)),queryParameters:{},headers:{}};return n.request(o,a)},getRecommendRule({indexName:e,model:t,objectID:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `getRecommendRule`.");if(!t)throw new Error("Parameter `model` is required when calling `getRecommendRule`.");if(!r)throw new Error("Parameter `objectID` is required when calling `getRecommendRule`.");const o={method:"GET",path:"/1/indexes/{indexName}/{model}/recommend/rules/{objectID}".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)).replace("{objectID}",encodeURIComponent(r)),queryParameters:{},headers:{}};return n.request(o,a)},getRecommendStatus({indexName:e,model:t,taskID:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `getRecommendStatus`.");if(!t)throw new Error("Parameter `model` is required when calling `getRecommendStatus`.");if(!r)throw new Error("Parameter `taskID` is required when calling `getRecommendStatus`.");const o={method:"GET",path:"/1/indexes/{indexName}/{model}/task/{taskID}".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)).replace("{taskID}",encodeURIComponent(r)),queryParameters:{},headers:{}};return n.request(o,a)},getRecommendations(e,t){if(e&&Array.isArray(e)&&(e={requests:e}),!e)throw new Error("Parameter `getRecommendationsParams` is required when calling `getRecommendations`.");if(!e.requests)throw new Error("Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.");const r={method:"POST",path:"/1/indexes/*/recommendations",queryParameters:{},headers:{},data:e,useReadTransporter:!0,cacheable:!0};return n.request(r,t)},searchRecommendRules({indexName:e,model:t,searchRecommendRulesParams:r},a){if(!e)throw new Error("Parameter `indexName` is required when calling `searchRecommendRules`.");if(!t)throw new Error("Parameter `model` is required when calling `searchRecommendRules`.");const o={method:"POST",path:"/1/indexes/{indexName}/{model}/recommend/rules/search".replace("{indexName}",encodeURIComponent(e)).replace("{model}",encodeURIComponent(t)),queryParameters:{},headers:{},data:r||{},useReadTransporter:!0,cacheable:!0};return n.request(o,a)}}}({appId:e,apiKey:o,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const a=(e,a)=>setTimeout((()=>{r.abort(),t({status:0,content:a,isTimedOut:!0})}),e),o=a(e.connectTimeout,"Connection timeout");let s;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===s&&(clearTimeout(o),s=a(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(o),clearTimeout(s),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(o),clearTimeout(s),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:a(),requestsCache:a({serializable:!1}),hostsCache:r({caches:[t({key:`${w}-${e}`}),a()]}),...s})}}));
package/dist/src/recommendClient.d.ts CHANGED
@@ -6,7 +6,7 @@ import type { GetRecommendationsParams } from '../model/getRecommendationsParams
6
6
  import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
7
7
  import type { RecommendRule } from '../model/recommendRule';
8
8
  import type { SearchRecommendRulesResponse } from '../model/searchRecommendRulesResponse';
9
- export declare const apiClientVersion = "5.0.0-beta.9";
9
+ export declare const apiClientVersion = "5.0.2";
10
10
  export declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
11
11
  transporter: import("@algolia/client-common").Transporter;
12
12
  /**
package/dist/src/recommendClient.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,8BAA8B,EAC9B,yBAAyB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAE1F,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAsC/C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;;;OAWG;wDAE+B,wBAAwB,mBACvC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAqC7B;;;;;;;;;;;OAWG;qDAE+B,qBAAqB,mBACpC,cAAc,GAC9B,OAAO,CAAC,aAAa,CAAC;IAqCzB;;;;;;;;;;;OAWG;qDAE6B,uBAAuB,mBACpC,cAAc,GAC9B,OAAO,CAAC,wBAAwB,CAAC;IAoCpC;;;;;;;;OAQG;iDAGG,wBAAwB,GACxB,8BAA8B,mBACjB,cAAc,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IAuCtC;;;;;;;;;;;OAWG;4EAME,yBAAyB,mBACX,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;EAiC3C"}
1
+ {"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,8BAA8B,EAC9B,yBAAyB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAE1F,eAAO,MAAM,gBAAgB,UAAU,CAAC;AAsCxC,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;;;OAWG;wDAE+B,wBAAwB,mBACvC,cAAc,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAqC7B;;;;;;;;;;;OAWG;qDAE+B,qBAAqB,mBACpC,cAAc,GAC9B,OAAO,CAAC,aAAa,CAAC;IAqCzB;;;;;;;;;;;OAWG;qDAE6B,uBAAuB,mBACpC,cAAc,GAC9B,OAAO,CAAC,wBAAwB,CAAC;IAoCpC;;;;;;;;OAQG;iDAGG,wBAAwB,GACxB,8BAA8B,mBACjB,cAAc,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IAuCtC;;;;;;;;;;;OAWG;4EAME,yBAAyB,mBACX,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;EAiC3C"}
package/model/aroundPrecision.ts CHANGED
@@ -1,8 +1,8 @@
1
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 { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
3
+ import type { Range } from './range';
4
4
 
5
5
  /**
6
6
  * Precision of a coordinate-based search in meters to group results with similar distances. The Geo ranking criterion considers all matches within the same range of distances to be equal.
7
7
  */
8
- export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
8
+ export type AroundPrecision = Range[] | number;
package/model/baseSearchResponse.ts CHANGED
@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
53
53
  */
54
54
  facets_stats?: Record<string, FacetsStats>;
55
55
 
56
- /**
57
- * Number of hits per page.
58
- */
59
- hitsPerPage: number;
60
-
61
56
  /**
62
57
  * Index name used for the query.
63
58
  */
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
73
68
  */
74
69
  message?: string;
75
70
 
76
- /**
77
- * Number of results (hits).
78
- */
79
- nbHits: number;
80
-
81
- /**
82
- * Number of pages of results.
83
- */
84
- nbPages: number;
85
-
86
71
  /**
87
72
  * Number of hits selected and sorted by the relevant sort algorithm.
88
73
  */
89
74
  nbSortedHits?: number;
90
75
 
91
- /**
92
- * Page of search results to retrieve.
93
- */
94
- page: number;
95
-
96
76
  /**
97
77
  * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
98
78
  */
package/model/getRecommendationsResponse.ts CHANGED
@@ -3,5 +3,5 @@
3
3
  import type { RecommendationsResults } from './recommendationsResults';
4
4
 
5
5
  export type GetRecommendationsResponse = {
6
- results?: RecommendationsResults[];
6
+ results: RecommendationsResults[];
7
7
  };
package/model/highlightResult.ts CHANGED
@@ -5,4 +5,5 @@ import type { HighlightResultOption } from './highlightResultOption';
5
5
  export type HighlightResult =
6
6
  | HighlightResultOption
7
7
  | HighlightResultOption[]
8
- | Record<string, HighlightResultOption>;
8
+ | Record<string, HighlightResultOption>
9
+ | { [key: string]: HighlightResult };
package/model/index.ts CHANGED
@@ -3,7 +3,6 @@
3
3
  export * from './advancedSyntaxFeatures';
4
4
  export * from './alternativesAsExact';
5
5
  export * from './aroundPrecision';
6
- export * from './aroundPrecisionFromValueInner';
7
6
  export * from './aroundRadius';
8
7
  export * from './aroundRadiusAll';
9
8
  export * from './autoFacetFilter';
@@ -46,12 +45,12 @@ export * from './paramsConsequence';
46
45
  export * from './personalization';
47
46
  export * from './promoteConsequenceObject';
48
47
  export * from './queryType';
48
+ export * from './range';
49
49
  export * from './rankingInfo';
50
50
  export * from './reRankingApplyFilter';
51
51
  export * from './recommendHit';
52
52
  export * from './recommendModels';
53
53
  export * from './recommendRule';
54
- export * from './recommendRuleMetadata';
55
54
  export * from './recommendationsHit';
56
55
  export * from './recommendationsHits';
57
56
  export * from './recommendationsRequest';
@@ -60,8 +59,8 @@ export * from './recommendedForYou';
60
59
  export * from './recommendedForYouModel';
61
60
  export * from './recommendedForYouQuery';
62
61
  export * from './redirect';
62
+ export * from './redirectRuleIndexData';
63
63
  export * from './redirectRuleIndexMetadata';
64
- export * from './redirectRuleIndexMetadataData';
65
64
  export * from './redirectURL';
66
65
  export * from './relatedModel';
67
66
  export * from './relatedProducts';
@@ -69,6 +68,8 @@ export * from './relatedQuery';
69
68
  export * from './removeStopWords';
70
69
  export * from './removeWordsIfNoResults';
71
70
  export * from './renderingContent';
71
+ export * from './ruleMetadata';
72
+ export * from './searchPagination';
72
73
  export * from './searchParams';
73
74
  export * from './searchParamsObject';
74
75
  export * from './searchParamsQuery';
package/model/indexSettingsAsSearchParams.ts CHANGED
@@ -108,7 +108,7 @@ export type IndexSettingsAsSearchParams = {
108
108
  queryLanguages?: SupportedLanguage[];
109
109
 
110
110
  /**
111
- * Whether to split compound words into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.
111
+ * Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
112
112
  */
113
113
  decompoundQuery?: boolean;
114
114
 
package/model/{aroundPrecisionFromValueInner.ts → range.ts} RENAMED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * Range object with lower and upper values in meters to define custom ranges.
5
5
  */
6
- export type AroundPrecisionFromValueInner = {
6
+ export type Range = {
7
7
  /**
8
8
  * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
9
9
  */
package/model/recommendRule.ts CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  import type { Condition } from './condition';
4
4
  import type { Consequence } from './consequence';
5
- import type { RecommendRuleMetadata } from './recommendRuleMetadata';
5
+ import type { RuleMetadata } from './ruleMetadata';
6
6
 
7
7
  /**
8
8
  * Recommend rule.
9
9
  */
10
10
  export type RecommendRule = {
11
- _metadata?: RecommendRuleMetadata;
11
+ _metadata?: RuleMetadata;
12
12
 
13
13
  /**
14
14
  * Unique identifier of a rule object.
package/model/recommendationsResults.ts CHANGED
@@ -2,5 +2,8 @@
2
2
 
3
3
  import type { BaseSearchResponse } from './baseSearchResponse';
4
4
  import type { RecommendationsHits } from './recommendationsHits';
5
+ import type { SearchPagination } from './searchPagination';
5
6
 
6
- export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;
7
+ export type RecommendationsResults = BaseSearchResponse &
8
+ RecommendationsHits &
9
+ SearchPagination;
package/model/{redirectRuleIndexMetadataData.ts → redirectRuleIndexData.ts} RENAMED
@@ -3,6 +3,6 @@
3
3
  /**
4
4
  * Redirect rule data.
5
5
  */
6
- export type RedirectRuleIndexMetadataData = {
6
+ export type RedirectRuleIndexData = {
7
7
  ruleObjectID: string;
8
8
  };
package/model/redirectRuleIndexMetadata.ts CHANGED
@@ -1,6 +1,6 @@
1
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 { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
3
+ import type { RedirectRuleIndexData } from './redirectRuleIndexData';
4
4
 
5
5
  export type RedirectRuleIndexMetadata = {
6
6
  /**
@@ -23,5 +23,5 @@ export type RedirectRuleIndexMetadata = {
23
23
  */
24
24
  succeed: boolean;
25
25
 
26
- data: RedirectRuleIndexMetadataData;
26
+ data: RedirectRuleIndexData;
27
27
  };
package/model/{recommendRuleMetadata.ts → ruleMetadata.ts} RENAMED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * Rule metadata.
5
5
  */
6
- export type RecommendRuleMetadata = {
6
+ export type RuleMetadata = {
7
7
  /**
8
8
  * Date and time when the object was updated, in RFC 3339 format.
9
9
  */
package/model/searchPagination.ts ADDED
@@ -0,0 +1,23 @@
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
+ export type SearchPagination = {
4
+ /**
5
+ * Page of search results to retrieve.
6
+ */
7
+ page: number;
8
+
9
+ /**
10
+ * Number of results (hits).
11
+ */
12
+ nbHits: number;
13
+
14
+ /**
15
+ * Number of pages of results.
16
+ */
17
+ nbPages: number;
18
+
19
+ /**
20
+ * Number of hits per page.
21
+ */
22
+ hitsPerPage: number;
23
+ };
package/model/snippetResult.ts CHANGED
@@ -5,4 +5,5 @@ import type { SnippetResultOption } from './snippetResultOption';
5
5
  export type SnippetResult =
6
6
  | Record<string, SnippetResultOption>
7
7
  | SnippetResultOption
8
- | SnippetResultOption[];
8
+ | SnippetResultOption[]
9
+ | { [key: string]: SnippetResult };
package/model/trendingItems.ts CHANGED
@@ -7,12 +7,12 @@ export type TrendingItems = {
7
7
  /**
8
8
  * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
9
9
  */
10
- facetName: string;
10
+ facetName?: string;
11
11
 
12
12
  /**
13
13
  * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
14
14
  */
15
- facetValue: string;
15
+ facetValue?: string;
16
16
 
17
17
  model: TrendingItemsModel;
18
18
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@algolia/recommend",
3
- "version": "5.0.0-beta.9",
3
+ "version": "5.0.2",
4
4
  "description": "JavaScript client for recommend",
5
5
  "repository": {
6
6
  "type": "git",
@@ -42,14 +42,14 @@
42
42
  "clean": "rm -rf ./dist || true"
43
43
  },
44
44
  "dependencies": {
45
- "@algolia/client-common": "5.0.0-beta.10",
46
- "@algolia/requester-browser-xhr": "5.0.0-beta.10",
47
- "@algolia/requester-node-http": "5.0.0-beta.10"
45
+ "@algolia/client-common": "5.0.2",
46
+ "@algolia/requester-browser-xhr": "5.0.2",
47
+ "@algolia/requester-node-http": "5.0.2"
48
48
  },
49
49
  "devDependencies": {
50
- "@types/node": "20.14.10",
51
- "rollup": "4.18.0",
52
- "typescript": "5.5.3"
50
+ "@types/node": "22.2.0",
51
+ "rollup": "4.20.0",
52
+ "typescript": "5.5.4"
53
53
  },
54
54
  "engines": {
55
55
  "node": ">= 14.0.0"
package/dist/model/aroundPrecisionFromValueInner.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
package/dist/model/recommendRuleMetadata.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"recommendRuleMetadata.d.ts","sourceRoot":"","sources":["../../model/recommendRuleMetadata.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}
package/dist/model/redirectRuleIndexMetadataData.d.ts DELETED
@@ -1,7 +0,0 @@
1
- /**
2
- * Redirect rule data.
3
- */
4
- export type RedirectRuleIndexMetadataData = {
5
- ruleObjectID: string;
6
- };
7
- //# sourceMappingURL=redirectRuleIndexMetadataData.d.ts.map
package/dist/model/redirectRuleIndexMetadataData.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"redirectRuleIndexMetadataData.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadataData.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}