feat(clients): add new abtesting-v3 package to clients + stabilize alpha js package (#5157)

leonardogavaudan · shortcuts · web-flow · commit 66bc4eee9e22 · 2025-07-29T12:33:07.000Z
Co-authored-by: shortcuts &lt;vannicattec@gmail.com&gt;
diff --git a/clients/algoliasearch-client-dart/packages/client_abtesting_v3/build.yaml b/clients/algoliasearch-client-dart/packages/client_abtesting_v3/build.yaml
@@ -0,0 +1,14 @@
+targets:
+  $default:
+    builders:
+      json_serializable:
+        options:
+          any_map: false
+          checked: true
+          create_factory: true
+          create_to_json: true
+          disallow_unrecognized_keys: false
+          explicit_to_json: true
+          field_rename: none
+          ignore_unannotated: false
+          include_if_null: false
diff --git a/clients/algoliasearch-client-dart/packages/client_abtesting_v3/example/example.dart b/clients/algoliasearch-client-dart/packages/client_abtesting_v3/example/example.dart
@@ -0,0 +1,17 @@
+import 'package:algolia_client_abtesting_v3/algolia_client_abtesting_v3.dart';
+
+void main() async {
+  // Creating an instance of the Abtesting V3 client with the provided App ID and API key.
+  final abtesting = AbtestingV3Client(
+    appId: 'latency',
+    apiKey: '6be0576ff61c053d5f9a3225e2a90f76',
+    region: 'us',
+  );
+
+  await abtesting.getABTest(
+    id: 123,
+  );
+
+  // Close the client and dispose of all underlying resources.
+  abtesting.dispose();
+}
diff --git a/clients/algoliasearch-client-dart/packages/client_abtesting_v3/lib/src/extension.dart b/clients/algoliasearch-client-dart/packages/client_abtesting_v3/lib/src/extension.dart
@@ -0,0 +1 @@
+
diff --git a/clients/algoliasearch-client-dart/packages/client_abtesting_v3/test/version_test.dart b/clients/algoliasearch-client-dart/packages/client_abtesting_v3/test/version_test.dart
@@ -0,0 +1,18 @@
+import 'dart:io';
+
+import 'package:algolia_client_abtesting_v3/src/version.dart';
+import 'package:test/test.dart';
+
+void main() {
+  if (Directory.current.path.endsWith('/test')) {
+    Directory.current = Directory.current.parent;
+  }
+  test('package version matches pubspec', () {
+    final pubspecPath = '${Directory.current.path}/pubspec.yaml';
+    final pubspec = File(pubspecPath).readAsStringSync();
+    final regex = RegExp('version:s*(.*)');
+    final match = regex.firstMatch(pubspec);
+    expect(match, isNotNull);
+    expect(packageVersion, match?.group(1)?.trim());
+  });
+}
diff --git a/clients/algoliasearch-client-javascript/package.json b/clients/algoliasearch-client-javascript/package.json
@@ -7,7 +7,7 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "lerna run build --skip-nx-cache --scope '@algolia/requester-testing' --scope '@algolia/logger-console' --scope 'algoliasearch' --scope '@algolia/client-composition' --scope '@algolia/composition' --scope '@algolia/advanced-personalization' --scope '@algolia/abtesting' --include-dependencies ",
+    "build": "lerna run build --skip-nx-cache --scope '@algolia/requester-testing' --scope '@algolia/logger-console' --scope 'algoliasearch' --scope '@algolia/client-composition' --scope '@algolia/composition' --scope '@algolia/advanced-personalization' --include-dependencies ",
     "clean": "lerna run clean",
     "release:publish": "tsc --project scripts/tsconfig.json && node scripts/dist/publish.js",
     "test": "lerna run test $*",
diff --git a/clients/algoliasearch-client-javascript/packages/abtesting/package.json b/clients/algoliasearch-client-javascript/packages/abtesting/package.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.0.1-alpha.6",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -51,8 +51,8 @@
   "dependencies": {
     "@algolia/client-common": "5.34.1",
     "@algolia/requester-browser-xhr": "5.34.1",
-    "@algolia/requester-fetch": "5.34.1",
-    "@algolia/requester-node-http": "5.34.1"
+    "@algolia/requester-node-http": "5.34.1",
+    "@algolia/requester-fetch": "5.34.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",
diff --git a/clients/algoliasearch-client-javascript/yarn.lock b/clients/algoliasearch-client-javascript/yarn.lock
@@ -5,7 +5,7 @@ __metadata:
   version: 8
   cacheKey: 10
 
-"@algolia/abtesting@workspace:packages/abtesting":
+"@algolia/abtesting@npm:1.0.0, @algolia/abtesting@workspace:packages/abtesting":
   version: 0.0.0-use.local
   resolution: "@algolia/abtesting@workspace:packages/abtesting"
   dependencies:
@@ -2523,6 +2523,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "algoliasearch@workspace:packages/algoliasearch"
   dependencies:
+    "@algolia/abtesting": "npm:1.0.0"
     "@algolia/client-abtesting": "npm:5.34.1"
     "@algolia/client-analytics": "npm:5.34.1"
     "@algolia/client-common": "npm:5.34.1"
diff --git a/config/clients.config.json b/config/clients.config.json
@@ -3,6 +3,7 @@
   "csharp": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -34,6 +35,10 @@
         "name": "algoliasearch",
         "output": "clients/algoliasearch-client-dart/packages/algoliasearch"
       },
+      {
+        "name": "abtesting-v3",
+        "output": "clients/algoliasearch-client-dart/packages/client_abtesting_v3"
+      },
       {
         "name": "composition",
         "output": "clients/algoliasearch-client-dart/packages/client_composition"
@@ -69,6 +74,7 @@
   "go": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -97,6 +103,7 @@
   "java": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -140,9 +147,7 @@
       },
       {
         "name": "abtesting-v3",
-        "output": "clients/algoliasearch-client-javascript/packages/abtesting",
-        "isStandaloneClient": true,
-        "clientName": "abtesting"
+        "output": "clients/algoliasearch-client-javascript/packages/abtesting"
       },
       {
         "name": "analytics",
@@ -211,6 +216,7 @@
   "kotlin": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -239,6 +245,7 @@
   "php": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -267,6 +274,7 @@
   "python": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -302,6 +310,7 @@
   "ruby": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -330,6 +339,7 @@
   "scala": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
@@ -358,6 +368,7 @@
   "swift": {
     "clients": [
       "abtesting",
+      "abtesting-v3",
       "analytics",
       "composition",
       "ingestion",
diff --git a/config/clients.schema.json b/config/clients.schema.json
@@ -12,6 +12,7 @@
               "type": "string",
               "enum": [
                 "abtesting",
+                "abtesting-v3",
                 "analytics",
                 "composition",
                 "ingestion",
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaSwiftGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaSwiftGenerator.java
@@ -30,7 +30,14 @@
 public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
 
   private static final List<String> reservedModelNames = List.of(
+    "abtest",
+    "abtestconfiguration",
+    "abtestresponse",
+    "abtestsvariant",
+    "abtestsvariantsearchparams",
     "action",
+    "addabtestsrequest",
+    "addabtestsvariant",
     "advancedsyntaxfeatures",
     "alternativesasexact",
     "anchoring",
@@ -58,11 +65,18 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
     "consequenceparams",
     "consequencequery",
     "consequencequeryobject",
+    "customsearchparams",
     "deletedatresponse",
+    "direction",
     "distinct",
     "edit",
     "edittype",
+    "effectmetric",
+    "emptysearchfilter",
     "errorbase",
+    "estimateabtestrequest",
+    "estimateabtestresponse",
+    "estimateconfiguration",
     "event",
     "eventstatus",
     "eventtype",
@@ -72,20 +86,24 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
     "facetordering",
     "facets",
     "facetstats",
+    "filtereffects",
     "forbidden",
     "highlightresult",
     "highlightresultoption",
     "ignoreplurals",
     "indexsettingsassearchparams",
     "insideboundingbox",
     "languages",
+    "listabtestsresponse",
     "loglevel",
     "matchedgeolocation",
     "matchlevel",
+    "minimumdetectableeffect",
     "mode",
     "numericfilters",
     "optionalfilters",
     "optionalwords",
+    "outliersfilter",
     "params",
     "personalization",
     "promote",
@@ -104,6 +122,8 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
     "removewordsifnoresults",
     "renderingcontent",
     "rerankingapplyfilter",
+    "scheduleabtestresponse",
+    "scheduleabtestsrequest",
     "searchpagination",
     "searchparams",
     "searchparamsobject",
@@ -122,6 +142,7 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
     "typotolerance",
     "typotoleranceenum",
     "value",
+    "variant",
     "watchresponse",
     "widgets"
   );
diff --git a/generators/src/main/java/com/algolia/codegen/cts/manager/DartCTSManager.java b/generators/src/main/java/com/algolia/codegen/cts/manager/DartCTSManager.java
@@ -40,8 +40,15 @@ public void addDataToBundle(Map<String, Object> bundle) throws GeneratorExceptio
   @Override
   public void addSnippetsSupportingFiles(List<SupportingFile> supportingFiles, String output) {
     supportingFiles.add(new SupportingFile("snippets/.gitignore.mustache", output + "/dart/.gitignore"));
-    supportingFiles.add(new SupportingFile("snippets/analysis_options.mustache", output + "/dart/analysis_options.yaml"));
-    supportingFiles.add(new SupportingFile("snippets/pubspec.mustache", output + "/dart/pubspec.yaml"));
-    supportingFiles.add(new SupportingFile("snippets/pubspec_overrides.mustache", output + "/dart/pubspec_overrides.yaml"));
+    supportingFiles.add(new SupportingFile("analysis_options.tests.mustache", output + "/dart/analysis_options.yaml"));
+    supportingFiles.add(new SupportingFile("pubspec.tests.mustache", output + "/dart/pubspec.yaml"));
+    supportingFiles.add(new SupportingFile("pubspec_overrides.tests.mustache", output + "/dart/pubspec_overrides.yaml"));
+  }
+
+  @Override
+  public void addTestsSupportingFiles(List<SupportingFile> supportingFiles) {
+    supportingFiles.add(new SupportingFile("analysis_options.tests.mustache", "tests/output/dart/analysis_options.yaml"));
+    supportingFiles.add(new SupportingFile("pubspec.tests.mustache", "tests/output/dart/pubspec.yaml"));
+    supportingFiles.add(new SupportingFile("pubspec_overrides.tests.mustache", "tests/output/dart/pubspec_overrides.yaml"));
   }
 }
diff --git a/generators/src/main/java/com/algolia/codegen/cts/tests/SnippetsGenerator.java b/generators/src/main/java/com/algolia/codegen/cts/tests/SnippetsGenerator.java
@@ -93,6 +93,8 @@ private Map<String, Snippet[]> loadSnippets(Map<String, CodegenOperation> operat
   public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation> operations, Map<String, Object> bundle) throws Exception {
     Map<String, Snippet[]> snippets = loadSnippets(operations);
 
+    bundle.put("isSnippet", true);
+
     if (this.client.equals("search")) {
       bundle.put("isSearchClient", true);
     }
diff --git a/playground/javascript/node/abtestingV3.ts b/playground/javascript/node/abtestingV3.ts
@@ -1,11 +1,11 @@
-import { abtestingClient } from '@algolia/abtesting';
+import { abtestingV3Client } from '@algolia/abtesting';
 import { ApiError } from '@algolia/client-common';
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey = process.env.ALGOLIA_ANALYTICS_KEY || '**** ANALYTICS_API_KEY *****';
 
 // Init client with appId and apiKey
-const client = abtestingClient(appId, apiKey, 'de');
+const client = abtestingV3Client(appId, apiKey, 'de');
 
 async function testABTesting() {
   try {
diff --git a/specs/abtesting-v3/common/schemas/Timeseries.yml b/specs/abtesting-v3/common/schemas/Timeseries.yml
@@ -37,7 +37,6 @@ metricDate:
     date:
       type: string
       description: Date where the metric was updated, in RFC 3339 format.
-      format: date
       example: 2025-06-15
     metrics:
       $ref: 'Variant.yml#/metrics'
diff --git a/templates/dart/analysis_options.tests.mustache b/templates/dart/analysis_options.tests.mustache
diff --git a/templates/dart/pubspec.tests.mustache b/templates/dart/pubspec.tests.mustache
@@ -1,17 +1,23 @@
-name: algolia_snippets
+name: algolia_{{#isSnippet}}snippets{{/isSnippet}}{{^isSnippet}}test{{/isSnippet}}
 version: 1.0.0
 
 environment:
   sdk: ^3.0.0
 
 dependencies:
-  algoliasearch: ^1.0.0
-  algolia_client_search: ^1.0.0
+  algolia_client_abtesting_v3: ^1.0.0
+  algolia_client_composition: ^1.0.0
   algolia_client_insights: ^1.0.0
   algolia_client_recommend: ^1.0.0
-  algolia_client_composition: ^1.0.0
+  algolia_client_search: ^1.0.0
+  algoliasearch: ^1.0.0
+  collection: ^1.17.2
   dotenv: ^4.1.0
   http: ^1.2.2
+  test: ^1.25.8
+  test_api: ^0.7.3
+
+  algolia_client_core: any
 
 dev_dependencies:
   lints: ^6.0.0
diff --git a/templates/dart/pubspec_overrides.tests.mustache b/templates/dart/pubspec_overrides.tests.mustache
@@ -10,4 +10,6 @@ dependency_overrides:
   algolia_client_recommend:
     path: ../../../clients/algoliasearch-client-dart/packages/client_recommend
   algolia_client_composition:
-    path: ../../../clients/algoliasearch-client-dart/packages/client_composition
+    path: ../../../clients/algoliasearch-client-dart/packages/client_composition
+  algolia_client_abtesting_v3:
+    path: ../../../clients/algoliasearch-client-dart/packages/client_abtesting_v3
diff --git a/templates/javascript/clients/algoliasearch/builds/models.mustache b/templates/javascript/clients/algoliasearch/builds/models.mustache
diff --git a/tests/CTS/requests/abtesting-v3/listABTests.json b/tests/CTS/requests/abtesting-v3/listABTests.json
diff --git a/tests/output/dart/pubspec.yaml b/tests/output/dart/pubspec.yaml
diff --git a/tests/output/dart/pubspec_overrides.yaml b/tests/output/dart/pubspec_overrides.yaml
diff --git a/website/docs/testing/common-test-suite.md b/website/docs/testing/common-test-suite.md
