clarion-shared-types 1.0.85 → 1.0.87

package/dist/esm/modules/partner/index.js

@@ -0,0 +1,12 @@
+// Enums
+export * from './enums/partner-enums';
+// Interfaces / DTOs
+export * from './interfaces/partner-provider.dto';
+export * from './interfaces/partner-integration.dto';
+export * from './interfaces/partner-coverage-rule.dto';
+export * from './interfaces/partner-dispatch-progress.dto';
+export * from './interfaces/partner-dispatch.dto';
+export * from './interfaces/incident-partner-routing.dto';
+// Utilities
+export * from './utils/partner-display.util';
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/partner/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/partner/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,uBAAuB,CAAC;AAEtC,oBAAoB;AACpB,cAAc,mCAAmC,CAAC;AAClD,cAAc,sCAAsC,CAAC;AACrD,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mCAAmC,CAAC;AAClD,cAAc,2CAA2C,CAAC;AAE1D,YAAY;AACZ,cAAc,8BAA8B,CAAC"}

package/dist/esm/modules/partner/interfaces/incident-partner-routing.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=incident-partner-routing.dto.js.map

package/dist/esm/modules/partner/interfaces/incident-partner-routing.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"incident-partner-routing.dto.js","sourceRoot":"","sources":["../../../../../src/modules/partner/interfaces/incident-partner-routing.dto.ts"],"names":[],"mappings":""}

package/dist/esm/modules/partner/interfaces/partner-coverage-rule.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=partner-coverage-rule.dto.js.map

package/dist/esm/modules/partner/interfaces/partner-coverage-rule.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-coverage-rule.dto.js","sourceRoot":"","sources":["../../../../../src/modules/partner/interfaces/partner-coverage-rule.dto.ts"],"names":[],"mappings":""}

package/dist/esm/modules/partner/interfaces/partner-dispatch-progress.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=partner-dispatch-progress.dto.js.map

package/dist/esm/modules/partner/interfaces/partner-dispatch-progress.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-dispatch-progress.dto.js","sourceRoot":"","sources":["../../../../../src/modules/partner/interfaces/partner-dispatch-progress.dto.ts"],"names":[],"mappings":""}

package/dist/esm/modules/partner/interfaces/partner-dispatch.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=partner-dispatch.dto.js.map

package/dist/esm/modules/partner/interfaces/partner-dispatch.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-dispatch.dto.js","sourceRoot":"","sources":["../../../../../src/modules/partner/interfaces/partner-dispatch.dto.ts"],"names":[],"mappings":""}

package/dist/esm/modules/partner/interfaces/partner-integration.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=partner-integration.dto.js.map

package/dist/esm/modules/partner/interfaces/partner-integration.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-integration.dto.js","sourceRoot":"","sources":["../../../../../src/modules/partner/interfaces/partner-integration.dto.ts"],"names":[],"mappings":""}

package/dist/esm/modules/partner/interfaces/partner-provider.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=partner-provider.dto.js.map

package/dist/esm/modules/partner/interfaces/partner-provider.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-provider.dto.js","sourceRoot":"","sources":["../../../../../src/modules/partner/interfaces/partner-provider.dto.ts"],"names":[],"mappings":""}

package/dist/esm/modules/partner/utils/partner-display.util.js

