clarion-shared-types 1.0.106 → 1.0.108

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

@@ -6,6 +6,7 @@ export * from './enums/incident-status.enum';
 export * from './enums/incident-actions.enum';
 export * from './enums/incident-workflow-queue-name.enum';
 export * from './enums/incident-emergency-type.enum';
+export * from './enums/incident-origin-type.enum';
 export * from './intefaces/incident';
 export * from './intefaces/incident-action';
 export * from './intefaces/incident-attachment';

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

@@ -1,3 +1,5 @@
+import { IncidentOriginType } from '../enums/incident-origin-type.enum';
+import { SafetyAlertContext } from '../../safety/interfaces/safety-alert-context';
 import { IncidentPartnerRoutingStatus } from "../../partner/enums/partner-enums";
 import { IncidentPartnerRoutingSnapshotDto } from "../../partner/interfaces/incident-partner-routing.dto";
 import { MapLocation } from "../../common/interfaces/map-location";
@@ -37,6 +39,12 @@ export interface Incident {
     originalDescription?: string | null;
     /** ISO 639-1 code of `originalDescription`'s language, e.g. `sw`. */
     originalLanguage?: string | null;
+    /** Set when a safety feature raised the incident; absent for everything a person raised. */
+    originType?: IncidentOriginType | null;
+    /** The raising record: a Safety Check or Follow Me session id. */
+    originReferenceId?: string | null;
+    /** Why the safety feature raised it, as labelled facts for responders. */
+    originContext?: SafetyAlertContext | null;
     status?: IncidentStatus;
     statusDetails?: IncidentStatusDetails;
     priority?: IncidentPriority;

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

@@ -178,6 +178,11 @@ export declare enum PermissionActions {
     USE_SAFETY_CHECK = "use:safety-check",
     READ_SAFETY_CHECK = "read:safety-check",
     MANAGE_SAFETY_CHECK_REASON = "manage:safety-check-reason",
+    READ_SAFETY_ANALYTICS = "read:safety-analytics",
+    USE_FOLLOW_ME = "use:follow-me",
+    READ_FOLLOW_ME = "read:follow-me",
+    TRACK_FOLLOW_ME = "track:follow-me",
+    MANAGE_SAVED_PLACE = "manage:saved-place",
     /** @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

@@ -13,5 +13,6 @@ export declare enum PermissionsModule {
     SUPPORT = "Support",
     NOTIFICATION = "Notification",
     ALERT_INTAKE = "Alert Intake",
-    SAFETY = "Safety"
+    SAFETY = "Safety",
+    PLACES = "Places"
 }

package/dist/types/modules/role/constants/safety-roles.d.ts

@@ -6,3 +6,9 @@
 export declare const SAFETY_MANAGER_ROLES: string[];
 /** Staff who may read Safety Checks: the managers, and a control-centre admin within their control centre. */
 export declare const SAFETY_VIEWER_ROLES: string[];
+/** Staff who may see Follow Me sessions (read:follow-me) and, where shared, where the user is (track:follow-me). */
+export declare const FOLLOW_ME_VIEWER_ROLES: string[];
+/** Admitted by clarion-socket to `followme:org:{orgId}`. */
+export declare const FOLLOW_ME_ORG_TRACKER_ROLES: string[];
+/** Admitted by clarion-socket to `followme:cc:{orgId}:{ccId}`. */
+export declare const FOLLOW_ME_CC_TRACKER_ROLES: string[];

package/dist/types/modules/safety/constants/follow-me.const.d.ts

@@ -0,0 +1,46 @@
+import { FollowMeTransportMode } from '../enums/follow-me.enums';
+export declare const FOLLOW_ME_LIMITS: {
+    readonly minDurationMinutes: 5;
+    readonly maxDurationMinutes: number;
+    readonly defaultDurationMinutes: 60;
+    readonly routeDurationBufferMinutes: 30;
+    readonly minPromptCountdownSeconds: 15;
+    readonly maxPromptCountdownSeconds: number;
+    readonly defaultPromptCountdownSeconds: 60;
+    readonly promptGraceSeconds: 10;
+    readonly staleSosWindowMinutes: number;
+    readonly maxIntermediateStops: 5;
+    readonly customReasonMaxLength: 120;
+    readonly maxTrackPointsPerBatch: 200;
+    readonly routePreviewTtlMinutes: 30;
+    readonly trackingStaleAfterSeconds: 120;
+    readonly externalPollIntervalSeconds: 10;
+    readonly externalRequestsPerMinute: 20;
+    readonly externalTokenBytes: 32;
+};
+export declare const FOLLOW_ME_DEFAULTS: {
+    readonly durationMinutes: 60;
+    readonly promptCountdownSeconds: 60;
+    readonly allGuardiansSelected: true;
+    readonly notifyServiceProvider: true;
+    readonly notifyGuardiansOnStartEnd: true;
+    readonly transportMode: FollowMeTransportMode.DRIVE;
+    readonly vibrate: true;
+    readonly alarmSound: true;
+};
+/** States in which followers may see the live position. */
+export declare const LIVE_FOLLOW_ME_STATUS_VALUES: readonly string[];
+/** Header the public follow page sends its token in (the token lives in the URL fragment). */
+export declare const FOLLOW_ME_TOKEN_HEADER = "x-follow-token";
+/** Socket.IO event carrying every live Safety update. */
+export declare const SAFETY_SOCKET_EVENT = "safety.event";
+/**
+ * Staff rooms that receive a session's live Follow Me updates, and only when the
+ * user shared the journey with their provider. clarion-socket admits
+ * FOLLOW_ME_ORG_TRACKER_ROLES to the org room and FOLLOW_ME_CC_TRACKER_ROLES to
+ * their own control centre's room.
+ */
+export declare const FOLLOW_ME_ROOMS: {
+    readonly organization: (organizationId: number) => string;
+    readonly controlCentre: (organizationId: number, controlCentreId: number) => string;
+};

package/dist/types/modules/safety/enums/follow-me.enums.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Lifecycle of one Follow Me session. clarion-safety is the only writer; every
+ * transition is validated against FOLLOW_ME_TRANSITIONS and applied as a
+ * conditional update, exactly as a Safety Check is.
+ *
+ *   CREATED        accepted and persisted; the trip, the timer and the guardian
+ *                  requests are being set up. Already counts as live.
+ *   ACTIVE         the journey is being shared and monitored.
+ *   PROMPTING      a safety prompt is open (see FollowMePromptStatus); an SOS is
+ *                  raised if it is not answered.
+ *   ARRIVED        the destination was reached. Terminal, successful.
+ *   SOS_TRIGGERED  an SOS was raised - a prompt went unanswered or the user
+ *                  asked for one. Follow Me is over; the recorded trip goes on as
+ *                  the incident's trip and followers move to the SOS view.
+ *   STOPPED        the user ended it. Terminal.
+ *   EXPIRED        the chosen duration ran out before arrival. Terminal; never
+ *                  raises an SOS by itself. Deferred while a prompt is open.
+ *   CANCELLED      ended by the platform rather than the user (e.g. sign-out).
+ *   FAILED         the SOS could not be raised because clarion-incident refused
+ *                  it outright. Terminal; the user and guardians are told to act.
+ *
+ * Deliberately NOT a status: whether live sharing is healthy. That is
+ * FollowMeTrackingHealth, derived from when the last location arrived - a
+ * session with a flat battery is still a session.
+ */
+export declare enum FollowMeStatus {
+    CREATED = "CREATED",
+    ACTIVE = "ACTIVE",
+    PROMPTING = "PROMPTING",
+    ARRIVED = "ARRIVED",
+    SOS_TRIGGERED = "SOS_TRIGGERED",
+    STOPPED = "STOPPED",
+    EXPIRED = "EXPIRED",
+    CANCELLED = "CANCELLED",
+    FAILED = "FAILED"
+}
+/**
+ * One guardian's relationship to a session - separate from the session's own
+ * state. A guardian stopping following never ends the session.
+ *
+ *   PENDING            asked, not yet answered.
+ *   ACCEPTED           following (whether they are looking right now is
+ *                      presence, not state).
+ *   DECLINED           said no. May still accept while the session is live.
+ *   STOPPED_FOLLOWING  followed, then stopped. May follow again while live.
+ *   EXPIRED            the session ended; every open participation ends with it.
+ */
+export declare enum FollowMeParticipantStatus {
+    PENDING = "PENDING",
+    ACCEPTED = "ACCEPTED",
+    DECLINED = "DECLINED",
+    STOPPED_FOLLOWING = "STOPPED_FOLLOWING",
+    EXPIRED = "EXPIRED"
+}
+/** Who a participant is. App guardians sign in; external guardians hold a link. */
+export declare enum FollowMeParticipantKind {
+    SYSTEM_GUARDIAN = "SYSTEM_GUARDIAN",
+    EXTERNAL_GUARDIAN = "EXTERNAL_GUARDIAN"
+}
+export declare enum FollowMeTransportMode {
+    WALK = "WALK",
+    DRIVE = "DRIVE",
+    TWO_WHEELER = "TWO_WHEELER",
+    PUBLIC_TRANSPORT = "PUBLIC_TRANSPORT",
+    /** A taxi or ride-hail: routed as driving, monitored as a vehicle. */
+    RIDE_SERVICE = "RIDE_SERVICE"
+}
+export declare enum FollowMeWaypointKind {
+    START = "START",
+    STOP = "STOP",
+    DESTINATION = "DESTINATION"
+}
+/** A route is never replaced silently: the plan and every recalculation are kept. */
+export declare enum FollowMeRouteKind {
+    ORIGINAL = "ORIGINAL",
+    RECALCULATED = "RECALCULATED"
+}
+/** What made Follow Me ask the user whether they are safe. */
+export declare enum FollowMeSafetyTrigger {
+    CRASH_SUSPECTED = "CRASH_SUSPECTED",
+    ROUTE_DEVIATION = "ROUTE_DEVIATION",
+    PROLONGED_STOP = "PROLONGED_STOP",
+    ETA_OVERDUE = "ETA_OVERDUE"
+}
+export declare enum FollowMePromptStatus {
+    ACTIVE = "ACTIVE",
+    CONFIRMED_OK = "CONFIRMED_OK",
+    /** Unanswered - the SOS followed. */
+    EXPIRED = "EXPIRED",
+    /** Closed without an answer for another reason: the session ended, or the user pressed SOS. */
+    CANCELLED = "CANCELLED"
+}
+/**
+ * What the monitors observed (follow_me_safety_events). Evidence, not decisions:
+ * most of these never become a prompt.
+ */
+export declare enum FollowMeSafetyEventType {
+    OFF_ROUTE_SUSPECTED = "OFF_ROUTE_SUSPECTED",
+    BACK_ON_ROUTE = "BACK_ON_ROUTE",
+    ROUTE_RECALCULATED = "ROUTE_RECALCULATED",
+    DEVIATION_CONFIRMED = "DEVIATION_CONFIRMED",
+    PROLONGED_STOP_DETECTED = "PROLONGED_STOP_DETECTED",
+    STOP_DEFERRED_FOR_TRAFFIC = "STOP_DEFERRED_FOR_TRAFFIC",
+    ETA_RECALCULATED = "ETA_RECALCULATED",
+    ETA_OVERDUE_DETECTED = "ETA_OVERDUE_DETECTED",
+    CRASH_REPORTED = "CRASH_REPORTED",
+    CRASH_REJECTED = "CRASH_REJECTED",
+    ARRIVAL_DETECTED = "ARRIVAL_DETECTED",
+    TRACKING_STALE = "TRACKING_STALE",
+    TRACKING_RESTORED = "TRACKING_RESTORED"
+}
+/** Is the session's live location actually live? Derived from lastLocationAt. */
+export declare enum FollowMeTrackingHealth {
+    LIVE = "LIVE",
+    /** Nothing for a while - show "last seen N min ago", never "live". */
+    STALE = "STALE",
+    /** No location has arrived yet. */
+    NO_SIGNAL = "NO_SIGNAL"
+}
+/** Audit trail (follow_me_audit_events). Never carries a location or a token. */
+export declare enum FollowMeAuditEventType {
+    CREATED = "CREATED",
+    ACTIVATED = "ACTIVATED",
+    TRACKING_STARTED = "TRACKING_STARTED",
+    TRACKING_UNAVAILABLE = "TRACKING_UNAVAILABLE",
+    WORKFLOW_STARTED = "WORKFLOW_STARTED",
+    WORKFLOW_START_FAILED = "WORKFLOW_START_FAILED",
+    CHAT_CREATED = "CHAT_CREATED",
+    GUARDIAN_INVITED = "GUARDIAN_INVITED",
+    GUARDIAN_ACCEPTED = "GUARDIAN_ACCEPTED",
+    GUARDIAN_DECLINED = "GUARDIAN_DECLINED",
+    GUARDIAN_STOPPED_FOLLOWING = "GUARDIAN_STOPPED_FOLLOWING",
+    EXTERNAL_LINK_ISSUED = "EXTERNAL_LINK_ISSUED",
+    EXTERNAL_LINK_USED = "EXTERNAL_LINK_USED",
+    ROUTE_RECALCULATED = "ROUTE_RECALCULATED",
+    PROMPT_STARTED = "PROMPT_STARTED",
+    PROMPT_CONFIRMED = "PROMPT_CONFIRMED",
+    PROMPT_EXPIRED = "PROMPT_EXPIRED",
+    PROMPT_CANCELLED = "PROMPT_CANCELLED",
+    SOS_TRIGGERED = "SOS_TRIGGERED",
+    SOS_INCIDENT_CREATED = "SOS_INCIDENT_CREATED",
+    SOS_INCIDENT_RETRY = "SOS_INCIDENT_RETRY",
+    SOS_FAILED = "SOS_FAILED",
+    ARRIVED = "ARRIVED",
+    STOPPED = "STOPPED",
+    EXPIRED = "EXPIRED",
+    CANCELLED = "CANCELLED"
+}
+/** Kafka event types (the `eventType` of FollowMeEvent), one topic each. */
+export declare enum FollowMeEventType {
+    STARTED = "FOLLOW_ME_STARTED",
+    GUARDIAN_RESPONDED = "FOLLOW_ME_GUARDIAN_RESPONDED",
+    PROMPTING = "FOLLOW_ME_PROMPTING",
+    SOS_TRIGGERED = "FOLLOW_ME_SOS_TRIGGERED",
+    ENDED = "FOLLOW_ME_ENDED"
+}
+/** Socket.IO `safety.event` types for Follow Me (FollowMeRealtimeEnvelope.type). */
+export declare enum FollowMeRealtimeEventType {
+    STARTED = "FOLLOW_ME_STARTED",
+    REQUEST = "FOLLOW_ME_REQUEST",
+    GUARDIAN_ACCEPTED = "FOLLOW_ME_GUARDIAN_ACCEPTED",
+    GUARDIAN_DECLINED = "FOLLOW_ME_GUARDIAN_DECLINED",
+    GUARDIAN_STOPPED_FOLLOWING = "FOLLOW_ME_GUARDIAN_STOPPED_FOLLOWING",
+    LOCATION_UPDATED = "FOLLOW_ME_LOCATION_UPDATED",
+    ROUTE_UPDATED = "FOLLOW_ME_ROUTE_UPDATED",
+    ETA_UPDATED = "FOLLOW_ME_ETA_UPDATED",
+    SAFETY_EVENT = "FOLLOW_ME_SAFETY_EVENT",
+    PROMPT_STARTED = "FOLLOW_ME_PROMPT_STARTED",
+    PROMPT_CONFIRMED = "FOLLOW_ME_PROMPT_CONFIRMED",
+    SOS_TRIGGERED = "FOLLOW_ME_SOS_TRIGGERED",
+    ARRIVED = "FOLLOW_ME_ARRIVED",
+    STOPPED = "FOLLOW_ME_STOPPED",
+    EXPIRED = "FOLLOW_ME_EXPIRED",
+    ENDED = "FOLLOW_ME_ENDED",
+    PROVIDER_UPDATED = "FOLLOW_ME_PROVIDER_UPDATED"
+}
+/**
+ * Push `data.action` / `data.type` values for Follow Me (allow-listed by the
+ * app's notification_deep_link_coordinator.dart - changing one breaks installed
+ * apps).
+ */
+export declare enum FollowMePushAction {
+    /** To a guardian: somebody asked you to follow their journey. */
+    FOLLOW_ME_REQUEST = "FOLLOW_ME_REQUEST",
+    /** To the user: a guardian accepted or declined. */
+    FOLLOW_ME_GUARDIAN_RESPONDED = "FOLLOW_ME_GUARDIAN_RESPONDED",
+    /** To the user: confirm you are safe. */
+    FOLLOW_ME_PROMPT = "FOLLOW_ME_PROMPT",
+    /** To the user and followers: an SOS was raised from Follow Me. */
+    FOLLOW_ME_SOS_TRIGGERED = "FOLLOW_ME_SOS_TRIGGERED",
+    /** To followers (and the user when it ended without them): Follow Me ended. */
+    FOLLOW_ME_ENDED = "FOLLOW_ME_ENDED"
+}
+/** Machine-readable `code` on every Follow Me error. */
+export declare enum FollowMeErrorCode {
+    NOT_FOUND = "FOLLOW_ME_NOT_FOUND",
+    ALREADY_ACTIVE = "FOLLOW_ME_ALREADY_ACTIVE",
+    ALREADY_ENDED = "FOLLOW_ME_ENDED",
+    SOS_ALREADY_TRIGGERED = "FOLLOW_ME_SOS_ALREADY_TRIGGERED",
+    INVALID_TRANSITION = "FOLLOW_ME_INVALID_TRANSITION",
+    INVALID_DURATION = "FOLLOW_ME_INVALID_DURATION",
+    ROUTE_EXCEEDS_MAX_DURATION = "FOLLOW_ME_ROUTE_EXCEEDS_MAX_DURATION",
+    ROUTE_INVALID = "FOLLOW_ME_ROUTE_INVALID",
+    ROUTE_EXPIRED = "FOLLOW_ME_ROUTE_EXPIRED",
+    ROUTING_UNAVAILABLE = "FOLLOW_ME_ROUTING_UNAVAILABLE",
+    INVALID_REASON = "FOLLOW_ME_INVALID_REASON",
+    CUSTOM_REASON_REQUIRED = "FOLLOW_ME_CUSTOM_REASON_REQUIRED",
+    GUARDIAN_NOT_FOUND = "FOLLOW_ME_GUARDIAN_NOT_FOUND",
+    GUARDIANS_UNAVAILABLE = "FOLLOW_ME_GUARDIANS_UNAVAILABLE",
+    NO_RECIPIENTS = "FOLLOW_ME_NO_RECIPIENTS",
+    SERVICE_PROVIDER_NOT_ENTITLED = "FOLLOW_ME_SERVICE_PROVIDER_NOT_ENTITLED",
+    PROMPT_NOT_ACTIVE = "FOLLOW_ME_PROMPT_NOT_ACTIVE",
+    TRACKING_CLOSED = "FOLLOW_ME_TRACKING_CLOSED",
+    NOT_A_PARTICIPANT = "FOLLOW_ME_NOT_A_PARTICIPANT",
+    ACCESS_EXPIRED = "FOLLOW_ME_ACCESS_EXPIRED",
+    LOCATION_NOT_SHARED = "FOLLOW_ME_LOCATION_NOT_SHARED",
+    RATE_LIMITED = "FOLLOW_ME_RATE_LIMITED"
+}

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

@@ -18,10 +18,12 @@ export declare enum SafetyCheckStatus {
     CANCELLED = "CANCELLED",
     FAILED = "FAILED"
 }
-/** Why a Safety Check raised an SOS. */
+/** Why a safety feature raised an SOS (shared by Safety Check and Follow Me). */
 export declare enum SafetyCheckSosTrigger {
     MISSED_CHECK_IN = "MISSED_CHECK_IN",
-    USER_REQUESTED = "USER_REQUESTED"
+    USER_REQUESTED = "USER_REQUESTED",
+    /** Follow Me: a safety prompt (crash, deviation, stop, overdue) went unanswered. */
+    MISSED_SAFETY_PROMPT = "MISSED_SAFETY_PROMPT"
 }
 /** Who caused a Safety Check transition. */
 export declare enum SafetyCheckActorType {

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

@@ -1,5 +1,11 @@
 export * from './enums/safety-enums';
+export * from './enums/follow-me.enums';
 export * from './constants/safety-check-limits.const';
 export * from './constants/safety-taxonomy.const';
+export * from './constants/follow-me.const';
 export * from './interfaces/safety-check.dto';
+export * from './interfaces/safety-alert-context';
+export * from './interfaces/follow-me.dto';
+export * from './interfaces/safety-analytics';
 export * from './utils/safety-display.util';
+export * from './utils/follow-me-display.util';