Skip to content

[typescript-angular] Fix inner enum reference in multi-map property type #22748

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 5 commits into from
Feb 10, 2026
Merged

[typescript-angular] Fix inner enum reference in multi-map property type #22748

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b112c18
[typescript-angular] Fix inner enum reference in multi-map property type
saxicek Jan 20, 2026
decf2cf
[typescript] Fix inner enum reference in multi-map property type
saxicek Feb 5, 2026
94499fa
test for the double-prefixed enum names
saxicek Feb 5, 2026
8f72be1
Implement review comment about the trailing `>`
saxicek Feb 6, 2026
213ee3f
fix @type for generic interfaces in TypeScript clients
saxicek Feb 6, 2026
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
147 changes: 124 additions & 23 deletions ...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,39 +17,65 @@

package org.openapitools.codegen.languages;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.parameters.Parameter;
import lombok.Getter;
import lombok.Setter;
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.form;
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.simple;
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
import static org.openapitools.codegen.utils.StringUtils.camelize;
import static org.openapitools.codegen.utils.StringUtils.underscore;

import java.io.File;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.BiPredicate;
import java.util.function.Function;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.StringUtils;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.openapitools.codegen.*;
import org.openapitools.codegen.CliOption;
import org.openapitools.codegen.CodegenConfig;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.CodegenConstants.ENUM_PROPERTY_NAMING_TYPE;
import org.openapitools.codegen.CodegenConstants.MODEL_PROPERTY_NAMING_TYPE;
import org.openapitools.codegen.CodegenConstants.PARAM_NAMING_TYPE;
import org.openapitools.codegen.meta.features.*;
import org.openapitools.codegen.CodegenModel;
import org.openapitools.codegen.CodegenOperation;
import org.openapitools.codegen.CodegenParameter;
import org.openapitools.codegen.CodegenProperty;
import org.openapitools.codegen.CodegenType;
import org.openapitools.codegen.DefaultCodegen;
import org.openapitools.codegen.GeneratorLanguage;
import org.openapitools.codegen.meta.features.ClientModificationFeature;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.meta.features.SchemaSupportFeature;
import org.openapitools.codegen.meta.features.SecurityFeature;
import org.openapitools.codegen.meta.features.WireFormatFeature;
import org.openapitools.codegen.model.ModelMap;
import org.openapitools.codegen.model.ModelsMap;
import org.openapitools.codegen.utils.ModelUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.function.BiPredicate;
import java.util.function.Function;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.form;
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.simple;
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
import static org.openapitools.codegen.utils.StringUtils.camelize;
import static org.openapitools.codegen.utils.StringUtils.underscore;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.parameters.Parameter;
import lombok.Getter;
import lombok.Setter;

public abstract class AbstractTypeScriptClientCodegen extends DefaultCodegen implements CodegenConfig {

Expand Down Expand Up @@ -1023,22 +1049,97 @@ protected void addImport(CodegenModel m, String type) {
}
}

/**
* Override to fix the inner enum naming issue for maps/arrays of enums.
* <p>
* The parent implementation uses toEnumName(baseItem) which produces a generic name
* like "InnerEnum" based on the inner item's name. This override first calculates
* the correct property.enumName, then uses it in the datatypeWithEnum replacement.
* </p>
*
* @param property Codegen property
*/
@Override
protected void updateDataTypeWithEnumForArray(CodegenProperty property) {
CodegenProperty baseItem = property.items;
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|| Boolean.TRUE.equals(baseItem.isArray))) {
baseItem = baseItem.items;
}

if (baseItem != null) {
// First, set the property's enumName using the property itself (not the inner item)
// This ensures the correct enum name (e.g., "OptionsEnum") is used
// instead of the generic inner item name (e.g., "InnerEnum")
property.enumName = toEnumName(property);

// Now use property.enumName for datatypeWithEnum
property.datatypeWithEnum = property.datatypeWithEnum.replace(baseItem.baseType, property.enumName);

// set default value for variable with inner enum
if (property.defaultValue != null) {
property.defaultValue = property.defaultValue.replace(baseItem.baseType, property.enumName);
}

updateCodegenPropertyEnum(property);
}
}

