@algolia/client-abtesting 5.0.0-alpha.73 → 5.0.0-alpha.76

package/model/variant.ts

@@ -2,72 +2,72 @@
 
 export type Variant = {
   /**
-   * Average click position for the variant.
+   * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
    */
   averageClickPosition: number;
 
   /**
-   * Distinct click count for the variant.
+   * Number of click events for this variant.
    */
   clickCount: number;
 
   /**
-   * Click through rate for the variant.
+   * Variant\'s [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
    */
   clickThroughRate: number;
 
   /**
-   * Distinct conversion count for the variant.
+   * Number of click events for this variant.
    */
   conversionCount: number;
 
   /**
-   * Conversion rate for the variant.
+   * Variant\'s [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
    */
   conversionRate: number;
 
   /**
-   * The A/B test description.
+   * A/B test description.
    */
   description: string;
 
   /**
-   * The index performing the A/B test.
+   * A/B test index.
    */
   index: string;
 
   /**
-   * The number of occurrences.
+   * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
    */
   noResultCount: number;
 
   /**
-   * Count of the tracked searches attributed to outlier traffic that were removed from the A/B test.
+   * Number of tracked searches attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
    */
   outlierTrackedSearchesCount: number;
 
   /**
-   * Count of users attributed to outlier traffic that were removed from the A/B test.
+   * Number of users attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test.
    */
   outlierUsersCount: number;
 
   /**
-   * The number of search during the A/B test.
+   * Number of searches carried out during the A/B test.
    */
   searchCount: 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 traffic percentage for the A/B test.
+   * A/B test traffic percentage.
    */
   trafficPercentage: number;
 
   /**
-   * The number of user during the A/B test.
+   * Number of users during the A/B test.
    */
   userCount: number;
 };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@algolia/client-abtesting",
-  "version": "5.0.0-alpha.73",
+  "version": "5.0.0-alpha.76",
   "description": "JavaScript client for client-abtesting",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
+  "type": "module",
   "exports": {
     ".": {
       "node": {
@@ -38,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.73",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.73",
-    "@algolia/requester-node-http": "5.0.0-alpha.73"
+    "@algolia/client-common": "5.0.0-alpha.76",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.76",
+    "@algolia/requester-node-http": "5.0.0-alpha.76"
   },
   "devDependencies": {
-    "@types/node": "18.16.18",
-    "rollup": "2.79.1",
-    "typescript": "5.0.4"
+    "@types/node": "18.17.0",
+    "rollup": "3.26.3",
+    "typescript": "5.1.6"
   },
   "engines": {
     "node": ">= 14.0.0"