botsfwmodels

type AppUserAdapter interface {
	// SetBotUserID associates bot user ID with an app user record
	SetBotUserID(platform, botID, botUserID string)

	// UserNamesHolder is an interface to set and get user's names.
	UserNamesHolder

	// PreferredLocaleHolder is an interface to set and get preferred locale
	PreferredLocaleHolder
}

type AppUserData interface {

	// BotsFwAdapter returns to bots framework an adapter to app user data record.
	// Using an adapter ensures there is no clashes between bots framework interfaces and app user struct.
	BotsFwAdapter() AppUserAdapter
}

type BotBaseData struct {
	//user.OwnedByUserWithID
	AppUserID string `json:"appUserID" firestore:"appUserID"` // intentionally indexed & do NOT omitempty (so we can find records with empty AppUserID)

	DtCreated time.Time `json:"dtCreated" datastore:"dtCreated" firestore:"dtCreated"`
	DtUpdated time.Time `json:"dtUpdated" datastore:"dtUpdated" firestore:"dtUpdated"`

	// AccessGranted indicates if access to the bot has been granted
	AccessGranted bool `json:"isAccessGranted" dalgo:"isAccessGranted" datastore:"isAccessGranted" firestore:"isAccessGranted"`
}

type BotChatData interface {
	// Base returns a base struct that should be included in all structs that implement BotChatData.
	Base() *ChatBaseData // TODO: Document why this is needed or remove

	// IsChanged returns true if data has been changed
	IsChanged() bool

	// GetAppUserID returns app user ID
	GetAppUserID() (appUserID string)

	// SetAppUserID sets app user ID
	SetAppUserID(appUserID string)

	// AddClientLanguage adds client language
	AddClientLanguage(languageCode string) (changed bool)

	// SetBotUserID sets bot user ID
	SetBotUserID(id interface{})

	// SetIsGroupChat marks current chat as a group chat
	SetIsGroupChat(bool)

	// IsAccessGranted returns true if access is granted
	IsAccessGranted() bool

	// IsGroupChat returns true if current chat is a group chat
	IsGroupChat() bool

	// SetAccessGranted sets access granted flag
	SetAccessGranted(value bool) bool

	// GetPreferredLanguage returns preferred language for the chat
	GetPreferredLanguage() string

	// SetPreferredLanguage sets preferred language for the chat
	SetPreferredLanguage(value string)

	// SetUpdatedTime sets updated time
	SetUpdatedTime(time.Time) // github.com/strongo/user.UpdatedTimeSetter

	// SetDtLastInteraction sets last interaction time
	SetDtLastInteraction(time time.Time)

	// GetAwaitingReplyTo returns path of the step that is awaiting reply to
	GetAwaitingReplyTo() string

	// SetAwaitingReplyTo sets path of the step that is awaiting reply to
	SetAwaitingReplyTo(path string)

	// IsAwaitingReplyTo returns true if awaiting reply to specific step
	IsAwaitingReplyTo(code string) bool

	// AddWizardParam adds a parameter to wizard with a given key & value
	AddWizardParam(key, value string)

	// GetWizardParam returns a parameter from wizard for a given key
	GetWizardParam(key string) string

	// PopStepsFromAwaitingReplyUpToSpecificParent pops steps from awaiting reply up to specific parent
	PopStepsFromAwaitingReplyUpToSpecificParent(code string)

	// PushStepToAwaitingReplyTo pushes step to awaiting reply to
	PushStepToAwaitingReplyTo(code string)

	SetVar(key string, value string)
	GetVar(key string) string
	DelVar(key string)
	HasChangedVars() bool
}

type ChatBaseData struct {

	// BotUserIDs keeps ids of bot users who are members of a group chat or a single user ID if it's a chat with bot
	BotUserIDs []string `firestore:"botUserIDs,omitempty"`

	BotBaseData

	// IsGroup indicates if bot is added/used in a group chat
	IsGroup bool `firestore:"isGroup,omitempty"`

	Type string `firestore:"type,omitempty"` // TODO: document what is it & why needed or remove

	// Title stores a title of a chat if bot platforms supports named chats
	Title string `firestore:"title,omitempty"`

	// AnalyticsClientIDs stores IDs of analytics clients. For example {"GA": "1234567890.1234567890"}
	AnalyticsClientIDs map[string]string `firestore:"analyticsClientIDs,omitempty"`

	// DtLastInteraction must be set through SetDtLastInteraction() as it also increments InteractionsCount
	DtLastInteraction time.Time `firestore:"dtLastInteraction"`

	// InteractionsCount is a number of interactions with a bot in this chat
	InteractionsCount int `firestore:"interactionsCount,omitempty"`

	// DtForbidden is a time when bot was forbidden to interact with a chat
	DtForbidden time.Time `firestore:"dtForbidden,omitempty"`

	// DtForbiddenLast needs documentation on intended usage. TODO: Consider removing
	DtForbiddenLast time.Time `dalgo:",omitempty" datastore:",omitempty" firestore:",omitempty"`
	// contains filtered or unexported fields
}

type ChatKey struct {
	// BotID an id of a bot that owns this chat
	BotID string

	// ChatID is an id of a chat as was provided by a bot platform. Might be an integer converted to a string.
	// It's different from ChatInstanceID of Telegram - TODO: document what is the difference an why ChatInstanceID is needed.
	ChatID string
}

type PlatformUserBaseDbo struct {
	BotBaseData

	WithRequiredBotIDs

	// FirstName is the first name of a user
	FirstName string `json:"firstName,omitempty" dalgo:"firstName,omitempty,noindex" firestore:"firstName,omitempty"`

	// LastName is the last name of a user
	LastName string `json:"lastName,omitempty"  dalgo:"lastName,omitempty,noindex" firestore:"lastName,omitempty"`

	// UserName is login ID of a user
	UserName string `json:"userName,omitempty"  dalgo:"userName,omitempty,noindex" firestore:"userName,omitempty"`
}

type PlatformUserData interface {
	// BaseData returns base data that should be implemented by all bot user structs
	BaseData() *PlatformUserBaseDbo

	// GetAppUserID returns app user ID if available
	GetAppUserID() string

	// SetAppUserID sets app user ID to associate bot user record with app user
	SetAppUserID(appUserID string)

	WithAccessGrantedFlag

	// SetUpdatedTime sets last updated time // TODO: document intended usage
	SetUpdatedTime(time.Time) //to satisfy github.com/strongo/app/user.UpdatedTimeSetter
}

type PreferredLocaleHolder interface {

	// SetPreferredLocale sets preferred locale for the chat as code5 (e.g. en-US)
	SetPreferredLocale(code5 string) error

	// GetPreferredLocale returns preferred locale for the chat as code5 (e.g. en-US)
	GetPreferredLocale() string
}

type UserNamesHolder interface {

	// SetNames sets names of a user.
	SetNames(firstName, lastName, fullName string) error
}

type WithAccessGrantedFlag interface {

	// IsAccessGranted returns true if access is granted
	IsAccessGranted() bool

	// SetAccessGranted sets access granted flag
	SetAccessGranted(value bool) bool
}

type WithBotIDs struct {
	BotIDs []string `json:"botIDs,omitempty" dalgo:"botIDs,omitempty,noindex" firestore:"botIDs,omitempty"`
}

type WithBotUserIDs struct {
	BotUserIDs []string `json:"botUserIDs,omitempty" firestore:"botUserIDs,omitempty" dalgo:"botUserIDs,omitempty"`
}

type WithRequiredBotIDs WithBotIDs