dt-common-device 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-export * as cloud from "./device/cloud/services";
+export { CloudDeviceService, CloudDeviceHubService, CloudConnectionService, } from "./device/cloud/services";
+export { LocalDeviceService, LocalDeviceHubService, } from "./device/local/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";
+export { initialize, getConfig } from "./config/config";

package/dist/index.js

@@ -37,11 +37,20 @@ 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;
+exports.getConfig = exports.initialize = exports.localInterfaces = exports.cloudInterfaces = exports.LocalDeviceHubService = exports.LocalDeviceService = exports.CloudConnectionService = exports.CloudDeviceHubService = exports.CloudDeviceService = void 0;
 // Cloud exports
-exports.cloud = __importStar(require("./device/cloud/services"));
+var services_1 = require("./device/cloud/services");
+Object.defineProperty(exports, "CloudDeviceService", { enumerable: true, get: function () { return services_1.CloudDeviceService; } });
+Object.defineProperty(exports, "CloudDeviceHubService", { enumerable: true, get: function () { return services_1.CloudDeviceHubService; } });
+Object.defineProperty(exports, "CloudConnectionService", { enumerable: true, get: function () { return services_1.CloudConnectionService; } });
+var services_2 = require("./device/local/services");
+Object.defineProperty(exports, "LocalDeviceService", { enumerable: true, get: function () { return services_2.LocalDeviceService; } });
+Object.defineProperty(exports, "LocalDeviceHubService", { enumerable: true, get: function () { return services_2.LocalDeviceHubService; } });
 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"));
+//initialize export
+var config_1 = require("./config/config");
+Object.defineProperty(exports, "initialize", { enumerable: true, get: function () { return config_1.initialize; } });
+Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return config_1.getConfig; } });

package/dist/types/config.types.d.ts

@@ -0,0 +1,7 @@
+export type DeviceConfig = {
+    ADMIN_SERVICE: string;
+    OPERATIONAL_SERVICE: string;
+    DEVICE_SERVICE: string;
+    MONITORING_SERVICE: string;
+    [key: string]: string;
+};

package/dist/types/config.types.js

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

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./config.types";

package/dist/types/index.js

@@ -0,0 +1,17 @@
+"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("./config.types"), exports);

package/package.json

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

package/src/config/config.ts

@@ -0,0 +1,27 @@
+import { DeviceConfig } from "../types";
+
+let config: DeviceConfig | null = null;
+
+export function initialize(cfg: DeviceConfig) {
+  // Check if at least one service is provided
+  const hasAtLeastOneService = [
+    "ADMIN_SERVICE",
+    "OPERATIONAL_SERVICE",
+    "DEVICE_SERVICE",
+    "MONITORING_SERVICE",
+  ].some((key) => Boolean(cfg[key]));
+
+  if (!hasAtLeastOneService) {
+    throw new Error("At least one http service must be initialized");
+  }
+  config = { ...cfg };
+}
+
+export function getConfig(): DeviceConfig {
+  if (!config) {
+    throw new Error(
+      "dt-common-device: Library not initialized. Call initialize() first."
+    );
+  }
+  return config;
+}

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

