clarion-shared-types 1.0.97 → 1.0.99

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

@@ -0,0 +1,94 @@
+/**
+ * Alert intake: how a member of the public reaches an organization WITHOUT the app -
+ * an SMS, a WhatsApp message or an email that clarion-alerts turns into an incident.
+ *
+ * Not to be confused with `alert-dispatch`, which is about who an SOS raised IN the
+ * app is sent to.
+ */
+/** The channel a message arrived on. */
+export var AlertIntakeChannel;
+(function (AlertIntakeChannel) {
+    AlertIntakeChannel["SMS"] = "SMS";
+    AlertIntakeChannel["WHATSAPP"] = "WHATSAPP";
+    AlertIntakeChannel["EMAIL"] = "EMAIL";
+})(AlertIntakeChannel || (AlertIntakeChannel = {}));
+/**
+ * The provider a connection talks to.
+ *
+ * A code here only RESERVES the name. Whether a provider can be connected is
+ * answered by clarion-alerts' provider catalogue (`AlertIntakeProviderDescriptor`),
+ * which lists only providers with a registered adapter. UWAZII and CELCOM are
+ * reserved without an adapter on purpose: their inbound callback formats have not
+ * been confirmed, and until they are, GENERIC_SMS connects them by configuration.
+ */
+export var AlertIntakeProvider;
+(function (AlertIntakeProvider) {
+    // SMS
+    AlertIntakeProvider["AFRICASTALKING"] = "africastalking";
+    AlertIntakeProvider["UWAZII"] = "uwazii";
+    AlertIntakeProvider["CELCOM"] = "celcom";
+    /** Any gateway that POSTs flat JSON or form fields; the field names are configured. */
+    AlertIntakeProvider["GENERIC_SMS"] = "generic_sms";
+    // WhatsApp
+    AlertIntakeProvider["WHATSAPP_CLOUD"] = "whatsapp_cloud";
+    // Email
+    AlertIntakeProvider["IMAP"] = "imap";
+    /** An inbound-parse webhook (Mailgun routes, SendGrid Inbound Parse, or a generic JSON post). */
+    AlertIntakeProvider["EMAIL_WEBHOOK"] = "email_webhook";
+})(AlertIntakeProvider || (AlertIntakeProvider = {}));
+/**
+ * Where a connection's credentials live. Never in a plaintext column.
+ *
+ *   ENCRYPTED         entered by the organization, encrypted at rest by clarion-alerts
+ *                     (AES-256-GCM, bound to the connection and the field). Write-only:
+ *                     the API never returns them.
+ *   SECRET_REFERENCE  the NAME of a secret the platform operator provisioned (Secret
+ *                     Manager / environment). How the legacy per-tenant credentials
+ *                     keep working, and the option for an operator who does not want
+ *                     a credential in the database at all.
+ */
+export var AlertIntakeSecretSource;
+(function (AlertIntakeSecretSource) {
+    AlertIntakeSecretSource["ENCRYPTED"] = "ENCRYPTED";
+    AlertIntakeSecretSource["SECRET_REFERENCE"] = "SECRET_REFERENCE";
+})(AlertIntakeSecretSource || (AlertIntakeSecretSource = {}));
+/**
+ * How the emergency type of an incident raised from a message is decided.
+ * AUTO derives it from the organization: a grievance desk never raises an
+ * emergency; an incident desk decides from the message's category and priority.
+ */
+export var AlertIntakeEmergencyPolicy;
+(function (AlertIntakeEmergencyPolicy) {
+    AlertIntakeEmergencyPolicy["AUTO"] = "AUTO";
+    AlertIntakeEmergencyPolicy["ALWAYS_EMERGENCY"] = "ALWAYS_EMERGENCY";
+    AlertIntakeEmergencyPolicy["ALWAYS_NON_EMERGENCY"] = "ALWAYS_NON_EMERGENCY";
+})(AlertIntakeEmergencyPolicy || (AlertIntakeEmergencyPolicy = {}));
+/** How a message on a PLATFORM connection finds its organization. */
+export var AlertIntakeRouteMatch;
+(function (AlertIntakeRouteMatch) {
+    /** The first word of the message, e.g. `G4S fire at ...` on a shared short code. */
+    AlertIntakeRouteMatch["KEYWORD"] = "KEYWORD";
+    /** Everything no other route claimed. At most one per connection. */
+    AlertIntakeRouteMatch["DEFAULT"] = "DEFAULT";
+})(AlertIntakeRouteMatch || (AlertIntakeRouteMatch = {}));
+/** How a provider proves a webhook call really came from it. */
+export var AlertIntakeWebhookVerification;
+(function (AlertIntakeWebhookVerification) {
+    /** The unguessable URL is the only proof (Africa's Talking signs nothing). */
+    AlertIntakeWebhookVerification["SECRET_URL"] = "SECRET_URL";
+    /** A shared secret the gateway sends in a header, compared in constant time. */
+    AlertIntakeWebhookVerification["SHARED_SECRET_HEADER"] = "SHARED_SECRET_HEADER";
+    /** `X-Hub-Signature-256`: HMAC-SHA256 of the raw body with the Meta app secret. */
+    AlertIntakeWebhookVerification["META_SIGNATURE"] = "META_SIGNATURE";
+})(AlertIntakeWebhookVerification || (AlertIntakeWebhookVerification = {}));
+/** Why a message that arrived did not become an incident. Stored; shown to operators. */
+export var AlertIntakeRejectionReason;
+(function (AlertIntakeRejectionReason) {
+    AlertIntakeRejectionReason["UNKNOWN_CONNECTION"] = "UNKNOWN_CONNECTION";
+    AlertIntakeRejectionReason["CONNECTION_DISABLED"] = "CONNECTION_DISABLED";
+    AlertIntakeRejectionReason["VERIFICATION_FAILED"] = "VERIFICATION_FAILED";
+    AlertIntakeRejectionReason["NO_ORGANIZATION"] = "NO_ORGANIZATION";
+    AlertIntakeRejectionReason["ORGANIZATION_INACTIVE"] = "ORGANIZATION_INACTIVE";
+    AlertIntakeRejectionReason["RATE_LIMITED"] = "RATE_LIMITED";
+})(AlertIntakeRejectionReason || (AlertIntakeRejectionReason = {}));
+//# sourceMappingURL=alert-intake.enum.js.map

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

