dt-common-device 4.0.8 → 5.0.0

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

@@ -3,7 +3,7 @@ import { IAlertDocument } from "./Alert.model";
 import { CreateAlertData, UpdateAlertData, AlertCategory, AlertSeverity, EntityType } from "./alert.types";
 import { Source } from "../constants/Service";
 import { AlertBuilder } from "./AlertBuilder";
-import { IDevice } from "../device/local/interfaces";
+import { IDevice } from "../entities/device/local/interfaces";
 export declare class AlertService {
     private readonly alertRepository;
     constructor(alertRepository: AlertRepository);

package/dist/audit/AuditUtils.d.ts

@@ -1,2 +1,26 @@
-import { AuditProperties } from "./AuditProperties";
-export declare function buildAuditProperties(input: AuditProperties): Record<string, any>;
+import { IAuditProperties } from "./IAuditProperties";
+export declare class AuditUtils {
+    private readonly redisUtils;
+    private readonly CACHE_TTL;
+    private readonly CACHE_PREFIX;
+    constructor();
+    private readonly AUDIT_FIELDS;
+    buildAuditProperties(input: IAuditProperties): Promise<IAuditProperties>;
+    private populateAuditFields;
+    /**
+     * Generic utility to get cached entity data from Redis using individual keys
+     */
+    private getCachedEntityData;
+    /**
+     * Utility to calculate schedule duration in days
+     */
+    private calculateScheduleDuration;
+    private getPropertyName;
+    private getPropertyIdFromDevice;
+    private getUserName;
+    private getGuestName;
+    private getDeviceName;
+    private getZoneName;
+    private getAccessGroupName;
+    private getScheduleDetails;
+}

package/dist/audit/AuditUtils.js

@@ -1,36 +1,259 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildAuditProperties = buildAuditProperties;
-const AUDIT_FIELDS = [
-    "resource",
-    "propertyId",
-    "propertyName",
-    "userId",
-    "userName",
-    "deviceId",
-    "deviceName",
-    "zoneId",
-    "zoneName",
-    "accessGroupId",
-    "accessGroupName",
-    "scheduleId",
-    "scheduleName",
-];
-function buildAuditProperties(input) {
-    // Normalize keys to camelCase for matching
-    const normalized = { ...input };
-    // Build the audit object with all standard fields
-    const audit = {};
-    for (const field of AUDIT_FIELDS) {
-        // Try to find a matching key in input (case-insensitive)
-        const foundKey = Object.keys(normalized).find((k) => k.toLowerCase() === field.toLowerCase());
-        audit[field] = foundKey ? normalized[foundKey] : undefined;
+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]; } };
     }
-    // Merge in all other event-specific data (but don't overwrite audit fields)
-    for (const key of Object.keys(normalized)) {
-        if (!audit.hasOwnProperty(key)) {
-            audit[key] = normalized[key];
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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] = _;
         }
     }
