@supabase/gotrue-js 1.17.0 → 1.20.0

package/src/GoTrueClient.ts

@@ -1,5 +1,5 @@
-import GoTrueApi from './GoTrueApi'
-import { isBrowser, getParameterByName, uuid, LocalStorage } from './lib/helpers'
+import GoTrueApi, { ApiError } from './GoTrueApi'
+import { isBrowser, getParameterByName, uuid } from './lib/helpers'
 import { GOTRUE_URL, DEFAULT_HEADERS, STORAGE_KEY } from './lib/constants'
 import {
   Session,
@@ -13,6 +13,7 @@ import {
   VerifyOTPParams,
 } from './lib/types'
 import { polyfillGlobalThis } from './lib/polyfills'
+import { Fetch } from './lib/fetch'
 
 polyfillGlobalThis() // Make "globalThis" available
 
@@ -20,10 +21,21 @@ const DEFAULT_OPTIONS = {
   url: GOTRUE_URL,
   autoRefreshToken: true,
   persistSession: true,
-  localStorage: globalThis.localStorage,
   detectSessionInUrl: true,
   headers: DEFAULT_HEADERS,
 }
+
+type AnyFunction = (...args: any[]) => any
+type MaybePromisify<T> = T | Promise<T>
+
+type PromisifyMethods<T> = {
+  [K in keyof T]: T[K] extends AnyFunction
+    ? (...args: Parameters<T[K]>) => MaybePromisify<ReturnType<T[K]>>
+    : T[K]
+}
+
+type SupportedStorage = PromisifyMethods<Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>>
+
 export default class GoTrueClient {
   /**
    * Namespace for the GoTrue API methods.
@@ -41,7 +53,7 @@ export default class GoTrueClient {
 
   protected autoRefreshToken: boolean
   protected persistSession: boolean
-  protected localStorage: Storage
+  protected localStorage: SupportedStorage
   protected stateChangeEmitters: Map<string, Subscription> = new Map()
   protected refreshTokenTimer?: ReturnType<typeof setTimeout>
 
@@ -53,6 +65,8 @@ export default class GoTrueClient {
    * @param options.autoRefreshToken Set to "true" if you want to automatically refresh the token before expiring.
    * @param options.persistSession Set to "true" if you want to automatically save the user session into local storage.
    * @param options.localStorage
+   * @param options.cookieOptions
+   * @param options.fetch A custom fetch implementation.
    */
   constructor(options: {
     url?: string
@@ -60,30 +74,32 @@ export default class GoTrueClient {
     detectSessionInUrl?: boolean
     autoRefreshToken?: boolean
     persistSession?: boolean
-    localStorage?: Storage
+    localStorage?: SupportedStorage
     cookieOptions?: CookieOptions
+    fetch?: Fetch
   }) {
     const settings = { ...DEFAULT_OPTIONS, ...options }
     this.currentUser = null
     this.currentSession = null
     this.autoRefreshToken = settings.autoRefreshToken
     this.persistSession = settings.persistSession
-    this.localStorage = new LocalStorage(settings.localStorage)
+    this.localStorage = settings.localStorage || globalThis.localStorage
     this.api = new GoTrueApi({
       url: settings.url,
       headers: settings.headers,
       cookieOptions: settings.cookieOptions,
+      fetch: settings.fetch,
     })
     this._recoverSession()
     this._recoverAndRefresh()
 
     // Handle the OAuth redirect
-    try {
-      if (settings.detectSessionInUrl && isBrowser() && !!getParameterByName('access_token')) {
-        this.getSessionFromUrl({ storeSession: true })
-      }
-    } catch (error) {
-      console.log('Error getting session from URL.')
+    if (settings.detectSessionInUrl && isBrowser() && !!getParameterByName('access_token')) {
+      this.getSessionFromUrl({ storeSession: true }).then(({ error }) => {
+        if (error) {
+          console.error('Error getting session from URL.', error)
+        }
+      })
     }
   }
 
@@ -94,16 +110,18 @@ export default class GoTrueClient {
    * @param password The user's password.
    * @param phone The user's phone number.
    * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+   * @param data Optional user metadata.
    */
   async signUp(
     { email, password, phone }: UserCredentials,
     options: {
       redirectTo?: string
+      data?: object
     } = {}
   ): Promise<{
     user: User | null
     session: Session | null
-    error: Error | null
+    error: ApiError | null
     data: Session | User | null // Deprecated
   }> {
     try {
@@ -111,9 +129,12 @@ export default class GoTrueClient {
 
       const { data, error } =
         phone && password
-          ? await this.api.signUpWithPhone(phone!, password!)
+          ? await this.api.signUpWithPhone(phone!, password!, {
+              data: options.data,
+            })
           : await this.api.signUpWithEmail(email!, password!, {
               redirectTo: options.redirectTo,
+              data: options.data,
             })
 
       if (error) {
@@ -139,8 +160,8 @@ export default class GoTrueClient {
       }
 
       return { data, user, session, error: null }
-    } catch (error) {
-      return { data: null, user: null, session: null, error }
+    } catch (e) {
+      return { data: null, user: null, session: null, error: e as ApiError }
     }
   }
 
@@ -165,7 +186,7 @@ export default class GoTrueClient {
     user: User | null
     provider?: Provider
     url?: string | null
-    error: Error | null
+    error: ApiError | null
     data: Session | null // Deprecated
   }> {
     try {
@@ -208,8 +229,8 @@ export default class GoTrueClient {
         })
       }
       throw new Error(`You must provide either an email, phone number or a third-party provider.`)
-    } catch (error) {
-      return { data: null, user: null, session: null, error }
+    } catch (e) {
+      return { data: null, user: null, session: null, error: e as ApiError }
     }
   }
 
@@ -227,7 +248,7 @@ export default class GoTrueClient {
   ): Promise<{
     user: User | null
     session: Session | null
-    error: Error | null
+    error: ApiError | null
     data: Session | User | null // Deprecated
   }> {
     try {
@@ -258,8 +279,8 @@ export default class GoTrueClient {
       }
 
       return { data, user, session, error: null }
-    } catch (error) {
-      return { data: null, user: null, session: null, error }
+    } catch (e) {
+      return { data: null, user: null, session: null, error: e as ApiError }
     }
   }
 
@@ -285,7 +306,7 @@ export default class GoTrueClient {
   async refreshSession(): Promise<{
     data: Session | null
     user: User | null
-    error: Error | null
+    error: ApiError | null
   }> {
     try {
       if (!this.currentSession?.access_token) throw new Error('Not logged in.')
@@ -295,8 +316,8 @@ export default class GoTrueClient {
       if (error) throw error
 
       return { data: this.currentSession, user: this.currentUser, error: null }
-    } catch (error) {
-      return { data: null, user: null, error }
+    } catch (e) {
+      return { data: null, user: null, error: e as ApiError }
     }
   }
 
@@ -305,7 +326,7 @@ export default class GoTrueClient {
    */
   async update(
     attributes: UserAttributes
-  ): Promise<{ data: User | null; user: User | null; error: Error | null }> {
+  ): Promise<{ data: User | null; user: User | null; error: ApiError | null }> {
     try {
       if (!this.currentSession?.access_token) throw new Error('Not logged in.')
 
@@ -321,8 +342,8 @@ export default class GoTrueClient {
       this._notifyAllSubscribers('USER_UPDATED')
 
       return { data: user, user, error: null }
-    } catch (error) {
-      return { data: null, user: null, error }
+    } catch (e) {
+      return { data: null, user: null, error: e as ApiError }
     }
   }
 
@@ -332,7 +353,7 @@ export default class GoTrueClient {
    */
   async setSession(
     refresh_token: string
-  ): Promise<{ session: Session | null; error: Error | null }> {
+  ): Promise<{ session: Session | null; error: ApiError | null }> {
     try {
       if (!refresh_token) {
         throw new Error('No current session.')
@@ -341,18 +362,12 @@ export default class GoTrueClient {
       if (error) {
         return { session: null, error: error }
       }
-      if (!data) {
-        return {
-          session: null,
-          error: { name: 'Invalid refresh_token', message: 'JWT token provided is Invalid' },
-        }
-      }
 
-      this._saveSession(data)
+      this._saveSession(data!)
       this._notifyAllSubscribers('SIGNED_IN')
       return { session: data, error: null }
-    } catch (error) {
-      return { error, session: null }
+    } catch (e) {
+      return { error: e as ApiError, session: null }
     }
   }
 
@@ -377,7 +392,7 @@ export default class GoTrueClient {
    */
   async getSessionFromUrl(options?: {
     storeSession?: boolean
-  }): Promise<{ data: Session | null; error: Error | null }> {
+  }): Promise<{ data: Session | null; error: ApiError | null }> {
     try {
       if (!isBrowser()) throw new Error('No browser detected.')
 
@@ -420,18 +435,18 @@ export default class GoTrueClient {
       window.location.hash = ''
 
       return { data: session, error: null }
-    } catch (error) {
-      return { data: null, error }
+    } catch (e) {
+      return { data: null, error: e as ApiError }
     }
   }
 
   /**
-   * Inside a browser context, `signOut()` will remove extract the logged in user from the browser session
+   * Inside a browser context, `signOut()` will remove the logged in user from the browser session
    * and log them out - removing all items from localstorage and then trigger a "SIGNED_OUT" event.
    *
    * For server-side management, you can disable sessions by passing a JWT through to `auth.api.signOut(JWT: string)`
    */
-  async signOut(): Promise<{ error: Error | null }> {
+  async signOut(): Promise<{ error: ApiError | null }> {
     const accessToken = this.currentSession?.access_token
     this._removeSession()
     this._notifyAllSubscribers('SIGNED_OUT')
@@ -446,23 +461,23 @@ export default class GoTrueClient {
    * Receive a notification every time an auth event happens.
    * @returns {Subscription} A subscription object which can be used to unsubscribe itself.
    */
-  onAuthStateChange(
-    callback: (event: AuthChangeEvent, session: Session | null) => void
-  ): { data: Subscription | null; error: Error | null } {
+  onAuthStateChange(callback: (event: AuthChangeEvent, session: Session | null) => void): {
+    data: Subscription | null
+    error: ApiError | null
+  } {
     try {
       const id: string = uuid()
-      const self = this
       const subscription: Subscription = {
         id,
         callback,
         unsubscribe: () => {
-          self.stateChangeEmitters.delete(id)
+          this.stateChangeEmitters.delete(id)
         },
       }
       this.stateChangeEmitters.set(id, subscription)
       return { data: subscription, error: null }
-    } catch (error) {
-      return { data: null, error }
+    } catch (e) {
+      return { data: null, error: e as ApiError }
     }
   }
 
@@ -485,8 +500,8 @@ export default class GoTrueClient {
       }
 
       return { data, user: data.user, session: data, error: null }
-    } catch (error) {
-      return { data: null, user: null, session: null, error }
+    } catch (e) {
+      return { data: null, user: null, session: null, error: e as ApiError }
     }
   }
 
@@ -501,8 +516,8 @@ export default class GoTrueClient {
       }
 
       return { data, user: data.user, session: data, error: null }
-    } catch (error) {
-      return { data: null, user: null, session: null, error }
+    } catch (e) {
+      return { data: null, user: null, session: null, error: e as ApiError }
     }
   }
 
@@ -524,10 +539,10 @@ export default class GoTrueClient {
         window.location.href = url
       }
       return { provider, url, data: null, session: null, user: null, error: null }
-    } catch (error) {
+    } catch (e) {
       // fallback to returning the URL
-      if (!!url) return { provider, url, data: null, session: null, user: null, error: null }
-      return { data: null, user: null, session: null, error }
+      if (url) return { provider, url, data: null, session: null, user: null, error: null }
+      return { data: null, user: null, session: null, error: e as ApiError }
     }
   }
 
@@ -608,8 +623,8 @@ export default class GoTrueClient {
       this._notifyAllSubscribers('SIGNED_IN')
 
       return { data, error: null }
-    } catch (error) {
-      return { data: null, error }
+    } catch (e) {
+      return { data: null, error: e as ApiError }
     }
   }
 

package/src/lib/constants.ts

@@ -1,6 +1,7 @@
+import { version } from './version'
 export const GOTRUE_URL = 'http://localhost:9999'
 export const AUDIENCE = ''
-export const DEFAULT_HEADERS = {}
+export const DEFAULT_HEADERS = { 'X-Client-Info': `gotrue-js/${version}` }
 export const EXPIRY_MARGIN = 60 * 1000
 export const STORAGE_KEY = 'supabase.auth.token'
 export const COOKIE_OPTIONS = {

package/src/lib/cookies.ts

@@ -25,6 +25,7 @@ function serialize(
 ) {
   const opt = options || {}
   const enc = encodeURIComponent
+  /* eslint-disable-next-line no-control-regex */
   const fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/
 
   if (typeof enc !== 'function') {

package/src/lib/fetch.ts

@@ -1,4 +1,6 @@
-import fetch from 'cross-fetch'
+import crossFetch from 'cross-fetch'
+
+export type Fetch = typeof fetch
 
 export interface FetchOptions {
   headers?: {
@@ -38,13 +40,14 @@ const _getRequestParams = (method: RequestMethodType, options?: FetchOptions, bo
 }
 
 async function _handleRequest(
+  fetcher: Fetch = crossFetch,
   method: RequestMethodType,
   url: string,
   options?: FetchOptions,
   body?: object
 ): Promise<any> {
   return new Promise((resolve, reject) => {
-    fetch(url, _getRequestParams(method, options, body))
+    fetcher(url, _getRequestParams(method, options, body))
       .then((result) => {
         if (!result.ok) throw result
         if (options?.noResolveJson) return resolve
@@ -55,18 +58,37 @@ async function _handleRequest(
   })
 }
 
-export async function get(url: string, options?: FetchOptions): Promise<any> {
-  return _handleRequest('GET', url, options)
+export async function get(
+  fetcher: Fetch | undefined,
+  url: string,
+  options?: FetchOptions
+): Promise<any> {
+  return _handleRequest(fetcher, 'GET', url, options)
 }
 
-export async function post(url: string, body: object, options?: FetchOptions): Promise<any> {
-  return _handleRequest('POST', url, options, body)
+export async function post(
+  fetcher: Fetch | undefined,
+  url: string,
+  body: object,
+  options?: FetchOptions
+): Promise<any> {
+  return _handleRequest(fetcher, 'POST', url, options, body)
 }
 
-export async function put(url: string, body: object, options?: FetchOptions): Promise<any> {
-  return _handleRequest('PUT', url, options, body)
+export async function put(
+  fetcher: Fetch | undefined,
+  url: string,
+  body: object,
+  options?: FetchOptions
+): Promise<any> {
+  return _handleRequest(fetcher, 'PUT', url, options, body)
 }
 
-export async function remove(url: string, body: object, options?: FetchOptions): Promise<any> {
-  return _handleRequest('DELETE', url, options, body)
+export async function remove(
+  fetcher: Fetch | undefined,
+  url: string,
+  body: object,
+  options?: FetchOptions
+): Promise<any> {
+  return _handleRequest(fetcher, 'DELETE', url, options, body)
 }

package/src/lib/helpers.ts

@@ -5,7 +5,7 @@ export function expiresAt(expiresIn: number) {
 
 export function uuid() {
   return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-    var r = (Math.random() * 16) | 0,
+    const r = (Math.random() * 16) | 0,
       v = c == 'x' ? r : (r & 0x3) | 0x8
     return v.toString(16)
   })
@@ -15,34 +15,11 @@ export const isBrowser = () => typeof window !== 'undefined'
 
 export function getParameterByName(name: string, url?: string) {
   if (!url) url = window.location.href
+  /* eslint-disable-next-line no-useless-escape */
   name = name.replace(/[\[\]]/g, '\\$&')
-  var regex = new RegExp('[?&#]' + name + '(=([^&#]*)|&|#|$)'),
+  const regex = new RegExp('[?&#]' + name + '(=([^&#]*)|&|#|$)'),
     results = regex.exec(url)
   if (!results) return null
   if (!results[2]) return ''
   return decodeURIComponent(results[2].replace(/\+/g, ' '))
 }
-
-export class LocalStorage implements Storage {
-  localStorage: Storage;
-  [name: string]: any
-  length!: number
-  constructor(localStorage: Storage) {
-    this.localStorage = localStorage || globalThis.localStorage
-  }
-  clear(): void {
-    return this.localStorage.clear()
-  }
-  key(index: number): string | null {
-    return this.localStorage.key(index)
-  }
-  setItem(key: string, value: any): void {
-    return this.localStorage.setItem(key, value)
-  }
-  getItem(key: string): string | null {
-    return this.localStorage.getItem(key)
-  }
-  removeItem(key: string): void {
-    return this.localStorage.removeItem(key)
-  }
-}

package/src/lib/polyfills.ts

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 /**
  * https://mathiasbynens.be/notes/globalthis
  */
@@ -12,10 +10,13 @@ export function polyfillGlobalThis() {
       },
       configurable: true,
     })
+    // @ts-expect-error 'Allow access to magic'
     __magic__.globalThis = __magic__
+    // @ts-expect-error 'Allow access to magic'
     delete Object.prototype.__magic__
   } catch (e) {
     if (typeof self !== 'undefined') {
+      // @ts-expect-error 'Allow access to globals'
       self.globalThis = self
     }
   }

package/src/lib/types.ts

@@ -9,6 +9,8 @@ export type Provider =
   | 'apple'
   | 'discord'
   | 'twitch'
+  | 'spotify'
+  | 'slack'
 
 export type AuthChangeEvent =
   | 'SIGNED_IN'

package/src/lib/version.ts

@@ -0,0 +1,2 @@
+// generated by genversion
+export const version = '1.20.0'