grafana/pkg/kindsys/kindmetas.go

package kindsys

import "github.com/grafana/thema"

// CommonMeta contains the metadata common to all categories of kinds.
type CommonMeta struct {
	Name              string   `json:"name"`
	PluralName        string   `json:"pluralName"`
	MachineName       string   `json:"machineName"`
	PluralMachineName string   `json:"pluralMachineName"`
	LineageIsGroup    bool     `json:"lineageIsGroup"`
	Maturity          Maturity `json:"maturity"`
}

// TODO generate from type.cue
type RawMeta struct {
	CommonMeta
	Extensions []string `json:"extensions"`
}

func (m RawMeta) _private() {}
func (m RawMeta) Common() CommonMeta {
	return m.CommonMeta
}

// TODO
type CoreStructuredMeta struct {
	CommonMeta
	CurrentVersion thema.SyntacticVersion `json:"currentVersion"`
}

func (m CoreStructuredMeta) _private() {}
func (m CoreStructuredMeta) Common() CommonMeta {
	return m.CommonMeta
}

// TODO
type CustomStructuredMeta struct {
	CommonMeta
	CurrentVersion thema.SyntacticVersion `json:"currentVersion"`
}

func (m CustomStructuredMeta) _private() {}
func (m CustomStructuredMeta) Common() CommonMeta {
	return m.CommonMeta
}

// TODO
type ComposableMeta struct {
	CommonMeta
	CurrentVersion thema.SyntacticVersion `json:"currentVersion"`
}

func (m ComposableMeta) _private() {}
func (m ComposableMeta) Common() CommonMeta {
	return m.CommonMeta
}

// SomeKindMeta is an interface type to abstract over the different kind
// metadata struct types: [RawMeta], [CoreStructuredMeta],
// [CustomStructuredMeta].
//
// It is the traditional interface counterpart to the generic type constraint
// KindMetas.
type SomeKindMeta interface {
	_private()
	Common() CommonMeta
}

// KindMetas is a type parameter that comprises the base possible set of
// kind metadata configurations.
type KindMetas interface {
	RawMeta | CoreStructuredMeta | CustomStructuredMeta | ComposableMeta
}