Removed TypeScript utility type samples. Other reviews applied

Author: DavidGrath

bin/configs/typescript-fetch-utility-types-without-runtime.yaml

@@ -304,12 +304,13 @@ public AbstractTypeScriptClientCodegen() {
                 // Typescript reserved words
                 "abstract", "await", "boolean", "break", "byte", "case", "catch", "char", "class", "const", "continue", "debugger", "default", "delete", "do", "double", "else", "enum", "export", "extends", "false", "final", "finally", "float", "for", "function", "goto", "if", "implements", "import", "in", "instanceof", "int", "interface", "let", "long", "native", "new", "null", "package", "private", "protected", "public", "return", "short", "static", "super", "switch", "synchronized", "this", "throw", "transient", "true", "try", "typeof", "var", "void", "volatile", "while", "with", "yield"));
 
-        defaultIncludes = new HashSet<>(Arrays.asList(
-                //Utility types
+        Set<String> utilityTypes = new HashSet<>(Arrays.asList(
                 "Awaited","Partial","Required","Readonly","Record","Pick","Omit","Exclude","Extract","NonNullable",
                 "Parameters","ConstructorParameters","ReturnType","InstanceType","NoInfer","ThisParameterType",
-                "OmitThisParameter","ThisType","Uppercase","Lowercase","Capitalize","Uncapitalize"
-        ));
+                "OmitThisParameter","ThisType","Uppercase","Lowercase","Capitalize","Uncapitalize")
+        );
+        defaultIncludes = new HashSet<>();
+        defaultIncludes.addAll(utilityTypes);
 
         languageSpecificPrimitives = new HashSet<>(Arrays.asList(
                 "string",
@@ -330,12 +331,9 @@ public AbstractTypeScriptClientCodegen() {
                 "Error",
                 "Map",
                 "object",
-                "Set",
-                //Utility types
-                "Awaited","Partial","Required","Readonly","Record","Pick","Omit","Exclude","Extract","NonNullable",
-                "Parameters","ConstructorParameters","ReturnType","InstanceType","NoInfer","ThisParameterType",
-                "OmitThisParameter","ThisType","Uppercase","Lowercase","Capitalize","Uncapitalize"
+                "Set"
         ));
+        languageSpecificPrimitives.addAll(utilityTypes);
 
         languageGenericTypes = new HashSet<>(Collections.singletonList(
                 "Array"
@@ -816,14 +814,8 @@ public String getSchemaType(Schema p) {
             return openAPIType;
         } else if (typeMapping.containsKey(openAPIType)) {
             type = typeMapping.get(openAPIType);
-            String typeWithoutGeneric = null;
-            int genericIndex = type.indexOf("<");
-            if(genericIndex != -1) {
-                typeWithoutGeneric = type.substring(0, genericIndex);
-            }
-            if (languageSpecificPrimitives.contains(type)) {
-                return type;
-            } else if(typeWithoutGeneric != null && languageSpecificPrimitives.contains(typeWithoutGeneric)) {
+            String typeWithoutGeneric = typeWithoutGeneric(type);
+            if (languageSpecificPrimitives.contains(typeWithoutGeneric)) {
                 return type;
             }
         } else {
@@ -1177,9 +1169,12 @@ protected List<String> getTypesFromSchemas(List<Schema> schemas) {
 
     @Override
     protected boolean needToImport(String type) {
+        return super.needToImport(typeWithoutGeneric(type));
+    }
+
+    private String typeWithoutGeneric(String type) {
         int genericIndex = type.indexOf("<");
-        String typeWithoutGeneric = genericIndex != -1 ? type.substring(0, genericIndex) : type;
-        return super.needToImport(typeWithoutGeneric);
+        return genericIndex == -1 ? type : type.substring(0, genericIndex);
     }
 
     @Override

bin/configs/typescript-fetch-utility-types.yaml

@@ -1,9 +1,5 @@
 package org.openapitools.codegen.typescript;
 
-import lombok.Getter;
-import org.antlr.v4.runtime.*;
-import org.antlr.v4.runtime.tree.ParseTree;
-import org.antlr.v4.runtime.tree.ParseTreeWalker;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.openapitools.codegen.ClientOptInput;
@@ -26,7 +22,6 @@
 import java.util.List;
 import java.util.Map;
 
-import static org.openapitools.codegen.CodegenConstants.*;
 import static org.openapitools.codegen.typescript.TypeScriptGroups.TYPESCRIPT;
 
 @Test(groups = {TYPESCRIPT})
@@ -126,52 +121,64 @@ public void givenTypeMappingContainsGenericAndMappedTypeIsUtilityTypeThenTypeIsN
         File mainOutput = new File(output, "main");
 
         Generator generator = new DefaultGenerator();
-        CodegenConfigurator runtimeChecksConfigurator = new CodegenConfigurator()
+        CodegenConfigurator configurator = new CodegenConfigurator()
                 .setInputSpec("src/test/resources/3_1/issue_21317.yaml")
                 .setGeneratorName("typescript-fetch")
                 .addTypeMapping("object", "Record<string,unknown>")
                 .setOutputDir(mainOutput.getAbsolutePath());
-        ClientOptInput clientOptInput = runtimeChecksConfigurator.toClientOptInput();
+        ClientOptInput clientOptInput = configurator.toClientOptInput();
         generator.opts(clientOptInput)
                 .generate();
         String mainPath = mainOutput.getAbsolutePath();
         File userModel = new File(mainPath, "/models/User.ts");
-        String userModelContent = Files.readString(userModel.toPath());
 
         TestUtils.assertFileNotContains(userModel.toPath(), "Recordstringunknown");
         TestUtils.assertFileContains(userModel.toPath(), "Record<string,unknown>");
+    }
 
+    @Test(description = "Issue #21317")
+    public void givenTypeMappingContainsGenericAndMappedTypeIsUtilityAndWithoutRuntimeChecksTrueTypeThenTypeIsNotImportedAndTypeAppearsCorrectly() throws Exception {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
 
-        File noRuntimeOutput = new File(output, "noruntime");
+        Generator generator = new DefaultGenerator();
 
         CodegenConfigurator noRuntimeConfigurator = new CodegenConfigurator()
                 .setInputSpec("src/test/resources/3_1/issue_21317.yaml")
                 .setGeneratorName("typescript-fetch")
                 .addTypeMapping("object", "Record<string, unknown>")
                 .addTypeMapping("UserSummary", "Pick<User, \"email\">")
                 .addAdditionalProperty(TypeScriptFetchClientCodegen.WITHOUT_RUNTIME_CHECKS, true)
-                .setOutputDir(noRuntimeOutput.getAbsolutePath());
+                .setOutputDir(output.getAbsolutePath());
         ClientOptInput clientOptInput2 = noRuntimeConfigurator.toClientOptInput();
         generator.opts(clientOptInput2)
                 .generate();
-        String noRuntimePath = noRuntimeOutput.getAbsolutePath();
+        String noRuntimePath = output.getAbsolutePath();
         File apiFile = new File(noRuntimePath, "/apis/DefaultApi.ts");
-        String apiFileContent = Files.readString(apiFile.toPath());
+        System.out.println(Files.readString(apiFile.toPath()));
 
         TestUtils.assertFileContains(apiFile.toPath(), "Promise<Pick<User, \"email\">>");
         TestUtils.assertFileNotContains(apiFile.toPath(), "Promise<Pickuser");
+    }
 
 
+    @Test(description = "Issue #21317")
+    public void givenTypeMappingContainsGenericAndMappedTypeIsUtilityTypeThenTypeIsNotImportedAndTypeAppearsCorrectlyAxios() throws Exception {
 
-        File axiosOutputPath = new File(output, "axios");
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
 
-        runtimeChecksConfigurator.setGeneratorName("typescript-axios")
+        Generator generator = new DefaultGenerator();
+        CodegenConfigurator configurator = new CodegenConfigurator()
+                .setInputSpec("src/test/resources/3_1/issue_21317.yaml")
+                .setGeneratorName("typescript-axios")
                 .addTypeMapping("UserSummary", "Pick<User, \"email\">")
-                .setOutputDir(axiosOutputPath.getAbsolutePath());
-        generator.opts(runtimeChecksConfigurator.toClientOptInput())
+                .addTypeMapping("object", "Record<string,unknown>")
+                .setOutputDir(output.getAbsolutePath());
+        generator.opts(configurator.toClientOptInput())
                 .generate();
 
-        File axiosApiFile = new File(axiosOutputPath, "/api.ts");
+        File axiosApiFile = new File(output, "/api.ts");
 
         TestUtils.assertFileContains(axiosApiFile.toPath(), "AxiosPromise<Pick<User, \"email\">>");
         TestUtils.assertFileNotContains(axiosApiFile.toPath(), "AxiosPromise<UserSummary>");