clarion-shared-types 1.0.118 → 1.0.120

package/dist/esm/modules/responder/utils/responder-display.util.js

@@ -0,0 +1,92 @@
+import { ResponderDutyEndReason, ResponderDutySessionStatus, ResponderReportOutcome } from '../enums/responder-enums';
+/*
+ * How the responder app's records read on the control room's screens - in the
+ * shared package, as for dispatches, so the unit screen, the incident screen
+ * and any future duty board name the same thing the same way.
+ */
+/** The backend's limit on a duty-end reason (grm-shared-library RESPONDER_FIELD_LIMITS.dutyEndReason). */
+export const RESPONDER_DUTY_END_REASON_MAX_LENGTH = 300;
+export const RESPONDER_REPORT_OUTCOME_LABELS = {
+    [ResponderReportOutcome.RESOLVED_ON_SCENE]: 'Resolved on scene',
+    [ResponderReportOutcome.HANDED_OVER]: 'Handed over',
+    [ResponderReportOutcome.REFERRED]: 'Referred',
+    [ResponderReportOutcome.NO_ACTION_REQUIRED]: 'No action required',
+    [ResponderReportOutcome.FALSE_ALARM]: 'False alarm',
+    [ResponderReportOutcome.UNABLE_TO_LOCATE]: 'Unable to locate',
+    [ResponderReportOutcome.OTHER]: 'Other',
+};
+export const RESPONDER_DUTY_END_REASON_LABELS = {
+    [ResponderDutyEndReason.RESPONDER]: 'Ended by the responder',
+    [ResponderDutyEndReason.CONTROL_CENTRE]: 'Ended by the control room',
+    [ResponderDutyEndReason.MEMBERSHIP_REMOVED]: 'Removed from the unit',
+    [ResponderDutyEndReason.UNIT_DEACTIVATED]: 'Unit deactivated',
+};
+export const RESPONDER_DUTY_SESSION_STATUS_LABELS = {
+    [ResponderDutySessionStatus.ACTIVE]: 'On duty',
+    [ResponderDutySessionStatus.ENDED]: 'Ended',
+};
+export function responderReportOutcomeTone(outcome) {
+    switch (outcome) {
+        case ResponderReportOutcome.RESOLVED_ON_SCENE:
+            return 'success';
+        case ResponderReportOutcome.HANDED_OVER:
+        case ResponderReportOutcome.REFERRED:
+            return 'info';
+        case ResponderReportOutcome.UNABLE_TO_LOCATE:
+            return 'warning';
+        default:
+            return 'grey';
+    }
+}
+/** The outcome's label, or the raw value when this package does not know it yet. */
+export function responderReportOutcomeLabel(outcome) {
+    var _a;
+    if (!outcome)
+        return '';
+    return (_a = RESPONDER_REPORT_OUTCOME_LABELS[outcome]) !== null && _a !== void 0 ? _a : String(outcome);
+}
+/** The end reason's label, or the raw value when this package does not know it yet. */
+export function responderDutyEndReasonLabel(reason) {
+    var _a;
+    if (!reason)
+        return '';
+    return (_a = RESPONDER_DUTY_END_REASON_LABELS[reason]) !== null && _a !== void 0 ? _a : String(reason);
+}
+/**
+ * A checklist item id as words, for a screen that has the answers but not the
+ * organization's policy (where the labels live): "scene-made-safe",
+ * "scene_made_safe" and "sceneMadeSafe" all read "Scene made safe".
+ */
+export function humanizeResponderChecklistItem(itemId) {
+    if (!itemId)
+        return '';
+    const words = itemId
+        .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+        .replace(/[-_.]+/g, ' ')
+        .trim()
+        .toLowerCase()
+        .replace(/\s+/g, ' ');
+    return words ? words.charAt(0).toUpperCase() + words.slice(1) : '';
+}
+/** "3 of 4 confirmed"; '' for an empty checklist. */
+export function describeResponderChecklist(checklist) {
+    const items = checklist !== null && checklist !== void 0 ? checklist : [];
+    if (items.length === 0)
+        return '';
+    const checked = items.filter((item) => item.checked).length;
+    return `${checked} of ${items.length} confirmed`;
+}
+/** The responder's name - or, when their account could not be read, its number. */
+export function responderDisplayName(responder) {
+    var _a, _b;
+    const name = (_b = (_a = responder.user) === null || _a === void 0 ? void 0 : _a.name) === null || _b === void 0 ? void 0 : _b.trim();
+    return name ? name : `Account #${responder.userId}`;
+}
+/** "jane@example.com · +254 712 345678", whichever of the two the account has. */
+export function responderContactLine(responder) {
+    const user = responder.user;
+    if (!user)
+        return '';
+    return [user.email, user.phoneNumber].filter((value) => !!value && value.trim().length > 0).join(' · ');
+}
+//# sourceMappingURL=responder-display.util.js.map

