Packages

supabase_gotrue

0.3.0
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.

HexDocs

Current section

Files

Jump to
Readme
18 Versions
4 Dependencies
Dependants
Files
Activity
supabase_gotrue lib supabase go_true_behaviour.ex
Raw

lib/supabase/go_true_behaviour.ex 

defmodule Supabase.GoTrueBehaviour do

  @moduledoc false



  alias Supabase.Client

  alias Supabase.GoTrue.Schemas.SignInWithIdToken

  alias Supabase.GoTrue.Schemas.SignInWithOauth

  alias Supabase.GoTrue.Schemas.SignInWithOTP

  alias Supabase.GoTrue.Schemas.SignInWithPassword

  alias Supabase.GoTrue.Schemas.SignInWithSSO

  alias Supabase.GoTrue.Schemas.SignUpWithPassword

  alias Supabase.GoTrue.Schemas.VerifyOTP

  alias Supabase.GoTrue.Session

  alias Supabase.GoTrue.User



  @type sign_in_response ::

          {:ok, Session.t()}

          | {:error, :invalid_grant}

          | {:error, {:invalid_grant, :invalid_credentials}}



  @callback get_user(Client.client(), Session.t()) :: {:ok, User.t()} | {:error, atom}

  @callback sign_in_with_oauth(Client.client(), SignInWithOauth.t()) :: {:ok, atom, URI.t()}

  @callback verify_otp(Client.client(), VerifyOTP.t()) :: sign_in_response

  @callback sign_in_with_otp(Client.client(), SignInWithOTP.t()) :: :ok | {:ok, Ecto.UUID.t()}

  @callback sign_in_with_sso(Client.client(), SignInWithSSO.t()) :: {:ok, URI.t()}

  @callback sign_in_with_id_token(Client.client(), SignInWithIdToken.t()) :: sign_in_response

  @callback sign_in_with_password(Client.client(), SignInWithPassword.t()) ::

              sign_in_response

  @callback sign_up(Client.client(), SignUpWithPassword.t()) ::

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

end