@opengis/fastify-table 1.1.51 → 1.1.52

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 (218) hide show
  1. package/.eslintrc.cjs +42 -42
  2. package/.gitlab-ci.yml +18 -18
  3. package/Changelog.md +352 -352
  4. package/README.md +26 -26
  5. package/config.js +10 -10
  6. package/cron/controllers/cronApi.js +22 -22
  7. package/cron/controllers/utils/cronList.js +1 -1
  8. package/cron/funcs/addCron.js +132 -132
  9. package/cron/index.js +12 -10
  10. package/cron/schema.js +8 -0
  11. package/crud/controllers/deleteCrud.js +36 -36
  12. package/crud/controllers/insert.js +71 -71
  13. package/crud/controllers/update.js +76 -76
  14. package/crud/controllers/utils/xssInjection.js +72 -72
  15. package/crud/funcs/dataDelete.js +19 -19
  16. package/crud/funcs/dataInsert.js +30 -30
  17. package/crud/funcs/dataUpdate.js +48 -48
  18. package/crud/funcs/getAccess.js +46 -46
  19. package/crud/funcs/getOpt.js +10 -10
  20. package/crud/funcs/getToken.js +27 -27
  21. package/crud/funcs/isFileExists.js +13 -13
  22. package/crud/funcs/setOpt.js +16 -16
  23. package/crud/funcs/setToken.js +53 -53
  24. package/crud/funcs/utils/getFolder.js +9 -9
  25. package/crud/funcs/utils/logChanges.js +62 -62
  26. package/crud/index.js +31 -36
  27. package/crud/schema.js +11 -0
  28. package/docs/.vitepress/abbr.mjs +26 -26
  29. package/docs/.vitepress/config.mjs +127 -127
  30. package/docs/.vitepress/navigation.mjs +82 -82
  31. package/docs/.vitepress/theme/Layout.vue +17 -17
  32. package/docs/.vitepress/theme/components/NavigationLinks.vue +102 -102
  33. package/docs/.vitepress/theme/components/Panzoom.vue +169 -169
  34. package/docs/.vitepress/theme/index.mjs +15 -15
  35. package/docs/.vitepress/theme/style.scss +163 -163
  36. package/docs/abbr.json +4 -4
  37. package/docs/api/cron/cronApi.md +56 -56
  38. package/docs/api/crud/deleteCrud.md +58 -58
  39. package/docs/api/crud/insert.md +82 -82
  40. package/docs/api/crud/update.md +85 -85
  41. package/docs/api/index.md +47 -47
  42. package/docs/api/notification/testEmail.md +91 -91
  43. package/docs/api/table/card.md +73 -73
  44. package/docs/api/table/data.md +134 -134
  45. package/docs/api/table/export.md +60 -60
  46. package/docs/api/table/filter.md +104 -104
  47. package/docs/api/table/form.md +126 -126
  48. package/docs/api/table/search.md +123 -123
  49. package/docs/api/table/suggest.md +156 -156
  50. package/docs/api/table/table.md +107 -107
  51. package/docs/api/user/user.cls.id.md +77 -77
  52. package/docs/api/user/user.cls.md +49 -49
  53. package/docs/api/user/user.cls.post.md +62 -62
  54. package/docs/api/user/user.info.md +37 -37
  55. package/docs/api/utils/logger.file.md +60 -60
  56. package/docs/api/utils/next.id.md +34 -34
  57. package/docs/api/utils/properties.add.md +127 -127
  58. package/docs/api/utils/properties.get.md +73 -73
  59. package/docs/api/utils/status.monitor.md +36 -36
  60. package/docs/api/widget/widget.del.md +76 -76
  61. package/docs/api/widget/widget.get.md +233 -233
  62. package/docs/api/widget/widget.set.md +88 -88
  63. package/docs/db/admin.md +947 -947
  64. package/docs/db/crm.md +564 -564
  65. package/docs/db/index.md +9 -9
  66. package/docs/db/log.md +204 -204
  67. package/docs/hook/card/afterCard.md +20 -20
  68. package/docs/hook/card/preCard.md +25 -25
  69. package/docs/hook/data/afterData.md +26 -26
  70. package/docs/hook/data/preData.md +26 -26
  71. package/docs/hook/deleteCrud/afterDelete.md +21 -21
  72. package/docs/hook/deleteCrud/preDelete.md +26 -26
  73. package/docs/hook/form/afterForm.md +19 -19
  74. package/docs/hook/form/preForm.md +26 -26
  75. package/docs/hook/getTemplate/afterTemplate.md +24 -24
  76. package/docs/hook/getTemplate/preTemplate.md +29 -29
  77. package/docs/hook/index.md +45 -45
  78. package/docs/hook/insert/afterInsert.md +41 -41
  79. package/docs/hook/insert/preInsert.md +25 -25
  80. package/docs/hook/table/afterTable.md +20 -20
  81. package/docs/hook/table/preTable.md +25 -25
  82. package/docs/hook/update/afterUpdate.md +41 -41
  83. package/docs/hook/update/preUpdate.md +25 -25
  84. package/docs/index.md +42 -42
  85. package/docs/public/fastify-dark.svg +3 -3
  86. package/docs/public/logo-short-dark.svg +11 -11
  87. package/docs/public/logo-short.svg +10 -10
  88. package/docs/public/logo.svg +19 -19
  89. package/docs/readme/index.md +121 -121
  90. package/docs/templates/card.md +83 -83
  91. package/docs/templates/cls.md +29 -29
  92. package/docs/templates/filters.md +91 -91
  93. package/docs/templates/forms.md +139 -139
  94. package/docs/templates/index.md +28 -28
  95. package/docs/templates/select.md +90 -90
  96. package/docs/templates/table.md +162 -162
  97. package/docs/utils/cron/addCron.md +29 -29
  98. package/docs/utils/crud/dataInsert.md +51 -51
  99. package/docs/utils/crud/dataUpdate.md +52 -52
  100. package/docs/utils/crud/getOpt.md +33 -33
  101. package/docs/utils/crud/isFileExists.md +37 -37
  102. package/docs/utils/crud/setOpt.md +37 -37
  103. package/docs/utils/hook/addHook.md +74 -74
  104. package/docs/utils/hook/applyHook.md +64 -64
  105. package/docs/utils/index.md +47 -47
  106. package/docs/utils/notification/addNotification.md +28 -28
  107. package/docs/utils/notification/notification.md +41 -41
  108. package/docs/utils/pg/autoIndex.md +22 -22
  109. package/docs/utils/pg/getMeta.md +58 -58
  110. package/docs/utils/pg/getPG.md +34 -34
  111. package/docs/utils/pg/init.md +29 -29
  112. package/docs/utils/pg/pg.md +70 -70
  113. package/docs/utils/redis/getRedis.md +36 -36
  114. package/docs/utils/redis/rclient.md +74 -74
  115. package/docs/utils/table/getForm.md +68 -68
  116. package/docs/utils/table/getMeta.md +55 -55
  117. package/docs/utils/table/getSelect.md +38 -38
  118. package/docs/utils/table/getSelectMeta.md +46 -46
  119. package/docs/utils/table/getTable.md +77 -77
  120. package/helper.js +30 -30
  121. package/index.js +105 -105
  122. package/migration/exec.migrations.js +79 -79
  123. package/module/core/select/core.user_mentioned.sql +1 -1
  124. package/module/test/cls/itree.composition.json +25 -25
  125. package/module/test/table/test.rest_zone.table.json +265 -265
  126. package/notification/controllers/readNotifications.js +27 -30
  127. package/notification/controllers/testEmail.js +46 -50
  128. package/notification/controllers/userNotifications.js +61 -64
  129. package/notification/funcs/addNotification.js +21 -21
  130. package/notification/funcs/sendNotification.js +112 -112
  131. package/notification/index.js +3 -8
  132. package/notification/schema.js +10 -0
  133. package/package.json +41 -41
  134. package/pg/funcs/getMeta.js +29 -29
  135. package/pg/funcs/getPG.js +30 -30
  136. package/pg/pgClients.js +20 -20
  137. package/policy/funcs/checkPolicy.js +92 -92
  138. package/policy/funcs/sqlInjection.js +33 -33
  139. package/policy/index.js +14 -14
  140. package/redis/client.js +8 -8
  141. package/redis/funcs/getRedis.js +23 -23
  142. package/redis/funcs/redisClients.js +2 -2
  143. package/redis/index.js +19 -19
  144. package/server/migrations/0.sql +78 -78
  145. package/server/migrations/cls.sql +39 -39
  146. package/server/migrations/log.sql +80 -80
  147. package/server/migrations/properties.sql +144 -144
  148. package/server/migrations/roles.sql +172 -172
  149. package/server/migrations/users.sql +168 -168
  150. package/server.js +26 -26
  151. package/table/controllers/data.js +157 -150
  152. package/table/controllers/filter.js +61 -50
  153. package/table/controllers/form.js +42 -42
  154. package/table/controllers/search.js +76 -80
  155. package/table/controllers/suggest.js +79 -79
  156. package/table/controllers/table.js +83 -83
  157. package/table/controllers/utils/addTemplateDir.js +8 -8
  158. package/table/controllers/utils/getSelect.js +19 -19
  159. package/table/controllers/utils/getSelectMeta.js +66 -66
  160. package/table/controllers/utils/getTemplate_old.js +28 -28
  161. package/table/controllers/utils/getTemplates.js +18 -18
  162. package/table/controllers/utils/gisIRColumn.js +72 -67
  163. package/table/controllers/utils/loadTemplate.js +1 -1
  164. package/table/controllers/utils/loadTemplatePath.js +1 -1
  165. package/table/controllers/utils/userTemplateDir.js +1 -1
  166. package/table/funcs/getFilterSQL/index.js +94 -94
  167. package/table/funcs/getFilterSQL/util/formatValue.js +170 -170
  168. package/table/funcs/getFilterSQL/util/getCustomQuery.js +13 -13
  169. package/table/funcs/getFilterSQL/util/getFilterQuery.js +66 -66
  170. package/table/funcs/getFilterSQL/util/getOptimizedQuery.js +12 -12
  171. package/table/funcs/getFilterSQL/util/getTableSql.js +34 -34
  172. package/table/funcs/metaFormat/getSelectVal.js +21 -21
  173. package/table/funcs/metaFormat/index.js +28 -28
  174. package/table/index.js +37 -37
  175. package/table/schema.js +64 -54
  176. package/test/api/applyHook.test.js +95 -95
  177. package/test/api/crud.test.js +89 -89
  178. package/test/api/crud.xss.test.js +80 -80
  179. package/test/api/suggest.test.js +66 -66
  180. package/test/api/table.test.js +134 -134
  181. package/test/api/user.test.js +85 -85
  182. package/test/api/widget.test.js +117 -117
  183. package/test/config.example +18 -18
  184. package/test/funcs/pg.test.js +34 -34
  185. package/test/funcs/redis.test.js +19 -19
  186. package/test/helper/formatDate.test.js +62 -62
  187. package/test/templates/cls/test.json +9 -9
  188. package/test/templates/form/cp_building.form.json +32 -32
  189. package/test/templates/select/account_id.json +3 -3
  190. package/test/templates/select/storage.data.json +2 -2
  191. package/test/templates/select/test.storage.data.json +3 -3
  192. package/test/templates/select/test.suggest.ato_new.json +3 -3
  193. package/test/templates/select/test.suggest.ato_new.sql +25 -25
  194. package/test/templates/select/test.suggest.data.json +4 -4
  195. package/test/templates/select/test.suggest.parent.sql +1 -1
  196. package/test/templates/table/gis.dataset.table.json +20 -20
  197. package/user/controllers/user.cls.id.js +14 -14
  198. package/user/controllers/user.cls.js +71 -75
  199. package/user/controllers/user.cls.post.js +52 -55
  200. package/user/controllers/user.info.js +17 -21
  201. package/user/index.js +7 -36
  202. package/user/schema.js +17 -0
  203. package/util/controllers/logger.file.js +91 -91
  204. package/util/controllers/next.id.js +4 -4
  205. package/util/controllers/properties.add.js +56 -60
  206. package/util/controllers/properties.get.js +16 -19
  207. package/util/controllers/status.monitor.js +8 -8
  208. package/util/controllers/utils/checkUserAccess.js +20 -17
  209. package/util/controllers/utils/getRootDir.js +25 -25
  210. package/util/index.js +19 -23
  211. package/util/schema.js +19 -0
  212. package/utils.js +106 -104
  213. package/widget/controllers/utils/historyFormat.js +76 -76
  214. package/widget/controllers/utils/obj2db.js +13 -13
  215. package/widget/controllers/widget.del.js +41 -44
  216. package/widget/controllers/widget.get.js +96 -102
  217. package/widget/controllers/widget.set.js +74 -79
  218. package/widget/index.js +40 -40
