@memberjunction/notifications 0.0.1 → 3.3.0

package/dist/NotificationEngine.d.ts

@@ -0,0 +1,65 @@
+import { BaseEngine, IMetadataProvider, UserInfo } from '@memberjunction/core';
+import { SendNotificationParams, NotificationResult } from './types';
+export declare class NotificationEngine extends BaseEngine<NotificationEngine> {
+    /**
+     * Returns the singleton instance of the NotificationEngine
+     */
+    static get Instance(): NotificationEngine;
+    /**
+     * Configures the notification engine.
+     *
+     * NOTE: This does NOT load notification types - UserInfoEngine handles that.
+     * UserInfoEngine is auto-configured via @RegisterForStartup() and loads notification types
+     * into its cache. This engine just provides the delivery mechanism.
+     *
+     * @param forceRefresh - If true, reloads data even if already loaded
+     * @param contextUser - User context for database operations (required on server)
+     * @param provider - Optional metadata provider override
+     */
+    Config(forceRefresh?: boolean, contextUser?: UserInfo, provider?: IMetadataProvider): Promise<void>;
+    /**
+     * Get a notification type by name (case-insensitive) or ID.
+     * Uses UserInfoEngine's cached notification types.
+     *
+     * @param nameOrId - The notification type name or UUID
+     * @returns The notification type entity or null if not found
+     */
+    private getNotificationType;
+    /**
+     * Send a notification using the unified notification system.
+     *
+     * This method:
+     * 1. Looks up the notification type from cache
+     * 2. Checks user preferences for delivery method
+     * 3. Creates in-app notification if applicable
+     * 4. Sends email/SMS using templates if applicable
+     *
+     * @param params - Notification parameters
+     * @param contextUser - User context for database operations
+     * @returns Result indicating success and delivery details
+     */
+    SendNotification(params: SendNotificationParams, contextUser: UserInfo): Promise<NotificationResult>;
+    /**
+     * Resolve the effective delivery channels based on force, preference, and type defaults.
+     * Uses the new boolean column approach for flexible multi-channel selection.
+     */
+    private resolveDeliveryChannels;
+    /**
+     * Get user preferences for a notification type from UserInfoEngine's cache.
+     * Preferences are still cached in UserInfoEngine (user-specific data).
+     */
+    private getUserPreferences;
+    /**
+     * Create in-app notification record
+     */
+    private createInAppNotification;
+    /**
+     * Send email notification using template
+     */
+    private sendEmail;
+    /**
+     * Send SMS notification using template
+     */
+    private sendSMS;
+}
+//# sourceMappingURL=NotificationEngine.d.ts.map

package/dist/NotificationEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationEngine.d.ts","sourceRoot":"","sources":["../src/NotificationEngine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAY,QAAQ,EAA2C,MAAM,sBAAsB,CAAC;AAMlI,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAoB,MAAM,SAAS,CAAC;AASvF,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,kBAAkB,CAAC;IACpE;;OAEG;IACH,WAAkB,QAAQ,IAAI,kBAAkB,CAE/C;IAED;;;;;;;;;;OAUG;IACU,MAAM,CACjB,YAAY,GAAE,OAAe,EAC7B,WAAW,CAAC,EAAE,QAAQ,EACtB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;;;;;;;;;;OAYG;IACU,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA8DjH;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAoC/B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;OAEG;YACW,uBAAuB;IAgCrC;;OAEG;YACW,SAAS;IAsDvB;;OAEG;YACW,OAAO;CAqDtB"}

package/dist/NotificationEngine.js

