plugin

package

Go to main page

Versions in this module

v0

v0.8.1

Apr 4, 2026

Changes in this version

+ func SetGlobalManager(m *Manager)

type DefaultHostAPI

+ func (h *DefaultHostAPI) DeleteFile(ctx context.Context, key string) error

+ func (h *DefaultHostAPI) GetFile(ctx context.Context, key string) ([]byte, map[string]string, error)

+ func (h *DefaultHostAPI) ListFiles(ctx context.Context, prefix string) ([]FileInfo, error)

+ func (h *DefaultHostAPI) StoreFile(ctx context.Context, key string, data []byte, metadata map[string]string) error

+ type FileInfo = pkgplugin.FileInfo

+ type FileStorageBackend interface

+ Delete func(path string) error

+ Get func(path string) ([]byte, map[string]string, error)

+ List func(prefix string) ([]pkgplugin.FileInfo, error)

+ Store func(path string, data []byte, metadata map[string]string) error

+ Usage func(prefix string) (int64, error)

type Manager

+ func (m *Manager) PolicyFor(name string) *ResourcePolicy

+ func (m *Manager) SkipsOrgInjection(name string) bool

type ProdHostAPI

+ func (h *ProdHostAPI) DeleteFile(ctx context.Context, key string) error

+ func (h *ProdHostAPI) GetFile(ctx context.Context, key string) ([]byte, map[string]string, error)

+ func (h *ProdHostAPI) ListFiles(ctx context.Context, prefix string) ([]pkgplugin.FileInfo, error)

+ func (h *ProdHostAPI) StoreFile(ctx context.Context, key string, data []byte, metadata map[string]string) error

type SSEBroker

+ func (b *SSEBroker) ServeChannel(w http.ResponseWriter, r *http.Request, pluginName, channel string)

type SSEEvent

+ Channel string

type SandboxedHostAPI

+ func (s *SandboxedHostAPI) DeleteFile(ctx context.Context, key string) error

+ func (s *SandboxedHostAPI) GetFile(ctx context.Context, key string) ([]byte, map[string]string, error)

+ func (s *SandboxedHostAPI) ListFiles(ctx context.Context, prefix string) ([]FileInfo, error)

+ func (s *SandboxedHostAPI) StoreFile(ctx context.Context, key string, data []byte, metadata map[string]string) error

v0.8.0

Mar 28, 2026

Changes in this version

+ type CascadeSpec = pkgplugin.CascadeSpec

+ type CustomFieldFilter = pkgplugin.CustomFieldFilter

+ type CustomFieldSpec = pkgplugin.CustomFieldSpec

type DefaultHostAPI

+ func (h *DefaultHostAPI) CustomFieldsGet(ctx context.Context, entityType string, objectID int64, fields []string) (map[string]any, error)

+ func (h *DefaultHostAPI) CustomFieldsQuery(ctx context.Context, entityType string, filters []CustomFieldFilter) ([]int64, error)

+ func (h *DefaultHostAPI) CustomFieldsSet(ctx context.Context, entityType string, objectID int64, values map[string]any) error

+ func (h *DefaultHostAPI) EntityHardDelete(ctx context.Context, entityType string, entityID int64, reason string) error

+ func (h *DefaultHostAPI) EntityRestore(ctx context.Context, entityType string, entityID int64) error

+ func (h *DefaultHostAPI) EntitySoftDelete(ctx context.Context, entityType string, entityID int64, reason string) error

+ func (h *DefaultHostAPI) OrgID(ctx context.Context) int64

+ func (h *DefaultHostAPI) RecycleBinList(ctx context.Context, entityType string) (json.RawMessage, error)

+ func (h *DefaultHostAPI) SecureConfigGet(ctx context.Context, key string) (string, error)

+ func (h *DefaultHostAPI) SecureConfigSet(ctx context.Context, key string, value string) error

type ProdHostAPI

+ func (h *ProdHostAPI) CustomFieldsGet(ctx context.Context, entityType string, objectID int64, fields []string) (map[string]any, error)

+ func (h *ProdHostAPI) CustomFieldsQuery(ctx context.Context, entityType string, filters []CustomFieldFilter) ([]int64, error)

