dt-common-device 9.1.3 → 9.1.4

package/dist/device/local/events/Events.d.ts

@@ -0,0 +1,54 @@
+export declare const DT_EVENT_TYPES: {
+    DEVICE: {
+        DEVICE: {
+            CREATED: string;
+            UPDATED: string;
+            DELETED: string;
+        };
+        STATE: {
+            SET: string;
+            UNKNOWN: string;
+            UPDATED: string;
+            CHANGED: string;
+        };
+        STATUS: {
+            SET: string;
+            ONLINE: string;
+            OFFLINE: string;
+            UNKNOWN: string;
+            UPDATED: string;
+            CHANGED: string;
+        };
+        BATTERY: {
+            SET: string;
+            UNKNOWN: string;
+            LOW: string;
+            CRITICAL: string;
+            UPDATED: string;
+            CHANGED: string;
+        };
+        META_DATA: {
+            SET: string;
+            UPDATED: string;
+            CHANGED: string;
+        };
+    };
+    CONNECTION: {
+        CONNECTION: {
+            CREATED: string;
+            UPDATED: string;
+            DELETED: string;
+        };
+    };
+    PROPERTY: {
+        PROPERTY: {
+            CREATED: string;
+            UPDATED: string;
+            DELETED: string;
+        };
+        PREFERENCES: {
+            UPDATED: string;
+            CREATED: string;
+        };
+    };
+};

package/dist/device/local/events/Events.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DT_EVENT_TYPES = void 0;
+exports.DT_EVENT_TYPES = {
+    DEVICE: {
+        DEVICE: {
+            CREATED: "device.device.created",
+            UPDATED: "device.device.updated",
+            DELETED: "device.device.deleted",
+        },
+        STATE: {
+            SET: "device.state.set",
+            UNKNOWN: "device.state.unknown",
+            UPDATED: "device.state.updated",
+            CHANGED: "device.state.changed",
+        },
+        STATUS: {
+            SET: "device.status.set",
+            ONLINE: "device.status.online",
+            OFFLINE: "device.status.offline",
+            UNKNOWN: "device.status.unknown",
+            UPDATED: "device.status.updated",
+            CHANGED: "device.status.changed",
+        },
+        BATTERY: {
+            SET: "device.battery.set",
+            UNKNOWN: "device.battery.unknown",
+            LOW: "device.battery.low",
+            CRITICAL: "device.battery.critical",
+            UPDATED: "device.battery.updated",
+            CHANGED: "device.battery.changed",
+        },
+        META_DATA: {
+            SET: "device.metaData.set",
+            UPDATED: "device.metaData.updated",
+            CHANGED: "device.metaData.changed",
+        },
+    },
+    CONNECTION: {
+        CONNECTION: {
+            CREATED: "connection.connection.created",
+            UPDATED: "connection.connection.updated",
+            DELETED: "connection.connection.deleted",
+        },
+    },
+    PROPERTY: {
+        PROPERTY: {
+            CREATED: "property.property.created",
+            UPDATED: "property.property.updated",
+            DELETED: "property.property.deleted",
+        },
+        PREFERENCES: {
+            UPDATED: "property.preferences.updated",
+            CREATED: "property.preferences.created",
+        },
+    },
+};

package/dist/device/local/events/index.d.ts

@@ -0,0 +1,2 @@
+export { DT_EVENT_TYPES } from "./Events";
+export { EventHandler } from "./EventHandler";

package/dist/device/local/events/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventHandler = exports.DT_EVENT_TYPES = void 0;
+var Events_1 = require("./Events");
+Object.defineProperty(exports, "DT_EVENT_TYPES", { enumerable: true, get: function () { return Events_1.DT_EVENT_TYPES; } });
+var EventHandler_1 = require("./EventHandler");
+Object.defineProperty(exports, "EventHandler", { enumerable: true, get: function () { return EventHandler_1.EventHandler; } });

package/dist/device/local/handler/EventHandler.d.ts

@@ -0,0 +1,7 @@
+export declare class EventHandler {
+    private readonly source;
+    constructor();
+    onStateChange(deviceId: string, state: any): Promise<void>;
+    onStatusChange(deviceId: string, status: any): Promise<void>;
+    onBatteryLevelChange(deviceId: string, batteryLevel: number): Promise<void>;
+}

package/dist/device/local/handler/EventHandler.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventHandler = void 0;
+const dt_pub_sub_1 = require("dt-pub-sub");
+const dt_audit_library_1 = require("dt-audit-library");
+class EventHandler {
+    constructor() {
+        this.source = "dt-common-device";
+    }
+    async onStateChange(deviceId, state) {
+        await dt_pub_sub_1.eventDispatcher.publishEvent("device.state.set", { deviceId, state }, this.source);
+        const payload = {
+            eventType: "device.state.set",
+            properties: {
+                deviceId,
+                state,
+            },
+        };
+        await (0, dt_audit_library_1.publishAudit)(payload);
+    }
+    async onStatusChange(deviceId, status) {
+        await dt_pub_sub_1.eventDispatcher.publishEvent("device.status.set", { deviceId, status }, this.source);
+        const payload = {
+            eventType: "device.status.set",
+            properties: {
+                deviceId,
+                status,
+            },
+        };
+        await (0, dt_audit_library_1.publishAudit)(payload);
+    }
+    async onBatteryLevelChange(deviceId, batteryLevel) {
+        await dt_pub_sub_1.eventDispatcher.publishEvent("device.battery.set", { deviceId, batteryLevel }, this.source);
+        const payload = {
+            eventType: "device.battery.set",
+            properties: {
+                deviceId,
+                batteryLevel,
+            },
+        };
+        await (0, dt_audit_library_1.publishAudit)(payload);
+    }
+}
+exports.EventHandler = EventHandler;

