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/AdminTask.html ADDED Viewed

@@ -0,0 +1,740 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> AdminTask</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>Class</p>
+                    <h1>AdminTask</h1>
+                </header>
+<section>
+<header>
+        <h2><span class="attribs"><span class="type-signature"></span></span>AdminTask<span class="signature">()</span><span class="type-signature"></span></h2>
+            <div class="class-description">Admin Class for task, permission admin</div>
+</header>
+<article>
+    <div class="container-overview">
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        <div class=name>
+                            <span class="tag">Constructor</span>
+                        </div>
+    <h4 class="name" id="AdminTask">
+        <a class="href-link" href="#AdminTask">#</a>
+        <span class="code-name">
+                new AdminTask<span class="signature">()</span><span class="type-signature"></span>
+        </span>
+    </h4>
+<dl class="details">
+        <p class="tag-source">
+            <a href="admin_task.js.html" class="button">View Source</a>
+            <span>
+                <a href="admin_task.js.html">admin/task.js</a>, <a href="admin_task.js.html#line9">line 9</a>
+            </span>
+        </p>
+</dl>
+                    </div>
+                </div>
+            </div>
+    </div>
+        <div class='vertical-section'>
+            <h1>Methods</h1>
+            <div class="members">
+                <div class="member">
+    <h4 class="name" id="find">
+        <a class="href-link" href="#find">#</a>
+                <span class='tag'>async</span>
+        <span class="code-name">
+                find<span class="signature">(params, session)</span><span class="type-signature"></span>
+        </span>
+    </h4>
+    <div class="description">
+        Get task by user Id
+    </div>
+    <h5>Parameters:</h5>
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Attributes</th>
+            <th>Default</th>
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+        <tbody>
+<tr class="deep-level-0">
+      <td class="name"><code>params</code></td>
+  <td class="type">
+<code class="param-type">object</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">Params to get task</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>userId</code></td>
+  <td class="type">
+<code class="param-type">string</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">User id (_id database)</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>filter</code></td>
+  <td class="type">
+<code class="param-type">string</code>
+  </td>
+      <td class="attributes">
+          &lt;optional><br>
+      </td>
+      <td class="default">
+          NOT_DONE
+      </td>
+  <td class="description last">Filter type CLEAN | EXECUTED | PENDING | LATE | NOT_DONE | DONE</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>project</code></td>
+  <td class="type">
+<code class="param-type">object</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">Project to return</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>project.returnProcessProperties</code></td>
+  <td class="type">
+<code class="param-type">boolean</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">Return process properties</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>project.returnInitParams</code></td>
+  <td class="type">
+<code class="param-type">boolean</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">Return init params</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>userId</code></td>
+  <td class="type">
+<code class="param-type">string</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">User id (_id database)</td>
+</tr>
+<tr class="deep-level-1">
+      <td class="name"><code>includeOwner</code></td>
+  <td class="type">
+<code class="param-type">boolean</code>
+  </td>
+      <td class="attributes">
+          &lt;optional><br>
+      </td>
+      <td class="default">
+          false
+      </td>
+  <td class="description last">Include owner true | false</td>
+</tr>
+<tr class="deep-level-0">
+      <td class="name"><code>session</code></td>
+  <td class="type">
+<code class="param-type">string</code>
+  </td>
+      <td class="attributes">
+      </td>
+      <td class="default">
+      </td>
+  <td class="description last">Session, token JWT</td>
+</tr>
+        </tbody>
+    </table>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+        </ul>
+    </dd>
+        <p class="tag-source">
+            <a href="admin_task.js.html" class="button">View Source</a>
+            <span>
+                <a href="admin_task.js.html">admin/task.js</a>, <a href="admin_task.js.html#line95">line 95</a>
+            </span>
+        </p>
+</dl>
+    <h5>Example</h5>
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ userId: '55e4a3bd6be6b45210833fae',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.task.find(params, session);</code></pre>
+</div>
+            </div>
+        </div>
+</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>