common

type App interface {
	Init(baseApp *BaseApp) error
	Start(process *lib.Process)
	WaitReady(ctx context.Context) (bool, error)
	WaitForDone()
	Err() error
}

type BaseApp struct {
	PluginName string
	APIClient  teleport.Client
	Conf       PluginConfiguration
	Bot        MessagingBot
	Clock      clockwork.Clock

	*lib.Process
	// contains filtered or unexported fields
}

type BaseConfig struct {
	Teleport   lib.TeleportConfig `toml:"teleport"`
	Recipients RawRecipientsMap   `toml:"role_to_recipients"`
	Log        logger.Config      `toml:"log"`
	PluginType types.PluginType
}

type GenericAPIConfig struct {
	Token string
	// DELETE IN 11.0.0 (Joerger) - use "role_to_recipients["*"]" instead
	Recipients []string
	APIURL     string
}

type MessagingBot interface {
	// CheckHealth checks if the bot can connect to its messaging service
	CheckHealth(ctx context.Context) error
	// FetchRecipient fetches recipient data from the messaging service API. It can also be used to check and initialize
	// a communication channel (e.g. MsTeams needs to install the app for the user before being able to send
	// notifications)
	FetchRecipient(ctx context.Context, recipient string) (*Recipient, error)
	// SupportedApps are the apps supported by this bot.
	SupportedApps() []App
}

type PluginConfiguration interface {
	GetTeleportClient(ctx context.Context) (teleport.Client, error)
	GetRecipients() RawRecipientsMap
	NewBot(clusterName string, webProxyAddr string) (MessagingBot, error)
	GetPluginType() types.PluginType
}

type RawRecipientsMap map[string][]string

type Recipient struct {
	// Name is the original string that was passed to create the recipient. This can be an id, email, channel name
	// URL, ... This is the user input (through suggested reviewers or plugin configuration)
	Name string
	// ID represents the recipient from the messaging service point of view.
	// e.g. if Name is a Slack user email address, ID will be the Slack user id.
	// This information should be sufficient to send a new message to a recipient.
	ID string
	// Kind is the recipient kind inferred from the Recipient Name. This is a messaging service concept, most common
	// values are "User" or "Channel".
	Kind string
	// Data allows MessagingBot to store required data for the recipient
	Data interface{}
}

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

type StatusSink interface {
	Emit(ctx context.Context, s types.PluginStatus) error
}