Added allFieldsRequired flag for cases when you don't need optional fields (using nulls only)

Author: crutch12

bin/index.js

@@ -17,6 +17,7 @@ program
     .option('--exportServices <value>', 'Generate services', true)
     .option('--exportModels <value>', 'Generate models', true)
     .option('--exportSchemas <value>', 'Generate schemas', false)
+    .option('--allFieldsRequired', 'Set all response required (key:? val -> key: val)')
     .parse(process.argv);
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
@@ -32,6 +33,7 @@ if (OpenAPI) {
         exportServices: JSON.parse(program.exportServices) === true,
         exportModels: JSON.parse(program.exportModels) === true,
         exportSchemas: JSON.parse(program.exportSchemas) === true,
+        allFieldsRequired: program.allFieldsRequired,
     })
         .then(() => {
             process.exit(0);

src/index.ts

@@ -22,6 +22,7 @@ export interface Options {
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
+    allFieldsRequired?: boolean;
     write?: boolean;
 }
 
@@ -38,6 +39,7 @@ export interface Options {
  * @param exportServices: Generate services.
  * @param exportModels: Generate models.
  * @param exportSchemas: Generate schemas.
+ * @param allFieldsRequired Set all fields required (key:? val -> key: val).
  * @param write Write the files to disk (true or false).
  */
 export async function generate({
@@ -50,6 +52,7 @@ export async function generate({
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    allFieldsRequired = false,
     write = true,
 }: Options): Promise<void> {
     // Load the specification, read the OpenAPI version and load the
@@ -63,7 +66,7 @@ export async function generate({
             const client = parseV2(openApi);
             const clientFinal = postProcessClient(client, useUnionTypes);
             if (write) {
-                await writeClient(clientFinal, templates, output, httpClient, useOptions, exportCore, exportServices, exportModels, exportSchemas);
+                await writeClient(clientFinal, templates, output, httpClient, useOptions, exportCore, exportServices, exportModels, exportSchemas, allFieldsRequired);
             }
             break;
         }
@@ -72,7 +75,7 @@ export async function generate({
             const client = parseV3(openApi);
             const clientFinal = postProcessClient(client, useUnionTypes);
             if (write) {
-                await writeClient(clientFinal, templates, output, httpClient, useOptions, exportCore, exportServices, exportModels, exportSchemas);
+                await writeClient(clientFinal, templates, output, httpClient, useOptions, exportCore, exportServices, exportModels, exportSchemas, allFieldsRequired);
             }
             break;
         }

src/templates/partials/isRequired.hbs

@@ -1,5 +1,8 @@
+{{#if @root.allFieldsRequired}}
+{{else}}
 {{#if @root.useOptions}}
-{{~#unless isRequired}}?{{else if default}}?{{/unless~}}
+{{~#unless isRequired}}?{{else if default}}{{else if default}}?{{/unless~}}
 {{else}}
 {{~#unless isRequired}}{{#unless default}}?{{/unless}}{{/unless~}}
 {{/if}}
+{{/if}}

src/utils/writeClient.ts

@@ -25,6 +25,7 @@ async function copySupportFile(filePath: string, outputPath: string): Promise<vo
  * @param exportServices: Generate services.
  * @param exportModels: Generate models.
  * @param exportSchemas: Generate schemas.
+ * @param allFieldsRequired: Require all response fields.
  */
 export async function writeClient(
     client: Client,
@@ -35,7 +36,8 @@ export async function writeClient(
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
-    exportSchemas: boolean
+    exportSchemas: boolean,
+    allFieldsRequired: boolean
 ): Promise<void> {
     const outputPath = path.resolve(process.cwd(), output);
     const outputPathCore = path.resolve(outputPath, 'core');
@@ -74,7 +76,7 @@ export async function writeClient(
     if (exportModels) {
         await mkdir(outputPathModels);
         await copySupportFile('models/Dictionary.ts', outputPath);
-        await writeClientModels(client.models, templates, outputPathModels);
+        await writeClientModels(client.models, templates, outputPathModels, allFieldsRequired);
     }
 
     await writeClientIndex(client, templates, outputPath, exportCore, exportServices, exportModels, exportSchemas);

src/utils/writeClientModels.ts

@@ -11,10 +11,13 @@ import { Templates } from './registerHandlebarTemplates';
  * @param templates The loaded handlebar templates.
  * @param outputPath Directory to write the generated files to.
  */
-export async function writeClientModels(models: Model[], templates: Templates, outputPath: string): Promise<void> {
+export async function writeClientModels(models: Model[], templates: Templates, outputPath: string, allFieldsRequired: boolean): Promise<void> {
     for (const model of models) {
         const file = path.resolve(outputPath, `${model.name}.ts`);
-        const templateResult = templates.model(model);
+        const templateResult = templates.model({
+            ...model,
+            allFieldsRequired,
+        });
         await writeFile(file, format(templateResult));
     }
 }