grm-shared-library 1.1.222 → 1.1.224

package/dist/types/modules/safety/utils/follow-me-state-machine.d.ts

@@ -0,0 +1,51 @@
+import { FollowMeParticipantStatus, FollowMeStatus, FollowMeTrackingHealth } from '../enums/follow-me.enums';
+/**
+ * Every legal Follow Me transition. Applied by clarion-safety as a conditional
+ * update, so the database settles every race (arrival vs a deviation, "I'm OK" at
+ * the deadline, stop while a prompt expires). Re-applying the current state is an
+ * idempotent no-op, not listed here.
+ *
+ * Two rules the table encodes on purpose:
+ *   - PROMPTING cannot EXPIRE and cannot ARRIVE: an open prompt is answered or
+ *     escalated before the session is allowed to end on its own. The user CAN stop
+ *     while prompted - doing so is itself proof they are responsive.
+ *   - SOS_TRIGGERED ends Follow Me; the journey continues as the incident's trip.
+ */
+export declare const FOLLOW_ME_TRANSITIONS: Readonly<Record<FollowMeStatus, readonly FollowMeStatus[]>>;
+/** At most one of these per user. */
+export declare const OPEN_FOLLOW_ME_STATUSES: readonly FollowMeStatus[];
+export declare const TERMINAL_FOLLOW_ME_STATUSES: readonly FollowMeStatus[];
+/**
+ * States in which followers may see the LIVE position. SOS_TRIGGERED is not one:
+ * app guardians move to the existing SOS follow, and the external page is served
+ * by its own rule in clarion-safety (live while the incident trip is still active,
+ * never past the 24 h cap).
+ */
+export declare const LIVE_FOLLOW_ME_STATUSES: readonly FollowMeStatus[];
+export declare function isOpenFollowMeStatus(status: FollowMeStatus | string | null | undefined): boolean;
+export declare function isTerminalFollowMeStatus(status: FollowMeStatus | string | null | undefined): boolean;
+export declare function canTransitionFollowMe(from: FollowMeStatus, to: FollowMeStatus): boolean;
+export declare function allowedFollowMeSourcesFor(to: FollowMeStatus): FollowMeStatus[];
+/**
+ * A guardian's own transitions while the session is live. EXPIRED is reached only
+ * when the session ends, never by the guardian.
+ */
+export declare const FOLLOW_ME_PARTICIPANT_TRANSITIONS: Readonly<Record<FollowMeParticipantStatus, readonly FollowMeParticipantStatus[]>>;
+export declare function canTransitionParticipant(from: FollowMeParticipantStatus, to: FollowMeParticipantStatus): boolean;
+/** Whether a participant may see the live position right now. */
+export declare function participantHasLiveAccess(participant: FollowMeParticipantStatus, session: FollowMeStatus): boolean;
+/** Live, stale or never seen - so no screen ever calls a stale position "live". */
+export declare function followMeTrackingHealth(lastLocationAt: Date | null, now: Date): FollowMeTrackingHealth;
+/** When a prompt shown at `startedAt` stops being visible to the user. */
+export declare function followMePromptDeadline(startedAt: Date, countdownSeconds: number): Date;
+/** When the server escalates an unanswered prompt: the visible deadline plus the grace. */
+export declare function followMePromptSosDueAt(deadlineAt: Date): Date;
+/**
+ * The default duration for a planned journey: its travel time plus a buffer,
+ * rounded up to 15 minutes, capped at the 24 h maximum.
+ */
+export declare function suggestFollowMeDurationMinutes(routeDurationSeconds: number | null | undefined): number;
+/** Whether a journey of this length can be followed at all. */
+export declare function routeExceedsFollowMeMaximum(routeDurationSeconds: number): boolean;
+/** +2547******78 - enough to recognise, not enough to use. */
+export declare function maskPhoneNumber(phone: string | null | undefined): string | null;

package/dist/types/modules/sms/enums/sms-template.enum.d.ts

@@ -8,6 +8,8 @@ export declare enum SmsTemplateType {
     INCIDENT_GUARDIAN_NOTIFICATION = "incident_guardian_notification",
     SAFETY_CHECK_GUARDIAN_STARTED = "safety_check_guardian_started",
     SAFETY_CHECK_GUARDIAN_ENDED = "safety_check_guardian_ended",
+    FOLLOW_ME_GUARDIAN_REQUEST = "follow_me_guardian_request",
+    FOLLOW_ME_GUARDIAN_ENDED = "follow_me_guardian_ended",
     APPOINTMENT_REMINDER = "appointment_reminder",
     GENERAL_NOTIFICATION = "general_notification"
 }

package/package.json

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