@@ -0,0 +1,285 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationEngine = void 0;
+const core_1 = require("@memberjunction/core");
+const core_entities_1 = require("@memberjunction/core-entities");
+const templates_1 = require("@memberjunction/templates");
+const communication_engine_1 = require("@memberjunction/communication-engine");
+const communication_types_1 = require("@memberjunction/communication-types");
+const sqlserver_dataprovider_1 = require("@memberjunction/sqlserver-dataprovider");
+/*
+ * Unified notification engine that handles in-app, email, and SMS delivery
+ * based on notification types and user preferences.
+ *
+ * This engine relies on UserInfoEngine for notification types and preferences.
+ * UserInfoEngine loads and caches all notification metadata via BaseEngine.
+ */
+class NotificationEngine extends core_1.BaseEngine {
+    /**
+     * Returns the singleton instance of the NotificationEngine
+     */
+    static get Instance() {
+        return super.getInstance();
+    }
+    /**
+     * Configures the notification engine.
+     *
+     * NOTE: This does NOT load notification types - UserInfoEngine handles that.
+     * UserInfoEngine is auto-configured via @RegisterForStartup() and loads notification types
+     * into its cache. This engine just provides the delivery mechanism.
+     *
+     * @param forceRefresh - If true, reloads data even if already loaded
+     * @param contextUser - User context for database operations (required on server)
+     * @param provider - Optional metadata provider override
+     */
+    async Config(forceRefresh = false, contextUser, provider) {
+        // Ensure UserInfoEngine is configured (it loads notification types)
+        await core_entities_1.UserInfoEngine.Instance.Config(forceRefresh, contextUser, provider);
+        // BaseEngine Load with empty configs - we don't load our own data
+        await this.Load([], provider || core_1.Metadata.Provider, forceRefresh, contextUser);
+    }
+    /**
+     * Get a notification type by name (case-insensitive) or ID.
+     * Uses UserInfoEngine's cached notification types.
+     *
+     * @param nameOrId - The notification type name or UUID
+     * @returns The notification type entity or null if not found
+     */
+    getNotificationType(nameOrId) {
+        const types = core_entities_1.UserInfoEngine.Instance.NotificationTypes;
+        // Try by ID first
+        const byId = types.find(t => t.ID === nameOrId);
+        if (byId)
+            return byId;
+        // Try by name (case-insensitive)
+        const lowerName = nameOrId.toLowerCase();
+        return types.find(t => t.Name.toLowerCase() === lowerName) || null;
+    }
+    /**
+     * Send a notification using the unified notification system.
+     *
+     * This method:
+     * 1. Looks up the notification type from cache
+     * 2. Checks user preferences for delivery method
+     * 3. Creates in-app notification if applicable
+     * 4. Sends email/SMS using templates if applicable
+     *
+     * @param params - Notification parameters
+     * @param contextUser - User context for database operations
+     * @returns Result indicating success and delivery details
+     */
+    async SendNotification(params, contextUser) {
+        this.TryThrowIfNotLoaded();
+        const result = {
+            success: true,
+            deliveryChannels: { inApp: false, email: false, sms: false },
+            errors: [],
+        };
+        try {
+            // Look up notification type from cache
+            const type = this.getNotificationType(params.typeNameOrId);
+            if (!type) {
+                throw new Error(`Notification type not found: ${params.typeNameOrId}`);
+            }
+            // looks up user preference from cache
+            const prefs = this.getUserPreferences(params.userId, type.ID);
+            // Determine delivery channels
+            const channels = this.resolveDeliveryChannels(params, prefs, type);
+            result.deliveryChannels = channels;
+            // Early return if user has opted out (all channels disabled)
+            if (!channels.inApp && !channels.email && !channels.sms) {
+                (0, core_1.LogStatus)(`User has opted out or all channels disabled for notification type: ${type.Name}`);
+                return result;
+            }
+            // 5. Create in-app notification if enabled (awaited - fast DB insert)
+            if (channels.inApp) {
+                result.inAppNotificationId = await this.createInAppNotification(params, type, contextUser);
+            }
+            // 6. Send email if enabled - fire and forget (don't block)
+            if (channels.email) {
+                result.emailSent = true; // Optimistically set - actual send is async
+                this.sendEmail(params, type, contextUser).catch((error) => {
+                    const errorMessage = error instanceof Error ? error.message : String(error);
+                    (0, core_1.LogError)(`Email delivery failed for notification type ${type.Name}: ${errorMessage}`);
+                });
+            }
+            // 7. Send SMS if enabled - fire and forget (don't block)
+            if (channels.sms) {
+                result.smsSent = true; // Optimistically set - actual send is async
+                this.sendSMS(params, type, contextUser).catch((error) => {
+                    const errorMessage = error instanceof Error ? error.message : String(error);
+                    (0, core_1.LogError)(`SMS delivery failed for notification type ${type.Name}: ${errorMessage}`);
+                });
+            }
+            return result;
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            result.success = false;
+            result.errors?.push(errorMessage);
+            (0, core_1.LogError)(`Notification delivery failed: ${errorMessage}`);
+            return result;
+        }
+    }
+    /**
+     * Resolve the effective delivery channels based on force, preference, and type defaults.
+     * Uses the new boolean column approach for flexible multi-channel selection.
+     */
+    resolveDeliveryChannels(params, prefs, type) {
+        // If forceDeliveryChannels is specified, use it directly
+        if (params.forceDeliveryChannels) {
+            return params.forceDeliveryChannels;
+        }
+        // Check if user has opted out entirely (master switch)
+        if (prefs && !prefs.Enabled) {
+            return { inApp: false, email: false, sms: false };
+        }
+        // Determine each channel: user pref (if allowed and set) > type default
+        const allowUserPref = type.AllowUserPreference !== false;
+        // Resolve InApp channel
+        const inApp = (allowUserPref && prefs?.InAppEnabled != null)
+            ? prefs.InAppEnabled
+            : (type.DefaultInApp ?? false);
+        // Resolve Email channel
+        const email = (allowUserPref && prefs?.EmailEnabled != null)
+            ? prefs.EmailEnabled
+            : (type.DefaultEmail ?? false);
+        // Resolve SMS channel
+        const sms = (allowUserPref && prefs?.SMSEnabled != null)
+            ? prefs.SMSEnabled
+            : (type.DefaultSMS ?? false);
+        return { inApp, email, sms };
+    }
+    /**
+     * Get user preferences for a notification type from UserInfoEngine's cache.
+     * Preferences are still cached in UserInfoEngine (user-specific data).
+     */
+    getUserPreferences(userId, typeId) {
+        // Use cached preferences from UserInfoEngine (user-specific)
+        const pref = core_entities_1.UserInfoEngine.Instance.GetUserPreferenceForType(userId, typeId);
+        // If preference exists, return it
+        if (pref) {
+            return pref;
+        }
+        // If no preference exists and the type doesn't allow user preferences, return null
+        const type = this.getNotificationType(typeId);
+        if (type && !type.AllowUserPreference) {
+            return null;
+        }
+        // If we reach here, the user hasn't set a preference yet
+        // Return null to use type defaults
+        return null;
+    }
+    /**
+     * Create in-app notification record
+     */
+    async createInAppNotification(params, type, contextUser) {
+        const md = new core_1.Metadata();
+        const notification = await md.GetEntityObject('User Notifications', contextUser);
+        notification.UserID = params.userId;
+        notification.NotificationTypeID = type.ID;
+        notification.Title = params.title;
+        notification.Message = params.message;
+        notification.Unread = true;
+        if (params.resourceTypeId) {
+            notification.ResourceTypeID = params.resourceTypeId;
+        }
+        if (params.resourceRecordId) {
+            notification.ResourceRecordID = params.resourceRecordId;
+        }
+        if (params.resourceConfiguration) {
+            notification.ResourceConfiguration = JSON.stringify(params.resourceConfiguration);
+        }
+        if (await notification.Save()) {
+            (0, core_1.LogStatus)(`In-app notification created: ${notification.ID} for type: ${type.Name}`);
+            return notification.ID;
+        }
+        throw new Error('Failed to save in-app notification');
+    }
+    /**
+     * Send email notification using template
+     */
+    async sendEmail(params, type, contextUser) {
+        // Access EmailTemplateID
+        const emailTemplateId = type.EmailTemplateID;
+        if (!emailTemplateId) {
+            (0, core_1.LogStatus)(`No email template configured for notification type: ${type.Name}`);
+            return false;
+        }
+        // Load and configure template engine (loads all template metadata)
+        const templateEngine = templates_1.TemplateEngineServer.Instance;
+        await templateEngine.Config(false, contextUser);
+        // Find the email template from the cached Templates array
+        const templateEntity = templateEngine.Templates.find((t) => t.ID === emailTemplateId);
+        if (!templateEntity) {
+            throw new Error(`Email template not found: ${emailTemplateId}`);
+        }
+        // Get user from cache (server-side optimization - no database query)
+        const user = sqlserver_dataprovider_1.UserCache.Instance.Users.find((u) => u.ID === params.userId);
+        if (!user) {
+            throw new Error('User not found for email delivery');
+        }
+        if (!user.Email) {
+            throw new Error('User has no email address configured');
+        }
+        // Configure and send via CommunicationEngine
+        const commEngine = communication_engine_1.CommunicationEngine.Instance;
+        await commEngine.Config(false, contextUser);
+        const message = new communication_types_1.Message();
+        message.From = process.env.NOTIFICATION_FROM_EMAIL || 'notifications@memberjunction.com';
+        message.To = user.Email;
+        message.HTMLBodyTemplate = templateEntity;
+        message.ContextData = params.templateData || {};
+        message.Subject = params.title;
+        const sendResult = await commEngine.SendSingleMessage('SendGrid', 'Email', message, undefined, false);
+        const success = sendResult?.Success === true;
+        if (success) {
+            (0, core_1.LogStatus)(`Email sent successfully to ${user.Email} for notification type: ${type.Name}`);
+        }
+        return success;
+    }
+    /**
+     * Send SMS notification using template
+     */
+    async sendSMS(params, type, contextUser) {
+        // Access SMSTemplateID
+        const smsTemplateId = type.SMSTemplateID;
+        if (!smsTemplateId) {
+            (0, core_1.LogStatus)(`No SMS template configured for notification type: ${type.Name}`);
+            return false;
+        }
+        // Load and configure template engine (loads all template metadata)
+        const templateEngine = templates_1.TemplateEngineServer.Instance;
+        await templateEngine.Config(false, contextUser);
+        // Find the SMS template from the cached Templates array
+        const templateEntity = templateEngine.Templates.find((t) => t.ID === smsTemplateId);
+        if (!templateEntity) {
+            throw new Error(`SMS template not found: ${smsTemplateId}`);
+        }
+        // Get user from cache (server-side optimization - no database query)
+        const user = sqlserver_dataprovider_1.UserCache.Instance.Users.find((u) => u.ID === params.userId);
+        if (!user) {
+            throw new Error('User not found for SMS delivery');
+        }
+        // Type assertion since UserInfo doesn't have Phone property yet
+        const userWithPhone = user;
+        if (!userWithPhone.Phone) {
+            throw new Error('User has no phone number configured');
+        }
+        // Send via CommunicationEngine - let it handle template rendering
+        const commEngine = communication_engine_1.CommunicationEngine.Instance;
+        await commEngine.Config(false, contextUser);
+        const message = new communication_types_1.Message();
+        message.To = userWithPhone.Phone;
+        message.BodyTemplate = templateEntity;
+        message.ContextData = params.templateData || {};
+        const sendResult = await commEngine.SendSingleMessage('Twilio', 'Standard SMS', message, undefined, false);
+        const success = sendResult?.Success === true;
+        if (success) {
+            (0, core_1.LogStatus)(`SMS sent successfully to ${userWithPhone.Phone} for notification type: ${type.Name}`);
+        }
+        return success;
+    }
+}
+exports.NotificationEngine = NotificationEngine;
+//# sourceMappingURL=NotificationEngine.js.map

