@algolia/abtesting 0.0.1-alpha.4 → 0.0.1-alpha.5

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.
package/dist/worker.d.ts CHANGED
@@ -66,9 +66,13 @@ type Status = 'active' | 'stopped' | 'expired' | 'failed';
66
66
  */
67
67
  type MetricMetadata = {
68
68
  /**
69
- * Only present in case the metric is \'revenue\'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
69
+ * Only present in case the metric is \'revenue\'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
70
70
  */
71
71
  winsorizedValue?: number | undefined;
72
+ /**
73
+ * Mean value for this metric.
74
+ */
75
+ mean?: number | undefined;
72
76
  };
73
77
 
74
78
  type MetricResult = {
@@ -79,11 +83,11 @@ type MetricResult = {
79
83
  updatedAt: string;
80
84
  value: number;
81
85
  /**
82
- * The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
86
+ * The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
83
87
  */
84
88
  valueCIHigh?: number | undefined;
85
89
  /**
86
- * The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
90
+ * The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
87
91
  */
88
92
  valueCILow?: number | undefined;
89
93
  /**
@@ -96,7 +100,7 @@ type MetricResult = {
96
100
  dimension?: string | undefined;
97
101
  metadata?: MetricMetadata | undefined;
98
102
  /**
99
- * The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.
103
+ * The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.
100
104
  */
101
105
  criticalValue?: number | undefined;
102
106
  /**
@@ -522,7 +526,7 @@ type StopABTestProps = {
522
526
  id: number;
523
527
  };
524
528
 
525
- declare const apiClientVersion = "0.0.1-alpha.4";
529
+ declare const apiClientVersion = "0.0.1-alpha.5";
526
530
  declare const REGIONS: readonly ["de", "us"];
527
531
  type Region = (typeof REGIONS)[number];
528
532
  type RegionOptions = {
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.0.1-alpha.4",
2
+ "version": "0.0.1-alpha.5",
3
3
  "repository": {
4
4
  "type": "git",
5
5
  "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,10 +49,10 @@
49
49
  "index.d.ts"
50
50
  ],
51
51
  "dependencies": {
52
- "@algolia/client-common": "5.33.0",
53
- "@algolia/requester-browser-xhr": "5.33.0",
54
- "@algolia/requester-fetch": "5.33.0",
55
- "@algolia/requester-node-http": "5.33.0"
52
+ "@algolia/client-common": "5.34.0",
53
+ "@algolia/requester-browser-xhr": "5.34.0",
54
+ "@algolia/requester-fetch": "5.34.0",
55
+ "@algolia/requester-node-http": "5.34.0"
56
56
  },
57
57
  "devDependencies": {
58
58
  "@arethetypeswrong/cli": "0.18.2",