clarion-shared-types 1.0.74 → 1.0.76

package/dist/cjs/index.js

@@ -30,6 +30,7 @@ __exportStar(require("./modules/sms/index"), exports);
 __exportStar(require("./modules/gis/index"), exports);
 __exportStar(require("./modules/socket/index"), exports);
 __exportStar(require("./modules/web-notification/index"), exports);
+__exportStar(require("./modules/notification/index"), exports);
 __exportStar(require("./modules/chat/index"), exports);
 // Interfaces
 __exportStar(require("./modules/common/interfaces/server-message"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,UAAU;AACV,uDAAqC;AACrC,+DAA6C;AAC7C,yDAAuC;AACvC,6DAA2C;AAC3C,uDAAqC;AACrC,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,2DAAyC;AACzC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,mEAAiD;AACjD,uDAAqC;AAErC,aAAa;AACb,6EAA2D;AAC3D,yEAAuD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,UAAU;AACV,uDAAqC;AACrC,+DAA6C;AAC7C,yDAAuC;AACvC,6DAA2C;AAC3C,uDAAqC;AACrC,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,2DAAyC;AACzC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,mEAAiD;AACjD,+DAA6C;AAC7C,uDAAqC;AAErC,aAAa;AACb,6EAA2D;AAC3D,yEAAuD"}

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailProviderName = void 0;
+/**
+ * Identifiers for the email providers the notification service can dispatch through.
+ * TWILIO_SENDGRID is the Twilio email provider (SendGrid API).
+ * Provider order/fallback is configuration-driven; new providers can be appended.
+ */
+var EmailProviderName;
+(function (EmailProviderName) {
+    EmailProviderName["TWILIO_SENDGRID"] = "twilio_sendgrid";
+    EmailProviderName["MAILGUN"] = "mailgun";
+    EmailProviderName["SES"] = "ses";
+})(EmailProviderName || (exports.EmailProviderName = EmailProviderName = {}));
+//# sourceMappingURL=email-provider-name.enum.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email-provider-name.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/email-provider-name.enum.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,wDAAmC,CAAA;IACnC,wCAAmB,CAAA;IACnB,gCAAW,CAAA;AACf,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}

package/dist/cjs/modules/notification/enums/notification-channel.enum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationChannel = void 0;
+/**
+ * Delivery channels supported by the clarion-notification service.
+ * Used to key per-channel dispatch results.
+ */
+var NotificationChannel;
+(function (NotificationChannel) {
+    NotificationChannel["SMS"] = "SMS";
+    NotificationChannel["EMAIL"] = "EMAIL";
+    NotificationChannel["PUSH"] = "PUSH";
+    NotificationChannel["WEB"] = "WEB";
+})(NotificationChannel || (exports.NotificationChannel = NotificationChannel = {}));
+//# sourceMappingURL=notification-channel.enum.js.map

package/dist/cjs/modules/notification/enums/notification-channel.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-channel.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/notification-channel.enum.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,sCAAe,CAAA;IACf,oCAAa,CAAA;IACb,kCAAW,CAAA;AACf,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B"}

package/dist/cjs/modules/notification/enums/notification-overall-status.enum.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationOverallStatus = void 0;
+/**
+ * Aggregate status for a multi-channel notification dispatch.
+ * - SUCCESS: every attempted channel succeeded.
+ * - PARTIAL_SUCCESS: at least one channel succeeded and at least one failed.
+ * - FAILED: no attempted channel succeeded.
+ */
+var NotificationOverallStatus;
+(function (NotificationOverallStatus) {
+    NotificationOverallStatus["SUCCESS"] = "SUCCESS";
+    NotificationOverallStatus["PARTIAL_SUCCESS"] = "PARTIAL_SUCCESS";
+    NotificationOverallStatus["FAILED"] = "FAILED";
+})(NotificationOverallStatus || (exports.NotificationOverallStatus = NotificationOverallStatus = {}));
+//# sourceMappingURL=notification-overall-status.enum.js.map

package/dist/cjs/modules/notification/enums/notification-overall-status.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-overall-status.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/notification-overall-status.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACjC,gDAAmB,CAAA;IACnB,gEAAmC,CAAA;IACnC,8CAAiB,CAAA;AACrB,CAAC,EAJW,yBAAyB,yCAAzB,yBAAyB,QAIpC"}

package/dist/cjs/modules/notification/enums/provider-failure-reason.enum.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProviderFailureReason = void 0;
+/**
+ * Normalized classification of why a provider attempt failed.
+ * Drives fallback behaviour: VALIDATION / CONFIG_MISSING are non-retryable
+ * (no fallback), the remainder are provider-level failures that trigger fallback.
+ */
+var ProviderFailureReason;
+(function (ProviderFailureReason) {
+    /** Malformed/invalid request (bad recipient, missing body/subject). Do not fall back. */
+    ProviderFailureReason["VALIDATION"] = "VALIDATION";
+    /** Provider is not configured/enabled. Skip provider (try next), not a send failure. */
+    ProviderFailureReason["CONFIG_MISSING"] = "CONFIG_MISSING";
+    /** Authentication/authorization failure with the provider. */
+    ProviderFailureReason["AUTH"] = "AUTH";
+    /** Provider rate limited the request. */
+    ProviderFailureReason["RATE_LIMIT"] = "RATE_LIMIT";
+    /** Request timed out. */
+    ProviderFailureReason["TIMEOUT"] = "TIMEOUT";
+    /** Network/connection error reaching the provider. */
+    ProviderFailureReason["NETWORK"] = "NETWORK";
+    /** Provider returned a server-side/processing error. */
+    ProviderFailureReason["PROVIDER_ERROR"] = "PROVIDER_ERROR";
+    /** Unclassified failure. */
+    ProviderFailureReason["UNKNOWN"] = "UNKNOWN";
+})(ProviderFailureReason || (exports.ProviderFailureReason = ProviderFailureReason = {}));
+//# sourceMappingURL=provider-failure-reason.enum.js.map

package/dist/cjs/modules/notification/enums/provider-failure-reason.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider-failure-reason.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/provider-failure-reason.enum.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,qBAiBX;AAjBD,WAAY,qBAAqB;IAC7B,yFAAyF;IACzF,kDAAyB,CAAA;IACzB,wFAAwF;IACxF,0DAAiC,CAAA;IACjC,8DAA8D;IAC9D,sCAAa,CAAA;IACb,yCAAyC;IACzC,kDAAyB,CAAA;IACzB,yBAAyB;IACzB,4CAAmB,CAAA;IACnB,sDAAsD;IACtD,4CAAmB,CAAA;IACnB,wDAAwD;IACxD,0DAAiC,CAAA;IACjC,4BAA4B;IAC5B,4CAAmB,CAAA;AACvB,CAAC,EAjBW,qBAAqB,qCAArB,qBAAqB,QAiBhC"}

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ */
+var SmsProviderName;
+(function (SmsProviderName) {
+    SmsProviderName["TWILIO"] = "twilio";
+    SmsProviderName["UWAZII"] = "uwazii";
+    SmsProviderName["AFRICASTALKING"] = "africastalking";
+})(SmsProviderName || (exports.SmsProviderName = SmsProviderName = {}));
+//# sourceMappingURL=sms-provider-name.enum.js.map

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

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

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

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Enums
+__exportStar(require("./enums/notification-channel.enum"), exports);
+__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);
+// 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);
+//# sourceMappingURL=index.js.map

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

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

package/dist/cjs/modules/notification/interfaces/email-send-result.js

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

package/dist/cjs/modules/notification/interfaces/email-send-result.js.map

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

package/dist/cjs/modules/notification/interfaces/notification-dispatch-result.js

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

package/dist/cjs/modules/notification/interfaces/notification-dispatch-result.js.map

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

package/dist/cjs/modules/notification/interfaces/per-channel-result.js

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

package/dist/cjs/modules/notification/interfaces/per-channel-result.js.map

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

package/dist/cjs/modules/notification/interfaces/provider-attempt.js

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

package/dist/cjs/modules/notification/interfaces/provider-attempt.js.map

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

package/dist/cjs/modules/notification/interfaces/sms-send-result.js

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

package/dist/cjs/modules/notification/interfaces/sms-send-result.js.map

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

package/dist/esm/index.js

@@ -14,6 +14,7 @@ export * from './modules/sms/index';
 export * from './modules/gis/index';
 export * from './modules/socket/index';
 export * from './modules/web-notification/index';
+export * from './modules/notification/index';
 export * from './modules/chat/index';
 // Interfaces
 export * from './modules/common/interfaces/server-message';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,UAAU;AACV,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,sBAAsB,CAAC;AAErC,aAAa;AACb,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,UAAU;AACV,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AAErC,aAAa;AACb,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC"}

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

@@ -0,0 +1,12 @@
+/**
+ * Identifiers for the email providers the notification service can dispatch through.
+ * TWILIO_SENDGRID is the Twilio email provider (SendGrid API).
+ * Provider order/fallback is configuration-driven; new providers can be appended.
+ */
+export var EmailProviderName;
+(function (EmailProviderName) {
+    EmailProviderName["TWILIO_SENDGRID"] = "twilio_sendgrid";
+    EmailProviderName["MAILGUN"] = "mailgun";
+    EmailProviderName["SES"] = "ses";
+})(EmailProviderName || (EmailProviderName = {}));
+//# sourceMappingURL=email-provider-name.enum.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email-provider-name.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/email-provider-name.enum.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,wDAAmC,CAAA;IACnC,wCAAmB,CAAA;IACnB,gCAAW,CAAA;AACf,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B"}

package/dist/esm/modules/notification/enums/notification-channel.enum.js

@@ -0,0 +1,12 @@
+/**
+ * Delivery channels supported by the clarion-notification service.
+ * Used to key per-channel dispatch results.
+ */
+export var NotificationChannel;
+(function (NotificationChannel) {
+    NotificationChannel["SMS"] = "SMS";
+    NotificationChannel["EMAIL"] = "EMAIL";
+    NotificationChannel["PUSH"] = "PUSH";
+    NotificationChannel["WEB"] = "WEB";
+})(NotificationChannel || (NotificationChannel = {}));
+//# sourceMappingURL=notification-channel.enum.js.map

package/dist/esm/modules/notification/enums/notification-channel.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-channel.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/notification-channel.enum.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,sCAAe,CAAA;IACf,oCAAa,CAAA;IACb,kCAAW,CAAA;AACf,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B"}

package/dist/esm/modules/notification/enums/notification-overall-status.enum.js

@@ -0,0 +1,13 @@
+/**
+ * Aggregate status for a multi-channel notification dispatch.
+ * - SUCCESS: every attempted channel succeeded.
+ * - PARTIAL_SUCCESS: at least one channel succeeded and at least one failed.
+ * - FAILED: no attempted channel succeeded.
+ */
+export var NotificationOverallStatus;
+(function (NotificationOverallStatus) {
+    NotificationOverallStatus["SUCCESS"] = "SUCCESS";
+    NotificationOverallStatus["PARTIAL_SUCCESS"] = "PARTIAL_SUCCESS";
+    NotificationOverallStatus["FAILED"] = "FAILED";
+})(NotificationOverallStatus || (NotificationOverallStatus = {}));
+//# sourceMappingURL=notification-overall-status.enum.js.map

package/dist/esm/modules/notification/enums/notification-overall-status.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-overall-status.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/notification-overall-status.enum.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACjC,gDAAmB,CAAA;IACnB,gEAAmC,CAAA;IACnC,8CAAiB,CAAA;AACrB,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC"}

package/dist/esm/modules/notification/enums/provider-failure-reason.enum.js

@@ -0,0 +1,25 @@
+/**
+ * Normalized classification of why a provider attempt failed.
+ * Drives fallback behaviour: VALIDATION / CONFIG_MISSING are non-retryable
+ * (no fallback), the remainder are provider-level failures that trigger fallback.
+ */
+export var ProviderFailureReason;
+(function (ProviderFailureReason) {
+    /** Malformed/invalid request (bad recipient, missing body/subject). Do not fall back. */
+    ProviderFailureReason["VALIDATION"] = "VALIDATION";
+    /** Provider is not configured/enabled. Skip provider (try next), not a send failure. */
+    ProviderFailureReason["CONFIG_MISSING"] = "CONFIG_MISSING";
+    /** Authentication/authorization failure with the provider. */
+    ProviderFailureReason["AUTH"] = "AUTH";
+    /** Provider rate limited the request. */
+    ProviderFailureReason["RATE_LIMIT"] = "RATE_LIMIT";
+    /** Request timed out. */
+    ProviderFailureReason["TIMEOUT"] = "TIMEOUT";
+    /** Network/connection error reaching the provider. */
+    ProviderFailureReason["NETWORK"] = "NETWORK";
+    /** Provider returned a server-side/processing error. */
+    ProviderFailureReason["PROVIDER_ERROR"] = "PROVIDER_ERROR";
+    /** Unclassified failure. */
+    ProviderFailureReason["UNKNOWN"] = "UNKNOWN";
+})(ProviderFailureReason || (ProviderFailureReason = {}));
+//# sourceMappingURL=provider-failure-reason.enum.js.map

package/dist/esm/modules/notification/enums/provider-failure-reason.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider-failure-reason.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/provider-failure-reason.enum.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAN,IAAY,qBAiBX;AAjBD,WAAY,qBAAqB;IAC7B,yFAAyF;IACzF,kDAAyB,CAAA;IACzB,wFAAwF;IACxF,0DAAiC,CAAA;IACjC,8DAA8D;IAC9D,sCAAa,CAAA;IACb,yCAAyC;IACzC,kDAAyB,CAAA;IACzB,yBAAyB;IACzB,4CAAmB,CAAA;IACnB,sDAAsD;IACtD,4CAAmB,CAAA;IACnB,wDAAwD;IACxD,0DAAiC,CAAA;IACjC,4BAA4B;IAC5B,4CAAmB,CAAA;AACvB,CAAC,EAjBW,qBAAqB,KAArB,qBAAqB,QAiBhC"}

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

@@ -0,0 +1,11 @@
+/**
+ * Identifiers for the SMS providers the notification service can dispatch through.
+ * Provider order/fallback is configuration-driven; new providers can be appended.
+ */
+export var SmsProviderName;
+(function (SmsProviderName) {
+    SmsProviderName["TWILIO"] = "twilio";
+    SmsProviderName["UWAZII"] = "uwazii";
+    SmsProviderName["AFRICASTALKING"] = "africastalking";
+})(SmsProviderName || (SmsProviderName = {}));
+//# sourceMappingURL=sms-provider-name.enum.js.map

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

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

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

@@ -0,0 +1,13 @@
+// Enums
+export * from './enums/notification-channel.enum';
+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';
+// 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';
+//# sourceMappingURL=index.js.map

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

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

package/dist/esm/modules/notification/interfaces/email-send-result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=email-send-result.js.map

package/dist/esm/modules/notification/interfaces/email-send-result.js.map

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

package/dist/esm/modules/notification/interfaces/notification-dispatch-result.js

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

package/dist/esm/modules/notification/interfaces/notification-dispatch-result.js.map

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

package/dist/esm/modules/notification/interfaces/per-channel-result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=per-channel-result.js.map

package/dist/esm/modules/notification/interfaces/per-channel-result.js.map

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

package/dist/esm/modules/notification/interfaces/provider-attempt.js

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

package/dist/esm/modules/notification/interfaces/provider-attempt.js.map

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

package/dist/esm/modules/notification/interfaces/sms-send-result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sms-send-result.js.map

package/dist/esm/modules/notification/interfaces/sms-send-result.js.map

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

package/dist/types/index.d.ts

@@ -13,6 +13,7 @@ export * from './modules/sms/index';
 export * from './modules/gis/index';
 export * from './modules/socket/index';
 export * from './modules/web-notification/index';
+export * from './modules/notification/index';
 export * from './modules/chat/index';
 export * from './modules/common/interfaces/server-message';
 export * from './modules/common/interfaces/pagination';

package/dist/types/modules/incident/intefaces/incident.d.ts

@@ -32,6 +32,7 @@ export interface Incident {
     location?: MapLocation;
     physicalAddress?: string;
     audioRecordingUrl?: string;
+    audioRecordingId?: number;
     conversationId?: string;
     creatorId?: number;
     assigneeIds?: number[];

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

@@ -0,0 +1,10 @@
+/**
+ * Identifiers for the email providers the notification service can dispatch through.
+ * TWILIO_SENDGRID is the Twilio email provider (SendGrid API).
+ * Provider order/fallback is configuration-driven; new providers can be appended.
+ */
+export declare enum EmailProviderName {
+    TWILIO_SENDGRID = "twilio_sendgrid",
+    MAILGUN = "mailgun",
+    SES = "ses"
+}

package/dist/types/modules/notification/enums/notification-channel.enum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Delivery channels supported by the clarion-notification service.
+ * Used to key per-channel dispatch results.
+ */
+export declare enum NotificationChannel {
+    SMS = "SMS",
+    EMAIL = "EMAIL",
+    PUSH = "PUSH",
+    WEB = "WEB"
+}

package/dist/types/modules/notification/enums/notification-overall-status.enum.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Aggregate status for a multi-channel notification dispatch.
+ * - SUCCESS: every attempted channel succeeded.
+ * - PARTIAL_SUCCESS: at least one channel succeeded and at least one failed.
+ * - FAILED: no attempted channel succeeded.
+ */
+export declare enum NotificationOverallStatus {
+    SUCCESS = "SUCCESS",
+    PARTIAL_SUCCESS = "PARTIAL_SUCCESS",
+    FAILED = "FAILED"
+}

package/dist/types/modules/notification/enums/provider-failure-reason.enum.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Normalized classification of why a provider attempt failed.
+ * Drives fallback behaviour: VALIDATION / CONFIG_MISSING are non-retryable
+ * (no fallback), the remainder are provider-level failures that trigger fallback.
+ */
+export declare enum ProviderFailureReason {
+    /** Malformed/invalid request (bad recipient, missing body/subject). Do not fall back. */
+    VALIDATION = "VALIDATION",
+    /** Provider is not configured/enabled. Skip provider (try next), not a send failure. */
+    CONFIG_MISSING = "CONFIG_MISSING",
+    /** Authentication/authorization failure with the provider. */
+    AUTH = "AUTH",
+    /** Provider rate limited the request. */
+    RATE_LIMIT = "RATE_LIMIT",
+    /** Request timed out. */
+    TIMEOUT = "TIMEOUT",
+    /** Network/connection error reaching the provider. */
+    NETWORK = "NETWORK",
+    /** Provider returned a server-side/processing error. */
+    PROVIDER_ERROR = "PROVIDER_ERROR",
+    /** Unclassified failure. */
+    UNKNOWN = "UNKNOWN"
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Identifiers for the SMS providers the notification service can dispatch through.
+ * Provider order/fallback is configuration-driven; new providers can be appended.
+ */
+export declare enum SmsProviderName {
+    TWILIO = "twilio",
+    UWAZII = "uwazii",
+    AFRICASTALKING = "africastalking"
+}

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

@@ -0,0 +1,10 @@
+export * from './enums/notification-channel.enum';
+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 './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';

package/dist/types/modules/notification/interfaces/email-send-result.d.ts

@@ -0,0 +1,22 @@
+import { NotificationChannel } from '../enums/notification-channel.enum';
+import { EmailProviderName } from '../enums/email-provider-name.enum';
+import { ProviderFailureReason } from '../enums/provider-failure-reason.enum';
+import { ProviderAttempt } from './provider-attempt';
+/**
+ * Normalized result of an email send across the configured provider chain.
+ */
+export interface EmailSendResult {
+    channel: NotificationChannel.EMAIL;
+    success: boolean;
+    /** Provider that ultimately succeeded. */
+    provider?: EmailProviderName | string;
+    /** Normalized provider message/reference id. */
+    messageId?: string;
+    /** Recipients targeted. */
+    to?: string[];
+    /** Ordered attempts (primary first, then fallbacks). */
+    attempts: ProviderAttempt[];
+    failureReason?: ProviderFailureReason;
+    /** Internal, safe-to-log error summary. */
+    errorMessage?: string;
+}

package/dist/types/modules/notification/interfaces/notification-dispatch-result.d.ts

@@ -0,0 +1,26 @@
+import { NotificationChannel } from '../enums/notification-channel.enum';
+import { NotificationOverallStatus } from '../enums/notification-overall-status.enum';
+import { PerChannelResult } from './per-channel-result';
+import { ProviderAttempt } from './provider-attempt';
+/**
+ * Aggregate outcome of a multi-channel notification dispatch.
+ *
+ * NOTE: In the current architecture most dispatches are triggered by fire-and-forget
+ * Kafka events, so this object is produced for internal logging/persistence and
+ * observability rather than being returned synchronously to the original API caller.
+ * It is display-safe (no secrets) and can back a future synchronous notification
+ * endpoint or an admin-facing view.
+ */
+export interface NotificationDispatchResult {
+    overallStatus: NotificationOverallStatus;
+    successfulChannels: NotificationChannel[];
+    failedChannels: NotificationChannel[];
+    /** Per-channel outcomes including provider attempts. */
+    perChannelResults: PerChannelResult[];
+    /** Flattened list of every provider attempt across all channels. */
+    providerAttempts: ProviderAttempt[];
+    /** Internal, safe-to-log error summaries. */
+    errors: string[];
+    /** Correlation/trace id linking this dispatch to the originating event. */
+    correlationId?: string;
+}

package/dist/types/modules/notification/interfaces/per-channel-result.d.ts

@@ -0,0 +1,22 @@
+import { NotificationChannel } from '../enums/notification-channel.enum';
+import { ProviderFailureReason } from '../enums/provider-failure-reason.enum';
+import { ProviderAttempt } from './provider-attempt';
+/**
+ * Normalized outcome for a single notification channel, including every provider
+ * attempt made (primary and fallbacks) and which provider ultimately succeeded.
+ */
+export interface PerChannelResult {
+    channel: NotificationChannel;
+    success: boolean;
+    /** Provider that ultimately succeeded (undefined when the channel failed). */
+    provider?: string;
+    /** Normalized provider reference id from the successful provider. */
+    messageId?: string;
+    /** Ordered attempts (primary first, then fallbacks). */
+    attempts: ProviderAttempt[];
+    /** True when the channel was intentionally not attempted (e.g. no recipient). */
+    skipped?: boolean;
+    failureReason?: ProviderFailureReason;
+    /** Internal, safe-to-log error summary. */
+    errorMessage?: string;
+}

package/dist/types/modules/notification/interfaces/provider-attempt.d.ts

@@ -0,0 +1,25 @@
+import { NotificationChannel } from '../enums/notification-channel.enum';
+import { ProviderFailureReason } from '../enums/provider-failure-reason.enum';
+/**
+ * Record of a single provider send attempt within a channel.
+ * One channel may produce several attempts (primary + fallbacks).
+ * Error details here are intended for internal logging/observability, not for
+ * public API clients.
+ */
+export interface ProviderAttempt {
+    /** Provider identifier (SmsProviderName | EmailProviderName value). */
+    provider: string;
+    channel: NotificationChannel;
+    success: boolean;
+    /** Whether the failure was provider-level and eligible for fallback. */
+    retryable?: boolean;
+    failureReason?: ProviderFailureReason;
+    /** Normalized provider message/reference id when the send succeeded. */
+    messageId?: string;
+    /** Internal, safe-to-log error summary (never surfaced to public clients). */
+    errorMessage?: string;
+    /** Provider HTTP/status code when available. */
+    statusCode?: number;
+    startedAt?: string;
+    durationMs?: number;
+}

package/dist/types/modules/notification/interfaces/sms-send-result.d.ts

@@ -0,0 +1,22 @@
+import { NotificationChannel } from '../enums/notification-channel.enum';
+import { ProviderFailureReason } from '../enums/provider-failure-reason.enum';
+import { SmsProviderName } from '../enums/sms-provider-name.enum';
+import { ProviderAttempt } from './provider-attempt';
+/**
+ * Normalized result of an SMS send across the configured provider chain.
+ */
+export interface SmsSendResult {
+    channel: NotificationChannel.SMS;
+    success: boolean;
+    /** Provider that ultimately succeeded. */
+    provider?: SmsProviderName | string;
+    /** Normalized provider message/reference id. */
+    messageId?: string;
+    /** Recipients targeted (E.164). */
+    to?: string[];
+    /** Ordered attempts (primary first, then fallbacks). */
+    attempts: ProviderAttempt[];
+    failureReason?: ProviderFailureReason;
+    /** Internal, safe-to-log error summary. */
+    errorMessage?: string;
+}

package/package.json

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