@dx-do/client 7.6.0 → 7.7.0
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.
- package/dist/index.cjs.js +24291 -23493
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +24262 -23494
- package/dist/index.esm.js.map +1 -1
- package/dist/src/lib/model/alarm/alarm-queue.d.ts +390 -39
- package/dist/src/lib/model/alarm/alarm-queue.d.ts.map +1 -1
- package/dist/src/lib/model/channel/notify-channel-testing.d.ts +2 -2
- package/dist/src/lib/model/curl/Curl.d.ts.map +1 -1
- package/dist/src/lib/model/datastore/audit/response.d.ts +7 -2
- package/dist/src/lib/model/datastore/audit/response.d.ts.map +1 -1
- package/dist/src/lib/model/postman/Postman.d.ts.map +1 -1
- package/dist/src/lib/services/alarm.service.d.ts +65 -12
- package/dist/src/lib/services/alarm.service.d.ts.map +1 -1
- package/dist/src/lib/services/datastore/datastore-audit.service.d.ts +9 -1
- package/dist/src/lib/services/datastore/datastore-audit.service.d.ts.map +1 -1
- package/dist/src/lib/services/dx-saas.service.d.ts +12 -1
- package/dist/src/lib/services/dx-saas.service.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,41 +1,392 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
1
|
+
import { z } from 'zod/v4';
|
|
2
|
+
import type { PolicyFilterAtom, PolicyFilterExpression } from '../channel/notify-policy-template';
|
|
3
|
+
/**
|
|
4
|
+
* Alarm queues — the UI name for `oi/v2/api/alarmfilters` ("alarm filters"):
|
|
5
|
+
* saved alarm searches with display preferences, personal to their creator or
|
|
6
|
+
* owned by a role and shared to other roles. Shapes and defaults below are the
|
|
7
|
+
* key sets the DXO2 UI sends and receives, observed in HAR captures on the lab
|
|
8
|
+
* tenant (create x2, update, pin, list, detail; delete read live from DevTools).
|
|
9
|
+
*
|
|
10
|
+
* The filter expression is the same and/or tree notification policies use
|
|
11
|
+
* (`filterExpressionV1`), so the atom / expression schemas are shared with
|
|
12
|
+
* `../channel/notify-policy-template`.
|
|
13
|
+
*/
|
|
14
|
+
export type AlarmQueueFilterAtom = PolicyFilterAtom;
|
|
15
|
+
export type AlarmQueueFilterExpression = PolicyFilterExpression;
|
|
16
|
+
export declare const ALARM_QUEUE_FILTER_SETTING_KEYS: readonly ["displayclosedalarms", "alarmsPartOfSituations", "displayMaintenanceAlarms", "displayAlgorithmicSituations", "expandVisualizations", "autoRefreshAlarms"];
|
|
17
|
+
export type AlarmQueueFilterSettingKey = (typeof ALARM_QUEUE_FILTER_SETTING_KEYS)[number];
|
|
18
|
+
export declare const AlarmQueueFilterSettingsSchema: z.ZodObject<{
|
|
19
|
+
displayclosedalarms: z.ZodBoolean;
|
|
20
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
21
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
22
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
23
|
+
expandVisualizations: z.ZodBoolean;
|
|
24
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
25
|
+
}, z.core.$loose>;
|
|
26
|
+
export type AlarmQueueFilterSettings = z.infer<typeof AlarmQueueFilterSettingsSchema>;
|
|
27
|
+
export declare const ALARM_QUEUE_DEFAULT_FILTER_SETTINGS: AlarmQueueFilterSettings;
|
|
28
|
+
/** One alarm queue as the list and detail reads return it. */
|
|
29
|
+
export declare const AlarmQueueSchema: z.ZodObject<{
|
|
30
|
+
id: z.ZodString;
|
|
31
|
+
filterName: z.ZodString;
|
|
32
|
+
alarmCategory: z.ZodString;
|
|
33
|
+
personal: z.ZodOptional<z.ZodBoolean>;
|
|
34
|
+
ownerRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
35
|
+
sharedToRoles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
36
|
+
isPinned: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
37
|
+
isDefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
38
|
+
createdBy: z.ZodOptional<z.ZodString>;
|
|
39
|
+
updatedBy: z.ZodOptional<z.ZodString>;
|
|
40
|
+
creationTime: z.ZodOptional<z.ZodString>;
|
|
41
|
+
lastUpdated: z.ZodOptional<z.ZodString>;
|
|
42
|
+
rank: z.ZodOptional<z.ZodString>;
|
|
43
|
+
groupSelected: z.ZodOptional<z.ZodBoolean>;
|
|
44
|
+
isComplexFilter: z.ZodOptional<z.ZodBoolean>;
|
|
45
|
+
displayColumns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
|
|
46
|
+
columnOrder: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
47
|
+
columnPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
48
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
49
|
+
}, z.core.$loose>>>;
|
|
50
|
+
columnSize: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
|
|
51
|
+
pinnedColumns: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
|
|
52
|
+
sortColumn: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
53
|
+
sharePreferences: z.ZodOptional<z.ZodBoolean>;
|
|
54
|
+
defaultRoleData: z.ZodOptional<z.ZodUnknown>;
|
|
55
|
+
filterSettings: z.ZodOptional<z.ZodObject<{
|
|
56
|
+
displayclosedalarms: z.ZodBoolean;
|
|
57
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
58
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
59
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
60
|
+
expandVisualizations: z.ZodBoolean;
|
|
61
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
62
|
+
}, z.core.$loose>>;
|
|
63
|
+
}, z.core.$loose>;
|
|
64
|
+
export type AlarmQueue = z.infer<typeof AlarmQueueSchema>;
|
|
65
|
+
/** Sharing as the reads report it; older list reads omit `personal`, so the owner role decides. */
|
|
66
|
+
export declare function isPersonalQueue(queue: Pick<AlarmQueue, 'personal' | 'ownerRole'>): boolean;
|
|
67
|
+
/** The detail read answers 200 with an id-less body when the queue does not exist (e.g. after a delete). */
|
|
68
|
+
export declare function isAlarmQueueNotFound(raw: unknown): boolean;
|
|
69
|
+
/** The detail read (`_search?id=`) adds the filter expression. */
|
|
70
|
+
export declare const AlarmQueueDetailSchema: z.ZodObject<{
|
|
71
|
+
id: z.ZodString;
|
|
72
|
+
filterName: z.ZodString;
|
|
73
|
+
alarmCategory: z.ZodString;
|
|
74
|
+
personal: z.ZodOptional<z.ZodBoolean>;
|
|
75
|
+
ownerRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
76
|
+
sharedToRoles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
77
|
+
isPinned: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
78
|
+
isDefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
79
|
+
createdBy: z.ZodOptional<z.ZodString>;
|
|
80
|
+
updatedBy: z.ZodOptional<z.ZodString>;
|
|
81
|
+
creationTime: z.ZodOptional<z.ZodString>;
|
|
82
|
+
lastUpdated: z.ZodOptional<z.ZodString>;
|
|
83
|
+
rank: z.ZodOptional<z.ZodString>;
|
|
84
|
+
groupSelected: z.ZodOptional<z.ZodBoolean>;
|
|
85
|
+
isComplexFilter: z.ZodOptional<z.ZodBoolean>;
|
|
86
|
+
displayColumns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
|
|
87
|
+
columnOrder: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
88
|
+
columnPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
89
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
90
|
+
}, z.core.$loose>>>;
|
|
91
|
+
columnSize: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
|
|
92
|
+
pinnedColumns: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
|
|
93
|
+
sortColumn: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
94
|
+
sharePreferences: z.ZodOptional<z.ZodBoolean>;
|
|
95
|
+
defaultRoleData: z.ZodOptional<z.ZodUnknown>;
|
|
96
|
+
filterSettings: z.ZodOptional<z.ZodObject<{
|
|
97
|
+
displayclosedalarms: z.ZodBoolean;
|
|
98
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
99
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
100
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
101
|
+
expandVisualizations: z.ZodBoolean;
|
|
102
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
103
|
+
}, z.core.$loose>>;
|
|
104
|
+
filterExpressions: z.ZodType<PolicyFilterExpression, unknown, z.core.$ZodTypeInternals<PolicyFilterExpression, unknown>>;
|
|
105
|
+
}, z.core.$loose>;
|
|
106
|
+
export type AlarmQueueDetail = z.infer<typeof AlarmQueueDetailSchema>;
|
|
107
|
+
/** `GET oi/v2/api/alarmfilters/_search`: the queues visible to the caller. */
|
|
108
|
+
export declare const AlarmQueueListResponseSchema: z.ZodObject<{
|
|
109
|
+
alarmFilters: z.ZodArray<z.ZodObject<{
|
|
110
|
+
id: z.ZodString;
|
|
111
|
+
filterName: z.ZodString;
|
|
112
|
+
alarmCategory: z.ZodString;
|
|
113
|
+
personal: z.ZodOptional<z.ZodBoolean>;
|
|
114
|
+
ownerRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
115
|
+
sharedToRoles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
116
|
+
isPinned: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
117
|
+
isDefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
118
|
+
createdBy: z.ZodOptional<z.ZodString>;
|
|
119
|
+
updatedBy: z.ZodOptional<z.ZodString>;
|
|
120
|
+
creationTime: z.ZodOptional<z.ZodString>;
|
|
121
|
+
lastUpdated: z.ZodOptional<z.ZodString>;
|
|
122
|
+
rank: z.ZodOptional<z.ZodString>;
|
|
123
|
+
groupSelected: z.ZodOptional<z.ZodBoolean>;
|
|
124
|
+
isComplexFilter: z.ZodOptional<z.ZodBoolean>;
|
|
125
|
+
displayColumns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
|
|
126
|
+
columnOrder: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
127
|
+
columnPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
128
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
129
|
+
}, z.core.$loose>>>;
|
|
130
|
+
columnSize: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
|
|
131
|
+
pinnedColumns: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
|
|
132
|
+
sortColumn: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
133
|
+
sharePreferences: z.ZodOptional<z.ZodBoolean>;
|
|
134
|
+
defaultRoleData: z.ZodOptional<z.ZodUnknown>;
|
|
135
|
+
filterSettings: z.ZodOptional<z.ZodObject<{
|
|
136
|
+
displayclosedalarms: z.ZodBoolean;
|
|
137
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
138
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
139
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
140
|
+
expandVisualizations: z.ZodBoolean;
|
|
141
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
142
|
+
}, z.core.$loose>>;
|
|
143
|
+
}, z.core.$loose>>;
|
|
144
|
+
}, z.core.$loose>;
|
|
145
|
+
export type AlarmQueueListResponse = z.infer<typeof AlarmQueueListResponseSchema>;
|
|
146
|
+
/**
|
|
147
|
+
* `GET oi/v2/api/allalarmfilters`: shared queues with their expressions
|
|
148
|
+
* inlined. When nothing matches the server answers 200 with a message body
|
|
149
|
+
* and no `alarmFilters` key.
|
|
150
|
+
*/
|
|
151
|
+
export declare const AllAlarmQueuesResponseSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
152
|
+
alarmFilters: z.ZodArray<z.ZodObject<{
|
|
153
|
+
id: z.ZodString;
|
|
154
|
+
filterName: z.ZodString;
|
|
155
|
+
alarmCategory: z.ZodString;
|
|
156
|
+
personal: z.ZodOptional<z.ZodBoolean>;
|
|
157
|
+
ownerRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
158
|
+
sharedToRoles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
159
|
+
isPinned: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
160
|
+
isDefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
161
|
+
createdBy: z.ZodOptional<z.ZodString>;
|
|
162
|
+
updatedBy: z.ZodOptional<z.ZodString>;
|
|
163
|
+
creationTime: z.ZodOptional<z.ZodString>;
|
|
164
|
+
lastUpdated: z.ZodOptional<z.ZodString>;
|
|
165
|
+
rank: z.ZodOptional<z.ZodString>;
|
|
166
|
+
groupSelected: z.ZodOptional<z.ZodBoolean>;
|
|
167
|
+
isComplexFilter: z.ZodOptional<z.ZodBoolean>;
|
|
168
|
+
displayColumns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
|
|
169
|
+
columnOrder: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
170
|
+
columnPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
171
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
172
|
+
}, z.core.$loose>>>;
|
|
173
|
+
columnSize: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
|
|
174
|
+
pinnedColumns: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
|
|
175
|
+
sortColumn: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
176
|
+
sharePreferences: z.ZodOptional<z.ZodBoolean>;
|
|
177
|
+
defaultRoleData: z.ZodOptional<z.ZodUnknown>;
|
|
178
|
+
filterSettings: z.ZodOptional<z.ZodObject<{
|
|
179
|
+
displayclosedalarms: z.ZodBoolean;
|
|
180
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
181
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
182
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
183
|
+
expandVisualizations: z.ZodBoolean;
|
|
184
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
185
|
+
}, z.core.$loose>>;
|
|
186
|
+
filterExpressions: z.ZodType<PolicyFilterExpression, unknown, z.core.$ZodTypeInternals<PolicyFilterExpression, unknown>>;
|
|
187
|
+
}, z.core.$loose>>;
|
|
188
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
189
|
+
message: z.ZodString;
|
|
190
|
+
}, z.core.$loose>]>;
|
|
191
|
+
export type AllAlarmQueuesResponse = z.infer<typeof AllAlarmQueuesResponseSchema>;
|
|
192
|
+
/** Normalizes the two `allalarmfilters` shapes to a plain array. */
|
|
193
|
+
export declare function allAlarmQueues(raw: AllAlarmQueuesResponse): AlarmQueueDetail[];
|
|
194
|
+
/**
|
|
195
|
+
* One entry of `GET oi/v2/api/alarms/fields`, the field catalog the queue
|
|
196
|
+
* editor offers (87 entries, e.g. `service`, `severity`, `message`, `host`).
|
|
197
|
+
* Distinct from the policy catalogs: the same concept is `service` here and
|
|
198
|
+
* `services_impacted` in `normalizedalarms/fields`.
|
|
199
|
+
*/
|
|
200
|
+
export declare const AlarmQueueFieldSchema: z.ZodObject<{
|
|
201
|
+
field: z.ZodString;
|
|
202
|
+
fieldDescription: z.ZodString;
|
|
203
|
+
values: z.ZodArray<z.ZodString>;
|
|
204
|
+
hideMoreOptions: z.ZodOptional<z.ZodBoolean>;
|
|
205
|
+
}, z.core.$loose>;
|
|
206
|
+
export type AlarmQueueField = z.infer<typeof AlarmQueueFieldSchema>;
|
|
207
|
+
export declare const AlarmQueueFieldsResponseSchema: z.ZodArray<z.ZodObject<{
|
|
208
|
+
field: z.ZodString;
|
|
209
|
+
fieldDescription: z.ZodString;
|
|
210
|
+
values: z.ZodArray<z.ZodString>;
|
|
211
|
+
hideMoreOptions: z.ZodOptional<z.ZodBoolean>;
|
|
212
|
+
}, z.core.$loose>>;
|
|
213
|
+
/** One entry of `GET oi/v2/api/getUserRoles`, the tenant's role catalog. */
|
|
214
|
+
export declare const TenantRoleSchema: z.ZodObject<{
|
|
215
|
+
id: z.ZodString;
|
|
216
|
+
name: z.ZodString;
|
|
217
|
+
description: z.ZodOptional<z.ZodString>;
|
|
218
|
+
owner: z.ZodOptional<z.ZodString>;
|
|
219
|
+
inactive: z.ZodOptional<z.ZodBoolean>;
|
|
220
|
+
type: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
221
|
+
}, z.core.$loose>;
|
|
222
|
+
export type TenantRole = z.infer<typeof TenantRoleSchema>;
|
|
223
|
+
export declare const TenantRolesResponseSchema: z.ZodArray<z.ZodObject<{
|
|
224
|
+
id: z.ZodString;
|
|
225
|
+
name: z.ZodString;
|
|
226
|
+
description: z.ZodOptional<z.ZodString>;
|
|
227
|
+
owner: z.ZodOptional<z.ZodString>;
|
|
228
|
+
inactive: z.ZodOptional<z.ZodBoolean>;
|
|
229
|
+
type: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
230
|
+
}, z.core.$loose>>;
|
|
231
|
+
/**
|
|
232
|
+
* Body of `POST oi/v2/api/alarmfilters` (create) and
|
|
233
|
+
* `PUT oi/v2/api/alarmfilters?filterName=<name>` (update, which adds `id` and
|
|
234
|
+
* `isFilterExpressionChanged`). Personal queues send `ownerRole: null` and
|
|
235
|
+
* `sharedToRoles: null`; shared queues send the owner role and the role list,
|
|
236
|
+
* with `newSharedRoles` / `unSharedRoles` carrying the delta on update.
|
|
237
|
+
*/
|
|
238
|
+
export declare const AlarmQueueWriteBodySchema: z.ZodObject<{
|
|
239
|
+
id: z.ZodOptional<z.ZodString>;
|
|
240
|
+
filterName: z.ZodString;
|
|
241
|
+
alarmCategory: z.ZodString;
|
|
242
|
+
isPinned: z.ZodBoolean;
|
|
243
|
+
isDefault: z.ZodBoolean;
|
|
244
|
+
personal: z.ZodBoolean;
|
|
245
|
+
ownerRole: z.ZodNullable<z.ZodString>;
|
|
246
|
+
sharedToRoles: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
247
|
+
newSharedRoles: z.ZodArray<z.ZodString>;
|
|
248
|
+
unSharedRoles: z.ZodArray<z.ZodString>;
|
|
249
|
+
isComplexFilter: z.ZodBoolean;
|
|
250
|
+
filterExpressions: z.ZodType<PolicyFilterExpression, unknown, z.core.$ZodTypeInternals<PolicyFilterExpression, unknown>>;
|
|
251
|
+
displayColumns: z.ZodRecord<z.ZodString, z.ZodBoolean>;
|
|
252
|
+
columnOrder: z.ZodArray<z.ZodString>;
|
|
253
|
+
pinnedColumns: z.ZodUnion<readonly [z.ZodNull, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
|
|
254
|
+
sharePreferences: z.ZodBoolean;
|
|
255
|
+
filterSettings: z.ZodObject<{
|
|
256
|
+
displayclosedalarms: z.ZodBoolean;
|
|
257
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
258
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
259
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
260
|
+
expandVisualizations: z.ZodBoolean;
|
|
261
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
262
|
+
}, z.core.$loose>;
|
|
263
|
+
isFilterExpressionChanged: z.ZodOptional<z.ZodBoolean>;
|
|
264
|
+
}, z.core.$loose>;
|
|
265
|
+
export type AlarmQueueWriteBody = z.infer<typeof AlarmQueueWriteBodySchema>;
|
|
266
|
+
/** Create / update response: the persisted queue plus the server's insert flags. */
|
|
267
|
+
export declare const AlarmQueueWriteResponseSchema: z.ZodObject<{
|
|
268
|
+
id: z.ZodString;
|
|
269
|
+
filterName: z.ZodString;
|
|
270
|
+
alarmCategory: z.ZodString;
|
|
271
|
+
personal: z.ZodOptional<z.ZodBoolean>;
|
|
272
|
+
ownerRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
273
|
+
sharedToRoles: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
274
|
+
isPinned: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
275
|
+
isDefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
276
|
+
createdBy: z.ZodOptional<z.ZodString>;
|
|
277
|
+
updatedBy: z.ZodOptional<z.ZodString>;
|
|
278
|
+
creationTime: z.ZodOptional<z.ZodString>;
|
|
279
|
+
lastUpdated: z.ZodOptional<z.ZodString>;
|
|
280
|
+
rank: z.ZodOptional<z.ZodString>;
|
|
281
|
+
groupSelected: z.ZodOptional<z.ZodBoolean>;
|
|
282
|
+
isComplexFilter: z.ZodOptional<z.ZodBoolean>;
|
|
283
|
+
displayColumns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
|
|
284
|
+
columnOrder: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
285
|
+
columnPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
286
|
+
width: z.ZodOptional<z.ZodNumber>;
|
|
287
|
+
}, z.core.$loose>>>;
|
|
288
|
+
columnSize: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
|
|
289
|
+
pinnedColumns: z.ZodOptional<z.ZodUnion<readonly [z.ZodNull, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
|
|
290
|
+
sortColumn: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
291
|
+
sharePreferences: z.ZodOptional<z.ZodBoolean>;
|
|
292
|
+
defaultRoleData: z.ZodOptional<z.ZodUnknown>;
|
|
293
|
+
filterSettings: z.ZodOptional<z.ZodObject<{
|
|
294
|
+
displayclosedalarms: z.ZodBoolean;
|
|
295
|
+
alarmsPartOfSituations: z.ZodBoolean;
|
|
296
|
+
displayMaintenanceAlarms: z.ZodBoolean;
|
|
297
|
+
displayAlgorithmicSituations: z.ZodBoolean;
|
|
298
|
+
expandVisualizations: z.ZodBoolean;
|
|
299
|
+
autoRefreshAlarms: z.ZodBoolean;
|
|
300
|
+
}, z.core.$loose>>;
|
|
301
|
+
filterExpressions: z.ZodType<PolicyFilterExpression, unknown, z.core.$ZodTypeInternals<PolicyFilterExpression, unknown>>;
|
|
302
|
+
queueInserted: z.ZodOptional<z.ZodBoolean>;
|
|
303
|
+
isDuplicate: z.ZodOptional<z.ZodBoolean>;
|
|
304
|
+
isFilterExpressionChanged: z.ZodOptional<z.ZodBoolean>;
|
|
305
|
+
}, z.core.$loose>;
|
|
306
|
+
export type AlarmQueueWriteResponse = z.infer<typeof AlarmQueueWriteResponseSchema>;
|
|
307
|
+
/**
|
|
308
|
+
* Body of `POST oi/v2/api/updateUserPreferences`, the per-user pin / default
|
|
309
|
+
* toggle. Exactly the six keys the UI sends.
|
|
310
|
+
*/
|
|
311
|
+
export declare const AlarmQueuePreferencesSchema: z.ZodObject<{
|
|
312
|
+
id: z.ZodString;
|
|
313
|
+
filterName: z.ZodString;
|
|
314
|
+
isPinned: z.ZodBoolean;
|
|
315
|
+
isDefault: z.ZodBoolean;
|
|
316
|
+
sharePreferences: z.ZodBoolean;
|
|
317
|
+
alarmCategory: z.ZodString;
|
|
318
|
+
}, z.core.$strict>;
|
|
319
|
+
export type AlarmQueuePreferences = z.infer<typeof AlarmQueuePreferencesSchema>;
|
|
320
|
+
export declare const AlarmQueuePreferencesResponseSchema: z.ZodObject<{
|
|
321
|
+
message: z.ZodString;
|
|
322
|
+
}, z.core.$loose>;
|
|
323
|
+
export type AlarmQueuePreferencesResponse = z.infer<typeof AlarmQueuePreferencesResponseSchema>;
|
|
324
|
+
/** `DELETE oi/v2/api/alarmfilters?id=&alarmCategory=rawAlarm`: observed live on the lab tenant. */
|
|
325
|
+
export declare const AlarmQueueDeleteResponseSchema: z.ZodObject<{
|
|
326
|
+
message: z.ZodString;
|
|
327
|
+
}, z.core.$loose>;
|
|
328
|
+
export type AlarmQueueDeleteResponse = z.infer<typeof AlarmQueueDeleteResponseSchema>;
|
|
329
|
+
export declare const ALARM_QUEUE_DISPLAY_COLUMN_KEYS: readonly ["severity", "alarmType", "annotation", "message", "entity", "ip", "locationString", "Service", "sourceProduct", "ticketID", "ticketStatus", "troubleShooter", "timeOrigin", "lastUpdateTime", "agent", "csId", "alert_definition_link", "subsystem", "deviceName", "metricType", "host", "causeCode", "monitoringHost", "ciType", "group", "assignmentGroup", "devId", "component_name", "alarmURL", "external_ids", "tags", "domain", "metric_view_link", "ciName", "applicationName", "isolation_view_link", "probe", "modelName", "custom1", "custom2", "custom3", "custom4", "custom5", "custom6", "custom7", "custom8", "custom9", "custom10", "clusterId", "clusterStatus", "isStableCluster", "clusterTroubleTicket", "sourceTimestamp", "subClustersCount", "custom_11", "custom_12", "custom_13", "custom_14", "custom_15", "custom_16", "custom_17", "custom_18", "custom_19", "custom_20", "custom_21", "custom_22", "custom_23", "custom_24", "custom_25", "custom_26", "custom_27", "custom_28", "custom_29", "custom_30", "custom_31", "custom_32", "custom_33", "custom_34", "custom_35", "custom_36", "custom_37", "custom_38", "custom_39", "custom_40", "custom_41", "custom_42", "custom_43", "custom_44", "custom_45", "custom_46", "custom_47", "custom_48", "custom_49", "custom_50", "custom_51", "custom_52", "custom_53", "custom_54", "custom_55", "custom_56", "custom_57", "custom_58", "custom_59", "custom_60"];
|
|
330
|
+
export type AlarmQueueColumnKey = (typeof ALARM_QUEUE_DISPLAY_COLUMN_KEYS)[number];
|
|
331
|
+
export declare const ALARM_QUEUE_DEFAULT_VISIBLE_COLUMNS: readonly AlarmQueueColumnKey[];
|
|
332
|
+
export declare const ALARM_QUEUE_DEFAULT_COLUMN_ORDER: readonly string[];
|
|
333
|
+
/** Conditions the queue editor offers: the platform's string matchers (no notify-time detectors). */
|
|
334
|
+
export declare const ALARM_QUEUE_FILTER_CONDITIONS: readonly string[];
|
|
335
|
+
/**
|
|
336
|
+
* Builds `filterExpressions` the way the UI does: atoms that share a
|
|
337
|
+
* field+condition become one `or` group (any-of), and the groups AND
|
|
338
|
+
* together under one outer `and`. One atom per group reproduces the captured
|
|
339
|
+
* shape exactly.
|
|
340
|
+
*/
|
|
341
|
+
export declare function buildAlarmQueueFilterExpression(atoms: AlarmQueueFilterAtom[]): AlarmQueueFilterExpression;
|
|
342
|
+
/** The full column map with exactly `visible` set to true; unknown ids throw. */
|
|
343
|
+
export declare function displayColumnsFor(visible: readonly string[]): Record<string, boolean>;
|
|
344
|
+
/** Visible column ids of a queue, in catalog order (unknown ids last). */
|
|
345
|
+
export declare function visibleAlarmQueueColumns(displayColumns: Record<string, boolean> | undefined): string[];
|
|
346
|
+
/** `newSharedRoles` / `unSharedRoles` for a change of the shared-to list. */
|
|
347
|
+
export declare function sharedRoleDelta(previous: readonly string[] | null | undefined, next: readonly string[] | null | undefined): {
|
|
348
|
+
newSharedRoles: string[];
|
|
349
|
+
unSharedRoles: string[];
|
|
350
|
+
};
|
|
351
|
+
export interface AlarmQueueSharing {
|
|
352
|
+
personal: boolean;
|
|
353
|
+
ownerRole?: string | null | undefined;
|
|
354
|
+
sharedToRoles?: readonly string[] | null | undefined;
|
|
40
355
|
}
|
|
356
|
+
/** Personal means null owner and roles; shared means the owner as given and a role array. */
|
|
357
|
+
export declare function normalizeAlarmQueueSharing(sharing: AlarmQueueSharing): {
|
|
358
|
+
personal: boolean;
|
|
359
|
+
ownerRole: string | null;
|
|
360
|
+
sharedToRoles: string[] | null;
|
|
361
|
+
};
|
|
362
|
+
export interface AlarmQueueCreateInput extends AlarmQueueSharing {
|
|
363
|
+
filterName: string;
|
|
364
|
+
filterExpressions: AlarmQueueFilterExpression;
|
|
365
|
+
/** Column ids to show; defaults to the UI's eleven. */
|
|
366
|
+
visibleColumns?: readonly string[] | undefined;
|
|
367
|
+
filterSettings?: Partial<AlarmQueueFilterSettings> | undefined;
|
|
368
|
+
isPinned?: boolean | undefined;
|
|
369
|
+
isDefault?: boolean | undefined;
|
|
370
|
+
}
|
|
371
|
+
/** The create body with the UI's defaults filled in. */
|
|
372
|
+
export declare function toAlarmQueueWriteBody(input: AlarmQueueCreateInput): AlarmQueueWriteBody;
|
|
373
|
+
export interface AlarmQueueUpdatePatch {
|
|
374
|
+
filterName?: string | undefined;
|
|
375
|
+
filterExpressions?: AlarmQueueFilterExpression | undefined;
|
|
376
|
+
personal?: boolean | undefined;
|
|
377
|
+
ownerRole?: string | null | undefined;
|
|
378
|
+
sharedToRoles?: readonly string[] | null | undefined;
|
|
379
|
+
visibleColumns?: readonly string[] | undefined;
|
|
380
|
+
filterSettings?: Partial<AlarmQueueFilterSettings> | undefined;
|
|
381
|
+
}
|
|
382
|
+
/**
|
|
383
|
+
* The update body for an existing queue with only the patched fields changed;
|
|
384
|
+
* everything else (display columns, order, settings, pin state) is sent back
|
|
385
|
+
* verbatim. Returns human-readable `changes` for previews; an empty list means
|
|
386
|
+
* there is nothing to save.
|
|
387
|
+
*/
|
|
388
|
+
export declare function buildAlarmQueueUpdateBody(existing: AlarmQueueDetail, patch: AlarmQueueUpdatePatch): {
|
|
389
|
+
body: AlarmQueueWriteBody;
|
|
390
|
+
changes: string[];
|
|
391
|
+
};
|
|
41
392
|
//# sourceMappingURL=alarm-queue.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alarm-queue.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/alarm/alarm-queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"alarm-queue.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/alarm/alarm-queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAGlG;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AACpD,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,CAAC;AAMhE,eAAO,MAAM,+BAA+B,qKAOlC,CAAC;AACX,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1F,eAAO,MAAM,8BAA8B;;;;;;;iBAOzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF,eAAO,MAAM,mCAAmC,EAAE,wBAOjD,CAAC;AAMF,8DAA8D;AAC9D,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2D3B,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,mGAAmG;AACnG,wBAAgB,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,GAAG,WAAW,CAAC,GAAG,OAAO,CAE1F;AAED,4GAA4G;AAC5G,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAE1D;AAED,kEAAkE;AAClE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,8EAA8E;AAC9E,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAGvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,GAAG,EAAE,sBAAsB,GAAG,gBAAgB,EAAE,CAG9E;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;iBAKhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,eAAO,MAAM,8BAA8B;;;;;kBAAiC,CAAC;AAE7E,4EAA4E;AAC5E,eAAO,MAAM,gBAAgB;;;;;;;iBAO3B,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,eAAO,MAAM,yBAAyB;;;;;;;kBAA4B,CAAC;AAMnE;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkDlC,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,oFAAoF;AACpF,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIxC,CAAC;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,2BAA2B;;;;;;;kBAOtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,eAAO,MAAM,mCAAmC;;iBAE9C,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG,mGAAmG;AACnG,eAAO,MAAM,8BAA8B;;iBAEzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAMtF,eAAO,MAAM,+BAA+B,y3CAyGlC,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnF,eAAO,MAAM,mCAAmC,EAAE,SAAS,mBAAmB,EAY7E,CAAC;AAEF,eAAO,MAAM,gCAAgC,EAAE,SAAS,MAAM,EAgE7D,CAAC;AAEF,qGAAqG;AACrG,eAAO,MAAM,6BAA6B,EAAE,SAAS,MAAM,EAAyC,CAAC;AAMrG;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,oBAAoB,EAAE,GAAG,0BAA0B,CAYzG;AAED,iFAAiF;AACjF,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQrF;AAED,0EAA0E;AAC1E,wBAAgB,wBAAwB,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,MAAM,EAAE,CAMtG;AAED,6EAA6E;AAC7E,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,EAC9C,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,GACzC;IAAE,cAAc,EAAE,MAAM,EAAE,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAA;CAAE,CAOvD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;CACtD;AAED,6FAA6F;AAC7F,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,iBAAiB,GAAG;IACtE,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CASA;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,0BAA0B,CAAC;IAC9C,uDAAuD;IACvD,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/C,cAAc,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAC;IAC/D,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC;AAED,wDAAwD;AACxD,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,qBAAqB,GAAG,mBAAmB,CAoBvF;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,iBAAiB,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IAC3D,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IACrD,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/C,cAAc,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAC;CAChE;AAID;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,qBAAqB,GAC3B;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAkFlD"}
|
|
@@ -20,8 +20,8 @@ export type SmtpTestRequest = z.infer<typeof SmtpTestRequestSchema>;
|
|
|
20
20
|
/** Caller-supplied part of {@link SmtpTestRequestSchema}; the service stamps orgId. */
|
|
21
21
|
export declare const SmtpTestInputSchema: z.ZodObject<{
|
|
22
22
|
alarmType: z.ZodString;
|
|
23
|
-
alarmId: z.ZodString;
|
|
24
23
|
templateName: z.ZodString;
|
|
24
|
+
alarmId: z.ZodString;
|
|
25
25
|
maskRecipients: z.ZodBoolean;
|
|
26
26
|
useDefaultConfigs: z.ZodBoolean;
|
|
27
27
|
recipients: z.ZodArray<z.ZodEmail>;
|
|
@@ -59,9 +59,9 @@ export type WebhookTestRequest = z.infer<typeof WebhookTestRequestSchema>;
|
|
|
59
59
|
export declare const WebhookTestInputSchema: z.ZodObject<{
|
|
60
60
|
url: z.ZodURL;
|
|
61
61
|
alarmType: z.ZodString;
|
|
62
|
+
id: z.ZodNumber;
|
|
62
63
|
alarmId: z.ZodString;
|
|
63
64
|
headers: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
64
|
-
id: z.ZodNumber;
|
|
65
65
|
proxyId: z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
66
66
|
authDetails: z.ZodObject<{
|
|
67
67
|
authType: z.ZodEnum<{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Curl.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/curl/Curl.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Curl.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/curl/Curl.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAOnE,qEAAqE;AACrE,eAAO,MAAM,cAAc,eAAe,CAAC;AAC3C,wEAAwE;AACxE,eAAO,MAAM,aAAa,cAAc,CAAC;AACzC,eAAO,MAAM,eAAe,gBAAgB,CAAC;AAE7C,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAgGD;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE,iBAAsB,GAC9B,MAAM,CAkCR;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAMjE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EAAE,EACvB,OAAO,GAAE,iBAAsB,GAC9B,MAAM,CAqER"}
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
import { z } from 'zod/v4';
|
|
2
|
-
/**
|
|
3
|
-
|
|
2
|
+
/**
|
|
3
|
+
* Store acknowledgement. On success the audit store answers HTTP 200 with no
|
|
4
|
+
* body at all (observed 2026-09-07: `content-length: 0`), which axios
|
|
5
|
+
* surfaces as `''`; an empty object is accepted as well in case a gateway
|
|
6
|
+
* starts sending one.
|
|
7
|
+
*/
|
|
8
|
+
export declare const AuditStoreResponseSchema: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodObject<{}, z.core.$loose>]>>;
|
|
4
9
|
export type AuditStoreResponse = z.infer<typeof AuditStoreResponseSchema>;
|
|
5
10
|
/**
|
|
6
11
|
* An audit record as returned from the query endpoint (Elasticsearch-shaped).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/model/datastore/audit/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B
|
|
1
|
+
{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/model/datastore/audit/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,wFAKxB,CAAC;AAEd,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;iBAsB9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;kBAEU,CAAC;AAEhD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Postman.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/postman/Postman.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Postman.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/postman/Postman.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAO9D,4EAA4E;AAC5E,eAAO,MAAM,iBAAiB,eAAe,CAAC;AAE9C,sEAAsE;AACtE,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,0EAA0E;IAC1E,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE;QACP,GAAG,EAAE;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,GAAG,EAAE,UAAU,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,EAAE,CAAC;CACd;AAED,gBAAgB;AAChB,MAAM,WAAW,UAAU;IAEzB,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,EAAE,CAAC;IACtE,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,gBAAgB;AAChB,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,YAAY,EACrB,OAAO,GAAE,oBAAyB,GACjC,cAAc,CA6DhB"}
|
|
@@ -3,7 +3,7 @@ import { OIAlarm } from '../model/oi/alarms';
|
|
|
3
3
|
import { DateTime } from 'luxon';
|
|
4
4
|
import { Logging } from '@dx-do/util';
|
|
5
5
|
import { AlarmEnrichment } from '../model/alarm/alarm-enrichment';
|
|
6
|
-
import type {
|
|
6
|
+
import type { AlarmQueueDeleteResponse, AlarmQueueDetail, AlarmQueueField, AlarmQueueListResponse, AlarmQueuePreferences, AlarmQueuePreferencesResponse, AlarmQueueWriteBody, AlarmQueueWriteResponse, TenantRole } from '../model/alarm/alarm-queue';
|
|
7
7
|
import { PlatformFilters } from '../model/filter/platform-filter';
|
|
8
8
|
import { Situations } from '../model/situations/Situations';
|
|
9
9
|
import { RelatedAlarmResponseBody } from '../model/alarm/related-alarms';
|
|
@@ -39,17 +39,70 @@ export declare class AlarmService {
|
|
|
39
39
|
getAlarms(startTime: DateTime, endTime: DateTime, includedAlarmTypes?: string[], includeClosed?: boolean, pageSize?: number, alarmFilter?: PlatformFilters.PlatformFilter): Promise<Map<string, OIAlarm.Alarm>>;
|
|
40
40
|
/** Returns all alarm enrichment rules configured for the tenant. */
|
|
41
41
|
getEnrichmentRules(): Promise<AlarmEnrichment.EnrichmentRulesResponse>;
|
|
42
|
-
/**
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
42
|
+
/**
|
|
43
|
+
* Lists the alarm queues visible to the caller
|
|
44
|
+
* (`GET oi/v2/api/alarmfilters/_search?sortBy=filterName`).
|
|
45
|
+
* @remarks Response-validated, not thrown: a schema mismatch logs a warning and returns the raw body.
|
|
46
|
+
*/
|
|
47
|
+
getAlarmQueues(): Promise<AlarmQueueListResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Reads one alarm queue with its filter expression
|
|
50
|
+
* (`GET oi/v2/api/alarmfilters/_search?id=<id>&alarmCategory=rawAlarm`).
|
|
51
|
+
* A missing id answers 200 with an id-less body (see `isAlarmQueueNotFound`).
|
|
52
|
+
* @remarks Response-validated, not thrown.
|
|
53
|
+
*/
|
|
54
|
+
getAlarmQueueDetail(queueId: string): Promise<AlarmQueueDetail>;
|
|
55
|
+
/**
|
|
56
|
+
* Shared alarm queues with their expressions inlined (`GET oi/v2/api/allalarmfilters`).
|
|
57
|
+
* Personal queues are not listed; an empty result is a message body, normalized to `[]`.
|
|
58
|
+
* @remarks Response-validated, not thrown.
|
|
59
|
+
*/
|
|
60
|
+
listAllAlarmQueues(): Promise<AlarmQueueDetail[]>;
|
|
61
|
+
/**
|
|
62
|
+
* Creates an alarm queue (`POST oi/v2/api/alarmfilters`). The body is the
|
|
63
|
+
* UI's full key set; `toAlarmQueueWriteBody` fills the defaults.
|
|
64
|
+
* @throws ZodError when the body violates the personal / shared invariant.
|
|
65
|
+
* @remarks Response-validated, not thrown.
|
|
66
|
+
*/
|
|
67
|
+
createAlarmQueue(body: AlarmQueueWriteBody): Promise<AlarmQueueWriteResponse>;
|
|
68
|
+
/**
|
|
69
|
+
* Updates an alarm queue (`PUT oi/v2/api/alarmfilters?filterName=<name>`).
|
|
70
|
+
* The body carries `id`; `buildAlarmQueueUpdateBody` derives it from the
|
|
71
|
+
* existing queue. The UI puts the queue name in the query string, so
|
|
72
|
+
* `filterNameQuery` defaults to the name in the body (the new name on a rename).
|
|
73
|
+
* @throws ZodError when the body violates the personal / shared invariant.
|
|
74
|
+
* @throws Error when `body.id` is missing.
|
|
75
|
+
* @remarks Response-validated, not thrown.
|
|
76
|
+
*/
|
|
77
|
+
updateAlarmQueue(body: AlarmQueueWriteBody, filterNameQuery?: string): Promise<AlarmQueueWriteResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* Deletes an alarm queue
|
|
80
|
+
* (`DELETE oi/v2/api/alarmfilters?id=<id>&alarmCategory=rawAlarm`, read live
|
|
81
|
+
* from the UI's DevTools; the HAR exports never carried the row). Answers
|
|
82
|
+
* `{ message: 'Delete Filter Successful !!!' }`; callers still prove the
|
|
83
|
+
* delete by re-reading the queue.
|
|
84
|
+
* @remarks Response-validated, not thrown.
|
|
85
|
+
*/
|
|
86
|
+
deleteAlarmQueue(queueId: string): Promise<AlarmQueueDeleteResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* Sets the caller's pin / default preference for a queue
|
|
89
|
+
* (`POST oi/v2/api/updateUserPreferences`). Per-user: other users' views are untouched.
|
|
90
|
+
* @throws ZodError on a malformed body.
|
|
91
|
+
* @remarks Response-validated, not thrown.
|
|
92
|
+
*/
|
|
93
|
+
setAlarmQueuePreferences(prefs: AlarmQueuePreferences): Promise<AlarmQueuePreferencesResponse>;
|
|
94
|
+
/**
|
|
95
|
+
* The field catalog the queue editor offers (`GET oi/v2/api/alarms/fields`):
|
|
96
|
+
* names, labels, and closed vocabularies for `filterExpressions` atoms.
|
|
97
|
+
* @remarks Response-validated, not thrown.
|
|
98
|
+
*/
|
|
99
|
+
listAlarmQueueFields(): Promise<AlarmQueueField[]>;
|
|
100
|
+
/**
|
|
101
|
+
* The tenant's role catalog (`GET oi/v2/api/getUserRoles`), the vocabulary
|
|
102
|
+
* for `ownerRole` / `sharedToRoles`.
|
|
103
|
+
* @remarks Response-validated, not thrown.
|
|
104
|
+
*/
|
|
105
|
+
listTenantRoles(): Promise<TenantRole[]>;
|
|
53
106
|
/** Returns historically related alarms for a given alarm ID. */
|
|
54
107
|
getRelatedAlarms(alarmId: string): Promise<RelatedAlarmResponseBody>;
|
|
55
108
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alarm.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/alarm.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"alarm.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/alarm.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAgBlE,OAAO,KAAK,EACV,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,6BAA6B,EAC7B,mBAAmB,EACnB,uBAAuB,EAEvB,UAAU,EACX,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;GAGG;AACH,qBAAa,YAAY;IAMrB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IANnB;;;OAGG;gBAEO,aAAa,EAAE,aAAa,EAC5B,SAAS,GAAE,OAAO,CAAC,SAAuC;IAGpE,+DAA+D;IACzD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;IAMvD,oFAAoF;IAC9E,gBAAgB,CAAC,OAAO,EAAE,MAAM;IAmDtC,gGAAgG;IAC1F,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,uBAAuB,EAAE,MAAM,EAC/B,QAAQ,SAAK,EACb,MAAM,SAAU;IAsBlB,mDAAmD;IAC7C,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB/D,gCAAgC;IAC1B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB9C,+CAA+C;IACzC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3E,gFAAgF;IAC1E,gBAAgB,CACpB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,OAAO,CAAC;IA+CnB,gEAAgE;IAC1D,iBAAiB,CACrB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAoB9C,uFAAuF;IACjF,SAAS,CACb,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,kBAAkB,GAAE,MAAM,EAAO,EACjC,aAAa,UAAQ,EACrB,QAAQ,SAAM,EACd,WAAW,CAAC,EAAE,eAAe,CAAC,cAAc,GAC3C,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAsDtC,oEAAoE;IAC9D,kBAAkB;IAMxB;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAWvD;;;;;OAKG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYrE;;;;OAIG;IACG,kBAAkB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IASvD;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAUnF;;;;;;;;OAQG;IACG,gBAAgB,CACpB,IAAI,EAAE,mBAAmB,EACzB,eAAe,GAAE,MAAwB,GACxC,OAAO,CAAC,uBAAuB,CAAC;IAenC;;;;;;;OAOG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAY1E;;;;;OAKG;IACG,wBAAwB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAUpG;;;;OAIG;IACG,oBAAoB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IASxD;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAS9C,gEAAgE;IAC1D,gBAAgB,CAAC,OAAO,EAAE,MAAM;CAcvC"}
|
|
@@ -30,9 +30,17 @@ export declare class DataStoreAuditService {
|
|
|
30
30
|
/**
|
|
31
31
|
* POSTs to `/audit/store` to record an audit event.
|
|
32
32
|
*
|
|
33
|
+
* @param options.timeoutMs - Abort the request after this many
|
|
34
|
+
* milliseconds. Unbounded by default; the CLI's at-exit command audit
|
|
35
|
+
* sets it so a hung gateway cannot stall every exit.
|
|
36
|
+
* @remarks Response is `safeParse`-validated (warn-on-mismatch, raw still returned).
|
|
33
37
|
* @throws ZodError if the request fails schema validation.
|
|
38
|
+
* @throws SimpleHTTPError when the tenant refuses the record (401/403 for a
|
|
39
|
+
* token without audit rights, 400 for a rejected payload).
|
|
34
40
|
*/
|
|
35
|
-
storeAudit(record: AuditRecord
|
|
41
|
+
storeAudit(record: AuditRecord, options?: {
|
|
42
|
+
timeoutMs?: number;
|
|
43
|
+
}): Promise<AuditStoreResponse>;
|
|
36
44
|
/**
|
|
37
45
|
* GETs `/audit/query` to retrieve audit records for the current tenant.
|
|
38
46
|
* Requires TA-role authorization on the server side.
|