@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
  1. package/.github/workflows/static.yml +43 -0
  2. package/api/external.js +41 -0
  3. package/dist/bundle.cjs +41 -0
  4. package/dist/bundle.mjs +1 -1
  5. package/doc/api.md +382 -0
  6. package/docs/Admin.html +336 -0
  7. package/docs/AdminDocuments.html +2235 -0
  8. package/docs/AdminForm.html +934 -0
  9. package/docs/AdminLists.html +895 -0
  10. package/docs/AdminMessage.html +1490 -0
  11. package/docs/AdminNotification.html +1636 -0
  12. package/docs/AdminPlugin.html +696 -0
  13. package/docs/AdminPolicy.html +451 -0
  14. package/docs/AdminProcesses.html +692 -0
  15. package/docs/AdminTask.html +740 -0
  16. package/docs/AdminUser.html +1203 -0
  17. package/docs/Datasource.html +660 -0
  18. package/docs/Dispatch.html +624 -0
  19. package/docs/Documents.html +4875 -0
  20. package/docs/External.html +1497 -0
  21. package/docs/GeoLocation.html +503 -0
  22. package/docs/Login.html +1839 -0
  23. package/docs/Notification.html +625 -0
  24. package/docs/Organization.html +2767 -0
  25. package/docs/Process.html +1598 -0
  26. package/docs/Register.html +1604 -0
  27. package/docs/Session.html +482 -0
  28. package/docs/Task.html +1394 -0
  29. package/docs/TaskAvailable.html +893 -0
  30. package/docs/User.html +2002 -0
  31. package/docs/Users.html +569 -0
  32. package/docs/admin_doctypes.js.html +193 -0
  33. package/docs/admin_document.js.html +449 -0
  34. package/docs/admin_form.js.html +268 -0
  35. package/docs/admin_index.js.html +163 -0
  36. package/docs/admin_list.js.html +250 -0
  37. package/docs/admin_message.js.html +311 -0
  38. package/docs/admin_notification.js.html +350 -0
  39. package/docs/admin_organization.js.html +241 -0
  40. package/docs/admin_plugin.js.html +233 -0
  41. package/docs/admin_policy.js.html +195 -0
  42. package/docs/admin_processes.js.html +487 -0
  43. package/docs/admin_task.js.html +242 -0
  44. package/docs/admin_user.js.html +302 -0
  45. package/docs/dispatch.js.html +218 -0
  46. package/docs/external.js.html +333 -0
  47. package/docs/general_geoLocation.js.html +205 -0
  48. package/docs/general_index.js.html +140 -0
  49. package/docs/index.html +129 -0
  50. package/docs/login.js.html +384 -0
  51. package/docs/scripts/app.min.js +1 -0
  52. package/docs/scripts/linenumber.js +26 -0
  53. package/docs/scripts/search.js +39 -0
  54. package/docs/session.js.html +202 -0
  55. package/docs/styles/app.min.css +1 -0
  56. package/docs/styles/iframe.css +13 -0
  57. package/docs/styles/prettify-jsdoc.css +111 -0
  58. package/docs/styles/prettify-tomorrow.css +132 -0
  59. package/docs/styles/reset.css +44 -0
  60. package/docs/user_datasource.js.html +261 -0
  61. package/docs/user_document.js.html +847 -0
  62. package/docs/user_index.js.html +156 -0
  63. package/docs/user_notification.js.html +218 -0
  64. package/docs/user_organization.js.html +347 -0
  65. package/docs/user_process.js.html +352 -0
  66. package/docs/user_register.js.html +322 -0
  67. package/docs/user_task.js.html +319 -0
  68. package/docs/user_task_available.js.html +252 -0
  69. package/docs/user_user.js.html +404 -0
  70. package/docs/utils_promises.js.html +235 -0
  71. package/package.json +7 -4
  72. package/readme.md +7 -8
  73. package/doc.md +0 -653
