component

type Closer interface {
	// Close can be implemented to gracefully close component dependencies.
	Close(context.Context) error
}

type Enricher interface {
	// Annotate enriches vulnerability findings by some criteria.
	Annotate(ctx context.Context, findings []*finding.VulnerabilityFinding) ([]*finding.VulnerabilityFinding, error)
}

type ErrInvalidRunnerConfig struct {
	FieldName string
	Reason    string
}

type ErrRunnerOption struct {
	OptionName string
	Reason     string
}

type Filter interface {
	// Filter returns filtered findings from the supplied ones applying some criteria.
	// It returns false if no findings have been filtered out.
	Filter(ctx context.Context, findings []*finding.VulnerabilityFinding) ([]*finding.VulnerabilityFinding, bool, error)
}

type PanicHandler interface {
	// HandlePanic handles a panic and returns an optional error with a signal on whether it should be
	// fatal or not.
	HandlePanic(ctx context.Context, err any) (error, bool)
}

type Reader interface {
	// Read reads vulnerability findings from a storage.
	Read(ctx context.Context, instanceID uuid.UUID, queryOpts *store.QueryOpts) ([]*finding.VulnerabilityFinding, error)
}

type Reporter interface {
	// Report reports vulnerability findings on a specified destination.
	// i.e. raises them as tickets on your favourite ticketing system.
	Report(ctx context.Context, findings []*finding.VulnerabilityFinding) error
}

type RunnerConfig struct {
	SDKVersion    string
	ComponentName string
	InstanceID    uuid.UUID

	Logging      RunnerConfigLogging
	PanicHandler PanicHandler

	StoreConfig StoreConfig
}

type RunnerConfigLogging struct {
	Level  sdklogger.RunnerConfigLoggingLevel
	Logger sdklogger.Logger
}

type RunnerConfigOption func(*RunnerConfig) error

type RunnerOption func(r *runner) error

type Scanner interface {
	// Transform transforms the raw scan data into vulnerability finding format.
	Transform(ctx context.Context) ([]*ocsf.VulnerabilityFinding, error)
}

type StoreConfig struct {
	DisableStoreValidation bool
	StoreType              StoreType
	Storer                 Storer
}

type StoreType string

type Storer interface {
	Closer
	Validator
	Reader
	Updater
	Writer
}

type Target interface {
	// Prepare prepares the target to be scanned.
	Prepare(ctx context.Context) error
}

type Updater interface {
	// Update updates existing vulnerability findings.
	Update(ctx context.Context, instanceID uuid.UUID, findings []*finding.VulnerabilityFinding) error
}

type Validator interface {
	// Validate validates the supplied vulnerability finding and returns an error if invalid.
	Validate(finding *ocsf.VulnerabilityFinding) error
}

type Writer interface {
	// Write writes non-existing vulnerability findings.
	Write(ctx context.Context, instanceID uuid.UUID, findings []*ocsf.VulnerabilityFinding) error
}