@docbrasil/api-systemmanager 1.1.23 → 1.1.24

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 (78) hide show
  1. package/api/user/dashboard.js +150 -0
  2. package/api/user/index.js +2 -0
  3. package/dist/bundle.cjs +5 -2
  4. package/dist/bundle.mjs +1 -1
  5. package/doc/api.md +59 -0
  6. package/docs/Admin.html +1 -1
  7. package/docs/AdminDocuments.html +1 -1
  8. package/docs/AdminForm.html +1 -1
  9. package/docs/AdminLists.html +1 -1
  10. package/docs/AdminMessage.html +1 -1
  11. package/docs/AdminNotification.html +1 -1
  12. package/docs/AdminPlugin.html +1 -1
  13. package/docs/AdminPolicy.html +1 -1
  14. package/docs/AdminProcesses.html +1 -1
  15. package/docs/AdminTask.html +1 -1
  16. package/docs/AdminUser.html +1 -1
  17. package/docs/Application.html +1 -1
  18. package/docs/Chart.html +528 -0
  19. package/docs/Dashboard.html +349 -0
  20. package/docs/Datasource.html +1 -1
  21. package/docs/Dispatch.html +1 -1
  22. package/docs/Documents.html +1 -1
  23. package/docs/External.html +1 -1
  24. package/docs/GeoLocation.html +1 -1
  25. package/docs/Help.html +1 -1
  26. package/docs/Login.html +1 -1
  27. package/docs/MyTasks.html +1 -1
  28. package/docs/Notification.html +1 -1
  29. package/docs/Organization.html +1 -1
  30. package/docs/Page.html +1 -1
  31. package/docs/Process.html +1 -1
  32. package/docs/Register.html +1 -1
  33. package/docs/Session.html +1 -1
  34. package/docs/Settings.html +1 -1
  35. package/docs/Task.html +1 -1
  36. package/docs/TaskAvailable.html +1 -1
  37. package/docs/Updates.html +1 -1
  38. package/docs/User.html +1 -1
  39. package/docs/Users.html +2 -2
  40. package/docs/admin_doctypes.js.html +1 -1
  41. package/docs/admin_document.js.html +1 -1
  42. package/docs/admin_form.js.html +1 -1
  43. package/docs/admin_index.js.html +1 -1
  44. package/docs/admin_list.js.html +1 -1
  45. package/docs/admin_message.js.html +1 -1
  46. package/docs/admin_notification.js.html +1 -1
  47. package/docs/admin_organization.js.html +1 -1
  48. package/docs/admin_plugin.js.html +1 -1
  49. package/docs/admin_policy.js.html +1 -1
  50. package/docs/admin_processes.js.html +1 -1
  51. package/docs/admin_task.js.html +1 -1
  52. package/docs/admin_user.js.html +1 -1
  53. package/docs/dispatch.js.html +1 -1
  54. package/docs/external.js.html +1 -1
  55. package/docs/general_geoLocation.js.html +1 -1
  56. package/docs/general_index.js.html +1 -1
  57. package/docs/index.html +1 -1
  58. package/docs/login.js.html +1 -1
  59. package/docs/session.js.html +1 -1
  60. package/docs/user_application.js.html +1 -1
  61. package/docs/user_dashboard.js.html +267 -0
  62. package/docs/user_datasource.js.html +1 -1
  63. package/docs/user_document.js.html +1 -1
  64. package/docs/user_help.js.html +1 -1
  65. package/docs/user_index.js.html +3 -1
  66. package/docs/user_my_tasks.js.html +1 -1
  67. package/docs/user_notification.js.html +1 -1
  68. package/docs/user_organization.js.html +1 -1
  69. package/docs/user_page.js.html +1 -1
  70. package/docs/user_process.js.html +1 -1
  71. package/docs/user_register.js.html +1 -1
  72. package/docs/user_settings.js.html +1 -1
  73. package/docs/user_task.js.html +1 -1
  74. package/docs/user_task_available.js.html +1 -1
  75. package/docs/user_updates.js.html +1 -1
  76. package/docs/user_user.js.html +1 -1
  77. package/docs/utils_promises.js.html +1 -1
  78. package/package.json +1 -1
