dt-common-device 3.0.2 → 3.0.3

package/src/alerts/Alert.service.ts

@@ -8,7 +8,9 @@ import {
   AlertSeverity,
   EntityType,
 } from "./alert.types";
+import { Source } from "../constants/Service";
 import { AlertBuilder } from "./AlertBuilder";
+import { IDevice } from "../device/local/interfaces";
 
 @Service()
 export class AlertService {
@@ -114,9 +116,9 @@ export class AlertService {
     propertyId: string,
     title: string,
     description: string,
-    category?: AlertCategory,
+    category?: AlertCategory | AlertCategory[],
     severity?: AlertSeverity,
-    createdBy?: string
+    source?: Source
   ): Promise<IAlertDocument> {
     const alertBuilder = AlertBuilder.createDeviceAlert(deviceId, propertyId)
       .setTitle(title)
@@ -124,7 +126,7 @@ export class AlertService {
 
     if (category) alertBuilder.setCategory(category);
     if (severity) alertBuilder.setSeverity(severity);
-    if (createdBy) alertBuilder.setCreatedBy(createdBy);
+    if (source) alertBuilder.setCreatedBy(source);
 
     return await this.createAlert(alertBuilder);
   }
@@ -137,7 +139,7 @@ export class AlertService {
     propertyId: string,
     title: string,
     description: string,
-    category?: AlertCategory,
+    category?: AlertCategory | AlertCategory[],
     severity?: AlertSeverity,
     createdBy?: string
   ): Promise<IAlertDocument> {
@@ -152,6 +154,68 @@ export class AlertService {
     return await this.createAlert(alertBuilder);
   }
 
+  /**
+   * Raise alert for device going offline
+   */
+  async raiseDeviceOfflineAlert(
+    device: IDevice,
+    source: Source,
+    reason?: string
+  ): Promise<IAlertDocument> {
+    return await this.raiseDeviceAlert(
+      device.deviceId,
+      device.propertyId,
+      "Device Offline",
+      `Device ${device.name} (${device.deviceId}) has gone offline. ${
+        reason ? `Reason: ${reason}` : ""
+      }`,
+      [AlertCategory.OPERATIONS],
+      AlertSeverity.HIGH,
+      source
+    );
+  }
+
+  /**
+   * Raise alert for device coming online
+   */
+  async raiseDeviceOnlineAlert(
+    device: IDevice,
+    source: Source,
+    reason?: string
+  ): Promise<IAlertDocument> {
+    return await this.raiseDeviceAlert(
+      device.deviceId,
+      device.propertyId,
+      "Device Online",
+      `Device ${device.name} (${device.deviceId}) is now online. ${
+        reason ? `Reason: ${reason}` : ""
+      }`,
+      [AlertCategory.OPERATIONS],
+      AlertSeverity.INFO,
+      source
+    );
+  }
+
+  /**
+   * Raise alert for device battery level below threshold
+   */
+  async raiseDeviceBatteryAlert(
+    device: IDevice,
+    batteryLevel: number,
+    threshold: number,
+    source: Source
+  ): Promise<IAlertDocument> {
+    return await this.raiseDeviceAlert(
+      device.deviceId,
+      device.propertyId,
+      "Device Battery Low",
+      `Device ${device.name} (${device.deviceId}) battery level is ${batteryLevel}%, which is below the property threshold of ${threshold}%.`,
+      [AlertCategory.ENERGY],
+      AlertSeverity.MEDIUM,
+      source
+    );
+  }
+
   /**
    * Create a new alert with business logic validation
    * Accepts either a CreateAlertData object or an AlertBuilder instance
@@ -216,7 +280,7 @@ export class AlertService {
   async getAlerts(
     filters: {
       propertyId?: string;
-      category?: AlertCategory;
+      category?: AlertCategory | AlertCategory[];
       severity?: AlertSeverity;
       entityType?: EntityType;
       entityId?: string;
@@ -440,7 +504,7 @@ export class AlertService {
    * Get alerts by category with business logic
    */
   async getAlertsByCategory(
-    category: AlertCategory,
+    category: AlertCategory | AlertCategory[],
     includeDeleted = false
   ): Promise<IAlertDocument[]> {
     if (!category) {
@@ -600,7 +664,9 @@ export class AlertService {
     }
   }
 
-  private determineDefaultSeverity(category: AlertCategory): AlertSeverity {
+  private determineDefaultSeverity(
+    category: AlertCategory | AlertCategory[]
+  ): AlertSeverity {
     // Business logic: Determine default severity based on category
     const categorySeverities: Record<AlertCategory, AlertSeverity> = {
       [AlertCategory.READINESS]: AlertSeverity.MEDIUM,
@@ -610,6 +676,24 @@ export class AlertService {
       [AlertCategory.OTHER]: AlertSeverity.MEDIUM,
     };
 
+    // If it's an array, use the highest severity category
+    if (Array.isArray(category)) {
+      const severities = category.map(
+        (cat) => categorySeverities[cat] || AlertSeverity.MEDIUM
+      );
+      const severityOrder = [
+        AlertSeverity.CRITICAL,
+        AlertSeverity.HIGH,
+        AlertSeverity.MEDIUM,
+        AlertSeverity.LOW,
+        AlertSeverity.INFO,
+      ];
+      return (
+        severityOrder.find((severity) => severities.includes(severity)) ||
+        AlertSeverity.MEDIUM
+      );
+    }
+
     return categorySeverities[category] || AlertSeverity.MEDIUM;
   }
 

package/src/alerts/AlertBuilder.ts

@@ -30,8 +30,8 @@ export class AlertBuilder {
   /**
    * Sets the alert category
    */
-  setCategory(category: AlertCategory): AlertBuilder {
-    this.data.category = category;
+  setCategory(category: AlertCategory | AlertCategory[]): AlertBuilder {
+    this.data.category = Array.isArray(category) ? category : [category];
     return this;
   }
 

package/src/alerts/AlertService.example.ts

@@ -1,3 +1,4 @@
+import { Source } from "../constants/Service";
 import { AlertService } from "./Alert.service";
 import { AlertBuilder } from "./AlertBuilder";
 import { AlertCategory, AlertSeverity, EntityType } from "./alert.types";
@@ -88,7 +89,7 @@ export class AlertServiceExample {
       "Device battery level is below 20%",
       undefined, // Use default category
       undefined, // Use default severity
-      "system"
+      Source.CLOUD_EVENT
     );
 
     // Create a device alert with custom category and severity
@@ -99,7 +100,7 @@ export class AlertServiceExample {
       "New firmware version is available for installation",
       AlertCategory.READINESS,
       AlertSeverity.MEDIUM,
-      "firmware-manager"
+      Source.CLOUD_EVENT
     );
 
     return { deviceAlert1, deviceAlert2 };
@@ -212,7 +213,7 @@ export class AlertServiceExample {
    */
   async createAlertWithLegacyData() {
     const alertData = {
-      category: AlertCategory.OPERATIONS,
+      category: [AlertCategory.OPERATIONS],
       propertyId: "prop123",
       title: "Legacy Alert",
       description:
@@ -221,6 +222,7 @@ export class AlertServiceExample {
       entityType: EntityType.DEVICE,
       severity: AlertSeverity.MEDIUM,
       createdBy: "legacy-system",
+      source: Source.CLOUD_EVENT,
     };
 
     // This still works with the updated createAlert method

package/src/alerts/alert.types.ts

@@ -18,7 +18,7 @@ export enum AlertSeverity {
 
 export interface AlertDocument {
   _id: string;
-  category: AlertCategory;
+  category: AlertCategory[];
   propertyId: string;
   title: string;
   description: string;
@@ -36,7 +36,7 @@ export interface AlertDocument {
 }
 
 export interface CreateAlertData {
-  category: AlertCategory;
+  category: AlertCategory[];
   propertyId: string;
   title: string;
   description: string;
@@ -48,7 +48,7 @@ export interface CreateAlertData {
 }
 
 export interface UpdateAlertData {
-  category?: AlertCategory;
+  category?: AlertCategory[];
   title?: string;
   description?: string;
   entityId?: string;

package/src/config/config.ts

@@ -1,8 +1,8 @@
 import { initializeAudit } from "dt-audit-library";
-import { connectDatabase } from "src/db/db";
+import { connectDatabase } from "../db/db";
 import dotenv from "dotenv";
-import { InternalEventSubscription } from "src/events";
-import { validateServiceUrl } from "src/utils/http.utils";
+import { InternalEventSubscription } from "../events";
+import { validateServiceUrl } from "../utils/http.utils";
 import { IConfig } from "./config.types";
 
 dotenv.config();

package/src/connection/Connection.repository.ts

@@ -1,4 +1,4 @@
-import { getPostgresClient } from "src/db";
+import { getPostgresClient } from "../db";
 import { IConnection } from "./IConnection";
 import { Service } from "typedi";
 

package/src/constants/ConnectionProviders.ts

@@ -0,0 +1,11 @@
+export const CONNECTION_PROVIDERS = {
+  DEVICETHREAD: "Devicethread",
+  SALTOKS: "SaltoKS",
+  SCHLAGE: "Schlage",
+  SENSIBO: "Sensibo",
+  SMARTTHINGS: "Smartthings",
+  TTLOCK: "TTLock",
+  TUYA: "Tuya",
+  VERDANT: "Verdant",
+  YALEWIFI: "YaleWifi",
+} as const;

package/src/constants/Event.ts

@@ -39,6 +39,20 @@ export const DT_EVENT_TYPES = {
       UPDATED: "device.metaData.updated",
       CHANGED: "device.metaData.changed",
     },
+    EVENT: {
+      RECEIVED: "device.event.received",
+      REGISTERED: "device.event.registered",
+      UNREGISTERED: "device.event.unregistered",
+      PROCESSED: "device.event.processed",
+      UNPROCESSED: "device.event.unprocessed",
+    },
+    WEBHOOK: {
+      RECEIVED: "device.webhook.received",
+      REGISTERED: "device.webhook.registered",
+      UNREGISTERED: "device.webhook.unregistered",
+      PROCESSED: "device.webhook.processed",
+      UNPROCESSED: "device.webhook.unprocessed",
+    },
   },
   CONNECTION: {
     CREATE: {

package/src/constants/Service.ts

@@ -0,0 +1,17 @@
+export const SERVICE_NAMES = {
+  CLOUD: "smart-cloud",
+  ACCESS: "smart-access",
+  ENERGY: "smart-energy",
+  SCHEDULE: "smart-schedule",
+  DEVICE: "smart-device",
+} as const;
+
+
+export enum Source {
+  USER = "user",
+  CLOUD_EVENT = "cloud-event",
+  CLOUD_WEBHOOK = "cloud-webhook",
+  HEARTBEAT = "heartbeat",
+  CODE_ACTION = "code-action",
+  DEVICE_ACTION = "device-action",
+}

package/src/constants/index.ts

@@ -0,0 +1,3 @@
+export * from "./ConnectionProviders";
+export * from "./Event";
+export * from "./Service";

package/src/device/cloud/entities/CloudDevice.ts

@@ -1,7 +1,7 @@
-import { IDevice } from "src/device/local/interfaces";
+import { IDevice } from "../../local/interfaces";
 import { ICloudDevice } from "../interfaces/ICloudDevice";
 import { ICloudDeviceService } from "../interfaces/ICloudDeviceService";
-import { IConnection } from "src/connection";
+import { IConnection } from "../../../connection";
 
 export abstract class CloudDevice implements ICloudDevice {
   deviceId: string;

package/src/device/cloud/entities/CloudDeviceService.ts

@@ -1,5 +1,5 @@
 import { ICloudDeviceService } from "../interfaces/ICloudDeviceService";
-import { IConnection } from "src/connection";
+import { IConnection } from "../../../connection";
 
 export class CloudDeviceService implements ICloudDeviceService {
   async getConnection(deviceId: string): Promise<IConnection> {

package/src/device/cloud/entities/DeviceFactory.ts

@@ -1,5 +1,5 @@
-import { IDevice } from "src/device/local/interfaces";
-import { LocalDeviceService } from "src/device/local/services/Device.service";
+import { IDevice } from "../../local/interfaces";
+import { LocalDeviceService } from "../../local/services/Device.service";
 import { IDeviceFactory } from "../interfaces/IDeviceFactory";
 
 export class DeviceFactory implements IDeviceFactory {

package/src/device/local/interfaces/IDevice.ts

@@ -42,8 +42,8 @@ export interface IDevice {
     value: boolean;
     lastUpdated: string;
   };
-  state?: object;
-  metaData?: object;
+  state?: Record<string, any>;
+  metaData?: Record<string, any>;
   createdAt?: Date;
   updatedAt?: Date;
   hubDeviceDetails?: IDevice[];
@@ -51,6 +51,7 @@ export interface IDevice {
 
 export class IStatus {
   online: boolean = false;
+  liveStatus?: "ONLINE" | "OFFLINE";
   error?: {
     type?: string;
     message?: string;

package/src/device/local/repository/Device.repository.ts

@@ -1,9 +1,9 @@
 import { IDevice, IStatus } from "../interfaces/IDevice";
-import { getConfig } from "src/config/config";
-import { getPostgresClient } from "src/db";
+import { getConfig } from "../../../config/config";
+import { getPostgresClient } from "../../../db";
 import { Service } from "typedi";
 import { IDtDevice } from "../interfaces/IDtDevice";
-import { getDeviceServiceAxiosInstance } from "src/utils/http.utils";
+import { getDeviceServiceAxiosInstance } from "../../../utils/http.utils";
 
 @Service()
 export class DeviceRepository {

package/src/device/local/repository/Hub.repository.ts

@@ -1,8 +1,8 @@
-import { getConfig } from "src/config/config";
-import { getPostgresClient } from "src/db";
+import { getConfig } from "../../../config/config";
+import { getPostgresClient } from "../../../db";
 import { Service } from "typedi";
 import { IDevice } from "../interfaces";
-import { getDeviceServiceAxiosInstance } from "src/utils/http.utils";
+import { getDeviceServiceAxiosInstance } from "../../../utils/http.utils";
 
 @Service()
 export class HubRepository {

package/src/device/local/repository/Schedule.repository.ts

@@ -1,7 +1,7 @@
 import { Service } from "typedi";
-import { getConfig } from "src/config/config";
+import { getConfig } from "../../../config/config";
 import { ISchedule } from "../interfaces/ISchedule";
-import { getDeviceServiceAxiosInstance } from "src/utils/http.utils";
+import { getDeviceServiceAxiosInstance } from "../../../utils/http.utils";
 
 @Service()
 export class ScheduleRepository {