@algolia/client-analytics 5.0.0-alpha.9 → 5.0.0-alpha.90

package/model/topHitsResponseWithAnalytics.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 import type { TopHitWithAnalytics } from './topHitWithAnalytics';
 
 export type TopHitsResponseWithAnalytics = {
   /**
-   * A list of top hits with their count and analytics.
+   * Top hits.
    */
   hits: TopHitWithAnalytics[];
 };

package/model/topSearch.ts

@@ -1,18 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type TopSearch = {
   /**
-   * The search query.
+   * User query.
    */
   search: string;
 
   /**
-   * The number of occurrences.
+   * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
    */
   count: number;
 
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 };

package/model/topSearchWithAnalytics.ts

@@ -1,48 +1,48 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type TopSearchWithAnalytics = {
   /**
-   * The search query.
+   * User query.
    */
   search: string;
 
   /**
-   * The number of occurrences.
+   * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
    */
   count: number;
 
   /**
-   * The click-through rate.
+   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
    */
   clickThroughRate: number;
 
   /**
-   * The average position of all the click count event.
+   * Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
    */
   averageClickPosition: number;
 
   /**
-   * The conversion rate.
+   * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
    */
   conversionRate: number;
 
   /**
-   * The number of tracked search click.
+   * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
    */
   trackedSearchCount: number;
 
   /**
-   * The number of click event.
+   * Number of click events.
    */
   clickCount: number;
 
   /**
-   * The number of converted clicks.
+   * Number of converted clicks.
    */
   conversionCount: number;
 
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 };

package/model/topSearchesResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 import type { TopSearch } from './topSearch';
 
 export type TopSearchesResponse = {
   /**
-   * A list of top searches with their count.
+   * Top searches with their hits count.
    */
   searches: TopSearch[];
 };

package/model/topSearchesResponseWithAnalytics.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
 
 export type TopSearchesResponseWithAnalytics = {
   /**
-   * A list of top searches with their count and analytics.
+   * Top searches with their hits count and analytics.
    */
   searches: TopSearchWithAnalytics[];
 };

package/model/userWithDate.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type UserWithDate = {
   /**
-   * Date of the event.
+   * Date of the event in the format YYYY-MM-DD.
    */
   date: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/package.json

@@ -1,16 +1,33 @@
 {
   "name": "@algolia/client-analytics",
-  "version": "5.0.0-alpha.9",
+  "version": "5.0.0-alpha.90",
   "description": "JavaScript client for client-analytics",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
-  "main": "index.js",
-  "jsdelivr": "dist/client-analytics.umd.js",
-  "unpkg": "dist/client-analytics.umd.js",
-  "module": "dist/client-analytics.esm.node.js",
-  "browser": "dist/client-analytics.umd.js",
-  "types": "index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/client-analytics.esm.node.js",
+        "module": "./dist/client-analytics.esm.node.js",
+        "require": "./dist/client-analytics.cjs",
+        "default": "./dist/client-analytics.cjs"
+      },
+      "default": {
+        "umd": "./dist/client-analytics.umd.js",
+        "module": "./dist/client-analytics.esm.browser.js",
+        "import": "./dist/client-analytics.esm.browser.js",
+        "default": "./dist/client-analytics.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/client-analytics.umd.js",
+  "unpkg": "./dist/client-analytics.umd.js",
+  "browser": "./dist/client-analytics.umd.js",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "model",
@@ -22,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.9",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.9",
-    "@algolia/requester-node-http": "5.0.0-alpha.9"
+    "@algolia/client-common": "5.0.0-alpha.91",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.91",
+    "@algolia/requester-node-http": "5.0.0-alpha.91"
   },
   "devDependencies": {
-    "@types/node": "16.11.47",
-    "rollup": "2.77.2",
-    "typescript": "4.7.4"
+    "@types/node": "20.8.10",
+    "rollup": "4.3.0",
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": ">= 14.0.0"