Versions in this module Expand all Collapse all v0 v0.1.1 Nov 12, 2026 v0.1.0 Oct 14, 2026 Changes in this version + const DefaultAvailableLimit + const DefaultAvailableWindow + const EndpointAvailable + const EndpointSet + const KindUsername + const MaxLength + const MinLength + const PluginName + const TableAliasIdentity + var DefaultReserved = []string + var ErrBadAvailableLimit = errors.New(...) + var ErrBadLength = errors.New("username: Length needs 1 <= min <= max") + var ErrDisplayInvalid = auth.NewError("username.display_invalid", http.StatusBadRequest, ...) + var ErrImmutable = auth.NewError("username.immutable", http.StatusConflict, "Your username cannot be changed.") + var ErrReserved = auth.NewError("username.reserved", http.StatusConflict, "This username is not available.") + var IdentityCreatedAt = sqlb.Col[time.Time](TableIdentity, auth.ColIdentityCreatedAt) + var IdentityIsPrimary = sqlb.Col[bool](TableIdentity, auth.ColIdentityIsPrimary) + var IdentityKind = sqlb.Col[auth.IdentifierKindName](TableIdentity, auth.ColIdentityKind) + var IdentityUserID = sqlb.Col[string](TableIdentity, auth.ColIdentityUserID) + var IdentityValue = sqlb.Col[string](TableIdentity, auth.ColIdentityValue) + var IdentityValueRaw = sqlb.Col[string](TableIdentity, auth.ColIdentityValueRaw) + var TableIdentity = sqlb.Table + func ByHandleQuery(a *auth.Auth, rawHandle string, dst *auth.User) (sqlb.Query, error) + func Normalize(raw string) (string, error) + func Of(a *auth.Auth, userID string, dst *Data) (sqlb.Query, error) + func UserBindings(dst *Data) []sqlb.Binding + func UserJoin() sqlb.Join + func Validate(v string) error + func ValidateChars(v string) error + type Availability struct + Available bool + type Data struct + Display string + Handle string + func (d *Data) Exists() bool + type Option func(*Plugin) + func DisplayNormalizer(fn func(display string) string) Option + func DisplayValidator(fn func(display string) error) Option + func Immutable() Option + func Length(min, max int) Option + func Login() Option + func Reserved(names ...string) Option + func ScopedByTenant() Option + func ValidateDisplayAfterNormalization() Option + func WithAvailableLimit(n int, window time.Duration) Option + func WithNormalizer(fn func(raw string) (string, error)) Option + func WithValidator(fn func(normalized string) error) Option + func WithoutAvailability() Option + type Plugin struct + func New(opts ...Option) *Plugin + func (p *Plugin) Available(ctx context.Context, handle string) (bool, error) + func (p *Plugin) Claim(ctx context.Context, userID, handle string) error + func (p *Plugin) ClaimWithDisplay(ctx context.Context, userID, handle, display string) error + func (p *Plugin) DataHooks() auth.DataHooks + func (p *Plugin) DisplayForm(handle, display string) (string, error) + func (p *Plugin) Identifiers() []auth.IdentifierKind + func (p *Plugin) Init(a *auth.Auth) error + func (p *Plugin) IsReserved(handle string) bool + func (p *Plugin) Name() string + func (p *Plugin) Operations() []auth.Operation + func (p *Plugin) OptionErr() error + func (p *Plugin) RateLimits() []auth.RateRule + func (p *Plugin) Set(ctx context.Context, handle string) (Result, error) + func (p *Plugin) SetWithDisplay(ctx context.Context, handle, display string) (Result, error) + func (p *Plugin) Tables() []sqlb.Table + func (p *Plugin) UserJoin() sqlb.Join + func (p *Plugin) Validate(*auth.Config) error + type Request struct + DisplayUsername string + Username string + type Result struct + Username string