feat: add index.ts to models and service directory

romantech48 · romantech48 · commit 49d522337ba5 · 2022-07-12T17:48:17.000+05:00
diff --git a/src/templates/modelsIndex.hbs b/src/templates/modelsIndex.hbs
@@ -0,0 +1,18 @@
+{{>header}}
+
+{{#if @root.exportModels}}
+{{#if models}}
+{{#each models}}
+{{#if @root.useUnionTypes}}
+export type { {{{name}}} } from './{{camelCase name}}{{#if ../additionalModelFileExtension}}.models{{/if}}';
+{{else if enum}}
+export { {{{name}}} } from './{{camelCase name}}{{#if ../additionalModelFileExtension}}.models{{/if}}';
+{{else if enums}}
+export { {{{name}}} } from './{{camelCase name}}{{#if ../additionalModelFileExtension}}.models{{/if}}';
+{{else}}
+export type { {{{name}}} } from './{{camelCase name}}{{#if ../additionalModelFileExtension}}.models{{/if}}';
+{{/if}}
+{{/each}}
+{{/if}}
+{{/if}}
+
diff --git a/src/templates/servicesIndex.hbs b/src/templates/servicesIndex.hbs
@@ -0,0 +1,13 @@
+{{>header}}
+
+{{#if @root.exportServices}}
+{{#if services}}
+{{#each services}}
+{{#equals @root.httpClient 'saddleback'}}
+export * as fetch{{{name}}}{{{@root.postfix}}} from './{{camelCase name}}{{{@root.postfix}}}{{#if ../additionalServiceFileExtension}}.service{{/if}}';
+{{else}}
+export { {{{name}}}{{{@root.postfix}}} } from './{{camelCase name}}{{{@root.postfix}}}{{#if ../additionalServiceFileExtension}}.service{{/if}}';
+{{/equals}}
+{{/each}}
+{{/if}}
+{{/if}}
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -57,6 +57,7 @@ import templateExportSaddlebackService from '../templates/exportSaddlebackServic
 import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
 import templateIndex from '../templates/index.hbs';
+import templateModelsIndex from '../templates/modelsIndex.hbs';
 import partialBase from '../templates/partials/base.hbs';
 import partialExportComposition from '../templates/partials/exportComposition.hbs';
 import partialExportEnum from '../templates/partials/exportEnum.hbs';
@@ -85,10 +86,13 @@ import partialTypeInterface from '../templates/partials/typeInterface.hbs';
 import partialTypeIntersection from '../templates/partials/typeIntersection.hbs';
 import partialTypeReference from '../templates/partials/typeReference.hbs';
 import partialTypeUnion from '../templates/partials/typeUnion.hbs';
+import templateServiceIndex from '../templates/servicesIndex.hbs';
 import { registerHandlebarHelpers } from './registerHandlebarHelpers';
 
 export interface Templates {
     index: Handlebars.TemplateDelegate;
+    serviceIndex: Handlebars.TemplateDelegate;
+    modelsIndex: Handlebars.TemplateDelegate;
     client: Handlebars.TemplateDelegate;
     exports: {
         model: Handlebars.TemplateDelegate;
@@ -122,6 +126,8 @@ export const registerHandlebarTemplates = (root: {
     // Main templates (entry points for the files we write to disk)
     const templates: Templates = {
         index: Handlebars.template(templateIndex),
+        serviceIndex: Handlebars.template(templateServiceIndex),
+        modelsIndex: Handlebars.template(templateModelsIndex),
         client: Handlebars.template(templateClient),
         exports: {
             model: Handlebars.template(templateExportModel),
diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -18,6 +18,8 @@ describe('writeClient', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -14,6 +14,8 @@ import { writeClientModels } from './writeClientModels';
 import { writeClientSchemas } from './writeClientSchemas';
 import { writeClientServices } from './writeClientServices';
 import { writeSaddlebackClientServices } from './writeSaddlebackClientServices';
+import { writeSaddlebackModelsIndex } from './writeSaddlebackModelsIndex';
+import { writeSaddlebackServiceIndex } from './writeSaddlebackServiceIndex';
 
 /**
  * Write our OpenAPI client, using the given templates at the given output
@@ -128,6 +130,38 @@ export const writeClient = async (
         await mkdir(outputPath);
         await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfix);
     }
+    // write service index
+    if (exportCore || exportServices || exportSchemas || exportModels) {
+        await mkdir(outputPath);
+        await writeSaddlebackServiceIndex(
+            client,
+            templates,
+            outputPathServices,
+            useUnionTypes,
+            exportServices,
+            postfix,
+            httpClient,
+            additionalModelFileExtension,
+            additionalServiceFileExtension,
+            clientName
+        );
+    }
+    // write models index
+    if (exportCore || exportServices || exportSchemas || exportModels) {
+        await mkdir(outputPath);
+        await writeSaddlebackModelsIndex(
+            client,
+            templates,
+            outputPathModels,
+            useUnionTypes,
+            exportModels,
+            postfix,
+            httpClient,
+            additionalModelFileExtension,
+            additionalServiceFileExtension,
+            clientName
+        );
+    }
 
     if (exportCore || exportServices || exportSchemas || exportModels) {
         await mkdir(outputPath);
diff --git a/src/utils/writeClientClass.spec.ts b/src/utils/writeClientClass.spec.ts
@@ -18,6 +18,8 @@ describe('writeClientClass', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
diff --git a/src/utils/writeClientCore.spec.ts b/src/utils/writeClientCore.spec.ts
@@ -20,6 +20,8 @@ describe('writeClientCore', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -1,8 +1,8 @@
 import type { Client } from '../client/interfaces/Client';
+import { HttpClient } from '../HttpClient';
 import { writeFile } from './fileSystem';
 import type { Templates } from './registerHandlebarTemplates';
 import { writeClientIndex } from './writeClientIndex';
-import { HttpClient } from '../HttpClient';
 
 jest.mock('./fileSystem');
 
@@ -17,6 +17,8 @@ describe('writeClientIndex', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
@@ -36,7 +38,20 @@ describe('writeClientIndex', () => {
             },
         };
 
-        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', HttpClient.AXIOS, false, false);
+        await writeClientIndex(
+            client,
+            templates,
+            '/',
+            true,
+            true,
+            true,
+            true,
+            true,
+            'Service',
+            HttpClient.AXIOS,
+            false,
+            false
+        );
 
         expect(writeFile).toBeCalledWith('/index.ts', 'index');
     });
diff --git a/src/utils/writeClientModels.spec.ts b/src/utils/writeClientModels.spec.ts
@@ -33,6 +33,8 @@ describe('writeClientModels', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
diff --git a/src/utils/writeClientSchemas.spec.ts b/src/utils/writeClientSchemas.spec.ts
@@ -33,6 +33,8 @@ describe('writeClientSchemas', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
diff --git a/src/utils/writeClientServices.spec.ts b/src/utils/writeClientServices.spec.ts
@@ -21,6 +21,8 @@ describe('writeClientServices', () => {
 
         const templates: Templates = {
             index: () => 'index',
+            modelsIndex: () => 'modelsIndex',
+            serviceIndex: () => 'serviceIndex',
             client: () => 'client',
             exports: {
                 model: () => 'model',
diff --git a/src/utils/writeSaddlebackModelsIndex.ts b/src/utils/writeSaddlebackModelsIndex.ts
@@ -0,0 +1,54 @@
+import { resolve } from 'path';
+
+import type { Client } from '../client/interfaces/Client';
+import { HttpClient } from '../HttpClient';
+import { writeFile } from './fileSystem';
+import { isDefined } from './isDefined';
+import { Templates } from './registerHandlebarTemplates';
+import { sortModelsByName } from './sortModelsByName';
+import { sortServicesByName } from './sortServicesByName';
+
+/**
+ * Generate the OpenAPI client index file using the Handlebar template and write it to disk.
+ * The index file just contains all the exports you need to use the client as a standalone
+ * library. But yuo can also import individual models and services directly.
+ * @param client Client object, containing, models, schemas and services
+ * @param templates The loaded handlebar templates
+ * @param outputPath Directory to write the generated files to
+ * @param useUnionTypes Use union types instead of enums
+ * @param exportModels Generate models
+ * @param postfix Service name postfix
+ * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param additionalModelFileExtension Add file extension for models *.models.*
+ * @param additionalServiceFileExtension Add file extension for service *.service.*
+ * @param clientName Custom client class name
+ */
+export const writeSaddlebackModelsIndex = async (
+    client: Client,
+    templates: Templates,
+    outputPath: string,
+    useUnionTypes: boolean,
+    exportModels: boolean,
+    postfix: string,
+    httpClient: HttpClient,
+    additionalModelFileExtension: boolean,
+    additionalServiceFileExtension: boolean,
+    clientName?: string
+): Promise<void> => {
+    const templateResult = templates.modelsIndex({
+        exportModels,
+        useUnionTypes,
+        postfix,
+        clientName,
+        server: client.server,
+        version: client.version,
+        models: sortModelsByName(client.models),
+        services: sortServicesByName(client.services),
+        exportClient: isDefined(clientName),
+        httpClient,
+        additionalModelFileExtension,
+        additionalServiceFileExtension,
+    });
+
+    await writeFile(resolve(outputPath, 'index.ts'), templateResult);
+};
diff --git a/src/utils/writeSaddlebackServiceIndex.ts b/src/utils/writeSaddlebackServiceIndex.ts
@@ -0,0 +1,54 @@
+import { resolve } from 'path';
+
+import type { Client } from '../client/interfaces/Client';
+import { HttpClient } from '../HttpClient';
+import { writeFile } from './fileSystem';
+import { isDefined } from './isDefined';
+import { Templates } from './registerHandlebarTemplates';
+import { sortModelsByName } from './sortModelsByName';
+import { sortServicesByName } from './sortServicesByName';
+
+/**
+ * Generate the OpenAPI client index file using the Handlebar template and write it to disk.
+ * The index file just contains all the exports you need to use the client as a standalone
+ * library. But yuo can also import individual models and services directly.
+ * @param client Client object, containing, models, schemas and services
+ * @param templates The loaded handlebar templates
+ * @param outputPath Directory to write the generated files to
+ * @param useUnionTypes Use union types instead of enums
+ * @param exportServices Generate services
+ * @param postfix Service name postfix
+ * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param additionalModelFileExtension Add file extension for models *.models.*
+ * @param additionalServiceFileExtension Add file extension for service *.service.*
+ * @param clientName Custom client class name
+ */
+export const writeSaddlebackServiceIndex = async (
+    client: Client,
+    templates: Templates,
+    outputPath: string,
+    useUnionTypes: boolean,
+    exportServices: boolean,
+    postfix: string,
+    httpClient: HttpClient,
+    additionalModelFileExtension: boolean,
+    additionalServiceFileExtension: boolean,
+    clientName?: string
+): Promise<void> => {
+    const templateResult = templates.serviceIndex({
+        exportServices,
+        useUnionTypes,
+        postfix,
+        clientName,
+        server: client.server,
+        version: client.version,
+        models: sortModelsByName(client.models),
+        services: sortServicesByName(client.services),
+        exportClient: isDefined(clientName),
+        httpClient,
+        additionalModelFileExtension,
+        additionalServiceFileExtension,
+    });
+
+    await writeFile(resolve(outputPath, 'index.ts'), templateResult);
+};
