clarion-shared-types 1.0.104 → 1.0.106

package/dist/types/modules/safety/interfaces/safety-check.dto.d.ts

@@ -0,0 +1,176 @@
+import { GuardianAudience } from '../../alert-dispatch/interfaces/guardian-audience';
+import { SafetyCheckActorType, SafetyCheckAuditEventType, SafetyCheckSosTrigger, SafetyCheckStatus } from '../enums/safety-enums';
+/**
+ * Response shapes of clarion-safety, mirrored from grm-shared-library
+ * (modules/safety/interfaces/safety-check.ts). Timestamps are ISO 8601 strings
+ * from the server clock.
+ */
+/** A reason as the app's dropdown shows it. */
+export interface SafetyCheckReasonView {
+    id: string;
+    code: string;
+    label: string;
+    description: string | null;
+    /** The "Write my own" entry: the user types the reason. */
+    isCustom: boolean;
+    displayOrder: number;
+}
+/** A reason as the admin manages it. */
+export interface SafetyCheckReasonAdminView extends SafetyCheckReasonView {
+    /** Null for a platform-wide reason (Super-Admin only). */
+    organizationId: number | null;
+    /** Null for every country. */
+    countryCode: string | null;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Body of POST /safety/admin/check-reasons. */
+export interface CreateSafetyCheckReasonRequest {
+    code: string;
+    label: string;
+    description?: string;
+    organizationId?: number;
+    countryCode?: string;
+    isCustom?: boolean;
+    active?: boolean;
+    displayOrder?: number;
+}
+/** Body of PATCH /safety/admin/check-reasons/:id. Code, organization and custom-ness are fixed. */
+export interface UpdateSafetyCheckReasonRequest {
+    label?: string;
+    description?: string | null;
+    countryCode?: string | null;
+    active?: boolean;
+    displayOrder?: number;
+}
+/** One Safety Check as its owner sees it. */
+export interface SafetyCheckView {
+    id: string;
+    status: SafetyCheckStatus;
+    reasonId: string | null;
+    reasonCode: string | null;
+    reasonLabel: string;
+    customReason: string | null;
+    durationMinutes: number;
+    extensionCount: number;
+    startedAt: string;
+    scheduledCheckInAt: string;
+    promptCountdownSeconds: number;
+    promptStartedAt: string | null;
+    promptDeadlineAt: string | null;
+    checkedInAt: string | null;
+    endedAt: string | null;
+    guardians: GuardianAudience;
+    notifyGuardiansOnStartEnd: boolean;
+    notifyServiceProviderRequested: boolean;
+    notifyServiceProviderAllowed: boolean;
+    sosTrigger: SafetyCheckSosTrigger | null;
+    sosTriggeredAt: string | null;
+    incidentId: number | null;
+    tripId: string | null;
+    serverTime: string;
+}
+/** What the setup screens need from the server. */
+export interface SafetyCheckStartOptions {
+    limits: {
+        minDurationMinutes: number;
+        maxDurationMinutes: number;
+        presetDurationsMinutes: number[];
+        minPromptCountdownSeconds: number;
+        maxPromptCountdownSeconds: number;
+        customReasonMaxLength: number;
+    };
+    defaults: {
+        durationMinutes: number;
+        promptCountdownSeconds: number;
+        notifyServiceProvider: boolean;
+        notifyGuardiansOnStartEnd: boolean;
+    };
+    serviceProvider: {
+        available: boolean;
+        tier: string | null;
+        degraded: boolean;
+    };
+    serverTime: string;
+}
+/** The recorded trip, WITHOUT coordinates - location is never shown before an SOS. */
+export interface SafetyCheckTripSummary {
+    id: string;
+    status: string;
+    visibility: string;
+    purpose: string;
+    incidentId: number | null;
+    startedAt: string;
+    endedAt: string | null;
+    sharedAt: string | null;
+    distanceMeters: number | null;
+    trackPointCount: number;
+}
+export interface SafetyCheckAuditEntry {
+    id: string;
+    eventType: SafetyCheckAuditEventType;
+    fromStatus: SafetyCheckStatus | null;
+    toStatus: SafetyCheckStatus | null;
+    actorType: SafetyCheckActorType;
+    actorUserId: number | null;
+    /** Identifiers and timings only - never a location or a message body. */
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+}
+/** A row of the admin list. */
+export interface SafetyCheckAdminListItem {
+    id: string;
+    status: SafetyCheckStatus;
+    userId: number;
+    userName: string | null;
+    organizationId: number;
+    controlCentreId: number | null;
+    reasonLabel: string;
+    durationMinutes: number;
+    startedAt: string;
+    scheduledCheckInAt: string;
+    checkedInAt: string | null;
+    endedAt: string | null;
+    sosTrigger: SafetyCheckSosTrigger | null;
+    incidentId: number | null;
+    createdAt: string;
+}
+/** The check as the admin detail view receives it. */
+export interface SafetyCheckAdminView extends SafetyCheckView {
+    userId: number;
+    userName: string | null;
+    userPhoneNumber: string | null;
+    organizationId: number;
+    controlCentreId: number | null;
+    appId: string | null;
+    countryCode: string | null;
+    entitlementTierAtStart: string | null;
+    workflowId: string | null;
+    workflowStartedAt: string | null;
+    trackPointCount: number;
+    lastLocationAt: string | null;
+    sosAttempts: number;
+    sosFailureReason: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** The admin detail view. */
+export interface SafetyCheckAdminDetail {
+    check: SafetyCheckAdminView;
+    events: SafetyCheckAuditEntry[];
+    trip: SafetyCheckTripSummary | null;
+}
+/** Filters for GET /safety/admin/checks. */
+export interface SafetyCheckAdminQuery {
+    page?: number;
+    limit?: number;
+    status?: SafetyCheckStatus;
+    /** Super-admin only. */
+    organizationId?: number;
+    userId?: number;
+    sosOnly?: boolean;
+    from?: string;
+    to?: string;
+    id?: string;
+}

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

@@ -0,0 +1,18 @@
+import { SafetyCheckActorType, SafetyCheckAuditEventType, SafetyCheckSosTrigger, SafetyCheckStatus } from '../enums/safety-enums';
+/**
+ * Human labels for the Safety enums, kept here so every screen that shows a
+ * Safety Check names the same state the same way.
+ */
+export declare const SAFETY_CHECK_STATUS_LABELS: Readonly<Record<SafetyCheckStatus, string>>;
+export declare const SAFETY_CHECK_SOS_TRIGGER_LABELS: Readonly<Record<SafetyCheckSosTrigger, string>>;
+export declare const SAFETY_CHECK_ACTOR_TYPE_LABELS: Readonly<Record<SafetyCheckActorType, string>>;
+export declare const SAFETY_CHECK_AUDIT_EVENT_LABELS: Readonly<Record<SafetyCheckAuditEventType, string>>;
+/** Chip tone. The admin maps these onto its own classes. */
+export type SafetyTone = 'success' | 'warn' | 'danger' | 'neutral' | 'info';
+export declare function safetyCheckStatusTone(status: SafetyCheckStatus): SafetyTone;
+/** Whether the check is still running (the user is "in" it). */
+export declare function isOpenSafetyCheck(status: SafetyCheckStatus): boolean;
+/** "15 min", "2 h", "1 h 30 min", "24 h". */
+export declare function formatSafetyCheckDuration(minutes: number | null | undefined): string;
+/** A distance in metres as the admin shows it. */
+export declare function formatSafetyTripDistance(metres: number | null | undefined): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clarion-shared-types",
-  "version": "1.0.104",
+  "version": "1.0.106",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",