clarion-shared-types 1.0.99 → 1.0.100

package/dist/cjs/modules/alert-intake/enums/alert-intake.enum.js

@@ -7,7 +7,7 @@
  * app is sent to.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlertIntakeRejectionReason = exports.AlertIntakeWebhookVerification = exports.AlertIntakeRouteMatch = exports.AlertIntakeEmergencyPolicy = exports.AlertIntakeSecretSource = exports.AlertIntakeProvider = exports.AlertIntakeChannel = void 0;
+exports.AlertIntakeMessageState = exports.AlertIntakeRejectionReason = exports.AlertIntakeWebhookVerification = exports.AlertIntakeRouteMatch = exports.AlertIntakeEmergencyPolicy = exports.AlertIntakeSecretSource = exports.AlertIntakeProvider = exports.AlertIntakeChannel = void 0;
 /** The channel a message arrived on. */
 var AlertIntakeChannel;
 (function (AlertIntakeChannel) {
@@ -94,4 +94,23 @@ var AlertIntakeRejectionReason;
     AlertIntakeRejectionReason["ORGANIZATION_INACTIVE"] = "ORGANIZATION_INACTIVE";
     AlertIntakeRejectionReason["RATE_LIMITED"] = "RATE_LIMITED";
 })(AlertIntakeRejectionReason || (exports.AlertIntakeRejectionReason = AlertIntakeRejectionReason = {}));
+/**
+ * Where a stored message stands, as an operator reads it. Derived from the pipeline's
+ * processing status, retry schedule and rejection reason - not stored.
+ *
+ *   QUEUED     waiting for, or being worked on by, the pipeline
+ *   RAISED     became an incident
+ *   RETRYING   failed; another attempt is scheduled
+ *   PARKED     failed and will not be retried on its own: it ran out of attempts, or it
+ *              has a `rejectionReason` (no organization, organization inactive)
+ *   DUPLICATE  the same sender repeating themselves; not raised
+ */
+var AlertIntakeMessageState;
+(function (AlertIntakeMessageState) {
+    AlertIntakeMessageState["QUEUED"] = "QUEUED";
+    AlertIntakeMessageState["RAISED"] = "RAISED";
+    AlertIntakeMessageState["RETRYING"] = "RETRYING";
+    AlertIntakeMessageState["PARKED"] = "PARKED";
+    AlertIntakeMessageState["DUPLICATE"] = "DUPLICATE";
+})(AlertIntakeMessageState || (exports.AlertIntakeMessageState = AlertIntakeMessageState = {}));
 //# sourceMappingURL=alert-intake.enum.js.map