@@ -0,0 +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"}

package/dist/esm/modules/alert-intake/index.js

@@ -0,0 +1,7 @@
+// Enums
+export * from './enums/alert-intake.enum';
+// Response shapes + plain request interfaces
+export * from './interfaces/alert-intake';
+// Utilities
+export * from './utils/alert-intake.util';
+//# sourceMappingURL=index.js.map

package/dist/esm/modules/alert-intake/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/alert-intake/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,2BAA2B,CAAC;AAE1C,6CAA6C;AAC7C,cAAc,2BAA2B,CAAC;AAE1C,YAAY;AACZ,cAAc,2BAA2B,CAAC"}

package/dist/esm/modules/alert-intake/interfaces/alert-intake.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=alert-intake.js.map

package/dist/esm/modules/alert-intake/interfaces/alert-intake.js.map

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

package/dist/esm/modules/alert-intake/utils/alert-intake.util.js

@@ -0,0 +1,42 @@
+/** A routing keyword: 2-20 letters or digits, stored upper-cased. */
+export const ALERT_INTAKE_KEYWORD_PATTERN = /^[A-Z0-9]{2,20}$/;
+/** Upper bounds that keep one organization's settings a form rather than a list to page through. */
+export const MAX_ALERT_INTAKE_CONNECTIONS_PER_ORGANIZATION = 20;
+export const MAX_ALERT_INTAKE_ROUTES_PER_CONNECTION = 200;
+/** One settings value (config or secret). An access token is the longest thing that goes here. */
+export const MAX_ALERT_INTAKE_SETTING_LENGTH = 4096;
+/** Normalises what an operator typed into the stored form. Null when it is not a valid keyword. */
+export function normaliseAlertIntakeKeyword(value) {
+    const keyword = (value !== null && value !== void 0 ? value : '').trim().toUpperCase();
+    return ALERT_INTAKE_KEYWORD_PATTERN.test(keyword) ? keyword : null;
+}
+/**
+ * The routing keyword of a message: its first word, upper-cased, punctuation
+ * stripped - `g4s, fire at the gate` and `G4S: fire` both give `G4S`.
+ * Null when the first word could not be a keyword.
+ *
+ * Deliberately only the FIRST word. Matching a keyword anywhere in the text would
+ * route "I was robbed near the G4S office" to G4S.
+ */
+export function extractAlertIntakeKeyword(text) {
+    var _a;
+    const first = (_a = (text !== null && text !== void 0 ? text : '').trim().split(/\s+/)[0]) !== null && _a !== void 0 ? _a : '';
+    return normaliseAlertIntakeKeyword(first.replace(/^[^A-Za-z0-9]+|[^A-Za-z0-9]+$/g, ''));
+}
+/**
+ * The message with its routing keyword removed, so "G4S fire at the gate" is
+ * analysed as "fire at the gate". Returns the text unchanged when it does not start
+ * with that keyword.
+ */
+export function stripAlertIntakeKeyword(text, keyword) {
+    const trimmed = (text !== null && text !== void 0 ? text : '').trim();
+    // Keywords are [A-Z0-9] by construction; escaping keeps this safe for a caller that skipped normalising.
+    const literal = keyword.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    const match = new RegExp(`^[^A-Za-z0-9]*${literal}(?![A-Za-z0-9])[^A-Za-z0-9]*`, 'i').exec(trimmed);
+    if (!match)
+        return text;
+    const rest = trimmed.slice(match[0].length).trim();
+    // A message that was ONLY the keyword is still a message; do not turn it into nothing.
+    return rest.length > 0 ? rest : trimmed;
+}
+//# sourceMappingURL=alert-intake.util.js.map

