refactor: typed the response types

src/lib/types.ts

@@ -1,3 +1,5 @@
+import { StorageError } from './errors'
+
 export interface Bucket {
   id: string
   name: string
@@ -109,3 +111,28 @@ export interface TransformOptions {
    */
   format?: 'origin'
 }
+
+type StorageUploadResponseData =
+  | { path: string }
+  | { message: string }
+  | { signedUrl: string }
+  | {
+      signedUrl: string
+      token: string
+      path: string
+    }
+  | {
+      error: string | null
+      path: string | null
+      signedUrl: string
+    }[]
+
+export type StorageUploadResponse =
+  | {
+      data: StorageUploadResponseData
+      error: null
+    }
+  | {
+      data: null
+      error: StorageError
+    }

src/packages/StorageBucketApi.ts

@@ -2,7 +2,7 @@ import { DEFAULT_HEADERS } from '../lib/constants'
 import { isStorageError, StorageError } from '../lib/errors'
 import { Fetch, get, post, put, remove } from '../lib/fetch'
 import { resolveFetch } from '../lib/helpers'
-import { Bucket } from '../lib/types'
+import { Bucket, StorageUploadResponse } from '../lib/types'
 
 export default class StorageBucketApi {
   protected url: string
@@ -143,16 +143,7 @@ export default class StorageBucketApi {
       fileSizeLimit?: number | string | null
       allowedMimeTypes?: string[] | null
     }
-  ): Promise<
-    | {
-        data: { message: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  ): Promise<StorageUploadResponse> {
     try {
       const data = await put(
         this.fetch,
@@ -181,18 +172,7 @@ export default class StorageBucketApi {
    *
    * @param id The unique identifier of the bucket you would like to empty.
    */
-  async emptyBucket(
-    id: string
-  ): Promise<
-    | {
-        data: { message: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  async emptyBucket(id: string): Promise<StorageUploadResponse> {
     try {
       const data = await post(
         this.fetch,
@@ -216,18 +196,7 @@ export default class StorageBucketApi {
    *
    * @param id The unique identifier of the bucket you would like to delete.
    */
-  async deleteBucket(
-    id: string
-  ): Promise<
-    | {
-        data: { message: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  async deleteBucket(id: string): Promise<StorageUploadResponse> {
     try {
       const data = await remove(
         this.fetch,

src/packages/StorageFileApi.ts

@@ -7,6 +7,7 @@ import {
   SearchOptions,
   FetchParameters,
   TransformOptions,
+  StorageUploadResponse,
 } from '../lib/types'
 
 const DEFAULT_SEARCH_OPTIONS = {
@@ -66,16 +67,7 @@ export default class StorageFileApi {
     path: string,
     fileBody: FileBody,
     fileOptions?: FileOptions
-  ): Promise<
-    | {
-        data: { id: string, path: string, fullPath: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  ): Promise<StorageUploadResponse> {
     try {
       let body
       const options = { ...DEFAULT_FILE_OPTIONS, ...fileOptions }
@@ -136,16 +128,7 @@ export default class StorageFileApi {
     path: string,
     fileBody: FileBody,
     fileOptions?: FileOptions
-  ): Promise<
-    | {
-        data: { path: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  ): Promise<StorageUploadResponse> {
     return this.uploadOrUpdate('POST', path, fileBody, fileOptions)
   }
 
@@ -220,18 +203,7 @@ export default class StorageFileApi {
    * They are valid for 2 hours.
    * @param path The file path, including the current file name. For example `folder/image.png`.
    */
-  async createSignedUploadUrl(
-    path: string
-  ): Promise<
-    | {
-        data: { signedUrl: string; token: string; path: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  async createSignedUploadUrl(path: string): Promise<StorageUploadResponse> {
     try {
       let _path = this._getFinalPath(path)
 
@@ -280,16 +252,7 @@ export default class StorageFileApi {
       | URLSearchParams
       | string,
     fileOptions?: FileOptions
-  ): Promise<
-    | {
-        data: { path: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  ): Promise<StorageUploadResponse> {
     return this.uploadOrUpdate('PUT', path, fileBody, fileOptions)
   }
 
@@ -299,19 +262,7 @@ export default class StorageFileApi {
    * @param fromPath The original file path, including the current file name. For example `folder/image.png`.
    * @param toPath The new file path, including the new file name. For example `folder/image-new.png`.
    */
-  async move(
-    fromPath: string,
-    toPath: string
-  ): Promise<
-    | {
-        data: { message: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  async move(fromPath: string, toPath: string): Promise<StorageUploadResponse> {
     try {
       const data = await post(
         this.fetch,
@@ -335,19 +286,7 @@ export default class StorageFileApi {
    * @param fromPath The original file path, including the current file name. For example `folder/image.png`.
    * @param toPath The new file path, including the new file name. For example `folder/image-copy.png`.
    */
-  async copy(
-    fromPath: string,
-    toPath: string
-  ): Promise<
-    | {
-        data: { path: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  async copy(fromPath: string, toPath: string): Promise<StorageUploadResponse> {
     try {
       const data = await post(
         this.fetch,
@@ -377,16 +316,7 @@ export default class StorageFileApi {
     path: string,
     expiresIn: number,
     options?: { download?: string | boolean; transform?: TransformOptions }
-  ): Promise<
-    | {
-        data: { signedUrl: string }
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  ): Promise<StorageUploadResponse> {
     try {
       let _path = this._getFinalPath(path)
 
@@ -422,16 +352,7 @@ export default class StorageFileApi {
     paths: string[],
     expiresIn: number,
     options?: { download: string | boolean }
-  ): Promise<
-    | {
-        data: { error: string | null; path: string | null; signedUrl: string }[]
-        error: null
-      }
-    | {
-        data: null
-        error: StorageError
-      }
-  > {
+  ): Promise<StorageUploadResponse> {
     try {
       const data = await post(
         this.fetch,