datastore

type AddHelpPageStatus string

type Command struct {
	Args []string
	Env  []string
	Dir  string
}

type Completion struct {
	Flag    string
	Context FlagContext
}

type FlagContext struct {
	SubCommand []string `json:"sub-command,omitempty"`
	Framework  string   `json:"framework,omitempty"`
}

type HelpPage struct {
	ExecutablePath string
	Completions    []Completion
	CheckSum       string
	Command        Command
}

type Policy string

type Storage interface {
	GetCommandPolicy(args []string) (policy Policy, err error)

	GetAllCompletions() (pages []HelpPage, err error)
	GetCompletions(path string) (completions []Completion, err error)

	AddHelpPage(helpPage *HelpPage, policy Policy) (status AddHelpPageStatus, err error)

	// NB. This command might return null pointers in case some help page is broken.
	ListCommands() (result map[int64]*Command, err error)

	RemoveHelpPage(commandId int64) (path string, err error)

	Close() error
}