grm-shared-library 1.1.240 → 1.1.242

package/dist/types/modules/safety/interfaces/safety-history.d.ts

@@ -0,0 +1,217 @@
+import { TripPathPoint } from '../../gis/interfaces/trip-path-snapshot';
+import { FollowMeAuditEventType, FollowMeParticipantKind, FollowMeSafetyEventType, FollowMeSafetyTrigger, FollowMeStatus, FollowMeTransportMode } from '../enums/follow-me.enums';
+import { SafetyCheckStatus } from '../enums/safety-check-status.enum';
+import { SafetyCheckActorType, SafetyCheckAuditEventType, SafetyCheckSosTrigger } from '../enums/safety-enums';
+import { SafetyHistoryEventSource, SafetyHistoryPathStatus } from '../enums/safety-history.enums';
+import { FollowMePromptView, FollowMeRouteView, FollowMeWaypointView } from './follow-me';
+export interface SafetyHistoryLocation {
+    lat: number;
+    lng: number;
+}
+/** The SOS incident a session raised, as clarion-incident shows it to the caller now. */
+export interface SafetyHistoryIncident {
+    id: number;
+    /**
+     * False when clarion-incident could not be read just now, or would not show
+     * this incident to the caller - the id is still the session's own record.
+     */
+    available: boolean;
+    /** clarion-incident's status label ('Pending', 'Resolved', ...). */
+    status: string | null;
+    typeName: string | null;
+    categoryName: string | null;
+    createdAt: string | null;
+}
+/** Who an SOS reached, as clarion-incident reported when it created the incident. */
+export interface SafetyHistoryEscalation {
+    guardiansAlerted: boolean | null;
+    serviceProviderAlerted: boolean | null;
+}
+/**
+ * Facts an event carries, by event type - each present only where the persisted
+ * record holds it.
+ */
+export interface SafetyHistoryEventDetails {
+    /** SOS_TRIGGERED: why the SOS was raised. */
+    sosTrigger?: SafetyCheckSosTrigger | null;
+    /** Follow Me prompts and SOS: what made the journey ask (or the unanswered question behind an SOS). */
+    promptTrigger?: FollowMeSafetyTrigger | null;
+    /** SOS_INCIDENT_CREATED. */
+    incidentId?: number | null;
+    serviceProviderAlerted?: boolean | null;
+    guardiansAlerted?: boolean | null;
+    /** EXTENDED. */
+    additionalMinutes?: number | null;
+    /** CHECKED_IN / PROMPT_CONFIRMED: seconds between the question and the answer. */
+    responseSeconds?: number | null;
+    /** CHECKED_IN / STOPPED: the user answered while being asked. */
+    whilePrompted?: boolean | null;
+    /** PROMPT_STARTED: the countdown the user had. */
+    countdownSeconds?: number | null;
+    /** Follow Me guardian events: the name the user chose them by. */
+    guardianName?: string | null;
+    /** PROLONGED_STOP_DETECTED. */
+    stoppedMinutes?: number | null;
+    /** DEVIATION_CONFIRMED. */
+    distanceFromRouteMeters?: number | null;
+}
+/** One entry of a session's timeline, oldest first. */
+export interface SafetyHistoryTimelineEntry {
+    /** Stable within the session (`audit:<id>`, `monitor:<id>`). */
+    id: string;
+    occurredAt: string;
+    source: SafetyHistoryEventSource;
+    eventType: SafetyCheckAuditEventType | FollowMeAuditEventType | FollowMeSafetyEventType;
+    /** Who caused a lifecycle entry; null for what a monitor observed. */
+    actorType: SafetyCheckActorType | null;
+    details: SafetyHistoryEventDetails;
+    /** Where it happened, when the record says - the owner's own location. */
+    location: SafetyHistoryLocation | null;
+}
+/** The recorded path of a session, thinned for a map. */
+export interface SafetyHistoryPath {
+    status: SafetyHistoryPathStatus;
+    /** Oldest first; empty unless RECORDED. */
+    points: TripPathPoint[];
+    /** Fixes recorded for the session before thinning. */
+    totalPoints: number;
+    simplified: boolean;
+    distanceMeters: number | null;
+    /** Where the device was when the session started, when it reported a fix then. */
+    startLocation: SafetyHistoryLocation | null;
+}
+/** A row of the Safety Check history. */
+export interface SafetyCheckHistoryItem {
+    id: string;
+    status: SafetyCheckStatus;
+    /** The words the user chose at start (their own text for "Write my own"). */
+    reasonLabel: string;
+    startedAt: string;
+    /** When it ended; null while open, and for an SOS (see sosTriggeredAt). */
+    endedAt: string | null;
+    /** Configured minutes from start to check-in, extensions included. */
+    durationMinutes: number;
+    extensionCount: number;
+    scheduledCheckInAt: string;
+    /** From the start to the end (or to the SOS). Null while open. */
+    actualDurationSeconds: number | null;
+    checkedInAt: string | null;
+    sosTriggered: boolean;
+    sosTrigger: SafetyCheckSosTrigger | null;
+    sosTriggeredAt: string | null;
+    /** Null until clarion-incident created the SOS (and for a check without one). */
+    incidentId: number | null;
+    /** At least one location was recorded. */
+    locationRecorded: boolean;
+}
+export interface SafetyCheckHistoryDetail {
+    check: SafetyCheckHistoryItem & {
+        promptCountdownSeconds: number;
+        promptStartedAt: string | null;
+        promptDeadlineAt: string | null;
+        notifyGuardiansOnStartEnd: boolean;
+        /** How many guardians the user chose for this check. */
+        guardianCount: number;
+        serviceProviderRequested: boolean;
+        serviceProviderAllowed: boolean;
+        trackPointCount: number;
+        lastLocationAt: string | null;
+    };
+    /** Null unless an SOS incident was created. */
+    escalation: SafetyHistoryEscalation | null;
+    timeline: SafetyHistoryTimelineEntry[];
+    incident: SafetyHistoryIncident | null;
+    serverTime: string;
+}
+/** The Safety Check's map. */
+export interface SafetyCheckHistoryTrack {
+    checkId: string;
+    path: SafetyHistoryPath;
+    serverTime: string;
+}
+/** A row of the Follow Me history. */
+export interface FollowMeHistoryItem {
+    id: string;
+    status: FollowMeStatus;
+    reasonLabel: string;
+    startedAt: string;
+    plannedEndAt: string;
+    /** Null while open, and for an SOS (see sosTriggeredAt). */
+    endedAt: string | null;
+    arrivedAt: string | null;
+    durationMinutes: number;
+    actualDurationSeconds: number | null;
+    transportMode: FollowMeTransportMode | null;
+    /** The planned START waypoint's label; null without a planned route. */
+    startLabel: string | null;
+    /** Null when the journey had no destination (Follow Me without a route). */
+    destinationLabel: string | null;
+    stopCount: number;
+    /** A route was planned and monitored. */
+    plannedRoute: boolean;
+    /** The arrival the plan promised (moved only by a legitimate recalculation). */
+    plannedArrivalAt: string | null;
+    sosTriggered: boolean;
+    sosTrigger: SafetyCheckSosTrigger | null;
+    /** The unanswered question behind a missed-prompt SOS. */
+    sosCause: FollowMeSafetyTrigger | null;
+    sosTriggeredAt: string | null;
+    incidentId: number | null;
+    locationRecorded: boolean;
+}
+/** A guardian the user asked to follow, and what they did - from the audit trail. */
+export interface FollowMeHistoryGuardian {
+    displayName: string;
+    kind: FollowMeParticipantKind;
+    invitedAt: string;
+    /** Accepted at some point (they may have stopped following later). */
+    accepted: boolean;
+    acceptedAt: string | null;
+    /** Declined and never accepted. */
+    declined: boolean;
+}
+export interface FollowMeHistoryDetail {
+    session: FollowMeHistoryItem & {
+        promptCountdownSeconds: number;
+        notifyGuardiansOnStartEnd: boolean;
+        serviceProviderRequested: boolean;
+        serviceProviderAllowed: boolean;
+        crashDetectionEnabled: boolean;
+        /** The last live arrival estimate. */
+        lastEtaAt: string | null;
+        trackPointCount: number;
+        lastLocationAt: string | null;
+    };
+    /** START, STOPs in order, DESTINATION - the plan as the user made it. */
+    waypoints: FollowMeWaypointView[];
+    /** The original plan and every recalculation, oldest first. No geometry here (see the track). */
+    routes: FollowMeRouteView[];
+    /** Every safety question the journey asked, oldest first. */
+    prompts: FollowMePromptView[];
+    guardians: FollowMeHistoryGuardian[];
+    escalation: SafetyHistoryEscalation | null;
+    timeline: SafetyHistoryTimelineEntry[];
+    incident: SafetyHistoryIncident | null;
+    serverTime: string;
+}
+/** A safety event the map can pin: where a question was asked or a finding was made. */
+export interface FollowMeHistoryEventMarker {
+    id: string;
+    occurredAt: string;
+    /** The monitor's finding; null for a prompt marker. */
+    eventType: FollowMeSafetyEventType | null;
+    /** The question asked; null for a finding without one. */
+    trigger: FollowMeSafetyTrigger | null;
+    lat: number;
+    lng: number;
+}
+/** The Follow Me journey's map: what was planned and what was travelled. */
+export interface FollowMeHistoryTrack {
+    sessionId: string;
+    path: SafetyHistoryPath;
+    waypoints: FollowMeWaypointView[];
+    /** With geometry: ORIGINAL first, then each RECALCULATED in order. */
+    routes: FollowMeRouteView[];
+    eventMarkers: FollowMeHistoryEventMarker[];
+    serverTime: string;
+}

package/dist/types/modules/tracking/enums/tracking-provider-code.enum.d.ts

@@ -22,5 +22,13 @@ export declare enum TrackingProviderCode {
     /** Generic WebSocket adapter (reserved). */
     GENERIC_WEBSOCKET = "GENERIC_WEBSOCKET",
     /** Generic HTTP polling adapter (reserved). */
-    GENERIC_HTTP_POLLING = "GENERIC_HTTP_POLLING"
+    GENERIC_HTTP_POLLING = "GENERIC_HTTP_POLLING",
+    /**
+     * The responder app: the phone of the responder on duty with a unit reports
+     * the unit's position (`POST /tracking/responder/positions`). Inbound only -
+     * there is no connection to open, so the connector never runs a session
+     * for it. Used only for units with no enabled hardware tracker binding, so
+     * a vehicle's tracker and a crew member's phone never compete.
+     */
+    MOBILE_APP = "MOBILE_APP"
 }

package/package.json

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