plugin

type Identifier struct {
	// Module is the name of the go module that the plugin is in. Generally, this will be formatted as
	// "site.com/author/repo". This will be added to the go.mod file.
	Module string
	// Checksum is a unique string of data that identifies one specific version of a plugin. It is used to determine if
	// the plugin has been updated since the last time the server has been compiled.
	// Any algorithm may be used, as long as it is deterministic and unique for a specific version of a plugin's source
	// code and the provider that was used to get the plugin. For local plugins, it may be the checksum of the entire
	// directory where the plugin's go.mod file is in. For remote git repositories, the commit hash works.
	Checksum string
}

type Module struct {
	// Module is the name and version of the go module that the plugin is in. Generally, this will be formatted as
	// "site.com/author/repo". This will be added to the go.mod file.
	Module string
	// Version is the version string used in the require directive for the package. It is not use anywhere else, and can
	// be left empty if the plugin does not have a version. An empty version string will be treated as "v0.0.0"
	Version string
	// Replace allows the plugin to optionally add a replace directive to the go.mod file for this plugin. This is
	// usually a path to a local go module.
	Replace string
	// Import returns the package that should be imported for side effects in the server. This is full name of the
	// package (equivalent to how it would be imported) where the plugin is registered to saddle, such as
	// "site.com/author/repo/plugin".
	Import string
}

type Plugin interface {
	// Latest fetches the Identifier for the latest available version that should be downloaded while respecting the
	// configuration of the user. For example, if the user specifies "0.1.7" as a version, this function will return
	// the identifier for that version of the plugin. The result is used to determine whether Plugin.Pull() should be
	// called. This identifier is then assumed to be the identifier of the newly updated plugin.
	Latest() (Identifier, error)
	// Pull will ensure all the necessary files for the plugin are downloaded, if this is needed. Extra checks can also
	// be done here to ensure that the plugin has been downloaded correctly. If an error is returned, the error will be
	// shown and the program will halt. This method is guaranteed to be executed before Plugin.Module().
	Pull() error
	// Module returns info about the go module of the plugin and the package that should be imported. It is used to
	// bundle the plugins.
	Module() Module
}

type Provider = func(info map[string]any) (Plugin, error)