grm-shared-library 1.1.221 → 1.1.223

package/dist/cjs/modules/safety/constants/safety-integration.const.js

@@ -0,0 +1,151 @@
+"use strict";
+/**
+ * Cross-service contracts for the Safety domain. Each value is read by more than
+ * one repository - change both sides together.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FOLLOW_ME_REDIS_KEYS = exports.FOLLOW_ME_ROOMS = exports.SAFETY_REALTIME_ROOM_PATTERNS = exports.SAFETY_SOCKET_EVENT = exports.SAFETY_REALTIME_CHANNEL = exports.FOLLOW_ME_TOKEN_HEADER = exports.FOLLOW_ME_MOBILE_ROUTES = exports.FOLLOW_ME_INTERNAL_PATHS = exports.FOLLOW_ME_WORKFLOW = exports.SAFETY_REDIS_KEYS = exports.SAFETY_MOBILE_ROUTES = exports.SAFETY_INTERNAL_PATHS = exports.SAFETY_CHECK_WORKFLOW = exports.SAFETY_INTERNAL_TOKEN_ENV_KEYS = exports.SAFETY_INTERNAL_TOKEN_HEADER = void 0;
+exports.safetyCheckWorkflowId = safetyCheckWorkflowId;
+exports.followMeWorkflowId = followMeWorkflowId;
+/**
+ * Header carrying the shared internal service token on the calls that can raise
+ * or steer an SOS: workflow-manager -> clarion-safety (advance), clarion-safety
+ * -> workflow-manager (start/signal) and clarion-safety -> clarion-incident
+ * (create the Safety SOS incident). Same header workflow-manager already
+ * requires on its API.
+ */
+exports.SAFETY_INTERNAL_TOKEN_HEADER = 'x-internal-service-token';
+/**
+ * Env vars the token is read from, in order. `SAFETY_INTERNAL_API_TOKEN` may hold
+ * a comma-separated list (rotation); when it is unset every party falls back to
+ * `WORKFLOW_MANAGER_API_TOKEN`, which every pod already receives from
+ * runtime-secrets. Senders use the FIRST value; receivers accept ANY.
+ */
+exports.SAFETY_INTERNAL_TOKEN_ENV_KEYS = ['SAFETY_INTERNAL_API_TOKEN', 'WORKFLOW_MANAGER_API_TOKEN'];
+/** Temporal: the durable Safety Check timer. */
+exports.SAFETY_CHECK_WORKFLOW = {
+    /** Registered workflow function name in clarion-workflow-manager. */
+    workflowType: 'safetyCheckWorkflow',
+    /** Default task queue; overridable with TEMPORAL_SAFETY_TASK_QUEUE. */
+    taskQueue: 'safety-check-task-queue',
+    /** Signal that wakes the workflow early (extension, check-in, stop, SOS). */
+    changedSignal: 'safetyCheckChanged',
+    /** Query returning the workflow's view of the next wake time. */
+    stateQuery: 'safetyCheckWorkflowState',
+};
+/** Workflow id for a Safety Check. One per check, ever - the id IS the idempotency key. */
+function safetyCheckWorkflowId(safetyCheckId) {
+    return `safety-check-${safetyCheckId}`;
+}
+/** Internal HTTP paths (not proxied by the gateway). */
+exports.SAFETY_INTERNAL_PATHS = {
+    /** clarion-safety: the one domain step the durable timer drives. */
+    advanceCheck: (safetyCheckId) => `/safety/internal/checks/${encodeURIComponent(safetyCheckId)}/advance`,
+    /** clarion-workflow-manager: start the timer for a check. */
+    startWorkflow: '/safety-checks/workflows',
+    /** clarion-workflow-manager: wake the timer early. */
+    signalWorkflow: (safetyCheckId) => `/safety-checks/workflows/${encodeURIComponent(safetyCheckId)}/signal`,
+    /** clarion-incident: raise the Safety SOS incident (idempotent per origin). */
+    createSafetyAlertIncident: '/incidents/safety-alerts',
+    /** clarion-incident: which of these incident type ids are platform-managed system types. */
+    classifyIncidentTypes: '/incident-types/classify',
+    /** clarion-gis private trips (tracked privately until an SOS shares them). */
+    createPrivateTrip: '/trips/private',
+    tripTrackPoints: (tripId) => `/trips/${encodeURIComponent(tripId)}/track-points`,
+    shareTrip: (tripId) => `/trips/${encodeURIComponent(tripId)}/share`,
+    stopPrivateTrip: (tripId) => `/trips/${encodeURIComponent(tripId)}/stop-private`,
+    tripSummary: (tripId) => `/trips/${encodeURIComponent(tripId)}/summary`,
+};
+/**
+ * go_router locations in clarion_mobile that pushes deep-link to. A push route
+ * is an APP location, never an API path.
+ */
+exports.SAFETY_MOBILE_ROUTES = {
+    active: '/safety-check/active',
+    prompt: '/safety-check/prompt',
+};
+/** Redis keys clarion-safety owns. */
+exports.SAFETY_REDIS_KEYS = {
+    sweeperLock: 'safety:lock:sweeper',
+    rateLimit: (userId, bucket) => `safety:rl:${bucket}:${userId}`,
+};
+// --- Follow Me ------------------------------------------------------------------------
+/** Temporal: the durable Follow Me timer (expiry, prompt deadline, ETA checks). */
+exports.FOLLOW_ME_WORKFLOW = {
+    workflowType: 'followMeWorkflow',
+    /** Shares the Safety task queue and worker with the Safety Check timer. */
+    taskQueue: exports.SAFETY_CHECK_WORKFLOW.taskQueue,
+    changedSignal: 'followMeChanged',
+    stateQuery: 'followMeWorkflowState',
+};
+/** One workflow per session, ever. */
+function followMeWorkflowId(sessionId) {
+    return `follow-me-${sessionId}`;
+}
+/** Internal HTTP paths for Follow Me (never proxied by the gateway). */
+exports.FOLLOW_ME_INTERNAL_PATHS = {
+    /** clarion-safety: the one step the durable timer drives. */
+    advanceSession: (sessionId) => `/safety/internal/follow-me/${encodeURIComponent(sessionId)}/advance`,
+    /**
+     * clarion-safety: mint a fresh external follow link for one participant, at the
+     * moment the SMS is sent. The raw token exists only in this response and the
+     * SMS - never on a Kafka topic, never in a log.
+     */
+    mintExternalLink: (participantId) => `/safety/internal/follow-me/participants/${encodeURIComponent(participantId)}/access-link`,
+    /** clarion-workflow-manager. */
+    startWorkflow: '/follow-me/workflows',
+    signalWorkflow: (sessionId) => `/follow-me/workflows/${encodeURIComponent(sessionId)}/signal`,
+    /** clarion-gis routing and places (internal; the gateway exposes the places ones to the app). */
+    computeRoute: '/gis/routes/compute',
+    placesAutocomplete: '/gis/places/autocomplete',
+    placeDetails: '/gis/places/details',
+    reverseGeocode: '/gis/places/reverse',
+    /** clarion-gis: a page of a trip's recorded points. */
+    tripPoints: (tripId) => `/trips/${encodeURIComponent(tripId)}/points`,
+};
+/** App locations for Follow Me pushes (go_router, never API paths). */
+exports.FOLLOW_ME_MOBILE_ROUTES = {
+    active: '/follow-me/active',
+    prompt: '/follow-me/prompt',
+    requests: '/follow-me/requests',
+    follow: (sessionId) => `/follow-me/follow/${encodeURIComponent(sessionId)}`,
+};
+/**
+ * Header the external follow page sends its token in. The link carries the token
+ * in the URL FRAGMENT (`/follow#t=...`), which browsers never send to a server, so
+ * it cannot land in a proxy or access log; the page reads it and sends it here.
+ */
+exports.FOLLOW_ME_TOKEN_HEADER = 'x-follow-token';
+/**
+ * Redis pub/sub channel clarion-safety publishes live Safety events on. The
+ * envelope DECLARES its rooms (as support does); clarion-socket validates them
+ * against SAFETY_REALTIME_ROOM_PATTERNS and never adds any.
+ */
+exports.SAFETY_REALTIME_CHANNEL = 'realtime:safety';
+/** Socket.IO event name clients listen to. */
+exports.SAFETY_SOCKET_EVENT = 'safety.event';
+/** The only rooms a Safety envelope may target. */
+exports.SAFETY_REALTIME_ROOM_PATTERNS = [
+    /^user:\d+$/,
+    /^followme:org:\d+$/,
+    /^followme:cc:\d+:\d+$/,
+];
+/**
+ * Staff rooms that receive a session's live Follow Me updates - ONLY when the user
+ * chose to include their provider. clarion-socket admits staff by role:
+ * org rooms FOLLOW_ME_ORG_TRACKER_ROLES of that organization, cc rooms
+ * FOLLOW_ME_CC_TRACKER_ROLES of that organization and control centre.
+ */
+exports.FOLLOW_ME_ROOMS = {
+    user: (userId) => `user:${userId}`,
+    organization: (organizationId) => `followme:org:${organizationId}`,
+    controlCentre: (organizationId, controlCentreId) => `followme:cc:${organizationId}:${controlCentreId}`,
+};
+exports.FOLLOW_ME_REDIS_KEYS = {
+    lastLocation: (sessionId) => `safety:fm:last:${sessionId}`,
+    routePreview: (token) => `safety:fm:route:${token}`,
+    presence: (sessionId, participantId) => `safety:fm:presence:${sessionId}:${participantId}`,
+    realtimeThrottle: (sessionId) => `safety:fm:rt:${sessionId}`,
+    externalRateLimit: (bucket) => `safety:rl:fm-ext:${bucket}`,
+};
+//# sourceMappingURL=safety-integration.const.js.map

