@intentius/chant-lexicon-grafana 0.98.0 → 0.100.0

package/src/schema/barchart.gen.ts

@@ -0,0 +1,221 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/barchart.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 Options {
+  /**
+   * Manually select which field from the dataset to represent the x field.
+   */
+  xField?: string;
+  /**
+   * Use the color value for a sibling field to color each bar value.
+   */
+  colorByField?: string;
+  /**
+   * Controls the orientation of the bar chart, either vertical or horizontal.
+   */
+  orientation: VizOrientation;
+  /**
+   * Controls the radius of each bar.
+   */
+  barRadius?: number;
+  /**
+   * Controls the rotation of the x axis labels.
+   */
+  xTickLabelRotation: number;
+  /**
+   * Sets the max length that a label can have before it is truncated.
+   */
+  xTickLabelMaxLength: number;
+  /**
+   * Controls the spacing between x axis labels.
+   * negative values indicate backwards skipping behavior
+   */
+  xTickLabelSpacing?: number;
+  /**
+   * Controls whether bars are stacked or not, either normally or in percent mode.
+   */
+  stacking: StackingMode;
+  /**
+   * This controls whether values are shown on top or to the left of bars.
+   */
+  showValue: VisibilityMode;
+  /**
+   * Controls the width of bars. 1 = Max width, 0 = Min width.
+   */
+  barWidth: number;
+  /**
+   * Controls the width of groups. 1 = max with, 0 = min width.
+   */
+  groupWidth: number;
+  legend: VizLegendOptions;
+  tooltip: VizTooltipOptions;
+  text?: VizTextDisplayOptions;
+  /**
+   * Enables mode which highlights the entire bar area and shows tooltip when cursor
+   * hovers over highlighted area
+   */
+  fullHighlight: boolean;
+}
+
+export interface FieldConfig {
+  /**
+   * Controls line width of the bars.
+   */
+  lineWidth?: number;
+  /**
+   * Controls the fill opacity of the bars.
+   */
+  fillOpacity?: number;
+  /**
+   * Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
+   * Gradient appearance is influenced by the Fill opacity setting.
+   */
+  gradientMode?: GraphGradientMode;
+  axisPlacement?: AxisPlacement;
+  axisColorMode?: AxisColorMode;
+  axisLabel?: string;
+  axisWidth?: number;
+  axisSoftMin?: number;
+  axisSoftMax?: number;
+  axisGridShow?: boolean;
+  scaleDistribution?: ScaleDistributionConfig;
+  axisCenteredZero?: boolean;
+  hideFrom?: HideSeriesConfig;
+  /**
+   * Threshold rendering
+   */
+  thresholdsStyle?: GraphThresholdsStyleConfig;
+  axisBorderShow?: boolean;
+}
+
+/**
+ * TODO docs
+ */
+export type VizOrientation = "auto" | "vertical" | "horizontal";
+
+/**
+ * TODO docs
+ */
+export type StackingMode = "none" | "normal" | "percent";
+
+/**
+ * TODO docs
+ */
+export type VisibilityMode = "auto" | "never" | "always";
+
+/**
+ * TODO docs
+ */
+export interface VizLegendOptions {
+  displayMode: LegendDisplayMode;
+  placement: LegendPlacement;
+  showLegend: boolean;
+  asTable?: boolean;
+  isVisible?: boolean;
+  sortBy?: string;
+  sortDesc?: boolean;
+  width?: number;
+  calcs: string[];
+}
+
+/**
+ * TODO docs
+ */
+export interface VizTooltipOptions {
+  mode: TooltipDisplayMode;
+  sort: SortOrder;
+  maxWidth?: number;
+  maxHeight?: number;
+  hideZeros?: boolean;
+}
+
+/**
+ * TODO docs
+ */
+export interface VizTextDisplayOptions {
+  /**
+   * Explicit title text size
+   */
+  titleSize?: number;
+  /**
+   * Explicit value text size
+   */
+  valueSize?: number;
+  /**
+   * Explicit percent text size
+   */
+  percentSize?: number;
+}
+
+/**
+ * TODO docs
+ */
+export type GraphGradientMode = "none" | "opacity" | "hue" | "scheme";
+
+/**
+ * TODO docs
+ */
+export type AxisPlacement = "auto" | "top" | "right" | "bottom" | "left" | "hidden";
+
+/**
+ * TODO docs
+ */
+export type AxisColorMode = "text" | "series";
+
+/**
+ * TODO docs
+ */
+export interface ScaleDistributionConfig {
+  type: ScaleDistribution;
+  log?: number;
+  linearThreshold?: number;
+}
+
+/**
+ * TODO docs
+ */
+export interface HideSeriesConfig {
+  tooltip: boolean;
+  legend: boolean;
+  viz: boolean;
+}
+
+/**
+ * TODO docs
+ */
+export interface GraphThresholdsStyleConfig {
+  mode: GraphThresholdsStyleMode;
+}
+
+/**
+ * TODO docs
+ * Note: "hidden" needs to remain as an option for plugins compatibility
+ */
+export type LegendDisplayMode = "list" | "table" | "hidden";
+
+/**
+ * TODO docs
+ */
+export type LegendPlacement = "bottom" | "right";
+
+/**
+ * TODO docs
+ */
+export type TooltipDisplayMode = "single" | "multi" | "none";
+
+/**
+ * TODO docs
+ */
+export type SortOrder = "asc" | "desc" | "none";
+
+/**
+ * TODO docs
+ */
+export type ScaleDistribution = "linear" | "log" | "ordinal" | "symlog";
+
+/**
+ * TODO docs
+ */
+export type GraphThresholdsStyleMode = "off" | "line" | "dashed" | "area" | "line+area" | "dashed+area" | "series";

