fix(nestjs): improve type schema generation for string, enum, and array types#93
Merged
hyeonss0417 merged 1 commit intomainfrom Dec 25, 2025
Merged
Conversation
…ay types - Fix string types being incorrectly converted to Record<string, string> - Fix enum types being incorrectly treated as index signature types - Fix array types (T[]) being converted to object with additionalProperties - Add TJS integration as fallback for types not found in typeDefinitions - Add test for array property types to prevent regression - Make generateOpenApiFromNest async for TJS schema conversion The root cause was that TypeScript's getIndexInfosOfType() returns index signatures for primitive types (string[number] -> string), enum types, and array types. These should not be treated as Record/Map types. Added checks in getIndexSignatureInfoFromType() to skip: - Primitive types (string, number, boolean, etc.) - Array types (T[] or Array<T>) - Enum types (union of literals or TypeFlags.Enum)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix incorrect OpenAPI schema generation for
string,enum, and array types in NestJS parser.Problem
The following types were being incorrectly converted to
{ type: 'object', additionalProperties: ... }:key: string→{ type: 'object', additionalProperties: { type: 'string' } }gender: Gender→{ type: 'object', additionalProperties: ... }users: UserDto[]→{ type: 'object', additionalProperties: { $ref: '...' } }Root Cause
TypeScript's
getIndexInfosOfType()returns index signatures for:string[number]→string)T[])These were incorrectly treated as
Record<K, V>orMap<K, V>types.Solution
Added checks in
getIndexSignatureInfoFromType()to skip:string,number,boolean, etc.)T[]orArray<T>)TypeFlags.Enum)Additional Changes
typescript-json-schemaas fallback for types not found intypeDefinitionsgenerateOpenApiFromNestasync for TJS schema conversionTesting
should handle array properties correctly (not as Record/Map)Example
Before:
After: