@robotbas/robotcloud-client 1.0.0-rc.1

package/README.md

@@ -0,0 +1,30 @@
+# TYPESCRIPT ROBOTCLOUD API CLIENT
+
+Typescript library to access robotcloud endpoints.
+
+## Installation
+
+```bash
+yarn add @robotbas/robotcloud-client
+```
+
+## Configure authentication interceptor
+
+Example used on a nuxtjs middleware to setup the RobotCloud API token.
+```typescript
+import robotcloudApi, { setCheckTokenFunction } from "robotcloud-client";
+
+const appConfigs = useRuntimeConfig().public; // Get aplication global configs
+robotcloudApi.defaults.baseURL = appConfigs.robotCloudUrl
+setCheckTokenFunction(async () => {
+    const token = await getAccessToken()
+    if (!token) {
+        await navigateTo(appConfigs.loginUrl, { external: true })
+        return ''
+    }
+    return token
+})
+
+```
+
+

package/dist/RobotCloudClient.d--IA4S5ZR.d.mts

@@ -0,0 +1,203 @@
+type TemperatureUnit = "CELSIUS" | "FAHRENHEIT"
+type RegimState = "COLD"|"HEAT"|"AUTO"
+
+type ProjectAccessLevel = "BLOCKED" | "RESTRICTED" | "BASIC" | "ADVANCED"
+type AppAccessLevel = "BLOCKED" | "STANDARD" | "ADVANCED" | "ADMIN"
+
+type RobotCloudServiceType = "RoomClime_1"|"RoomGuestStatus_1"
+
+interface ProjectRequestParams {
+
+}
+
+interface ProjectDetailsRequestParams {
+
+}
+interface SubsystemRequestParams {
+  subsystem_id?: string;
+}
+
+interface PaginableRequestParams {
+  startIndex?: number;
+  maxSize?: number;
+}
+
+interface ProjectLocationsRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  tag_id?: string | string[];
+}
+
+interface ServiceDataRequestParams extends SubsystemRequestParams {
+  tag_id?: string | string[];
+}
+
+interface ProjectTagRequestParams extends PaginableRequestParams {
+  parent_tag?: string;
+  no_parent?: boolean;
+}
+
+interface ServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  id?: string;
+  name?: string;
+  location_id?: string;
+  device_id?: string;
+  tag_id?: string[];
+}
+
+interface LocationServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  tag_id?: string[];
+}
+
+interface RoomClimeInstanceConfigParams {
+  temperature_set_point?: number;
+  humidity_set_point?: number;
+  regim?: RegimState;
+  eco_mode?: "STANDBY" | "ECO" | "VIP";
+  fancoil_speed?: 0 | 1 | 2 | 3;
+  on?: boolean;
+  high_temperature_level?: number;
+  low_temperature_level?: number;
+  high_humidity_level?: number;
+  fancoil_on_time_limit?: number;
+  temperature_units?: TemperatureUnit;
+}
+
+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;
+}
+
+
+/** RESPONSE **/
+
+interface RobotCloudNamedItem {
+  id: string;
+  name: string;
+}
+
+interface RobotCloudProject {
+  id: string;
+  name: string;
+  organization: string;
+}
+
+/** USERS */
+interface RobotCloudUserDetails {
+    username: string;
+    name: string;
+    last_name: string;
+    email: string;
+    org_id: string;
+    org_access: number;
+}
+
+
+interface RobotCloudProjectDetails extends RobotCloudProject {
+  version: number;
+  description?: string;
+  country?: string;
+  timezone?: string;
+  image_url?: string;
+  longitude?: number;
+  latitude?: number;
+  application_enabled?: boolean;
+  access_level?: ProjectAccessLevel;
+  app_access_level?: AppAccessLevel;
+}
+
+interface RobotCloudDeviceDetails extends RobotCloudNamedItem {
+  description?: string;
+  location: string;
+  address: {
+    domain: number;
+    zone: number;
+    id: number;
+  };
+  type: number;
+  configuration_type: string;
+  tags: string;
+}
+
+/** SERVICE EVENTS VALUES **/
+interface RoomClime1AlertEventValue {
+  high_temperature: boolean;
+  low_temperature: boolean;
+  high_humidity: boolean;
+  fancoil_on_overtime: boolean;
+}
+interface RoomClime1EventValue {
+  temperature: number;
+  humidity: number;
+  fancoil_speed: number;
+  fancoil_manual: boolean;
+  on: boolean;
+  temperature_set_point: number; 
+  humidity_set_point: number; 
+  regim: RegimState;
+  eco_mode: "STANDBY"|"ECO"|"VIP";
+}
+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 AirQuality1DataEventValue {
+  co2: number;
+}
+interface AirQuality1AlertEventValue {
+  high_co2: boolean;
+}
+interface RoomConsumes1AlertEventValue {
+  high_daily_energy_electric: boolean;
+  high_daily_energy_thermal: boolean;
+  high_daily_hot_water: boolean;
+  high_daily_cold_water: boolean;
+}
+
+interface RoomGrouping1DataEventValue {
+  replica_1_active: boolean;
+  replica_2_active: boolean;
+  replica_3_active: boolean;
+}
+
+interface RoomConsumes1DataEventValue {
+    energy_electric: number;
+    energy_thermal: number;
+    hot_water: number;
+    cold_water: number;
+    daily_energy_electric: number;
+    daily_energy_thermal: number;
+    daily_hot_water: number;
+    daily_cold_water: number;
+    daily_co2_footprint: number;
+    daily_tree_equivalent: number;
+}
+
+/** SERVICE INSTANCES DEVICE CONFIG */
+interface ServiceInstanceDeviceConfig {
+  device: string;
+}
+
+interface RoomGrouping1InstanceDeviceConfig {
+  Main: ServiceInstanceDeviceConfig;
+  Replica_1: ServiceInstanceDeviceConfig;
+  Replica_2: ServiceInstanceDeviceConfig;
+  Replica_3: ServiceInstanceDeviceConfig;
+}
+
+export type { AirQuality1DataEventValue as A, LocationServiceInstancesRequestParams as L, ProjectRequestParams as P, RobotCloudNamedItem as R, ServiceInstancesRequestParams as S, TemperatureUnit as T, RobotCloudServiceType as a, RobotCloudUserDetails as b, RobotCloudProject as c, ProjectDetailsRequestParams as d, RobotCloudProjectDetails as e, ProjectLocationsRequestParams as f, ProjectTagRequestParams as g, RobotCloudDeviceDetails as h, ServiceDataRequestParams as i, RoomClime1EventValue as j, RoomGuestStatus1EventValue as k, RoomGrouping1DataEventValue as l, RoomConsumes1DataEventValue as m, RoomClime1AlertEventValue as n, RoomGuestStatus1AlertEventValue as o, AirQuality1AlertEventValue as p, RoomConsumes1AlertEventValue as q, RoomClimeInstanceConfigParams as r, RoomGuestStatusInstanceConfigParams as s, RoomGrouping1InstanceDeviceConfig as t, RegimState as u, ProjectAccessLevel as v, AppAccessLevel as w, SubsystemRequestParams as x, PaginableRequestParams as y, ServiceInstanceDeviceConfig as z };