package/dist/esm/modules/responder/utils/responder-display.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responder-display.util.js","sourceRoot":"","sources":["../../../../../src/modules/responder/utils/responder-display.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGtH;;;;GAIG;AAEH,0GAA0G;AAC1G,MAAM,CAAC,MAAM,oCAAoC,GAAG,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,+BAA+B,GAAqD;IAC7F,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,mBAAmB;IAC/D,CAAC,sBAAsB,CAAC,WAAW,CAAC,EAAE,aAAa;IACnD,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,UAAU;IAC7C,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,EAAE,oBAAoB;IACjE,CAAC,sBAAsB,CAAC,WAAW,CAAC,EAAE,aAAa;IACnD,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;IAC7D,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,OAAO;CAC1C,CAAC;AAEF,MAAM,CAAC,MAAM,gCAAgC,GAAqD;IAC9F,CAAC,sBAAsB,CAAC,SAAS,CAAC,EAAE,wBAAwB;IAC5D,CAAC,sBAAsB,CAAC,cAAc,CAAC,EAAE,2BAA2B;IACpE,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,EAAE,uBAAuB;IACpE,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;CAChE,CAAC;AAEF,MAAM,CAAC,MAAM,oCAAoC,GAAyD;IACtG,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAAE,SAAS;IAC9C,CAAC,0BAA0B,CAAC,KAAK,CAAC,EAAE,OAAO;CAC9C,CAAC;AAKF,MAAM,UAAU,0BAA0B,CAAC,OAA2D;IAClG,QAAQ,OAAO,EAAE,CAAC;QACd,KAAK,sBAAsB,CAAC,iBAAiB;YACzC,OAAO,SAAS,CAAC;QACrB,KAAK,sBAAsB,CAAC,WAAW,CAAC;QACxC,KAAK,sBAAsB,CAAC,QAAQ;YAChC,OAAO,MAAM,CAAC;QAClB,KAAK,sBAAsB,CAAC,gBAAgB;YACxC,OAAO,SAAS,CAAC;QACrB;YACI,OAAO,MAAM,CAAC;IACtB,CAAC;AACL,CAAC;AAED,oFAAoF;AACpF,MAAM,UAAU,2BAA2B,CAAC,OAA2D;;IACnG,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,OAAO,MAAA,+BAA+B,CAAC,OAAiC,CAAC,mCAAI,MAAM,CAAC,OAAO,CAAC,CAAC;AACjG,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,2BAA2B,CAAC,MAA0D;;IAClG,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO,MAAA,gCAAgC,CAAC,MAAgC,CAAC,mCAAI,MAAM,CAAC,MAAM,CAAC,CAAC;AAChG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,MAAiC;IAC5E,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,MAAM;SACf,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,IAAI,EAAE;SACN,WAAW,EAAE;SACb,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACvE,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,0BAA0B,CAAC,SAAuE;IAC9G,MAAM,KAAK,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC5D,OAAO,GAAG,OAAO,OAAO,KAAK,CAAC,MAAM,YAAY,CAAC;AACrD,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,oBAAoB,CAAC,SAAyD;;IAC1F,MAAM,IAAI,GAAG,MAAA,MAAA,SAAS,CAAC,IAAI,0CAAE,IAAI,0CAAE,IAAI,EAAE,CAAC;IAC1C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,SAAS,CAAC,MAAM,EAAE,CAAC;AACxD,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,oBAAoB,CAAC,SAA8C;IAC/E,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;IAC5B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC7H,CAAC"}

package/dist/esm/modules/tracking/index.js

@@ -11,4 +11,5 @@ export * from './interfaces/tracking-position.dto';
 export * from './interfaces/tracking-socket-events';
 export * from './interfaces/tracking-operations.dto';
 export * from './interfaces/tracking-playback.dto';
+export * from './interfaces/tracking-analytics';
 //# sourceMappingURL=index.js.map

