@algolia/client-analytics 5.7.0 → 5.8.1

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 +5 -6
  2. package/dist/browser.d.ts +825 -834
  3. package/dist/builds/browser.js +144 -168
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +3 -3
  8. package/dist/builds/fetch.js +141 -165
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +141 -165
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +142 -166
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +824 -832
  15. package/dist/node.d.cts +824 -832
  16. package/dist/node.d.ts +824 -832
  17. package/dist/src/analyticsClient.cjs +140 -164
  18. package/dist/src/analyticsClient.cjs.map +1 -1
  19. package/dist/src/analyticsClient.js +140 -164
  20. package/dist/src/analyticsClient.js.map +1 -1
  21. package/index.d.ts +0 -1
  22. package/index.js +1 -2
  23. package/model/clickPosition.ts +1 -1
  24. package/model/clientMethodProps.ts +23 -22
  25. package/model/dailyRevenue.ts +1 -1
  26. package/model/getAddToCartRateResponse.ts +1 -1
  27. package/model/getAverageClickPositionResponse.ts +1 -1
  28. package/model/getClickPositionsResponse.ts +1 -1
  29. package/model/getClickThroughRateResponse.ts +1 -1
  30. package/model/getConversionRateResponse.ts +1 -1
  31. package/model/getNoClickRateResponse.ts +1 -1
  32. package/model/getNoResultsRateResponse.ts +1 -1
  33. package/model/getPurchaseRateResponse.ts +1 -1
  34. package/model/getRevenue.ts +2 -2
  35. package/model/getSearchesCountResponse.ts +1 -1
  36. package/model/getSearchesNoClicksResponse.ts +1 -1
  37. package/model/getSearchesNoResultsResponse.ts +1 -1
  38. package/model/getTopCountriesResponse.ts +1 -1
  39. package/model/getTopFilterAttributesResponse.ts +1 -1
  40. package/model/getTopFilterForAttributeResponse.ts +1 -1
  41. package/model/getTopFiltersNoResultsResponse.ts +1 -1
  42. package/model/getTopFiltersNoResultsValues.ts +1 -1
  43. package/model/getUsersCountResponse.ts +1 -1
  44. package/model/index.ts +5 -5
  45. package/model/operator.ts +1 -1
  46. package/model/orderBy.ts +1 -1
  47. package/model/topHitWithRevenueAnalytics.ts +1 -1
  48. package/model/topHitsResponse.ts +1 -1
  49. package/model/topHitsResponseWithAnalytics.ts +1 -1
  50. package/model/topHitsResponseWithRevenueAnalytics.ts +1 -1
  51. package/model/topSearchWithAnalytics.ts +1 -1
  52. package/model/topSearchWithRevenueAnalytics.ts +2 -2
  53. package/model/topSearchesResponse.ts +1 -1
  54. package/model/topSearchesResponseWithAnalytics.ts +1 -1
  55. package/model/topSearchesResponseWithRevenueAnalytics.ts +1 -1
  56. package/package.json +6 -6
@@ -11,5 +11,5 @@ export type GetSearchesCountResponse = {
11
11
  /**
12
12
  * Daily number of searches.
13
13
  */
14
- dates: DailySearches[];
14
+ dates: Array<DailySearches>;
15
15
  };
@@ -6,5 +6,5 @@ export type GetSearchesNoClicksResponse = {
6
6
  /**
7
7
  * Searches without any clicks.
8
8
  */
9
- searches: DailySearchesNoClicks[];
9
+ searches: Array<DailySearchesNoClicks>;
10
10
  };
@@ -6,5 +6,5 @@ export type GetSearchesNoResultsResponse = {
6
6
  /**
7
7
  * Searches without results.
8
8
  */
9
- searches: DailySearchesNoResults[];
9
+ searches: Array<DailySearchesNoResults>;
10
10
  };
@@ -6,5 +6,5 @@ export type GetTopCountriesResponse = {
6
6
  /**
7
7
  * Countries and number of searches.
8
8
  */
9
- countries: TopCountry[];
9
+ countries: Array<TopCountry>;
10
10
  };
