@robotbas/robotcloud-client 0.1.14 → 0.2.0

package/types/request-params.d.ts

@@ -0,0 +1,87 @@
+/**
+ * 
+ */
+
+import { MeasurementStatus } from "./services";
+
+/*
+ *  GENERIC REQUEST PARAMS INTERFACES
+ */
+
+export interface SubsystemRequestParams {
+  subsystem_id?: string;
+}
+
+export interface PaginableRequestParams {
+  startIndex?: number;
+  maxSize?: number;
+}
+
+export interface SubsystemTagsRequestParams extends SubsystemRequestParams {
+  tag_id?: string | string[];
+}
+
+export interface BaseFullPaginableRequestParams  extends SubsystemTagsRequestParams, PaginableRequestParams {
+ 
+}
+
+/*
+ * CONCRETE INTERFACES
+ */
+
+export interface ProjectClassifiersRequestParams extends PaginableRequestParams {
+
+}
+
+export interface ProjectsRequestParams extends PaginableRequestParams {
+  "organization-id": string;
+}
+
+export interface ProjectDetailsRequestParams {
+
+}
+
+export interface ProjectLocationsRequestParams extends BaseFullPaginableRequestParams {
+  
+}
+
+
+export interface ServiceInstanceDataRequestParams {
+
+}
+
+export interface ProjectTagRequestParams extends PaginableRequestParams {
+  parent_tag?: string;
+  no_parent?: boolean;
+}
+
+export interface LocationServiceInstancesRequestParams extends BaseFullPaginableRequestParams {
+  
+}
+
+export interface AlertLogsListRequestParams extends BaseFullPaginableRequestParams {
+
+}
+
+
+export interface ServiceInstancesRequestParams extends BaseFullPaginableRequestParams {
+  id?: string;
+  name?: string;
+  location_id?: string;
+  device_id?: string;
+}
+
+
+export interface ServiceDataRequestParams extends SubsystemTagsRequestParams {
+}
+
+export interface ServiceInstanceHistoricAggregateParams {
+  offset?: string;
+  property?: any[];
+  maxSize?: number;
+}
+export interface ServiceInstanceHistoricParams {
+  status?: MeasurementStatus;
+  property?: any[];
+  maxSize?: number;
+}

package/types/services.d.ts

@@ -1,117 +1,92 @@
 import { AxiosResponse } from "axios";
 import { ServiceInstanceRead } from "./ServiceInstanceRead";
-import { ServiceInstanceDataRequestParams, SubsystemRequestParams } from "./RobotCloudClient";
+import { ServiceDataRequestParams, ServiceInstanceDataRequestParams, ServiceInstanceHistoricAggregateParams, ServiceInstanceHistoricParams } from "./request-params";
 
-export type MeasurementStatus =  "GOOD"|"NOT_MEASURED"|"INVALID_VALUE"|"DEVICE_ERROR";
 
-export interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
-    status: MeasurementStatus;
-}
+export type MeasurementStatus =
+  | "GOOD"
+  | "NOT_MEASURED"
+  | "INVALID_VALUE"
+  | "DEVICE_ERROR";
 
-export interface ServiceDataRequestParams extends SubsystemRequestParams {
-    tag_id?: string | string[];
+export interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
+  status: MeasurementStatus;
 }
-export interface ServiceInstanceHistoricAggregateParams {
-    offset?: string;
-    property?: any[];
-    maxSize?: number;
-} 
-export interface ServiceInstanceHistoricParams {
-    status?: MeasurementStatus;
-    property?: any[];
-    maxSize?: number;
-} 
 
 export interface AirQuality1DataEventValue {
-    co2: number;
+  co2: number;
 }
 
 export interface AirQuality1AlertEventValue {
-    high_co2: boolean;
+  high_co2: boolean;
 }
 
-
 export interface RoomGuestStatus1AlertEventValue {
-    door_open_overtime: boolean;
-    window_open_overtime: boolean;
-    medical_alarm: boolean;
+  door_open_overtime: boolean;
+  window_open_overtime: boolean;
+  medical_alarm: boolean;
 }
 
 
 ////
-// Alert status interfaces
+// Generic interface  types
 ////
 
-export interface ServiceTypeAlertStatusResponse<T extends string> {
-  instance: string;
-  time_mark: string;
-  alert_status: Record<T, ServiceTypeAlertStatus>;
-}
-export interface ServiceTypeAlertStatus {
-  acknowledged: boolean;
-  ack_time: string;
-  ack_user: string; // username
-  active_time: string;
-  deactive_time: string;
-  activation_count: number;
+export type HistoricAggregateFunction =
+  | "count"
+  | "increase"
+  | "mean"
+  | "first"
+  | "last"
+  | "max"
+  | "min"
+  | "amax"
+  | "amin"
+  | "pmax"
+  | "pmin"
+  | "nmax"
+  | "nmin";
+
+  
+export interface ServiceInstanceConfigClient<T> {
+  get(project_id: string, instance_id: string): Promise<AxiosResponse<T>>;
+  put(project_id: string, instance_id: string, configuration: T): Promise<AxiosResponse<T>>;
 }
 
-export interface ServiceTypeAlertStatusClient<T extends string> {
-  getAll(projectId: string): Promise<AxiosResponse<ServiceTypeAlertStatusResponse<T>[]>>;
-  get(projectId: string, instanceId: string): Promise<AxiosResponse<ServiceTypeAlertStatusResponse<T>>>;
-  put(projectId: string, instanceId: string, status: Record<T, boolean>): Promise<AxiosResponse<ServiceTypeAlertStatusResponse<T>>>;
-}
+export interface ServiceTypeClient<T_ALERTS, T_DATA> {
 
-////
-// Generic interface  types
-////
-
-export type HistoricAggregateFunction = "count"|"increase"|"mean"|"first"|"last"|"max"|"min"|"amax"|"amin"|"pmax"|"pmin"|"nmax"|"nmin";
-
-export interface ServiceTypeClient<T_ALERTS, T_DATA, T_CONFIG> {
-  get alertStatus(): ServiceTypeAlertStatusClient<any>;  
+  get configuration(): ServiceInstanceConfigClient<any>;  
   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>>;
-
-    getInstanceData (
-        prjId: string,
-        instanceId: string,
-        params?: ServiceInstanceDataRequestParams
-    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>>>;
-
-    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>[]>>;
-}
+    prjId: string,
+    params?: ServiceDataRequestParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
+
+  getData(
+    prjId: string,
+    params?: ServiceDataRequestParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+  getInstanceData(
+    prjId: string,
+    instanceId: string,
+    params?: ServiceInstanceDataRequestParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>>>;
+
+  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>[]>>;
+}