Skip to content

[typescript] Utility types now considered when generating schemas (Issue #21317) #21414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
macjohnny merged 13 commits into from
Jun 29, 2025
+398 −1
Merged

[typescript] Utility types now considered when generating schemas (Issue #21317) #21414

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a231ab6
Added failing test to fix Record renaming issue
DavidGrath Jun 12, 2025
9adc829
Typescript utility types now taken into account when generating. Addr…
DavidGrath Jun 14, 2025
6dfc001
Ran generation script
DavidGrath Jun 14, 2025
f729421
Remove print statements
DavidGrath Jun 14, 2025
7007105
Removed TS ANTLR. Added Utility Types Sample. Pending Regeneration
DavidGrath Jun 17, 2025
b8f5cdf
Generated samples for utility types
DavidGrath Jun 18, 2025
7826ba6
Samples fix
DavidGrath Jun 18, 2025
4a6cc5a
Removed TypeScript utility type samples. Other reviews applied
DavidGrath Jun 21, 2025
8f77456
Merge branch 'master' into issue-21317
DavidGrath Jun 21, 2025
600ad25
Merge branch 'master' into issue-21317
DavidGrath Jun 21, 2025
572dd9e
Updated samples
DavidGrath Jun 25, 2025
a9fc23c
meta-codegen
DavidGrath Jun 25, 2025
465e1c6
Merge branch 'master' into issue-21317
DavidGrath Jun 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions bin/configs/typescript-fetch-utility-types-without-runtime.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
generatorName: typescript-fetch
Copy link
Member

@macjohnny macjohnny Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for adding the sample configs here, but after looking at the updated unit test, which covers the relevant code changes, i would argue the sample configs bin/configs/typescript-fetch-utility-types-without-runtime.yaml and bin/configs/typescript-fetch-utility-types.yaml and the corresponding samples should be removed, since:

  • the diff to other samples is minimal
  • the functionality is already covered in the unit test
  • there is no big change in the template

outputDir: samples/client/petstore/typescript-fetch/builds/utility-types-without-runtime
inputSpec: modules/openapi-generator/src/test/resources/3_1/issue_21317.yaml
templateDir: modules/openapi-generator/src/main/resources/typescript-fetch
typeMappings:
object: Record<string, unknown>
UserSummary: Pick<User, "email">
additionalProperties:
withoutRuntimeChecks: true

7 changes: 7 additions & 0 deletions bin/configs/typescript-fetch-utility-types.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
generatorName: typescript-fetch
outputDir: samples/client/petstore/typescript-fetch/builds/utility-types
inputSpec: modules/openapi-generator/src/test/resources/3_1/issue_21317.yaml
templateDir: modules/openapi-generator/src/main/resources/typescript-fetch
typeMappings:
object: Record<string, unknown>

22 changes: 22 additions & 0 deletions docs/generators/typescript-angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,42 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Blob</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-aurelia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,41 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-axios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,41 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,41 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-inversify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,42 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Blob</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-jquery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,41 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-nestjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,42 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Blob</li>
<li>Boolean</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
22 changes: 22 additions & 0 deletions docs/generators/typescript-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,23 +56,45 @@ These options may be applied as additional-properties (cli) or configOptions (pl

<ul class="column-ul">
<li>Array</li>
<li>Awaited</li>
<li>Boolean</li>
<li>Buffer</li>
<li>Capitalize</li>
<li>ConstructorParameters</li>
<li>Date</li>
<li>Double</li>
<li>Error</li>
<li>Exclude</li>
<li>Extract</li>
<li>File</li>
<li>Float</li>
<li>InstanceType</li>
<li>Integer</li>
<li>Long</li>
<li>Lowercase</li>
<li>Map</li>
<li>NoInfer</li>
<li>NonNullable</li>
<li>Object</li>
<li>Omit</li>
<li>OmitThisParameter</li>
<li>Parameters</li>
<li>Partial</li>
<li>Pick</li>
<li>ReadStream</li>
<li>Readonly</li>
<li>ReadonlyArray</li>
<li>Record</li>
<li>RequestDetailedFile</li>
<li>RequestFile</li>
<li>Required</li>
<li>ReturnType</li>
<li>Set</li>
<li>String</li>
<li>ThisParameterType</li>
<li>ThisType</li>
<li>Uncapitalize</li>
<li>Uppercase</li>
<li>any</li>
<li>boolean</li>
<li>number</li>
Expand Down
Loading
Loading