add functionality to create samples alongside client

Author: sachinr

bin/index.js

@@ -17,6 +17,7 @@ const params = program
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
     .option('--exportCore <value>', 'Write core files to disk', true)
+    .option('--exportSamples <value>', 'Write samples to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
@@ -39,6 +40,7 @@ if (OpenAPI) {
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
         exportCore: JSON.parse(params.exportCore) === true,
+        exportSamples: JSON.parse(params.exportSamples) === true,
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,

src/index.ts

@@ -20,6 +20,7 @@ export type Options = {
     useOptions?: boolean;
     useUnionTypes?: boolean;
     exportCore?: boolean;
+    exportSamples?: boolean;
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
@@ -58,6 +59,7 @@ export const generate = async ({
     useOptions = false,
     useUnionTypes = false,
     exportCore = true,
+    exportSamples = true,
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
@@ -88,6 +90,7 @@ export const generate = async ({
                 useOptions,
                 useUnionTypes,
                 exportCore,
+                exportSamples,
                 exportServices,
                 exportModels,
                 exportSchemas,
@@ -112,6 +115,7 @@ export const generate = async ({
                 useOptions,
                 useUnionTypes,
                 exportCore,
+                exportSamples,
                 exportServices,
                 exportModels,
                 exportSchemas,

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 templateExportSample from '../templates/exportSample.hbs';
 import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
 import templateIndex from '../templates/index.hbs';
@@ -92,6 +93,7 @@ export interface Templates {
         model: Handlebars.TemplateDelegate;
         schema: Handlebars.TemplateDelegate;
         service: Handlebars.TemplateDelegate;
+        sample: HandlebarsTemplateDelegate;
     };
     core: {
         settings: Handlebars.TemplateDelegate;
@@ -124,6 +126,7 @@ export const registerHandlebarTemplates = (root: {
             model: Handlebars.template(templateExportModel),
             schema: Handlebars.template(templateExportSchema),
             service: Handlebars.template(templateExportService),
+            sample: Handlebars.template(templateExportSample),
         },
         core: {
             settings: Handlebars.template(templateCoreSettings),

src/utils/writeClient.spec.ts

@@ -22,6 +22,7 @@ describe('writeClient', () => {
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
+                sample: () => 'sample',
                 service: () => 'service',
             },
             core: {
@@ -47,6 +48,7 @@ describe('writeClient', () => {
             true,
             true,
             true,
+            true,
             Indent.SPACE_4,
             'Service',
             'AppClient'

src/utils/writeClient.ts

@@ -11,6 +11,7 @@ import { writeClientClass } from './writeClientClass';
 import { writeClientCore } from './writeClientCore';
 import { writeClientIndex } from './writeClientIndex';
 import { writeClientModels } from './writeClientModels';
+import { writeClientSamples } from './writeClientSamples';
 import { writeClientSchemas } from './writeClientSchemas';
 import { writeClientServices } from './writeClientServices';
 
@@ -24,6 +25,7 @@ import { writeClientServices } from './writeClientServices';
  * @param useUnionTypes Use union types instead of enums
  * @param exportCore Generate core client classes
  * @param exportServices Generate services
+ * @param exportSamples Generate samples
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
  * @param exportSchemas Generate schemas
@@ -41,6 +43,7 @@ export const writeClient = async (
     useOptions: boolean,
     useUnionTypes: boolean,
     exportCore: boolean,
+    exportSamples: boolean,
     exportServices: boolean,
     exportModels: boolean,
     exportSchemas: boolean,
@@ -55,6 +58,7 @@ export const writeClient = async (
     const outputPathModels = resolve(outputPath, 'models');
     const outputPathSchemas = resolve(outputPath, 'schemas');
     const outputPathServices = resolve(outputPath, 'services');
+    const outputPathSamples = resolve(outputPath, 'samples');
 
     if (!isSubDirectory(process.cwd(), output)) {
         throw new Error(`Output folder is not a subdirectory of the current working directory`);
@@ -82,6 +86,22 @@ export const writeClient = async (
         );
     }
 
+    if (exportSamples) {
+        await rmdir(outputPathSamples);
+        await mkdir(outputPathSamples);
+        await writeClientSamples(
+            client.services,
+            templates,
+            outputPathSamples,
+            httpClient,
+            useUnionTypes,
+            useOptions,
+            indent,
+            '',
+            clientName
+        );
+    }
+
     if (exportSchemas) {
         await rmdir(outputPathSchemas);
         await mkdir(outputPathSchemas);

src/utils/writeClientClass.spec.ts

@@ -21,6 +21,7 @@ describe('writeClientClass', () => {
             client: () => 'client',
             exports: {
                 model: () => 'model',
+                sample: () => 'sample',
                 schema: () => 'schema',
                 service: () => 'service',
             },

src/utils/writeClientCore.spec.ts

@@ -23,6 +23,7 @@ describe('writeClientCore', () => {
             client: () => 'client',
             exports: {
                 model: () => 'model',
+                sample: () => 'sample',
                 schema: () => 'schema',
                 service: () => 'service',
             },

src/utils/writeClientIndex.spec.ts

@@ -19,6 +19,7 @@ describe('writeClientIndex', () => {
             client: () => 'client',
             exports: {
                 model: () => 'model',
+                sample: () => 'sample',
                 schema: () => 'schema',
                 service: () => 'service',
             },

src/utils/writeClientModels.spec.ts

@@ -36,6 +36,7 @@ describe('writeClientModels', () => {
             client: () => 'client',
             exports: {
                 model: () => 'model',
+                sample: () => 'sample',
                 schema: () => 'schema',
                 service: () => 'service',
             },

src/utils/writeClientSchemas.spec.ts

@@ -36,6 +36,7 @@ describe('writeClientSchemas', () => {
             client: () => 'client',
             exports: {
                 model: () => 'model',
+                sample: () => 'sample',
                 schema: () => 'schema',
                 service: () => 'service',
             },