Bugfix/required and nullable difference

README.md

@@ -59,7 +59,9 @@ export interface ISwaggerOptions {
   urlFilters?: Array<string>
   /** custom function to format the output file (default: prettier.format()) **/
   format?: (s: string) => string
-  /** match with tsconfig */
+  /** force required option for fields */
+  strictRequiredChecks?: boolean | undefined
+  /** force nullable option for fields */
   strictNullChecks?: boolean | undefined
   /** definition Class mode */
   modelMode?: 'class' | 'interface'
@@ -86,6 +88,7 @@ const defaultOptions: ISwaggerOptions = {
   useStaticMethod: true,
   useCustomerRequestInstance: false,
   include: [],
+  strictRequiredChecks: true,
   strictNullChecks: true,
   /** definition Class mode ,auto use interface mode to streamlined code*/
   modelMode?: 'interface'

example/swagger/codegen-customMethodNameMode.js

@@ -1,4 +1,4 @@
-const { codegen } = require('../../dist/index.js')
+const { codegen } = require('../../dist/index.js');
 
 codegen({
   methodNameMode: (reqProps) => {
@@ -9,9 +9,10 @@ codegen({
   },
   source: require('../swagger-operationId.json'),
   outputDir: './swagger/services',
+  strictRequiredChecks: false,
   strictNullChecks: false,
   modelMode: 'interface',
   extendDefinitionFile: './swagger/customerDefinition.ts',
   extendGenericType: ['JsonResult'],
   sharedServiceOptions: true
-})
+});

example/swagger/codegen-shortOperationId.js

@@ -1,12 +1,13 @@
-const { codegen } = require('../../dist/index.js')
+const { codegen } = require('../../dist/index.js');
 
 codegen({
   methodNameMode: 'shortOperationId',
   source: require('../swagger-operationId.json'),
   outputDir: './swagger/services',
+  strictRequiredChecks: false,
   strictNullChecks: false,
   modelMode: 'interface',
   extendDefinitionFile: './swagger/customerDefinition.ts',
   extendGenericType: ['JsonResult'],
   sharedServiceOptions: true
-})
+});

example/swagger/codegen.generic.js

@@ -1,12 +1,13 @@
 // const { codegen } = require('swagger-axios-codegen')
-const { codegen } = require('../../dist/index.js')
+const { codegen } = require('../../dist/index.js');
 
 codegen({
   methodNameMode: 'path',
   source: require('../swaggerGeneric.json'),
   // remoteUrl: 'http://localhost:44307/swagger/v1/swagger.json',
   outputDir: './swagger/services',
   fileName: 'indexGeneric.ts',
+  strictRequiredChecks: false,
   strictNullChecks: false,
   modelMode: 'interface'
-})
+});

example/swagger/codegen.include.js

@@ -1,5 +1,5 @@
 // const { codegen } = require('swagger-axios-codegen')
-const { codegen } = require('../../dist/index.js')
+const { codegen } = require('../../dist/index.js');
 
 let include = [
   // "products-test",
@@ -11,12 +11,13 @@ let include = [
   // 'Products*',
   '!Products',
   { 'User': ['*', '!history'] },
-]
+];
 codegen({
   methodNameMode: 'path',
+  strictRequiredChecks: false,
   strictNullChecks: false,
   modelMode: 'interface',
   source: require('../swagger.json'),
   outputDir: './swagger/services',
   include
-})
+});

example/swagger/codegen.js

@@ -1,15 +1,16 @@
 // const { codegen } = require('swagger-axios-codegen')
-const { codegen } = require('../../dist/index.js')
+const { codegen } = require('../../dist/index.js');
 
 codegen({
   methodNameMode: 'path',
   source: require('../swagger.json'),
   // remoteUrl: 'http://localhost:44307/swagger/v1/swagger.json',
   outputDir: './swagger/services',
+  strictRequiredChecks: false,
   strictNullChecks: false,
   // useCustomerRequestInstance: true,
   modelMode: 'interface',
   extendDefinitionFile: './swagger/customerDefinition.ts',
   extendGenericType: ['JsonResult'],
   sharedServiceOptions: true
-})
+});

example/swagger/codegen.v3.js

@@ -1,12 +1,13 @@
 // const { codegen } = require('swagger-axios-codegen')
-const { codegen } = require('../../dist/index.js')
+const { codegen } = require('../../dist/index.js');
 
 codegen({
   methodNameMode: 'path',
   source: require('../swagger3.json'),
   // remoteUrl: 'http://localhost:44307/swagger/v1/swagger.json',
   outputDir: './swagger/services',
   fileName: 'indexv3.ts',
+  strictRequiredChecks: false,
   strictNullChecks: false,
   modelMode: 'interface'
-})
+});

src/baseInterfaces.ts