package/dist/RobotCloudClient.d--IA4S5ZR.d.ts

@@ -0,0 +1,203 @@
+type TemperatureUnit = "CELSIUS" | "FAHRENHEIT"
+type RegimState = "COLD"|"HEAT"|"AUTO"
+
+type ProjectAccessLevel = "BLOCKED" | "RESTRICTED" | "BASIC" | "ADVANCED"
+type AppAccessLevel = "BLOCKED" | "STANDARD" | "ADVANCED" | "ADMIN"
+
+type RobotCloudServiceType = "RoomClime_1"|"RoomGuestStatus_1"
+
+interface ProjectRequestParams {
+
+}
+
+interface ProjectDetailsRequestParams {
+
+}
+interface SubsystemRequestParams {
+  subsystem_id?: string;
+}
+
+interface PaginableRequestParams {
+  startIndex?: number;
+  maxSize?: number;
+}
+
+interface ProjectLocationsRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  tag_id?: string | string[];
+}
+
+interface ServiceDataRequestParams extends SubsystemRequestParams {
+  tag_id?: string | string[];
+}
+
+interface ProjectTagRequestParams extends PaginableRequestParams {
+  parent_tag?: string;
+  no_parent?: boolean;
+}
+
+interface ServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  id?: string;
+  name?: string;
+  location_id?: string;
+  device_id?: string;
+  tag_id?: string[];
+}
+
+interface LocationServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  tag_id?: string[];
+}
+
+interface RoomClimeInstanceConfigParams {
+  temperature_set_point?: number;
+  humidity_set_point?: number;
+  regim?: RegimState;
+  eco_mode?: "STANDBY" | "ECO" | "VIP";
+  fancoil_speed?: 0 | 1 | 2 | 3;
+  on?: boolean;
+  high_temperature_level?: number;
+  low_temperature_level?: number;
+  high_humidity_level?: number;
+  fancoil_on_time_limit?: number;
+  temperature_units?: TemperatureUnit;
+}
+
+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;
+}
+
+
+/** RESPONSE **/
+
+interface RobotCloudNamedItem {
+  id: string;
+  name: string;
+}
+
+interface RobotCloudProject {
+  id: string;
+  name: string;
+  organization: string;
+}
+
+/** USERS */
+interface RobotCloudUserDetails {
+    username: string;
+    name: string;
+    last_name: string;
+    email: string;
+    org_id: string;
+    org_access: number;
+}
+
+
+interface RobotCloudProjectDetails extends RobotCloudProject {
+  version: number;
+  description?: string;
+  country?: string;
+  timezone?: string;
+  image_url?: string;
+  longitude?: number;
+  latitude?: number;
+  application_enabled?: boolean;
+  access_level?: ProjectAccessLevel;
+  app_access_level?: AppAccessLevel;
+}
+
+interface RobotCloudDeviceDetails extends RobotCloudNamedItem {
+  description?: string;
+  location: string;
+  address: {
+    domain: number;
+    zone: number;
+    id: number;
+  };
+  type: number;
+  configuration_type: string;
+  tags: string;
+}
+
+/** SERVICE EVENTS VALUES **/
+interface RoomClime1AlertEventValue {
+  high_temperature: boolean;
+  low_temperature: boolean;
+  high_humidity: boolean;
+  fancoil_on_overtime: boolean;
+}
+interface RoomClime1EventValue {
+  temperature: number;
+  humidity: number;
+  fancoil_speed: number;
+  fancoil_manual: boolean;
+  on: boolean;
+  temperature_set_point: number; 
+  humidity_set_point: number; 
+  regim: RegimState;
+  eco_mode: "STANDBY"|"ECO"|"VIP";
+}
+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 AirQuality1DataEventValue {
+  co2: number;
+}
+interface AirQuality1AlertEventValue {
+  high_co2: boolean;
+}
+interface RoomConsumes1AlertEventValue {
+  high_daily_energy_electric: boolean;
+  high_daily_energy_thermal: boolean;
+  high_daily_hot_water: boolean;
+  high_daily_cold_water: boolean;
+}
+
+interface RoomGrouping1DataEventValue {
+  replica_1_active: boolean;
+  replica_2_active: boolean;
+  replica_3_active: boolean;
+}
+
+interface RoomConsumes1DataEventValue {
+    energy_electric: number;
+    energy_thermal: number;
+    hot_water: number;
+    cold_water: number;
+    daily_energy_electric: number;
+    daily_energy_thermal: number;
+    daily_hot_water: number;
+    daily_cold_water: number;
+    daily_co2_footprint: number;
+    daily_tree_equivalent: number;
+}
+
+/** SERVICE INSTANCES DEVICE CONFIG */
+interface ServiceInstanceDeviceConfig {
+  device: string;
+}
+
+interface RoomGrouping1InstanceDeviceConfig {
+  Main: ServiceInstanceDeviceConfig;
+  Replica_1: ServiceInstanceDeviceConfig;
+  Replica_2: ServiceInstanceDeviceConfig;
+  Replica_3: ServiceInstanceDeviceConfig;
+}
+
+export type { AirQuality1DataEventValue as A, LocationServiceInstancesRequestParams as L, ProjectRequestParams as P, RobotCloudNamedItem as R, ServiceInstancesRequestParams as S, TemperatureUnit as T, RobotCloudServiceType as a, RobotCloudUserDetails as b, RobotCloudProject as c, ProjectDetailsRequestParams as d, RobotCloudProjectDetails as e, ProjectLocationsRequestParams as f, ProjectTagRequestParams as g, RobotCloudDeviceDetails as h, ServiceDataRequestParams as i, RoomClime1EventValue as j, RoomGuestStatus1EventValue as k, RoomGrouping1DataEventValue as l, RoomConsumes1DataEventValue as m, RoomClime1AlertEventValue as n, RoomGuestStatus1AlertEventValue as o, AirQuality1AlertEventValue as p, RoomConsumes1AlertEventValue as q, RoomClimeInstanceConfigParams as r, RoomGuestStatusInstanceConfigParams as s, RoomGrouping1InstanceDeviceConfig as t, RegimState as u, ProjectAccessLevel as v, AppAccessLevel as w, SubsystemRequestParams as x, PaginableRequestParams as y, ServiceInstanceDeviceConfig as z };

