feat(specs): rename composition to composition-full (private) and add composition (public) (#4357)

Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>

Author: 3 people

clients/algoliasearch-client-dart/packages/client_composition/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

clients/algoliasearch-client-javascript/yarn.lock

@@ -139,6 +139,23 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@algolia/composition@workspace:packages/composition":
+  version: 0.0.0-use.local
+  resolution: "@algolia/composition@workspace:packages/composition"
+  dependencies:
+    "@algolia/client-common": "npm:5.19.0"
+    "@algolia/requester-browser-xhr": "npm:5.19.0"
+    "@algolia/requester-fetch": "npm:5.19.0"
+    "@algolia/requester-node-http": "npm:5.19.0"
+    "@arethetypeswrong/cli": "npm:0.17.3"
+    "@types/node": "npm:22.10.7"
+    publint: "npm:0.3.2"
+    rollup: "npm:4.30.1"
+    tsup: "npm:8.3.5"
+    typescript: "npm:5.7.3"
+  languageName: unknown
+  linkType: soft
+
 "@algolia/ingestion@npm:1.19.0, @algolia/ingestion@workspace:packages/ingestion":
   version: 0.0.0-use.local
   resolution: "@algolia/ingestion@workspace:packages/ingestion"

config/clients.config.json

@@ -3,6 +3,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -32,6 +33,10 @@
         "name": "algoliasearch",
         "output": "clients/algoliasearch-client-dart/packages/algoliasearch"
       },
+      {
+        "name": "composition",
+        "output": "clients/algoliasearch-client-dart/packages/client_composition"
+      },
       {
         "name": "insights",
         "output": "clients/algoliasearch-client-dart/packages/client_insights"
@@ -64,6 +69,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -91,6 +97,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -134,6 +141,10 @@
         "name": "analytics",
         "output": "clients/algoliasearch-client-javascript/packages/client-analytics"
       },
+      {
+        "name": "composition",
+        "output": "clients/algoliasearch-client-javascript/packages/composition"
+      },
       {
         "name": "ingestion",
         "output": "clients/algoliasearch-client-javascript/packages/ingestion"
@@ -163,7 +174,7 @@
         "output": "clients/algoliasearch-client-javascript/packages/client-search"
       },
       {
-        "name": "composition",
+        "name": "composition-full",
         "output": "clients/algoliasearch-client-javascript/packages/client-composition"
       }
     ],
