mirror of https://github.com/grafana/grafana
codegen: Introduce TS codegen veneer (#54816)
* Split all named types out into defs, etc. * Use latest cuetsy, refactor generators accordingly * Return AST type from plugin TS generator * Near-complete checkin of TS veneer code generator * First full completed pass * Improve the attribute name * Defer use of the dashboard veneer type to follow-up * Remove dummy index, prettier on veneer * Fix merge errors in gen.go * Add match field to SpecialValueMap * Fix backend lint errorspull/55517/head^2
sam boyer
3 years ago
committed by
GitHub
parent
f8240e4b0a
commit
e2ff875976
@ -0,0 +1,76 @@ |
||||
// This file is autogenerated. DO NOT EDIT.
|
||||
//
|
||||
// Generated by pkg/framework/coremodel/gen.go
|
||||
//
|
||||
// Run `make gen-cue` from repository root to regenerate.
|
||||
|
||||
// Raw generated types from dashboard entity type.
|
||||
export type { |
||||
AnnotationQuery, |
||||
VariableModel, |
||||
DashboardLink, |
||||
DashboardLinkType, |
||||
VariableType, |
||||
FieldColorModeId, |
||||
FieldColorSeriesByMode, |
||||
FieldColor, |
||||
GridPos, |
||||
Threshold, |
||||
ThresholdsMode, |
||||
ThresholdsConfig, |
||||
ValueMapping, |
||||
MappingType, |
||||
ValueMap, |
||||
RangeMap, |
||||
RegexMap, |
||||
SpecialValueMap, |
||||
SpecialValueMatch, |
||||
ValueMappingResult, |
||||
Transformation, |
||||
DashboardCursorSync, |
||||
MatcherConfig, |
||||
RowPanel |
||||
} from './raw/dashboard/x/dashboard.gen'; |
||||
|
||||
// Raw generated default consts from dashboard entity type.
|
||||
export { |
||||
defaultAnnotationQuery, |
||||
defaultDashboardLink, |
||||
defaultGridPos, |
||||
defaultThresholdsConfig, |
||||
defaultDashboardCursorSync, |
||||
defaultMatcherConfig, |
||||
defaultRowPanel |
||||
} from './raw/dashboard/x/dashboard.gen'; |
||||
|
||||
// The following exported declarations correspond to types in the dashboard@0.0 schema with
|
||||
// attribute @grafana(TSVeneer="type"). (lineage declared in file: pkg/coremodel/dashboard/coremodel.cue)
|
||||
//
|
||||
// The handwritten file for these type and default veneers is expected to be at
|
||||
// packages/grafana-schema/src/veneer/dashboard.types.ts.
|
||||
// This re-export declaration enforces that the handwritten veneer file exists,
|
||||
// and exports all the symbols in the list.
|
||||
//
|
||||
// TODO generate code such that tsc enforces type compatibility between raw and veneer decls
|
||||
export type { |
||||
Dashboard, |
||||
Panel, |
||||
FieldConfigSource, |
||||
FieldConfig |
||||
} from './veneer/dashboard.types'; |
||||
|
||||
// The following exported declarations correspond to types in the dashboard@0.0 schema with
|
||||
// attribute @grafana(TSVeneer="type"). (lineage declared in file: pkg/coremodel/dashboard/coremodel.cue)
|
||||
//
|
||||
// The handwritten file for these type and default veneers is expected to be at
|
||||
// packages/grafana-schema/src/veneer/dashboard.types.ts.
|
||||
// This re-export declaration enforces that the handwritten veneer file exists,
|
||||
// and exports all the symbols in the list.
|
||||
//
|
||||
// TODO generate code such that tsc enforces type compatibility between raw and veneer decls
|
||||
export { |
||||
defaultDashboard, |
||||
defaultPanel, |
||||
defaultFieldConfigSource, |
||||
defaultFieldConfig |
||||
} from './veneer/dashboard.types'; |
||||
@ -0,0 +1,676 @@ |
||||
// This file is autogenerated. DO NOT EDIT.
|
||||
//
|
||||
// Generated by pkg/framework/coremodel/gen.go
|
||||
//
|
||||
// Derived from the Thema lineage declared in pkg/coremodel/dashboard/coremodel.cue
|
||||
//
|
||||
// Run `make gen-cue` from repository root to regenerate.
|
||||
|
||||
/** |
||||
* TODO docs |
||||
* FROM: AnnotationQuery in grafana-data/src/types/annotations.ts |
||||
*/ |
||||
export interface AnnotationQuery { |
||||
builtIn: number; |
||||
/** |
||||
* Datasource to use for annotation. |
||||
*/ |
||||
datasource: { |
||||
type?: string; |
||||
uid?: string; |
||||
}; |
||||
/** |
||||
* Whether annotation is enabled. |
||||
*/ |
||||
enable: boolean; |
||||
/** |
||||
* Whether to hide annotation. |
||||
*/ |
||||
hide?: boolean; |
||||
/** |
||||
* Annotation icon color. |
||||
*/ |
||||
iconColor?: string; |
||||
/** |
||||
* Name of annotation. |
||||
*/ |
||||
name?: string; |
||||
/** |
||||
* Query for annotation data. |
||||
*/ |
||||
rawQuery?: string; |
||||
showIn: number; |
||||
target?: Record<string, unknown>; |
||||
type: string; |
||||
} |
||||
|
||||
export const defaultAnnotationQuery: Partial<AnnotationQuery> = { |
||||
builtIn: 0, |
||||
enable: true, |
||||
hide: false, |
||||
showIn: 0, |
||||
type: 'dashboard', |
||||
}; |
||||
|
||||
/** |
||||
* FROM: packages/grafana-data/src/types/templateVars.ts |
||||
* TODO docs |
||||
* TODO what about what's in public/app/features/types.ts? |
||||
* TODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction |
||||
*/ |
||||
export interface VariableModel { |
||||
label?: string; |
||||
name: string; |
||||
type: VariableType; |
||||
} |
||||
|
||||
/** |
||||
* FROM public/app/features/dashboard/state/DashboardModels.ts - ish |
||||
* TODO docs |
||||
*/ |
||||
export interface DashboardLink { |
||||
asDropdown: boolean; |
||||
icon?: string; |
||||
includeVars: boolean; |
||||
keepTime: boolean; |
||||
tags: Array<string>; |
||||
targetBlank: boolean; |
||||
title: string; |
||||
tooltip?: string; |
||||
type: DashboardLinkType; |
||||
url?: string; |
||||
} |
||||
|
||||
export const defaultDashboardLink: Partial<DashboardLink> = { |
||||
asDropdown: false, |
||||
includeVars: false, |
||||
keepTime: false, |
||||
tags: [], |
||||
targetBlank: false, |
||||
}; |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export type DashboardLinkType = ('link' | 'dashboards'); |
||||
|
||||
/** |
||||
* FROM: packages/grafana-data/src/types/templateVars.ts |
||||
* TODO docs |
||||
* TODO this implies some wider pattern/discriminated union, probably? |
||||
*/ |
||||
export type VariableType = ('query' | 'adhoc' | 'constant' | 'datasource' | 'interval' | 'textbox' | 'custom' | 'system'); |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export enum FieldColorModeId { |
||||
ContinuousGrYlRd = 'continuous-GrYlRd', |
||||
Fixed = 'fixed', |
||||
PaletteClassic = 'palette-classic', |
||||
PaletteSaturated = 'palette-saturated', |
||||
Thresholds = 'thresholds', |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export type FieldColorSeriesByMode = ('min' | 'max' | 'last'); |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface FieldColor { |
||||
/** |
||||
* Stores the fixed color value if mode is fixed |
||||
*/ |
||||
fixedColor?: string; |
||||
/** |
||||
* The main color scheme mode |
||||
*/ |
||||
mode: FieldColorModeId; |
||||
/** |
||||
* Some visualizations need to know how to assign a series color from by value color schemes |
||||
*/ |
||||
seriesBy?: FieldColorSeriesByMode; |
||||
} |
||||
|
||||
export interface GridPos { |
||||
/** |
||||
* Panel |
||||
*/ |
||||
h: number; |
||||
/** |
||||
* true if fixed |
||||
*/ |
||||
static?: boolean; |
||||
/** |
||||
* Panel |
||||
*/ |
||||
w: number; |
||||
/** |
||||
* Panel x |
||||
*/ |
||||
x: number; |
||||
/** |
||||
* Panel y |
||||
*/ |
||||
y: number; |
||||
} |
||||
|
||||
export const defaultGridPos: Partial<GridPos> = { |
||||
h: 9, |
||||
w: 12, |
||||
x: 0, |
||||
y: 0, |
||||
}; |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface Threshold { |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
color: string; |
||||
/** |
||||
* TODO docs |
||||
* TODO are the values here enumerable into a disjunction? |
||||
* Some seem to be listed in typescript comment |
||||
*/ |
||||
state?: string; |
||||
/** |
||||
* TODO docs |
||||
* FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON |
||||
*/ |
||||
value?: number; |
||||
} |
||||
|
||||
export enum ThresholdsMode { |
||||
Absolute = 'absolute', |
||||
Percentage = 'percentage', |
||||
} |
||||
|
||||
export interface ThresholdsConfig { |
||||
mode: ThresholdsMode; |
||||
/** |
||||
* Must be sorted by 'value', first value is always -Infinity |
||||
*/ |
||||
steps: Array<Threshold>; |
||||
} |
||||
|
||||
export const defaultThresholdsConfig: Partial<ThresholdsConfig> = { |
||||
steps: [], |
||||
}; |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export type ValueMapping = (ValueMap | RangeMap | RegexMap | SpecialValueMap); |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export enum MappingType { |
||||
RangeToText = 'range', |
||||
RegexToText = 'regex', |
||||
SpecialValue = 'special', |
||||
ValueToText = 'value', |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface ValueMap { |
||||
options: Record<string, unknown>; |
||||
type: MappingType.ValueToText; |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface RangeMap { |
||||
options: { |
||||
/** |
||||
* to and from are `number | null` in current ts, really not sure what to do |
||||
*/ |
||||
from: number; |
||||
to: number; |
||||
result: ValueMappingResult; |
||||
}; |
||||
type: MappingType.RangeToText; |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface RegexMap { |
||||
options: { |
||||
pattern: string; |
||||
result: ValueMappingResult; |
||||
}; |
||||
type: MappingType.RegexToText; |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface SpecialValueMap { |
||||
options: { |
||||
match: ('true' | 'false'); |
||||
pattern: string; |
||||
result: ValueMappingResult; |
||||
}; |
||||
type: MappingType.SpecialValue; |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export enum SpecialValueMatch { |
||||
Empty = 'empty', |
||||
False = 'false', |
||||
NaN = 'nan', |
||||
Null = 'null', |
||||
NullAndNan = 'null+nan', |
||||
True = 'true', |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
export interface ValueMappingResult { |
||||
color?: string; |
||||
icon?: string; |
||||
index?: number; |
||||
text?: string; |
||||
} |
||||
|
||||
/** |
||||
* TODO docs |
||||
* FIXME this is extremely underspecfied; wasn't obvious which typescript types corresponded to it |
||||
*/ |
||||
export interface Transformation { |
||||
id: string; |
||||
options: Record<string, unknown>; |
||||
} |
||||
|
||||
/** |
||||
* 0 for no shared crosshair or tooltip (default). |
||||
* 1 for shared crosshair. |
||||
* 2 for shared crosshair AND shared tooltip. |
||||
*/ |
||||
export enum DashboardCursorSync { |
||||
Crosshair = 1, |
||||
Off = 0, |
||||
Tooltip = 2, |
||||
} |
||||
|
||||
export const defaultDashboardCursorSync: DashboardCursorSync = DashboardCursorSync.Off; |
||||
|
||||
/** |
||||
* Dashboard panels. Panels are canonically defined inline |
||||
* because they share a version timeline with the dashboard |
||||
* schema; they do not evolve independently. |
||||
*/ |
||||
export interface Panel { |
||||
/** |
||||
* The datasource used in all targets. |
||||
*/ |
||||
datasource?: { |
||||
type?: string; |
||||
uid?: string; |
||||
}; |
||||
/** |
||||
* Description. |
||||
*/ |
||||
description?: string; |
||||
fieldConfig: FieldConfigSource; |
||||
/** |
||||
* Grid position. |
||||
*/ |
||||
gridPos?: GridPos; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
id?: number; |
||||
/** |
||||
* TODO docs |
||||
* TODO tighter constraint |
||||
*/ |
||||
interval?: string; |
||||
/** |
||||
* Panel links. |
||||
* TODO fill this out - seems there are a couple variants? |
||||
*/ |
||||
links?: Array<DashboardLink>; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
maxDataPoints?: number; |
||||
/** |
||||
* options is specified by the PanelOptions field in panel |
||||
* plugin schemas. |
||||
*/ |
||||
options: Record<string, unknown>; |
||||
/** |
||||
* FIXME this almost certainly has to be changed in favor of scuemata versions |
||||
*/ |
||||
pluginVersion?: string; |
||||
/** |
||||
* Name of template variable to repeat for. |
||||
*/ |
||||
repeat?: string; |
||||
/** |
||||
* Direction to repeat in if 'repeat' is set. |
||||
* "h" for horizontal, "v" for vertical. |
||||
*/ |
||||
repeatDirection: ('h' | 'v'); |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
tags?: Array<string>; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
targets?: Array<Record<string, unknown>>; |
||||
/** |
||||
* TODO docs - seems to be an old field from old dashboard alerts? |
||||
*/ |
||||
thresholds?: Array<any>; |
||||
/** |
||||
* TODO docs |
||||
* TODO tighter constraint |
||||
*/ |
||||
timeFrom?: string; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
timeRegions?: Array<any>; |
||||
/** |
||||
* TODO docs |
||||
* TODO tighter constraint |
||||
*/ |
||||
timeShift?: string; |
||||
/** |
||||
* Panel title. |
||||
*/ |
||||
title?: string; |
||||
transformations: Array<Transformation>; |
||||
/** |
||||
* Whether to display the panel without a background. |
||||
*/ |
||||
transparent: boolean; |
||||
/** |
||||
* The panel plugin type id. May not be empty. |
||||
*/ |
||||
type: string; |
||||
} |
||||
|
||||
export const defaultPanel: Partial<Panel> = { |
||||
links: [], |
||||
repeatDirection: 'h', |
||||
tags: [], |
||||
targets: [], |
||||
thresholds: [], |
||||
timeRegions: [], |
||||
transformations: [], |
||||
transparent: false, |
||||
}; |
||||
|
||||
export interface FieldConfigSource { |
||||
defaults: FieldConfig; |
||||
overrides: Array<{ |
||||
matcher: MatcherConfig; |
||||
properties: Array<{ |
||||
id: string; |
||||
value?: any; |
||||
}>; |
||||
}>; |
||||
} |
||||
|
||||
export const defaultFieldConfigSource: Partial<FieldConfigSource> = { |
||||
overrides: [], |
||||
}; |
||||
|
||||
export interface MatcherConfig { |
||||
id: string; |
||||
options?: any; |
||||
} |
||||
|
||||
export const defaultMatcherConfig: Partial<MatcherConfig> = { |
||||
id: '', |
||||
}; |
||||
|
||||
export interface FieldConfig { |
||||
/** |
||||
* Map values to a display color |
||||
*/ |
||||
color?: FieldColor; |
||||
/** |
||||
* custom is specified by the PanelFieldConfig field |
||||
* in panel plugin schemas. |
||||
*/ |
||||
custom?: Record<string, unknown>; |
||||
/** |
||||
* Significant digits (for display) |
||||
*/ |
||||
decimals?: number; |
||||
/** |
||||
* Human readable field metadata |
||||
*/ |
||||
description?: string; |
||||
/** |
||||
* The display value for this field. This supports template variables blank is auto |
||||
*/ |
||||
displayName?: string; |
||||
/** |
||||
* This can be used by data sources that return and explicit naming structure for values and labels |
||||
* When this property is configured, this value is used rather than the default naming strategy. |
||||
*/ |
||||
displayNameFromDS?: string; |
||||
/** |
||||
* True if data source field supports ad-hoc filters |
||||
*/ |
||||
filterable?: boolean; |
||||
/** |
||||
* The behavior when clicking on a result |
||||
*/ |
||||
links?: Array<any>; |
||||
/** |
||||
* Convert input values into a display string |
||||
*/ |
||||
mappings?: Array<ValueMapping>; |
||||
max?: number; |
||||
min?: number; |
||||
/** |
||||
* Alternative to empty string |
||||
*/ |
||||
noValue?: 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; |
||||
/** |
||||
* Map numeric values to states |
||||
*/ |
||||
thresholds?: ThresholdsConfig; |
||||
/** |
||||
* Numeric Options |
||||
*/ |
||||
unit?: string; |
||||
/** |
||||
* True if data source can write a value to the path. Auth/authz are supported separately |
||||
*/ |
||||
writeable?: boolean; |
||||
} |
||||
|
||||
export const defaultFieldConfig: Partial<FieldConfig> = { |
||||
links: [], |
||||
mappings: [], |
||||
}; |
||||
|
||||
/** |
||||
* Row panel |
||||
*/ |
||||
export interface RowPanel { |
||||
collapsed: boolean; |
||||
/** |
||||
* Name of default datasource. |
||||
*/ |
||||
datasource?: { |
||||
type?: string; |
||||
uid?: string; |
||||
}; |
||||
gridPos?: GridPos; |
||||
id: number; |
||||
panels: Array<(Panel | { |
||||
type: 'graph'; |
||||
} | { |
||||
type: 'heatmap'; |
||||
})>; |
||||
/** |
||||
* Name of template variable to repeat for. |
||||
*/ |
||||
repeat?: string; |
||||
title?: string; |
||||
type: 'row'; |
||||
} |
||||
|
||||
export const defaultRowPanel: Partial<RowPanel> = { |
||||
collapsed: false, |
||||
panels: [], |
||||
}; |
||||
|
||||
export interface Dashboard { |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
annotations?: { |
||||
list: Array<AnnotationQuery>; |
||||
}; |
||||
/** |
||||
* Description of dashboard. |
||||
*/ |
||||
description?: string; |
||||
/** |
||||
* Whether a dashboard is editable or not. |
||||
*/ |
||||
editable: boolean; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
fiscalYearStartMonth?: number; |
||||
gnetId?: string; |
||||
graphTooltip: DashboardCursorSync; |
||||
/** |
||||
* Unique numeric identifier for the dashboard. |
||||
* TODO must isolate or remove identifiers local to a Grafana instance...? |
||||
*/ |
||||
id?: number; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
links?: Array<DashboardLink>; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
liveNow?: boolean; |
||||
panels?: Array<(Panel | RowPanel | { |
||||
type: 'graph'; |
||||
} | { |
||||
type: 'heatmap'; |
||||
})>; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
refresh?: (string | false); |
||||
/** |
||||
* Version of the JSON schema, incremented each time a Grafana update brings |
||||
* changes to said schema. |
||||
* TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion |
||||
*/ |
||||
schemaVersion: number; |
||||
/** |
||||
* Theme of dashboard. |
||||
*/ |
||||
style: ('light' | 'dark'); |
||||
/** |
||||
* Tags associated with dashboard. |
||||
*/ |
||||
tags?: Array<string>; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
templating?: { |
||||
list: Array<VariableModel>; |
||||
}; |
||||
/** |
||||
* Time range for dashboard, e.g. last 6 hours, last 7 days, etc |
||||
*/ |
||||
time?: { |
||||
from: string; |
||||
to: string; |
||||
}; |
||||
/** |
||||
* TODO docs |
||||
* TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes |
||||
*/ |
||||
timepicker?: { |
||||
/** |
||||
* Whether timepicker is collapsed or not. |
||||
*/ |
||||
collapse: boolean; |
||||
/** |
||||
* Whether timepicker is enabled or not. |
||||
*/ |
||||
enable: boolean; |
||||
/** |
||||
* Whether timepicker is visible or not. |
||||
*/ |
||||
hidden: boolean; |
||||
/** |
||||
* Selectable intervals for auto-refresh. |
||||
*/ |
||||
refresh_intervals: Array<string>; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
time_options: Array<string>; |
||||
}; |
||||
/** |
||||
* Timezone of dashboard, |
||||
*/ |
||||
timezone?: ('browser' | 'utc' | ''); |
||||
/** |
||||
* Title of dashboard. |
||||
*/ |
||||
title?: string; |
||||
/** |
||||
* Unique dashboard identifier that can be generated by anyone. string (8-40) |
||||
*/ |
||||
uid?: string; |
||||
/** |
||||
* Version of the dashboard, incremented each time the dashboard is updated. |
||||
*/ |
||||
version?: number; |
||||
/** |
||||
* TODO docs |
||||
*/ |
||||
weekStart?: string; |
||||
} |
||||
|
||||
export const defaultDashboard: Partial<Dashboard> = { |
||||
editable: true, |
||||
graphTooltip: DashboardCursorSync.Off, |
||||
links: [], |
||||
panels: [], |
||||
schemaVersion: 36, |
||||
style: 'dark', |
||||
tags: [], |
||||
timezone: 'browser', |
||||
}; |
||||
@ -1,274 +0,0 @@ |
||||
// This file is autogenerated. DO NOT EDIT.
|
||||
//
|
||||
// Generated by pkg/framework/coremodel/gen.go
|
||||
//
|
||||
// Derived from the Thema lineage declared in pkg/coremodel/dashboard/coremodel.cue
|
||||
//
|
||||
// Run `make gen-cue` from repository root to regenerate.
|
||||
|
||||
|
||||
// This model is a WIP and not yet canonical. Consequently, its members are
|
||||
// not exported to exclude it from grafana-schema's public API surface.
|
||||
|
||||
interface AnnotationQuery { |
||||
builtIn: number; |
||||
datasource: { |
||||
type?: string; |
||||
uid?: string; |
||||
}; |
||||
enable: boolean; |
||||
hide?: boolean; |
||||
iconColor?: string; |
||||
name?: string; |
||||
rawQuery?: string; |
||||
showIn: number; |
||||
target?: {}; |
||||
type: string; |
||||
} |
||||
|
||||
const defaultAnnotationQuery: Partial<AnnotationQuery> = { |
||||
builtIn: 0, |
||||
enable: true, |
||||
hide: false, |
||||
showIn: 0, |
||||
type: 'dashboard', |
||||
}; |
||||
|
||||
interface VariableModel { |
||||
label?: string; |
||||
name: string; |
||||
type: VariableType; |
||||
} |
||||
|
||||
interface DashboardLink { |
||||
asDropdown: boolean; |
||||
icon?: string; |
||||
includeVars: boolean; |
||||
keepTime: boolean; |
||||
tags: string[]; |
||||
targetBlank: boolean; |
||||
title: string; |
||||
tooltip?: string; |
||||
type: DashboardLinkType; |
||||
url?: string; |
||||
} |
||||
|
||||
const defaultDashboardLink: Partial<DashboardLink> = { |
||||
asDropdown: false, |
||||
includeVars: false, |
||||
keepTime: false, |
||||
tags: [], |
||||
targetBlank: false, |
||||
}; |
||||
|
||||
type DashboardLinkType = ('link' | 'dashboards'); |
||||
|
||||
type VariableType = ('query' | 'adhoc' | 'constant' | 'datasource' | 'interval' | 'textbox' | 'custom' | 'system'); |
||||
|
||||
enum FieldColorModeId { |
||||
ContinuousGrYlRd = 'continuous-GrYlRd', |
||||
Fixed = 'fixed', |
||||
PaletteClassic = 'palette-classic', |
||||
PaletteSaturated = 'palette-saturated', |
||||
Thresholds = 'thresholds', |
||||
} |
||||
|
||||
type FieldColorSeriesByMode = ('min' | 'max' | 'last'); |
||||
|
||||
interface FieldColor { |
||||
fixedColor?: string; |
||||
mode: (FieldColorModeId | string); |
||||
seriesBy?: FieldColorSeriesByMode; |
||||
} |
||||
|
||||
interface GridPos { |
||||
h: number; |
||||
static?: boolean; |
||||
w: number; |
||||
x: number; |
||||
y: number; |
||||
} |
||||
|
||||
const defaultGridPos: Partial<GridPos> = { |
||||
h: 9, |
||||
w: 12, |
||||
x: 0, |
||||
y: 0, |
||||
}; |
||||
|
||||
interface Threshold { |
||||
color: string; |
||||
state?: string; |
||||
value?: number; |
||||
} |
||||
|
||||
enum ThresholdsMode { |
||||
Absolute = 'absolute', |
||||
Percentage = 'percentage', |
||||
} |
||||
|
||||
interface ThresholdsConfig { |
||||
mode: ThresholdsMode; |
||||
steps: Threshold[]; |
||||
} |
||||
|
||||
const defaultThresholdsConfig: Partial<ThresholdsConfig> = { |
||||
steps: [], |
||||
}; |
||||
|
||||
interface Transformation { |
||||
id: string; |
||||
options: {}; |
||||
} |
||||
|
||||
enum DashboardCursorSync { |
||||
Crosshair = 1, |
||||
Off = 0, |
||||
Tooltip = 2, |
||||
} |
||||
|
||||
const defaultDashboardCursorSync: DashboardCursorSync = DashboardCursorSync.Off; |
||||
|
||||
interface Panel { |
||||
datasource?: { |
||||
type?: string; |
||||
uid?: string; |
||||
}; |
||||
description?: string; |
||||
fieldConfig: { |
||||
defaults: { |
||||
displayName?: string; |
||||
displayNameFromDS?: string; |
||||
description?: string; |
||||
path?: string; |
||||
writeable?: boolean; |
||||
filterable?: boolean; |
||||
unit?: string; |
||||
decimals?: number; |
||||
min?: number; |
||||
max?: number; |
||||
mappings?: {}[]; |
||||
thresholds?: ThresholdsConfig; |
||||
color?: FieldColor; |
||||
links?: any[]; |
||||
noValue?: string; |
||||
custom?: {}; |
||||
}; |
||||
overrides: { |
||||
matcher: { |
||||
id: string; |
||||
options?: any; |
||||
}; |
||||
properties: { |
||||
id: string; |
||||
value?: any; |
||||
}[]; |
||||
}[]; |
||||
}; |
||||
gridPos?: GridPos; |
||||
id?: number; |
||||
interval?: string; |
||||
links?: DashboardLink[]; |
||||
maxDataPoints?: number; |
||||
options: {}; |
||||
pluginVersion?: string; |
||||
repeat?: string; |
||||
repeatDirection: ('h' | 'v'); |
||||
tags?: string[]; |
||||
targets?: {}[]; |
||||
thresholds?: any[]; |
||||
timeFrom?: string; |
||||
timeRegions?: any[]; |
||||
timeShift?: string; |
||||
title?: string; |
||||
transformations: Transformation[]; |
||||
transparent: boolean; |
||||
type: string; |
||||
} |
||||
|
||||
const defaultPanel: Partial<Panel> = { |
||||
links: [], |
||||
repeatDirection: 'h', |
||||
tags: [], |
||||
targets: [], |
||||
thresholds: [], |
||||
timeRegions: [], |
||||
transformations: [], |
||||
transparent: false, |
||||
}; |
||||
|
||||
interface RowPanel { |
||||
collapsed: boolean; |
||||
datasource?: { |
||||
type?: string; |
||||
uid?: string; |
||||
}; |
||||
gridPos?: GridPos; |
||||
id: number; |
||||
panels: (Panel | { |
||||
type: 'graph'; |
||||
} | { |
||||
type: 'heatmap'; |
||||
})[]; |
||||
repeat?: string; |
||||
title?: string; |
||||
type: 'row'; |
||||
} |
||||
|
||||
const defaultRowPanel: Partial<RowPanel> = { |
||||
collapsed: false, |
||||
panels: [], |
||||
}; |
||||
|
||||
interface Dashboard { |
||||
annotations?: { |
||||
list: AnnotationQuery[]; |
||||
}; |
||||
description?: string; |
||||
editable: boolean; |
||||
fiscalYearStartMonth?: number; |
||||
gnetId?: string; |
||||
graphTooltip: DashboardCursorSync; |
||||
id?: number; |
||||
links?: DashboardLink[]; |
||||
liveNow?: boolean; |
||||
panels?: (Panel | RowPanel | { |
||||
type: 'graph'; |
||||
} | { |
||||
type: 'heatmap'; |
||||
})[]; |
||||
refresh?: (string | false); |
||||
schemaVersion: number; |
||||
style: ('light' | 'dark'); |
||||
tags?: string[]; |
||||
templating?: { |
||||
list: VariableModel[]; |
||||
}; |
||||
time?: { |
||||
from: string; |
||||
to: string; |
||||
}; |
||||
timepicker?: { |
||||
collapse: boolean; |
||||
enable: boolean; |
||||
hidden: boolean; |
||||
refresh_intervals: string[]; |
||||
time_options: string[]; |
||||
}; |
||||
timezone?: ('browser' | 'utc' | ''); |
||||
title?: string; |
||||
uid?: string; |
||||
version?: number; |
||||
weekStart?: string; |
||||
} |
||||
|
||||
const defaultDashboard: Partial<Dashboard> = { |
||||
editable: true, |
||||
graphTooltip: DashboardCursorSync.Off, |
||||
links: [], |
||||
panels: [], |
||||
schemaVersion: 36, |
||||
style: 'dark', |
||||
tags: [], |
||||
timezone: 'browser', |
||||
}; |
||||
@ -0,0 +1,32 @@ |
||||
import * as raw from '../raw/dashboard/x/dashboard.gen'; |
||||
|
||||
export interface Dashboard extends raw.Dashboard { |
||||
panels?: Array< |
||||
| Panel |
||||
| raw.RowPanel |
||||
| { |
||||
type: 'graph'; |
||||
} |
||||
| { |
||||
type: 'heatmap'; |
||||
} |
||||
>; |
||||
} |
||||
|
||||
export interface Panel<TOptions = Record<string, unknown>, TCustomFieldConfig = Record<string, unknown>> |
||||
extends raw.Panel { |
||||
fieldConfig: FieldConfigSource<TCustomFieldConfig>; |
||||
} |
||||
|
||||
export interface FieldConfig<TOptions = Record<string, unknown>> extends raw.FieldConfig { |
||||
custom?: TOptions & Record<string, unknown>; |
||||
} |
||||
|
||||
export interface FieldConfigSource<TOptions = Record<string, unknown>> extends raw.FieldConfigSource { |
||||
defaults: FieldConfig<TOptions>; |
||||
} |
||||
|
||||
export const defaultDashboard: Partial<Dashboard> = raw.defaultDashboard; |
||||
export const defaultPanel: Partial<Panel> = raw.defaultPanel; |
||||
export const defaultFieldConfig: Partial<FieldConfig> = raw.defaultFieldConfig; |
||||
export const defaultFieldConfigSource: Partial<FieldConfigSource> = raw.defaultFieldConfigSource; |
||||
@ -1,7 +1,2 @@ |
||||
{{ template "autogen_header.tmpl" .Header -}} |
||||
{{range .Imports}} |
||||
import * as {{.Ident}} from '{{.Pkg}}';{{end}} |
||||
{{range .Sections}}{{if ne .ModelName "" }} |
||||
export const {{.ModelName}}ModelVersion = Object.freeze([{{index .V 0}}, {{index .V 1}}]); |
||||
{{end}} |
||||
{{.Body}}{{end}} |
||||
{{ .Body }} |
||||
|
||||
Loading…
Reference in new issue