[CHK-1807] feat: allow object properties to be defined with oneOf

__mocks__/api.yaml

@@ -366,6 +366,21 @@ definitions:
         properties:
           unlimited:
             type: boolean
+  OneOfPropertyTest:
+    type: object
+    description: test if we can use `oneOf` as an object property
+    properties:
+      fields:
+        oneOf:
+          - type: object
+            properties:
+              foo:
+                type: string
+          - type: object
+            properties:
+              bar:
+                type: string
+          - $ref: "#/definitions/Person"
   AdditionalPropsTest:
     type: object
     additionalProperties:

__mocks__/openapi_v3/api.yaml

@@ -500,6 +500,21 @@ components:
           properties:
             unlimited:
               type: boolean
+    OneOfPropertyTest:
+      type: object
+      description: test if we can use `oneOf` as an object property
+      properties:
+        fields:
+          oneOf:
+            - type: object
+              properties:
+                foo:
+                  type: string
+            - type: object
+              properties:
+                bar:
+                  type: string
+            - $ref: "#/components/schemas/Person"
     AllOfWithOneElementTest:
       description: test if we can use allOf with just one element inside
       allOf:

src/commands/gen-api-models/__tests__/__snapshots__/index.test.ts.snap

@@ -310,6 +310,78 @@ export type OneOfTest = t.TypeOf<typeof OneOfTest>;
 "
 `;
 
+exports[`Openapi V2 |> gen-api-models should generate an object with a union property when that property has oneOf: oneof-property-test 1`] = `
+"/**
+ * Do not edit this file it is auto-generated by io-utils / gen-api-models.
+ * See https://github.com/pagopa/io-utils
+ */
+/* eslint-disable  */
+
+import * as t from \\"io-ts\\";
+import { Person } from \\"./Person\\";
+
+/**
+ * test if we can use \`oneOf\` as an object property
+ */
+
+// required attributes
+const OneOfPropertyTestFields1R = t.interface({});
+
+// optional attributes
+const OneOfPropertyTestFields1O = t.partial({
+  foo: t.string
+});
+
+export const OneOfPropertyTestFields1 = t.intersection(
+  [OneOfPropertyTestFields1R, OneOfPropertyTestFields1O],
+  \\"OneOfPropertyTestFields1\\"
+);
+
+export type OneOfPropertyTestFields1 = t.TypeOf<
+  typeof OneOfPropertyTestFields1
+>;
+
+// required attributes
+const OneOfPropertyTestFields2R = t.interface({});
+
+// optional attributes
+const OneOfPropertyTestFields2O = t.partial({
+  bar: t.string
+});
+
+export const OneOfPropertyTestFields2 = t.intersection(
+  [OneOfPropertyTestFields2R, OneOfPropertyTestFields2O],
+  \\"OneOfPropertyTestFields2\\"
+);
+
+export type OneOfPropertyTestFields2 = t.TypeOf<
+  typeof OneOfPropertyTestFields2
+>;
+
+export const OneOfPropertyTestFields = t.union(
+  [OneOfPropertyTestFields1, OneOfPropertyTestFields2, Person],
+  \\"OneOfPropertyTestFields\\"
+);
+
+export type OneOfPropertyTestFields = t.TypeOf<typeof OneOfPropertyTestFields>;
+
+// required attributes
+const OneOfPropertyTestR = t.interface({});
+
+// optional attributes
+const OneOfPropertyTestO = t.partial({
+  fields: OneOfPropertyTestFields
+});
+
+export const OneOfPropertyTest = t.intersection(
+  [OneOfPropertyTestR, OneOfPropertyTestO],
+  \\"OneOfPropertyTest\\"
+);
+
+export type OneOfPropertyTest = t.TypeOf<typeof OneOfPropertyTest>;
+"
+`;
+
 exports[`Openapi V2 |> gen-api-models should generate decoder definitions for (get, /test-auth-bearer)  1`] = `
 "
     /****************************************************************
@@ -2196,6 +2268,78 @@ export type OneOfTest = t.TypeOf<typeof OneOfTest>;
 "
 `;
 
+exports[`Openapi V3 |> gen-api-models should generate an object with a union property when that property has oneOf: oneof-property-test 1`] = `
+"/**
+ * Do not edit this file it is auto-generated by io-utils / gen-api-models.
+ * See https://github.com/pagopa/io-utils
+ */
+/* eslint-disable  */
+
+import * as t from \\"io-ts\\";
+import { Person } from \\"./Person\\";
+
+/**
+ * test if we can use \`oneOf\` as an object property
+ */
+
+// required attributes
+const OneOfPropertyTestFields1R = t.interface({});
+
+// optional attributes
+const OneOfPropertyTestFields1O = t.partial({
+  foo: t.string
+});
+
+export const OneOfPropertyTestFields1 = t.intersection(
+  [OneOfPropertyTestFields1R, OneOfPropertyTestFields1O],
+  \\"OneOfPropertyTestFields1\\"
+);
+
+export type OneOfPropertyTestFields1 = t.TypeOf<
+  typeof OneOfPropertyTestFields1
+>;
+
+// required attributes
+const OneOfPropertyTestFields2R = t.interface({});
+
+// optional attributes
+const OneOfPropertyTestFields2O = t.partial({
+  bar: t.string
+});
+
+export const OneOfPropertyTestFields2 = t.intersection(
+  [OneOfPropertyTestFields2R, OneOfPropertyTestFields2O],
+  \\"OneOfPropertyTestFields2\\"
+);
+
+export type OneOfPropertyTestFields2 = t.TypeOf<
+  typeof OneOfPropertyTestFields2
+>;
+
+export const OneOfPropertyTestFields = t.union(
+  [OneOfPropertyTestFields1, OneOfPropertyTestFields2, Person],
+  \\"OneOfPropertyTestFields\\"
+);
+
+export type OneOfPropertyTestFields = t.TypeOf<typeof OneOfPropertyTestFields>;
+
+// required attributes
+const OneOfPropertyTestR = t.interface({});
+
+// optional attributes
+const OneOfPropertyTestO = t.partial({
+  fields: OneOfPropertyTestFields
+});
+
+export const OneOfPropertyTest = t.intersection(
+  [OneOfPropertyTestR, OneOfPropertyTestO],
+  \\"OneOfPropertyTest\\"
+);
+
+export type OneOfPropertyTest = t.TypeOf<typeof OneOfPropertyTest>;
+"
+`;
+
 exports[`Openapi V3 |> gen-api-models should generate decoder definitions for (get, /test-auth-bearer)  1`] = `
 "
     /****************************************************************

src/commands/gen-api-models/__tests__/index.test.ts

@@ -350,6 +350,23 @@ describe.each`
     expect(code).toMatchSnapshot("oneof-test");
   });
 
+  it("should generate an object with a union property when that property has oneOf", async () => {
+    const definitonName = "OneOfPropertyTest";
+    const definition = getDefinitionOrFail(spec, definitonName);
+
+    const code = await renderDefinitionCode(
+      definitonName,
+      getParser(spec).parseDefinition(
+        // @ts-ignore
+        definition
+      ),
+      false
+    );
+
+    expect(code).toContain("t.union");
+    expect(code).toMatchSnapshot("oneof-property-test");
+  });
+
   it("should generate a type union from allOf when x-one-of is used", async () => {
     if (version === 2) {
       const definitonName = "AllOfOneOfTest";

templates/macros.njk

@@ -265,6 +265,15 @@
   {{ defineConst(definition.default, definitionName, typedef, false, inline) }}
 {% endmacro %}
 
+{##
+ # defines a oneOf property
+ #}
+ {% macro defineOneOfProperty(parentPropName, propName, definition, inline = false) -%}
+  {{- 'import * as t from "io-ts";' | addImport -}}
+  {% set definitionName %}{{ parentPropName }}{{ propName | capitalizeFirst }}{% endset %}
+  {{ definitionName }}
+ {% endmacro %}
+
 {##
  # defines an object property of some prop.type
  #}
@@ -290,6 +299,8 @@
     {{ defineString(propName, prop, true) }}
   {% elif prop.type == "boolean" %}
     {{ defineBoolean(propName, prop, true) }}
+  {% elif prop.oneOf %}
+    {{ defineOneOfProperty(parentPropName, propName, prop.oneOf, true)}}
   {% else %}
     // TODO: generate model for definition "{{ propName }}: {{ prop.type }}"
   {% endif %}
@@ -323,6 +334,38 @@
   {% endfor %}
 {% endmacro -%}
 
+{% macro defineOneOf(definitionName, prop, strictInterfaces, camelCasedPropNames) -%}
+    {{- 'import * as t from "io-ts";' | addImport -}}
+
+    {% for schema in prop -%}
+      {% if schema.type == "object" %}
+        {% set name %}{{ definitionName }}{{ loop.index }}{% endset %}
+        {{ defineObject(name, schema, strictInterfaces, camelCasedPropNames) }}
+      {% elif schema.$ref %}
+        {%- set realPropName = schema.$ref | splitBy("/") | last -%}
+        {{ importLocalProp(realPropName) }}
+      {% elif schema.type == "array" %}
+        {% set name %}{{ definitionName }}{{ loop.index }}{% endset %}
+        {{ defineArray(name, schema) }}
+      {% endif %}
+    {% endfor %}
+
+    export const {{ definitionName }} =
+      t.union([
+        {% for schema in prop -%}
+          {% if schema.type == "object" or schema.type == "array" %}
+            {{ definitionName }}{{ loop.index }},
+          {% elif schema.$ref %}
+            {{ schema.$ref | splitBy("/") | last }},
+          {% endif %}
+        {% endfor %}
+      ],
+      "{{ definitionName }}"
+    );
+
+    export type {{ definitionName }} = t.TypeOf<typeof {{ definitionName }}>;
+{% endmacro -%}
+
 {##
  # define object properties recursively,
  # supports additionaProperties, allOf and oneOf.
@@ -341,6 +384,9 @@
       {% if prop.type == "object" %}
         {% set composedPropName %}{{ definitionName }}{{ propName | capitalizeFirst }}{% endset %}
         {{ defineObject(composedPropName, prop, strictInterfaces, camelCasedPropNames) }}
+      {% elif prop.oneOf %}
+        {% set composedPropName %}{{ definitionName }}{{ propName | capitalizeFirst }}{% endset %}
+        {{ defineOneOf(composedPropName, prop.oneOf, strictInterfaces, camelCasedPropNames) }}
       {% endif %}
     {% endfor %}
 
@@ -418,31 +464,7 @@
   {% elif definition.oneOf %}
     {% set oneOfProps = definition.oneOf if definition.oneOf else definition.allOf %}
 
-    {{- 'import * as t from "io-ts";' | addImport -}}
-
-    {% for schema in oneOfProps -%}
-      {% if schema.type == "object" %}
-        {{ defineObject(definitionName + loop.index, schema, strictInterfaces, camelCasedPropNames) }}
-      {% elif schema.$ref %}
-        {%- set realPropName = schema.$ref | splitBy("/") | last -%}
-        {{ importLocalProp(realPropName) }}
-      {% endif %}
-    {% endfor %}
-
-    export const {{ definitionName }} =
-      t.union([
-        {% for schema in oneOfProps -%}
-          {% if schema.type == "object" %}
-            {{ definitionName + loop.index }},
-          {% elif schema.$ref %}
-            {{ schema.$ref | splitBy("/") | last }},
-          {% endif %}
-        {% endfor %}
-      ],
-      "{{ definitionName }}"
-    );
-
-    export type {{ definitionName }} = t.TypeOf<typeof {{ definitionName }}>;
+    {{ defineOneOf(definitionName, oneOfProps, strictInterfaces, camelCasedPropNames) }}
 
   {% elif definition.type == "number" %}