@dx-do/client 7.15.0 → 7.17.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 +2075 -292
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +2061 -293
- package/dist/index.esm.js.map +1 -1
- package/dist/src/index.d.ts +7 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/lib/model/alarm/alarm-record.d.ts +53 -0
- package/dist/src/lib/model/alarm/alarm-record.d.ts.map +1 -0
- package/dist/src/lib/model/datastore/datastore-schemas.d.ts +2 -7
- package/dist/src/lib/model/datastore/datastore-schemas.d.ts.map +1 -1
- package/dist/src/lib/model/datastore/metrics-metadata/attribute-name-specifier.d.ts +2 -2
- package/dist/src/lib/model/datastore/metrics-metadata/folder-name-specifier.d.ts +2 -2
- package/dist/src/lib/model/datastore/metrics-metadata/source-name-specifier.d.ts +2 -2
- package/dist/src/lib/model/datastore/nassql/operations.d.ts.map +1 -1
- package/dist/src/lib/model/datastore/tas/filters.d.ts +11 -10
- package/dist/src/lib/model/datastore/tas/filters.d.ts.map +1 -1
- package/dist/src/lib/model/oi/alarms.d.ts +12 -0
- package/dist/src/lib/model/oi/alarms.d.ts.map +1 -1
- package/dist/src/lib/model/oi/services.bulk-select.d.ts +109 -0
- package/dist/src/lib/model/oi/services.bulk-select.d.ts.map +1 -0
- package/dist/src/lib/model/oi/services.bulk.d.ts +243 -0
- package/dist/src/lib/model/oi/services.bulk.d.ts.map +1 -0
- package/dist/src/lib/model/oi/services.d.ts +2 -0
- package/dist/src/lib/model/oi/services.d.ts.map +1 -1
- package/dist/src/lib/model/oi/services.export.d.ts +10 -0
- package/dist/src/lib/model/oi/services.export.d.ts.map +1 -1
- package/dist/src/lib/model/oi/services.import.d.ts +43 -0
- package/dist/src/lib/model/oi/services.import.d.ts.map +1 -0
- package/dist/src/lib/model/oi/services.transform.d.ts +10 -1
- package/dist/src/lib/model/oi/services.transform.d.ts.map +1 -1
- package/dist/src/lib/model/service/service-overview.d.ts +20 -0
- package/dist/src/lib/model/service/service-overview.d.ts.map +1 -1
- package/dist/src/lib/services/alarm-export.d.ts +85 -0
- package/dist/src/lib/services/alarm-export.d.ts.map +1 -0
- package/dist/src/lib/services/alarm-window-search.d.ts +59 -0
- package/dist/src/lib/services/alarm-window-search.d.ts.map +1 -0
- package/dist/src/lib/services/alarm.service.d.ts +57 -4
- package/dist/src/lib/services/alarm.service.d.ts.map +1 -1
- package/dist/src/lib/services/dxoi.service.d.ts +15 -3
- package/dist/src/lib/services/dxoi.service.d.ts.map +1 -1
- package/dist/src/lib/services/lifecycle-pages.d.ts +20 -0
- package/dist/src/lib/services/lifecycle-pages.d.ts.map +1 -0
- package/dist/src/lib/services/service.service.d.ts +107 -10
- package/dist/src/lib/services/service.service.d.ts.map +1 -1
- package/dist/src/lib/services/situation.service.d.ts +9 -2
- package/dist/src/lib/services/situation.service.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -8,6 +8,9 @@ import type { AlarmQueueDeleteResponse, AlarmQueueDetail, AlarmQueueField, Alarm
|
|
|
8
8
|
import { PlatformFilters } from '../model/filter/platform-filter';
|
|
9
9
|
import { Situations } from '../model/situations/Situations';
|
|
10
10
|
import { RelatedAlarmResponseBody } from '../model/alarm/related-alarms';
|
|
11
|
+
import type { AlarmExportMatch, AlarmExportOptions } from './alarm-export';
|
|
12
|
+
import type { AlarmRecord } from '../model/alarm/alarm-record';
|
|
13
|
+
import type { AlarmSearchPage, AlarmWindowSearchOptions } from './alarm-window-search';
|
|
11
14
|
/**
|
|
12
15
|
* Service for OI alarms: get, search, assign, acknowledge, clear, lifecycle,
|
|
13
16
|
* enrichment rules, alarm queues, and related alarms.
|
|
@@ -32,7 +35,12 @@ export declare class AlarmService {
|
|
|
32
35
|
* unknown ID.
|
|
33
36
|
*/
|
|
34
37
|
findAlarm(alarmId: string, lookbackMs: number, requestOverrides?: RequestOverrides): Promise<OIAlarm.Alarm | undefined>;
|
|
35
|
-
/**
|
|
38
|
+
/**
|
|
39
|
+
* Returns an open alarm of the last 30 days by its ID (the payload a channel
|
|
40
|
+
* notification sends).
|
|
41
|
+
*
|
|
42
|
+
* @throws Error when no open alarm has that ID.
|
|
43
|
+
*/
|
|
36
44
|
getAlarmOverview(alarmId: string): Promise<OIAlarm.Alarm>;
|
|
37
45
|
/** Sends a notification for an alarm to the specified channel with optional template/locale. */
|
|
38
46
|
triggerNotification(alarmId: string, notificationChannelName: string, template?: string, locale?: string): Promise<Situations.SituationActionResponse>;
|
|
@@ -44,10 +52,55 @@ export declare class AlarmService {
|
|
|
44
52
|
acknowledge(alarmId: string, unacknowledge?: boolean): Promise<unknown>;
|
|
45
53
|
/** Updates a single field on an alarm document via the Jarvis ingestion API. */
|
|
46
54
|
updateAlarmField(alarmId: string, field: string, value: string): Promise<unknown>;
|
|
47
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* Returns an alarm's whole lifecycle event history, newest first.
|
|
57
|
+
*
|
|
58
|
+
* @remarks Reads pages of 1000 until the server's `totalCount` is reached
|
|
59
|
+
* (it used to ask for 20 and stop, dropping the oldest events, "Alarm
|
|
60
|
+
* Opened" first). `totalCount` is returned as the server reported it; if a
|
|
61
|
+
* page comes back empty early, the result holds fewer events and a warning
|
|
62
|
+
* is logged.
|
|
63
|
+
*/
|
|
48
64
|
getAlarmLifeCycle(alarmId: string): Promise<OIAlarm.AlarmLifecycleResponseBody>;
|
|
49
|
-
/**
|
|
50
|
-
|
|
65
|
+
/**
|
|
66
|
+
* One alarm search over `[startTime, endTime]`: the exact number of alarms
|
|
67
|
+
* in the range and the first `pageSize` of them (at most
|
|
68
|
+
* {@link ALARM_SEARCH_PAGE_CAP}, whatever is asked). Use it where a sample
|
|
69
|
+
* plus the true total is enough; {@link getAlarms} reads the whole range.
|
|
70
|
+
*/
|
|
71
|
+
searchAlarmPage(startTime: DateTime, endTime: DateTime, includedAlarmTypes?: string[], includeClosed?: boolean, pageSize?: number, alarmFilter?: PlatformFilters.PlatformFilter): Promise<AlarmSearchPage>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns every alarm in `[startTime, endTime]`, keyed by `alarmId`.
|
|
74
|
+
*
|
|
75
|
+
* One search returns at most {@link ALARM_SEARCH_PAGE_CAP} alarms and cannot
|
|
76
|
+
* be paged, so a larger range is read in windows and merged
|
|
77
|
+
* (`searchAlarmWindows`). A window holds every alarm whose lifetime overlaps
|
|
78
|
+
* it, so long-open alarms appear in all of them; the merge keeps one copy.
|
|
79
|
+
*
|
|
80
|
+
* @param pageSize - Ignored: each request asks for the server's
|
|
81
|
+
* maximum. Kept for signature compatibility.
|
|
82
|
+
* @throws IncompleteAlarmSearchError when the whole range cannot be read:
|
|
83
|
+
* more alarms than one response holds at a single instant, alarms arriving
|
|
84
|
+
* or backdated into the range during the read, or the request budget spent.
|
|
85
|
+
* A partial set is never returned.
|
|
86
|
+
*/
|
|
87
|
+
getAlarms(startTime: DateTime, endTime: DateTime, includedAlarmTypes?: string[], includeClosed?: boolean, pageSize?: number, alarmFilter?: PlatformFilters.PlatformFilter, options?: AlarmWindowSearchOptions): Promise<Map<string, OIAlarm.Alarm>>;
|
|
88
|
+
/**
|
|
89
|
+
* Streams every alarm that `match` selects in `[startTime, endTime)` from the
|
|
90
|
+
* alarms analytics index (`GET oi/v2/aoanalytics/alarms/alarms_all/_search`),
|
|
91
|
+
* in open-time order — for exports over long ranges.
|
|
92
|
+
*
|
|
93
|
+
* Unlike {@link getAlarms} (the alarm search: every alarm active in the range,
|
|
94
|
+
* 1000 per request), the index filters on the open or close time directly
|
|
95
|
+
* and allows windows of 10000, so alarms that stay open do not crowd the
|
|
96
|
+
* windows. Records are the stored documents (see `AlarmRecordSchema`).
|
|
97
|
+
*
|
|
98
|
+
* @remarks Responses are validated, not thrown on. The export throws
|
|
99
|
+
* `IncompleteAlarmSearchError` when a window changes while it is read or
|
|
100
|
+
* cannot be split; records already yielded are complete and in order.
|
|
101
|
+
*/
|
|
102
|
+
exportAlarmRecords(startTime: DateTime, endTime: DateTime, match?: AlarmExportMatch, options?: AlarmExportOptions): AsyncGenerator<AlarmRecord>;
|
|
103
|
+
private searchPage;
|
|
51
104
|
/**
|
|
52
105
|
* Lists every alarm enrichment rule of the tenant
|
|
53
106
|
* (`GET oi/v2/alarm/enrichment/rules`).
|
|
@@ -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,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"alarm.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/alarm.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAgBtC,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAQ1I,OAAO,KAAK,EACV,qBAAqB,EACrB,yBAAyB,EACzB,cAAc,EACd,uBAAuB,EACxB,MAAM,sCAAsC,CAAC;AAC9C,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;AAIzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAqB,MAAM,gBAAgB,CAAC;AAE9F,OAAO,KAAK,EAAE,WAAW,EAA6B,MAAM,6BAA6B,CAAC;AAC1F,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAEvF;;;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;;;;;;;;OAQG;IACG,SAAS,CACb,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,gBAAgB,GAAE,gBAAqB,GACtC,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;IAkCrC;;;;;OAKG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM;IAoCtC,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;;;;;;;;OAQG;IACG,iBAAiB,CACrB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAuB9C;;;;;OAKG;IACG,eAAe,CACnB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,kBAAkB,GAAE,MAAM,EAAO,EACjC,aAAa,UAAQ,EACrB,QAAQ,SAAwB,EAChC,WAAW,CAAC,EAAE,eAAe,CAAC,cAAc,GAC3C,OAAO,CAAC,eAAe,CAAC;IAS3B;;;;;;;;;;;;;;OAcG;IACG,SAAS,CACb,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,kBAAkB,GAAE,MAAM,EAAO,EACjC,aAAa,UAAQ,EAErB,QAAQ,SAAM,EACd,WAAW,CAAC,EAAE,eAAe,CAAC,cAAc,EAC5C,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAiBtC;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,KAAK,GAAE,gBAA2B,EAClC,OAAO,GAAE,kBAAuB,GAC/B,cAAc,CAAC,WAAW,CAAC;YAwChB,UAAU;IAuBxB;;;;;;;OAOG;IACG,kBAAkB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IASrD;;;;;;;;OAQG;IACG,kBAAkB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,CAAC;IAUhF,qGAAqG;IAC/F,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM5D;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;KAAO,GAC7D,OAAO,CAAC,yBAAyB,CAAC;IAarC;;;;;;OAMG;IACG,0BAA0B,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAS9D,gHAAgH;IAC1G,yBAAyB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIpD,oGAAoG;IAC9F,8BAA8B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAI3E;;;;;;OAMG;IACG,0BAA0B,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAWpE;;;;;;;;OAQG;IACG,0BAA0B,CAAC,MAAM,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAYnG;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAWvD;;;;;;;OAOG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,SAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYjG;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKhE;;;;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;;;;;;;;OAQG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,SAAa,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAYtG;;;;;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,mBAAmB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IASlF;;;;;OAKG;IACG,iBAAiB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAUtF;;;;;OAKG;IACG,iBAAiB,CAAC,IAAI,EAAE,oBAAoB,EAAE,eAAe,SAAkB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAazH,8FAA8F;IACxF,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAI3G;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAS9C,gEAAgE;IAC1D,gBAAgB,CAAC,OAAO,EAAE,MAAM;CAcvC"}
|
|
@@ -9,6 +9,7 @@ import type { OIEntity } from '../model/oi/entity';
|
|
|
9
9
|
*/
|
|
10
10
|
export declare class DxoiService {
|
|
11
11
|
private dxSaaSService;
|
|
12
|
+
private readonly alarms;
|
|
12
13
|
/** @param dxSaaSService - DX SaaS HTTP client for OI endpoints */
|
|
13
14
|
constructor(dxSaaSService: DxSaasService);
|
|
14
15
|
/** Returns top-level OI services using the default service request body. */
|
|
@@ -17,11 +18,22 @@ export declare class DxoiService {
|
|
|
17
18
|
getSituations(startTime: DateTime, endTime: DateTime): Promise<OIAlarm.SituationsResponseBody>;
|
|
18
19
|
/** Returns the entity-detail attributes for a given entity external ID. */
|
|
19
20
|
getEntityAttributes(entityExternalId: string): Promise<OIEntity.EntityDetails>;
|
|
20
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Returns a single alarm by its ID.
|
|
23
|
+
* @deprecated Use `AlarmService.getAlarm` (`ServiceMonolith.dxAlarmService`).
|
|
24
|
+
*/
|
|
21
25
|
getAlarm(alarmId: string): Promise<OIAlarm.Alarm>;
|
|
22
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* Returns the lifecycle event history for a given alarm ID.
|
|
28
|
+
* @deprecated Use `AlarmService.getAlarmLifeCycle` (`ServiceMonolith.dxAlarmService`).
|
|
29
|
+
*/
|
|
23
30
|
getAlarmLifeCycle(alarmId: string): Promise<OIAlarm.AlarmLifecycleResponseBody>;
|
|
24
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Returns every open alarm in a time range.
|
|
33
|
+
* @deprecated Use `AlarmService.getAlarms`, which this now calls: it reads
|
|
34
|
+
* ranges over 1000 alarms in windows and throws `IncompleteAlarmSearchError`
|
|
35
|
+
* instead of returning a partial set (the old page loop could not end).
|
|
36
|
+
*/
|
|
25
37
|
getAlarms(startTime: DateTime, endTime: DateTime): Promise<Map<string, OIAlarm.Alarm>>;
|
|
26
38
|
}
|
|
27
39
|
//# sourceMappingURL=dxoi.service.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dxoi.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/dxoi.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"dxoi.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/dxoi.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAKnD;;;GAGG;AACH,qBAAa,WAAW;IAIV,OAAO,CAAC,aAAa;IAHjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IAEtC,kEAAkE;gBAC9C,aAAa,EAAE,aAAa;IAIhD,4EAA4E;IAC5E,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC;IASlD,uEAAuE;IACjE,aAAa,CACjB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAa1C,2EAA2E;IACrE,mBAAmB,CAAC,gBAAgB,EAAE,MAAM;IASlD;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;IAIvD;;;OAGG;IACG,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAIrF;;;;;OAKG;IACG,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;CAG7F"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Logging } from '@dx-do/util';
|
|
2
|
+
/**
|
|
3
|
+
* Events per `oi/v2/api/alarms/lifecycle/_search` request. The endpoint
|
|
4
|
+
* reports `totalCount` and pages exactly: for an alarm with 54 events and a
|
|
5
|
+
* situation with 69, pages of 10 or 20 equalled one read of 1000, same set
|
|
6
|
+
* and order (THE_LABORATORY and demo-dev, 2026-10-22).
|
|
7
|
+
*/
|
|
8
|
+
export declare const LIFECYCLE_PAGE_SIZE = 1000;
|
|
9
|
+
export interface LifecyclePage<E> {
|
|
10
|
+
totalCount: string;
|
|
11
|
+
lifecycle_events: E[];
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Reads every page of a lifecycle (alarm or situation) until the server's
|
|
15
|
+
* `totalCount` is reached. `totalCount` is returned as the server reported
|
|
16
|
+
* it; if a page comes back empty first, the result holds fewer events and a
|
|
17
|
+
* warning is logged, so a short read stays visible.
|
|
18
|
+
*/
|
|
19
|
+
export declare function readLifecyclePages<E>(fetchPage: (pageNumber: number, pageSize: number) => Promise<LifecyclePage<E>>, label: string, log: Logging.SimpleLog): Promise<LifecyclePage<E>>;
|
|
20
|
+
//# sourceMappingURL=lifecycle-pages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lifecycle-pages.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/lifecycle-pages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,OAAO,CAAC;AAExC,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,CAAC,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EACxC,SAAS,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAC9E,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,OAAO,CAAC,SAAS,GACrB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAe3B"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { DxSaasService } from './dx-saas.service';
|
|
2
2
|
import { DateTime } from 'luxon';
|
|
3
3
|
import { OIService } from '../model/oi/services';
|
|
4
|
+
import Service = OIService.Service;
|
|
4
5
|
import type { CreateServices } from '../model/oi/services.create';
|
|
5
6
|
type CreateSimpleServiceBody = CreateServices.CreateServiceBody;
|
|
6
7
|
type ServiceVertex = CreateServices.ServiceVertex;
|
|
@@ -21,6 +22,9 @@ import { ServiceSearch } from '../model/service/service-search';
|
|
|
21
22
|
import type { RetrieveServices } from '../model/oi/services.retrieve';
|
|
22
23
|
type RetrieveServiceResponse = RetrieveServices.RetrieveServiceResponse;
|
|
23
24
|
type ServiceTopologyGraph = RetrieveServices.ServiceTopologyGraph;
|
|
25
|
+
import { ServiceBulk } from '../model/oi/services.bulk';
|
|
26
|
+
import { ServiceBulkSelect } from '../model/oi/services.bulk-select';
|
|
27
|
+
import { ServiceImport } from '../model/oi/services.import';
|
|
24
28
|
/**
|
|
25
29
|
* Service for OI services: dependency graph, top-level/all services, inventory,
|
|
26
30
|
* create, delete, and helpers for service content and vertex payloads.
|
|
@@ -67,15 +71,95 @@ export declare class ServiceService {
|
|
|
67
71
|
*/
|
|
68
72
|
getServiceTopology(serviceName: string): Promise<ServiceTopologyGraph>;
|
|
69
73
|
/**
|
|
70
|
-
* Builds a faithful, re-postable store body for a service's entire subtree
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* `export-hierarchy`, `associate`, and `dissociate`.
|
|
74
|
+
* Builds a faithful, re-postable store body for a service's entire subtree
|
|
75
|
+
* (full attributes + association edges) from one hierarchy read. Shared by
|
|
76
|
+
* `export-hierarchy`, `associate`, `dissociate` and `update-service`.
|
|
74
77
|
*
|
|
75
|
-
* @
|
|
76
|
-
* are not throttled like saves.
|
|
78
|
+
* @throws Error if the service does not exist.
|
|
77
79
|
*/
|
|
78
80
|
buildHierarchyBody(rootName: string): Promise<CreateSimpleServiceBody>;
|
|
81
|
+
/**
|
|
82
|
+
* Reads every hierarchy that contains the named services into one name-keyed
|
|
83
|
+
* graph: one `GET oi/v2/sa/services/{name}?subservices=true` per service not
|
|
84
|
+
* already covered by an earlier read (the endpoint returns whole hierarchies
|
|
85
|
+
* from their top-level services down, full attributes included).
|
|
86
|
+
*
|
|
87
|
+
* @param opts.allowMissing - skip services that do not exist instead of throwing.
|
|
88
|
+
* @throws Error if a service does not exist, or a read is paged.
|
|
89
|
+
*/
|
|
90
|
+
readServiceGraph(names: string[], opts?: {
|
|
91
|
+
allowMissing?: boolean;
|
|
92
|
+
}): Promise<ServiceBulk.ServiceGraph>;
|
|
93
|
+
/**
|
|
94
|
+
* Plans changes to any number of services, in any hierarchies, without
|
|
95
|
+
* saving: reads what the changes name, applies them, and returns the
|
|
96
|
+
* per-service diff, the services the save would carry, and the store body.
|
|
97
|
+
*
|
|
98
|
+
* @throws ZodError for malformed changes; Error for an invalid change or
|
|
99
|
+
* weights over 100 %.
|
|
100
|
+
*/
|
|
101
|
+
planServiceChanges(changes: ServiceBulk.ServiceChange[]): Promise<{
|
|
102
|
+
plan: ServiceBulk.ServicePlan;
|
|
103
|
+
body: CreateSimpleServiceBody;
|
|
104
|
+
}>;
|
|
105
|
+
/**
|
|
106
|
+
* Previews one set of edits applied to every service a selector picks, saving
|
|
107
|
+
* nothing. Candidates come from `services` / `root` when given, otherwise from
|
|
108
|
+
* the services list; every criterion is then re-checked against the fresh
|
|
109
|
+
* hierarchy read the save would be built from. Edits that would change
|
|
110
|
+
* nothing on a service are reported, not emitted.
|
|
111
|
+
*
|
|
112
|
+
* @param opts.max - more services to change than this is a blocker (default 25).
|
|
113
|
+
* @throws ZodError for a malformed selector or edits; Error when nothing matches
|
|
114
|
+
* or a named service does not exist.
|
|
115
|
+
*/
|
|
116
|
+
planBulkUpdate(selector: ServiceBulkSelect.ServiceSelector, edits: ServiceBulkSelect.BulkEdit, opts?: {
|
|
117
|
+
max?: number;
|
|
118
|
+
}): Promise<ServiceBulkSelect.BulkUpdateReport>;
|
|
119
|
+
/** "No service named …", with case-insensitive suggestions from the services list. */
|
|
120
|
+
private unknownServicesMessage;
|
|
121
|
+
/**
|
|
122
|
+
* The tenant's service cap and how many services count against it
|
|
123
|
+
* (`GET oi/v2/sa/serviceLimitExceeded`).
|
|
124
|
+
*
|
|
125
|
+
* @remarks `limitExceeded` is already true when the count equals the limit (the tenant is
|
|
126
|
+
* full). The count lags deletes by one to three minutes.
|
|
127
|
+
*/
|
|
128
|
+
getServiceLimit(): Promise<{
|
|
129
|
+
limitExceeded: boolean;
|
|
130
|
+
limit: number;
|
|
131
|
+
totalServiceCnt: number;
|
|
132
|
+
}>;
|
|
133
|
+
/**
|
|
134
|
+
* Plans importing a store body (an export file) into this tenant, saving nothing:
|
|
135
|
+
* reads the target's current state for every name in the file, takes each service's
|
|
136
|
+
* metrics from the target ({@link ServiceImport.planImport}), and checks the service cap.
|
|
137
|
+
*
|
|
138
|
+
* @param opts.prefix - rename every service in the file first (cloning).
|
|
139
|
+
*/
|
|
140
|
+
planImport(file: CreateSimpleServiceBody, opts?: {
|
|
141
|
+
prefix?: string;
|
|
142
|
+
}): Promise<ServiceImport.ImportPlan & {
|
|
143
|
+
headroom: number;
|
|
144
|
+
limit: number;
|
|
145
|
+
}>;
|
|
146
|
+
/**
|
|
147
|
+
* Commits a plan in ONE save. Re-reads the plan's services and refuses when a
|
|
148
|
+
* value the plan replaces has moved; otherwise re-applies the changes onto the
|
|
149
|
+
* fresh read (so concurrent edits elsewhere are kept) and saves. A plan whose
|
|
150
|
+
* changes are already in place saves nothing (`response` is absent).
|
|
151
|
+
*
|
|
152
|
+
* @param opts.force - skip the conflict check and apply onto whatever is there now.
|
|
153
|
+
* @throws ServiceBulk.ServiceConflictError listing what moved.
|
|
154
|
+
* @remarks The server rejects an invalid payload whole — nothing is applied.
|
|
155
|
+
*/
|
|
156
|
+
commitServicePlan(plan: ServiceBulk.ServicePlan, opts?: {
|
|
157
|
+
force?: boolean;
|
|
158
|
+
}): Promise<{
|
|
159
|
+
plan: ServiceBulk.ServicePlan;
|
|
160
|
+
body: CreateSimpleServiceBody;
|
|
161
|
+
response?: CreateServiceResponse;
|
|
162
|
+
}>;
|
|
79
163
|
/** Builds a single-service store body (no edges) for `service export`. */
|
|
80
164
|
exportServiceBody(serviceName: string): Promise<CreateSimpleServiceBody>;
|
|
81
165
|
/**
|
|
@@ -85,10 +169,23 @@ export declare class ServiceService {
|
|
|
85
169
|
getServiceExternalId(serviceName: string): Promise<string>;
|
|
86
170
|
/** Returns the overview vertex for a named service; throws if not found. */
|
|
87
171
|
getServiceOverview(serviceName: string): Promise<ServiceOverviewVertex>;
|
|
88
|
-
/**
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
172
|
+
/**
|
|
173
|
+
* Returns the top-level (grouped) services, every page of them.
|
|
174
|
+
*
|
|
175
|
+
* @param pageSize - Services per request.
|
|
176
|
+
* @param maxRequests - Optional cap on the number of requests; omitted = until `groupedCnt` is reached.
|
|
177
|
+
* @remarks Stops early on an empty page; a short result (cap or empty page) is logged as a warning.
|
|
178
|
+
*/
|
|
179
|
+
getTopLevelServices(pageSize?: number, maxRequests?: number): Promise<Service[]>;
|
|
180
|
+
/**
|
|
181
|
+
* Returns all services (ungrouped), every page of them.
|
|
182
|
+
*
|
|
183
|
+
* @param pageSize - Services per request.
|
|
184
|
+
* @param maxRequests - Optional cap on the number of requests; omitted = until `totalCnt` is reached.
|
|
185
|
+
* @remarks Stops early on an empty page; a short result (cap or empty page) is logged as a warning.
|
|
186
|
+
*/
|
|
187
|
+
getAllServices(pageSize?: number, maxRequests?: number): Promise<Service[]>;
|
|
188
|
+
private fetchServicePages;
|
|
92
189
|
/** Builds a services request body scoped to parent (top-level) services. */
|
|
93
190
|
createParentServiceRequestBody(pageSize: number): OIService.ServicesRequestBody;
|
|
94
191
|
/** Builds a services request body that includes all services (no grouping). */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/service.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"service.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/service.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;AAGnC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,KAAK,uBAAuB,GAAG,cAAc,CAAC,iBAAiB,CAAC;AAChE,KAAK,aAAa,GAAG,cAAc,CAAC,aAAa,CAAC;AAClD,KAAK,qBAAqB,GAAG,cAAc,CAAC,qBAAqB,CAAC;AAClE,KAAK,qBAAqB,GAAG,cAAc,CAAC,qBAAqB,CAAC;AAClE,KAAK,2BAA2B,GAAG,cAAc,CAAC,2BAA2B,CAAC;AAC9E,KAAK,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;AACpD,KAAK,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC;AAC9C,KAAK,kBAAkB,GAAG,cAAc,CAAC,kBAAkB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAEL,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,KAAK,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,KAAK,uBAAuB,GAAG,gBAAgB,CAAC,uBAAuB,CAAC;AACxE,KAAK,oBAAoB,GAAG,gBAAgB,CAAC,oBAAoB,CAAC;AAElE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D;;;GAGG;AACH,qBAAa,cAAc;IAMvB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,GAAG;IANb;;;OAGG;gBAEO,aAAa,EAAE,aAAa,EAC5B,GAAG,GAAE,OAAO,CAAC,SAAuC;IAG9D,qEAAqE;IAC/D,yBAAyB,CAC7B,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAO1B,+EAA+E;IACzE,uBAAuB,CAC3B,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,YAAY,GAAE,YAA8B;;;;;IAiC9C,gEAAgE;IAC1D,cAAc,CAAC,aAAa,EAAE,aAAa,CAAC,wBAAwB;IAU1E,sEAAsE;IAChE,cAAc,CAClB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ;IAgBnB,iFAAiF;IAC3E,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,YAAY,GAAE,YAA8B;IAqB9C;;;;;;OAMG;IACG,UAAU,CACd,WAAW,EAAE,MAAM,EACnB,WAAW,UAAQ,GAClB,OAAO,CAAC,uBAAuB,CAAC;IAOnC;;;;;;;;;OASG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAO5E;;;;;;OAMG;IACG,kBAAkB,CACtB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,uBAAuB,CAAC;IAKnC;;;;;;;;OAQG;IACG,gBAAgB,CACpB,KAAK,EAAE,MAAM,EAAE,EACf,IAAI,GAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO,GACpC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC;IAiBpC;;;;;;;OAOG;IACG,kBAAkB,CACtB,OAAO,EAAE,WAAW,CAAC,aAAa,EAAE,GACnC,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC;QAAC,IAAI,EAAE,uBAAuB,CAAA;KAAE,CAAC;IAO5E;;;;;;;;;;OAUG;IACG,cAAc,CAClB,QAAQ,EAAE,iBAAiB,CAAC,eAAe,EAC3C,KAAK,EAAE,iBAAiB,CAAC,QAAQ,EACjC,IAAI,GAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAO,GAC1B,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC;IA0E9C,sFAAsF;YACxE,sBAAsB;IASpC;;;;;;OAMG;IACG,eAAe,IAAI,OAAO,CAAC;QAAE,aAAa,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,CAAC;IAIpG;;;;;;OAMG;IACG,UAAU,CACd,IAAI,EAAE,uBAAuB,EAC7B,IAAI,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAC7B,OAAO,CAAC,aAAa,CAAC,UAAU,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAiB1E;;;;;;;;;OASG;IACG,iBAAiB,CACrB,IAAI,EAAE,WAAW,CAAC,WAAW,EAC7B,IAAI,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAC7B,OAAO,CAAC;QACT,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC;QAC9B,IAAI,EAAE,uBAAuB,CAAC;QAC9B,QAAQ,CAAC,EAAE,qBAAqB,CAAC;KAClC,CAAC;IAeF,0EAA0E;IACpE,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAW9E;;;OAGG;IACG,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOhE,4EAA4E;IACtE,kBAAkB,CACtB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;;;OAMG;IACG,mBAAmB,CAAC,QAAQ,SAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQnF;;;;;;OAMG;IACG,cAAc,CAAC,QAAQ,SAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAQhE,iBAAiB;IAwC/B,4EAA4E;IACrE,8BAA8B,CACnC,QAAQ,EAAE,MAAM,GACf,SAAS,CAAC,mBAAmB;IAQhC,+EAA+E;IACxE,2BAA2B,CAChC,QAAQ,EAAE,MAAM,GACf,SAAS,CAAC,mBAAmB;IAShC,6EAA6E;IACvE,mBAAmB,CAAC,WAAW,EAAE,MAAM;IA0B7C,OAAO,CAAC,iCAAiC;IAQzC;;;;;;;;;;OAUG;IACG,aAAa,CACjB,iBAAiB,EAAE,uBAAuB,EAC1C,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO;IAaxD;;;;;;;;OAQG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GACxD,OAAO,CAAC,uBAAuB,CAAC;IAgCnC,8FAA8F;IACxF,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE;QACJ,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,OAAO,CAAC;KACjB,GACL,OAAO,CAAC,qBAAqB,CAAC;IAQjC;;;;;OAKG;IACG,mBAAmB,CACvB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,uBAAuB,CAAC;IAenC,sGAAsG;IAChG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,qBAAqB,CAAC;IAKjC;;;;;;;;;OASG;IACG,uBAAuB,CAC3B,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,cAAc,EAAE,EAC5B,IAAI,EAAE,KAAK,GAAG,KAAK,GAClB,OAAO,CAAC;QACT,IAAI,EAAE,uBAAuB,CAAC;QAC9B,eAAe,EAAE,cAAc,EAAE,CAAC;KACnC,CAAC;IAYF,6FAA6F;IACvF,oBAAoB,CACxB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,cAAc,EAAE,EAC5B,IAAI,EAAE,KAAK,GAAG,KAAK,GAClB,OAAO,CAAC,qBAAqB,CAAC;IASjC;;;;;;;;;;OAUG;IACG,sBAAsB,CAC1B,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC;QAAE,IAAI,EAAE,uBAAuB,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAMhE,uFAAuF;IACjF,aAAa,CACjB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAKjC,gFAAgF;IAC1E,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,UAAQ;IAQ1D,8EAA8E;IACvE,sBAAsB,CAC3B,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,QAAQ,GAAE,2BAAkC,EAC5C,kBAAkB,UAAQ,GACzB,cAAc;IAejB;;;OAGG;IACI,0BAA0B,CAC/B,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,EAC1B,8BAA8B,EAAE,OAAO,EACvC,IAAI,GAAE,MAAM,EAAO,EACnB,gBAAgB,GAAE,qBAAqB,EAAO,EAC9C,WAAW,GAAE,WAAuB,EACpC,QAAQ,SAAK,GACZ,aAAa;IAsBhB,4EAA4E;IACrE,yBAAyB,IAAI,uBAAuB;CAM5D"}
|
|
@@ -3,6 +3,7 @@ import { Situations } from '../model/situations/Situations';
|
|
|
3
3
|
import SituationSearchOperation = Situations.SituationSearchOperation;
|
|
4
4
|
import { DateTime } from 'luxon';
|
|
5
5
|
import { SituationLifecycle } from '../model/situations/SituationLifecycle';
|
|
6
|
+
import SituationLifecycleEventsResponseBody = SituationLifecycle.SituationLifecycleEventsResponseBody;
|
|
6
7
|
import { Logging } from '@dx-do/util';
|
|
7
8
|
import { SituationInspectionResponseBody } from '../model/situations/situation-inspect';
|
|
8
9
|
import type { SituationSummary } from '../model/situations/situation-summary';
|
|
@@ -26,8 +27,14 @@ export declare class SituationService {
|
|
|
26
27
|
private getSituationRequestBody;
|
|
27
28
|
/** Returns the overview record for a situation by its alarm ID. */
|
|
28
29
|
getSituationOverview(situationId: string): Promise<Situations.SituationOverview>;
|
|
29
|
-
/**
|
|
30
|
-
|
|
30
|
+
/**
|
|
31
|
+
* Returns a situation's whole lifecycle (state change) history, newest first.
|
|
32
|
+
*
|
|
33
|
+
* @remarks Reads every page until the server's `totalCount` (it used to
|
|
34
|
+
* stop at 50; a demo-dev situation had 69). A short read keeps the server's
|
|
35
|
+
* `totalCount` and logs a warning.
|
|
36
|
+
*/
|
|
37
|
+
getSituationLifecycleEvents(situationId: string): Promise<SituationLifecycleEventsResponseBody>;
|
|
31
38
|
/** Returns the inspector inspection result for a situation (related alarms, topology). */
|
|
32
39
|
getSituationInspection(situationId: string): Promise<SituationInspectionResponseBody>;
|
|
33
40
|
/** Returns all alarms belonging to a situation in a time window. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"situation.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/situation.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,wBAAwB,GAAG,UAAU,CAAC,wBAAwB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;
|
|
1
|
+
{"version":3,"file":"situation.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/situation.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,wBAAwB,GAAG,UAAU,CAAC,wBAAwB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,oCAAoC,GAAG,kBAAkB,CAAC,oCAAoC,CAAC;AACtG,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAE9E,KAAK,YAAY,GAAG,gBAAgB,CAAC,YAAY,CAAC;AAGlD;;;GAGG;AACH,qBAAa,gBAAgB;IAMzB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,GAAG;IANb;;;OAGG;gBAEO,aAAa,EAAE,aAAa,EAC5B,GAAG,GAAE,OAAO,CAAC,SAAuC;IAG9D,mGAAmG;IAC7F,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,uBAAuB,EAAE,MAAM,EAC/B,QAAQ,SAAK,EACb,MAAM,SAAU;IAwBlB,yFAAyF;IACnF,aAAa,CACjB,eAAe,EAAE,wBAAwB,EACzC,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,aAAa,UAAQ,EACrB,QAAQ,SAAK;IAcf,OAAO,CAAC,uBAAuB;IA6B/B,mEAAmE;IAC7D,oBAAoB,CAAC,WAAW,EAAE,MAAM;IAO9C;;;;;;OAMG;IACG,2BAA2B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,oCAAoC,CAAC;IAkBrG,0FAA0F;IACpF,sBAAsB,CAAC,WAAW,EAAE,MAAM;IAYhD,oEAAoE;IAC9D,kBAAkB,CACtB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,SAAK;IA6Bf,iFAAiF;IAC3E,mBAAmB,CACvB,WAAW,EAAE,MAAM,EACnB,oBAAoB,EAAE,YAAY;CA2CrC"}
|