@robotbas/robotcloud-client 1.0.0-rc.1 → 1.0.0-rc.2

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 import * as axios from 'axios';
 import { AxiosResponse } from 'axios';
-import { R as RobotCloudNamedItem, a as RobotCloudServiceType, L as LocationServiceInstancesRequestParams, b as RobotCloudUserDetails, P as ProjectRequestParams, c as RobotCloudProject, d as ProjectDetailsRequestParams, e as RobotCloudProjectDetails, f as ProjectLocationsRequestParams, S as ServiceInstancesRequestParams, g as ProjectTagRequestParams, h as RobotCloudDeviceDetails, i as ServiceDataRequestParams, j as RoomClime1EventValue, k as RoomGuestStatus1EventValue, A as AirQuality1DataEventValue, l as RoomGrouping1DataEventValue, m as RoomConsumes1DataEventValue, n as RoomClime1AlertEventValue, o as RoomGuestStatus1AlertEventValue, p as AirQuality1AlertEventValue, q as RoomConsumes1AlertEventValue, r as RoomClimeInstanceConfigParams, s as RoomGuestStatusInstanceConfigParams, t as RoomGrouping1InstanceDeviceConfig } from './RobotCloudClient.d--IA4S5ZR.js';
-export { w as AppAccessLevel, y as PaginableRequestParams, v as ProjectAccessLevel, u as RegimState, z as ServiceInstanceDeviceConfig, x as SubsystemRequestParams, T as TemperatureUnit } from './RobotCloudClient.d--IA4S5ZR.js';
+import { R as RobotCloudNamedItem, S as SubsystemRequestParams, a as RobotCloudServiceType, L as LocationServiceInstancesRequestParams, b as RobotCloudUserDetails, P as ProjectRequestParams, c as RobotCloudProject, d as ProjectDetailsRequestParams, e as RobotCloudProjectDetails, f as ProjectLocationsRequestParams, g as ServiceInstancesRequestParams, h as ProjectTagRequestParams, i as RobotCloudDeviceDetails, j as RoomGrouping1DataEventValue, k as ServiceInstanceDataRequestParams, l as RoomConsumes1DataEventValue, m as RoomGrouping1InstanceDeviceConfig, n as RoomConsumes1AlertEventValue, o as RoomClime1AlertEventValue, p as RoomClime1EventValue, q as RoomClimeInstanceConfigParams } from './RobotCloudClient.d-tle3DEZp.js';
+export { A as AppAccessLevel, F as FancoilSpeedState, t as PaginableRequestParams, s as ProjectAccessLevel, r as RegimState, u as ServiceInstanceDeviceConfig, T as TemperatureUnit } from './RobotCloudClient.d-tle3DEZp.js';
 
 declare const robotcloudApi: axios.AxiosInstance;