package/dist/esm/modules/tracking/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/tracking/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AAEzD,oBAAoB;AACpB,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0CAA0C,CAAC;AACzD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/tracking/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AAEzD,oBAAoB;AACpB,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0CAA0C,CAAC;AACzD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC;AACnD,cAAc,iCAAiC,CAAC"}

package/dist/esm/modules/tracking/interfaces/tracking-analytics.js

@@ -0,0 +1,13 @@
+/**
+ * Units & Tracking analytics, the tracking half (the admin's Units & Tracking
+ * Analytics): the response units in scope and how they are tracked - computed by
+ * clarion-response-tracking. The other half, what was dispatched and how it went, is
+ * DispatchAnalytics (clarion-incident); both answer the same query.
+ *
+ * The fleet and its live status are as they stand NOW. Everything else is the period's,
+ * counted by the hour a position was recorded (`eventTime`): the service keeps an hourly
+ * rollup of the position history, so a year costs no more to read than a day. Counts,
+ * rates and durations only - never a position, a route or a device identifier.
+ */
+export {};
+//# sourceMappingURL=tracking-analytics.js.map

package/dist/esm/modules/tracking/interfaces/tracking-analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking-analytics.js","sourceRoot":"","sources":["../../../../../src/modules/tracking/interfaces/tracking-analytics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG"}

package/dist/types/index.d.ts

@@ -27,5 +27,6 @@ export * from './modules/billing/index';
 export * from './modules/newsfeed/index';
 export * from './modules/dispatch/index';
 export * from './modules/incident-sla/index';
+export * from './modules/responder/index';
 export * from './modules/common/interfaces/server-message';
 export * from './modules/common/interfaces/pagination';

package/dist/types/modules/dispatch/index.d.ts

@@ -1,3 +1,4 @@
 export * from './enums/response-unit-dispatch-enums';
 export * from './interfaces/response-unit-dispatch.dto';
+export * from './interfaces/dispatch-analytics';
 export * from './utils/response-unit-dispatch-display.util';

package/dist/types/modules/dispatch/interfaces/dispatch-analytics.d.ts

