feat: support throwing errors by default

Author: darora

package-lock.json

@@ -38,7 +38,7 @@
   },
   "dependencies": {
     "@supabase/gotrue-js": "^1.22.3",
-    "@supabase/postgrest-js": "^0.36.2",
+    "@supabase/postgrest-js": "^0.37.0",
     "@supabase/realtime-js": "^1.3.6",
     "@supabase/storage-js": "^1.6.4"
   },

package.json

@@ -5,7 +5,7 @@ import { SupabaseAuthClient } from './lib/SupabaseAuthClient'
 import { SupabaseQueryBuilder } from './lib/SupabaseQueryBuilder'
 import { SupabaseStorageClient } from '@supabase/storage-js'
 import { PostgrestClient } from '@supabase/postgrest-js'
-import { AuthChangeEvent, Session, Subscription } from '@supabase/gotrue-js'
+import { AuthChangeEvent } from '@supabase/gotrue-js'
 import { RealtimeClient, RealtimeSubscription, RealtimeClientOptions } from '@supabase/realtime-js'
 
 const DEFAULT_OPTIONS = {
@@ -37,6 +37,8 @@ export default class SupabaseClient {
   protected multiTab: boolean
   protected fetch?: Fetch
   protected changedAccessToken: string | undefined
+  protected shouldThrowOnError: boolean
+
   protected headers: {
     [key: string]: string
   }
@@ -73,6 +75,7 @@ export default class SupabaseClient {
     this.multiTab = settings.multiTab
     this.fetch = settings.fetch
     this.headers = { ...DEFAULT_HEADERS, ...options?.headers }
+    this.shouldThrowOnError = settings.shouldThrowOnError || false
 
     this.auth = this._initSupabaseAuthClient(settings)
     this.realtime = this._initRealtimeClient({ headers: this.headers, ...settings.realtime })
@@ -106,6 +109,7 @@ export default class SupabaseClient {
       realtime: this.realtime,
       table,
       fetch: this.fetch,
+      shouldThrowOnError: this.shouldThrowOnError,
     })
   }
 
@@ -235,6 +239,7 @@ export default class SupabaseClient {
       headers: this._getAuthHeaders(),
       schema: this.schema,
       fetch: this.fetch,
+      throwOnError: this.shouldThrowOnError,
     })
   }
 

src/SupabaseClient.ts

@@ -18,15 +18,17 @@ export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
       realtime,
       table,
       fetch,
+      shouldThrowOnError,
     }: {
       headers?: GenericObject
       schema: string
       realtime: RealtimeClient
       table: string
       fetch?: Fetch
+      shouldThrowOnError?: boolean
     }
   ) {
-    super(url, { headers, schema, fetch })
+    super(url, { headers, schema, fetch, shouldThrowOnError })
 
     this._realtime = realtime
     this._headers = headers

src/lib/SupabaseQueryBuilder.ts

@@ -3,7 +3,7 @@ import { RealtimeClientOptions } from '@supabase/realtime-js'
 
 type GoTrueClientOptions = ConstructorParameters<typeof GoTrueClient>[0]
 
-export interface SupabaseAuthClientOptions extends GoTrueClientOptions {}
+export interface SupabaseAuthClientOptions extends GoTrueClientOptions { }
 
 export type GenericObject = { [key: string]: string }
 
@@ -44,6 +44,11 @@ export type SupabaseClientOptions = {
    * A custom `fetch` implementation.
    */
   fetch?: Fetch
+
+  /**
+   * Throw errors, instead of returning them.
+   */
+  shouldThrowOnError?: boolean
 }
 
 export type SupabaseRealtimePayload<T> = {