dt-common-device 1.0.0

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

@@ -0,0 +1,77 @@
+export interface IConnection {
+    connectionName: string;
+    connectionRefId: string;
+    propertyId: string;
+    connectionProvider: ConnectionProvider;
+    accessToken?: string;
+    clientId?: string;
+    clientSecret?: string;
+}
+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>;
+    hubDeviceDetails?: IDevice[];
+}
+export interface IDeviceAccountResponse {
+    id: string;
+    connection_name: string;
+    connection_access_token: string;
+    connection_provider: string;
+    totalDevices: number;
+    connection_ref_id: string;
+    isActive: boolean;
+}
+export interface IConnectionConnectParams {
+    code?: string;
+    propertyId?: string;
+    [key: string]: any;
+}
+export interface ConnectionProvider {
+    Smartthings: "Smartthings";
+    SaltoKS: "SaltoKS";
+    Tuya: "Tuya";
+    TTLock: "TTLock";
+    Schlage: "Schlage";
+    YaleWifi: "YaleWifi";
+    Devicethread: "Devicethread";
+    Sensibo: "Sensibo";
+}

package/dist/device/cloud/types.js

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

package/dist/device/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./cloud/interface";
+export * from "./cloud/types";
+export type { IConnection, IConnectionConnectParams, IDevice, IDeviceAccountResponse, } from "./cloud/types";
+export type { IDeviceCloudService } from "./cloud/interface";

package/dist/device/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// DeviceThread Common Library - Device Module
+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 });
+// Export cloud device interfaces
+__exportStar(require("./cloud/interface"), exports);
+__exportStar(require("./cloud/types"), exports);

package/dist/device/local/interface.js

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

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

@@ -0,0 +1,46 @@
+export interface IDeviceCreateParams {
+    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/IDevice.js

@@ -0,0 +1,3 @@
+"use strict";
+// Interfaces for DeviceService methods
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,46 @@
+export interface IHubCreateParams {
+    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/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./IDevice";
+export * from "./IHub";

package/dist/device/local/interfaces/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("./IDevice"), exports);
+__exportStar(require("./IHub"), exports);

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

@@ -0,0 +1,18 @@
+import { IDeviceCreateParams } from "../interfaces";
+export declare class DeviceService {
+    createDevice(body: IDeviceCreateParams, httpClient: {
+        post: (url: string, options: any) => Promise<any>;
+    }): Promise<void>;
+    getDevice(deviceId: string, httpClient: {
+        get: (url: string) => Promise<any>;
+    }): Promise<any>;
+    getPropertyDevices(propertyId: string, httpClient: {
+        get: (url: string, options: any) => Promise<any>;
+    }): Promise<any>;
+    updateDevice(deviceId: string, body: any, httpClient: {
+        put: (url: string, options: any) => Promise<any>;
+    }): Promise<any>;
+    deleteDevice(deviceId: string, httpClient: {
+        delete: (url: string) => Promise<any>;
+    }): Promise<any>;
+}

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

@@ -0,0 +1,27 @@
+"use strict";
+// src/device/local/services/Device.service.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceService = void 0;
+class DeviceService {
+    async createDevice(body, httpClient) {
+        // Create main device
+        await httpClient.post("/devices", { body });
+    }
+    async getDevice(deviceId, httpClient) {
+        return await httpClient.get(`/devices/${deviceId}`);
+    }
+    async getPropertyDevices(propertyId, httpClient) {
+        return await httpClient.get(`/devices`, {
+            params: {
+                propertyId,
+            },
+        });
+    }
+    async updateDevice(deviceId, body, httpClient) {
+        return await httpClient.put(`/devices/${deviceId}`, { body });
+    }
+    async deleteDevice(deviceId, httpClient) {
+        return await httpClient.delete(`/devices/${deviceId}`);
+    }
+}
+exports.DeviceService = DeviceService;

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

@@ -0,0 +1,21 @@
+import { IHubCreateParams } from "../interfaces";
+export declare class DeviceHubService {
+    addHub(body: IHubCreateParams, httpClient: {
+        post: (url: string, options: any) => Promise<any>;
+    }): Promise<any>;
+    getHubs(hubIds: string[], httpClient: {
+        get: (url: string, options?: any) => Promise<any>;
+    }): Promise<any>;
+    getHub(hubId: string, httpClient: {
+        get: (url: string) => Promise<any>;
+    }): Promise<any>;
+    updateHub(hubId: string, body: any, httpClient: {
+        put: (url: string, options: any) => Promise<any>;
+    }): Promise<any>;
+    deleteHub(hubId: string, httpClient: {
+        delete: (url: string) => Promise<any>;
+    }): Promise<any>;
+    deleteAllHubs(hubIds: string[], httpClient: {
+        delete: (url: string) => Promise<any>;
+    }): Promise<any>;
+}

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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceHubService = void 0;
+class DeviceHubService {
+    async addHub(body, httpClient) {
+        return await httpClient.post(`/devices/hubs`, { body });
+    }
+    //get hubs takes an array of hub ids as query params
+    async getHubs(hubIds, httpClient) {
+        const query = hubIds && hubIds.length ? `?ids=${hubIds.join(",")}` : "";
+        return await httpClient.get(`/devices/hubs${query}`);
+    }
+    //get hub takes a hub id in params
+    async getHub(hubId, httpClient) {
+        return await httpClient.get(`/devices/hubs/${hubId}`);
+    }
+    async updateHub(hubId, body, httpClient) {
+        return await httpClient.put(`/devices/hubs/${hubId}`, { body });
+    }
+    async deleteHub(hubId, httpClient) {
+        return await httpClient.delete(`/devices/hubs/${hubId}`);
+    }
+    async deleteAllHubs(hubIds, httpClient) {
+        const query = hubIds.length ? `?ids=${hubIds.join(",")}` : "";
+        return await httpClient.delete(`/devices/hubs${query}`);
+    }
+}
+exports.DeviceHubService = DeviceHubService;

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

@@ -0,0 +1,2 @@
+export * from "./Device.service";
+export * from "./DeviceHub.service";

package/dist/device/local/services/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("./Device.service"), exports);
+__exportStar(require("./DeviceHub.service"), exports);

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * as cloud from "./device/cloud/services";
+export * as cloudInterfaces from "./device/cloud/interfaces";
+export * from "./device/cloud/types";
+export * as local from "./device/local/services";
+export * as localInterfaces from "./device/local/interfaces";