package/dist/cjs/modules/safety/constants/safety-integration.const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety-integration.const.js","sourceRoot":"","sources":["../../../../../src/modules/safety/constants/safety-integration.const.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAgCH,sDAEC;AAkDD,gDAEC;AApFD;;;;;;GAMG;AACU,QAAA,4BAA4B,GAAG,0BAA0B,CAAC;AAEvE;;;;;GAKG;AACU,QAAA,8BAA8B,GAAG,CAAC,2BAA2B,EAAE,4BAA4B,CAAU,CAAC;AAEnH,gDAAgD;AACnC,QAAA,qBAAqB,GAAG;IACjC,qEAAqE;IACrE,YAAY,EAAE,qBAAqB;IACnC,uEAAuE;IACvE,SAAS,EAAE,yBAAyB;IACpC,6EAA6E;IAC7E,aAAa,EAAE,oBAAoB;IACnC,iEAAiE;IACjE,UAAU,EAAE,0BAA0B;CAChC,CAAC;AAEX,2FAA2F;AAC3F,SAAgB,qBAAqB,CAAC,aAAqB;IACvD,OAAO,gBAAgB,aAAa,EAAE,CAAC;AAC3C,CAAC;AAED,wDAAwD;AAC3C,QAAA,qBAAqB,GAAG;IACjC,oEAAoE;IACpE,YAAY,EAAE,CAAC,aAAqB,EAAE,EAAE,CAAC,2BAA2B,kBAAkB,CAAC,aAAa,CAAC,UAAU;IAC/G,6DAA6D;IAC7D,aAAa,EAAE,0BAA0B;IACzC,sDAAsD;IACtD,cAAc,EAAE,CAAC,aAAqB,EAAE,EAAE,CACtC,4BAA4B,kBAAkB,CAAC,aAAa,CAAC,SAAS;IAC1E,+EAA+E;IAC/E,yBAAyB,EAAE,0BAA0B;IACrD,4FAA4F;IAC5F,qBAAqB,EAAE,0BAA0B;IACjD,8EAA8E;IAC9E,iBAAiB,EAAE,gBAAgB;IACnC,eAAe,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,UAAU,kBAAkB,CAAC,MAAM,CAAC,eAAe;IACxF,SAAS,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,UAAU,kBAAkB,CAAC,MAAM,CAAC,QAAQ;IAC3E,eAAe,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,UAAU,kBAAkB,CAAC,MAAM,CAAC,eAAe;IACxF,WAAW,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,UAAU,kBAAkB,CAAC,MAAM,CAAC,UAAU;CACzE,CAAC;AAEX;;;GAGG;AACU,QAAA,oBAAoB,GAAG;IAChC,MAAM,EAAE,sBAAsB;IAC9B,MAAM,EAAE,sBAAsB;CACxB,CAAC;AAEX,sCAAsC;AACzB,QAAA,iBAAiB,GAAG;IAC7B,WAAW,EAAE,qBAAqB;IAClC,SAAS,EAAE,CAAC,MAAc,EAAE,MAAc,EAAE,EAAE,CAAC,aAAa,MAAM,IAAI,MAAM,EAAE;CACxE,CAAC;AAEX,yFAAyF;AAEzF,mFAAmF;AACtE,QAAA,kBAAkB,GAAG;IAC9B,YAAY,EAAE,kBAAkB;IAChC,2EAA2E;IAC3E,SAAS,EAAE,6BAAqB,CAAC,SAAS;IAC1C,aAAa,EAAE,iBAAiB;IAChC,UAAU,EAAE,uBAAuB;CAC7B,CAAC;AAEX,sCAAsC;AACtC,SAAgB,kBAAkB,CAAC,SAAiB;IAChD,OAAO,aAAa,SAAS,EAAE,CAAC;AACpC,CAAC;AAED,wEAAwE;AAC3D,QAAA,wBAAwB,GAAG;IACpC,6DAA6D;IAC7D,cAAc,EAAE,CAAC,SAAiB,EAAE,EAAE,CAClC,8BAA8B,kBAAkB,CAAC,SAAS,CAAC,UAAU;IACzE;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,aAAqB,EAAE,EAAE,CACxC,2CAA2C,kBAAkB,CAAC,aAAa,CAAC,cAAc;IAC9F,gCAAgC;IAChC,aAAa,EAAE,sBAAsB;IACrC,cAAc,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,wBAAwB,kBAAkB,CAAC,SAAS,CAAC,SAAS;IACrG,iGAAiG;IACjG,YAAY,EAAE,qBAAqB;IACnC,kBAAkB,EAAE,0BAA0B;IAC9C,YAAY,EAAE,qBAAqB;IACnC,cAAc,EAAE,qBAAqB;IACrC,uDAAuD;IACvD,UAAU,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,UAAU,kBAAkB,CAAC,MAAM,CAAC,SAAS;CACvE,CAAC;AAEX,uEAAuE;AAC1D,QAAA,uBAAuB,GAAG;IACnC,MAAM,EAAE,mBAAmB;IAC3B,MAAM,EAAE,mBAAmB;IAC3B,QAAQ,EAAE,qBAAqB;IAC/B,MAAM,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,qBAAqB,kBAAkB,CAAC,SAAS,CAAC,EAAE;CAC7E,CAAC;AAEX;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,gBAAgB,CAAC;AAEvD;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,iBAAiB,CAAC;AACzD,8CAA8C;AACjC,QAAA,mBAAmB,GAAG,cAAc,CAAC;AAElD,mDAAmD;AACtC,QAAA,6BAA6B,GAAsB;IAC5D,YAAY;IACZ,oBAAoB;IACpB,uBAAuB;CAC1B,CAAC;AAEF;;;;;GAKG;AACU,QAAA,eAAe,GAAG;IAC3B,IAAI,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,MAAM,EAAE;IAC1C,YAAY,EAAE,CAAC,cAAsB,EAAE,EAAE,CAAC,gBAAgB,cAAc,EAAE;IAC1E,aAAa,EAAE,CAAC,cAAsB,EAAE,eAAuB,EAAE,EAAE,CAC/D,eAAe,cAAc,IAAI,eAAe,EAAE;CAChD,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAChC,YAAY,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,kBAAkB,SAAS,EAAE;IAClE,YAAY,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,mBAAmB,KAAK,EAAE;IAC3D,QAAQ,EAAE,CAAC,SAAiB,EAAE,aAAqB,EAAE,EAAE,CAAC,sBAAsB,SAAS,IAAI,aAAa,EAAE;IAC1G,gBAAgB,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,gBAAgB,SAAS,EAAE;IACpE,iBAAiB,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,oBAAoB,MAAM,EAAE;CAC7D,CAAC"}

