[Typescript][Fetch] Fix bugs with new typescript-fetch generator (#1545)

* [Typescript][Fetch] Always initialize queryParameters * [Typescript][Fetch] Resolve date and date-time formats to parameter type Date * [Typescript][Fetch] Update models template - Add `readonly` modifier to readOnly parameters. - Omit readOnly parameters from requests when serializing models - Use allVars in models template when serializing/deserializing requests * [Typescript][Fetch] Omit time component when parameter format: date * [Typescript][Fetch] Add moduleResolution: node option to tsconfig.json * [Typescript][Fetch] Added non-model enums
OpenAPITools · Dec 6, 2018 · 1e023f3 · 1e023f3
1 parent 6976a8c
commit 1e023f3
Show file tree

Hide file tree

Showing 29 changed files with 708 additions and 35 deletions.
diff --git a/...erator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java b/...erator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java
@@ -22,6 +22,8 @@
 import io.swagger.v3.parser.util.SchemaTypeUtil;
 import org.openapitools.codegen.CliOption;
 import org.openapitools.codegen.CodegenModel;
+import org.openapitools.codegen.CodegenOperation;
+import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenConstants;
 import org.openapitools.codegen.SupportingFile;
 import org.openapitools.codegen.CodegenConstants.MODEL_PROPERTY_NAMING_TYPE;
@@ -132,9 +134,12 @@ public String getTypeDeclaration(Schema p) {
             return "Blob";
         } else if (ModelUtils.isBinarySchema(p)) {
             return "Blob";
-        } else {
-            return super.getTypeDeclaration(p);
+        } else if (ModelUtils.isDateSchema(p)) {
+            return "Date";
+        } else if (ModelUtils.isDateTimeSchema(p)) {
+            return "Date";
         }
+        return super.getTypeDeclaration(p);
     }
 
     @Override
@@ -183,6 +188,7 @@ private void addNpmPackageGeneration() {
     @Override
     public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> operations, List<Object> allModels) {
         this.addOperationModelImportInfomation(operations);
+        this.updateOperationParameterEnumInformation(operations);
         return operations;
     }
 
@@ -196,6 +202,25 @@ private void addOperationModelImportInfomation(Map<String, Object> operations) {
         }
     }
 
