grm-shared-library 1.1.238 → 1.1.239

package/dist/cjs/modules/incident-sla/dtos/incident-sla-analytics-query.dto.js

@@ -15,24 +15,33 @@ const class_transformer_1 = require("class-transformer");
 const class_validator_1 = require("class-validator");
 const incident_priority_enum_1 = require("../../incident/enums/incident-priority.enum");
 const incident_sla_stage_enum_1 = require("../enums/incident-sla-stage.enum");
-/** `GET /incident-sla/analytics` - by instance start time, default the last 30 days. */
+/**
+ * `GET /incident-sla/analytics` - the emergencies raised in a period. Both ends
+ * optional: no `from` is "forever", no `to` is now.
+ */
 class IncidentSlaAnalyticsQueryDto {
 }
 exports.IncidentSlaAnalyticsQueryDto = IncidentSlaAnalyticsQueryDto;
 __decorate([
-    (0, swagger_1.ApiPropertyOptional)(),
+    (0, swagger_1.ApiPropertyOptional)({ example: '2026-09-01T00:00:00+03:00', description: 'Inclusive. Omit for "forever".' }),
     (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsISO8601)(),
+    (0, class_validator_1.IsISO8601)({ strict: true }),
     __metadata("design:type", String)
 ], IncidentSlaAnalyticsQueryDto.prototype, "from", void 0);
 __decorate([
-    (0, swagger_1.ApiPropertyOptional)(),
+    (0, swagger_1.ApiPropertyOptional)({ example: '2026-09-30T23:59:59+03:00', description: 'Exclusive. Omit for "now".' }),
     (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsISO8601)(),
+    (0, class_validator_1.IsISO8601)({ strict: true }),
     __metadata("design:type", String)
 ], IncidentSlaAnalyticsQueryDto.prototype, "to", void 0);
 __decorate([
-    (0, swagger_1.ApiPropertyOptional)(),
+    (0, swagger_1.ApiPropertyOptional)({ example: 'Africa/Nairobi', description: 'IANA time zone for the chart buckets and the hour-of-week grid.' }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsTimeZone)(),
+    __metadata("design:type", String)
+], IncidentSlaAnalyticsQueryDto.prototype, "timeZone", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Super-Admin only' }),
     (0, class_validator_1.IsOptional)(),
     (0, class_transformer_1.Type)(() => Number),
     (0, class_validator_1.IsInt)(),

package/dist/cjs/modules/incident-sla/dtos/incident-sla-analytics-query.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"incident-sla-analytics-query.dto.js","sourceRoot":"","sources":["../../../../../src/modules/incident-sla/dtos/incident-sla-analytics-query.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAsD;AACtD,yDAAyC;AACzC,qDAAmF;AACnF,wFAA+E;AAC/E,8EAAoE;AAEpE,wFAAwF;AACxF,MAAa,4BAA4B;CA4BxC;AA5BD,oEA4BC;AA1BG;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,2BAAS,GAAE;;0DACnC;AAGd;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,2BAAS,GAAE;;wDACrC;AAIZ;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;oEACvD;AAGxB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;qEACtD;AAGzB;IADC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,yCAAgB,EAAE,CAAC;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAM,EAAC,yCAAgB,CAAC;;8DAC5D;AAG5B;IADC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,0CAAgB,EAAE,CAAC;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAM,EAAC,0CAAgB,CAAC;;2DAC/D;AAGzB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;4DAC/D;AAGhB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;gEAC3D;AAGpB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;oEACvD"}
+{"version":3,"file":"incident-sla-analytics-query.dto.js","sourceRoot":"","sources":["../../../../../src/modules/incident-sla/dtos/incident-sla-analytics-query.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAsD;AACtD,yDAAyC;AACzC,qDAA+F;AAC/F,wFAA+E;AAC/E,8EAAoE;AAEpE;;;GAGG;AACH,MAAa,4BAA4B;CAsCxC;AAtCD,oEAsCC;AAnCG;IAFC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;IAC5G,IAAA,4BAAU,GAAE;IAAE,IAAA,2BAAS,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;0DAC5B;AAId;IAFC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,4BAA4B,EAAE,CAAC;IACxG,IAAA,4BAAU,GAAE;IAAE,IAAA,2BAAS,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;wDAC9B;AAIZ;IAFC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iEAAiE,EAAE,CAAC;IAClI,IAAA,4BAAU,GAAE;IAAE,IAAA,4BAAU,GAAE;;8DACT;AAIlB;IADC,IAAA,6BAAmB,EAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;oEAC1F;AAIxB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;qEACtD;AAIzB;IADC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,yCAAgB,EAAE,CAAC;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAM,EAAC,yCAAgB,CAAC;;8DAC5D;AAI5B;IADC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,0CAAgB,EAAE,CAAC;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAM,EAAC,0CAAgB,CAAC;;2DAC/D;AAGzB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;4DAC/D;AAGhB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;gEAC3D;AAIpB;IADC,IAAA,6BAAmB,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;oEACvD"}

package/dist/esm/modules/incident-sla/dtos/incident-sla-analytics-query.dto.js

@@ -9,26 +9,35 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 import { ApiPropertyOptional } from '@nestjs/swagger';
 import { Type } from 'class-transformer';
-import { IsEnum, IsInt, IsISO8601, IsOptional, IsPositive } from 'class-validator';
+import { IsEnum, IsInt, IsISO8601, IsOptional, IsPositive, IsTimeZone } from 'class-validator';
 import { IncidentPriority } from '../../incident/enums/incident-priority.enum';
 import { IncidentSlaStage } from '../enums/incident-sla-stage.enum';
-/** `GET /incident-sla/analytics` - by instance start time, default the last 30 days. */
+/**
+ * `GET /incident-sla/analytics` - the emergencies raised in a period. Both ends
+ * optional: no `from` is "forever", no `to` is now.
+ */
 export class IncidentSlaAnalyticsQueryDto {
 }
 __decorate([
-    ApiPropertyOptional(),
+    ApiPropertyOptional({ example: '2026-09-01T00:00:00+03:00', description: 'Inclusive. Omit for "forever".' }),
     IsOptional(),
-    IsISO8601(),
+    IsISO8601({ strict: true }),
     __metadata("design:type", String)
 ], IncidentSlaAnalyticsQueryDto.prototype, "from", void 0);
 __decorate([
-    ApiPropertyOptional(),
+    ApiPropertyOptional({ example: '2026-09-30T23:59:59+03:00', description: 'Exclusive. Omit for "now".' }),
     IsOptional(),
-    IsISO8601(),
+    IsISO8601({ strict: true }),
     __metadata("design:type", String)
 ], IncidentSlaAnalyticsQueryDto.prototype, "to", void 0);
 __decorate([
-    ApiPropertyOptional(),
+    ApiPropertyOptional({ example: 'Africa/Nairobi', description: 'IANA time zone for the chart buckets and the hour-of-week grid.' }),
+    IsOptional(),
+    IsTimeZone(),
+    __metadata("design:type", String)
+], IncidentSlaAnalyticsQueryDto.prototype, "timeZone", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'Super-Admin only' }),
     IsOptional(),
     Type(() => Number),
     IsInt(),

package/dist/esm/modules/incident-sla/dtos/incident-sla-analytics-query.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"incident-sla-analytics-query.dto.js","sourceRoot":"","sources":["../../../../../src/modules/incident-sla/dtos/incident-sla-analytics-query.dto.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAEpE,wFAAwF;AACxF,MAAM,OAAO,4BAA4B;CA4BxC;AA1BG;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,SAAS,EAAE;;0DACnC;AAGd;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,SAAS,EAAE;;wDACrC;AAIZ;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;oEACvD;AAGxB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;qEACtD;AAGzB;IADC,mBAAmB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAAE,UAAU,EAAE;IAAE,MAAM,CAAC,gBAAgB,CAAC;;8DAC5D;AAG5B;IADC,mBAAmB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAAE,UAAU,EAAE;IAAE,MAAM,CAAC,gBAAgB,CAAC;;2DAC/D;AAGzB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;4DAC/D;AAGhB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;gEAC3D;AAGpB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;oEACvD"}
+{"version":3,"file":"incident-sla-analytics-query.dto.js","sourceRoot":"","sources":["../../../../../src/modules/incident-sla/dtos/incident-sla-analytics-query.dto.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,4BAA4B;CAsCxC;AAnCG;IAFC,mBAAmB,CAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;IAC5G,UAAU,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;0DAC5B;AAId;IAFC,mBAAmB,CAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,4BAA4B,EAAE,CAAC;IACxG,UAAU,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;wDAC9B;AAIZ;IAFC,mBAAmB,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iEAAiE,EAAE,CAAC;IAClI,UAAU,EAAE;IAAE,UAAU,EAAE;;8DACT;AAIlB;IADC,mBAAmB,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;oEAC1F;AAIxB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;qEACtD;AAIzB;IADC,mBAAmB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAAE,UAAU,EAAE;IAAE,MAAM,CAAC,gBAAgB,CAAC;;8DAC5D;AAI5B;IADC,mBAAmB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAAE,UAAU,EAAE;IAAE,MAAM,CAAC,gBAAgB,CAAC;;2DAC/D;AAGzB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;4DAC/D;AAGhB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;gEAC3D;AAIpB;IADC,mBAAmB,EAAE;IAAE,UAAU,EAAE;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;oEACvD"}

package/dist/types/modules/incident-sla/dtos/incident-sla-analytics-query.dto.d.ts

@@ -1,15 +1,23 @@
 import { IncidentPriority } from '../../incident/enums/incident-priority.enum';
 import { IncidentSlaStage } from '../enums/incident-sla-stage.enum';
-/** `GET /incident-sla/analytics` - by instance start time, default the last 30 days. */
+/**
+ * `GET /incident-sla/analytics` - the emergencies raised in a period. Both ends
+ * optional: no `from` is "forever", no `to` is now.
+ */
 export declare class IncidentSlaAnalyticsQueryDto {
     from?: string;
     to?: string;
+    timeZone?: string;
     /** Honoured for Super-Admin only; everybody else is held to their own scope. */
     organizationId?: number;
+    /** Narrows an organization's figures to one control centre; a control centre's staff are held to their own. */
     controlCentreId?: number;
+    /** The priority each emergency was measured at. */
     priority?: IncidentPriority;
+    /** Narrows the stage figures (compliance, durations) to one stage. */
     stage?: IncidentSlaStage;
     typeId?: number;
     categoryId?: number;
+    /** The emergencies a unit was dispatched to. */
     responseUnitId?: number;
 }

package/dist/types/modules/incident-sla/interfaces/incident-sla-analytics.d.ts

@@ -1,4 +1,50 @@
+import { IncidentPriority } from '../../incident/enums/incident-priority.enum';
 import { IncidentSlaStage } from '../enums/incident-sla-stage.enum';
+import { SlaPriorityLevel } from '../enums/sla-overall-state.enum';
+/**
+ * Emergency SLA analytics (the admin's SLA Analytics): how fast the control room
+ * and the response units answered the emergencies raised over a period, stage by
+ * stage, against the targets of the policy each emergency ran under - and what
+ * happened when they did not (escalations, alternative units, pauses, exceptions,
+ * notifications).
+ *
+ * One read, computed by clarion-incident from one consistent snapshot. Counts,
+ * rates and durations only.
+ *
+ * How it is counted:
+ *  - Everything belongs to the period its EMERGENCY was raised in (the incident's
+ *    creation): its stage clocks, dispatches, escalations and notifications, even
+ *    when they happened after the period ended. So every figure on the page is
+ *    about the same emergencies.
+ *  - Compliance = met / (met + breached), over stage clocks that were decided.
+ *    An approved exception shows in its own figure; the breach stays a breach.
+ *  - Durations are in SECONDS, measured from the incident's creation (the SLA's
+ *    start) unless the field says otherwise; stage durations exclude paused time.
+ *  - Only measured emergencies count: INCIDENT class, reaching a control room.
+ */
+/** How the period is cut into points for the charts. Chosen by the service from the length of the period. */
+export type IncidentSlaAnalyticsBucket = 'hour' | 'day' | 'week' | 'month';
+export interface IncidentSlaAnalyticsRange {
+    /** Inclusive, ISO 8601. The first emergency when the period asked for was "forever". */
+    from: string;
+    /** Exclusive, ISO 8601. */
+    to: string;
+    bucket: IncidentSlaAnalyticsBucket;
+    /** IANA time zone the buckets and the hour-of-week grid are cut in. */
+    timeZone: string;
+}
+/** A count by a key, largest first unless the section says otherwise. */
+export interface IncidentSlaAnalyticsCount<K extends string = string> {
+    key: K;
+    count: number;
+}
+/** Median and 90th percentile of one duration, in seconds; null when nothing was measured. */
+export interface IncidentSlaDurationSummary {
+    median: number | null;
+    p90: number | null;
+    /** How many were measured. */
+    count: number;
+}
 /**
  * Durations at percentiles, in seconds. Percentiles are the point: an average
  * hides the slow tail, and the slow tail is the emergency that went wrong.
@@ -10,26 +56,301 @@ export interface IncidentSlaDurationPercentiles {
     p95: number | null;
     p99: number | null;
     average: number | null;
+    /** How many were measured. */
+    count: number;
+}
+/** The headline figures of a period. */
+export interface IncidentSlaAnalyticsSummary {
+    /** Measured emergencies raised in the period. */
+    emergencies: number;
+    /** Of those, still being worked (not yet closed / ended). */
+    openNow: number;
+    /** With at least one breached stage. */
+    breachedEmergencies: number;
+    breachedEmergencyPercent: number | null;
+    /** Stage clocks decided: met + breached. */
+    decided: number;
+    met: number;
+    breached: number;
+    breachedWithApprovedException: number;
+    compliancePercent: number | null;
+    complianceWithExceptionsPercent: number | null;
+    acknowledged: number;
+    dispatched: number;
+    /** A unit reached the scene. */
+    arrived: number;
+    resolved: number;
+    closed: number;
+    autoClosed: number;
+    /** Raised to acknowledged. */
+    timeToAcknowledge: IncidentSlaDurationSummary;
+    /** Raised to the first dispatch. */
+    timeToDispatch: IncidentSlaDurationSummary;
+    /** Raised to the first unit on scene - the response time the reporter lives through. */
+    timeToArrival: IncidentSlaDurationSummary;
+    /** First unit assigned to first unit on scene - the travel. */
+    travelTime: IncidentSlaDurationSummary;
+    /** Raised to resolved. */
+    timeToResolve: IncidentSlaDurationSummary;
+    escalations: number;
+    alternativesRecommended: number;
+    reassignments: number;
+    /** Notification requests that reached nobody or only some (FAILED, PARTIAL). */
+    notificationsFailed: number;
 }
+/** One stage across the period's emergencies. */
 export interface IncidentSlaStageAnalytics {
     stage: IncidentSlaStage;
+    /** Clocks of this stage (one per dispatch for acceptance and mobilization). */
     instances: number;
     met: number;
     breached: number;
     breachedWithApprovedException: number;
+    /** Still running, or paused. */
+    open: number;
+    waived: number;
+    /** Ended with the incident before its milestone (expired), or never started (cancelled). */
+    expired: number;
+    cancelled: number;
+    /** Reached the warning (75 %) / at-risk (90 %) mark. */
+    warned: number;
+    atRisk: number;
     compliancePercent: number | null;
     complianceWithExceptionsPercent: number | null;
-    /** Start to milestone, pauses excluded, over the instances that reached it. */
+    /** The target most of these clocks ran against (median), seconds. */
+    targetSeconds: number | null;
+    /** Start to milestone, pauses excluded, over the clocks that reached it. */
     duration: IncidentSlaDurationPercentiles;
+    /** By how much the breached ones were late. */
+    overrun: IncidentSlaDurationSummary;
+}
+/** One stage of one priority, for the priority × stage grid. */
+export interface IncidentSlaStageCell {
+    stage: IncidentSlaStage;
+    met: number;
+    breached: number;
+    compliancePercent: number | null;
+    medianSeconds: number | null;
+}
+export interface IncidentSlaPriorityRow {
+    priority: IncidentPriority;
+    level: SlaPriorityLevel;
+    emergencies: number;
+    breachedEmergencies: number;
+    met: number;
+    breached: number;
+    compliancePercent: number | null;
+    medianSecondsToAcknowledge: number | null;
+    medianSecondsToArrival: number | null;
+    stages: IncidentSlaStageCell[];
+}
+/** One point of the charts. `bucket` is its start, local to the range's zone, without an offset. */
+export interface IncidentSlaTimelinePoint {
+    bucket: string;
+    emergencies: number;
+    breachedEmergencies: number;
+    met: number;
+    breached: number;
+    compliancePercent: number | null;
+    medianSecondsToAcknowledge: number | null;
+    medianSecondsToArrival: number | null;
+    escalations: number;
+}
+export interface IncidentSlaControlCentreRow {
+    /** Null: emergencies no control centre was set on. */
+    controlCentreId: number | null;
+    emergencies: number;
+    breachedEmergencies: number;
+    met: number;
+    breached: number;
+    compliancePercent: number | null;
+    medianSecondsToAcknowledge: number | null;
+    medianSecondsToDispatch: number | null;
+    medianSecondsToArrival: number | null;
+    escalations: number;
+}
+export interface IncidentSlaTypeRow {
+    typeId: number | null;
+    typeName: string | null;
+    categoryId: number | null;
+    categoryName: string | null;
+    emergencies: number;
+    breachedEmergencies: number;
+    met: number;
+    breached: number;
+    compliancePercent: number | null;
+    medianSecondsToArrival: number | null;
+}
+export interface IncidentSlaResponseUnitRow {
+    responseUnitId: number;
+    responseUnitName: string;
+    dispatches: number;
+    /** Acknowledged the dispatch (accepted). */
+    accepted: number;
+    declined: number;
+    stoodDown: number;
+    arrived: number;
+    /** Arrivals inferred from the unit's live tracking. */
+    arrivalsInferred: number;
+    /** The acceptance clock, for this unit. */
+    acceptanceMet: number;
+    acceptanceBreached: number;
+    acceptanceCompliancePercent: number | null;
+    medianSecondsToAccept: number | null;
+    /** Accepted to en route. */
+    medianSecondsToMobilize: number | null;
+    /** Dispatched to on scene. */
+    medianSecondsToArrive: number | null;
+}
+export interface IncidentSlaArrivalAnalytics {
+    arrivals: number;
+    /** How each first arrival is known: inferred from tracking, the responder, the control room (UNKNOWN for older ones). */
+    bySource: IncidentSlaAnalyticsCount[];
+    inferredPercent: number | null;
+    /** Dispatches whose live ETA turned at risk / likely late / uncertain at least once. */
+    etaAtRisk: number;
+    etaLikelyLate: number;
+    etaUncertain: number;
+    /** Emergencies a unit was predicted late for, and of those, how many breached the arrival target. */
+    predictedLate: number;
+    predictedLateAndBreached: number;
+    /** predictedLateAndBreached / predictedLate. */
+    latePredictionPrecisionPercent: number | null;
+    /** How far the first ETA was from the actual arrival (absolute seconds). */
+    firstEtaError: IncidentSlaDurationSummary;
+    /** Straight-line distance of the unit when dispatched, metres. */
+    distanceAtDispatch: IncidentSlaDurationSummary;
+}
+export interface IncidentSlaEscalationAnalytics {
+    total: number;
+    /** SLA_BREACHED, SLA_AT_RISK, ETA_LIKELY_BREACH, DISPATCH_REJECTED... */
+    byTrigger: IncidentSlaAnalyticsCount[];
+    /** DISPATCHER, SUPERVISOR, DUTY_MANAGER, ORGANIZATION_ADMIN. */
+    byLevel: IncidentSlaAnalyticsCount[];
+    byStage: IncidentSlaAnalyticsCount[];
+    /** The policy rules that fired most - the ten commonest. */
+    byRule: IncidentSlaAnalyticsCount[];
+    alternativesRecommended: number;
+    reassignments: number;
+    /** Emergencies escalated at least once. */
+    escalatedEmergencies: number;
+}
+export interface IncidentSlaPauseAnalytics {
+    requested: number;
+    approved: number;
+    rejected: number;
+    /** Waiting for a supervisor. */
+    pending: number;
+    withdrawn: number;
+    totalPausedSeconds: number;
+    pausedTime: IncidentSlaDurationSummary;
+    byReason: IncidentSlaAnalyticsCount[];
+}
+export interface IncidentSlaExceptionAnalytics {
+    requested: number;
+    approved: number;
+    rejected: number;
+    pending: number;
+    byReason: IncidentSlaAnalyticsCount[];
+}
+export interface IncidentSlaNotificationEventRow {
+    /** emergency-created, emergency-sla-breached... */
+    event: string;
+    requests: number;
+    failed: number;
+}
+export interface IncidentSlaNotificationChannelRow {
+    channel: string;
+    recipients: number;
+    sent: number;
+    failed: number;
+    successPercent: number | null;
+}
+export interface IncidentSlaNotificationAnalytics {
+    /** Requests clarion-notification answered. */
+    requests: number;
+    /** SENT, PARTIAL, FAILED, NOT_POSSIBLE. */
+    byStatus: IncidentSlaAnalyticsCount[];
+    byEvent: IncidentSlaNotificationEventRow[];
+    byChannel: IncidentSlaNotificationChannelRow[];
+    /** By audience: REPORTER, DISPATCHER, SUPERVISOR... (people reached). */
+    byAudience: IncidentSlaAnalyticsCount[];
+}
+export interface IncidentSlaClosureAnalytics {
+    resolved: number;
+    closed: number;
+    manual: number;
+    automatic: number;
+    /** Resolved and not closed yet. */
+    awaitingClosure: number;
+    /** Emergencies whose automatic closure waited for a unit still out. */
+    autoCloseDeferred: number;
+    resolvedToClosed: IncidentSlaDurationSummary;
+}
+/** One hour of one weekday (1 = Monday), in the range's zone. */
+export interface IncidentSlaHeatmapCell {
+    weekday: number;
+    hour: number;
+    emergencies: number;
+    breachedEmergencies: number;
+}
+/** The emergencies that went most wrong - by total time over target. */
+export interface IncidentSlaWorstIncident {
+    incidentId: number;
+    /** `#1234`. */
+    reference: string;
+    priority: IncidentPriority;
+    typeName: string | null;
+    controlCentreId: number | null;
+    createdAt: string;
+    breachedStages: number;
+    worstStage: IncidentSlaStage | null;
+    maxOverrunSeconds: number;
+    totalOverrunSeconds: number;
+    timeToArrivalSeconds: number | null;
+}
+/** A Super-Admin's platform view: one row per organization. */
+export interface IncidentSlaOrganizationRow {
+    organizationId: number;
+    emergencies: number;
+    breachedEmergencies: number;
+    met: number;
+    breached: number;
+    compliancePercent: number | null;
+    medianSecondsToAcknowledge: number | null;
+    medianSecondsToArrival: number | null;
 }
 /** `GET /incident-sla/analytics`. */
-export interface IncidentSlaAnalyticsResult {
-    from: string;
-    to: string;
+export interface IncidentSlaAnalytics {
+    range: IncidentSlaAnalyticsRange;
+    /** The organization the figures are for; null in a Super-Admin's platform view. */
     organizationId: number | null;
     controlCentreId: number | null;
-    incidents: number;
-    breachedIncidents: number;
+    /** A Super-Admin across every organization (`byOrganization` is filled). */
+    platform: boolean;
+    summary: IncidentSlaAnalyticsSummary;
+    /** The previous period of the same length; null for "forever". */
+    previous: IncidentSlaAnalyticsSummary | null;
     stages: IncidentSlaStageAnalytics[];
+    /** Critical, High, Medium, Low - in that order, zeros included. */
+    byPriority: IncidentSlaPriorityRow[];
+    timeline: IncidentSlaTimelinePoint[];
+    byControlCentre: IncidentSlaControlCentreRow[];
+    byType: IncidentSlaTypeRow[];
+    /** The 25 units dispatched most. */
+    byResponseUnit: IncidentSlaResponseUnitRow[];
+    arrival: IncidentSlaArrivalAnalytics;
+    escalations: IncidentSlaEscalationAnalytics;
+    pauses: IncidentSlaPauseAnalytics;
+    exceptions: IncidentSlaExceptionAnalytics;
+    notifications: IncidentSlaNotificationAnalytics;
+    closure: IncidentSlaClosureAnalytics;
+    /** emergency, panic... (the alert's own kind). */
+    emergencyTypes: IncidentSlaAnalyticsCount[];
+    heatmap: IncidentSlaHeatmapCell[];
+    worstIncidents: IncidentSlaWorstIncident[];
+    byOrganization: IncidentSlaOrganizationRow[];
     generatedAt: string;
 }
+/** The name the first release used. */
+export type IncidentSlaAnalyticsResult = IncidentSlaAnalytics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grm-shared-library",
-  "version": "1.1.238",
+  "version": "1.1.239",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",