+ func (h *ProdHostAPI) CustomFieldsSet(ctx context.Context, entityType string, objectID int64, values map[string]any) error

+ func (h *ProdHostAPI) EntityHardDelete(ctx context.Context, entityType string, entityID int64, reason string) error

+ func (h *ProdHostAPI) EntityRestore(ctx context.Context, entityType string, entityID int64) error

+ func (h *ProdHostAPI) EntitySoftDelete(ctx context.Context, entityType string, entityID int64, reason string) error

+ func (h *ProdHostAPI) OrgID(ctx context.Context) int64

+ func (h *ProdHostAPI) RecycleBinList(ctx context.Context, entityType string) (json.RawMessage, error)

+ func (h *ProdHostAPI) SecureConfigGet(ctx context.Context, key string) (string, error)

+ func (h *ProdHostAPI) SecureConfigSet(ctx context.Context, key string, value string) error

type SandboxedHostAPI

+ func (s *SandboxedHostAPI) CustomFieldsGet(ctx context.Context, entityType string, objectID int64, fields []string) (map[string]any, error)

+ func (s *SandboxedHostAPI) CustomFieldsQuery(ctx context.Context, entityType string, filters []CustomFieldFilter) ([]int64, error)

+ func (s *SandboxedHostAPI) CustomFieldsSet(ctx context.Context, entityType string, objectID int64, values map[string]any) error

+ func (s *SandboxedHostAPI) EntityHardDelete(ctx context.Context, entityType string, entityID int64, reason string) error

+ func (s *SandboxedHostAPI) EntityRestore(ctx context.Context, entityType string, entityID int64) error

+ func (s *SandboxedHostAPI) EntitySoftDelete(ctx context.Context, entityType string, entityID int64, reason string) error

+ func (s *SandboxedHostAPI) OrgID(ctx context.Context) int64

+ func (s *SandboxedHostAPI) RecycleBinList(ctx context.Context, entityType string) (json.RawMessage, error)

+ func (s *SandboxedHostAPI) SecureConfigGet(ctx context.Context, key string) (string, error)

+ func (s *SandboxedHostAPI) SecureConfigSet(ctx context.Context, key string, value string) error

+ type UIAuthSpec = pkgplugin.UIAuthSpec

+ type UIBrandingSpec = pkgplugin.UIBrandingSpec

+ type UINavItem = pkgplugin.UINavItem

+ type UINavSpec = pkgplugin.UINavSpec

+ type UIPWASpec = pkgplugin.UIPWASpec

+ type UIRouteSpec = pkgplugin.UIRouteSpec

+ type UISpec = pkgplugin.UISpec

v0.7.0

Mar 26, 2026

Changes in this version

+ var DefaultResourcePolicy = pkgplugin.DefaultResourcePolicy

type DefaultHostAPI

+ func (h *DefaultHostAPI) PublishEvent(ctx context.Context, eventType string, data string) error

type Manager

+ func (m *Manager) AllPluginStats() []StatsSnapshot

+ func (m *Manager) AllPolicies() map[string]ResourcePolicy

+ func (m *Manager) GetPolicy(name string) (ResourcePolicy, bool)

+ func (m *Manager) HiddenMenuItems() []string

+ func (m *Manager) Host() HostAPI

+ func (m *Manager) LandingPage() string

+ func (m *Manager) PluginStats(name string) (StatsSnapshot, bool)

+ func (m *Manager) ReplacePlugin(ctx context.Context, oldName string, newPlugin Plugin) error

+ func (m *Manager) SetPolicy(name string, policy ResourcePolicy)

+ type Permission = pkgplugin.Permission

+ type PluginStats struct

+ CacheOps atomic.Int64

+ Calls atomic.Int64

+ DBExecs atomic.Int64

+ DBQueries atomic.Int64

+ Errors atomic.Int64

+ HTTPRequests atomic.Int64

+ LastCallAt atomic.Int64

+ func (s *PluginStats) Snapshot(name string) StatsSnapshot

type ProdHostAPI

+ SSEBroker *SSEBroker

+ func (h *ProdHostAPI) PublishEvent(ctx context.Context, eventType string, data string) error

+ type ResourcePolicy = pkgplugin.ResourcePolicy

+ type ResourceRequest = pkgplugin.ResourceRequest