package/dist/esm/modules/alert-intake/utils/alert-intake.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alert-intake.util.js","sourceRoot":"","sources":["../../../../../src/modules/alert-intake/utils/alert-intake.util.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,MAAM,CAAC,MAAM,4BAA4B,GAAG,kBAAkB,CAAC;AAE/D,oGAAoG;AACpG,MAAM,CAAC,MAAM,6CAA6C,GAAG,EAAE,CAAC;AAChE,MAAM,CAAC,MAAM,sCAAsC,GAAG,GAAG,CAAC;AAC1D,kGAAkG;AAClG,MAAM,CAAC,MAAM,+BAA+B,GAAG,IAAI,CAAC;AAEpD,mGAAmG;AACnG,MAAM,UAAU,2BAA2B,CAAC,KAAgC;IACxE,MAAM,OAAO,GAAG,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACnD,OAAO,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;AACvE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAA+B;;IACrE,MAAM,KAAK,GAAG,MAAA,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;IACxD,OAAO,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,gCAAgC,EAAE,EAAE,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAY,EAAE,OAAe;IACjE,MAAM,OAAO,GAAG,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACpC,yGAAyG;IACzG,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,iBAAiB,OAAO,8BAA8B,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpG,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IACnD,uFAAuF;IACvF,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;AAC5C,CAAC"}

package/dist/esm/modules/notification/enums/notification-settings.enums.js

@@ -0,0 +1,81 @@
+/**
+ * Organization notification settings enums.
+ *
+ * MIRRORS grm-shared-library (`modules/notification/enums`), values included. The
+ * admin renders and submits these strings and clarion-notification validates the
+ * same ones, so any drift is a form the API refuses. `notification-settings.spec.ts`
+ * pins the values.
+ */
+/** What kind of identity an SMS is sent from. Decides how the value is validated. */
+export var SmsSenderType;
+(function (SmsSenderType) {
+    /** A registered alphanumeric sender name, e.g. `G4S`. At most 11 characters. */
+    SmsSenderType["ALPHANUMERIC"] = "ALPHANUMERIC";
+    /** An E.164 long number, e.g. `+254711000000`. */
+    SmsSenderType["PHONE_NUMBER"] = "PHONE_NUMBER";
+    /** A telco short code, e.g. `22384`. */
+    SmsSenderType["SHORT_CODE"] = "SHORT_CODE";
+    /** A provider-side sender pool (Twilio Messaging Service SID, `MG...`). */
+    SmsSenderType["MESSAGING_SERVICE"] = "MESSAGING_SERVICE";
+})(SmsSenderType || (SmsSenderType = {}));
+/**
+ * Lifecycle of an organization-owned SMS sender. An organization REQUESTS a sender
+ * (PENDING) and a platform operator ACTIVATES it once the provider and the telco
+ * have registered it. Only ACTIVE senders are ever used to send.
+ */
+export var NotificationSenderStatus;
+(function (NotificationSenderStatus) {
+    NotificationSenderStatus["PENDING"] = "PENDING";
+    NotificationSenderStatus["ACTIVE"] = "ACTIVE";
+    NotificationSenderStatus["SUSPENDED"] = "SUSPENDED";
+    NotificationSenderStatus["REJECTED"] = "REJECTED";
+})(NotificationSenderStatus || (NotificationSenderStatus = {}));
+/**
+ * Whether an email provider will accept mail FROM an organization's address.
+ * Tracked per provider: an address can be verified in Twilio SendGrid while its
+ * domain is unknown to Mailgun. A provider only sends from an address it has
+ * VERIFIED; otherwise it falls back to the platform sender.
+ */
+export var EmailSenderVerificationStatus;
+(function (EmailSenderVerificationStatus) {
+    /** The provider does not know this address or its domain. */
+    EmailSenderVerificationStatus["UNVERIFIED"] = "UNVERIFIED";
+    /** Verification was started and is waiting on the owner (inbox click or DNS records). */
+    EmailSenderVerificationStatus["PENDING"] = "PENDING";
+    /** The provider accepts mail from this address. */
+    EmailSenderVerificationStatus["VERIFIED"] = "VERIFIED";
+    /** The last check could not be completed (provider error). */
+    EmailSenderVerificationStatus["FAILED"] = "FAILED";
+})(EmailSenderVerificationStatus || (EmailSenderVerificationStatus = {}));
+/** How the provider recognises the address. */
+export var EmailSenderVerificationMethod;
+(function (EmailSenderVerificationMethod) {
+    /** The exact address was verified on its own (SendGrid Single Sender Verification). */
+    EmailSenderVerificationMethod["SINGLE_SENDER"] = "SINGLE_SENDER";
+    /** The whole domain is authenticated (SendGrid domain authentication, Mailgun domain). */
+    EmailSenderVerificationMethod["DOMAIN"] = "DOMAIN";
+})(EmailSenderVerificationMethod || (EmailSenderVerificationMethod = {}));
+/** Whose identity a message actually went out under. */
+export var NotificationSenderSource;
+(function (NotificationSenderSource) {
+    /** The organization's own verified email address / active SMS sender. */
+    NotificationSenderSource["ORGANIZATION"] = "ORGANIZATION";
+    /** The platform's default (country-aware) sender. */
+    NotificationSenderSource["PLATFORM_DEFAULT"] = "PLATFORM_DEFAULT";
+})(NotificationSenderSource || (NotificationSenderSource = {}));
+/**
+ * Where one resolved branding value came from. Branding resolves field by field,
+ * highest precedence first, so a half-filled profile still produces a complete email.
+ */
+export var NotificationBrandingSource;
+(function (NotificationBrandingSource) {
+    /** The organization's notification settings. */
+    NotificationBrandingSource["PROFILE"] = "PROFILE";
+    /** The organization record (clarion-organization). */
+    NotificationBrandingSource["ORGANIZATION"] = "ORGANIZATION";
+    /** The legacy per-app defaults (deprecated). */
+    NotificationBrandingSource["APP_DEFAULT"] = "APP_DEFAULT";
+    /** The platform's own branding. */
+    NotificationBrandingSource["PLATFORM_DEFAULT"] = "PLATFORM_DEFAULT";
+})(NotificationBrandingSource || (NotificationBrandingSource = {}));
+//# sourceMappingURL=notification-settings.enums.js.map

