dt-common-device 13.1.3 → 13.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/dist/admin/Admin.repository.d.ts +7 -0
  2. package/dist/admin/Admin.service.d.ts +5 -0
  3. package/dist/admin/index.d.ts +1 -0
  4. package/dist/alerts/AlertBuilder.example.d.ts +11 -0
  5. package/dist/alerts/AlertService.example.d.ts +55 -0
  6. package/dist/audit/AuditProperties.d.ts +16 -0
  7. package/dist/chronicle/Cronicle.service.d.ts +9 -0
  8. package/dist/chronicle/IChronicle.interface.d.ts +14 -0
  9. package/dist/chronicle/ICronicle.interface.d.ts +15 -0
  10. package/dist/chronicle/chronicle.service.d.ts +4 -0
  11. package/dist/chronicle/index.d.ts +2 -0
  12. package/dist/connection/Connection.repository.d.ts +8 -0
  13. package/dist/connection/Connection.service.d.ts +8 -0
  14. package/dist/connection/IConnection.d.ts +28 -0
  15. package/dist/connection/index.d.ts +2 -0
  16. package/dist/copilotQueue/examples/CopilotQueue.example.d.ts +37 -0
  17. package/dist/copilotQueue/examples/index.d.ts +1 -0
  18. package/dist/device/cloud/entities/CloudConnection.d.ts +6 -0
  19. package/dist/device/cloud/entities/CloudDevice.d.ts +16 -0
  20. package/dist/device/cloud/entities/CloudDeviceService.d.ts +5 -0
  21. package/dist/device/cloud/entities/DeviceFactory.d.ts +7 -0
  22. package/dist/device/cloud/entities/index.d.ts +3 -0
  23. package/dist/device/cloud/interface.d.ts +101 -0
  24. package/dist/device/cloud/interfaces/ICloudConnection.d.ts +5 -0
  25. package/dist/device/cloud/interfaces/ICloudDevice.d.ts +9 -0
  26. package/dist/device/cloud/interfaces/ICloudDeviceService.d.ts +4 -0
  27. package/dist/device/cloud/interfaces/IConnectionService.d.ts +7 -0
  28. package/dist/device/cloud/interfaces/IDeviceConnectionService.d.ts +7 -0
  29. package/dist/device/cloud/interfaces/IDeviceFactory.d.ts +4 -0
  30. package/dist/device/cloud/interfaces/IDeviceService.d.ts +8 -0
  31. package/dist/device/cloud/interfaces/IDevicesService.d.ts +9 -0
  32. package/dist/device/cloud/interfaces/IHubService.d.ts +5 -0
  33. package/dist/device/cloud/interfaces/IRawDataTransformer.d.ts +4 -0
  34. package/dist/device/cloud/interfaces/IRawDevice.d.ts +17 -0
  35. package/dist/device/cloud/interfaces/index.d.ts +5 -0
  36. package/dist/device/cloud/services/CloudDevice.service.d.ts +5 -0
  37. package/dist/device/cloud/services/Connection.service.d.ts +8 -0
  38. package/dist/device/cloud/services/Device.service.d.ts +39 -0
  39. package/dist/device/cloud/services/DeviceCloudService.d.ts +42 -0
  40. package/dist/device/cloud/services/DeviceHub.service.d.ts +3 -0
  41. package/dist/device/cloud/services/Hub.service.d.ts +25 -0
  42. package/dist/device/cloud/services/SmartThingsDeviceService.d.ts +38 -0
  43. package/dist/device/cloud/services/SmartThingsDeviceService.js +52 -0
  44. package/dist/device/cloud/services/index.d.ts +2 -0
  45. package/dist/device/cloud/types.d.ts +52 -0
  46. package/dist/device/cloud/types.js +15 -0
  47. package/dist/device/index.d.ts +4 -0
  48. package/dist/device/local/entities/AlertBuilder.d.ts +87 -0
  49. package/dist/device/local/entities/AlertBuilder.example.d.ts +11 -0
  50. package/dist/device/local/entities/IssueBuilder.d.ts +109 -0
  51. package/dist/device/local/entities/IssueBuilder.example.d.ts +16 -0
  52. package/dist/device/local/entities/IssueBuilder.example.js +196 -0
  53. package/dist/device/local/entities/IssueBuilder.js +237 -0
  54. package/dist/device/local/entities/index.d.ts +2 -0
  55. package/dist/device/local/events/EventHandler.d.ts +11 -0
  56. package/dist/device/local/events/Events.d.ts +54 -0
  57. package/dist/device/local/events/index.d.ts +2 -0
  58. package/dist/device/local/handler/EventHandler.d.ts +7 -0
  59. package/dist/device/local/interface.d.ts +0 -0
  60. package/dist/device/local/interfaces/IConnection.d.ts +26 -0
  61. package/dist/device/local/interfaces/IDevice.d.ts +68 -0
  62. package/dist/device/local/interfaces/IDtDevice.d.ts +16 -0
  63. package/dist/device/local/interfaces/IHub.d.ts +46 -0
  64. package/dist/device/local/interfaces/IProperty.d.ts +29 -0
  65. package/dist/device/local/interfaces/ISchedule.d.ts +25 -0
  66. package/dist/device/local/interfaces/index.d.ts +3 -0
  67. package/dist/device/local/models/Alert.model.d.ts +28 -0
  68. package/dist/device/local/models/Issue.model.d.ts +28 -0
  69. package/dist/device/local/repository/Alert.repository.d.ts +106 -0
  70. package/dist/device/local/repository/Connection.repository.d.ts +8 -0
  71. package/dist/device/local/repository/Device.repository.d.ts +30 -0
  72. package/dist/device/local/repository/Hub.repository.d.ts +13 -0
  73. package/dist/device/local/repository/Issue.repository.d.ts +113 -0
  74. package/dist/device/local/repository/Property.repository.d.ts +8 -0
  75. package/dist/device/local/repository/Property.repository.js +95 -0
  76. package/dist/device/local/repository/Schedule.repository.d.ts +9 -0
  77. package/dist/device/local/repository/Schedule.repository.js +109 -0
  78. package/dist/device/local/services/Alert.service.d.ts +137 -0
  79. package/dist/device/local/services/AlertService.example.d.ts +55 -0
  80. package/dist/device/local/services/Connection.service.d.ts +8 -0
  81. package/dist/device/local/services/Device.service.d.ts +40 -0
  82. package/dist/device/local/services/DeviceHub.service.d.ts +11 -0
  83. package/dist/device/local/services/Hub.service.d.ts +12 -0
  84. package/dist/device/local/services/Issue.service.d.ts +168 -0
  85. package/dist/device/local/services/Issue.service.js +642 -0
  86. package/dist/device/local/services/IssueService.example.d.ts +68 -0
  87. package/dist/device/local/services/IssueService.example.js +177 -0
  88. package/dist/device/local/services/Property.service.d.ts +8 -0
  89. package/dist/device/local/services/Property.service.js +36 -0
  90. package/dist/device/local/services/Schedule.service.d.ts +9 -0
  91. package/dist/device/local/services/Schedule.service.js +26 -0
  92. package/dist/device/local/services/index.d.ts +3 -0
  93. package/dist/entities/accessGroup/AccessGroup.repository.d.ts +5 -0
  94. package/dist/entities/accessGroup/AccessGroup.service.d.ts +5 -0
  95. package/dist/entities/accessGroup/IAccessGroup.d.ts +14 -0
  96. package/dist/entities/accessGroup/index.d.ts +2 -0
  97. package/dist/entities/admin/Admin.repository.d.ts +1 -0
  98. package/dist/entities/admin/Admin.repository.js +9 -0
  99. package/dist/entities/admin/Admin.service.d.ts +1 -0
  100. package/dist/entities/admin/Admin.service.js +3 -0
  101. package/dist/entities/device/local/repository/DeviceProfile.repository.d.ts +5 -0
  102. package/dist/entities/guest/Guest.repository.d.ts +6 -0
  103. package/dist/entities/guest/Guest.service.d.ts +6 -0
  104. package/dist/entities/guest/IGuest.d.ts +12 -0
  105. package/dist/entities/guest/index.d.ts +2 -0
  106. package/dist/entities/schedules/ISchedule.d.ts +14 -0
  107. package/dist/entities/schedules/Schedule.repository.d.ts +6 -0
  108. package/dist/entities/schedules/Schedule.repository.js +74 -0
  109. package/dist/entities/schedules/Schedule.service.d.ts +6 -0
  110. package/dist/entities/schedules/Schedule.service.js +104 -0
  111. package/dist/entities/schedules/index.d.ts +2 -0
  112. package/dist/entities/user/IUser.d.ts +15 -0
  113. package/dist/entities/user/IUser.js +2 -0
  114. package/dist/entities/user/User.repository.d.ts +5 -0
  115. package/dist/entities/user/User.repository.js +68 -0
  116. package/dist/entities/user/User.service.d.ts +6 -0
  117. package/dist/entities/user/User.service.js +103 -0
  118. package/dist/entities/zone/IZone.d.ts +10 -0
  119. package/dist/entities/zone/IZone.js +2 -0
  120. package/dist/entities/zone/Zone.repository.d.ts +6 -0
  121. package/dist/entities/zone/Zone.repository.js +77 -0
  122. package/dist/entities/zone/Zone.service.d.ts +6 -0
  123. package/dist/entities/zone/Zone.service.js +104 -0
  124. package/dist/entities/zone/index.d.ts +2 -0
  125. package/dist/issues/IssueBuilder.example.d.ts +16 -0
  126. package/dist/issues/IssueBuilder.example.js +196 -0
  127. package/dist/issues/IssueService.example.d.ts +68 -0
  128. package/dist/issues/IssueService.example.js +292 -0
  129. package/dist/pms/IPms.d.ts +6 -0
  130. package/dist/pms/index.d.ts +1 -0
  131. package/dist/pms/webhookQueue/examples/index.d.ts +2 -0
  132. package/dist/pms/webhookQueue/examples/pms-integration.d.ts +65 -0
  133. package/dist/pms/webhookQueue/examples/pms-integration.js +254 -0
  134. package/dist/pms/webhookQueue/examples/usage.d.ts +7 -0
  135. package/dist/pms/webhookQueue/examples/usage.js +175 -0
  136. package/dist/pms/webhookQueue/index.d.ts +3 -0
  137. package/dist/pms/webhookQueue/interfaces/IWebhookQueue.d.ts +33 -0
  138. package/dist/pms/webhookQueue/interfaces/IWebhookQueue.js +2 -0
  139. package/dist/pms/webhookQueue/interfaces/IWebhookWorker.d.ts +38 -0
  140. package/dist/pms/webhookQueue/interfaces/IWebhookWorker.js +2 -0
  141. package/dist/pms/webhookQueue/interfaces/index.d.ts +1 -0
  142. package/dist/pms/webhookQueue/services/WebhookQueueFactory.d.ts +38 -0
  143. package/dist/pms/webhookQueue/services/WebhookQueueFactory.js +131 -0
  144. package/dist/pms/webhookQueue/services/WebhookQueueIntegration.d.ts +70 -0
  145. package/dist/pms/webhookQueue/services/WebhookQueueIntegration.js +207 -0
  146. package/dist/pms/webhookQueue/services/WebhookQueueService.d.ts +45 -0
  147. package/dist/pms/webhookQueue/services/WebhookQueueService.js +270 -0
  148. package/dist/pms/webhookQueue/services/WebhookWorker.d.ts +37 -0
  149. package/dist/pms/webhookQueue/services/WebhookWorker.js +201 -0
  150. package/dist/pms/webhookQueue/services/index.d.ts +1 -0
  151. package/dist/pms/webhookQueue/types/index.d.ts +1 -0
  152. package/dist/pms/webhookQueue/types/webhook.types.d.ts +39 -0
  153. package/dist/pms/webhookQueue/types/webhook.types.js +2 -0
  154. package/dist/property/IProperty.d.ts +29 -0
  155. package/dist/property/Property.repository.d.ts +8 -0
  156. package/dist/property/Property.repository.js +109 -0
  157. package/dist/property/Property.service.d.ts +8 -0
  158. package/dist/property/Property.service.js +124 -0
  159. package/dist/property/index.d.ts +2 -0
  160. package/dist/queue/interfaces/IHttpRequestJob.d.ts +9 -0
  161. package/dist/types/alert.types.d.ts +57 -0
  162. package/dist/types/config.types.d.ts +19 -0
  163. package/dist/types/index.d.ts +3 -0
  164. package/dist/types/issue.types.d.ts +90 -0
  165. package/dist/types/issue.types.js +40 -0
  166. package/dist/utils/http-utils.d.ts +13 -0
  167. package/package.json +1 -1