package/dist/cjs/modules/alert-intake/enums/alert-intake.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"alert-intake.enum.js","sourceRoot":"","sources":["../../../../../src/modules/alert-intake/enums/alert-intake.enum.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,wCAAwC;AACxC,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,iCAAW,CAAA;IACX,2CAAqB,CAAA;IACrB,qCAAe,CAAA;AACnB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED;;;;;;;;GAQG;AACH,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC3B,MAAM;IACN,wDAAiC,CAAA;IACjC,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,uFAAuF;IACvF,kDAA2B,CAAA;IAC3B,WAAW;IACX,wDAAiC,CAAA;IACjC,QAAQ;IACR,oCAAa,CAAA;IACb,iGAAiG;IACjG,sDAA+B,CAAA;AACnC,CAAC,EAbW,mBAAmB,mCAAnB,mBAAmB,QAa9B;AAED;;;;;;;;;;GAUG;AACH,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,kDAAuB,CAAA;IACvB,gEAAqC,CAAA;AACzC,CAAC,EAHW,uBAAuB,uCAAvB,uBAAuB,QAGlC;AAED;;;;GAIG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IAClC,2CAAa,CAAA;IACb,mEAAqC,CAAA;IACrC,2EAA6C,CAAA;AACjD,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAED,qEAAqE;AACrE,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,oFAAoF;IACpF,4CAAmB,CAAA;IACnB,qEAAqE;IACrE,4CAAmB,CAAA;AACvB,CAAC,EALW,qBAAqB,qCAArB,qBAAqB,QAKhC;AAED,gEAAgE;AAChE,IAAY,8BAOX;AAPD,WAAY,8BAA8B;IACtC,8EAA8E;IAC9E,2DAAyB,CAAA;IACzB,gFAAgF;IAChF,+EAA6C,CAAA;IAC7C,mFAAmF;IACnF,mEAAiC,CAAA;AACrC,CAAC,EAPW,8BAA8B,8CAA9B,8BAA8B,QAOzC;AAED,yFAAyF;AACzF,IAAY,0BAOX;AAPD,WAAY,0BAA0B;IAClC,uEAAyC,CAAA;IACzC,yEAA2C,CAAA;IAC3C,yEAA2C,CAAA;IAC3C,iEAAmC,CAAA;IACnC,6EAA+C,CAAA;IAC/C,2DAA6B,CAAA;AACjC,CAAC,EAPW,0BAA0B,0CAA1B,0BAA0B,QAOrC"}
+{"version":3,"file":"alert-intake.enum.js","sourceRoot":"","sources":["../../../../../src/modules/alert-intake/enums/alert-intake.enum.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,wCAAwC;AACxC,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,iCAAW,CAAA;IACX,2CAAqB,CAAA;IACrB,qCAAe,CAAA;AACnB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED;;;;;;;;GAQG;AACH,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC3B,MAAM;IACN,wDAAiC,CAAA;IACjC,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,uFAAuF;IACvF,kDAA2B,CAAA;IAC3B,WAAW;IACX,wDAAiC,CAAA;IACjC,QAAQ;IACR,oCAAa,CAAA;IACb,iGAAiG;IACjG,sDAA+B,CAAA;AACnC,CAAC,EAbW,mBAAmB,mCAAnB,mBAAmB,QAa9B;AAED;;;;;;;;;;GAUG;AACH,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,kDAAuB,CAAA;IACvB,gEAAqC,CAAA;AACzC,CAAC,EAHW,uBAAuB,uCAAvB,uBAAuB,QAGlC;AAED;;;;GAIG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IAClC,2CAAa,CAAA;IACb,mEAAqC,CAAA;IACrC,2EAA6C,CAAA;AACjD,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAED,qEAAqE;AACrE,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,oFAAoF;IACpF,4CAAmB,CAAA;IACnB,qEAAqE;IACrE,4CAAmB,CAAA;AACvB,CAAC,EALW,qBAAqB,qCAArB,qBAAqB,QAKhC;AAED,gEAAgE;AAChE,IAAY,8BAOX;AAPD,WAAY,8BAA8B;IACtC,8EAA8E;IAC9E,2DAAyB,CAAA;IACzB,gFAAgF;IAChF,+EAA6C,CAAA;IAC7C,mFAAmF;IACnF,mEAAiC,CAAA;AACrC,CAAC,EAPW,8BAA8B,8CAA9B,8BAA8B,QAOzC;AAED,yFAAyF;AACzF,IAAY,0BAOX;AAPD,WAAY,0BAA0B;IAClC,uEAAyC,CAAA;IACzC,yEAA2C,CAAA;IAC3C,yEAA2C,CAAA;IAC3C,iEAAmC,CAAA;IACnC,6EAA+C,CAAA;IAC/C,2DAA6B,CAAA;AACjC,CAAC,EAPW,0BAA0B,0CAA1B,0BAA0B,QAOrC;AAED;;;;;;;;;;GAUG;AACH,IAAY,uBAMX;AAND,WAAY,uBAAuB;IAC/B,4CAAiB,CAAA;IACjB,4CAAiB,CAAA;IACjB,gDAAqB,CAAA;IACrB,4CAAiB,CAAA;IACjB,kDAAuB,CAAA;AAC3B,CAAC,EANW,uBAAuB,uCAAvB,uBAAuB,QAMlC"}

package/dist/esm/modules/alert-intake/enums/alert-intake.enum.js

@@ -91,4 +91,23 @@ export var AlertIntakeRejectionReason;
     AlertIntakeRejectionReason["ORGANIZATION_INACTIVE"] = "ORGANIZATION_INACTIVE";
     AlertIntakeRejectionReason["RATE_LIMITED"] = "RATE_LIMITED";
 })(AlertIntakeRejectionReason || (AlertIntakeRejectionReason = {}));
