dt-common-device 1.0.12 → 1.0.14

package/README.md

@@ -20,6 +20,20 @@ npm install dt-common-device
 - `dt-common-device` will automatically initialize audit logging using these environment variables when you create a local device service.
 - If either variable is missing, the library will throw a clear error at runtime.
 
+## Environment Variables
+
+This library requires the following environment variable to be set in your project's environment or in a `.env` file:
+
+- `POSTGRESQL_DB_URI`: The connection URI for your PostgreSQL database.
+
+Example `.env` file:
+
+```
+POSTGRESQL_DB_URI=postgres://username:password@host:port/database
+```
+
+The library will throw an error if this variable is not set when attempting to connect to the database.
+
 ---
 
 ## Initialization (Required)
@@ -176,38 +190,4 @@ import { IDevice, IHub, IConnection } from "dt-common-device";
 
 - You **must** call `initialize()` before using any service. If not, you will get a runtime error.
 - **You must set `POSTHOG_API_KEY` and `POSTHOG_HOST` in your environment before using any local device service.**
-- You do **not** need to call `initializeAudit()`; the library will handle audit initialization automatically.
-- Cloud service methods are stubs and must be implemented by the consuming project.
-- All types are strongly typed for TypeScript support.
-
----
-
-## Example Usage
-
-```ts
-import {
-  initialize,
-  CloudDeviceService,
-  LocalDeviceService,
-  IDevice,
-} from "dt-common-device";
-
-initialize({
-  DEVICE_SERVICE: "https://api.example.com/device",
-});
-
-const cloudService = new CloudDeviceService();
-const localService = new LocalDeviceService();
-
-async function main() {
-  // Example: get devices from cloud (must implement in your project)
-  // const devices: IDevice[] = await cloudService.getDevices(connection);
-
-  // Example: create a device locally
-  await localService.createDevice({
-    /* device params */
-  });
-}
-
-main();
-```
+- You do **not** need to call `initializeAudit()`

package/dist/config/config.d.ts

@@ -3,3 +3,16 @@ export declare function initialize(cfg: DeviceConfig): void;
 export declare function getConfig(): DeviceConfig;
 export declare function checkAwsEnv(): void;
 export declare function ensureAuditInitialized(): void;
+/**
+ * Returns the PostgreSQL DB URI from environment variables.
+ * Throws an error if not set.
+ */
+export declare function getPostgresDbUri(): string;
+/**
+ * Returns the Redis DB Host and port from environment variables.
+ * Throws an error if not set.
+ */
+export declare function getRedisDbHostAndPort(): {
+    host: string;
+    port: number;
+};

package/dist/config/config.js

@@ -1,10 +1,17 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initialize = initialize;
 exports.getConfig = getConfig;
 exports.checkAwsEnv = checkAwsEnv;
 exports.ensureAuditInitialized = ensureAuditInitialized;
+exports.getPostgresDbUri = getPostgresDbUri;
+exports.getRedisDbHostAndPort = getRedisDbHostAndPort;
 const dt_audit_library_1 = require("dt-audit-library");
+const dotenv_1 = __importDefault(require("dotenv"));
+dotenv_1.default.config();
 let config = null;
 let auditInitialized = false;
 function initialize(cfg) {
@@ -50,3 +57,26 @@ function ensureAuditInitialized() {
     (0, dt_audit_library_1.initializeAudit)(apiKey, host);
     auditInitialized = true;
 }
+/**
+ * Returns the PostgreSQL DB URI from environment variables.
+ * Throws an error if not set.
+ */
+function getPostgresDbUri() {
+    const uri = process.env.DATABASE_URL;
+    if (!uri) {
+        throw new Error("dt-common-device: POSTGRESQL_DB_URI must be set in environment variables or .env file");
+    }
+    return uri;
+}
+/**
+ * Returns the Redis DB Host and port from environment variables.
+ * Throws an error if not set.
+ */
+function getRedisDbHostAndPort() {
+    const host = process.env.REDIS_HOST;
+    const port = process.env.REDIS_PORT;
+    if (!host || !port) {
+        throw new Error("dt-common-device: REDIS_HOST and REDIS_PORT must be set in environment variables");
+    }
+    return { host, port: Number(port) };
+}

package/dist/db/db.d.ts

@@ -0,0 +1,2 @@
+import { Pool } from "pg";
+export declare function getPostgresClient(): Pool;

package/dist/db/db.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPostgresClient = getPostgresClient;
+const pg_1 = require("pg");
+const config_1 = require("../config/config");
+const dbUri = (0, config_1.getPostgresDbUri)();
+let pool = null;
+function getPostgresClient() {
+    if (!pool) {
+        pool = new pg_1.Pool({
+            connectionString: dbUri,
+        });
+    }
+    return pool;
+}

package/dist/db/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./db";
+export * from "./redis";

package/dist/db/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("./db"), exports);
+__exportStar(require("./redis"), exports);

