appuser

type Account struct {
	// Global ID of Account
	Provider string // E.g. Email, Google, Facebook, etc.
	App      string
	ID       string // An ID of a user at auth provider. E.g. email address, some ID, etc.
}

type AccountData interface {
	BelongsToUser
	GetEmailLowerCase() string
	GetEmailConfirmed() bool
	SetLastLogin(time time.Time)
	GetNames() NameFields
}

type AccountDataBase struct {
	Account
	OwnedByUserWithID
	NameFields
	LastLogin
	EmailData

	Admin bool

	// ClientID is an OAuth2 client ID
	ClientID string

	FederatedIdentity string `dalgo:",noindex" datastore:",noindex"`
	FederatedProvider string `dalgo:",noindex" datastore:",noindex"`
}

type AccountRecord interface {
	Key() Account
	Data() AccountData
}

type AccountsOfUser struct {
	// Member of TgUserEntity class
	Accounts []string `datastore:",noindex"`
}

type BaseUserData interface {
	NamesSetter
	SetPreferredLocale(code5 string) error
	GetPreferredLocale() string
	GetCreatedTime() time.Time
}

type BaseUserFields struct {
	NameFields
	AccountsOfUser
	WithPreferredLocale
	WithCreatedTimestamp
}

type BelongsToUser interface {
	GetAppUserID() (appUserID string)
	SetAppUserID(appUserID string)
	GetCreatedTime() time.Time
	GetUpdatedTime() time.Time
	SetUpdatedTime(time.Time)
}

type CreatedTimeGetter interface {
	GetCreatedTime() time.Time
}

type EmailData struct {
	// Deprecated: use EmailRaw & EmailLowerCase instead
	Email          string `dalgo:",noindex" datastore:",noindex"` // TODO: remove once old records migrated to new format that uses EmailRaw & EmailLowerCase
	EmailRaw       string `dalgo:",noindex" datastore:",noindex"`
	EmailLowerCase string
	EmailConfirmed bool
}

type LastLogin struct {
	DtLastLogin time.Time `datastore:",omitempty"`
}

type Name struct {
	Field name
	Value string
}

type NameFields struct {
	FirstName  string `json:"firstName,omitempty" dalgo:"firstName,omitempty" firestore:"firstName,omitempty"`
	MiddleName string `json:"middleName,omitempty" dalgo:"middleName,omitempty" firestore:"middleName,omitempty"`
	LastName   string `json:"lastName,omitempty" dalgo:"lastName,omitempty" firestore:"lastName,omitempty"`
	NickName   string `json:"nickName,omitempty" dalgo:"nickName,omitempty" firestore:"nickName,omitempty"`
	UserName   string `json:"userName,omitempty" dalgo:"userName,omitempty" firestore:"userName,omitempty"`
}

type NamesSetter interface {
	SetNames(names ...Name)
}

type OwnedByUserWithID struct {
	AppUserID string // intentionally indexed & do NOT omitempty (so we can find records with empty AppUserID)

	// AppUserIntID is a strongly typed integer ID of a user
	// Deprecated: use AppUserID instead. Remove BelongsToUserWithIntID once AppUserIntID is removed.
	AppUserIntID int64

	DtCreated time.Time `json:",omitempty" datastore:",omitempty" firestore:",omitempty"`
	DtUpdated time.Time `json:",omitempty" datastore:",omitempty" firestore:",omitempty"`
}

type WithCreatedTimestamp struct {
	DtCreated time.Time `json:"dtCreated,omitempty" firestore:"dtCreated,omitempty" dalgo:"dtCreated,omitempty"`
}

type WithPreferredLocale struct {
	PreferredLocale string `json:"preferredLocale,omitempty" dalgo:"preferredLocale,omitempty" firestore:"preferredLocale,omitempty"`
}