Dialup.Auth.Accounts behaviour (Dialup v0.2.0)

Behaviour implemented by generated Accounts contexts.

Dialup.Auth resolves the current user through this callback module configured on Dialup.Auth.Plug or use Dialup, auth_accounts: MyApp.Accounts.

Summary

user()

@type user() :: map() | struct()

@callback delete_session_token(token :: binary()) :: :ok

(optional)

@callback deliver_user_reset_password_instructions(user(), reset_url_fun :: function()) ::
  :ok

@callback generate_user_session_token(user()) :: binary()

(optional)

@callback get_user_by_email(email :: binary()) :: user() | nil

@callback get_user_by_email_and_password(email :: binary(), password :: binary()) ::
  {:ok, user()} | {:error, :invalid_credentials}

(optional)

@callback get_user_by_reset_password_token(token :: binary()) :: user() | nil

@callback get_user_by_session_token(token :: binary()) :: user() | nil

(optional)

@callback register_user(attrs :: map()) :: {:ok, user()} | {:error, term()}

(optional)

@callback reset_user_password(user(), attrs :: map()) :: {:ok, user()} | {:error, term()}