package/dist/device/local/interface.js

@@ -0,0 +1 @@
+"use strict";

package/dist/device/local/interfaces/IConnection.d.ts

@@ -0,0 +1,26 @@
+export interface IConnection {
+    id?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    isDeleted?: boolean;
+    connectionName: string;
+    connectionRefId: string;
+    propertyId: string;
+    connectionProvider: ConnectionProvider;
+    accessToken?: string;
+    refreshToken?: string;
+    clientId?: string;
+    clientSecret: string;
+    isActive?: boolean;
+    metaData?: any;
+}
+export declare enum ConnectionProvider {
+    Smartthings = "Smartthings",
+    SaltoKS = "SaltoKS",
+    TTLock = "TTLock",
+    Tuya = "Tuya",
+    Schlage = "Schlage",
+    YaleWifi = "YaleWifi",
+    Sensibo = "Sensibo",
+    Devicethread = "Devicethread"
+}

package/dist/device/local/interfaces/IConnection.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionProvider = void 0;
+var ConnectionProvider;
+(function (ConnectionProvider) {
+    ConnectionProvider["Smartthings"] = "Smartthings";
+    ConnectionProvider["SaltoKS"] = "SaltoKS";
+    ConnectionProvider["TTLock"] = "TTLock";
+    ConnectionProvider["Tuya"] = "Tuya";
+    ConnectionProvider["Schlage"] = "Schlage";
+    ConnectionProvider["YaleWifi"] = "YaleWifi";
+    ConnectionProvider["Sensibo"] = "Sensibo";
+    ConnectionProvider["Devicethread"] = "Devicethread";
+})(ConnectionProvider || (exports.ConnectionProvider = ConnectionProvider = {}));

package/dist/device/local/interfaces/IDevice.d.ts

@@ -0,0 +1,68 @@
+export interface IDevice {
+    deviceId: string;
+    propertyId: string;
+    zoneId: string;
+    name: string;
+    hubId: string[];
+    specifications: {
+        manufacturer?: string;
+        model?: string;
+        firmware?: {
+            version?: string;
+            newVersionAvailable?: boolean;
+            newVersion?: string;
+            mandatoryUpdate?: boolean;
+        };
+    };
+    protocol: {
+        location?: {
+            id?: string;
+            name?: string;
+            city?: string;
+        };
+        name?: string;
+        room?: {
+            id?: string;
+            name?: string;
+        };
+        accountId?: string;
+    };
+    connection: {
+        id: string;
+        name: string;
+    };
+    deviceType: {
+        id: string;
+        type: string;
+    };
+    status: IStatus;
+    isActive: {
+        value: boolean;
+        lastUpdated: string;
+    };
+    state?: Record<string, any>;
+    metaData?: Record<string, any>;
+    createdAt?: Date;
+    updatedAt?: Date;
+    hubDeviceDetails?: IDevice[];
+    capabilities?: Record<string, any>;
+}
+export declare class IStatus {
+    online: boolean;
+    liveStatus?: "ONLINE" | "OFFLINE";
+    error?: {
+        type?: string;
+        message?: string;
+        default?: object;
+    };
+    lastUpdated?: string;
+}
+export interface IStatusQuery {
+    deviceIds?: string[];
+    zoneId?: string;
+    propertyId?: string;
+}
+export interface IStatusUpdateRequest {
+    query: IStatusQuery;
+    status: IStatus;
+}

package/dist/device/local/interfaces/IDevice.js

@@ -0,0 +1,10 @@
+"use strict";
+// Interfaces for DeviceService methods
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IStatus = void 0;
+class IStatus {
+    constructor() {
+        this.online = false;
+    }
+}
+exports.IStatus = IStatus;

package/dist/device/local/interfaces/IDtDevice.d.ts

@@ -0,0 +1,16 @@
+export interface IDtDevice {
+    id: string;
+    name: string;
+    type: string;
+    zoneId: string;
+    deviceType: string;
+    deviceId: string;
+    deviceNetworkId: string;
+    propertyId: string;
+    connectionId: string;
+    hubId: string;
+    isBatteryLowAlertSent: boolean;
+    createdAt: string;
+    updatedAt: string;
+    isActive: boolean;
+}

package/dist/device/local/interfaces/IDtDevice.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/device/local/interfaces/IHub.d.ts

