feat: improve function return types (#60)

* feat: improve types * chore: better error handling * feat: custom storage api error * chore: use custom error type * chore: update custom error type * chore: replace instanceof with isStorageError * chore: move isStorageError to a non-static method
supabase · Jun 16, 2022 · 767e1df · 767e1df
1 parent 1a7d98c
commit 767e1df
Show file tree

Hide file tree

Showing 9 changed files with 445 additions and 90 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -36,7 +36,7 @@
     "docs:json": "typedoc --json docs/spec.json --mode modules --includeDeclarations --excludeExternals"
   },
   "dependencies": {
-    "cross-fetch": "^3.1.0"
+    "cross-fetch": "^3.1.5"
   },
   "devDependencies": {
     "@types/jest": "^26.0.13",
@@ -51,7 +51,7 @@
     "ts-jest": "^26.3.0",
     "ts-loader": "^8.0.11",
     "typedoc": "^0.19.1",
-    "typescript": "^4.0.2",
+    "typescript": "^4.6.3",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0"
   },

diff --git a/src/index.ts b/src/index.ts
@@ -3,3 +3,4 @@ export {
   StorageClient as SupabaseStorageClient,
 } from './StorageClient'
 export * from './lib/types'
+export * from './lib/errors'
diff --git a/src/lib/StorageBucketApi.ts b/src/lib/StorageBucketApi.ts
@@ -1,4 +1,5 @@
 import { DEFAULT_HEADERS } from './constants'
+import { isStorageError, StorageError } from './errors'
 import { Fetch, get, post, put, remove } from './fetch'
 import { resolveFetch } from './helpers'
 import { Bucket } from './types'
@@ -17,12 +18,25 @@ export class StorageBucketApi {
   /**
    * Retrieves the details of all Storage buckets within an existing project.
    */
-  async listBuckets(): Promise<{ data: Bucket[] | null; error: Error | null }> {
+  async listBuckets(): Promise<
+    | {
+        data: Bucket[]
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await get(this.fetch, `${this.url}/bucket`, { headers: this.headers })
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -31,12 +45,27 @@ export class StorageBucketApi {
    *
    * @param id The unique identifier of the bucket you would like to retrieve.
    */
-  async getBucket(id: string): Promise<{ data: Bucket | null; error: Error | null }> {
+  async getBucket(
+    id: string
+  ): Promise<
+    | {
+        data: Bucket
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await get(this.fetch, `${this.url}/bucket/${id}`, { headers: this.headers })
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -49,7 +78,16 @@ export class StorageBucketApi {
   async createBucket(
     id: string,
     options: { public: boolean } = { public: false }
-  ): Promise<{ data: string | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: string
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await post(
         this.fetch,
@@ -59,7 +97,11 @@ export class StorageBucketApi {
       )
       return { data: data.name, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -71,7 +113,16 @@ export class StorageBucketApi {
   async updateBucket(
     id: string,
     options: { public: boolean }
-  ): Promise<{ data: { message: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { message: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await put(
         this.fetch,
@@ -81,7 +132,11 @@ export class StorageBucketApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -92,7 +147,16 @@ export class StorageBucketApi {
    */
   async emptyBucket(
     id: 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,
@@ -102,7 +166,11 @@ export class StorageBucketApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 
@@ -114,7 +182,16 @@ export class StorageBucketApi {
    */
   async deleteBucket(
     id: string
-  ): Promise<{ data: { message: string } | null; error: Error | null }> {
+  ): Promise<
+    | {
+        data: { message: string }
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
     try {
       const data = await remove(
         this.fetch,
@@ -124,7 +201,11 @@ export class StorageBucketApi {
       )
       return { data, error: null }
     } catch (error) {
-      return { data: null, error }
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
     }
   }
 }