scanpipeline

type Enricher struct {
	Client   *scanoss.Client
	Services []scanoss.Service
	Reporter scanoss.DecorationReporter
}

type Options struct {
	Client *scanoss.Client // required

	// Services are the decoration services to gather over the components. The caller resolves
	// these — from a flag, a config file, or nothing at all — and hands over the result: this
	// package knows services, not whatever vocabulary produced them.
	Services []scanoss.Service

	// SourceDeclared asks for declared dependencies to be sourced from the dependency manifests in
	// the same tree, and merged into the inventory alongside the scan's detected components. It is
	// not a decoration service: nothing is fetched, the manifests already carry resolved PURLs.
	SourceDeclared bool

	SourcePath string // file or directory to scan (required)
	Threads    int    // fingerprint workers (<1 => 1)
	// ScanFilters collects the files to fingerprint; DependencyFilters collects the
	// manifests, when SourceDeclared asks for them.
	//
	// Both are the caller's to build, because only the caller knows which of the values
	// in them came from a user flag and which from a profile. This package used to
	// derive the second from the first by copying selected fields, which meant a field
	// the dependency profile had deliberately set was overwritten by the scan's.
	ScanFilters       filter.Options
	DependencyFilters filter.Options
	ScanOptions       []scanoss.ScanOption // per-scan tuning (chunk size, poll interval, BOM, ...)

	// WFPWriter, when set, receives the WFP as it is generated, block by block. It is how a
	// caller keeps the WFP: pass a file to save it, a bytes.Buffer to hold it in memory. Nil
	// discards it after upload, which costs nothing. Block order is completion order.
	WFPWriter io.Writer

	// OnProgress receives every layer's progress. Optional; nil reports nothing. The pipeline runs
	// layers concurrently, so it must be safe for concurrent use.
	OnProgress func(Progress)
}

type Progress struct {
	Layer  string // which layer is reporting; see the Layer* constants
	Status Status // where that layer is
	Done   int    // units done, only ever growing
	Total  int    // units in total; 0 when the layer cannot say
}

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

type Result struct {
	Inventory sbom.Inventory

	// ProcessErrors are the files that could not be fingerprinted, as pkg/wfp reported them.
	// A scan of 3000 files that skipped 3 unreadable ones still produced a usable WFP, so these
	// are not fatal — but which file failed and why is the caller's to judge, and a count alone
	// cannot answer it. Empty when every file was fingerprinted.
	ProcessErrors []error

	// EnrichError reports that the requested layers did not all come back. The pipeline stays
	// non-fatal — a service that fails does not discard a scan — so this is how a caller tells an
	// inventory with no licences because the project declares none from one with no licences
	// because every request failed. Nil when everything asked for arrived.
	EnrichError error
}

type Status string