+ type SSEBroker struct

+ func NewSSEBroker() *SSEBroker

+ func (b *SSEBroker) ClientCount() int

+ func (b *SSEBroker) Publish(event SSEEvent)

+ func (b *SSEBroker) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (b *SSEBroker) Subscribe(pluginFilter string) chan SSEEvent

+ func (b *SSEBroker) Unsubscribe(ch chan SSEEvent)

+ type SSEEvent struct

+ Data string

+ Plugin string

+ Type string

+ type SandboxedHostAPI struct

+ func NewSandboxedHostAPI(inner HostAPI, pluginName string, policy ResourcePolicy) *SandboxedHostAPI

+ func (s *SandboxedHostAPI) CacheDelete(ctx context.Context, key string) error

+ func (s *SandboxedHostAPI) CacheGet(ctx context.Context, key string) ([]byte, bool, error)

+ func (s *SandboxedHostAPI) CacheSet(ctx context.Context, key string, value []byte, ttlSeconds int) error

+ func (s *SandboxedHostAPI) CallPlugin(ctx context.Context, pluginName, fn string, args json.RawMessage) (json.RawMessage, error)

+ func (s *SandboxedHostAPI) ConfigGet(ctx context.Context, key string) (string, error)

+ func (s *SandboxedHostAPI) DBExec(ctx context.Context, query string, args ...any) (int64, error)

+ func (s *SandboxedHostAPI) DBQuery(ctx context.Context, query string, args ...any) ([]map[string]any, error)

+ func (s *SandboxedHostAPI) HTTPRequest(ctx context.Context, method, url string, headers map[string]string, ...) (int, []byte, error)

+ func (s *SandboxedHostAPI) Log(ctx context.Context, level, message string, fields map[string]any)

+ func (s *SandboxedHostAPI) PublishEvent(ctx context.Context, eventType string, data string) error

+ func (s *SandboxedHostAPI) SendEmail(ctx context.Context, to, subject, body string, html bool) error

+ func (s *SandboxedHostAPI) Stats() StatsSnapshot

+ func (s *SandboxedHostAPI) Translate(ctx context.Context, key string, args ...any) string

+ func (s *SandboxedHostAPI) UpdatePolicy(policy ResourcePolicy)

+ type StatsSnapshot struct

+ CacheOps int64

+ Calls int64

+ DBExecs int64

+ DBQueries int64

+ Errors int64

+ HTTPRequests int64

+ LastCallAt int64

+ PluginName string

v0.6.5

Feb 9, 2026

Changes in this version

+ var PluginCallerKey = pluginCallerKeyType

+ var PluginLanguageKey = pluginLangKeyType

+ func RegisterPluginJobs(mgr *Manager, sched *scheduler.Service) int

+ func SetTemplateOverrides(registry *TemplateOverrideRegistry)

+ func SetTemplatePluginManager(mgr *Manager)

+ type DefaultHostAPI struct

+ func NewDefaultHostAPI() *DefaultHostAPI

+ func (h *DefaultHostAPI) CacheDelete(ctx context.Context, key string) error

+ func (h *DefaultHostAPI) CacheGet(ctx context.Context, key string) ([]byte, bool, error)

+ func (h *DefaultHostAPI) CacheSet(ctx context.Context, key string, value []byte, ttlSeconds int) error

+ func (h *DefaultHostAPI) CallPlugin(ctx context.Context, pluginName, fn string, args json.RawMessage) (json.RawMessage, error)

+ func (h *DefaultHostAPI) ConfigGet(ctx context.Context, key string) (string, error)

+ func (h *DefaultHostAPI) DBExec(ctx context.Context, query string, args ...any) (int64, error)

+ func (h *DefaultHostAPI) DBQuery(ctx context.Context, query string, args ...any) ([]map[string]any, error)

+ func (h *DefaultHostAPI) HTTPRequest(ctx context.Context, method, url string, headers map[string]string, ...) (int, []byte, error)

+ func (h *DefaultHostAPI) Log(ctx context.Context, level, message string, fields map[string]any)

+ func (h *DefaultHostAPI) SendEmail(ctx context.Context, to, subject, body string, html bool) error

