user

type Core struct {
	// ID is the primary and unique user identification key.
	ID xid.ID `json:"id" db:"id"`

	// CreatedAt specifies the exact time when the user was created.
	CreatedAt time.Time `json:"created_at" db:"created_at"`

	// UpdatedAt specifies the exact time when the user was last updated.
	UpdatedAt time.Time `json:"updated_at" db:"updated_at"`

	// ActivatedAt specifies the exact time when user's account
	// was activated.
	ActivatedAt zero.Time `json:"activated_at" db:"activated_at"`

	// Email is user's active email address.
	Email string `json:"email" db:"email"`

	// UnverifiedEmail is a new email address yet to be verified by its
	// owner. When verified this field is empty.
	UnverifiedEmail zero.String `json:"unverified_email" db:"unverified_email"`

	// PasswordHash is already hashed version of user's password.
	PasswordHash []byte `json:"-" db:"password_hash"`

	// Verification holds data needed for account activation or email
	// update.
	Verification Token `json:"-" db:"verification"`

	// Recovery holds data needed for account recovery.
	Recovery Token `json:"-" db:"recovery"`
}

type CoreInput struct {
	// Email is user's email address submitted for further processing.
	Email string `json:"email"`

	// Password is user's plain-text password submitted for
	// further processing.
	Password string `json:"password"`

	// OldPassword is user's plain-text password submitted for
	// confirmation before password's update.
	OldPassword string `json:"old_password"`

	// RememberMe specifies whether a persistent session should be
	// created on registration / log in or not.
	RememberMe bool `json:"remember_me"`
}

type CoreStats struct {
	// Total specifies the total number of users in the data store.
	Total int `json:"total" db:"total"`
}

type CoreSummary struct {
	// Email specifies whether the email was modified during
	// input application or not.
	Email bool

	// Password specifies whether the password was modified
	// during input application or not.
	Password bool
}

type Creator func(ctx context.Context, inp Inputer) (User, error)

type DB interface {
	// UserStats should return users' data statistics from the
	// underlying data store.
	UserStats(ctx context.Context) (Stats, error)

	// CreateUser should insert a freshly created user into the
	// underlying data store.
	CreateUser(ctx context.Context, usr User) error

	// FetchManyUsers should retrieve multiple users from the
	// underlying data store by the provided query.
	// Int return value specifies the total page count.
	FetchManyUsers(ctx context.Context, qr httpflow.Query) ([]User, int, error)

	// FetchUserByID should retrieve a user from the underlying
	// data store by their ID.
	FetchUserByID(ctx context.Context, id xid.ID) (User, error)

	// FetchUserByEmail should retrieve a user from the
	// underlying data store by their email address.
	FetchUserByEmail(ctx context.Context, eml string) (User, error)

	// UpdateUser should update user's data in the underlying
	// data store.
	UpdateUser(ctx context.Context, usr User) error

	// DeleteUserByID should delete a user from the underlying
	// data store by their ID.
	DeleteUserByID(ctx context.Context, id xid.ID) error
}

type DeleteCheck func(ctx context.Context, usr User) error

type EmailSender interface {
	// SendAccountActivation should send an email regarding account
	// activation with the token, embedded into a full URL, to the
	// specified email address.
	SendAccountActivation(ctx context.Context, eml, tok string)

	// SendEmailVerification should send an email regarding new email
	// verification with the token, embedded into a full URL, to the
	// specified email address.
	SendEmailVerification(ctx context.Context, eml, tok string)

	// SendEmailChanged should send an email to the old email
	// address (first parameter) about a new email address
	// being set (second parameter).
	SendEmailChanged(ctx context.Context, oEml, nEml string)

	// SendAccountRecovery should send an email regarding account
	// recovery with the token, embedded into a full URL, to the
	// specified email address.
	SendAccountRecovery(ctx context.Context, eml, tok string)

	// SendAccountDeleted should send an email regarding
	// successful account deletion to the specified email address.
	SendAccountDeleted(ctx context.Context, eml string)

	// SendPasswordChanged should send an email notifying about
	// a successful password change to the specified email address.
	// Last parameter specifies whether the password was changed during
	// the recovery process or not.
	SendPasswordChanged(ctx context.Context, eml string, recov bool)
}

type Handler struct {
	// contains filtered or unexported fields
}

type Inputer interface {
	// ExposeCore should return user's core input fields.
	ExposeCore() CoreInput
}

type LoginCheck func(ctx context.Context, usr User) error

type Parser func(r *http.Request) (Inputer, error)

type Stats interface {
	// ExposeCore should return users' core statistics.
	ExposeCore() CoreStats
}

type Summary interface {
	// ExposeCore should return user's core fields' modification status.
	ExposeCore() CoreSummary
}

type Token struct {
	// ExpiresAt specifies the exact time when the token becomes invalid.
	ExpiresAt null.Time `json:"-" db:"expires_at"`

	// NextAt specifies the exact time when the next token will be allowed
	// to be generated.
	NextAt null.Time `json:"-" db:"next_at"`

	// Hash is the hashed token value version. Treat it as a temporary
	// password.
	Hash []byte `json:"-" db:"hash"`
}

type TokenLifetime struct {
	// Interval is used for token expiration time calculation.
	Interval time.Duration

	// Cooldown is used for token next allowed generation time calculation.
	Cooldown time.Duration
}

type User interface {
	// ApplyInput should set values from provided data structure.
	// If certain input fields are empty, their destination fields
	// in the underlying user's structure should not be modified.
	ApplyInput(i Inputer) (Summary, error)

	// ExposeCore should return user's core fields.
	ExposeCore() *Core
}