package/dist/db/redis.d.ts

@@ -0,0 +1,2 @@
+import Redis from "ioredis";
+export declare function getRedisClient(): Redis;

package/dist/db/redis.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRedisClient = getRedisClient;
+const config_1 = require("../config/config");
+const ioredis_1 = __importDefault(require("ioredis"));
+let redisClient = null;
+function getRedisClient() {
+    if (!redisClient) {
+        const { host, port } = (0, config_1.getRedisDbHostAndPort)();
+        redisClient = new ioredis_1.default({
+            host,
+            port,
+        });
+        redisClient.on("error", (error) => {
+            console.error("Redis error:", error);
+        });
+    }
+    return redisClient;
+}

package/dist/device/cloud/entities/CloudDevice.d.ts

@@ -0,0 +1,15 @@
+import { IDevice } from "../../local/interfaces";
+import { ICloudDevice } from "../interfaces/ICloudDevice";
+import { ICloudDeviceService } from "../interfaces/ICloudDeviceService";
+import { IConnection } from "../types";
+export declare abstract class CloudDevice implements ICloudDevice {
+    deviceId: string;
+    localDevice?: IDevice;
+    connection?: IConnection;
+    cloudDeviceService: ICloudDeviceService;
+    constructor(device: IDevice, cloudDeviceService: ICloudDeviceService);
+    getDevice(connectionId: string, deviceId: string): Promise<Record<string, any>>;
+    getBattery(deviceId: string): Promise<number | string>;
+    getState(deviceId: string): Promise<string>;
+    getStatus(connectionId: string, deviceId: string): Promise<string>;
+}

package/dist/device/cloud/entities/CloudDevice.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudDevice = void 0;
+class CloudDevice {
+    constructor(device, cloudDeviceService) {
+        this.deviceId = device.deviceId;
+        this.localDevice = device;
+        this.cloudDeviceService = cloudDeviceService;
+    }
+    async getDevice(connectionId, deviceId) {
+        throw new Error("Method not implemented in Super Class.");
+    }
+    async getBattery(deviceId) {
+        throw new Error("Method not implemented in Super Class.");
+    }
+    async getState(deviceId) {
+        throw new Error("Method not implemented in Super Class.");
+    }
+    async getStatus(connectionId, deviceId) {
+        throw new Error("Method not implemented in Super Class.");
+    }
+}
+exports.CloudDevice = CloudDevice;
+/*
+Usage Example:
+
+// When extending CloudDevice, you can now do:
+class MyCloudDevice extends CloudDevice {
+  constructor(device: IDevice, cloudDeviceService: ICloudDeviceService) {
+    super(device, cloudDeviceService);
+    // Additional initialization if needed
+  }
+}
+
+// Create and initialize in one step:
+const device = await MyCloudDevice.create(device, cloudDeviceService);
+// The device is now fully initialized with connection and localDevice loaded
+
+// Or if you need to create without auto-initialization:
+const device = new MyCloudDevice(device, cloudDeviceService);
+await device.initialize(); // Manual initialization
+*/

package/dist/device/cloud/entities/DeviceFactory.d.ts

@@ -0,0 +1,6 @@
+import { IDevice } from "../../local/interfaces";
+export declare class DeviceFactory {
+    private readonly localDeviceService;
+    constructor();
+    getDevice(deviceId: string): Promise<IDevice>;
+}

package/dist/device/cloud/entities/DeviceFactory.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceFactory = void 0;
+const Device_service_1 = require("../../local/services/Device.service");
+class DeviceFactory {
+    constructor() {
+        this.localDeviceService = new Device_service_1.LocalDeviceService();
+    }
+    async getDevice(deviceId) {
+        return await this.localDeviceService.getDevice(deviceId);
+    }
+}
+exports.DeviceFactory = DeviceFactory;

package/dist/device/cloud/entities/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./CloudDevice";
+export * from "./DeviceFactory";

package/dist/device/cloud/entities/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("./CloudDevice"), exports);
+__exportStar(require("./DeviceFactory"), exports);

