flowcoverage

type Citation struct {
	Anchors     []doccorpus.Anchor `json:"anchors"`
	IDs         []string           `json:"ids"`
	Unavailable string             `json:"unavailable"`
}

type Citations struct {
	Docs            Citation `json:"docs"`
	Claims          Citation `json:"claims"`
	SourceBranches  Citation `json:"source_branches"`
	LegacyTests     Citation `json:"legacy_tests"`
	DownstreamFlows Citation `json:"downstream_flows"`
}

type Denominator struct {
	Schema     string               `json:"schema"`
	Source     doccorpus.Repository `json:"source"`
	Intents    IntentDirectory      `json:"intents"`
	Inventory  Inventory            `json:"documented_inventory"`
	Flows      []Mapping            `json:"flows"`
	Variations []Variation          `json:"variations"`
}

type Entry struct {
	Locator    appflows.NavLocator `json:"locator"`
	Acceptance doccorpus.Anchor    `json:"acceptance"`
}

type ExactTest struct {
	File       string             `json:"file"`
	FullTitle  string             `json:"full_title"`
	Project    *string            `json:"project"`
	Anchor     doccorpus.Anchor   `json:"anchor"`
	Assertions []doccorpus.Anchor `json:"assertions"`
}

type IntentDirectory struct {
	Directory string `json:"directory"`
	Revision  string `json:"revision"`
}

type Inventory struct {
	Kind string `json:"kind"`
	Ref
}

type Mapping struct {
	DocumentedID  string   `json:"documented_id"`
	IntentFlowIDs []string `json:"intent_flow_ids"`
}

type Observation struct {
	HistoryGroup      string    `json:"history_group"`
	Historical        bool      `json:"historical"`
	BindingGroup      string    `json:"binding_group"`
	Receipt           string    `json:"receipt_sha256"`
	Kind              string    `json:"kind"`
	Test              ExactTest `json:"test"`
	State             string    `json:"state"`
	Attempts          int       `json:"attempts"`
	ConfiguredRetries []int     `json:"configured_retries"`
	Qualified         bool      `json:"qualified"`
	Reasons           []string  `json:"reasons"`
	SourceRevision    string    `json:"source_revision"`
}

type Options struct{ Denominator, Receipts, Revision string }

type Page struct {
	Schema       string   `json:"schema"`
	Revision     string   `json:"revision"`
	ReportSHA256 string   `json:"report_sha256"`
	Passed       bool     `json:"passed"`
	Gaps         int      `json:"gaps"`
	Total        int      `json:"total"`
	Offset       int      `json:"offset"`
	Next         *int     `json:"next_offset"`
	Rows         []Row    `json:"rows"`
	Limitations  []string `json:"limitations"`
}

type Ref struct {
	Path     string `json:"path"`
	Revision string `json:"revision"`
	SHA256   string `json:"sha256"`
}

type Report struct {
	Schema            string   `json:"schema"`
	Revision          string   `json:"revision"`
	DenominatorSHA256 string   `json:"denominator_sha256"`
	RunsSHA256        string   `json:"runs_sha256"`
	Passed            bool     `json:"passed"`
	Gaps              int      `json:"gaps"`
	Rows              []Row    `json:"rows"`
	Limitations       []string `json:"limitations"`
}

type Result struct {
	Report     Report
	Generation *flowdocs.Result
	Documented []string
}

type Row struct {
	DocumentedID         string                 `json:"documented_id"`
	FlowID               string                 `json:"intent_flow_id"`
	VariationID          string                 `json:"variation_id"`
	Status               string                 `json:"status"`
	Actor                string                 `json:"actor"`
	Preconditions        []string               `json:"preconditions"`
	Entry                *appflows.NavLocator   `json:"entry"`
	Actions              []appflows.FlowStep    `json:"actions"`
	Facts                []string               `json:"observable_facts"`
	Outcomes             []appflows.FlowOutcome `json:"outcomes"`
	Citations            Citations              `json:"citations"`
	Tests                []Test                 `json:"tests"`
	Observations         []Observation          `json:"observations"`
	Reasons              []string               `json:"reasons"`
	LastVerifiedRevision string                 `json:"last_verified_revision"`
	Skeleton             *Skeleton              `json:"skeleton,omitempty"`
}

type Run struct {
	Ref
	Kind                string            `json:"kind"`
	SourceRevision      string            `json:"source_revision"`
	TestRevision        string            `json:"test_revision"`
	Paths               map[string]string `json:"paths"`
	PackagePaths        []string          `json:"package_paths"`
	BuildScope          string            `json:"build_scope"`
	ApplicationIdentity string            `json:"application_identity"`
	Environment         map[string]string `json:"environment"`
}

type Runs struct {
	Schema    string `json:"schema"`
	Directory string `json:"directory"`
	Revision  string `json:"revision"`
	Runs      []Run  `json:"runs"`
}

type Skeleton struct {
	Entry       *appflows.NavLocator   `json:"entry"`
	Outcomes    []appflows.FlowOutcome `json:"outcomes"`
	Fixtures    []doccorpus.Anchor     `json:"fixtures"`
	PageObjects []doccorpus.Anchor     `json:"page_objects"`
	Unknown     []string               `json:"unknown"`
}

type Test struct {
	ExactTest
	Mode        string             `json:"mode"`
	Outcomes    []string           `json:"outcomes"`
	Controls    []ExactTest        `json:"controls"`
	Fixtures    []doccorpus.Anchor `json:"fixtures"`
	PageObjects []doccorpus.Anchor `json:"page_objects"`
	Acceptance  doccorpus.Anchor   `json:"acceptance"`
}

type Variation struct {
	FlowID    string    `json:"intent_flow_id"`
	ID        string    `json:"variation_id"`
	Entry     *Entry    `json:"entry,omitempty"`
	Citations Citations `json:"citations"`
	Tests     []Test    `json:"tests"`
	Exclusion *Ref      `json:"exclusion,omitempty"`
}