Supabase.Auth.Behaviour behaviour (supabase_auth v0.6.0)
View SourceBehaviour specification for the Supabase.Auth module.
This module defines the contract that any Auth implementation must fulfill, providing function specifications and return types for all authentication operations.
Summary
Types
@type conn() :: Plug.Conn.t() | Phoenix.LiveView.Socket.t()
@type sign_in_response() :: {:ok, Supabase.Auth.Session.t()} | {:error, term()}
Callbacks
@callback exchange_code_for_session(Supabase.Client.t(), String.t(), String.t(), map()) :: sign_in_response()
@callback get_server_health(Supabase.Client.t()) :: {:ok, Supabase.Auth.Schemas.ServerHealth.t()} | {:error, term()}
@callback get_server_settings(Supabase.Client.t()) :: {:ok, Supabase.Auth.Schemas.ServerSettings.t()} | {:error, term()}
@callback get_user(Supabase.Client.t(), Supabase.Auth.Session.t()) :: {:ok, Supabase.Auth.User.t()} | {:error, term()}
@callback get_user_identities(Supabase.Client.t(), Supabase.Auth.Session.t()) :: {:ok, [Supabase.Auth.User.Identity.t()]} | {:error, term()}
@callback link_identity(Supabase.Client.t(), Supabase.Auth.Session.t(), map()) :: {:ok, map()} | {:error, term()}
@callback reauthenticate(Supabase.Client.t(), Supabase.Auth.Session.t()) :: :ok | {:error, term()}
@callback refresh_session(Supabase.Client.t(), String.t()) :: sign_in_response()
@callback resend(Supabase.Client.t(), String.t(), Supabase.Auth.Schemas.ResendParams.t()) :: :ok | {:error, term()}
@callback sign_in_anonymously( Supabase.Client.t(), Supabase.Auth.Schemas.SignInAnonymously.t() ) :: sign_in_response()
@callback sign_in_with_id_token(Supabase.Client.t(), map()) :: sign_in_response()
@callback sign_in_with_oauth(Supabase.Client.t(), map()) :: {:ok, atom(), String.t()} | {:error, term()}
@callback sign_in_with_otp(Supabase.Client.t(), map()) :: :ok | {:ok, String.t()} | {:error, term()}
@callback sign_in_with_password(Supabase.Client.t(), map()) :: sign_in_response()
@callback sign_in_with_sso(Supabase.Client.t(), map()) :: {:ok, String.t()} | {:error, term()}
@callback sign_up(Supabase.Client.t(), map()) :: {:ok, Supabase.Auth.User.t()} | {:error, term()}
@callback unlink_identity(Supabase.Client.t(), Supabase.Auth.Session.t(), String.t()) :: :ok | {:error, term()}
@callback update_user(Supabase.Client.t(), conn(), Supabase.Auth.Schemas.UserParams.t()) :: {:ok, conn()} | {:error, term()}
@callback verify_otp(Supabase.Client.t(), map()) :: sign_in_response()