package/dist/device/cloud/interfaces/ICloudDevice.d.ts

@@ -0,0 +1,9 @@
+import { ICloudDeviceService } from "./ICloudDeviceService";
+export interface ICloudDevice {
+    deviceId: string;
+    cloudDeviceService: ICloudDeviceService;
+    getDevice(connectionId: string, deviceId: string): Promise<Record<string, any>>;
+    getBattery(deviceId: string): Promise<number | string>;
+    getState(deviceId: string): Promise<string>;
+    getStatus(connectionId: string, deviceId: string): Promise<string>;
+}

package/dist/device/cloud/interfaces/ICloudDevice.js

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

package/dist/device/cloud/interfaces/ICloudDeviceService.d.ts

@@ -0,0 +1,4 @@
+import { IConnection } from "../types";
+export interface ICloudDeviceService {
+    getConnection(deviceId: string): Promise<IConnection>;
+}

package/dist/device/cloud/interfaces/ICloudDeviceService.js

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

package/dist/device/cloud/interfaces/IConnectionService.js

@@ -1,3 +1,2 @@
 "use strict";
-// Device Cloud Class Interface for DeviceThread Common Library
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,3 +1,5 @@
 export * from "./IConnectionService";
 export * from "./IDeviceService";
 export * from "./IHubService";
+export * from "./ICloudDevice";
+export * from "./ICloudDeviceService";

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

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./IConnectionService"), exports);
 __exportStar(require("./IDeviceService"), exports);
 __exportStar(require("./IHubService"), exports);
+__exportStar(require("./ICloudDevice"), exports);
+__exportStar(require("./ICloudDeviceService"), exports);

package/dist/device/cloud/services/CloudDevice.service.d.ts

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

package/dist/device/cloud/services/CloudDevice.service.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudDeviceService = void 0;
+class CloudDeviceService {
+}
+exports.CloudDeviceService = CloudDeviceService;

package/dist/device/cloud/services/Connection.service.d.ts

@@ -1,5 +1,5 @@
 import { IConnectionService } from "../interfaces";
-import { IConnection, IDeviceAccountResponse, IConnectionConnectParams } from "../types";
+import { IDeviceAccountResponse, IConnectionConnectParams, IConnection } from "../types";
 export declare abstract class ConnectionService implements IConnectionService {
     abstract createConnection(data: IConnection, userId: string): Promise<any>;
     abstract getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;

package/dist/device/cloud/services/index.d.ts

@@ -1,3 +1,2 @@
-export { DeviceService as CloudDeviceService } from "./Device.service";
-export { ConnectionService as CloudConnectionService } from "./Connection.service";
-export { HubService as CloudHubService } from "./Hub.service";
+export * from "./CloudDevice.service";
+export * from "./Connection.service";

package/dist/device/cloud/services/index.js

@@ -1,10 +1,18 @@
 "use strict";
-// Device Cloud Services - Export all service classes
+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 });
-exports.CloudHubService = exports.CloudConnectionService = exports.CloudDeviceService = void 0;
-var Device_service_1 = require("./Device.service");
-Object.defineProperty(exports, "CloudDeviceService", { enumerable: true, get: function () { return Device_service_1.DeviceService; } });
-var Connection_service_1 = require("./Connection.service");
-Object.defineProperty(exports, "CloudConnectionService", { enumerable: true, get: function () { return Connection_service_1.ConnectionService; } });
-var Hub_service_1 = require("./Hub.service");
-Object.defineProperty(exports, "CloudHubService", { enumerable: true, get: function () { return Hub_service_1.HubService; } });
+__exportStar(require("./CloudDevice.service"), exports);
+__exportStar(require("./Connection.service"), exports);

package/dist/device/cloud/types.d.ts

@@ -21,65 +21,6 @@ export interface IConnectionPagination {
     page: number;
     limit: number;
 }
