hub

type APIPlugin interface {
	Plugin
	// A router mounted on /. Generally, keep API extensions inside of
	// `/api/`; this interface gives / for well-known URIs, etc.
	Route(chi.Router)
}

type CrossPlugin interface {
	Plugin
	// Called after all other plugins have been initialized.
	Extend(map[string]Plugin) error
}

type DB struct{ *bun.DB }

type DatabasePlugin interface {
	Plugin
	Migrations() map[uint]func(*DB) error
}

type Manager interface {
	// On error, returns the index of the plugin erroring and the error
	// received, or “(-1, nil)“ if all plugins initialized successfully.
	AddPlugins(...Plugin) (int, error)
	AddPluginFile(filename string) error
	GetPluginMap() map[string]Plugin
	// Finishishes initializing each plugin, specifically by passing the
	// plugin map to CrossPlugins.
	Finalize()
	// Starts listening. If the Server pointer is nil, Listen will use the
	// implementation default. Implementors should not modify a passed
	// Server except its Handler.
	Listen(*http.Server)
	// Shuts down the “http.Server“ in Listen() and calls Destroy() on
	// each plugin. Returns any error in shutting down, for instance from
	// “http.Server.Shutdown()“.
	Shutdown() error
}

type Plugin interface {
	Init(*log.Logger, PluginParams) error
	// Returns the D-Bus or Java–style name for the plugin. Must not rely
	// on an earlier Init() call.
	DBusName() string
	// Function to close connections, end requests, etc.
	Destroy()
}

type PluginParams struct {
	// A struct containing a bun DB, generally Postgres or another system
	// supporting  PL/pgSQL. If you prefer, you can access a `*sql.DB` at
	// `plugin.DB.DB.DB`.
	//
	// Please be mindful of other plugins and contain your plugin's data
	// in its own Postgres schema.
	DB *DB

	// A file handle for a config file. If there is no configuration file,
	// this is set to nil. This is owned by the manager - the file will be
	// closed after the AddPlugins function (when Init is called) ends.
	ConfigHandle io.ReadSeekCloser
}