package/dist/index.js

@@ -0,0 +1,47 @@
+"use strict";
+// Main entry point for dt-common-device
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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 __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.localInterfaces = exports.local = exports.cloudInterfaces = exports.cloud = void 0;
+// Cloud exports
+exports.cloud = __importStar(require("./device/cloud/services"));
+exports.cloudInterfaces = __importStar(require("./device/cloud/interfaces"));
+__exportStar(require("./device/cloud/types"), exports);
+// Local exports
+exports.local = __importStar(require("./device/local/services"));
+exports.localInterfaces = __importStar(require("./device/local/interfaces"));

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "dt-common-device",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "axios": "^1.10.0"
+  }
+}

package/src/device/cloud/interfaces/IDeviceConnectionService.ts

@@ -0,0 +1,54 @@
+// Device Cloud Class Interface for DeviceThread Common Library
+
+import {
+  IConnection,
+  IConnectionConnectParams,
+  IDevice,
+  IDeviceAccountResponse,
+} from "../types";
+
+/**
+ * Class interface for device cloud operations and connection management
+ */
+export interface IDeviceConnectionService {
+  /**
+   * Creates a new connection for device management
+   * @param data - Connection data
+   * @param userId - User identifier
+   * @returns Promise with connection result
+   */
+  createConnection(data: IConnection, userId: string): Promise<any>;
+
+  /**
+   * Gets device account information for a connection
+   * @param connection - Connection object
+   * @returns Promise with device account response
+   */
+  getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
+
+  /**
+   * Gets all devices for a connection
+   * @param connection - Connection object
+   * @returns Promise with array of devices
+   */
+  getDevices(connection: IConnection): Promise<any>;
+
+  /**
+   * Filters devices based on connection and device list
+   * @param connection - Connection object
+   * @param devices - Array of devices to filter
+   * @returns Promise with filtered devices
+   */
+  filterDevices(connection: IConnection, devices: any[]): Promise<IDevice[]>;
+
+  /**
+   * Connects to a device service
+   * @param connection - Connection object
+   * @param connectionConnect - Connection parameters
+   * @returns Promise with connection result
+   */
+  connect(
+    connection: IConnection,
+    connectionConnect: IConnectionConnectParams
+  ): Promise<any>;
+}

package/src/device/cloud/interfaces/IDevicesService.ts

