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.
	GetInt(table, key string) (int, error)                           // Retrieve an int stored with PutInt.
	GetObj(table, key string, obj interface{}) error                 // Retrieve an object stored with PutObj.
	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
	PutInt(table, key string, i int) error                           // Inserts an integer at location "key" for retrieval via GetInt
	PutObj(table, key string, obj interface{}) error                 // Inserts an object at location "key" for retrieval via GetObj
	Remove(table, key string) error                                  // Removes an object at location "key"
	SetIndex(table, field string) error                              // Sets an index on field. If using LevelDB, values in this field must be unique.
	Close() error                                                    // Terminate a database session (only run if nothing is using the database).
}

type Emoji struct {
	ID    UUID   // The UUID of the emoji, should never be blank.
	Name  string // Either a unicode representation of the emoji, or a name.
	Added bool   // If true, the emoji was just added as a reaction. If false, it was just removed. Ignore field on reaction lists (See Message.Reactions()).
}

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
	SendFormattedText(text, formattedText string) // Sends formatted text to the location (correctness might vary between protocols)
	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 for commands)
	FormattedText() string             // the formatted text being received (minus trigger for commands)
	StripPrefix(prefix string) Message // Returns a copy of the message with `prefix + commandName + " "` stripped (Ex: "!say Hello" becomes "Hello")
	Raw() []byte                       // The raw data received
	UUID() UUID                        // Unique identifier for the message (can be empty)
	Mentioned() bool                   // True if the bot was mentioned in the message
	Reaction() *Emoji                  // Returns an emoji that was either added or removed, or nil if none

}

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() string                            // The version of the plugin
	Implements() (map[string]Command, *Monitor) // Returns a map 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() string                                       // 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
	SendFormattedText(to UUID, text, formattedText string) // Sends formatted text to a location (correctness might vary between protocols)
	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 sender
	Location() Location                           // The location where this sender sent the message from
	Protocol() string                             // Returns the protocol name responsible for the sender
	Self() bool                                   // Returns true if the sender is the bot
	Send(msg Message)                             // Sends a Message to the sender
	SendText(text string)                         // Sends text to the sender
	SendFormattedText(text, formattedText string) // Sends formatted text to the sender (correctness might vary between protocols)
}

type UUID string

type UserObject struct {
	Alias UUID `bson:"a"` // User alias, UUID
}