+ func (h *DefaultHostAPI) Translate(ctx context.Context, key string, args ...any) string

+ type ErrorCodeSpec struct

+ Code string

+ HTTPStatus int

+ Message string

+ type GKRegistration struct

+ Author string

+ Description string

+ ErrorCodes []ErrorCodeSpec

+ Homepage string

+ I18n *I18nSpec

+ Jobs []JobSpec

+ License string

+ MenuItems []MenuItemSpec

+ MinHostVersion string

+ Name string

+ Permissions []string

+ Routes []RouteSpec

+ Templates []TemplateSpec

+ Version string

+ Widgets []WidgetSpec

+ type HostAPI interface

+ CacheDelete func(ctx context.Context, key string) error

+ CacheGet func(ctx context.Context, key string) ([]byte, bool, error)

+ CacheSet func(ctx context.Context, key string, value []byte, ttlSeconds int) error

+ CallPlugin func(ctx context.Context, pluginName, fn string, args json.RawMessage) (json.RawMessage, error)

+ ConfigGet func(ctx context.Context, key string) (string, error)

+ DBExec func(ctx context.Context, query string, args ...any) (int64, error)

+ DBQuery func(ctx context.Context, query string, args ...any) ([]map[string]any, error)

+ HTTPRequest func(ctx context.Context, method, url string, headers map[string]string, ...) (int, []byte, error)

+ Log func(ctx context.Context, level, message string, fields map[string]any)

+ SendEmail func(ctx context.Context, to, subject, body string, html bool) error

+ Translate func(ctx context.Context, key string, args ...any) string

+ type I18nSpec struct

+ Languages []string

+ Namespace string

+ Translations map[string]map[string]string

+ type JobSpec struct

+ Description string

+ Enabled bool

+ Handler string

+ ID string

+ Schedule string

+ Timeout string

+ type LazyLoader interface

+ Discovered func() []string

+ EnsureLoaded func(ctx context.Context, name string) error

+ type LogBuffer struct

+ func GetLogBuffer() *LogBuffer

+ func NewLogBuffer(maxSize int) *LogBuffer

+ func (b *LogBuffer) Add(entry LogEntry)

+ func (b *LogBuffer) Clear()

+ func (b *LogBuffer) Count() int

+ func (b *LogBuffer) GetAll() []LogEntry

+ func (b *LogBuffer) GetByLevel(minLevel string) []LogEntry

+ func (b *LogBuffer) GetByPlugin(pluginName string) []LogEntry

+ func (b *LogBuffer) GetRecent(n int) []LogEntry

+ func (b *LogBuffer) Log(plugin, level, message string, fields map[string]any)

+ type LogEntry struct

+ Fields map[string]any

+ Level string

+ Message string

+ Plugin string

+ Timestamp time.Time

+ type Manager struct

+ func NewManager(host HostAPI) *Manager

+ func (m *Manager) AllWidgets(location string) []PluginWidget

+ func (m *Manager) Call(ctx context.Context, pluginName, fn string, args []byte) ([]byte, error)

+ func (m *Manager) CallFrom(ctx context.Context, callerPlugin, targetPlugin, fn string, args []byte) ([]byte, error)

+ func (m *Manager) Disable(name string) error

+ func (m *Manager) Discovered() []string

+ func (m *Manager) Enable(name string) error

+ func (m *Manager) Get(name string) (Plugin, bool)

+ func (m *Manager) IsEnabled(name string) bool

+ func (m *Manager) Jobs() []PluginJob

+ func (m *Manager) List() []GKRegistration

+ func (m *Manager) MenuItems(location string) []PluginMenuItem

+ func (m *Manager) Register(ctx context.Context, p Plugin) error

+ func (m *Manager) Routes() []PluginRoute

+ func (m *Manager) SetLazyLoader(loader LazyLoader)

+ func (m *Manager) ShutdownAll(ctx context.Context) error

+ func (m *Manager) Unregister(ctx context.Context, name string) error

+ func (m *Manager) Widgets(location string) []PluginWidget

+ type MenuItemSpec struct

+ Children []MenuItemSpec

+ ID string

+ Icon string

+ Label string

+ Location string

+ Order int

+ Parent string

+ Path string

+ type Plugin interface