package/dist/esm/modules/notification/enums/notification-settings.enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-settings.enums.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/notification-settings.enums.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,qFAAqF;AACrF,MAAM,CAAN,IAAY,aASX;AATD,WAAY,aAAa;IACrB,gFAAgF;IAChF,8CAA6B,CAAA;IAC7B,kDAAkD;IAClD,8CAA6B,CAAA;IAC7B,wCAAwC;IACxC,0CAAyB,CAAA;IACzB,2EAA2E;IAC3E,wDAAuC,CAAA;AAC3C,CAAC,EATW,aAAa,KAAb,aAAa,QASxB;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAChC,+CAAmB,CAAA;IACnB,6CAAiB,CAAA;IACjB,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAED;;;;;GAKG;AACH,MAAM,CAAN,IAAY,6BASX;AATD,WAAY,6BAA6B;IACrC,6DAA6D;IAC7D,0DAAyB,CAAA;IACzB,yFAAyF;IACzF,oDAAmB,CAAA;IACnB,mDAAmD;IACnD,sDAAqB,CAAA;IACrB,8DAA8D;IAC9D,kDAAiB,CAAA;AACrB,CAAC,EATW,6BAA6B,KAA7B,6BAA6B,QASxC;AAED,+CAA+C;AAC/C,MAAM,CAAN,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACrC,uFAAuF;IACvF,gEAA+B,CAAA;IAC/B,0FAA0F;IAC1F,kDAAiB,CAAA;AACrB,CAAC,EALW,6BAA6B,KAA7B,6BAA6B,QAKxC;AAED,wDAAwD;AACxD,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAChC,yEAAyE;IACzE,yDAA6B,CAAA;IAC7B,qDAAqD;IACrD,iEAAqC,CAAA;AACzC,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,0BASX;AATD,WAAY,0BAA0B;IAClC,gDAAgD;IAChD,iDAAmB,CAAA;IACnB,sDAAsD;IACtD,2DAA6B,CAAA;IAC7B,gDAAgD;IAChD,yDAA2B,CAAA;IAC3B,mCAAmC;IACnC,mEAAqC,CAAA;AACzC,CAAC,EATW,0BAA0B,KAA1B,0BAA0B,QASrC"}

package/dist/esm/modules/notification/enums/sms-provider-name.enum.js

@@ -1,11 +1,16 @@
 /**
  * Identifiers for the SMS providers the notification service can dispatch through.
  * Provider order/fallback is configuration-driven; new providers can be appended.
+ *
+ * A code here only RESERVES the name. Whether a provider can actually be used is
+ * answered by the notification service's provider catalogue
+ * (`SmsProviderDescriptor`), which lists only providers with a registered adapter.
  */
 export var SmsProviderName;
 (function (SmsProviderName) {
     SmsProviderName["TWILIO"] = "twilio";
     SmsProviderName["UWAZII"] = "uwazii";
     SmsProviderName["AFRICASTALKING"] = "africastalking";
+    SmsProviderName["CELCOM"] = "celcom";
 })(SmsProviderName || (SmsProviderName = {}));
 //# sourceMappingURL=sms-provider-name.enum.js.map

package/dist/esm/modules/notification/enums/sms-provider-name.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"sms-provider-name.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/sms-provider-name.enum.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,oDAAiC,CAAA;AACrC,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B"}
+{"version":3,"file":"sms-provider-name.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/sms-provider-name.enum.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,oDAAiC,CAAA;IACjC,oCAAiB,CAAA;AACrB,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B"}

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

@@ -4,10 +4,15 @@ export * from './enums/sms-provider-name.enum';
 export * from './enums/email-provider-name.enum';
 export * from './enums/notification-overall-status.enum';
 export * from './enums/provider-failure-reason.enum';
