@spec authenticate(map(), Pow.Config.t()) :: map() | nil

Authenticate a user.

This calls Pow.Ecto.Context.authenticate/2 or authenticate/1 on a custom context module.

@spec changeset(map(), Pow.Config.t()) :: map() | nil

Build a changeset from a blank user struct.

It'll use the schema module fetched from the config through Pow.Config.user!/1.

@spec changeset(map(), map(), Pow.Config.t()) :: map()

Build a changeset from existing user struct.

It'll call the changeset/2 function on the user struct.

@spec create(map(), Pow.Config.t()) :: {:ok, map()} | {:error, map()}

Create a new user.

This calls Pow.Ecto.Context.create/2 or create/1 on a custom context module.

@spec delete(map(), Pow.Config.t()) :: {:ok, map()} | {:error, map()}

Delete an existing user.

This calls Pow.Ecto.Context.delete/2 or delete/1 on a custom context module.

@spec fetch_primary_key_values(
  struct(),
  Pow.Config.t()
) :: {:ok, keyword()} | {:error, term()}

Retrieve a keyword list of primary key value(s) from the provided struct.

The keys will be fetched from the __schema__/1 function in the struct module. If no __schema__/1 function exists, then it's expected that the struct has :id as its only primary key.

@spec get_by(Keyword.t() | map(), Pow.Config.t()) :: map() | nil

Retrieve a user with the provided clauses.

This calls Pow.Ecto.Context.get_by/2 or get_by/1 on a custom context module.

@spec reload(
  struct(),
  Pow.Config.t()
) :: struct() | nil

Takes a struct and will reload it.

The clauses are fetched with fetch_primary_key_values/2, and the struct loaded with get_by/2. A RuntimeError exception will be raised if the clauses could not be fetched.

@spec update(map(), map(), Pow.Config.t()) :: {:ok, map()} | {:error, map()}

Update an existing user.

This calls Pow.Ecto.Context.update/3 or update/2 on a custom context module.