clarion-shared-types 1.0.115 → 1.0.116

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

@@ -0,0 +1,166 @@
+import { ResponseCapability, ResponseUnitAvailability } from '../../response-unit/enums/response-unit/response-capability.enum';
+import { IncidentDispatchBlocker, ResponseCapabilityRequirementSource, ResponseUnitCapabilityMatch, ResponseUnitDispatchConstraint, ResponseUnitDispatchNotificationFailure, ResponseUnitDispatchNotificationStatus, ResponseUnitDispatchStatus, ResponseUnitDispatchTransitionSource, ResponseUnitDistanceBasis, ResponseUnitLocationFreshness, ResponseUnitLocationSource, ResponseUnitRecommendationReason, ResponseUnitRecommendationStatus } from '../enums/response-unit-dispatch-enums';
+export interface ResponseCapabilityRequirementDto {
+    capabilities: ResponseCapability[];
+    source: ResponseCapabilityRequirementSource;
+}
+export interface ResponseUnitCandidateLocationDto {
+    source: ResponseUnitLocationSource;
+    freshness: ResponseUnitLocationFreshness;
+    latitude: number | null;
+    longitude: number | null;
+    recordedAt: string | null;
+    ageSeconds: number | null;
+    accuracyMetres: number | null;
+}
+export interface ResponseUnitTravelEstimateDto {
+    distanceMetres: number;
+    durationSeconds: number | null;
+    basis: ResponseUnitDistanceBasis;
+    trafficAware: boolean;
+}
+export interface ResponseUnitCandidateDto {
+    responseUnitId: number;
+    name: string;
+    responseUnitType: string;
+    vehicleType: string | null;
+    registrationNumber: string | null;
+    controlCentreId: number | null;
+    sameControlCentre: boolean;
+    operationalStatus: string | null;
+    availability: ResponseUnitAvailability;
+    engagedIncidentId: number | null;
+    capabilities: ResponseCapability[];
+    capabilityMatch: ResponseUnitCapabilityMatch;
+    matchedCapabilities: ResponseCapability[];
+    location: ResponseUnitCandidateLocationDto;
+    distanceMetres: number | null;
+    travel: ResponseUnitTravelEstimateDto | null;
+    hasPhoneNumber: boolean;
+    dispatchable: boolean;
+    recommendable: boolean;
+    constraints: ResponseUnitDispatchConstraint[];
+    reasons: ResponseUnitRecommendationReason[];
+    rank: number | null;
+}
+export interface ResponseUnitRecommendationSummaryDto {
+    configuredUnits: number;
+    dispatchableUnits: number;
+    recommendableUnits: number;
+    engagedUnits: number;
+    unavailableUnits: number;
+    unitsWithoutLocation: number;
+    truncated: boolean;
+}
+export interface ResponseUnitDispatchUnitSnapshotDto {
+    availability: ResponseUnitAvailability;
+    operationalStatus: string | null;
+    capabilities: ResponseCapability[];
+    capabilityMatch: ResponseUnitCapabilityMatch;
+    sameControlCentre: boolean;
+    locationSource: ResponseUnitLocationSource;
+    locationFreshness: ResponseUnitLocationFreshness;
+    locationRecordedAt: string | null;
+    locationAgeSeconds: number | null;
+    distanceMetres: number | null;
+    hasPhoneNumber: boolean;
+}
+export interface ResponseUnitDispatchRecommendationSnapshotDto {
+    generatedAt: string;
+    status: ResponseUnitRecommendationStatus;
+    recommendedResponseUnitId: number | null;
+    ranked: Array<{
+        responseUnitId: number;
+        rank: number;
+        distanceMetres: number | null;
+        capabilityMatch: ResponseUnitCapabilityMatch;
+        locationFreshness: ResponseUnitLocationFreshness;
+    }>;
+    requiredCapabilities: ResponseCapability[];
+    requirementSource: ResponseCapabilityRequirementSource;
+    liveTrackingAvailable: boolean;
+}
+export interface ResponseUnitDispatchNotificationStateDto {
+    channel: 'SMS';
+    status: ResponseUnitDispatchNotificationStatus;
+    failureReason: ResponseUnitDispatchNotificationFailure | null;
+    /** Masked (+2547******78). */
+    recipient: string | null;
+    attempts: number;
+    requestedAt: string | null;
+    resultAt: string | null;
+    providerCode: string | null;
+}
+/** One response unit sent to one incident. */
+export interface IncidentResponseUnitDispatchDto {
+    id: number;
+    reference: string;
+    incidentId: number;
+    organizationId: number;
+    controlCentreId: number | null;
+    responseUnitId: number;
+    responseUnitName: string;
+    responseUnitType: string | null;
+    responseUnitControlCentreId: number | null;
+    status: ResponseUnitDispatchStatus;
+    dispatchedByUserId: number;
+    dispatchedAt: string;
+    wasRecommended: boolean;
+    recommendedResponseUnitId: number | null;
+    shownRecommendedResponseUnitId: number | null;
+    overrideReason: string | null;
+    notes: string | null;
+    distanceMetres: number | null;
+    unitSnapshot: ResponseUnitDispatchUnitSnapshotDto;
+    recommendationSnapshot: ResponseUnitDispatchRecommendationSnapshotDto | null;
+    statusChangedAt: string;
+    statusChangedByUserId: number | null;
+    statusSource: ResponseUnitDispatchTransitionSource;
+    statusReason: string | null;
+    acknowledgedAt: string | null;
+    enRouteAt: string | null;
+    onSceneAt: string | null;
+    completedAt: string | null;
+    cancelledAt: string | null;
+    notification: ResponseUnitDispatchNotificationStateDto;
+    createdAt: string;
+    updatedAt: string;
+}
+/** `GET /api/incidents/:id/response-unit-recommendation`. */
+export interface ResponseUnitRecommendationDto {
+    incidentId: number;
+    organizationId: number;
+    controlCentreId: number | null;
+    generatedAt: string;
+    status: ResponseUnitRecommendationStatus;
+    incidentBlockers: IncidentDispatchBlocker[];
+    requirement: ResponseCapabilityRequirementDto;
+    recommended: ResponseUnitCandidateDto | null;
+    alternatives: ResponseUnitCandidateDto[];
+    otherUnits: ResponseUnitCandidateDto[];
+    activeDispatches: IncidentResponseUnitDispatchDto[];
+    summary: ResponseUnitRecommendationSummaryDto;
+    incidentLocationAvailable: boolean;
+    liveTrackingAvailable: boolean;
+    travelTimeEnabled: boolean;
+}
+/** `POST /api/incidents/:id/response-unit-dispatches` body. Send an Idempotency-Key header with it. */
+export interface DispatchResponseUnitRequest {
+    responseUnitId: number;
+    /** The unit the screen showed as recommended. */
+    recommendedResponseUnitId?: number | null;
+    /** Optional: why another unit than the recommended one. */
+    overrideReason?: string;
+    notes?: string;
+}
+/** `POST /api/incidents/:id/response-unit-dispatches` response. */
+export interface DispatchResponseUnitResultDto {
+    dispatch: IncidentResponseUnitDispatchDto;
+    /** A repeat of an earlier request (same Idempotency-Key): nothing was sent again. */
+    replayed: boolean;
+}
+/** `POST /api/incidents/:id/response-unit-dispatches/:dispatchId/status` body. */
+export interface UpdateResponseUnitDispatchStatusRequest {
+    status: ResponseUnitDispatchStatus;
+    reason?: string;
+}

