@supabase/storage-js 1.7.1 → 1.8.0-next.1

package/src/lib/StorageFileApi.ts

@@ -1,3 +1,4 @@
+import { isStorageError, StorageError } from './errors'
 import { Fetch, FetchParameters, get, post, remove } from './fetch'
 import { resolveFetch } from './helpers'
 import { FileObject, FileOptions, SearchOptions } from './types'
@@ -61,7 +62,16 @@ export class StorageFileApi {
       | URLSearchParams
       | string,
     fileOptions?: FileOptions
-  ): Promise<{ data: { Key: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { path: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       let body
       const options = { ...DEFAULT_FILE_OPTIONS, ...fileOptions }
@@ -92,15 +102,20 @@ export class StorageFileApi {
       })
 
       if (res.ok) {
-        // const data = await res.json()
-        // temporary fix till backend is updated to the latest storage-api version
-        return { data: { Key: _path }, error: null }
+        return {
+          data: { path: cleanPath },
+          error: null,
+        }
       } else {
         const error = await res.json()
         return { data: null, error }
       }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -128,7 +143,16 @@ export class StorageFileApi {
       | URLSearchParams
       | string,
     fileOptions?: FileOptions
-  ): Promise<{ data: { Key: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { path: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     return this.uploadOrUpdate('POST', path, fileBody, fileOptions)
   }
 
@@ -156,7 +180,16 @@ export class StorageFileApi {
       | URLSearchParams
       | string,
     fileOptions?: FileOptions
-  ): Promise<{ data: { Key: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { path: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     return this.uploadOrUpdate('PUT', path, fileBody, fileOptions)
   }
 
@@ -169,7 +202,16 @@ export class StorageFileApi {
   async move(
     fromPath: string,
     toPath: string
-  ): Promise<{ data: { message: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { message: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await post(
         this.fetch,
@@ -179,7 +221,11 @@ export class StorageFileApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -192,7 +238,16 @@ export class StorageFileApi {
   async copy(
     fromPath: string,
     toPath: string
-  ): Promise<{ data: { message: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { message: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await post(
         this.fetch,
@@ -202,7 +257,11 @@ export class StorageFileApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -215,11 +274,18 @@ export class StorageFileApi {
   async createSignedUrl(
     path: string,
     expiresIn: number
-  ): Promise<{
-    data: { signedURL: string } | null
-    error: Error | null
-    signedURL: string | null
-  }> {
+  ): Promise<
+    | {
+        data: { signedURL: string }
+        error: null
+        signedURL: string
+      }
+    | {
+        data: null
+        error: StorageError
+        signedURL: null
+      }
+  > {
     try {
       const _path = this._getFinalPath(path)
       let data = await post(
@@ -232,7 +298,11 @@ export class StorageFileApi {
       data = { signedURL }
       return { data, error: null, signedURL }
     } catch (error) {
-      return { data: null, error, signedURL: null }
+      if (isStorageError(error)) {
+        return { data: null, error, signedURL: null }
+      }
+
+      throw error
     }
   }
 
@@ -245,10 +315,16 @@ export class StorageFileApi {
   async createSignedUrls(
     paths: string[],
     expiresIn: number
-  ): Promise<{
-    data: { error: string | null; path: string | null; signedURL: string }[] | null
-    error: Error | null
-  }> {
+  ): Promise<
+    | {
+        data: { error: string | null; path: string | null; signedURL: string }[]
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await post(
         this.fetch,
@@ -264,7 +340,11 @@ export class StorageFileApi {
         error: null,
       }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -273,7 +353,18 @@ export class StorageFileApi {
    *
    * @param path The file path to be downloaded, including the path and file name. For example `folder/image.png`.
    */
-  async download(path: string): Promise<{ data: Blob | null; error: Error | null }> {
+  async download(
+    path: string
+  ): Promise<
+    | {
+        data: Blob
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const _path = this._getFinalPath(path)
       const res = await get(this.fetch, `${this.url}/object/${_path}`, {
@@ -283,30 +374,22 @@ export class StorageFileApi {
       const data = await res.blob()
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
   /**
-   * Retrieve URLs for assets in public buckets
+   * Retrieve URLs for assets in public buckets and encapsulates it in a return object
    *
    * @param path The file path to be downloaded, including the path and file name. For example `folder/image.png`.
    */
-  getPublicUrl(
-    path: string
-  ): {
-    data: { publicURL: string } | null
-    error: Error | null
-    publicURL: string | null
-  } {
-    try {
-      const _path = this._getFinalPath(path)
-      const publicURL = `${this.url}/object/public/${_path}`
-      const data = { publicURL }
-      return { data, error: null, publicURL }
-    } catch (error) {
-      return { data: null, error, publicURL: null }
-    }
+  getPublicUrl(path: string): string {
+    const _path = this._getFinalPath(path)
+    return `${this.url}/object/public/${_path}`
   }
 
   /**
@@ -314,7 +397,18 @@ export class StorageFileApi {
    *
    * @param paths An array of files to be deleted, including the path and file name. For example [`folder/image.png`].
    */
-  async remove(paths: string[]): Promise<{ data: FileObject[] | null; error: Error | null }> {
+  async remove(
+    paths: string[]
+  ): Promise<
+    | {
+        data: FileObject[]
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await remove(
         this.fetch,
@@ -324,7 +418,11 @@ export class StorageFileApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -332,12 +430,27 @@ export class StorageFileApi {
    * Get file metadata
    * @param id the file id to retrieve metadata
    */
-  // async getMetadata(id: string): Promise<{ data: Metadata | null; error: Error | null }> {
+  // async getMetadata(
+  //   id: string
+  // ): Promise<
+  //   | {
+  //       data: Metadata
+  //       error: null
+  //     }
+  //   | {
+  //       data: null
+  //       error: StorageError
+  //     }
+  // > {
   //   try {
-  //     const data = await get(`${this.url}/metadata/${id}`, { headers: this.headers })
+  //     const data = await get(this.fetch, `${this.url}/metadata/${id}`, { headers: this.headers })
   //     return { data, error: null }
   //   } catch (error) {
-  //     return { data: null, error }
+  //     if (isStorageError(error)) {
+  //       return { data: null, error }
+  //     }
+
+  //     throw error
   //   }
   // }
 
@@ -349,26 +462,53 @@ export class StorageFileApi {
   // async updateMetadata(
   //   id: string,
   //   meta: Metadata
-  // ): Promise<{ data: Metadata | null; error: Error | null }> {
+  // ): Promise<
+  //   | {
+  //       data: Metadata
+  //       error: null
+  //     }
+  //   | {
+  //       data: null
+  //       error: StorageError
+  //     }
+  // > {
   //   try {
-  //     const data = await post(`${this.url}/metadata/${id}`, { ...meta }, { headers: this.headers })
+  //     const data = await post(
+  //       this.fetch,
+  //       `${this.url}/metadata/${id}`,
+  //       { ...meta },
+  //       { headers: this.headers }
+  //     )
   //     return { data, error: null }
   //   } catch (error) {
-  //     return { data: null, error }
+  //     if (isStorageError(error)) {
+  //       return { data: null, error }
+  //     }
+
+  //     throw error
   //   }
   // }
 
   /**
    * Lists all the files within a bucket.
    * @param path The folder path.
-   * @param options Search options, including `limit`, `offset`, and `sortBy`.
+   * @param options Search options, including `limit`, `offset`, `sortBy`, and `search`.
    * @param parameters Fetch parameters, currently only supports `signal`, which is an AbortController's signal
    */
   async list(
     path?: string,
     options?: SearchOptions,
     parameters?: FetchParameters
-  ): Promise<{ data: FileObject[] | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: FileObject[]
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const body = { ...DEFAULT_SEARCH_OPTIONS, ...options, prefix: path || '' }
       const data = await post(
@@ -380,7 +520,11 @@ export class StorageFileApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 

package/src/lib/errors.ts

@@ -0,0 +1,40 @@
+export class StorageError extends Error {
+  protected __isStorageError = true
+
+  constructor(message: string) {
+    super(message)
+    this.name = 'StorageError'
+  }
+}
+
+export function isStorageError(error: unknown): error is StorageError {
+  return typeof error === 'object' && error !== null && '__isStorageError' in error
+}
+
+export class StorageApiError extends StorageError {
+  status: number
+
+  constructor(message: string, status: number) {
+    super(message)
+    this.name = 'StorageApiError'
+    this.status = status
+  }
+
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      status: this.status,
+    }
+  }
+}
+
+export class StorageUnknownError extends StorageError {
+  originalError: unknown
+
+  constructor(message: string, originalError: unknown) {
+    super(message)
+    this.name = 'StorageUnknownError'
+    this.originalError = originalError
+  }
+}

package/src/lib/fetch.ts

@@ -1,3 +1,6 @@
+import { StorageApiError, StorageUnknownError } from './errors'
+import { resolveResponse } from './helpers'
+
 export type Fetch = typeof fetch
 
 export interface FetchOptions {
@@ -16,16 +19,16 @@ export type RequestMethodType = 'GET' | 'POST' | 'PUT' | 'DELETE'
 const _getErrorMessage = (err: any): string =>
   err.msg || err.message || err.error_description || err.error || JSON.stringify(err)
 
-const handleError = (error: any, reject: any) => {
-  if (typeof error.json !== 'function') {
-    return reject(error)
-  }
-  error.json().then((err: any) => {
-    return reject({
-      message: _getErrorMessage(err),
-      status: error?.status || 500,
+const handleError = async (error: unknown, reject: (reason?: any) => void) => {
+  const Res = await resolveResponse()
+
+  if (error instanceof Res) {
+    error.json().then((err) => {
+      reject(new StorageApiError(_getErrorMessage(err), error.status || 500))
     })
-  })
+  } else {
+    reject(new StorageUnknownError(_getErrorMessage(error), error))
+  }
 }
 
 const _getRequestParams = (
@@ -57,7 +60,7 @@ async function _handleRequest(
     fetcher(url, _getRequestParams(method, options, parameters, body))
       .then((result) => {
         if (!result.ok) throw result
-        if (options?.noResolveJson) return resolve(result)
+        if (options?.noResolveJson) return result
         return result.json()
       })
       .then((data) => resolve(data))

package/src/lib/helpers.ts

@@ -1,5 +1,3 @@
-import crossFetch from 'cross-fetch'
-
 type Fetch = typeof fetch
 
 export const resolveFetch = (customFetch?: Fetch): Fetch => {
@@ -7,9 +5,17 @@ export const resolveFetch = (customFetch?: Fetch): Fetch => {
   if (customFetch) {
     _fetch = customFetch
   } else if (typeof fetch === 'undefined') {
-    _fetch = (crossFetch as unknown) as Fetch
+    _fetch = async (...args) => await (await import('cross-fetch')).fetch(...args)
   } else {
     _fetch = fetch
   }
   return (...args) => _fetch(...args)
 }
+
+export const resolveResponse = async () => {
+  if (typeof Response === 'undefined') {
+    return (await import('cross-fetch')).Response
+  }
+
+  return Response
+}

package/src/lib/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '0.0.0'
+export const version = '1.8.0-next.1'