@intentius/chant-lexicon-grafana 0.97.0 → 0.99.0

package/src/schema/expr.gen.ts

@@ -0,0 +1,618 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/expr.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 Expr = TypeMath | TypeReduce | TypeResample | TypeClassicConditions | TypeThreshold | TypeSql;
+
+export interface TypeMath {
+  /**
+   * The datasource
+   */
+  datasource?: DataSourceRef;
+  /**
+   * General math expression
+   */
+  expression: string;
+  /**
+   * true if query is disabled (ie should not be returned to the dashboard)
+   * NOTE: this does not always imply that the query should not be executed since
+   * the results from a hidden query may be used as the input to other queries (SSE etc)
+   */
+  hide?: boolean;
+  /**
+   * Interval is the suggested duration between time points in a time series query.
+   * NOTE: the values for intervalMs is not saved in the query model.  It is typically calculated
+   * from the interval required to fill a pixels in the visualization
+   */
+  intervalMs?: number;
+  /**
+   * MaxDataPoints is the maximum number of data points that should be returned from a time series query.
+   * NOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated
+   * from the number of pixels visible in a visualization
+   */
+  maxDataPoints?: number;
+  /**
+   * QueryType is an optional identifier for the type of query.
+   * It can be used to distinguish different types of queries.
+   */
+  queryType?: string;
+  /**
+   * RefID is the unique identifier of the query, set by the frontend call.
+   */
+  refId?: string | null;
+  /**
+   * Optionally define expected query result behavior
+   */
+  resultAssertions?: {
+    /**
+     * Maximum frame count
+     */
+    maxFrames?: number;
+    /**
+     * Type asserts that the frame matches a known type structure.
+     * Possible enum values:
+     *  - `""`
+     *  - `"timeseries-wide"`
+     *  - `"timeseries-long"`
+     *  - `"timeseries-many"`
+     *  - `"timeseries-multi"`
+     *  - `"directory-listing"`
+     *  - `"table"`
+     *  - `"numeric-wide"`
+     *  - `"numeric-multi"`
+     *  - `"numeric-long"`
+     *  - `"log-lines"`
+     */
+    type?: "" | "timeseries-wide" | "timeseries-long" | "timeseries-many" | "timeseries-multi" | "directory-listing" | "table" | "numeric-wide" | "numeric-multi" | "numeric-long" | "log-lines";
+    /**
+     * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
+     * contract documentation https://grafana.github.io/dataplane/contract/.
+     */
+    typeVersion: number[];
+  };
+  /**
+   * TimeRange represents the query range
+   * NOTE: unlike generic /ds/query, we can now send explicit time values in each query
+   * NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly
+   */
+  timeRange?: {
+    /**
+     * From is the start time of the query.
+     */
+    from: string;
+    /**
+     * To is the end time of the query.
+     */
+    to: string;
+  };
+  type: "math";
+}
+
+export interface TypeReduce {
+  /**
+   * The datasource
+   */
+  datasource?: DataSourceRef;
+  /**
+   * Reference to single query result
+   */
+  expression: string;
+  /**
+   * true if query is disabled (ie should not be returned to the dashboard)
+   * NOTE: this does not always imply that the query should not be executed since
+   * the results from a hidden query may be used as the input to other queries (SSE etc)
+   */
+  hide?: boolean;
+  /**
+   * Interval is the suggested duration between time points in a time series query.
+   * NOTE: the values for intervalMs is not saved in the query model.  It is typically calculated
+   * from the interval required to fill a pixels in the visualization
+   */
+  intervalMs?: number;
+  /**
+   * MaxDataPoints is the maximum number of data points that should be returned from a time series query.
+   * NOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated
+   * from the number of pixels visible in a visualization
+   */
+  maxDataPoints?: number;
+  /**
+   * QueryType is an optional identifier for the type of query.
+   * It can be used to distinguish different types of queries.
+   */
+  queryType?: string;
+  /**
+   * The reducer
+   * Possible enum values:
+   *  - `"sum"`
+   *  - `"mean"`
+   *  - `"min"`
+   *  - `"max"`
+   *  - `"count"`
+   *  - `"last"`
+   *  - `"median"`
+   */
+  reducer: "sum" | "mean" | "min" | "max" | "count" | "last" | "median";
+  /**
+   * RefID is the unique identifier of the query, set by the frontend call.
+   */
+  refId?: string | null;
+  /**
+   * Optionally define expected query result behavior
+   */
+  resultAssertions?: {
+    /**
+     * Maximum frame count
+     */
+    maxFrames?: number;
+    /**
+     * Type asserts that the frame matches a known type structure.
+     * Possible enum values:
+     *  - `""`
+     *  - `"timeseries-wide"`
+     *  - `"timeseries-long"`
+     *  - `"timeseries-many"`
+     *  - `"timeseries-multi"`
+     *  - `"directory-listing"`
+     *  - `"table"`
+     *  - `"numeric-wide"`
+     *  - `"numeric-multi"`
+     *  - `"numeric-long"`
+     *  - `"log-lines"`
+     */
+    type?: "" | "timeseries-wide" | "timeseries-long" | "timeseries-many" | "timeseries-multi" | "directory-listing" | "table" | "numeric-wide" | "numeric-multi" | "numeric-long" | "log-lines";
+    /**
+     * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
+     * contract documentation https://grafana.github.io/dataplane/contract/.
+     */
+    typeVersion: number[];
+  };
+  /**
+   * Reducer Options
+   */
+  settings?: {
+    /**
+     * Non-number reduce behavior
+     * Possible enum values:
+     *  - `"dropNN"` Drop non-numbers
+     *  - `"replaceNN"` Replace non-numbers
+     */
+    mode: "dropNN" | "replaceNN";
+    /**
+     * Only valid when mode is replace
+     */
+    replaceWithValue?: number;
+  };
+  /**
+   * TimeRange represents the query range
+   * NOTE: unlike generic /ds/query, we can now send explicit time values in each query
+   * NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly
+   */
+  timeRange?: {
+    /**
+     * From is the start time of the query.
+     */
+    from: string;
+    /**
+     * To is the end time of the query.
+     */
+    to: string;
+  };
+  type: "reduce";
+}
+
+export interface TypeResample {
+  /**
+   * The datasource
+   */
+  datasource?: DataSourceRef;
+  /**
+   * The downsample function
+   * Possible enum values:
+   *  - `"sum"`
+   *  - `"mean"`
+   *  - `"min"`
+   *  - `"max"`
+   *  - `"count"`
+   *  - `"last"`
+   *  - `"median"`
+   */
+  downsampler: "sum" | "mean" | "min" | "max" | "count" | "last" | "median";
+  /**
+   * The math expression
+   */
+  expression: string;
+  /**
+   * true if query is disabled (ie should not be returned to the dashboard)
+   * NOTE: this does not always imply that the query should not be executed since
+   * the results from a hidden query may be used as the input to other queries (SSE etc)
+   */
+  hide?: boolean;
+  /**
+   * Interval is the suggested duration between time points in a time series query.
+   * NOTE: the values for intervalMs is not saved in the query model.  It is typically calculated
+   * from the interval required to fill a pixels in the visualization
+   */
+  intervalMs?: number;
+  /**
+   * MaxDataPoints is the maximum number of data points that should be returned from a time series query.
+   * NOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated
+   * from the number of pixels visible in a visualization
+   */
+  maxDataPoints?: number;
+  /**
+   * QueryType is an optional identifier for the type of query.
+   * It can be used to distinguish different types of queries.
+   */
+  queryType?: string;
+  /**
+   * RefID is the unique identifier of the query, set by the frontend call.
+   */
+  refId?: string | null;
+  /**
+   * Optionally define expected query result behavior
+   */
+  resultAssertions?: {
+    /**
+     * Maximum frame count
+     */
+    maxFrames?: number;
+    /**
+     * Type asserts that the frame matches a known type structure.
+     * Possible enum values:
+     *  - `""`
+     *  - `"timeseries-wide"`
+     *  - `"timeseries-long"`
+     *  - `"timeseries-many"`
+     *  - `"timeseries-multi"`
+     *  - `"directory-listing"`
+     *  - `"table"`
+     *  - `"numeric-wide"`
+     *  - `"numeric-multi"`
+     *  - `"numeric-long"`
+     *  - `"log-lines"`
+     */
+    type?: "" | "timeseries-wide" | "timeseries-long" | "timeseries-many" | "timeseries-multi" | "directory-listing" | "table" | "numeric-wide" | "numeric-multi" | "numeric-long" | "log-lines";
+    /**
+     * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
+     * contract documentation https://grafana.github.io/dataplane/contract/.
+     */
+    typeVersion: number[];
+  };
+  /**
+   * TimeRange represents the query range
+   * NOTE: unlike generic /ds/query, we can now send explicit time values in each query
+   * NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly
+   */
+  timeRange?: {
+    /**
+     * From is the start time of the query.
+     */
+    from: string;
+    /**
+     * To is the end time of the query.
+     */
+    to: string;
+  };
+  type: "resample";
+  /**
+   * The upsample function
+   * Possible enum values:
+   *  - `"pad"` Use the last seen value
+   *  - `"backfilling"` backfill
+   *  - `"fillna"` Do not fill values (nill)
+   */
+  upsampler: "pad" | "backfilling" | "fillna";
+  /**
+   * The time duration
+   */
+  window: string;
+}
+
+export interface TypeClassicConditions {
+  conditions: {
+    evaluator: {
+      params: number[];
+      /**
+       * e.g. "gt"
+       */
+      type: string;
+    };
+    operator: {
+      type: "and" | "or" | "logic-or";
+    };
+    query: {
+      params: string[];
+    };
+    reducer: {
+      type: string;
+    };
+  }[];
+  /**
+   * The datasource
+   */
+  datasource?: DataSourceRef;
+  /**
+   * true if query is disabled (ie should not be returned to the dashboard)
+   * NOTE: this does not always imply that the query should not be executed since
+   * the results from a hidden query may be used as the input to other queries (SSE etc)
+   */
+  hide?: boolean;
+  /**
+   * Interval is the suggested duration between time points in a time series query.
+   * NOTE: the values for intervalMs is not saved in the query model.  It is typically calculated
+   * from the interval required to fill a pixels in the visualization
+   */
+  intervalMs?: number;
+  /**
+   * MaxDataPoints is the maximum number of data points that should be returned from a time series query.
+   * NOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated
+   * from the number of pixels visible in a visualization
+   */
+  maxDataPoints?: number;
+  /**
+   * QueryType is an optional identifier for the type of query.
+   * It can be used to distinguish different types of queries.
+   */
+  queryType?: string;
+  /**
+   * RefID is the unique identifier of the query, set by the frontend call.
+   */
+  refId?: string | null;
+  /**
+   * Optionally define expected query result behavior
+   */
+  resultAssertions?: {
+    /**
+     * Maximum frame count
+     */
+    maxFrames?: number;
+    /**
+     * Type asserts that the frame matches a known type structure.
+     * Possible enum values:
+     *  - `""`
+     *  - `"timeseries-wide"`
+     *  - `"timeseries-long"`
+     *  - `"timeseries-many"`
+     *  - `"timeseries-multi"`
+     *  - `"directory-listing"`
+     *  - `"table"`
+     *  - `"numeric-wide"`
+     *  - `"numeric-multi"`
+     *  - `"numeric-long"`
+     *  - `"log-lines"`
+     */
+    type?: "" | "timeseries-wide" | "timeseries-long" | "timeseries-many" | "timeseries-multi" | "directory-listing" | "table" | "numeric-wide" | "numeric-multi" | "numeric-long" | "log-lines";
+    /**
+     * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
+     * contract documentation https://grafana.github.io/dataplane/contract/.
+     */
+    typeVersion: number[];
+  };
+  /**
+   * TimeRange represents the query range
+   * NOTE: unlike generic /ds/query, we can now send explicit time values in each query
+   * NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly
+   */
+  timeRange?: {
+    /**
+     * From is the start time of the query.
+     */
+    from: string;
+    /**
+     * To is the end time of the query.
+     */
+    to: string;
+  };
+  type: "classic_conditions";
+}
+
+export interface TypeThreshold {
+  /**
+   * Threshold Conditions
+   */
+  conditions: {
+    evaluator: {
+      params: number[];
+      /**
+       * e.g. "gt"
+       */
+      type: "gt" | "lt" | "eq" | "ne" | "gte" | "lte" | "within_range" | "outside_range" | "within_range_included" | "outside_range_included";
+    };
+    loadedDimensions?: Record<string, unknown>;
+    unloadEvaluator?: {
+      params: number[];
+      /**
+       * e.g. "gt"
+       */
+      type: "gt" | "lt" | "eq" | "ne" | "gte" | "lte" | "within_range" | "outside_range" | "within_range_included" | "outside_range_included";
+    };
+    /**
+     * Fingerprints of the series already firing, written by Grafana while it evaluates a rule with a recovery threshold. Supersedes loadedDimensions. Never set it by hand.
+     */
+    loadedFingerprints?: string[];
+  }[];
+  /**
+   * The datasource
+   */
+  datasource?: DataSourceRef;
+  /**
+   * Reference to single query result
+   */
+  expression: string;
+  /**
+   * true if query is disabled (ie should not be returned to the dashboard)
+   * NOTE: this does not always imply that the query should not be executed since
+   * the results from a hidden query may be used as the input to other queries (SSE etc)
+   */
+  hide?: boolean;
+  /**
+   * Interval is the suggested duration between time points in a time series query.
+   * NOTE: the values for intervalMs is not saved in the query model.  It is typically calculated
+   * from the interval required to fill a pixels in the visualization
+   */
+  intervalMs?: number;
+  /**
+   * MaxDataPoints is the maximum number of data points that should be returned from a time series query.
+   * NOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated
+   * from the number of pixels visible in a visualization
+   */
+  maxDataPoints?: number;
+  /**
+   * QueryType is an optional identifier for the type of query.
+   * It can be used to distinguish different types of queries.
+   */
+  queryType?: string;
+  /**
+   * RefID is the unique identifier of the query, set by the frontend call.
+   */
+  refId?: string | null;
+  /**
+   * Optionally define expected query result behavior
+   */
+  resultAssertions?: {
+    /**
+     * Maximum frame count
+     */
+    maxFrames?: number;
+    /**
+     * Type asserts that the frame matches a known type structure.
+     * Possible enum values:
+     *  - `""`
+     *  - `"timeseries-wide"`
+     *  - `"timeseries-long"`
+     *  - `"timeseries-many"`
+     *  - `"timeseries-multi"`
+     *  - `"directory-listing"`
+     *  - `"table"`
+     *  - `"numeric-wide"`
+     *  - `"numeric-multi"`
+     *  - `"numeric-long"`
+     *  - `"log-lines"`
+     */
+    type?: "" | "timeseries-wide" | "timeseries-long" | "timeseries-many" | "timeseries-multi" | "directory-listing" | "table" | "numeric-wide" | "numeric-multi" | "numeric-long" | "log-lines";
+    /**
+     * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
+     * contract documentation https://grafana.github.io/dataplane/contract/.
+     */
+    typeVersion: number[];
+  };
+  /**
+   * TimeRange represents the query range
+   * NOTE: unlike generic /ds/query, we can now send explicit time values in each query
+   * NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly
+   */
+  timeRange?: {
+    /**
+     * From is the start time of the query.
+     */
+    from: string;
+    /**
+     * To is the end time of the query.
+     */
+    to: string;
+  };
+  type: "threshold";
+}
+
+export interface TypeSql {
+  /**
+   * The datasource
+   */
+  datasource?: DataSourceRef;
+  expression: string;
+  format: string;
+  /**
+   * true if query is disabled (ie should not be returned to the dashboard)
+   * NOTE: this does not always imply that the query should not be executed since
+   * the results from a hidden query may be used as the input to other queries (SSE etc)
+   */
+  hide?: boolean;
+  /**
+   * Interval is the suggested duration between time points in a time series query.
+   * NOTE: the values for intervalMs is not saved in the query model.  It is typically calculated
+   * from the interval required to fill a pixels in the visualization
+   */
+  intervalMs?: number;
+  /**
+   * MaxDataPoints is the maximum number of data points that should be returned from a time series query.
+   * NOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated
+   * from the number of pixels visible in a visualization
+   */
+  maxDataPoints?: number;
+  /**
+   * QueryType is an optional identifier for the type of query.
+   * It can be used to distinguish different types of queries.
+   */
+  queryType?: string;
+  /**
+   * RefID is the unique identifier of the query, set by the frontend call.
+   */
+  refId?: string | null;
+  /**
+   * Optionally define expected query result behavior
+   */
+  resultAssertions?: {
+    /**
+     * Maximum frame count
+     */
+    maxFrames?: number;
+    /**
+     * Type asserts that the frame matches a known type structure.
+     * Possible enum values:
+     *  - `""`
+     *  - `"timeseries-wide"`
+     *  - `"timeseries-long"`
+     *  - `"timeseries-many"`
+     *  - `"timeseries-multi"`
+     *  - `"directory-listing"`
+     *  - `"table"`
+     *  - `"numeric-wide"`
+     *  - `"numeric-multi"`
+     *  - `"numeric-long"`
+     *  - `"log-lines"`
+     */
+    type?: "" | "timeseries-wide" | "timeseries-long" | "timeseries-many" | "timeseries-multi" | "directory-listing" | "table" | "numeric-wide" | "numeric-multi" | "numeric-long" | "log-lines";
+    /**
+     * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
+     * contract documentation https://grafana.github.io/dataplane/contract/.
+     */
+    typeVersion: number[];
+  };
+  /**
+   * TimeRange represents the query range
+   * NOTE: unlike generic /ds/query, we can now send explicit time values in each query
+   * NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly
+   */
+  timeRange?: {
+    /**
+     * From is the start time of the query.
+     */
+    from: string;
+    /**
+     * To is the end time of the query.
+     */
+    to: string;
+  };
+  type: "sql";
+}
+
+export interface TypeMathOrTypeReduceOrTypeResampleOrTypeClassicConditionsOrTypeThresholdOrTypeSql {
+  TypeMath?: TypeMath | null;
+  TypeReduce?: TypeReduce | null;
+  TypeResample?: TypeResample | null;
+  TypeClassicConditions?: TypeClassicConditions | null;
+  TypeThreshold?: TypeThreshold | null;
+  TypeSql?: TypeSql | null;
+}
+
+export interface DataSourceRef {
+  /**
+   * The plugin type-id
+   */
+  type?: string;
+  /**
+   * Specific datasource instance
+   */
+  uid?: string;
+}

package/src/schema/gauge.gen.ts

@@ -1,5 +1,6 @@
 // Code generated by chant generate from the vendored Grafana schema
-// src/spec/schemas/gauge.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+// src/spec/schemas/gauge.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 {