+export * from './enums/notification-settings.enums';
 // Result/interface contracts (display-safe)
 export * from './interfaces/provider-attempt';
 export * from './interfaces/per-channel-result';
 export * from './interfaces/sms-send-result';
 export * from './interfaces/email-send-result';
 export * from './interfaces/notification-dispatch-result';
+// Organization notification settings (branding + sender identity)
+export * from './interfaces/organization-notification-settings.dto';
+// Utilities
+export * from './utils/notification-sender.util';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AAErD,4CAA4C;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AAEpD,4CAA4C;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAE1D,kEAAkE;AAClE,cAAc,qDAAqD,CAAC;AAEpE,YAAY;AACZ,cAAc,kCAAkC,CAAC"}

package/dist/esm/modules/notification/interfaces/organization-notification-settings.dto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=organization-notification-settings.dto.js.map

package/dist/esm/modules/notification/interfaces/organization-notification-settings.dto.js.map

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

package/dist/esm/modules/notification/utils/notification-sender.util.js

@@ -0,0 +1,89 @@
+import { SmsSenderType } from '../enums/notification-settings.enums';
+/**
+ * MIRRORS grm-shared-library (`modules/notification/constants` and `utils`),
+ * patterns and thresholds included. The settings form validates with these and
+ * clarion-notification validates with the originals, so they must agree to the
+ * character: a form that accepts what the API refuses is worse than no check.
+ */
+/** `#RRGGBB`. The only colour format accepted, because it is inlined into email CSS. */
+export const BRAND_COLOUR_PATTERN = /^#[0-9a-fA-F]{6}$/;
+/**
+ * What a sender value must look like, per type. ALPHANUMERIC follows the GSM rule
+ * every supported provider enforces: 3-11 characters, at least one letter (an
+ * all-digit "name" is a number, and telcos reject it as spoofing).
+ */
+export const SMS_SENDER_ID_PATTERNS = Object.freeze({
+    [SmsSenderType.ALPHANUMERIC]: /^(?=.*[A-Za-z])[A-Za-z0-9 _.&-]{3,11}$/,
+    [SmsSenderType.PHONE_NUMBER]: /^\+[1-9]\d{6,14}$/,
+    [SmsSenderType.SHORT_CODE]: /^\d{3,8}$/,
+    [SmsSenderType.MESSAGING_SERVICE]: /^MG[0-9a-fA-F]{32}$/,
+});
+/** Human-readable form of {@link SMS_SENDER_ID_PATTERNS}, for validation messages and form hints. */
+export const SMS_SENDER_ID_HINTS = Object.freeze({
+    [SmsSenderType.ALPHANUMERIC]: '3-11 characters (letters, digits, space, _ . & -) with at least one letter, e.g. G4S',
+    [SmsSenderType.PHONE_NUMBER]: 'an E.164 number, e.g. +254711000000',
+    [SmsSenderType.SHORT_CODE]: '3-8 digits, e.g. 22384',
+    [SmsSenderType.MESSAGING_SERVICE]: 'a Twilio Messaging Service SID (MG followed by 32 hex characters)',
+});
+/** Upper bounds that keep one organization from turning its settings into a list to page through. */
+export const MAX_EMAIL_SENDERS_PER_ORGANIZATION = 10;
+export const MAX_SMS_SENDERS_PER_ORGANIZATION = 30;
+/** Large text and UI components (WCAG 1.4.11): buttons and links in the primary colour. */
+export const MIN_PRIMARY_COLOUR_CONTRAST = 3;
+/** Body-size white text sits on the accent colour (WCAG 1.4.3). */
+export const MIN_ACCENT_COLOUR_CONTRAST = 4.5;
+/**
+ * Validates an SMS sender value against its declared type.
+ * Returns null when valid, otherwise a message fit to show an operator.
+ */
+export function validateSmsSenderId(senderType, senderId) {
+    const pattern = SMS_SENDER_ID_PATTERNS[senderType];
+    if (!pattern)
+        return `Unsupported sender type: ${senderType}`;
+    const value = (senderId !== null && senderId !== void 0 ? senderId : '').trim();
+    if (!value)
+        return 'Sender ID is required';
+    return pattern.test(value) ? null : `A ${senderType} sender must be ${SMS_SENDER_ID_HINTS[senderType]}`;
+}
+/** The domain part of an email address, lower-cased. Null when there is none. */
+export function emailDomainOf(address) {
+    const value = (address !== null && address !== void 0 ? address : '').trim().toLowerCase();
+    const at = value.lastIndexOf('@');
+    if (at <= 0 || at === value.length - 1)
+        return null;
+    return value.slice(at + 1);
+}
+/**
+ * WCAG contrast ratio of a `#RRGGBB` colour against white, from 1 (white) to 21
+ * (black). The email templates put WHITE text on the primary colour (buttons) and
+ * on the accent colour (header banner, footer), so a pale brand colour produces
+ * an email nobody can read. Returns 0 for anything that is not a hex colour.
+ */
+export function contrastRatioWithWhite(hex) {
+    const match = /^#([0-9a-fA-F]{6})$/.exec((hex !== null && hex !== void 0 ? hex : '').trim());
+    if (!match)
+        return 0;
+    const [r, g, b] = [0, 2, 4].map(offset => {
+        const channel = parseInt(match[1].slice(offset, offset + 2), 16) / 255;
+        return channel <= 0.03928 ? channel / 12.92 : Math.pow((channel + 0.055) / 1.055, 2.4);
+    });
+    const luminance = 0.2126 * r + 0.7152 * g + 0.0722 * b;
+    return Math.round((1.05 / (luminance + 0.05)) * 100) / 100;
+}
+/**
+ * Darkens a `#RRGGBB` colour by a fraction (0-1). Used to derive the hover/pressed
+ * shade of a brand colour so an organization only has to choose one.
+ * Returns the input unchanged when it is not a valid hex colour.
+ */
+export function darkenHexColour(hex, fraction = 0.15) {
+    const match = /^#([0-9a-fA-F]{6})$/.exec((hex !== null && hex !== void 0 ? hex : '').trim());
+    if (!match)
+        return hex;
+    const clamped = Math.min(Math.max(fraction, 0), 1);
+    const channels = [0, 2, 4].map(offset => {
+        const channel = parseInt(match[1].slice(offset, offset + 2), 16);
+        return Math.round(channel * (1 - clamped)).toString(16).padStart(2, '0');
+    });
+    return `#${channels.join('')}`;
+}
+//# sourceMappingURL=notification-sender.util.js.map

