Fix for #15736 [TYPESCRIPT-FETCH] Subclassing components using discri… (

#19524) * Fix for #15736 [TYPESCRIPT-FETCH] Subclassing components using discriminators fails to convert subclasses to JSON. Added similar discriminator handling to ToJSON as was already in place for FromJSON. The actual files changed are typescript-fetch/modelGeneric.mustache and typescript-fetch/apis.mustache. Also, adjusted FromJSON a bit in an attempt to support multiple hierarchical levels of discriminators. And fixed an issue with calling FromJSON from the map() function, which caused the index parameter getting inadvertently passed as the ignoreDiscriminator parameter. Additionally, fixed failing "mvn integration-test -f samples/client/petstore/typescript-fetch/builds/prefix-parameter-interfaces/pom.xml" Moreover, added forceConsistentCasingInFileNames:false into tsconfig.json to make tests compile on OsX. * Rolled back the changes related to the map() function calls in favor of using ToJSONTyped instead, as that is in line with how FromJSON is already implemented.
OpenAPITools · Sep 5, 2024 · 2f54a2f · 2f54a2f
1 parent e914c40
commit 2f54a2f
Show file tree

Hide file tree

Showing 185 changed files with 1,213 additions and 202 deletions.
diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/modelEnum.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/modelEnum.mustache
@@ -22,3 +22,7 @@ export function {{classname}}FromJSONTyped(json: any, ignoreDiscriminator: boole
 export function {{classname}}ToJSON(value?: {{classname}} | null): any {
     return value as any;
 }
+
+export function {{classname}}ToJSONTyped(value: any, ignoreDiscriminator: boolean): {{classname}} {
+    return value as {{classname}};
+}
diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache
@@ -6,13 +6,14 @@ import {
     {{classname}}FromJSON,
     {{classname}}FromJSONTyped,
     {{classname}}ToJSON,
+    {{classname}}ToJSONTyped,
 } from './{{filename}}{{importFileExtension}}';
 {{/tsImports}}
 
 {{/hasImports}}
 {{#discriminator}}
 {{#discriminator.mappedModels}}
-import { {{modelName}}FromJSONTyped } from './{{modelName}}{{importFileExtension}}';
+import { {{modelName}}, {{modelName}}FromJSONTyped, {{modelName}}ToJSON, {{modelName}}ToJSONTyped } from './{{modelName}}{{importFileExtension}}';
 {{/discriminator.mappedModels}}
 {{/discriminator}}
 {{>modelGenericInterfaces}}
@@ -42,13 +43,13 @@ export function {{classname}}FromJSONTyped(json: any, ignoreDiscriminator: boole
     if (!ignoreDiscriminator) {
 {{#discriminator.mappedModels}}
         if (json['{{discriminator.propertyBaseName}}'] === '{{mappingName}}') {
-            return {{modelName}}FromJSONTyped(json, true);
+            return {{modelName}}FromJSONTyped(json, ignoreDiscriminator);
         }
 {{/discriminator.mappedModels}}
     }
 {{/discriminator}}
     return {
-        {{#parent}}...{{{.}}}FromJSONTyped(json, ignoreDiscriminator),{{/parent}}
+        {{#parent}}...{{{.}}}FromJSONTyped(json, true),{{/parent}}
         {{#additionalPropertiesType}}
             ...json,
         {{/additionalPropertiesType}}
@@ -97,13 +98,31 @@ export function {{classname}}FromJSONTyped(json: any, ignoreDiscriminator: boole
     {{/hasVars}}
 }
 
-export function {{classname}}ToJSON(value?: {{#hasReadOnly}}Omit<{{classname}}, {{#readOnlyVars}}'{{baseName}}'{{^-last}}|{{/-last}}{{/readOnlyVars}}>{{/hasReadOnly}}{{^hasReadOnly}}{{classname}}{{/hasReadOnly}} | null): any {
+  export function {{classname}}ToJSON(json: any): {{classname}} {
+      return {{classname}}ToJSONTyped(json, false);
+  }
+
+  export function {{classname}}ToJSONTyped(value?: {{#hasReadOnly}}Omit<{{classname}}, {{#readOnlyVars}}'{{baseName}}'{{^-last}}|{{/-last}}{{/readOnlyVars}}>{{/hasReadOnly}}{{^hasReadOnly}}{{classname}}{{/hasReadOnly}} | null, ignoreDiscriminator: boolean = false): any {
     {{#hasVars}}
     if (value == null) {
         return value;
     }
+    {{#discriminator}}
+
+    if (!ignoreDiscriminator) {
+        switch (value['{{discriminator.propertyName}}']) {
+        {{#discriminator.mappedModels}}
+            case '{{mappingName}}':
+                return {{modelName}}ToJSONTyped(value as {{modelName}}, ignoreDiscriminator);
+        {{/discriminator.mappedModels}}
+            default:
+                throw new Error(`No variant of {{classname}} exists with '{{discriminator.propertyName}}=${value['{{discriminator.propertyName}}']}'`);
+        }
+    }
+    {{/discriminator}}
+
     return {
-        {{#parent}}...{{{.}}}ToJSON(value),{{/parent}}
+        {{#parent}}...{{{.}}}ToJSONTyped(value, true),{{/parent}}
         {{#additionalPropertiesType}}
             ...value,
         {{/additionalPropertiesType}}

diff --git a/samples/client/others/typescript-fetch/self-import-issue/models/AbstractUserDto.ts b/samples/client/others/typescript-fetch/self-import-issue/models/AbstractUserDto.ts
@@ -18,10 +18,11 @@ import {
     BranchDtoFromJSON,
     BranchDtoFromJSONTyped,
     BranchDtoToJSON,
+    BranchDtoToJSONTyped,
 } from './BranchDto';
 
-import { InternalAuthenticatedUserDtoFromJSONTyped } from './InternalAuthenticatedUserDto';
-import { RemoteAuthenticatedUserDtoFromJSONTyped } from './RemoteAuthenticatedUserDto';
+import { InternalAuthenticatedUserDto, InternalAuthenticatedUserDtoFromJSONTyped, InternalAuthenticatedUserDtoToJSON, InternalAuthenticatedUserDtoToJSONTyped } from './InternalAuthenticatedUserDto';
+import { RemoteAuthenticatedUserDto, RemoteAuthenticatedUserDtoFromJSONTyped, RemoteAuthenticatedUserDtoToJSON, RemoteAuthenticatedUserDtoToJSONTyped } from './RemoteAuthenticatedUserDto';
 /**
  * 
  * @export
@@ -65,10 +66,10 @@ export function AbstractUserDtoFromJSONTyped(json: any, ignoreDiscriminator: boo
     }
     if (!ignoreDiscriminator) {
         if (json['type'] === 'internal-authenticated') {
-            return InternalAuthenticatedUserDtoFromJSONTyped(json, true);
+            return InternalAuthenticatedUserDtoFromJSONTyped(json, ignoreDiscriminator);
         }
         if (json['type'] === 'remote-authenticated') {
-            return RemoteAuthenticatedUserDtoFromJSONTyped(json, true);
+            return RemoteAuthenticatedUserDtoFromJSONTyped(json, ignoreDiscriminator);
         }
     }
     return {
@@ -79,10 +80,26 @@ export function AbstractUserDtoFromJSONTyped(json: any, ignoreDiscriminator: boo
     };
 }
 
-export function AbstractUserDtoToJSON(value?: AbstractUserDto | null): any {
+  export function AbstractUserDtoToJSON(json: any): AbstractUserDto {
+      return AbstractUserDtoToJSONTyped(json, false);
+  }
+
+  export function AbstractUserDtoToJSONTyped(value?: AbstractUserDto | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
+    if (!ignoreDiscriminator) {
+        switch (value['type']) {
+            case 'internal-authenticated':
+                return InternalAuthenticatedUserDtoToJSONTyped(value as InternalAuthenticatedUserDto, ignoreDiscriminator);
+            case 'remote-authenticated':
+                return RemoteAuthenticatedUserDtoToJSONTyped(value as RemoteAuthenticatedUserDto, ignoreDiscriminator);
+            default:
+                throw new Error(`No variant of AbstractUserDto exists with 'type=${value['type']}'`);
+        }
+    }
+
     return {
 
         'username': value['username'],

diff --git a/samples/client/others/typescript-fetch/self-import-issue/models/BranchDto.ts b/samples/client/others/typescript-fetch/self-import-issue/models/BranchDto.ts
@@ -48,10 +48,15 @@ export function BranchDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean):
     };
 }
 
-export function BranchDtoToJSON(value?: BranchDto | null): any {
+  export function BranchDtoToJSON(json: any): BranchDto {
+      return BranchDtoToJSONTyped(json, false);
+  }
+
+  export function BranchDtoToJSONTyped(value?: BranchDto | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'name': value['name'],

diff --git a/...s/client/others/typescript-fetch/self-import-issue/models/InternalAuthenticatedUserDto.ts b/...s/client/others/typescript-fetch/self-import-issue/models/InternalAuthenticatedUserDto.ts
@@ -18,12 +18,14 @@ import {
     BranchDtoFromJSON,
     BranchDtoFromJSONTyped,
     BranchDtoToJSON,
+    BranchDtoToJSONTyped,
 } from './BranchDto';
 import type { AbstractUserDto } from './AbstractUserDto';
 import {
     AbstractUserDtoFromJSON,
     AbstractUserDtoFromJSONTyped,
     AbstractUserDtoToJSON,
+    AbstractUserDtoToJSONTyped,
 } from './AbstractUserDto';
 
 /**
@@ -49,7 +51,11 @@ export function InternalAuthenticatedUserDtoFromJSONTyped(json: any, ignoreDiscr
     return json;
 }
 
-export function InternalAuthenticatedUserDtoToJSON(value?: InternalAuthenticatedUserDto | null): any {
+  export function InternalAuthenticatedUserDtoToJSON(json: any): InternalAuthenticatedUserDto {
+      return InternalAuthenticatedUserDtoToJSONTyped(json, false);
+  }
+
+  export function InternalAuthenticatedUserDtoToJSONTyped(value?: InternalAuthenticatedUserDto | null, ignoreDiscriminator: boolean = false): any {
     return value;
 }
 
diff --git a/...les/client/others/typescript-fetch/self-import-issue/models/RemoteAuthenticatedUserDto.ts b/...les/client/others/typescript-fetch/self-import-issue/models/RemoteAuthenticatedUserDto.ts
@@ -18,12 +18,14 @@ import {
     BranchDtoFromJSON,
     BranchDtoFromJSONTyped,
     BranchDtoToJSON,
+    BranchDtoToJSONTyped,
 } from './BranchDto';
 import type { AbstractUserDto } from './AbstractUserDto';
 import {
     AbstractUserDtoFromJSON,
     AbstractUserDtoFromJSONTyped,
     AbstractUserDtoToJSON,
+    AbstractUserDtoToJSONTyped,
 } from './AbstractUserDto';
 
 /**
@@ -49,7 +51,11 @@ export function RemoteAuthenticatedUserDtoFromJSONTyped(json: any, ignoreDiscrim
     return json;
 }
 
-export function RemoteAuthenticatedUserDtoToJSON(value?: RemoteAuthenticatedUserDto | null): any {
+  export function RemoteAuthenticatedUserDtoToJSON(json: any): RemoteAuthenticatedUserDto {
+      return RemoteAuthenticatedUserDtoToJSONTyped(json, false);
+  }
+
+  export function RemoteAuthenticatedUserDtoToJSONTyped(value?: RemoteAuthenticatedUserDto | null, ignoreDiscriminator: boolean = false): any {
     return value;
 }
 
diff --git a/samples/client/petstore/typescript-fetch/builds/allOf-nullable/models/Club.ts b/samples/client/petstore/typescript-fetch/builds/allOf-nullable/models/Club.ts
@@ -18,6 +18,7 @@ import {
     OwnerFromJSON,
     OwnerFromJSONTyped,
     OwnerToJSON,
+    OwnerToJSONTyped,
 } from './Owner';
 
 /**
@@ -55,10 +56,15 @@ export function ClubFromJSONTyped(json: any, ignoreDiscriminator: boolean): Club
     };
 }
 
-export function ClubToJSON(value?: Club | null): any {
+  export function ClubToJSON(json: any): Club {
+      return ClubToJSONTyped(json, false);
+  }
+
+  export function ClubToJSONTyped(value?: Club | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'owner': OwnerToJSON(value['owner']),

diff --git a/samples/client/petstore/typescript-fetch/builds/allOf-nullable/models/Owner.ts b/samples/client/petstore/typescript-fetch/builds/allOf-nullable/models/Owner.ts
@@ -48,10 +48,15 @@ export function OwnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): Own
     };
 }
 
-export function OwnerToJSON(value?: Owner | null): any {
+  export function OwnerToJSON(json: any): Owner {
+      return OwnerToJSONTyped(json, false);
+  }
+
+  export function OwnerToJSONTyped(value?: Owner | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'name': value['name'],

diff --git a/samples/client/petstore/typescript-fetch/builds/allOf-readonly/models/Club.ts b/samples/client/petstore/typescript-fetch/builds/allOf-readonly/models/Club.ts
@@ -18,6 +18,7 @@ import {
     OwnerFromJSON,
     OwnerFromJSONTyped,
     OwnerToJSON,
+    OwnerToJSONTyped,
 } from './Owner';
 
 /**
@@ -55,10 +56,15 @@ export function ClubFromJSONTyped(json: any, ignoreDiscriminator: boolean): Club
     };
 }
 
-export function ClubToJSON(value?: Omit<Club, 'owner'> | null): any {
+  export function ClubToJSON(json: any): Club {
+      return ClubToJSONTyped(json, false);
+  }
+
+  export function ClubToJSONTyped(value?: Omit<Club, 'owner'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
     };

diff --git a/samples/client/petstore/typescript-fetch/builds/allOf-readonly/models/Owner.ts b/samples/client/petstore/typescript-fetch/builds/allOf-readonly/models/Owner.ts
@@ -48,10 +48,15 @@ export function OwnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): Own
     };
 }
 
-export function OwnerToJSON(value?: Owner | null): any {
+  export function OwnerToJSON(json: any): Owner {
+      return OwnerToJSONTyped(json, false);
+  }
+
+  export function OwnerToJSONTyped(value?: Owner | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'name': value['name'],

diff --git a/.../client/petstore/typescript-fetch/builds/default-v3.0/models/AdditionalPropertiesClass.ts b/.../client/petstore/typescript-fetch/builds/default-v3.0/models/AdditionalPropertiesClass.ts
@@ -55,10 +55,15 @@ export function AdditionalPropertiesClassFromJSONTyped(json: any, ignoreDiscrimi
     };
 }
 
-export function AdditionalPropertiesClassToJSON(value?: AdditionalPropertiesClass | null): any {
+  export function AdditionalPropertiesClassToJSON(json: any): AdditionalPropertiesClass {
+      return AdditionalPropertiesClassToJSONTyped(json, false);
+  }
+
+  export function AdditionalPropertiesClassToJSONTyped(value?: AdditionalPropertiesClass | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'map_property': value['mapProperty'],

diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/models/AllOfWithSingleRef.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/models/AllOfWithSingleRef.ts
@@ -18,6 +18,7 @@ import {
     SingleRefTypeFromJSON,
     SingleRefTypeFromJSONTyped,
     SingleRefTypeToJSON,
+    SingleRefTypeToJSONTyped,
 } from './SingleRefType';
 
 /**
@@ -64,10 +65,15 @@ export function AllOfWithSingleRefFromJSONTyped(json: any, ignoreDiscriminator:
     };
 }
 
-export function AllOfWithSingleRefToJSON(value?: AllOfWithSingleRef | null): any {
+  export function AllOfWithSingleRefToJSON(json: any): AllOfWithSingleRef {
+      return AllOfWithSingleRefToJSONTyped(json, false);
+  }
+
+  export function AllOfWithSingleRefToJSONTyped(value?: AllOfWithSingleRef | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'username': value['username'],

diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/models/Animal.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/models/Animal.ts
@@ -13,8 +13,8 @@
  */
 
 import { mapValues } from '../runtime';
-import { CatFromJSONTyped } from './Cat';
-import { DogFromJSONTyped } from './Dog';
+import { Cat, CatFromJSONTyped, CatToJSON, CatToJSONTyped } from './Cat';
+import { Dog, DogFromJSONTyped, DogToJSON, DogToJSONTyped } from './Dog';
 /**
  * 
  * @export
@@ -53,10 +53,10 @@ export function AnimalFromJSONTyped(json: any, ignoreDiscriminator: boolean): An
     }
     if (!ignoreDiscriminator) {
         if (json['className'] === 'CAT') {
-            return CatFromJSONTyped(json, true);
+            return CatFromJSONTyped(json, ignoreDiscriminator);
         }
         if (json['className'] === 'DOG') {
-            return DogFromJSONTyped(json, true);
+            return DogFromJSONTyped(json, ignoreDiscriminator);
         }
     }
     return {
@@ -66,10 +66,26 @@ export function AnimalFromJSONTyped(json: any, ignoreDiscriminator: boolean): An
     };
 }
 
-export function AnimalToJSON(value?: Animal | null): any {
+  export function AnimalToJSON(json: any): Animal {
+      return AnimalToJSONTyped(json, false);
+  }
+
+  export function AnimalToJSONTyped(value?: Animal | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
+    if (!ignoreDiscriminator) {
+        switch (value['className']) {
+            case 'CAT':
+                return CatToJSONTyped(value as Cat, ignoreDiscriminator);
+            case 'DOG':
+                return DogToJSONTyped(value as Dog, ignoreDiscriminator);
+            default:
+                throw new Error(`No variant of Animal exists with 'className=${value['className']}'`);
+        }
+    }
+
     return {
 
         'className': value['className'],

diff --git a/...s/client/petstore/typescript-fetch/builds/default-v3.0/models/ArrayOfArrayOfNumberOnly.ts b/...s/client/petstore/typescript-fetch/builds/default-v3.0/models/ArrayOfArrayOfNumberOnly.ts
@@ -48,10 +48,15 @@ export function ArrayOfArrayOfNumberOnlyFromJSONTyped(json: any, ignoreDiscrimin
     };
 }
 
-export function ArrayOfArrayOfNumberOnlyToJSON(value?: ArrayOfArrayOfNumberOnly | null): any {
+  export function ArrayOfArrayOfNumberOnlyToJSON(json: any): ArrayOfArrayOfNumberOnly {
+      return ArrayOfArrayOfNumberOnlyToJSONTyped(json, false);
+  }
+
+  export function ArrayOfArrayOfNumberOnlyToJSONTyped(value?: ArrayOfArrayOfNumberOnly | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'ArrayArrayNumber': value['arrayArrayNumber'],