@grafana/plugin-types 0.0.46 → 0.0.48

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,7 @@
1
1
  // Generated by dts-bundle-generator v9.5.1
2
2
 
3
3
  /**
4
- * Generated by orval v7.9.0 🍺
4
+ * Generated by orval v8.0.0-rc.2 🍺
5
5
  * Do not edit manually.
6
6
  * Entity Graph API
7
7
  * OpenAPI spec version: 1.0.0
@@ -11,14 +11,14 @@
11
11
  */
12
12
  export type EntityId = string;
13
13
  /**
14
- * Generated by orval v7.9.0 🍺
14
+ * Generated by orval v8.0.0-rc.2 🍺
15
15
  * Do not edit manually.
16
16
  * Entity Graph API
17
17
  * OpenAPI spec version: 1.0.0
18
18
  */
19
19
  export type EntityProperty = string | number;
20
20
  /**
21
- * Generated by orval v7.9.0 🍺
21
+ * Generated by orval v8.0.0-rc.2 🍺
22
22
  * Do not edit manually.
23
23
  * Entity Graph API
24
24
  * OpenAPI spec version: 1.0.0
@@ -27,7 +27,7 @@ export type EntitySummaryScope = {
27
27
  [key: string]: string;
28
28
  };
29
29
  /**
30
- * Generated by orval v7.9.0 🍺
30
+ * Generated by orval v8.0.0-rc.2 🍺
31
31
  * Do not edit manually.
32
32
  * Entity Graph API
33
33
  * OpenAPI spec version: 1.0.0
@@ -40,6 +40,9 @@ export interface EntityParent {
40
40
  name?: string;
41
41
  type?: string;
42
42
  }
43
+ /**
44
+ * Represents an entity with its properties, relationships, and metadata.
45
+ */
43
46
  export interface Entity {
44
47
  id?: EntityId;
45
48
  type?: string;
@@ -51,16 +54,53 @@ export interface Entity {
51
54
  parentEntity?: EntityParent;
52
55
  connectedEntities?: Entity[];
53
56
  }
57
+ /**
58
+ * Supported filter operations for entity properties.
59
+ */
54
60
  export type EntityFilterOperation = "eq" | "neq" | "starts_with" | "contains" | "is_null";
61
+ /**
62
+ * Represents a filter parameter for an entity property.
63
+ */
55
64
  export interface EntityFilterParameter {
56
65
  op: EntityFilterOperation;
57
66
  value: string | true | false;
58
67
  }
68
+ /**
69
+ * Criteria for filtering entities by scope (environment, site, namespace).
70
+ */
59
71
  export interface ScopeCriteria {
60
72
  env?: EntityFilterParameter[];
61
73
  site?: EntityFilterParameter[];
62
74
  namespace?: EntityFilterParameter[];
63
75
  }
76
+ /**
77
+ * Information about a property and the operation to filter by.
78
+ */
79
+ export interface EntityPropertyInfo {
80
+ /** The property identifier used to search connected non-direct entities. */
81
+ propertyId: string;
82
+ /** The filter operation to apply to the property. */
83
+ op: EntityFilterOperation;
84
+ }
85
+ /**
86
+ * Describes how an entity is connected through another entity type, with optional scope and property links.
87
+ */
88
+ export type ConnectedEntityThrough = {
89
+ /** The type of the connecting entity. */
90
+ type: string;
91
+ /** Optional criteria for filtering by scope. */
92
+ scopeCriteria?: ScopeCriteria;
93
+ /** Optional property links for the connection. */
94
+ propertyLinks?: EntityPropertyInfo[];
95
+ };
96
+ /**
97
+ * Represents a type of entity that can be connected, with optional scope and connection details.
98
+ */
99
+ export type ConnectedEntityType = {
100
+ type: string;
101
+ scopeCriteria?: ScopeCriteria;
102
+ through?: ConnectedEntityThrough;
103
+ };
64
104
  export declare enum StringRules {
65
105
  EQUALS = "=",
66
106
  NOT_EQUALS = "<>",
@@ -91,11 +131,58 @@ export interface EntityFilterPropertyMatcher {
91
131
  type: EntityPropertyTypes;
92
132
  uom?: string | null;
93
133
  }
134
+ export interface EntityAssertion {
135
+ severity?: AssertionSeverity;
136
+ amend?: boolean;
137
+ assertions?: {
138
+ assertionName: string;
139
+ severity: AssertionSeverity;
140
+ category: string;
141
+ entityType: string;
142
+ }[];
143
+ }
144
+ export type EntityProperties = Partial<Record<string, string | number>> & {
145
+ _created?: number;
146
+ _updated?: number;
147
+ };
148
+ export interface Edge {
149
+ destination: number;
150
+ id: number;
151
+ active?: boolean;
152
+ properties: {
153
+ _rel_source?: string;
154
+ _created: number;
155
+ _updated: number;
156
+ cardinality: string;
157
+ };
158
+ source: number;
159
+ type: string;
160
+ trafficPresent: boolean;
161
+ callsPerMinute: number | undefined;
162
+ }
163
+ interface Entity$1 {
164
+ id: number;
165
+ name: string;
166
+ type: string;
167
+ assertion: EntityAssertion | undefined;
168
+ connectedAssertion: EntityAssertion | undefined;
169
+ properties: EntityProperties;
170
+ connectedEntityTypes?: Record<string, number>;
171
+ scope: Scope | undefined;
172
+ parentEntityId?: number;
173
+ edgeWithActiveElement?: Edge;
174
+ }
94
175
  export interface EntityAssertionsWidgetProps {
95
176
  query: useMultipleEntitiesProps;
96
177
  size?: "xs" | "sm" | "md" | "lg";
97
178
  source?: string;
98
179
  returnToPrevious?: boolean;
180
+ additionalClickHandlers?: {
181
+ onOpenPopoverClick?: () => void;
182
+ onClosePopoverClick?: () => void;
183
+ onConnectedEntitiesClick?: (entity: Entity$1) => void;
184
+ onOpenInRCAWorkbenchClick?: (entities: Entity$1[]) => void;
185
+ };
99
186
  }
100
187
  export interface useMultipleEntitiesProps extends UseMultiEntityTypeParams {
101
188
  additionalMatchers?: EntityFilterPropertyMatcher[];
@@ -138,10 +225,6 @@ export type DrawerViewProps = {
138
225
  end: string;
139
226
  };
140
227
  export type DrawerSize = "sm" | "md" | "lg";
141
- export type ConnectedEntityType = {
142
- type: string;
143
- scopeCriteria?: ScopeCriteria;
144
- };
145
228
  export interface EntityCrossLinkWidgetProps {
146
229
  entityName?: string;
147
230
  entityType: string;
@@ -165,3 +248,7 @@ export interface RelatedEntitiesWidgetProps {
165
248
  start: number | string;
166
249
  end: number | string;
167
250
  }
251
+
252
+ export {
253
+ Entity$1 as Entity,
254
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@grafana/plugin-types",
3
- "version": "0.0.46",
3
+ "version": "0.0.48",
4
4
  "description": "NPM package consisting of various Grafana plugins exposed types.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Grafana Labs",