plugins

type Catalog struct {
	Groups []CatalogGroup `json:"groups"`
}

type CatalogEntry struct {
	Slug            string         `json:"slug"`
	Name            string         `json:"name"`
	Description     string         `json:"description,omitempty"`
	MandatoryStages []policy.Stage `json:"mandatory_stages"`
	SupportedStages []policy.Stage `json:"supported_stages"`
	SupportedModes  []policy.Mode  `json:"supported_modes"`
	DefaultMode     policy.Mode    `json:"default_mode"`
	SettingsSchema  SettingsSchema `json:"settings_schema"`
}

type CatalogGroup struct {
	Type  string         `json:"type"`
	Items []CatalogEntry `json:"items"`
}

type CatalogService interface {
	Catalog() Catalog
}

type ExecInput struct {
	Stage    policy.Stage
	Mode     policy.Mode
	Config   policy.PluginConfig
	Scope    RuntimeScope
	Request  *infracontext.RequestContext
	Response *infracontext.ResponseContext
	// Event is the per-invocation metrics sink. It is nil when plugin traces
	// are disabled, so plugins must nil-check before using it.
	Event *metrics.EventContext
}

type Executor interface {
	RunStage(ctx context.Context, in StageInput) (*StageOutcome, error)
}

type Field struct {
	Key         string    `json:"key"`
	Label       string    `json:"label"`
	Type        FieldType `json:"type"`
	Description string    `json:"description,omitempty"`
	Required    bool      `json:"required,omitempty"`
	Default     any       `json:"default,omitempty"`
	Enum        []string  `json:"enum,omitempty"`
	// Fields lists the child fields of an object.
	Fields []Field `json:"fields,omitempty"`
	// Item describes the element schema of an array.
	Item *Field `json:"item,omitempty"`
	// KeyOptions lists the well-known keys of a map. Empty means free-form keys.
	KeyOptions []string `json:"key_options,omitempty"`
	// Value describes the value schema of a map.
	Value *Field `json:"value,omitempty"`
}

type FieldType string

type Plugin interface {
	Name() string
	// MandatoryStages are the stages the plugin always runs on, regardless of
	// the policy configuration. They must be a subset of SupportedStages.
	MandatoryStages() []policy.Stage
	// SupportedStages are every stage the plugin can run on. A policy may opt
	// into any subset of these; mandatory stages are always included.
	SupportedStages() []policy.Stage
	SupportedModes() []policy.Mode
	ValidateConfig(settings map[string]any) error
	Execute(ctx context.Context, in ExecInput) (*Result, error)
	MutatesRequestBody() bool
	MutatesResponseBody() bool
	MutatesMetadata() bool
}

type PluginError struct {
	StatusCode int
	Type       string
	Message    string
	Headers    map[string][]string
	Body       []byte
}

type Registry interface {
	Register(p Plugin) error
	Get(name string) (Plugin, bool)
	Validate(name string, settings map[string]any) error
	ValidateStages(name string, selected []policy.Stage) error
	Names() []string
}

type Result struct {
	StatusCode   int
	Body         []byte
	RequestBody  []byte
	Headers      map[string][]string
	StopUpstream bool
}

type RuntimeScope struct {
	GatewayID  string
	ConsumerID string
	Global     bool
}

type SettingsSchema struct {
	Fields []Field `json:"fields"`
}

type StageInput struct {
	Stage    policy.Stage
	Policies []*policy.Policy
	Plan     *StagePlan
	Request  *infracontext.RequestContext
	Response *infracontext.ResponseContext
}

type StageOutcome struct {
	ShortCircuit bool
	StatusCode   int
	Body         []byte
	Headers      map[string][]string
}

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