65 lines
2.1 KiB
Go
65 lines
2.1 KiB
Go
package plugin
|
|
|
|
import (
|
|
"context"
|
|
"io/fs"
|
|
"net/http"
|
|
|
|
"git.dev.alexdunmow.com/block/pluginsdk/blocks"
|
|
"git.dev.alexdunmow.com/block/pluginsdk/templates"
|
|
)
|
|
|
|
// RegisterFunc is the function signature for plugin registration.
|
|
// Plugins register their templates and blocks through the provided registries.
|
|
type RegisterFunc func(tr templates.TemplateRegistry, br blocks.BlockRegistry) error
|
|
|
|
// LoadOnceHook is a persistent, keyed load callback. The host runs Run after
|
|
// the ordinary Load hook and records a successful execution by plugin name and
|
|
// Key. The same key is never run successfully again on that site; changing the
|
|
// key explicitly schedules a replacement callback once.
|
|
type LoadOnceHook struct {
|
|
Key string
|
|
Run func(deps CoreServices) error
|
|
}
|
|
|
|
// PluginRegistration defines a compiled-in plugin's entry points.
|
|
type PluginRegistration struct {
|
|
Name string
|
|
|
|
Register RegisterFunc
|
|
RegisterWithProvisioner func(tr templates.TemplateRegistry, br blocks.BlockRegistry, p Provisioner) error
|
|
|
|
Assets func() http.Handler
|
|
Schemas func() fs.FS
|
|
SettingsSchema func() []byte
|
|
ThemePresets func() []byte
|
|
BundledFonts func() []byte
|
|
MasterPages func() []MasterPageDefinition
|
|
|
|
HTTPHandler func(deps CoreServices) http.Handler
|
|
SettingsPanel func() string
|
|
AdminPages func() []AdminPage
|
|
|
|
CSSManifest func() *CSSManifest
|
|
ServiceHandlers func(deps CoreServices) (*ServiceRegistration, error)
|
|
JobHandlers func(deps CoreServices) map[string]JobHandlerFunc
|
|
AIActions func() []AIAction
|
|
|
|
DirectoryExtensions func() *DirectoryExtensions
|
|
MediaHooks MediaHooksProvider
|
|
|
|
Load func(deps CoreServices) error
|
|
LoadOnce []LoadOnceHook
|
|
Unload func(ctx context.Context) error
|
|
|
|
Dependencies []Dependency
|
|
Migrations func() fs.FS
|
|
Version string
|
|
|
|
// RequiredIconPacks are icon-pack slugs the CMS must ensure are installed
|
|
// before the theme loads (e.g. "tabler", "phosphor"). Loader auto-installs
|
|
// from the bundled registry; out-of-registry slugs are logged and require
|
|
// manual install.
|
|
RequiredIconPacks []string
|
|
}
|