npm - @docbrasil/api-systemmanager - Versions diffs - 1.0.107 → 1.0.109 - Mend

@docbrasil/api-systemmanager 1.0.107 → 1.0.109

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

package/.github/workflows/static.yml +43 -0
package/api/external.js +41 -0
package/dist/bundle.cjs +41 -0
package/dist/bundle.mjs +1 -1
package/doc/api.md +382 -0
package/docs/Admin.html +336 -0
package/docs/AdminDocuments.html +2235 -0
package/docs/AdminForm.html +934 -0
package/docs/AdminLists.html +895 -0
package/docs/AdminMessage.html +1490 -0
package/docs/AdminNotification.html +1636 -0
package/docs/AdminPlugin.html +696 -0
package/docs/AdminPolicy.html +451 -0
package/docs/AdminProcesses.html +692 -0
package/docs/AdminTask.html +740 -0
package/docs/AdminUser.html +1203 -0
package/docs/Datasource.html +660 -0
package/docs/Dispatch.html +624 -0
package/docs/Documents.html +4875 -0
package/docs/External.html +1497 -0
package/docs/GeoLocation.html +503 -0
package/docs/Login.html +1839 -0
package/docs/Notification.html +625 -0
package/docs/Organization.html +2767 -0
package/docs/Process.html +1598 -0
package/docs/Register.html +1604 -0
package/docs/Session.html +482 -0
package/docs/Task.html +1394 -0
package/docs/TaskAvailable.html +893 -0
package/docs/User.html +2002 -0
package/docs/Users.html +569 -0
package/docs/admin_doctypes.js.html +193 -0
package/docs/admin_document.js.html +449 -0
package/docs/admin_form.js.html +268 -0
package/docs/admin_index.js.html +163 -0
package/docs/admin_list.js.html +250 -0
package/docs/admin_message.js.html +311 -0
package/docs/admin_notification.js.html +350 -0
package/docs/admin_organization.js.html +241 -0
package/docs/admin_plugin.js.html +233 -0
package/docs/admin_policy.js.html +195 -0
package/docs/admin_processes.js.html +487 -0
package/docs/admin_task.js.html +242 -0
package/docs/admin_user.js.html +302 -0
package/docs/dispatch.js.html +218 -0
package/docs/external.js.html +333 -0
package/docs/general_geoLocation.js.html +205 -0
package/docs/general_index.js.html +140 -0
package/docs/index.html +129 -0
package/docs/login.js.html +384 -0
package/docs/scripts/app.min.js +1 -0
package/docs/scripts/linenumber.js +26 -0
package/docs/scripts/search.js +39 -0
package/docs/session.js.html +202 -0
package/docs/styles/app.min.css +1 -0
package/docs/styles/iframe.css +13 -0
package/docs/styles/prettify-jsdoc.css +111 -0
package/docs/styles/prettify-tomorrow.css +132 -0
package/docs/styles/reset.css +44 -0
package/docs/user_datasource.js.html +261 -0
package/docs/user_document.js.html +847 -0
package/docs/user_index.js.html +156 -0
package/docs/user_notification.js.html +218 -0
package/docs/user_organization.js.html +347 -0
package/docs/user_process.js.html +352 -0
package/docs/user_register.js.html +322 -0
package/docs/user_task.js.html +319 -0
package/docs/user_task_available.js.html +252 -0
package/docs/user_user.js.html +404 -0
package/docs/utils_promises.js.html +235 -0
package/package.json +7 -4
package/readme.md +7 -8
package/doc.md +0 -653

package/docs/login.js.html ADDED Viewed