package/dist/helpers/index.d.mts

@@ -0,0 +1,9 @@
+import { v as ProjectAccessLevel } from '../RobotCloudClient.d--IA4S5ZR.mjs';
+
+interface RobotCloudPermissionsHelper {
+    checkProjectAccess(prjId: string, required_project_access: ProjectAccessLevel): Promise<boolean>;
+}
+
+declare const robotCloudPermissionsHelper: RobotCloudPermissionsHelper;
+
+export { type RobotCloudPermissionsHelper, robotCloudPermissionsHelper };

package/dist/helpers/index.d.ts

@@ -0,0 +1,9 @@
+import { v as ProjectAccessLevel } from '../RobotCloudClient.d--IA4S5ZR.js';
+
+interface RobotCloudPermissionsHelper {
+    checkProjectAccess(prjId: string, required_project_access: ProjectAccessLevel): Promise<boolean>;
+}
+
+declare const robotCloudPermissionsHelper: RobotCloudPermissionsHelper;
+
+export { type RobotCloudPermissionsHelper, robotCloudPermissionsHelper };

package/dist/helpers/index.js

@@ -0,0 +1,110 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/helpers/index.ts
+var helpers_exports = {};
+__export(helpers_exports, {
+  robotCloudPermissionsHelper: () => robotCloudPermissionsHelper
+});
+module.exports = __toCommonJS(helpers_exports);
+
+// src/utils/logger.ts
+var import_consola = require("consola");
+function useLogger(tag, options = { level: 1e3 }) {
+  return tag ? (0, import_consola.createConsola)(options).withTag(tag) : (0, import_consola.createConsola)(options);
+}
+
+// src/robotCloudApi.ts
+var import_axios = __toESM(require("axios"));
+var logger = useLogger("robotcloud-api");
+var robotcloudApi = import_axios.default.create();
+var checkTokenPromise = null;
+var clearPromise = () => checkTokenPromise = null;
+async function refreshToken(checkToken2) {
+  const access_token = await checkToken2();
+  return access_token;
+}
+var checkToken = async () => {
+  return "";
+};
+robotcloudApi.interceptors.request.use(
+  async (config) => {
+    logger.info("robotcloud api interceptor:", config.url);
+    if (!checkTokenPromise) {
+      checkTokenPromise = refreshToken(checkToken).finally(clearPromise);
+    }
+    const token = await checkTokenPromise;
+    if (!token) {
+      return config;
+    }
+    config.headers.authorization = `Bearer ${token}`;
+    return config;
+  },
+  (error) => {
+    logger.error(error);
+    Promise.reject(error);
+  }
+);
+var robotCloudApi_default = robotcloudApi;
+
+// src/robotCloudClient.ts
+var logger2 = useLogger("robotcloud-client");
+var getProjectDetails = (prjId, params) => {
+  return robotCloudApi_default.get(`projects/${prjId}`, {
+    params
+  });
+};
+
+// src/helpers/robotCloudPermissionsHelper.ts
+var RobotCloudPermissionsHelperImpl = class {
+  async checkProjectAccess(prjId, required_project_access) {
+    const { data: project } = await getProjectDetails(prjId);
+    if (project.access_level == required_project_access) {
+      return true;
+    }
+    switch (required_project_access) {
+      case "ADVANCED":
+        return project.access_level == "ADVANCED";
+      case "BASIC":
+        return project.access_level == "BASIC" || project.access_level == "ADVANCED";
+      case "RESTRICTED":
+        return project.access_level == "RESTRICTED" || project.access_level == "BASIC" || project.access_level == "ADVANCED";
+      case "BLOCKED":
+        return true;
+      default:
+        return false;
+    }
+  }
+};
+var robotCloudPermissionsHelper = new RobotCloudPermissionsHelperImpl();
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  robotCloudPermissionsHelper
+});
+//# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/helpers/index.ts","../../src/utils/logger.ts","../../src/robotCloudApi.ts","../../src/robotCloudClient.ts","../../src/helpers/robotCloudPermissionsHelper.ts"],"sourcesContent":["export { robotCloudPermissionsHelper } from \"helpers/robotCloudPermissionsHelper\";\n\nexport type * from \"../../types/helpers\";","import { createConsola } from \"consola\";\nimport type { ConsolaOptions } from 'consola';\n\nexport function useLogger (tag?: string, options: Partial<ConsolaOptions> = { level: 1000 }) {\n    return tag ? createConsola(options).withTag(tag) : createConsola(options)\n}","import axios from \"axios\"\nimport { useLogger } from 'utils/logger';\n\nconst logger = useLogger(\"robotcloud-api\")\n\nconst robotcloudApi = axios.create();\n\nlet checkTokenPromise: Promise<string | undefined> | null = null;\nconst clearPromise = () => checkTokenPromise = null;\n\nasync function refreshToken(checkToken: () => Promise<string | undefined>) {\n    const access_token = await checkToken();\n    return access_token;\n  }\n\n  \nlet checkToken = async (): Promise<string> => { return ''}\n\n// Important to add interceptor once, inside a middleware are stacked in each request.\nrobotcloudApi.interceptors.request.use(\n    async config => {\n        logger.info(\"robotcloud api interceptor:\", config.url)\n        if (!checkTokenPromise) {\n            checkTokenPromise = refreshToken(checkToken).finally(clearPromise);\n        }\n\n        // When other request is checking token wait for it\n        const token = await checkTokenPromise;\n        if (!token) {\n            return config\n        }\n\n        config.headers.authorization = `Bearer ${token}`;\n        return config;\n    },\n    error => {\n        logger.error(error)\n        Promise.reject(error)\n  });\n\nexport const setCheckTokenFunction = (fun: () => Promise<string>) => {\n    checkToken = fun\n}\n\nexport default robotcloudApi;\n","import type { AxiosResponse } from \"axios\";\n\nimport { useLogger } from 'utils/logger';\nimport robotcloudApi from \"robotCloudApi\";\nimport { AirQuality1AlertEventValue, AirQuality1DataEventValue, LocationServiceInstancesRequestParams, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectRequestParams, ProjectTagRequestParams, RobotCloudDeviceDetails, RobotCloudNamedItem, RobotCloudProject, RobotCloudProjectDetails, RobotCloudServiceType, RobotCloudUserDetails, RoomClime1AlertEventValue, RoomClime1EventValue, RoomClimeInstanceConfigParams, RoomConsumes1AlertEventValue, RoomConsumes1DataEventValue, RoomGrouping1DataEventValue, RoomGrouping1InstanceDeviceConfig, RoomGuestStatus1AlertEventValue, RoomGuestStatus1EventValue, RoomGuestStatusInstanceConfigParams, ServiceDataRequestParams, ServiceInstancesRequestParams } from \"../types/RobotCloudClient\";\nimport { RobotCloudServiceInstance, ServiceInstanceDetails } from \"../types/ServiceInstance\";\nimport { ClassifierDetails } from \"../types/ProjectClassifer\";\nimport { ProjectTag, ProjectTagTreeNode, ProjectTagsTree } from \"../types/ProjectTag\";\nimport { ServiceDataMeasurement } from \"../types/ServiceDataMeasurement\";\n\n\nconst logger = useLogger(\"robotcloud-client\")\n\n\n\ninterface RobotCloudLocationDetails {\n  id: string;\n  name: string;\n  description: string;\n  project: string;\n  tags: string[]\n}\n\nexport const getLocationServiceInstances = (\n  prjId: string,\n  locId: string,\n  service_type: RobotCloudServiceType,\n  params?: LocationServiceInstancesRequestParams\n): Promise<AxiosResponse<RobotCloudServiceInstance[]>> => {\n  return robotcloudApi.get<RobotCloudServiceInstance[]>(`projects/${prjId}/locations/${locId}/services/${service_type}/instances`, {\n    params,\n  });\n}\n\n\n// USERS ENDPOINTS\nexport const getUser = (\n    username: string\n  ): Promise<AxiosResponse<RobotCloudUserDetails>> => {\n    return robotcloudApi.get<RobotCloudUserDetails>(`users/${username}`);\n  };\n\n// PROJECT ENDPOINTS\nexport const getProjects = (\n  params?: ProjectRequestParams\n): Promise<AxiosResponse<RobotCloudProject[]>> => {\n  return robotcloudApi.get<RobotCloudProject[]>(\"projects\", {\n    params\n  });\n};\n\nexport const getProjectDetails = (\n  prjId: string,\n  params?: ProjectDetailsRequestParams\n): Promise<AxiosResponse<RobotCloudProjectDetails>> => {\n  return robotcloudApi.get<RobotCloudProjectDetails>(`projects/${prjId}`, {\n    params,\n  });\n};\n\n// PROJECT SUBSYSTEMS ENDPOINTS\n\nexport const getProjectSubsystem = (\n  prjId: string,\n  subsysId: string\n) => {\n  return robotcloudApi.get<RobotCloudNamedItem>(`projects/${prjId}/subsystems/${subsysId}`);\n}\n\nexport const getLocations = (\n  prjId: string,\n  params?: ProjectLocationsRequestParams\n): Promise<AxiosResponse<RobotCloudNamedItem[]>> => {\n  return robotcloudApi.get<RobotCloudNamedItem[]>(`projects/${prjId}/locations`, {\n    params,\n  });\n};\n\nexport const getLocation = (\n  locationId: string\n): Promise<AxiosResponse<RobotCloudLocationDetails>> => {\n  return robotcloudApi.get<RobotCloudLocationDetails>(`locations/${locationId}`, { });\n};\n\nexport const getServiceInstances = (\n  prjId: string,\n  service_type: string,\n  params?: ServiceInstancesRequestParams\n): Promise<AxiosResponse<RobotCloudServiceInstance[]>> => {\n  return robotcloudApi.get<RobotCloudServiceInstance[]>(`projects/${prjId}/services/${service_type}/instances`, {\n    params,\n  });\n}\n\nexport const getServiceInstance = (\n  prjId: string,\n  service_type: string,\n  service_id: string\n) => {\n  return robotcloudApi.get<ServiceInstanceDetails>(`projects/${prjId}/services/${service_type}/instances/${service_id}`);\n}\n\nexport const getClassifier = (\n  classifierId: string\n) => {\n  return robotcloudApi.get<ClassifierDetails>(`classifiers/${classifierId}`);\n}\n\nexport const getTags = (\n  prjId: string,\n  params?: ProjectTagRequestParams\n): Promise<AxiosResponse<ProjectTag[]>> => {\n    logger.info(`Get project ${prjId} tags`)\n  return robotcloudApi.get<ProjectTag[]>(`projects/${prjId}/tags`, {\n    params,\n  });\n};\n\nexport const getTagsTree = async (\n  prjId: string,\n  maxDepth: number = 2,\n  params?: ProjectTagRequestParams\n): Promise<ProjectTagsTree> => {\n    logger.info(`Get project ${prjId} tags tree`)\n  if (!params) {\n    params = {} as ProjectTagRequestParams  \n  }\n  params.no_parent = true;\n\n  const tags = await getTagsChildren(prjId, 0, undefined, undefined, maxDepth)\n  return {root: tags} as ProjectTagsTree;\n};\n\nexport const getTagsChildren = async (\n  prjId: string,\n  level: number = 0,\n  parent_id?: string,\n  params?: ProjectTagRequestParams,\n  maxDepth?: number\n): Promise<ProjectTagTreeNode[]> => {\n    logger.debug(`Get project ${prjId} tags children: ${parent_id}`)\n  if (!params) {\n    params = {} as ProjectTagRequestParams  \n  }\n  params.no_parent = !parent_id;\n  params.parent_tag = parent_id;\n\n  const tags = await getTags(prjId, params)\n  if (tags.data.length == 0) {\n    return [];\n  }\n  \n  const response: ProjectTagTreeNode[] = []\n  const requests: any[] = []\n  for (let i = 0; i < tags.data.length; i++) {\n    const element = tags.data[i]\n    const node = {\n      tag: element\n    } as ProjectTagTreeNode;\n    response.push(node)\n    if (maxDepth && level < maxDepth) {\n      requests.push(\n        getTagsChildren(prjId, level + 1, element.id, params, maxDepth)\n      )\n    }\n  }\n\n  const responses = await Promise.all(requests)\n  let i = 0;\n  responses.forEach(element => {\n    response[i].children = element\n    i++\n  });\n  \n  return response;\n\n}\n\n/* PROJECT DEVICES ENDPOINTS */\nexport const getDeviceDetails = (\n  deviceId: string,\n): Promise<AxiosResponse<RobotCloudDeviceDetails>> => {\n  return robotcloudApi.get<RobotCloudDeviceDetails>(`devices/${deviceId}`);\n}\n\n/* SERVICES INSTANCES DATA ENDPOINTS */\n\nexport const getRoomClimeServiceData = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1EventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<RoomClime1EventValue>[]>(\n    `/projects/${prjId}/services/RoomClime_1/data`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getRoomGuestStatusServiceData = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<RoomGuestStatus1EventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<RoomGuestStatus1EventValue>[]>(\n    `/projects/${prjId}/services/RoomGuestStatus_1/data`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getAirQualityServiceData = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<AirQuality1DataEventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<AirQuality1DataEventValue>[]>(\n    `/projects/${prjId}/services/AirQuality_1/data`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getRoomGrouping1ServiceData = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>(\n    `/projects/${prjId}/services/RoomGrouping_1/data`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getRoomConsumesServiceData = (\n    prjId: string,\n    params?: ServiceDataRequestParams\n  ): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1DataEventValue>[]>> => {\n    return robotcloudApi.get<ServiceDataMeasurement<RoomConsumes1DataEventValue>[]>(\n      `/projects/${prjId}/services/RoomConsumes_1/data`,\n      { \n        params,\n        headers: {\n          \"Accept\": 'application/json'\n        }\n      }\n    )\n  }\n/* SERVICES INSTANCES ALERTS ENDPOINTS */\n\nexport const getRoomClimeServiceAlert = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<RoomClime1AlertEventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<RoomClime1AlertEventValue>[]>(\n    `/projects/${prjId}/services/RoomClime_1/alert`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getRoomGuestStatusServiceAlert = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<RoomGuestStatus1AlertEventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<RoomGuestStatus1AlertEventValue>[]>(\n    `/projects/${prjId}/services/RoomGuestStatus_1/alert`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getAirQualityServiceAlert = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<AirQuality1AlertEventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<AirQuality1AlertEventValue>[]>(\n    `/projects/${prjId}/services/AirQuality_1/alert`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\nexport const getRoomConsumesServiceAlert = (\n  prjId: string,\n  params?: ServiceDataRequestParams\n): Promise<AxiosResponse<ServiceDataMeasurement<RoomConsumes1AlertEventValue>[]>> => {\n  return robotcloudApi.get<ServiceDataMeasurement<RoomConsumes1AlertEventValue>[]>(\n    `/projects/${prjId}/services/RoomConsumes_1/alert`,\n    { \n      params,\n      headers: {\n        \"Accept\": 'application/json'\n      }\n    }\n  )\n}\n\n/* SERVICES INSTANCES CONFIGURATION ENDPOINTS */\n\nexport const getRoomClimeServiceInstanceConfiguration = (\n  prjId: string,\n  instanceId: string\n): Promise<AxiosResponse<RoomClimeInstanceConfigParams>> => {\n  return robotcloudApi.get<RoomClimeInstanceConfigParams>(\n    `/projects/${prjId}/services/RoomClime_1/instances/${instanceId}/configuration`\n  )\n}\n\nexport const getRoomGuestStatusServiceInstanceConfiguration = (\n  prjId: string,\n  instanceId: string\n): Promise<AxiosResponse<RoomGuestStatusInstanceConfigParams>> => {\n  return robotcloudApi.get<RoomGuestStatusInstanceConfigParams>(\n    `/projects/${prjId}/services/RoomGuestStatus_1/instances/${instanceId}/configuration`\n  )\n}\n\nexport const putRoomClimeServiceInstanceConfiguration = (\n  prjId: string,\n  instanceId: string,\n  data: RoomClimeInstanceConfigParams\n): Promise<AxiosResponse<RoomClimeInstanceConfigParams>> => {\n  return robotcloudApi.put<RoomClimeInstanceConfigParams>(\n    `/projects/${prjId}/services/RoomClime_1/instances/${instanceId}/configuration`,\n    data\n  )\n}\n\nexport const putRoomGuestStatusServiceInstanceConfiguration = (\n  prjId: string,\n  instanceId: string,\n  data: RoomGuestStatusInstanceConfigParams\n): Promise<AxiosResponse<RoomGuestStatusInstanceConfigParams>> => {\n  return robotcloudApi.put<RoomGuestStatusInstanceConfigParams>(\n    `/projects/${prjId}/services/RoomGuestStatus_1/instances/${instanceId}/configuration`,\n    data\n  )\n}\n\n\n/* SERVICES INSTANCES DEVICE INGORMATION ENDPOINTS */\n\n\nexport const getRoomGrouping1InstanceDeviceConfig = (\n  prjId: string,\n  instanceId: string,\n): Promise<AxiosResponse<RoomGrouping1InstanceDeviceConfig>> => {\n  return robotcloudApi.put<RoomGrouping1InstanceDeviceConfig>(\n    `/projects/${prjId}/services/RoomGrouping_1/instances/${instanceId}/configuration`\n  )\n}\n","import * as robotCloudClient from \"robotCloudClient\";\nimport { RobotCloudPermissionsHelper } from \"../../types/helpers\";\nimport { ProjectAccessLevel } from \"../../types/RobotCloudClient\";\n\n\nclass RobotCloudPermissionsHelperImpl implements RobotCloudPermissionsHelper {\n\n    async checkProjectAccess(prjId: string, required_project_access: ProjectAccessLevel): Promise<boolean> {\n\n        const { data: project} = await robotCloudClient.getProjectDetails(prjId)\n        if (project.access_level == required_project_access) {\n            return true\n        }\n\n        switch (required_project_access) {\n            case 'ADVANCED':\n                return project.access_level == 'ADVANCED'\n            case 'BASIC':\n                return project.access_level == 'BASIC' || project.access_level == 'ADVANCED'\n            case 'RESTRICTED':\n                return project.access_level == 'RESTRICTED' || project.access_level == 'BASIC' || \n                        project.access_level == 'ADVANCED'\n            case 'BLOCKED':\n                return true   \n            default:\n                return false\n        }\n        \n    }\n}\n\nexport const robotCloudPermissionsHelper: RobotCloudPermissionsHelper = new RobotCloudPermissionsHelperImpl()"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,qBAA8B;AAGvB,SAAS,UAAW,KAAc,UAAmC,EAAE,OAAO,IAAK,GAAG;AACzF,SAAO,UAAM,8BAAc,OAAO,EAAE,QAAQ,GAAG,QAAI,8BAAc,OAAO;AAC5E;;;ACLA,mBAAkB;AAGlB,IAAM,SAAS,UAAU,gBAAgB;AAEzC,IAAM,gBAAgB,aAAAA,QAAM,OAAO;AAEnC,IAAI,oBAAwD;AAC5D,IAAM,eAAe,MAAM,oBAAoB;AAE/C,eAAe,aAAaC,aAA+C;AACvE,QAAM,eAAe,MAAMA,YAAW;AACtC,SAAO;AACT;AAGF,IAAI,aAAa,YAA6B;AAAE,SAAO;AAAE;AAGzD,cAAc,aAAa,QAAQ;AAAA,EAC/B,OAAM,WAAU;AACZ,WAAO,KAAK,+BAA+B,OAAO,GAAG;AACrD,QAAI,CAAC,mBAAmB;AACpB,0BAAoB,aAAa,UAAU,EAAE,QAAQ,YAAY;AAAA,IACrE;AAGA,UAAM,QAAQ,MAAM;AACpB,QAAI,CAAC,OAAO;AACR,aAAO;AAAA,IACX;AAEA,WAAO,QAAQ,gBAAgB,UAAU,KAAK;AAC9C,WAAO;AAAA,EACX;AAAA,EACA,WAAS;AACL,WAAO,MAAM,KAAK;AAClB,YAAQ,OAAO,KAAK;AAAA,EAC1B;AAAC;AAMH,IAAO,wBAAQ;;;ACjCf,IAAMC,UAAS,UAAU,mBAAmB;AAwCrC,IAAM,oBAAoB,CAC/B,OACA,WACqD;AACrD,SAAO,sBAAc,IAA8B,YAAY,KAAK,IAAI;AAAA,IACtE;AAAA,EACF,CAAC;AACH;;;ACrDA,IAAM,kCAAN,MAA6E;AAAA,EAEzE,MAAM,mBAAmB,OAAe,yBAA+D;AAEnG,UAAM,EAAE,MAAM,QAAO,IAAI,MAAuB,kBAAkB,KAAK;AACvE,QAAI,QAAQ,gBAAgB,yBAAyB;AACjD,aAAO;AAAA,IACX;AAEA,YAAQ,yBAAyB;AAAA,MAC7B,KAAK;AACD,eAAO,QAAQ,gBAAgB;AAAA,MACnC,KAAK;AACD,eAAO,QAAQ,gBAAgB,WAAW,QAAQ,gBAAgB;AAAA,MACtE,KAAK;AACD,eAAO,QAAQ,gBAAgB,gBAAgB,QAAQ,gBAAgB,WAC/D,QAAQ,gBAAgB;AAAA,MACpC,KAAK;AACD,eAAO;AAAA,MACX;AACI,eAAO;AAAA,IACf;AAAA,EAEJ;AACJ;AAEO,IAAM,8BAA2D,IAAI,gCAAgC;","names":["axios","checkToken","logger"]}

