(fix) add response headers in fetch client

orval-labs · Nov 9, 2024 · ee8e99d · ee8e99d
1 parent e40b326
commit ee8e99d
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 11 deletions.
diff --git a/docs/src/pages/guides/fetch-client.md b/docs/src/pages/guides/fetch-client.md
@@ -97,7 +97,7 @@ export const useListPets = <TError = Promise<Pets | Error>>(
 #### return original defined return type
 
 When using `fetch` as an `httpClient`, by default the `fetch` response type includes http status.
-If use `swr` or queries, i will be accessing things like `data.data`, which will be noisy so if you want to return a defined return type instead of an automatically generated return type, set `override.fetch.includeHttpStatusReturnType` value to `false`.
+If use `swr` or queries, i will be accessing things like `data.data`, which will be noisy so if you want to return a defined return type instead of an automatically generated return type, set `override.fetch.includeHttpResponseReturnType` value to `false`.
 
 ```js
 module.exports = {
@@ -106,7 +106,7 @@ module.exports = {
       ...
       override: {
         fetch: {
-          includeHttpStatusReturnType: false,
+          includeHttpResponseReturnType: false,
         },
       },
     },

diff --git a/docs/src/pages/reference/configuration/output.md b/docs/src/pages/reference/configuration/output.md
@@ -683,7 +683,7 @@ module.exports = {
       ...
       override: {
         fetch: {
-          includeHttpStatusReturnType: false,
+          includeHttpResponseReturnType: false,
         },
       },
     },
@@ -692,7 +692,7 @@ module.exports = {
 };
 ```
 
-##### includeHttpStatusReturnType
+##### includeHttpResponseReturnType
 
 Type: `Boolean`.
 Default: `true`

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -500,7 +500,7 @@ export type SwrOptions = {
 };
 
 export type FetchOptions = {
-  includeHttpStatusReturnType: boolean;
+  includeHttpResponseReturnType: boolean;
 };
 
 export type InputTransformerFn = (spec: OpenAPIObject) => OpenAPIObject;

diff --git a/packages/fetch/src/index.ts b/packages/fetch/src/index.ts
@@ -109,7 +109,8 @@ ${
     response.definition.success,
     operationName,
   );
-  const responseTypeImplementation = override.fetch.includeHttpResponseReturnType
+  const responseTypeImplementation = override.fetch
+    .includeHttpResponseReturnType
     ? `export type ${responseTypeName} = {
   data: ${response.definition.success || 'unknown'};
   status: number;

diff --git a/packages/orval/src/utils/options.ts b/packages/orval/src/utils/options.ts
@@ -304,8 +304,9 @@ export const normalizeOptions = async (
           provideIn: outputOptions.override?.angular?.provideIn ?? 'root',
         },
         fetch: {
-          includeHttpStatusReturnType:
-            outputOptions.override?.fetch?.includeHttpStatusReturnType ?? true,
+          includeHttpResponseReturnType:
+            outputOptions.override?.fetch?.includeHttpResponseReturnType ??
+            true,
           ...(outputOptions.override?.fetch ?? {}),
         },
         useDates: outputOptions.override?.useDates || false,

diff --git a/packages/swr/src/client.ts b/packages/swr/src/client.ts
@@ -235,13 +235,13 @@ export const getSwrMutationFetcherOptionType = (
 export const getSwrMutationFetcherType = (
   response: GetterResponse,
   httpClient: OutputHttpClient,
-  includeHttpStatusReturnType: boolean,
+  includeHttpResponseReturnType: boolean,
   operationName: string,
   mutator?: GeneratorMutator,
 ) => {
   if (httpClient === OutputHttpClient.FETCH) {
     const responseType = fetchResponseTypeName(
-      includeHttpStatusReturnType,
+      includeHttpResponseReturnType,
       response.definition.success,
       operationName,
     );

diff --git a/packages/swr/src/index.ts b/packages/swr/src/index.ts
@@ -532,7 +532,7 @@ export const ${swrKeyFnName} = (${queryKeyProps}) => [\`${route}\`${
     const swrMutationFetcherType = getSwrMutationFetcherType(
       response,
       httpClient,
-      override.fetch.includeHttpStatusReturnType,
+      override.fetch.includeHttpResponseReturnType,
       operationName,
       mutator,
     );