@@ -0,0 +1,46 @@
+export interface IHub {
+    deviceId: string;
+    propertyId: string;
+    name: string;
+    hubId?: string[];
+    specifications: {
+        manufacturer?: string;
+        model?: string;
+        firmware?: {
+            version?: string;
+            newVersionAvailable?: boolean;
+            newVersion?: string;
+            mandatoryUpdate?: boolean;
+        };
+    };
+    protocol: {
+        location?: {
+            id?: string;
+            name?: string;
+            city?: string;
+        };
+        name?: string;
+        room?: {
+            id?: string;
+            name?: string;
+        };
+        accountId?: string;
+    };
+    deviceType: {
+        id: string;
+        type: string;
+    };
+    status: {
+        online: boolean;
+        error?: {
+            type?: string;
+            message?: string;
+            default?: object;
+        };
+        lastUpdated?: Date;
+    };
+    state?: object;
+    metaData?: object;
+    createdAt?: Date;
+    updatedAt?: Date;
+}

package/dist/device/local/interfaces/IHub.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/device/local/interfaces/IProperty.d.ts

@@ -0,0 +1,29 @@
+export interface IProperty {
+    id: string;
+    name: string;
+    apartment: string;
+    city: string;
+    country: string;
+    state: string;
+    street: string;
+    zipCode: string;
+    createdBy?: string;
+    isDeleted: boolean;
+    imageURL: string;
+    timezone: string;
+    officialName?: string;
+    sameAsOfficialName?: boolean;
+    phoneNumber?: string;
+    phoneNumberCountryCode?: string;
+    propertyKey?: string;
+    hubNetworkId?: string;
+    isTimeZoneOverridden: boolean;
+    createdAt: string;
+    updatedAt: string;
+    propertyBillingId?: string;
+}
+export interface IPropertySettings {
+    id: string;
+    propertyId: string;
+    settings: Record<string, any>;
+}

package/dist/device/local/interfaces/IProperty.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/device/local/interfaces/ISchedule.d.ts

@@ -0,0 +1,25 @@
+export interface ISchedule {
+    id?: string;
+    name: string;
+    deviceId: string;
+    scheduleId: string | null;
+    state: {
+        targetTemperature?: number;
+        temperatureUnit?: "C" | "F";
+        mode?: "cool" | "heat" | "fan" | "dry" | "auto";
+        swing?: "stopped" | "rangeFull" | "fixedTop" | "fixedMiddleTop" | "fixedMiddle" | "fixedMiddleBottom" | "fixedBottom";
+        fanLevel?: "auto" | "low" | "medium" | "high";
+    };
+    startTime: string;
+    endTime: string;
+    recurringDays: ("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday")[];
+    createTime?: string;
+    nextTime?: string;
+    nextTimeSecondsFromNow?: number;
+    targetTimeLocal: string;
+    timezone: string;
+    scheduleInheritedFrom: "zone" | "device";
+    zoneId: string;
+    userId: string;
+    status?: "SET" | "UNSET";
+}

package/dist/device/local/interfaces/ISchedule.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/device/local/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./IDevice";
+export * from "./IDtDevice";
+export * from "./ISchedule";

package/dist/device/local/interfaces/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IDevice"), exports);
+__exportStar(require("./IDtDevice"), exports);
+__exportStar(require("./ISchedule"), exports);

package/dist/device/local/models/Alert.model.d.ts

@@ -0,0 +1,28 @@
+import mongoose, { Model } from "mongoose";
+import { AlertCategory, AlertSeverity, EntityType, AlertDocument as IAlertDocument, CreateAlertData, UpdateAlertData } from "../../../types/alert.types";
+interface IAlertMethods {
+    markAsRead(updatedBy: string): void;
+    markAsUnread(updatedBy: string): void;
+    activate(updatedBy: string): void;
+    deactivate(updatedBy: string): void;
+    snooze(until: Date, updatedBy: string): void;
+    unsnooze(updatedBy: string): void;
+}
+interface IAlertModel extends Model<IAlertDocument, {}, IAlertMethods> {
+    findByProperty(propertyId: string, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findByEntity(entityId: string, entityType: EntityType, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findByCategory(category: AlertCategory, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findBySeverity(severity: AlertSeverity, includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findActive(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findUnread(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findSnoozed(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+    findExpiredSnooze(includeDeleted?: boolean): Promise<IAlertDocument[]>;
+}
+declare const AlertSchema: mongoose.Schema<IAlertDocument, IAlertModel, IAlertMethods, {}, {}, {}, mongoose.DefaultSchemaOptions, IAlertDocument, mongoose.Document<unknown, {}, mongoose.FlatRecord<IAlertDocument>, {}> & Omit<mongoose.FlatRecord<IAlertDocument> & Required<{
+    _id: string;
+}> & {
+    __v: number;
+}, keyof IAlertMethods> & IAlertMethods>;
+export declare const AlertModel: IAlertModel;
+export { AlertSchema };
+export type { IAlertDocument, CreateAlertData, UpdateAlertData, IAlertMethods, IAlertModel, };