[typescript-angular] fix: when model property name is sanitized, use instead original property name within quotes in mustache template (#19508)

* fix: typescript-angular -> when model property name is sanitized, use instead original property name within quotes in mustache template

* fix: updated samples

* chore: added comment for hasSanitizedName

* add original tag, add dummy model for test

* update samples

---------

Co-authored-by: Davide Diaconu <[email protected]>

Author: wing328

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java

@@ -243,6 +243,8 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
     private boolean hasDiscriminatorWithNonEmptyMapping;
     private CodegenComposedSchemas composedSchemas = null;
     private boolean hasMultipleTypes = false;
+    /** true if the property's baseName != name, e.g. baseName = '_prop.value', name = 'propValue' after sanitization */
+    private boolean hasSanitizedName = false;
     private Map<String, CodegenProperty> requiredVarsMap;
     private String ref;
     private boolean schemaIsFromAdditionalProperties;
@@ -843,6 +845,12 @@ public void setHasMultipleTypes(boolean hasMultipleTypes) {
         this.hasMultipleTypes = hasMultipleTypes;
     }
 
+    public boolean getHasSanitizedName() {
+        return hasSanitizedName;
+    }
+
+    public void setHasSanitizedName(boolean hasSanitizedName) { this.hasSanitizedName = hasSanitizedName; }
+
     @Override
     public boolean getIsUuid() {
         return isUuid;
@@ -1061,6 +1069,7 @@ public String toString() {
         sb.append(", getHasDiscriminatorWithNonEmptyMapping=").append(hasDiscriminatorWithNonEmptyMapping);
         sb.append(", composedSchemas=").append(composedSchemas);
         sb.append(", hasMultipleTypes=").append(hasMultipleTypes);
+        sb.append(", hasSanitizedName=").append(hasSanitizedName);
         sb.append(", requiredVarsMap=").append(requiredVarsMap);
         sb.append(", ref=").append(ref);
         sb.append(", schemaIsFromAdditionalProperties=").append(schemaIsFromAdditionalProperties);
@@ -1129,6 +1138,7 @@ public boolean equals(Object o) {
                 isNull == that.isNull &&
                 isVoid == that.isVoid &&
                 hasMultipleTypes == that.getHasMultipleTypes() &&
+                hasSanitizedName == that.getHasSanitizedName() &&
                 hasDiscriminatorWithNonEmptyMapping == that.hasDiscriminatorWithNonEmptyMapping &&
                 isBooleanSchemaTrue == that.getIsBooleanSchemaTrue() &&
                 isBooleanSchemaFalse == that.getIsBooleanSchemaFalse() &&
@@ -1207,7 +1217,7 @@ public int hashCode() {
                 vendorExtensions, hasValidation, isInherited, discriminatorValue, nameInPascalCase, nameInCamelCase,
                 nameInSnakeCase, enumName, maxItems, minItems, isXmlAttribute, xmlPrefix, xmlName,
                 xmlNamespace, isXmlWrapped, isNull, isVoid, additionalPropertiesIsAnyType, hasVars, hasRequired,
-                hasDiscriminatorWithNonEmptyMapping, composedSchemas, hasMultipleTypes, requiredVarsMap,
+                hasDiscriminatorWithNonEmptyMapping, composedSchemas, hasMultipleTypes, hasSanitizedName, requiredVarsMap,
                 ref, uniqueItemsBoolean, schemaIsFromAdditionalProperties, isBooleanSchemaTrue, isBooleanSchemaFalse,
                 format, dependentRequired, contains);
     }

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -3884,6 +3884,7 @@ public CodegenProperty fromProperty(String name, Schema p, boolean required, boo
 
         property.name = toVarName(name);
         property.baseName = name;
+        property.setHasSanitizedName(!property.baseName.equals(property.name));
         if (ModelUtils.getType(p) == null) {
             property.openApiType = getSchemaType(p);
         } else {

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

@@ -856,6 +856,7 @@ private String getNameUsingParamNaming(String name) {
     private String getNameUsingModelPropertyNaming(String name) {
         switch (getModelPropertyNaming()) {
             case original:
+                additionalProperties.put("modelPropertyNamingOriginal", true);
                 return name;
             case camelCase:
                 return camelize(name, LOWERCASE_FIRST_LETTER);

modules/openapi-generator/src/main/resources/typescript-angular/modelGeneric.mustache

@@ -13,6 +13,11 @@ export interface {{classname}}{{#allParents}}{{#-first}} extends {{/-first}}{{{.
     /** @deprecated */
     {{/deprecated}}
     {{/description}}
+    {{^modelPropertyNamingOriginal}}
     {{#isReadOnly}}readonly {{/isReadOnly}}{{{name}}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
+    {{/modelPropertyNamingOriginal}}
+    {{#modelPropertyNamingOriginal}}
+    {{#isReadOnly}}readonly {{/isReadOnly}}{{#hasSanitizedName}}'{{{baseName}}}'{{/hasSanitizedName}}{{^hasSanitizedName}}{{{name}}}{{/hasSanitizedName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
+    {{/modelPropertyNamingOriginal}}
 {{/vars}}
 }{{>modelGenericEnums}}

modules/openapi-generator/src/test/resources/3_0/typescript-angular/composed-schemas.yaml

@@ -26,6 +26,11 @@ paths:
 
 components:
   schemas:
+    Dummy:
+      type: object
+      properties:
+        property.name:
+          type: string
     DogBreed:
       type: string
       enum: [Dingo, Husky]

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/.openapi-generator/FILES

@@ -14,6 +14,7 @@ model/dogBreed.ts
 model/dogComposed.ts
 model/dogInherited.ts
 model/dogMapped.ts
+model/dummy.ts
 model/models.ts
 model/petWithMappedDiscriminator.ts
 model/petWithSimpleDiscriminator.ts

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/model/dummy.ts

@@ -0,0 +1,16 @@
+/**
+ * Schemas with different types of composition for testing models generation
+ *
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface DummyModel { 
+    'property.name'?: string;
+}
+
+

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/model/models.ts

@@ -5,6 +5,7 @@ export * from './dogBreed';
 export * from './dogComposed';
 export * from './dogInherited';
 export * from './dogMapped';
+export * from './dummy';
 export * from './petWithMappedDiscriminator';
 export * from './petWithSimpleDiscriminator';
 export * from './petWithoutDiscriminator';

samples/client/others/typescript-angular/builds/composed-schemas/.openapi-generator/FILES

@@ -14,6 +14,7 @@ model/dogBreed.ts
 model/dogComposed.ts
 model/dogInherited.ts
 model/dogMapped.ts
+model/dummy.ts
 model/models.ts
 model/petWithMappedDiscriminator.ts
 model/petWithSimpleDiscriminator.ts

samples/client/others/typescript-angular/builds/composed-schemas/model/dummy.ts

@@ -0,0 +1,15 @@
+/**
+ * Schemas with different types of composition for testing models generation
+ *
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface DummyModel { 
+    'property.name'?: string;
+}
+

samples/client/others/typescript-angular/builds/composed-schemas/model/models.ts

@@ -5,6 +5,7 @@ export * from './dogBreed';
 export * from './dogComposed';
 export * from './dogInherited';
 export * from './dogMapped';
+export * from './dummy';
 export * from './petWithMappedDiscriminator';
 export * from './petWithSimpleDiscriminator';
 export * from './petWithoutDiscriminator';