-    return audit;
-}
+    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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.AuditUtils = void 0;
+const property_1 = require("../entities/property");
+const redis_utils_1 = require("../utils/redis.utils");
+const User_service_1 = require("../entities/user/User.service");
+const services_1 = require("../entities/device/local/services");
+const accessGroup_1 = require("../entities/accessGroup");
+const zone_1 = require("../entities/zone");
+const schedules_1 = require("../entities/schedules");
+const guest_1 = require("../entities/guest");
+const typedi_1 = __importStar(require("typedi"));
+let AuditUtils = (() => {
+    let _classDecorators = [(0, typedi_1.Service)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var AuditUtils = _classThis = class {
+        constructor() {
+            this.CACHE_TTL = 24 * 60 * 60; // 24 hours in seconds
+            this.CACHE_PREFIX = "audit:entity";
+            this.AUDIT_FIELDS = [
+                "resource",
+                "propertyId",
+                "propertyName",
+                "userId",
+                "userName",
+                "guestId",
+                "guestName",
+                "deviceId",
+                "deviceName",
+                "zoneId",
+                "zoneName",
+                "accessGroupId",
+                "accessGroupName",
+                "scheduleId",
+                "scheduleStartDate",
+                "scheduleEndDate",
+                "scheduleDuration",
+                "scheduleSource",
+                "scheduleStatus",
+                "eventData",
+            ];
+            this.redisUtils = new redis_utils_1.RedisUtils();
+        }
+        async buildAuditProperties(input) {
+            // Normalize keys to camelCase for matching
+            const normalized = { ...input };
+            // Build the audit object with all standard fields
+            const audit = {};
+            for (const field of this.AUDIT_FIELDS) {
+                // Try to find a matching key in input (case-insensitive)
+                const foundKey = Object.keys(normalized).find((k) => k.toLowerCase() === field.toLowerCase());
+                audit[field] = foundKey ? normalized[foundKey] : undefined;
+            }
+            // Merge in all other event-specific data (but don't overwrite audit fields)
+            for (const key of Object.keys(normalized)) {
+                if (!audit.hasOwnProperty(key)) {
+                    audit[key] = normalized[key];
+                }
+            }
+            // Util Function that will take all id Fields and get related information from database and add to audit
+            await this.populateAuditFields(audit);
+            return audit;
+        }
+        async populateAuditFields(audit) {
+            const { propertyId, propertyName, userId, userName, guestId, guestName, deviceId, deviceName, zoneId, zoneName, accessGroupId, accessGroupName, scheduleId, } = audit;
+            if (propertyId && !propertyName)
+                audit.propertyName = await this.getPropertyName(propertyId);
+            if (!propertyId && deviceId) {
+                audit.propertyId = await this.getPropertyIdFromDevice(deviceId);
+                audit.propertyName = await this.getPropertyName(audit.propertyId);
+            }
+            if (userId && !userName)
+                audit.userName = await this.getUserName(userId);
+            if (guestId && !guestName)
+                audit.guestName = await this.getGuestName(guestId);
+            if (deviceId && !deviceName)
+                audit.deviceName = await this.getDeviceName(deviceId);
+            if (zoneId && !zoneName)
+                audit.zoneName = await this.getZoneName(zoneId);
+            if (accessGroupId && !accessGroupName)
+                audit.accessGroupName = await this.getAccessGroupName(accessGroupId);
+            if (scheduleId) {
+                const { scheduleStartDate, scheduleEndDate, scheduleDuration, scheduleSource, scheduleStatus, } = await this.getScheduleDetails(scheduleId);
+                audit.scheduleStartDate = scheduleStartDate;
+                audit.scheduleEndDate = scheduleEndDate;
+                audit.scheduleDuration = scheduleDuration;
+                audit.scheduleSource = scheduleSource;
+                audit.scheduleStatus = scheduleStatus;
+            }
+        }
+        /**
+         * Generic utility to get cached entity data from Redis using individual keys
+         */
+        async getCachedEntityData(entityType, entityId, fetchFunction) {
+            const cacheKey = `${this.CACHE_PREFIX}:${entityType}:${entityId}`;
+            // Try to get from cache first
+            const cachedData = await this.redisUtils.get(cacheKey);
+            if (cachedData) {
+                return JSON.parse(cachedData);
+            }
+            // If not in cache, fetch from database and cache it
+            const entityData = await fetchFunction();
+            await this.redisUtils.set(cacheKey, JSON.stringify(entityData), this.CACHE_TTL);
+            return entityData;
+        }
+        /**
+         * Utility to calculate schedule duration in days
+         */
+        calculateScheduleDuration(startTime, endTime) {
+            const duration = new Date(endTime).getTime() - new Date(startTime).getTime();
+            return Math.ceil(duration / (1000 * 60 * 60 * 24));
+        }
+        async getPropertyName(propertyId) {
+            return this.getCachedEntityData("property", propertyId, async () => {
+                const property = await typedi_1.default.get(property_1.LocalPropertyService).getProperty(propertyId);
+                return property?.name || "";
+            });
+        }
+        async getPropertyIdFromDevice(deviceId) {
+            const redisKey = `device:${deviceId}`;
+            const redisDevice = await this.redisUtils.hget(redisKey, "device");
+            if (redisDevice) {
+                return JSON.parse(redisDevice).propertyId;
+            }
+            else {
+                const device = await typedi_1.default.get(services_1.LocalDeviceService).getDevice(deviceId);
+                await this.redisUtils.hset(redisKey, "device", JSON.stringify(device));
+                await this.redisUtils.expire(redisKey, this.CACHE_TTL);
+                return device.propertyId;
+            }
+        }
+        async getUserName(userId) {
+            return this.getCachedEntityData("user", userId, async () => {
+                const user = await typedi_1.default.get(User_service_1.UserService).getUser(userId);
+                return `${user?.firstName || ""} ${user?.lastName || ""}`.trim();
+            });
+        }
+        async getGuestName(guestId) {
+            return this.getCachedEntityData("guest", guestId, async () => {
+                const guest = await typedi_1.default.get(guest_1.GuestService).getGuest(guestId);
+                return `${guest?.firstName || ""} ${guest?.lastName || ""}`.trim();
+            });
+        }
+        async getDeviceName(deviceId) {
+            return this.getCachedEntityData("device", deviceId, async () => {
+                const device = await typedi_1.default.get(services_1.LocalDeviceService).querySelect({ deviceId }, ["name"]);
+                return device?.name || "";
+            });
+        }
+        async getZoneName(zoneId) {
+            return this.getCachedEntityData("zone", zoneId, async () => {
+                const zone = await typedi_1.default.get(zone_1.ZoneService).getZone(zoneId);
+                return zone?.name || "";
+            });
+        }
+        async getAccessGroupName(accessGroupId) {
+            return this.getCachedEntityData("accessGroup", accessGroupId, async () => {
+                const accessGroup = await typedi_1.default.get(accessGroup_1.AccessGroupService).getAccessGroup(accessGroupId);
+                return accessGroup?.name || "";
+            });
+        }
+        async getScheduleDetails(scheduleId) {
+            return this.getCachedEntityData("schedule", scheduleId, async () => {
+                const schedule = await typedi_1.default.get(schedules_1.ScheduleService).getSchedule(scheduleId);
+                const scheduleDuration = this.calculateScheduleDuration(schedule.startTime, schedule.endTime);
+                return {
+                    scheduleStartDate: schedule.startTime,
+                    scheduleEndDate: schedule.endTime,
+                    scheduleDuration,
+                    scheduleSource: schedule.source,
+                    scheduleStatus: schedule.status,
+                };
+            });
+        }
+    };
+    __setFunctionName(_classThis, "AuditUtils");
+    (() => {
+        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);
+        AuditUtils = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return AuditUtils = _classThis;
+})();
+exports.AuditUtils = AuditUtils;

package/dist/audit/IAuditProperties.d.ts

@@ -0,0 +1,32 @@
+export declare enum Resource {
+    ORGANIZATION = "organization",
+    PROPERTY = "property",
+    ACCESS_GROUP = "accessGroup",
+    ZONE = "zone",
+    DEVICE = "device",
+    SCHEDULE = "schedule",
+    USER = "user"
+}
+export interface IAuditProperties {
+    resource: Resource;
+    propertyId: string;
+    propertyName?: string;
+    userId?: string;
+    userName?: string;
+    guestId?: string;
+    guestName?: string;
+    deviceId?: string;
+    deviceName?: string;
+    zoneId?: string;
+    zoneName?: string;
+    accessGroupId?: string;
+    accessGroupName?: string;
+    scheduleId?: string;
+    scheduleStartDate?: string;
+    scheduleEndDate?: string;
+    scheduleDuration?: number;
+    scheduleSource?: string;
+    scheduleStatus?: string;
+    eventData?: any;
+    [key: string]: any;
+}

package/dist/audit/IAuditProperties.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resource = void 0;
+var Resource;
+(function (Resource) {
+    Resource["ORGANIZATION"] = "organization";
+    Resource["PROPERTY"] = "property";
+    Resource["ACCESS_GROUP"] = "accessGroup";
+    Resource["ZONE"] = "zone";
+    Resource["DEVICE"] = "device";
+    Resource["SCHEDULE"] = "schedule";
+    Resource["USER"] = "user";
+})(Resource || (exports.Resource = Resource = {}));

package/dist/audit/PushAudit.d.ts

@@ -0,0 +1,5 @@
+import { IAuditProperties } from "./IAuditProperties";
+export declare function pushAudit(data: {
+    auditType: string;
+    auditData: IAuditProperties;
+}): Promise<void>;

package/dist/audit/PushAudit.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pushAudit = pushAudit;
+const dt_audit_library_1 = require("dt-audit-library");
+const AuditUtils_1 = require("./AuditUtils");
+const typedi_1 = __importDefault(require("typedi"));
+async function pushAudit(data) {
+    const audit = await typedi_1.default.get(AuditUtils_1.AuditUtils).buildAuditProperties(data.auditData);
+    await (0, dt_audit_library_1.publishAudit)({
+        eventType: data.auditType,
+        properties: audit,
+    });
+}

package/dist/audit/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./PushAudit";
+export * from "./IAuditProperties";

package/dist/audit/index.js

@@ -0,0 +1,18 @@
+"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("./PushAudit"), exports);
+__exportStar(require("./IAuditProperties"), exports);

package/dist/config/config.d.ts

@@ -1,16 +1,23 @@
 import { InternalEventSubscription } from "../events";
-import { IConfig } from "./config.types";
+import { IConfig, ILogger } from "./config.types";
 export declare function initialize(cfg: IConfig): Promise<void>;
 export declare function getConfig(): IConfig;
+export declare function getDeviceServiceUrl(): string;
+export declare function getAdminServiceUrl(): string;
+export declare function getSqsQueueUrl(): string;
 export declare function getEventSubscription(): InternalEventSubscription | null;
-export declare function checkRequiredEnv(): void;
+export declare function checkRequiredEnv(requiredEnvs: string[]): void;
 export declare function ensureAuditInitialized(): void;
+export declare function getLogger(): ILogger;
 /**
  * Returns the PostgreSQL DB URI from environment variables.
  * Throws an error if not set.
  */
-export declare function getPostgresDbUri(): string;
+export declare function getAdminPostgresDbUri(): string;
+export declare function getAccessPostgresDbUri(): string;
+export declare function getPmsPostgresDbUri(): string;
 export declare function getMongoUri(): string;
+export declare function getDTApiKey(): string;
 /**
  * Returns the Redis DB Host and port from environment variables.
  * Throws an error if not set.