packaging

type Package interface {
	// PolicyManifest returns the manifest data about the policy
	// in struct format.
	PolicyManifest() *PolicyManifest

	// Return any rego files, with their names as the keys and
	// their content as strings.
	RegoText() map[string]string
}

type PolicyManifest struct {
	Namespace     string    `yaml:"namespace"`
	ID            string    `yaml:"id"`
	DataGatherers []string  `yaml:"data-gatherers,omitempty"`
	RootQuery     string    `yaml:"root-query"`
	Name          string    `yaml:"name"`
	Description   string    `yaml:"description,omitempty"`
	Sections      []Section `yaml:"sections,omitempty"`
}

type Rule struct {
	ID          string   `yaml:"id"`
	Name        string   `yaml:"name"`
	Description string   `yaml:"description,omitempty"`
	Manual      bool     `yaml:"manual,omitempty"`
	Remediation string   `yaml:"remediation,omitempty"`
	Links       []string `yaml:"links,omitempty"`
}

type Section struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Description string `yaml:"description,omitempty"`
	Rules       []Rule `yaml:"rules,omitempty"`
}