dt-common-device 1.0.0

package/README.md

@@ -0,0 +1,73 @@
+npm install dt-common-device
+
+## Import
+
+import { cloud, local, cloudInterfaces, localInterfaces } from "dt-common-device";
+
+## Cloud Functions
+
+These are stubs and must be implemented by the consuming project.
+
+```ts
+const connectionService = new cloud.ConnectionService();
+
+// Example: create a connection (must implement this in your project)
+await connectionService.createConnection(connectionData, userId);
+
+// Example: get device account (must implement this in your project)
+await connectionService.getDeviceAccount(connection);
+```
+
+## Local Functions
+
+### DeviceService
+
+```ts
+const deviceService = new local.DeviceService();
+
+// Create a device
+await deviceService.createDevice(deviceBody, httpClient);
+
+// Get a device
+const device = await deviceService.getDevice(deviceId, httpClient);
+
+// Update a device
+await deviceService.updateDevice(deviceId, updateBody, httpClient);
+
+// Delete a device
+await deviceService.deleteDevice(deviceId, httpClient);
+```
+
+## Local Functions
+
+### DeviceHubService
+
+```ts
+const deviceHubService = new local.DeviceHubService();
+
+// Add a hub
+await deviceHubService.addHub(hubBody, httpClient);
+
+// Get hubs
+const hubs = await deviceHubService.getHubs(hubIds, httpClient);
+
+// Get a single hub
+const hub = await deviceHubService.getHub(hubId, httpClient);
+
+// Update a hub
+await deviceHubService.updateHub(hubId, updateBody, httpClient);
+
+// Delete a hub
+await deviceHubService.deleteHub(hubId, httpClient);
+
+// Delete multiple hubs
+await deviceHubService.deleteAllHubs(hubIds, httpClient);
+```
+
+### Types
+
+All types and interfaces are available as named exports:
+
+```ts
+import { IDevice, IHubCreateParams } from "dt-common-device";
+```

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

@@ -0,0 +1,101 @@
+import { IConnection, IConnectionConnectParams, IDevice, IDeviceAccountResponse, IDeviceCommand, ISmartthingsDeviceCommand, ICommandResponse } from "./types";
+/**
+ * Class interface for device cloud operations and connection management
+ */
+export interface IDeviceCloudService {
+    /**
+     * 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<IDevice[]>;
+    /**
+     * 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>;
+}
+/**
+ * Interface for device command operations
+ */
+export interface IDeviceCommandManager {
+    /**
+     * Invokes a command on a device
+     * @param command - Device command to execute
+     * @param deviceId - Device identifier
+     * @returns Promise with command response
+     */
+    invokeCommand(command: IDeviceCommand, deviceId: string): Promise<ICommandResponse>;
+}
+/**
+ * Interface for SmartThings specific device command operations
+ */
+export interface ISmartthingsDeviceCommandManager extends IDeviceCommandManager {
+    /**
+     * Performs device action for SmartThings
+     * @param commands - Array of SmartThings device commands
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with action result
+     */
+    performDeviceAction(commands: ISmartthingsDeviceCommand[], deviceId: string, accessToken: string): Promise<any>;
+    /**
+     * Gets device status for SmartThings
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with device status
+     */
+    getDeviceStatus(deviceId: string, accessToken: string): Promise<any>;
+    /**
+     * Gets device lock status for SmartThings
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with lock status
+     */
+    getDeviceLockStatus(deviceId: string, accessToken: string): Promise<any>;
+}
+/**
+ * Interface for device command factory
+ */
+export interface IDeviceCommandManagerFactory {
+    /**
+     * Creates a device command manager for a specific connection provider
+     * @param connectionProvider - Connection provider type
+     * @param connection - Connection object
+     * @returns Device command manager instance
+     */
+    createDeviceCommandManager(connectionProvider: string, connection: IConnection): IDeviceCommandManager;
+}
+/**
+ * Interface for device command classes
+ */
+export interface IDeviceCommandClass {
+    /**
+     * Creates a SmartThings device command from a generic device command
+     * @param deviceCommand - Generic device command
+     * @returns SmartThings device command
+     */
+    fromDeviceCommand(deviceCommand: IDeviceCommand): ISmartthingsDeviceCommand;
+}

package/dist/device/cloud/interface.js

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

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

@@ -0,0 +1,39 @@
+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/dist/device/cloud/interfaces/IDeviceConnectionService.js

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

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

@@ -0,0 +1,9 @@
+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/dist/device/cloud/interfaces/IDevicesService.js

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

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

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

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

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

@@ -0,0 +1,42 @@
+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 declare class ConnectionService implements 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/dist/device/cloud/services/Connection.service.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionService = void 0;
+/**
+ * Device Cloud Service Class
+ * Implements IDeviceCloudService interface with empty implementations
+ * Implementation will be provided by the consuming project
+ */
+class ConnectionService {
+    /**
+     * Creates a new connection for device management
+     * @param data - Connection data
+     * @param userId - User identifier
+     * @returns Promise with connection result
+     */
+    async createConnection(data, userId) {
+        // 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) {
+        // 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) {
+        // 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, devices) {
+        // 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, connectionConnect) {
+        // Implementation will be provided by the consuming project
+        throw new Error("connect method not implemented");
+    }
+}
+exports.ConnectionService = ConnectionService;

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

@@ -0,0 +1,10 @@
+import { IDeviceService } from "../interfaces";
+import { IConnection } from "../types";
+export declare class DeviceService implements 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/dist/device/cloud/services/Device.service.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceService = void 0;
+class DeviceService {
+    async getDevices(connection) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getDevices method not implemented");
+    }
+    async getDevice(connectionId, deviceId) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getDevice method not implemented");
+    }
+    async getStatus(connectionId, deviceId) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getDeviceStatus method not implemented");
+    }
+    async getState(deviceId) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getState method not implemented");
+    }
+    async getGateways(connectionId) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getGateways method not implemented");
+    }
+    async getGatewayDetails(connectionId, gatewayId) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getGatewayDetails method not implemented");
+    }
+}
+exports.DeviceService = DeviceService;

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

