fix(core): add missing properties in subschemas to fix TS error (#1115)

* fix(core): add missing properties in subschemas to fix TS error * chore: updated samples Signed-off-by: Olzhas Alexandrov <[email protected]> --------- Signed-off-by: Olzhas Alexandrov <[email protected]>
orval-labs · Dec 19, 2023 · b889c88 · b889c88
1 parent 7580f55
commit b889c88
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 6 deletions.
diff --git a/packages/core/src/getters/combine.ts b/packages/core/src/getters/combine.ts
@@ -21,6 +21,11 @@ type CombinedData = {
   isEnum: boolean[];
   types: string[];
   hasReadonlyProps: boolean;
+  /**
+   * List of all properties in all subschemas
+   * - used to add missing properties in subschemas to avoid TS error described in @see https://github.com/anymaniax/orval/issues/935
+   */
+  allProperties: string[];
 };
 
 type Separator = 'allOf' | 'anyOf' | 'oneOf';
@@ -48,13 +53,37 @@ const combineValues = ({
     }`;
   }
 
+  let values = resolvedData.values;
+  const hasObjectSubschemas = resolvedData.allProperties.length;
+  if (hasObjectSubschemas) {
+    values = []; // the list of values will be rebuilt to add missing properties (if exist) in subschemas
+    for (let i = 0; i < resolvedData.values.length; i += 1) {
+      const subSchema = resolvedData.originalSchema[i];
+      if (subSchema?.type !== 'object') {
+        values.push(resolvedData.values[i]);
+        continue;
+      }
+
+      const missingProperties = resolvedData.allProperties.filter(
+        (p) => !Object.keys(subSchema.properties!).includes(p),
+      );
+      values.push(
+        `${resolvedData.values[i]}${
+          missingProperties.length
+            ? ` & {${missingProperties.map((p) => `${p}?: never`).join('; ')}}`
+            : ''
+        }`,
+      );
+    }
+  }
+
   if (resolvedValue) {
-    return `(${resolvedData.values.join(` & ${resolvedValue.value}) | (`)} & ${
+    return `(${values.join(` & ${resolvedValue.value}) | (`)} & ${
       resolvedValue.value
     })`;
   }
 
-  return resolvedData.values.join(' | ');
+  return values.join(' | ');
 };
 
 export const combineSchemas = ({
@@ -95,6 +124,12 @@ export const combineSchemas = ({
       acc.originalSchema.push(resolvedValue.originalSchema);
       acc.hasReadonlyProps ||= resolvedValue.hasReadonlyProps;
 
+      if (resolvedValue.type === 'object') {
+        acc.allProperties.push(
+          ...Object.keys(resolvedValue.originalSchema.properties!),
+        );
+      }
+
       return acc;
     },
     {
@@ -105,6 +140,7 @@ export const combineSchemas = ({
       isRef: [],
       types: [],
       originalSchema: [],
+      allProperties: [],
       hasReadonlyProps: false,
       example: schema.example,
       examples: resolveExampleRefs(schema.examples, context),

diff --git a/samples/react-query/basic/src/api/model/dog.ts b/samples/react-query/basic/src/api/model/dog.ts
@@ -9,11 +9,11 @@ import type { Dachshund } from './dachshund';
 import type { DogType } from './dogType';
 
 export type Dog =
-  | (Labradoodle & {
+  | (Labradoodle & { length?: never } & {
       barksPerMinute?: number;
       type: DogType;
     })
-  | (Dachshund & {
+  | (Dachshund & { cuteness?: never } & {
       barksPerMinute?: number;
       type: DogType;
     });
diff --git a/samples/react-query/basic/src/api/model/pet.ts b/samples/react-query/basic/src/api/model/pet.ts
@@ -10,7 +10,7 @@ import type { PetCallingCode } from './petCallingCode';
 import type { PetCountry } from './petCountry';
 
 export type Pet =
-  | (Dog & {
+  | (Dog & { petsRequested?: never } & {
       '@id'?: string;
       callingCode?: PetCallingCode;
       country?: PetCountry;
@@ -19,7 +19,7 @@ export type Pet =
       name: string;
       tag?: string;
     })
-  | (Cat & {
+  | (Cat & { barksPerMinute?: never } & {
       '@id'?: string;
       callingCode?: PetCallingCode;
       country?: PetCountry;