@@ -0,0 +1,158 @@
+import { UnitsAnalyticsCount, UnitsAnalyticsDuration, UnitsAnalyticsRange, UnitsAnalyticsScope } from '../../tracking/interfaces/tracking-analytics';
+/**
+ * Units & Tracking analytics, the dispatch half: the response units sent to emergencies
+ * and what became of each - computed by clarion-incident, for the same query as
+ * TrackingAnalytics.
+ *
+ * Dispatches are counted by when they were made (`dispatchedAt`) and shown as they stand
+ * now: a dispatch made in the period and completed after it counts as completed. Times
+ * are measured between the timestamps a dispatch records. Emergencies are the period's
+ * incidents (not grievances) that reached the control room. Counts, rates and durations
+ * only - never a dispatcher, a crew's phone number, a reason someone typed or a note.
+ */
+export interface DispatchAnalyticsTotals {
+    dispatches: number;
+    /** The previous period of the same length; null for "forever". */
+    previousDispatches: number | null;
+    /** Emergencies a unit was sent to in the period. */
+    incidentsDispatched: number;
+    /** Emergencies raised in the period (reaching the control room), and those a unit was ever sent to. */
+    emergencies: number;
+    emergenciesDispatched: number;
+    /** emergenciesDispatched / emergencies, as a percentage. */
+    dispatchRate: number | null;
+    unitsDispatched: number;
+    dispatchers: number;
+    /** Dispatches per emergency dispatched in the period. */
+    unitsPerIncident: number | null;
+}
+export interface DispatchAnalyticsOutcomes {
+    /** Still out: dispatched, acknowledged, en route or on scene. */
+    active: number;
+    completed: number;
+    /** Stood down (CANCELLED) - and of those, refused by the responder. */
+    cancelled: number;
+    rejected: number;
+    /** Reached the scene. */
+    reachedScene: number;
+    /** Completed, as a percentage of the dispatches no longer out. */
+    completionRate: number | null;
+    /** Every status, in the order a dispatch lives through them, zero counts included. */
+    byStatus: UnitsAnalyticsCount[];
+    /** How the arrival was recorded (responder, control centre, inferred from tracking). */
+    arrivalBySource: UnitsAnalyticsCount[];
+    /** Who recorded each dispatch's latest status. */
+    statusBySource: UnitsAnalyticsCount[];
+}
+export interface DispatchAnalyticsTimes {
+    /** From an emergency being raised to its first unit being sent (the period's emergencies). */
+    toFirstDispatch: UnitsAnalyticsDuration;
+    /** From the unit being sent to it acknowledging, setting off, arriving and being done. */
+    toAcknowledge: UnitsAnalyticsDuration;
+    toEnRoute: UnitsAnalyticsDuration;
+    toOnScene: UnitsAnalyticsDuration;
+    /** From arriving to being done. */
+    onScene: UnitsAnalyticsDuration;
+    toComplete: UnitsAnalyticsDuration;
+}
+export interface DispatchAnalyticsRecommendation {
+    /** Dispatches made with a recommendation on screen. */
+    recommended: number;
+    /** ...that sent the recommended unit. */
+    followed: number;
+    /** ...that sent another unit, and of those, with a reason given. */
+    overridden: number;
+    overriddenWithReason: number;
+    /** Dispatches made when no unit was recommended. */
+    withoutRecommendation: number;
+    /** followed / recommended, as a percentage. */
+    followRate: number | null;
+    /** The sent unit as the recommendation saw it: how its capabilities matched, its availability, how fresh its position was. */
+    capabilityMatch: UnitsAnalyticsCount[];
+    availability: UnitsAnalyticsCount[];
+    locationFreshness: UnitsAnalyticsCount[];
+    /** Straight-line distance from the unit to the emergency when it was sent. */
+    distance: {
+        samples: number;
+        medianMetres: number | null;
+        p90Metres: number | null;
+    };
+}
+/** The dispatch message (SMS) to the crew. */
+export interface DispatchAnalyticsNotification {
+    sent: number;
+    failed: number;
+    /** Could not be sent at all: no phone number, not configured, ... */
+    notPossible: number;
+    pending: number;
+    failures: UnitsAnalyticsCount[];
+    /** sent / (sent + failed), as a percentage. */
+    deliveryRate: number | null;
+    /** From the message being requested to the provider's answer. */
+    toResult: UnitsAnalyticsDuration;
+    /** Dispatches whose message was sent more than once. */
+    resent: number;
+}
+export interface DispatchAnalyticsTimelinePoint {
+    /** Start of the bucket, ISO 8601. */
+    at: string;
+    dispatches: number;
+    completed: number;
+    cancelled: number;
+}
+export interface DispatchAnalyticsUnitRow {
+    responseUnitId: number;
+    organizationId: number;
+    /** As it was named when last sent. */
+    name: string;
+    responseUnitType: string | null;
+    dispatches: number;
+    completed: number;
+    cancelled: number;
+    rejected: number;
+    medianSecondsToAcknowledge: number | null;
+    medianSecondsToOnScene: number | null;
+    lastDispatchedAt: string;
+}
+export interface DispatchAnalyticsTypeRow {
+    responseUnitType: string;
+    dispatches: number;
+    completed: number;
+    medianSecondsToOnScene: number | null;
+}
+export interface DispatchAnalyticsHourOfWeek {
+    /** 0 = Monday ... 6 = Sunday, in the period's time zone. */
+    day: number;
+    hour: number;
+    dispatches: number;
+}
+/** Platform view only: one row per organization. */
+export interface DispatchAnalyticsOrganizationRow {
+    organizationId: number;
+    dispatches: number;
+    emergencies: number;
+    emergenciesDispatched: number;
+    completed: number;
+    medianSecondsToOnScene: number | null;
+}
+export interface DispatchAnalytics {
+    generatedAt: string;
+    range: UnitsAnalyticsRange;
+    scope: UnitsAnalyticsScope;
+    totals: DispatchAnalyticsTotals;
+    outcomes: DispatchAnalyticsOutcomes;
+    times: DispatchAnalyticsTimes;
+    recommendation: DispatchAnalyticsRecommendation;
+    notification: DispatchAnalyticsNotification;
+    timeline: DispatchAnalyticsTimelinePoint[];
+    byUnitType: DispatchAnalyticsTypeRow[];
+    /** The dispatched emergencies by their emergency type. */
+    byEmergencyType: UnitsAnalyticsCount[];
+    /** Dispatches by weekday and hour; only cells with dispatches. */
+    hourOfWeek: DispatchAnalyticsHourOfWeek[];
+    /** Units sent in the period, most dispatches first; capped (see `unitsTruncated`). */
+    units: DispatchAnalyticsUnitRow[];
+    unitsTruncated: boolean;
+    /** Platform view only; null otherwise. */
+    byOrganization: DispatchAnalyticsOrganizationRow[] | null;
+}

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

