clarion-shared-types 1.0.115 → 1.0.117

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

@@ -0,0 +1,286 @@
+import { IncidentEmergencyType } from '../../incident/enums/incident-emergency-type.enum';
+import { IncidentPriority } from '../../incident/enums/incident-priority.enum';
+import { EmergencyIncidentStage, EtaBasis, EtaStatus, IncidentActorType, IncidentArrivalSource, IncidentClosureReason, IncidentSlaEventSource, IncidentSlaEventType, IncidentSlaStage, IncidentSlaStatus, SlaEscalationLevel, SlaEscalationTrigger, SlaExceptionReason, SlaExceptionStatus, SlaOverallState, SlaPauseReason, SlaPauseStatus, SlaPolicyScope, SlaPriorityLevel } from '../enums/incident-sla-enums';
+export interface IncidentSlaExceptionDto {
+    status: SlaExceptionStatus;
+    reason: SlaExceptionReason | null;
+    note: string | null;
+    requestedBy: number | null;
+    requestedAt: string | null;
+    decidedBy: number | null;
+    decidedAt: string | null;
+    decisionNote: string | null;
+}
+export interface IncidentSlaInstanceDto {
+    id: number;
+    stage: IncidentSlaStage;
+    cycle: number;
+    responseUnitDispatchId: number | null;
+    responseUnitId: number | null;
+    responseUnitName: string | null;
+    priority: IncidentPriority;
+    status: IncidentSlaStatus;
+    targetSeconds: number | null;
+    startedAt: string | null;
+    deadlineAt: string | null;
+    originalDeadlineAt: string | null;
+    warningAt: string | null;
+    atRiskAt: string | null;
+    warnedAt: string | null;
+    atRiskSince: string | null;
+    breachedAt: string | null;
+    completedAt: string | null;
+    endedAt: string | null;
+    endReason: string | null;
+    pausedAt: string | null;
+    totalPausedSeconds: number;
+    elapsedSeconds: number | null;
+    remainingSeconds: number | null;
+    overdueSeconds: number | null;
+    exception: IncidentSlaExceptionDto | null;
+    waivedBy: number | null;
+    waivedAt: string | null;
+    waiveReason: string | null;
+    slaPolicyId: number | null;
+    slaPolicyVersion: number | null;
+}
+export type IncidentSlaTimelineState = 'DONE' | 'CURRENT' | 'PENDING' | 'SKIPPED';
+export interface IncidentSlaTimelineItemDto {
+    milestone: EmergencyIncidentStage;
+    state: IncidentSlaTimelineState;
+    at: string | null;
+    implied: boolean;
+    actorType: IncidentActorType | null;
+    source: IncidentSlaEventSource | null;
+    stage: IncidentSlaStage | null;
+    slaStatus: IncidentSlaStatus | null;
+    targetAt: string | null;
+    etaAt: string | null;
+    arrivalSource: IncidentArrivalSource | null;
+}
+export interface IncidentSlaStatsDto {
+    total: number;
+    decided: number;
+    met: number;
+    breached: number;
+    breachedWithApprovedException: number;
+    open: number;
+    warnings: number;
+    atRisk: number;
+    compliancePercent: number | null;
+    complianceWithExceptionsPercent: number | null;
+}
+export interface IncidentEtaDto {
+    dispatchId: number;
+    responseUnitId: number;
+    responseUnitName: string | null;
+    status: EtaStatus;
+    etaSeconds: number | null;
+    predictedArrivalAt: string | null;
+    distanceMetres: number | null;
+    basis: EtaBasis | null;
+    computedAt: string | null;
+    lastLocationAt: string | null;
+    locationAgeSeconds: number | null;
+    arrivalDeadlineAt: string | null;
+}
+export interface IncidentSlaPauseDto {
+    id: number;
+    instanceId: number;
+    stage: IncidentSlaStage;
+    reason: SlaPauseReason;
+    note: string | null;
+    status: SlaPauseStatus;
+    requestedBy: number | null;
+    requestedAt: string;
+    decidedBy: number | null;
+    decidedAt: string | null;
+    decisionNote: string | null;
+    startedAt: string | null;
+    endedAt: string | null;
+    pausedSeconds: number;
+}
+export interface IncidentSlaAlternativeDto {
+    responseUnitId: number;
+    responseUnitName: string | null;
+    distanceMetres: number | null;
+    etaSeconds: number | null;
+    trigger: SlaEscalationTrigger;
+    forDispatchId: number | null;
+    recommendedAt: string;
+}
+export interface IncidentSlaAllowedActionsDto {
+    acknowledge: boolean;
+    triage: boolean;
+    recordAssessment: boolean;
+    requestPause: boolean;
+    approvePause: boolean;
+    endPause: boolean;
+    requestException: boolean;
+    approveException: boolean;
+    waive: boolean;
+}
+export interface IncidentSlaClosureDto {
+    resolvedAt: string | null;
+    closedAt: string | null;
+    closureReason: IncidentClosureReason | null;
+    closedBy: number | null;
+    autoCloseEnabled: boolean;
+    autoCloseAt: string | null;
+}
+export interface IncidentSlaContributingPolicyDto {
+    policyId: number;
+    policyKey: string;
+    version: number;
+    name: string;
+    scope: SlaPolicyScope;
+}
+export interface IncidentSlaPolicyReferenceDto {
+    id: number | null;
+    key: string | null;
+    version: number | null;
+    name: string;
+    scope: SlaPolicyScope;
+    contributingPolicies: IncidentSlaContributingPolicyDto[];
+}
+/** `GET /api/incidents/:id/sla`. */
+export interface IncidentSlaSummaryDto {
+    incidentId: number;
+    tracked: boolean;
+    notTrackedReason: string | null;
+    serverTime: string;
+    priority: IncidentPriority | null;
+    priorityLevel: SlaPriorityLevel | null;
+    policy: IncidentSlaPolicyReferenceDto | null;
+    overall: SlaOverallState;
+    currentStage: EmergencyIncidentStage | null;
+    currentInstance: IncidentSlaInstanceDto | null;
+    instances: IncidentSlaInstanceDto[];
+    timeline: IncidentSlaTimelineItemDto[];
+    stats: IncidentSlaStatsDto;
+    etas: IncidentEtaDto[];
+    primaryEta: IncidentEtaDto | null;
+    pauses: IncidentSlaPauseDto[];
+    alternative: IncidentSlaAlternativeDto | null;
+    closure: IncidentSlaClosureDto;
+    allowedActions: IncidentSlaAllowedActionsDto;
+    workflowId: string | null;
+}
+/** One row of `GET /api/incidents/:id/sla/events`. */
+export interface IncidentSlaEventDto {
+    id: number;
+    eventType: IncidentSlaEventType;
+    stage: IncidentSlaStage | null;
+    cycle: number | null;
+    instanceId: number | null;
+    milestone: EmergencyIncidentStage | null;
+    fromStatus: IncidentSlaStatus | null;
+    toStatus: IncidentSlaStatus | null;
+    actorUserId: number | null;
+    actorType: IncidentActorType;
+    source: IncidentSlaEventSource;
+    reason: string | null;
+    note: string | null;
+    metadata: Record<string, unknown> | null;
+    correlationId: string | null;
+    workflowId: string | null;
+    occurredAt: string;
+    recordedAt: string;
+}
+export interface IncidentSlaEventPageDto {
+    data: IncidentSlaEventDto[];
+    total: number;
+    page: number;
+    limit: number;
+}
+/** Bodies of the SLA write routes. */
+export interface TriageEmergencyIncidentRequest {
+    priority?: IncidentPriority;
+    note?: string;
+}
+export interface RequestSlaPauseRequest {
+    reason: SlaPauseReason;
+    note?: string;
+    instanceIds?: number[];
+}
+export interface RequestSlaExceptionRequest {
+    reason: SlaExceptionReason;
+    note: string;
+}
+/** A stored SLA policy version (`GET /api/incident-sla/policies`). */
+export interface IncidentSlaPolicyDto {
+    id: number;
+    policyKey: string;
+    version: number;
+    name: string;
+    description: string | null;
+    scope: SlaPolicyScope;
+    organizationId: number | null;
+    controlCentreId: number | null;
+    categoryId: number | null;
+    typeId: number | null;
+    priority: IncidentPriority | null;
+    zoneId: number | null;
+    incidentClass: string;
+    effectiveFrom: string;
+    effectiveTo: string | null;
+    active: boolean;
+    settings: Record<string, number | boolean>;
+    priorityFloors: Partial<Record<IncidentEmergencyType, IncidentPriority>> | null;
+    startAnchors: Partial<Record<IncidentSlaStage, EmergencyIncidentStage>> | null;
+    targets: {
+        stage: IncidentSlaStage;
+        priority: IncidentPriority;
+        targetSeconds: number | null;
+    }[];
+    escalationRules: {
+        key: string;
+        trigger: SlaEscalationTrigger;
+        stages: IncidentSlaStage[];
+        priorities: IncidentPriority[];
+        level: SlaEscalationLevel;
+        channels: string[];
+        actions: string[];
+        delaySeconds: number;
+        recipientRoles: string[];
+        contacts: {
+            name?: string | null;
+            phoneNumber?: string | null;
+            email?: string | null;
+        }[];
+    }[] | null;
+    usageCount?: number;
+    createdBy: number | null;
+    updatedBy: number | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface IncidentSlaDurationPercentilesDto {
+    p50: number | null;
+    p75: number | null;
+    p90: number | null;
+    p95: number | null;
+    p99: number | null;
+    average: number | null;
+}
+export interface IncidentSlaStageAnalyticsDto {
+    stage: IncidentSlaStage;
+    instances: number;
+    met: number;
+    breached: number;
+    breachedWithApprovedException: number;
+    compliancePercent: number | null;
+    complianceWithExceptionsPercent: number | null;
+    duration: IncidentSlaDurationPercentilesDto;
+}
+/** `GET /api/incident-sla/analytics`. */
+export interface IncidentSlaAnalyticsDto {
+    from: string;
+    to: string;
+    organizationId: number | null;
+    controlCentreId: number | null;
+    incidents: number;
+    breachedIncidents: number;
+    stages: IncidentSlaStageAnalyticsDto[];
+    generatedAt: string;
+}

package/dist/types/modules/incident-sla/utils/incident-sla-display.util.d.ts

@@ -0,0 +1,38 @@
+import { EmergencyIncidentStage, EtaStatus, IncidentActorType, IncidentArrivalSource, IncidentSlaEventType, IncidentSlaStage, IncidentSlaStatus, SlaExceptionReason, SlaExceptionStatus, SlaOverallState, SlaPauseReason } from '../enums/incident-sla-enums';
+import { IncidentSlaInstanceDto } from '../interfaces/incident-sla.dto';
+/** A Clarion colour family: bg-light-{tone} text-{tone}. */
+export type SlaTone = 'success' | 'info' | 'warning' | 'error' | 'grey' | 'primary' | 'accent';
+export declare const INCIDENT_SLA_STAGE_LABELS: Readonly<Record<IncidentSlaStage, string>>;
+export declare const INCIDENT_SLA_STATUS_LABELS: Readonly<Record<IncidentSlaStatus, string>>;
+export declare const SLA_OVERALL_STATE_LABELS: Readonly<Record<SlaOverallState, string>>;
+export declare const EMERGENCY_INCIDENT_STAGE_LABELS: Readonly<Record<EmergencyIncidentStage, string>>;
+export declare const SLA_PAUSE_REASON_LABELS: Readonly<Record<SlaPauseReason, string>>;
+export declare const SLA_EXCEPTION_REASON_LABELS: Readonly<Record<SlaExceptionReason, string>>;
+export declare const SLA_EXCEPTION_STATUS_LABELS: Readonly<Record<SlaExceptionStatus, string>>;
+export declare const ETA_STATUS_LABELS: Readonly<Record<EtaStatus, string>>;
+export declare const INCIDENT_ARRIVAL_SOURCE_LABELS: Readonly<Record<IncidentArrivalSource, string>>;
+export declare const INCIDENT_ACTOR_TYPE_LABELS: Readonly<Record<IncidentActorType, string>>;
+export declare const INCIDENT_SLA_EVENT_TYPE_LABELS: Readonly<Record<IncidentSlaEventType, string>>;
+/** The colour of an instance's status chip. */
+export declare function incidentSlaStatusTone(status: IncidentSlaStatus | string | null | undefined, exceptionStatus?: SlaExceptionStatus | string | null): SlaTone;
+export declare function slaOverallStateTone(state: SlaOverallState | string | null | undefined): SlaTone;
+export declare function etaStatusTone(status: EtaStatus | string | null | undefined): SlaTone;
+/** "01:12", "12:05", "1:05:00", and overdue as "+00:45". */
+export declare function formatSlaClock(seconds: number | null | undefined): string;
+/** "15 sec", "2 min", "1 h 30 min", "1 d 2 h". */
+export declare function formatSlaTarget(seconds: number | null | undefined): string;
+/**
+ * Seconds left on an instance at the browser's `nowMs`, corrected for the
+ * difference between the server's clock and the browser's (`skewMs` = server -
+ * browser, measured when the summary arrived). Null when its clock is not
+ * running. Display only - the server decides every transition.
+ */
+export declare function liveRemainingSeconds(instance: Pick<IncidentSlaInstanceDto, 'status' | 'deadlineAt'>, nowMs: number, skewMs?: number): number | null;
+/**
+ * The status an open instance shows at `nowMs`: what the server said, or the
+ * next threshold if the clock has passed it since (the server's own event
+ * follows within seconds). Never goes backwards.
+ */
+export declare function liveIncidentSlaStatus(instance: Pick<IncidentSlaInstanceDto, 'status' | 'warningAt' | 'atRiskAt' | 'deadlineAt' | 'completedAt'>, nowMs: number, skewMs?: number): IncidentSlaStatus;
+/** Statuses whose clock is running (or paused). */
+export declare function isOpenIncidentSlaStatus(status: IncidentSlaStatus | string | null | undefined): boolean;

package/dist/types/modules/permission/enums/permission-actions.enum.d.ts

@@ -53,6 +53,9 @@ export declare enum PermissionActions {
     READ_TRACKING_HISTORY = "read:tracking-history",
     READ_TRACKING_OPERATIONS = "read:tracking-operations",
     MANAGE_TRACKING_OPERATIONS = "manage:tracking-operations",
+    READ_RESPONSE_UNIT_DISPATCH = "read:response-unit-dispatch",
+    CREATE_RESPONSE_UNIT_DISPATCH = "create:response-unit-dispatch",
+    UPDATE_RESPONSE_UNIT_DISPATCH = "update:response-unit-dispatch",
     CREATE_SUPPORT_TICKET = "create:support-ticket",
     READ_SUPPORT_TICKET = "read:support-ticket",
     UPDATE_SUPPORT_TICKET = "update:support-ticket",
@@ -190,6 +193,12 @@ export declare enum PermissionActions {
     READ_FOLLOW_ME = "read:follow-me",
     TRACK_FOLLOW_ME = "track:follow-me",
     MANAGE_SAVED_PLACE = "manage:saved-place",
+    READ_INCIDENT_SLA = "read:incident-sla",
+    UPDATE_INCIDENT_SLA = "update:incident-sla",
+    APPROVE_INCIDENT_SLA = "approve:incident-sla",
+    READ_INCIDENT_SLA_POLICY = "read:incident-sla-policy",
+    MANAGE_INCIDENT_SLA_POLICY = "manage:incident-sla-policy",
+    READ_INCIDENT_SLA_ANALYTICS = "read:incident-sla-analytics",
     /** @deprecated Retiring: split into the connection / message / screened-message / analytics actions. */
     READ_ALERT_INTAKE = "read:alert-intake",
     /** @deprecated Retiring: split into the connection / message / screened-message / analytics actions. */

package/dist/types/modules/permission/enums/permissions-moudule.enum.d.ts

@@ -8,11 +8,13 @@ export declare enum PermissionsModule {
     INCIDENT = "Grievance",
     RESPONSE_UNIT = "Response Unit",
     TRACKING = "Tracking",
+    RESPONSE_UNIT_DISPATCH = "Response Unit Dispatch",
     BILLING = "Billing",
     NEWSFEED = "Newsfeed",
     SUPPORT = "Support",
     NOTIFICATION = "Notification",
     ALERT_INTAKE = "Alert Intake",
     SAFETY = "Safety",
-    PLACES = "Places"
+    PLACES = "Places",
+    INCIDENT_SLA = "Incident SLA"
 }

package/dist/types/modules/response-unit/enums/response-unit/response-capability.enum.d.ts

@@ -0,0 +1,22 @@
+/**
+ * What kind of emergency a response unit can answer. Mirrors
+ * grm-shared-library's ResponseCapability.
+ *
+ * A unit with no configured capabilities is treated as having what its type
+ * implies (an ambulance is MEDICAL_RESPONSE, a security vehicle
+ * SECURITY_RESPONSE), so configuring them is only needed where a unit differs
+ * from its type.
+ */
+export declare enum ResponseCapability {
+    MEDICAL_RESPONSE = "MEDICAL_RESPONSE",
+    SECURITY_RESPONSE = "SECURITY_RESPONSE",
+    FIRE_RESPONSE = "FIRE_RESPONSE",
+    ROADSIDE_ASSISTANCE = "ROADSIDE_ASSISTANCE"
+}
+/** Can a unit be sent right now - from its manual status and its active dispatches. */
+export declare enum ResponseUnitAvailability {
+    AVAILABLE = "AVAILABLE",
+    ENGAGED = "ENGAGED",
+    UNAVAILABLE = "UNAVAILABLE",
+    INACTIVE = "INACTIVE"
+}

package/dist/types/modules/response-unit/index.d.ts

@@ -10,6 +10,7 @@ export * from './interfaces/vehicle-unit/vehicle-type/security-vehicle';
 export * from './interfaces/vehicle-unit/vehicle-type/fire-vehicle';
 export * from './interfaces/vehicle-unit/vehicle-type/road-rescue-vehicle';
 export * from './enums/response-unit/response-unit-type.enum';
+export * from './enums/response-unit/response-capability.enum';
 export * from './enums/person-unit/person-unit-category.enum';
 export * from './enums/person-unit/person-unit-status.enum';
 export * from './enums/vehicle-unit/vehicle-unit-ownership.enum';

package/dist/types/modules/response-unit/interfaces/response-unit/response-unit.d.ts

@@ -1,5 +1,6 @@
 import { MapAddress, MapLocation } from "../../../common";
 import { ResponseUnitType } from "../../enums/response-unit/response-unit-type.enum";
+import { ResponseCapability } from "../../enums/response-unit/response-capability.enum";
 export interface ResponseUnit {
     id: number;
     name: string;
@@ -11,6 +12,8 @@ export interface ResponseUnit {
         name: string;
         address: MapAddress;
     };
+    /** Configured capabilities; empty = derived from the unit's type. */
+    capabilities?: ResponseCapability[];
     controlCentreId: number;
     organizationId: number;
     createdAt?: Date;

package/package.json

@@ -1,45 +1,45 @@
-{
-  "name": "clarion-shared-types",
-  "version": "1.0.115",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    },
-    "./dist/modules/*": {
-      "types": "./dist/types/modules/*.d.ts",
-      "import": "./dist/esm/modules/*.js",
-      "require": "./dist/cjs/modules/*.js"
-    }
-  },
-  "files": [
-    "dist/**/*"
-  ],
-  "scripts": {
-    "clean": "rimraf dist dist-test",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:types": "tsc -p tsconfig.types.json",
-    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:esm",
-    "prepublishOnly": "npm run build",
-    "pretest": "rimraf dist-test",
-    "test": "tsc -p tsconfig.spec.json && node --test \"dist-test/**/*.spec.js\""
-  },
-  "keywords": [],
-  "author": "vince_lawino",
-  "license": "ISC",
-  "description": "",
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/geojson": "^7946.0.16",
-    "@types/node": "^20.11.2",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.7.3"
-  }
-}
+{
+  "name": "clarion-shared-types",
+  "version": "1.0.117",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./dist/modules/*": {
+      "types": "./dist/types/modules/*.d.ts",
+      "import": "./dist/esm/modules/*.js",
+      "require": "./dist/cjs/modules/*.js"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "clean": "rimraf dist dist-test",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:esm",
+    "prepublishOnly": "npm run build",
+    "pretest": "rimraf dist-test",
+    "test": "tsc -p tsconfig.spec.json && node --test \"dist-test/**/*.spec.js\""
+  },
+  "keywords": [],
+  "author": "vince_lawino",
+  "license": "ISC",
+  "description": "",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/geojson": "^7946.0.16",
+    "@types/node": "^20.11.2",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.7.3"
+  }
+}