dt-common-device 3.0.10 → 3.0.11

package/src/alerts/AlertBuilder.example.ts

@@ -1,126 +0,0 @@
-import { AlertBuilder } from "./AlertBuilder";
-import { AlertCategory, AlertSeverity, EntityType } from "./alert.types";
-
-/**
- * Example usage of AlertBuilder
- * This file demonstrates various ways to use the AlertBuilder pattern
- */
-
-// Example 1: Basic alert creation
-export function createBasicAlert() {
-  const alertData = new AlertBuilder()
-    .setCategory(AlertCategory.OPERATIONS)
-    .setPropertyId("prop123")
-    .setTitle("Device Offline")
-    .setDescription("Device has been offline for more than 5 minutes")
-    .setEntityId("device456")
-    .setEntityType(EntityType.DEVICE)
-    .setSeverity(AlertSeverity.HIGH)
-    .setCreatedBy("user789")
-    .build();
-
-  return alertData;
-}
-
-// Example 2: Using static factory methods
-export function createDeviceAlert() {
-  const alertData = AlertBuilder.createDeviceAlert("device123", "prop456")
-    .setCategory(AlertCategory.READINESS)
-    .setTitle("Device Maintenance Required")
-    .setDescription("Device firmware update is available")
-    .setSeverity(AlertSeverity.MEDIUM)
-    .setCreatedBy("system")
-    .build();
-
-  return alertData;
-}
-
-// Example 3: Using predefined alert types
-export function createSecurityAlert() {
-  const alertData = AlertBuilder.createSecurityAlert()
-    .setPropertyId("prop789")
-    .setTitle("Unauthorized Access Attempt")
-    .setDescription("Multiple failed login attempts detected")
-    .setEntityId("user123")
-    .setEntityType(EntityType.USER)
-    .setCreatedBy("security-system")
-    .build();
-
-  return alertData;
-}
-
-// Example 4: Creating energy alert
-export function createEnergyAlert() {
-  const alertData = AlertBuilder.createEnergyAlert()
-    .setPropertyId("prop101")
-    .setTitle("High Energy Consumption")
-    .setDescription("Energy usage is 20% above normal levels")
-    .setEntityId("zone456")
-    .setEntityType(EntityType.COLLECTION)
-    .setCreatedBy("energy-monitor")
-    .build();
-
-  return alertData;
-}
-
-// Example 5: Creating hub alert
-export function createHubAlert() {
-  const alertData = AlertBuilder.createHubAlert("hub789", "prop202")
-    .setCategory(AlertCategory.OPERATIONS)
-    .setTitle("Hub Connection Lost")
-    .setDescription("Hub has lost connection to the network")
-    .setSeverity(AlertSeverity.CRITICAL)
-    .setCreatedBy("network-monitor")
-    .build();
-
-  return alertData;
-}
-
-// Example 6: Alert with snooze
-export function createSnoozedAlert() {
-  const snoozeUntil = new Date();
-  snoozeUntil.setHours(snoozeUntil.getHours() + 2); // Snooze for 2 hours
-
-  const alertData = new AlertBuilder()
-    .setCategory(AlertCategory.OTHER)
-    .setPropertyId("prop303")
-    .setTitle("Scheduled Maintenance")
-    .setDescription("System maintenance scheduled for tonight")
-    .setEntityType(EntityType.PROPERTY)
-    .setSeverity(AlertSeverity.INFO)
-    .setCreatedBy("admin")
-    .setSnoozeUntil(snoozeUntil)
-    .build();
-
-  return alertData;
-}
-
-// Example 7: Reusing builder instance
-export function createMultipleAlerts() {
-  const builder = new AlertBuilder()
-    .setPropertyId("prop404")
-    .setCreatedBy("system");
-
-  const alert1 = builder
-    .setCategory(AlertCategory.OPERATIONS)
-    .setTitle("Device Temperature High")
-    .setDescription("Device temperature exceeds normal operating range")
-    .setEntityId("device789")
-    .setEntityType(EntityType.DEVICE)
-    .setSeverity(AlertSeverity.HIGH)
-    .build();
-
-  const alert2 = builder
-    .reset()
-    .setPropertyId("prop404")
-    .setCategory(AlertCategory.ENERGY)
-    .setTitle("Low Battery Warning")
-    .setDescription("Device battery level is below 20%")
-    .setEntityId("device789")
-    .setEntityType(EntityType.DEVICE)
-    .setSeverity(AlertSeverity.MEDIUM)
-    .setCreatedBy("system")
-    .build();
-
-  return [alert1, alert2];
-}

