dt-common-device 1.0.4 → 1.0.5

package/README.md

@@ -28,6 +28,65 @@ At least one service URL must be provided.
 
 ---
 
+## Implementing Abstract Classes (Cloud Connection Example)
+
+This library provides abstract classes (such as `ConnectionService`) that define the required contract for cloud connection managers. **You should extend these abstract classes and implement all required methods.**
+
+**You do NOT need to instantiate your class unless you want to use it in your application logic.**
+
+### Example: Implementing a Cloud Connection Service
+
+```ts
+import {
+  ConnectionService,
+  IConnection,
+  IDevice,
+  IDeviceAccountResponse,
+  IConnectionConnectParams,
+} from "dt-common-device";
+
+class MyConnectionService extends ConnectionService {
+  async createConnection(data: IConnection, userId: string): Promise<any> {
+    // Your implementation
+  }
+
+  async getDeviceAccount(
+    connection: IConnection
+  ): Promise<IDeviceAccountResponse> {
+    // Your implementation
+  }
+
+  async getDevices(connection: IConnection): Promise<IDevice[]> {
+    // Your implementation
+  }
+
+  async filterDevices(
+    connection: IConnection,
+    devices: Record<string, any>[]
+  ): Promise<IDevice[]> {
+    // Your implementation
+  }
+
+  async connect(
+    connection: IConnection,
+    connectionConnect: IConnectionConnectParams
+  ): Promise<any> {
+    // Your implementation
+  }
+}
+```
+
+- TypeScript will enforce that you implement all required methods.
+- If you miss any, you will get a compile-time error.
+- You only need to instantiate your class if you want to use it in your application logic:
+
+```ts
+const myService = new MyConnectionService();
+myService.createConnection(...);
+```
+
+---
+
 ## Importing Services
 
 ### Cloud Device Service

package/dist/config/config.js

@@ -10,6 +10,7 @@ function initialize(cfg) {
         "OPERATIONAL_SERVICE",
         "DEVICE_SERVICE",
         "MONITORING_SERVICE",
+        "ENERGY_SERVICE",
     ].some((key) => Boolean(cfg[key]));
     if (!hasAtLeastOneService) {
         throw new Error("At least one http service must be initialized");

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

@@ -1,9 +1,9 @@
 import { IDeviceConnectionService } from "../interfaces";
-import { IConnection, IDevice, IDeviceAccountResponse } from "../types";
-export declare class ConnectionService implements IDeviceConnectionService {
-    createConnection(data: IConnection, userId: string): Promise<void>;
-    getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
-    getDevices(connection: IConnection): Promise<IDevice[]>;
-    filterDevices(connection: IConnection, devices: Record<string, any>[]): Promise<IDevice[]>;
-    connect(connection: IConnection): Promise<void>;
+import { IConnection, IDevice, IDeviceAccountResponse, IConnectionConnectParams } from "../types";
+export declare abstract class ConnectionService implements IDeviceConnectionService {
+    abstract createConnection(data: IConnection, userId: string): Promise<any>;
+    abstract getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
+    abstract getDevices(connection: IConnection): Promise<IDevice[]>;
+    abstract filterDevices(connection: IConnection, devices: Record<string, any>[]): Promise<IDevice[]>;
+    abstract connect(connection: IConnection, connectionConnect: IConnectionConnectParams): Promise<any>;
 }

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

@@ -2,25 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConnectionService = void 0;
 class ConnectionService {
-    async createConnection(data, userId) {
-        // Implementation will be provided by the consuming project
-        throw new Error("createConnection method not implemented");
-    }
-    async getDeviceAccount(connection) {
-        // Implementation will be provided by the consuming project
-        throw new Error("getDeviceAccount method not implemented");
-    }
-    async getDevices(connection) {
-        // Implementation will be provided by the consuming project
-        throw new Error("getDevices method not implemented");
-    }
-    async filterDevices(connection, devices) {
-        // Implementation will be provided by the consuming project
-        throw new Error("filterDevices method not implemented");
-    }
-    async connect(connection) {
-        // 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

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

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

@@ -2,29 +2,5 @@
 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/DeviceHub.service.d.ts

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

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

@@ -2,9 +2,5 @@
 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/types/config.types.d.ts

@@ -3,5 +3,6 @@ export type DeviceConfig = {
     OPERATIONAL_SERVICE: string;
     DEVICE_SERVICE: string;
     MONITORING_SERVICE: string;
+    ENERGY_SERVICE: string;
     [key: string]: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dt-common-device",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/config/config.ts

@@ -9,6 +9,7 @@ export function initialize(cfg: DeviceConfig) {
     "OPERATIONAL_SERVICE",
     "DEVICE_SERVICE",
     "MONITORING_SERVICE",
+    "ENERGY_SERVICE",
   ].some((key) => Boolean(cfg[key]));
 
   if (!hasAtLeastOneService) {

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

@@ -1,35 +1,28 @@
 // Device Cloud Service - Class Implementation
 import { IDeviceConnectionService } from "../interfaces";
-import { IConnection, IDevice, IDeviceAccountResponse } from "../types";
+import {
+  IConnection,
+  IDevice,
+  IDeviceAccountResponse,
+  IConnectionConnectParams,
+} from "../types";
 
-export class ConnectionService implements IDeviceConnectionService {
-  async createConnection(data: IConnection, userId: string) {
-    // Implementation will be provided by the consuming project
-    throw new Error("createConnection method not implemented");
-  }
+export abstract class ConnectionService implements IDeviceConnectionService {
+  abstract createConnection(data: IConnection, userId: string): Promise<any>;
 
-  async getDeviceAccount(
+  abstract getDeviceAccount(
     connection: IConnection
-  ): Promise<IDeviceAccountResponse> {
-    // Implementation will be provided by the consuming project
-    throw new Error("getDeviceAccount method not implemented");
-  }
+  ): Promise<IDeviceAccountResponse>;
 
-  async getDevices(connection: IConnection): Promise<IDevice[]> {
-    // Implementation will be provided by the consuming project
-    throw new Error("getDevices method not implemented");
-  }
+  abstract getDevices(connection: IConnection): Promise<IDevice[]>;
 
-  async filterDevices(
+  abstract filterDevices(
     connection: IConnection,
     devices: Record<string, any>[]
-  ): Promise<IDevice[]> {
-    // Implementation will be provided by the consuming project
-    throw new Error("filterDevices method not implemented");
-  }
+  ): Promise<IDevice[]>;
 
-  async connect(connection: IConnection) {
-    // Implementation will be provided by the consuming project
-    throw new Error("connect method not implemented");
-  }
+  abstract connect(
+    connection: IConnection,
+    connectionConnect: IConnectionConnectParams
+  ): Promise<any>;
 }

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

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

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

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

package/src/types/config.types.ts

@@ -3,5 +3,6 @@ export type DeviceConfig = {
   OPERATIONAL_SERVICE: string;
   DEVICE_SERVICE: string;
   MONITORING_SERVICE: string;
+  ENERGY_SERVICE: string;
   [key: string]: string;
 };