@@ -0,0 +1,134 @@
+import { IncidentPartnerRoutingStatus, PartnerEngagementState, PartnerCoverageMatchType, PartnerDispatchStatus, PartnerIntegrationStatus, PartnerRoutingMode, PartnerServiceCapability, } from '../enums/partner-enums';
+/**
+ * Human labels for the partner enums.
+ *
+ * Kept in the shared package rather than in the admin app so every screen that
+ * shows a dispatch - the list, the detail drawer, the incident view - names the
+ * same state the same way. An operator reading "Waiting for confirmation" in one
+ * place and "Pending approval" in another would reasonably assume they were
+ * different things.
+ */
+export const PARTNER_DISPATCH_STATUS_LABELS = {
+    [PartnerDispatchStatus.PENDING_APPROVAL]: 'Waiting for confirmation',
+    [PartnerDispatchStatus.QUEUED]: 'Queued',
+    [PartnerDispatchStatus.SENDING]: 'Sending',
+    [PartnerDispatchStatus.SENT]: 'Sent to partner',
+    [PartnerDispatchStatus.ACKNOWLEDGED]: 'Responder assigned',
+    [PartnerDispatchStatus.COMPLETED]: 'Closed by partner',
+    [PartnerDispatchStatus.FAILED]: 'Failed',
+    [PartnerDispatchStatus.REJECTED]: 'Declined',
+    // "Cancelled" and "Stood down" read differently on purpose: one is an
+    // emergency the partner never heard about, the other is a responder who was
+    // dispatched and recalled.
+    [PartnerDispatchStatus.CANCELLED]: 'Cancelled before sending',
+    [PartnerDispatchStatus.WITHDRAWN]: 'Stood down',
+    [PartnerDispatchStatus.EXPIRED]: 'Expired',
+};
+/** How a partner's own progress state reads on screen. */
+export const PARTNER_ENGAGEMENT_STATE_LABELS = {
+    [PartnerEngagementState.ACTIVE]: 'In progress',
+    [PartnerEngagementState.CLOSED]: 'Closed',
+    [PartnerEngagementState.UNKNOWN]: 'Unknown',
+};
+export const INCIDENT_PARTNER_ROUTING_STATUS_LABELS = {
+    [IncidentPartnerRoutingStatus.NOT_ROUTED]: 'No partner',
+    [IncidentPartnerRoutingStatus.PENDING]: 'Contacting partner',
+    [IncidentPartnerRoutingStatus.AWAITING_APPROVAL]: 'Waiting for confirmation',
+    [IncidentPartnerRoutingStatus.ROUTED]: 'Partner notified',
+    [IncidentPartnerRoutingStatus.PARTIALLY_ROUTED]: 'Partly notified',
+    [IncidentPartnerRoutingStatus.FAILED]: 'Partner not reached',
+    [IncidentPartnerRoutingStatus.DECLINED]: 'Declined',
+};
+export const PARTNER_ROUTING_MODE_LABELS = {
+    [PartnerRoutingMode.AUTO]: 'Automatic',
+    [PartnerRoutingMode.MANUAL]: 'Needs confirmation',
+    [PartnerRoutingMode.DISABLED]: 'Routing off',
+};
+export const PARTNER_INTEGRATION_STATUS_LABELS = {
+    [PartnerIntegrationStatus.UNKNOWN]: 'Not tested',
+    [PartnerIntegrationStatus.HEALTHY]: 'Healthy',
+    [PartnerIntegrationStatus.DEGRADED]: 'Degraded',
+    [PartnerIntegrationStatus.UNREACHABLE]: 'Unreachable',
+};
+export const PARTNER_CAPABILITY_LABELS = {
+    [PartnerServiceCapability.AMBULANCE]: 'Ambulance',
+    [PartnerServiceCapability.MEDICAL_EVACUATION]: 'Medical evacuation',
+    [PartnerServiceCapability.FIRE_RESPONSE]: 'Fire response',
+    [PartnerServiceCapability.SECURITY_RESPONSE]: 'Security response',
+    [PartnerServiceCapability.ROADSIDE_ASSISTANCE]: 'Roadside assistance',
+    [PartnerServiceCapability.TOWING]: 'Towing',
+    [PartnerServiceCapability.OTHER]: 'Other',
+};
+export const PARTNER_COVERAGE_MATCH_TYPE_LABELS = {
+    [PartnerCoverageMatchType.ALL]: 'Every incident',
+    [PartnerCoverageMatchType.INCIDENT_TYPE]: 'Incident type',
+    [PartnerCoverageMatchType.INCIDENT_CATEGORY]: 'Incident category',
+    [PartnerCoverageMatchType.EMERGENCY_TYPE]: 'Emergency classification',
+};
+/**
+ * Chip family for a dispatch status, matching the admin's existing chip
+ * vocabulary: `success` for anything the partner has, `warn` for anything still
+ * needing a human, `danger` for a failure, `neutral` for a settled non-event.
+ */
+export function partnerDispatchStatusTone(status) {
+    switch (status) {
+        case PartnerDispatchStatus.SENT:
+        case PartnerDispatchStatus.ACKNOWLEDGED:
+        case PartnerDispatchStatus.COMPLETED:
+            return 'success';
+        case PartnerDispatchStatus.PENDING_APPROVAL:
+        case PartnerDispatchStatus.QUEUED:
+        case PartnerDispatchStatus.SENDING:
+            return 'warn';
+        case PartnerDispatchStatus.FAILED:
+        case PartnerDispatchStatus.EXPIRED:
+            return 'danger';
+        default:
+            return 'neutral';
+    }
+}
+/** The same tone mapping for the incident-level rolled-up status. */
+export function incidentPartnerRoutingTone(status) {
+    switch (status) {
+        case IncidentPartnerRoutingStatus.ROUTED:
+            return 'success';
+        case IncidentPartnerRoutingStatus.PENDING:
+        case IncidentPartnerRoutingStatus.AWAITING_APPROVAL:
+        case IncidentPartnerRoutingStatus.PARTIALLY_ROUTED:
+            return 'warn';
+        case IncidentPartnerRoutingStatus.FAILED:
+            return 'danger';
+        default:
+            return 'neutral';
+    }
+}
+/**
+ * Whether an operator can act on a dispatch, so a table can enable or hide its
+ * buttons without duplicating the backend's transition rules.
+ *
+ * The two withdrawals are separate answers: `canCancel` is a local decision
+ * before the partner has it, `canStandDown` means telling THEM - which is only
+ * possible for a partner whose API supports it.
+ */
+export function partnerDispatchActions(status, capabilities = {}) {
+    const pending = status === PartnerDispatchStatus.PENDING_APPROVAL;
+    const withPartner = status === PartnerDispatchStatus.SENT ||
+        status === PartnerDispatchStatus.ACKNOWLEDGED;
+    return {
+        canApprove: pending,
+        canReject: pending,
+        /** Local withdrawal, before the partner ever heard about it. */
+        canCancel: pending || status === PartnerDispatchStatus.QUEUED,
+        /**
+         * Standing a partner down is only offered where the partner's API can
+         * actually do it. Everywhere else the screen should say "contact them
+         * directly" rather than show a button that changes a status here while
+         * an ambulance keeps driving.
+         */
+        canStandDown: withPartner && !!capabilities.supportsWithdrawal,
+        canAmend: withPartner && !!capabilities.supportsAmendment,
+        canResend: status === PartnerDispatchStatus.FAILED ||
+            status === PartnerDispatchStatus.EXPIRED,
+    };
+}
+//# sourceMappingURL=partner-display.util.js.map