package/src/alerts/AlertBuilder.ts

@@ -1,208 +0,0 @@
-import {
-  CreateAlertData,
-  AlertCategory,
-  AlertSeverity,
-  EntityType,
-} from "./alert.types";
-
-/**
- * AlertBuilder - A builder pattern implementation for constructing CreateAlertData objects
- *
- * This builder provides a fluent interface for creating alert data with proper validation
- * and default values. It follows the Builder pattern which is a standard design pattern
- * in TypeScript for constructing complex objects.
- *
- * Usage example:
- * const alertData = new AlertBuilder()
- *   .setCategory(AlertCategory.OPERATIONS)
- *   .setPropertyId("prop123")
- *   .setTitle("Device Offline")
- *   .setDescription("Device has been offline for more than 5 minutes")
- *   .setEntityId("device456")
- *   .setEntityType(EntityType.DEVICE)
- *   .setSeverity(AlertSeverity.HIGH)
- *   .setCreatedBy("user789")
- *   .build();
- */
-export class AlertBuilder {
-  private data: Partial<CreateAlertData> = {};
-
-  /**
-   * Sets the alert category
-   */
-  setCategory(category: AlertCategory | AlertCategory[]): AlertBuilder {
-    this.data.category = Array.isArray(category) ? category : [category];
-    return this;
-  }
-
-  /**
-   * Sets the property ID
-   */
-  setPropertyId(propertyId: string): AlertBuilder {
-    if (!propertyId || propertyId.trim() === "") {
-      throw new Error("Property ID is required and cannot be empty");
-    }
-    this.data.propertyId = propertyId;
-    return this;
-  }
-
-  /**
-   * Sets the alert title
-   */
-  setTitle(title: string): AlertBuilder {
-    if (!title || title.trim() === "") {
-      throw new Error("Title is required and cannot be empty");
-    }
-    this.data.title = title.trim();
-    return this;
-  }
-
-  /**
-   * Sets the alert description
-   */
-  setDescription(description: string): AlertBuilder {
-    if (!description || description.trim() === "") {
-      throw new Error("Description is required and cannot be empty");
-    }
-    this.data.description = description.trim();
-    return this;
-  }
-
-  /**
-   * Sets the entity ID (optional)
-   */
-  setEntityId(entityId?: string): AlertBuilder {
-    if (entityId !== undefined) {
-      this.data.entityId = entityId.trim() || undefined;
-    }
-    return this;
-  }
-
-  /**
-   * Sets the entity type
-   */
-  setEntityType(entityType: EntityType): AlertBuilder {
-    this.data.entityType = entityType;
-    return this;
-  }
-
-  /**
-   * Sets the alert severity (optional, defaults to MEDIUM)
-   */
-  setSeverity(severity?: AlertSeverity): AlertBuilder {
-    if (severity !== undefined) {
-      this.data.severity = severity;
-    }
-    return this;
-  }
-
-  /**
-   * Sets the user who created the alert (optional)
-   */
-  setCreatedBy(createdBy?: string): AlertBuilder {
-    if (createdBy !== undefined) {
-      this.data.createdBy = createdBy.trim() || undefined;
-    }
-    return this;
-  }
-
-  /**
-   * Sets the snooze until date (optional)
-   */
-  setSnoozeUntil(snoozeUntil?: Date): AlertBuilder {
-    if (snoozeUntil !== undefined) {
-      this.data.snoozeUntil = snoozeUntil;
-    }
-    return this;
-  }
-
-  /**
-   * Validates that all required fields are present
-   */
-  private validate(): void {
-    const requiredFields = [
-      "category",
-      "propertyId",
-      "title",
-      "description",
-      "entityType",
-    ];
-    const missingFields = requiredFields.filter(
-      (field) => !this.data[field as keyof CreateAlertData]
-    );
-
-    if (missingFields.length > 0) {
-      throw new Error(`Missing required fields: ${missingFields.join(", ")}`);
-    }
-  }
-
-  /**
-   * Builds and returns the CreateAlertData object
-   * @throws Error if required fields are missing
-   */
-  build(): CreateAlertData {
-    this.validate();
-
-    // Set default severity if not provided
-    if (!this.data.severity) {
-      this.data.severity = AlertSeverity.MEDIUM;
-    }
-
-    return this.data as CreateAlertData;
-  }
-
-  /**
-   * Resets the builder to its initial state
-   */
-  reset(): AlertBuilder {
-    this.data = {};
-    return this;
-  }
-
-  /**
-   * Creates a new builder instance with predefined values for common alert types
-   */
-  static createReadinessAlert(): AlertBuilder {
-    return new AlertBuilder()
-      .setCategory(AlertCategory.READINESS)
-      .setSeverity(AlertSeverity.MEDIUM);
-  }
-
-  static createOperationsAlert(): AlertBuilder {
-    return new AlertBuilder()
-      .setCategory(AlertCategory.OPERATIONS)
-      .setSeverity(AlertSeverity.HIGH);
-  }
-
-  static createSecurityAlert(): AlertBuilder {
-    return new AlertBuilder()
-      .setCategory(AlertCategory.SECURITY)
-      .setSeverity(AlertSeverity.CRITICAL);
-  }
-
-  static createEnergyAlert(): AlertBuilder {
-    return new AlertBuilder()
-      .setCategory(AlertCategory.ENERGY)
-      .setSeverity(AlertSeverity.LOW);
-  }
-
-  /**
-   * Creates a device-specific alert builder
-   */
-  static createDeviceAlert(deviceId: string, propertyId: string): AlertBuilder {
-    return new AlertBuilder()
-      .setEntityType(EntityType.DEVICE)
-      .setEntityId(deviceId)
-      .setPropertyId(propertyId);
-  }
-
-  /**
-   * Creates a hub-specific alert builder
-   */
-  static createHubAlert(hubId: string, propertyId: string): AlertBuilder {
-    return new AlertBuilder()
-      .setEntityType(EntityType.HUB)
-      .setEntityId(hubId)
-      .setPropertyId(propertyId);
-  }
-}

