pluginui

type PluginCaller interface {
	Call(ctx context.Context, pluginName, fn string, args []byte) ([]byte, error)
}

type PluginUI struct {
	ID           int64            `json:"id" db:"id"`
	PluginName   string           `json:"plugin_name" db:"plugin_name"`
	UIID         string           `json:"ui_id" db:"ui_id"`
	FullID       string           `json:"full_id" db:"full_id"`
	Name         string           `json:"name" db:"name"`
	Description  *string          `json:"description,omitempty" db:"description"`
	UIType       string           `json:"ui_type" db:"ui_type"`
	Shell        string           `json:"shell" db:"shell"`
	Icon         *string          `json:"icon,omitempty" db:"icon"`
	Config       *json.RawMessage `json:"config,omitempty" db:"config"`
	Enabled      bool             `json:"enabled" db:"enabled"`
	CustomDomain *string          `json:"custom_domain,omitempty" db:"custom_domain"`
	ValidID      int              `json:"valid_id" db:"valid_id"`
	CreateTime   time.Time        `json:"create_time" db:"create_time"`
	CreateBy     int              `json:"create_by" db:"create_by"`
	ChangeTime   time.Time        `json:"change_time" db:"change_time"`
	ChangeBy     int              `json:"change_by" db:"change_by"`
}

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

type TemplateRenderer interface {
	HTML(c *gin.Context, code int, name string, data interface{})
}

type UIAuth struct {
	// Authenticate identifies the caller from a session cookie, JWT or API
	// token and rejects anonymous requests.
	Authenticate gin.HandlerFunc
	// RequireGroup returns middleware admitting admins and members of the
	// named agent group.
	RequireGroup func(name string) gin.HandlerFunc
	// Envelope replaces any client-supplied envelope key in args with the
	// host's call envelope for the request's caller (identity, admin flag,
	// organisation, language), the same envelope every API plugin call
	// carries. The plugin Manager turns it into the call context. Required.
	Envelope func(c *gin.Context, args map[string]any, pluginName string)
}

type UIAuthConfig struct {
	Method string   `json:"method,omitempty"` // session, pin, token, none
	Groups []string `json:"groups,omitempty"`
}

type UIBrandingConfig struct {
	AppName string `json:"app_name,omitempty"`
	Logo    string `json:"logo,omitempty"`
	Favicon string `json:"favicon,omitempty"`
	Color   string `json:"color,omitempty"`
}

type UIConfig struct {
	Routes    []UIRouteConfig   `json:"routes,omitempty"`
	Nav       *UINavConfig      `json:"nav,omitempty"`
	Branding  *UIBrandingConfig `json:"branding,omitempty"`
	Auth      *UIAuthConfig     `json:"auth,omitempty"`
	PWA       *UIPWAConfig      `json:"pwa,omitempty"`
	DataScope string            `json:"data_scope,omitempty"`
	RateLimit int               `json:"rate_limit,omitempty"`
}

type UIInfoLookup interface {
	GetByFullID(fullID string) (*PluginUI, error)
}

type UINavConfig struct {
	Position string            `json:"position"` // bottom, top, side
	Items    []UINavItemConfig `json:"items"`
}

type UINavItemConfig struct {
	Label string `json:"label"`
	Icon  string `json:"icon"`
	Path  string `json:"path"`
	Badge string `json:"badge,omitempty"` // plugin function name for badge count
	Order int    `json:"order,omitempty"`
}

type UIPWAConfig struct {
	Enabled     bool     `json:"enabled"`
	StartURL    string   `json:"start_url,omitempty"`
	Display     string   `json:"display,omitempty"` // standalone, fullscreen, minimal-ui
	ThemeColor  string   `json:"theme_color,omitempty"`
	CacheRoutes []string `json:"cache_routes,omitempty"`
}

type UIRouteConfig struct {
	Path    string `json:"path"`
	Method  string `json:"method,omitempty"`
	Handler string `json:"handler"`
}