package/dist/helpers/index.mjs

@@ -0,0 +1,73 @@
+// src/utils/logger.ts
+import { createConsola } from "consola";
+function useLogger(tag, options = { level: 1e3 }) {
+  return tag ? createConsola(options).withTag(tag) : createConsola(options);
+}
+
+// src/robotCloudApi.ts
+import axios from "axios";
+var logger = useLogger("robotcloud-api");
+var robotcloudApi = axios.create();
+var checkTokenPromise = null;
+var clearPromise = () => checkTokenPromise = null;
+async function refreshToken(checkToken2) {
+  const access_token = await checkToken2();
+  return access_token;
+}
+var checkToken = async () => {
+  return "";
+};
+robotcloudApi.interceptors.request.use(
+  async (config) => {
+    logger.info("robotcloud api interceptor:", config.url);
+    if (!checkTokenPromise) {
+      checkTokenPromise = refreshToken(checkToken).finally(clearPromise);
+    }
+    const token = await checkTokenPromise;
+    if (!token) {
+      return config;
+    }
+    config.headers.authorization = `Bearer ${token}`;
+    return config;
+  },
+  (error) => {
+    logger.error(error);
+    Promise.reject(error);
+  }
+);
+var robotCloudApi_default = robotcloudApi;
+
+// src/robotCloudClient.ts
+var logger2 = useLogger("robotcloud-client");
+var getProjectDetails = (prjId, params) => {
+  return robotCloudApi_default.get(`projects/${prjId}`, {
+    params
+  });
+};
+
+// src/helpers/robotCloudPermissionsHelper.ts
+var RobotCloudPermissionsHelperImpl = class {
+  async checkProjectAccess(prjId, required_project_access) {
+    const { data: project } = await getProjectDetails(prjId);
+    if (project.access_level == required_project_access) {
+      return true;
+    }
+    switch (required_project_access) {
+      case "ADVANCED":
+        return project.access_level == "ADVANCED";
+      case "BASIC":
+        return project.access_level == "BASIC" || project.access_level == "ADVANCED";
+      case "RESTRICTED":
+        return project.access_level == "RESTRICTED" || project.access_level == "BASIC" || project.access_level == "ADVANCED";
+      case "BLOCKED":
+        return true;
+      default:
+        return false;
+    }
+  }
+};
+var robotCloudPermissionsHelper = new RobotCloudPermissionsHelperImpl();
+export {
+  robotCloudPermissionsHelper
+};
+//# sourceMappingURL=index.mjs.map