dt-common-device 1.0.0

package/src/device/cloud/types.ts

@@ -0,0 +1,83 @@
+// 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";
+}

package/src/device/local/interfaces/IDevice.ts

@@ -0,0 +1,48 @@
+// Interfaces for DeviceService methods
+
+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/src/device/local/interfaces/IHub.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/src/device/local/interfaces/index.ts

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

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

@@ -0,0 +1,46 @@
+// src/device/local/services/Device.service.ts
+
+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 });
+  }
+
+  async getDevice(
+    deviceId: string,
+    httpClient: { get: (url: string) => Promise<any> }
+  ): Promise<any> {
+    return await httpClient.get(`/devices/${deviceId}`);
+  }
+
+  async getPropertyDevices(
+    propertyId: string,
+    httpClient: { get: (url: string, options: any) => Promise<any> }
+  ): Promise<any> {
+    return await httpClient.get(`/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 deleteDevice(
+    deviceId: string,
+    httpClient: { delete: (url: string) => Promise<any> }
+  ): Promise<any> {
+    return await httpClient.delete(`/devices/${deviceId}`);
+  }
+}

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

@@ -0,0 +1,50 @@
+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 });
+  }
+
+  //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> {
+    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: string,
+    httpClient: { get: (url: string) => Promise<any> }
+  ): Promise<any> {
+    return await httpClient.get(`/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 deleteHub(
+    hubId: string,
+    httpClient: { delete: (url: string) => Promise<any> }
+  ): Promise<any> {
+    return await httpClient.delete(`/devices/hubs/${hubId}`);
+  }
+
+  async deleteAllHubs(
+    hubIds: string[],
+    httpClient: { delete: (url: string) => Promise<any> }
+  ): Promise<any> {
+    const query = hubIds.length ? `?ids=${hubIds.join(",")}` : "";
+    return await httpClient.delete(`/devices/hubs${query}`);
+  }
+}

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

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

package/src/index.ts

@@ -0,0 +1,10 @@
+// Main entry point for dt-common-device
+
+// Cloud exports
+export * as cloud from "./device/cloud/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";

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}