chore: openapi-generator 의 몇몇 옵션값을 cherry-pick 합니다 (#10)

* feat(openapi): bfc784e

openapi-generator 8에 들어가게되는 OpenAPITools#18531 를 채리픽 합니다.

* fix(typescript-client): TypeScript Client 의 codegen 이 'from' 을 예약어 취급해서 제네래이션을 막는 버그 수정

* chore: example update

* chore: docsgen 누락 수정

* fix: 기본값수정

* chore: test 누락 수정

* fix: whatwg-fetch 의존성 제거

full-context: 현제 니즈에서는 whatwg-fetch 만을 포함할수 있는 상황도 아니며 재품 기준에서 처리하기 어려움

* fix(openapi-typescript): auth methods configuration 타입젠이 잘못된 securitySchemes 를 만나면 타입의 값이 비어버리는 버그 픽스

* chore: update diff

Author: CreeJee

bin/configs/typescript-consolidated-browser.yaml

@@ -8,3 +8,4 @@ additionalProperties:
   projectName: ts-petstore-client
   moduleName: petstore
   supportsES6: true
+  enumType: stringUnion

bin/configs/typescript-consolidated-deno.yaml

@@ -7,3 +7,4 @@ additionalProperties:
   npmName: ts-petstore-client
   projectName: ts-petstore-client
   moduleName: petstore
+  enumType: stringUnion

bin/configs/typescript-consolidated-jquery.yaml

@@ -7,3 +7,4 @@ additionalProperties:
   npmName: ts-petstore-client
   projectName: ts-petstore-client
   moduleName: petstore
+  enumType: stringUnion

bin/configs/typescript-consolidated-node-object-parameters.yaml

@@ -8,3 +8,4 @@ additionalProperties:
   useObjectParameters: true
   projectName: ts-petstore-client
   moduleName: petstore
+  enumType: stringUnion

docs/generators/typescript.md

@@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |PascalCase|
 |enumPropertyNamingReplaceSpecialChar|Set to true to replace '-' and '+' symbols with 'minus_' and 'plus_' in enum of type string| |false|
+|enumType|Specify the enum type which should be used in the client code.|<dl><dt>**stringUnion**</dt><dd>Union of literal string types</dd><dt>**enum**</dt><dd>Typescript's [string enums](https://www.typescriptlang.org/docs/handbook/enums.html#string-enums)</dd></dl>|enum|
 |enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
 |fileContentDataType|Specifies the type to use for the content of a file - i.e. Blob (Browser, Deno) / Buffer (node)| |Buffer|
 |framework|Specify the framework which should be used in the client code.|<dl><dt>**fetch-api**</dt><dd>fetch-api</dd><dt>**jquery**</dt><dd>jquery</dd></dl>|fetch-api|
@@ -136,7 +137,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <li>float</li>
 <li>for</li>
 <li>formParams</li>
-<li>from</li>
 <li>function</li>
 <li>goto</li>
 <li>headerParams</li>

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

@@ -26,6 +26,7 @@
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
+import io.swagger.v3.oas.models.security.SecurityScheme;
 import lombok.Getter;
 import lombok.Setter;
 import org.apache.commons.lang3.StringUtils;
@@ -81,6 +82,10 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
     public static final String USE_ERASABLE_SYNTAX = "useErasableSyntax";
     public static final String USE_ERASABLE_SYNTAX_DESC = "Use erasable syntax for the generated code. This is a temporary feature and will be removed in the future.";
 
+    private static final String ENUM_TYPE_SWITCH = "enumType";
+    private static final String ENUM_TYPE_SWITCH_DESC = "Specify the enum type which should be used in the client code.";
+    private static final String[][] ENUM_TYPES = {{"stringUnion", "Union of literal string types"}, {"enum", "Typescript's [string enums](https://www.typescriptlang.org/docs/handbook/enums.html#string-enums)"}};
+    
     private final Map<String, String> frameworkToHttpLibMap;
 
     @Setter
@@ -118,8 +123,6 @@ public TypeScriptClientCodegen() {
 
         // NOTE: TypeScript uses camel cased reserved words, while models are title cased. We don't want lowercase comparisons.
         reservedWords.addAll(Arrays.asList(
-                // local variable names used in API methods (endpoints)
-                "from",
                 // Typescript reserved words
                 "constructor"));
 
@@ -149,6 +152,13 @@ public TypeScriptClientCodegen() {
 
         cliOptions.add(platformOption);
 
+        CliOption enumTypeOption = new CliOption(TypeScriptClientCodegen.ENUM_TYPE_SWITCH, TypeScriptClientCodegen.ENUM_TYPE_SWITCH_DESC);
+        for (String[] option : TypeScriptClientCodegen.ENUM_TYPES) {
+            enumTypeOption.addEnum(option[0], option[1]);
+        }
+        enumTypeOption.defaultValue(ENUM_TYPES[1][0]);
+        cliOptions.add(enumTypeOption);
+
         // Set property naming to camelCase
         supportModelPropertyNaming(CodegenConstants.MODEL_PROPERTY_NAMING_TYPE.camelCase);
 
@@ -402,6 +412,14 @@ public ModelsMap postProcessModels(ModelsMap objs) {
         return objs;
     }
 
+    @Override
+    public List<CodegenSecurity> fromSecurity(Map<String, SecurityScheme> schemes) {
+        List<CodegenSecurity> securities = super.fromSecurity(schemes);
+
+        securities.removeIf(security ->!security.isApiKey && !security.isBasicBasic && !security.isBasicBearer && !security.isOAuth && !security.isHttpSignature);
+        return securities;
+    }
+
     @Override
     public String apiDocFileFolder() {
         return (outputFolder + "/" + apiDocPath).replace('/', File.separatorChar);
@@ -450,6 +468,15 @@ public void processOpts() {
                 "http", httpLibName + ".ts"
         ));
 
+        additionalProperties.putIfAbsent(ENUM_TYPE_SWITCH, ENUM_TYPES[1][0]);
+        Object propEnumType = additionalProperties.get(ENUM_TYPE_SWITCH);
+
+        Map<String, Boolean> enumTypes = new HashMap<>();
+        for (String[] option : ENUM_TYPES) {
+            enumTypes.put(option[0], option[0].equals(propEnumType));
+        }
+        additionalProperties.put("enumTypes", enumTypes);
+
         Object propPlatform = additionalProperties.get(PLATFORM_SWITCH);
         if (propPlatform == null) {
             propPlatform = "browser";

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

@@ -24,6 +24,7 @@
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
+import io.swagger.v3.oas.models.security.SecurityScheme;
 import io.swagger.v3.oas.models.servers.Server;
 import io.swagger.v3.parser.util.SchemaTypeUtil;
 import lombok.Getter;
@@ -408,6 +409,14 @@ public void postProcessParameter(CodegenParameter parameter) {
         }
     }
 
+    @Override
+    public List<CodegenSecurity> fromSecurity(Map<String, SecurityScheme> schemes) {
+        List<CodegenSecurity> securities = super.fromSecurity(schemes);
+
+        securities.removeIf(security ->!security.isApiKey && !security.isBasicBasic && !security.isBasicBearer && !security.isOAuth && !security.isHttpSignature);
+        return securities;
+    }
+    
     @Override
     public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs) {
         List<ExtendedCodegenModel> allModels = new ArrayList<>();

modules/openapi-generator/src/main/resources/typescript/http/isomorphic-fetch.mustache

@@ -5,7 +5,7 @@ import { from, Observable } from {{#useRxJS}}'rxjs'{{/useRxJS}}{{^useRxJS}}'../r
 import fetch from "node-fetch";
 {{/node}}
 {{#browser}}
-import "whatwg-fetch";
+//import "whatwg-fetch"; 추가 의존성을 재거하는 방향으로 수정
 {{/browser}}
 {{/platforms}}
 

modules/openapi-generator/src/main/resources/typescript/model/model.mustache

@@ -89,27 +89,41 @@ export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
 
 {{#vars}}
 {{#isEnum}}
+{{#enumTypes}}
+{{#enum}}
 export enum {{classname}}{{enumName}} {
     {{#allowableValues}}
     {{#enumVars}}
     {{name}} = {{{value}}}{{^-last}},{{/-last}}
     {{/enumVars}}
     {{/allowableValues}}
 }
+{{/enum}}
+{{#stringUnion}}
+    export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
+{{/stringUnion}}
+{{/enumTypes}}
 {{/isEnum}}
 {{/vars}}
 
 {{/hasEnums}}
 {{/oneOf}}
 {{/isEnum}}
 {{#isEnum}}
+{{#enumTypes}}
+{{#enum}}
 export enum {{classname}} {
     {{#allowableValues}}
     {{#enumVars}}
     {{name}} = {{{value}}}{{^-last}},{{/-last}}
     {{/enumVars}}
     {{/allowableValues}}
 }
+{{/enum}}
+{{#stringUnion}}
+    export type {{classname}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
+{{/stringUnion}}
+{{/enumTypes}}
 {{/isEnum}}
 {{/model}}
 {{/models}}

modules/openapi-generator/src/main/resources/typescript/package.mustache

@@ -50,7 +50,6 @@
     "@types/node-fetch": "^2.6.13",
           {{/node}}
           {{#browser}}
-    "whatwg-fetch": "^3.0.0",
           {{/browser}}
         {{/platforms}}
       {{/fetch-api}}