@varity-labs/sdk 2.0.0-alpha.1

package/dist/modules/notifications/NotificationsModule.d.ts

@@ -0,0 +1,336 @@
+import type { VaritySDK } from '../../core/VaritySDK';
+/**
+ * Notifications Module
+ *
+ * Universal multi-channel notifications and alerting across all templates.
+ * Supports email, SMS, Slack, push notifications, and more.
+ * Works identically for ISO, Healthcare, Finance, Retail, etc.
+ */
+export type NotificationType = 'email' | 'sms' | 'slack' | 'push' | 'webhook' | 'in-app';
+export type NotificationPriority = 'low' | 'normal' | 'high' | 'urgent';
+export type NotificationStatus = 'pending' | 'sent' | 'delivered' | 'failed' | 'bounced';
+export interface SendNotificationOptions {
+    type: NotificationType;
+    to: string | string[];
+    template?: string;
+    subject?: string;
+    message?: string;
+    data?: Record<string, any>;
+    priority?: NotificationPriority;
+    channels?: NotificationType[];
+    attachments?: NotificationAttachment[];
+    scheduledFor?: string;
+    metadata?: Record<string, any>;
+}
+export interface NotificationAttachment {
+    filename: string;
+    url?: string;
+    content?: string;
+    mimetype?: string;
+}
+export interface NotificationResult {
+    id: string;
+    type: NotificationType;
+    status: NotificationStatus;
+    to: string[];
+    sentAt?: string;
+    deliveredAt?: string;
+    error?: string;
+    metadata?: Record<string, any>;
+}
+export interface NotificationPreferences {
+    email?: boolean;
+    sms?: boolean;
+    slack?: boolean;
+    push?: boolean;
+    inApp?: boolean;
+    alerts?: string[];
+    quietHours?: {
+        enabled: boolean;
+        start: string;
+        end: string;
+        timezone?: string;
+    };
+    frequency?: {
+        digest?: boolean;
+        digestFrequency?: 'hourly' | 'daily' | 'weekly';
+    };
+}
+export interface NotificationHistoryOptions {
+    type?: NotificationType;
+    status?: NotificationStatus;
+    startDate?: string;
+    endDate?: string;
+    limit?: number;
+    offset?: number;
+    userId?: string;
+}
+export interface NotificationHistoryEntry {
+    id: string;
+    type: NotificationType;
+    status: NotificationStatus;
+    to: string[];
+    subject?: string;
+    template?: string;
+    sentAt: string;
+    deliveredAt?: string;
+    error?: string;
+    metadata?: Record<string, any>;
+}
+export interface NotificationHistoryResult {
+    entries: NotificationHistoryEntry[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+export interface ScheduleNotificationOptions extends SendNotificationOptions {
+    scheduledFor: string;
+    repeat?: {
+        interval: 'daily' | 'weekly' | 'monthly';
+        count?: number;
+        endDate?: string;
+    };
+}
+export interface ScheduledNotification {
+    id: string;
+    notification: SendNotificationOptions;
+    scheduledFor: string;
+    repeat?: {
+        interval: string;
+        count?: number;
+        endDate?: string;
+    };
+    status: 'scheduled' | 'sent' | 'cancelled';
+    createdAt: string;
+}
+export interface AlertRule {
+    id?: string;
+    name: string;
+    condition: AlertCondition;
+    notification: SendNotificationOptions;
+    enabled: boolean;
+    metadata?: Record<string, any>;
+}
+export interface AlertCondition {
+    metric: string;
+    operator: '>' | '<' | '=' | '>=' | '<=' | '!=';
+    threshold: number | string;
+    duration?: number;
+    aggregation?: 'avg' | 'sum' | 'count' | 'min' | 'max';
+}
+export interface AlertRuleResult {
+    id: string;
+    name: string;
+    condition: AlertCondition;
+    notification: SendNotificationOptions;
+    enabled: boolean;
+    lastTriggered?: string;
+    triggerCount: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface NotificationTemplate {
+    id?: string;
+    name: string;
+    type: NotificationType;
+    subject?: string;
+    body: string;
+    variables?: string[];
+    metadata?: Record<string, any>;
+}
+/**
+ * NotificationsModule - Universal notifications and alerting
+ *
+ * Provides multi-channel notification delivery with templates, scheduling,
+ * preferences, and alert rules. Works across all templates by using
+ * template-specific notification templates.
+ */
+export declare class NotificationsModule {
+    private sdk;
+    constructor(sdk: VaritySDK);
+    /**
+     * Send notification immediately
+     *
+     * Universal method - sends notifications via any channel for any template.
+     * Template configuration provides template-specific message content.
+     *
+     * @example ISO Dashboard
+     * ```typescript
+     * await sdk.notifications.send({
+     *   type: 'email',
+     *   to: 'merchant@example.com',
+     *   template: 'merchant_registered',
+     *   data: { merchantName: 'Acme Corp' }
+     * })
+     * ```
+     *
+     * @example Healthcare Dashboard
+     * ```typescript
+     * await sdk.notifications.send({
+     *   type: 'sms',
+     *   to: '+1234567890',
+     *   template: 'appointment_reminder',
+     *   data: { patientName: 'John Doe', appointmentTime: '2025-01-15 10:00' }
+     * })
+     * ```
+     */
+    send(options: SendNotificationOptions): Promise<NotificationResult>;
+    /**
+     * Send batch notifications
+     *
+     * Universal method - sends multiple notifications efficiently.
+     *
+     * @example
+     * ```typescript
+     * const results = await sdk.notifications.sendBatch([
+     *   { type: 'email', to: 'user1@example.com', template: 'alert' },
+     *   { type: 'email', to: 'user2@example.com', template: 'alert' },
+     *   { type: 'sms', to: '+1234567890', template: 'urgent_alert' }
+     * ])
+     * ```
+     */
+    sendBatch(notifications: SendNotificationOptions[]): Promise<NotificationResult[]>;
+    /**
+     * Get notification preferences for a user
+     *
+     * Universal method - retrieves user notification preferences.
+     */
+    getPreferences(userId?: string): Promise<NotificationPreferences>;
+    /**
+     * Set notification preferences for a user
+     *
+     * Universal method - updates user notification preferences.
+     *
+     * @example
+     * ```typescript
+     * await sdk.notifications.setPreferences({
+     *   email: true,
+     *   slack: true,
+     *   push: false,
+     *   alerts: ['compliance', 'anomaly', 'milestone'],
+     *   quietHours: {
+     *     enabled: true,
+     *     start: '22:00',
+     *     end: '08:00',
+     *     timezone: 'America/New_York'
+     *   }
+     * })
+     * ```
+     */
+    setPreferences(preferences: NotificationPreferences, userId?: string): Promise<void>;
+    /**
+     * Get notification history
+     *
+     * Universal method - retrieves past notifications with filtering.
+     *
+     * @example
+     * ```typescript
+     * const history = await sdk.notifications.getHistory({
+     *   type: 'email',
+     *   status: 'delivered',
+     *   startDate: '2025-01-01',
+     *   limit: 50
+     * })
+     * ```
+     */
+    getHistory(options?: NotificationHistoryOptions): Promise<NotificationHistoryResult>;
+    /**
+     * Schedule notification for later delivery
+     *
+     * Universal method - schedules notifications for future delivery.
+     *
+     * @example
+     * ```typescript
+     * const scheduled = await sdk.notifications.schedule({
+     *   type: 'email',
+     *   to: 'user@example.com',
+     *   template: 'monthly_report',
+     *   scheduledFor: '2025-02-01T09:00:00Z',
+     *   repeat: {
+     *     interval: 'monthly',
+     *     count: 12
+     *   }
+     * })
+     * ```
+     */
+    schedule(options: ScheduleNotificationOptions): Promise<ScheduledNotification>;
+    /**
+     * Cancel scheduled notification
+     *
+     * Universal method - cancels a scheduled notification.
+     */
+    cancelScheduled(notificationId: string): Promise<void>;
+    /**
+     * List scheduled notifications
+     *
+     * Universal method - lists all scheduled notifications.
+     */
+    listScheduled(options?: {
+        status?: string;
+        limit?: number;
+    }): Promise<ScheduledNotification[]>;
+    /**
+     * Create alert rule
+     *
+     * Universal method - creates an automatic alert based on conditions.
+     *
+     * @example ISO Dashboard
+     * ```typescript
+     * await sdk.notifications.createAlertRule({
+     *   name: 'High Residual Alert',
+     *   condition: {
+     *     metric: 'residual_amount',
+     *     operator: '>',
+     *     threshold: 10000,
+     *     duration: 300 // 5 minutes
+     *   },
+     *   notification: {
+     *     type: 'email',
+     *     to: 'admin@example.com',
+     *     template: 'high_residual_alert'
+     *   },
+     *   enabled: true
+     * })
+     * ```
+     */
+    createAlertRule(rule: AlertRule): Promise<AlertRuleResult>;
+    /**
+     * Update alert rule
+     *
+     * Universal method - updates an existing alert rule.
+     */
+    updateAlertRule(ruleId: string, updates: Partial<AlertRule>): Promise<AlertRuleResult>;
+    /**
+     * Delete alert rule
+     *
+     * Universal method - deletes an alert rule.
+     */
+    deleteAlertRule(ruleId: string): Promise<void>;
+    /**
+     * List alert rules
+     *
+     * Universal method - lists all alert rules.
+     */
+    listAlertRules(options?: {
+        enabled?: boolean;
+    }): Promise<AlertRuleResult[]>;
+    /**
+     * Create notification template
+     *
+     * Universal method - creates a reusable notification template.
+     */
+    createTemplate(template: NotificationTemplate): Promise<NotificationTemplate>;
+    /**
+     * Get notification template
+     *
+     * Universal method - retrieves a notification template by name.
+     */
+    getTemplate(templateName: string): Promise<NotificationTemplate>;
+    /**
+     * List notification templates
+     *
+     * Universal method - lists all available notification templates.
+     */
+    listTemplates(type?: NotificationType): Promise<NotificationTemplate[]>;
+}
+//# sourceMappingURL=NotificationsModule.d.ts.map

package/dist/modules/notifications/NotificationsModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationsModule.d.ts","sourceRoot":"","sources":["../../../src/modules/notifications/NotificationsModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD;;;;;;GAMG;AAEH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAA;AAExF,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEvE,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAA;AAExF,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,gBAAgB,CAAA;IACtB,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,QAAQ,CAAC,EAAE,oBAAoB,CAAA;IAC/B,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC7B,WAAW,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACtC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,gBAAgB,CAAA;IACtB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,EAAE,EAAE,MAAM,EAAE,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,UAAU,CAAC,EAAE;QACX,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,GAAG,EAAE,MAAM,CAAA;QACX,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,SAAS,CAAC,EAAE;QACV,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,eAAe,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;KAChD,CAAA;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,gBAAgB,CAAA;IACtB,MAAM,EAAE,kBAAkB,CAAA;IAC1B,EAAE,EAAE,MAAM,EAAE,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,wBAAwB,EAAE,CAAA;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE;QACP,QAAQ,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;QACxC,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,uBAAuB,CAAA;IACrC,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE;QACP,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,MAAM,EAAE,WAAW,GAAG,MAAM,GAAG,WAAW,CAAA;IAC1C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,cAAc,CAAA;IACzB,YAAY,EAAE,uBAAuB,CAAA;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;IAC9C,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,CAAA;CACtD;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,cAAc,CAAA;IACzB,YAAY,EAAE,uBAAuB,CAAA;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,gBAAgB,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAClB,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,SAAS;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,IAAI,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAoBzE;;;;;;;;;;;;;OAaG;IACG,SAAS,CAAC,aAAa,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAoBxF;;;;OAIG;IACG,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAuBvE;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAAC,WAAW,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB1F;;;;;;;;;;;;;;OAcG;IACG,UAAU,CAAC,OAAO,GAAE,0BAA+B,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAoB9F;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBpF;;;;OAIG;IACG,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB5D;;;;OAIG;IACG,aAAa,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAuBxG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC;IAoBhE;;;;OAIG;IACG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;IAoB5F;;;;OAIG;IACG,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpD;;;;OAIG;IACG,cAAc,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAsBrF;;;;OAIG;IACG,cAAc,CAAC,QAAQ,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAoBnF;;;;OAIG;IACG,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAmBtE;;;;OAIG;IACG,aAAa,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;CAoB9E"}