@supabase/supabase-js 1.29.2 → 1.30.1

package/src/SupabaseClient.ts

@@ -1,6 +1,6 @@
 import { DEFAULT_HEADERS, STORAGE_KEY } from './lib/constants'
 import { stripTrailingSlash, isBrowser } from './lib/helpers'
-import { Fetch, SupabaseClientOptions } from './lib/types'
+import { Fetch, GenericObject, SupabaseClientOptions } from './lib/types'
 import { SupabaseAuthClient } from './lib/SupabaseAuthClient'
 import { SupabaseQueryBuilder } from './lib/SupabaseQueryBuilder'
 import { SupabaseStorageClient } from '@supabase/storage-js'
@@ -62,13 +62,13 @@ export default class SupabaseClient {
     if (!supabaseUrl) throw new Error('supabaseUrl is required.')
     if (!supabaseKey) throw new Error('supabaseKey is required.')
 
-    supabaseUrl = stripTrailingSlash(supabaseUrl)
-
+    const _supabaseUrl = stripTrailingSlash(supabaseUrl)
     const settings = { ...DEFAULT_OPTIONS, ...options }
-    this.restUrl = `${supabaseUrl}/rest/v1`
-    this.realtimeUrl = `${supabaseUrl}/realtime/v1`.replace('http', 'ws')
-    this.authUrl = `${supabaseUrl}/auth/v1`
-    this.storageUrl = `${supabaseUrl}/storage/v1`
+
+    this.restUrl = `${_supabaseUrl}/rest/v1`
+    this.realtimeUrl = `${_supabaseUrl}/realtime/v1`.replace('http', 'ws')
+    this.authUrl = `${_supabaseUrl}/auth/v1`
+    this.storageUrl = `${_supabaseUrl}/storage/v1`
     this.schema = settings.schema
     this.multiTab = settings.multiTab
     this.fetch = settings.fetch
@@ -131,45 +131,65 @@ export default class SupabaseClient {
   }
 
   /**
-   * Remove all subscriptions.
+   * Closes and removes all subscriptions and returns a list of removed
+   * subscriptions and their errors.
    */
-  async removeAllSubscriptions() {
-    const subscriptions = this.realtime.channels.slice()
-    return await Promise.allSettled(subscriptions.map((sub) => this.removeSubscription(sub)))
+  async removeAllSubscriptions(): Promise<
+    { data: { subscription: RealtimeSubscription }; error: Error | null }[]
+  > {
+    const allSubs: RealtimeSubscription[] = this.getSubscriptions().slice()
+    const allSubPromises = allSubs.map((sub) => this.removeSubscription(sub))
+    const allRemovedSubs = await Promise.all(allSubPromises)
+
+    return allRemovedSubs.map(({ error }, i) => {
+      return {
+        data: { subscription: allSubs[i] },
+        error,
+      }
+    })
   }
 
   /**
-   * Removes an active subscription and returns the number of open connections.
+   * Closes and removes a subscription and returns the number of open subscriptions.
    *
-   * @param subscription The subscription you want to remove.
+   * @param subscription The subscription you want to close and remove.
    */
-  removeSubscription(subscription: RealtimeSubscription) {
-    return new Promise(async (resolve) => {
-      try {
-        await this._closeSubscription(subscription)
+  async removeSubscription(
+    subscription: RealtimeSubscription
+  ): Promise<{ data: { openSubscriptions: number }; error: Error | null }> {
+    const { error } = await this._closeSubscription(subscription)
+    const allSubs: RealtimeSubscription[] = this.getSubscriptions()
+    const openSubCount = allSubs.filter((chan) => chan.isJoined()).length
 
-        const allSubscriptions = this.getSubscriptions()
-        const openSubscriptionsCount = allSubscriptions.filter((chan) => chan.isJoined()).length
+    if (allSubs.length === 0) await this.realtime.disconnect()
 
-        if (!allSubscriptions.length) {
-          const { error } = await this.realtime.disconnect()
-          if (error) return resolve({ error })
-        }
-        return resolve({ error: null, data: { openSubscriptions: openSubscriptionsCount } })
-      } catch (error) {
-        return resolve({ error })
-      }
-    })
+    return { data: { openSubscriptions: openSubCount }, error }
   }
 
-  private async _closeSubscription(subscription: RealtimeSubscription) {
+  private async _closeSubscription(
+    subscription: RealtimeSubscription
+  ): Promise<{ error: Error | null }> {
+    let error = null
+
     if (!subscription.isClosed()) {
-      await this._closeChannel(subscription)
+      const { error: unsubError } = await this._unsubscribeSubscription(subscription)
+      error = unsubError
     }
 
+    this.realtime.remove(subscription)
+
+    return { error }
+  }
+
+  private _unsubscribeSubscription(
+    subscription: RealtimeSubscription
+  ): Promise<{ error: Error | null }> {
     return new Promise((resolve) => {
-      this.realtime.remove(subscription)
-      return resolve(true)
+      subscription
+        .unsubscribe()
+        .receive('ok', () => resolve({ error: null }))
+        .receive('error', (error: Error) => resolve({ error }))
+        .receive('timeout', () => resolve({ error: new Error('timed out') }))
     })
   }
 
@@ -218,25 +238,14 @@ export default class SupabaseClient {
     })
   }
 
-  private _getAuthHeaders(): { [key: string]: string } {
-    const headers: { [key: string]: string } = this.headers
+  private _getAuthHeaders(): GenericObject {
+    const headers: GenericObject = this.headers
     const authBearer = this.auth.session()?.access_token ?? this.supabaseKey
     headers['apikey'] = this.supabaseKey
     headers['Authorization'] = `Bearer ${authBearer}`
     return headers
   }
 
-  private _closeChannel(subscription: RealtimeSubscription) {
-    return new Promise((resolve, reject) => {
-      subscription
-        .unsubscribe()
-        .receive('ok', () => {
-          return resolve(true)
-        })
-        .receive('error', (e: Error) => reject(e))
-    })
-  }
-
   private _listenForMultiTabEvents() {
     if (!this.multiTab || !isBrowser() || !window?.addEventListener) {
       return null
@@ -289,7 +298,7 @@ export default class SupabaseClient {
       this.changedAccessToken = token
     } else if (event === 'SIGNED_OUT' || event === 'USER_DELETED') {
       // Token is removed
-      this.removeAllSubscriptions()
+      this.realtime.setAuth(this.supabaseKey)
       if (source == 'STORAGE') this.auth.signOut()
     }
   }

package/src/index.ts

@@ -17,7 +17,7 @@ const createClient = (
   supabaseUrl: string,
   supabaseKey: string,
   options?: SupabaseClientOptions
-) => {
+): SupabaseClient => {
   return new SupabaseClient(supabaseUrl, supabaseKey, options)
 }
 

package/src/lib/SupabaseQueryBuilder.ts

@@ -1,12 +1,12 @@
 import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
 import { SupabaseRealtimeClient } from './SupabaseRealtimeClient'
 import { RealtimeClient } from '@supabase/realtime-js'
-import { Fetch, SupabaseEventTypes, SupabaseRealtimePayload } from './types'
+import { Fetch, GenericObject, SupabaseEventTypes, SupabaseRealtimePayload } from './types'
 
 export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
   private _subscription: SupabaseRealtimeClient | null = null
   private _realtime: RealtimeClient
-  private _headers: { [key: string]: string }
+  private _headers: GenericObject
   private _schema: string
   private _table: string
 
@@ -19,7 +19,7 @@ export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
       table,
       fetch,
     }: {
-      headers?: { [key: string]: string }
+      headers?: GenericObject
       schema: string
       realtime: RealtimeClient
       table: string

package/src/lib/SupabaseRealtimeClient.ts

@@ -1,16 +1,11 @@
 import { RealtimeSubscription, RealtimeClient, Transformers } from '@supabase/realtime-js'
-import { SupabaseEventTypes, SupabaseRealtimePayload } from './types'
+import { GenericObject, SupabaseEventTypes, SupabaseRealtimePayload } from './types'
 
 export class SupabaseRealtimeClient {
   subscription: RealtimeSubscription
 
-  constructor(
-    socket: RealtimeClient,
-    headers: { [key: string]: string },
-    schema: string,
-    tableName: string
-  ) {
-    const chanParams: { [key: string]: string } = {}
+  constructor(socket: RealtimeClient, headers: GenericObject, schema: string, tableName: string) {
+    const chanParams: GenericObject = {}
     const topic = tableName === '*' ? `realtime:${schema}` : `realtime:${schema}:${tableName}`
     const userToken = headers['Authorization'].split(' ')[1]
 

package/src/lib/helpers.ts

@@ -8,7 +8,7 @@ export function uuid() {
   })
 }
 
-export function stripTrailingSlash(url: string) {
+export function stripTrailingSlash(url: string): string {
   return url.replace(/\/$/, '')
 }
 

package/src/lib/types.ts

@@ -1,12 +1,14 @@
 import { GoTrueClient } from '@supabase/gotrue-js'
 import { RealtimeClientOptions } from '@supabase/realtime-js'
 
-export type Fetch = typeof fetch
-
 type GoTrueClientOptions = ConstructorParameters<typeof GoTrueClient>[0]
 
 export interface SupabaseAuthClientOptions extends GoTrueClientOptions {}
 
+export type GenericObject = { [key: string]: string }
+
+export type Fetch = typeof fetch
+
 export type SupabaseClientOptions = {
   /**
    * The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'.
@@ -15,7 +17,7 @@ export type SupabaseClientOptions = {
   /**
    * Optional headers for initializing the client.
    */
-  headers?: { [key: string]: string }
+  headers?: GenericObject
   /**
    * Automatically refreshes the token for logged in users.
    */

package/src/lib/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '1.29.2'
+export const version = '1.30.1'