- Cleanup of templates

ferdikoomen · ferdikoomen · commit 923c141fdba7 · 2020-09-30T23:35:02.000+02:00
- Fixed File type for Node.js and Browser clients
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.5.0-beta",
+    "version": "0.5.0-rc",
     "description": "NodeJS library that generates Typescript or Javascript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
@@ -46,8 +46,6 @@
         "build": "rollup --config --environment NODE_ENV:development",
         "build:watch": "rollup --config --environment NODE_ENV:development --watch",
         "release": "rollup --config --environment NODE_ENV:production",
-        "start": "nest start --path ./test/server/tsconfig.json",
-        "start:watch": "nest start --path ./test/server/tsconfig.json --watch",
         "run": "node ./test/index.js",
         "test": "jest --selectProjects UNIT",
         "test:update": "jest --selectProjects UNIT --updateSnapshot",
diff --git a/src/openApi/v2/parser/constants.ts b/src/openApi/v2/parser/constants.ts
@@ -1,7 +1,7 @@
 export enum PrimaryType {
-    FILE = 'any', // File or Buffer?
+    FILE = 'File',
     OBJECT = 'any',
-    ARRAY = 'any',
+    ARRAY = 'any[]',
     BOOLEAN = 'boolean',
     NUMBER = 'number',
     STRING = 'string',
diff --git a/src/openApi/v2/parser/getMappedType.spec.ts b/src/openApi/v2/parser/getMappedType.spec.ts
@@ -2,7 +2,7 @@ import { getMappedType } from './getMappedType';
 
 describe('getMappedType', () => {
     it('should map types to the basics', () => {
-        expect(getMappedType('File')).toEqual('any');
+        expect(getMappedType('File')).toEqual('File');
         expect(getMappedType('String')).toEqual('string');
         expect(getMappedType('date')).toEqual('string');
         expect(getMappedType('date-time')).toEqual('string');
diff --git a/src/openApi/v3/parser/constants.ts b/src/openApi/v3/parser/constants.ts
@@ -1,5 +1,5 @@
 export enum PrimaryType {
-    FILE = 'any', // File or Buffer?
+    FILE = 'File',
     OBJECT = 'any',
     ARRAY = 'any[]',
     BOOLEAN = 'boolean',
diff --git a/src/openApi/v3/parser/getMappedType.spec.ts b/src/openApi/v3/parser/getMappedType.spec.ts
@@ -2,7 +2,7 @@ import { getMappedType } from './getMappedType';
 
 describe('getMappedType', () => {
     it('should map types to the basics', () => {
-        expect(getMappedType('File')).toEqual('any');
+        expect(getMappedType('File')).toEqual('File');
         expect(getMappedType('String')).toEqual('string');
         expect(getMappedType('date')).toEqual('string');
         expect(getMappedType('date-time')).toEqual('string');
diff --git a/src/templates/core/request.hbs b/src/templates/core/request.hbs
@@ -1,9 +1,3 @@
-{{#equals httpClient 'fetch'}}
-{{>fetch/request}}
-{{/equals}}
-{{#equals httpClient 'xhr'}}
-{{>xhr/request}}
-{{/equals}}
-{{#equals httpClient 'node'}}
-{{>node/request}}
-{{/equals}}
+{{#equals @root.httpClient 'fetch'}}{{>fetch/request}}{{/equals}}
+{{#equals @root.httpClient 'xhr'}}{{>xhr/request}}{{/equals}}
+{{#equals @root.httpClient 'node'}}{{>node/request}}{{/equals}}
diff --git a/src/templates/exportSchema.hbs b/src/templates/exportSchema.hbs
@@ -2,7 +2,7 @@
 {{#if extends}}
 
 {{#each extends}}
-import type { ${{{this}}} } from './${{{this}}}';
+import { ${{{this}}} } from './${{{this}}}';
 {{/each}}
 {{/if}}
 
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -37,45 +37,45 @@ export class {{{name}}} {
         const result = await __request({
             method: '{{{method}}}',
             path: `{{{path}}}`,
-            {{#if parametersCookie~}}
+            {{#if parametersCookie}}
             cookies: {
                 {{#each parametersCookie}}
                 '{{{prop}}}': {{{name}}},
                 {{/each}}
             },
             {{/if}}
-            {{#if parametersHeader~}}
+            {{#if parametersHeader}}
             headers: {
                 {{#each parametersHeader}}
                 '{{{prop}}}': {{{name}}},
                 {{/each}}
             },
             {{/if}}
-            {{#if parametersQuery~}}
+            {{#if parametersQuery}}
             query: {
                 {{#each parametersQuery}}
                 '{{{prop}}}': {{{name}}},
                 {{/each}}
             },
             {{/if}}
-            {{#if parametersForm~}}
+            {{#if parametersForm}}
             formData: {
                 {{#each parametersForm}}
                 '{{{prop}}}': {{{name}}},
                 {{/each}}
             },
             {{/if}}
-            {{#if parametersBody~}}
+            {{#if parametersBody}}
             body: {{{parametersBody.name}}},
             {{/if}}
-            {{#if responseHeader~}}
+            {{#if responseHeader}}
             responseHeader: '{{{responseHeader}}}',
             {{/if}}
-            {{#if errors~}}
+            {{#if errors}}
             errors: {
-            {{#each errors}}
+                {{#each errors}}
                 {{{code}}}: `{{{description}}}`,
-            {{/each}}
+                {{/each}}
             },
             {{/if}}
         });
diff --git a/src/templates/partials/base.hbs b/src/templates/partials/base.hbs
@@ -0,0 +1,7 @@
+{{~#equals this 'File'~}}
+{{~#equals @root.httpClient 'fetch'}}Blob{{/equals~}}
+{{~#equals @root.httpClient 'xhr'}}Blob{{/equals~}}
+{{~#equals @root.httpClient 'node'}}Buffer | ArrayBuffer | ArrayBufferView{{/equals~}}
+{{~else~}}
+{{this}}
+{{~/equals~}}
diff --git a/src/templates/partials/isRequired.hbs b/src/templates/partials/isRequired.hbs
@@ -1,5 +1,5 @@
-{{#if @root.useOptions}}
-{{~#unless isRequired}}?{{else if default}}?{{/unless~}}
-{{else}}
-{{~#unless isRequired}}{{#unless default}}?{{/unless}}{{/unless~}}
-{{/if}}
+{{~#if @root.useOptions~}}
+{{#unless isRequired}}?{{else if default}}?{{/unless}}
+{{~else~}}
+{{#unless isRequired}}{{#unless default}}?{{/unless}}{{/unless}}
+{{~/if~}}
diff --git a/src/templates/partials/parameters.hbs b/src/templates/partials/parameters.hbs
@@ -9,7 +9,7 @@
 {{{name}}}{{>isRequired}}: {{>type}},
 {{/each}}
 }
-{{~else}}
+{{else}}
 
 {{#each parameters}}
 {{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},
diff --git a/src/templates/partials/schemaArray.hbs b/src/templates/partials/schemaArray.hbs
@@ -1,12 +1,12 @@
 {
     type: 'Array',
-{{#if isReadOnly~}}
+{{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
 {{/if}}
-{{#if isRequired~}}
+{{#if isRequired}}
     isRequired: {{{isRequired}}},
 {{/if}}
-{{#if isNullable~}}
+{{#if isNullable}}
     isNullable: {{{isNullable}}},
 {{/if}}
 }
diff --git a/src/templates/partials/schemaDictionary.hbs b/src/templates/partials/schemaDictionary.hbs
@@ -1,12 +1,12 @@
 {
     type: 'Dictionary',
-{{#if isReadOnly~}}
+{{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
 {{/if}}
-{{#if isRequired~}}
+{{#if isRequired}}
     isRequired: {{{isRequired}}},
 {{/if}}
-{{#if isNullable~}}
+{{#if isNullable}}
     isNullable: {{{isNullable}}},
 {{/if}}
 }
diff --git a/src/templates/partials/schemaEnum.hbs b/src/templates/partials/schemaEnum.hbs
@@ -1,12 +1,12 @@
 {
     type: 'Enum',
-{{#if isReadOnly~}}
+{{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
 {{/if}}
-{{#if isRequired~}}
+{{#if isRequired}}
     isRequired: {{{isRequired}}},
 {{/if}}
-{{#if isNullable~}}
+{{#if isNullable}}
     isNullable: {{{isNullable}}},
 {{/if}}
 }
diff --git a/src/templates/partials/schemaGeneric.hbs b/src/templates/partials/schemaGeneric.hbs
@@ -1,56 +1,56 @@
 {
-{{#if type~}}
+{{#if type}}
     type: '{{{base}}}',
 {{/if}}
-{{#if isReadOnly~}}
+{{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
 {{/if}}
-{{#if isRequired~}}
+{{#if isRequired}}
     isRequired: {{{isRequired}}},
 {{/if}}
-{{#if isNullable~}}
+{{#if isNullable}}
     isNullable: {{{isNullable}}},
 {{/if}}
-{{#if format~}}
+{{#if format}}
     format: '{{{format}}}',
 {{/if}}
-{{#if maximum~}}
+{{#if maximum}}
     maximum: {{{maximum}}},
 {{/if}}
-{{#if exclusiveMaximum~}}
+{{#if exclusiveMaximum}}
     exclusiveMaximum: {{{exclusiveMaximum}}},
 {{/if}}
-{{#if minimum~}}
+{{#if minimum}}
     minimum: {{{minimum}}},
 {{/if}}
-{{#if exclusiveMinimum~}}
+{{#if exclusiveMinimum}}
     exclusiveMinimum: {{{exclusiveMinimum}}},
 {{/if}}
-{{#if multipleOf~}}
+{{#if multipleOf}}
     multipleOf: {{{multipleOf}}},
 {{/if}}
-{{#if maxLength~}}
+{{#if maxLength}}
     maxLength: {{{maxLength}}},
 {{/if}}
-{{#if minLength~}}
+{{#if minLength}}
     minLength: {{{minLength}}},
 {{/if}}
-{{#if pattern~}}
+{{#if pattern}}
     pattern: '{{{pattern}}}',
 {{/if}}
-{{#if maxItems~}}
+{{#if maxItems}}
     maxItems: {{{maxItems}}},
 {{/if}}
-{{#if minItems~}}
+{{#if minItems}}
     minItems: {{{minItems}}},
 {{/if}}
-{{#if uniqueItems~}}
+{{#if uniqueItems}}
     uniqueItems: {{{uniqueItems}}},
 {{/if}}
-{{#if maxProperties~}}
+{{#if maxProperties}}
     maxProperties: {{{maxProperties}}},
 {{/if}}
-{{#if minProperties~}}
+{{#if minProperties}}
     minProperties: {{{minProperties}}},
 {{/if}}
 }
diff --git a/src/templates/partials/schemaInterface.hbs b/src/templates/partials/schemaInterface.hbs
@@ -11,13 +11,13 @@
     {{/each}}
 {{/if}}
     },
-{{#if isReadOnly~}}
+{{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
 {{/if}}
-{{#if isRequired~}}
+{{#if isRequired}}
     isRequired: {{{isRequired}}},
 {{/if}}
-{{#if isNullable~}}
+{{#if isNullable}}
     isNullable: {{{isNullable}}},
 {{/if}}
 }
diff --git a/src/templates/partials/typeArray.hbs b/src/templates/partials/typeArray.hbs
@@ -1,5 +1,5 @@
 {{~#if link~}}
 Array<{{>type link}}>{{>isNullable}}
 {{~else~}}
-Array<{{{base}}}>{{>isNullable}}
+Array<{{>base base}}>{{>isNullable}}
 {{~/if~}}
diff --git a/src/templates/partials/typeDictionary.hbs b/src/templates/partials/typeDictionary.hbs
@@ -1,5 +1,5 @@
 {{~#if link~}}
 Record<string, {{>type link}}>{{>isNullable}}
 {{~else~}}
-Record<string, {{{base}}}>{{>isNullable}}
+Record<string, {{>base base}}>{{>isNullable}}
 {{~/if~}}
diff --git a/src/templates/partials/typeEnum.hbs b/src/templates/partials/typeEnum.hbs
@@ -1,13 +1,7 @@
 {{~#if @root.useUnionTypes~}}
-{{~#each enum~}}
-{{{value}}}{{#unless @last}} | {{/unless}}
-{{~/each~}}
-{{>isNullable}}
+{{#each enum}}{{{value}}}{{#unless @last}} | {{/unless}}{{/each}}{{>isNullable}}
 {{~else if parent~}}
 {{{parent}}}.{{{name}}}{{>isNullable}}
 {{~else~}}
-{{~#each enum~}}
-{{{value}}}{{#unless @last}} | {{/unless}}
-{{~/each~}}
-{{>isNullable}}
+{{#each enum}}{{{value}}}{{#unless @last}} | {{/unless}}{{/each}}{{>isNullable}}
 {{~/if~}}
diff --git a/src/templates/partials/typeGeneric.hbs b/src/templates/partials/typeGeneric.hbs
@@ -1 +1 @@
-{{{base}}}{{>isNullable}}
+{{>base base}}{{>isNullable}}
diff --git a/src/templates/partials/typeReference.hbs b/src/templates/partials/typeReference.hbs
@@ -1 +1 @@
-{{{base}}}{{>isNullable}}
+{{>base base}}{{>isNullable}}
diff --git a/src/utils/registerHandlebarHelpers.ts b/src/utils/registerHandlebarHelpers.ts
@@ -1,12 +1,12 @@
+// @ts-nocheck
+
 import * as Handlebars from 'handlebars/runtime';
 
 export function registerHandlebarHelpers(): void {
     Handlebars.registerHelper('equals', function (a: string, b: string, options: Handlebars.HelperOptions): string {
-        // @ts-ignore
         return a === b ? options.fn(this) : options.inverse(this);
     });
     Handlebars.registerHelper('notEquals', function (a: string, b: string, options: Handlebars.HelperOptions): string {
-        // @ts-ignore
         return a !== b ? options.fn(this) : options.inverse(this);
     });
 }
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -36,6 +36,7 @@ import templateExportModel from '../templates/exportModel.hbs';
 import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
 import templateIndex from '../templates/index.hbs';
+import partialBase from '../templates/partials/base.hbs';
 import partialExportEnum from '../templates/partials/exportEnum.hbs';
 import partialExportInterface from '../templates/partials/exportInterface.hbs';
 import partialExportType from '../templates/partials/exportType.hbs';
@@ -125,6 +126,7 @@ export function registerHandlebarTemplates(): Templates {
     Handlebars.registerPartial('typeGeneric', Handlebars.template(partialTypeGeneric));
     Handlebars.registerPartial('typeInterface', Handlebars.template(partialTypeInterface));
     Handlebars.registerPartial('typeReference', Handlebars.template(partialTypeReference));
+    Handlebars.registerPartial('base', Handlebars.template(partialBase));
 
     // Generic functions used in 'request' file @see src/templates/core/request.hbs for more info
     Handlebars.registerPartial('functions/catchErrors', Handlebars.template(functionCatchErrors));
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -16,7 +16,7 @@ import { writeClientServices } from './writeClientServices';
  * @param client Client object with all the models, services, etc.
  * @param templates Templates wrapper with all loaded Handlebars templates
  * @param output The relative ___location of the output directory
- * @param httpClient The selected httpClient (fetch or XHR)
+ * @param httpClient The selected httpClient (fetch, xhr or node)
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums
  * @param exportCore: Generate core client classes
@@ -56,17 +56,17 @@ export async function writeClient(
 
     if (exportServices) {
         await mkdir(outputPathServices);
-        await writeClientServices(client.services, templates, outputPathServices, useUnionTypes, useOptions);
+        await writeClientServices(client.services, templates, outputPathServices, httpClient, useUnionTypes, useOptions);
     }
 
     if (exportSchemas) {
         await mkdir(outputPathSchemas);
-        await writeClientSchemas(client.models, templates, outputPathSchemas, useUnionTypes);
+        await writeClientSchemas(client.models, templates, outputPathSchemas, httpClient, useUnionTypes);
     }
 
     if (exportModels) {
         await mkdir(outputPathModels);
-        await writeClientModels(client.models, templates, outputPathModels, useUnionTypes);
+        await writeClientModels(client.models, templates, outputPathModels, httpClient, useUnionTypes);
     }
 
     await writeClientIndex(client, templates, outputPath, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas);
diff --git a/src/utils/writeClientModels.ts b/src/utils/writeClientModels.ts
diff --git a/src/utils/writeClientSchemas.ts b/src/utils/writeClientSchemas.ts
diff --git a/src/utils/writeClientServices.ts b/src/utils/writeClientServices.ts
diff --git a/test/__snapshots__/index.spec.js.snap b/test/__snapshots__/index.spec.js.snap
diff --git a/test/e2e/scripts/compile.js b/test/e2e/scripts/compile.js
diff --git a/test/e2e/v2.fetch.spec.js b/test/e2e/v2.fetch.spec.js
diff --git a/test/e2e/v2.xhr.spec.js b/test/e2e/v2.xhr.spec.js
diff --git a/test/e2e/v3.fetch.spec.js b/test/e2e/v3.fetch.spec.js
diff --git a/test/e2e/v3.xhr.spec.js b/test/e2e/v3.xhr.spec.js
diff --git a/tsconfig.json b/tsconfig.json
