@docbrasil/api-systemmanager 1.1.23 → 1.1.24

package/api/user/dashboard.js

@@ -0,0 +1,150 @@
+import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+
+/**
+ * Class user access to charts
+ * @class
+ */
+class Chart {
+  constructor(options) {
+    Joi.assert(options, Joi.object().required());
+    Joi.assert(options.parent, Joi.object().required());
+
+    const self = this;
+    self.parent = options.parent;
+    self._client = self.parent.dispatch.getClient();
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description Get the return data and check for errors
+   * @param {object} retData Response HTTP
+   * @return {*}
+   * @private
+   */
+  _returnData(retData, def = {}) {
+    if (retData.status !== 200) {
+      return Boom.badRequest(_.get(retData, 'message', 'No error message reported!'))
+    } else {
+      return _.get(retData, 'data', def);
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Set header with new session
+   * @param {string} session Session, token JWT
+   * @return {object} header with new session
+   * @private
+   */
+  _setHeader(session) {
+    return {
+      headers: {
+        authorization: session,
+      }
+    };
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the data for a chart
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.type Type of the chart data
+   * @param {object} params.query The query if any
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  type: 'heatmap_data'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.dashboard.chart.getData(params, session);
+   */
+  async getData(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to helps from a topic');
+      Joi.assert(params.type, Joi.string().required(), 'Type of graph');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const { type, query = {} } = params;
+      const apiCall = self._client.post(`/organizations/dashboard/chart/data/${type}`, query, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
+/**
+ * Class user access to dashboards
+ * @class
+ */
+class Dashboard {
+
+  constructor(options) {
+    Joi.assert(options, Joi.object().required());
+    Joi.assert(options.parent, Joi.object().required());
+
+    const self = this;
+    self.parent = options.parent;
+    self._client = self.parent.dispatch.getClient();
+    self._chart = new Chart(options);
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description Get the return data and check for errors
+   * @param {object} retData Response HTTP
+   * @return {*}
+   * @private
+   */
+  _returnData(retData, def = {}) {
+    if (retData.status !== 200) {
+      return Boom.badRequest(_.get(retData, 'message', 'No error message reported!'))
+    } else {
+      return _.get(retData, 'data', def);
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Set header with new session
+   * @param {string} session Session, token JWT
+   * @return {object} header with new session
+   * @private
+   */
+  _setHeader(session) {
+    return {
+      headers: {
+        authorization: session,
+      }
+    };
+  }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description return the chart
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.help.getTopics({}, session);
+   */
+    get chart() {
+      const self = this;
+      return self._chart;
+  }
+}
+
+export default Help;

package/api/user/index.js

@@ -13,6 +13,7 @@ import Help from './help.js';
 import Datasource from './datasource.js';
 import Application from './application.js';
 import Settings from './settings.js';
+import Dashboard from './dashboard.js';
 
 /**
  * @class API request, user permission level
@@ -41,6 +42,7 @@ class Users {
     self.updates = new Updates(options);
     self.help = new Help(options);
     self.application = new Application(options);
+    self.dashboard = new Dashboard(options);
   }
 }
 

package/dist/bundle.cjs

@@ -10446,7 +10446,7 @@ class Updates {
  * Class for user registration in a user
  * @class
  */
-class Help {
+class Help$1 {
 
   constructor(options) {
     Joi__default["default"].assert(options, Joi__default["default"].object().required());
@@ -11002,6 +11002,8 @@ class Settings {
   }
 }
 
+var Dashboard = Help;
+
 /**
  * @class API request, user permission level
  */
@@ -11027,8 +11029,9 @@ class Users {
     self.register = new Register(options);
     self.notification = new Notification(options);
     self.updates = new Updates(options);
-    self.help = new Help(options);
+    self.help = new Help$1(options);
     self.application = new Application(options);
+    self.dashboard = new Dashboard(options);
   }
 }