package/src/schema/bargauge.gen.ts

@@ -0,0 +1,111 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/bargauge.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 Options {
+  displayMode: BarGaugeDisplayMode;
+  valueMode: BarGaugeValueMode;
+  namePlacement: BarGaugeNamePlacement;
+  showUnfilled: boolean;
+  sizing: BarGaugeSizing;
+  minVizWidth: number;
+  minVizHeight: number;
+  legend: VizLegendOptions;
+  reduceOptions: ReduceDataOptions;
+  text?: VizTextDisplayOptions;
+  maxVizHeight: number;
+  orientation: VizOrientation;
+}
+
+/**
+ * Enum expressing the possible display modes
+ * for the bar gauge component of Grafana UI
+ */
+export type BarGaugeDisplayMode = "basic" | "lcd" | "gradient";
+
+/**
+ * Allows for the table cell gauge display type to set the gauge mode.
+ */
+export type BarGaugeValueMode = "color" | "text" | "hidden";
+
+/**
+ * Allows for the bar gauge name to be placed explicitly
+ */
+export type BarGaugeNamePlacement = "auto" | "top" | "left" | "hidden";
+
+/**
+ * Allows for the bar gauge size to be set explicitly
+ */
+export type BarGaugeSizing = "auto" | "manual";
+
+/**
+ * TODO docs
+ */
+export interface VizLegendOptions {
+  displayMode: LegendDisplayMode;
+  placement: LegendPlacement;
+  showLegend: boolean;
+  asTable?: boolean;
+  isVisible?: boolean;
+  sortBy?: string;
+  sortDesc?: boolean;
+  width?: number;
+  calcs: string[];
+}
+
+/**
+ * TODO docs
+ */
+export interface ReduceDataOptions {
+  /**
+   * If true show each row value
+   */
+  values?: boolean;
+  /**
+   * if showing all values limit
+   */
+  limit?: number;
+  /**
+   * When !values, pick one value for the whole field
+   */
+  calcs: string[];
+  /**
+   * Which fields to show.  By default this is only numeric fields
+   */
+  fields?: string;
+}
+
+/**
+ * TODO docs
+ */
+export interface VizTextDisplayOptions {
+  /**
+   * Explicit title text size
+   */
+  titleSize?: number;
+  /**
+   * Explicit value text size
+   */
+  valueSize?: number;
+  /**
+   * Explicit percent text size
+   */
+  percentSize?: number;
+}
+
+/**
+ * TODO docs
+ */
+export type VizOrientation = "auto" | "vertical" | "horizontal";
+
+/**
+ * TODO docs
+ * Note: "hidden" needs to remain as an option for plugins compatibility
+ */
+export type LegendDisplayMode = "list" | "table" | "hidden";
+
+/**
+ * TODO docs
+ */
+export type LegendPlacement = "bottom" | "right";