package/dist/esm/modules/notification/utils/notification-sender.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-sender.util.js","sourceRoot":"","sources":["../../../../../src/modules/notification/utils/notification-sender.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAErE;;;;;GAKG;AAEH,wFAAwF;AACxF,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAExD;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAA4C,MAAM,CAAC,MAAM,CAAC;IACzF,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,wCAAwC;IACtE,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,mBAAmB;IACjD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,WAAW;IACvC,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,qBAAqB;CAC3D,CAAC,CAAC;AAEH,qGAAqG;AACrG,MAAM,CAAC,MAAM,mBAAmB,GAA4C,MAAM,CAAC,MAAM,CAAC;IACtF,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,sFAAsF;IACpH,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,qCAAqC;IACnE,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,wBAAwB;IACpD,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,mEAAmE;CACzG,CAAC,CAAC;AAEH,qGAAqG;AACrG,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AACrD,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAEnD,2FAA2F;AAC3F,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC;AAC7C,mEAAmE;AACnE,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAE9C;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAyB,EAAE,QAAgB;IAC3E,MAAM,OAAO,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IACnD,IAAI,CAAC,OAAO;QAAE,OAAO,4BAA4B,UAAU,EAAE,CAAC;IAC9D,MAAM,KAAK,GAAG,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACtC,IAAI,CAAC,KAAK;QAAE,OAAO,uBAAuB,CAAC;IAC3C,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,mBAAmB,mBAAmB,CAAC,UAAU,CAAC,EAAE,CAAC;AAC5G,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,aAAa,CAAC,OAAkC;IAC5D,MAAM,KAAK,GAAG,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACnD,MAAM,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpD,OAAO,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAW;IAC9C,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7D,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC;IACrB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC;QACvE,OAAO,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,GAAG,MAAM,GAAG,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW,EAAE,QAAQ,GAAG,IAAI;IACxD,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7D,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,CAAC;IACvB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;AACnC,CAAC"}

package/dist/esm/modules/permission/enums/permission-actions.enum.js

@@ -106,5 +106,22 @@ export var PermissionActions;
     PermissionActions["READ_SUPPORT_REPORT"] = "read:support-report";
     PermissionActions["READ_SUPPORT_SYNC"] = "read:support-sync";
     PermissionActions["MANAGE_SUPPORT_SYNC"] = "manage:support-sync";
+    // Module: Notification
+    // An organization's notification settings (clarion-notification): how its
+    // emails are branded, the address they are sent from, and the sender ID its
+    // SMS arrive under. Mirrors grm-shared-library.
+    PermissionActions["READ_NOTIFICATION_SETTINGS"] = "read:notification-settings";
+    PermissionActions["MANAGE_NOTIFICATION_SETTINGS"] = "manage:notification-settings";
+    // Confirming that an SMS sender ID really is registered with the provider.
+    // Granted to NO role on the backend: only Super-Admin ('*') passes it.
+    PermissionActions["APPROVE_NOTIFICATION_SENDER"] = "approve:notification-sender";
+    // Module: Alert Intake
+    // The channels the PUBLIC reaches an organization on without the app - its SMS
+    // short code, WhatsApp number and mailbox (clarion-alerts). Mirrors grm-shared-library.
+    PermissionActions["READ_ALERT_INTAKE"] = "read:alert-intake";
+    PermissionActions["MANAGE_ALERT_INTAKE"] = "manage:alert-intake";
+    // PLATFORM connections and their routes (which keyword sends a message to which
+    // organization). Granted to NO role on the backend: only Super-Admin ('*') passes it.
+    PermissionActions["MANAGE_ALERT_INTAKE_PLATFORM"] = "manage:alert-intake-platform";
 })(PermissionActions || (PermissionActions = {}));
 //# sourceMappingURL=permission-actions.enum.js.map

