grm-shared-library 1.1.236 → 1.1.238

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

@@ -8,11 +8,13 @@ export declare enum PermissionsModule {
     INCIDENT = "Grievance",
     RESPONSE_UNIT = "Response Unit",
     TRACKING = "Tracking",
+    RESPONSE_UNIT_DISPATCH = "Response Unit Dispatch",
     BILLING = "Billing",
     NEWSFEED = "Newsfeed",
     SUPPORT = "Support",
     NOTIFICATION = "Notification",
     ALERT_INTAKE = "Alert Intake",
     SAFETY = "Safety",
-    PLACES = "Places"
+    PLACES = "Places",
+    INCIDENT_SLA = "Incident SLA"
 }

package/dist/types/modules/response-unit/dtos/response-unit/base-response-unit.dto.d.ts

@@ -1,4 +1,5 @@
 import { ResponseUnitType } from "../../enums/response-unit/response-unit-type.enum";
+import { ResponseCapability } from "../../enums/response-unit/response-capability.enum";
 import { MapLocationDto } from "../../../common";
 import { StationDto } from "./station.dto";
 export declare class BaseResponseUnitDto {
@@ -9,6 +10,12 @@ export declare class BaseResponseUnitDto {
     isActive: boolean;
     location: MapLocationDto;
     station: StationDto;
+    /**
+     * What this unit can respond to. Optional: empty means "whatever the unit's
+     * type implies" (an ambulance is MEDICAL_RESPONSE), so a unit only needs
+     * this when it differs from its type - see effectiveResponseCapabilities.
+     */
+    capabilities?: ResponseCapability[];
     controlCentreId: number;
     organizationId: number;
     createdAt?: Date;

package/dist/types/modules/response-unit/enums/response-unit/response-capability.enum.d.ts

@@ -0,0 +1,24 @@
+/**
+ * What kind of emergency a response unit can answer.
+ *
+ * Deliberately the platform's existing vocabulary and nothing more: each value
+ * is what one {@link VehicleUnitType} already says about a vehicle (Ambulance,
+ * Security, Fire, Road Rescue), named the way {@link PartnerServiceCapability}
+ * names the same services for third-party responders. A unit with no explicit
+ * capabilities gets these derived from its vehicle type (or a person unit from
+ * its category) - see `deriveResponseCapabilities` - so every existing unit is
+ * classified on day one without anybody configuring anything.
+ *
+ * Stored as plain strings (varchar[]) wherever it is persisted, so adding a
+ * value here never needs a database migration.
+ */
+export declare enum ResponseCapability {
+    /** Ambulances and medical officers. */
+    MEDICAL_RESPONSE = "MEDICAL_RESPONSE",
+    /** Security response vehicles, patrols and police officers. */
+    SECURITY_RESPONSE = "SECURITY_RESPONSE",
+    /** Fire and rescue appliances. */
+    FIRE_RESPONSE = "FIRE_RESPONSE",
+    /** Breakdown, recovery and towing. */
+    ROADSIDE_ASSISTANCE = "ROADSIDE_ASSISTANCE"
+}

package/dist/types/modules/response-unit/enums/response-unit/response-unit-availability.enum.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Can this unit be sent to an incident right now?
+ *
+ * Two sources decide it and neither is enough alone:
+ *
+ *  - clarion-organization's MANUAL statuses (`isActive`, `vehicleStatus`,
+ *    `personStatus`, `teamStatus`) - what somebody set on the unit. Read by
+ *    `resolveResponseUnitAvailability`.
+ *  - clarion-incident's ACTIVE DISPATCHES - the authoritative record of a unit
+ *    being out on a job. A unit with one is ENGAGED whatever its manual status
+ *    says, and that is enforced by a unique index, not by this enum.
+ */
+export declare enum ResponseUnitAvailability {
+    /** On duty / operational, enabled, and not out on a job. */
+    AVAILABLE = "AVAILABLE",
+    /** Out on a job: an active dispatch, or a manual Engaged / On Mission status. */
+    ENGAGED = "ENGAGED",
+    /** Enabled but not able to respond: non-operational, off duty, on leave, training. */
+    UNAVAILABLE = "UNAVAILABLE",
+    /** Switched off in the organization (`isActive = false`). */
+    INACTIVE = "INACTIVE"
+}

package/dist/types/modules/response-unit/index.d.ts

@@ -65,3 +65,7 @@ export * from './enums/vehicle-unit/vehicle-type/fire-vehicle-type.enum';
 export * from './enums/vehicle-unit/vehicle-crew/fire-vehicle-role.enum';
 export * from './enums/vehicle-unit/vehicle-type/road-rescue-vehicle-type.enum';
 export * from './enums/vehicle-unit/vehicle-crew/road-rescue-vehicle-role.enum';
+export * from './enums/response-unit/response-capability.enum';
+export * from './enums/response-unit/response-unit-availability.enum';
+export * from './utils/response-capability.util';
+export * from './utils/response-unit-availability.util';

package/dist/types/modules/response-unit/interfaces/response-unit/response-unit.d.ts

@@ -1,5 +1,6 @@
 import { MapAddressDto, MapLocation } from "../../../common";
 import { ResponseUnitType } from "../../enums/response-unit/response-unit-type.enum";
+import { ResponseCapability } from "../../enums/response-unit/response-capability.enum";
 export interface ResponseUnit {
     id: number;
     name: string;
@@ -11,6 +12,8 @@ export interface ResponseUnit {
         name: string;
         address: MapAddressDto;
     };
+    /** Configured capabilities; empty means "derived from the unit's type". */
+    capabilities?: ResponseCapability[];
     controlCentreId: number;
     organizationId: number;
     createdAt?: Date;

package/dist/types/modules/response-unit/utils/response-capability.util.d.ts

@@ -0,0 +1,31 @@
+import { ResponseCapability } from '../enums/response-unit/response-capability.enum';
+/** The most capabilities one unit or one incident type may carry. */
+export declare const MAX_RESPONSE_CAPABILITIES = 10;
+/**
+ * Keep only known capabilities, once each, in a stable order.
+ *
+ * Accepts anything because it reads values back from jsonb, varchar[] and
+ * request bodies alike; an unknown value is dropped rather than thrown, so a
+ * capability retired from the enum can never make a stored unit unreadable.
+ */
+export declare function normalizeResponseCapabilities(values: unknown): ResponseCapability[];
+/** The parts of a response unit that say what it is. */
+export interface ResponseCapabilitySource {
+    /** Configured on the unit. When non-empty it is the whole answer. */
+    capabilities?: unknown;
+    vehicleType?: string | null;
+    /** A person unit's category. */
+    category?: string | null;
+}
+/**
+ * What a unit's TYPE says it can do - ignoring anything configured on it.
+ * Empty when the type says nothing (a team, a volunteer).
+ */
+export declare function deriveResponseCapabilities(source: ResponseCapabilitySource): ResponseCapability[];
+/**
+ * The capabilities a unit is treated as having: what was configured on it when
+ * anything was, otherwise what its type implies. Configured capabilities
+ * REPLACE the derived ones rather than adding to them - an ambulance that has
+ * been re-equipped as a patient-transport-only vehicle must be able to say so.
+ */
+export declare function effectiveResponseCapabilities(source: ResponseCapabilitySource): ResponseCapability[];

package/dist/types/modules/response-unit/utils/response-unit-availability.util.d.ts

@@ -0,0 +1,21 @@
+import { ResponseUnitAvailability } from '../enums/response-unit/response-unit-availability.enum';
+/** The manual status fields of a response unit, whichever subtype it is. */
+export interface ResponseUnitStatusSource {
+    isActive?: boolean | null;
+    vehicleStatus?: string | null;
+    personStatus?: string | null;
+    teamStatus?: string | null;
+}
+/**
+ * Availability from the unit's own MANUAL status - not from dispatches, which
+ * clarion-incident layers on top (a unit with an active dispatch is ENGAGED
+ * whatever this returns).
+ *
+ * A missing status is AVAILABLE: a person unit's `personStatus` is nullable and
+ * every unit created before statuses existed has none, and refusing to dispatch
+ * a unit because nobody filled a field in would make the feature useless for
+ * the organizations that configured least.
+ */
+export declare function resolveResponseUnitAvailability(unit: ResponseUnitStatusSource): ResponseUnitAvailability;
+/** The unit's manual operational status as one string, whichever field holds it. */
+export declare function responseUnitOperationalStatus(unit: ResponseUnitStatusSource): string | null;

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

@@ -10,6 +10,9 @@ export declare enum SmsTemplateType {
     SAFETY_CHECK_GUARDIAN_ENDED = "safety_check_guardian_ended",
     FOLLOW_ME_GUARDIAN_REQUEST = "follow_me_guardian_request",
     FOLLOW_ME_GUARDIAN_ENDED = "follow_me_guardian_ended",
+    RESPONSE_UNIT_DISPATCH = "response_unit_dispatch",
+    EMERGENCY_STAFF_ALERT = "emergency_staff_alert",
+    EMERGENCY_REPORTER_UPDATE = "emergency_reporter_update",
     APPOINTMENT_REMINDER = "appointment_reminder",
     GENERAL_NOTIFICATION = "general_notification"
 }

package/package.json

@@ -1,72 +1,72 @@
-{
-  "name": "grm-shared-library",
-  "version": "1.1.236",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    },
-    "./dist/modules/*": {
-      "types": "./dist/types/modules/*.d.ts",
-      "import": "./dist/esm/modules/*.js",
-      "require": "./dist/cjs/modules/*.js"
-    }
-  },
-  "files": [
-    "dist/**/*"
-  ],
-  "scripts": {
-    "clean": "rimraf dist dist-test",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:types": "tsc -p tsconfig.types.json",
-    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:esm",
-    "prepublishOnly": "npm run build",
-    "pretest": "rimraf dist-test",
-    "test": "tsc -p tsconfig.spec.json && node --test \"dist-test/**/*.spec.js\""
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "description": "",
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/express": "^5.0.3",
-    "@types/geojson": "^7946.0.14",
-    "@types/node": "^22.10.5",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.7.3"
-  },
-  "dependencies": {
-    "@nestjs/common": "^11.0.0",
-    "@nestjs/core": "^11.0.0",
-    "@nestjs/mapped-types": "^2.0.6",
-    "@nestjs/microservices": "^11.0.0",
-    "@nestjs/swagger": "^11.2.0",
-    "@sentry/node": "^8.0.0",
-    "class-transformer": "^0.5.0",
-    "class-validator": "^0.14.0",
-    "express": "^5.1.0",
-    "geojson": "^0.5.0",
-    "grm-shared-library": "^1.1.101",
-    "libphonenumber-js": "^1.13.8",
-    "rxjs": "^7.8.2",
-    "swagger-ui-express": "^5.0.1",
-    "@nestjs/config": "^4.0.0"
-  },
-  "peerDependencies": {
-    "@nestjs/common": "^11.0.0",
-    "@nestjs/core": "^11.0.0",
-    "@nestjs/microservices": "^11.0.0",
-    "@sentry/node": "^8.0.0",
-    "class-transformer": "^0.5.0",
-    "class-validator": "^0.14.0",
-    "@nestjs/config": "^4.0.0"
-  }
-}
+{
+  "name": "grm-shared-library",
+  "version": "1.1.238",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./dist/modules/*": {
+      "types": "./dist/types/modules/*.d.ts",
+      "import": "./dist/esm/modules/*.js",
+      "require": "./dist/cjs/modules/*.js"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "clean": "rimraf dist dist-test",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:esm",
+    "prepublishOnly": "npm run build",
+    "pretest": "rimraf dist-test",
+    "test": "tsc -p tsconfig.spec.json && node --test \"dist-test/**/*.spec.js\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.3",
+    "@types/geojson": "^7946.0.14",
+    "@types/node": "^22.10.5",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/mapped-types": "^2.0.6",
+    "@nestjs/microservices": "^11.0.0",
+    "@nestjs/swagger": "^11.2.0",
+    "@sentry/node": "^8.0.0",
+    "class-transformer": "^0.5.0",
+    "class-validator": "^0.14.0",
+    "express": "^5.1.0",
+    "geojson": "^0.5.0",
+    "grm-shared-library": "^1.1.101",
+    "libphonenumber-js": "^1.13.8",
+    "rxjs": "^7.8.2",
+    "swagger-ui-express": "^5.0.1",
+    "@nestjs/config": "^4.0.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/microservices": "^11.0.0",
+    "@sentry/node": "^8.0.0",
+    "class-transformer": "^0.5.0",
+    "class-validator": "^0.14.0",
+    "@nestjs/config": "^4.0.0"
+  }
+}