@@ -0,0 +1,10 @@
+import { IConnection } from "../types";
+
+export interface IDeviceService {
+  getDevices(connection: IConnection): Promise<any[]>;
+  getDevice(connectionId: string, deviceId: string): Promise<any>;
+  getStatus(connectionId: string, deviceId: string): Promise<string | null>;
+  getState(deviceId: string): Promise<any>;
+  getGateways(connectionId: string): Promise<any[] | null>;
+  getGatewayDetails(connectionId: string, gatewayId: string): Promise<any>;
+}

package/src/device/cloud/interfaces/index.ts

@@ -0,0 +1,2 @@
+export * from "./IDeviceConnectionService";
+export * from "./IDevicesService";

package/src/device/cloud/services/Connection.service.ts

@@ -0,0 +1,76 @@
+// Device Cloud Service - Class Implementation
+import { IDeviceConnectionService } from "../interfaces";
+import {
+  IConnection,
+  IConnectionConnectParams,
+  IDevice,
+  IDeviceAccountResponse,
+} from "../types";
+
+/**
+ * Device Cloud Service Class
+ * Implements IDeviceCloudService interface with empty implementations
+ * Implementation will be provided by the consuming project
+ */
+export class ConnectionService implements IDeviceConnectionService {
+  /**
+   * Creates a new connection for device management
+   * @param data - Connection data
+   * @param userId - User identifier
+   * @returns Promise with connection result
+   */
+  async createConnection(data: IConnection, userId: string): Promise<any> {
+    // Implementation will be provided by the consuming project
+    throw new Error("createConnection method not implemented");
+  }
+
+  /**
+   * Gets device account information for a connection
+   * @param connection - Connection object
+   * @returns Promise with device account response
+   */
+  async getDeviceAccount(
+    connection: IConnection
+  ): Promise<IDeviceAccountResponse> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getDeviceAccount method not implemented");
+  }
+
+  /**
+   * Gets all devices for a connection
+   * @param connection - Connection object
+   * @returns Promise with array of devices
+   */
+  async getDevices(connection: IConnection): Promise<any> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getDevices method not implemented");
+  }
+
+  /**
+   * Filters devices based on connection and device list
+   * @param connection - Connection object
+   * @param devices - Array of devices to filter
+   * @returns Promise with filtered devices
+   */
+  async filterDevices(
+    connection: IConnection,
+    devices: any[]
+  ): Promise<IDevice[]> {
+    // Implementation will be provided by the consuming project
+    throw new Error("filterDevices method not implemented");
+  }
+
+  /**
+   * Connects to a device service
+   * @param connection - Connection object
+   * @param connectionConnect - Connection parameters
+   * @returns Promise with connection result
+   */
+  async connect(
+    connection: IConnection,
+    connectionConnect: IConnectionConnectParams
+  ): Promise<any> {
+    // Implementation will be provided by the consuming project
+    throw new Error("connect method not implemented");
+  }
+}

package/src/device/cloud/services/Device.service.ts

@@ -0,0 +1,40 @@
+import { IDeviceService } from "../interfaces";
+import { IConnection } from "../types";
+
+export class DeviceService implements IDeviceService {
+  async getDevices(connection: IConnection): Promise<any[]> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getDevices method not implemented");
+  }
+
+  async getDevice(connectionId: string, deviceId: string): Promise<any> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getDevice method not implemented");
+  }
+
+  async getStatus(
+    connectionId: string,
+    deviceId: string
+  ): Promise<string | null> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getDeviceStatus method not implemented");
+  }
+
+  async getState(deviceId: string): Promise<any> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getState method not implemented");
+  }
+
+  async getGateways(connectionId: string): Promise<any[] | null> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getGateways method not implemented");
+  }
+
+  async getGatewayDetails(
+    connectionId: string,
+    gatewayId: string
+  ): Promise<any> {
+    // Implementation will be provided by the consuming project
+    throw new Error("getGatewayDetails method not implemented");
+  }
+}

package/src/device/cloud/services/DeviceHub.service.ts

@@ -0,0 +1,6 @@
+export class DeviceHubService {
+  async getHubs(): Promise<any> {
+    // implements will be provided by the consuming project
+    throw new Error("getHubs method not implemented");
+  }
+}

package/src/device/cloud/services/index.ts

@@ -0,0 +1,4 @@
+// Device Cloud Services - Export all service classes
+
+export * from "./Connection.service";
+export * from "./Device.service";