package/dist/types/modules/dispatch/utils/response-unit-dispatch-display.util.d.ts

@@ -0,0 +1,30 @@
+import { ResponseCapability, ResponseUnitAvailability } from '../../response-unit/enums/response-unit/response-capability.enum';
+import { IncidentDispatchBlocker, ResponseUnitDispatchConstraint, ResponseUnitDispatchNotificationFailure, ResponseUnitDispatchNotificationStatus, ResponseUnitDispatchStatus } from '../enums/response-unit-dispatch-enums';
+import { ResponseUnitCandidateDto } from '../interfaces/response-unit-dispatch.dto';
+export declare const RESPONSE_CAPABILITY_LABELS: Readonly<Record<ResponseCapability, string>>;
+export declare const RESPONSE_UNIT_AVAILABILITY_LABELS: Readonly<Record<ResponseUnitAvailability, string>>;
+export declare const RESPONSE_UNIT_DISPATCH_STATUS_LABELS: Readonly<Record<ResponseUnitDispatchStatus, string>>;
+/** Why a unit cannot go, or is not suggested - as the dispatcher reads it. */
+export declare const RESPONSE_UNIT_DISPATCH_CONSTRAINT_LABELS: Readonly<Record<ResponseUnitDispatchConstraint, string>>;
+export declare const INCIDENT_DISPATCH_BLOCKER_LABELS: Readonly<Record<IncidentDispatchBlocker, string>>;
+export declare const RESPONSE_UNIT_DISPATCH_NOTIFICATION_STATUS_LABELS: Readonly<Record<ResponseUnitDispatchNotificationStatus, string>>;
+export declare const RESPONSE_UNIT_DISPATCH_NOTIFICATION_FAILURE_LABELS: Readonly<Record<ResponseUnitDispatchNotificationFailure, string>>;
+/** Where each dispatch may be moved next (forward only; steps may be skipped). */
+export declare const RESPONSE_UNIT_DISPATCH_NEXT_STATUSES: Readonly<Record<ResponseUnitDispatchStatus, readonly ResponseUnitDispatchStatus[]>>;
+export declare const ACTIVE_RESPONSE_UNIT_DISPATCH_STATUSES: readonly ResponseUnitDispatchStatus[];
+export declare function isActiveResponseUnitDispatch(status: ResponseUnitDispatchStatus | string | null | undefined): boolean;
+/** "850 m", "2.4 km", "38 km". */
+export declare function formatDispatchDistance(metres: number | null | undefined): string;
+/** "18 sec ago", "4 min ago", "2 h ago". */
+export declare function formatDispatchAge(seconds: number | null | undefined): string;
+/** "7 min", "1 h 05 min". */
+export declare function formatDispatchDuration(seconds: number | null | undefined): string;
+/** A candidate's position, as one short phrase: "Live 18 sec ago", "Live, out of date (6 min ago)", "Base location". */
+export declare function describeCandidateLocation(candidate: ResponseUnitCandidateDto, ageSeconds?: number | null): string;
+/**
+ * The "Recommended because" lines, from the reasons and the numbers behind
+ * them. Never the scoring - the facts it rests on, in the order it weighs them.
+ */
+export declare function explainRecommendation(candidate: ResponseUnitCandidateDto, ageSeconds?: number | null): string[];
+/** The reasons a unit cannot go or is not suggested, as labels. */
+export declare function describeCandidateConstraints(candidate: ResponseUnitCandidateDto): string[];

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

