@docbrasil/api-systemmanager 1.1.70 → 1.1.72

package/api/user/dashboard.js

@@ -123,6 +123,88 @@ class Chart {
   }
 }
 
+/**
+ * Class user access to reports
+ * @class
+ */
+class Report {
+  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 report
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.type Type of the report data
+   * @param {object} params.query The query if any (to search documents)
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  type: '[REPORTS] Myndie:vat_data',
+   *  query: { ... } // the last query to search documents
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.dashboard.report.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/report/data/${type}`, query, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
 /**
  * Class user access to dashboards
  * @class
@@ -137,6 +219,7 @@ class Dashboard {
     self.parent = options.parent;
     self._client = self.parent.dispatch.getClient();
     self._chart = new Chart(options);
+    self._report = new Report(options);
   }
 
   /**
@@ -173,18 +256,21 @@ class Dashboard {
    * @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;
   }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description return the report
+   * @public
+   */
+  get report() {
+    const self = this;
+    return self._report;
+  }
 }
 
 export default Dashboard;

package/dist/bundle.cjs

@@ -11869,6 +11869,88 @@ class Chart {
   }
 }
 
+/**
+ * Class user access to reports
+ * @class
+ */
+class Report {
+  constructor(options) {
+    Joi__default["default"].assert(options, Joi__default["default"].object().required());
+    Joi__default["default"].assert(options.parent, Joi__default["default"].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__default["default"].badRequest(___default["default"].get(retData, 'message', 'No error message reported!'))
+    } else {
+      return ___default["default"].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 report
+   * @param {object} params Params to get helps from topic
+   * @param {object} params.type Type of the report data
+   * @param {object} params.query The query if any (to search documents)
+   * @param {string} session Session, token JWT
+   * @returns {promise}
+   * @public
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  type: '[REPORTS] Myndie:vat_data',
+   *  query: { ... } // the last query to search documents
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.dashboard.report.getData(params, session);
+   */
+  async getData(params, session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to helps from a topic');
+      Joi__default["default"].assert(params.type, Joi__default["default"].string().required(), 'Type of graph');
+      Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session token JWT');
+
+      const { type, query = {} } = params;
+      const apiCall = self._client.post(`/organizations/dashboard/report/data/${type}`, query, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+
 /**
  * Class user access to dashboards
  * @class
@@ -11883,6 +11965,7 @@ class Dashboard {
     self.parent = options.parent;
     self._client = self.parent.dispatch.getClient();
     self._chart = new Chart(options);
+    self._report = new Report(options);
   }
 
   /**
@@ -11919,18 +12002,21 @@ class Dashboard {
    * @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;
   }
+
+  /**
+   * @author Augusto Pissarra <abernardo.br@gmail.com>
+   * @description return the report
+   * @public
+   */
+  get report() {
+    const self = this;
+    return self._report;
+  }
 }
 
 /**