package/dist/cjs/modules/safety/constants/safety-taxonomy.const.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SAFETY_ALERTS_TAXONOMY = void 0;
+exports.safetyIncidentTypeCodeFor = safetyIncidentTypeCodeFor;
+exports.isSafetyIncidentTypeCode = isSafetyIncidentTypeCode;
+const safety_enums_1 = require("../enums/safety-enums");
+/**
+ * The incident category and types EVERY organization receives - existing ones by
+ * migration and reconciliation, new ones on `org.created`. There is no
+ * per-organization exception (NAVCDP included).
+ *
+ * They are SYSTEM rows in clarion-incident (`isSystem = true`, matched by
+ * `code`, never by name): hidden from the SOS bottom sheet and from package
+ * configuration, immutable through the admin API, and raised only by the
+ * safety features themselves.
+ *
+ * Names are stored once at provisioning; renaming here does not rename existing
+ * rows.
+ */
+exports.SAFETY_ALERTS_TAXONOMY = {
+    code: safety_enums_1.SafetyIncidentCategoryCode.SAFETY_ALERTS,
+    name: 'Safety Alerts',
+    description: 'SOS alerts raised automatically by Clarion safety features.',
+    types: [
+        {
+            code: safety_enums_1.SafetyIncidentTypeCode.SAFETY_CHECK_SOS,
+            name: 'Safety Check SOS',
+            description: 'Raised when a user misses a Safety Check check-in or asks for help during one.',
+            feature: safety_enums_1.SafetyFeature.SAFETY_CHECK,
+        },
+        {
+            code: safety_enums_1.SafetyIncidentTypeCode.FOLLOW_ME_SOS,
+            name: 'Follow Me SOS',
+            description: 'Raised by a Follow Me journey.',
+            feature: safety_enums_1.SafetyFeature.FOLLOW_ME,
+        },
+    ],
+};
+/** The incident type a safety feature raises its SOS as. */
+function safetyIncidentTypeCodeFor(feature) {
+    const match = exports.SAFETY_ALERTS_TAXONOMY.types.find((type) => type.feature === feature);
+    if (!match)
+        throw new Error(`No safety incident type for feature ${feature}`);
+    return match.code;
+}
+/** True for a code clarion-incident treats as a platform-managed safety type. */
+function isSafetyIncidentTypeCode(code) {
+    return !!code && Object.values(safety_enums_1.SafetyIncidentTypeCode).includes(code);
+}
+//# sourceMappingURL=safety-taxonomy.const.js.map

