What Ithibati adds to the account schema an application already owns.

defmodule MyApp.Accounts.User do
  use Ecto.Schema
  alias Ithibati.Schema.Identifier
  alias Ithibati.Schema.User

  use User, identifier: :email, format: Identifier.email_format()

  import Ecto.Changeset

  schema "users" do
    ithibati_account()

    field :name, :string
    timestamps(type: :utc_datetime_usec)
  end

  def changeset(user, attrs) do
    user
    |> identifier_changeset(attrs)
    |> cast(attrs, [:name])
  end
end

Options

• identifier: — required, a literal atom: the field an account is known by. You have to write this one out here, because it is the field your schema declares.
• format: — optional, a regular expression, evaluated once when your module compiles. Ithibati.Schema.Identifier.email_format/0 offers one for addresses.
• constraint_name: — optional, the name of the unique index on that column. Say it when your naming convention is not the one Ecto derives. Ithibati then creates the index under that name, and the changeset's constraint matches it.
• unique_index: false — optional, an opt-out. Say it when your application creates that index itself, and Ithibati checks that one exists rather than creating it.

You may write each of the three value options inline, or name a module attribute standing above the use line. Ithibati refuses an option written as nil, because that is what a misspelled attribute looks like.

identifier_changeset/2 trims and lowercases the values it writes, whatever the field is called.

There is no default, and the macro says so when you leave it out: this library never sends mail, so it will not ask you for an address by assumption. Ithibati.Schema.Identifier.email_format/0 says what the offered email pattern accepts and why it is not RFC 5322.

What it injects, and what it refuses

The macro injects one field, three associations, and three functions: identifier_changeset/2, passkey_display_name/1 (overridable, nil by default) and __ithibati__/1. Ithibati.Schema.UserTest pins that list against a schema that does not use this macro, so a fourth one has to be a decision.

It refuses two things, both at compile time: a module that never calls ithibati_account/0 inside its schema block, and one that defines identifier_changeset/2 or __ithibati__/1 itself.