catalog

type App struct {
	Vendor        string        // must be present and match a client's installation
	Product       string        // must be present and match a client's installation
	Name          string        // for printing; if not given, "<vendor> <product>" will be used
	Active        bool          // if this app is "delivered" or "handled" at all
	Locked        bool          // if updates of this app are "delivered" at all
	AllowRegister bool          // if clients are allowed to register
	UpgradeTarget UpgradeTarget // If empty, the default upgrade target will be used
	Created       time.Time
	Updated       time.Time
	Groups        []string
	DefaultGroups []string // empty means "public" by default
	Variants      []string
}

type Catalog interface {
	RegisterClient(vendor string, product string, variant string) (*ClientState, error)
	ShouldUpgrade(state *ClientState) (Criticality, error)
	// FindNextUpgrade should return nil if no update is available
	FindNextUpgrade(state *ClientState) (*UpgradeStep, error)
	// FindUpgradePath should return nil if no update is available
	FindUpgradePath(state *ClientState) (*UpgradePath, error)
}

type Client struct {
	App     *App
	Variant string
	Uuid    string
	Name    string
	Active  bool
	Locked  bool
	Groups  []string // will be hydrated by DB layer
	Created time.Time
	Updated time.Time
}

type ClientState struct {
	ClientId       string
	Vendor         string
	Product        string
	Variant        string // optional
	OS             string // optional, e.g. for jars
	Arch           string // optional
	CurrentVersion string
	WithUnstable   bool
}

type Criticality int

type Filter struct {
	Vendor         string
	Product        string
	Name           string
	Variant        string
	EnforceVariant bool // if an empty variant will be matched
	OS             string
	Arch           string
	Alias          string
	MinVersion     string // use MinVersion == MaxVersion to hit an exact version
	MaxVersion     string
	AfterVersion   string // like a "MinVersion" but excluding this version
	BeforeVersion  string // like a "MaxVersion" but excluding this version
	WithUnstable   bool
	Groups         []string
}

type Group struct {
	App     *App
	Name    string
	Created time.Time
	Updated time.Time
}

type GroupFilter struct {
	Vendor  string
	Product string
	Name    string
}

type NextSpec struct {
	Steps     int
	Numbering Numbering
}

type Numbering string

type Release struct {
	App           *App
	Variant       string // sth like "Pro" or "Light" (if given it must match a client's installation)
	Description   string
	OS            string // sth like "MacOS", "darwin" or "linux"; if given it must match a client's installation
	Arch          string // sth like "i386 or "ppc64"; if given it must match a client's installation
	Date          time.Time
	Version       string // for use with semantic versioning
	Unstable      bool   // some clients may not want to use unstable versions
	Alias         string // sth like "Focal Fossa"; optional, for printing (and release management) only
	Link          string // Some URL or whatever the installer should be pointed to
	Format        string // The package format might change over time. Use format to handle these generations
	Signature     string // a cryptographical representation (hash etc)
	Tags          []string
	UpgradeTarget UpgradeTarget // If empty, the default upgrade target will be used
	ShouldUpgrade Criticality
	Groups        []string
}

type ReleaseHistory struct {
	App      *App
	Releases []Release
}

type StoreInterface interface {
	// App management
	ListApps(limit int) ([]*App, error)
	StoreApp(app *App, allowUpdate bool) (*App, error)
	FindApp(vendor string, product string) (*App, error)
	SetAppDefaultGroups(app *App) (*App, error)

	// Group management
	ListGroups(filter GroupFilter, limit int) ([]*Group, error)
	StoreGroup(group *Group, allowUpdate bool) (*Group, error)

	// Client management
	RegisterClient(app *App, variant string, groups []string) (*Client, error)

	// Variant management
	ListVariants(filter VariantFilter, limit int) ([]*Variant, error)
	StoreVariant(variant *Variant, allowUpdate bool) (*Variant, error)

	// Release management
	StoreRelease(release *Release, allowUpdate bool) (*Release, error)
	FetchReleases(filter Filter, limit int) ([]*Release, error)
	SetCriticality(filter Filter, criticality Criticality) ([]*Release, error)
	SetStability(filter Filter, stability bool) ([]*Release, error)
	SetUpgradeTarget(filter Filter, target UpgradeTarget) ([]*Release, error)
}

type TargetSpec struct {
	Major      string
	Minor      string
	Patch      string
	PreRelease string
	Build      string
}

type UpgradeInfo struct {
	ShortInfo    string
	Description  string
	Explanation  string
	ReferenceUrl string
}

type UpgradePath struct {
	Info        UpgradeInfo
	Criticality Criticality
	Steps       []UpgradeStep
}

type UpgradeStep struct {
	Info        UpgradeInfo
	Release     Release
	Criticality Criticality
}

type UpgradeTarget string

type Variant struct {
	App           *App
	Name          string
	Active        bool          // if this app variant is "delivered" or "handled" at all
	Locked        bool          // if updates of this app variant are "delivered" at all
	AllowRegister bool          // if clients are allowed to register
	UpgradeTarget UpgradeTarget // If empty, the upgrade target of the app will be used
	Created       time.Time
	Updated       time.Time
	DefaultGroups []string // empty means "default groups of the app" here
}

type VariantFilter struct {
	Vendor  string
	Product string
	Name    string
}

type VersionInfo struct {
	Major      int
	Minor      int
	Patch      int
	Prerelease string
	Build      string
}