- Decoupled OpenAPI object from request files

Author: ferdikoomen

src/templates/core/OpenAPI.hbs

@@ -5,7 +5,7 @@ import type { ApiRequestOptions } from './ApiRequestOptions';
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
 
-type Config = {
+export type OpenAPIConfig = {
 	BASE: string;
 	VERSION: string;
 	WITH_CREDENTIALS: boolean;
@@ -17,7 +17,7 @@ type Config = {
 	ENCODE_PATH?: (path: string) => string;
 };
 
-export const OpenAPI: Config = {
+export const OpenAPI: OpenAPIConfig = {
 	BASE: '{{{server}}}',
 	VERSION: '{{{version}}}',
 	WITH_CREDENTIALS: false,

src/templates/core/axios/getHeaders.hbs

@@ -1,8 +1,8 @@
-async function getHeaders(options: ApiRequestOptions, formData?: FormData): Promise<Record<string, string>> {
-	const token = await resolve(options, OpenAPI.TOKEN);
-	const username = await resolve(options, OpenAPI.USERNAME);
-	const password = await resolve(options, OpenAPI.PASSWORD);
-	const additionalHeaders = await resolve(options, OpenAPI.HEADERS);
+const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions, formData?: FormData): Promise<Record<string, string>> => {
+	const token = await resolve(options, config.TOKEN);
+	const username = await resolve(options, config.USERNAME);
+	const password = await resolve(options, config.PASSWORD);
+	const additionalHeaders = await resolve(options, config.HEADERS);
 	const formHeaders = typeof formData?.getHeaders === 'function' && formData?.getHeaders() || {}
 
 	const headers = Object.entries({
@@ -27,4 +27,4 @@ async function getHeaders(options: ApiRequestOptions, formData?: FormData): Prom
 	}
 
 	return headers;
-}
+};

src/templates/core/axios/getRequestBody.hbs

@@ -1,6 +1,6 @@
-function getRequestBody(options: ApiRequestOptions): any {
+const getRequestBody = (options: ApiRequestOptions): any => {
 	if (options.body) {
 		return options.body;
 	}
 	return;
-}
+};

src/templates/core/axios/getResponseBody.hbs

@@ -1,6 +1,6 @@
-function getResponseBody(response: AxiosResponse<any>): any {
+const getResponseBody = (response: AxiosResponse<any>): any => {
 	if (response.status !== 204) {
 		return response.data;
 	}
 	return;
-}
+};

src/templates/core/axios/getResponseHeader.hbs

@@ -1,9 +1,9 @@
-function getResponseHeader(response: AxiosResponse<any>, responseHeader?: string): string | undefined {
+const getResponseHeader = (response: AxiosResponse<any>, responseHeader?: string): string | undefined => {
 	if (responseHeader) {
 		const content = response.headers[responseHeader];
 		if (isString(content)) {
 			return content;
 		}
 	}
 	return;
-}
+};

src/templates/core/axios/request.hbs

@@ -8,7 +8,7 @@ import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
 import { CancelablePromise } from './CancelablePromise';
 import type { OnCancel } from './CancelablePromise';
-import { OpenAPI } from './OpenAPI';
+import { OpenAPIConfig } from './OpenAPI';
 
 {{>functions/isDefined}}
 
@@ -60,20 +60,21 @@ import { OpenAPI } from './OpenAPI';
 
 /**
  * Request using axios client
+ * @param config The OpenAPI configuration object
  * @param options The request options from the service
  * @returns CancelablePromise<T>
  * @throws ApiError
  */
-export function request<T>(options: ApiRequestOptions): CancelablePromise<T> {
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> => {
 	return new CancelablePromise(async (resolve, reject, onCancel) => {
 		try {
-			const url = getUrl(options);
+			const url = getUrl(config, options);
 			const formData = getFormData(options);
 			const body = getRequestBody(options);
-			const headers = await getHeaders(options, formData);
+			const headers = await getHeaders(config, options, formData);
 
 			if (!onCancel.isCancelled) {
-				const response = await sendRequest(options, url, formData, body, headers, onCancel);
+				const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
 				const responseBody = getResponseBody(response);
 				const responseHeader = getResponseHeader(response, options.responseHeader);
 
@@ -93,5 +94,5 @@ export function request<T>(options: ApiRequestOptions): CancelablePromise<T> {
 			reject(error);
 		}
 	});
-}
+};
 

src/templates/core/axios/sendRequest.hbs

@@ -1,19 +1,20 @@
-async function sendRequest(
+const sendRequest = async (
+	config: OpenAPIConfig,
 	options: ApiRequestOptions,
 	url: string,
 	formData: FormData | undefined,
 	body: any,
 	headers: Record<string, string>,
 	onCancel: OnCancel
-): Promise<AxiosResponse<any>> {
+): Promise<AxiosResponse<any>> => {
 	const source = axios.CancelToken.source();
 
 	const config: AxiosRequestConfig = {
 		url,
 		headers,
 		data: body || formData,
 		method: options.method,
-		withCredentials: OpenAPI.WITH_CREDENTIALS,
+		withCredentials: config.WITH_CREDENTIALS,
 		cancelToken: source.token,
 	};
 
@@ -28,4 +29,4 @@ async function sendRequest(
 		}
 		throw error;
 	}
-}
+};

src/templates/core/fetch/getHeaders.hbs

@@ -1,8 +1,8 @@
-async function getHeaders(options: ApiRequestOptions): Promise<Headers> {
-	const token = await resolve(options, OpenAPI.TOKEN);
-	const username = await resolve(options, OpenAPI.USERNAME);
-	const password = await resolve(options, OpenAPI.PASSWORD);
-	const additionalHeaders = await resolve(options, OpenAPI.HEADERS);
+const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Promise<Headers> => {
+	const token = await resolve(options, config.TOKEN);
+	const username = await resolve(options, config.USERNAME);
+	const password = await resolve(options, config.PASSWORD);
+	const additionalHeaders = await resolve(options, config.HEADERS);
 
 	const defaultHeaders = Object.entries({
 		Accept: 'application/json',
@@ -39,4 +39,4 @@ async function getHeaders(options: ApiRequestOptions): Promise<Headers> {
 	}
 
 	return headers;
-}
+};

src/templates/core/fetch/getRequestBody.hbs

@@ -1,4 +1,4 @@
-function getRequestBody(options: ApiRequestOptions): BodyInit | undefined {
+const getRequestBody = (options: ApiRequestOptions): BodyInit | undefined => {
 	if (options.body) {
 		if (options.mediaType?.includes('/json')) {
 			return JSON.stringify(options.body)
@@ -9,4 +9,4 @@ function getRequestBody(options: ApiRequestOptions): BodyInit | undefined {
 		}
 	}
 	return;
-}
+};

src/templates/core/fetch/getResponseBody.hbs

@@ -1,4 +1,4 @@
-async function getResponseBody(response: Response): Promise<any> {
+const getResponseBody = async (response: Response): Promise<any> => {
 	if (response.status !== 204) {
 		try {
 			const contentType = response.headers.get('Content-Type');
@@ -15,4 +15,4 @@ async function getResponseBody(response: Response): Promise<any> {
 		}
 	}
 	return;
-}
+};