@@ -0,0 +1,624 @@
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> Dispatch</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="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>
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>Dispatch</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>Dispatch<span class="signature">()</span><span class="type-signature"></span></h2>
89
+
90
+ <div class="class-description">Api dispatch manager</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="Dispatch">
110
+ <a class="href-link" href="#Dispatch">#</a>
111
+
112
+ <span class="code-name">
113
+
114
+ new Dispatch<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="dispatch.js.html" class="button">View Source</a>
169
+ <span>
170
+ <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line8">line 8</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="getClient">
228
+ <a class="href-link" href="#getClient">#</a>
229
+
230
+
231
+ <span class='tag'>async</span>
232
+
233
+
234
+ <span class="code-name">
235
+
236
+ getClient<span class="signature">()</span><span class="type-signature"> &rarr; {promise}</span>
237
+
238
+ </span>
239
+ </h4>
240
+
241
+
242
+
243
+
244
+ <div class="description">
245
+ Get client Axios
246
+ </div>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+ <dl class="details">
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <dt class="tag-author">Author:</dt>
281
+ <dd class="tag-author">
282
+ <ul>
283
+ <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
284
+ </ul>
285
+ </dd>
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+ <p class="tag-source">
301
+ <a href="dispatch.js.html" class="button">View Source</a>
302
+ <span>
303
+ <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line91">line 91</a>
304
+ </span>
305
+ </p>
306
+
307
+ </dl>
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <div class='columns method-parameter'>
327
+ <div class="column is-2"><label>Returns:</label></div>
328
+ <div class="column is-10">
329
+
330
+
331
+
332
+ <div class="columns">
333
+
334
+ <div class='param-desc column is-7'>return client axios</div>
335
+
336
+
337
+ <div class='column is-5 has-text-left'>
338
+ <label>Type: </label>
339
+
340
+ <code class="param-type">promise</code>
341
+
342
+
343
+ </div>
344
+
345
+ </div>
346
+
347
+
348
+ </div>
349
+ </div>
350
+
351
+
352
+
353
+
354
+ <h5>Example</h5>
355
+
356
+
357
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
358
+ const api = new API();
359
+ await api.dispatch.getClient();</code></pre>
360
+
361
+
362
+
363
+ </div>
364
+
365
+ <div class="member">
366
+
367
+
368
+
369
+ <h4 class="name" id="getContext">
370
+ <a class="href-link" href="#getContext">#</a>
371
+
372
+
373
+ <span class='tag'>async</span>
374
+
375
+
376
+ <span class="code-name">
377
+
378
+ getContext<span class="signature">(url, session)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
379
+
380
+ </span>
381
+ </h4>
382
+
383
+
384
+
385
+
386
+ <div class="description">
387
+ Get the URL context
388
+ </div>
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+ <h5>Parameters:</h5>
400
+
401
+ <div class="table-container">
402
+ <table class="params table">
403
+ <thead>
404
+ <tr>
405
+
406
+ <th>Name</th>
407
+
408
+
409
+ <th>Type</th>
410
+
411
+
412
+
413
+
414
+ <th>Default</th>
415
+
416
+
417
+ <th class="last">Description</th>
418
+ </tr>
419
+ </thead>
420
+
421
+ <tbody>
422
+
423
+
424
+
425
+ <tr class="deep-level-0">
426
+
427
+ <td class="name"><code>url</code></td>
428
+
429
+
430
+ <td class="type">
431
+
432
+
433
+ <code class="param-type">string</code>
434
+
435
+
436
+
437
+ </td>
438
+
439
+
440
+
441
+
442
+ <td class="default">
443
+
444
+ </td>
445
+
446
+
447
+ <td class="description last">Full url</td>
448
+ </tr>
449
+
450
+
451
+
452
+
453
+
454
+ <tr class="deep-level-0">
455
+
456
+ <td class="name"><code>session</code></td>
457
+
458
+
459
+ <td class="type">
460
+
461
+
462
+ <code class="param-type">session</code>
463
+
464
+
465
+
466
+ </td>
467
+
468
+
469
+
470
+
471
+ <td class="default">
472
+
473
+ null
474
+
475
+ </td>
476
+
477
+
478
+ <td class="description last">Session, token JWT</td>
479
+ </tr>
480
+
481
+
482
+
483
+ </tbody>
484
+ </table>
485
+ </div>
486
+
487
+
488
+
489
+
490
+
491
+ <dl class="details">
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+ <p class="tag-source">
524
+ <a href="dispatch.js.html" class="button">View Source</a>
525
+ <span>
526
+ <a href="dispatch.js.html">dispatch.js</a>, <a href="dispatch.js.html#line64">line 64</a>
527
+ </span>
528
+ </p>
529
+
530
+ </dl>
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+ <div class='columns method-parameter'>
550
+ <div class="column is-2"><label>Returns:</label></div>
551
+ <div class="column is-10">
552
+
553
+
554
+
555
+ <div class="columns">
556
+
557
+ <div class='param-desc column is-7'>The full data context of the URL</div>
558
+
559
+
560
+ <div class='column is-5 has-text-left'>
561
+ <label>Type: </label>
562
+
563
+ <code class="param-type">Promise.&lt;object></code>
564
+
565
+
566
+ </div>
567
+
568
+ </div>
569
+
570
+
571
+ </div>
572
+ </div>
573
+
574
+
575
+
576
+
577
+ <h5>Example</h5>
578
+
579
+
580
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
581
+ const api = new API();
582
+ const retContext = await api.dispatch.getContext('http://myndware.io/login/myorg);</code></pre>
583
+
584
+
585
+
586
+ </div>
587
+
588
+ </div>
589
+ </div>
590
+
591
+
592
+
593
+
594
+
595
+ </article>
596
+
597
+ </section>
598
+
599
+
600
+
601
+
602
+ </div>
603
+
604
+ <footer class="footer">
605
+ <div class="content has-text-centered">
606
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
607
+ <p class="sidebar-created-by">
608
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
609
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
610
+ </p>
611
+ </div>
612
+ </footer>
613
+
614
+ </div>
615
+ <div id="side-nav" class="side-nav">
616
+ </div>
617
+ </div>
618
+ <script src="scripts/app.min.js"></script>
619
+ <script>PR.prettyPrint();</script>
620
+ <script src="scripts/linenumber.js"> </script>
621
+
622
+
623
+ </body>
624
+ </html>