/**
* Override to fix the inner enum naming issue for map properties.
* <p>
* The parent implementation uses {@code toEnumName(baseItem)} which produces "InnerEnum"
* for properties whose inner item has a generic name like "inner". We instead
* calculate the enumName from the property itself first, then use it in the replacement.
* </p>
*
* @param property Codegen property
*/
@Override
protected void updateDataTypeWithEnumForMap(CodegenProperty property) {
CodegenProperty baseItem = property.items;
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|| Boolean.TRUE.equals(baseItem.isArray))) {
baseItem = baseItem.items;
}

if (baseItem != null) {
// First, set the property's enumName using the property itself (not the inner item)
property.enumName = toEnumName(property);

// Now use property.enumName for datatypeWithEnum instead of toEnumName(baseItem)
// This ensures the correct enum name (e.g., "ProjectRolesEnum") is used
// instead of the generic inner item name (e.g., "InnerEnum")
property.datatypeWithEnum = property.datatypeWithEnum.replace(baseItem.baseType + ">", property.enumName + ">");
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
Outdated

// set default value for variable with inner enum
if (property.defaultValue != null) {
property.defaultValue = property.defaultValue.replace(", " + property.items.baseType, ", " + property.enumName);
}

updateCodegenPropertyEnum(property);
}
}

@Override
public ModelsMap postProcessModels(ModelsMap objs) {
// process enum in models
List<ModelMap> models = postProcessModelsEnum(objs).getModels();
for (ModelMap mo : models) {
CodegenModel cm = mo.getModel();
cm.imports = new TreeSet<>(cm.imports);

// name enum with model name, e.g. StatusEnum => Pet.StatusEnum
// This applies to both direct enum properties (isEnum) and properties containing
// inner enums (isInnerEnum) like maps or arrays of enums.
for (CodegenProperty var : cm.vars) {
if (Boolean.TRUE.equals(var.isEnum)) {
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
var.datatypeWithEnum = var.datatypeWithEnum.replace(var.enumName, cm.classname + classEnumSeparator + var.enumName);
}
}
if (cm.parent != null) {
for (CodegenProperty var : cm.allVars) {
if (Boolean.TRUE.equals(var.isEnum)) {
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
var.datatypeWithEnum = var.datatypeWithEnum
.replace(var.enumName, cm.classname + classEnumSeparator + var.enumName);
}
Expand Down
12 changes: 8 additions & 4 deletions ...erator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,7 @@ protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, Sc

@Override
public ModelsMap postProcessModels(ModelsMap objs) {
// postProcessModelsEnum applies inner enum fixes via the parent class override
List<ModelMap> models = postProcessModelsEnum(objs).getModels();

// process enum and custom properties in models
Expand Down Expand Up @@ -800,7 +801,8 @@ private ExtendedCodegenModel processCodeGenModel(ExtendedCodegenModel cm) {
for (CodegenProperty cpVar : cm.allVars) {
ExtendedCodegenProperty var = (ExtendedCodegenProperty) cpVar;

if (Boolean.TRUE.equals(var.isEnum)) {
// Handle both direct enum properties and inner enums (maps/arrays of enums)
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Feb 5, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: Inner enum names can be double-prefixed for child properties when a model has a parent: processCodegenProperty already prefixes isInnerEnum, and the new inheritance loop prefixes isInnerEnum again on cm.allVars, which reuses the same property objects for child vars.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java, line 805:

<comment>Inner enum names can be double-prefixed for child properties when a model has a parent: processCodegenProperty already prefixes isInnerEnum, and the new inheritance loop prefixes isInnerEnum again on cm.allVars, which reuses the same property objects for child vars.</comment>

<file context>
@@ -800,7 +801,8 @@ private ExtendedCodegenModel processCodeGenModel(ExtendedCodegenModel cm) {
 
-                if (Boolean.TRUE.equals(var.isEnum)) {
+                // Handle both direct enum properties and inner enums (maps/arrays of enums)
+                if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
                     var.datatypeWithEnum = var.datatypeWithEnum
                             .replace(var.enumName, cm.classname + var.enumName);
</file context>
Fix with Cubic

Copy link
Copy Markdown
Contributor Author

@saxicek saxicek Feb 5, 2026

Choose a reason for hiding this comment

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

The concern about double-prefixing is theoretical but not an actual bug in practice. My investigation shows:

Why there's no double-prefix bug:

  1. For TypeScriptFetch: cm.parent is always null because TypeScriptFetchClientCodegen does NOT set supportsMultipleInheritance = true. The entire if (cm.parent != null) block is dead code.

  2. For generators that DO support inheritance (typescript-angular, etc.): When supportsMultipleInheritance = true, the cm.allVars collection contains COPIES of the properties, not references to the same object instances as cm.vars.

Therefore, modifying properties in cm.vars does not affect the (different) property objects in cm.allVars. Added commit 94499fa as a proof.

Comment thread
saxicek marked this conversation as resolved.
var.datatypeWithEnum = var.datatypeWithEnum
.replace(var.enumName, cm.classname + var.enumName);
}
Expand Down Expand Up @@ -845,7 +847,9 @@ private ExtendedCodegenModel processCodeGenModel(ExtendedCodegenModel cm) {

private boolean processCodegenProperty(ExtendedCodegenProperty var, String parentClassName, Object xEntityId) {
// name enum with model name, e.g. StatusEnum => PetStatusEnum
if (Boolean.TRUE.equals(var.isEnum)) {
// This applies to both direct enum properties (isEnum) and properties containing
// inner enums (isInnerEnum) like maps or arrays of enums.
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
// behaviour for enum names is specific for Typescript Fetch, not using namespaces
var.datatypeWithEnum = var.datatypeWithEnum.replace(var.enumName, parentClassName + var.enumName);

Expand Down Expand Up @@ -1525,11 +1529,11 @@ public class ExtendedCodegenModel extends CodegenModel {
public Set<CodegenProperty> oneOfPrimitives = new HashSet<>();
@Getter @Setter
public CodegenDiscriminator.MappedModel selfReferencingDiscriminatorMapping;

public boolean isEntity; // Is a model containing an "id" property marked as isUniqueId
public String returnPassthrough;
public boolean hasReturnPassthroughVoid;

public boolean hasSelfReferencingDiscriminatorMapping(){
return selfReferencingDiscriminatorMapping != null;
}
Expand Down
2 changes: 1 addition & 1 deletion ...les/openapi-generator/src/main/resources/typescript-fetch/modelGenericInterfaces.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
* @deprecated
{{/deprecated}}
*/
{{#isReadOnly}}readonly {{/isReadOnly}}{{name}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}};
{{#isReadOnly}}readonly {{/isReadOnly}}{{name}}{{^required}}?{{/required}}: {{{datatypeWithEnum}}}{{#isNullable}} | null{{/isNullable}};
{{/vars}}
}{{#hasEnums}}

Expand Down
95 changes: 83 additions & 12 deletions ...api-generator/src/test/java/org/openapitools/codegen/typescript/SharedTypeScriptTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
package org.openapitools.codegen.typescript;

import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.openapitools.codegen.ClientOptInput;
import org.openapitools.codegen.DefaultGenerator;
import org.openapitools.codegen.Generator;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.config.CodegenConfigurator;
import org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.testng.Assert;
import org.testng.annotations.Test;
import static org.openapitools.codegen.typescript.TypeScriptGroups.TYPESCRIPT;

import java.io.File;
import java.io.IOException;
Expand All @@ -21,8 +11,20 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import java.util.stream.Stream;

import static org.openapitools.codegen.typescript.TypeScriptGroups.TYPESCRIPT;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.openapitools.codegen.ClientOptInput;
import org.openapitools.codegen.DefaultGenerator;
import org.openapitools.codegen.Generator;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.config.CodegenConfigurator;
import org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.testng.Assert;
import org.testng.annotations.Test;

@Test(groups = {TYPESCRIPT})
public class SharedTypeScriptTest {
Expand Down Expand Up @@ -67,6 +69,24 @@ private void checkAPIFile(List<File> files, String apiFileName) throws IOExcepti
Assert.assertEquals(StringUtils.countMatches(apiFileContent, "import { GetCustomer200Response }"), 1);
}

private Path findModelDefinitionFile(Path root, Pattern modelPattern) throws IOException {
try (Stream<Path> paths = Files.walk(root)) {
return paths
.filter(Files::isRegularFile)
.filter(path -> path.toString().endsWith(".ts"))
.filter(path -> {
try {
String content = Files.readString(path);
return modelPattern.matcher(content).find();
} catch (IOException e) {
return false;
}
})
.findFirst()
.orElseThrow(() -> new IOException("Unable to locate model definition in " + root));
}
}

@Test
public void oldImportsStillPresentTest() throws IOException {
Path output = Files.createTempDirectory("test");
Expand Down Expand Up @@ -184,4 +204,55 @@ public void givenTypeMappingContainsGenericAndMappedTypeIsUtilityTypeThenTypeIsN
TestUtils.assertFileNotContains(axiosApiFile.toPath(), "AxiosPromise<UserSummary>");
}

@Test(description = "Issue #20877, #22747 - Maps/arrays of inner enums should use correct enum name")
public void givenMapWithArrayOfEnumsThenCorrectEnumNameIsUsed() throws Exception {
// This tests the fix for the issue where maps with array of enums generated
// "InnerEnum" type reference instead of the correct qualified enum name.
// The fix is in AbstractTypeScriptClientCodegen and applies to all TypeScript generators.
final String specPath = "src/test/resources/3_0/issue_19393_map_of_inner_enum.yaml";

List<String> generators = Arrays.asList(
"typescript",
"typescript-angular",
"typescript-axios",
"typescript-aurelia",
"typescript-fetch",
"typescript-inversify",
"typescript-jquery",
"typescript-nestjs",
"typescript-nestjs-server",
"typescript-node",
"typescript-redux-query",
"typescript-rxjs"
);

Pattern modelDefinition = Pattern.compile("\\b(interface|type|class)\\s+EmployeeWithMultiMapOfEnum\\b");
Pattern namespacedEnumRef = Pattern.compile("projectRoles[^\\n]*ProjectRolesEnum");
Pattern flatEnumRef = Pattern.compile("projectRoles[^\\n]*EmployeeWithMultiMapOfEnumProjectRolesEnum");

for (String generatorName : generators) {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();

CodegenConfigurator configurator = new CodegenConfigurator()
.setGeneratorName(generatorName)
.setInputSpec(specPath)
.setOutputDir(output.getAbsolutePath());

Generator generator = new DefaultGenerator();
generator.opts(configurator.toClientOptInput()).generate();

Path modelFile = findModelDefinitionFile(output.toPath(), modelDefinition);
String fileContents = Files.readString(modelFile);

Assert.assertFalse(fileContents.contains("InnerEnum"),
generatorName + ": Should not contain 'InnerEnum' reference in " + modelFile);

boolean hasEnumRef = namespacedEnumRef.matcher(fileContents).find()
|| flatEnumRef.matcher(fileContents).find();
Assert.assertTrue(hasEnumRef,
generatorName + ": Expected enum reference not found in " + modelFile);
}
}

}
Loading