protocol

type Action interface {
	// GetLatestEvents get latest events, Only the HTTP communication method must be supported for polling for events.
	GetLatestEvents(req Request) Response
	// GetSupportedActions get supported actions
	GetSupportedActions(req Request) Response
	// GetStatus get status
	GetStatus(req Request) Response
	// GetVersion get version
	GetVersion(req Request) Response

	// SendMessage send message
	SendMessage(req Request) Response
	// UpdateMessage update an existing message (e.g. replace "thinking..." with final result)
	UpdateMessage(req Request) Response
	// DeleteMessage delete a message
	DeleteMessage(req Request) Response

	// GetUserInfo get user info
	GetUserInfo(req Request) Response

	// CreateChannel create channel
	CreateChannel(req Request) Response
	// GetChannelInfo get channel info
	GetChannelInfo(req Request) Response
	// GetChannelList get channel list
	GetChannelList(req Request) Response

	// RegisterChannels register channels
	RegisterChannels(req Request) Response
	// RegisterSlashCommands register slash commands
	RegisterSlashCommands(req Request) Response
}

type Adapter interface {
	MessageConvert(data any) Message
	EventConvert(data any) Event
}

type Command struct {
	Token          string `json:"token"`
	TeamID         string `json:"team_id"`
	TeamDomain     string `json:"team_domain"`
	EnterpriseID   string `json:"enterprise_id,omitempty"`
	EnterpriseName string `json:"enterprise_name,omitempty"`
	ChannelID      string `json:"channel_id"`
	ChannelName    string `json:"channel_name"`
	UserID         string `json:"user_id"`
	UserName       string `json:"user_name"`
	Command        string `json:"command"`
	Text           string `json:"text"`
	ResponseURL    string `json:"response_url"`
	TriggerID      string `json:"trigger_id"`
	APIAppID       string `json:"api_app_id"`

	Prefix string `json:"prefix"`
}

type CommandEventData struct {
	Command string `json:"command,omitempty"`
}

type Driver interface {
	// HttpServer The application can actively access the Chatbot implementation.
	HttpServer(ctx fiber.Ctx) error
	// HttpWebhookClient Chatbot implements active access to applications
	HttpWebhookClient(message Message) error
	// WebSocketClient The application can actively access the Chatbot implementation.
	WebSocketClient()
	// WebSocketServer Chatbot implements active access to applications
	WebSocketServer()
	// Shutdown Shut down the driver
	Shutdown() error
}

type Event struct {
	Id         string    `json:"id"`
	Time       int64     `json:"time"`
	Type       EventType `json:"type"`
	DetailType string    `json:"detail_type"`
	Data       any       `json:"data"`
}

type EventType string

type Message []MessageSegment

type MessageEventData struct {
	Self       Self             `json:"self"`
	MessageId  string           `json:"message_id,omitempty"`
	Message    []MessageSegment `json:"message,omitempty"`
	AltMessage string           `json:"alt_message,omitempty"`
	UserId     string           `json:"user_id,omitempty"`

	TopicId   string `json:"topic_id,omitempty"`
	TopicType string `json:"topic_type,omitempty"`

	Forwarded string `json:"forwarded,omitempty"`

	Seq    float64 `json:"seq,omitempty"`
	Option string  `json:"option,omitempty"`
}

type MessageSegment struct {
	Type string         `json:"type"`
	Data map[string]any `json:"data"`
}

type Request struct {
	Action string         `json:"action"`
	Params map[string]any `json:"params"`
}

type Response struct {
	// Execution status (success or failure), must be one of ok and failed,
	// indicating successful and unsuccessful execution, respectively.
	Status ResponseStatus `json:"status"`
	// The return code, which must conform to the return code rules defined later on this page
	RetCode string `json:"retcode,omitempty"`
	// Response data
	Data any `json:"data,omitempty"`
	// Error message, it is recommended to fill in a human-readable error message when the action fails to execute,
	// or an empty string when it succeeds.
	Message string `json:"message,omitempty"`
}

type ResponseStatus string

type Self struct {
	Platform string `json:"platform"`
	UserId   string `json:"user_id"`
}

type User struct {
	RawData     types.KV `json:"raw_data"`
	Email       string   `json:"email"`
	Name        string   `json:"name"`
	FirstName   string   `json:"first_name"`
	LastName    string   `json:"last_name"`
	NickName    string   `json:"nick_name"`
	Description string   `json:"description"`
	UserID      string   `json:"user_id"`
	AvatarURL   string   `json:"avatar_url"`
	Location    string   `json:"location"`
	Platform    string   `json:"platform"`
	IsBot       bool     `json:"is_bot"`
}