feat(client): use File or Blob for binary types

hey-api · Mar 30, 2024 · 1f8f651 · 1f8f651
1 parent 7b66dfa
commit 1f8f651
Show file tree

Hide file tree

Showing 19 changed files with 36 additions and 35 deletions.
diff --git a/.changeset/odd-oranges-appear.md b/.changeset/odd-oranges-appear.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+Use File or Blob type for binary types
diff --git a/src/templates/partials/base.hbs b/src/templates/partials/base.hbs
@@ -1,9 +1,5 @@
 {{~#equals base 'binary'~}}
-{{~#equals @root.$config.client 'fetch'}}Blob{{/equals~}}
-{{~#equals @root.$config.client 'xhr'}}Blob{{/equals~}}
-{{~#equals @root.$config.client 'axios'}}Blob{{/equals~}}
-{{~#equals @root.$config.client 'angular'}}Blob{{/equals~}}
-{{~#equals @root.$config.client 'node'}}Blob{{/equals~}}
+Blob | File
 {{~else~}}
 {{~#useDateType @root.$config format~}}
 Date

diff --git a/test/__snapshots__/v2/models.ts.snap b/test/__snapshots__/v2/models.ts.snap
@@ -54,7 +54,7 @@ export type NonAsciiStringæøåÆØÅöôêÊ字符串 = string;
 /**
  * This is a simple file
  */
-export type SimpleFile = Blob;
+export type SimpleFile = Blob | File;
 
 /**
  * This is a simple reference
@@ -313,7 +313,7 @@ export type ModelWithReference = {
  */
 export type ModelWithArray = {
     prop?: Array<ModelWithString>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 

diff --git a/test/__snapshots__/v3/models.ts.snap b/test/__snapshots__/v3/models.ts.snap
@@ -54,7 +54,7 @@ export type NonAsciiStringæøåÆØÅöôêÊ字符串 = string;
 /**
  * This is a simple file
  */
-export type SimpleFile = Blob;
+export type SimpleFile = Blob | File;
 
 /**
  * This is a simple reference
@@ -367,7 +367,7 @@ export type ModelWithReference = {
  */
 export type ModelWithArrayReadOnlyAndWriteOnly = {
     prop?: Array<ModelWithReadOnlyAndWriteOnly>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 
@@ -376,7 +376,7 @@ export type ModelWithArrayReadOnlyAndWriteOnly = {
  */
 export type ModelWithArray = {
     prop?: Array<ModelWithString>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 

diff --git a/test/__snapshots__/v3/services/FileResponseService.ts.snap b/test/__snapshots__/v3/services/FileResponseService.ts.snap
@@ -11,7 +11,7 @@ export class FileResponseService {
      * @returns binary Success
      * @throws ApiError
      */
-    public static fileResponse(data: TDataFileResponse): CancelablePromise<Blob> {
+    public static fileResponse(data: TDataFileResponse): CancelablePromise<Blob | File> {
         const { id } = data;
         return __request(OpenAPI, {
             method: 'GET',

diff --git a/test/__snapshots__/v3/services/MultipartService.ts.snap b/test/__snapshots__/v3/services/MultipartService.ts.snap
@@ -5,7 +5,7 @@ import { request as __request } from '../core/request';
 
 export type TDataMultipartRequest = {
     formData?: {
-        content?: Blob;
+        content?: Blob | File;
         data?: ModelWithString | null;
     };
 };
@@ -29,7 +29,7 @@ export class MultipartService {
      * @throws ApiError
      */
     public static multipartResponse(): CancelablePromise<{
-        file?: Blob;
+        file?: Blob | File;
         metadata?: {
             foo?: string;
             bar?: string;

diff --git a/test/__snapshots__/v3/services/UploadService.ts.snap b/test/__snapshots__/v3/services/UploadService.ts.snap
@@ -6,7 +6,7 @@ export type TDataUploadFile = {
     /**
      * Supply a file reference for upload
      */
-    file: Blob;
+    file: Blob | File;
 };
 
 export class UploadService {

diff --git a/test/__snapshots__/v3_angular/models.ts.snap b/test/__snapshots__/v3_angular/models.ts.snap
@@ -54,7 +54,7 @@ export type NonAsciiStringæøåÆØÅöôêÊ字符串 = string;
 /**
  * This is a simple file
  */
-export type SimpleFile = Blob;
+export type SimpleFile = Blob | File;
 
 /**
  * This is a simple reference
@@ -297,7 +297,7 @@ export type ModelWithReference = {
  */
 export type ModelWithArrayReadOnlyAndWriteOnly = {
     prop?: Array<ModelWithReadOnlyAndWriteOnly>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 
@@ -306,7 +306,7 @@ export type ModelWithArrayReadOnlyAndWriteOnly = {
  */
 export type ModelWithArray = {
     prop?: Array<ModelWithString>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 

diff --git a/test/__snapshots__/v3_angular/services/FileResponseService.ts.snap b/test/__snapshots__/v3_angular/services/FileResponseService.ts.snap
@@ -19,7 +19,7 @@ export class FileResponseService {
      * @returns binary Success
      * @throws ApiError
      */
-    public fileResponse(data: TDataFileResponse): Observable<Blob> {
+    public fileResponse(data: TDataFileResponse): Observable<Blob | File> {
         const { id } = data;
         return __request(OpenAPI, this.http, {
             method: 'GET',

diff --git a/test/__snapshots__/v3_angular/services/MultipartService.ts.snap b/test/__snapshots__/v3_angular/services/MultipartService.ts.snap
@@ -7,7 +7,7 @@ import { request as __request } from '../core/request';
 
 export type TDataMultipartRequest = {
     formData?: {
-        content?: Blob;
+        content?: Blob | File;
         data?: ModelWithString | null;
     };
 };
@@ -36,7 +36,7 @@ export class MultipartService {
      * @throws ApiError
      */
     public multipartResponse(): Observable<{
-        file?: Blob;
+        file?: Blob | File;
         metadata?: {
             foo?: string;
             bar?: string;

diff --git a/test/__snapshots__/v3_angular/services/UploadService.ts.snap b/test/__snapshots__/v3_angular/services/UploadService.ts.snap
@@ -9,7 +9,7 @@ export type TDataUploadFile = {
     /**
      * Supply a file reference for upload
      */
-    file: Blob;
+    file: Blob | File;
 };
 
 @Injectable({

diff --git a/test/__snapshots__/v3_client/models.ts.snap b/test/__snapshots__/v3_client/models.ts.snap
@@ -54,7 +54,7 @@ export type NonAsciiStringæøåÆØÅöôêÊ字符串 = string;
 /**
  * This is a simple file
  */
-export type SimpleFile = Blob;
+export type SimpleFile = Blob | File;
 
 /**
  * This is a simple reference
@@ -367,7 +367,7 @@ export type ModelWithReference = {
  */
 export type ModelWithArrayReadOnlyAndWriteOnly = {
     prop?: Array<ModelWithReadOnlyAndWriteOnly>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 
@@ -376,7 +376,7 @@ export type ModelWithArrayReadOnlyAndWriteOnly = {
  */
 export type ModelWithArray = {
     prop?: Array<ModelWithString>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 

diff --git a/test/__snapshots__/v3_client/services/FileResponseService.ts.snap b/test/__snapshots__/v3_client/services/FileResponseService.ts.snap
@@ -12,7 +12,7 @@ export class FileResponseService {
      * @returns binary Success
      * @throws ApiError
      */
-    public fileResponse(data: TDataFileResponse): CancelablePromise<Blob> {
+    public fileResponse(data: TDataFileResponse): CancelablePromise<Blob | File> {
         const { id } = data;
         return this.httpRequest.request({
             method: 'GET',

diff --git a/test/__snapshots__/v3_client/services/MultipartService.ts.snap b/test/__snapshots__/v3_client/services/MultipartService.ts.snap
@@ -4,7 +4,7 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
 
 export type TDataMultipartRequest = {
     formData?: {
-        content?: Blob;
+        content?: Blob | File;
         data?: ModelWithString | null;
     };
 };
@@ -30,7 +30,7 @@ export class MultipartService {
      * @throws ApiError
      */
     public multipartResponse(): CancelablePromise<{
-        file?: Blob;
+        file?: Blob | File;
         metadata?: {
             foo?: string;
             bar?: string;

diff --git a/test/__snapshots__/v3_client/services/UploadService.ts.snap b/test/__snapshots__/v3_client/services/UploadService.ts.snap
@@ -5,7 +5,7 @@ export type TDataUploadFile = {
     /**
      * Supply a file reference for upload
      */
-    file: Blob;
+    file: Blob | File;
 };
 
 export class UploadService {

diff --git a/test/__snapshots__/v3_enums_typescript/models.ts.snap b/test/__snapshots__/v3_enums_typescript/models.ts.snap
@@ -54,7 +54,7 @@ export type NonAsciiStringæøåÆØÅöôêÊ字符串 = string;
 /**
  * This is a simple file
  */
-export type SimpleFile = Blob;
+export type SimpleFile = Blob | File;
 
 /**
  * This is a simple reference
@@ -333,7 +333,7 @@ export type ModelWithReference = {
  */
 export type ModelWithArrayReadOnlyAndWriteOnly = {
     prop?: Array<ModelWithReadOnlyAndWriteOnly>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 
@@ -342,7 +342,7 @@ export type ModelWithArrayReadOnlyAndWriteOnly = {
  */
 export type ModelWithArray = {
     prop?: Array<ModelWithString>;
-    propWithFile?: Array<Blob>;
+    propWithFile?: Array<Blob | File>;
     propWithNumber?: Array<number>;
 };
 

diff --git a/test/__snapshots__/v3_enums_typescript/services/FileResponseService.ts.snap b/test/__snapshots__/v3_enums_typescript/services/FileResponseService.ts.snap
@@ -11,7 +11,7 @@ export class FileResponseService {
      * @returns binary Success
      * @throws ApiError
      */
-    public static fileResponse(data: TDataFileResponse): CancelablePromise<Blob> {
+    public static fileResponse(data: TDataFileResponse): CancelablePromise<Blob | File> {
         const { id } = data;
         return __request(OpenAPI, {
             method: 'GET',

diff --git a/test/__snapshots__/v3_enums_typescript/services/MultipartService.ts.snap b/test/__snapshots__/v3_enums_typescript/services/MultipartService.ts.snap
@@ -5,7 +5,7 @@ import { request as __request } from '../core/request';
 
 export type TDataMultipartRequest = {
     formData?: {
-        content?: Blob;
+        content?: Blob | File;
         data?: ModelWithString | null;
     };
 };
@@ -29,7 +29,7 @@ export class MultipartService {
      * @throws ApiError
      */
     public static multipartResponse(): CancelablePromise<{
-        file?: Blob;
+        file?: Blob | File;
         metadata?: {
             foo?: string;
             bar?: string;

diff --git a/test/__snapshots__/v3_enums_typescript/services/UploadService.ts.snap b/test/__snapshots__/v3_enums_typescript/services/UploadService.ts.snap
@@ -6,7 +6,7 @@ export type TDataUploadFile = {
     /**
      * Supply a file reference for upload
      */
-    file: Blob;
+    file: Blob | File;
 };
 
 export class UploadService {