Added a clientService that will generate the client SDK files

matt-aitken · matt-aitken · commit 52fbebe2839f · 2022-07-15T18:01:59.000+01:00
diff --git a/src/templates/exportClientService.hbs b/src/templates/exportClientService.hbs
@@ -0,0 +1,102 @@
+{{>header}}
+
+{{#if imports}}
+{{#each imports}}
+import type { {{{this}}} } from '../models/{{{this}}}';
+{{/each}}
+{{/if}}
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class {{{name}}}{{{@root.postfix}}} {
+
+	{{#each operations}}
+	/**
+	{{#if deprecated}}
+	 * @deprecated
+	{{/if}}
+	{{#if summary}}
+	 * {{{escapeComment summary}}}
+	{{/if}}
+	{{#if description}}
+	 * {{{escapeComment description}}}
+	{{/if}}
+	{{#unless @root.useOptions}}
+	{{#if parameters}}
+	{{#each parameters}}
+	 * @param {{{name}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+	{{/each}}
+	{{/if}}
+	{{/unless}}
+	{{#each results}}
+	 * @returns {{{type}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+	{{/each}}
+	 * @throws ApiError
+	 */
+	public static {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+		return __request(OpenAPI, {
+			method: '{{{method}}}',
+			url: '{{{path}}}',
+			{{#if parametersPath}}
+			path: {
+				{{#each parametersPath}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersCookie}}
+			cookies: {
+				{{#each parametersCookie}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersHeader}}
+			headers: {
+				{{#each parametersHeader}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersQuery}}
+			query: {
+				{{#each parametersQuery}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersForm}}
+			formData: {
+				{{#each parametersForm}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersBody}}
+			{{#equals parametersBody.in 'formData'}}
+			formData: {{{parametersBody.name}}},
+			{{/equals}}
+			{{#equals parametersBody.in 'body'}}
+			body: {{{parametersBody.name}}},
+			{{/equals}}
+			{{#if parametersBody.mediaType}}
+			mediaType: '{{{parametersBody.mediaType}}}',
+			{{/if}}
+			{{/if}}
+			{{#if responseHeader}}
+			responseHeader: '{{{responseHeader}}}',
+			{{/if}}
+			{{#if errors}}
+			errors: {
+				{{#each errors}}
+				{{{code}}}: `{{{escapeDescription description}}}`,
+				{{/each}}
+			},
+			{{/if}}
+		});
+	}
+
+	{{/each}}
+}
diff --git a/src/utils/registerHandlebarTemplates.spec.ts b/src/utils/registerHandlebarTemplates.spec.ts
@@ -12,6 +12,7 @@ describe('registerHandlebarTemplates', () => {
         expect(templates.exports.model).toBeDefined();
         expect(templates.exports.schema).toBeDefined();
         expect(templates.exports.service).toBeDefined();
+        expect(templates.exports.clientService).toBeDefined();
         expect(templates.core.settings).toBeDefined();
         expect(templates.core.apiError).toBeDefined();
         expect(templates.core.apiRequestOptions).toBeDefined();
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -52,6 +52,7 @@ import xhrGetResponseBody from '../templates/core/xhr/getResponseBody.hbs';
 import xhrGetResponseHeader from '../templates/core/xhr/getResponseHeader.hbs';
 import xhrRequest from '../templates/core/xhr/request.hbs';
 import xhrSendRequest from '../templates/core/xhr/sendRequest.hbs';
+import templateExportClientService from '../templates/exportClientService.hbs';
 import templateExportModel from '../templates/exportModel.hbs';
 import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
@@ -92,6 +93,7 @@ export interface Templates {
         model: Handlebars.TemplateDelegate;
         schema: Handlebars.TemplateDelegate;
         service: Handlebars.TemplateDelegate;
+        clientService: Handlebars.TemplateDelegate;
     };
     core: {
         settings: Handlebars.TemplateDelegate;
@@ -124,6 +126,7 @@ export const registerHandlebarTemplates = (root: {
             model: Handlebars.template(templateExportModel),
             schema: Handlebars.template(templateExportSchema),
             service: Handlebars.template(templateExportService),
+            clientService: Handlebars.template(templateExportClientService),
         },
         core: {
             settings: Handlebars.template(templateCoreSettings),
diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -23,6 +23,7 @@ describe('writeClient', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -13,6 +13,7 @@ import { writeClientIndex } from './writeClientIndex';
 import { writeClientModels } from './writeClientModels';
 import { writeClientSchemas } from './writeClientSchemas';
 import { writeClientServices } from './writeClientServices';
+import { writeUserClientServices } from './writeUserClientServices';
 
 /**
  * Write our OpenAPI client, using the given templates at the given output
@@ -78,6 +79,17 @@ export const writeClient = async (
             postfix,
             clientName
         );
+        await writeUserClientServices(
+            client.services,
+            templates,
+            outputPathServices,
+            httpClient,
+            useUnionTypes,
+            useOptions,
+            indent,
+            postfix,
+            clientName
+        );
     }
 
     if (exportSchemas) {
diff --git a/src/utils/writeClientClass.spec.ts b/src/utils/writeClientClass.spec.ts
@@ -23,6 +23,7 @@ describe('writeClientClass', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeClientCore.spec.ts b/src/utils/writeClientCore.spec.ts
@@ -25,6 +25,7 @@ describe('writeClientCore', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -21,6 +21,7 @@ describe('writeClientIndex', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeClientModels.spec.ts b/src/utils/writeClientModels.spec.ts
@@ -38,6 +38,7 @@ describe('writeClientModels', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeClientSchemas.spec.ts b/src/utils/writeClientSchemas.spec.ts
@@ -38,6 +38,7 @@ describe('writeClientSchemas', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeClientServices.spec.ts b/src/utils/writeClientServices.spec.ts
@@ -26,6 +26,7 @@ describe('writeClientServices', () => {
                 model: () => 'model',
                 schema: () => 'schema',
                 service: () => 'service',
+                clientService: () => 'clientService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeUserClientServices.spec.ts b/src/utils/writeUserClientServices.spec.ts
@@ -0,0 +1,56 @@
+import { EOL } from 'os';
+
+import type { Service } from '../client/interfaces/Service';
+import { HttpClient } from '../HttpClient';
+import { Indent } from '../Indent';
+import { writeFile } from './fileSystem';
+import type { Templates } from './registerHandlebarTemplates';
+import { writeUserClientServices } from './writeUserClientServices';
+
+jest.mock('./fileSystem');
+
+describe('writeUserClientServices', () => {
+    it('should write to filesystem', async () => {
+        const services: Service[] = [
+            {
+                name: 'User',
+                operations: [],
+                imports: [],
+            },
+        ];
+
+        const templates: Templates = {
+            index: () => 'index',
+            client: () => 'client',
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+                clientService: () => 'clientService',
+            },
+            core: {
+                settings: () => 'settings',
+                apiError: () => 'apiError',
+                apiRequestOptions: () => 'apiRequestOptions',
+                apiResult: () => 'apiResult',
+                cancelablePromise: () => 'cancelablePromise',
+                request: () => 'request',
+                baseHttpRequest: () => 'baseHttpRequest',
+                httpRequest: () => 'httpRequest',
+            },
+        };
+
+        await writeUserClientServices(
+            services,
+            templates,
+            '/',
+            HttpClient.FETCH,
+            false,
+            false,
+            Indent.SPACE_4,
+            'Service'
+        );
+
+        expect(writeFile).toBeCalledWith('/UserClientService.ts', `clientService${EOL}`);
+    });
+});
diff --git a/src/utils/writeUserClientServices.ts b/src/utils/writeUserClientServices.ts
@@ -0,0 +1,47 @@
+import { resolve } from 'path';
+
+import type { Service } from '../client/interfaces/Service';
+import type { HttpClient } from '../HttpClient';
+import type { Indent } from '../Indent';
+import { writeFile } from './fileSystem';
+import { formatCode as f } from './formatCode';
+import { formatIndentation as i } from './formatIndentation';
+import { isDefined } from './isDefined';
+import type { Templates } from './registerHandlebarTemplates';
+
+/**
+ * Generate Services using the Handlebar template and write to disk.
+ * @param services Array of Services to write
+ * @param templates The loaded handlebar templates
+ * @param outputPath Directory to write the generated files to
+ * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param useUnionTypes Use union types instead of enums
+ * @param useOptions Use options or arguments functions
+ * @param indent Indentation options (4, 2 or tab)
+ * @param postfix Service name postfix
+ * @param clientName Custom client class name
+ */
+export const writeUserClientServices = async (
+    services: Service[],
+    templates: Templates,
+    outputPath: string,
+    httpClient: HttpClient,
+    useUnionTypes: boolean,
+    useOptions: boolean,
+    indent: Indent,
+    postfix: string,
+    clientName?: string
+): Promise<void> => {
+    for (const service of services) {
+        const file = resolve(outputPath, `${service.name}Client${postfix}.ts`);
+        const templateResult = templates.exports.clientService({
+            ...service,
+            httpClient,
+            useUnionTypes,
+            useOptions,
+            postfix,
+            exportClient: isDefined(clientName),
+        });
+        await writeFile(file, i(f(templateResult), indent));
+    }
+};