@@ -0,0 +1,384 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> login.js</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Source</p>
+                    <h1>login.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Joi from 'joi';
+/**
+ * @class Login manager
+ */
+class Login {
+  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 &lt;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) {
+      throw Boom.badRequest(_.get(retData, 'message', 'No error message reported!'))
+    } else {
+      return _.get(retData, 'data', def);
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.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 CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Login with social login Facebook
+   * @param {object} params Params to login Facebook
+   * @param {string} params.accessToken Access token of the system manager
+   * @param {object} params.initialUserData Object with roles default if sigin
+   * @param {array} params.initialUserData.externalRoles Array with permission of user
+   * @return {promise&lt;object>} data
+   * @return {object} data.auth true or false if we have the user authenticaited correctly
+   * @return {object} data.user the logged user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const params = { accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cC...' };
+   * const { auth, user } = await api.login.facebook(params);
+   */
+  async facebook(params) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to login Facebook');
+      Joi.assert(params.accessToken, Joi.string().required(), 'Access token of the system manager');
+      if (_.hasIn(params, 'initialUserData')) {
+        Joi.assert(params.initialUserData, Joi.object().required(), 'Object with roles default if sigin');
+        Joi.assert(params.initialUserData.externalRoles, Joi.array().required(), 'Array with permission of user');
+      }
+      const apiCall = self._client.post('/login/facebook', params);
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Login with social login Google
+   * @param {object} params Params to login Google
+   * @param {string} params.accessToken Access token of the system manager
+   * @param {object} params.initialUserData Object with roles default if sigin
+   * @param {array} params.initialUserData.externalRoles Array with permission of user
+   * @return {promise&lt;object>} data
+   * @return {object} data.auth true or false if we have the user authenticaited correctly
+   * @return {object} data.user the logged user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const accessToken = 'eyJhbGciOiJIUzI1NiIsInR5cC...';
+   * const { auth, user } = await api.login.google(accessToken);
+   */
+  async google(params) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to login Google');
+      Joi.assert(params.accessToken, Joi.string().required(), 'Access token of the system manager');
+      if (_.hasIn(params, 'initialUserData')) {
+        Joi.assert(params.initialUserData, Joi.object().required(), 'Object with roles default if sigin');
+        Joi.assert(params.initialUserData.externalRoles, Joi.array().required(), 'Array with permission of user');
+      }
+      const apiCall = self._client.post('/login/google', params);
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Login with apikey
+   * @param {string} apikey Access key
+   * @return {promise&lt;object>} data
+   * @return {object} data.auth true or false if we have the user authenticaited correctly
+   * @return {object} data.user the logged user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const apiKey = '043a0eb2-f5c3-4900-b781-7f229d00d092';
+   * const { auth, user } = await api.login.apiKey(apiKey);
+   */
+  async apiKey(apiKey) {
+    const self = this;
+    try {
+      Joi.assert(apiKey, Joi.string().required());
+      const apiCall = self._client.post('/login/api', {apiKey});
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Login with user and password
+   * @param {object} params Object with user and password
+   * @param {string} params.username Username or email of the user
+   * @param {string} params.password Password of the user
+   * @param {string} params.orgname The organame of the user
+   * @return {promise&lt;object>} data
+   * @return {object} data.auth true or false if we have the user authenticaited correctly
+   * @return {object} data.user the logged user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const params = {
+   *   username: 'ana.silva@gmail.com',
+   *   password: '123456'
+   * };
+   * const { auth, user } = await api.login.userPass(params);
+   */
+  async userPass(params) {
+    const self = this;
+    try {
+      Joi.assert(params.username, Joi.string().required());
+      Joi.assert(params.password, Joi.string().required());
+      const { orgname = '' } = params;
+      let url;
+      if(orgname !== '') {
+        url = `/login/${orgname}`;
+      } else {
+        url = `/login`;
+      }
+      const apiCall = self._client.post(url, params);
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Logout user system manager
+   * @param {string} session Session, token JWT
+   * @return {promise&lt;object>}} data
+   * @return {boolean} data.success true|false
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const { success } = await api.login.logout(session);
+   */
+  async logout(session) {
+    const self = this;
+    try {
+      Joi.assert(session, Joi.string().required());
+      const apiCall = self._client.get('/logout', self._setHeader(session));
+      const { response = 'NOT_OK' } = self._returnData(await apiCall);
+      return response === 'OK';
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Recover the password
+   * @param {string} username The username or email
+   * @return {promise&lt;object>}} data
+   * @return {boolean} data.success true|false
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   *
+   * // Params of the instance
+   * const params = {...}
+   * const api = new API(params);
+   * const { success } = await api.login.recover('myusername');
+   */
+  async recover(username) {
+    const self = this;
+    try {
+      Joi.assert(username, Joi.string().required());
+      const url = `users/${username}/sendResetEmail`;
+      const apiCall = self._client.get(url);
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default Login;
+</code></pre>
+        </article>
+    </section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

package/docs/scripts/app.min.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";$().ready(function(){});var sidebarIsVisible=!1,toggleSidebar=function(e){var a=!(0<arguments.length&&void 0!==e)||e;$("#sidebarNav").toggleClass("sticky",a),$("#stickyNavbarOverlay").toggleClass("active",a),$("#hamburger").toggleClass("is-active"),sidebarIsVisible=a};$().ready(function(){$("#hamburger").click(function(){toggleSidebar(!sidebarIsVisible)}),$("#stickyNavbarOverlay").click(function(){sidebarIsVisible&&toggleSidebar(!1)})});var OFFSET=150;$().ready(function(){var o=$("#side-nav"),c=[];if($(".vertical-section").length||o.hide(),$(".vertical-section").each(function(e,a){var i=$(a),t=i.find("> h1").text();if(t){o.append($("<h3/>").text(t));var s=$("<ul></ul>");i.find(".members h4.name").each(function(e,a){var i=$(a),t=i.find(".code-name").clone().children().remove().end().text(),n=i.find("a").attr("href"),r=$('<a href="'.concat(n,'" />')).text(t);s.append($("<li></li>").append(r)),c.push({link:r,offset:i.offset().top})}),o.append(s)}else i.find(".members h4.name").each(function(e,a){var i=$(a),t=i.find(".code-name").clone().children().remove().end().text(),n=i.find("a").attr("href"),r=$('<a href="'.concat(n,'" />')).text(t);o.append(r),c.push({link:r,offset:i.offset().top})})}),!$.trim(o.text()))return o.hide();function e(){for(var e=n.scrollTop(),a=!1,i=c.length-1;0<=i;i--){var t=c[i];t.link.removeClass("is-active"),e+OFFSET>=t.offset?a?t.link.addClass("is-past"):(t.link.addClass("is-active"),a=!0):t.link.removeClass("is-past")}}var n=$("#main-content-wrapper");n.on("scroll",e),e(),c.forEach(function(e){e.link.click(function(){n.animate({scrollTop:e.offset-OFFSET+1},500)})})}),$().ready(function(){$("#sidebarNav a").each(function(e,a){var i=$(a).attr("href");window.location.pathname.match("/"+i)&&($(a).addClass("active"),$("#sidebarNav").scrollTop($(a).offset().top-150))})});

package/docs/scripts/linenumber.js ADDED Viewed

@@ -0,0 +1,26 @@
+/*global document */
+(function() {
+    var source = document.getElementsByClassName('prettyprint source linenums');
+    var i = 0;
+    var lineNumber = 0;
+    var lineId;
+    var lines;
+    var totalLines;
+    var anchorHash;
+    if (source && source[0]) {
+        anchorHash = document.location.hash.substring(1);
+        lines = source[0].getElementsByTagName('li');
+        totalLines = lines.length;
+        for (; i < totalLines; i++) {
+            lineNumber++;
+            lineId = 'line' + lineNumber;
+            lines[i].id = lineId;
+            if (lineId === anchorHash) {
+                lines[i].className += ' selected';
+            }
+        }
+    }
+})();

package/docs/scripts/search.js ADDED Viewed

@@ -0,0 +1,39 @@
+(function() {
+  const input = document.querySelector('#search')
+  const targets = [ ...document.querySelectorAll('#sidebarNav li')]
+  input.addEventListener('keyup', () => {
+    // loop over each targets and hide the not corresponding ones
+    targets.forEach(target => {
+      if (!target.innerText.toLowerCase().includes(input.value.toLowerCase())) {
+        target.style.display = 'none'
+        /**
+         * Detects an empty list
+         * Remove the list and the list's title if the list is not displayed
+         */
+        const list = [...target.parentNode.childNodes].filter( elem => elem.style.display !== 'none')
+        if (!list.length) {
+          target.parentNode.style.display = 'none'
+          target.parentNode.previousSibling.style.display = 'none'
+        }
+        /**
+         * Detects empty category
+         * Remove the entire category if no item is displayed
+         */
+        const category = [...target.parentNode.parentNode.childNodes]
+          .filter( elem => elem.tagName !== 'H2' && elem.style.display !== 'none')
+        if (!category.length) {
+          target.parentNode.parentNode.style.display = 'none'
+        }
+      } else {
+        target.parentNode.style.display = 'block'
+        target.parentNode.previousSibling.style.display = 'block'
+        target.parentNode.parentNode.style.display = 'block'
+        target.style.display = 'block'
+      }
+    })
+  })
+})()

package/docs/session.js.html ADDED Viewed

@@ -0,0 +1,202 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> session.js</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Login.html">Login</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Source</p>
+                    <h1>session.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Joi from 'joi';
+import Boom from '@hapi/boom';
+/**
+ * @class Session manager of the API
+ */
+class Session {
+  constructor(options) {
+    Joi.assert(options, Joi.object().required());
+    Joi.assert(options.parent, Joi.object().required());
+    const self = this;
+    self._session;
+    self._userData;
+    self.parent = options.parent;
+    self._client = self.parent.dispatch.getClient();
+  }
+  /**
+   * @author Augusto Pissarra &lt;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 CloudBrasil &lt;abernardo.br@gmail.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,
+      }
+    };
+  }
+  /**
+   * @description Show information for session, thus validating the session (Valid token JWT)
+   * @param {string} sessionId The user session (JWT Token)
+   * @param {string} suSessionId=sessionId Given a JWT Token of a SU (SuperAdmin), allow to check session for another user.
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const sessionId = 'eyJhbFVBBiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const suSessionId = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.session.information(sessionId, suSessionId);
+   *
+   */
+  async information(sessionId, suSessionId = null) {
+    const self = this;
+    try {
+      Joi.assert(sessionId, Joi.string().required());
+      // if not provided, just use the same sessionId
+      suSessionId = suSessionId || sessionId;
+      const apiCall = self._client.get(`session?token=${sessionId}`, self._setHeader(suSessionId));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default Session;
+</code></pre>
+        </article>
+    </section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>