refactor: create a new type to avoid repeat ourselves and add the correct return type for createClient method

Author: ftonato

src/SupabaseClient.ts

@@ -1,5 +1,5 @@
 import { DEFAULT_HEADERS } from './lib/constants'
-import { SupabaseClientOptions } from './lib/types'
+import { GenericObject, SupabaseClientOptions } from './lib/types'
 import { SupabaseAuthClient } from './lib/SupabaseAuthClient'
 import { SupabaseQueryBuilder } from './lib/SupabaseQueryBuilder'
 import { SupabaseStorageClient } from '@supabase/storage-js'
@@ -116,7 +116,7 @@ export default class SupabaseClient {
       try {
         await this._closeSubscription(subscription)
 
-        const openSubscriptions = this.getSubscriptions().length
+        const openSubscriptions = this._getSubscriptions().length
         if (!openSubscriptions) {
           const { error } = await this.realtime.disconnect()
           if (error) return resolve({ error })
@@ -137,7 +137,7 @@ export default class SupabaseClient {
   /**
    * Returns an array of all your subscriptions.
    */
-  getSubscriptions(): RealtimeSubscription[] {
+  _getSubscriptions(): RealtimeSubscription[] {
     return this.realtime.channels
   }
 
@@ -176,8 +176,8 @@ export default class SupabaseClient {
     })
   }
 
-  private _getAuthHeaders(): { [key: string]: string } {
-    const headers: { [key: string]: string } = DEFAULT_HEADERS
+  private _getAuthHeaders(): GenericObject {
+    const headers: GenericObject = DEFAULT_HEADERS
     const authBearer = this.auth.session()?.access_token ?? this.supabaseKey
     headers['apikey'] = this.supabaseKey
     headers['Authorization'] = `Bearer ${authBearer}`

src/index.ts

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

src/lib/SupabaseQueryBuilder.ts

@@ -1,7 +1,7 @@
 import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
 import { SupabaseRealtimeClient } from './SupabaseRealtimeClient'
 import { RealtimeClient } from '@supabase/realtime-js'
-import { SupabaseEventTypes, SupabaseRealtimePayload } from './types'
+import { GenericObject, SupabaseEventTypes, SupabaseRealtimePayload } from './types'
 
 export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
   private _subscription: SupabaseRealtimeClient
@@ -15,7 +15,7 @@ export class SupabaseQueryBuilder<T> extends PostgrestQueryBuilder<T> {
       realtime,
       table,
     }: {
-      headers?: { [key: string]: string }
+      headers?: GenericObject
       schema: string
       realtime: RealtimeClient
       table: string

src/lib/types.ts

@@ -1,6 +1,8 @@
 import { GoTrueClient } from '@supabase/gotrue-js'
 import { RealtimeClientOptions } from '@supabase/realtime-js'
 
+export type GenericObject = { [key: string]: string }
+
 type GoTrueClientOptions = ConstructorParameters<typeof GoTrueClient>[0]
 
 export interface SupabaseAuthClientOptions extends GoTrueClientOptions {}
@@ -13,7 +15,7 @@ export type SupabaseClientOptions = {
   /**
    * Optional headers for initializing the client.
    */
-  headers?: { [key: string]: string }
+  headers?: GenericObject
   /**
    * Automatically refreshes the token for logged in users.
    */