package/dist/esm/modules/permission/enums/permission-actions.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAmHX;AAnHD,WAAY,iBAAiB;IACzB,uBAAuB;IACvB,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gEAA2C,CAAA;IAE3C,kBAAkB;IAClB,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,wEAAwE;IACxE,mEAAmE;IACnE,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,uDAAuD;IACvD,wEAAmD,CAAA;IACnD,4EAAuD,CAAA;IAEvD,wBAAwB;IACxB,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,mBAAmB;IACnB,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,wDAAmC,CAAA;IACnC,oFAA+D,CAAA;IAC/D,gFAA2D,CAAA;IAC3D,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAE/D,uBAAuB;IACvB,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,kEAA6C,CAAA;IAE7C,4EAA4E;IAC5E,wEAAwE;IACxE,6EAA6E;IAC7E,qDAAqD;IACrD,gGAA2E,CAAA;IAC3E,4FAAuE,CAAA;IACvE,gGAA2E,CAAA;IAC3E,gGAA2E,CAAA;IAC3E,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,sEAAiD,CAAA;IACjD,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,8EAAyD,CAAA;IAEzD,kBAAkB;IAClB,EAAE;IACF,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,+BAA+B;IAC/B,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,yEAAyE;IACzE,gEAA2C,CAAA;IAC3C;;;OAGG;IACH,8DAAyC,CAAA;IACzC,mFAAmF;IACnF,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,gFAAgF;IAChF,sEAAiD,CAAA;IACjD,wEAAmD,CAAA;IACnD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IACrD,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,8DAAyC,CAAA;IACzC,kFAA6D,CAAA;IAC7D,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;AAC/C,CAAC,EAnHW,iBAAiB,KAAjB,iBAAiB,QAmH5B"}
+{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAsIX;AAtID,WAAY,iBAAiB;IACzB,uBAAuB;IACvB,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gEAA2C,CAAA;IAE3C,kBAAkB;IAClB,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,wEAAwE;IACxE,mEAAmE;IACnE,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,uDAAuD;IACvD,wEAAmD,CAAA;IACnD,4EAAuD,CAAA;IAEvD,wBAAwB;IACxB,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,mBAAmB;IACnB,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,wDAAmC,CAAA;IACnC,oFAA+D,CAAA;IAC/D,gFAA2D,CAAA;IAC3D,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAE/D,uBAAuB;IACvB,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,kEAA6C,CAAA;IAE7C,4EAA4E;IAC5E,wEAAwE;IACxE,6EAA6E;IAC7E,qDAAqD;IACrD,gGAA2E,CAAA;IAC3E,4FAAuE,CAAA;IACvE,gGAA2E,CAAA;IAC3E,gGAA2E,CAAA;IAC3E,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,sEAAiD,CAAA;IACjD,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,8EAAyD,CAAA;IAEzD,kBAAkB;IAClB,EAAE;IACF,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,+BAA+B;IAC/B,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,yEAAyE;IACzE,gEAA2C,CAAA;IAC3C;;;OAGG;IACH,8DAAyC,CAAA;IACzC,mFAAmF;IACnF,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,gFAAgF;IAChF,sEAAiD,CAAA;IACjD,wEAAmD,CAAA;IACnD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IACrD,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,8DAAyC,CAAA;IACzC,kFAA6D,CAAA;IAC7D,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAE3C,uBAAuB;IACvB,0EAA0E;IAC1E,4EAA4E;IAC5E,gDAAgD;IAChD,8EAAyD,CAAA;IACzD,kFAA6D,CAAA;IAC7D,2EAA2E;IAC3E,uEAAuE;IACvE,gFAA2D,CAAA;IAE3D,uBAAuB;IACvB,+EAA+E;IAC/E,wFAAwF;IACxF,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gFAAgF;IAChF,sFAAsF;IACtF,kFAA6D,CAAA;AACjE,CAAC,EAtIW,iBAAiB,KAAjB,iBAAiB,QAsI5B"}

package/dist/esm/modules/permission/enums/permissions-moudule.enum.js

@@ -10,5 +10,7 @@ export var PermissionsModule;
     PermissionsModule["RESPONSE_UNIT"] = "Response Unit";
     PermissionsModule["TRACKING"] = "Tracking";
     PermissionsModule["SUPPORT"] = "Support";
+    PermissionsModule["NOTIFICATION"] = "Notification";
+    PermissionsModule["ALERT_INTAKE"] = "Alert Intake";
 })(PermissionsModule || (PermissionsModule = {}));
 //# sourceMappingURL=permissions-moudule.enum.js.map