+ Call func(ctx context.Context, fn string, args json.RawMessage) (json.RawMessage, error)

+ GKRegister func() GKRegistration

+ Init func(ctx context.Context, host HostAPI) error

+ Shutdown func(ctx context.Context) error

+ type PluginCaller struct

+ Ctx context.Context

+ Manager *Manager

+ PluginName string

+ func (pc *PluginCaller) Call(fn string, args ...interface{}) interface{}

+ func (pc *PluginCaller) Translate(key string, args ...interface{}) string

+ func (pc *PluginCaller) Widget(widgetID string) string

+ type PluginDisabledError struct

+ CallerPlugin string

+ PluginName string

+ func (e *PluginDisabledError) Error() string

+ type PluginJob struct

+ PluginName string

+ type PluginMenuItem struct

+ PluginName string

+ type PluginNotFoundError struct

+ CallerPlugin string

+ Function string

+ PluginName string

+ func (e *PluginNotFoundError) Error() string

+ type PluginRoute struct

+ PluginName string

+ RouteSpec RouteSpec

+ type PluginWidget struct

+ PluginName string

+ type ProdHostAPI struct

+ PluginManager *Manager

+ func NewProdHostAPI(opts ...ProdHostAPIOption) *ProdHostAPI

+ func (h *ProdHostAPI) CacheDelete(ctx context.Context, key string) error

+ func (h *ProdHostAPI) CacheGet(ctx context.Context, key string) ([]byte, bool, error)

+ func (h *ProdHostAPI) CacheSet(ctx context.Context, key string, value []byte, ttlSeconds int) error

+ func (h *ProdHostAPI) CallPlugin(ctx context.Context, pluginName, fn string, args json.RawMessage) (json.RawMessage, error)

+ func (h *ProdHostAPI) ConfigGet(ctx context.Context, key string) (string, error)

+ func (h *ProdHostAPI) DBExec(ctx context.Context, query string, args ...any) (int64, error)

+ func (h *ProdHostAPI) DBQuery(ctx context.Context, query string, args ...any) ([]map[string]any, error)

+ func (h *ProdHostAPI) HTTPRequest(ctx context.Context, method, url string, headers map[string]string, ...) (int, []byte, error)

+ func (h *ProdHostAPI) Log(ctx context.Context, level, message string, fields map[string]any)

+ func (h *ProdHostAPI) SendEmail(ctx context.Context, to, subject, body string, html bool) error

+ func (h *ProdHostAPI) Translate(ctx context.Context, key string, args ...any) string

+ type ProdHostAPIOption func(*ProdHostAPI)

+ func WithCache(c *cache.RedisCache) ProdHostAPIOption

+ func WithDB(name string, db *sql.DB) ProdHostAPIOption

+ func WithDefaultDB(name string) ProdHostAPIOption

+ func WithLogger(logger *slog.Logger) ProdHostAPIOption

+ func WithPluginManager(mgr *Manager) ProdHostAPIOption

+ type RouteSpec struct

+ Description string

+ Handler string

+ Method string

+ Middleware []string

+ Path string

+ type TemplateOverride struct

+ Handler string

+ PluginName string

+ TemplateName string

+ type TemplateOverrideRegistry struct

+ func GetTemplateOverrides() *TemplateOverrideRegistry

+ func NewTemplateOverrideRegistry(mgr *Manager) *TemplateOverrideRegistry

+ func (r *TemplateOverrideRegistry) GetOverride(templateName string) *TemplateOverride

+ func (r *TemplateOverrideRegistry) HasOverride(templateName string) bool

+ func (r *TemplateOverrideRegistry) List() map[string]*TemplateOverride

+ func (r *TemplateOverrideRegistry) Register(pluginName string, templates []TemplateSpec)

+ func (r *TemplateOverrideRegistry) RenderOverride(ctx context.Context, templateName string, data map[string]any) (string, bool)

+ func (r *TemplateOverrideRegistry) Unregister(pluginName string)

+ type TemplateSpec struct

+ Name string

+ Override bool

+ Path string

+ type WidgetSpec struct

+ Description string

+ Handler string

+ ID string

+ Location string

+ Order int

+ RefreshSec int

+ Refreshable bool

+ Size string

+ Title string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL