@grafana/plugin-types 0.0.13 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,74 @@
1
1
  // Generated by dts-bundle-generator v9.5.1
2
2
 
3
3
  export type ComponentSize = "xs" | "sm" | "md" | "lg";
4
- declare enum StringRules {
4
+ /**
5
+ * Generated by orval v7.9.0 🍺
6
+ * Do not edit manually.
7
+ * Entity Graph API
8
+ * OpenAPI spec version: 1.0.0
9
+ */
10
+ /**
11
+ * @pattern ^[1-9][0-9]*$
12
+ */
13
+ export type EntityId = string;
14
+ /**
15
+ * Generated by orval v7.9.0 🍺
16
+ * Do not edit manually.
17
+ * Entity Graph API
18
+ * OpenAPI spec version: 1.0.0
19
+ */
20
+ export type EntityProperty = string | number;
21
+ /**
22
+ * Generated by orval v7.9.0 🍺
23
+ * Do not edit manually.
24
+ * Entity Graph API
25
+ * OpenAPI spec version: 1.0.0
26
+ */
27
+ export type EntitySummaryScope = {
28
+ [key: string]: string;
29
+ };
30
+ /**
31
+ * Generated by orval v7.9.0 🍺
32
+ * Do not edit manually.
33
+ * Entity Graph API
34
+ * OpenAPI spec version: 1.0.0
35
+ */
36
+ export type EntitySummaryProperties = {
37
+ [key: string]: EntityProperty;
38
+ };
39
+ export interface EntityParent {
40
+ id?: EntityId;
41
+ name?: string;
42
+ type?: string;
43
+ }
44
+ export interface Entity {
45
+ id?: EntityId;
46
+ type?: string;
47
+ name?: string;
48
+ active?: boolean;
49
+ scope?: EntitySummaryScope;
50
+ properties?: EntitySummaryProperties;
51
+ connectedEntityTypes?: string[];
52
+ parentEntity?: EntityParent;
53
+ connectedEntities?: Entity[];
54
+ }
55
+ declare enum EntityFilterOperation {
56
+ EQUALS = "eq",
57
+ NOT_EQUALS = "neq",
58
+ STARTS_WITH = "starts_with",
59
+ CONTAINS = "contains",
60
+ IsNull = "is_null"
61
+ }
62
+ export interface EntityFilterParameter {
63
+ op: EntityFilterOperation;
64
+ value: string | true | false;
65
+ }
66
+ export interface ScopeCriteria {
67
+ env?: EntityFilterParameter[];
68
+ site?: EntityFilterParameter[];
69
+ namespace?: EntityFilterParameter[];
70
+ }
71
+ export declare enum StringRules {
5
72
  EQUALS = "=",
6
73
  NOT_EQUALS = "<>",
7
74
  STARTS_WITH = "STARTS WITH",
@@ -9,7 +76,7 @@ declare enum StringRules {
9
76
  IS_NULL = "IS NULL",
10
77
  IS_NOT_NULL = "IS NOT NULL"
11
78
  }
12
- declare enum NumberRules {
79
+ export declare enum NumberRules {
13
80
  EQUALS = "=",
14
81
  NOT_EQUALS = "<>",
15
82
  GREATER = ">",
@@ -23,27 +90,24 @@ export declare enum EntityPropertyTypes {
23
90
  STRING = "String",
24
91
  DOUBLE = "Double"
25
92
  }
93
+ export interface EntityFilterPropertyMatcher {
94
+ id: number;
95
+ name: string;
96
+ value: string | number;
97
+ op: StringRules | NumberRules;
98
+ type: EntityPropertyTypes;
99
+ uom?: string | null;
100
+ }
26
101
  export interface EntityAssertionsWidgetProps {
27
- query: {
28
- additionalMatchers?: {
29
- id: number;
30
- name: string;
31
- value: string | number;
32
- op: StringRules | NumberRules;
33
- type: EntityPropertyTypes;
34
- uom?: string | null;
35
- }[];
36
- enabled: boolean;
37
- matchAllNames?: boolean;
38
- entityName?: string;
39
- entityType?: string;
40
- start: number;
41
- end: number;
42
- scope?: Scope;
43
- };
102
+ query: useMultipleEntitiesProps;
44
103
  size?: ComponentSize;
45
104
  source?: string;
46
105
  }
106
+ export interface useMultipleEntitiesProps extends UseEntityParams {
107
+ additionalMatchers?: EntityFilterPropertyMatcher[];
108
+ enabled: boolean;
109
+ matchAllNames?: boolean;
110
+ }
47
111
  export interface UseEntityParams {
48
112
  entityName?: string;
49
113
  entityType?: string;
@@ -56,3 +120,31 @@ export interface Scope {
56
120
  site?: string;
57
121
  namespace?: string;
58
122
  }
123
+ /********************** Entity Cross Link ***********/
124
+ export declare enum EntityCrossLinkType {
125
+ K8S_NODE = "k8s_node",
126
+ EC2_INSTANCE = "ec2_instance",
127
+ RDS_INSTANCE = "rds_instance",
128
+ MYSQL_INSTANCE = "mysql_instance",
129
+ UNKNOWN = "unknown"
130
+ }
131
+ export type DrawerViewProps = {
132
+ entity: Entity;
133
+ start: string;
134
+ end: string;
135
+ };
136
+ export type ConnectedEntityType = {
137
+ type: string;
138
+ scopeCriteria?: ScopeCriteria;
139
+ };
140
+ export interface EntityCrossLinkWidgetProps {
141
+ entityName?: string;
142
+ entityType: string;
143
+ start: string;
144
+ end: string;
145
+ connectToEntityTypes?: Array<ConnectedEntityType | string>;
146
+ scopeCriteria?: ScopeCriteria;
147
+ backTo?: string;
148
+ onConnectedEntityClick?: (entity: Entity) => void;
149
+ drawerView?: (props: DrawerViewProps) => JSX.Element;
150
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@grafana/plugin-types",
3
- "version": "0.0.13",
3
+ "version": "0.0.15",
4
4
  "description": "NPM package consisting of various Grafana plugins exposed types.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Grafana Labs",