@docbrasil/api-systemmanager 1.1.22 → 1.1.24

package/api/admin/form.js

@@ -47,6 +47,32 @@ class AdminForm {
     };
   }
 
+   /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the types for forms
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.form.findById(params, session);
+   */
+   get types() {
+    return {
+       BUSINESS: 1,
+       ADVANCED: 2,
+       CHECKLIST: 3,
+       EXTERNAL: 4
+    };
+   }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get advance form by ID
@@ -122,7 +148,6 @@ class AdminForm {
       Joi.assert(params.sort, Joi.object(), 'Sort fields for');
       Joi.assert(session, Joi.string().required(), 'Session, token JWT');
 
-      const FORM_ADVANCED = 2;
       const PROJECTION_DEFAULT = {_id: 1, name: 1};
       const SORT_DEFAULT = {name: 1};
 
@@ -130,7 +155,7 @@ class AdminForm {
         orgId,
         page = 1,
         perPage = 200,
-        type = FORM_ADVANCED,
+        type = self.types.ADVANCED,
         project = PROJECTION_DEFAULT,
         sort = SORT_DEFAULT
       } = params;

package/api/admin/user.js

@@ -272,6 +272,61 @@ class AdminUser {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Request signed url url to put or get
+   * @param {object} params - Params to get form list
+   * @param {number} params.page=1 - Page of pagination
+   * @param {number} params.perPage=200 - Items per page
+   * @param {object} params.project={_id: 1, name: 1} - Fields to project
+   * @param {object} params.sort={name: 1} - Sort fields
+   * @param {string} session - Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  project: {_id: 1, name: 1, orgId: 1, orgIds: 1},
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.form.getUserList(params, session);
+   */
+  async getUserList(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to get form list');
+      Joi.assert(params.page, Joi.number(), 'Page of pagination');
+      Joi.assert(params.perPage, Joi.number(), 'Items per page');
+      Joi.assert(params.project, Joi.object(), 'Fields to project');
+      Joi.assert(params.sort, Joi.object(), 'Sort fields for');
+      Joi.assert(session, Joi.string().required(), 'Session, token JWT');
+
+      const PROJECTION_DEFAULT = {_id: 1, name: 1};
+      const SORT_DEFAULT = {name: 1};
+
+      const {
+        page = 1,
+        perPage = 200,
+        project = PROJECTION_DEFAULT,
+        sort = SORT_DEFAULT
+      } = params;
+
+      const payloadToSend = {$project: project, sort};
+
+      const apiCall = self._client
+          .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default AdminUser;

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/api/user/user.js

@@ -289,7 +289,6 @@ class User {
    * @param {object} query={} The query, if any, to add to the JWT token
    * @param {array<string>} query.orgIds An array of orgIds that we want to filter by
    * @param {array<string>} query.orgProcessIds An array of orgProcessId that we want to filter by
-   * @param {array<string>} query.tags An array of org processes tags that we want to filter by
    * @param {date} query.startDate The start date in ISO format that we want to filter by
    * @param {date} query.endDate The start date in ISO format that we want to filter by
    * @param {string} session Is token JWT of user NOT allow SU

package/dist/bundle.cjs

@@ -3121,7 +3121,6 @@ class User {
    * @param {object} query={} The query, if any, to add to the JWT token
    * @param {array<string>} query.orgIds An array of orgIds that we want to filter by
    * @param {array<string>} query.orgProcessIds An array of orgProcessId that we want to filter by
-   * @param {array<string>} query.tags An array of org processes tags that we want to filter by
    * @param {date} query.startDate The start date in ISO format that we want to filter by
    * @param {date} query.endDate The start date in ISO format that we want to filter by
    * @param {string} session Is token JWT of user NOT allow SU
@@ -10447,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());
@@ -11003,6 +11002,8 @@ class Settings {
   }
 }
 
+var Dashboard = Help;
+
 /**
  * @class API request, user permission level
  */
@@ -11028,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);
   }
 }
 
@@ -11405,6 +11407,32 @@ class AdminForm {
     };
   }
 
+   /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get the types for forms
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  id: '55e4a3bd6be6b45210833fae',
+   *  orgId: '5edd11c46b6ce9729c2c297c',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.form.findById(params, session);
+   */
+   get types() {
+    return {
+       BUSINESS: 1,
+       ADVANCED: 2,
+       CHECKLIST: 3,
+       EXTERNAL: 4
+    };
+   }
+
   /**
    * @author Myndware <augusto.pissarra@myndware.com>
    * @description Get advance form by ID
@@ -11480,7 +11508,6 @@ class AdminForm {
       Joi__default["default"].assert(params.sort, Joi__default["default"].object(), 'Sort fields for');
       Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session, token JWT');
 
-      const FORM_ADVANCED = 2;
       const PROJECTION_DEFAULT = {_id: 1, name: 1};
       const SORT_DEFAULT = {name: 1};
 
@@ -11488,7 +11515,7 @@ class AdminForm {
         orgId,
         page = 1,
         perPage = 200,
-        type = FORM_ADVANCED,
+        type = self.types.ADVANCED,
         project = PROJECTION_DEFAULT,
         sort = SORT_DEFAULT
       } = params;
@@ -12436,6 +12463,61 @@ class AdminUser {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Request signed url url to put or get
+   * @param {object} params - Params to get form list
+   * @param {number} params.page=1 - Page of pagination
+   * @param {number} params.perPage=200 - Items per page
+   * @param {object} params.project={_id: 1, name: 1} - Fields to project
+   * @param {object} params.sort={name: 1} - Sort fields
+   * @param {string} session - Session, token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params - {
+   *  project: {_id: 1, name: 1, orgId: 1, orgIds: 1},
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.user.form.getUserList(params, session);
+   */
+  async getUserList(params, session) {
+    const self = this;
+
+    try {
+      Joi__default["default"].assert(params, Joi__default["default"].object().required(), 'Params to get form list');
+      Joi__default["default"].assert(params.page, Joi__default["default"].number(), 'Page of pagination');
+      Joi__default["default"].assert(params.perPage, Joi__default["default"].number(), 'Items per page');
+      Joi__default["default"].assert(params.project, Joi__default["default"].object(), 'Fields to project');
+      Joi__default["default"].assert(params.sort, Joi__default["default"].object(), 'Sort fields for');
+      Joi__default["default"].assert(session, Joi__default["default"].string().required(), 'Session, token JWT');
+
+      const PROJECTION_DEFAULT = {_id: 1, name: 1};
+      const SORT_DEFAULT = {name: 1};
+
+      const {
+        page = 1,
+        perPage = 200,
+        project = PROJECTION_DEFAULT,
+        sort = SORT_DEFAULT
+      } = params;
+
+      const payloadToSend = {$project: project, sort};
+
+      const apiCall = self._client
+          .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 /**