@@ -14,7 +14,9 @@ export interface ISwaggerOptions {
   /** include types which are not included during the filtering **/
   includeTypes?: Array<string>
   format?: (s: string) => string
-  /** match with tsconfig */
+  /** force required option for fields */
+  strictRequiredChecks?: boolean | undefined
+  /** force required option for fields */
   strictNullChecks?: boolean | undefined
   /** definition Class mode */
   modelMode?: 'class' | 'interface'

src/index.filter.ts

@@ -79,11 +79,12 @@ function codegenInclude(
     if (allImport.includes(item.name)) {
       const text =
         options.modelMode === 'interface'
-          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictNullChecks)
+          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictRequiredChecks, options.strictNullChecks)
           : classTemplate(
             item.value.name,
             item.value.props,
             [],
+            options.strictRequiredChecks,
             options.strictNullChecks,
             options.useClassTransformer,
             options.generateValidationModel
@@ -225,11 +226,12 @@ function codegenMultimatchInclude(
     if (allImport.includes(item.name)) {
       const text =
         options.modelMode === 'interface'
-          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictNullChecks)
+          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictRequiredChecks, options.strictNullChecks)
           : classTemplate(
             item.value.name,
             item.value.props,
             [],
+            options.strictRequiredChecks,
             options.strictNullChecks,
             options.useClassTransformer,
             options.generateValidationModel

src/index.ts

@@ -14,7 +14,7 @@ import {
   classTemplate,
   typeTemplate
 } from './templates/template'
-import { customerServiceHeader, serviceHeader, definitionHeader, disableLint } from './templates/serviceHeader'
+import { customerServiceHeader, serviceHeader, definitionHeader } from './templates/serviceHeader'
 import { isOpenApi3, findDeepRefs, setDefinedGenericTypes, getDefinedGenericTypes, trimString } from './utils'
 import { requestCodegen, IRequestClass, IRequestMethods } from './requestCodegen'
 import { componentsCodegen } from './componentsCodegen'
@@ -31,6 +31,7 @@ const defaultOptions: ISwaggerOptions = {
   modelMode: 'interface',
   include: [],
   includeTypes: [],
+  strictRequiredChecks: true,
   strictNullChecks: true,
   useClassTransformer: false,
   extendGenericType: [],
@@ -125,9 +126,7 @@ export async function codegen(params: ISwaggerOptions) {
       for (const item of allImport) {
         if (!uniqueImports.includes(item)) uniqueImports.push(item)
       }
-      console.log(disableLint());
 
-      text = disableLint() + text
       text = serviceTemplate(className + options.serviceNameSuffix, text, uniqueImports)
       writeFile(options.outputDir || '', className + 'Service.ts', format(text, options))
     })
@@ -139,11 +138,12 @@ export async function codegen(params: ISwaggerOptions) {
     Object.values(models).forEach(item => {
       const text =
         params.modelMode === 'interface'
-          ? interfaceTemplate(item.value.name, item.value.props, [], params.strictNullChecks)
+          ? interfaceTemplate(item.value.name, item.value.props, [], params.strictRequiredChecks, params.strictNullChecks)
           : classTemplate(
             item.value.name,
             item.value.props,
             [],
+            params.strictRequiredChecks,
             params.strictNullChecks,
             options.useClassTransformer,
             options.generateValidationModel
@@ -219,11 +219,12 @@ function codegenAll(
     Object.values(models).forEach(item => {
       const text =
         options.modelMode === 'interface'
-          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictNullChecks)
+          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictRequiredChecks, options.strictNullChecks)
           : classTemplate(
             item.value.name,
             item.value.props,
             [],
+            options.strictRequiredChecks,
             options.strictNullChecks,
             options.useClassTransformer,
             options.generateValidationModel
@@ -244,9 +245,7 @@ function codegenAll(
       }
       apiSource += text
     })
-    // console.log(disableLint());
 
-    apiSource = disableLint() + apiSource
     writeFile(options.outputDir || '', options.fileName || '', format(apiSource, options))
   } catch (error) {
     console.log('error', error)
@@ -313,11 +312,12 @@ function codegenInclude(
     if (allImport.includes(item.name) || options.includeTypes.includes(item.name)) {
       const text =
         options.modelMode === 'interface'
-          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictNullChecks)
+          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictRequiredChecks, options.strictNullChecks)
           : classTemplate(
             item.value.name,
             item.value.props,
             [],
+            options.strictRequiredChecks,
             options.strictNullChecks,
             options.useClassTransformer,
             options.generateValidationModel
@@ -459,11 +459,12 @@ function codegenMultimatchInclude(
     if (allImport.includes(item.name) || options.includeTypes.includes(item.name)) {
       const text =
         options.modelMode === 'interface'
-          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictNullChecks)
+          ? interfaceTemplate(item.value.name, item.value.props, [], options.strictRequiredChecks, options.strictNullChecks)
           : classTemplate(
             item.value.name,
             item.value.props,
             [],
+            options.strictRequiredChecks,
             options.strictNullChecks,
             options.useClassTransformer,
             options.generateValidationModel
@@ -489,7 +490,6 @@ function codegenMultimatchInclude(
     }
   })
 
-  apiSource = disableLint() + apiSource
   apiSource += reqSource + defSource
   writeFile(options.outputDir || '', options.fileName || '', format(apiSource, options))
 }

src/swaggerInterfaces.ts

@@ -107,6 +107,8 @@ export interface IDefinitionProperty {
   type: string
   enum: any[]
   format: string
+  readOnly: boolean
+  nullable: boolean
   maxLength: number
   $ref: string
   allOf: IDefinitionProperty[]

src/templates/serviceHeader.ts

@@ -35,13 +35,6 @@ export function serviceHeader(options: ISwaggerOptions) {
   `;
 }
 
-export function disableLint() {
-  return `/** Generate by swagger-axios-codegen */
-  // @ts-nocheck
-/* eslint-disable */
-
-`}
-
 
 export function customerServiceHeader(options: ISwaggerOptions) {