feat: Adding support for response headers

examples/output/github/hooks/fetcher.ts → custom-fetcher/index.ts

@@ -8,12 +8,29 @@ export interface FetcherOptions<TQueryParams = never, TBody = never, THeaderPara
 
 const JSON_HEADERS = ['application/json'];
 
+export interface PaginationHeaders {
+	total?: number | null;
+	totalPages?: number | null;
+	perPage?: number | null;
+	nextPage?: number | null;
+	prevPage?: number | null;
+}
+
+interface ResponseContainer<TResponse> {
+	content: TResponse;
+	headers: {
+		pagination: PaginationHeaders;
+	};
+}
+
 export async function fetcher<
 	TResponse = unknown,
 	TQueryParams = never,
 	TBody = never,
 	THeaderParams = HeadersInit,
->(options: FetcherOptions<TQueryParams, TBody, THeaderParams>): Promise<TResponse> {
+>(
+	options: FetcherOptions<TQueryParams, TBody, THeaderParams>,
+): Promise<ResponseContainer<TResponse>> {
 	const { body, url, queryParams, headers, ...rest } = options;
 
 	const response = await fetch(url, {

examples/oats.config.ts

@@ -8,10 +8,22 @@ export default defineConfig({
 			output: './output/petstore-swagger',
 			url: 'https://petstore.swagger.io/v2/swagger.json',
 			fileHeader: '/* This is a sample header */',
+			genOnlyUsed: true,
+			plugins: [
+				reactQueryPlugin({
+					customFetcher: '../../../../custom-fetcher/index.js',
+				}),
+			],
 		},
 		'petstore-openapi-v3.0': {
 			output: './output/petstore-openapi-v3.0',
 			file: './schemas/petstore-v3.yaml',
+			genOnlyUsed: true,
+			plugins: [
+				reactQueryPlugin({
+					customFetcher: '../../../../custom-fetcher/index.js',
+				}),
+			],
 		},
 		github: {
 			url: 'https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.yaml',
@@ -20,6 +32,7 @@ export default defineConfig({
 			plugins: [
 				reactQueryPlugin({
 					allowedOperationIds: ['repos/list-for-authenticated-user'],
+					customFetcher: '../../../../custom-fetcher/index.js',
 				}),
 			],
 		},

examples/output/github/hooks/useReposListForAuthenticatedUserQuery.ts

@@ -8,7 +8,7 @@ import type { NotModifiedResponse } from '../responses/NotModifiedResponse';
 import type { RequiresAuthenticationResponse } from '../responses/RequiresAuthenticationResponse';
 import type { ForbiddenResponse } from '../responses/ForbiddenResponse';
 import type { ValidationFailedResponse } from '../responses/ValidationFailedResponse';
-import { fetcher, FetcherOptions } from './fetcher';
+import { fetcher, FetcherOptions } from '../../../../custom-fetcher/index.js';
 
 export interface ReposListForAuthenticatedUserQueryQueryParams {
 	/**
@@ -59,9 +59,14 @@ export interface ReposListForAuthenticatedUserProps
 	queryParams: ReposListForAuthenticatedUserQueryQueryParams;
 }
 
+export interface ReposListForAuthenticatedUserResponseContainer {
+	content: ReposListForAuthenticatedUserOkResponse;
+	headers: Record<string, any>;
+}
+
 export function reposListForAuthenticatedUser(
 	props: ReposListForAuthenticatedUserProps,
-): Promise<ReposListForAuthenticatedUserOkResponse> {
+): Promise<ReposListForAuthenticatedUserResponseContainer> {
 	return fetcher<
 		ReposListForAuthenticatedUserOkResponse,
 		ReposListForAuthenticatedUserQueryQueryParams,
@@ -82,14 +87,14 @@ export function useReposListForAuthenticatedUserQuery(
 	props: ReposListForAuthenticatedUserProps,
 	options?: Omit<
 		UseQueryOptions<
-			ReposListForAuthenticatedUserOkResponse,
+			ReposListForAuthenticatedUserResponseContainer,
 			ReposListForAuthenticatedUserErrorResponse
 		>,
 		'queryKey' | 'queryFn'
 	>,
 ) {
 	return useQuery<
-		ReposListForAuthenticatedUserOkResponse,
+		ReposListForAuthenticatedUserResponseContainer,
 		ReposListForAuthenticatedUserErrorResponse
 	>(
 		['repos/list-for-authenticated-user', props.queryParams],

examples/output/github/index.ts

@@ -14,7 +14,6 @@ export type { RequiresAuthenticationResponse } from './responses/RequiresAuthent
 export type { ValidationFailedResponse } from './responses/ValidationFailedResponse';
 export type { BasicError } from './schemas/BasicError';
 export type { NullableLicenseSimple } from './schemas/NullableLicenseSimple';
-export type { NullableSimpleUser } from './schemas/NullableSimpleUser';
 export type { Repository } from './schemas/Repository';
 export type { SimpleUser } from './schemas/SimpleUser';
 export type { ValidationError } from './schemas/ValidationError';