@@ -0,0 +1,42 @@
+import { IDeviceCloudService } from "../interface";
+import { IConnection, IDevice, IDeviceAccountResponse, IConnectionConnectParams } from "../types";
+/**
+ * Device Cloud Service Class
+ * Implements IDeviceCloudService interface with empty implementations
+ * Implementation will be provided by the consuming project
+ */
+export declare class DeviceCloudService implements IDeviceCloudService {
+    /**
+     * 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<IDevice[]>;
+    /**
+     * 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/dist/device/cloud/services/DeviceCloudService.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceCloudService = void 0;
+/**
+ * Device Cloud Service Class
+ * Implements IDeviceCloudService interface with empty implementations
+ * Implementation will be provided by the consuming project
+ */
+class DeviceCloudService {
+    /**
+     * Creates a new connection for device management
+     * @param data - Connection data
+     * @param userId - User identifier
+     * @returns Promise with connection result
+     */
+    async createConnection(data, userId) {
+        // 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) {
+        // 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) {
+        // 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, devices) {
+        // 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, connectionConnect) {
+        // Implementation will be provided by the consuming project
+        throw new Error("connect method not implemented");
+    }
+}
+exports.DeviceCloudService = DeviceCloudService;

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

@@ -0,0 +1,3 @@
+export declare class DeviceHubService {
+    getHubs(): Promise<any>;
+}

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceHubService = void 0;
+class DeviceHubService {
+    async getHubs() {
+        // implements will be provided by the consuming project
+        throw new Error("getHubs method not implemented");
+    }
+}
+exports.DeviceHubService = DeviceHubService;

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

@@ -0,0 +1,38 @@
+import { ISmartthingsDeviceCommandManager } from "../interface";
+import { IDeviceCommand, ISmartthingsDeviceCommand, ICommandResponse } from "../types";
+/**
+ * SmartThings Device Service Class
+ * Implements ISmartthingsDeviceCommandManager interface with empty implementations
+ * Implementation will be provided by the consuming project
+ */
+export declare class SmartThingsDeviceService implements ISmartthingsDeviceCommandManager {
+    /**
+     * Invokes a command on a device
+     * @param command - Device command to execute
+     * @param deviceId - Device identifier
+     * @returns Promise with command response
+     */
+    invokeCommand(command: IDeviceCommand, deviceId: string): Promise<ICommandResponse>;
+    /**
+     * Performs device action for SmartThings
+     * @param commands - Array of SmartThings device commands
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with action result
+     */
+    performDeviceAction(commands: ISmartthingsDeviceCommand[], deviceId: string, accessToken: string): Promise<any>;
+    /**
+     * Gets device status for SmartThings
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with device status
+     */
+    getDeviceStatus(deviceId: string, accessToken: string): Promise<any>;
+    /**
+     * Gets device lock status for SmartThings
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with lock status
+     */
+    getDeviceLockStatus(deviceId: string, accessToken: string): Promise<any>;
+}

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmartThingsDeviceService = void 0;
+/**
+ * SmartThings Device Service Class
+ * Implements ISmartthingsDeviceCommandManager interface with empty implementations
+ * Implementation will be provided by the consuming project
+ */
+class SmartThingsDeviceService {
+    /**
+     * Invokes a command on a device
+     * @param command - Device command to execute
+     * @param deviceId - Device identifier
+     * @returns Promise with command response
+     */
+    async invokeCommand(command, deviceId) {
+        // Implementation will be provided by the consuming project
+        throw new Error("invokeCommand method not implemented");
+    }
+    /**
+     * Performs device action for SmartThings
+     * @param commands - Array of SmartThings device commands
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with action result
+     */
+    async performDeviceAction(commands, deviceId, accessToken) {
+        // Implementation will be provided by the consuming project
+        throw new Error("performDeviceAction method not implemented");
+    }
+    /**
+     * Gets device status for SmartThings
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with device status
+     */
+    async getDeviceStatus(deviceId, accessToken) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getDeviceStatus method not implemented");
+    }
+    /**
+     * Gets device lock status for SmartThings
+     * @param deviceId - Device identifier
+     * @param accessToken - Access token for authentication
+     * @returns Promise with lock status
+     */
+    async getDeviceLockStatus(deviceId, accessToken) {
+        // Implementation will be provided by the consuming project
+        throw new Error("getDeviceLockStatus method not implemented");
+    }
+}
+exports.SmartThingsDeviceService = SmartThingsDeviceService;

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

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

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

@@ -0,0 +1,19 @@
+"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 });
+__exportStar(require("./Connection.service"), exports);
+__exportStar(require("./Device.service"), exports);