Schema: Add schema for library panels (#62169)

pkg/kinds/dashboard/dashboard_types_gen.go

@@ -458,6 +458,12 @@ type HeatmapPanel struct {
 // HeatmapPanelType defines model for HeatmapPanel.Type.
 type HeatmapPanelType string
 
+// LibraryPanelRef defines model for LibraryPanelRef.
+type LibraryPanelRef struct {
+	Name string `json:"name"`
+	Uid  string `json:"uid"`
+}
+
 // LoadingState defines model for LoadingState.
 type LoadingState string
 
@@ -490,7 +496,8 @@ type Panel struct {
 
 	// TODO docs
 	// TODO tighter constraint
-	Interval *string `json:"interval,omitempty"`
+	Interval     *string          `json:"interval,omitempty"`
+	LibraryPanel *LibraryPanelRef `json:"libraryPanel,omitempty"`
 
 	// Panel links.
 	// TODO fill this out - seems there are a couple variants?

pkg/kinds/librarypanel/librarypanel_kind_gen.go

@@ -0,0 +1,113 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     CoreKindJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package librarypanel
+
+import (
+	"github.com/grafana/grafana/pkg/kindsys"
+	"github.com/grafana/thema"
+	"github.com/grafana/thema/vmux"
+)
+
+// rootrel is the relative path from the grafana repository root to the
+// directory containing the .cue files in which this kind is declared. Necessary
+// for runtime errors related to the declaration and/or lineage to provide
+// a real path to the correct .cue file.
+const rootrel string = "kinds/librarypanel"
+
+// TODO standard generated docs
+type Kind struct {
+	lin    thema.ConvergentLineage[*LibraryPanel]
+	jcodec vmux.Codec
+	valmux vmux.ValueMux[*LibraryPanel]
+	decl   kindsys.Decl[kindsys.CoreProperties]
+}
+
+// type guard
+var _ kindsys.Core = &Kind{}
+
+// TODO standard generated docs
+func NewKind(rt *thema.Runtime, opts ...thema.BindOption) (*Kind, error) {
+	decl, err := kindsys.LoadCoreKind(rootrel, rt.Context(), nil)
+	if err != nil {
+		return nil, err
+	}
+	k := &Kind{
+		decl: decl,
+	}
+
+	lin, err := decl.Some().BindKindLineage(rt, opts...)
+	if err != nil {
+		return nil, err
+	}
+
+	// Get the thema.Schema that the meta says is in the current version (which
+	// codegen ensures is always the latest)
+	cursch := thema.SchemaP(lin, k.decl.Properties.CurrentVersion)
+	tsch, err := thema.BindType[*LibraryPanel](cursch, &LibraryPanel{})
+	if err != nil {
+		// Should be unreachable, modulo bugs in the Thema->Go code generator
+		return nil, err
+	}
+
+	k.jcodec = vmux.NewJSONCodec("librarypanel.json")
+	k.lin = tsch.ConvergentLineage()
+	k.valmux = vmux.NewValueMux(k.lin.TypedSchema(), k.jcodec)
+	return k, nil
+}
+
+// TODO standard generated docs
+func (k *Kind) Name() string {
+	return "librarypanel"
+}
+
+// TODO standard generated docs
+func (k *Kind) MachineName() string {
+	return "librarypanel"
+}
+
+// TODO standard generated docs
+func (k *Kind) Lineage() thema.Lineage {
+	return k.lin
+}
+
+// TODO standard generated docs
+func (k *Kind) ConvergentLineage() thema.ConvergentLineage[*LibraryPanel] {
+	return k.lin
+}
+
+// JSONValueMux is a version multiplexer that maps a []byte containing JSON data
+// at any schematized dashboard version to an instance of LibraryPanel.
+//
+// Validation and translation errors emitted from this func will identify the
+// input bytes as "dashboard.json".
+//
+// This is a thin wrapper around Thema's [vmux.ValueMux].
+func (k *Kind) JSONValueMux(b []byte) (*LibraryPanel, thema.TranslationLacunas, error) {
+	return k.valmux(b)
+}
+
+// TODO standard generated docs
+func (k *Kind) Maturity() kindsys.Maturity {
+	return k.decl.Properties.Maturity
+}
+
+// Decl returns the [kindsys.Decl] containing both CUE and Go representations of the
+// librarypanel declaration in .cue files.
+func (k *Kind) Decl() kindsys.Decl[kindsys.CoreProperties] {
+	return k.decl
+}
+
+// Props returns a [kindsys.SomeKindProps], with underlying type [kindsys.CoreProperties],
+// representing the static properties declared in the librarypanel kind.
+//
+// This method is identical to calling Decl().Props. It is provided to satisfy [kindsys.Interface].
+func (k *Kind) Props() kindsys.SomeKindProperties {
+	return k.decl.Properties
+}

pkg/kinds/librarypanel/librarypanel_types_gen.go

@@ -0,0 +1,58 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     kinds/gen.go
+// Using jennies:
+//     GoTypesJenny
+//     LatestJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package librarypanel
+
+// LibraryElementDTOMeta defines model for LibraryElementDTOMeta.
+type LibraryElementDTOMeta struct {
+	ConnectedDashboards int64                     `json:"connectedDashboards"`
+	Created             string                    `json:"created"`
+	CreatedBy           LibraryElementDTOMetaUser `json:"createdBy"`
+	FolderName          string                    `json:"folderName"`
+	FolderUid           string                    `json:"folderUid"`
+	Updated             string                    `json:"updated"`
+	UpdatedBy           LibraryElementDTOMetaUser `json:"updatedBy"`
+}
+
+// LibraryElementDTOMetaUser defines model for LibraryElementDTOMetaUser.
+type LibraryElementDTOMetaUser struct {
+	AvatarUrl string `json:"avatarUrl"`
+	Id        int64  `json:"id"`
+	Name      string `json:"name"`
+}
+
+// LibraryPanel defines model for LibraryPanel.
+type LibraryPanel struct {
+	// Panel description
+	Description *string `json:"description,omitempty"`
+
+	// Folder UID
+	FolderUid *string                `json:"folderUid,omitempty"`
+	Meta      *LibraryElementDTOMeta `json:"meta,omitempty"`
+
+	// TODO: should be the same panel schema defined in dashboard
+	// Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
+	Model map[string]interface{} `json:"model"`
+
+	// Panel name (also saved in the model)
+	Name string `json:"name"`
+
+	// Dashboard version when this was saved (zero if unknown)
+	SchemaVersion *int `json:"schemaVersion,omitempty"`
+
+	// The panel type (from inside the model)
+	Type string `json:"type"`
+
+	// Library element UID
+	Uid string `json:"uid"`
+
+	// panel version, incremented each time the dashboard is updated.
+	Version int64 `json:"version"`
+}