@robotbas/robotcloud-client 0.0.2 → 0.0.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.
- package/README.md +7 -5
- package/dist/helpers/index.d.mts +1 -9
- package/dist/helpers/index.d.ts +1 -9
- package/dist/helpers/index.js +47 -6
- package/dist/helpers/index.js.map +1 -1
- package/dist/helpers/index.mjs +47 -6
- package/dist/helpers/index.mjs.map +1 -1
- package/dist/{RobotCloudClient.d-L7OLs5ZS.d.mts → index-I3qNUoYH.d.mts} +11 -41
- package/dist/{RobotCloudClient.d-L7OLs5ZS.d.ts → index-I3qNUoYH.d.ts} +11 -41
- package/dist/index.d.mts +84 -18
- package/dist/index.d.ts +84 -18
- package/dist/index.js +77 -34
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +73 -32
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/types/RobotCloudClient.d.ts +1 -38
- package/types/helpers.d.ts +3 -1
- package/types/services-configuration.d.ts +22 -0
- package/types/services-data.d.ts +38 -0
package/dist/index.d.mts
CHANGED
|
@@ -1,10 +1,57 @@
|
|
|
1
1
|
import * as axios from 'axios';
|
|
2
2
|
import { AxiosResponse } from 'axios';
|
|
3
|
-
import { R as RobotCloudNamedItem, S as SubsystemRequestParams,
|
|
4
|
-
export { A as AppAccessLevel, F as FancoilSpeedState,
|
|
3
|
+
import { R as RegimState, a as RobotCloudNamedItem, S as SubsystemRequestParams, b as RobotCloudServiceType, L as LocationServiceInstancesRequestParams, c as RobotCloudUserDetails, P as ProjectRequestParams, d as RobotCloudProject, e as ProjectDetailsRequestParams, f as RobotCloudProjectDetails, g as ProjectLocationsRequestParams, h as ServiceInstancesRequestParams, i as ProjectTagRequestParams, j as RobotCloudDeviceDetails, k as RobotCloudServiceTypeDetails, l as RoomGrouping1DataEventValue, m as RoomGrouping1InstanceDeviceConfig, T as TemperatureUnit, n as RoomClime1AlertEventValue, o as RoomConsumes1AlertEventValue, p as ServiceInstanceDataRequestParams } from './index-I3qNUoYH.mjs';
|
|
4
|
+
export { A as AppAccessLevel, F as FancoilSpeedState, t as PaginableRequestParams, s as ProjectAccessLevel, q as RobotCloudPermissionsHelper, u as ServiceInstanceDeviceConfig, r as robotCloudPermissionsHelper } from './index-I3qNUoYH.mjs';
|
|
5
5
|
|
|
6
6
|
declare const robotcloudApi: axios.AxiosInstance;
|
|
7
|
-
|
|
7
|
+
|
|
8
|
+
declare class RobotCloudClientConfig {
|
|
9
|
+
private _baseUrl?;
|
|
10
|
+
private _checkToken;
|
|
11
|
+
tokenMinutesBeforeExpirationRenew: number;
|
|
12
|
+
set baseURL(value: string);
|
|
13
|
+
get baseUrl(): string | undefined;
|
|
14
|
+
set checkToken(fun: () => Promise<string>);
|
|
15
|
+
get checkToken(): () => Promise<string>;
|
|
16
|
+
}
|
|
17
|
+
declare const clientConfig: RobotCloudClientConfig;
|
|
18
|
+
|
|
19
|
+
interface RoomClime1Data {
|
|
20
|
+
demandRF: boolean;
|
|
21
|
+
eco_mode: "STANDBY"|"ECO"|"VIP";
|
|
22
|
+
fancoil_manual: boolean;
|
|
23
|
+
fancoil_speed: number;
|
|
24
|
+
humidity: number;
|
|
25
|
+
humidity_set_point: number;
|
|
26
|
+
|
|
27
|
+
on: boolean;
|
|
28
|
+
onRF: boolean;
|
|
29
|
+
|
|
30
|
+
temperature: number;
|
|
31
|
+
temperature_set_point: number;
|
|
32
|
+
regim: RegimState;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface RoomConsumes1Data {
|
|
36
|
+
energy_electric: number;
|
|
37
|
+
energy_thermal: number;
|
|
38
|
+
hot_water: number;
|
|
39
|
+
cold_water: number;
|
|
40
|
+
|
|
41
|
+
daily_energy_electric: number;
|
|
42
|
+
daily_energy_thermal: number;
|
|
43
|
+
daily_hot_water: number;
|
|
44
|
+
daily_cold_water: number;
|
|
45
|
+
daily_co2_footprint: number;
|
|
46
|
+
daily_tree_equivalent: number;
|
|
47
|
+
|
|
48
|
+
guest_energy_electric: number;
|
|
49
|
+
guest_energy_thermal: number;
|
|
50
|
+
guest_hot_water: number;
|
|
51
|
+
guest_cold_water: number;
|
|
52
|
+
guest_co2_footprint: number;
|
|
53
|
+
guest_tree_equivalent: number;
|
|
54
|
+
}
|
|
8
55
|
|
|
9
56
|
interface RobotCloudServiceInstance extends RobotCloudNamedItem {
|
|
10
57
|
service: string;
|
|
@@ -172,7 +219,6 @@ declare const getTagsChildren: (prjId: string, level?: number, parent_id?: strin
|
|
|
172
219
|
declare const getDeviceDetails: (deviceId: string) => Promise<AxiosResponse<RobotCloudDeviceDetails>>;
|
|
173
220
|
declare const getProjectServiceTypes: (prjId: string, params?: SubsystemRequestParams) => Promise<AxiosResponse<RobotCloudServiceTypeDetails[]>>;
|
|
174
221
|
declare const getRoomGrouping1ServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>>;
|
|
175
|
-
declare const getRoomConsumesInstanceServiceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>>>;
|
|
176
222
|
declare const getRoomGrouping1InstanceDeviceConfig: (prjId: string, instanceId: string) => Promise<AxiosResponse<RoomGrouping1InstanceDeviceConfig>>;
|
|
177
223
|
|
|
178
224
|
declare const robotCloudClient_getClassifier: typeof getClassifier;
|
|
@@ -184,7 +230,6 @@ declare const robotCloudClient_getProjectDetails: typeof getProjectDetails;
|
|
|
184
230
|
declare const robotCloudClient_getProjectServiceTypes: typeof getProjectServiceTypes;
|
|
185
231
|
declare const robotCloudClient_getProjectSubsystem: typeof getProjectSubsystem;
|
|
186
232
|
declare const robotCloudClient_getProjects: typeof getProjects;
|
|
187
|
-
declare const robotCloudClient_getRoomConsumesInstanceServiceData: typeof getRoomConsumesInstanceServiceData;
|
|
188
233
|
declare const robotCloudClient_getRoomGrouping1InstanceDeviceConfig: typeof getRoomGrouping1InstanceDeviceConfig;
|
|
189
234
|
declare const robotCloudClient_getRoomGrouping1ServiceData: typeof getRoomGrouping1ServiceData;
|
|
190
235
|
declare const robotCloudClient_getServiceInstance: typeof getServiceInstance;
|
|
@@ -194,7 +239,7 @@ declare const robotCloudClient_getTagsChildren: typeof getTagsChildren;
|
|
|
194
239
|
declare const robotCloudClient_getTagsTree: typeof getTagsTree;
|
|
195
240
|
declare const robotCloudClient_getUser: typeof getUser;
|
|
196
241
|
declare namespace robotCloudClient {
|
|
197
|
-
export { robotCloudClient_getClassifier as getClassifier, robotCloudClient_getDeviceDetails as getDeviceDetails, robotCloudClient_getLocation as getLocation, robotCloudClient_getLocationServiceInstances as getLocationServiceInstances, robotCloudClient_getLocations as getLocations, robotCloudClient_getProjectDetails as getProjectDetails, robotCloudClient_getProjectServiceTypes as getProjectServiceTypes, robotCloudClient_getProjectSubsystem as getProjectSubsystem, robotCloudClient_getProjects as getProjects,
|
|
242
|
+
export { robotCloudClient_getClassifier as getClassifier, robotCloudClient_getDeviceDetails as getDeviceDetails, robotCloudClient_getLocation as getLocation, robotCloudClient_getLocationServiceInstances as getLocationServiceInstances, robotCloudClient_getLocations as getLocations, robotCloudClient_getProjectDetails as getProjectDetails, robotCloudClient_getProjectServiceTypes as getProjectServiceTypes, robotCloudClient_getProjectSubsystem as getProjectSubsystem, robotCloudClient_getProjects as getProjects, robotCloudClient_getRoomGrouping1InstanceDeviceConfig as getRoomGrouping1InstanceDeviceConfig, robotCloudClient_getRoomGrouping1ServiceData as getRoomGrouping1ServiceData, robotCloudClient_getServiceInstance as getServiceInstance, robotCloudClient_getServiceInstances as getServiceInstances, robotCloudClient_getTags as getTags, robotCloudClient_getTagsChildren as getTagsChildren, robotCloudClient_getTagsTree as getTagsTree, robotCloudClient_getUser as getUser };
|
|
198
243
|
}
|
|
199
244
|
|
|
200
245
|
interface CheckTokenResponse {
|
|
@@ -228,13 +273,34 @@ declare namespace robotCloudToken {
|
|
|
228
273
|
export { type robotCloudToken_RobotCloudNewTokenResponse as RobotCloudNewTokenResponse, robotCloudToken_decodeToken as decodeToken, robotCloudToken_isTokenExpired as isTokenExpired, robotCloudToken_renewToken as renewToken, robotCloudToken_validateToken as validateToken };
|
|
229
274
|
}
|
|
230
275
|
|
|
231
|
-
|
|
276
|
+
interface RoomClimeConfigurationParams {
|
|
277
|
+
temperature_set_point?: number;
|
|
278
|
+
humidity_set_point?: number;
|
|
279
|
+
regim?: RegimState;
|
|
280
|
+
eco_mode?: "STANDBY" | "ECO" | "VIP";
|
|
281
|
+
fancoil_speed?: 0 | 1 | 2 | 3;
|
|
282
|
+
on?: boolean;
|
|
283
|
+
|
|
284
|
+
hasFC?: boolean;
|
|
285
|
+
hasRF?: boolean;
|
|
286
|
+
isRFLinked?: boolean;
|
|
287
|
+
|
|
288
|
+
onRF?: boolean;
|
|
289
|
+
|
|
290
|
+
high_temperature_level?: number;
|
|
291
|
+
low_temperature_level?: number;
|
|
292
|
+
high_humidity_level?: number;
|
|
293
|
+
fancoil_on_time_limit?: number;
|
|
294
|
+
temperature_units?: TemperatureUnit;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
declare class RoomClimeClient implements ServiceTypeClient<RoomClime1AlertEventValue, RoomClime1Data, RoomClimeConfigurationParams> {
|
|
232
298
|
getAlerts(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1AlertEventValue>[]>>;
|
|
233
|
-
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
234
|
-
getInstanceConfiguration(prjId: string, instanceId: string): Promise<AxiosResponse<
|
|
235
|
-
putInstanceConfiguration(prjId: string, instanceId: string, data:
|
|
236
|
-
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
237
|
-
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
299
|
+
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1Data>[]>>;
|
|
300
|
+
getInstanceConfiguration(prjId: string, instanceId: string): Promise<AxiosResponse<RoomClimeConfigurationParams>>;
|
|
301
|
+
putInstanceConfiguration(prjId: string, instanceId: string, data: RoomClimeConfigurationParams): Promise<AxiosResponse<RoomClimeConfigurationParams>>;
|
|
302
|
+
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1Data>[]>>;
|
|
303
|
+
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1Data>[]>>;
|
|
238
304
|
}
|
|
239
305
|
declare const roomClimeClient: RoomClimeClient;
|
|
240
306
|
|
|
@@ -258,15 +324,15 @@ declare class AirQualityClient implements ServiceTypeClient<AirQuality1AlertEven
|
|
|
258
324
|
}
|
|
259
325
|
declare const airQualityClient: AirQualityClient;
|
|
260
326
|
|
|
261
|
-
declare class RoomConsumesClient implements ServiceTypeClient<RoomConsumes1AlertEventValue,
|
|
327
|
+
declare class RoomConsumesClient implements ServiceTypeClient<RoomConsumes1AlertEventValue, RoomConsumes1Data, any> {
|
|
262
328
|
getAlerts(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1AlertEventValue>[]>>;
|
|
263
|
-
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
264
|
-
getInstanceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<
|
|
329
|
+
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>[]>>;
|
|
330
|
+
getInstanceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>>>;
|
|
265
331
|
getInstanceConfiguration<T>(prjId: string, instanceId: string): Promise<AxiosResponse<T>>;
|
|
266
332
|
putInstanceConfiguration<T>(prjId: string, instanceId: string, data: T): Promise<AxiosResponse<T>>;
|
|
267
|
-
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
268
|
-
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
333
|
+
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>[]>>;
|
|
334
|
+
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>[]>>;
|
|
269
335
|
}
|
|
270
336
|
declare const roomConsumesClient: RoomConsumesClient;
|
|
271
337
|
|
|
272
|
-
export { type AirQuality1AlertEventValue, type AirQuality1DataEventValue, type CheckTokenResponse, type ClassifierDetails, type HistoricAggregateFunction, LocationServiceInstancesRequestParams, type MeasurementStatus, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectRequestParams, type ProjectTag, ProjectTagRequestParams, type ProjectTagTreeNode, type ProjectTagsTree, RobotCloudDeviceDetails, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudProject, RobotCloudProjectDetails, type RobotCloudServiceInstance, RobotCloudServiceType, RobotCloudServiceTypeDetails, RobotCloudUserDetails, RoomClime1AlertEventValue,
|
|
338
|
+
export { type AirQuality1AlertEventValue, type AirQuality1DataEventValue, type CheckTokenResponse, type ClassifierDetails, type HistoricAggregateFunction, LocationServiceInstancesRequestParams, type MeasurementStatus, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectRequestParams, type ProjectTag, ProjectTagRequestParams, type ProjectTagTreeNode, type ProjectTagsTree, RegimState, RobotCloudClientConfig, RobotCloudDeviceDetails, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudProject, RobotCloudProjectDetails, type RobotCloudServiceInstance, RobotCloudServiceType, RobotCloudServiceTypeDetails, RobotCloudUserDetails, RoomClime1AlertEventValue, type RoomClime1Data, type RoomClimeConfigurationParams, RoomConsumes1AlertEventValue, type RoomConsumes1Data, RoomGrouping1DataEventValue, RoomGrouping1InstanceDeviceConfig, type RoomGuestStatus1AlertEventValue, type RoomGuestStatus1EventValue, type RoomGuestStatusInstanceConfigParams, type ServiceDataMeasurement, type ServiceDataRequestParams, ServiceInstanceDataRequestParams, type ServiceInstanceDetails, type ServiceInstanceHistoricAggregateParams, type ServiceInstanceHistoricParams, type ServiceInstanceRead, ServiceInstancesRequestParams, type ServiceTypeClient, SubsystemRequestParams, TemperatureUnit, airQualityClient, clientConfig, robotCloudToken, robotcloudApi, robotCloudClient as robotcloudClient, roomClimeClient, roomConsumesClient, roomGuestStatusClient };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,57 @@
|
|
|
1
1
|
import * as axios from 'axios';
|
|
2
2
|
import { AxiosResponse } from 'axios';
|
|
3
|
-
import { R as RobotCloudNamedItem, S as SubsystemRequestParams,
|
|
4
|
-
export { A as AppAccessLevel, F as FancoilSpeedState,
|
|
3
|
+
import { R as RegimState, a as RobotCloudNamedItem, S as SubsystemRequestParams, b as RobotCloudServiceType, L as LocationServiceInstancesRequestParams, c as RobotCloudUserDetails, P as ProjectRequestParams, d as RobotCloudProject, e as ProjectDetailsRequestParams, f as RobotCloudProjectDetails, g as ProjectLocationsRequestParams, h as ServiceInstancesRequestParams, i as ProjectTagRequestParams, j as RobotCloudDeviceDetails, k as RobotCloudServiceTypeDetails, l as RoomGrouping1DataEventValue, m as RoomGrouping1InstanceDeviceConfig, T as TemperatureUnit, n as RoomClime1AlertEventValue, o as RoomConsumes1AlertEventValue, p as ServiceInstanceDataRequestParams } from './index-I3qNUoYH.js';
|
|
4
|
+
export { A as AppAccessLevel, F as FancoilSpeedState, t as PaginableRequestParams, s as ProjectAccessLevel, q as RobotCloudPermissionsHelper, u as ServiceInstanceDeviceConfig, r as robotCloudPermissionsHelper } from './index-I3qNUoYH.js';
|
|
5
5
|
|
|
6
6
|
declare const robotcloudApi: axios.AxiosInstance;
|
|
7
|
-
|
|
7
|
+
|
|
8
|
+
declare class RobotCloudClientConfig {
|
|
9
|
+
private _baseUrl?;
|
|
10
|
+
private _checkToken;
|
|
11
|
+
tokenMinutesBeforeExpirationRenew: number;
|
|
12
|
+
set baseURL(value: string);
|
|
13
|
+
get baseUrl(): string | undefined;
|
|
14
|
+
set checkToken(fun: () => Promise<string>);
|
|
15
|
+
get checkToken(): () => Promise<string>;
|
|
16
|
+
}
|
|
17
|
+
declare const clientConfig: RobotCloudClientConfig;
|
|
18
|
+
|
|
19
|
+
interface RoomClime1Data {
|
|
20
|
+
demandRF: boolean;
|
|
21
|
+
eco_mode: "STANDBY"|"ECO"|"VIP";
|
|
22
|
+
fancoil_manual: boolean;
|
|
23
|
+
fancoil_speed: number;
|
|
24
|
+
humidity: number;
|
|
25
|
+
humidity_set_point: number;
|
|
26
|
+
|
|
27
|
+
on: boolean;
|
|
28
|
+
onRF: boolean;
|
|
29
|
+
|
|
30
|
+
temperature: number;
|
|
31
|
+
temperature_set_point: number;
|
|
32
|
+
regim: RegimState;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface RoomConsumes1Data {
|
|
36
|
+
energy_electric: number;
|
|
37
|
+
energy_thermal: number;
|
|
38
|
+
hot_water: number;
|
|
39
|
+
cold_water: number;
|
|
40
|
+
|
|
41
|
+
daily_energy_electric: number;
|
|
42
|
+
daily_energy_thermal: number;
|
|
43
|
+
daily_hot_water: number;
|
|
44
|
+
daily_cold_water: number;
|
|
45
|
+
daily_co2_footprint: number;
|
|
46
|
+
daily_tree_equivalent: number;
|
|
47
|
+
|
|
48
|
+
guest_energy_electric: number;
|
|
49
|
+
guest_energy_thermal: number;
|
|
50
|
+
guest_hot_water: number;
|
|
51
|
+
guest_cold_water: number;
|
|
52
|
+
guest_co2_footprint: number;
|
|
53
|
+
guest_tree_equivalent: number;
|
|
54
|
+
}
|
|
8
55
|
|
|
9
56
|
interface RobotCloudServiceInstance extends RobotCloudNamedItem {
|
|
10
57
|
service: string;
|
|
@@ -172,7 +219,6 @@ declare const getTagsChildren: (prjId: string, level?: number, parent_id?: strin
|
|
|
172
219
|
declare const getDeviceDetails: (deviceId: string) => Promise<AxiosResponse<RobotCloudDeviceDetails>>;
|
|
173
220
|
declare const getProjectServiceTypes: (prjId: string, params?: SubsystemRequestParams) => Promise<AxiosResponse<RobotCloudServiceTypeDetails[]>>;
|
|
174
221
|
declare const getRoomGrouping1ServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>>;
|
|
175
|
-
declare const getRoomConsumesInstanceServiceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>>>;
|
|
176
222
|
declare const getRoomGrouping1InstanceDeviceConfig: (prjId: string, instanceId: string) => Promise<AxiosResponse<RoomGrouping1InstanceDeviceConfig>>;
|
|
177
223
|
|
|
178
224
|
declare const robotCloudClient_getClassifier: typeof getClassifier;
|
|
@@ -184,7 +230,6 @@ declare const robotCloudClient_getProjectDetails: typeof getProjectDetails;
|
|
|
184
230
|
declare const robotCloudClient_getProjectServiceTypes: typeof getProjectServiceTypes;
|
|
185
231
|
declare const robotCloudClient_getProjectSubsystem: typeof getProjectSubsystem;
|
|
186
232
|
declare const robotCloudClient_getProjects: typeof getProjects;
|
|
187
|
-
declare const robotCloudClient_getRoomConsumesInstanceServiceData: typeof getRoomConsumesInstanceServiceData;
|
|
188
233
|
declare const robotCloudClient_getRoomGrouping1InstanceDeviceConfig: typeof getRoomGrouping1InstanceDeviceConfig;
|
|
189
234
|
declare const robotCloudClient_getRoomGrouping1ServiceData: typeof getRoomGrouping1ServiceData;
|
|
190
235
|
declare const robotCloudClient_getServiceInstance: typeof getServiceInstance;
|
|
@@ -194,7 +239,7 @@ declare const robotCloudClient_getTagsChildren: typeof getTagsChildren;
|
|
|
194
239
|
declare const robotCloudClient_getTagsTree: typeof getTagsTree;
|
|
195
240
|
declare const robotCloudClient_getUser: typeof getUser;
|
|
196
241
|
declare namespace robotCloudClient {
|
|
197
|
-
export { robotCloudClient_getClassifier as getClassifier, robotCloudClient_getDeviceDetails as getDeviceDetails, robotCloudClient_getLocation as getLocation, robotCloudClient_getLocationServiceInstances as getLocationServiceInstances, robotCloudClient_getLocations as getLocations, robotCloudClient_getProjectDetails as getProjectDetails, robotCloudClient_getProjectServiceTypes as getProjectServiceTypes, robotCloudClient_getProjectSubsystem as getProjectSubsystem, robotCloudClient_getProjects as getProjects,
|
|
242
|
+
export { robotCloudClient_getClassifier as getClassifier, robotCloudClient_getDeviceDetails as getDeviceDetails, robotCloudClient_getLocation as getLocation, robotCloudClient_getLocationServiceInstances as getLocationServiceInstances, robotCloudClient_getLocations as getLocations, robotCloudClient_getProjectDetails as getProjectDetails, robotCloudClient_getProjectServiceTypes as getProjectServiceTypes, robotCloudClient_getProjectSubsystem as getProjectSubsystem, robotCloudClient_getProjects as getProjects, robotCloudClient_getRoomGrouping1InstanceDeviceConfig as getRoomGrouping1InstanceDeviceConfig, robotCloudClient_getRoomGrouping1ServiceData as getRoomGrouping1ServiceData, robotCloudClient_getServiceInstance as getServiceInstance, robotCloudClient_getServiceInstances as getServiceInstances, robotCloudClient_getTags as getTags, robotCloudClient_getTagsChildren as getTagsChildren, robotCloudClient_getTagsTree as getTagsTree, robotCloudClient_getUser as getUser };
|
|
198
243
|
}
|
|
199
244
|
|
|
200
245
|
interface CheckTokenResponse {
|
|
@@ -228,13 +273,34 @@ declare namespace robotCloudToken {
|
|
|
228
273
|
export { type robotCloudToken_RobotCloudNewTokenResponse as RobotCloudNewTokenResponse, robotCloudToken_decodeToken as decodeToken, robotCloudToken_isTokenExpired as isTokenExpired, robotCloudToken_renewToken as renewToken, robotCloudToken_validateToken as validateToken };
|
|
229
274
|
}
|
|
230
275
|
|
|
231
|
-
|
|
276
|
+
interface RoomClimeConfigurationParams {
|
|
277
|
+
temperature_set_point?: number;
|
|
278
|
+
humidity_set_point?: number;
|
|
279
|
+
regim?: RegimState;
|
|
280
|
+
eco_mode?: "STANDBY" | "ECO" | "VIP";
|
|
281
|
+
fancoil_speed?: 0 | 1 | 2 | 3;
|
|
282
|
+
on?: boolean;
|
|
283
|
+
|
|
284
|
+
hasFC?: boolean;
|
|
285
|
+
hasRF?: boolean;
|
|
286
|
+
isRFLinked?: boolean;
|
|
287
|
+
|
|
288
|
+
onRF?: boolean;
|
|
289
|
+
|
|
290
|
+
high_temperature_level?: number;
|
|
291
|
+
low_temperature_level?: number;
|
|
292
|
+
high_humidity_level?: number;
|
|
293
|
+
fancoil_on_time_limit?: number;
|
|
294
|
+
temperature_units?: TemperatureUnit;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
declare class RoomClimeClient implements ServiceTypeClient<RoomClime1AlertEventValue, RoomClime1Data, RoomClimeConfigurationParams> {
|
|
232
298
|
getAlerts(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1AlertEventValue>[]>>;
|
|
233
|
-
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
234
|
-
getInstanceConfiguration(prjId: string, instanceId: string): Promise<AxiosResponse<
|
|
235
|
-
putInstanceConfiguration(prjId: string, instanceId: string, data:
|
|
236
|
-
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
237
|
-
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
299
|
+
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1Data>[]>>;
|
|
300
|
+
getInstanceConfiguration(prjId: string, instanceId: string): Promise<AxiosResponse<RoomClimeConfigurationParams>>;
|
|
301
|
+
putInstanceConfiguration(prjId: string, instanceId: string, data: RoomClimeConfigurationParams): Promise<AxiosResponse<RoomClimeConfigurationParams>>;
|
|
302
|
+
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1Data>[]>>;
|
|
303
|
+
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1Data>[]>>;
|
|
238
304
|
}
|
|
239
305
|
declare const roomClimeClient: RoomClimeClient;
|
|
240
306
|
|
|
@@ -258,15 +324,15 @@ declare class AirQualityClient implements ServiceTypeClient<AirQuality1AlertEven
|
|
|
258
324
|
}
|
|
259
325
|
declare const airQualityClient: AirQualityClient;
|
|
260
326
|
|
|
261
|
-
declare class RoomConsumesClient implements ServiceTypeClient<RoomConsumes1AlertEventValue,
|
|
327
|
+
declare class RoomConsumesClient implements ServiceTypeClient<RoomConsumes1AlertEventValue, RoomConsumes1Data, any> {
|
|
262
328
|
getAlerts(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1AlertEventValue>[]>>;
|
|
263
|
-
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
264
|
-
getInstanceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<
|
|
329
|
+
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>[]>>;
|
|
330
|
+
getInstanceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>>>;
|
|
265
331
|
getInstanceConfiguration<T>(prjId: string, instanceId: string): Promise<AxiosResponse<T>>;
|
|
266
332
|
putInstanceConfiguration<T>(prjId: string, instanceId: string, data: T): Promise<AxiosResponse<T>>;
|
|
267
|
-
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
268
|
-
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<
|
|
333
|
+
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>[]>>;
|
|
334
|
+
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1Data>[]>>;
|
|
269
335
|
}
|
|
270
336
|
declare const roomConsumesClient: RoomConsumesClient;
|
|
271
337
|
|
|
272
|
-
export { type AirQuality1AlertEventValue, type AirQuality1DataEventValue, type CheckTokenResponse, type ClassifierDetails, type HistoricAggregateFunction, LocationServiceInstancesRequestParams, type MeasurementStatus, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectRequestParams, type ProjectTag, ProjectTagRequestParams, type ProjectTagTreeNode, type ProjectTagsTree, RobotCloudDeviceDetails, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudProject, RobotCloudProjectDetails, type RobotCloudServiceInstance, RobotCloudServiceType, RobotCloudServiceTypeDetails, RobotCloudUserDetails, RoomClime1AlertEventValue,
|
|
338
|
+
export { type AirQuality1AlertEventValue, type AirQuality1DataEventValue, type CheckTokenResponse, type ClassifierDetails, type HistoricAggregateFunction, LocationServiceInstancesRequestParams, type MeasurementStatus, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectRequestParams, type ProjectTag, ProjectTagRequestParams, type ProjectTagTreeNode, type ProjectTagsTree, RegimState, RobotCloudClientConfig, RobotCloudDeviceDetails, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudProject, RobotCloudProjectDetails, type RobotCloudServiceInstance, RobotCloudServiceType, RobotCloudServiceTypeDetails, RobotCloudUserDetails, RoomClime1AlertEventValue, type RoomClime1Data, type RoomClimeConfigurationParams, RoomConsumes1AlertEventValue, type RoomConsumes1Data, RoomGrouping1DataEventValue, RoomGrouping1InstanceDeviceConfig, type RoomGuestStatus1AlertEventValue, type RoomGuestStatus1EventValue, type RoomGuestStatusInstanceConfigParams, type ServiceDataMeasurement, type ServiceDataRequestParams, ServiceInstanceDataRequestParams, type ServiceInstanceDetails, type ServiceInstanceHistoricAggregateParams, type ServiceInstanceHistoricParams, type ServiceInstanceRead, ServiceInstancesRequestParams, type ServiceTypeClient, SubsystemRequestParams, TemperatureUnit, airQualityClient, clientConfig, robotCloudToken, robotcloudApi, robotCloudClient as robotcloudClient, roomClimeClient, roomConsumesClient, roomGuestStatusClient };
|
package/dist/index.js
CHANGED
|
@@ -30,20 +30,47 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
30
30
|
// src/index.ts
|
|
31
31
|
var src_exports = {};
|
|
32
32
|
__export(src_exports, {
|
|
33
|
+
RobotCloudClientConfig: () => RobotCloudClientConfig,
|
|
33
34
|
airQualityClient: () => airQualityClient,
|
|
35
|
+
clientConfig: () => config_default,
|
|
36
|
+
robotCloudPermissionsHelper: () => robotCloudPermissionsHelper,
|
|
34
37
|
robotCloudToken: () => robotCloudToken_exports,
|
|
35
38
|
robotcloudApi: () => robotCloudApi_default,
|
|
36
39
|
robotcloudClient: () => robotCloudClient_exports,
|
|
37
40
|
roomClimeClient: () => roomClimeClient,
|
|
38
41
|
roomConsumesClient: () => roomConsumesClient,
|
|
39
|
-
roomGuestStatusClient: () => roomGuestStatusClient
|
|
40
|
-
setCheckTokenFunction: () => setCheckTokenFunction
|
|
42
|
+
roomGuestStatusClient: () => roomGuestStatusClient
|
|
41
43
|
});
|
|
42
44
|
module.exports = __toCommonJS(src_exports);
|
|
43
45
|
|
|
44
46
|
// src/robotCloudApi.ts
|
|
45
47
|
var import_axios = __toESM(require("axios"));
|
|
46
48
|
|
|
49
|
+
// src/config.ts
|
|
50
|
+
var RobotCloudClientConfig = class {
|
|
51
|
+
constructor() {
|
|
52
|
+
this._checkToken = async () => {
|
|
53
|
+
return "";
|
|
54
|
+
};
|
|
55
|
+
this.tokenMinutesBeforeExpirationRenew = 20;
|
|
56
|
+
}
|
|
57
|
+
set baseURL(value) {
|
|
58
|
+
robotCloudApi_default.defaults.baseURL = value;
|
|
59
|
+
this._baseUrl = value;
|
|
60
|
+
}
|
|
61
|
+
get baseUrl() {
|
|
62
|
+
return this._baseUrl;
|
|
63
|
+
}
|
|
64
|
+
set checkToken(fun) {
|
|
65
|
+
this._checkToken = fun;
|
|
66
|
+
}
|
|
67
|
+
get checkToken() {
|
|
68
|
+
return this._checkToken;
|
|
69
|
+
}
|
|
70
|
+
};
|
|
71
|
+
var clientConfig = new RobotCloudClientConfig();
|
|
72
|
+
var config_default = clientConfig;
|
|
73
|
+
|
|
47
74
|
// src/utils/logger.ts
|
|
48
75
|
var import_consola = require("consola");
|
|
49
76
|
function useLogger(tag, options = { level: 1e3 }) {
|
|
@@ -55,18 +82,15 @@ var logger = useLogger("robotcloud-api");
|
|
|
55
82
|
var robotcloudApi = import_axios.default.create();
|
|
56
83
|
var checkTokenPromise = null;
|
|
57
84
|
var clearPromise = () => checkTokenPromise = null;
|
|
58
|
-
async function refreshToken(
|
|
59
|
-
const access_token = await
|
|
85
|
+
async function refreshToken(checkToken) {
|
|
86
|
+
const access_token = await checkToken();
|
|
60
87
|
return access_token;
|
|
61
88
|
}
|
|
62
|
-
var checkToken = async () => {
|
|
63
|
-
return "";
|
|
64
|
-
};
|
|
65
89
|
robotcloudApi.interceptors.request.use(
|
|
66
90
|
async (config) => {
|
|
67
91
|
logger.info("robotcloud api interceptor:", config.url);
|
|
68
92
|
if (!checkTokenPromise) {
|
|
69
|
-
checkTokenPromise = refreshToken(checkToken).finally(clearPromise);
|
|
93
|
+
checkTokenPromise = refreshToken(config_default.checkToken).finally(clearPromise);
|
|
70
94
|
}
|
|
71
95
|
const token = await checkTokenPromise;
|
|
72
96
|
if (!token) {
|
|
@@ -80,9 +104,6 @@ robotcloudApi.interceptors.request.use(
|
|
|
80
104
|
Promise.reject(error);
|
|
81
105
|
}
|
|
82
106
|
);
|
|
83
|
-
var setCheckTokenFunction = (fun) => {
|
|
84
|
-
checkToken = fun;
|
|
85
|
-
};
|
|
86
107
|
var robotCloudApi_default = robotcloudApi;
|
|
87
108
|
|
|
88
109
|
// src/robotCloudClient.ts
|
|
@@ -97,7 +118,6 @@ __export(robotCloudClient_exports, {
|
|
|
97
118
|
getProjectServiceTypes: () => getProjectServiceTypes,
|
|
98
119
|
getProjectSubsystem: () => getProjectSubsystem,
|
|
99
120
|
getProjects: () => getProjects,
|
|
100
|
-
getRoomConsumesInstanceServiceData: () => getRoomConsumesInstanceServiceData,
|
|
101
121
|
getRoomGrouping1InstanceDeviceConfig: () => getRoomGrouping1InstanceDeviceConfig,
|
|
102
122
|
getRoomGrouping1ServiceData: () => getRoomGrouping1ServiceData,
|
|
103
123
|
getServiceInstance: () => getServiceInstance,
|
|
@@ -215,17 +235,6 @@ var getRoomGrouping1ServiceData = (prjId, params) => {
|
|
|
215
235
|
}
|
|
216
236
|
);
|
|
217
237
|
};
|
|
218
|
-
var getRoomConsumesInstanceServiceData = (prjId, instanceId, params) => {
|
|
219
|
-
return robotCloudApi_default.get(
|
|
220
|
-
`/projects/${prjId}/services/RoomConsumes_1/instances/${instanceId}/data`,
|
|
221
|
-
{
|
|
222
|
-
params,
|
|
223
|
-
headers: {
|
|
224
|
-
"Accept": "application/json"
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
);
|
|
228
|
-
};
|
|
229
238
|
var getRoomGrouping1InstanceDeviceConfig = (prjId, instanceId) => {
|
|
230
239
|
return robotCloudApi_default.put(
|
|
231
240
|
`/projects/${prjId}/services/RoomGrouping_1/instances/${instanceId}/configuration`
|
|
@@ -241,15 +250,7 @@ __export(robotCloudToken_exports, {
|
|
|
241
250
|
validateToken: () => validateToken
|
|
242
251
|
});
|
|
243
252
|
var import_axios2 = __toESM(require("axios"));
|
|
244
|
-
|
|
245
|
-
// src/config.ts
|
|
246
|
-
var RobotCloudClientConfig = class {
|
|
247
|
-
};
|
|
248
|
-
RobotCloudClientConfig.tokenMinutesBeforeExpirationRenew = 20;
|
|
249
|
-
|
|
250
|
-
// src/helpers/robotCloudToken.ts
|
|
251
253
|
var logger3 = useLogger("robotcloud-token");
|
|
252
|
-
var MINUTES_BEFORE_EXPIRATION_RENEW = RobotCloudClientConfig.tokenMinutesBeforeExpirationRenew;
|
|
253
254
|
function parseJwt(token) {
|
|
254
255
|
if (!token) {
|
|
255
256
|
return;
|
|
@@ -266,7 +267,7 @@ var decodeToken = (token) => {
|
|
|
266
267
|
var isTokenExpired = (payload) => {
|
|
267
268
|
const expirationDate = new Date(payload.exp * 1e3);
|
|
268
269
|
expirationDate.setMinutes(
|
|
269
|
-
expirationDate.getMinutes() -
|
|
270
|
+
expirationDate.getMinutes() - config_default.tokenMinutesBeforeExpirationRenew
|
|
270
271
|
);
|
|
271
272
|
const currentDate = /* @__PURE__ */ new Date();
|
|
272
273
|
return currentDate >= expirationDate;
|
|
@@ -546,15 +547,57 @@ var RoomConsumesClient = class {
|
|
|
546
547
|
}
|
|
547
548
|
};
|
|
548
549
|
var roomConsumesClient = new RoomConsumesClient();
|
|
550
|
+
|
|
551
|
+
// src/helpers/robotCloudPermissionsHelper.ts
|
|
552
|
+
var RobotCloudPermissionsHelperImpl = class {
|
|
553
|
+
async checkProjectAccess(prjId, required_project_access) {
|
|
554
|
+
const { data: project } = await getProjectDetails(prjId);
|
|
555
|
+
if (project.access_level == required_project_access) {
|
|
556
|
+
return true;
|
|
557
|
+
}
|
|
558
|
+
return this.hasAccessLevel(project, required_project_access);
|
|
559
|
+
}
|
|
560
|
+
hasAccessLevel(project, required_project_access) {
|
|
561
|
+
switch (required_project_access) {
|
|
562
|
+
case "ADVANCED":
|
|
563
|
+
return project.access_level == "ADVANCED";
|
|
564
|
+
case "BASIC":
|
|
565
|
+
return project.access_level == "BASIC" || project.access_level == "ADVANCED";
|
|
566
|
+
case "RESTRICTED":
|
|
567
|
+
return project.access_level == "RESTRICTED" || project.access_level == "BASIC" || project.access_level == "ADVANCED";
|
|
568
|
+
case "BLOCKED":
|
|
569
|
+
return true;
|
|
570
|
+
default:
|
|
571
|
+
return false;
|
|
572
|
+
}
|
|
573
|
+
}
|
|
574
|
+
hasAppAccessLevel(project, required_application_access) {
|
|
575
|
+
switch (required_application_access) {
|
|
576
|
+
case "ADMIN":
|
|
577
|
+
return project.app_access_level == "ADMIN";
|
|
578
|
+
case "ADVANCED":
|
|
579
|
+
return project.app_access_level == "ADVANCED" || project.app_access_level == "ADMIN";
|
|
580
|
+
case "STANDARD":
|
|
581
|
+
return project.app_access_level == "STANDARD" || project.app_access_level == "ADVANCED" || project.app_access_level == "ADMIN";
|
|
582
|
+
case "BLOCKED":
|
|
583
|
+
return true;
|
|
584
|
+
default:
|
|
585
|
+
return false;
|
|
586
|
+
}
|
|
587
|
+
}
|
|
588
|
+
};
|
|
589
|
+
var robotCloudPermissionsHelper = new RobotCloudPermissionsHelperImpl();
|
|
549
590
|
// Annotate the CommonJS export names for ESM import in node:
|
|
550
591
|
0 && (module.exports = {
|
|
592
|
+
RobotCloudClientConfig,
|
|
551
593
|
airQualityClient,
|
|
594
|
+
clientConfig,
|
|
595
|
+
robotCloudPermissionsHelper,
|
|
552
596
|
robotCloudToken,
|
|
553
597
|
robotcloudApi,
|
|
554
598
|
robotcloudClient,
|
|
555
599
|
roomClimeClient,
|
|
556
600
|
roomConsumesClient,
|
|
557
|
-
roomGuestStatusClient
|
|
558
|
-
setCheckTokenFunction
|
|
601
|
+
roomGuestStatusClient
|
|
559
602
|
});
|
|
560
603
|
//# sourceMappingURL=index.js.map
|