Packages

supabase_gotrue

0.5.2
0.5.2 retired 0.5.1 0.5.0 0.4.1 0.4.0 0.3.10 0.3.9 0.3.8 0.3.7 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.1 0.2.0

Integration with the GoTrue API from Supabase services. Provide authentication with MFA, password and magic link.

Retired package: Renamed - It was renamed to supabase_auth, check https://github.com/supabase-community/supabase-ex/issues/66
HexDocs

Current section

Files

Jump to
Readme
18 Versions
5 Dependencies
Dependants
Files
Activity
supabase_gotrue lib supabase go_true admin_behaviour.ex
Raw

lib/supabase/go_true/admin_behaviour.ex 

defmodule Supabase.GoTrue.AdminBehaviour do

  @moduledoc """

  Behaviour specification for the Supabase.GoTrue.Admin module.



  This module defines the contract that any GoTrue Admin implementation must fulfill,

  providing function specifications and return types for all admin operations.

  """



  alias Supabase.Client

  alias Supabase.GoTrue.Session

  alias Supabase.GoTrue.User



  @type scope :: :global | :local | :others

  @type invite_options :: %{optional(:data) => map(), optional(:redirect_to) => String.t()}

  @type pagination :: %{next_page: integer() | nil, last_page: integer(), total: integer()}



  @callback sign_out(Client.t(), Session.t(), scope) :: :ok | {:error, term()}



  @callback invite_user_by_email(Client.t(), String.t(), invite_options()) ::

              {:ok, User.t()} | {:error, term()}



  @callback generate_link(Client.t(), map()) ::

              {:ok,

               %{

                 action_link: String.t(),

                 email_otp: String.t(),

                 hashed_token: String.t(),

                 redirect_to: String.t(),

                 verification_type: atom()

               }}

              | {:error, term()}



  @callback create_user(Client.t(), map()) :: {:ok, User.t()} | {:error, term()}



  @callback list_users(Client.t(), map()) ::

              {:ok, list(User.t()), pagination()} | {:error, term()}



  @callback get_user_by_id(Client.t(), String.t()) :: {:ok, User.t()} | {:error, term()}



  @callback update_user_by_id(Client.t(), String.t(), map()) ::

              {:ok, User.t()} | {:error, term()}



  @callback delete_user(Client.t(), String.t(), keyword()) :: :ok | {:error, term()}



  @callback delete_factor(Client.t(), String.t(), String.t()) :: :ok | {:error, term()}



  @callback list_identities(Client.t(), String.t()) ::

              {:ok, list(User.Identity.t())} | {:error, term()}



  @callback delete_identity(Client.t(), String.t(), String.t()) :: :ok | {:error, term()}

end