grm-shared-library 1.1.197 → 1.1.198

package/dist/types/modules/partner/interfaces/partner-dispatch-progress.d.ts

@@ -0,0 +1,48 @@
+import { PartnerEngagementState } from '../enums/partner-engagement-state.enum';
+/** Whoever the partner has put on the job. */
+export interface PartnerResponderInfo {
+    name?: string | null;
+    /** E.164 where the partner gives one. */
+    phoneNumber?: string | null;
+    /** The partner's own identifier for the responder. */
+    reference?: string | null;
+}
+/** The unit the partner has assigned, described the way a control room needs it. */
+export interface PartnerResponderVehicle {
+    /** Registration, call sign, or whatever the partner uses to identify the unit. */
+    identifier?: string | null;
+    /** Human description, e.g. "White Toyota HiAce". */
+    description?: string | null;
+    /** The partner's own classification of the unit, e.g. "ADVANCED_LIFE_SUPPORT". */
+    serviceType?: string | null;
+}
+/**
+ * What a partner reports about an emergency they are already working.
+ *
+ * This is the answer to the question a control room actually asks after
+ * dispatching: "is anyone coming, who, and where are they taking them?" Every
+ * field is optional because partners differ enormously in what they publish -
+ * some return a full crew and vehicle, some return nothing but a status - and
+ * the platform must be useful with either.
+ *
+ * Provider-neutral: `partnerStatus` keeps the partner's own word verbatim so an
+ * operator sees exactly what was said, while `state` reduces it to something
+ * every screen and every report can rely on.
+ */
+export interface PartnerDispatchProgress {
+    state: PartnerEngagementState;
+    /** The partner's own status string, unmodified. */
+    partnerStatus?: string | null;
+    /** The partner's human-facing reference, if it appears or changes here. */
+    partnerNumber?: string | null;
+    responder?: PartnerResponderInfo | null;
+    vehicle?: PartnerResponderVehicle | null;
+    /** Where the responder is taking the patient, when the partner says. */
+    destination?: string | null;
+    /** The partner's own label for the journey, e.g. "PENDING", "EN_ROUTE". */
+    journeyStatus?: string | null;
+    /** When the partner last changed anything, as the partner reports it. */
+    partnerUpdatedAt?: string | null;
+    /** When this platform last read it. */
+    observedAt: string;
+}

package/dist/types/modules/partner/interfaces/partner-dispatch.d.ts

@@ -5,7 +5,9 @@ import { PartnerDispatchStatus } from '../enums/partner-dispatch-status.enum';
 import { PartnerProviderCode } from '../enums/partner-provider-code.enum';
 import { PartnerRoutingMode } from '../enums/partner-routing-mode.enum';
 import { PartnerServiceCapability } from '../enums/partner-service-capability.enum';
+import { PartnerEngagementState } from '../enums/partner-engagement-state.enum';
 import { PartnerDispatchLocation } from './partner-dispatch-location';
+import { PartnerDispatchProgress } from './partner-dispatch-progress';
 import { PartnerEmergencyContact } from './partner-emergency-contact';
 /**
  * The incident facts a dispatch was built from, frozen at routing time.
@@ -100,6 +102,26 @@ export interface PartnerDispatch {
     partnerNumber?: string | null;
     /** The partner's own status string, passed through verbatim. */
     partnerStatus?: string | null;
+    /**
+     * The partner's status reduced to something every screen can rely on.
+     * Absent for a partner that publishes no status at all.
+     */
+    engagementState?: PartnerEngagementState | null;
+    /**
+     * What the partner last reported - responder, vehicle, destination.
+     *
+     * This is the answer to "is anyone actually coming?", which is the only
+     * question a control room has once a dispatch has left the building.
+     */
+    progress?: PartnerDispatchProgress | null;
+    /** When progress was last read from the partner. */
+    lastPolledAt?: string | null;
+    /** When the partner first confirmed it was working the emergency. */
+    acknowledgedAt?: string | null;
+    /** When the partner closed the request. */
+    closedAt?: string | null;
+    withdrawnByUserId?: number | null;
+    withdrawnAt?: string | null;
     /** The sanitized body sent to the partner. Never contains a credential. */
     requestPayload?: Record<string, unknown> | null;
     /** The sanitized body the partner returned. */

package/dist/types/modules/partner/interfaces/partner-provider-descriptor.d.ts

@@ -51,6 +51,35 @@ export interface PartnerProviderDescriptor {
     credentialFields: PartnerProviderCredentialField[];
     /** True when the adapter implements a non-mutating connectivity probe. */
     supportsHealthCheck: boolean;
+    /**
+     * True when the partner publishes the state of a request we have already
+     * sent, so progress can be polled and shown to a control room.
+     */
+    supportsStatusPolling: boolean;
+    /**
+     * True when the partner lets a request be stood down after they accepted it.
+     *
+     * When false, an organization that changes its mind has to telephone the
+     * partner - and the platform says so plainly rather than offering a button
+     * that quietly does nothing.
+     */
+    supportsWithdrawal: boolean;
+    /**
+     * True when the partner lets the details of a live request be corrected.
+     *
+     * The case that matters is a caller ringing back with a better location
+     * after a responder is already moving.
+     */
+    supportsAmendment: boolean;
+    /**
+     * True when the partner can be asked whether a request we may already have
+     * sent exists.
+     *
+     * This is what makes a retry after a TIMEOUT safe. Without it, a request
+     * that landed but whose reply was lost can only be retried blind, and a
+     * blind retry on a non-idempotent emergency API means two ambulances.
+     */
+    supportsDuplicateDetection: boolean;
     /** False for reserved provider codes that have no working adapter yet. */
     available: boolean;
 }

package/package.json

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