@intentius/chant-lexicon-grafana 0.97.0 → 0.99.0

package/src/schema/canvas.gen.ts

@@ -0,0 +1,176 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/canvas.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export type HorizontalConstraint = "left" | "right" | "leftright" | "center" | "scale";
+
+export type VerticalConstraint = "top" | "bottom" | "topbottom" | "center" | "scale";
+
+export interface Constraint {
+  horizontal?: HorizontalConstraint;
+  vertical?: VerticalConstraint;
+}
+
+export interface Placement {
+  top?: number;
+  left?: number;
+  right?: number;
+  bottom?: number;
+  width?: number;
+  height?: number;
+  rotation?: number;
+}
+
+export type BackgroundImageSize = "original" | "contain" | "cover" | "fill" | "tile";
+
+export interface BackgroundConfig {
+  color?: ColorDimensionConfig;
+  image?: ResourceDimensionConfig;
+  size?: BackgroundImageSize;
+}
+
+export interface LineConfig {
+  color?: ColorDimensionConfig;
+  width?: number;
+  radius?: number;
+}
+
+export type HttpRequestMethod = "GET" | "POST" | "PUT";
+
+export interface ConnectionCoordinates {
+  x: number;
+  y: number;
+}
+
+export type ConnectionPath = "straight";
+
+export interface CanvasConnection {
+  source: ConnectionCoordinates;
+  target: ConnectionCoordinates;
+  targetName?: string;
+  path: ConnectionPath;
+  color?: ColorDimensionConfig;
+  size?: ScaleDimensionConfig;
+  vertices?: ConnectionCoordinates[];
+  sourceOriginal?: ConnectionCoordinates;
+  targetOriginal?: ConnectionCoordinates;
+  direction?: DirectionDimensionConfig;
+}
+
+export interface CanvasElementOptions {
+  name: string;
+  type: string;
+  /**
+   * TODO: figure out how to define this (element config(s))
+   */
+  config?: Record<string, unknown>;
+  constraint?: Constraint;
+  placement?: Placement;
+  background?: BackgroundConfig;
+  border?: LineConfig;
+  connections?: CanvasConnection[];
+}
+
+export interface Options {
+  /**
+   * Enable inline editing
+   */
+  inlineEditing: boolean;
+  /**
+   * Show all available element types
+   */
+  showAdvancedTypes: boolean;
+  /**
+   * Enable pan and zoom
+   */
+  panZoom: boolean;
+  /**
+   * Enable infinite pan
+   */
+  infinitePan: boolean;
+  /**
+   * The root element of canvas (frame), where all canvas elements are nested
+   * TODO: Figure out how to define a default value for this
+   */
+  root: {
+    /**
+     * Name of the root element
+     */
+    name: string;
+    /**
+     * Type of root element (frame)
+     */
+    type: "frame";
+    /**
+     * The list of canvas elements attached to the root element
+     */
+    elements: CanvasElementOptions[];
+    constraint?: Constraint;
+    placement?: Placement;
+    background?: BackgroundConfig;
+    border?: LineConfig;
+  };
+  /**
+   * Controls tooltip options
+   */
+  tooltip?: CanvasTooltip;
+  /**
+   * Zoom to content
+   */
+  zoomToContent?: boolean;
+}
+
+export interface ColorDimensionConfig {
+  /**
+   * color value
+   */
+  fixed?: string;
+  /**
+   * fixed: T -- will be added by each element
+   */
+  field?: string;
+}
+
+/**
+ * Links to a resource (image/svg path)
+ */
+export interface ResourceDimensionConfig {
+  mode: ResourceDimensionMode;
+  /**
+   * fixed: T -- will be added by each element
+   */
+  field?: string;
+  fixed?: string;
+}
+
+export interface ScaleDimensionConfig {
+  min: number;
+  max: number;
+  fixed?: number;
+  /**
+   * fixed: T -- will be added by each element
+   */
+  field?: string;
+  /**
+   * | *"linear"
+   */
+  mode?: ScaleDimensionMode;
+}
+
+export type ResourceDimensionMode = "fixed" | "field" | "mapping";
+
+export type ScaleDimensionMode = "linear" | "quad";
+
+export type TooltipDisplayMode = "single" | "multi" | "none";
+
+export interface CanvasTooltip {
+  mode: TooltipDisplayMode;
+  disableForOneClick?: boolean;
+}
+
+export interface DirectionDimensionConfig {
+  field?: string;
+  mode: "fixed" | "field";
+  fixed?: "forward" | "reverse" | "both" | "none";
+}