@@ -6,5 +6,5 @@ export type GetTopFilterAttributesResponse = {
6
6
  /**
7
7
  * Most frequent filters.
8
8
  */
9
- attributes: GetTopFilterAttribute[];
9
+ attributes: Array<GetTopFilterAttribute>;
10
10
  };
@@ -6,5 +6,5 @@ export type GetTopFilterForAttributeResponse = {
6
6
  /**
7
7
  * Filter values for an attribute.
8
8
  */
9
- values: GetTopFilterForAttribute[];
9
+ values: Array<GetTopFilterForAttribute>;
10
10
  };
@@ -6,5 +6,5 @@ export type GetTopFiltersNoResultsResponse = {
6
6
  /**
7
7
  * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
8
8
  */
9
- values: GetTopFiltersNoResultsValues[] | null;
9
+ values: Array<GetTopFiltersNoResultsValues> | null;
10
10
  };
@@ -11,5 +11,5 @@ export type GetTopFiltersNoResultsValues = {
11
11
  /**
12
12
  * Filters with no results.
13
13
  */
14
- values: GetTopFiltersNoResultsValue[];
14
+ values: Array<GetTopFiltersNoResultsValue>;
15
15
  };
@@ -11,5 +11,5 @@ export type GetUsersCountResponse = {
11
11
  /**
12
12
  * Daily number of unique users.
13
13
  */
14
- dates: DailyUsers[];
14
+ dates: Array<DailyUsers>;
15
15
  };
package/model/index.ts CHANGED
@@ -1,6 +1,7 @@
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
3
  export * from './clickPosition';
4
+ export * from './clientMethodProps';
4
5
  export * from './currencyCode';
5
6
  export * from './dailyAddToCartRates';
6
7
  export * from './dailyAverageClicks';
@@ -44,15 +45,14 @@ export * from './operator';
44
45
  export * from './orderBy';
45
46
  export * from './topCountry';
46
47
  export * from './topHit';
47
- export * from './topHitWithAnalytics';
48
- export * from './topHitWithRevenueAnalytics';
49
48
  export * from './topHitsResponse';
50
49
  export * from './topHitsResponseWithAnalytics';
51
50
  export * from './topHitsResponseWithRevenueAnalytics';
51
+ export * from './topHitWithAnalytics';
52
+ export * from './topHitWithRevenueAnalytics';
52
53
  export * from './topSearch';
53
- export * from './topSearchWithAnalytics';
54
- export * from './topSearchWithRevenueAnalytics';
55
54
  export * from './topSearchesResponse';
56
55
  export * from './topSearchesResponseWithAnalytics';
57
56
  export * from './topSearchesResponseWithRevenueAnalytics';
58
- export * from './clientMethodProps';
57
+ export * from './topSearchWithAnalytics';
58
+ export * from './topSearchWithRevenueAnalytics';
package/model/operator.ts CHANGED
@@ -3,4 +3,4 @@
3
3
  /**
4
4
  * Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
5
5
  */
6
- export type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
6
+ export type Operator = ':' | '<' | '<=' | '=' | '!=' | '>' | '>=';
package/model/orderBy.ts CHANGED
@@ -3,4 +3,4 @@
3
3
  /**
4
4
  * Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
5
5
  */
6
- export type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
6
+ export type OrderBy = 'searchCount' | 'clickThroughRate' | 'conversionRate' | 'averageClickPosition';
@@ -61,5 +61,5 @@ export type TopHitWithRevenueAnalytics = {
61
61
  /**
62
62
  * Revenue associated with this search, broken-down by currencies.
63
63
  */
64
- currencies: Record<string, CurrencyCode>;
64
+ currencies: { [key: string]: CurrencyCode };
65
65
  };
@@ -6,5 +6,5 @@ export type TopHitsResponse = {
6
6
  /**
7
7
  * Most frequent search results.
8
8
  */
9
- hits: TopHit[];
9
+ hits: Array<TopHit>;
10
10
  };
