dt-common-device 2.0.6 → 3.0.0

package/dist/alerts/Alert.service.d.ts

@@ -0,0 +1,137 @@
+import { AlertRepository } from "./Alert.repository";
+import { IAlertDocument } from "./Alert.model";
+import { CreateAlertData, UpdateAlertData, AlertCategory, AlertSeverity, EntityType } from "./alert.types";
+import { AlertBuilder } from "./AlertBuilder";
+export declare class AlertService {
+    private readonly alertRepository;
+    constructor(alertRepository: AlertRepository);
+    /**
+     * Create a readiness alert using AlertBuilder
+     */
+    raiseReadinessAlert(propertyId: string, title: string, description: string, entityId?: string, entityType?: EntityType, createdBy?: string): Promise<IAlertDocument>;
+    /**
+     * Create an operations alert using AlertBuilder
+     */
+    raiseOperationsAlert(propertyId: string, title: string, description: string, entityId?: string, entityType?: EntityType, createdBy?: string): Promise<IAlertDocument>;
+    /**
+     * Create a security alert using AlertBuilder
+     */
+    raiseSecurityAlert(propertyId: string, title: string, description: string, entityId?: string, entityType?: EntityType, createdBy?: string): Promise<IAlertDocument>;
+    /**
+     * Create an energy alert using AlertBuilder
+     */
+    raiseEnergyAlert(propertyId: string, title: string, description: string, entityId?: string, entityType?: EntityType, createdBy?: string): Promise<IAlertDocument>;
+    /**
+     * Create a device-specific alert using AlertBuilder
+     */
+    raiseDeviceAlert(deviceId: string, propertyId: string, title: string, description: string, category?: AlertCategory, severity?: AlertSeverity, createdBy?: string): Promise<IAlertDocument>;
+    /**
+     * Create a hub-specific alert using AlertBuilder
+     */
+    raiseHubAlert(hubId: string, propertyId: string, title: string, description: string, category?: AlertCategory, severity?: AlertSeverity, createdBy?: string): Promise<IAlertDocument>;
+    /**
+     * Create a new alert with business logic validation
+     * Accepts either a CreateAlertData object or an AlertBuilder instance
+     */
+    createAlert(alertData: CreateAlertData | AlertBuilder): Promise<IAlertDocument>;
+    /**
+     * Get alert by ID with business logic
+     */
+    getAlertById(id: string, includeDeleted?: boolean): Promise<IAlertDocument | null>;
+    /**
+     * Get all alerts with business logic filtering
+     */
+    getAlerts(filters?: {
+        propertyId?: string;
+        category?: AlertCategory;
+        severity?: AlertSeverity;
+        entityType?: EntityType;
+        entityId?: string;
+        isActive?: boolean;
+        isRead?: boolean;
+        includeDeleted?: boolean;
+        limit?: number;
+        skip?: number;
+    }): Promise<IAlertDocument[]>;
+    /**
+     * Update an alert with business logic validation
+     */
+    updateAlert(id: string, updateData: UpdateAlertData): Promise<IAlertDocument | null>;
+    /**
+     * Soft delete an alert with business logic
+     */
+    deleteAlert(id: string, deletedBy: string): Promise<boolean>;
+    /**
+     * Mark alert as read with business logic
+     */
+    markAsRead(id: string, updatedBy: string): Promise<IAlertDocument | null>;
+    /**
+     * Mark alert as unread with business logic
+     */
+    markAsUnread(id: string, updatedBy: string): Promise<IAlertDocument | null>;
+    /**
+     * Activate an alert with business logic
+     */
+    activateAlert(id: string, updatedBy: string): Promise<IAlertDocument | null>;
+    /**
+     * Deactivate an alert with business logic
+     */
+    deactivateAlert(id: string, updatedBy: string): Promise<IAlertDocument | null>;
+    /**
+     * Snooze an alert with business logic
+     */
+    snoozeAlert(id: string, until: Date, updatedBy: string): Promise<IAlertDocument | null>;
+    /**
+     * Unsnooze an alert with business logic
+     */
+    unsnoozeAlert(id: string, updatedBy: string): Promise<IAlertDocument | null>;
+    /**
+     * Get alerts by property with business logic
+     */
+    getAlertsByProperty(propertyId: string, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get alerts by entity with business logic
+     */
+    getAlertsByEntity(entityId: string, entityType: EntityType, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get alerts by category with business logic
+     */
+    getAlertsByCategory(category: AlertCategory, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get alerts by severity with business logic
+     */
+    getAlertsBySeverity(severity: AlertSeverity, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get active alerts with business logic
+     */
+    getActiveAlerts(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get unread alerts with business logic
+     */
+    getUnreadAlerts(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get snoozed alerts with business logic
+     */
+    getSnoozedAlerts(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get expired snooze alerts with business logic
+     */
+    getExpiredSnoozeAlerts(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    /**
+     * Get alert statistics with business logic
+     */
+    getAlertStatistics(propertyId?: string): Promise<{
+        total: number;
+        active: number;
+        unread: number;
+        snoozed: number;
+        bySeverity: Record<AlertSeverity, number>;
+        byCategory: Record<AlertCategory, number>;
+    }>;
+    private validateAlertData;
+    private validateFilters;
+    private validateUpdateData;
+    private validateSnoozeDate;
+    private determineDefaultSeverity;
+    private applyBusinessRules;
+}

package/dist/alerts/Alert.service.js

@@ -0,0 +1,476 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertService = void 0;
+const typedi_1 = require("typedi");
+const Alert_model_1 = require("./Alert.model");
+const alert_types_1 = require("./alert.types");
+const AlertBuilder_1 = require("./AlertBuilder");
+let AlertService = (() => {
+    let _classDecorators = [(0, typedi_1.Service)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var AlertService = _classThis = class {
+        constructor(alertRepository) {
+            this.alertRepository = alertRepository;
+        }
+        /**
+         * Create a readiness alert using AlertBuilder
+         */
+        async raiseReadinessAlert(propertyId, title, description, entityId, entityType, createdBy) {
+            const alertBuilder = AlertBuilder_1.AlertBuilder.createReadinessAlert()
+                .setPropertyId(propertyId)
+                .setTitle(title)
+                .setDescription(description);
+            if (entityId)
+                alertBuilder.setEntityId(entityId);
+            if (entityType)
+                alertBuilder.setEntityType(entityType);
+            if (createdBy)
+                alertBuilder.setCreatedBy(createdBy);
+            return await this.createAlert(alertBuilder);
+        }
+        /**
+         * Create an operations alert using AlertBuilder
+         */
+        async raiseOperationsAlert(propertyId, title, description, entityId, entityType, createdBy) {
+            const alertBuilder = AlertBuilder_1.AlertBuilder.createOperationsAlert()
+                .setPropertyId(propertyId)
+                .setTitle(title)
+                .setDescription(description);
+            if (entityId)
+                alertBuilder.setEntityId(entityId);
+            if (entityType)
+                alertBuilder.setEntityType(entityType);
+            if (createdBy)
+                alertBuilder.setCreatedBy(createdBy);
+            return await this.createAlert(alertBuilder);
+        }
+        /**
+         * Create a security alert using AlertBuilder
+         */
+        async raiseSecurityAlert(propertyId, title, description, entityId, entityType, createdBy) {
+            const alertBuilder = AlertBuilder_1.AlertBuilder.createSecurityAlert()
+                .setPropertyId(propertyId)
+                .setTitle(title)
+                .setDescription(description);
+            if (entityId)
+                alertBuilder.setEntityId(entityId);
+            if (entityType)
+                alertBuilder.setEntityType(entityType);
+            if (createdBy)
+                alertBuilder.setCreatedBy(createdBy);
+            return await this.createAlert(alertBuilder);
+        }
+        /**
+         * Create an energy alert using AlertBuilder
+         */
+        async raiseEnergyAlert(propertyId, title, description, entityId, entityType, createdBy) {
+            const alertBuilder = AlertBuilder_1.AlertBuilder.createEnergyAlert()
+                .setPropertyId(propertyId)
+                .setTitle(title)
+                .setDescription(description);
+            if (entityId)
+                alertBuilder.setEntityId(entityId);
+            if (entityType)
+                alertBuilder.setEntityType(entityType);
+            if (createdBy)
+                alertBuilder.setCreatedBy(createdBy);
+            return await this.createAlert(alertBuilder);
+        }
+        /**
+         * Create a device-specific alert using AlertBuilder
+         */
+        async raiseDeviceAlert(deviceId, propertyId, title, description, category, severity, createdBy) {
+            const alertBuilder = AlertBuilder_1.AlertBuilder.createDeviceAlert(deviceId, propertyId)
+                .setTitle(title)
+                .setDescription(description);
+            if (category)
+                alertBuilder.setCategory(category);
+            if (severity)
+                alertBuilder.setSeverity(severity);
+            if (createdBy)
+                alertBuilder.setCreatedBy(createdBy);
+            return await this.createAlert(alertBuilder);
+        }
+        /**
+         * Create a hub-specific alert using AlertBuilder
+         */
+        async raiseHubAlert(hubId, propertyId, title, description, category, severity, createdBy) {
+            const alertBuilder = AlertBuilder_1.AlertBuilder.createHubAlert(hubId, propertyId)
+                .setTitle(title)
+                .setDescription(description);
+            if (category)
+                alertBuilder.setCategory(category);
+            if (severity)
+                alertBuilder.setSeverity(severity);
+            if (createdBy)
+                alertBuilder.setCreatedBy(createdBy);
+            return await this.createAlert(alertBuilder);
+        }
+        /**
+         * Create a new alert with business logic validation
+         * Accepts either a CreateAlertData object or an AlertBuilder instance
+         */
+        async createAlert(alertData) {
+            let processedAlertData;
+            // Handle AlertBuilder instance
+            if (alertData instanceof AlertBuilder_1.AlertBuilder) {
+                processedAlertData = alertData.build();
+            }
+            else {
+                processedAlertData = alertData;
+            }
+            // Business logic: Validate alert data
+            this.validateAlertData(processedAlertData);
+            // Business logic: Set default severity if not provided
+            if (!processedAlertData.severity) {
+                processedAlertData.severity = this.determineDefaultSeverity(processedAlertData.category);
+            }
+            // Business logic: Validate snooze date is in the future
+            if (processedAlertData.snoozeUntil &&
+                processedAlertData.snoozeUntil <= new Date()) {
+                throw new Error("Snooze date must be in the future");
+            }
+            return await this.alertRepository.create(processedAlertData);
+        }
+        /**
+         * Get alert by ID with business logic
+         */
+        async getAlertById(id, includeDeleted = false) {
+            if (!id) {
+                throw new Error("Alert ID is required");
+            }
+            const alert = await this.alertRepository.findById(id, includeDeleted);
+            // Business logic: Check if alert is snoozed and expired
+            if (alert?.snoozeUntil && alert.snoozeUntil <= new Date()) {
+                console.warn(`Alert ${id} snooze has expired`);
+            }
+            return alert;
+        }
+        /**
+         * Get all alerts with business logic filtering
+         */
+        async getAlerts(filters = {}) {
+            // Business logic: Validate filters
+            this.validateFilters(filters);
+            // Business logic: Apply business rules to filters
+            const enhancedFilters = this.applyBusinessRules(filters);
+            return await this.alertRepository.findAll(enhancedFilters);
+        }
+        /**
+         * Update an alert with business logic validation
+         */
+        async updateAlert(id, updateData) {
+            if (!id) {
+                throw new Error("Alert ID is required");
+            }
+            // Business logic: Validate update data
+            this.validateUpdateData(updateData);
+            // Business logic: Check if alert exists and is not deleted
+            const existingAlert = await this.alertRepository.findById(id);
+            if (!existingAlert) {
+                throw new Error("Alert not found");
+            }
+            // Business logic: Handle snooze validation
+            if (updateData.snoozeUntil) {
+                this.validateSnoozeDate(updateData.snoozeUntil);
+            }
+            return await this.alertRepository.update(id, updateData);
+        }
+        /**
+         * Soft delete an alert with business logic
+         */
+        async deleteAlert(id, deletedBy) {
+            if (!id || !deletedBy) {
+                throw new Error("Alert ID and deleted by user are required");
+            }
+            // Business logic: Check if alert can be deleted
+            const alert = await this.alertRepository.findById(id);
+            if (!alert) {
+                throw new Error("Alert not found");
+            }
+            // Business logic: Prevent deletion of critical alerts (optional rule)
+            if (alert.severity === alert_types_1.AlertSeverity.CRITICAL) {
+                throw new Error("Cannot delete critical alerts");
+            }
+            return await this.alertRepository.softDelete(id, deletedBy);
+        }
+        /**
+         * Mark alert as read with business logic
+         */
+        async markAsRead(id, updatedBy) {
+            if (!id || !updatedBy) {
+                throw new Error("Alert ID and updated by user are required");
+            }
+            const alertModel = await Alert_model_1.AlertModel.findById(id);
+            if (!alertModel)
+                return null;
+            alertModel.markAsRead(updatedBy);
+            return await alertModel.save();
+        }
+        /**
+         * Mark alert as unread with business logic
+         */
+        async markAsUnread(id, updatedBy) {
+            if (!id || !updatedBy) {
+                throw new Error("Alert ID and updated by user are required");
+            }
+            const alertModel = await Alert_model_1.AlertModel.findById(id);
+            if (!alertModel)
+                return null;
+            alertModel.markAsUnread(updatedBy);
+            return await alertModel.save();
+        }
+        /**
+         * Activate an alert with business logic
+         */
+        async activateAlert(id, updatedBy) {
+            if (!id || !updatedBy) {
+                throw new Error("Alert ID and updated by user are required");
+            }
+            const alertModel = await Alert_model_1.AlertModel.findById(id);
+            if (!alertModel)
+                return null;
+            alertModel.activate(updatedBy);
+            return await alertModel.save();
+        }
+        /**
+         * Deactivate an alert with business logic
+         */
+        async deactivateAlert(id, updatedBy) {
+            if (!id || !updatedBy) {
+                throw new Error("Alert ID and updated by user are required");
+            }
+            const alertModel = await Alert_model_1.AlertModel.findById(id);
+            if (!alertModel)
+                return null;
+            alertModel.deactivate(updatedBy);
+            return await alertModel.save();
+        }
+        /**
+         * Snooze an alert with business logic
+         */
+        async snoozeAlert(id, until, updatedBy) {
+            if (!id || !until || !updatedBy) {
+                throw new Error("Alert ID, snooze date, and updated by user are required");
+            }
+            // Business logic: Validate snooze date
+            this.validateSnoozeDate(until);
+            const alertModel = await Alert_model_1.AlertModel.findById(id);
+            if (!alertModel)
+                return null;
+            alertModel.snooze(until, updatedBy);
+            return await alertModel.save();
+        }
+        /**
+         * Unsnooze an alert with business logic
+         */
+        async unsnoozeAlert(id, updatedBy) {
+            if (!id || !updatedBy) {
+                throw new Error("Alert ID and updated by user are required");
+            }
+            const alertModel = await Alert_model_1.AlertModel.findById(id);
+            if (!alertModel)
+                return null;
+            alertModel.unsnooze(updatedBy);
+            return await alertModel.save();
+        }
+        /**
+         * Get alerts by property with business logic
+         */
+        async getAlertsByProperty(propertyId, includeDeleted = false) {
+            if (!propertyId) {
+                throw new Error("Property ID is required");
+            }
+            return await this.alertRepository.findByProperty(propertyId, includeDeleted);
+        }
+        /**
+         * Get alerts by entity with business logic
+         */
+        async getAlertsByEntity(entityId, entityType, includeDeleted = false) {
+            if (!entityId || !entityType) {
+                throw new Error("Entity ID and entity type are required");
+            }
+            return await this.alertRepository.findByEntity(entityId, entityType, includeDeleted);
+        }
+        /**
+         * Get alerts by category with business logic
+         */
+        async getAlertsByCategory(category, includeDeleted = false) {
+            if (!category) {
+                throw new Error("Alert category is required");
+            }
+            return await this.alertRepository.findByCategory(category, includeDeleted);
+        }
+        /**
+         * Get alerts by severity with business logic
+         */
+        async getAlertsBySeverity(severity, includeDeleted = false) {
+            if (!severity) {
+                throw new Error("Alert severity is required");
+            }
+            return await this.alertRepository.findBySeverity(severity, includeDeleted);
+        }
+        /**
+         * Get active alerts with business logic
+         */
+        async getActiveAlerts(includeDeleted = false) {
+            const activeAlerts = await this.alertRepository.findActive(includeDeleted);
+            // Business logic: Log active alerts for monitoring
+            if (activeAlerts.length > 0) {
+                console.log(`Found ${activeAlerts.length} active alerts`);
+            }
+            return activeAlerts;
+        }
+        /**
+         * Get unread alerts with business logic
+         */
+        async getUnreadAlerts(includeDeleted = false) {
+            const unreadAlerts = await this.alertRepository.findUnread(includeDeleted);
+            // Business logic: Log unread alerts for monitoring
+            if (unreadAlerts.length > 0) {
+                console.warn(`Found ${unreadAlerts.length} unread alerts`);
+            }
+            return unreadAlerts;
+        }
+        /**
+         * Get snoozed alerts with business logic
+         */
+        async getSnoozedAlerts(includeDeleted = false) {
+            return await this.alertRepository.findSnoozed(includeDeleted);
+        }
+        /**
+         * Get expired snooze alerts with business logic
+         */
+        async getExpiredSnoozeAlerts(includeDeleted = false) {
+            const expiredAlerts = await this.alertRepository.findExpiredSnooze(includeDeleted);
+            // Business logic: Log expired snooze alerts
+            if (expiredAlerts.length > 0) {
+                console.warn(`Found ${expiredAlerts.length} alerts with expired snooze`);
+            }
+            return expiredAlerts;
+        }
+        /**
+         * Get alert statistics with business logic
+         */
+        async getAlertStatistics(propertyId) {
+            const stats = await this.alertRepository.getStatistics(propertyId);
+            // Business logic: Add alerts for critical metrics
+            if (stats.unread > 0) {
+                console.warn(`Alert: ${stats.unread} unread alerts require attention`);
+            }
+            if (stats.bySeverity[alert_types_1.AlertSeverity.CRITICAL] > 0) {
+                console.error(`Alert: ${stats.bySeverity[alert_types_1.AlertSeverity.CRITICAL]} critical alerts require immediate attention`);
+            }
+            if (stats.bySeverity[alert_types_1.AlertSeverity.HIGH] > 0) {
+                console.warn(`Alert: ${stats.bySeverity[alert_types_1.AlertSeverity.HIGH]} high severity alerts require attention`);
+            }
+            return stats;
+        }
+        // Private business logic methods
+        validateAlertData(data) {
+            if (!data.title || data.title.trim().length < 3) {
+                throw new Error("Alert title must be at least 3 characters long");
+            }
+            if (!data.description || data.description.trim().length < 5) {
+                throw new Error("Alert description must be at least 5 characters long");
+            }
+            if (!data.propertyId) {
+                throw new Error("Property ID is required");
+            }
+            if (!data.entityType) {
+                throw new Error("Entity type is required");
+            }
+        }
+        validateFilters(filters) {
+            if (filters.limit && (filters.limit < 1 || filters.limit > 100)) {
+                throw new Error("Limit must be between 1 and 100");
+            }
+            if (filters.skip && filters.skip < 0) {
+                throw new Error("Skip must be non-negative");
+            }
+        }
+        validateUpdateData(data) {
+            if (data.title && data.title.trim().length < 3) {
+                throw new Error("Alert title must be at least 3 characters long");
+            }
+            if (data.description && data.description.trim().length < 5) {
+                throw new Error("Alert description must be at least 5 characters long");
+            }
+        }
+        validateSnoozeDate(snoozeUntil) {
+            if (snoozeUntil <= new Date()) {
+                throw new Error("Snooze date must be in the future");
+            }
+        }
+        determineDefaultSeverity(category) {
+            // Business logic: Determine default severity based on category
+            const categorySeverities = {
+                [alert_types_1.AlertCategory.READINESS]: alert_types_1.AlertSeverity.MEDIUM,
+                [alert_types_1.AlertCategory.OPERATIONS]: alert_types_1.AlertSeverity.HIGH,
+                [alert_types_1.AlertCategory.SECURITY]: alert_types_1.AlertSeverity.CRITICAL,
+                [alert_types_1.AlertCategory.ENERGY]: alert_types_1.AlertSeverity.LOW,
+                [alert_types_1.AlertCategory.OTHER]: alert_types_1.AlertSeverity.MEDIUM,
+            };
+            return categorySeverities[category] || alert_types_1.AlertSeverity.MEDIUM;
+        }
+        applyBusinessRules(filters) {
+            // Business logic: Apply additional filters based on business rules
+            const enhancedFilters = { ...filters };
+            // Example: Always exclude deleted alerts unless explicitly requested
+            if (!enhancedFilters.includeDeleted) {
+                enhancedFilters.includeDeleted = false;
+            }
+            return enhancedFilters;
+        }
+    };
+    __setFunctionName(_classThis, "AlertService");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        AlertService = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return AlertService = _classThis;
+})();
+exports.AlertService = AlertService;