Pass through required properties to allOf/anyOf/oneOf children (#342)

* Pass through required properties to allOf children

* extend fix to anyOf and oneOf

* fix: account for children making parent fields required

Co-authored-by: Anders Cassidy <[email protected]>
Co-authored-by: Daniel Playfair Cal <[email protected]>
Co-authored-by: Sergey S. Volkov <[email protected]>

Author: 4 people

src/schema.js

@@ -186,16 +186,57 @@ const getObjectTypeContent = (schema) => {
 const complexTypeGetter = (schema) => getInlineParseContent(schema);
 const filterContents = (contents, types) => _.filter(contents, (type) => !_.includes(types, type));
 
+const makeAddRequiredToChildSchema = (parentSchema) => (childSchema) => {
+  let required = childSchema.required || [];
+  let properties = childSchema.properties || {};
+
+  // Inherit all the required fields from the parent schema that are defined
+  // either on the parent schema or on the child schema
+  // TODO: any that are defined at grandparents or higher are ignored
+  required = required.concat(
+    (parentSchema.required || []).filter(
+      (key) =>
+        !required.includes(key) && (_.keys(properties).includes(key) || _.keys(parentSchema.properties).includes(key)),
+    ),
+  );
+
+  // Identify properties that are required in the child schema, but
+  // defined only in the parent schema (TODO: this only works one level deep)
+  const parentPropertiesRequiredByChild = required.filter(
+    (key) => !_.keys(childSchema.properties).includes(key) && _.keys(parentSchema.properties).includes(key),
+  );
+
+  // Add such properties to the child so that they can be overriden and made required
+  properties = {
+    ...properties,
+    ...parentPropertiesRequiredByChild.reduce(
+      (additionalProperties, key) => ({
+        ...additionalProperties,
+        [key]: (parentSchema.properties || {})[key],
+      }),
+      {},
+    ),
+  };
+
+  return _.merge(
+    {
+      required: required,
+      properties: properties,
+    },
+    childSchema,
+  );
+};
+
 const complexSchemaParsers = {
   [SCHEMA_TYPES.COMPLEX_ONE_OF]: (schema) => {
     // T1 | T2
-    const combined = _.map(schema.oneOf, complexTypeGetter);
+    const combined = _.map(schema.oneOf.map(makeAddRequiredToChildSchema(schema)), complexTypeGetter);
 
     return checkAndAddNull(schema, filterContents(combined, [TS_KEYWORDS.ANY]).join(" | "));
   },
   [SCHEMA_TYPES.COMPLEX_ALL_OF]: (schema) => {
     // T1 & T2
-    const combined = _.map(schema.allOf, complexTypeGetter);
+    const combined = _.map(schema.allOf.map(makeAddRequiredToChildSchema(schema)), complexTypeGetter);
     return checkAndAddNull(
       schema,
       filterContents(combined, [...JS_EMPTY_TYPES, ...JS_PRIMITIVE_TYPES, TS_KEYWORDS.ANY]).join(
@@ -205,7 +246,7 @@ const complexSchemaParsers = {
   },
   [SCHEMA_TYPES.COMPLEX_ANY_OF]: (schema) => {
     // T1 | T2 | (T1 & T2)
-    const combined = _.map(schema.anyOf, complexTypeGetter);
+    const combined = _.map(makeAddRequiredToChildSchema(schema), complexTypeGetter);
     const nonEmptyTypesCombined = filterContents(combined, [
       ...JS_EMPTY_TYPES,
       ...JS_PRIMITIVE_TYPES,

tests/generated/v3.0/allof-example.ts

@@ -13,7 +13,7 @@ export interface Pet {
   pet_type: string;
 }
 
-export type Dog = Pet & { bark?: boolean; breed?: "Dingo" | "Husky" | "Retriever" | "Shepherd" };
+export type Dog = Pet & { bark?: boolean; breed: "Dingo" | "Husky" | "Retriever" | "Shepherd" };
 
 export type Cat = Pet & { hunts?: boolean; age?: number };
 

tests/generated/v3.0/full-swagger-scheme.ts

@@ -10610,9 +10610,41 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      */
     gistsUpdate: (
       gistId: string,
-      data: (any | any | null) & {
+      data: (
+        | { description: string }
+        | {
+            files: Record<
+              string,
+              (
+                | { content: string }
+                | { filename: string | null }
+                | object
+                | ({ content: string } & { filename: string | null } & object)
+              ) & { content?: string; filename?: string | null }
+            >;
+          }
+        | ({ description: string } & {
+            files: Record<
+              string,
+              (
+                | { content: string }
+                | { filename: string | null }
+                | object
+                | ({ content: string } & { filename: string | null } & object)
+              ) & { content?: string; filename?: string | null }
+            >;
+          })
+      ) & {
         description?: string;
-        files?: Record<string, (any | any | object | null) & { content?: string; filename?: string | null }>;
+        files?: Record<
+          string,
+          (
+            | { content: string }
+            | { filename: string | null }
+            | object
+            | ({ content: string } & { filename: string | null } & object)
+          ) & { content?: string; filename?: string | null }
+        >;
       },
       params: RequestParams = {},
     ) =>
@@ -15917,9 +15949,21 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       owner: string,
       repo: string,
       data: (
-        | { status?: "completed"; [key: string]: any }
-        | { status?: "queued" | "in_progress"; [key: string]: any }
-        | ({ status?: "completed"; [key: string]: any } & { status?: "queued" | "in_progress"; [key: string]: any })
+        | {
+            status?: "completed";
+            conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required";
+            name: string;
+            head_sha: string;
+            [key: string]: any;
+          }
+        | { status?: "queued" | "in_progress"; name: string; head_sha: string; [key: string]: any }
+        | ({
+            status?: "completed";
+            conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required";
+            name: string;
+            head_sha: string;
+            [key: string]: any;
+          } & { status?: "queued" | "in_progress"; name: string; head_sha: string; [key: string]: any })
       ) & {
         name: string;
         head_sha: string;
@@ -15988,9 +16032,17 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       repo: string,
       checkRunId: number,
       data: (
-        | { status?: "completed"; [key: string]: any }
+        | {
+            status?: "completed";
+            conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required";
+            [key: string]: any;
+          }
         | { status?: "queued" | "in_progress"; [key: string]: any }
-        | ({ status?: "completed"; [key: string]: any } & { status?: "queued" | "in_progress"; [key: string]: any })
+        | ({
+            status?: "completed";
+            conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required";
+            [key: string]: any;
+          } & { status?: "queued" | "in_progress"; [key: string]: any })
       ) & {
         name?: string;
         details_url?: string;

tests/schemas/v3.0/allof-example.yaml

@@ -29,7 +29,9 @@ components:
       discriminator:
         propertyName: pet_type
     Dog:     # "Dog" is a value for the pet_type property (the discriminator value)
-      allOf: # Combines the main `Pet` schema with `Dog`-specific properties 
+      required:
+        - breed
+      allOf: # Combines the main `Pet` schema with `Dog`-specific properties
         - $ref: '#/components/schemas/Pet'
         - type: object
           # all other properties specific to a `Dog`
@@ -48,4 +50,4 @@ components:
             hunts:
               type: boolean
             age:
-              type: integer
+              type: integer