package/dist/esm/modules/permission/enums/permissions-moudule.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"permissions-moudule.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permissions-moudule.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IACzB,kDAA6B,CAAA;IAC7B,wCAAmB,CAAA;IACnB,sDAAiC,CAAA;IACjC,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,2CAAsB,CAAA;IACtB,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;AACvB,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B"}
+{"version":3,"file":"permissions-moudule.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permissions-moudule.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAaX;AAbD,WAAY,iBAAiB;IACzB,kDAA6B,CAAA;IAC7B,wCAAmB,CAAA;IACnB,sDAAiC,CAAA;IACjC,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,2CAAsB,CAAA;IACtB,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,kDAA6B,CAAA;IAC7B,kDAA6B,CAAA;AACjC,CAAC,EAbW,iBAAiB,KAAjB,iBAAiB,QAa5B"}

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,83 @@
+/**
+ * Alert intake: how a member of the public reaches an organization WITHOUT the app -
+ * an SMS, a WhatsApp message or an email that clarion-alerts turns into an incident.
+ *
+ * Not to be confused with `alert-dispatch`, which is about who an SOS raised IN the
+ * app is sent to.
+ */
+/** The channel a message arrived on. */
+export declare enum AlertIntakeChannel {
+    SMS = "SMS",
+    WHATSAPP = "WHATSAPP",
+    EMAIL = "EMAIL"
+}
+/**
+ * The provider a connection talks to.
+ *
+ * A code here only RESERVES the name. Whether a provider can be connected is
+ * answered by clarion-alerts' provider catalogue (`AlertIntakeProviderDescriptor`),
+ * which lists only providers with a registered adapter. UWAZII and CELCOM are
+ * reserved without an adapter on purpose: their inbound callback formats have not
+ * been confirmed, and until they are, GENERIC_SMS connects them by configuration.
+ */
+export declare enum AlertIntakeProvider {
+    AFRICASTALKING = "africastalking",
+    UWAZII = "uwazii",
+    CELCOM = "celcom",
+    /** Any gateway that POSTs flat JSON or form fields; the field names are configured. */
+    GENERIC_SMS = "generic_sms",
+    WHATSAPP_CLOUD = "whatsapp_cloud",
+    IMAP = "imap",
+    /** An inbound-parse webhook (Mailgun routes, SendGrid Inbound Parse, or a generic JSON post). */
+    EMAIL_WEBHOOK = "email_webhook"
+}
+/**
+ * Where a connection's credentials live. Never in a plaintext column.
+ *
+ *   ENCRYPTED         entered by the organization, encrypted at rest by clarion-alerts
+ *                     (AES-256-GCM, bound to the connection and the field). Write-only:
+ *                     the API never returns them.
+ *   SECRET_REFERENCE  the NAME of a secret the platform operator provisioned (Secret
+ *                     Manager / environment). How the legacy per-tenant credentials
+ *                     keep working, and the option for an operator who does not want
+ *                     a credential in the database at all.
+ */
+export declare enum AlertIntakeSecretSource {
+    ENCRYPTED = "ENCRYPTED",
+    SECRET_REFERENCE = "SECRET_REFERENCE"
+}
+/**
+ * How the emergency type of an incident raised from a message is decided.
+ * AUTO derives it from the organization: a grievance desk never raises an
+ * emergency; an incident desk decides from the message's category and priority.
+ */
+export declare enum AlertIntakeEmergencyPolicy {
+    AUTO = "AUTO",
+    ALWAYS_EMERGENCY = "ALWAYS_EMERGENCY",
+    ALWAYS_NON_EMERGENCY = "ALWAYS_NON_EMERGENCY"
+}
+/** How a message on a PLATFORM connection finds its organization. */
+export declare enum AlertIntakeRouteMatch {
+    /** The first word of the message, e.g. `G4S fire at ...` on a shared short code. */
+    KEYWORD = "KEYWORD",
+    /** Everything no other route claimed. At most one per connection. */
+    DEFAULT = "DEFAULT"
+}
+/** How a provider proves a webhook call really came from it. */
+export declare enum AlertIntakeWebhookVerification {
+    /** The unguessable URL is the only proof (Africa's Talking signs nothing). */
+    SECRET_URL = "SECRET_URL",
+    /** A shared secret the gateway sends in a header, compared in constant time. */
+    SHARED_SECRET_HEADER = "SHARED_SECRET_HEADER",
+    /** `X-Hub-Signature-256`: HMAC-SHA256 of the raw body with the Meta app secret. */
+    META_SIGNATURE = "META_SIGNATURE"
+}
+/** Why a message that arrived did not become an incident. Stored; shown to operators. */
+export declare enum AlertIntakeRejectionReason {
+    UNKNOWN_CONNECTION = "UNKNOWN_CONNECTION",
+    CONNECTION_DISABLED = "CONNECTION_DISABLED",
+    VERIFICATION_FAILED = "VERIFICATION_FAILED",
+    NO_ORGANIZATION = "NO_ORGANIZATION",
+    ORGANIZATION_INACTIVE = "ORGANIZATION_INACTIVE",
+    RATE_LIMITED = "RATE_LIMITED"
+}

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

@@ -0,0 +1,3 @@
+export * from './enums/alert-intake.enum';
+export * from './interfaces/alert-intake';
+export * from './utils/alert-intake.util';