package/docs/Chart.html ADDED
@@ -0,0 +1,528 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width, initial-scale=1">
8
+ <title> Chart</title>
9
+
10
+ <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
+ <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
+ <script src="./build/entry.js"></script>
13
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
+ <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
+ <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
+ <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
+ <link type="text/css" rel="stylesheet" href="">
23
+ <script async defer src="https://buttons.github.io/buttons.js"></script>
24
+
25
+
26
+ </head>
27
+
28
+
29
+
30
+ <body class="layout small-header">
31
+ <div id="stickyNavbarOverlay"></div>
32
+
33
+
34
+ <div class="top-nav">
35
+ <div class="inner">
36
+ <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
+ <span aria-hidden="true"></span>
38
+ <span aria-hidden="true"></span>
39
+ <span aria-hidden="true"></span>
40
+ </a>
41
+ <div class="logo">
42
+
43
+
44
+ </div>
45
+ <div class="menu">
46
+
47
+ <div class="navigation">
48
+ <a
49
+ href="index.html"
50
+ class="link"
51
+ >
52
+ Documentation
53
+ </a>
54
+
55
+
56
+
57
+ </div>
58
+ </div>
59
+ </div>
60
+ </div>
61
+ <div id="main">
62
+ <div
63
+ class="sidebar "
64
+ id="sidebarNav"
65
+ >
66
+
67
+ <nav>
68
+
69
+ <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="Application.html">Application</a></li><li><a href="Chart.html">Chart</a></li><li><a href="Dashboard.html">Dashboard</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="Help.html">Help</a></li><li><a href="Login.html">Login</a></li><li><a href="MyTasks.html">MyTasks</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Page.html">Page</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="Settings.html">Settings</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="Updates.html">Updates</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
70
+
71
+ </nav>
72
+ </div>
73
+ <div class="core" id="main-content-wrapper">
74
+ <div class="content">
75
+ <header class="page-title">
76
+ <p>Class</p>
77
+ <h1>Chart</h1>
78
+ </header>
79
+
80
+
81
+
82
+
83
+
84
+ <section>
85
+
86
+ <header>
87
+
88
+ <h2><span class="attribs"><span class="type-signature"></span></span>Chart<span class="signature">()</span><span class="type-signature"></span></h2>
89
+
90
+ <div class="class-description">Class user access to charts</div>
91
+
92
+
93
+ </header>
94
+
95
+ <article>
96
+ <div class="container-overview">
97
+
98
+
99
+ <div class='vertical-section'>
100
+ <div class="members">
101
+ <div class="member">
102
+ <div class=name>
103
+ <span class="tag">Constructor</span>
104
+ </div>
105
+
106
+
107
+
108
+
109
+ <h4 class="name" id="Chart">
110
+ <a class="href-link" href="#Chart">#</a>
111
+
112
+ <span class="code-name">
113
+
114
+ new Chart<span class="signature">()</span><span class="type-signature"></span>
115
+
116
+ </span>
117
+ </h4>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <dl class="details">
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <p class="tag-source">
168
+ <a href="user_dashboard.js.html" class="button">View Source</a>
169
+ <span>
170
+ <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line9">line 9</a>
171
+ </span>
172
+ </p>
173
+
174
+ </dl>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ </div>
198
+ </div>
199
+ </div>
200
+
201
+
202
+ </div>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <div class='vertical-section'>
220
+ <h1>Methods</h1>
221
+ <div class="members">
222
+
223
+ <div class="member">
224
+
225
+
226
+
227
+ <h4 class="name" id="getData">
228
+ <a class="href-link" href="#getData">#</a>
229
+
230
+
231
+ <span class='tag'>async</span>
232
+
233
+
234
+ <span class="code-name">
235
+
236
+ getData<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise}</span>
237
+
238
+ </span>
239
+ </h4>
240
+
241
+
242
+
243
+
244
+ <div class="description">
245
+ Get the data for a chart
246
+ </div>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <h5>Parameters:</h5>
258
+
259
+ <div class="table-container">
260
+ <table class="params table">
261
+ <thead>
262
+ <tr>
263
+
264
+ <th>Name</th>
265
+
266
+
267
+ <th>Type</th>
268
+
269
+
270
+
271
+
272
+
273
+ <th class="last">Description</th>
274
+ </tr>
275
+ </thead>
276
+
277
+ <tbody>
278
+
279
+
280
+
281
+ <tr class="deep-level-0">
282
+
283
+ <td class="name"><code>params</code></td>
284
+
285
+
286
+ <td class="type">
287
+
288
+
289
+ <code class="param-type">object</code>
290
+
291
+
292
+
293
+ </td>
294
+
295
+
296
+
297
+
298
+
299
+ <td class="description last">Params to get helps from topic</td>
300
+ </tr>
301
+
302
+
303
+
304
+
305
+ <tr class="deep-level-1">
306
+
307
+ <td class="name"><code>type</code></td>
308
+
309
+
310
+ <td class="type">
311
+
312
+
313
+ <code class="param-type">object</code>
314
+
315
+
316
+
317
+ </td>
318
+
319
+
320
+
321
+
322
+
323
+ <td class="description last">Type of the chart data</td>
324
+ </tr>
325
+
326
+
327
+
328
+ <tr class="deep-level-1">
329
+
330
+ <td class="name"><code>query</code></td>
331
+
332
+
333
+ <td class="type">
334
+
335
+
336
+ <code class="param-type">object</code>
337
+
338
+
339
+
340
+ </td>
341
+
342
+
343
+
344
+
345
+
346
+ <td class="description last">The query if any</td>
347
+ </tr>
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+ <tr class="deep-level-0">
356
+
357
+ <td class="name"><code>session</code></td>
358
+
359
+
360
+ <td class="type">
361
+
362
+
363
+ <code class="param-type">string</code>
364
+
365
+
366
+
367
+ </td>
368
+
369
+
370
+
371
+
372
+
373
+ <td class="description last">Session, token JWT</td>
374
+ </tr>
375
+
376
+
377
+
378
+ </tbody>
379
+ </table>
380
+ </div>
381
+
382
+
383
+
384
+
385
+
386
+ <dl class="details">
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <dt class="tag-author">Author:</dt>
406
+ <dd class="tag-author">
407
+ <ul>
408
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
409
+ </ul>
410
+ </dd>
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+ <p class="tag-source">
426
+ <a href="user_dashboard.js.html" class="button">View Source</a>
427
+ <span>
428
+ <a href="user_dashboard.js.html">user/dashboard.js</a>, <a href="user_dashboard.js.html#line68">line 68</a>
429
+ </span>
430
+ </p>
431
+
432
+ </dl>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+ <div class='columns method-parameter'>
452
+ <div class="column is-2"><label>Returns:</label></div>
453
+ <div class="column is-10">
454
+
455
+
456
+
457
+ <div class="columns">
458
+
459
+
460
+ <div class='column is-5 has-text-left'>
461
+ <label>Type: </label>
462
+
463
+ <code class="param-type">promise</code>
464
+
465
+
466
+ </div>
467
+
468
+ </div>
469
+
470
+
471
+ </div>
472
+ </div>
473
+
474
+
475
+
476
+
477
+ <h5>Example</h5>
478
+
479
+
480
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
481
+ const api = new API();
482
+ const params = {
483
+ type: 'heatmap_data'
484
+ };
485
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
486
+ await api.user.dashboard.chart.getData(params, session);</code></pre>
487
+
488
+
489
+
490
+ </div>
491
+
492
+ </div>
493
+ </div>
494
+
495
+
496
+
497
+
498
+
499
+ </article>
500
+
501
+ </section>
502
+
503
+
504
+
505
+
506
+ </div>
507
+
508
+ <footer class="footer">
509
+ <div class="content has-text-centered">
510
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
511
+ <p class="sidebar-created-by">
512
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
513
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
514
+ </p>
515
+ </div>
516
+ </footer>
517
+
518
+ </div>
519
+ <div id="side-nav" class="side-nav">
520
+ </div>
521
+ </div>
522
+ <script src="scripts/app.min.js"></script>
523
+ <script>PR.prettyPrint();</script>
524
+ <script src="scripts/linenumber.js"> </script>
525
+
526
+
527
+ </body>
528
+ </html>