package/dist/cjs/modules/safety/constants/safety-taxonomy.const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety-taxonomy.const.js","sourceRoot":"","sources":["../../../../../src/modules/safety/constants/safety-taxonomy.const.ts"],"names":[],"mappings":";;;AAkDA,8DAIC;AAGD,4DAEC;AA3DD,wDAA0G;AAgB1G;;;;;;;;;;;;GAYG;AACU,QAAA,sBAAsB,GAAqC;IACpE,IAAI,EAAE,yCAA0B,CAAC,aAAa;IAC9C,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE,6DAA6D;IAC1E,KAAK,EAAE;QACH;YACI,IAAI,EAAE,qCAAsB,CAAC,gBAAgB;YAC7C,IAAI,EAAE,kBAAkB;YACxB,WAAW,EAAE,gFAAgF;YAC7F,OAAO,EAAE,4BAAa,CAAC,YAAY;SACtC;QACD;YACI,IAAI,EAAE,qCAAsB,CAAC,aAAa;YAC1C,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,gCAAgC;YAC7C,OAAO,EAAE,4BAAa,CAAC,SAAS;SACnC;KACJ;CACJ,CAAC;AAEF,4DAA4D;AAC5D,SAAgB,yBAAyB,CAAC,OAAsB;IAC5D,MAAM,KAAK,GAAG,8BAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IACpF,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;IAC9E,OAAO,KAAK,CAAC,IAAI,CAAC;AACtB,CAAC;AAED,iFAAiF;AACjF,SAAgB,wBAAwB,CAAC,IAA+B;IACpE,OAAO,CAAC,CAAC,IAAI,IAAK,MAAM,CAAC,MAAM,CAAC,qCAAsB,CAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACxF,CAAC"}