package/src/schema/bigquery.gen.ts

@@ -0,0 +1,110 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/bigquery.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
+/* eslint-disable */
+
+/**
+ * Manually converted from https://github.com/grafana/google-bigquery-datasource/blob/18680e42ba557791d109c7c540c2c3f2647592f0/src/types.ts#L75
+ */
+export interface Dataquery {
+  dataset?: string;
+  table?: string;
+  project?: string;
+  format: QueryFormat;
+  rawQuery?: boolean;
+  rawSql: string;
+  location?: string;
+  partitioned?: boolean;
+  partitionedField?: string;
+  convertToUTC?: boolean;
+  sharded?: boolean;
+  queryPriority?: QueryPriority;
+  timeShift?: string;
+  editorMode?: EditorMode;
+  sql?: SQLExpression;
+  /**
+   * A unique identifier for the query within the list of targets.
+   * In server side expressions, the refId is used as a variable name to identify results.
+   * By default, the UI will assign A->Z; however setting meaningful names may be useful.
+   */
+  refId?: string | null;
+  /**
+   * If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
+   */
+  hide?: boolean;
+  /**
+   * Specify the query flavor
+   * TODO make this required and give it a default
+   */
+  queryType?: string;
+  /**
+   * For mixed data sources the selected datasource is on the query level.
+   * For non mixed scenarios this is undefined.
+   * TODO find a better way to do this ^ that's friendly to schema
+   * TODO this shouldn't be unknown but DataSourceRef | null
+   */
+  datasource?: DataSourceRef;
+}
+
+export type QueryFormat = 0 | 1;
+
+export type QueryPriority = "INTERACTIVE" | "BATCH";
+
+export type EditorMode = "code" | "builder";
+
+export interface SQLExpression {
+  columns?: QueryEditorFunctionExpression[];
+  from?: string;
+  /**
+   * whereJsonTree?: _
+   */
+  whereString?: string;
+  groupBy?: QueryEditorGroupByExpression[];
+  orderBy?: QueryEditorPropertyExpression;
+  orderByDirection?: OrderByDirection;
+  limit?: number;
+  offset?: number;
+}
+
+export interface QueryEditorFunctionExpression {
+  type: QueryEditorExpressionType;
+  name?: string;
+  parameters?: QueryEditorFunctionParameterExpression[];
+}
+
+export type QueryEditorExpressionType = "property" | "operator" | "or" | "and" | "groupBy" | "function" | "functionParameter";
+
+export interface QueryEditorFunctionParameterExpression {
+  type: QueryEditorExpressionType;
+  name?: string;
+}
+
+export interface QueryEditorGroupByExpression {
+  type: QueryEditorExpressionType;
+  property: QueryEditorProperty;
+}
+
+export interface QueryEditorProperty {
+  type: QueryEditorPropertyType;
+  name?: string;
+}
+
+export type QueryEditorPropertyType = "string";
+
+export interface QueryEditorPropertyExpression {
+  type: QueryEditorExpressionType;
+  property: QueryEditorProperty;
+}
+
+export type OrderByDirection = "ASC" | "DESC";
+
+export interface DataSourceRef {
+  /**
+   * The plugin type-id
+   */
+  type?: string;
+  /**
+   * Specific datasource instance
+   */
+  uid?: string;
+}

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";
+}