@@ -185,6 +196,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -212,6 +224,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -239,6 +252,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -273,6 +287,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",
@@ -300,6 +315,7 @@
     "clients": [
       "abtesting",
       "analytics",
+      "composition",
       "ingestion",
       "insights",
       "monitoring",

generators/src/main/java/com/algolia/codegen/AlgoliaCSharpGenerator.java

@@ -44,7 +44,7 @@ public void processOpts() {
     additionalProperties.put("sourceFolder", "");
     additionalProperties.put("netCoreProjectFile", true);
     additionalProperties.put("targetFramework", "netstandard2.1;netstandard2.0");
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     additionalProperties.put("apiPackageName", getClientName(client));
     additionalProperties.put("equatable", false);
     additionalProperties.put("disallowAdditionalPropertiesIfNotPresent", true);

generators/src/main/java/com/algolia/codegen/AlgoliaDartGenerator.java

@@ -36,6 +36,7 @@ public void processOpts() {
     isAlgoliasearchClient = client.equals("algoliasearch");
     String version = Helpers.getClientConfigField("dart", "packageVersion");
     additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
 
     // pubspec.yaml
     setPubAuthor("Algolia");

generators/src/main/java/com/algolia/codegen/AlgoliaGoGenerator.java

@@ -30,7 +30,7 @@ public void processOpts() {
 
     additionalProperties.put("packageName", client.equals("query-suggestions") ? "suggestions" : client);
     additionalProperties.put("enumClassPrefix", true);
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
 
     String outputFolder = "algolia" + File.separator + client;
     setOutputDir(getOutputDir() + File.separator + outputFolder);

generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java

@@ -49,7 +49,7 @@ public void processOpts() {
     final String invokerFolder = (sourceFolder + '/' + invokerPackage).replace(".", "/");
     supportingFiles.add(new SupportingFile("build_config.mustache", invokerFolder, "BuildConfig.java"));
     supportingFiles.add(new SupportingFile("gradle.properties.mustache", "", "gradle.properties"));
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
 
     Helpers.addCommonSupportingFiles(supportingFiles, "");
 

generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java

@@ -18,7 +18,6 @@ public class AlgoliaJavascriptGenerator extends TypeScriptNodeClientCodegen {
 
   private String CLIENT;
   private boolean isAlgoliasearchClient;
-  private boolean isAlgoliaCompositionClient;
 
   @Override
   public String getName() {
@@ -31,7 +30,6 @@ public void processOpts() {
 
     CLIENT = Helpers.camelize((String) additionalProperties.get("client"));
     isAlgoliasearchClient = CLIENT.equals("algoliasearch");
-    isAlgoliaCompositionClient = CLIENT.equals("composition");
 
     // generator specific options
     setSupportsES6(true);
@@ -154,9 +152,10 @@ private void setDefaultGeneratorOptions() {
     String packageName = getPackageName((String) additionalProperties.get("client"));
 
     additionalProperties.put("apiName", CLIENT);
-    additionalProperties.put("clientName", clientName);
+    // Just so the full client doesn't have the weird Full naming
+    additionalProperties.put("clientName", CLIENT.contains("composition") ? "composition" + Helpers.API_SUFFIX : clientName);
     additionalProperties.put("algoliaAgent", Helpers.capitalize(CLIENT));
-    additionalProperties.put("is" + Helpers.capitalize(CLIENT) + "Client", true);
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient);
     additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
     additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName));
@@ -186,7 +185,7 @@ private void setDefaultGeneratorOptions() {
         dependency.put("withInitMethod", !name.contains("search"));
         dependency.put(
           "dependencyHasRegionalHosts",
-          !name.contains("search") && !name.contains("recommend") && !name.contains("monitoring")
+          !name.contains("search") && !name.contains("recommend") && !name.contains("monitoring") && !name.startsWith("composition")
         );
 
         dependencies.add(dependency);

generators/src/main/java/com/algolia/codegen/AlgoliaKotlinGenerator.java

@@ -48,7 +48,7 @@ public void processOpts() {
     supportingFiles.removeIf(file -> file.getTemplateFile().contains("auth"));
 
     // Search config
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
 
     // We don't extend hashmap
     propertyAdditionalKeywords.clear();

generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java

@@ -56,7 +56,7 @@ public void processOpts() {
 
     Helpers.addCommonSupportingFiles(supportingFiles, "");
 
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     additionalProperties.put("configClassname", getClientName(client) + "Config");
 
     try {

generators/src/main/java/com/algolia/codegen/AlgoliaPythonGenerator.java

@@ -26,7 +26,7 @@ public String getName() {
   public void processOpts() {
     CLIENT = (String) additionalProperties.get("client");
 
-    additionalProperties.put("isSearchClient", CLIENT.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     additionalProperties.put("packageVersion", Helpers.getClientConfigField("python", "packageVersion"));
     additionalProperties.put(CodegenConstants.EXCLUDE_TESTS, true);
 

generators/src/main/java/com/algolia/codegen/AlgoliaRubyGenerator.java

@@ -25,7 +25,7 @@ public String getName() {
   public void processOpts() {
     CLIENT = (String) additionalProperties.get("client");
 
-    additionalProperties.put("isSearchClient", CLIENT.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     additionalProperties.put("packageVersion", Helpers.getClientConfigField("ruby", "packageVersion"));
     setGemName("algolia");
     additionalProperties.put("modelModule", Helpers.capitalize(Helpers.camelize(CLIENT)));

generators/src/main/java/com/algolia/codegen/AlgoliaScalaGenerator.java

@@ -77,7 +77,7 @@ public void processOpts() {
 
     Helpers.addCommonSupportingFiles(supportingFiles, "");
 
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     typeMapping.put("AnyType", "Any");
 
     nameMapping.putAll(NAME_MAPPING);

generators/src/main/java/com/algolia/codegen/AlgoliaSwiftGenerator.java

@@ -179,7 +179,7 @@ public void processOpts() {
       System.exit(1);
     }
 
-    additionalProperties.put("isSearchClient", CLIENT.equals("search"));
+    additionalProperties.put("is" + Helpers.capitalize(Helpers.camelize((String) additionalProperties.get("client"))) + "Client", true);
     additionalProperties.put(CodegenConstants.EXCLUDE_TESTS, true);
 
     additionalProperties.put(RESPONSE_AS, new String[] { RESPONSE_LIBRARY_ASYNC_AWAIT });
@@ -301,14 +301,14 @@ public void processOpenAPI(OpenAPI openAPI) {
   public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> models) {
     OperationsMap operations = super.postProcessOperationsWithModels(objs, models);
     Helpers.removeHelpers(operations);
-    GenericPropagator.propagateGenericsToOperations(operations, models);
+    GenericPropagator.propagateGenericsToOperations("swift", CLIENT, operations, models);
     return operations;
   }
 
   @Override
   public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs) {
     Map<String, ModelsMap> models = super.postProcessAllModels(objs);
-    GenericPropagator.propagateGenericsToModels(models);
+    GenericPropagator.propagateGenericsToModels("swift", CLIENT, models);
     OneOf.updateModelsOneOf(models, modelPackage);
     OneOf.addOneOfMetadata(models);
     return models;

generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java

@@ -143,8 +143,8 @@ public Map<String, Object> postProcessSupportingFileData(Map<String, Object> obj
 
       // We can put whatever we want in the bundle, and it will be accessible in the template
       bundle.put("mode", mode);
-      bundle.put("is" + Helpers.capitalize(client) + "Client", true);
-      bundle.put("isStandaloneClient", client.contains("search") || client.equals("composition"));
+      bundle.put("is" + Helpers.capitalize(Helpers.camelize(client)) + "Client", true);
+      bundle.put("isStandaloneClient", client.contains("search") || client.contains("composition"));
       bundle.put("isSearchClient", client.contains("search")); // just so algoliasearch is treated as a search client too
       bundle.put("client", Helpers.createClientName(importClientName, language) + "Client");
       bundle.put("clientPrefix", Helpers.createClientName(importClientName, language));

generators/src/main/java/com/algolia/codegen/cts/manager/JavascriptCTSManager.java

@@ -46,13 +46,23 @@ public void addDataToBundle(Map<String, Object> bundle) throws GeneratorExceptio
     bundle.put("utilsPackageVersion", Helpers.getPackageJsonVersion("client-common"));
     bundle.put("algoliasearchVersion", Helpers.getPackageJsonVersion("algoliasearch"));
     bundle.put("initMethod", "init" + Helpers.capitalize(Helpers.camelize(client)));
-    bundle.put(
-      "clientName",
-      client.equals("algoliasearch") ? "liteClient" : client.equals("composition") ? "compositionClient" : "algoliasearch"
-    );
-    bundle.put(
-      "importPackage",
-      client.equals("algoliasearch") ? "algoliasearch/lite" : client.equals("composition") ? "@algolia/client-composition" : "algoliasearch"
-    );
+
+    switch (client) {
+      case "composition":
+        bundle.put("clientName", "compositionClient");
+        bundle.put("importPackage", "@algolia/composition");
+        break;
+      case "composition-full":
+        bundle.put("clientName", "compositionClient");
+        bundle.put("importPackage", "@algolia/client-composition");
+        break;
+      case "algoliasearch":
+        bundle.put("clientName", "liteClient");
+        bundle.put("importPackage", "algoliasearch/lite");
+        break;
+      default:
+        bundle.put("clientName", "algoliasearch");
+        bundle.put("importPackage", "algoliasearch");
+    }
   }
 }

generators/src/main/java/com/algolia/codegen/cts/tests/TestsClient.java

@@ -107,6 +107,11 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
             } else if (step.type.equals("method")) {
               ope = operations.get(step.method);
               if (ope == null) {
+                // some clients don't have custom methods
+                if (step.method.startsWith("custom") && client.equals("composition")) {
+                  continue skipTest;
+                }
+
                 throw new CTSException("Cannot find operation for method: " + step.method, test.testName);
               }
               stepOut.put("stepTemplate", "tests/client/method.mustache");

generators/src/main/java/com/algolia/codegen/cts/tests/TestsGenerator.java

@@ -51,10 +51,15 @@ protected <T> Map<String, T> loadCTS(String path, String clientName, Class<T> js
 
     Map<String, T> cts = new TreeMap<>();
 
-    for (File f : allTests) {
+    skipFile: for (File f : allTests) {
       String json = new String(Files.readAllBytes(Paths.get(f.getAbsolutePath())));
       json = injectVariables(json);
-      cts.put(f.getName().replace(".json", ""), Json.mapper().readValue(json, jsonType));
+      String key = f.getName().replace(".json", "");
+      // some clients don't have custom methods
+      if (clientName.equals("composition") && (key.equals("commonApi") || key.equals("setClientApiKey"))) {
+        continue skipFile;
+      }
+      cts.put(key, Json.mapper().readValue(json, jsonType));
     }
     return cts;
   }

generators/src/main/java/com/algolia/codegen/cts/tests/TestsRequest.java

@@ -81,10 +81,10 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
     List<Object> blocksE2E = new ArrayList<>();
     ParametersWithDataType paramsType = new ParametersWithDataType(models, language, client, false);
 
-    bundle.put("e2eAppID", client.equals("composition") ? "METIS_APPLICATION_ID" : "ALGOLIA_APPLICATION_ID");
+    bundle.put("e2eAppID", client.startsWith("composition") ? "METIS_APPLICATION_ID" : "ALGOLIA_APPLICATION_ID");
     bundle.put(
       "e2eApiKey",
-      client.equals("composition") ? "METIS_API_KEY" : (client.equals("monitoring") ? "MONITORING_API_KEY" : "ALGOLIA_ADMIN_KEY")
+      client.startsWith("composition") ? "METIS_API_KEY" : (client.equals("monitoring") ? "MONITORING_API_KEY" : "ALGOLIA_ADMIN_KEY")
     );
     bundle.put("useEchoRequester", true);