sdk

type IResourcePluginOpts[CT, DT, IT any] interface {
	HasDiscovery() (bool, error)
	GetClientFactory() factories.ResourceClientFactory[CT]
	GetResourcers() map[types.ResourceMeta]types.Resourcer[CT]
	GetDynamicResourcers() map[string]types.DynamicResourcer[CT]
	HasDynamicResourcers() bool
	GetResourceGroups() []types.ResourceGroup
	GetDiscoveryClientFactory() factories.ResourceDiscoveryClientFactory[DT]
	GetDiscoveryFunc() func(*pkgtypes.PluginContext, *DT) ([]types.ResourceMeta, error)
	HasInformer() bool
	GetInformerOpts() *types.InformerOptions[CT, IT]
	GetLayoutOpts() *types.LayoutOpts
	GetLoadConnectionFunc() func(*pkgtypes.PluginContext) ([]pkgtypes.Connection, error)
	GetLoadConnectionNamespacesFunc() func(*pkgtypes.PluginContext, *CT) ([]string, error)
	GetCheckConnectionFunc() func(*pkgtypes.PluginContext, *pkgtypes.Connection, *CT) (pkgtypes.ConnectionStatus, error)
	GetResourceDefinitions() map[string]types.ResourceDefinition
	GetDefaultResourceDefinition() types.ResourceDefinition
}

type Plugin struct {
	// settingsProvider is the settings provider for the plugin.
	SettingsProvider pkgsettings.Provider

	Logger    *zap.SugaredLogger
	HCLLogger hclog.Logger
	// contains filtered or unexported fields
}

type PluginOpts struct {
	// ID is the unique identifier for the plugin
	ID string

	// Settings is a list of settings to be used by the plugin
	Settings []pkgsettings.Setting

	// Debug is the debug mode for the plugin
	Debug bool
}

type ResourcePluginOpts[ClientT, DiscoveryClientT, InformerT any] struct {
	// LoadConnectionFunc is a function that will be called to load the possible connections
	// for the resource plugin. This should be used to load the possible connections available based on either
	// settings within the ide (by pulling it off of the plugin context) or by using system defaults.
	//
	// TODO - move this and the client factory to the parent plugin opts so that multiple capabilities can
	// use the same client and connection loaders
	LoadConnectionFunc           func(*pkgtypes.PluginContext) ([]pkgtypes.Connection, error)
	LoadConnectionNamespacesFunc func(*pkgtypes.PluginContext, *ClientT) ([]string, error)
	CheckConnectionFunc          func(*pkgtypes.PluginContext, *pkgtypes.Connection, *ClientT) (pkgtypes.ConnectionStatus, error)

	// ClientFactory is the factory for creating a new resource client to interact with a backend.
	//
	// TODO - move this and the load connection func to the parent plugin opts so that multiple capabilities can
	// use the same client
	ClientFactory factories.ResourceClientFactory[ClientT]

	// DiscoveryClientFactory is the factory for creating a new discovery client to interact with a backend.
	DiscoveryClientFactory factories.ResourceDiscoveryClientFactory[DiscoveryClientT]

	// DiscoveryFunc is the function that will be called to discover resources.
	DiscoveryFunc func(*pkgtypes.PluginContext, *DiscoveryClientT) ([]types.ResourceMeta, error)

	// Resourcers is a map of resource metadata to resourcers that the plugin will manage.
	Resourcers map[types.ResourceMeta]types.Resourcer[ClientT]

	// DynamicResourcers is a map of dynamic resourcers to use as fallbacks when a registered resourcer is not available.
	// Wilcard patterns are supported in the dynamic resourcer key.
	DynamicResourcers map[string]types.DynamicResourcer[ClientT]

	// ResourceGroups is an optional array of resource groups to provide more details about the groups that
	// contain the resources. Is is highly recommended to provide this information to enrich the UI.
	ResourceGroups []types.ResourceGroup

	// ResourceDefinitions is a map of resource names to their definitions, which includes various
	// metadata about how to display the resources in the UI.
	ResourceDefinitions map[string]types.ResourceDefinition

	// DefaultResourceDefinition is the default resource definition to use for resources that do not have
	// a specific definition.
	DefaultResourceDefinition types.ResourceDefinition

	// InformerOpts allows for an additional set of custom options for setting up informers on the
	// resource backend.
	InformerOpts *types.InformerOptions[ClientT, InformerT]

	// LayoutOpts allows for customizing the layout within the UI
	LayoutOpts *types.LayoutOpts
}