feat(specs): recursive snippets and highlights result (#3497)

algolia · Aug 9, 2024 · 4c05200 · 4c05200
1 parent 4fb106b
commit 4c05200
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 16 deletions.
diff --git a/generators/src/main/java/com/algolia/codegen/utils/OneOf.java b/generators/src/main/java/com/algolia/codegen/utils/OneOf.java
@@ -137,6 +137,7 @@ public static void addOneOfMetadata(Map<String, ModelsMap> models) {
       var model = modelContainer.getModels().get(0).getModel();
       var oneOfs = getCodegenProperties(model);
       if (isMultiArrayOneOfs(oneOfs)) model.vendorExtensions.put("x-is-multi-array", true);
+      if (isMultiMapOneOfs(oneOfs)) model.vendorExtensions.put("x-is-multi-map", true);
       if (hasAtModelOrEnum(oneOfs)) model.vendorExtensions.put("x-has-model", true);
       markOneOfModels(oneOfs);
       sortOneOfs(oneOfs);
@@ -151,6 +152,15 @@ private static List<CodegenProperty> getCodegenProperties(CodegenModel model) {
     return oneOfs;
   }
 
+  /** Get true if a composed type has more than a one array-subtype */
+  private static boolean isMultiMapOneOfs(List<CodegenProperty> oneOfs) {
+    var map = 0;
+    for (var prop : oneOfs) {
+      if (prop.isMap) map++;
+    }
+    return map > 1;
+  }
+
   /** Get true if a composed type has more than a one array-subtype */
   private static boolean isMultiArrayOneOfs(List<CodegenProperty> oneOfs) {
     var arrays = 0;

diff --git a/specs/common/schemas/HighlightResult.yml b/specs/common/schemas/HighlightResult.yml
@@ -46,6 +46,7 @@ highlightResultOptionArray:
 
 highlightResult:
   oneOf:
+    - $ref: '#/highlightResultMap'
     - $ref: '#/highlightResultOption'
     - $ref: '#/highlightResultOptionMap'
     - $ref: '#/highlightResultOptionArray'

diff --git a/specs/common/schemas/SnippetResult.yml b/specs/common/schemas/SnippetResult.yml
@@ -26,6 +26,7 @@ snippetResultOptionArray:
 
 snippetResult:
   oneOf:
+    - $ref: '#/snippetResultMap'
     - $ref: '#/snippetResultOption'
     - $ref: '#/snippetResultOptionMap'
     - $ref: '#/snippetResultOptionArray'

diff --git a/templates/csharp/modelOneOf.mustache b/templates/csharp/modelOneOf.mustache
@@ -65,7 +65,7 @@
         /// the InvalidClassException will be thrown{{/lambda.escape-generic}}
         /// </summary>
         /// <returns>An instance of {{#lambda.escape-generic}}{{dataType}}{{/lambda.escape-generic}}</returns>
-        public {{{dataType}}}{{#vendorExtensions.x-has-child-generic}}<T>{{/vendorExtensions.x-has-child-generic}} As{{#lambda.titlecase}}{{baseType}}{{/lambda.titlecase}}{{#isArray}}{{^complexType}}{{#lambda.titlecase}}{{{items.dataType}}}{{/lambda.titlecase}}{{/complexType}}{{/isArray}}()
+        public {{{dataType}}}{{#vendorExtensions.x-has-child-generic}}<T>{{/vendorExtensions.x-has-child-generic}} As{{#lambda.titlecase}}{{baseType}}{{/lambda.titlecase}}{{#lambda.titlecase}}{{{items.dataType}}}{{/lambda.titlecase}}()
         {
             return ({{{dataType}}}{{#vendorExtensions.x-has-child-generic}}<T>{{/vendorExtensions.x-has-child-generic}})ActualInstance;
         }
@@ -81,7 +81,7 @@
                 /// {{#lambda.escape-generic}}Check if the actual instance is of `{{{dataType}}}` type.{{/lambda.escape-generic}}
                 /// </summary>
                 /// <returns>Whether or not the instance is the type</returns>
-                public bool Is{{#lambda.titlecase}}{{baseType}}{{/lambda.titlecase}}{{#isArray}}{{^complexType}}{{#lambda.titlecase}}{{{items.dataType}}}{{/lambda.titlecase}}{{/complexType}}{{/isArray}}()
+                public bool Is{{#lambda.titlecase}}{{baseType}}{{/lambda.titlecase}}{{#lambda.titlecase}}{{{items.dataType}}}{{/lambda.titlecase}}()
                 {
                     return ActualInstance.GetType() == typeof({{{dataType}}}{{#vendorExtensions.x-has-child-generic}}<T>{{/vendorExtensions.x-has-child-generic}});
                 }
@@ -243,4 +243,4 @@
         writer.WriteRawValue(value.ToJson());
       }
     }
-{{/model}}
+{{/model}}
diff --git a/templates/java/oneof_interface.mustache b/templates/java/oneof_interface.mustache
@@ -33,7 +33,20 @@ public interface {{classname}}{{#vendorExtensions.x-has-child-generic}}<T>{{/ven
     {{/composedSchemas.oneOf}}
     {{/vendorExtensions.x-is-multi-array}}
 
-    {{^vendorExtensions.x-is-multi-array}}
+    {{#vendorExtensions.x-is-multi-map}}
+    {{#composedSchemas.oneOf}}
+    {{^isModel}}
+    {{^isEnumRef}}
+    // {{classname}} as {{{datatypeWithEnum}}} wrapper.
+    static {{classname}} of{{#isMap}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isMap}}({{{datatypeWithEnum}}} value) {
+        return new {{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Wrapper(value);
+    }
+    {{/isEnumRef}}
+    {{/isModel}}
+    {{/composedSchemas.oneOf}}
+    {{/vendorExtensions.x-is-multi-map}}
+
+    {{^vendorExtensions.x-is-multi-array}}{{^vendorExtensions.x-is-multi-map}}
     {{#composedSchemas.oneOf}}
     {{^isModel}}
     {{^isEnumRef}}
@@ -44,7 +57,7 @@ public interface {{classname}}{{#vendorExtensions.x-has-child-generic}}<T>{{/ven
     {{/isEnumRef}}
     {{/isModel}}
     {{/composedSchemas.oneOf}}
-    {{/vendorExtensions.x-is-multi-array}}
+    {{/vendorExtensions.x-is-multi-map}}{{/vendorExtensions.x-is-multi-array}}
 
     {{#composedSchemas.oneOf}}
     {{^isModel}}
@@ -125,4 +138,4 @@ public interface {{classname}}{{#vendorExtensions.x-has-child-generic}}<T>{{/ven
         {{/isNullable}}
         }
     }
-}
+}
diff --git a/templates/kotlin/oneof_interface.mustache b/templates/kotlin/oneof_interface.mustache
@@ -48,7 +48,19 @@ public sealed interface {{classname}} {
     {{/composedSchemas.oneOf}}
     {{/vendorExtensions.x-is-multi-array}}
 
-    {{^vendorExtensions.x-is-multi-array}}
+    {{#vendorExtensions.x-is-multi-map}}
+    {{#composedSchemas.oneOf}}
+    {{^isModel}}
+    {{^isEnumRef}}
+    public fun of{{#isMap}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isMap}}(value: {{{datatypeWithEnum}}}): {{classname}} {
+        return {{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Value(value);
+    }
+    {{/isEnumRef}}
+    {{/isModel}}
+    {{/composedSchemas.oneOf}}
+    {{/vendorExtensions.x-is-multi-map}}
+
+    {{^vendorExtensions.x-is-multi-array}}{{^vendorExtensions.x-is-multi-map}}
     {{#composedSchemas.oneOf}}
     {{^isModel}}
     {{^isEnumRef}}
@@ -58,7 +70,7 @@ public sealed interface {{classname}} {
     {{/isEnumRef}}
     {{/isModel}}
     {{/composedSchemas.oneOf}}
-    {{/vendorExtensions.x-is-multi-array}}
+    {{/vendorExtensions.x-is-multi-map}}{{/vendorExtensions.x-is-multi-array}}
     }
 }
 

diff --git a/templates/python/model_oneof.mustache b/templates/python/model_oneof.mustache
@@ -21,7 +21,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         """
         Unwraps the `actual_instance` when calling the `to_json` method.
         """
-        return self.actual_instance
+        return self.actual_instance if hasattr(self, "actual_instance") else self
 
     @classmethod
     def from_dict(cls, obj: dict) -> Self:
@@ -76,8 +76,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         if self.actual_instance is None:
             return "null"
 
-        to_json = getattr(self.actual_instance, "to_json", None)
-        if callable(to_json):
+        if hasattr(self.actual_instance, "to_json"):
             return self.actual_instance.to_json()
         else:
             return dumps(self.actual_instance)
@@ -87,8 +86,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         if self.actual_instance is None:
             return None
 
-        to_dict = getattr(self.actual_instance, "to_dict", None)
-        if callable(to_dict):
+        if hasattr(self.actual_instance, "to_dict"):
             return self.actual_instance.to_dict()
         else:
-            return self.actual_instance
+            return self.actual_instance
diff --git a/templates/scala/oneof_trait.mustache b/templates/scala/oneof_trait.mustache
@@ -23,6 +23,18 @@ object {{classname}}Evidence {
 }
 {{/vendorExtensions.x-is-multi-array}}
 
+{{#vendorExtensions.x-is-multi-map}}
+trait {{classname}}Evidence 
+
+object {{classname}}Evidence {
+{{#composedSchemas.oneOf}}
+{{#isMap}}
+    implicit object {{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Evidence extends {{classname}}Evidence
+{{/isMap}}
+{{/composedSchemas.oneOf}}
+}
+{{/vendorExtensions.x-is-multi-map}}
+
 object {{classname}} {
 
   {{#composedSchemas.oneOf}}
@@ -44,8 +56,20 @@ object {{classname}} {
   {{/isModel}}
   {{/composedSchemas.oneOf}}
   {{/vendorExtensions.x-is-multi-array}}
+
+  {{#vendorExtensions.x-is-multi-map}}
+  {{#composedSchemas.oneOf}}
+  {{^isModel}}
+  {{^isEnumRef}}
+  def apply(value: {{{datatypeWithEnum}}}){{#isMap}}(implicit ev: {{classname}}Evidence.{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Evidence.type){{/isMap}}: {{classname}} = {
+      {{classname}}.{{#isMap}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isMap}}{{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isMap}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}{{/isMap}}(value)
+  }
+  {{/isEnumRef}}
+  {{/isModel}}
+  {{/composedSchemas.oneOf}}
+  {{/vendorExtensions.x-is-multi-map}}
 
-  {{^vendorExtensions.x-is-multi-array}}
+  {{^vendorExtensions.x-is-multi-array}}{{^vendorExtensions.x-is-multi-map}}
   {{#composedSchemas.oneOf}}
   {{^isModel}}
   {{^isEnumRef}}
@@ -55,7 +79,7 @@ object {{classname}} {
   {{/isEnumRef}}
   {{/isModel}}
   {{/composedSchemas.oneOf}}
-  {{/vendorExtensions.x-is-multi-array}}
+  {{/vendorExtensions.x-is-multi-map}}{{/vendorExtensions.x-is-multi-array}}
 }
 
 object {{classname}}Serializer extends Serializer[{{classname}}] {