+/**
+ * Where a stored message stands, as an operator reads it. Derived from the pipeline's
+ * processing status, retry schedule and rejection reason - not stored.
+ *
+ *   QUEUED     waiting for, or being worked on by, the pipeline
+ *   RAISED     became an incident
+ *   RETRYING   failed; another attempt is scheduled
+ *   PARKED     failed and will not be retried on its own: it ran out of attempts, or it
+ *              has a `rejectionReason` (no organization, organization inactive)
+ *   DUPLICATE  the same sender repeating themselves; not raised
+ */
+export var AlertIntakeMessageState;
+(function (AlertIntakeMessageState) {
+    AlertIntakeMessageState["QUEUED"] = "QUEUED";
+    AlertIntakeMessageState["RAISED"] = "RAISED";
+    AlertIntakeMessageState["RETRYING"] = "RETRYING";
+    AlertIntakeMessageState["PARKED"] = "PARKED";
+    AlertIntakeMessageState["DUPLICATE"] = "DUPLICATE";
+})(AlertIntakeMessageState || (AlertIntakeMessageState = {}));
 //# sourceMappingURL=alert-intake.enum.js.map

package/dist/esm/modules/alert-intake/enums/alert-intake.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"alert-intake.enum.js","sourceRoot":"","sources":["../../../../../src/modules/alert-intake/enums/alert-intake.enum.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,wCAAwC;AACxC,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,iCAAW,CAAA;IACX,2CAAqB,CAAA;IACrB,qCAAe,CAAA;AACnB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAED;;;;;;;;GAQG;AACH,MAAM,CAAN,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC3B,MAAM;IACN,wDAAiC,CAAA;IACjC,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,uFAAuF;IACvF,kDAA2B,CAAA;IAC3B,WAAW;IACX,wDAAiC,CAAA;IACjC,QAAQ;IACR,oCAAa,CAAA;IACb,iGAAiG;IACjG,sDAA+B,CAAA;AACnC,CAAC,EAbW,mBAAmB,KAAnB,mBAAmB,QAa9B;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAN,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,kDAAuB,CAAA;IACvB,gEAAqC,CAAA;AACzC,CAAC,EAHW,uBAAuB,KAAvB,uBAAuB,QAGlC;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IAClC,2CAAa,CAAA;IACb,mEAAqC,CAAA;IACrC,2EAA6C,CAAA;AACjD,CAAC,EAJW,0BAA0B,KAA1B,0BAA0B,QAIrC;AAED,qEAAqE;AACrE,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,oFAAoF;IACpF,4CAAmB,CAAA;IACnB,qEAAqE;IACrE,4CAAmB,CAAA;AACvB,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC;AAED,gEAAgE;AAChE,MAAM,CAAN,IAAY,8BAOX;AAPD,WAAY,8BAA8B;IACtC,8EAA8E;IAC9E,2DAAyB,CAAA;IACzB,gFAAgF;IAChF,+EAA6C,CAAA;IAC7C,mFAAmF;IACnF,mEAAiC,CAAA;AACrC,CAAC,EAPW,8BAA8B,KAA9B,8BAA8B,QAOzC;AAED,yFAAyF;AACzF,MAAM,CAAN,IAAY,0BAOX;AAPD,WAAY,0BAA0B;IAClC,uEAAyC,CAAA;IACzC,yEAA2C,CAAA;IAC3C,yEAA2C,CAAA;IAC3C,iEAAmC,CAAA;IACnC,6EAA+C,CAAA;IAC/C,2DAA6B,CAAA;AACjC,CAAC,EAPW,0BAA0B,KAA1B,0BAA0B,QAOrC"}
+{"version":3,"file":"alert-intake.enum.js","sourceRoot":"","sources":["../../../../../src/modules/alert-intake/enums/alert-intake.enum.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,wCAAwC;AACxC,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,iCAAW,CAAA;IACX,2CAAqB,CAAA;IACrB,qCAAe,CAAA;AACnB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAED;;;;;;;;GAQG;AACH,MAAM,CAAN,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC3B,MAAM;IACN,wDAAiC,CAAA;IACjC,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,uFAAuF;IACvF,kDAA2B,CAAA;IAC3B,WAAW;IACX,wDAAiC,CAAA;IACjC,QAAQ;IACR,oCAAa,CAAA;IACb,iGAAiG;IACjG,sDAA+B,CAAA;AACnC,CAAC,EAbW,mBAAmB,KAAnB,mBAAmB,QAa9B;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAN,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAC/B,kDAAuB,CAAA;IACvB,gEAAqC,CAAA;AACzC,CAAC,EAHW,uBAAuB,KAAvB,uBAAuB,QAGlC;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IAClC,2CAAa,CAAA;IACb,mEAAqC,CAAA;IACrC,2EAA6C,CAAA;AACjD,CAAC,EAJW,0BAA0B,KAA1B,0BAA0B,QAIrC;AAED,qEAAqE;AACrE,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,oFAAoF;IACpF,4CAAmB,CAAA;IACnB,qEAAqE;IACrE,4CAAmB,CAAA;AACvB,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC;AAED,gEAAgE;AAChE,MAAM,CAAN,IAAY,8BAOX;AAPD,WAAY,8BAA8B;IACtC,8EAA8E;IAC9E,2DAAyB,CAAA;IACzB,gFAAgF;IAChF,+EAA6C,CAAA;IAC7C,mFAAmF;IACnF,mEAAiC,CAAA;AACrC,CAAC,EAPW,8BAA8B,KAA9B,8BAA8B,QAOzC;AAED,yFAAyF;AACzF,MAAM,CAAN,IAAY,0BAOX;AAPD,WAAY,0BAA0B;IAClC,uEAAyC,CAAA;IACzC,yEAA2C,CAAA;IAC3C,yEAA2C,CAAA;IAC3C,iEAAmC,CAAA;IACnC,6EAA+C,CAAA;IAC/C,2DAA6B,CAAA;AACjC,CAAC,EAPW,0BAA0B,KAA1B,0BAA0B,QAOrC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAN,IAAY,uBAMX;AAND,WAAY,uBAAuB;IAC/B,4CAAiB,CAAA;IACjB,4CAAiB,CAAA;IACjB,gDAAqB,CAAA;IACrB,4CAAiB,CAAA;IACjB,kDAAuB,CAAA;AAC3B,CAAC,EANW,uBAAuB,KAAvB,uBAAuB,QAMlC"}

package/dist/types/modules/alert-intake/enums/alert-intake.enum.d.ts

@@ -81,3 +81,21 @@ export declare enum AlertIntakeRejectionReason {
     ORGANIZATION_INACTIVE = "ORGANIZATION_INACTIVE",
     RATE_LIMITED = "RATE_LIMITED"
 }
+/**
+ * Where a stored message stands, as an operator reads it. Derived from the pipeline's
+ * processing status, retry schedule and rejection reason - not stored.
+ *
+ *   QUEUED     waiting for, or being worked on by, the pipeline
+ *   RAISED     became an incident
+ *   RETRYING   failed; another attempt is scheduled
+ *   PARKED     failed and will not be retried on its own: it ran out of attempts, or it
+ *              has a `rejectionReason` (no organization, organization inactive)
+ *   DUPLICATE  the same sender repeating themselves; not raised
+ */
+export declare enum AlertIntakeMessageState {
+    QUEUED = "QUEUED",
+    RAISED = "RAISED",
+    RETRYING = "RETRYING",
+    PARKED = "PARKED",
+    DUPLICATE = "DUPLICATE"
+}

package/dist/types/modules/alert-intake/interfaces/alert-intake.d.ts

@@ -1,5 +1,5 @@
 import { CountryCode } from '../../country/enums/country-code.enum';
-import { AlertIntakeChannel, AlertIntakeEmergencyPolicy, AlertIntakeProvider, AlertIntakeRouteMatch, AlertIntakeSecretSource, AlertIntakeWebhookVerification } from '../enums/alert-intake.enum';
+import { AlertIntakeChannel, AlertIntakeEmergencyPolicy, AlertIntakeMessageState, AlertIntakeProvider, AlertIntakeRejectionReason, AlertIntakeRouteMatch, AlertIntakeSecretSource, AlertIntakeWebhookVerification } from '../enums/alert-intake.enum';
 /**
  * Alert intake settings.
  *
@@ -146,6 +146,85 @@ export interface OrganizationAlertIntakeSettings {
     platformFallbacks: AlertIntakePlatformFallback[];
     /** False when the service has no key to encrypt credentials with: only secret references can be used. */
     encryptedSecretsAvailable: boolean;
+    /** What arrived for this organization recently, and what needs someone's attention. */
+    activity?: AlertIntakeActivitySummary;
+}
+/** Counts over the last `windowHours` - except `parked` and `failingConnections`, which are as of now. */
+export interface AlertIntakeActivitySummary {
+    windowHours: number;
+    received: number;
+    raised: number;
+    duplicates: number;
+    retrying: number;
+    /** Waiting for an operator: out of attempts, or held for a reason (no organization, organization inactive). */
+    parked: number;
+    /** Enabled connections whose last attempt failed (a rejected call, a mailbox that could not be read). */
+    failingConnections: number;
+}
+/** What is kept of a file that came with a message. Never its contents. */
+export interface AlertIntakeMessageAttachment {
+    fileName: string;
+    mimeType: string;
+    size: number;
+    /** True once the file is stored in DMS and linked to the incident. */
+    attached: boolean;
+    /** Why it was not attached, when it was not. */
+    error: string | null;
+}
+/**
+ * A stored message, as an operator sees it in a list. `preview` is the start of the
+ * text; the whole of it is only in the detail.
+ */
+export interface AlertIntakeMessage {
+    id: string;
+    /** Null while no organization has been found for it. */
+    organizationId: number | null;
+    connectionId: string | null;
+    connectionName: string | null;
+    channel: AlertIntakeChannel;
+    /** Phone number, WhatsApp number or email address, as stored. */
+    sender: string | null;
+    senderName: string | null;
+    subject: string | null;
+    preview: string;
+    /** The keyword that routed it, on a platform connection. */
+    routeKeyword: string | null;
+    state: AlertIntakeMessageState;
+    rejectionReason: AlertIntakeRejectionReason | null;
+    /** The last error, for RETRYING and PARKED. */
+    error: string | null;
+    attempts: number;
+    nextAttemptAt: string | null;
+    /** The incident it raised. */
+    incidentId: number | null;
+    attachmentCount: number;
+    /** When the sender was told their message was received, if they were. */
+    acknowledgedAt: string | null;
+    receivedAt: string;
+    updatedAt: string;
+    /** What the CALLER may do with it now. */
+    actions: {
+        /** Try again: a PARKED message that ran out of attempts, or whose organization is active again. */
+        retry: boolean;
+        /** Raise a message that was taken for a duplicate. */
+        raiseAnyway: boolean;
+        /** Give a message no route claimed to an organization (platform operators). */
+        assign: boolean;
+    };
+}
+export interface AlertIntakeMessageDetail extends AlertIntakeMessage {
+    /** What the incident is raised from (a routing keyword removed). */
+    content: string;
+    /** Exactly as received. */
+    originalContent: string;
+    attachments: AlertIntakeMessageAttachment[];
+    acknowledgementError: string | null;
+}
+export interface AlertIntakeMessagePage {
+    items: AlertIntakeMessage[];
+    total: number;
+    page: number;
+    limit: number;
 }
 export interface AlertIntakeConnectionTestResult {
     success: boolean;
@@ -200,3 +279,22 @@ export interface UpdateAlertIntakeRoute {
 export type AlertIntakePlatformConnection = AlertIntakeConnection & {
     routes: AlertIntakeRoute[];
 };
+/** Filters for an organization's stored messages (query string). `limit` is at most 100. */
+export interface ListAlertIntakeMessagesQuery {
+    state?: AlertIntakeMessageState;
+    channel?: AlertIntakeChannel;
+    connectionId?: string;
+    reason?: AlertIntakeRejectionReason;
+    page?: number;
+    limit?: number;
+}
+/** Platform operators: every organization's messages, and those no organization has yet. */
+export interface ListPlatformAlertIntakeMessagesQuery extends ListAlertIntakeMessagesQuery {
+    organizationId?: number;
+    /** Only messages no organization has been found for. */
+    unrouted?: boolean;
+}
+/** Platform operators: give a message no route claimed to an organization, and raise it. */
+export interface AssignAlertIntakeMessage {
+    organizationId: number;
+}

package/package.json

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