Merge pull request #59 from jordanshatford/feat/support-blob-responses

feat(response): basic support for blob responses
hey-api · Mar 17, 2024 · d370de7 · d370de7
2 parents 3df583a + 640700e
commit d370de7
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 4 deletions.
diff --git a/src/templates/core/fetch/getResponseBody.hbs b/src/templates/core/fetch/getResponseBody.hbs
@@ -3,10 +3,14 @@ export const getResponseBody = async (response: Response): Promise<any> => {
 		try {
 			const contentType = response.headers.get('Content-Type');
 			if (contentType) {
-				const jsonTypes = ['application/json', 'application/problem+json']
+				const jsonTypes = ['application/json', 'application/problem+json'];
+				const binaryTypes = ['audio/', 'image/', 'video/'];
 				const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
+                const isBinary = binaryTypes.some(type => contentType.toLowerCase().startsWith(type));
 				if (isJSON) {
 					return await response.json();
+				} else if (isBinary) {
+					return await response.blob();
 				} else {
 					return await response.text();
 				}

diff --git a/src/templates/core/node/getResponseBody.hbs b/src/templates/core/node/getResponseBody.hbs
@@ -3,10 +3,14 @@ export const getResponseBody = async (response: Response): Promise<any> => {
 		try {
 			const contentType = response.headers.get('Content-Type');
 			if (contentType) {
-				const jsonTypes = ['application/json', 'application/problem+json']
+				const jsonTypes = ['application/json', 'application/problem+json'];
+				const binaryTypes = ['audio/', 'image/', 'video/'];
 				const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
+				const isBinary = binaryTypes.some(type => contentType.toLowerCase().startsWith(type));
 				if (isJSON) {
 					return await response.json();
+				} else if (isBinary) {
+					return await response.blob();
 				} else {
 					return await response.text();
 				}

diff --git a/src/templates/core/xhr/getResponseBody.hbs b/src/templates/core/xhr/getResponseBody.hbs
@@ -3,7 +3,7 @@ export const getResponseBody = (xhr: XMLHttpRequest): any => {
 		try {
 			const contentType = xhr.getResponseHeader('Content-Type');
 			if (contentType) {
-				const jsonTypes = ['application/json', 'application/problem+json']
+				const jsonTypes = ['application/json', 'application/problem+json'];
 				const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
 				if (isJSON) {
 					return JSON.parse(xhr.responseText);

diff --git a/test/__snapshots__/index.spec.ts.snap b/test/__snapshots__/index.spec.ts.snap
@@ -465,9 +465,13 @@ export const getResponseBody = async (response: Response): Promise<any> => {
             const contentType = response.headers.get('Content-Type');
             if (contentType) {
                 const jsonTypes = ['application/json', 'application/problem+json'];
+                const binaryTypes = ['audio/', 'image/', 'video/'];
                 const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
+                const isBinary = binaryTypes.some(type => contentType.toLowerCase().startsWith(type));
                 if (isJSON) {
                     return await response.json();
+                } else if (isBinary) {
+                    return await response.blob();
                 } else {
                     return await response.text();
                 }
@@ -3320,9 +3324,13 @@ export const getResponseBody = async (response: Response): Promise<any> => {
             const contentType = response.headers.get('Content-Type');
             if (contentType) {
                 const jsonTypes = ['application/json', 'application/problem+json'];
+                const binaryTypes = ['audio/', 'image/', 'video/'];
                 const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
+                const isBinary = binaryTypes.some(type => contentType.toLowerCase().startsWith(type));
                 if (isJSON) {
                     return await response.json();
+                } else if (isBinary) {
+                    return await response.blob();
                 } else {
                     return await response.text();
                 }
@@ -4087,9 +4095,13 @@ export const getResponseBody = async (response: Response): Promise<any> => {
             const contentType = response.headers.get('Content-Type');
             if (contentType) {
                 const jsonTypes = ['application/json', 'application/problem+json'];
+                const binaryTypes = ['audio/', 'image/', 'video/'];
                 const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
+                const isBinary = binaryTypes.some(type => contentType.toLowerCase().startsWith(type));
                 if (isJSON) {
                     return await response.json();
+                } else if (isBinary) {
+                    return await response.blob();
                 } else {
                     return await response.text();
                 }
@@ -4399,6 +4411,7 @@ export { DeprecatedService } from './services/DeprecatedService';
 export { DescriptionsService } from './services/DescriptionsService';
 export { DuplicateService } from './services/DuplicateService';
 export { ErrorService } from './services/ErrorService';
+export { FileResponseService } from './services/FileResponseService';
 export { FormDataService } from './services/FormDataService';
 export { HeaderService } from './services/HeaderService';
 export { MultipartService } from './services/MultipartService';
@@ -7587,6 +7600,30 @@ export class ErrorService {
 "
 `;
 
+exports[`v3 should generate: test/generated/v3/services/FileResponseService.ts 1`] = `
+"import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class FileResponseService {
+    /**
+     * @param id
+     * @returns binary Success
+     * @throws ApiError
+     */
+    public static fileResponse(id: string): CancelablePromise<Blob> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v{api-version}/file/{id}',
+            path: {
+                id,
+            },
+        });
+    }
+}
+"
+`;
+
 exports[`v3 should generate: test/generated/v3/services/FormDataService.ts 1`] = `
 "import type { ModelWithString } from '../models/ModelWithString';
 import type { CancelablePromise } from '../core/CancelablePromise';

diff --git a/test/e2e/v3.fetch.spec.ts b/test/e2e/v3.fetch.spec.ts
@@ -75,6 +75,14 @@ describe('v3.fetch', () => {
         expect(result).toBeDefined();
     });
 
+    it('support blob response data', async () => {
+        const result = await browser.evaluate(async () => {
+            const { FileResponseService } = (window as any).api;
+            return await FileResponseService.fileResponse('test');
+        });
+        expect(result).toBeDefined();
+    });
+
     it('can abort the request', async () => {
         let error;
         try {

diff --git a/test/e2e/v3.node.spec.ts b/test/e2e/v3.node.spec.ts
@@ -62,6 +62,12 @@ describe('v3.node', () => {
         expect(result).toBeDefined();
     });
 
+    it('support blob response data', async () => {
+        const { FileResponseService } = require('./generated/v3/node/index.js');
+        const result = await FileResponseService.fileResponse('test');
+        expect(result).toBeDefined();
+    });
+
     it('can abort the request', async () => {
         let error;
         try {

diff --git a/test/spec/v3.json b/test/spec/v3.json
@@ -1229,6 +1229,49 @@
                 }
             }
         },
+        "/api/v{api-version}/file/{id}": {
+            "get": {
+                "tags": [
+                    "FileResponse"
+                ],
+                "operationId": "FileResponse",
+                "parameters": [
+                    {
+                        "name": "id",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    {
+                        "name": "api-version",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "audio/*": {
+                                "schema": {
+                                    "type": "file"
+                                }
+                            },
+                            "video/*": {
+                                "schema": {
+                                    "type": "file"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/api/v{api-version}/complex": {
             "get": {
                 "tags": [
@@ -3135,4 +3178,4 @@
             }
         }
     }
-}
+}