@@ -52,6 +52,7 @@ export declare enum PermissionActions {
     READ_TRACKING_POSITION = "read:tracking-position",
     READ_TRACKING_HISTORY = "read:tracking-history",
     READ_TRACKING_OPERATIONS = "read:tracking-operations",
+    READ_TRACKING_ANALYTICS = "read:tracking-analytics",
     MANAGE_TRACKING_OPERATIONS = "manage:tracking-operations",
     READ_RESPONSE_UNIT_DISPATCH = "read:response-unit-dispatch",
     CREATE_RESPONSE_UNIT_DISPATCH = "create:response-unit-dispatch",
@@ -199,6 +200,9 @@ export declare enum PermissionActions {
     READ_INCIDENT_SLA_POLICY = "read:incident-sla-policy",
     MANAGE_INCIDENT_SLA_POLICY = "manage:incident-sla-policy",
     READ_INCIDENT_SLA_ANALYTICS = "read:incident-sla-analytics",
+    USE_RESPONDER_APP = "use:responder-app",
+    RESPOND_RESPONSE_UNIT_DISPATCH = "respond:response-unit-dispatch",
+    REPORT_RESPONDER_POSITION = "report:responder-position",
     /** @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

@@ -16,5 +16,6 @@ export declare enum PermissionsModule {
     ALERT_INTAKE = "Alert Intake",
     SAFETY = "Safety",
     PLACES = "Places",
-    INCIDENT_SLA = "Incident SLA"
+    INCIDENT_SLA = "Incident SLA",
+    RESPONDER = "Responder"
 }

package/dist/types/modules/responder/enums/responder-enums.d.ts

@@ -0,0 +1,75 @@
+/**
+ * The responder app, as the control room sees it: field personnel (role
+ * `Responder`) linked to the response units they may staff, going on duty with
+ * one of them and reporting how each dispatch ended.
+ *
+ * The admin's mirror of grm-shared-library `src/modules/responder` - the string
+ * values MUST stay identical to the backend's (pinned by responder-display.spec.ts).
+ */
+/** A duty session's own lifecycle. One session is ACTIVE per responder at most. */
+export declare enum ResponderDutySessionStatus {
+    ACTIVE = "ACTIVE",
+    ENDED = "ENDED"
+}
+/** Why a duty session ended. */
+export declare enum ResponderDutyEndReason {
+    /** The responder went off duty in the app. */
+    RESPONDER = "RESPONDER",
+    /** The control room ended it (update:response-unit). */
+    CONTROL_CENTRE = "CONTROL_CENTRE",
+    /** The responder was removed from the unit while on duty with it. */
+    MEMBERSHIP_REMOVED = "MEMBERSHIP_REMOVED",
+    /** The unit was deactivated or deleted while the responder was on duty with it. */
+    UNIT_DEACTIVATED = "UNIT_DEACTIVATED"
+}
+/** How a response ended, as the responder reports it. */
+export declare enum ResponderReportOutcome {
+    RESOLVED_ON_SCENE = "RESOLVED_ON_SCENE",
+    HANDED_OVER = "HANDED_OVER",
+    REFERRED = "REFERRED",
+    NO_ACTION_REQUIRED = "NO_ACTION_REQUIRED",
+    FALSE_ALARM = "FALSE_ALARM",
+    UNABLE_TO_LOCATE = "UNABLE_TO_LOCATE",
+    OTHER = "OTHER"
+}
+/**
+ * Machine-readable refusals of the responder endpoints, in the error body's
+ * `code` (or `details.code` behind the gateway) - the same
+ * `{statusCode, code, message, ...details}` envelope the dispatch endpoints use.
+ */
+export declare enum ResponderErrorCode {
+    /** The caller does not hold the Responder role. */
+    NOT_A_RESPONDER = "RESPONDER_NOT_A_RESPONDER",
+    /** The responder account has no control centre, so nothing can be scoped. */
+    NO_CONTROL_CENTRE = "RESPONDER_NO_CONTROL_CENTRE",
+    UNIT_NOT_FOUND = "RESPONDER_UNIT_NOT_FOUND",
+    /** The caller is not a member of that unit. */
+    NOT_A_UNIT_MEMBER = "RESPONDER_NOT_A_UNIT_MEMBER",
+    UNIT_INACTIVE = "RESPONDER_UNIT_INACTIVE",
+    /** Already on duty with ANOTHER unit; end that duty first. `details.activeDuty` names it. */
+    ALREADY_ON_DUTY = "RESPONDER_ALREADY_ON_DUTY",
+    NOT_ON_DUTY = "RESPONDER_NOT_ON_DUTY",
+    /** Membership: the user is not a Responder of the unit's organization and control centre. */
+    USER_NOT_ELIGIBLE = "RESPONDER_USER_NOT_ELIGIBLE",
+    ALREADY_A_MEMBER = "RESPONDER_ALREADY_A_MEMBER",
+    MEMBERSHIP_NOT_FOUND = "RESPONDER_MEMBERSHIP_NOT_FOUND",
+    /** The dispatch does not exist or is not for one of the caller's units (never says which). */
+    DISPATCH_NOT_FOUND = "RESPONDER_DISPATCH_NOT_FOUND",
+    /** The move is not one a responder may make from the current status. `details.currentStatus`. */
+    INVALID_STATUS_TRANSITION = "RESPONDER_INVALID_STATUS_TRANSITION",
+    REASON_REQUIRED = "RESPONDER_REASON_REQUIRED",
+    DECLINE_NOT_ALLOWED = "RESPONDER_DECLINE_NOT_ALLOWED",
+    MANUAL_ARRIVAL_NOT_ALLOWED = "RESPONDER_MANUAL_ARRIVAL_NOT_ALLOWED",
+    /** Completing needs the response report first (organization policy). */
+    REPORT_REQUIRED = "RESPONDER_REPORT_REQUIRED",
+    /** A report can only be written once the unit reached the scene. */
+    REPORT_NOT_ALLOWED = "RESPONDER_REPORT_NOT_ALLOWED",
+    /** The report changed since the version the client edited. `details.currentVersion`. */
+    REPORT_VERSION_CONFLICT = "RESPONDER_REPORT_VERSION_CONFLICT",
+    /** The incident is closed or archived, so its reports can no longer be amended. */
+    REPORT_LOCKED = "RESPONDER_REPORT_LOCKED",
+    /** A required report field or checklist item is missing. `details.missing`. */
+    REPORT_INCOMPLETE = "RESPONDER_REPORT_INCOMPLETE",
+    /** An attachment id is not a file the caller may link. */
+    ATTACHMENT_NOT_READABLE = "RESPONDER_ATTACHMENT_NOT_READABLE"
+}

package/dist/types/modules/responder/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enums/responder-enums';
+export * from './interfaces/responder.dto';
+export * from './utils/responder-display.util';

package/dist/types/modules/responder/interfaces/responder.dto.d.ts

@@ -0,0 +1,87 @@
+import { ResponderDutyEndReason, ResponderDutySessionStatus, ResponderReportOutcome } from '../enums/responder-enums';
+/**
+ * A responder linked to a unit, as the unit screen lists them.
+ * `GET|POST /api/response-units/:id/responders`.
+ */
+export interface ResponseUnitResponder {
+    id: number;
+    responseUnitId: number;
+    userId: number;
+    organizationId: number;
+    controlCentreId: number | null;
+    createdByUserId: number | null;
+    createdAt: string;
+    /** The account, when clarion-authentication could be read; null otherwise. */
+    user: {
+        id: number;
+        name: string;
+        email: string | null;
+        phoneNumber: string | null;
+    } | null;
+    /** Set while this responder is on duty with THIS unit. */
+    activeDuty: {
+        sessionId: number;
+        startedAt: string;
+    } | null;
+}
+/** `POST /api/response-units/:id/responders` - link a Responder account to a unit. */
+export interface AddResponseUnitResponderRequest {
+    userId: number;
+}
+/** `POST /api/response-units/:id/responders/:userId/end-duty` - the control room ends someone's duty. */
+export interface EndResponderDutyRequest {
+    /** At most RESPONDER_DUTY_END_REASON_MAX_LENGTH characters. */
+    reason?: string;
+}
+/** One stretch of duty: a responder staffing one unit. */
+export interface ResponderDutySession {
+    id: number;
+    userId: number;
+    responseUnitId: number;
+    /** Copied at start so the record reads right after a rename. */
+    responseUnitName: string;
+    organizationId: number;
+    controlCentreId: number | null;
+    status: ResponderDutySessionStatus;
+    startedAt: string;
+    endedAt: string | null;
+    endReason: ResponderDutyEndReason | null;
+    endReasonText: string | null;
+    /** Who ended it - the responder, or the control-room user. */
+    endedByUserId: number | null;
+}
+/** One answer on a responder report's closure checklist. */
+export interface ResponderReportChecklistAnswer {
+    /** The organization policy's stable item id (the label lives in the policy). */
+    itemId: string;
+    checked: boolean;
+}
+/**
+ * What the responder reported about one dispatch. One per dispatch, amended in
+ * versions. `GET /api/incidents/:id/responder-reports` lists an incident's.
+ */
+export interface ResponderDispatchReport {
+    id: number;
+    reference: string;
+    dispatchId: number;
+    incidentId: number;
+    responseUnitId: number;
+    submittedByUserId: number;
+    /** Starts at 1; every amendment adds one. */
+    version: number;
+    summary: string;
+    actionsTaken: string | null;
+    outcome: ResponderReportOutcome;
+    personsContacted: string | null;
+    handoverTo: string | null;
+    followUpRequired: boolean;
+    followUpNotes: string | null;
+    remarks: string | null;
+    checklist: ResponderReportChecklistAnswer[];
+    /** dms file ids; the files are also appended to the incident's attachments. */
+    attachmentIds: number[];
+    submittedAt: string;
+    updatedAt: string;
+    /** Whether the CALLER may still amend it (submitter, incident not closed) - always false for the control room. */
+    amendable: boolean;
+}

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

@@ -0,0 +1,26 @@
+import { ResponderDutyEndReason, ResponderDutySessionStatus, ResponderReportOutcome } from '../enums/responder-enums';
+import { ResponderReportChecklistAnswer, ResponseUnitResponder } from '../interfaces/responder.dto';
+/** The backend's limit on a duty-end reason (grm-shared-library RESPONDER_FIELD_LIMITS.dutyEndReason). */
+export declare const RESPONDER_DUTY_END_REASON_MAX_LENGTH = 300;
+export declare const RESPONDER_REPORT_OUTCOME_LABELS: Readonly<Record<ResponderReportOutcome, string>>;
+export declare const RESPONDER_DUTY_END_REASON_LABELS: Readonly<Record<ResponderDutyEndReason, string>>;
+export declare const RESPONDER_DUTY_SESSION_STATUS_LABELS: Readonly<Record<ResponderDutySessionStatus, string>>;
+/** The colour an outcome is shown in: settled is green, passed on is blue, not found is amber, the rest neutral. */
+export type ResponderReportOutcomeTone = 'success' | 'info' | 'warning' | 'grey';
+export declare function responderReportOutcomeTone(outcome: ResponderReportOutcome | string | null | undefined): ResponderReportOutcomeTone;
+/** The outcome's label, or the raw value when this package does not know it yet. */
+export declare function responderReportOutcomeLabel(outcome: ResponderReportOutcome | string | null | undefined): string;
+/** The end reason's label, or the raw value when this package does not know it yet. */
+export declare function responderDutyEndReasonLabel(reason: ResponderDutyEndReason | string | null | undefined): string;
+/**
+ * A checklist item id as words, for a screen that has the answers but not the
+ * organization's policy (where the labels live): "scene-made-safe",
+ * "scene_made_safe" and "sceneMadeSafe" all read "Scene made safe".
+ */
+export declare function humanizeResponderChecklistItem(itemId: string | null | undefined): string;
+/** "3 of 4 confirmed"; '' for an empty checklist. */
+export declare function describeResponderChecklist(checklist: readonly ResponderReportChecklistAnswer[] | null | undefined): string;
+/** The responder's name - or, when their account could not be read, its number. */
+export declare function responderDisplayName(responder: Pick<ResponseUnitResponder, 'userId' | 'user'>): string;
+/** "jane@example.com · +254 712 345678", whichever of the two the account has. */
+export declare function responderContactLine(responder: Pick<ResponseUnitResponder, 'user'>): string;

package/dist/types/modules/tracking/index.d.ts

@@ -9,3 +9,4 @@ export * from './interfaces/tracking-position.dto';
 export * from './interfaces/tracking-socket-events';
 export * from './interfaces/tracking-operations.dto';
 export * from './interfaces/tracking-playback.dto';
+export * from './interfaces/tracking-analytics';