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