feat: change Blob to File | ReadStream

aspida · Mar 14, 2021 · 990a31a · 990a31a
1 parent 9d730c9
commit 990a31a
Show file tree

Hide file tree

Showing 22 changed files with 71 additions and 41 deletions.
diff --git a/samples/freee/@types.ts b/samples/freee/@types.ts
@@ -1,4 +1,6 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
+
 export type paymentParams = {
   company_id: number
   date: string
@@ -339,7 +341,7 @@ export type receiptCreateParams = {
   company_id: number
   description?: string
   issue_date?: string
-  receipt: Blob
+  receipt: File | ReadStream
 }
 
 export type receiptUpdateParams = {

diff --git a/samples/openapi/api/v1/parse/image/index.ts b/samples/openapi/api/v1/parse/image/index.ts
@@ -1,4 +1,6 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
+
 export type Methods = {
   post: {
     status: 200
@@ -10,7 +12,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       rightholder?: string
       statusCopyright?: 'unknown' | 'cc' | 'licensed' | 'sublicensed'
     }

diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/audio/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/audio/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       imageId?: string

diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/image/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/image/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       published?: boolean

diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/video/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/video/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       published?: boolean

diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/audio/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/audio/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       imageId?: string

diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/image/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/image/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       published?: boolean

diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/video/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/video/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       published?: boolean

diff --git a/samples/openapi/api/v3/extension/audio/index.ts b/samples/openapi/api/v3/extension/audio/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
     }
   }
 }
diff --git a/samples/openapi/api/v3/extension/image/index.ts b/samples/openapi/api/v3/extension/image/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../@types'
 
 export type Methods = {
@@ -15,7 +16,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
     }
   }
 }
diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/audio/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/audio/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       text?: string

diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/image/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/image/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       text?: string

diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../@types'
 
 export type Methods = {
@@ -28,9 +29,9 @@ export type Methods = {
       quoteSource?: string
       quotePersonHandle?: string
       videoId?: number
-      video?: Blob
+      video?: File | ReadStream
       audioId?: number
-      audio?: Blob
+      audio?: File | ReadStream
       text?: string
       headline?: string
       quoteCreated?: string

diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/video/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/video/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../../../@types'
 
 export type Methods = {
@@ -13,7 +14,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
       caption?: string
       headline?: string
       text?: string

diff --git a/samples/openapi/api/v3/extension/video/index.ts b/samples/openapi/api/v3/extension/video/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../@types'
 
 export type Methods = {
@@ -15,7 +16,7 @@ export type Methods = {
     reqFormat: FormData
 
     reqBody: {
-      file: Blob
+      file: File | ReadStream
     }
   }
 }
diff --git a/samples/openapi/api/v3/user/profile/index.ts b/samples/openapi/api/v3/user/profile/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../../@types'
 
 export type Methods = {
@@ -10,7 +11,7 @@ export type Methods = {
     reqBody: {
       screenName: string
       url: string
-      image: Blob
+      image: File | ReadStream
       imageId: string
     }
   }

diff --git a/samples/simple/$api.ts b/samples/simple/$api.ts
@@ -63,9 +63,9 @@ const api = <T>({ baseURL, fetch }: AspidaClient<T>) => {
         return {
           upload: {
             post: (option: { body: Methods3['post']['reqBody'], query: Methods3['post']['query'], config?: T }) =>
-              fetch<void, BasicHeaders, Methods3['post']['status']>(prefix, `${prefix1}${PATH5}`, POST, option, 'Blob').send(),
+              fetch<void, BasicHeaders, Methods3['post']['status']>(prefix, `${prefix1}${PATH5}`, POST, option).send(),
             $post: (option: { body: Methods3['post']['reqBody'], query: Methods3['post']['query'], config?: T }) =>
-              fetch<void, BasicHeaders, Methods3['post']['status']>(prefix, `${prefix1}${PATH5}`, POST, option, 'Blob').send().then(r => r.body),
+              fetch<void, BasicHeaders, Methods3['post']['status']>(prefix, `${prefix1}${PATH5}`, POST, option).send().then(r => r.body),
             $path: (option?: { method: 'post'; query: Methods3['post']['query'] }) =>
               `${prefix}${prefix1}${PATH5}${option && option.query ? `?${dataToURLString(option.query)}` : ''}`
           }

diff --git a/samples/simple/file/$api.ts b/samples/simple/file/$api.ts
@@ -15,9 +15,9 @@ const api = <T>({ baseURL, fetch }: AspidaClient<T>) => {
       return {
         upload: {
           post: (option: { body: Methods0['post']['reqBody'], query: Methods0['post']['query'], config?: T }) =>
-            fetch<void, BasicHeaders, Methods0['post']['status']>(prefix, `${prefix0}${PATH1}`, POST, option, 'Blob').send(),
+            fetch<void, BasicHeaders, Methods0['post']['status']>(prefix, `${prefix0}${PATH1}`, POST, option).send(),
           $post: (option: { body: Methods0['post']['reqBody'], query: Methods0['post']['query'], config?: T }) =>
-            fetch<void, BasicHeaders, Methods0['post']['status']>(prefix, `${prefix0}${PATH1}`, POST, option, 'Blob').send().then(r => r.body),
+            fetch<void, BasicHeaders, Methods0['post']['status']>(prefix, `${prefix0}${PATH1}`, POST, option).send().then(r => r.body),
           $path: (option?: { method: 'post'; query: Methods0['post']['query'] }) =>
             `${prefix}${prefix0}${PATH1}${option && option.query ? `?${dataToURLString(option.query)}` : ''}`
         }

diff --git a/samples/simple/file/_id@number/upload/index.ts b/samples/simple/file/_id@number/upload/index.ts
@@ -1,11 +1,13 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
+
 export type Methods = {
   post: {
     query: {
       path: string
     }
 
     status: 204
-    reqBody: Blob
+    reqBody: File | ReadStream
   }
 }
diff --git a/samples/swagger/pet/_petId@number/uploadImage/index.ts b/samples/swagger/pet/_petId@number/uploadImage/index.ts
@@ -1,4 +1,5 @@
 /* eslint-disable */
+import type { ReadStream } from 'fs'
 import * as Types from '../../../@types'
 
 export type Methods = {
@@ -9,7 +10,7 @@ export type Methods = {
 
     reqBody: {
       additionalMetadata: string
-      file: Blob
+      file: File | ReadStream
     }
   }
 }
diff --git a/src/buildV3.ts b/src/buildV3.ts
@@ -262,13 +262,15 @@ export default (openapi: OpenAPIV3.Document) => {
 
         if (methods.length) {
           const methodsText = props2String(methods, '')
+          const hasBinary = methodsText.includes('File | ReadStream')
+          const hasTypes = /( |<)Types\./.test(methodsText)
 
           return {
             file,
             methods: `/* eslint-disable */\n${
-              /( |<)Types\./.test(methodsText)
-                ? `import * as Types from '${file.map(() => '').join('../')}@types'\n\n`
-                : ''
+              hasBinary ? "import type { ReadStream } from 'fs'\n" : ''
+            }${hasBinary && !hasTypes ? '\n' : ''}${
+              hasTypes ? `import * as Types from '${file.map(() => '').join('../')}@types'\n\n` : ''
             }export type Methods = ${methodsText}\n`
           }
         } else {
@@ -278,23 +280,30 @@ export default (openapi: OpenAPIV3.Document) => {
       .filter(file => file.methods)
   )
 
+  const typesText =
+    parameters.length + schemas.length
+      ? [
+          ...parameters.map(p => ({
+            name: p.name,
+            text: typeof p.props === 'string' ? p.props : props2String(p.props, '')
+          })),
+          ...schemas.map(s => ({
+            name: s.name,
+            text: value2String(s.value, '').replace(/\n {2}/g, '\n')
+          }))
+        ]
+          .map(p => `\nexport type ${p.name} = ${p.text}\n`)
+          .join('')
+          .replace(/ Types\./g, ' ')
+      : null
+
   return {
     baseURL: openapi.servers?.[0]?.url || '',
     types:
-      parameters.length + schemas.length
-        ? `/* eslint-disable */${[
-            ...parameters.map(p => ({
-              name: p.name,
-              text: typeof p.props === 'string' ? p.props : props2String(p.props, '')
-            })),
-            ...schemas.map(s => ({
-              name: s.name,
-              text: value2String(s.value, '').replace(/\n {2}/g, '\n')
-            }))
-          ]
-            .map(p => `\nexport type ${p.name} = ${p.text}\n`)
-            .join('')}`.replace(/ Types\./g, ' ')
-        : null,
+      typesText &&
+      `/* eslint-disable */${
+        typesText.includes('File | ReadStream') ? "\nimport type { ReadStream } from 'fs'\n" : ''
+      }${typesText}`,
     files
   }
 }
diff --git a/src/builderUtils/converters.ts b/src/builderUtils/converters.ts
@@ -115,7 +115,7 @@ export const schema2value = (
     } else if (schema.properties || schema.additionalProperties) {
       value = object2value(schema)
     } else if (schema.format === 'binary') {
-      value = 'Blob'
+      value = 'File | ReadStream'
     } else if (schema.type !== 'object') {
       value = {
         integer: 'number',