@grafana/plugin-types 0.0.6 → 0.0.7

package/dist/grafana-pluginsplatform-app/index.d.ts

@@ -1,723 +1,9 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { DataQuery as DataQuery$1, DataTopic, HideSeriesConfig } from '@grafana/schema';
-
-export interface DateTimeBuiltinFormat {
-	__momentBuiltinFormatBrand: any;
-}
-export type DateTimeInput = Date | string | number | Array<string | number> | DateTime | null;
-export type FormatInput = string | DateTimeBuiltinFormat | undefined;
-export type DurationUnit = "year" | "years" | "y" | "month" | "months" | "M" | "week" | "weeks" | "isoWeek" | "w" | "day" | "days" | "d" | "hour" | "hours" | "h" | "minute" | "minutes" | "m" | "second" | "seconds" | "s" | "millisecond" | "milliseconds" | "ms" | "quarter" | "quarters" | "Q";
-export interface DateTime extends Object {
-	add: (amount?: DateTimeInput, unit?: DurationUnit) => DateTime;
-	set: (unit: DurationUnit | "date", amount: DateTimeInput) => void;
-	diff: (amount: DateTimeInput, unit?: DurationUnit, truncate?: boolean) => number;
-	endOf: (unitOfTime: DurationUnit) => DateTime;
-	format: (formatInput?: FormatInput) => string;
-	fromNow: (withoutSuffix?: boolean) => string;
-	from: (formaInput: DateTimeInput) => string;
-	isSame: (input?: DateTimeInput, granularity?: DurationUnit) => boolean;
-	isBefore: (input?: DateTimeInput) => boolean;
-	isValid: () => boolean;
-	local: () => DateTime;
-	locale: (locale: string) => DateTime;
-	startOf: (unitOfTime: DurationUnit) => DateTime;
-	subtract: (amount?: DateTimeInput, unit?: DurationUnit) => DateTime;
-	toDate: () => Date;
-	toISOString: (keepOffset?: boolean) => string;
-	isoWeekday: (day?: number | string) => number | string;
-	valueOf: () => number;
-	unix: () => number;
-	utc: () => DateTime;
-	utcOffset: () => number;
-	hour?: () => number;
-	minute?: () => number;
-}
-export interface RawTimeRange {
-	from: DateTime | string;
-	to: DateTime | string;
-}
-export interface TimeRange {
-	from: DateTime;
-	to: DateTime;
-	raw: RawTimeRange;
-}
-export interface FormattedValue {
-	text: string;
-	prefix?: string;
-	suffix?: string;
-}
-export type DisplayProcessor = (value: unknown, decimals?: DecimalCount) => DisplayValue;
-export interface DisplayValue extends FormattedValue {
-	/**
-	 *  Use isNaN to check if it is a real number
-	 */
-	numeric: number;
-	/**
-	 *  0-1 between min & max
-	 */
-	percent?: number;
-	/**
-	 *  0-1 percent change across range
-	 */
-	percentChange?: number;
-	/**
-	 *  Color based on mappings or threshold
-	 */
-	color?: string;
-	/**
-	 *  Icon based on mappings or threshold
-	 */
-	icon?: string;
-	title?: string;
-	/**
-	 * Used in limited scenarios like legend reducer calculations
-	 */
-	description?: string;
-}
-/**
- * These represents the display value with the longest title and text.
- * Used to align widths and heights when displaying multiple DisplayValues
- */
-export interface DisplayValueAlignmentFactors extends FormattedValue {
-	title?: string;
-}
-export type DecimalCount = number | null | undefined;
-export interface ScopedVar<T = any> {
-	text?: any;
-	value: T;
-}
-export interface ScopedVars {
-	__dataContext?: DataContextScopedVar;
-	[key: string]: ScopedVar | undefined;
-}
-/**
- * Used by data link macros
- */
-export interface DataContextScopedVar {
-	value: {
-		data: DataFrame[];
-		frame: DataFrame;
-		field: Field;
-		rowIndex?: number;
-		frameIndex?: number;
-		calculatedValue?: DisplayValue;
-	};
-}
-declare enum DataFrameType {
-	TimeSeriesWide = "timeseries-wide",
-	TimeSeriesLong = "timeseries-long",
-	/** @deprecated in favor of TimeSeriesMulti */
-	TimeSeriesMany = "timeseries-many",
-	TimeSeriesMulti = "timeseries-multi",
-	/** Numeric types: https://grafana.com/developers/dataplane/numeric */
-	NumericWide = "numeric-wide",
-	NumericMulti = "numeric-multi",
-	NumericLong = "numeric-long",
-	/** Logs types: https://grafana.com/developers/dataplane/logs */
-	LogLines = "log-lines",
-	/** Directory listing */
-	DirectoryListing = "directory-listing",
-	/**
-	 * First field is X, the rest are ordinal values used as rows in the heatmap
-	 */
-	HeatmapRows = "heatmap-rows",
-	/**
-	 * Explicit fields for:
-	 *  xMin, yMin, count, ...
-	 *
-	 * All values in the grid exist and have regular spacing
-	 *
-	 * If the y value is actually ordinal, use `meta.custom` to specify the bucket lookup values
-	 */
-	HeatmapCells = "heatmap-cells",
-	/**
-	 * Explicit fields for:
-	 *  xMin, xMax, count
-	 */
-	Histogram = "histogram"
-}
-export interface ExplorePanelsState extends Partial<Record<PreferredVisualisationType, {}>> {
-	trace?: ExploreTracePanelState;
-	logs?: ExploreLogsPanelState;
-}
-/**
- * Keep a list of vars the correlations editor / helper in explore will use
- *
- * vars can be modified by transformation variables, origVars is so we can rebuild the original list
- */
-/** @internal */
-export interface ExploreCorrelationHelperData {
-	resultField: string;
-	origVars: Record<string, string>;
-	vars: Record<string, string>;
-}
-export interface ExploreTracePanelState {
-	spanId?: string;
-}
-export interface ExploreLogsPanelState {
-	id?: string;
-	columns?: Record<number, string>;
-	visualisationType?: "table" | "logs";
-	labelFieldName?: string;
-	refId?: string;
-}
-export interface Threshold {
-	value: number;
-	color: string;
-	/**
-	 *  Warning, Error, LowLow, Low, OK, High, HighHigh etc
-	 */
-	state?: string;
-}
-declare enum ThresholdsMode {
-	Absolute = "absolute",
-	/**
-	 *  between 0 and 1 (based on min/max)
-	 */
-	Percentage = "percentage"
-}
-/**
- *  Config that is passed to the ThresholdsEditor
- */
-export interface ThresholdsConfig {
-	mode: ThresholdsMode;
-	/**
-	 *  Must be sorted by 'value', first value is always -Infinity
-	 */
-	steps: Threshold[];
-}
-declare enum MappingType {
-	ValueToText = "value",// was 1
-	RangeToText = "range",// was 2
-	RegexToText = "regex",
-	SpecialValue = "special"
-}
-/**
- * @alpha
- */
-export interface ValueMappingResult {
-	text?: string;
-	color?: string;
-	icon?: string;
-	index?: number;
-}
-/**
- * @alpha
- */
-export interface BaseValueMap<T> {
-	type: MappingType;
-	options: T;
-}
-/**
- * @alpha
- */
-export interface ValueMap extends BaseValueMap<Record<string, ValueMappingResult>> {
-	type: MappingType.ValueToText;
-}
-/**
- * @alpha
- */
-export interface RangeMapOptions {
-	from: number | null;
-	to: number | null;
-	result: ValueMappingResult;
-}
-/**
- * @alpha
- */
-export interface RangeMap extends BaseValueMap<RangeMapOptions> {
-	type: MappingType.RangeToText;
-}
-/**
- * @alpha
- */
-export interface RegexMapOptions {
-	pattern: string;
-	result: ValueMappingResult;
-}
-/**
- * @alpha
- */
-export interface RegexMap extends BaseValueMap<RegexMapOptions> {
-	type: MappingType.RegexToText;
-}
-/**
- * @alpha
- */
-export interface SpecialValueOptions {
-	match: SpecialValueMatch;
-	result: ValueMappingResult;
-}
-declare enum SpecialValueMatch {
-	True = "true",
-	False = "false",
-	Null = "null",
-	NaN = "nan",
-	NullAndNaN = "null+nan",
-	Empty = "empty"
-}
-/**
- * @alpha
- */
-export interface SpecialValueMap extends BaseValueMap<SpecialValueOptions> {
-	type: MappingType.SpecialValue;
-}
-/**
- * @alpha
- */
-export type ValueMapping = ValueMap | RangeMap | RegexMap | SpecialValueMap;
-/**
- * @deprecated use the type from @grafana/schema
- */
-export interface DataQuery extends DataQuery$1 {
-}
-export type InterpolateFunction = (value: string, scopedVars?: ScopedVars, format?: string | Function) => string;
-/**
- * Callback info for DataLink click events
- */
-export interface DataLinkClickEvent<T = any> {
-	origin: T;
-	replaceVariables: InterpolateFunction | undefined;
-	e?: any;
-}
-declare enum DataLinkConfigOrigin {
-	Datasource = "Datasource",
-	Correlations = "Correlations",
-	ExploreCorrelationsEditor = "CorrelationsEditor"
-}
-/**
- * Link configuration. The values may contain variables that need to be
- * processed before showing the link to user.
- *
- * TODO: <T extends DataQuery> is not strictly true for internal links as we do not need refId for example but all
- *  data source defined queries extend this so this is more for documentation.
- */
-export interface DataLink<T extends DataQuery = any> {
-	title: string;
-	targetBlank?: boolean;
-	url: string;
-	onBuildUrl?: (event: DataLinkClickEvent) => string;
-	onClick?: (event: DataLinkClickEvent) => void;
-	internal?: InternalDataLink<T>;
-	origin?: DataLinkConfigOrigin;
-	sortIndex?: number;
-}
-declare enum SupportedTransformationType {
-	Regex = "regex",
-	Logfmt = "logfmt"
-}
-/** @internal */
-export interface DataLinkTransformationConfig {
-	type: SupportedTransformationType;
-	field?: string;
-	expression?: string;
-	mapValue?: string;
-}
-/** @internal */
-export interface InternalDataLink<T extends DataQuery = any> {
-	query: T;
-	datasourceUid: string;
-	datasourceName: string;
-	panelsState?: ExplorePanelsState;
-	meta?: {
-		correlationData?: ExploreCorrelationHelperData;
-	};
-	transformations?: DataLinkTransformationConfig[];
-	range?: TimeRange;
-}
-export type LinkTarget = "_blank" | "_self" | undefined;
-/**
- * Processed Link Model. The values are ready to use
- */
-export interface LinkModel<T = any> {
-	href: string;
-	title: string;
-	target: LinkTarget;
-	origin: T;
-	onClick?: (e: any, origin?: any) => void;
-}
-declare const preferredVisualizationTypes: readonly [
-	"graph",
-	"table",
-	"logs",
-	"trace",
-	"nodeGraph",
-	"flamegraph",
-	"rawPrometheus"
-];
-export type PreferredVisualisationType = (typeof preferredVisualizationTypes)[number];
-/**
- * Should be kept in sync with https://github.com/grafana/grafana-plugin-sdk-go/blob/main/data/frame_meta.go
- * @public
- */
-export interface QueryResultMeta {
-	type?: DataFrameType;
-	/**
-	 * TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane
-	 * contract documentation https://github.com/grafana/grafana-plugin-sdk-go/tree/main/data/contract_docs.
-	 */
-	typeVersion?: [
-		number,
-		number
-	];
-	/** DatasSource Specific Values */
-	custom?: Record<string, any>;
-	/** Stats */
-	stats?: QueryResultMetaStat[];
-	/** Meta Notices */
-	notices?: QueryResultMetaNotice[];
-	/** Currently used to show results in Explore only in preferred visualisation option */
-	preferredVisualisationType?: PreferredVisualisationType;
-	/** Set the panel plugin id to use to render the data when using Explore. If the plugin cannot be found
-	 * will fall back to {@link preferredVisualisationType}.
-	 *
-	 * @alpha
-	 */
-	preferredVisualisationPluginId?: string;
-	/** The path for live stream updates for this frame */
-	channel?: string;
-	/** Did the query response come from the cache */
-	isCachedResponse?: boolean;
-	/**
-	 * Optionally identify which topic the frame should be assigned to.
-	 * A value specified in the response will override what the request asked for.
-	 */
-	dataTopic?: DataTopic;
-	/**
-	 * This is the raw query sent to the underlying system.  All macros and templating
-	 * as been applied.  When metadata contains this value, it will be shown in the query inspector
-	 */
-	executedQueryString?: string;
-	/**
-	 * A browsable path on the datasource
-	 */
-	path?: string;
-	/**
-	 * defaults to '/'
-	 */
-	pathSeparator?: string;
-	/** A time shift metadata indicating a result of comparison */
-	timeCompare?: {
-		diffMs: number;
-		isTimeShiftQuery: boolean;
-	};
-	/**
-	 * Legacy data source specific, should be moved to custom
-	 * */
-	searchWords?: string[];
-	limit?: number;
-	json?: boolean;
-	instant?: boolean;
-	/**
-	 * Array of field indices which values create a unique id for each row. Ideally this should be globally unique ID
-	 * but that isn't guarantied. Should help with keeping track and deduplicating rows in visualizations, especially
-	 * with streaming data with frequent updates.
-	 * Example: TraceID in Tempo, table name + primary key in SQL
-	 */
-	uniqueRowIdFields?: number[];
-}
-export interface QueryResultMetaStat extends FieldConfig {
-	displayName: string;
-	value: number;
-}
-/**
- * QueryResultMetaNotice is a structure that provides user notices for query result data
- * @public
- */
-export interface QueryResultMetaNotice {
-	/**
-	 * Specify the notice severity
-	 */
-	severity: "info" | "warning" | "error";
-	/**
-	 * Notice descriptive text
-	 */
-	text: string;
-	/**
-	 * An optional link that may be displayed in the UI.
-	 * This value may be an absolute URL or relative to grafana root
-	 */
-	link?: string;
-	/**
-	 * Optionally suggest an appropriate tab for the panel inspector
-	 */
-	inspect?: "meta" | "error" | "data" | "stats";
-}
-/**
- * @public
- */
-export interface QueryResultBase {
-	/**
-	 * Matches the query target refId
-	 */
-	refId?: string;
-	/**
-	 * Used by some backend data sources to communicate back info about the execution (generated sql, timing)
-	 */
-	meta?: QueryResultMeta;
-}
-export interface Labels {
-	[key: string]: string;
-}
-declare enum NullValueMode {
-	Null = "null",
-	Ignore = "connected",
-	AsZero = "null as zero"
-}
-declare enum FieldColorModeId {
-	Thresholds = "thresholds",
-	PaletteClassic = "palette-classic",
-	PaletteClassicByName = "palette-classic-by-name",
-	PaletteSaturated = "palette-saturated",
-	ContinuousGrYlRd = "continuous-GrYlRd",
-	ContinuousRdYlGr = "continuous-RdYlGr",
-	ContinuousBlYlRd = "continuous-BlYlRd",
-	ContinuousYlRd = "continuous-YlRd",
-	ContinuousBlPu = "continuous-BlPu",
-	ContinuousYlBl = "continuous-YlBl",
-	ContinuousBlues = "continuous-blues",
-	ContinuousReds = "continuous-reds",
-	ContinuousGreens = "continuous-greens",
-	ContinuousPurples = "continuous-purples",
-	Fixed = "fixed",
-	Shades = "shades"
-}
-/**
- * @public
- */
-export interface FieldColor {
-	/** The main color scheme mode */
-	mode: FieldColorModeId | string;
-	/** Stores the fixed color value if mode is fixed */
-	fixedColor?: string;
-	/** Some visualizations need to know how to assign a series color from by value color schemes */
-	seriesBy?: FieldColorSeriesByMode;
-}
-/**
- * @beta
- */
-export type FieldColorSeriesByMode = "min" | "max" | "last";
-declare enum FieldType {
-	time = "time",// or date
-	number = "number",
-	string = "string",
-	boolean = "boolean",
-	trace = "trace",
-	geo = "geo",
-	enum = "enum",
-	other = "other",// Object, Array, etc
-	frame = "frame",// DataFrame
-	nestedFrames = "nestedFrames"
-}
-/**
- * @public
- * Every property is optional
- *
- * Plugins may extend this with additional properties. Something like series overrides
- */
-export interface FieldConfig<TOptions = any> {
-	/**
-	 * The display value for this field.  This supports template variables blank is auto.
-	 * If you are a datasource plugin, do not set this. Use `field.value` and if that
-	 * is not enough, use `field.config.displayNameFromDS`.
-	 */
-	displayName?: string;
-	/**
-	 * This can be used by data sources that need to customize how values are named.
-	 * When this property is configured, this value is used rather than the default naming strategy.
-	 */
-	displayNameFromDS?: string;
-	/**
-	 * Human readable field metadata
-	 */
-	description?: string;
-	/**
-	 * An explict path to the field in the datasource.  When the frame meta includes a path,
-	 * This will default to `${frame.meta.path}/${field.name}
-	 *
-	 * When defined, this value can be used as an identifier within the datasource scope, and
-	 * may be used to update the results
-	 */
-	path?: string;
-	/**
-	 * True if data source can write a value to the path.  Auth/authz are supported separately
-	 */
-	writeable?: boolean;
-	/**
-	 * True if data source field supports ad-hoc filters
-	 */
-	filterable?: boolean;
-	unit?: string;
-	decimals?: DecimalCount;
-	min?: number | null;
-	max?: number | null;
-	interval?: number | null;
-	mappings?: ValueMapping[];
-	thresholds?: ThresholdsConfig;
-	color?: FieldColor;
-	nullValueMode?: NullValueMode;
-	links?: DataLink[];
-	noValue?: string;
-	type?: FieldTypeConfig;
-	custom?: TOptions;
-	fieldMinMax?: boolean;
-}
-export interface FieldTypeConfig {
-	enum?: EnumFieldConfig;
-}
-export interface EnumFieldConfig {
-	text?: string[];
-	color?: string[];
-	icon?: string[];
-	description?: string[];
-}
-/** @public */
-export interface ValueLinkConfig {
-	/**
-	 * Result of field reduction
-	 */
-	calculatedValue?: DisplayValue;
-	/**
-	 * Index of the value row within Field. Should be provided only when value is not a result of a reduction
-	 */
-	valueRowIndex?: number;
-}
-export interface Field<T = any> {
-	/**
-	 * Name of the field (column)
-	 */
-	name: string;
-	/**
-	 *  Field value type (string, number, etc)
-	 */
-	type: FieldType;
-	/**
-	 *  Meta info about how field and how to display it
-	 */
-	config: FieldConfig;
-	/**
-	 * The raw field values
-	 */
-	values: T[];
-	/**
-	 * When type === FieldType.Time, this can optionally store
-	 * the nanosecond-precison fractions as integers between
-	 * 0 and 999999.
-	 */
-	nanos?: number[];
-	labels?: Labels;
-	/**
-	 * Cached values with appropriate display and id values
-	 */
-	state?: FieldState | null;
-	/**
-	 * Convert a value for display
-	 */
-	display?: DisplayProcessor;
-	/**
-	 * Get value data links with variables interpolated
-	 */
-	getLinks?: (config: ValueLinkConfig) => Array<LinkModel<Field>>;
-}
-/** @alpha */
-export interface FieldState {
-	/**
-	 * An appropriate name for the field (does not include frame info)
-	 */
-	displayName?: string | null;
-	/**
-	 * Cache of reduced values
-	 */
-	calcs?: FieldCalcs;
-	/**
-	 * The numeric range for values in this field.  This value will respect the min/max
-	 * set in field config, or when set to `auto` this will have the min/max for all data
-	 * in the response
-	 */
-	range?: NumericRange;
-	/**
-	 * Appropriate values for templating
-	 */
-	scopedVars?: ScopedVars;
-	/**
-	 * Series index is index for this field in a larger data set that can span multiple DataFrames
-	 * Useful for assigning color to series by looking up a color in a palette using this index
-	 */
-	seriesIndex?: number;
-	/**
-	 * Location of this field within the context frames results
-	 *
-	 * @internal -- we will try to make this unnecessary
-	 */
-	origin?: DataFrameFieldIndex;
-	/**
-	 * Boolean value is true if field is in a larger data set with multiple frames.
-	 * This is only related to the cached displayName property above.
-	 */
-	multipleFrames?: boolean;
-	/**
-	 * Boolean value is true if a null filling threshold has been applied
-	 * against the frame of the field. This is used to avoid cases in which
-	 * this would applied more than one time.
-	 */
-	nullThresholdApplied?: boolean;
-	/**
-	 * Can be used by visualizations to cache max display value lengths to aid alignment.
-	 * It's up to each visualization to calculate and set this.
-	 */
-	alignmentFactors?: DisplayValueAlignmentFactors;
-	/**
-	 * This is the current ad-hoc state of whether this series is hidden in viz, tooltip, and legend.
-	 *
-	 * Currently this will match field.config.custom.hideFrom because fieldOverrides applies the special __system
-	 * override to the actual config during toggle via legend. This should go away once we have a unified system
-	 * for layering ad hoc field overrides and options but still being able to get the stateless fieldConfig and panel options
-	 */
-	hideFrom?: HideSeriesConfig;
-}
-/** @public */
-export interface NumericRange {
-	min?: number | null;
-	max?: number | null;
-	delta: number;
-}
-export interface DataFrame extends QueryResultBase {
-	name?: string;
-	fields: Field[];
-	length: number;
-}
-export interface FieldCalcs extends Record<string, any> {
-}
-/**
- * Describes where a specific data frame field is located within a
- * dataset of type DataFrame[]
- *
- * @internal -- we will try to make this unnecessary
- */
-export interface DataFrameFieldIndex {
-	frameIndex: number;
-	fieldIndex: number;
-}
 export type ComponentSize = "xs" | "sm" | "md" | "lg";
-export interface EntityAssertionsWidgetProps {
-	query: UseEntityParams;
-	size?: ComponentSize;
-}
 export interface Scope {
 	env?: string;
 	site?: string;
 	namespace?: string;
-}
-export interface UseEntityParams {
-	entityName?: string;
-	entityType?: string;
-	start: number;
-	end: number;
-	scope?: Scope;
-}
-export interface Entity {
-	name: string;
-	type: string;
-	frame: DataFrame;
+	size?: ComponentSize;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-types",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "NPM package consisting of various Grafana plugins exposed types.",
   "license": "Apache-2.0",
   "author": "Grafana Labs",