@@ -7,46 +7,18 @@ import {
   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>;
+  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[]>;
+  filterDevices(
+    connection: IConnection,
+    devices: Record<string, 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

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

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

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

@@ -1,34 +1,13 @@
 // Device Cloud Service - Class Implementation
 import { IDeviceConnectionService } from "../interfaces";
-import {
-  IConnection,
-  IConnectionConnectParams,
-  IDevice,
-  IDeviceAccountResponse,
-} from "../types";
+import { IConnection, 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> {
+  async createConnection(data: IConnection, userId: string) {
     // 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> {
@@ -36,40 +15,20 @@ export class ConnectionService implements IDeviceConnectionService {
     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> {
+  async getDevices(connection: IConnection): Promise<IDevice[]> {
     // 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[]
+    devices: Record<string, 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> {
+  async connect(connection: IConnection) {
     // Implementation will be provided by the consuming project
     throw new Error("connect method not implemented");
   }

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

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

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

@@ -1,4 +1,5 @@
 // Device Cloud Services - Export all service classes
 
-export * from "./Connection.service";
-export * from "./Device.service";
+export { DeviceService as CloudDeviceService } from "./Device.service";
+export { ConnectionService as CloudConnectionService } from "./Connection.service";
+export { DeviceHubService as CloudDeviceHubService } from "./DeviceHub.service";

package/src/device/cloud/types.ts

@@ -1,83 +1,105 @@
-// Device Cloud Type Interfaces for DeviceThread Common Library
-
-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";
-}
+// Device Cloud Type Interfaces for DeviceThread Common Library
+
+/**
+ * Represents a connection to a device provider.
+ * WARNING: Do not log or expose sensitive fields (accessToken, clientSecret).
+ */
+export interface IConnection {
+  connectionName: string;
+  connectionRefId: string;
+  propertyId: string;
+  connectionProvider: ConnectionProvider;
+  accessToken?: string;
+  clientId?: string;
+  clientSecret?: string;
+}
+
+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.
+ */
+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]: unknown;
+}
+
+export interface ConnectionProvider {
+  Smartthings: "Smartthings";
+  SaltoKS: "SaltoKS";
+  Tuya: "Tuya";
+  TTLock: "TTLock";
+  Schlage: "Schlage";
+  YaleWifi: "YaleWifi";
+  Devicethread: "Devicethread";
+  Sensibo: "Sensibo";
+}

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

@@ -1,46 +1,41 @@
 // src/device/local/services/Device.service.ts
 
+import axios from "axios";
+import { getConfig } from "../../../config/config";
 import { IDeviceCreateParams } from "../interfaces";
 
 export class DeviceService {
-  async createDevice(
-    body: IDeviceCreateParams,
-    httpClient: { post: (url: string, options: any) => Promise<any> }
-  ): Promise<void> {
-    // Create main device
-    await httpClient.post("/devices", { body });
+  private readonly baseUrl: string;
+
+  constructor() {
+    const { DEVICE_SERVICE } = getConfig();
+    if (!DEVICE_SERVICE) {
+      throw new Error(
+        "DEVICE_SERVICE is not configured. Call initialize() first with DEVICE_SERVICE."
+      );
+    }
+    this.baseUrl = DEVICE_SERVICE;
+  }
+
+  async createDevice(body: IDeviceCreateParams): Promise<void> {
+    await axios.post(`${this.baseUrl}/devices`, body);
   }
 
-  async getDevice(
-    deviceId: string,
-    httpClient: { get: (url: string) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.get(`/devices/${deviceId}`);
+  async getDevice(deviceId: string): Promise<any> {
+    return await axios.get(`${this.baseUrl}/devices/${deviceId}`);
   }
 
-  async getPropertyDevices(
-    propertyId: string,
-    httpClient: { get: (url: string, options: any) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.get(`/devices`, {
-      params: {
-        propertyId,
-      },
+  async getPropertyDevices(propertyId: string): Promise<any> {
+    return await axios.get(`${this.baseUrl}/devices`, {
+      params: { propertyId },
     });
   }
 
-  async updateDevice(
-    deviceId: string,
-    body: any,
-    httpClient: { put: (url: string, options: any) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.put(`/devices/${deviceId}`, { body });
+  async updateDevice(deviceId: string, body: any): Promise<any> {
+    return await axios.put(`${this.baseUrl}/devices/${deviceId}`, body);
   }
 
-  async deleteDevice(
-    deviceId: string,
-    httpClient: { delete: (url: string) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.delete(`/devices/${deviceId}`);
+  async deleteDevice(deviceId: string): Promise<any> {
+    return await axios.delete(`${this.baseUrl}/devices/${deviceId}`);
   }
 }

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

@@ -1,50 +1,45 @@
+import axios from "axios";
+import { getConfig } from "../../../config/config";
 import { IHubCreateParams } from "../interfaces";
 
 export class DeviceHubService {
-  async addHub(
-    body: IHubCreateParams,
-    httpClient: { post: (url: string, options: any) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.post(`/devices/hubs`, { body });
+  private readonly baseUrl: string;
+
+  constructor() {
+    const { DEVICE_SERVICE } = getConfig();
+    if (!DEVICE_SERVICE) {
+      throw new Error(
+        "DEVICE_SERVICE is not configured. Call initialize() first with DEVICE_SERVICE."
+      );
+    }
+    this.baseUrl = DEVICE_SERVICE;
+  }
+
+  async addHub(body: IHubCreateParams): Promise<any> {
+    return await axios.post(`${this.baseUrl}/devices/hubs`, body);
   }
 
   //get hubs takes an array of hub ids as query params
-  async getHubs(
-    hubIds: string[],
-    httpClient: { get: (url: string, options?: any) => Promise<any> }
-  ): Promise<any> {
+  async getHubs(hubIds: string[]): Promise<any> {
     const query = hubIds && hubIds.length ? `?ids=${hubIds.join(",")}` : "";
-    return await httpClient.get(`/devices/hubs${query}`);
+    return await axios.get(`${this.baseUrl}/devices/hubs${query}`);
   }
 
   //get hub takes a hub id in params
-  async getHub(
-    hubId: string,
-    httpClient: { get: (url: string) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.get(`/devices/hubs/${hubId}`);
+  async getHub(hubId: string): Promise<any> {
+    return await axios.get(`${this.baseUrl}/devices/hubs/${hubId}`);
   }
 
-  async updateHub(
-    hubId: string,
-    body: any,
-    httpClient: { put: (url: string, options: any) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.put(`/devices/hubs/${hubId}`, { body });
+  async updateHub(hubId: string, body: any): Promise<any> {
+    return await axios.put(`${this.baseUrl}/devices/hubs/${hubId}`, body);
   }
 
-  async deleteHub(
-    hubId: string,
-    httpClient: { delete: (url: string) => Promise<any> }
-  ): Promise<any> {
-    return await httpClient.delete(`/devices/hubs/${hubId}`);
+  async deleteHub(hubId: string): Promise<any> {
+    return await axios.delete(`${this.baseUrl}/devices/hubs/${hubId}`);
   }
 
-  async deleteAllHubs(
-    hubIds: string[],
-    httpClient: { delete: (url: string) => Promise<any> }
-  ): Promise<any> {
+  async deleteAllHubs(hubIds: string[]): Promise<any> {
     const query = hubIds.length ? `?ids=${hubIds.join(",")}` : "";
-    return await httpClient.delete(`/devices/hubs${query}`);
+    return await axios.delete(`${this.baseUrl}/devices/hubs${query}`);
   }
 }

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

@@ -1,2 +1,2 @@
-export * from "./Device.service";
-export * from "./DeviceHub.service";
+export { DeviceService as LocalDeviceService } from "./Device.service";
+export { DeviceHubService as LocalDeviceHubService } from "./DeviceHub.service";

package/src/index.ts

@@ -1,10 +1,21 @@
 // Main entry point for dt-common-device
 
 // Cloud exports
-export * as cloud from "./device/cloud/services";
+export {
+  CloudDeviceService,
+  CloudDeviceHubService,
+  CloudConnectionService,
+} from "./device/cloud/services";
+export {
+  LocalDeviceService,
+  LocalDeviceHubService,
+} from "./device/local/services";
+
 export * as cloudInterfaces from "./device/cloud/interfaces";
 export * from "./device/cloud/types";
 
 // Local exports
-export * as local from "./device/local/services";
 export * as localInterfaces from "./device/local/interfaces";
+
+//initialize export
+export { initialize, getConfig } from "./config/config";