@@ -6,5 +6,5 @@ export type TopHitsResponseWithAnalytics = {
6
6
  /**
7
7
  * Most frequent search results with click and conversion metrics.
8
8
  */
9
- hits: TopHitWithAnalytics[];
9
+ hits: Array<TopHitWithAnalytics>;
10
10
  };
@@ -6,5 +6,5 @@ export type TopHitsResponseWithRevenueAnalytics = {
6
6
  /**
7
7
  * Most frequent search results with click, conversion, and revenue metrics.
8
8
  */
9
- hits: TopHitWithRevenueAnalytics[];
9
+ hits: Array<TopHitWithRevenueAnalytics>;
10
10
  };
@@ -26,7 +26,7 @@ export type TopSearchWithAnalytics = {
26
26
  /**
27
27
  * List of positions in the search results and clicks associated with this search.
28
28
  */
29
- clickPositions: ClickPosition[];
29
+ clickPositions: Array<ClickPosition>;
30
30
 
31
31
  /**
32
32
  * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
@@ -27,7 +27,7 @@ export type TopSearchWithRevenueAnalytics = {
27
27
  /**
28
28
  * List of positions in the search results and clicks associated with this search.
29
29
  */
30
- clickPositions: ClickPosition[];
30
+ clickPositions: Array<ClickPosition>;
31
31
 
32
32
  /**
33
33
  * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
@@ -57,7 +57,7 @@ export type TopSearchWithRevenueAnalytics = {
57
57
  /**
58
58
  * Revenue associated with this search, broken-down by currencies.
59
59
  */
60
- currencies: Record<string, CurrencyCode>;
60
+ currencies: { [key: string]: CurrencyCode };
61
61
 
62
62
  /**
63
63
  * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
@@ -6,5 +6,5 @@ export type TopSearchesResponse = {
6
6
  /**
7
7
  * Most popular searches and their number of search results (hits).
8
8
  */
9
- searches: TopSearch[];
9
+ searches: Array<TopSearch>;
10
10
  };
@@ -6,5 +6,5 @@ export type TopSearchesResponseWithAnalytics = {
6
6
  /**
7
7
  * Most popular searches and their associated click and conversion metrics.
8
8
  */
9
- searches: TopSearchWithAnalytics[];
9
+ searches: Array<TopSearchWithAnalytics>;
10
10
  };
@@ -6,5 +6,5 @@ export type TopSearchesResponseWithRevenueAnalytics = {
6
6
  /**
7
7
  * Most popular searches, including their click and revenue metrics.
8
8
  */
9
- searches: TopSearchWithRevenueAnalytics[];
9
+ searches: Array<TopSearchWithRevenueAnalytics>;
10
10
  };
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "5.7.0",
2
+ "version": "5.8.1",
3
3
  "repository": {
4
4
  "type": "git",
5
5
  "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,16 +49,16 @@
49
49
  "index.d.ts"
50
50
  ],
51
51
  "dependencies": {
52
- "@algolia/client-common": "5.7.0",
53
- "@algolia/requester-browser-xhr": "5.7.0",
54
- "@algolia/requester-fetch": "5.7.0",
55
- "@algolia/requester-node-http": "5.7.0"
52
+ "@algolia/client-common": "5.8.1",
53
+ "@algolia/requester-browser-xhr": "5.8.1",
54
+ "@algolia/requester-fetch": "5.8.1",
55
+ "@algolia/requester-node-http": "5.8.1"
56
56
  },
57
57
  "devDependencies": {
58
58
  "@arethetypeswrong/cli": "0.16.4",
59
59
  "@types/node": "22.7.4",
60
60
  "publint": "0.2.11",
61
- "rollup": "4.22.5",
61
+ "rollup": "4.24.0",
62
62
  "tsup": "8.3.0",
63
63
  "typescript": "5.6.2"
64
64
  },