-/**
- * Represents a device in the system.
- * All date fields must be ISO 8601 strings.
- */
-export interface IDevice {
-    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;
-        };
-        lastUpdated?: string;
-    };
-    state?: Record<string, any>;
-    metaData?: Record<string, any>;
-    createdAt?: Date;
-    updatedAt?: Date;
-    isDeleted?: boolean;
-    hubDeviceDetails?: IDevice[];
-    parentZones?: {
-        id: string;
-        name: string;
-    }[];
-    zone?: {
-        id: string;
-        name: string;
-    };
-}
 /**
  * Device account response from provider.
  * WARNING: Do not log or expose connection_access_token.
@@ -98,13 +39,13 @@ export interface IConnectionConnectParams {
     propertyId?: string;
     [key: string]: unknown;
 }
-export declare enum ConnectionProvider {
-    Devicethread = "Devicethread",
-    Smartthings = "Smartthings",
-    SaltoKS = "SaltoKS",
-    Tuya = "Tuya",
-    TTLock = "TTLock",
-    Schlage = "Schlage",
-    YaleWifi = "YaleWifi",
-    Sensibo = "Sensibo"
+export interface ConnectionProvider {
+    DEVICETHREAD: "Devicethread";
+    SMARTTHINGS: "Smartthings";
+    SALTOKS: "SaltoKS";
+    TUYA: "Tuya";
+    TTLOCK: "TTLock";
+    SCHLAGE: "Schlage";
+    YALEWIFI: "YaleWifi";
+    SENSIBO: "Sensibo";
 }

package/dist/device/cloud/types.js

@@ -1,15 +1,3 @@
 "use strict";
 // Device Cloud Type Interfaces for DeviceThread Common Library
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConnectionProvider = void 0;
-var ConnectionProvider;
-(function (ConnectionProvider) {
-    ConnectionProvider["Devicethread"] = "Devicethread";
-    ConnectionProvider["Smartthings"] = "Smartthings";
-    ConnectionProvider["SaltoKS"] = "SaltoKS";
-    ConnectionProvider["Tuya"] = "Tuya";
-    ConnectionProvider["TTLock"] = "TTLock";
-    ConnectionProvider["Schlage"] = "Schlage";
-    ConnectionProvider["YaleWifi"] = "YaleWifi";
-    ConnectionProvider["Sensibo"] = "Sensibo";
-})(ConnectionProvider || (exports.ConnectionProvider = ConnectionProvider = {}));

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

@@ -0,0 +1,16 @@
+import { ConnectionProvider } from "../../cloud/types";
+export interface IConnection {
+    id?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    isDeleted?: boolean;
+    connectionName: string;
+    connectionRefId: string;
+    propertyId: string;
+    connectionProvider: ConnectionProvider;
+    accessToken?: string;
+    clientId?: string;
+    clientSecret?: string;
+    isActive?: boolean;
+    metaData?: any;
+}

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

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

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

@@ -26,6 +26,10 @@ export interface IDevice {
         };
         accountId?: string;
     };
+    account: {
+        id: string;
+        name: string;
+    };
     deviceType: {
         id: string;
         type: string;

package/dist/device/local/services/Connection.service.d.ts

@@ -0,0 +1,5 @@
+export declare class ConnectionService {
+    private readonly pool;
+    constructor();
+    getConnection(connectionId: string): Promise<any>;
+}

package/dist/device/local/services/Connection.service.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionService = void 0;
+const db_1 = require("../../../db");
+class ConnectionService {
+    constructor() {
+        this.pool = (0, db_1.getPostgresClient)();
+    }
+    async getConnection(connectionId) {
+        const result = await this.pool.query("SELECT * FROM dt_connections WHERE id = $1", [connectionId]);
+        return result.rows[0];
+    }
+}
+exports.ConnectionService = ConnectionService;

package/dist/device/local/services/Device.service.d.ts

@@ -1,8 +1,11 @@
 import { IDevice } from "../interfaces";
-export declare class DeviceService {
+export declare class LocalDeviceService {
     private readonly baseUrl;
     private readonly source;
     private readonly eventHandler;
+    private readonly alertService;
+    private readonly redis;
+    private readonly postgres;
     constructor();
     createDevice(body: IDevice): Promise<void>;
     getDevice(deviceId: string, withHubDetails?: boolean): Promise<IDevice>;
@@ -18,6 +21,7 @@ export declare class DeviceService {
     setBatteryLevel(deviceId: string, batteryLevel: number): Promise<void>;
     getMetaData(deviceId: string): Promise<import("axios").AxiosResponse<any, any>>;
     setMetaData(deviceId: string, metaData: Record<string, any>): Promise<void>;
-    getDeviceByZone(zoneId: string): Promise<void>;
-    getDevicesByAccessGroup(accessGroupId: string): Promise<void>;
+    getDeviceByZone(zoneId: string): Promise<any>;
+    getDevicesByAccessGroup(accessGroupId: string): Promise<any>;
+    getPropertyPreferences(propertyId: string): Promise<any>;
 }