feat: remove lodash prefixes

Author: romantech48

src/generateSaddlebackSpec.ts

@@ -1,13 +1,38 @@
 import { generate, Options } from './generate';
+import { isString } from './utils/isString';
+import { getOpenApiSpec } from './utils/getOpenApiSpec';
+import { OpenApi } from './openApi/v3/interfaces/OpenApi';
+import { Dictionary } from './utils/types';
+import { OpenApiSchema } from './openApi/v3/interfaces/OpenApiSchema';
+import { removeLodashPrefix } from './utils/removeLodashPrefix';
+import { mapSwaggerRef } from './utils/mapSwaggerRef';
+import { removeLodashPrefixFromRef } from './utils/removeLodashPrefixFromRef';
 
 type Config = Options & {
     useSaddlebackServices?: boolean;
     additionalModelFileExtension?: boolean;
     additionalServiceFileExtension?: boolean;
+    removeLodashPrefixes?: boolean;
 };
 
 export const generateSaddlebackSpec = async (config: Config) => {
-    await generate({ ...config });
+    const openApi: OpenApi = isString(config.input) ? await getOpenApiSpec(config.input) : config.input;
+
+    if (config.removeLodashPrefixes && openApi.components && openApi.components.schemas) {
+        const newSchemas: Dictionary<OpenApiSchema> = {};
+
+        for (const schemaKey in openApi.components.schemas) {
+            if (openApi.components.schemas.hasOwnProperty(schemaKey)) {
+                newSchemas[removeLodashPrefix(schemaKey)] = openApi.components.schemas[schemaKey];
+            }
+        }
+
+        openApi.components.schemas = newSchemas;
+    }
+
+    mapSwaggerRef(openApi, removeLodashPrefixFromRef);
+
+    await generate({ ...config, input: openApi });
 };
 
 export default generateSaddlebackSpec;

src/templates/exportSaddlebackService.hbs