+    private void updateOperationParameterEnumInformation(Map<String, Object> operations) {
+        // This method will add extra infomation as to whether or not we have enums and
+        // update their names with the operation.id prefixed.
+        Map<String, Object> _operations = (Map<String, Object>) operations.get("operations");
+        List<CodegenOperation> operationList = (List<CodegenOperation>) _operations.get("operation");
+        boolean hasEnum = false;
+        for (CodegenOperation op : operationList) {
+            for (CodegenParameter param : op.allParams) {
+                if (Boolean.TRUE.equals(param.isEnum)) {
+                    hasEnum = true;
+                    param.datatypeWithEnum = param.datatypeWithEnum
+                            .replace(param.enumName, op.operationIdCamelCase + param.enumName);
+                }
+            }
+        }
+
+        operations.put("hasEnums", hasEnum);
+    }
+
     private void addExtraReservedWords() {
         this.reservedWords.add("BASE_PATH");
         this.reservedWords.add("BaseAPI");

diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache
@@ -17,7 +17,7 @@ import {
 {{#allParams.0}}
 export interface {{operationIdCamelCase}}Request {
     {{#allParams}}
-    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}};
+    {{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}};
     {{/allParams}}
 }
 
@@ -48,10 +48,8 @@ export class {{classname}} extends runtime.BaseAPI {
 
         {{/required}}
         {{/allParams}}
-        {{#hasQueryParams}}
         const queryParameters: runtime.HTTPQuery = {};
 
-        {{/hasQueryParams}}
         {{#queryParams}}
         {{#isListContainer}}
         if (requestParameters.{{paramName}}) {
@@ -168,9 +166,7 @@ export class {{classname}} extends runtime.BaseAPI {
             path: `{{{path}}}`{{#pathParams}}.replace(`{${"{{baseName}}"}}`, encodeURIComponent(String(requestParameters.{{paramName}}))){{/pathParams}},
             method: '{{httpMethod}}',
             headers: headerParameters,
-            {{#hasQueryParams}}
             query: queryParameters,
-            {{/hasQueryParams}}
             {{#hasBodyParam}}
             {{#bodyParam}}
             {{#isContainer}}
@@ -243,3 +239,25 @@ export class {{classname}} extends runtime.BaseAPI {
     {{/operation}}
 }
 {{/operations}}
+{{#hasEnums}}
+
+{{#operations}}
+{{#operation}}
+{{#allParams}}
+{{#isEnum}}
+/**
+    * @export
+    * @enum {string}
+    */
+export enum {{operationIdCamelCase}}{{enumName}} {
+{{#allowableValues}}
+    {{#enumVars}}
+    {{{name}}} = {{{value}}}{{^-last}},{{/-last}}
+    {{/enumVars}}
+{{/allowableValues}}
+}
+{{/isEnum}}
+{{/allParams}}
+{{/operation}}
+{{/operations}}
+{{/hasEnums}}
diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/modelGeneric.mustache
@@ -24,14 +24,14 @@ export interface {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{
      * @type {{=<% %>=}}{<%&datatype%>}<%={{ }}=%>
      * @memberof {{classname}}
      */
-    {{name}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}};
+    {{#isReadOnly}}readonly {{/isReadOnly}}{{name}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}};
 {{/vars}}
 }
 
 export function {{classname}}FromJSON(json: any): {{classname}} {
     {{#hasVars}}
     return {
-        {{#vars}}
+        {{#allVars}}
         {{#isPrimitiveType}}
         {{#isDate}}
         '{{name}}': {{^required}}!exists(json, '{{baseName}}') ? undefined : {{/required}}new Date(json['{{baseName}}']),
@@ -53,7 +53,7 @@ export function {{classname}}FromJSON(json: any): {{classname}} {
         '{{name}}': {{^required}}!exists(json, '{{baseName}}') ? undefined : {{/required}}{{datatype}}FromJSON(json['{{baseName}}']),
         {{/isContainer}}
         {{/isPrimitiveType}}
-        {{/vars}}
+        {{/allVars}}
     };
     {{/hasVars}}
     {{^hasVars}}
@@ -67,9 +67,10 @@ export function {{classname}}ToJSON(value?: {{classname}}): any {
         return undefined;
     }
     return {
-        {{#vars}}
+        {{#allVars}}
+        {{^isReadOnly}}
         {{#isPrimitiveType}}
-        '{{baseName}}': {{#isDate}}{{^required}}value.{{name}} === undefined ? undefined : {{/required}}value.{{name}}.toISOString(){{/isDate}}{{#isDateTime}}{{^required}}value.{{name}} === undefined ? undefined : {{/required}}value.{{name}}.toISOString(){{/isDateTime}}{{^isDate}}{{^isDateTime}}value.{{name}}{{/isDateTime}}{{/isDate}},
+        '{{baseName}}': {{#isDate}}{{^required}}value.{{name}} === undefined ? undefined : {{/required}}value.{{name}}.toISOString().substr(0,10){{/isDate}}{{#isDateTime}}{{^required}}value.{{name}} === undefined ? undefined : {{/required}}value.{{name}}.toISOString(){{/isDateTime}}{{^isDate}}{{^isDateTime}}value.{{name}}{{/isDateTime}}{{/isDate}},
         {{/isPrimitiveType}}
         {{^isPrimitiveType}}
         {{#isContainer}}
@@ -79,7 +80,8 @@ export function {{classname}}ToJSON(value?: {{classname}}): any {
         '{{baseName}}': {{datatype}}ToJSON(value.{{name}}),
         {{/isContainer}}
         {{/isPrimitiveType}}
-        {{/vars}}
+        {{/isReadOnly}}
+        {{/allVars}}
     };
     {{/hasVars}}
     {{^hasVars}}

diff --git a/modules/openapi-generator/src/main/resources/typescript-fetch/tsconfig.mustache b/modules/openapi-generator/src/main/resources/typescript-fetch/tsconfig.mustache
@@ -3,6 +3,7 @@
     "declaration": true,
     "target": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}es5{{/supportsES6}}",
     "module": "commonjs",
+    "moduleResolution": "node",
     "outDir": "dist",
     "rootDir": "."{{^supportsES6}},
     "lib": [

diff --git a/...tor/src/test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchModelTest.java b/...tor/src/test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchModelTest.java
@@ -102,7 +102,7 @@ public void simpleModelTest() {
         final CodegenProperty property4 = cm.vars.get(3);
         Assert.assertEquals(property4.baseName, "birthDate");
         Assert.assertEquals(property4.complexType, null);
-        Assert.assertEquals(property4.dataType, "string");
+        Assert.assertEquals(property4.dataType, "Date");
         Assert.assertEquals(property4.name, "birthDate");
         Assert.assertEquals(property4.defaultValue, "undefined");
         Assert.assertFalse(property4.hasMore);

diff --git a/samples/client/petstore-security-test/typescript-fetch/.openapi-generator/VERSION b/samples/client/petstore-security-test/typescript-fetch/.openapi-generator/VERSION
@@ -1 +1 @@
-3.1.2-SNAPSHOT
+4.0.0-SNAPSHOT
diff --git a/samples/client/petstore-security-test/typescript-fetch/apis/FakeApi.ts b/samples/client/petstore-security-test/typescript-fetch/apis/FakeApi.ts
@@ -0,0 +1,61 @@
+// tslint:disable
+/**
+ * OpenAPI Petstore *_/ ' \" =end -- \\r\\n \\n \\r
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end --       
+ *
+ * OpenAPI spec version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
+ * Contact: something@something.abc *_/ ' \" =end -- \\r\\n \\n \\r
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    UNKNOWN_BASE_TYPE,
+    UNKNOWN_BASE_TYPEFromJSON,
+    UNKNOWN_BASE_TYPEToJSON,
+} from '../models';
+
+export interface TestCodeInjectEndRnNRRequest {
+    UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE;
+}
+
+/**
+ * no description
+ */
+export class FakeApi extends runtime.BaseAPI {
+
+    /**
+     * To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
+     * To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
+     */
+    async testCodeInjectEndRnNRRaw(requestParameters: TestCodeInjectEndRnNRRequest): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: runtime.HTTPQuery = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/fake`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UNKNOWN_BASE_TYPEToJSON(requestParameters.UNKNOWN_BASE_TYPE),
+        });
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
+     * To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
+     */
+    async testCodeInjectEndRnNR(requestParameters: TestCodeInjectEndRnNRRequest): Promise<void> {
+        await this.testCodeInjectEndRnNRRaw(requestParameters);
+    }
+
+}
diff --git a/samples/client/petstore-security-test/typescript-fetch/apis/index.ts b/samples/client/petstore-security-test/typescript-fetch/apis/index.ts
@@ -0,0 +1 @@
+export * from './FakeApi';
diff --git a/samples/client/petstore-security-test/typescript-fetch/index.ts b/samples/client/petstore-security-test/typescript-fetch/index.ts
@@ -1,16 +1,3 @@
-// tslint:disable
-/**
- * OpenAPI Petstore *_/ ' \" =end -- \\r\\n \\n \\r
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end --       
- *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
- * Contact: something@something.abc *_/ ' \" =end -- \\r\\n \\n \\r
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export * from "./api";
-export * from "./configuration";
+export * from './runtime';
+export * from './apis';
+export * from './models';
diff --git a/samples/client/petstore-security-test/typescript-fetch/models/Return.ts b/samples/client/petstore-security-test/typescript-fetch/models/Return.ts
@@ -0,0 +1,44 @@
+// tslint:disable
+/**
+ * OpenAPI Petstore *_/ ' \" =end -- \\r\\n \\n \\r
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end --       
+ *
+ * OpenAPI spec version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
+ * Contact: something@something.abc *_/ ' \" =end -- \\r\\n \\n \\r
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists } from '../runtime';
+/**
+ * Model for testing reserved words  *_/ ' \" =end -- \\r\\n \\n \\r
+ * @export
+ * @interface Return
+ */
+export interface Return {
+    /**
+     * property description  *_/ ' \" =end -- \\r\\n \\n \\r
+     * @type {number}
+     * @memberof Return
+     */
+    _return?: number;
+}
+
+export function ReturnFromJSON(json: any): Return {
+    return {
+        '_return': !exists(json, 'return') ? undefined : json['return'],
+    };
+}
+
+export function ReturnToJSON(value?: Return): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    return {
+        'return': value._return,
+    };
+}
+
+
diff --git a/samples/client/petstore-security-test/typescript-fetch/models/index.ts b/samples/client/petstore-security-test/typescript-fetch/models/index.ts
@@ -0,0 +1 @@
+export * from './Return';