package/dist/NotificationEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationEngine.js","sourceRoot":"","sources":["../src/NotificationEngine.ts"],"names":[],"mappings":";;;AAAA,+CAAkI;AAClI,iEAAqJ;AACrJ,yDAAiE;AACjE,+EAA2E;AAC3E,6EAA8D;AAC9D,mFAAmE;AAGnE;;;;;;GAMG;AACH,MAAa,kBAAmB,SAAQ,iBAA8B;IACpE;;OAEG;IACI,MAAM,KAAK,QAAQ;QACxB,OAAO,KAAK,CAAC,WAAW,EAAsB,CAAC;IACjD,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,MAAM,CACjB,eAAwB,KAAK,EAC7B,WAAsB,EACtB,QAA4B;QAE5B,oEAAoE;QACpE,MAAM,8BAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAE1E,kEAAkE;QAClE,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,IAAI,eAAQ,CAAC,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACK,mBAAmB,CAAC,QAAgB;QAC1C,MAAM,KAAK,GAAG,8BAAc,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAExD,kBAAkB;QAClB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;QAChD,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QAEtB,iCAAiC;QACjC,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAA8B,EAAE,WAAqB;QACjF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAE3B,MAAM,MAAM,GAAuB;YACjC,OAAO,EAAE,IAAI;YACb,gBAAgB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE;YAC5D,MAAM,EAAE,EAAE;SACX,CAAC;QAEF,IAAI,CAAC;YACH,uCAAuC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAC3D,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YACzE,CAAC;YAED,sCAAsC;YACtC,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAE9D,8BAA8B;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACnE,MAAM,CAAC,gBAAgB,GAAG,QAAQ,CAAC;YAEnC,6DAA6D;YAC7D,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACxD,IAAA,gBAAS,EAAC,sEAAsE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC7F,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,sEAAsE;YACtE,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;YAC7F,CAAC;YAED,2DAA2D;YAC3D,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,4CAA4C;gBACrE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACxD,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC5E,IAAA,eAAQ,EAAC,+CAA+C,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC,CAAC;gBACxF,CAAC,CAAC,CAAC;YACL,CAAC;YAED,yDAAyD;YACzD,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,4CAA4C;gBACnE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACtD,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC5E,IAAA,eAAQ,EAAC,6CAA6C,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC,CAAC;gBACtF,CAAC,CAAC,CAAC;YACL,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5E,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;YACvB,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAClC,IAAA,eAAQ,EAAC,iCAAiC,YAAY,EAAE,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,uBAAuB,CAC7B,MAA8B,EAC9B,KAA8C,EAC9C,IAAgC;QAEhC,yDAAyD;QACzD,IAAI,MAAM,CAAC,qBAAqB,EAAE,CAAC;YACjC,OAAO,MAAM,CAAC,qBAAqB,CAAC;QACtC,CAAC;QAED,uDAAuD;QACvD,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAC5B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QACpD,CAAC;QAED,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC;QAEzD,wBAAwB;QACxB,MAAM,KAAK,GAAG,CAAC,aAAa,IAAI,KAAK,EAAE,YAAY,IAAI,IAAI,CAAC;YAC1D,CAAC,CAAC,KAAK,CAAC,YAAY;YACpB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;QAEjC,wBAAwB;QACxB,MAAM,KAAK,GAAG,CAAC,aAAa,IAAI,KAAK,EAAE,YAAY,IAAI,IAAI,CAAC;YAC1D,CAAC,CAAC,KAAK,CAAC,YAAY;YACpB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;QAEjC,sBAAsB;QACtB,MAAM,GAAG,GAAG,CAAC,aAAa,IAAI,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;YACtD,CAAC,CAAC,KAAK,CAAC,UAAU;YAClB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,CAAC;QAE/B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACK,kBAAkB,CACxB,MAAc,EACd,MAAc;QAEd,6DAA6D;QAC7D,MAAM,IAAI,GAAG,8BAAc,CAAC,QAAQ,CAAC,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE9E,kCAAkC;QAClC,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,IAAI,CAAC;QACd,CAAC;QAED,mFAAmF;QACnF,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,yDAAyD;QACzD,mCAAmC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,uBAAuB,CACnC,MAA8B,EAC9B,IAAgC,EAChC,WAAqB;QAErB,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;QAC1B,MAAM,YAAY,GAAG,MAAM,EAAE,CAAC,eAAe,CAAyB,oBAAoB,EAAE,WAAW,CAAC,CAAC;QAEzG,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QACpC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,EAAE,CAAC;QAC1C,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAClC,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QACtC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC;QAE3B,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1B,YAAY,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QACtD,CAAC;QACD,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC5B,YAAY,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAC1D,CAAC;QACD,IAAI,MAAM,CAAC,qBAAqB,EAAE,CAAC;YACjC,YAAY,CAAC,qBAAqB,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QACpF,CAAC;QAED,IAAI,MAAM,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9B,IAAA,gBAAS,EAAC,gCAAgC,YAAY,CAAC,EAAE,cAAc,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACpF,OAAO,YAAY,CAAC,EAAE,CAAC;QACzB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,SAAS,CACrB,MAA8B,EAC9B,IAAgC,EAChC,WAAqB;QAErB,yBAAyB;QACzB,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,IAAA,gBAAS,EAAC,uDAAuD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC9E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mEAAmE;QACnE,MAAM,cAAc,GAAG,gCAAoB,CAAC,QAAQ,CAAC;QACrD,MAAM,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAEhD,0DAA0D;QAC1D,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,eAAe,CAAC,CAAC;QACtF,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,eAAe,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,qEAAqE;QACrE,MAAM,IAAI,GAAG,kCAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,6CAA6C;QAC7C,MAAM,UAAU,GAAG,0CAAmB,CAAC,QAAQ,CAAC;QAChD,MAAM,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,6BAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,kCAAkC,CAAC;QACzF,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,OAAO,CAAC,gBAAgB,GAAG,cAAc,CAAC;QAC1C,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC;QAChD,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;QAE/B,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,iBAAiB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAEtG,MAAM,OAAO,GAAG,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;QAE7C,IAAI,OAAO,EAAE,CAAC;YACZ,IAAA,gBAAS,EAAC,8BAA8B,IAAI,CAAC,KAAK,2BAA2B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5F,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,OAAO,CACnB,MAA8B,EAC9B,IAAgC,EAChC,WAAqB;QAErB,uBAAuB;QACvB,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,IAAA,gBAAS,EAAC,qDAAqD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mEAAmE;QACnE,MAAM,cAAc,GAAG,gCAAoB,CAAC,QAAQ,CAAC;QACrD,MAAM,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAEhD,wDAAwD;QACxD,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;QACpF,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,2BAA2B,aAAa,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,qEAAqE;QACrE,MAAM,IAAI,GAAG,kCAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QAED,gEAAgE;QAChE,MAAM,aAAa,GAAG,IAAqC,CAAC;QAC5D,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,kEAAkE;QAClE,MAAM,UAAU,GAAG,0CAAmB,CAAC,QAAQ,CAAC;QAChD,MAAM,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,6BAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC;QACjC,OAAO,CAAC,YAAY,GAAG,cAAc,CAAC;QACtC,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC;QAEhD,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,iBAAiB,CAAC,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAE3G,MAAM,OAAO,GAAG,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;QAE7C,IAAI,OAAO,EAAE,CAAC;YACZ,IAAA,gBAAS,EAAC,4BAA4B,aAAa,CAAC,KAAK,2BAA2B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACnG,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AApVD,gDAoVC"}

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @memberjunction/notifications
+ *
+ * Unified notification engine for MemberJunction with multi-channel delivery support.
+ * Extends BaseEngine for cached notification types and auto-refresh capabilities.
+ *
+ * Features:
+ * - Cached notification types (loaded once, auto-refreshed on changes)
+ * - User delivery preferences (In-App, Email, SMS per channel)
+ * - Template-based email/SMS formatting
+ * - Integration with CommunicationEngine for external delivery
+ * - Automatic in-app notification creation
+ *
+ * @example
+ * ```typescript
+ * import { NotificationEngine } from '@memberjunction/notifications';
+ *
+ * // Initialize at server startup
+ * await NotificationEngine.Instance.Config(false, contextUser);
+ *
+ * // Send a notification
+ * const result = await NotificationEngine.Instance.SendNotification({
+ *   userId: contextUser.ID,
+ *   typeNameOrId: 'Agent Completion',
+ *   title: 'Task Complete',
+ *   message: 'Your AI agent has finished processing',
+ *   templateData: {
+ *     agentName: 'My Agent',
+ *     conversationUrl: 'https://...'
+ *   }
+ * }, contextUser);
+ * ```
+ */
+export { NotificationEngine } from './NotificationEngine';
+export { SendNotificationParams, NotificationResult, DeliveryChannels } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * @memberjunction/notifications
+ *
+ * Unified notification engine for MemberJunction with multi-channel delivery support.
+ * Extends BaseEngine for cached notification types and auto-refresh capabilities.
+ *
+ * Features:
+ * - Cached notification types (loaded once, auto-refreshed on changes)
+ * - User delivery preferences (In-App, Email, SMS per channel)
+ * - Template-based email/SMS formatting
+ * - Integration with CommunicationEngine for external delivery
+ * - Automatic in-app notification creation
+ *
+ * @example
+ * ```typescript
+ * import { NotificationEngine } from '@memberjunction/notifications';
+ *
+ * // Initialize at server startup
+ * await NotificationEngine.Instance.Config(false, contextUser);
+ *
+ * // Send a notification
+ * const result = await NotificationEngine.Instance.SendNotification({
+ *   userId: contextUser.ID,
+ *   typeNameOrId: 'Agent Completion',
+ *   title: 'Task Complete',
+ *   message: 'Your AI agent has finished processing',
+ *   templateData: {
+ *     agentName: 'My Agent',
+ *     conversationUrl: 'https://...'
+ *   }
+ * }, contextUser);
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationEngine = void 0;
+var NotificationEngine_1 = require("./NotificationEngine");
+Object.defineProperty(exports, "NotificationEngine", { enumerable: true, get: function () { return NotificationEngine_1.NotificationEngine; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;;;AAEH,2DAA0D;AAAjD,wHAAA,kBAAkB,OAAA"}

package/dist/types.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Individual channel settings for notification delivery.
+ * Each channel can be independently enabled or disabled.
+ */
+export interface DeliveryChannels {
+    /**
+     * Whether in-app notifications are enabled
+     */
+    inApp: boolean;
+    /**
+     * Whether email notifications are enabled
+     */
+    email: boolean;
+    /**
+     * Whether SMS notifications are enabled
+     */
+    sms: boolean;
+}
+/**
+ * Parameters for sending a notification through the unified notification system
+ */
+export interface SendNotificationParams {
+    /**
+     * User ID to send notification to
+     */
+    userId: string;
+    /**
+     * Notification type name (e.g., 'Agent Completion') or UUID
+     */
+    typeNameOrId: string;
+    /**
+     * Short notification title (used for in-app and email subject)
+     */
+    title: string;
+    /**
+     * Full notification message (used for in-app display)
+     */
+    message: string;
+    /**
+     * Optional resource type ID for linking notification to a specific resource
+     */
+    resourceTypeId?: string;
+    /**
+     * Optional resource record ID for linking notification to a specific record
+     */
+    resourceRecordId?: string;
+    /**
+     * Optional navigation context stored as JSON (conversation ID, artifact details, etc.)
+     */
+    resourceConfiguration?: any;
+    /**
+     * Data object for template rendering (email/SMS templates)
+     */
+    templateData?: Record<string, any>;
+    /**
+     * Force specific delivery channels, overriding user preferences and type defaults.
+     * When specified, these channels are used instead of resolving from preferences.
+     */
+    forceDeliveryChannels?: DeliveryChannels;
+}
+/**
+ * Result of sending a notification
+ */
+export interface NotificationResult {
+    /**
+     * Whether the notification operation succeeded overall
+     */
+    success: boolean;
+    /**
+     * ID of the created in-app notification (if created)
+     */
+    inAppNotificationId?: string;
+    /**
+     * Whether email was sent successfully
+     */
+    emailSent?: boolean;
+    /**
+     * Whether SMS was sent successfully
+     */
+    smsSent?: boolean;
+    /**
+     * Actual delivery channels used (after resolving preferences)
+     */
+    deliveryChannels: DeliveryChannels;
+    /**
+     * Any errors that occurred during notification delivery
+     */
+    errors?: string[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,GAAG,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,gBAAgB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/dist/types.js

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

package/dist/types.js.map

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

package/package.json

@@ -1,10 +1,34 @@
 {
   "name": "@memberjunction/notifications",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/notifications",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "version": "3.3.0",
+  "description": "MemberJunction: Unified Notification System with Multi-Channel Delivery",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "devDependencies": {
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@memberjunction/global": "3.3.0",
+    "@memberjunction/core": "3.3.0",
+    "@memberjunction/core-entities": "3.3.0",
+    "@memberjunction/templates": "3.3.0",
+    "@memberjunction/communication-engine": "3.3.0",
+    "@memberjunction/communication-types": "3.3.0",
+    "@memberjunction/sqlserver-dataprovider": "3.3.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  }
 }

package/README.md

@@ -1,45 +0,0 @@
-# @memberjunction/notifications
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/notifications`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**