npm - @docbrasil/api-systemmanager - Versions diffs - 1.0.106 → 1.0.108 - Mend

@docbrasil/api-systemmanager 1.0.106 → 1.0.108

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 (76) hide show

package/.github/workflows/static.yml +43 -0
package/api/external.js +41 -0
package/api/user/process.js +44 -0
package/api/user/task.js +1 -0
package/api/user/task_available.js +1 -1
package/dist/bundle.cjs +87 -1
package/dist/bundle.mjs +1 -1
package/doc/api.md +412 -1
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 +1203 -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/admin_task.js.html ADDED Viewed

@@ -0,0 +1,242 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> admin/task.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>admin/task.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+/**
+ * Admin Class for task, permission admin
+ * @class
+ */
+class AdminTask {
+  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) {
+      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,
+      }
+    };
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Get filter to search tasks
+   * @param {string} filter Filter type
+   * @return {*}
+   * @private
+   */
+  _taskFilters(filter) {
+    const taskFilters = {
+      CLEAN: 1,
+      EXECUTED: 2,
+      PENDING: 3,
+      LATE: 4,
+      NOT_DONE: 5,
+      DONE: 6
+    };
+    return _.get(taskFilters, filter, 'NOT_DONE');
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Get task by user Id
+   * @param {object} params Params to get task
+   * @param {string} params.userId User id (_id database)
+   * @param {string} [params.filter=NOT_DONE] Filter type CLEAN | EXECUTED | PENDING | LATE | NOT_DONE | DONE
+   * @param {object} params.project Project to return
+   * @param {boolean} params.project.returnProcessProperties Return process properties
+   * @param {boolean} params.project.returnInitParams Return init params
+   * @param {string} params.userId User id (_id database)
+   * @param {boolean} [params.includeOwner=false] Include owner true | false
+   * @param {string} session Session, token JWT
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  userId: '55e4a3bd6be6b45210833fae',
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.task.find(params, session);
+   */
+  async find(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.userId, Joi.string().required());
+      Joi.assert(params.filter, Joi.string());
+      Joi.assert(params.project, Joi.object());
+      Joi.assert(params.includeOwner, Joi.boolean());
+      Joi.assert(session, Joi.string().required());
+      const filterType = _.get(params, 'filter', 'NOT_DONE') || 'NOT_DONE';
+      const includeOwner = _.get(params, 'includeOwner', false) || false;
+      const {userId} = params;
+      const filter = self._taskFilters(filterType);
+      const { returnProcessProperties, returnInitParams } = params?.project ?? {};
+      let queryString = `taskFilter=${filter}&amp;includeOwner=${includeOwner}`;
+      if (returnProcessProperties) queryString = `${queryString}&amp;returnProcessProperties=${returnProcessProperties}`;
+      if (returnInitParams) queryString = `${queryString}&amp;returnInitParams=${returnInitParams}`;
+      const apiCall = self._client.get(`/admin/users/${userId}/tasks?${queryString}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default AdminTask;
+</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/admin_user.js.html ADDED Viewed

@@ -0,0 +1,302 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> admin/user.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>admin/user.js</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _ from 'lodash';
+import Boom from '@hapi/boom';
+import Joi from 'joi';
+/**
+ * Admin Class for user, permission admin
+ * @class
+ */
+class AdminUser {
+  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 CloudBrasil &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,
+      }
+    };
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Request profile by userId
+   * @param {string} userId User identifier (_id database)
+   * @param {string} session Is token JWT
+   * @return {Promise}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.findById(userId, session);
+   */
+  async findById(userId, session) {
+    const self = this;
+    try {
+      Joi.assert(userId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const apiCall = self.client.get(`/admin/users/${userId}`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author CloudBrasil &lt;abernardo.br@gmail.com>
+   * @description Update password by userId
+   * @param {object} params Params to update password
+   * @param {string} params.userId Id of the user
+   * @param {string} params.oldPassword Old password
+   * @param {string} params.newPassword New password
+   * @param {string} session Is token JWT
+   * @return {Promise&lt;unknown>}
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *  userId: '55e4a3bd6be6b45210833fae',
+   *  oldPassword: '123456',
+   *  newPassword: '123456789'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.findByIdAndUpdatePassword(params, session);
+   */
+  async findByIdAndUpdatePassword(params, session) {
+    const self = this;
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.userId, Joi.string().required());
+      Joi.assert(params.oldPassword, Joi.string().required());
+      Joi.assert(params.newPassword, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+      const {userId, ...payload} = params;
+      const apiCall = self.client.put(`/admin/users/${userId}/password`, payload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @author Thiago Anselmo &lt;thiagoo.anselmoo@gmail.com>
+   * @description Check if email is unique
+   * @param {string} email Check if email is unique
+   * @param {string} session Is token JWT
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const email = 'ana.silva@gmail.com';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.emailExist(email, session);
+   */
+  async emailExist(email, session) {
+    const self = this;
+    try {
+      Joi.assert(email, Joi.string().email().required());
+      Joi.assert(session, Joi.string().required());
+      const payload = {email};
+      const apiCall = self.client.post(`/admin/users/email/exist`, payload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+  /**
+   * @description update userData by userSMId
+   * @param {string} userId - User SM Id
+   * @param {object} payload - Payload to update
+   * @param {string} session - Is token JWT
+   * @returns {Promise&lt;*>}
+   * @async
+   * @public
+   * @example
+   *
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const payload = {
+   *   name: 'Maria joaquina',
+   *   email: 'maria@gmail.com'
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   */
+  async findByIdAndUpdate(userId, payload, session) {
+    const self = this;
+    try {
+      Joi.assert(userId, Joi.string().required(), 'User id of SM');
+      Joi.assert(payload, Joi.object().required(), 'Payload to update');
+      Joi.assert(session, Joi.string().required(), 'Session user admin');
+      const apiCall = self.client.put(`/admin/users/${userId}`, payload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+}
+export default AdminUser;
+</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>