core

type Declaration struct {
	Name    string
	Version string
	Scope   Scope
	// Direct reports whether the manifest declares the package as a direct
	// dependency rather than a generated or transitive requirement.
	Direct bool
	// PURL identifies the declared package without a version. Parsers may set
	// it when a file can contain references from more than one ecosystem.
	PURL string
	// Ecosystem is the declaration's ecosystem name, in the same form as
	// ParseResult.Ecosystem. A parser sets it when the package belongs to a
	// different ecosystem than the file. Parse fills in the file's ecosystem
	// otherwise and leaves it empty when NoPURL is set.
	Ecosystem string
	// NoPURL marks a source-only entry whose package identity is unknown.
	// Parse leaves its PURL empty.
	NoPURL   bool
	Location string
	Source   Source
}

type Dependency struct {
	Name    string
	Version string
	Scope   Scope
	// Integrity is an opaque verification value derived from the manifest or
	// lockfile. Its digest encoding is ecosystem-specific.
	Integrity string
	Direct    bool
	// PURL identifies the package. Parse preserves a parser-supplied value and
	// otherwise builds it from Ecosystem, Name and, for lockfiles and
	// supplements, Version.
	PURL string
	// Ecosystem is the dependency's ecosystem name, in the same form as
	// ParseResult.Ecosystem. A parser sets it when the package belongs to a
	// different ecosystem than the file, such as an npm package imported from
	// deno.json. Parse fills in the file's ecosystem otherwise and leaves it
	// empty when NoPURL is set.
	Ecosystem string
	// NoPURL marks a source-only entry, such as a direct download URL, whose
	// package identity is unknown. Parse leaves its PURL empty.
	NoPURL      bool
	RegistryURL string
	// Source is set only when this dependency has an explicit source override.
	// It is intentionally separate from RegistryURL because paths and Git
	// repositories are not package registries.
	Source Source
}

type FSRootParser interface {
	ParseInRoot(filename string, content []byte, fsRoot string) (*Result, error)
}

type Kind string

type Match struct {
	Ecosystem string
	Kind      Kind
}

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

type ParseError struct {
	Filename string
	Err      error
}

type Parser interface {
	Parse(filename string, content []byte) (*Result, error)
}

type Registration struct {
	Ecosystem string
	Kind      Kind
	Parser    Parser
	Match     func(filename string) bool
}

type Result struct {
	// Name is the package's own name as declared in the manifest, when
	// the format has one. Empty for lockfiles and for manifest formats
	// that only list dependencies (Gemfile, requirements.txt, etc.).
	Name string
	// Version is the package's own version as declared in the manifest.
	Version string
	// Licenses holds the package's declared license values, without
	// normalization.
	Licenses []string
	// LicenseFile is a manifest-relative path to a declared license file.
	LicenseFile string
	// Digest is a file-level verification value whose meaning is defined by
	// the manifest format. It does not apply to individual dependencies.
	Digest       string
	Dependencies []Dependency
	Declarations []Declaration
	// Sources preserves manifest-level source declarations in source order.
	// These entries are configuration, not evidence that any dependency was
	// resolved from a particular source.
	Sources []Source
	// Scripts maps declared hook or task names to ordered commands or script paths.
	Scripts map[string][]string
}

type Scope string

type Source struct {
	Kind   SourceKind
	Value  string
	Branch string
	Tag    string
	Ref    string
	Rel    string
}

type SourceKind string