package/src/alerts/AlertService.example.ts

@@ -1,232 +0,0 @@
-import { Source } from "../constants/Service";
-import { AlertService } from "./Alert.service";
-import { AlertBuilder } from "./AlertBuilder";
-import { AlertCategory, AlertSeverity, EntityType } from "./alert.types";
-
-/**
- * Example usage of the updated AlertService with AlertBuilder integration
- * This file demonstrates various ways to use the AlertService with the new AlertBuilder
- */
-
-export class AlertServiceExample {
-  constructor(private readonly alertService: AlertService) {}
-
-  /**
-   * Example 1: Using the updated createAlert method with AlertBuilder
-   */
-  async createAlertWithBuilder() {
-    const alertBuilder = new AlertBuilder()
-      .setCategory(AlertCategory.OPERATIONS)
-      .setPropertyId("prop123")
-      .setTitle("Device Offline")
-      .setDescription("Device has been offline for more than 5 minutes")
-      .setEntityId("device456")
-      .setEntityType(EntityType.DEVICE)
-      .setSeverity(AlertSeverity.HIGH)
-      .setCreatedBy("user789");
-
-    // Pass the AlertBuilder directly to createAlert
-    const alert = await this.alertService.createAlert(alertBuilder);
-    return alert;
-  }
-
-  /**
-   * Example 2: Using convenience methods for specific alert types
-   */
-  async createSpecificAlerts() {
-    // Create a readiness alert
-    const readinessAlert = await this.alertService.raiseReadinessAlert(
-      "prop123",
-      "System Maintenance Required",
-      "System maintenance is scheduled for tonight",
-      "system456",
-      EntityType.PROPERTY,
-      "admin"
-    );
-
-    // Create an operations alert
-    const operationsAlert = await this.alertService.raiseOperationsAlert(
-      "prop123",
-      "Device Temperature High",
-      "Device temperature exceeds normal operating range",
-      "device789",
-      EntityType.DEVICE,
-      "monitor"
-    );
-
-    // Create a security alert
-    const securityAlert = await this.alertService.raiseSecurityAlert(
-      "prop123",
-      "Unauthorized Access Attempt",
-      "Multiple failed login attempts detected",
-      "user123",
-      EntityType.USER,
-      "security-system"
-    );
-
-    // Create an energy alert
-    const energyAlert = await this.alertService.raiseEnergyAlert(
-      "prop123",
-      "High Energy Consumption",
-      "Energy usage is 20% above normal levels",
-      "zone456",
-      EntityType.COLLECTION,
-      "energy-monitor"
-    );
-
-    return { readinessAlert, operationsAlert, securityAlert, energyAlert };
-  }
-
-  /**
-   * Example 3: Using device-specific alert methods
-   */
-  async createDeviceAlerts() {
-    // Create a device alert with default category and severity
-    const deviceAlert1 = await this.alertService.raiseDeviceAlert(
-      "device123",
-      "prop456",
-      "Device Battery Low",
-      "Device battery level is below 20%",
-      undefined, // Use default category
-      undefined, // Use default severity
-      Source.CLOUD_EVENT
-    );
-
-    // Create a device alert with custom category and severity
-    const deviceAlert2 = await this.alertService.raiseDeviceAlert(
-      "device789",
-      "prop456",
-      "Device Firmware Update Available",
-      "New firmware version is available for installation",
-      AlertCategory.READINESS,
-      AlertSeverity.MEDIUM,
-      Source.CLOUD_EVENT
-    );
-
-    return { deviceAlert1, deviceAlert2 };
-  }
-
-  /**
-   * Example 4: Using hub-specific alert methods
-   */
-  async createHubAlerts() {
-    // Create a hub alert with default settings
-    const hubAlert1 = await this.alertService.raiseHubAlert(
-      "hub123",
-      "prop456",
-      "Hub Connection Lost",
-      "Hub has lost connection to the network",
-      undefined, // Use default category
-      undefined, // Use default severity
-      "network-monitor"
-    );
-
-    // Create a hub alert with custom settings
-    const hubAlert2 = await this.alertService.raiseHubAlert(
-      "hub789",
-      "prop456",
-      "Hub Maintenance Required",
-      "Hub requires scheduled maintenance",
-      AlertCategory.READINESS,
-      AlertSeverity.LOW,
-      "maintenance-system"
-    );
-
-    return { hubAlert1, hubAlert2 };
-  }
-
-  /**
-   * Example 5: Using static factory methods with AlertBuilder
-   */
-  async createAlertsWithStaticMethods() {
-    // Create a device alert using static factory method
-    const deviceAlert = AlertBuilder.createDeviceAlert("device123", "prop456")
-      .setCategory(AlertCategory.OPERATIONS)
-      .setTitle("Device Offline")
-      .setDescription("Device has been offline for more than 5 minutes")
-      .setSeverity(AlertSeverity.HIGH)
-      .setCreatedBy("monitor");
-
-    const alert1 = await this.alertService.createAlert(deviceAlert);
-
-    // Create a hub alert using static factory method
-    const hubAlert = AlertBuilder.createHubAlert("hub789", "prop202")
-      .setCategory(AlertCategory.SECURITY)
-      .setTitle("Hub Security Breach")
-      .setDescription("Unauthorized access attempt detected on hub")
-      .setSeverity(AlertSeverity.CRITICAL)
-      .setCreatedBy("security-system");
-
-    const alert2 = await this.alertService.createAlert(hubAlert);
-
-    return { alert1, alert2 };
-  }
-
-  /**
-   * Example 6: Creating multiple alerts efficiently
-   */
-  async createMultipleAlerts() {
-    const alerts = [];
-
-    // Create multiple device alerts efficiently
-    const deviceIds = ["device1", "device2", "device3"];
-    const propertyId = "prop123";
-
-    for (const deviceId of deviceIds) {
-      const alertBuilder = AlertBuilder.createDeviceAlert(deviceId, propertyId)
-        .setCategory(AlertCategory.OPERATIONS)
-        .setTitle(`Device ${deviceId} Status`)
-        .setDescription(`Status check for device ${deviceId}`)
-        .setSeverity(AlertSeverity.MEDIUM)
-        .setCreatedBy("batch-processor");
-
-      const alert = await this.alertService.createAlert(alertBuilder);
-      alerts.push(alert);
-    }
-
-    return alerts;
-  }
-
-  /**
-   * Example 7: Creating alerts with snooze functionality
-   */
-  async createSnoozedAlert() {
-    const snoozeUntil = new Date();
-    snoozeUntil.setHours(snoozeUntil.getHours() + 2); // Snooze for 2 hours
-
-    const alertBuilder = new AlertBuilder()
-      .setCategory(AlertCategory.OTHER)
-      .setPropertyId("prop303")
-      .setTitle("Scheduled Maintenance")
-      .setDescription("System maintenance scheduled for tonight")
-      .setEntityType(EntityType.PROPERTY)
-      .setSeverity(AlertSeverity.INFO)
-      .setCreatedBy("admin")
-      .setSnoozeUntil(snoozeUntil);
-
-    const alert = await this.alertService.createAlert(alertBuilder);
-    return alert;
-  }
-
-  /**
-   * Example 8: Backward compatibility - still works with CreateAlertData
-   */
-  async createAlertWithLegacyData() {
-    const alertData = {
-      category: [AlertCategory.OPERATIONS],
-      propertyId: "prop123",
-      title: "Legacy Alert",
-      description:
-        "This alert was created using the old CreateAlertData format",
-      entityId: "device456",
-      entityType: EntityType.DEVICE,
-      severity: AlertSeverity.MEDIUM,
-      createdBy: "legacy-system",
-      source: Source.CLOUD_EVENT,
-    };
-
-    // This still works with the updated createAlert method
-    const alert = await this.alertService.createAlert(alertData);
-    return alert;
-  }
-}

