Merge pull request #458 from supabase/j0_revamp_constructor

Revamp Supabase Constructor for V2

Author: J0

src/SupabaseClient.ts

@@ -12,7 +12,7 @@ import { fetchWithAuth } from './lib/fetch'
 import { isBrowser, stripTrailingSlash } from './lib/helpers'
 import { SupabaseAuthClient } from './lib/SupabaseAuthClient'
 import { SupabaseRealtimeClient } from './lib/SupabaseRealtimeClient'
-import { Fetch, GenericSchema, SupabaseClientOptions } from './lib/types'
+import { Fetch, GenericSchema, SupabaseClientOptions, SupabaseAuthClientOptions } from './lib/types'
 
 const DEFAULT_OPTIONS = {
   schema: 'public',
@@ -93,17 +93,17 @@ export default class SupabaseClient<
       this.functionsUrl = `${_supabaseUrl}/functions/v1`
     }
 
-    this.multiTab = settings.multiTab
+    this.multiTab = settings.auth?.multiTab ?? false
     this.headers = { ...DEFAULT_HEADERS, ...options?.headers }
     this.shouldThrowOnError = settings.shouldThrowOnError || false
 
     this.fetch = fetchWithAuth(supabaseKey, this._getAccessToken.bind(this), settings.fetch)
 
-    this.auth = this._initSupabaseAuthClient(settings)
+    this.auth = this._initSupabaseAuthClient(settings.auth || {}, this.headers, this.fetch)
     this.realtime = this._initRealtimeClient({ headers: this.headers, ...settings.realtime })
     this.rest = new PostgrestClient(`${_supabaseUrl}/rest/v1`, {
       headers: this.headers,
-      schema: options?.schema,
+      schema: options?.db?.schema,
       fetch: this.fetch,
       throwOnError: this.shouldThrowOnError,
     })
@@ -261,16 +261,18 @@ export default class SupabaseClient<
     return this.realtime.channels as RealtimeChannel[]
   }
 
-  private _initSupabaseAuthClient({
-    autoRefreshToken,
-    persistSession,
-    detectSessionInUrl,
-    localStorage,
-    headers,
-    fetch,
-    cookieOptions,
-    multiTab,
-  }: SupabaseClientOptions<string>) {
+  private _initSupabaseAuthClient(
+    {
+      autoRefreshToken,
+      persistSession,
+      detectSessionInUrl,
+      localStorage,
+      cookieOptions,
+      multiTab,
+    }: SupabaseAuthClientOptions,
+    headers?: Record<string, string>,
+    fetch?: Fetch
+  ) {
     const authHeaders = {
       Authorization: `Bearer ${this.supabaseKey}`,
       apikey: `${this.supabaseKey}`,

src/lib/types.ts

@@ -11,51 +11,52 @@ export type SupabaseClientOptions<SchemaName> = {
   /**
    * The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'.
    */
-  schema?: SchemaName
-  /**
-   * Optional headers for initializing the client.
-   */
-  headers?: Record<string, string>
-  /**
-   * Automatically refreshes the token for logged in users.
-   */
-  autoRefreshToken?: boolean
-  /**
-   * Allows to enable/disable multi-tab/window events
-   */
-  multiTab?: boolean
-  /**
-   * Whether to persist a logged in session to storage.
-   */
-  persistSession?: boolean
-  /**
-   * Detect a session from the URL. Used for OAuth login callbacks.
-   */
-  detectSessionInUrl?: boolean
-  /**
-   * A storage provider. Used to store the logged in session.
-   */
-  localStorage?: SupabaseAuthClientOptions['localStorage']
+  db?: {
+    schema?: SchemaName
+  }
 
+  auth?: {
+    /**
+     * Automatically refreshes the token for logged in users.
+     */
+    autoRefreshToken?: boolean
+    /**
+     * Whether to persist a logged in session to storage.
+     */
+    persistSession?: boolean
+    /**
+     * Detect a session from the URL. Used for OAuth login callbacks.
+     */
+    detectSessionInUrl?: boolean
+    /**
+     * A storage provider. Used to store the logged in session.
+     */
+    localStorage?: SupabaseAuthClientOptions['localStorage']
+    /**
+     * Options passed to the gotrue-js instance
+     */
+    cookieOptions?: SupabaseAuthClientOptions['cookieOptions']
+    /**
+     * Allows to enable/disable multi-tab/window events
+     */
+    multiTab?: boolean
+  }
   /**
    * Options passed to the realtime-js instance
    */
   realtime?: RealtimeClientOptions
-
   /**
    * A custom `fetch` implementation.
    */
   fetch?: Fetch
-
   /**
-   * Throw errors, instead of returning them.
+   * Optional headers for initializing the client.
    */
-  shouldThrowOnError?: boolean
-
+  headers?: Record<string, string>
   /**
-   * Options passed to the gotrue-js instance
+   * Throw errors, instead of returning them.
    */
-  cookieOptions?: SupabaseAuthClientOptions['cookieOptions']
+  shouldThrowOnError?: boolean
 }
 
 export type SupabaseRealtimePayload<T> = {