package/dist/esm/modules/partner/utils/partner-display.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-display.util.js","sourceRoot":"","sources":["../../../../../src/modules/partner/utils/partner-display.util.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,wBAAwB,CAAC;AAEhC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAoD;IAC3F,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,0BAA0B;IACpE,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,QAAQ;IACxC,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,SAAS;IAC1C,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,iBAAiB;IAC/C,CAAC,qBAAqB,CAAC,YAAY,CAAC,EAAE,oBAAoB;IAC1D,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAAE,mBAAmB;IACtD,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,QAAQ;IACxC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,UAAU;IAC5C,sEAAsE;IACtE,4EAA4E;IAC5E,2BAA2B;IAC3B,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAAE,0BAA0B;IAC7D,CAAC,qBAAqB,CAAC,SAAS,CAAC,EAAE,YAAY;IAC/C,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,SAAS;CAC7C,CAAC;AAEF,0DAA0D;AAC1D,MAAM,CAAC,MAAM,+BAA+B,GAExC;IACA,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,aAAa;IAC9C,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,QAAQ;IACzC,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,SAAS;CAC9C,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAE/C;IACA,CAAC,4BAA4B,CAAC,UAAU,CAAC,EAAE,YAAY;IACvD,CAAC,4BAA4B,CAAC,OAAO,CAAC,EAAE,oBAAoB;IAC5D,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,EAAE,0BAA0B;IAC5E,CAAC,4BAA4B,CAAC,MAAM,CAAC,EAAE,kBAAkB;IACzD,CAAC,4BAA4B,CAAC,gBAAgB,CAAC,EAAE,iBAAiB;IAClE,CAAC,4BAA4B,CAAC,MAAM,CAAC,EAAE,qBAAqB;IAC5D,CAAC,4BAA4B,CAAC,QAAQ,CAAC,EAAE,UAAU;CACtD,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAiD;IACrF,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,WAAW;IACtC,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,oBAAoB;IACjD,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,aAAa;CAC/C,CAAC;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAE1C;IACA,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,YAAY;IAChD,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,SAAS;IAC7C,CAAC,wBAAwB,CAAC,QAAQ,CAAC,EAAE,UAAU;IAC/C,CAAC,wBAAwB,CAAC,WAAW,CAAC,EAAE,aAAa;CACxD,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAuD;IACzF,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE,WAAW;IACjD,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,EAAE,oBAAoB;IACnE,CAAC,wBAAwB,CAAC,aAAa,CAAC,EAAE,eAAe;IACzD,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,EAAE,mBAAmB;IACjE,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,EAAE,qBAAqB;IACrE,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,QAAQ;IAC3C,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,OAAO;CAC5C,CAAC;AAEF,MAAM,CAAC,MAAM,kCAAkC,GAE3C;IACA,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,gBAAgB;IAChD,CAAC,wBAAwB,CAAC,aAAa,CAAC,EAAE,eAAe;IACzD,CAAC,wBAAwB,CAAC,iBAAiB,CAAC,EAAE,mBAAmB;IACjE,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE,0BAA0B;CACxE,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACrC,MAA6B;IAE7B,QAAQ,MAAM,EAAE,CAAC;QACb,KAAK,qBAAqB,CAAC,IAAI,CAAC;QAChC,KAAK,qBAAqB,CAAC,YAAY,CAAC;QACxC,KAAK,qBAAqB,CAAC,SAAS;YAChC,OAAO,SAAS,CAAC;QACrB,KAAK,qBAAqB,CAAC,gBAAgB,CAAC;QAC5C,KAAK,qBAAqB,CAAC,MAAM,CAAC;QAClC,KAAK,qBAAqB,CAAC,OAAO;YAC9B,OAAO,MAAM,CAAC;QAClB,KAAK,qBAAqB,CAAC,MAAM,CAAC;QAClC,KAAK,qBAAqB,CAAC,OAAO;YAC9B,OAAO,QAAQ,CAAC;QACpB;YACI,OAAO,SAAS,CAAC;IACzB,CAAC;AACL,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,0BAA0B,CACtC,MAAoC;IAEpC,QAAQ,MAAM,EAAE,CAAC;QACb,KAAK,4BAA4B,CAAC,MAAM;YACpC,OAAO,SAAS,CAAC;QACrB,KAAK,4BAA4B,CAAC,OAAO,CAAC;QAC1C,KAAK,4BAA4B,CAAC,iBAAiB,CAAC;QACpD,KAAK,4BAA4B,CAAC,gBAAgB;YAC9C,OAAO,MAAM,CAAC;QAClB,KAAK,4BAA4B,CAAC,MAAM;YACpC,OAAO,QAAQ,CAAC;QACpB;YACI,OAAO,SAAS,CAAC;IACzB,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAClC,MAA6B,EAC7B,eAA0C,EAAE;IAS5C,MAAM,OAAO,GAAG,MAAM,KAAK,qBAAqB,CAAC,gBAAgB,CAAC;IAClE,MAAM,WAAW,GACb,MAAM,KAAK,qBAAqB,CAAC,IAAI;QACrC,MAAM,KAAK,qBAAqB,CAAC,YAAY,CAAC;IAElD,OAAO;QACH,UAAU,EAAE,OAAO;QACnB,SAAS,EAAE,OAAO;QAClB,gEAAgE;QAChE,SAAS,EAAE,OAAO,IAAI,MAAM,KAAK,qBAAqB,CAAC,MAAM;QAC7D;;;;;WAKG;QACH,YAAY,EAAE,WAAW,IAAI,CAAC,CAAC,YAAY,CAAC,kBAAkB;QAC9D,QAAQ,EAAE,WAAW,IAAI,CAAC,CAAC,YAAY,CAAC,iBAAiB;QACzD,SAAS,EACL,MAAM,KAAK,qBAAqB,CAAC,MAAM;YACvC,MAAM,KAAK,qBAAqB,CAAC,OAAO;KAC/C,CAAC;AACN,CAAC"}

