plugin

Documentation

Index

• Constants
• type Command
• type CommandContext
• type CommandProvider
• type CommandResult
• type EndpointSetup
• type MigrationProvider
• type OpenAPIProvider
• type OpenAPIResource
• type Plugin
• type PluginDependencies
• type PluginRegistry
  • func NewPluginRegistry() *PluginRegistry
  • func (r *PluginRegistry) Get(name string) (Plugin, bool)
  • func (r *PluginRegistry) GetAll() map[string]Plugin
  • func (r *PluginRegistry) Register(plugin Plugin)

Constants

const (
	ConfigKeyDependencies = "__dependencies"
	ConfigKeyVersion      = "__version"
)

Types

type Command

type Command interface {
	Name() string
	Description() string
	Run(ctx *CommandContext) *CommandResult
}

type CommandContext

type CommandContext struct {
	Config any

	Args []string

	ProgressCallback func(message string)
}

type CommandProvider

type CommandProvider interface {
	Commands() []Command
}

type CommandResult

type CommandResult struct {
	Success bool

	Error error

	FilesCreated []string

	FilesModified []string

	Message string
}

type EndpointSetup

type EndpointSetup interface {
	SetupEndpoints(router fiber.Router) error
}

type MigrationProvider

type MigrationProvider interface {
	// MigrationSource returns a migration source for this plugin
	// The source name should match the plugin name
	// Returns any to avoid circular dependency with migrations package
	// Actual type should be migrations.MigrationSource
	MigrationSource() any

	// MigrationDependencies returns list of sources this plugin depends on
	// Example: ["app", "users-plugin"]
	// Ensures migrations run in correct order
	// Return nil or empty slice if no dependencies
	MigrationDependencies() []string
}

type OpenAPIProvider

type OpenAPIProvider interface {
	GetOpenAPIResources() []OpenAPIResource
}

type OpenAPIResource

type OpenAPIResource struct {
	Name          string
	PluralName    string
	BasePath      string
	Tags          []string
	ResponseModel any
	CreateModel   any
	UpdateModel   any
	Description   string
}

type Plugin

type Plugin interface {
	Name() string

	Initialize(config map[string]any) error

	Handler() fiber.Handler
}

type PluginDependencies

type PluginDependencies interface {
	Dependencies() []string
}

PluginDependencies is an optional interface for plugins that depend on other plugins. Dependencies must be declared by their plugin name (matching Plugin.Name()). The plugin loader ensures:

• All dependencies are registered and enabled
• Dependencies are initialized before dependent plugins
• Circular dependencies are detected and rejected
• Dependencies are injected via Initialize() config under ConfigKeyDependencies

type PluginRegistry

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

Plugins are NOT automatically applied; user must explicitly call plugin.Handler() and register it.

func NewPluginRegistry

func NewPluginRegistry() *PluginRegistry

func (*PluginRegistry) Get

func (r *PluginRegistry) Get(name string) (Plugin, bool)

func (*PluginRegistry) GetAll

func (r *PluginRegistry) GetAll() map[string]Plugin

func (*PluginRegistry) Register

func (r *PluginRegistry) Register(plugin Plugin)