fix: infer responseType in SDKs for axios client

hey-api · Dec 12, 2024 · 4555796 · 4555796
1 parent 2bf1233
commit 4555796
Show file tree

Hide file tree

Showing 13 changed files with 90 additions and 2 deletions.
diff --git a/.changeset/fresh-feet-exist.md b/.changeset/fresh-feet-exist.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: infer responseType in SDKs for axios client
diff --git a/packages/openapi-ts/src/ir/operation.ts b/packages/openapi-ts/src/ir/operation.ts
@@ -61,7 +61,7 @@ export const operationPagination = ({
 
 type StatusGroup = '1XX' | '2XX' | '3XX' | '4XX' | '5XX' | 'default';
 
-const statusCodeToGroup = ({
+export const statusCodeToGroup = ({
   statusCode,
 }: {
   statusCode: string;

diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts
@@ -5,7 +5,10 @@ import type { ObjectValue } from '../../../compiler/types';
 import { clientApi, clientModulePath } from '../../../generate/client';
 import type { IRContext } from '../../../ir/context';
 import type { IROperationObject } from '../../../ir/ir';
-import { hasOperationDataRequired } from '../../../ir/operation';
+import {
+  hasOperationDataRequired,
+  statusCodeToGroup,
+} from '../../../ir/operation';
 import { escapeComment } from '../../../utils/escape';
 import { getServiceName } from '../../../utils/postprocess';
 import { irRef } from '../../../utils/ref';
@@ -74,6 +77,56 @@ export const operationOptionsType = ({
 
 const sdkId = 'sdk';
 
+/**
+ * Infers `responseType` value from provided response content type. This is
+ * an adapted version of `getParseAs()` from the Fetch API client.
+ *
+ * From Axios documentation:
+ * `responseType` indicates the type of data that the server will respond with
+ * options are: 'arraybuffer', 'document', 'json', 'text', 'stream'
+ * browser only: 'blob'
+ */
+export const getResponseType = (
+  contentType: string | null | undefined,
+):
+  | 'arraybuffer'
+  | 'blob'
+  | 'document'
+  | 'json'
+  | 'stream'
+  | 'text'
+  | undefined => {
+  if (!contentType) {
+    return;
+  }
+
+  const cleanContent = contentType.split(';')[0].trim();
+
+  if (
+    cleanContent.startsWith('application/json') ||
+    cleanContent.endsWith('+json')
+  ) {
+    return 'json';
+  }
+
+  // Axios does not handle form data out of the box
+  // if (cleanContent === 'multipart/form-data') {
+  //   return 'formData';
+  // }
+
+  if (
+    ['application/', 'audio/', 'image/', 'video/'].some((type) =>
+      cleanContent.startsWith(type),
+    )
+  ) {
+    return 'blob';
+  }
+
+  if (cleanContent.startsWith('text/')) {
+    return 'text';
+  }
+};
+
 const operationStatements = ({
   context,
   operation,
@@ -173,6 +226,26 @@ const operationStatements = ({
     });
   }
 
+  if (context.config.client.name === '@hey-api/client-axios') {
+    // try to infer `responseType` option for Axios. We don't need this in
+    // Fetch API client because it automatically detects the correct response
+    // during runtime.
+    for (const statusCode in operation.responses) {
+      // this doesn't handle default status code for now
+      if (statusCodeToGroup({ statusCode }) === '2XX') {
+        const response = operation.responses[statusCode];
+        const responseType = getResponseType(response?.mediaType);
+        // json is the default, skip it
+        if (responseType && responseType !== 'json') {
+          requestOptions.push({
+            key: 'responseType',
+            value: responseType,
+          });
+        }
+      }
+    }
+  }
+
   // TODO: parser - set parseAs to skip inference if every response has the same
   // content type. currently impossible because successes do not contain
   // header information

diff --git a/...ts/test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts b/...ts/test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/svelte-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/svelte-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/vue-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@tanstack/vue-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/...ts/test/__snapshots__/3.1.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts b/...ts/test/__snapshots__/3.1.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/react-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/react-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/solid-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/solid-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/svelte-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/svelte-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };

diff --git a/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/vue-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/3.1.x/plugins/@tanstack/vue-query/axios/sdk.gen.ts
@@ -304,6 +304,7 @@ export const uploadFile = <ThrowOnError extends boolean = false>(options: Option
 export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => {
     return (options?.client ?? client).get<FileResponseResponse, unknown, ThrowOnError>({
         ...options,
+        responseType: 'blob',
         url: '/api/v{api-version}/file/{id}'
     });
 };