feat: support nextjs customized fetch

Author: pycxxx

bin/index.js

@@ -12,7 +12,7 @@ const params = program
     .version(pkg.version)
     .requiredOption('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)')
     .requiredOption('-o, --output <value>', 'Output directory (required)')
-    .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular]', 'fetch')
+    .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular, nextjs]', 'fetch')
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')

src/HttpClient.ts

@@ -4,4 +4,5 @@ export enum HttpClient {
     NODE = 'node',
     AXIOS = 'axios',
     ANGULAR = 'angular',
+    NEXTJS = 'nextjs',
 }

src/index.ts

@@ -36,7 +36,7 @@ export type Options = {
  * service layer, etc.
  * @param input The relative ___location of the OpenAPI spec
  * @param output The relative ___location of the output directory
- * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param httpClient The selected httpClient (fetch, xhr, node, axios or nextjs)
  * @param clientName Custom client class name
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums

src/templates/core/ApiRequestOptions.hbs

@@ -1,6 +1,6 @@
 {{>header}}
 
-export type ApiRequestOptions = {
+export type ApiRequestOptions<ClientOptions extends object = {}> = {
 	readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
 	readonly url: string;
 	readonly path?: Record<string, any>;
@@ -12,4 +12,5 @@ export type ApiRequestOptions = {
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
 	readonly errors?: Record<number, string>;
+	readonly clientOptions?: ClientOptions;
 };

src/templates/core/nextjs/request.hbs

@@ -0,0 +1,101 @@
+{{>header}}
+
+import { ApiError } from './ApiError';
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+import { CancelablePromise } from './CancelablePromise';
+import type { OnCancel } from './CancelablePromise';
+import type { OpenAPIConfig } from './OpenAPI';
+
+{{>functions/isDefined}}
+
+
+{{>functions/isString}}
+
+
+{{>functions/isStringWithValue}}
+
+
+{{>functions/isBlob}}
+
+
+{{>functions/isFormData}}
+
+
+{{>functions/base64}}
+
+
+{{>functions/getQueryString}}
+
+
+{{>functions/getUrl}}
+
+
+{{>functions/getFormData}}
+
+
+{{>functions/resolve}}
+
+
+{{>fetch/getHeaders}}
+
+
+{{>fetch/getRequestBody}}
+
+
+{{>nextjs/sendRequest}}
+
+
+{{>fetch/getResponseHeader}}
+
+
+{{>fetch/getResponseBody}}
+
+
+{{>functions/catchErrorCodes}}
+
+interface ClientOptions {
+	cache?: 'force-cache' | 'no-store';
+	next?: {
+		revalidate?: false | number;
+		tags?: Array<string>;
+	};
+}
+
+/**
+ * Request method
+ * @param config The OpenAPI configuration object
+ * @param options The request options from the service
+ * @returns CancelablePromise<T>
+ * @throws ApiError
+ */
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<ClientOptions>): CancelablePromise<T> => {
+	return new CancelablePromise(async (resolve, reject, onCancel) => {
+		try {
+			const url = getUrl(config, options);
+			const formData = getFormData(options);
+			const body = getRequestBody(options);
+			const headers = await getHeaders(config, options);
+
+			if (!onCancel.isCancelled) {
+				const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
+				const responseBody = await getResponseBody(response);
+				const responseHeader = getResponseHeader(response, options.responseHeader);
+
+				const result: ApiResult = {
+					url,
+					ok: response.ok,
+					status: response.status,
+					statusText: response.statusText,
+					body: responseHeader ?? responseBody,
+				};
+
+				catchErrorCodes(options, result);
+
+				resolve(result.body);
+			}
+		} catch (error) {
+			reject(error);
+		}
+	});
+};

src/templates/core/nextjs/sendRequest.hbs

@@ -0,0 +1,28 @@
+export const sendRequest = async (
+	config: OpenAPIConfig,
+	options: ApiRequestOptions,
+	url: string,
+	body: any,
+	formData: FormData | undefined,
+	headers: Headers,
+	onCancel: OnCancel
+): Promise<Response> => {
+	const controller = new AbortController();
+
+	const request: RequestInit = {
+		headers,
+		body: body ?? formData,
+		method: options.method,
+		signal: controller.signal,
+		cache: options.cache,
+		next: options.next,
+	};
+
+	if (config.WITH_CREDENTIALS) {
+		request.credentials = config.CREDENTIALS;
+	}
+
+	onCancel(() => controller.abort());
+
+	return await fetch(url, request);
+};

src/templates/core/request.hbs

@@ -3,3 +3,4 @@
 {{~#equals @root.httpClient 'axios'}}{{>axios/request}}{{/equals~}}
 {{~#equals @root.httpClient 'angular'}}{{>angular/request}}{{/equals~}}
 {{~#equals @root.httpClient 'node'}}{{>node/request}}{{/equals~}}
+{{~#equals @root.httpClient 'nextjs'}}{{>nextjs/request}}{{/equals~}}

src/utils/getHttpRequestName.ts

@@ -2,7 +2,7 @@ import { HttpClient } from '../HttpClient';
 
 /**
  * Generate the HttpRequest filename based on the selected client
- * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param httpClient The selected httpClient (fetch, xhr, node, axios or nextjs)
  */
 export const getHttpRequestName = (httpClient: HttpClient): string => {
     switch (httpClient) {

src/utils/registerHandlebarTemplates.ts

@@ -38,6 +38,8 @@ import functionIsStringWithValue from '../templates/core/functions/isStringWithV
 import functionIsSuccess from '../templates/core/functions/isSuccess.hbs';
 import functionResolve from '../templates/core/functions/resolve.hbs';
 import templateCoreHttpRequest from '../templates/core/HttpRequest.hbs';
+import nextjsRequest from '../templates/core/nextjs/request.hbs';
+import nextjsSendRequest from '../templates/core/nextjs/sendRequest.hbs';
 import nodeGetHeaders from '../templates/core/node/getHeaders.hbs';
 import nodeGetRequestBody from '../templates/core/node/getRequestBody.hbs';
 import nodeGetResponseBody from '../templates/core/node/getResponseBody.hbs';
@@ -188,6 +190,10 @@ export const registerHandlebarTemplates = (root: {
     Handlebars.registerPartial('fetch/sendRequest', Handlebars.template(fetchSendRequest));
     Handlebars.registerPartial('fetch/request', Handlebars.template(fetchRequest));
 
+    // Specific files for the nextjs client implementation
+    Handlebars.registerPartial('nextjs/sendRequest', Handlebars.template(nextjsSendRequest));
+    Handlebars.registerPartial('nextjs/request', Handlebars.template(nextjsRequest));
+
     // Specific files for the xhr client implementation
     Handlebars.registerPartial('xhr/getHeaders', Handlebars.template(xhrGetHeaders));
     Handlebars.registerPartial('xhr/getRequestBody', Handlebars.template(xhrGetRequestBody));

src/utils/writeClient.ts

@@ -19,7 +19,7 @@ import { writeClientServices } from './writeClientServices';
  * @param client Client object with all the models, services, etc.
  * @param templates Templates wrapper with all loaded Handlebars templates
  * @param output The relative ___location of the output directory
- * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param httpClient The selected httpClient (fetch, xhr, node, axios or nextjs)
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums
  * @param exportCore Generate core client classes