@@ -7,6 +7,8 @@ export declare enum IncidentActions {
     ON_HOLD = "On Hold",
     ASSIGNED = "Assigned",
     RESPONSE_UNIT_ASSIGNED = "Response Unit Assigned",
+    RESPONSE_UNIT_DISPATCHED = "Response Unit Dispatched",
+    RESPONSE_UNIT_DISPATCH_UPDATED = "Response Unit Dispatch Updated",
     REOPENED = "Reopened",
     REPORT_CREATED = "Report Created",
     COMMENTED = "Commented",

package/dist/types/modules/incident/intefaces/incident-category.d.ts

@@ -1,3 +1,4 @@
+import { ResponseCapability } from "../../response-unit/enums/response-unit/response-capability.enum";
 import { IncidentType } from "./incident-type";
 export interface IncidentCategory {
     id?: number;
@@ -13,5 +14,10 @@ export interface IncidentCategory {
      * `includeSystem=true`.
      */
     isSystem?: boolean;
+    /**
+     * Response capabilities this kind of incident needs; a unit with ANY of them
+     * is suitable. A type's list overrides its category's; empty = no requirement.
+     */
+    responseCapabilities?: ResponseCapability[];
     types?: IncidentType[];
 }

package/dist/types/modules/incident/intefaces/incident-type.d.ts

@@ -1,3 +1,4 @@
+import { ResponseCapability } from "../../response-unit/enums/response-unit/response-capability.enum";
 import { IncidentCategory } from "./incident-category";
 export interface IncidentType {
     id?: number;
@@ -14,5 +15,10 @@ export interface IncidentType {
      * `includeSystem=true`.
      */
     isSystem?: boolean;
+    /**
+     * Response capabilities this kind of incident needs; a unit with ANY of them
+     * is suitable. A type's list overrides its category's; empty = no requirement.
+     */
+    responseCapabilities?: ResponseCapability[];
     category?: IncidentCategory;
 }

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",

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

@@ -8,6 +8,7 @@ export declare enum PermissionsModule {
     INCIDENT = "Grievance",
     RESPONSE_UNIT = "Response Unit",
     TRACKING = "Tracking",
+    RESPONSE_UNIT_DISPATCH = "Response Unit Dispatch",
     BILLING = "Billing",
     NEWSFEED = "Newsfeed",
     SUPPORT = "Support",

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,6 +1,6 @@
 {
   "name": "clarion-shared-types",
-  "version": "1.0.115",
+  "version": "1.0.116",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",