plugininventory

type PluginGroup struct {
	// Vendor of the group
	Vendor string
	// Publisher of the group
	Publisher string
	// Name of the group
	Name string
	// Description of the group
	Description string
	// Hidden tells whether the plugin-group should be ignored by the CLI.
	Hidden bool
	// Recommended version that the Tanzu CLI should install by default.
	// The value should be a valid semantic version as defined in
	// https://semver.org/. E.g., 2.0.1
	RecommendedVersion string
	// Map of version to list of plugins
	Versions map[string][]*PluginGroupPluginEntry
}

type PluginGroupFilter struct {
	// Vendor of the group to look for
	Vendor string
	// Publisher of the group to look for
	Publisher string
	// Name of the group to look for
	Name string
	// Version of the group
	Version string
	// IncludeHidden indicates if hidden plugin groups should be included
	IncludeHidden bool
}

type PluginGroupIdentifier struct {
	// Vendor of the group
	Vendor string
	// Publisher of the group
	Publisher string
	// Name of the group
	Name string
	// Version of the group
	Version string
}

type PluginGroupPluginEntry struct {
	// The plugin version of this plugin entry
	PluginIdentifier

	// Mandatory specifies if the plugin is required to be installed or not
	Mandatory bool
}

type PluginGroupSorter []*PluginGroup

type PluginIdentifier struct {
	// Name is the name of the plugin
	Name string
	// Target is the target of the plugin
	Target configtypes.Target
	// Version is the version for the plugin
	Version string
}

type PluginInventory interface {
	// GetAllPlugins returns all plugins found in the inventory.
	GetAllPlugins() ([]*PluginInventoryEntry, error)

	// GetPlugins returns the plugins found in the inventory that match the provided filter.
	GetPlugins(*PluginInventoryFilter) ([]*PluginInventoryEntry, error)

	// GetPluginGroups returns the plugin groups found in the inventory that match the provided filter.
	GetPluginGroups(PluginGroupFilter) ([]*PluginGroup, error)

	// CreateSchema creates table schemas to the provided database.
	// returns error if table creation fails for any reason
	CreateSchema() error

	// InsertPlugin inserts plugin to the inventory
	InsertPlugin(*PluginInventoryEntry) error

	// InsertPluginGroup inserts plugin-group to the inventory
	// if override is true, it will update the existing plugin by
	// updating the metadata and the plugin associated with the plugin-group
	InsertPluginGroup(pg *PluginGroup, override bool) error

	// UpdatePluginActivationState updates plugin metadata to activate or deactivate plugin
	UpdatePluginActivationState(*PluginInventoryEntry) error

	// UpdatePluginGroupActivationState updates plugin-group metadata to activate or deactivate the plugin-group
	UpdatePluginGroupActivationState(*PluginGroup) error
}

type PluginInventoryEntry struct {
	// Name of the plugin
	Name string
	// Target to which the plugin applies
	Target configtypes.Target
	// Description of the plugin
	Description string
	// Publisher is the name of the publisher of this plugin
	// (e.g., a product group within a company)
	Publisher string
	// Vendor is the name of the vendor of this plugin (e.g., a company's name)
	Vendor string
	// Recommended version that Tanzu CLI should install by default.
	// The value should be a valid semantic version as defined in
	// https://semver.org/. E.g., 2.0.1
	RecommendedVersion string
	// Hidden tells whether the plugin is marked as hidden or not.
	Hidden bool
	// Artifacts contains an artifact list for every available version.
	Artifacts distribution.Artifacts
}

type PluginInventoryFilter struct {
	// Name of the plugin to look for
	Name string
	// Target to which the plugins apply
	Target configtypes.Target
	// Version for the plugins to look for
	Version string
	// OS of the plugin binary in `GOOS` format.
	OS string
	// Arch of the plugin binary in `GOARCH` format.
	Arch string
	// Publisher of the plugins to look for
	Publisher string
	// Vendor of the plugins to look for
	Vendor string
	// IncludeHidden indicates if hidden plugins should be included
	IncludeHidden bool
}

type PluginInventoryMetadata interface {
	// CreateInventoryMetadataDBSchema creates table schemas for
	// plugin inventory metadata database
	// returns error if table creation fails for any reason
	CreateInventoryMetadataDBSchema() error

	// InsertPluginIdentifier inserts the PluginIdentifier entry to the
	// AvailablePluginBinaries table
	InsertPluginIdentifier(*PluginIdentifier) error

	// InsertPluginGroupIdentifier inserts the PluginGroupIdentifier entry to the
	// AvailablePluginGroups table
	InsertPluginGroupIdentifier(*PluginGroupIdentifier) error

	// MergeInventoryMetadataDatabase merges two inventory metadata database by
	// merging the content of AvailablePluginBinaries and AvailablePluginGroups tables
	MergeInventoryMetadataDatabase(additionalMetadataDBFilePath string) error

	// UpdatePluginInventoryDatabase updates the plugin inventory database based
	// on the plugin inventory metadata database by deleting entries that don't
	// exists in plugin inventory metadata database
	UpdatePluginInventoryDatabase(pluginInventoryDBFilePath string) error
}

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

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