@@ -51,7 +51,9 @@ export const fetch{{{../name}}}{{pascalCase name}} = async ({{> saddlebackParame
 		contentType: '{{{parametersBody.mediaType}}}',
 {{/if}}
 {{/if}}
+{{#if parameters}}
 		...config,
+{{/if}}
 	});
 
 	try {

src/templates/index.hbs

@@ -41,7 +41,11 @@ export { ${{{name}}} } from './schemas/${{{name}}}';
 {{#if services}}
 
 {{#each services}}
+{{#equals @root.httpClient 'saddleback'}}
+export * as fetch{{{name}}}{{{@root.postfix}}} from './services/{{{name}}}{{{@root.postfix}}}{{#if ../additionalServiceFileExtension}}.service{{/if}}';
+{{else}}
 export { {{{name}}}{{{@root.postfix}}} } from './services/{{{name}}}{{{@root.postfix}}}{{#if ../additionalServiceFileExtension}}.service{{/if}}';
+{{/equals}}
 {{/each}}
 {{/if}}
 {{/if}}

src/utils/mapSwaggerRef.ts

@@ -0,0 +1,13 @@
+export const mapSwaggerRef = (obj: Record<string, any>, mapFunction: Function): void => {
+    const searchRef = (obj: Record<string, any>) => {
+        for (const key in obj) {
+            if (obj.hasOwnProperty(key)) {
+                if (key === '$ref') {
+                    obj[key] = mapFunction(obj[key]);
+                } else if (typeof obj[key] === 'object') searchRef(obj[key]);
+            }
+        }
+    }
+
+    searchRef(obj);
+};

src/utils/removeLodashPrefix.ts

@@ -0,0 +1,3 @@
+export const removeLodashPrefix = (s: string): string => {
+    return s.split('_').slice(-1)[0];
+};

src/utils/removeLodashPrefixFromRef.ts

@@ -0,0 +1,11 @@
+import { removeLodashPrefix } from './removeLodashPrefix';
+
+export const removeLodashPrefixFromRef = (swaggerRef: string) => {
+    return (
+        swaggerRef
+            .split('/')
+            .slice(0, -1)
+            .reduce((acc: string, it: string) => `${acc}${it}/`, '') +
+        removeLodashPrefix(swaggerRef.split('/').slice(-1)[0])
+    );
+};

src/utils/writeClient.ts

@@ -141,6 +141,7 @@ export const writeClient = async (
             exportModels,
             exportSchemas,
             postfix,
+            httpClient,
             clientName
         );
     }

src/utils/writeClientIndex.spec.ts

@@ -2,6 +2,7 @@ import type { Client } from '../client/interfaces/Client';
 import { writeFile } from './fileSystem';
 import type { Templates } from './registerHandlebarTemplates';
 import { writeClientIndex } from './writeClientIndex';
+import { HttpClient } from '../HttpClient';
 
 jest.mock('./fileSystem');
 
@@ -35,7 +36,7 @@ describe('writeClientIndex', () => {
             },
         };
 
-        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service');
+        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', HttpClient.AXIOS);
 
         expect(writeFile).toBeCalledWith('/index.ts', 'index');
     });

src/utils/writeClientIndex.ts

@@ -6,6 +6,7 @@ import { isDefined } from './isDefined';
 import { Templates } from './registerHandlebarTemplates';
 import { sortModelsByName } from './sortModelsByName';
 import { sortServicesByName } from './sortServicesByName';
+import { HttpClient } from '../HttpClient';
 
 /**
  * Generate the OpenAPI client index file using the Handlebar template and write it to disk.
@@ -20,6 +21,7 @@ import { sortServicesByName } from './sortServicesByName';
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
  * @param postfix Service name postfix
+ * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param clientName Custom client class name
  */
 export const writeClientIndex = async (
@@ -32,6 +34,7 @@ export const writeClientIndex = async (
     exportModels: boolean,
     exportSchemas: boolean,
     postfix: string,
+    httpClient: HttpClient,
     clientName?: string
 ): Promise<void> => {
     const templateResult = templates.index({
@@ -47,6 +50,7 @@ export const writeClientIndex = async (
         models: sortModelsByName(client.models),
         services: sortServicesByName(client.services),
         exportClient: isDefined(clientName),
+        httpClient,
     });
 
     await writeFile(resolve(outputPath, 'index.ts'), templateResult);

test/index.js

@@ -60,8 +60,8 @@ const main = async () => {
     // await generate('./test/spec/v2.json', './test/generated/v2/');
     // await generate('./test/spec/v3.json', './test/generated/v3/');
     const config = {
-        httpClient: 'axios',
-        clientName: 'TestAxiosClassName',
+        httpClient: 'saddleback',
+        clientName: '',
         useOptions: true,
         useUnionTypes: false,
         exportCore: false,
@@ -70,27 +70,26 @@ const main = async () => {
         exportSchemas: false,
         indent: '4',
         postfix: '',
-        filterMethod: 'greedy',
-        filterArray: ['/api/agreement', '/api/agreement/{id}', '/api/share-page/compare-results'],
         additionalModelFileExtension: false,
         additionalServiceFileExtension: false,
+        removeLodashPrefixes: true,
     };
-    await OpenAPI.generateCustomSpec({
+    await OpenAPI.generateSaddlebackSpec({
         input: './test/spec/saddlebackCoreApi.json',
         output: './test/new/saddleback/core',
         ...config,
     });
-    await OpenAPI.generateCustomSpec({
+    await OpenAPI.generateSaddlebackSpec({
         input: './test/spec/saddlebackEventApi.json',
         output: './test/new/saddleback/event',
         ...config,
     });
-    await OpenAPI.generateCustomSpec({
+    await OpenAPI.generateSaddlebackSpec({
         input: './test/spec/saddlebackWebAppApi.json',
         output: './test/new/saddleback/web',
         ...config,
     });
-    await OpenAPI.generateCustomSpec({
+    await OpenAPI.generateSaddlebackSpec({
         input: './test/spec/saddlebackWorkflowApi.json',
         output: './test/new/saddleback/workflow',
         ...config,