code

type QueryRepository interface {
	QuerySignatureMatches(ctx context.Context, filter SignatureMatchFilter) (*SignatureMatchQueryResult, error)
}

type ReaderRepository interface {
	GetDependencyUsageEvidencesByPackageName(context.Context, string) ([]*ent.DepsUsageEvidence, error)
	GetSignatureMatchesByPackageHint(context.Context, string) ([]*ent.CodeSignatureMatch, error)
	GetAllSignatureMatches(context.Context) ([]*ent.CodeSignatureMatch, error)
	GetApplicationSignatureMatches(context.Context) ([]*ent.CodeSignatureMatch, error)
}

type Scanner interface {
	Scan(context.Context) error
}

type ScannerCallbackRegistry struct {
	// On start of scan
	OnScanStart func() error

	// On end of scan
	OnScanEnd func() error

	// OnFileScanned fires for each file processed by the callgraph plugin.
	// It is fire-and-forget and must not block or fail the scan.
	OnFileScanned func(filePath string)

	// OnSignatureMatch fires for each individual signature match found.
	// It is fire-and-forget and must not block or fail the scan.
	OnSignatureMatch func(match *SignatureMatchData)
}

type ScannerConfig struct {
	// First party application code directories
	AppDirectories []string

	// 3rd party imported code directories (e.g. Python virtual env, `node_modules` etc.)
	ImportDirectories []string

	// Regular expressions to exclude files or directories
	// from traversal
	ExcludePatterns []*regexp.Regexp

	// Languages to scan
	Languages []core.Language

	// Define callbacks if required
	Callbacks *ScannerCallbackRegistry

	// Plugin specific configuration
	SkipDependencyUsagePlugin bool

	// Signature matching configuration
	SkipSignatureMatching bool
	SignaturesToMatch     []*callgraphv1.Signature
}

type SignatureMatchData struct {
	SignatureID          string
	SignatureVendor      string
	SignatureProduct     string
	SignatureService     string
	SignatureDescription string
	Tags                 []string
	FilePath             string
	Language             string
	Line                 uint
	Column               uint
	CalleeNamespace      string
	MatchedCall          string
	PackageHint          string // empty = app-level finding
}

type SignatureMatchFilter struct {
	Tags          []string // OR: match has at least one of these tags
	Languages     []string // OR: match language is one of these
	Vendors       []string // OR: match vendor is one of these
	Products      []string // OR: match product is one of these
	Services      []string // OR: match service is one of these
	FileSubstring string   // case-insensitive substring match on file_path
	Limit         int      // max rows to return (0 = unlimited)
}

type SignatureMatchQueryResult struct {
	Matches    []*ent.CodeSignatureMatch
	TotalCount int
}