package/src/alerts/alert.types.ts

@@ -1,64 +0,0 @@
-import { EntityType } from "../issues/issue.types";
-
-export enum AlertCategory {
-  READINESS = "READINESS",
-  OPERATIONS = "OPERATIONS",
-  SECURITY = "SECURITY",
-  ENERGY = "ENERGY",
-  OTHER = "OTHER",
-}
-
-export enum AlertSeverity {
-  INFO = "INFO",
-  LOW = "LOW",
-  MEDIUM = "MEDIUM",
-  HIGH = "HIGH",
-  CRITICAL = "CRITICAL",
-}
-
-export interface AlertDocument {
-  _id: string;
-  category: AlertCategory[];
-  propertyId: string;
-  title: string;
-  description: string;
-  entityId?: string;
-  entityType: EntityType;
-  severity: AlertSeverity;
-  isRead: boolean;
-  isActive: boolean;
-  isDeleted: boolean;
-  snoozeUntil?: Date;
-  createdBy?: string;
-  updatedBy?: string;
-  createdAt: Date;
-  updatedAt: Date;
-}
-
-export interface CreateAlertData {
-  category: AlertCategory[];
-  propertyId: string;
-  title: string;
-  description: string;
-  entityId?: string;
-  entityType: EntityType;
-  severity?: AlertSeverity;
-  createdBy?: string;
-  snoozeUntil?: Date;
-}
-
-export interface UpdateAlertData {
-  category?: AlertCategory[];
-  title?: string;
-  description?: string;
-  entityId?: string;
-  entityType?: EntityType;
-  severity?: AlertSeverity;
-  isRead?: boolean;
-  isActive?: boolean;
-  snoozeUntil?: Date;
-  updatedBy?: string;
-}
-
-// Re-export EntityType from issue.types.ts to avoid duplication
-export { EntityType } from "../issues/issue.types";

package/src/alerts/index.ts

@@ -1,3 +0,0 @@
-export * from "./Alert.service";
-export * from "./AlertBuilder";
-export * from "./alert.types";