package/dist/types/index.d.ts

@@ -19,5 +19,6 @@ export * from './modules/country/index';
 export * from './modules/tracking/index';
 export * from './modules/entitlement/index';
 export * from './modules/alert-dispatch/index';
+export * from './modules/partner/index';
 export * from './modules/common/interfaces/server-message';
 export * from './modules/common/interfaces/pagination';

package/dist/types/modules/partner/enums/partner-enums.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Frontend mirrors of the partner enums in grm-shared-library.
+ *
+ * Kept in ONE file rather than one per enum: the admin's partner screens import
+ * most of them together, and the set only means anything as a whole. The values
+ * are byte-identical to the backend's, because they travel over the wire as
+ * strings and any drift would show up as a silently unstyled chip rather than a
+ * compile error.
+ */
+/** The third-party partner behind a partnership. */
+export declare enum PartnerProviderCode {
+    RESCUE_CO = "RESCUE_CO",
+    AAR = "AAR",
+    ST_JOHN = "ST_JOHN",
+    GENERIC_REST = "GENERIC_REST"
+}
+/** A class of emergency service a partner can be asked to provide. */
+export declare enum PartnerServiceCapability {
+    AMBULANCE = "AMBULANCE",
+    MEDICAL_EVACUATION = "MEDICAL_EVACUATION",
+    FIRE_RESPONSE = "FIRE_RESPONSE",
+    SECURITY_RESPONSE = "SECURITY_RESPONSE",
+    ROADSIDE_ASSISTANCE = "ROADSIDE_ASSISTANCE",
+    TOWING = "TOWING",
+    OTHER = "OTHER"
+}
+/** How an incident a partnership covers reaches the partner. */
+export declare enum PartnerRoutingMode {
+    /** Sent as soon as the incident is created. */
+    AUTO = "AUTO",
+    /** Held until an operator confirms it. */
+    MANUAL = "MANUAL",
+    /** Configuration kept, nothing routed. */
+    DISABLED = "DISABLED"
+}
+/** Which of a partner's environments a partnership points at. */
+export declare enum PartnerIntegrationEnvironment {
+    SANDBOX = "SANDBOX",
+    PRODUCTION = "PRODUCTION"
+}
+/** Last known health of a partnership's connection. Advisory only. */
+export declare enum PartnerIntegrationStatus {
+    UNKNOWN = "UNKNOWN",
+    HEALTHY = "HEALTHY",
+    DEGRADED = "DEGRADED",
+    UNREACHABLE = "UNREACHABLE"
+}
+/** What a coverage rule matches an incident on. */
+export declare enum PartnerCoverageMatchType {
+    ALL = "ALL",
+    INCIDENT_TYPE = "INCIDENT_TYPE",
+    INCIDENT_CATEGORY = "INCIDENT_CATEGORY",
+    EMERGENCY_TYPE = "EMERGENCY_TYPE"
+}
+/**
+ * Lifecycle of one incident's routing to one partner.
+ *
+ * Once the partner has it, the remaining transitions come from THEM: SENT ->
+ * ACKNOWLEDGED when they assign a responder, and either of those -> COMPLETED
+ * when they close it. WITHDRAWN is the exception - an organization standing a
+ * partner down after the fact.
+ */
+export declare enum PartnerDispatchStatus {
+    PENDING_APPROVAL = "PENDING_APPROVAL",
+    QUEUED = "QUEUED",
+    SENDING = "SENDING",
+    SENT = "SENT",
+    /** The partner has assigned a responder, or otherwise confirmed it is working it. */
+    ACKNOWLEDGED = "ACKNOWLEDGED",
+    /** The partner has closed the request. The engagement is over. */
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    REJECTED = "REJECTED",
+    /** Withdrawn BEFORE the partner ever received it. */
+    CANCELLED = "CANCELLED",
+    /**
+     * Stood down AFTER the partner received it.
+     *
+     * Distinct from CANCELLED because they are very different facts: one is an
+     * emergency a partner never heard about, the other is a responder who was
+     * dispatched and recalled.
+     */
+    WITHDRAWN = "WITHDRAWN",
+    EXPIRED = "EXPIRED"
+}
+/**
+ * What a partner says is happening with an emergency, reduced to the only three
+ * answers every partner can give.
+ *
+ * Partners describe progress in their own vocabulary and no screen should learn
+ * any of them; the raw word is kept alongside in `partnerStatus`.
+ */
+export declare enum PartnerEngagementState {
+    /** The partner is working the emergency. */
+    ACTIVE = "ACTIVE",
+    /** The partner has closed it. */
+    CLOSED = "CLOSED",
+    /** The partner reported something the adapter does not recognise. */
+    UNKNOWN = "UNKNOWN"
+}
+/** Why a dispatch did not reach its partner. */
+export declare enum PartnerDispatchFailureReason {
+    INVALID_PAYLOAD = "INVALID_PAYLOAD",
+    MISSING_REQUIRED_FIELD = "MISSING_REQUIRED_FIELD",
+    AUTHENTICATION_FAILED = "AUTHENTICATION_FAILED",
+    FEATURE_NOT_ENABLED = "FEATURE_NOT_ENABLED",
+    PROVIDER_REJECTED = "PROVIDER_REJECTED",
+    ADAPTER_NOT_SUPPORTED = "ADAPTER_NOT_SUPPORTED",
+    INTEGRATION_DISABLED = "INTEGRATION_DISABLED",
+    CREDENTIAL_UNAVAILABLE = "CREDENTIAL_UNAVAILABLE",
+    RATE_LIMITED = "RATE_LIMITED",
+    PROVIDER_UNAVAILABLE = "PROVIDER_UNAVAILABLE",
+    TIMEOUT = "TIMEOUT",
+    MAX_ATTEMPTS_EXCEEDED = "MAX_ATTEMPTS_EXCEEDED",
+    UNKNOWN = "UNKNOWN"
+}
+/** How the location attached to a dispatch was obtained. */
+export declare enum PartnerLocationProvider {
+    GPS = "GPS",
+    NETWORK = "NETWORK",
+    FUSED = "FUSED"
+}
+/** The outbound partner call an attempt record describes. */
+export declare enum PartnerAdapterOperation {
+    AUTHENTICATE = "AUTHENTICATE",
+    HEALTH_CHECK = "HEALTH_CHECK",
+    DISPATCH = "DISPATCH",
+    /** Asking the partner what has happened since. */
+    FETCH_STATUS = "FETCH_STATUS",
+    /** Standing the partner down after they had already accepted it. */
+    WITHDRAW = "WITHDRAW",
+    /** Correcting details of an emergency the partner is already working. */
+    AMEND = "AMEND",
+    /** Checking whether a request we may already have sent exists. */
+    LOOKUP = "LOOKUP"
+}
+/** The incident-side summary of third-party routing, stored on the incident row. */
+export declare enum IncidentPartnerRoutingStatus {
+    NOT_ROUTED = "NOT_ROUTED",
+    PENDING = "PENDING",
+    AWAITING_APPROVAL = "AWAITING_APPROVAL",
+    ROUTED = "ROUTED",
+    PARTIALLY_ROUTED = "PARTIALLY_ROUTED",
+    FAILED = "FAILED",
+    DECLINED = "DECLINED"
+}
+/** List filter for the admin's partner-routing incident views. */
+export declare enum PartnerDispatchScope {
+    ALL = "ALL",
+    ROUTED = "ROUTED",
+    AWAITING_APPROVAL = "AWAITING_APPROVAL",
+    FAILED = "FAILED",
+    NOT_ROUTED = "NOT_ROUTED"
+}

