pluginmodel

Documentation

Overview

Package plugin provides domain entities for the plugin system.

Index

• Constants
• Variables
• type ConfigField
• type InputSchema
  • func (i *InputSchema) IsValidType() bool
  • func (i *InputSchema) Validate() error
• type Manifest
  • func (m *Manifest) HasCapability(capability string) bool
  • func (m *Manifest) Validate() error
• type OperationResult
  • func (r *OperationResult) GetOutput(key string) (any, bool)
  • func (r *OperationResult) HasError() bool
  • func (r *OperationResult) IsSuccess() bool
• type OperationSchema
  • func (o *OperationSchema) GetRequiredInputs() []string
  • func (o *OperationSchema) Validate() error
• type PluginInfo
  • func (p *PluginInfo) CanLoad() bool
  • func (p *PluginInfo) IsActive() bool
• type PluginState
  • func NewPluginState() *PluginState
• type PluginStatus
• type PluginType

Constants

const (
	CapabilityOperations = "operations"
	CapabilityStepTypes  = "step_types"
	CapabilityValidators = "validators"
)

const (
	ConfigTypeString  = "string"
	ConfigTypeInteger = "integer"
	ConfigTypeBoolean = "boolean"
)

const (
	InputTypeString  = "string"
	InputTypeInteger = "integer"
	InputTypeBoolean = "boolean"
	InputTypeArray   = "array"
	InputTypeObject  = "object"
)

Variables

var ErrNotImplemented = errors.New("not implemented")

var ValidCapabilities = []string{
	CapabilityOperations,
	CapabilityStepTypes,
	CapabilityValidators,
}

var ValidConfigTypes = []string{
	ConfigTypeString,
	ConfigTypeInteger,
	ConfigTypeBoolean,
}

var ValidInputTypes = []string{
	InputTypeString,
	InputTypeInteger,
	InputTypeBoolean,
	InputTypeArray,
	InputTypeObject,
}

var ValidValidationRules = []string{
	"url",
	"email",
}

Types

type ConfigField

type ConfigField struct {
	Type        string
	Required    bool
	Default     any
	Description string
	Enum        []string
}

type InputSchema

type InputSchema struct {
	Type        string
	Required    bool
	Default     any
	Description string
	Validation  string
}

func (*InputSchema) IsValidType

func (i *InputSchema) IsValidType() bool

func (*InputSchema) Validate

func (i *InputSchema) Validate() error

type Manifest

type Manifest struct {
	Name         string
	Version      string
	Description  string
	AWFVersion   string
	Author       string
	License      string
	Homepage     string
	Capabilities []string
	Config       map[string]ConfigField
}

func (*Manifest) HasCapability

func (m *Manifest) HasCapability(capability string) bool

HasCapability checks if the plugin declares a specific capability.

func (*Manifest) Validate

func (m *Manifest) Validate() error

type OperationResult

type OperationResult struct {
	Success bool
	Outputs map[string]any
	Error   string
}

func (*OperationResult) GetOutput

func (r *OperationResult) GetOutput(key string) (any, bool)

func (*OperationResult) HasError

func (r *OperationResult) HasError() bool

func (*OperationResult) IsSuccess

func (r *OperationResult) IsSuccess() bool

type OperationSchema

type OperationSchema struct {
	Name        string
	Description string
	Inputs      map[string]InputSchema
	Outputs     []string
	PluginName  string
}

func (*OperationSchema) GetRequiredInputs

func (o *OperationSchema) GetRequiredInputs() []string

func (*OperationSchema) Validate

func (o *OperationSchema) Validate() error

type PluginInfo

type PluginInfo struct {
	Manifest      *Manifest
	Status        PluginStatus
	Type          PluginType
	Path          string
	Error         error
	LoadedAt      int64
	InitializedAt int64
	Operations    []string
	StepTypes     []string
}

func (*PluginInfo) CanLoad

func (p *PluginInfo) CanLoad() bool

func (*PluginInfo) IsActive

func (p *PluginInfo) IsActive() bool

type PluginState

type PluginState struct {
	Enabled    bool           `json:"enabled"`
	Config     map[string]any `json:"config,omitempty"`
	DisabledAt int64          `json:"disabled_at,omitempty"`
	SourceData map[string]any `json:"source_data,omitempty"`
}

func NewPluginState

func NewPluginState() *PluginState

type PluginStatus

type PluginStatus string

PluginStatus represents the lifecycle state of a plugin.

const (
	StatusDiscovered  PluginStatus = "discovered"  // Found in plugins/ directory
	StatusLoaded      PluginStatus = "loaded"      // Manifest parsed successfully
	StatusInitialized PluginStatus = "initialized" // Init() completed
	StatusRunning     PluginStatus = "running"     // Active and serving requests
	StatusStopped     PluginStatus = "stopped"     // Shutdown() completed
	StatusFailed      PluginStatus = "failed"      // Error occurred
	StatusDisabled    PluginStatus = "disabled"    // Manually disabled by user
	StatusBuiltin     PluginStatus = "builtin"     // Built-in provider registered at startup
)

type PluginType

type PluginType string

PluginType distinguishes built-in providers from external plugins.

const (
	PluginTypeBuiltin  PluginType = "builtin"
	PluginTypeExternal PluginType = "external"
)