feat: add the saddleback layout for generate custom services

romantech48 · romantech48 · commit e2a606ec465c · 2022-06-14T11:59:38.000+05:00
diff --git a/src/templates/exportSaddlebackService.hbs b/src/templates/exportSaddlebackService.hbs
@@ -0,0 +1,74 @@
+{{#if imports}}
+{{#each imports}}
+import type { {{{this}}} } from '../models/{{{this}}}.models';
+{{/each}}
+{{/if}}
+import axios, {
+	AxiosError,
+	AxiosResponse,
+} from 'axios';
+import serviceError from 'global/api/serviceError';
+import getBaseConfig from 'global/api/getBaseConfig';
+
+{{#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 Error('{{{../name}}}Service > {{name}}')
+ */
+
+export const fetch{{{../name}}}{{pascalCase name}} = async ({{> saddlebackParameters}}): Promise<AxiosResponse<{{>result}}>> => {
+	const setBaseConfig = getBaseConfig({
+{{#if parametersBody}}
+		data,
+{{/if}}
+{{#if parametersPath}}
+		params,
+{{else if parametersQuery}}
+		params,
+{{/if}}
+		method: '{{{method}}}',
+		url: '{{{path}}}',
+{{#if parametersBody}}
+{{#if parametersBody.mediaType}}
+		contentType: '{{{parametersBody.mediaType}}}',
+{{/if}}
+{{/if}}
+	});
+
+	try {
+		const response: AxiosResponse<{{>result}}> = await axios({
+			...setBaseConfig,
+		});
+
+		return response;
+	} catch (error) {
+		const axiosError = error as AxiosError;
+
+		serviceError({
+			response: axiosError.response,
+		});
+
+		throw new Error('{{{../name}}}Service > {{name}}');
+	}
+};
+
+{{/each}}
+
diff --git a/src/templates/partials/saddlebackParameters.hbs b/src/templates/partials/saddlebackParameters.hbs
@@ -0,0 +1,73 @@
+{{#if parameters}}
+{
+	{{#if parametersBody}}
+	data,
+	{{/if}}
+	{{#if parametersPath}}
+	params,
+	{{else if parametersQuery}}
+	params,
+{{/if~}} }: {
+	{{#if parametersBody}}
+	data: {{#equals parametersBody.in 'formData'}}FormData;{{else}}{{{parametersBody.type}}};{{/equals}}
+	{{/if}}
+	{{#if parametersPath}}
+	params: {
+		{{#each parametersPath}}
+		{{#ifdef description deprecated}}
+		/**
+				{{#if description}}
+		 * {{{escapeComment description}}}
+		{{/if}}
+			{{#if deprecated}}
+		 * @deprecated
+				{{/if}}
+		 */
+			{{/ifdef}}
+		{{{name}}}{{>isRequired}}: {{>type}};
+		{{/each}}
+		{{#each parametersQuery}}
+			{{#ifdef description deprecated}}
+		/**
+				{{#if description}}
+		 * {{{escapeComment description}}}
+			{{/if}}
+				{{#if deprecated}}
+		 * @deprecated
+				{{/if}}
+		 */
+			{{/ifdef}}
+		{{{name}}}{{>isRequired}}: {{>type}};
+		{{/each}}
+	};
+	{{else if parametersQuery}}
+	params: {
+		{{#each parametersPath}}
+			{{#ifdef description deprecated}}
+		/**
+				{{#if description}}
+		 * {{{escapeComment description}}}
+				{{/if}}
+				{{#if deprecated}}
+		 * @deprecated
+				{{/if}}
+		 */
+			{{/ifdef}}
+		{{{name}}}{{>isRequired}}: {{>type}};
+		{{/each}}
+		{{#each parametersQuery}}
+			{{#ifdef description deprecated}}
+		/**
+				{{#if description}}
+		 * {{{escapeComment description}}}
+				{{/if}}
+				{{#if deprecated}}
+		 * @deprecated
+				{{/if}}
+		 */
+			{{/ifdef}}
+		{{{name}}}{{>isRequired}}: {{>type}};
+		{{/each}}
+	};
+{{/if}}
+}{{/if}}
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -53,6 +53,7 @@ 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 templateExportModel from '../templates/exportModel.hbs';
+import templateExportSaddlebackService from '../templates/exportSaddlebackService.hbs';
 import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
 import templateIndex from '../templates/index.hbs';
@@ -67,6 +68,7 @@ import partialIsReadOnly from '../templates/partials/isReadOnly.hbs';
 import partialIsRequired from '../templates/partials/isRequired.hbs';
 import partialParameters from '../templates/partials/parameters.hbs';
 import partialResult from '../templates/partials/result.hbs';
+import saddlebackParameters from '../templates/partials/saddlebackParameters.hbs';
 import partialSchema from '../templates/partials/schema.hbs';
 import partialSchemaArray from '../templates/partials/schemaArray.hbs';
 import partialSchemaComposition from '../templates/partials/schemaComposition.hbs';
@@ -92,6 +94,7 @@ export interface Templates {
         model: Handlebars.TemplateDelegate;
         schema: Handlebars.TemplateDelegate;
         service: Handlebars.TemplateDelegate;
+        saddlebackService: Handlebars.TemplateDelegate;
     };
     core: {
         settings: Handlebars.TemplateDelegate;
@@ -124,6 +127,7 @@ export const registerHandlebarTemplates = (root: {
             model: Handlebars.template(templateExportModel),
             schema: Handlebars.template(templateExportSchema),
             service: Handlebars.template(templateExportService),
+            saddlebackService: Handlebars.template(templateExportSaddlebackService),
         },
         core: {
             settings: Handlebars.template(templateCoreSettings),
@@ -147,6 +151,7 @@ export const registerHandlebarTemplates = (root: {
     Handlebars.registerPartial('isReadOnly', Handlebars.template(partialIsReadOnly));
     Handlebars.registerPartial('isRequired', Handlebars.template(partialIsRequired));
     Handlebars.registerPartial('parameters', Handlebars.template(partialParameters));
+    Handlebars.registerPartial('saddlebackParameters', Handlebars.template(saddlebackParameters));
     Handlebars.registerPartial('result', Handlebars.template(partialResult));
     Handlebars.registerPartial('schema', Handlebars.template(partialSchema));
     Handlebars.registerPartial('schemaArray', Handlebars.template(partialSchemaArray));
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',
+                saddlebackService: () => 'saddlebackService',
             },
             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 { writeSaddlebackClientServices } from './writeSaddlebackClientServices';
 
 /**
  * Write our OpenAPI client, using the given templates at the given output
@@ -53,6 +54,7 @@ export const writeClient = async (
     const outputPathModels = resolve(outputPath, 'models');
     const outputPathSchemas = resolve(outputPath, 'schemas');
     const outputPathServices = resolve(outputPath, 'services');
+    const outputPathSaddlebackServices = resolve(outputPath, 'saddlebackServices');
 
     if (!isSubDirectory(process.cwd(), output)) {
         throw new Error(`Output folder is not a subdirectory of the current working directory`);
@@ -112,4 +114,21 @@ export const writeClient = async (
             clientName
         );
     }
+
+    if (true) {
+        await rmdir(outputPathSaddlebackServices);
+        await mkdir(outputPathSaddlebackServices);
+
+        await writeSaddlebackClientServices(
+            client.services,
+            templates,
+            outputPathSaddlebackServices,
+            httpClient,
+            useUnionTypes,
+            useOptions,
+            indent,
+            postfix,
+            clientName
+        );
+    }
 };
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',
+                saddlebackService: () => 'saddlebackService',
             },
             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',
+                saddlebackService: () => 'saddlebackService',
             },
             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',
+                saddlebackService: () => 'saddlebackService',
             },
             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',
+                saddlebackService: () => 'saddlebackService',
             },
             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',
+                saddlebackService: () => 'saddlebackService',
             },
             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',
+                saddlebackService: () => 'saddlebackService',
             },
             core: {
                 settings: () => 'settings',
diff --git a/src/utils/writeSaddlebackClientServices.ts b/src/utils/writeSaddlebackClientServices.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 writeSaddlebackClientServices = 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}${postfix}.service.ts`);
+        const templateResult = templates.exports.saddlebackService({
+            ...service,
+            httpClient,
+            useUnionTypes,
+            useOptions,
+            postfix,
+            exportClient: isDefined(clientName),
+        });
+        await writeFile(file, i(f(templateResult), indent));
+    }
+};
diff --git a/test/index.js b/test/index.js
@@ -72,8 +72,8 @@ const main = async () => {
         exportSchemas: false,
         indent: '4',
         postfix: '',
-        filterMethod: 'ascetic',
-        filterArray: ['/api/agreement', '/api/agreement/{id}'],
+        filterMethod: 'greedy',
+        filterArray: ['/api/agreement', '/api/agreement/{id}', '/api/share-page/compare-results'],
     });
     // await generateRealWorldSpecs();
 };
