Fix TanStack Query compatibility by adding support for returning null instead of undefined

README.md

@@ -42,6 +42,7 @@ $ openapi --help
     --name <value>            Custom client class name
     --useOptions              Use options instead of arguments
     --useUnionTypes           Use union types instead of enums
+    --useNullForNoContent     Use null for returning instead of undefined if a response returns 204 no content
     --exportCore <value>      Write core files to disk (default: true)
     --exportServices <value>  Write services to disk (default: true)
     --exportModels <value>    Write models to disk (default: true)

bin/index.js

@@ -16,6 +16,7 @@ const params = program
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
+    .option('--useNullForNoContent', 'Use null for returning instead of undefined if a response returns 204 no content')
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
@@ -37,6 +38,7 @@ if (OpenAPI) {
         clientName: params.name,
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
+        useNullForNoContent: params.useNullForNoContent,
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,

bin/index.spec.js

@@ -24,6 +24,7 @@ describe('bin', () => {
             'fetch',
             '--useOptions',
             '--useUnionTypes',
+            '--useNullForNoContent',
             '--exportCore',
             'true',
             '--exportServices',

docs/basic-usage.md

@@ -13,6 +13,7 @@ $ openapi --help
     --name <value>            Custom client class name
     --useOptions              Use options instead of arguments
     --useUnionTypes           Use union types instead of enums
+    --useNullForNoContent     Use null for returning instead of undefined if a response returns 204 no content
     --exportCore <value>      Write core files to disk (default: true)
     --exportServices <value>  Write services to disk (default: true)
     --exportModels <value>    Write models to disk (default: true)

src/index.ts

@@ -19,6 +19,7 @@ export type Options = {
     clientName?: string;
     useOptions?: boolean;
     useUnionTypes?: boolean;
+    useNullForNoContent?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
     exportModels?: boolean;
@@ -40,6 +41,7 @@ export type Options = {
  * @param clientName Custom client class name
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums
+ * @param useNullForNoContent Use null for no content responses
  * @param exportCore Generate core client classes
  * @param exportServices Generate services
  * @param exportModels Generate models
@@ -57,6 +59,7 @@ export const generate = async ({
     clientName,
     useOptions = false,
     useUnionTypes = false,
+    useNullForNoContent = false,
     exportCore = true,
     exportServices = true,
     exportModels = true,
@@ -72,6 +75,7 @@ export const generate = async ({
     const templates = registerHandlebarTemplates({
         httpClient,
         useUnionTypes,
+        useNullForNoContent,
         useOptions,
     });
 
@@ -87,6 +91,7 @@ export const generate = async ({
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                useNullForNoContent,
                 exportCore,
                 exportServices,
                 exportModels,
@@ -111,6 +116,7 @@ export const generate = async ({
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                useNullForNoContent,
                 exportCore,
                 exportServices,
                 exportModels,

src/templates/core/angular/getResponseBody.hbs

@@ -1,6 +1,11 @@
-export const getResponseBody = <T>(response: HttpResponse<T>): T | undefined => {
+export const getResponseBody = <T>(response: HttpResponse<T>): T | {{#if @root.useNullForNoContent}}null{{else}}undefined{{/if}} => {
+
 	if (response.status !== 204 && response.body !== null) {
 		return response.body;
 	}
+	{{#if @root.useNullForNoContent}}
+	return null;
+	{{else}}
 	return undefined;
+	{{/if}}
 };

src/templates/core/axios/getResponseBody.hbs

@@ -2,5 +2,9 @@ export const getResponseBody = (response: AxiosResponse<any>): any => {
 	if (response.status !== 204) {
 		return response.data;
 	}
+	{{#if @root.useNullForNoContent}}
+	return null;
+	{{else}}
 	return undefined;
+	{{/if}}
 };

src/templates/core/fetch/getResponseBody.hbs

@@ -15,5 +15,9 @@ export const getResponseBody = async (response: Response): Promise<any> => {
 			console.error(error);
 		}
 	}
+	{{#if @root.useNullForNoContent}}
+	return null;
+	{{else}}
 	return undefined;
+	{{/if}}
 };

src/templates/core/node/getResponseBody.hbs

@@ -15,5 +15,9 @@ export const getResponseBody = async (response: Response): Promise<any> => {
 			console.error(error);
 		}
 	}
+	{{#if @root.useNullForNoContent}}
+	return null;
+	{{else}}
 	return undefined;
+	{{/if}}
 };

src/templates/core/xhr/getResponseBody.hbs

@@ -15,5 +15,9 @@ export const getResponseBody = (xhr: XMLHttpRequest): any => {
 			console.error(error);
 		}
 	}
+	{{#if @root.useNullForNoContent}}
+	return null;
+	{{else}}
 	return undefined;
+	{{/if}}
 };

src/utils/registerHandlebarTemplates.spec.ts

@@ -7,6 +7,7 @@ describe('registerHandlebarTemplates', () => {
             httpClient: HttpClient.FETCH,
             useOptions: false,
             useUnionTypes: false,
+            useNullForNoContent: false,
         });
         expect(templates.index).toBeDefined();
         expect(templates.exports.model).toBeDefined();

src/utils/registerHandlebarTemplates.ts

@@ -113,6 +113,7 @@ export const registerHandlebarTemplates = (root: {
     httpClient: HttpClient;
     useOptions: boolean;
     useUnionTypes: boolean;
+    useNullForNoContent: boolean;
 }): Templates => {
     registerHandlebarHelpers(root);
 

src/utils/writeClient.spec.ts

@@ -43,6 +43,7 @@ describe('writeClient', () => {
             HttpClient.FETCH,
             false,
             false,
+            false,
             true,
             true,
             true,

src/utils/writeClient.ts

@@ -40,6 +40,7 @@ export const writeClient = async (
     httpClient: HttpClient,
     useOptions: boolean,
     useUnionTypes: boolean,
+    useNullForNoContent: boolean,
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
@@ -63,7 +64,7 @@ export const writeClient = async (
     if (exportCore) {
         await rmdir(outputPathCore);
         await mkdir(outputPathCore);
-        await writeClientCore(client, templates, outputPathCore, httpClient, indent, clientName, request);
+        await writeClientCore(client, templates, outputPathCore, httpClient, indent, clientName, request, useNullForNoContent);
     }
 
     if (exportServices) {

src/utils/writeClientCore.ts

@@ -26,7 +26,8 @@ export const writeClientCore = async (
     httpClient: HttpClient,
     indent: Indent,
     clientName?: string,
-    request?: string
+    request?: string,
+    useNullForNoContent?: boolean,
 ): Promise<void> => {
     const httpRequest = getHttpRequestName(httpClient);
     const context = {
@@ -35,6 +36,7 @@ export const writeClientCore = async (
         httpRequest,
         server: client.server,
         version: client.version,
+        useNullForNoContent,
     };
 
     await writeFile(resolve(outputPath, 'OpenAPI.ts'), i(templates.core.settings(context), indent));

test/index.js

@@ -10,6 +10,7 @@ const generate = async (input, output) => {
         httpClient: OpenAPI.HttpClient.FETCH,
         useOptions: true,
         useUnionTypes: false,
+        useNullForNoContent: false,
         exportCore: true,
         exportSchemas: true,
         exportModels: true,

test/index.spec.ts

@@ -11,6 +11,7 @@ describe('v2', () => {
             httpClient: HttpClient.FETCH,
             useOptions: false,
             useUnionTypes: false,
+            useNullForNoContent: false,
             exportCore: true,
             exportSchemas: true,
             exportModels: true,
@@ -32,6 +33,7 @@ describe('v3', () => {
             httpClient: HttpClient.FETCH,
             useOptions: false,
             useUnionTypes: false,
+            useNullForNoContent: false,
             exportCore: true,
             exportSchemas: true,
             exportModels: true,

types/index.d.ts

@@ -19,6 +19,7 @@ export type Options = {
     clientName?: string;
     useOptions?: boolean;
     useUnionTypes?: boolean;
+    useNullForNoContent?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
     exportModels?: boolean;