@@ -0,0 +1,7 @@
1
+ export declare class AdminRepository {
2
+ private readonly axiosInstance;
3
+ private readonly deviceRepository;
4
+ private readonly postgres;
5
+ constructor();
6
+ getZonesByAccessGroupIds(accessGroupIds: string[]): Promise<any[]>;
7
+ }
@@ -0,0 +1,5 @@
1
+ export declare class AdminService {
2
+ private readonly adminRepository;
3
+ constructor();
4
+ getZonesByAccessGroupIds(accessGroupIds: string[]): Promise<any[]>;
5
+ }
@@ -0,0 +1 @@
1
+ export * from "./Admin.service";
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Example usage of AlertBuilder
3
+ * This file demonstrates various ways to use the AlertBuilder pattern
4
+ */
5
+ export declare function createBasicAlert(): import("./alert.types").CreateAlertData;
6
+ export declare function createDeviceAlert(): import("./alert.types").CreateAlertData;
7
+ export declare function createSecurityAlert(): import("./alert.types").CreateAlertData;
8
+ export declare function createEnergyAlert(): import("./alert.types").CreateAlertData;
9
+ export declare function createHubAlert(): import("./alert.types").CreateAlertData;
10
+ export declare function createSnoozedAlert(): import("./alert.types").CreateAlertData;
11
+ export declare function createMultipleAlerts(): import("./alert.types").CreateAlertData[];
@@ -0,0 +1,55 @@
1
+ import { AlertService } from "./Alert.service";
2
+ /**
3
+ * Example usage of the updated AlertService with AlertBuilder integration
4
+ * This file demonstrates various ways to use the AlertService with the new AlertBuilder
5
+ */
6
+ export declare class AlertServiceExample {
7
+ private readonly alertService;
8
+ constructor(alertService: AlertService);
9
+ /**
10
+ * Example 1: Using the updated createAlert method with AlertBuilder
11
+ */
12
+ createAlertWithBuilder(): Promise<import("./alert.types").AlertDocument>;
13
+ /**
14
+ * Example 2: Using convenience methods for specific alert types
15
+ */
16
+ createSpecificAlerts(): Promise<{
17
+ readinessAlert: import("./alert.types").AlertDocument;
18
+ operationsAlert: import("./alert.types").AlertDocument;
19
+ securityAlert: import("./alert.types").AlertDocument;
20
+ energyAlert: import("./alert.types").AlertDocument;
21
+ }>;
22
+ /**
23
+ * Example 3: Using device-specific alert methods
24
+ */
25
+ createDeviceAlerts(): Promise<{
26
+ deviceAlert1: import("./alert.types").AlertDocument;
27
+ deviceAlert2: import("./alert.types").AlertDocument;
28
+ }>;
29
+ /**
30
+ * Example 4: Using hub-specific alert methods
31
+ */
32
+ createHubAlerts(): Promise<{
33
+ hubAlert1: import("./alert.types").AlertDocument;
34
+ hubAlert2: import("./alert.types").AlertDocument;
35
+ }>;
36
+ /**
37
+ * Example 5: Using static factory methods with AlertBuilder
38
+ */
39
+ createAlertsWithStaticMethods(): Promise<{
40
+ alert1: import("./alert.types").AlertDocument;
41
+ alert2: import("./alert.types").AlertDocument;
42
+ }>;
43
+ /**
44
+ * Example 6: Creating multiple alerts efficiently
45
+ */
46
+ createMultipleAlerts(): Promise<import("./alert.types").AlertDocument[]>;
47
+ /**
48
+ * Example 7: Creating alerts with snooze functionality
49
+ */
50
+ createSnoozedAlert(): Promise<import("./alert.types").AlertDocument>;
51
+ /**
52
+ * Example 8: Backward compatibility - still works with CreateAlertData
53
+ */
54
+ createAlertWithLegacyData(): Promise<import("./alert.types").AlertDocument>;
55
+ }
@@ -0,0 +1,16 @@
1
+ export interface AuditProperties {
2
+ resource: string;
3
+ propertyId: string;
4
+ propertyName?: string;
5
+ userId?: string;
6
+ userName?: string;
7
+ deviceId?: string;
8
+ deviceName?: string;
9
+ zoneId?: string;
10
+ zoneName?: string;
11
+ accessGroupId?: string;
12
+ accessGroupName?: string;
13
+ scheduleId?: string;
14
+ scheduleName?: string;
15
+ [key: string]: any;
16
+ }
@@ -0,0 +1,9 @@
1
+ import { ICronicle } from "./ICronicle.interface";
2
+ export declare class CronicleService {
3
+ private cronicleEndpoint;
4
+ private cronicleApiKey;
5
+ constructor();
6
+ registerJob(payload: ICronicle): Promise<void>;
7
+ getJob(jobId: string): Promise<any>;
8
+ deleteJob(jobId: string): Promise<void>;
9
+ }
@@ -0,0 +1,14 @@
1
+ export interface ICronicle {
2
+ name: string;
3
+ cronJobId: string;
4
+ apiUrl: string;
5
+ method: "POST";
6
+ target: string;
7
+ schedule: {
8
+ minutes?: string;
9
+ hours?: string;
10
+ dom?: string;
11
+ month?: string;
12
+ dow?: string;
13
+ };
14
+ }
@@ -0,0 +1,15 @@
1
+ export interface ICronicle {
2
+ name: string;
3
+ cronJobId: string;
4
+ apiUrl: string;
5
+ method: "POST";
6
+ target: string;
7
+ schedule: {
8
+ years?: number[];
9
+ months?: number[];
10
+ days?: number[];
11
+ weekdays?: number[];
12
+ hours?: number[];
13
+ minutes?: number[];
14
+ };
15
+ }
@@ -0,0 +1,4 @@
1
+ import { ICronicle } from "./IChronicle.interface";
2
+ export declare class ChronicleClass {
3
+ registerJob(payload: ICronicle): Promise<void>;
4
+ }
@@ -0,0 +1,2 @@
1
+ export { CronicleService } from "./Cronicle.service";
2
+ export type { ICronicle } from "./ICronicle.interface";
@@ -0,0 +1,8 @@
1
+ import { IConnection } from "./IConnection";
2
+ export declare class ConnectionRepository {
3
+ private readonly pool;
4
+ constructor();
5
+ createConnection(data: Partial<IConnection>): Promise<IConnection>;
6
+ getConnectionById(connectionId: string): Promise<IConnection>;
7
+ updateConnection(connectionId: string, data: Partial<IConnection>): Promise<any>;
8
+ }
@@ -0,0 +1,8 @@
1
+ import { IConnection } from "./IConnection";
2
+ export declare class LocalConnectionService {
3
+ private readonly connectionRepository;
4
+ constructor();
5
+ createConnection(data: Partial<IConnection>): Promise<IConnection>;
6
+ getConnection(connectionId: string): Promise<IConnection>;
7
+ updateConnection(connectionId: string, data: Partial<IConnection>): Promise<IConnection>;
8
+ }
@@ -0,0 +1,28 @@
1
+ export interface IConnection {
2
+ id?: string;
3
+ createdAt?: Date;
4
+ updatedAt?: Date;
5
+ isDeleted?: boolean;
6
+ connectionName: string;
7
+ connectionRefId: string;
8
+ propertyId: string;
9
+ connectionProvider: ConnectionProvider;
10
+ accessToken?: string;
11
+ refreshToken?: string;
12
+ clientId?: string;
13
+ clientSecret: string;
14
+ isActive?: boolean;
15
+ metaData?: any;
16
+ }
17
+ export declare enum ConnectionProvider {
18
+ Smartthings = "Smartthings",
19
+ SaltoKS = "SaltoKS",
20
+ TTLock = "TTLock",
21
+ Tuya = "Tuya",
22
+ Schlage = "Schlage",
23
+ YaleWifi = "YaleWifi",
24
+ Sensibo = "Sensibo",
25
+ Devicethread = "Devicethread",
26
+ Dormakaba = "Dormakaba",
27
+ Dusaw = "Dusaw"
28
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./IConnection";
2
+ export * from "./Connection.service";
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Example usage of CopilotQueueService
3
+ * This demonstrates how to use the queue system to handle API requests with FIFO ordering per property
4
+ */
5
+ export declare class CopilotQueueExample {
6
+ private copilotQueueService;
7
+ constructor();
8
+ /**
9
+ * Example: Add a simple GET request to the queue
10
+ */
11
+ addGetRequest(propertyId: string, url: string): Promise<string>;
12
+ /**
13
+ * Example: Add a POST request with body to the queue
14
+ */
15
+ addPostRequest(propertyId: string, url: string, data: any): Promise<string>;
16
+ /**
17
+ * Example: Add multiple requests for different properties
18
+ * This demonstrates FIFO ordering per property
19
+ */
20
+ addMultipleRequests(): Promise<void>;
21
+ /**
22
+ * Example: Monitor job status
23
+ */
24
+ monitorJob(jobId: string): Promise<void>;
25
+ /**
26
+ * Example: Get all jobs for a specific property
27
+ */
28
+ getPropertyJobs(propertyId: string): Promise<void>;
29
+ /**
30
+ * Example: Cancel a job
31
+ */
32
+ cancelJob(jobId: string): Promise<void>;
33
+ /**
34
+ * Example: Graceful shutdown
35
+ */
36
+ shutdown(): Promise<void>;
37
+ }
@@ -0,0 +1 @@
1
+ export * from './CopilotQueue.example';
@@ -0,0 +1,6 @@
1
+ import { ICloudConnection } from "../interfaces";
2
+ import { IDeviceAccountResponse, IConnection } from "../types";
3
+ export declare abstract class CloudConnection implements ICloudConnection {
4
+ abstract createConnection(data: IConnection, userId: string): Promise<IConnection>;
5
+ abstract getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
6
+ }
@@ -0,0 +1,16 @@
1
+ import { IDevice } from "../../local/interfaces";
2
+ import { ICloudDevice } from "../interfaces/ICloudDevice";
3
+ import { ICloudDeviceService } from "../interfaces/ICloudDeviceService";
4
+ import { IConnection } from "../../../connection";
5
+ export declare abstract class CloudDevice implements ICloudDevice {
6
+ deviceId: string;
7
+ localDevice?: IDevice;
8
+ connection?: IConnection;
9
+ cloudDeviceService: ICloudDeviceService;
10
+ constructor(device: IDevice, cloudDeviceService: ICloudDeviceService);
11
+ getDevice(connectionId: string, deviceId: string): Promise<Record<string, any>>;
12
+ getBattery(deviceId: string): Promise<number | string>;
13
+ getState(deviceId: string): Promise<string>;
14
+ getStatus(connectionId: string, deviceId: string): Promise<string>;
15
+ toLocalDevice(): Promise<IDevice>;
16
+ }
@@ -0,0 +1,5 @@
1
+ import { ICloudDeviceService } from "../interfaces/ICloudDeviceService";
2
+ import { IConnection } from "../../../connection";
3
+ export declare class CloudDeviceService implements ICloudDeviceService {
4
+ getConnection(deviceId: string): Promise<IConnection>;
5
+ }
@@ -0,0 +1,7 @@
1
+ import { IDevice } from "../../local/interfaces";
2
+ import { IDeviceFactory } from "../interfaces/IDeviceFactory";
3
+ export declare class DeviceFactory implements IDeviceFactory {
4
+ private readonly localDeviceService;
5
+ constructor();
6
+ getDevice(deviceId: string): Promise<IDevice>;
7
+ }
@@ -0,0 +1,3 @@
1
+ export * from "./CloudDevice";
2
+ export * from "./DeviceFactory";
3
+ export * from "./CloudDeviceService";
@@ -0,0 +1,101 @@
1
+ import { IConnection, IConnectionConnectParams, IDevice, IDeviceAccountResponse, IDeviceCommand, ISmartthingsDeviceCommand, ICommandResponse } from "./types";
2
+ /**
3
+ * Class interface for device cloud operations and connection management
4
+ */
5
+ export interface IDeviceCloudService {
6
+ /**
7
+ * Creates a new connection for device management
8
+ * @param data - Connection data
9
+ * @param userId - User identifier
10
+ * @returns Promise with connection result
11
+ */
12
+ createConnection(data: IConnection, userId: string): Promise<any>;
13
+ /**
14
+ * Gets device account information for a connection
15
+ * @param connection - Connection object
16
+ * @returns Promise with device account response
17
+ */
18
+ getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
19
+ /**
20
+ * Gets all devices for a connection
21
+ * @param connection - Connection object
22
+ * @returns Promise with array of devices
23
+ */
24
+ getDevices(connection: IConnection): Promise<IDevice[]>;
25
+ /**
26
+ * Filters devices based on connection and device list
27
+ * @param connection - Connection object
28
+ * @param devices - Array of devices to filter
29
+ * @returns Promise with filtered devices
30
+ */
31
+ filterDevices(connection: IConnection, devices: any[]): Promise<IDevice[]>;
32
+ /**
33
+ * Connects to a device service
34
+ * @param connection - Connection object
35
+ * @param connectionConnect - Connection parameters
36
+ * @returns Promise with connection result
37
+ */
38
+ connect(connection: IConnection, connectionConnect: IConnectionConnectParams): Promise<any>;
39
+ }
40
+ /**
41
+ * Interface for device command operations
42
+ */
43
+ export interface IDeviceCommandManager {
44
+ /**
45
+ * Invokes a command on a device
46
+ * @param command - Device command to execute
47
+ * @param deviceId - Device identifier
48
+ * @returns Promise with command response
49
+ */
50
+ invokeCommand(command: IDeviceCommand, deviceId: string): Promise<ICommandResponse>;
51
+ }
52
+ /**
53
+ * Interface for SmartThings specific device command operations
54
+ */
55
+ export interface ISmartthingsDeviceCommandManager extends IDeviceCommandManager {
56
+ /**
57
+ * Performs device action for SmartThings
58
+ * @param commands - Array of SmartThings device commands
59
+ * @param deviceId - Device identifier
60
+ * @param accessToken - Access token for authentication
61
+ * @returns Promise with action result
62
+ */
63
+ performDeviceAction(commands: ISmartthingsDeviceCommand[], deviceId: string, accessToken: string): Promise<any>;
64
+ /**
65
+ * Gets device status for SmartThings
66
+ * @param deviceId - Device identifier
67
+ * @param accessToken - Access token for authentication
68
+ * @returns Promise with device status
69
+ */
70
+ getDeviceStatus(deviceId: string, accessToken: string): Promise<any>;
71
+ /**
72
+ * Gets device lock status for SmartThings
73
+ * @param deviceId - Device identifier
74
+ * @param accessToken - Access token for authentication
75
+ * @returns Promise with lock status
76
+ */
77
+ getDeviceLockStatus(deviceId: string, accessToken: string): Promise<any>;
78
+ }
79
+ /**
80
+ * Interface for device command factory
81
+ */
82
+ export interface IDeviceCommandManagerFactory {
83
+ /**
84
+ * Creates a device command manager for a specific connection provider
85
+ * @param connectionProvider - Connection provider type
86
+ * @param connection - Connection object
87
+ * @returns Device command manager instance
88
+ */
89
+ createDeviceCommandManager(connectionProvider: string, connection: IConnection): IDeviceCommandManager;
90
+ }
91
+ /**
92
+ * Interface for device command classes
93
+ */
94
+ export interface IDeviceCommandClass {
95
+ /**
96
+ * Creates a SmartThings device command from a generic device command
97
+ * @param deviceCommand - Generic device command
98
+ * @returns SmartThings device command
99
+ */
100
+ fromDeviceCommand(deviceCommand: IDeviceCommand): ISmartthingsDeviceCommand;
101
+ }
@@ -0,0 +1,5 @@
1
+ import { IConnection, IDeviceAccountResponse } from "../types";
2
+ export interface ICloudConnection {
3
+ createConnection(data: IConnection, userId: string): Promise<IConnection>;
4
+ getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
5
+ }
@@ -0,0 +1,9 @@
1
+ import { ICloudDeviceService } from "./ICloudDeviceService";
2
+ export interface ICloudDevice {
3
+ deviceId: string;
4
+ cloudDeviceService: ICloudDeviceService;
5
+ getDevice(connectionId: string, deviceId: string): Promise<Record<string, any>>;
6
+ getBattery(deviceId: string): Promise<number | string>;
7
+ getState(deviceId: string): Promise<string>;
8
+ getStatus(connectionId: string, deviceId: string): Promise<string>;
9
+ }
@@ -0,0 +1,4 @@
1
+ import { IConnection } from "../../../connection";
2
+ export interface ICloudDeviceService {
3
+ getConnection(deviceId: string): Promise<IConnection>;
4
+ }
@@ -0,0 +1,7 @@
1
+ import { IConnection, IConnectionConnectParams, IDeviceAccountResponse } from "../types";
2
+ export interface IConnectionService {
3
+ createConnection(data: IConnection, userId: string): Promise<any>;
4
+ getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
5
+ getDevices(connection: IConnection): Promise<any>;
6
+ connect(connection: IConnection, connectionConnect: IConnectionConnectParams): Promise<any>;
7
+ }
@@ -0,0 +1,7 @@
1
+ import { IConnection, IConnectionConnectParams, IDeviceAccountResponse } from "../types";
2
+ export interface IDeviceConnectionService {
3
+ createConnection(data: IConnection, userId: string): Promise<any>;
4
+ getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
5
+ getDevices(connection: IConnection): Promise<any>;
6
+ connect(connection: IConnection, connectionConnect: IConnectionConnectParams): Promise<any>;
7
+ }
@@ -0,0 +1,4 @@
1
+ import { IDevice } from "../../local/interfaces";
2
+ export interface IDeviceFactory {
3
+ getDevice(deviceId: string): Promise<IDevice>;
4
+ }
@@ -0,0 +1,8 @@
1
+ import { IConnection } from "../types";
2
+ export interface IDeviceService {
3
+ getDevices(connection: IConnection): Promise<Record<string, any>[]>;
4
+ getDevice(connectionId: string, deviceId: string): Promise<Record<string, any>>;
5
+ getBattery(deviceId: string): Promise<number | string>;
6
+ getState(deviceId: string): Promise<string>;
7
+ getStatus(connectionId: string, deviceId: string): Promise<string>;
8
+ }
@@ -0,0 +1,9 @@
1
+ import { IConnection } from "../types";
2
+ export interface IDeviceService {
3
+ getDevices(connection: IConnection): Promise<Record<string, any>[]>;
4
+ getDevice(connectionId: string, deviceId: string): Promise<Record<string, any>>;
5
+ getStatus(connectionId: string, deviceId: string): Promise<string | null>;
6
+ getState(deviceId: string): Promise<Record<string, any>>;
7
+ getGateways(connectionId: string): Promise<any[] | null>;
8
+ getGatewayDetails(connectionId: string, gatewayId: string): Promise<any>;
9
+ }
@@ -0,0 +1,5 @@
1
+ export interface IHubService {
2
+ getHubs(connectionId: string): Promise<any[] | null>;
3
+ getHub(connectionId: string, hubId: string): Promise<Record<string, any>>;
4
+ getStatus(connectionId: string, hubId: string): Promise<string>;
5
+ }
@@ -0,0 +1,4 @@
1
+ import { IDevice } from "../../local/interfaces";
2
+ export interface IRawDataTransformer {
3
+ transform(): Promise<IDevice>;
4
+ }
@@ -0,0 +1,17 @@
1
+ import { IConnection } from "../../../connection";
2
+ export declare enum DeviceType {
3
+ HUB = "HUB",
4
+ LOCK = "LOCK",
5
+ ELEVATOR_LOCK = "ELEVATOR LOCK",
6
+ THERMOSTAT = "THERMOSTAT",
7
+ TV = "TV"
8
+ }
9
+ export interface IRawDevice {
10
+ deviceId?: string;
11
+ deviceType: DeviceType;
12
+ name?: string;
13
+ connection: IConnection;
14
+ propertyId: string;
15
+ zoneId: string;
16
+ [key: string]: any;
17
+ }
@@ -0,0 +1,5 @@
1
+ export * from "./ICloudDevice";
2
+ export * from "./ICloudDeviceService";
3
+ export * from "./IDeviceFactory";
4
+ export * from "./IRawDataTransformer";
5
+ export * from "./IRawDevice";
@@ -0,0 +1,5 @@
1
+ import { ICloudDeviceService } from "../interfaces/ICloudDeviceService";
2
+ import { IConnection } from "../types";
3
+ export declare class CloudDeviceService implements ICloudDeviceService {
4
+ getConnection(deviceId: string): Promise<IConnection>;
5
+ }
@@ -0,0 +1,8 @@
1
+ import { IConnectionService } from "../interfaces";
2
+ import { IDeviceAccountResponse, IConnectionConnectParams, IConnection } from "../types";
3
+ export declare abstract class ConnectionService implements IConnectionService {
4
+ abstract createConnection(data: IConnection, userId: string): Promise<any>;
5
+ abstract getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
6
+ abstract getDevices(connection: IConnection): Promise<any>;
7
+ abstract connect(connection: IConnection, connectionConnect: IConnectionConnectParams): Promise<any>;
8
+ }
@@ -0,0 +1,39 @@
1
+ import { IDeviceService } from "../interfaces";
2
+ import { IConnection, IDevice } from "../types";
3
+ export declare abstract class DeviceService implements IDeviceService {
4
+ deviceId: string;
5
+ propertyId: string;
6
+ name: string;
7
+ hubId: string[];
8
+ deviceType: {
9
+ id: string;
10
+ type: string;
11
+ };
12
+ status: {
13
+ online: boolean;
14
+ error?: {
15
+ type?: string;
16
+ message?: string;
17
+ };
18
+ lastUpdated?: string;
19
+ };
20
+ state?: Record<string, any>;
21
+ metaData?: Record<string, any>;
22
+ zone?: {
23
+ id: string;
24
+ name: string;
25
+ zoneType: string;
26
+ parentZone?: {
27
+ id: string;
28
+ name: string;
29
+ zoneType: string;
30
+ };
31
+ };
32
+ connection: IConnection;
33
+ constructor(device: IDevice);
34
+ abstract getDevices(connection: IConnection): Promise<Record<string, any>[]>;
35
+ abstract getDevice(connectionId: string, deviceId: string): Promise<any>;
36
+ abstract getBattery(deviceId: string): Promise<number | string>;
37
+ abstract getStatus(connectionId: string, deviceId: string): Promise<string>;
38
+ abstract getState(deviceId: string): Promise<string>;
39
+ }
@@ -0,0 +1,42 @@
1
+ import { IDeviceCloudService } from "../interface";
2
+ import { IConnection, IDevice, IDeviceAccountResponse, IConnectionConnectParams } from "../types";
3
+ /**
4
+ * Device Cloud Service Class
5
+ * Implements IDeviceCloudService interface with empty implementations
6
+ * Implementation will be provided by the consuming project
7
+ */
8
+ export declare class DeviceCloudService implements IDeviceCloudService {
9
+ /**
10
+ * Creates a new connection for device management
11
+ * @param data - Connection data
12
+ * @param userId - User identifier
13
+ * @returns Promise with connection result
14
+ */
15
+ createConnection(data: IConnection, userId: string): Promise<any>;
16
+ /**
17
+ * Gets device account information for a connection
18
+ * @param connection - Connection object
19
+ * @returns Promise with device account response
20
+ */
21
+ getDeviceAccount(connection: IConnection): Promise<IDeviceAccountResponse>;
22
+ /**
23
+ * Gets all devices for a connection
24
+ * @param connection - Connection object
25
+ * @returns Promise with array of devices
26
+ */
27
+ getDevices(connection: IConnection): Promise<IDevice[]>;
28
+ /**
29
+ * Filters devices based on connection and device list
30
+ * @param connection - Connection object
31
+ * @param devices - Array of devices to filter
32
+ * @returns Promise with filtered devices
33
+ */
34
+ filterDevices(connection: IConnection, devices: any[]): Promise<IDevice[]>;
35
+ /**
36
+ * Connects to a device service
37
+ * @param connection - Connection object
38
+ * @param connectionConnect - Connection parameters
39
+ * @returns Promise with connection result
40
+ */
41
+ connect(connection: IConnection, connectionConnect: IConnectionConnectParams): Promise<any>;
42
+ }
@@ -0,0 +1,3 @@
1
+ export declare abstract class DeviceHubService {
2
+ abstract getHubs(): Promise<any>;
3
+ }
@@ -0,0 +1,25 @@
1
+ import { IHubService } from "../interfaces";
2
+ import { IConnection, IDevice } from "../types";
3
+ export declare abstract class HubService implements IHubService {
4
+ deviceId: string;
5
+ propertyId: string;
6
+ name: string;
7
+ deviceType: {
8
+ id: string;
9
+ type: string;
10
+ };
11
+ status: {
12
+ online: boolean;
13
+ error?: {
14
+ type?: string;
15
+ message?: string;
16
+ };
17
+ lastUpdated?: string;
18
+ };
19
+ metaData?: Record<string, any>;
20
+ connection: IConnection;
21
+ constructor(hub: IDevice);
22
+ abstract getHubs(connectionId: string): Promise<any[] | null>;
23
+ abstract getHub(connectionId: string, hubId: string): Promise<Record<string, any>>;
24
+ abstract getStatus(connectionId: string, hubId: string): Promise<string>;
25
+ }