@robotbas/robotcloud-client 0.1.15 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robotbas/robotcloud-client",
-  "version": "0.1.15",
+  "version": "0.2.0",
   "description": "RobotCloud API client",
   "author": {
     "name": "Bernat Galmés Rubert",

package/types/ProjectClassifer.d.ts

@@ -1,9 +1,3 @@
-import { PaginableRequestParams } from "./RobotCloudClient";
-
-export interface ProjectClassifiersRequestParams extends PaginableRequestParams {
-
-}
-
 export interface Classifier {
     id: string;
     name: string;

package/types/RobotCloudClient.d.ts

@@ -10,45 +10,6 @@ export type RobotCloudServiceType = "RoomClime_1"|"RoomGuestStatus_1"|"AirQualit
 // Desired fancoil speed (0 = Auto, 1..3 = Manual Speed)
 export type FancoilSpeedState = 0|1|2|3;
 
-export interface ProjectRequestParams {
-
-}
-
-export interface ProjectDetailsRequestParams {
-
-}
-export interface SubsystemRequestParams {
-  subsystem_id?: string;
-}
-
-export interface PaginableRequestParams {
-  startIndex?: number;
-  maxSize?: number;
-}
-
-export interface SubsystemTagsRequestParams extends SubsystemRequestParams {
-  tag_id?: string | string[];
-}
-
-export interface ProjectLocationsRequestParams extends SubsystemTagsRequestParams, PaginableRequestParams {
-  
-}
-
-
-export interface ServiceInstanceDataRequestParams {
-
-}
-
-export interface ProjectTagRequestParams extends PaginableRequestParams {
-  parent_tag?: string;
-  no_parent?: boolean;
-}
-
-
-export interface LocationServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
-  tag_id?: string[];
-}
-
 
 /** RESPONSE **/
 
@@ -70,6 +31,11 @@ export interface RobotCloudUserAppAccess {
     access_level: AppAccessLevel;
 }
 
+export interface RobotCloudUserSimple {
+    username: string;
+    name: string;
+    last_name: string;
+}
 export interface RobotCloudUserDetails {
     username: string;
     name: string;

package/types/ServiceInstance.d.ts

@@ -1,4 +1,4 @@
-import { PaginableRequestParams, RobotCloudNamedItem, SubsystemRequestParams } from "./RobotCloudClient";
+import { RobotCloudNamedItem } from "./RobotCloudClient";
 
 export interface RobotCloudServiceInstance extends RobotCloudNamedItem {
     service: string;
@@ -10,12 +10,3 @@ export interface ServiceInstanceDetails extends RobotCloudServiceInstance {
   subsystems: string[];
   classifier: string;
 }
-
-export interface ServiceInstancesRequestParams extends SubsystemRequestParams, 
-    PaginableRequestParams {
-  id?: string;
-  name?: string;
-  location_id?: string;
-  device_id?: string;
-  tag_id?: string[];
-}

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,10 +1,7 @@
 import { AxiosResponse } from "axios";
 import { ServiceInstanceRead } from "./ServiceInstanceRead";
-import {
-  ServiceInstanceDataRequestParams,
-  SubsystemRequestParams,
-  SubsystemTagsRequestParams,
-} from "./RobotCloudClient";
+import { ServiceDataRequestParams, ServiceInstanceDataRequestParams, ServiceInstanceHistoricAggregateParams, ServiceInstanceHistoricParams } from "./request-params";
+
 
 export type MeasurementStatus =
   | "GOOD"
@@ -16,20 +13,6 @@ export interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
   status: MeasurementStatus;
 }
 
-export interface ServiceDataRequestParams extends SubsystemRequestParams {
-  tag_id?: string | string[];
-}
-export interface ServiceInstanceHistoricAggregateParams {
-  offset?: string;
-  property?: any[];
-  maxSize?: number;
-}
-export interface ServiceInstanceHistoricParams {
-  status?: MeasurementStatus;
-  property?: any[];
-  maxSize?: number;
-}
-
 export interface AirQuality1DataEventValue {
   co2: number;
 }
@@ -44,39 +27,6 @@ export interface RoomGuestStatus1AlertEventValue {
   medical_alarm: boolean;
 }
 
-////
-// Alert status interfaces
-////
-
-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 interface ServiceTypeAlertStatusClient<T extends string> {
-  getAll(
-    projectId: string,
-    params?: SubsystemTagsRequestParams
-  ): 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>>>;
-}
 
 ////
 // Generic interface  types
@@ -97,8 +47,15 @@ export type HistoricAggregateFunction =
   | "nmax"
   | "nmin";
 
-export interface ServiceTypeClient<T_ALERTS, T_DATA, T_CONFIG> {
-  get alertStatus(): ServiceTypeAlertStatusClient<any>;
+  
+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 ServiceTypeClient<T_ALERTS, T_DATA> {
+
+  get configuration(): ServiceInstanceConfigClient<any>;  
   getAlerts(
     prjId: string,
     params?: ServiceDataRequestParams
@@ -109,17 +66,6 @@ export interface ServiceTypeClient<T_ALERTS, T_DATA, T_CONFIG> {
     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,