clarion-shared-types 1.0.97 → 1.0.98

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

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationBrandingSource = exports.NotificationSenderSource = exports.EmailSenderVerificationMethod = exports.EmailSenderVerificationStatus = exports.NotificationSenderStatus = exports.SmsSenderType = void 0;
+/** What kind of identity an SMS is sent from. Decides how the value is validated. */
+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 || (exports.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.
+ */
+var NotificationSenderStatus;
+(function (NotificationSenderStatus) {
+    NotificationSenderStatus["PENDING"] = "PENDING";
+    NotificationSenderStatus["ACTIVE"] = "ACTIVE";
+    NotificationSenderStatus["SUSPENDED"] = "SUSPENDED";
+    NotificationSenderStatus["REJECTED"] = "REJECTED";
+})(NotificationSenderStatus || (exports.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.
+ */
+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 || (exports.EmailSenderVerificationStatus = EmailSenderVerificationStatus = {}));
+/** How the provider recognises the address. */
+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 || (exports.EmailSenderVerificationMethod = EmailSenderVerificationMethod = {}));
+/** Whose identity a message actually went out under. */
+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 || (exports.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.
+ */
+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 || (exports.NotificationBrandingSource = NotificationBrandingSource = {}));
+//# sourceMappingURL=notification-settings.enums.js.map

package/dist/cjs/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,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,6BAAb,aAAa,QASxB;AAED;;;;GAIG;AACH,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAChC,+CAAmB,CAAA;IACnB,6CAAiB,CAAA;IACjB,mDAAuB,CAAA;IACvB,iDAAqB,CAAA;AACzB,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAED;;;;;GAKG;AACH,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,6CAA7B,6BAA6B,QASxC;AAED,+CAA+C;AAC/C,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACrC,uFAAuF;IACvF,gEAA+B,CAAA;IAC/B,0FAA0F;IAC1F,kDAAiB,CAAA;AACrB,CAAC,EALW,6BAA6B,6CAA7B,6BAA6B,QAKxC;AAED,wDAAwD;AACxD,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAChC,yEAAyE;IACzE,yDAA6B,CAAA;IAC7B,qDAAqD;IACrD,iEAAqC,CAAA;AACzC,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAED;;;GAGG;AACH,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,0CAA1B,0BAA0B,QASrC"}

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

@@ -4,11 +4,16 @@ exports.SmsProviderName = void 0;
 /**
  * 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.
  */
 var SmsProviderName;
 (function (SmsProviderName) {
     SmsProviderName["TWILIO"] = "twilio";
     SmsProviderName["UWAZII"] = "uwazii";
     SmsProviderName["AFRICASTALKING"] = "africastalking";
+    SmsProviderName["CELCOM"] = "celcom";
 })(SmsProviderName || (exports.SmsProviderName = SmsProviderName = {}));
 //# sourceMappingURL=sms-provider-name.enum.js.map

package/dist/cjs/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,IAAY,eAIX;AAJD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,oDAAiC,CAAA;AACrC,CAAC,EAJW,eAAe,+BAAf,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,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,oDAAiC,CAAA;IACjC,oCAAiB,CAAA;AACrB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,oEAAkD;AAClD,iEAA+C;AAC/C,mEAAiD;AACjD,2EAAyD;AACzD,uEAAqD;AAErD,4CAA4C;AAC5C,gEAA8C;AAC9C,kEAAgD;AAChD,+DAA6C;AAC7C,iEAA+C;AAC/C,4EAA0D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,oEAAkD;AAClD,iEAA+C;AAC/C,mEAAiD;AACjD,2EAAyD;AACzD,uEAAqD;AACrD,sEAAoD;AAEpD,4CAA4C;AAC5C,gEAA8C;AAC9C,kEAAgD;AAChD,+DAA6C;AAC7C,iEAA+C;AAC/C,4EAA0D;AAE1D,kEAAkE;AAClE,sFAAoE;AAEpE,YAAY;AACZ,mEAAiD"}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=organization-notification-settings.dto.js.map

package/dist/cjs/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/cjs/modules/notification/utils/notification-sender.util.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MIN_ACCENT_COLOUR_CONTRAST = exports.MIN_PRIMARY_COLOUR_CONTRAST = exports.MAX_SMS_SENDERS_PER_ORGANIZATION = exports.MAX_EMAIL_SENDERS_PER_ORGANIZATION = exports.SMS_SENDER_ID_HINTS = exports.SMS_SENDER_ID_PATTERNS = exports.BRAND_COLOUR_PATTERN = void 0;
+exports.validateSmsSenderId = validateSmsSenderId;
+exports.emailDomainOf = emailDomainOf;
+exports.contrastRatioWithWhite = contrastRatioWithWhite;
+exports.darkenHexColour = darkenHexColour;
+const notification_settings_enums_1 = require("../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. */
+exports.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).
+ */
+exports.SMS_SENDER_ID_PATTERNS = Object.freeze({
+    [notification_settings_enums_1.SmsSenderType.ALPHANUMERIC]: /^(?=.*[A-Za-z])[A-Za-z0-9 _.&-]{3,11}$/,
+    [notification_settings_enums_1.SmsSenderType.PHONE_NUMBER]: /^\+[1-9]\d{6,14}$/,
+    [notification_settings_enums_1.SmsSenderType.SHORT_CODE]: /^\d{3,8}$/,
+    [notification_settings_enums_1.SmsSenderType.MESSAGING_SERVICE]: /^MG[0-9a-fA-F]{32}$/,
+});
+/** Human-readable form of {@link SMS_SENDER_ID_PATTERNS}, for validation messages and form hints. */
+exports.SMS_SENDER_ID_HINTS = Object.freeze({
+    [notification_settings_enums_1.SmsSenderType.ALPHANUMERIC]: '3-11 characters (letters, digits, space, _ . & -) with at least one letter, e.g. G4S',
+    [notification_settings_enums_1.SmsSenderType.PHONE_NUMBER]: 'an E.164 number, e.g. +254711000000',
+    [notification_settings_enums_1.SmsSenderType.SHORT_CODE]: '3-8 digits, e.g. 22384',
+    [notification_settings_enums_1.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. */
+exports.MAX_EMAIL_SENDERS_PER_ORGANIZATION = 10;
+exports.MAX_SMS_SENDERS_PER_ORGANIZATION = 30;
+/** Large text and UI components (WCAG 1.4.11): buttons and links in the primary colour. */
+exports.MIN_PRIMARY_COLOUR_CONTRAST = 3;
+/** Body-size white text sits on the accent colour (WCAG 1.4.3). */
+exports.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.
+ */
+function validateSmsSenderId(senderType, senderId) {
+    const pattern = exports.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 ${exports.SMS_SENDER_ID_HINTS[senderType]}`;
+}
+/** The domain part of an email address, lower-cased. Null when there is none. */
+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.
+ */
+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.
+ */
+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/cjs/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":";;;AA6CA,kDAMC;AAGD,sCAKC;AAQD,wDASC;AAOD,0CASC;AA5FD,sFAAqE;AAErE;;;;;GAKG;AAEH,wFAAwF;AAC3E,QAAA,oBAAoB,GAAG,mBAAmB,CAAC;AAExD;;;;GAIG;AACU,QAAA,sBAAsB,GAA4C,MAAM,CAAC,MAAM,CAAC;IACzF,CAAC,2CAAa,CAAC,YAAY,CAAC,EAAE,wCAAwC;IACtE,CAAC,2CAAa,CAAC,YAAY,CAAC,EAAE,mBAAmB;IACjD,CAAC,2CAAa,CAAC,UAAU,CAAC,EAAE,WAAW;IACvC,CAAC,2CAAa,CAAC,iBAAiB,CAAC,EAAE,qBAAqB;CAC3D,CAAC,CAAC;AAEH,qGAAqG;AACxF,QAAA,mBAAmB,GAA4C,MAAM,CAAC,MAAM,CAAC;IACtF,CAAC,2CAAa,CAAC,YAAY,CAAC,EAAE,sFAAsF;IACpH,CAAC,2CAAa,CAAC,YAAY,CAAC,EAAE,qCAAqC;IACnE,CAAC,2CAAa,CAAC,UAAU,CAAC,EAAE,wBAAwB;IACpD,CAAC,2CAAa,CAAC,iBAAiB,CAAC,EAAE,mEAAmE;CACzG,CAAC,CAAC;AAEH,qGAAqG;AACxF,QAAA,kCAAkC,GAAG,EAAE,CAAC;AACxC,QAAA,gCAAgC,GAAG,EAAE,CAAC;AAEnD,2FAA2F;AAC9E,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAC7C,mEAAmE;AACtD,QAAA,0BAA0B,GAAG,GAAG,CAAC;AAE9C;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,UAAyB,EAAE,QAAgB;IAC3E,MAAM,OAAO,GAAG,8BAAsB,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,2BAAmB,CAAC,UAAU,CAAC,EAAE,CAAC;AAC5G,CAAC;AAED,iFAAiF;AACjF,SAAgB,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,SAAgB,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,SAAgB,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/cjs/modules/permission/enums/permission-actions.enum.js

@@ -109,5 +109,14 @@ 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";
 })(PermissionActions || (exports.PermissionActions = PermissionActions = {}));
 //# sourceMappingURL=permission-actions.enum.js.map

package/dist/cjs/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,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,iCAAjB,iBAAiB,QAmH5B"}
+{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBA6HX;AA7HD,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;AAC/D,CAAC,EA7HW,iBAAiB,iCAAjB,iBAAiB,QA6H5B"}

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

@@ -13,5 +13,6 @@ var PermissionsModule;
     PermissionsModule["RESPONSE_UNIT"] = "Response Unit";
     PermissionsModule["TRACKING"] = "Tracking";
     PermissionsModule["SUPPORT"] = "Support";
+    PermissionsModule["NOTIFICATION"] = "Notification";
 })(PermissionsModule || (exports.PermissionsModule = PermissionsModule = {}));
 //# sourceMappingURL=permissions-moudule.enum.js.map

package/dist/cjs/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,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,iCAAjB,iBAAiB,QAW5B"}
+{"version":3,"file":"permissions-moudule.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permissions-moudule.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAYX;AAZD,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;AACjC,CAAC,EAZW,iBAAiB,iCAAjB,iBAAiB,QAY5B"}

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,14 @@ 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";
 })(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,iBA6HX;AA7HD,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;AAC/D,CAAC,EA7HW,iBAAiB,KAAjB,iBAAiB,QA6H5B"}

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

@@ -10,5 +10,6 @@ export var PermissionsModule;
     PermissionsModule["RESPONSE_UNIT"] = "Response Unit";
     PermissionsModule["TRACKING"] = "Tracking";
     PermissionsModule["SUPPORT"] = "Support";
+    PermissionsModule["NOTIFICATION"] = "Notification";
 })(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,iBAYX;AAZD,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;AACjC,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B"}

package/dist/types/modules/notification/enums/notification-settings.enums.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 declare enum SmsSenderType {
+    /** A registered alphanumeric sender name, e.g. `G4S`. At most 11 characters. */
+    ALPHANUMERIC = "ALPHANUMERIC",
+    /** An E.164 long number, e.g. `+254711000000`. */
+    PHONE_NUMBER = "PHONE_NUMBER",
+    /** A telco short code, e.g. `22384`. */
+    SHORT_CODE = "SHORT_CODE",
+    /** A provider-side sender pool (Twilio Messaging Service SID, `MG...`). */
+    MESSAGING_SERVICE = "MESSAGING_SERVICE"
+}
+/**
+ * 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 declare enum NotificationSenderStatus {
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    SUSPENDED = "SUSPENDED",
+    REJECTED = "REJECTED"
+}
+/**
+ * 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 declare enum EmailSenderVerificationStatus {
+    /** The provider does not know this address or its domain. */
+    UNVERIFIED = "UNVERIFIED",
+    /** Verification was started and is waiting on the owner (inbox click or DNS records). */
+    PENDING = "PENDING",
+    /** The provider accepts mail from this address. */
+    VERIFIED = "VERIFIED",
+    /** The last check could not be completed (provider error). */
+    FAILED = "FAILED"
+}
+/** How the provider recognises the address. */
+export declare enum EmailSenderVerificationMethod {
+    /** The exact address was verified on its own (SendGrid Single Sender Verification). */
+    SINGLE_SENDER = "SINGLE_SENDER",
+    /** The whole domain is authenticated (SendGrid domain authentication, Mailgun domain). */
+    DOMAIN = "DOMAIN"
+}
+/** Whose identity a message actually went out under. */
+export declare enum NotificationSenderSource {
+    /** The organization's own verified email address / active SMS sender. */
+    ORGANIZATION = "ORGANIZATION",
+    /** The platform's default (country-aware) sender. */
+    PLATFORM_DEFAULT = "PLATFORM_DEFAULT"
+}
+/**
+ * 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 declare enum NotificationBrandingSource {
+    /** The organization's notification settings. */
+    PROFILE = "PROFILE",
+    /** The organization record (clarion-organization). */
+    ORGANIZATION = "ORGANIZATION",
+    /** The legacy per-app defaults (deprecated). */
+    APP_DEFAULT = "APP_DEFAULT",
+    /** The platform's own branding. */
+    PLATFORM_DEFAULT = "PLATFORM_DEFAULT"
+}

package/dist/types/modules/notification/enums/sms-provider-name.enum.d.ts

@@ -1,9 +1,14 @@
 /**
  * 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 declare enum SmsProviderName {
     TWILIO = "twilio",
     UWAZII = "uwazii",
-    AFRICASTALKING = "africastalking"
+    AFRICASTALKING = "africastalking",
+    CELCOM = "celcom"
 }

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

@@ -3,8 +3,11 @@ 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';
 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';
+export * from './interfaces/organization-notification-settings.dto';
+export * from './utils/notification-sender.util';

package/dist/types/modules/notification/interfaces/organization-notification-settings.dto.d.ts

@@ -0,0 +1,213 @@
+import { CountryCode } from '../../country/enums/country-code.enum';
+import { IncidentAppId } from '../../incident/enums/incident-app-id.enum';
+import { EmailProviderName } from '../enums/email-provider-name.enum';
+import { EmailSenderVerificationMethod, EmailSenderVerificationStatus, NotificationBrandingSource, NotificationSenderSource, NotificationSenderStatus, SmsSenderType } from '../enums/notification-settings.enums';
+import { SmsProviderName } from '../enums/sms-provider-name.enum';
+/**
+ * Organization notification settings: what a customer sees in a notification - the
+ * logo and colours of an email, the address it came from, the name an SMS arrives
+ * under. `organizationId` is the single key; the legacy `appId` survives only as an
+ * alias for events that still carry nothing but an app id.
+ *
+ * MIRRORS grm-shared-library (`modules/notification/interfaces` and `dtos`). The
+ * response shapes are interfaces on both sides; the request shapes are class-validator
+ * DTOs on the backend and plain interfaces here. Owned by clarion-notification,
+ * proxied by the gateway, rendered by the admin. Nothing here is a secret.
+ */
+export interface NotificationSocialLinks {
+    facebook?: string | null;
+    x?: string | null;
+    instagram?: string | null;
+    linkedin?: string | null;
+}
+/** The values a notification template can brand itself with. */
+export interface NotificationBrandingFields {
+    /** Legal/trading name shown in the footer, e.g. `G4S Kenya Ltd`. */
+    companyName: string;
+    /** Product name the customer knows, e.g. `G4S Kenya`. Used in subjects and sign-offs. */
+    appName: string;
+    /** HTTPS URL of the logo. Email clients will not load anything else. */
+    logoUrl: string;
+    /** `#RRGGBB`. Buttons, links and accents. */
+    primaryColour: string;
+    /** `#RRGGBB`. Hover/pressed shade; derived from the primary when not chosen. */
+    primaryColourDark: string;
+    /** `#RRGGBB`. Header banner and footer background. */
+    accentColour: string;
+    physicalAddress: string;
+    phoneNumber: string;
+    /** General contact address printed in the footer. Not the address mail is sent FROM. */
+    contactEmail: string;
+    supportEmail: string;
+    websiteUrl: string;
+    /** Base URL that links in a notification point at (the organization's web client). */
+    clientBaseUrl: string;
+    social: NotificationSocialLinks;
+}
+/** What an organization has chosen to override. Every field is optional: gaps are resolved, not rejected. */
+export interface OrganizationNotificationBranding extends Partial<NotificationBrandingFields> {
+    organizationId: number;
+    /** Legacy alias: an appId-only event resolves to the organization that claims it. */
+    appId?: string | null;
+    createdAt?: string;
+    updatedAt?: string;
+    updatedBy?: number | null;
+}
+/** Branding after resolution: complete, and honest about where each value came from. */
+export interface ResolvedNotificationBranding extends NotificationBrandingFields {
+    organizationId: number | null;
+    sources: Record<keyof NotificationBrandingFields, NotificationBrandingSource>;
+}
+/** One provider's answer to "will you send mail from this address?". */
+export interface EmailSenderProviderVerification {
+    provider: EmailProviderName;
+    status: EmailSenderVerificationStatus;
+    method?: EmailSenderVerificationMethod | null;
+    /** Operator-facing explanation, e.g. "Domain ke.g4s.com is not added to Mailgun". */
+    detail?: string | null;
+    checkedAt?: string | null;
+}
+export interface OrganizationEmailSender {
+    id: string;
+    organizationId: number;
+    /** The address mail is sent FROM, e.g. `notifications@ke.g4s.com`. */
+    fromEmail: string;
+    /** Display name. Falls back to the resolved company name. */
+    fromName?: string | null;
+    /** Falls back to `fromEmail`. */
+    replyTo?: string | null;
+    /** The sender used when a notification does not ask for a specific one. One per organization. */
+    isDefault: boolean;
+    active: boolean;
+    verifications: EmailSenderProviderVerification[];
+    /** True when at least one configured provider has VERIFIED the address. */
+    usable: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface OrganizationSmsSender {
+    id: string;
+    organizationId: number;
+    /** The provider account this sender is registered with. */
+    provider: SmsProviderName;
+    /** The destination country it is registered for. Null = every country the provider serves. */
+    countryCode?: CountryCode | null;
+    senderType: SmsSenderType;
+    senderId: string;
+    status: NotificationSenderStatus;
+    /** Registration reference, telco ticket, anything the operator needs later. */
+    notes?: string | null;
+    reviewedBy?: number | null;
+    reviewedAt?: string | null;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/** A sender type a provider accepts, with everything a form needs to collect it. */
+export interface SmsProviderSenderTypeDescriptor {
+    type: SmsSenderType;
+    label: string;
+    placeholder?: string;
+    description?: string;
+}
+/**
+ * Self-description of an SMS provider, published by clarion-notification. Adding a
+ * provider (Celcom, Africa's Talking, ...) changes no client code. Only providers
+ * with a registered adapter are described.
+ */
+export interface SmsProviderDescriptor {
+    provider: SmsProviderName;
+    displayName: string;
+    description: string;
+    /** Countries the adapter can deliver to. */
+    supportedCountries: CountryCode[];
+    senderTypes: SmsProviderSenderTypeDescriptor[];
+    /** Whether the platform's account for this provider is configured and enabled right now. */
+    configured: boolean;
+    documentationUrl?: string;
+}
+/** The platform senders an organization falls back to. Display-only. */
+export interface PlatformNotificationDefaults {
+    email: {
+        fromEmail: string | null;
+        fromName: string | null;
+    };
+    /** Per-country default SMS provider chain, e.g. `{ KE: ['twilio', 'uwazii'] }`. */
+    smsProviderChains: Partial<Record<CountryCode, SmsProviderName[]>>;
+    /** Email providers currently able to send, in order. */
+    emailProviders: EmailProviderName[];
+}
+/** Everything the settings page needs, in one read. */
+export interface OrganizationNotificationSettings {
+    organizationId: number;
+    /** Null until the organization saves a profile. */
+    branding: OrganizationNotificationBranding | null;
+    effectiveBranding: ResolvedNotificationBranding;
+    emailSenders: OrganizationEmailSender[];
+    smsSenders: OrganizationSmsSender[];
+    platformDefaults: PlatformNotificationDefaults;
+}
+/**
+ * Saves an organization's branding. A field sent as null (or "") stops overriding
+ * and inherits again; a field left out is untouched.
+ */
+export interface UpsertOrganizationNotificationBranding {
+    /** Super-admin only. */
+    appId?: IncidentAppId | null;
+    companyName?: string | null;
+    appName?: string | null;
+    /** HTTPS only. */
+    logoUrl?: string | null;
+    primaryColour?: string | null;
+    primaryColourDark?: string | null;
+    accentColour?: string | null;
+    physicalAddress?: string | null;
+    phoneNumber?: string | null;
+    contactEmail?: string | null;
+    supportEmail?: string | null;
+    websiteUrl?: string | null;
+    clientBaseUrl?: string | null;
+    social?: NotificationSocialLinks | null;
+}
+export interface CreateOrganizationEmailSender {
+    fromEmail: string;
+    fromName?: string | null;
+    replyTo?: string | null;
+    isDefault?: boolean;
+}
+export interface UpdateOrganizationEmailSender {
+    fromName?: string | null;
+    replyTo?: string | null;
+    isDefault?: boolean;
+    active?: boolean;
+}
+export interface CreateOrganizationSmsSender {
+    provider: SmsProviderName;
+    countryCode?: CountryCode | null;
+    senderType: SmsSenderType;
+    senderId: string;
+    notes?: string | null;
+}
+export interface UpdateOrganizationSmsSender {
+    countryCode?: CountryCode | null;
+    senderType?: SmsSenderType;
+    /** Changing the value sends the sender back to PENDING. */
+    senderId?: string;
+    notes?: string | null;
+}
+/** Platform operators only. */
+export interface ReviewOrganizationSmsSender {
+    status: NotificationSenderStatus;
+    notes?: string | null;
+}
+export interface SendTestNotificationEmail {
+    to: string;
+}
+/** What the test-email endpoint answers with. */
+export interface TestNotificationEmailResult {
+    success: boolean;
+    provider: string | null;
+    /** The address the email actually went out from. */
+    sender: string | null;
+    senderSource: NotificationSenderSource | null;
+    errorMessage: string | null;
+}

package/dist/types/modules/notification/utils/notification-sender.util.d.ts

@@ -0,0 +1,44 @@
+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 declare const BRAND_COLOUR_PATTERN: RegExp;
+/**
+ * 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 declare const SMS_SENDER_ID_PATTERNS: Readonly<Record<SmsSenderType, RegExp>>;
+/** Human-readable form of {@link SMS_SENDER_ID_PATTERNS}, for validation messages and form hints. */
+export declare const SMS_SENDER_ID_HINTS: Readonly<Record<SmsSenderType, string>>;
+/** Upper bounds that keep one organization from turning its settings into a list to page through. */
+export declare const MAX_EMAIL_SENDERS_PER_ORGANIZATION = 10;
+export declare const MAX_SMS_SENDERS_PER_ORGANIZATION = 30;
+/** Large text and UI components (WCAG 1.4.11): buttons and links in the primary colour. */
+export declare const MIN_PRIMARY_COLOUR_CONTRAST = 3;
+/** Body-size white text sits on the accent colour (WCAG 1.4.3). */
+export declare 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 declare function validateSmsSenderId(senderType: SmsSenderType, senderId: string): string | null;
+/** The domain part of an email address, lower-cased. Null when there is none. */
+export declare function emailDomainOf(address: string | null | undefined): string | null;
+/**
+ * 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 declare function contrastRatioWithWhite(hex: string): number;
+/**
+ * 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 declare function darkenHexColour(hex: string, fraction?: number): string;

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

@@ -81,5 +81,8 @@ export declare enum PermissionActions {
     MANAGE_SUPPORT_CONFIGURATION = "manage:support-configuration",
     READ_SUPPORT_REPORT = "read:support-report",
     READ_SUPPORT_SYNC = "read:support-sync",
-    MANAGE_SUPPORT_SYNC = "manage:support-sync"
+    MANAGE_SUPPORT_SYNC = "manage:support-sync",
+    READ_NOTIFICATION_SETTINGS = "read:notification-settings",
+    MANAGE_NOTIFICATION_SETTINGS = "manage:notification-settings",
+    APPROVE_NOTIFICATION_SENDER = "approve:notification-sender"
 }

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

@@ -8,5 +8,6 @@ export declare enum PermissionsModule {
     INCIDENT = "Grievance",
     RESPONSE_UNIT = "Response Unit",
     TRACKING = "Tracking",
-    SUPPORT = "Support"
+    SUPPORT = "Support",
+    NOTIFICATION = "Notification"
 }

package/package.json

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