onelib

type Command func(msg Message, sender Sender)

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

type Database interface {
	Get(table, key string) (map[string]interface{}, error)           // Retrieves value by key directly
	GetString(table, key string) (string, error)                     // Retrieve a string stored with PutString.
	Search(table, field, key string) (map[string]interface{}, error) // Searches for key in field, containing key (IE: field:'username', key:'admin'), using an index if exists.
	Put(table string, data map[string]interface{}) ([]byte, error)   // Inserts data into database, using "_id" field as key, generating one if none exists. Returns key.
	PutString(table, key, text string) error                         // Inserts text at location "key" for retrieval via GetString
	SetIndex(table, field string) error                              // Sets an index on field.
	Close() error                                                    // Terminate a database session (only run if nothing is using the database).
}

type Location interface {
	DisplayName() string // Display name of the location
	Nickname() string    // The nickname of the bot in the location
	Topic() string       // The topic of the location
	// Picture // TODO The avatar of the location
	UUID() UUID           // Unique identifier for the location
	Send(msg Message)     // Sends a message to the location
	SendText(text string) // Sends text to the location
	Protocol() string     // Returns the name of the protocol the location is in
}

type Message interface {
	Text() string // The unformatted text being received (minus the trigger word for commands)
	// Reactions() []Reaction // TODO The reactions on the message
	StripPrefix() Message // Returns a copy of the message with `prefix + commandName + " "` stripped (Ex: "!say Hello" becomes "Hello")
	Raw() []byte          // The raw data received
}

type Monitor struct {
	OnMessage         func(from Sender, msg Message)    // Called on every new message
	OnMessageWithText func(from Sender, msg Message)    // Called on every new message containing text
	OnMessageUpdate   func(from Sender, update Message) // Called on message update (IE: edit, reaction)

}

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

type Plugin interface {
	Name() string                               // The name of the plugin, used in the plugin map (should be same as filename, minus extension)
	LongName() string                           // The display name of the plugin
	Version() int                               // The version of the plugin
	Implements() (map[string]Command, *Monitor) // Returns lists of commands and monitor the plugin implements
	Remove()                                    // Called when the plugin is about to be terminated
}

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

type Protocol interface {
	Name() string                  // The name of the protocol, used in the protocol map (should be same as filename, minus extension)
	LongName() string              // The display name of the protocol
	Version() int                  // The version of the protocol
	NewMessage(raw []byte) Message // Returns a new Message object built from []byte (TODO: I hate this)
	Send(to UUID, msg Message)     // Sends a Message to a location
	SendText(to UUID, text string) // Sends text to a location
	Remove()                       // Called when the protocol is about to be terminated
}

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

type Sender interface {
	DisplayName() string // Display name of the sender
	Username() string    // Username of the sender (often unknown, should return an empty string if so)
	UUID() UUID          // Unique identifier for the sender
	// Picture // TODO The avatar of the location
	Location() Location   // The location where this sender sent the message from
	Protocol() string     // Returns the protocol name responsible for the sender
	Send(msg Message)     // Sends a Message to the sender
	SendText(text string) // Sends text to the sender
}

type UUID string