package/dist/types/modules/partner/index.d.ts

@@ -0,0 +1,8 @@
+export * from './enums/partner-enums';
+export * from './interfaces/partner-provider.dto';
+export * from './interfaces/partner-integration.dto';
+export * from './interfaces/partner-coverage-rule.dto';
+export * from './interfaces/partner-dispatch-progress.dto';
+export * from './interfaces/partner-dispatch.dto';
+export * from './interfaces/incident-partner-routing.dto';
+export * from './utils/partner-display.util';

package/dist/types/modules/partner/interfaces/incident-partner-routing.dto.d.ts

@@ -0,0 +1,41 @@
+import { IncidentPartnerRoutingStatus, PartnerEngagementState, PartnerDispatchStatus, PartnerProviderCode, PartnerRoutingMode, PartnerServiceCapability } from '../enums/partner-enums';
+import { PartnerResponderDto, PartnerResponderVehicleDto } from './partner-dispatch-progress.dto';
+/** One partner's leg of an incident's routing, as stored on the incident. */
+export interface IncidentPartnerRoutingEntryDto {
+    integrationId: number;
+    providerCode: PartnerProviderCode;
+    providerName?: string | null;
+    capability: PartnerServiceCapability;
+    routingMode: PartnerRoutingMode;
+    dispatchId: number;
+    dispatchReference: string;
+    status: PartnerDispatchStatus;
+    partnerReference?: string | null;
+    /**
+     * What the partner last reported, carried on the incident itself.
+     *
+     * "An ambulance is on its way, registration KAA 123B, crew reachable on
+     * +254..." is the single most useful sentence on an incident screen, and it
+     * renders from here without a second request to another service.
+     */
+    engagementState?: PartnerEngagementState | null;
+    responder?: PartnerResponderDto | null;
+    vehicle?: PartnerResponderVehicleDto | null;
+    updatedAt: string;
+}
+/**
+ * The third-party routing summary carried on an incident.
+ *
+ * A read model owned by clarion-partner-services, so the incident list and
+ * detail can answer "was an ambulance called for this?" without a second
+ * request. The dispatches themselves live behind
+ * `GET /partner-services/dispatches/incidents/:incidentId`.
+ */
+export interface IncidentPartnerRoutingSnapshotDto {
+    status: IncidentPartnerRoutingStatus;
+    evaluatedAt: string;
+    consideredIntegrationCount: number;
+    entries: IncidentPartnerRoutingEntryDto[];
+    /** True when produced without a live answer from clarion-partner-services. */
+    degraded?: boolean;
+}