package/src/schema/dashboard.gen.ts

@@ -1,5 +1,6 @@
 // Code generated by chant generate from the vendored Grafana schema
-// src/spec/schemas/dashboard.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+// src/spec/schemas/dashboard.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
 /* eslint-disable */
 
 export interface AnnotationActions {
@@ -74,9 +75,9 @@ export interface Dashboard {
    */
   revision?: number;
   /**
-   * ID of a dashboard imported from the https://grafana.com/grafana/dashboards/ portal
+   * ID of a dashboard imported from the https://grafana.com/grafana/dashboards/ portal. A string in Grafana 12.4, an integer in 13.x; grafana.com downloads carry null.
    */
-  gnetId?: string;
+  gnetId?: string | number | null;
   /**
    * Tags associated with dashboard.
    */
@@ -140,7 +141,7 @@ export interface Dashboard {
   /**
    * Configured template variables
    */
-  templating: {
+  templating?: {
     /**
      * List of configured template variables with their saved values along with some other metadata
      */
@@ -152,7 +153,7 @@ export interface Dashboard {
    * Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.
    * See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/
    */
-  annotations: AnnotationContainer;
+  annotations?: AnnotationContainer;
   /**
    * Links with references to other dashboards or external websites.
    */
@@ -165,6 +166,18 @@ export interface Dashboard {
    * When set to true, the dashboard will load all panels in the dashboard when it's loaded.
    */
   preload?: boolean;
+  /**
+   * Inputs the importer asks for (datasources, constants). Written by "Export for sharing externally".
+   */
+  __inputs?: ExportInput[];
+  /**
+   * Plugins and the Grafana version the export needs. Written by "Export for sharing externally".
+   */
+  __requires?: ExportRequirement[];
+  /**
+   * Library panels the export embeds, keyed by uid. Written by "Export for sharing externally".
+   */
+  __elements?: Record<string, LibraryElementExport>;
 }
 
 /**
@@ -213,7 +226,7 @@ export interface Panel {
   /**
    * The panel plugin type id. This is used to find the plugin to display the panel.
    */
-  type: string;
+  type?: string;
   /**
    * Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.
    */
@@ -249,7 +262,7 @@ export interface Panel {
   /**
    * Panel links.
    */
-  links?: DashboardLink[];
+  links?: PanelLink[];
   /**
    * Name of template variable to repeat for.
    */
@@ -398,7 +411,7 @@ export interface DashboardLink {
   /**
    * If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards
    */
-  asDropdown: boolean;
+  asDropdown?: boolean;
   /**
    * Placement can be used to display the link somewhere else on the dashboard other than above the visualisations.
    */
@@ -406,15 +419,19 @@ export interface DashboardLink {
   /**
    * If true, the link will be opened in a new tab
    */
-  targetBlank: boolean;
+  targetBlank?: boolean;
   /**
    * If true, includes current template variables values in the link as query params
    */
-  includeVars: boolean;
+  includeVars?: boolean;
   /**
    * If true, includes current time range in the link as query params
    */
-  keepTime: boolean;
+  keepTime?: boolean;
+  /**
+   * The source that registered the link (if any)
+   */
+  origin?: ControlSourceRef;
 }
 
 /**
@@ -455,7 +472,7 @@ export interface DataTransformerConfig {
    * Options to be passed to the transformer
    * Valid options depend on the transformer id
    */
-  options: Record<string, unknown>;
+  options: unknown;
 }
 
 /**
@@ -468,9 +485,13 @@ export interface MatcherConfig {
    */
   id: string;
   /**
-   * The matcher options. This is specific to the matcher implementation.
+   * The matcher options. This is specific to the matcher implementation: a field name for byName, a pattern for byRegexp, an object for byNames or byValue.
    */
-  options?: Record<string, unknown>;
+  options?: unknown;
+  /**
+   * If set, limits this matcher to fields of that type. If not set, "series" mode is used.
+   */
+  scope?: MatcherScope;
 }
 
 /**
@@ -587,7 +608,7 @@ export interface FieldConfig {
   /**
    * The behavior when clicking on a result
    */
-  links?: DashboardLink[];
+  links?: DataLink[];
   /**
    * Define interactive HTTP requests that can be triggered from data visualizations.
    */
@@ -750,11 +771,15 @@ export interface Threshold {
    * Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.
    * Nulls currently appear here when serializing -Infinity to JSON.
    */
-  value: number | null;
+  value?: number | null;
   /**
    * Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.
    */
   color: string;
+  /**
+   * Optional dashboard-variable expression (e.g. `$myVar`) resolved at render time; `value` is the numeric fallback when the expression cannot be resolved to a single finite number.
+   */
+  valueExpr?: string;
 }
 
 /**
@@ -795,7 +820,7 @@ export interface FieldColor {
  * `shades`: Shades of a single color. Specify a single color, useful in an override rule.
  * `fixed`: Fixed color mode. Specify a single color, useful in an override rule.
  */
-export type FieldColorModeId = "thresholds" | "palette-classic" | "palette-classic-by-name" | "continuous-GrYlRd" | "continuous-RdYlGr" | "continuous-BlYlRd" | "continuous-YlRd" | "continuous-BlPu" | "continuous-YlBl" | "continuous-blues" | "continuous-reds" | "continuous-greens" | "continuous-purples" | "fixed" | "shades";
+export type FieldColorModeId = "thresholds" | "palette-classic" | "palette-classic-by-name" | "continuous-viridis" | "continuous-magma" | "continuous-plasma" | "continuous-inferno" | "continuous-cividis" | "continuous-GrYlRd" | "continuous-RdYlGr" | "continuous-BlYlRd" | "continuous-YlRd" | "continuous-BlPu" | "continuous-YlBl" | "continuous-blues" | "continuous-reds" | "continuous-greens" | "continuous-purples" | "fixed" | "shades";
 
 /**
  * Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.
@@ -871,7 +896,7 @@ export type ActionVariableType = "string";
 
 export interface DynamicConfigValue {
   id: string;
-  value?: Record<string, unknown>;
+  value?: unknown;
 }
 
 /**
@@ -941,17 +966,17 @@ export interface VariableModel {
    */
   description?: string;
   /**
-   * Query used to fetch values for a variable
+   * Query used to fetch values for a variable: a string, or the datasource's own query object (Prometheus writes { query, qryType, refId }).
    */
-  query?: string | Record<string, Record<string, unknown>>;
+  query?: string | Record<string, unknown>;
   /**
    * Data source used to fetch values for a variable. It can be defined but `null`.
    */
   datasource?: DataSourceRef;
   /**
-   * Shows current selected variable text/value on the dashboard
+   * Shows current selected variable text/value on the dashboard. `{}` before the variable has been resolved.
    */
-  current?: VariableOption;
+  current?: VariableOption | Record<string, never>;
   /**
    * Whether multiple values can be selected or not from variable value list
    */
@@ -1007,6 +1032,34 @@ export interface VariableModel {
    */
   auto_count?: number;
   definition?: string;
+  /**
+   * Whether the group-by operator is enabled in the ad hoc filter combobox.
+   */
+  enableGroupBy?: boolean;
+  /**
+   * Whether a custom variable defines its values as CSV or JSON.
+   */
+  valuesFormat?: "csv" | "json";
+  /**
+   * Whether regex applies to the variable value or its display text.
+   */
+  regexApplyTo?: "value" | "text";
+  /**
+   * Ad hoc variable: the filters currently applied.
+   */
+  filters?: AdHocFilter[];
+  /**
+   * Ad hoc variable: filters always applied to the key lookup, not shown in the UI.
+   */
+  baseFilters?: AdHocFilter[];
+  /**
+   * Ad hoc variable: static keys that override the datasource's.
+   */
+  defaultKeys?: Record<string, unknown>[];
+  /**
+   * Group-by variable: the default selection.
+   */
+  defaultValue?: VariableOption;
 }
 
 /**
@@ -1045,6 +1098,10 @@ export interface VariableOption {
    * Value of the option
    */
   value: string | string[];
+  /**
+   * Additional properties for multi-props variables
+   */
+  properties?: Record<string, string>;
 }
 
 /**
@@ -1154,6 +1211,7 @@ export interface AnnotationQuery {
    * Mappings define how to convert data frame fields to annotation event fields.
    */
   mappings?: Record<string, AnnotationEventFieldMapping>;
+  [key: string]: unknown;
 }
 
 export interface AnnotationPanelFilter {
@@ -1285,5 +1343,131 @@ export interface AnnotationEventFieldMapping {
   regex?: string;
 }
 
+/**
+ * One entry of an export's `__inputs`.
+ */
+export interface ExportInput {
+  /**
+   * Placeholder name, used as `${name}` in the dashboard.
+   */
+  name: string;
+  label?: string;
+  description?: string;
+  /**
+   * `datasource` or `constant`.
+   */
+  type: string;
+  pluginId?: string;
+  pluginName?: string;
+  /**
+   * The value a constant input carries.
+   */
+  value?: unknown;
+  [key: string]: unknown;
+}
+
+/**
+ * One entry of an export's `__requires`.
+ */
+export interface ExportRequirement {
+  /**
+   * `grafana`, `panel` or `datasource`.
+   */
+  type: string;
+  id: string;
+  name?: string;
+  version?: string;
+  [key: string]: unknown;
+}
+
+/**
+ * One library panel embedded in an export's `__elements`.
+ */
+export interface LibraryElementExport {
+  uid: string;
+  name: string;
+  kind?: number;
+  /**
+   * The library panel's own panel JSON. GRAF107 checks it as a panel (src/schema-validate.ts), not here.
+   */
+  model: Record<string, unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * A panel link: the fields Grafana's panel link editor writes, plus DashboardLink's.
+ */
+export interface PanelLink {
+  /**
+   * Title to display with the link
+   */
+  title: string;
+  /**
+   * Link URL. Supports variables, e.g. ${__url_time_range}.
+   */
+  url?: string;
+  /**
+   * If true, the link will be opened in a new tab
+   */
+  targetBlank?: boolean;
+  type?: DashboardLinkType;
+  icon?: string;
+  tooltip?: string;
+  tags?: string[];
+  asDropdown?: boolean;
+  includeVars?: boolean;
+  keepTime?: boolean;
+  placement?: DashboardLinkPlacement;
+  oneClick?: boolean;
+}
+
+/**
+ * A data link on a field. Open: the CUE leaves these items unconstrained.
+ */
+export interface DataLink {
+  title?: string;
+  /**
+   * Link URL. Supports data variables, e.g. ${__field.labels.pod}.
+   */
+  url?: string;
+  targetBlank?: boolean;
+  oneClick?: boolean;
+  /**
+   * A query in another datasource (Explore link).
+   */
+  internal?: Record<string, unknown>;
+  origin?: unknown;
+  [key: string]: unknown;
+}
+
+export interface ControlSourceRef {
+  type: "datasource";
+  /**
+   * The plugin type-id
+   */
+  group: string;
+}
+
+export type MatcherScope = "series" | "nested" | "annotation" | "exemplar";
+
+/**
+ * One ad hoc filter.
+ */
+export interface AdHocFilter {
+  key: string;
+  /**
+   * =, !=, =~, !~, <, >, =| or !=|
+   */
+  operator: string;
+  value?: string;
+  values?: string[];
+  origin?: string;
+  /**
+   * @deprecated
+   */
+  condition?: string;
+  [key: string]: unknown;
+}
+
 /** The dashboard `schemaVersion` the pinned schema defaults to, and the one chant emits. */
 export const DASHBOARD_SCHEMA_VERSION = 42;