+declare const setCheckTokenFunction: (fun: () => Promise<string>) => void;
 
 interface RobotCloudServiceInstance extends RobotCloudNamedItem {
     service: string;
@@ -43,8 +44,109 @@ interface ServiceInstanceRead<T> {
     value: T;
 }
 
+type MeasurementStatus =  "GOOD"|"NOT_MEASURED"|"INVALID_VALUE"|"DEVICE_ERROR";
+
 interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
-    status: "GOOD"|"NOT_MEASURED"|"INVALID_VALUE"|"DEVICE_ERROR";
+    status: MeasurementStatus;
+}
+
+interface ServiceDataRequestParams extends SubsystemRequestParams {
+    tag_id?: string | string[];
+}
+interface ServiceInstanceHistoricAggregateParams {
+    offset?: string;
+    property?: any[];
+    maxSize?: number;
+} 
+interface ServiceInstanceHistoricParams {
+    status?: MeasurementStatus;
+    property?: any[];
+    maxSize?: number;
+} 
+
+interface AirQuality1DataEventValue {
+    co2: number;
+}
+
+interface AirQuality1AlertEventValue {
+    high_co2: boolean;
+}
+
+
+interface RoomGuestStatus1AlertEventValue {
+    door_open_overtime: boolean;
+    window_open_overtime: boolean;
+    medical_alarm: boolean;
+}
+
+interface RoomGuestStatus1EventValue {
+    sold: boolean;
+    occupied: boolean;
+    do_not_disturb: boolean;
+    make_up_room: boolean;
+    tray_status: "IDLE"|'READY'|'FINISH';
+    remote_occupation: boolean;
+    door_open: boolean;
+    window_open: boolean;
+    medical_alarm: boolean; // TODO: ???
+}
+
+interface RoomGuestStatusInstanceConfigParams {
+    sold?: boolean;
+    do_not_disturb?: boolean;
+    make_up_room?: boolean;
+    remote_occupation?: boolean;
+    door_open_time_limit?: number;
+    window_open_time_limit?: number;
+    medical_alarm?: boolean;
+}
+
+
+////
+// Generic interface  types
+////
+
+type HistoricAggregateFunction = "count"|"increase"|"mean"|"first"|"last"|"max"|"min"|"amax"|"amin"|"pmax"|"pmin"|"nmax"|"nmin";
+
+interface ServiceTypeClient<T_ALERTS, T_DATA, T_CONFIG> {
+    getAlerts(
+        prjId: string,
+        params?: ServiceDataRequestParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
+
+    getData (
+        prjId: string,
+        params?: ServiceDataRequestParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+    getInstanceConfiguration (
+        prjId: string,
+        instanceId: string
+    ): Promise<AxiosResponse<T_CONFIG>>;
+
+    putInstanceConfiguration (
+        prjId: string,
+        instanceId: string,
+        data: T_CONFIG
+    ): Promise<AxiosResponse<T_CONFIG>>;
+
+    getInstanceHistoric (
+        prjId: string,
+        instanceId: string,
+        startTime: Date,
+        endTime: Date,
+        params: ServiceInstanceHistoricParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+    getInstanceHistoricAggregate(
+        prjId: string,
+        instanceId: string,
+        startTime: Date,
+        endTime: Date,
+        aggFunction: HistoricAggregateFunction,
+        periode: string,
+        params: ServiceInstanceHistoricAggregateParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
 }
 
 interface RobotCloudLocationDetails {
@@ -68,23 +170,10 @@ declare const getTags: (prjId: string, params?: ProjectTagRequestParams) => Prom
 declare const getTagsTree: (prjId: string, maxDepth?: number, params?: ProjectTagRequestParams) => Promise<ProjectTagsTree>;
 declare const getTagsChildren: (prjId: string, level?: number, parent_id?: string, params?: ProjectTagRequestParams, maxDepth?: number) => Promise<ProjectTagTreeNode[]>;
 declare const getDeviceDetails: (deviceId: string) => Promise<AxiosResponse<RobotCloudDeviceDetails>>;
-declare const getRoomClimeServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1EventValue>[]>>;
-declare const getRoomGuestStatusServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomGuestStatus1EventValue>[]>>;
-declare const getAirQualityServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<AirQuality1DataEventValue>[]>>;
 declare const getRoomGrouping1ServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>>;
-declare const getRoomConsumesServiceData: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>[]>>;
-declare const getRoomClimeServiceAlert: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1AlertEventValue>[]>>;
-declare const getRoomGuestStatusServiceAlert: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomGuestStatus1AlertEventValue>[]>>;
-declare const getAirQualityServiceAlert: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<AirQuality1AlertEventValue>[]>>;
-declare const getRoomConsumesServiceAlert: (prjId: string, params?: ServiceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1AlertEventValue>[]>>;
-declare const getRoomClimeServiceInstanceConfiguration: (prjId: string, instanceId: string) => Promise<AxiosResponse<RoomClimeInstanceConfigParams>>;
-declare const getRoomGuestStatusServiceInstanceConfiguration: (prjId: string, instanceId: string) => Promise<AxiosResponse<RoomGuestStatusInstanceConfigParams>>;
-declare const putRoomClimeServiceInstanceConfiguration: (prjId: string, instanceId: string, data: RoomClimeInstanceConfigParams) => Promise<AxiosResponse<RoomClimeInstanceConfigParams>>;
-declare const putRoomGuestStatusServiceInstanceConfiguration: (prjId: string, instanceId: string, data: RoomGuestStatusInstanceConfigParams) => Promise<AxiosResponse<RoomGuestStatusInstanceConfigParams>>;
+declare const getRoomConsumesInstanceServiceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>>>;
 declare const getRoomGrouping1InstanceDeviceConfig: (prjId: string, instanceId: string) => Promise<AxiosResponse<RoomGrouping1InstanceDeviceConfig>>;
 
-declare const robotCloudClient_getAirQualityServiceAlert: typeof getAirQualityServiceAlert;
-declare const robotCloudClient_getAirQualityServiceData: typeof getAirQualityServiceData;
 declare const robotCloudClient_getClassifier: typeof getClassifier;
 declare const robotCloudClient_getDeviceDetails: typeof getDeviceDetails;
 declare const robotCloudClient_getLocation: typeof getLocation;
@@ -93,26 +182,17 @@ declare const robotCloudClient_getLocations: typeof getLocations;
 declare const robotCloudClient_getProjectDetails: typeof getProjectDetails;
 declare const robotCloudClient_getProjectSubsystem: typeof getProjectSubsystem;
 declare const robotCloudClient_getProjects: typeof getProjects;
-declare const robotCloudClient_getRoomClimeServiceAlert: typeof getRoomClimeServiceAlert;
-declare const robotCloudClient_getRoomClimeServiceData: typeof getRoomClimeServiceData;
-declare const robotCloudClient_getRoomClimeServiceInstanceConfiguration: typeof getRoomClimeServiceInstanceConfiguration;
-declare const robotCloudClient_getRoomConsumesServiceAlert: typeof getRoomConsumesServiceAlert;
-declare const robotCloudClient_getRoomConsumesServiceData: typeof getRoomConsumesServiceData;
+declare const robotCloudClient_getRoomConsumesInstanceServiceData: typeof getRoomConsumesInstanceServiceData;
 declare const robotCloudClient_getRoomGrouping1InstanceDeviceConfig: typeof getRoomGrouping1InstanceDeviceConfig;
 declare const robotCloudClient_getRoomGrouping1ServiceData: typeof getRoomGrouping1ServiceData;
-declare const robotCloudClient_getRoomGuestStatusServiceAlert: typeof getRoomGuestStatusServiceAlert;
-declare const robotCloudClient_getRoomGuestStatusServiceData: typeof getRoomGuestStatusServiceData;
-declare const robotCloudClient_getRoomGuestStatusServiceInstanceConfiguration: typeof getRoomGuestStatusServiceInstanceConfiguration;
 declare const robotCloudClient_getServiceInstance: typeof getServiceInstance;
 declare const robotCloudClient_getServiceInstances: typeof getServiceInstances;
 declare const robotCloudClient_getTags: typeof getTags;
 declare const robotCloudClient_getTagsChildren: typeof getTagsChildren;
 declare const robotCloudClient_getTagsTree: typeof getTagsTree;
 declare const robotCloudClient_getUser: typeof getUser;
-declare const robotCloudClient_putRoomClimeServiceInstanceConfiguration: typeof putRoomClimeServiceInstanceConfiguration;
-declare const robotCloudClient_putRoomGuestStatusServiceInstanceConfiguration: typeof putRoomGuestStatusServiceInstanceConfiguration;
 declare namespace robotCloudClient {
-  export { robotCloudClient_getAirQualityServiceAlert as getAirQualityServiceAlert, robotCloudClient_getAirQualityServiceData as getAirQualityServiceData, 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_getProjectSubsystem as getProjectSubsystem, robotCloudClient_getProjects as getProjects, robotCloudClient_getRoomClimeServiceAlert as getRoomClimeServiceAlert, robotCloudClient_getRoomClimeServiceData as getRoomClimeServiceData, robotCloudClient_getRoomClimeServiceInstanceConfiguration as getRoomClimeServiceInstanceConfiguration, robotCloudClient_getRoomConsumesServiceAlert as getRoomConsumesServiceAlert, robotCloudClient_getRoomConsumesServiceData as getRoomConsumesServiceData, robotCloudClient_getRoomGrouping1InstanceDeviceConfig as getRoomGrouping1InstanceDeviceConfig, robotCloudClient_getRoomGrouping1ServiceData as getRoomGrouping1ServiceData, robotCloudClient_getRoomGuestStatusServiceAlert as getRoomGuestStatusServiceAlert, robotCloudClient_getRoomGuestStatusServiceData as getRoomGuestStatusServiceData, robotCloudClient_getRoomGuestStatusServiceInstanceConfiguration as getRoomGuestStatusServiceInstanceConfiguration, robotCloudClient_getServiceInstance as getServiceInstance, robotCloudClient_getServiceInstances as getServiceInstances, robotCloudClient_getTags as getTags, robotCloudClient_getTagsChildren as getTagsChildren, robotCloudClient_getTagsTree as getTagsTree, robotCloudClient_getUser as getUser, robotCloudClient_putRoomClimeServiceInstanceConfiguration as putRoomClimeServiceInstanceConfiguration, robotCloudClient_putRoomGuestStatusServiceInstanceConfiguration as putRoomGuestStatusServiceInstanceConfiguration };
+  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_getProjectSubsystem as getProjectSubsystem, robotCloudClient_getProjects as getProjects, robotCloudClient_getRoomConsumesInstanceServiceData as getRoomConsumesInstanceServiceData, 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 };
 }
 
 interface CheckTokenResponse {
@@ -146,4 +226,19 @@ declare namespace robotCloudToken {
   export { type robotCloudToken_RobotCloudNewTokenResponse as RobotCloudNewTokenResponse, robotCloudToken_decodeToken as decodeToken, robotCloudToken_isTokenExpired as isTokenExpired, robotCloudToken_renewToken as renewToken, robotCloudToken_validateToken as validateToken };
 }
 
-export { AirQuality1AlertEventValue, AirQuality1DataEventValue, type CheckTokenResponse, type ClassifierDetails, LocationServiceInstancesRequestParams, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectRequestParams, type ProjectTag, ProjectTagRequestParams, type ProjectTagTreeNode, type ProjectTagsTree, RobotCloudDeviceDetails, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudProject, RobotCloudProjectDetails, type RobotCloudServiceInstance, RobotCloudServiceType, RobotCloudUserDetails, RoomClime1AlertEventValue, RoomClime1EventValue, RoomClimeInstanceConfigParams, RoomConsumes1AlertEventValue, RoomConsumes1DataEventValue, RoomGrouping1DataEventValue, RoomGrouping1InstanceDeviceConfig, RoomGuestStatus1AlertEventValue, RoomGuestStatus1EventValue, RoomGuestStatusInstanceConfigParams, type ServiceDataMeasurement, ServiceDataRequestParams, type ServiceInstanceDetails, type ServiceInstanceRead, ServiceInstancesRequestParams, robotCloudToken, robotcloudApi, robotCloudClient as robotcloudClient };
+declare class RoomConsumesClient implements ServiceTypeClient<RoomConsumes1AlertEventValue, RoomConsumes1DataEventValue, any> {
+    getAlerts(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1AlertEventValue>[]>>;
+    getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>[]>>;
+    getInstanceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>>>;
+    getInstanceConfiguration<T>(prjId: string, instanceId: string): Promise<AxiosResponse<T>>;
+    putInstanceConfiguration<T>(prjId: string, instanceId: string, data: T): Promise<AxiosResponse<T>>;
+    getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>[]>>;
+    getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>[]>>;
+}
+declare const roomConsumesClient: RoomConsumesClient;
+
+declare const roomClimeClient: ServiceTypeClient<RoomClime1AlertEventValue, RoomClime1EventValue, RoomClimeInstanceConfigParams>;
+declare const roomGuestStatusClient: ServiceTypeClient<RoomGuestStatus1AlertEventValue, RoomGuestStatus1EventValue, RoomGuestStatusInstanceConfigParams>;
+declare const airQualityClient: ServiceTypeClient<AirQuality1AlertEventValue, AirQuality1DataEventValue, any>;
+
+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, RobotCloudUserDetails, RoomClime1AlertEventValue, RoomClime1EventValue, RoomClimeInstanceConfigParams, RoomConsumes1AlertEventValue, RoomConsumes1DataEventValue, 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, airQualityClient, robotCloudToken, robotcloudApi, robotCloudClient as robotcloudClient, roomClimeClient, roomConsumesClient, roomGuestStatusClient, setCheckTokenFunction };