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, Ecto.Changeset.t()}
          | {:error, :invalid_grant}
          | {:error, {:invalid_grant, :invalid_credentials}}

  @callback get_user(Client.t(), Session.t()) :: {:ok, User.t()} | {:error, atom}
  @callback sign_in_with_oauth(Client.t(), SignInWithOauth.t()) :: {:ok, atom, URI.t()}
  @callback verify_otp(Client.t(), VerifyOTP.t()) :: sign_in_response
  @callback sign_in_with_otp(Client.t(), SignInWithOTP.t()) :: :ok | {:ok, Ecto.UUID.t()}
  @callback sign_in_with_sso(Client.t(), SignInWithSSO.t()) :: {:ok, URI.t()}
  @callback sign_in_with_id_token(Client.t(), SignInWithIdToken.t()) :: sign_in_response
  @callback sign_in_with_password(Client.t(), SignInWithPassword.t()) ::
              sign_in_response
  @callback sign_up(Client.t(), SignUpWithPassword.t()) ::
              {:ok, User.t(), binary} | {:error, atom}
end