@grafana/plugin-types 0.0.47 → 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.
|
@@ -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,25 +54,48 @@ 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
|
+
*/
|
|
64
79
|
export interface EntityPropertyInfo {
|
|
80
|
+
/** The property identifier used to search connected non-direct entities. */
|
|
65
81
|
propertyId: string;
|
|
82
|
+
/** The filter operation to apply to the property. */
|
|
66
83
|
op: EntityFilterOperation;
|
|
67
84
|
}
|
|
85
|
+
/**
|
|
86
|
+
* Describes how an entity is connected through another entity type, with optional scope and property links.
|
|
87
|
+
*/
|
|
68
88
|
export type ConnectedEntityThrough = {
|
|
89
|
+
/** The type of the connecting entity. */
|
|
69
90
|
type: string;
|
|
91
|
+
/** Optional criteria for filtering by scope. */
|
|
70
92
|
scopeCriteria?: ScopeCriteria;
|
|
93
|
+
/** Optional property links for the connection. */
|
|
71
94
|
propertyLinks?: EntityPropertyInfo[];
|
|
72
95
|
};
|
|
96
|
+
/**
|
|
97
|
+
* Represents a type of entity that can be connected, with optional scope and connection details.
|
|
98
|
+
*/
|
|
73
99
|
export type ConnectedEntityType = {
|
|
74
100
|
type: string;
|
|
75
101
|
scopeCriteria?: ScopeCriteria;
|