package/dist/types/modules/partner/interfaces/partner-coverage-rule.dto.d.ts

@@ -0,0 +1,42 @@
+import { IncidentEmergencyType } from '../../incident/enums/incident-emergency-type.enum';
+import { PartnerCoverageMatchType, PartnerRoutingMode, PartnerServiceCapability } from '../enums/partner-enums';
+/**
+ * One "this kind of incident goes to this partner" statement.
+ *
+ * The match key must agree with `matchType`: INCIDENT_TYPE needs
+ * `incidentTypeId`, INCIDENT_CATEGORY needs `incidentCategoryId`,
+ * EMERGENCY_TYPE needs `emergencyType`, ALL needs none. The backend enforces
+ * that and blanks the other two, so a form that switches match type must clear
+ * the previous key rather than leaving it in the payload.
+ */
+export interface PartnerCoverageRuleDto {
+    id: number;
+    integrationId: number;
+    organizationId: number;
+    matchType: PartnerCoverageMatchType;
+    incidentTypeId: number | null;
+    incidentCategoryId: number | null;
+    emergencyType: IncidentEmergencyType | null;
+    capability: PartnerServiceCapability;
+    routingModeOverride: PartnerRoutingMode | null;
+    priority: number;
+    enabled: boolean;
+    notes: string | null;
+    createdBy: number | null;
+    updatedBy: number | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreatePartnerCoverageRuleDto {
+    matchType: PartnerCoverageMatchType;
+    incidentTypeId?: number;
+    incidentCategoryId?: number;
+    emergencyType?: IncidentEmergencyType;
+    /** Must be a capability the partnership declares. */
+    capability: PartnerServiceCapability;
+    routingModeOverride?: PartnerRoutingMode;
+    priority?: number;
+    enabled?: boolean;
+    notes?: string;
+}
+export type UpdatePartnerCoverageRuleDto = Partial<CreatePartnerCoverageRuleDto>;

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

@@ -0,0 +1,49 @@
+import { PartnerEngagementState } from '../enums/partner-enums';
+/** Whoever the partner has put on the job. */
+export interface PartnerResponderDto {
+    name?: string | null;
+    phoneNumber?: string | null;
+    reference?: string | null;
+}
+/** The unit the partner has assigned, described the way a control room needs it. */
+export interface PartnerResponderVehicleDto {
+    /** Registration or call sign. */
+    identifier?: string | null;
+    /** Human description, e.g. "White Toyota HiAce". */
+    description?: string | null;
+    /** The partner's own classification of the unit. */
+    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?" - and
+ * every field is optional because partners differ enormously in what they
+ * publish. A screen built on this must be useful with nothing but a status.
+ */
+export interface PartnerDispatchProgressDto {
+    state: PartnerEngagementState;
+    /** The partner's own status string, unmodified. Show it verbatim. */
+    partnerStatus?: string | null;
+    partnerNumber?: string | null;
+    responder?: PartnerResponderDto | null;
+    vehicle?: PartnerResponderVehicleDto | null;
+    destination?: string | null;
+    journeyStatus?: string | null;
+    partnerUpdatedAt?: string | null;
+    /** When the platform last read it. */
+    observedAt: string;
+}
+/** Correct the details of an emergency a partner is already working. */
+export interface AmendPartnerDispatchDto {
+    address?: string;
+    issue?: string;
+    location?: {
+        latitude: number;
+        longitude: number;
+        measuredAt?: string;
+    };
+    /** Why the details were corrected. Recorded in the audit trail. */
+    reason?: string;
+}

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

@@ -0,0 +1,144 @@
+import { CountryCode } from '../../country/enums/country-code.enum';
+import { PartnerAdapterOperation, PartnerEngagementState, PartnerDispatchFailureReason, PartnerDispatchStatus, PartnerLocationProvider, PartnerProviderCode, PartnerRoutingMode, PartnerServiceCapability } from '../enums/partner-enums';
+import { PartnerDispatchProgressDto } from './partner-dispatch-progress.dto';
+/** Where the emergency is, as sent to the partner. */
+export interface PartnerDispatchLocationDto {
+    latitude: number;
+    longitude: number;
+    measuredAt: string;
+    provider: PartnerLocationProvider;
+    address?: string | null;
+}
+/** Who the partner should call about the person in trouble. */
+export interface PartnerEmergencyContactDto {
+    emergencyContactName: string;
+    /** E.164 numbers, primary guardian first. */
+    phoneNumbers: string[];
+    relationship?: string;
+}
+/** The incident facts a dispatch was built from, frozen at routing time. */
+export interface PartnerDispatchIncidentSnapshotDto {
+    incidentId: number;
+    organizationId: number;
+    controlCentreId?: number | null;
+    incidentTypeId?: number | null;
+    incidentTypeName?: string | null;
+    incidentCategoryId?: number | null;
+    incidentCategoryName?: string | null;
+    emergencyType?: string | null;
+    incidentClass?: string | null;
+    channel?: string | null;
+    priority?: string | null;
+    description?: string | null;
+    createdAt: string;
+    reporterName?: string | null;
+    reporterPhoneNumber?: string | null;
+    reporterUserId?: number | null;
+    location?: PartnerDispatchLocationDto | null;
+    address?: string | null;
+}
+/** One outbound call made on a dispatch's behalf, success or failure. */
+export interface PartnerDispatchAttemptDto {
+    id: number;
+    dispatchId: number;
+    attemptNumber: number;
+    operation: PartnerAdapterOperation;
+    /** Query string already masked by the backend. */
+    requestUrl: string;
+    httpStatus: number | null;
+    success: boolean;
+    failureReason: PartnerDispatchFailureReason | null;
+    errorCode: string | null;
+    errorMessage: string | null;
+    durationMs: number;
+    responseSnapshot: Record<string, unknown> | null;
+    createdAt: string;
+}
+/**
+ * One incident's routing to one partnership.
+ *
+ * `requestPayload` and `responsePayload` are sanitized by the backend before
+ * they are stored, so they are safe to render verbatim in a support view.
+ */
+export interface PartnerDispatchDto {
+    id: number;
+    /** Stable reference, safe to quote to the partner or in a support ticket. */
+    dispatchReference: string;
+    organizationId: number;
+    controlCentreId: number | null;
+    integrationId: number;
+    providerCode: PartnerProviderCode;
+    capability: PartnerServiceCapability;
+    coverageRuleId: number | null;
+    incidentId: number;
+    incidentTypeId: number | null;
+    incidentCategoryId: number | null;
+    routingMode: PartnerRoutingMode;
+    status: PartnerDispatchStatus;
+    countryCode: CountryCode;
+    attemptCount: number;
+    maxAttempts: number;
+    nextAttemptAt: string | null;
+    approvalExpiresAt: string | null;
+    approvedByUserId: number | null;
+    approvedAt: string | null;
+    rejectedByUserId: number | null;
+    rejectedAt: string | null;
+    cancelledByUserId: number | null;
+    cancelledAt: string | null;
+    decisionReason: string | null;
+    /** The partner's own identifier, e.g. a Rescue.co SOS request id. */
+    partnerReference: string | null;
+    partnerNumber: string | null;
+    /** The partner's own status string. Show it verbatim next to the mapped state. */
+    partnerStatus: string | null;
+    /** The partner's status reduced to something every screen can rely on. */
+    engagementState: PartnerEngagementState | null;
+    /**
+     * What the partner last reported - responder, vehicle, destination.
+     *
+     * The answer to "is anyone actually coming?", which is the only question a
+     * control room has once a dispatch has left the building.
+     */
+    progress: PartnerDispatchProgressDto | null;
+    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;
+    requestPayload: Record<string, unknown> | null;
+    responsePayload: Record<string, unknown> | null;
+    failureReason: PartnerDispatchFailureReason | null;
+    lastErrorCode: string | null;
+    lastErrorMessage: string | null;
+    incidentSnapshot: PartnerDispatchIncidentSnapshotDto;
+    emergencyContact: PartnerEmergencyContactDto | null;
+    sentAt: string | null;
+    completedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    /** Present on the detail endpoint. */
+    attempts?: PartnerDispatchAttemptDto[];
+}
+/** Body for approve / reject / cancel. The acting user comes from the session. */
+export interface PartnerDispatchDecisionDto {
+    reason?: string;
+}
+/** List filters for the dispatches table. */
+export interface PartnerDispatchQueryParams {
+    page?: number;
+    limit?: number;
+    sortBy?: string;
+    sortOrder?: 'ASC' | 'DESC';
+    /** Super-Admin only. */
+    organizationId?: number;
+    incidentId?: number;
+    integrationId?: number;
+    status?: PartnerDispatchStatus;
+    providerCode?: PartnerProviderCode;
+    capability?: PartnerServiceCapability;
+    routingMode?: PartnerRoutingMode;
+    countryCode?: CountryCode;
+}