@@ -1,82 +1,82 @@
1
- # `POST` Insert
2
-
3
- ## Опис
4
-
5
- Імпорт даних у таблицю
6
-
7
- Є можливість виклику функцій через хук `preInsert` / `afterInsert` після внесення даних до БД
8
-
9
- ```example
10
- /api/table/data_user.work
11
- ```
12
-
13
- ## Параметри
14
-
15
- ```scheme-api
16
- /api/table/:table
17
- ```
18
-
19
- :::tabs
20
-
21
- == params
22
-
23
- | Назва | Тип | Опис |
24
- | ----- | ------ | ------- |
25
- | table | String | Таблиця / token |
26
-
27
- ==body
28
-
29
- | Назва | Тип | Опис |
30
- | --------------- | ------ | ----------------------- |
31
- | type_work | String | Тип |
32
- | date_in | String | Внесення даних |
33
- | date_out | String | Вилучення даних |
34
- | number_services | String | Кількість сервісів |
35
- | number_order | String | Порядок |
36
- | geom | String | Геометрія |
37
- | editor_id | String | Ідентифікатор редактора |
38
- | uid | String | Ідентифікатор |
39
- | editor_date | String | Дата зміни |
40
-
41
- :::
42
-
43
-
44
- ## Відповідь
45
-
46
- ::: tabs
47
-
48
- ==200
49
- ::: details Приклад відповіді
50
-
51
- ```json
52
- {
53
- "res": {
54
- "id_work": "3342439977240757305",
55
- "type_work": 1,
56
- "date_in": null,
57
- "date_out": null,
58
- "number_services": "23",
59
- "number_order": null,
60
- "shop": null,
61
- "geom": null,
62
- "editor_id": null,
63
- "uid": null,
64
- "editor_date": null
65
- }
66
- }
67
- ```
68
-
69
- ==404
70
- ```text
71
- table is required
72
- ```
73
-
74
- :::
75
-
76
- ## Статус коди
77
-
78
- | Ключ | Опис |
79
- | ---------------------------------------------------------- | -------------------------- |
80
- | <Badge type="code_2xx" text="200" /> Success | Успішний запит |
81
- | <Badge type="code_4xx" text="404" /> Not Found | Інформації не знайдено |
82
- | <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |
1
+ # `POST` Insert
2
+
3
+ ## Опис
4
+
5
+ Імпорт даних у таблицю
6
+
7
+ Є можливість виклику функцій через хук `preInsert` / `afterInsert` після внесення даних до БД
8
+
9
+ ```example
10
+ /api/table/data_user.work
11
+ ```
12
+
13
+ ## Параметри
14
+
15
+ ```scheme-api
16
+ /api/table/:table
17
+ ```
18
+
19
+ :::tabs
20
+
21
+ == params
22
+
23
+ | Назва | Тип | Опис |
24
+ | ----- | ------ | ------- |
25
+ | table | String | Таблиця / token |
26
+
27
+ ==body
28
+
29
+ | Назва | Тип | Опис |
30
+ | --------------- | ------ | ----------------------- |
31
+ | type_work | String | Тип |
32
+ | date_in | String | Внесення даних |
33
+ | date_out | String | Вилучення даних |
34
+ | number_services | String | Кількість сервісів |
35
+ | number_order | String | Порядок |
36
+ | geom | String | Геометрія |
37
+ | editor_id | String | Ідентифікатор редактора |
38
+ | uid | String | Ідентифікатор |
39
+ | editor_date | String | Дата зміни |
40
+
41
+ :::
42
+
43
+
44
+ ## Відповідь
45
+
46
+ ::: tabs
47
+
48
+ ==200
49
+ ::: details Приклад відповіді
50
+
51
+ ```json
52
+ {
53
+ "res": {
54
+ "id_work": "3342439977240757305",
55
+ "type_work": 1,
56
+ "date_in": null,
57
+ "date_out": null,
58
+ "number_services": "23",
59
+ "number_order": null,
60
+ "shop": null,
61
+ "geom": null,
62
+ "editor_id": null,
63
+ "uid": null,
64
+ "editor_date": null
65
+ }
66
+ }
67
+ ```
68
+
69
+ ==404
70
+ ```text
71
+ table is required
72
+ ```
73
+
74
+ :::
75
+
76
+ ## Статус коди
77
+
78
+ | Ключ | Опис |
79
+ | ---------------------------------------------------------- | -------------------------- |
80
+ | <Badge type="code_2xx" text="200" /> Success | Успішний запит |
81
+ | <Badge type="code_4xx" text="404" /> Not Found | Інформації не знайдено |
82
+ | <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |
@@ -1,85 +1,85 @@
1
- # `PUT` Update
2
-
3
- ## Опис
4
-
5
- Оновлення даних у таблиці
6
-
7
- Є можливість виклику функцій через хук `preUpdate` / `afterUpdate` після внесення даних до БД
8
-
9
- ```example
10
- /api/table/data_user.work/3342439977240757305
11
- ```
12
-
13
- ## Параметри
14
-
15
- ```scheme-api
16
- /api/table/:table/:id
17
- ```
18
-
19
- :::tabs
20
-
21
- == params
22
-
23
- | Назва | Тип | Опис |
24
- | ----- | ------ | ------------- |
25
- | table | String | Таблиця / token |
26
- | id | String | Ідентифікатор / token |
27
-
28
- ==body
29
-
30
- | Назва | Тип | Опис |
31
- | --------------- | ------ | ----------------------- |
32
- | type_work | String | Тип |
33
- | date_in | String | Внесення даних |
34
- | date_out | String | Вилучення даних |
35
- | number_services | String | Кількість сервісів |
36
- | number_order | String | Порядок |
37
- | geom | String | Геометрія |
38
- | editor_id | String | Ідентифікатор редактора |
39
- | uid | String | Ідентифікатор |
40
- | editor_date | String | Дата зміни |
41
-
42
- :::
43
-
44
- ## Відповідь
45
-
46
- ::: tabs
47
-
48
- ==200
49
- ::: details Приклад відповіді
50
-
51
- ```json
52
- {
53
- "res": {
54
- "id_work": "3342439977240757305",
55
- "type_work": 2,
56
- "date_in": null,
57
- "date_out": null,
58
- "number_services": "25",
59
- "number_order": null,
60
- "shop": null,
61
- "geom": null,
62
- "editor_id": null,
63
- "uid": null,
64
- "editor_date": "2024-04-09T10:53:23.000Z"
65
- }
66
- }
67
- ```
68
-
69
- ==404
70
- ```text
71
- table is required
72
- ```
73
-
74
- ```text
75
- id is required
76
- ```
77
-
78
- :::
79
- ## Статус коди
80
-
81
- | Ключ | Опис |
82
- | ---------------------------------------------------------- | -------------------------- |
83
- | <Badge type="code_2xx" text="200" /> Success | Успішний запит |
84
- | <Badge type="code_4xx" text="404" /> Not Found | Інформації не знайдено |
85
- | <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |
1
+ # `PUT` Update
2
+
3
+ ## Опис
4
+
5
+ Оновлення даних у таблиці
6
+
7
+ Є можливість виклику функцій через хук `preUpdate` / `afterUpdate` після внесення даних до БД
8
+
9
+ ```example
10
+ /api/table/data_user.work/3342439977240757305
11
+ ```
12
+
13
+ ## Параметри
14
+
15
+ ```scheme-api
16
+ /api/table/:table/:id
17
+ ```
18
+
19
+ :::tabs
20
+
21
+ == params
22
+
23
+ | Назва | Тип | Опис |
24
+ | ----- | ------ | ------------- |
25
+ | table | String | Таблиця / token |
26
+ | id | String | Ідентифікатор / token |
27
+
28
+ ==body
29
+
30
+ | Назва | Тип | Опис |
31
+ | --------------- | ------ | ----------------------- |
32
+ | type_work | String | Тип |
33
+ | date_in | String | Внесення даних |
34
+ | date_out | String | Вилучення даних |
35
+ | number_services | String | Кількість сервісів |
36
+ | number_order | String | Порядок |
37
+ | geom | String | Геометрія |
38
+ | editor_id | String | Ідентифікатор редактора |
39
+ | uid | String | Ідентифікатор |
40
+ | editor_date | String | Дата зміни |
41
+
42
+ :::
43
+
44
+ ## Відповідь
45
+
46
+ ::: tabs
47
+
48
+ ==200
49
+ ::: details Приклад відповіді
50
+
51
+ ```json
52
+ {
53
+ "res": {
54
+ "id_work": "3342439977240757305",
55
+ "type_work": 2,
56
+ "date_in": null,
57
+ "date_out": null,
58
+ "number_services": "25",
59
+ "number_order": null,
60
+ "shop": null,
61
+ "geom": null,
62
+ "editor_id": null,
63
+ "uid": null,
64
+ "editor_date": "2024-04-09T10:53:23.000Z"
65
+ }
66
+ }
67
+ ```
68
+
69
+ ==404
70
+ ```text
71
+ table is required
72
+ ```
73
+
74
+ ```text
75
+ id is required
76
+ ```
77
+
78
+ :::
79
+ ## Статус коди
80
+
81
+ | Ключ | Опис |
82
+ | ---------------------------------------------------------- | -------------------------- |
83
+ | <Badge type="code_2xx" text="200" /> Success | Успішний запит |
84
+ | <Badge type="code_4xx" text="404" /> Not Found | Інформації не знайдено |
85
+ | <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |
package/docs/api/index.md CHANGED
@@ -1,47 +1,47 @@
1
- ---
2
- order: -1
3
- ---
4
-
5
- # Список API
6
-
7
-
8
- ## CRUD
9
-
10
- - **[deleteCrud](./crud/deleteCrud.md)** - Видалення даних із таблиці
11
- - **[insert](./crud/insert.md)** - Імпорт даних у таблицю
12
- - **[update](./crud/update.md)** - Оновлення даних у таблиці
13
-
14
- ## Utils
15
-
16
- - **[logger-file](./utils/logger.file.md)** - Для перегляду логів
17
- - **[nextId](./utils/next.id.md)** - Отримання унікального ідентифікатора
18
- - **[getProperties](./utils/properties.get.md)** - Отримання додаткових атрибутів
19
- - **[addProperties](./utils/properties.add.md)** - Додавання додаткових атрибутів
20
- - **[statusMonitor](./utils/status.monitor.md)** - Отримання поточного стану навантаження серверу
21
-
22
- ## Table
23
-
24
- - **[table](./table/table.md)** - Повертає інформацію про об'єкт, що редагується
25
- - **[data](./table/data.md)** - Повертає інформацію про таблицю
26
- - **[card](./table/card.md)** - Повертає інформацію про картки
27
- - **[search](./table/search.md)** - Пошук даних по тексту з таблиці
28
- - **[filter](./table/filter.md)** - Повертає інформацію про фільтри таблиці
29
- - **[form](./table/form.md)** - Повертає шаблон
30
- - **[suggest](./table/suggest.md)** - Повертає інформацію за запитом
31
- - **[export](./table/export.md)** - Експорт даних з таблиці
32
-
33
- ## Widget
34
-
35
- - **[get](./widget/widget.get.md)** - Повертає дані по віджету
36
- - **[post](./widget/widget.set.md)** - Додає або оновлює дані, що відображаються у віджеті
37
- - **[del](./widget/widget.del.md)** - Видаляє дані відповідного віджету
38
-
39
- ## Notification
40
-
41
- - **[readNotifications](./notification/readNotifications.md)** - Відмічає повідомлення користувача як прочитане
42
- - **[userNotifications](./notification/userNotifications.md)** - Повертає список повідомлень користувача
43
- - **[testEmail](./notification/testEmail.md)** - Тест відправки повідомлень на ел. пошту
44
-
45
- ## Cron
46
-
47
- - **[cronApi](./cron/cronApi.md)** - Викликає планувальник
1
+ ---
2
+ order: -1
3
+ ---
4
+
5
+ # Список API
6
+
7
+
8
+ ## CRUD
9
+
10
+ - **[deleteCrud](./crud/deleteCrud.md)** - Видалення даних із таблиці
11
+ - **[insert](./crud/insert.md)** - Імпорт даних у таблицю
12
+ - **[update](./crud/update.md)** - Оновлення даних у таблиці
13
+
14
+ ## Utils
15
+
16
+ - **[logger-file](./utils/logger.file.md)** - Для перегляду логів
17
+ - **[nextId](./utils/next.id.md)** - Отримання унікального ідентифікатора
18
+ - **[getProperties](./utils/properties.get.md)** - Отримання додаткових атрибутів
19
+ - **[addProperties](./utils/properties.add.md)** - Додавання додаткових атрибутів
20
+ - **[statusMonitor](./utils/status.monitor.md)** - Отримання поточного стану навантаження серверу
21
+
22
+ ## Table
23
+
24
+ - **[table](./table/table.md)** - Повертає інформацію про об'єкт, що редагується
25
+ - **[data](./table/data.md)** - Повертає інформацію про таблицю
26
+ - **[card](./table/card.md)** - Повертає інформацію про картки
27
+ - **[search](./table/search.md)** - Пошук даних по тексту з таблиці
28
+ - **[filter](./table/filter.md)** - Повертає інформацію про фільтри таблиці
29
+ - **[form](./table/form.md)** - Повертає шаблон
30
+ - **[suggest](./table/suggest.md)** - Повертає інформацію за запитом
31
+ - **[export](./table/export.md)** - Експорт даних з таблиці
32
+
33
+ ## Widget
34
+
35
+ - **[get](./widget/widget.get.md)** - Повертає дані по віджету
36
+ - **[post](./widget/widget.set.md)** - Додає або оновлює дані, що відображаються у віджеті
37
+ - **[del](./widget/widget.del.md)** - Видаляє дані відповідного віджету
38
+
39
+ ## Notification
40
+
41
+ - **[readNotifications](./notification/readNotifications.md)** - Відмічає повідомлення користувача як прочитане
42
+ - **[userNotifications](./notification/userNotifications.md)** - Повертає список повідомлень користувача
43
+ - **[testEmail](./notification/testEmail.md)** - Тест відправки повідомлень на ел. пошту
44
+
45
+ ## Cron
46
+
47
+ - **[cronApi](./cron/cronApi.md)** - Викликає планувальник
@@ -1,91 +1,91 @@
1
- # `GET` testEmail
2
-
3
- ## Опис
4
-
5
- Тест відправки повідомлень на ел. пошту
6
-
7
- Наявне обмеження доступу до API. API доступна для:
8
-
9
- * користувачів з правами адміністратора
10
- * в рамках локальної розробки (параметр `local` у `config.json`)
11
-
12
- ```example
13
- /api/test-email?to=username@mail.com&table=rental.charge&id=3388805314823324672&template=charge.pt&nocache=1
14
- ```
15
-
16
- ## Параметри
17
-
18
- ```scheme-api
19
- /api/test-email?to={to}&from={from}&table={table}&id={id}&template={template}&nocache={nocache}
20
- ```
21
-
22
- :::tabs
23
-
24
- == query
25
-
26
- | Назва | Тип | Опис |
27
- | ----- | ------ | ---- |
28
- | to | String | Ел. пошта отримувача |
29
- | from | String | Ел. пошта відправника |
30
- | table | String | Таблиця в БД |
31
- | id | String | ID об'єкту в БД |
32
- | template | String | Шаблон (partial template) |
33
- | nocache | Number | Відключити кешування |
34
-
35
- :::
36
-
37
- ## Відповідь
38
-
39
- ::: tabs
40
-
41
- ==200
42
- ::: details Приклад відповіді
43
-
44
- ```json
45
- {
46
- "accepted": [
47
- "username@mail.com"
48
- ],
49
- "rejected": [],
50
- "ehlo": [
51
- "PIPELINING",
52
- "SIZE 15728640",
53
- "VRFY",
54
- "ETRN",
55
- "AUTH PLAIN LOGIN DIGEST-MD5 CRAM-MD5",
56
- "AUTH=PLAIN LOGIN DIGEST-MD5 CRAM-MD5",
57
- "ENHANCEDSTATUSCODES",
58
- "8BITMIME",
59
- "SMTPUTF8",
60
- "CHUNKING"
61
- ],
62
- "envelopeTime": 113,
63
- "messageTime": 85,
64
- "messageSize": 10887,
65
- "response": "250 OK queued as f71c7b08-923d-4169-b448-55212979bfd9",
66
- "envelope": {
67
- "from": "order@mail.com",
68
- "to": [
69
- "username@mail.com"
70
- ]
71
- },
72
- "messageId": "<53e901b0-88cf-0b37-2c62-080adbce5e5a@softpro.ua>"
73
- }
74
- ```
75
-
76
- ==403
77
-
78
- ```text
79
- access restricted
80
- ```
81
-
82
- :::
83
-
84
- ## Статус коди
85
-
86
- | Ключ | Опис |
87
- | ---------------------------------------------------------- | ----------------------------------------- |
88
- | <Badge type="code_2xx" text="200" /> Success | Успішний запит |
89
- | <Badge type="code_4xx" text="400" /> Bad Request | Неправильно сформований запит від клієнта |
90
- | <Badge type="code_4xx" text="404" /> Not Found | Інформації не знайдено |
91
- | <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |
1
+ # `GET` testEmail
2
+
3
+ ## Опис
4
+
5
+ Тест відправки повідомлень на ел. пошту
6
+
7
+ Наявне обмеження доступу до API. API доступна для:
8
+
9
+ * користувачів з правами адміністратора
10
+ * в рамках локальної розробки (параметр `local` у `config.json`)
11
+
12
+ ```example
13
+ /api/test-email?to=username@mail.com&table=rental.charge&id=3388805314823324672&template=charge.pt&nocache=1
14
+ ```
15
+
16
+ ## Параметри
17
+
18
+ ```scheme-api
19
+ /api/test-email?to={to}&from={from}&table={table}&id={id}&template={template}&nocache={nocache}
20
+ ```
21
+
22
+ :::tabs
23
+
24
+ == query
25
+
26
+ | Назва | Тип | Опис |
27
+ | ----- | ------ | ---- |
28
+ | to | String | Ел. пошта отримувача |
29
+ | from | String | Ел. пошта відправника |
30
+ | table | String | Таблиця в БД |
31
+ | id | String | ID об'єкту в БД |
32
+ | template | String | Шаблон (partial template) |
33
+ | nocache | Number | Відключити кешування |
34
+
35
+ :::
36
+
37
+ ## Відповідь
38
+
39
+ ::: tabs
40
+
41
+ ==200
42
+ ::: details Приклад відповіді
43
+
44
+ ```json
45
+ {
46
+ "accepted": [
47
+ "username@mail.com"
48
+ ],
49
+ "rejected": [],
50
+ "ehlo": [
51
+ "PIPELINING",
52
+ "SIZE 15728640",
53
+ "VRFY",
54
+ "ETRN",
55
+ "AUTH PLAIN LOGIN DIGEST-MD5 CRAM-MD5",
56
+ "AUTH=PLAIN LOGIN DIGEST-MD5 CRAM-MD5",
57
+ "ENHANCEDSTATUSCODES",
58
+ "8BITMIME",
59
+ "SMTPUTF8",
60
+ "CHUNKING"
61
+ ],
62
+ "envelopeTime": 113,
63
+ "messageTime": 85,
64
+ "messageSize": 10887,
65
+ "response": "250 OK queued as f71c7b08-923d-4169-b448-55212979bfd9",
66
+ "envelope": {
67
+ "from": "order@mail.com",
68
+ "to": [
69
+ "username@mail.com"
70
+ ]
71
+ },
72
+ "messageId": "<53e901b0-88cf-0b37-2c62-080adbce5e5a@softpro.ua>"
73
+ }
74
+ ```
75
+
76
+ ==403
77
+
78
+ ```text
79
+ access restricted
80
+ ```
81
+
82
+ :::
83
+
84
+ ## Статус коди
85
+
86
+ | Ключ | Опис |
87
+ | ---------------------------------------------------------- | ----------------------------------------- |
88
+ | <Badge type="code_2xx" text="200" /> Success | Успішний запит |
89
+ | <Badge type="code_4xx" text="400" /> Bad Request | Неправильно сформований запит від клієнта |
90
+ | <Badge type="code_4xx" text="404" /> Not Found | Інформації не знайдено |
91
+ | <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |