@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc.1

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 (298) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +27 -0
  3. package/documentation/arch/aspects.yaml +81 -0
  4. package/documentation/arch/components/browser.yaml +51 -0
  5. package/documentation/arch/components/examples/context.yaml +37 -0
  6. package/documentation/arch/components/examples/order.yaml +92 -0
  7. package/documentation/arch/components/examples/payment.yaml +92 -0
  8. package/documentation/arch/components/examples/root.yaml +42 -0
  9. package/documentation/arch/components/front.yaml +309 -0
  10. package/documentation/arch/components/gitlab.yaml +81 -0
  11. package/documentation/arch/components/plantuml.yaml +57 -0
  12. package/documentation/arch/components/root.yaml +36 -0
  13. package/documentation/arch/components/user.yaml +41 -0
  14. package/documentation/arch/components/web.yaml +39 -0
  15. package/documentation/arch/contexts.yaml +99 -0
  16. package/documentation/arch/forms.yaml +36 -0
  17. package/documentation/arch/namespaces.yaml +43 -0
  18. package/documentation/arch/root.yaml +43 -0
  19. package/documentation/arch/rules.yaml +91 -0
  20. package/documentation/arch/technologies.yaml +84 -0
  21. package/documentation/dochub.yaml +32 -0
  22. package/documentation/docs/conception/archdistrib.puml +38 -0
  23. package/documentation/docs/conception/archeco.puml +11 -0
  24. package/documentation/docs/conception/archeco_proc.puml +29 -0
  25. package/documentation/docs/conception/archver.puml +24 -0
  26. package/documentation/docs/conception/facade.puml +20 -0
  27. package/documentation/docs/conception/introduction.md +144 -0
  28. package/documentation/docs/conception/mindmap.puml +55 -0
  29. package/documentation/docs/conception/root.yaml +66 -0
  30. package/documentation/docs/manual/aspects.md +37 -0
  31. package/documentation/docs/manual/backend/api.yaml +664 -0
  32. package/documentation/docs/manual/backend/search-implementation.md +190 -0
  33. package/documentation/docs/manual/backend/search.yaml +495 -0
  34. package/documentation/docs/manual/clickstream-setup.md +50 -0
  35. package/documentation/docs/manual/components.md +45 -0
  36. package/documentation/docs/manual/config/deployment.md +337 -0
  37. package/documentation/docs/manual/context_source.puml +17 -0
  38. package/documentation/docs/manual/contexts.md +200 -0
  39. package/documentation/docs/manual/datasets.md +120 -0
  40. package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
  41. package/documentation/docs/manual/docs/asyncapi.md +63 -0
  42. package/documentation/docs/manual/docs/bpmn.md +122 -0
  43. package/documentation/docs/manual/docs/charts.md +371 -0
  44. package/documentation/docs/manual/docs/docs.md +76 -0
  45. package/documentation/docs/manual/docs/drawio_intro.md +397 -0
  46. package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
  47. package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
  48. package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
  49. package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
  50. package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
  51. package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
  52. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
  53. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
  54. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
  55. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
  56. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
  57. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
  58. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
  59. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
  60. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
  61. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
  62. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
  63. package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
  64. package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
  65. package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
  66. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
  67. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
  68. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
  69. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
  70. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
  71. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
  72. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
  73. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
  74. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
  75. package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
  76. package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
  77. package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
  78. package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
  79. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
  80. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
  81. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
  82. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
  83. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
  84. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
  85. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
  86. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
  87. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
  88. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
  89. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
  90. package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
  91. package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
  92. package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
  93. package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
  94. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
  95. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
  96. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
  97. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
  98. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
  99. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
  100. package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
  101. package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
  102. package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
  103. package/documentation/docs/manual/docs/editable_table/template.md +24 -0
  104. package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
  105. package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
  106. package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
  107. package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
  108. package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
  109. package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
  110. package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
  111. package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
  112. package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
  113. package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
  114. package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
  115. package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
  116. package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
  117. package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
  118. package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
  119. package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
  120. package/documentation/docs/manual/docs/examples/example.html +2 -0
  121. package/documentation/docs/manual/docs/examples/example.puml +17 -0
  122. package/documentation/docs/manual/docs/examples/example.yaml +53 -0
  123. package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
  124. package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
  125. package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
  126. package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
  127. package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
  128. package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
  129. package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
  130. package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
  131. package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
  132. package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
  133. package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
  134. package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
  135. package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
  136. package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
  137. package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
  138. package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
  139. package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
  140. package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
  141. package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
  142. package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
  143. package/documentation/docs/manual/docs/examples/table.yaml +341 -0
  144. package/documentation/docs/manual/docs/examples/template.puml +6 -0
  145. package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
  146. package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
  147. package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
  148. package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
  149. package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
  150. package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
  151. package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
  152. package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
  153. package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
  154. package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
  155. package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
  156. package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
  157. package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
  158. package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
  159. package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
  160. package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
  161. package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
  162. package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
  163. package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
  164. package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
  165. package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
  166. package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
  167. package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
  168. package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
  169. package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
  170. package/documentation/docs/manual/docs/gigachat/template.md +38 -0
  171. package/documentation/docs/manual/docs/images/cloud.png +0 -0
  172. package/documentation/docs/manual/docs/images/component.png +0 -0
  173. package/documentation/docs/manual/docs/images/system.png +0 -0
  174. package/documentation/docs/manual/docs/images/user.png +0 -0
  175. package/documentation/docs/manual/docs/markaper.md +278 -0
  176. package/documentation/docs/manual/docs/markdown.md +148 -0
  177. package/documentation/docs/manual/docs/mermaid.md +43 -0
  178. package/documentation/docs/manual/docs/network.md +117 -0
  179. package/documentation/docs/manual/docs/plantuml.md +28 -0
  180. package/documentation/docs/manual/docs/root.yaml +736 -0
  181. package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
  182. package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
  183. package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
  184. package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
  185. package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
  186. package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
  187. package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
  188. package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
  189. package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
  190. package/documentation/docs/manual/docs/smartants.md +583 -0
  191. package/documentation/docs/manual/docs/svg_inline.md +66 -0
  192. package/documentation/docs/manual/docs/swagger.md +52 -0
  193. package/documentation/docs/manual/docs/tables.md +264 -0
  194. package/documentation/docs/manual/docs/templates/example.drawio +43 -0
  195. package/documentation/docs/manual/docs/templates/test.svg +79 -0
  196. package/documentation/docs/manual/docs/templates.md +361 -0
  197. package/documentation/docs/manual/docs/toc.md +137 -0
  198. package/documentation/docs/manual/entities/bstages.md +43 -0
  199. package/documentation/docs/manual/entities/bundle.md +105 -0
  200. package/documentation/docs/manual/entities/entities.md +727 -0
  201. package/documentation/docs/manual/entities/images/id_errors.png +0 -0
  202. package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
  203. package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
  204. package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
  205. package/documentation/docs/manual/entities/images/object_select.png +0 -0
  206. package/documentation/docs/manual/entities/images/problems.png +0 -0
  207. package/documentation/docs/manual/entities/images/select_inter.png +0 -0
  208. package/documentation/docs/manual/entities/images/stages.jpg +0 -0
  209. package/documentation/docs/manual/entities/images/suggests.png +0 -0
  210. package/documentation/docs/manual/entities/intro.md +73 -0
  211. package/documentation/docs/manual/entities/rules.md +35 -0
  212. package/documentation/docs/manual/functions/example.yaml +50 -0
  213. package/documentation/docs/manual/functions/functions.md +51 -0
  214. package/documentation/docs/manual/functions/root.yaml +39 -0
  215. package/documentation/docs/manual/images/jbps1.1.png +0 -0
  216. package/documentation/docs/manual/images/jbps1.png +0 -0
  217. package/documentation/docs/manual/images/jbps2.png +0 -0
  218. package/documentation/docs/manual/images/vsc1.png +0 -0
  219. package/documentation/docs/manual/imports.md +59 -0
  220. package/documentation/docs/manual/introduction.md +38 -0
  221. package/documentation/docs/manual/jsonata.md +268 -0
  222. package/documentation/docs/manual/plugin-settings.md +134 -0
  223. package/documentation/docs/manual/plugins/interface.md +226 -0
  224. package/documentation/docs/manual/plugins/introduction.md +256 -0
  225. package/documentation/docs/manual/plugins/root.yaml +51 -0
  226. package/documentation/docs/manual/role-model.md +80 -0
  227. package/documentation/docs/manual/root-cluster-import.md +82 -0
  228. package/documentation/docs/manual/root.yaml +199 -0
  229. package/documentation/docs/manual/rules/exceptions.md +20 -0
  230. package/documentation/docs/manual/rules/exreason.md +3 -0
  231. package/documentation/docs/manual/rules/root.yaml +58 -0
  232. package/documentation/docs/manual/rules/rules.md +8 -0
  233. package/documentation/docs/manual/rules/standard.md +3 -0
  234. package/documentation/docs/manual/rules/validators.md +109 -0
  235. package/documentation/docs/manual/technologies.md +49 -0
  236. package/documentation/docs/root.yaml +32 -0
  237. package/documentation/docs/sequence.puml +48 -0
  238. package/documentation/docs/welcome.md +3 -0
  239. package/documentation/entities/extentions/entity.yaml +136 -0
  240. package/documentation/entities/extentions/templates/people.md +4 -0
  241. package/documentation/entities/interactions/entity.yaml +412 -0
  242. package/documentation/entities/interactions/templates/blank.puml +18 -0
  243. package/documentation/entities/interactions/templates/bpmn.xml +59 -0
  244. package/documentation/entities/interactions/templates/tree.puml +11 -0
  245. package/documentation/entities/root.yaml +33 -0
  246. package/documentation/root.yaml +37 -0
  247. package/metamodel/dochub/entities/aspects/base.yaml +73 -0
  248. package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
  249. package/metamodel/dochub/entities/aspects/components.yaml +52 -0
  250. package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
  251. package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
  252. package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
  253. package/metamodel/dochub/entities/aspects/root.yaml +9 -0
  254. package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
  255. package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
  256. package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
  257. package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
  258. package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
  259. package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
  260. package/metamodel/dochub/entities/components/base.yaml +97 -0
  261. package/metamodel/dochub/entities/components/blank.yaml +64 -0
  262. package/metamodel/dochub/entities/components/contexts.yaml +55 -0
  263. package/metamodel/dochub/entities/components/docs.yaml +50 -0
  264. package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
  265. package/metamodel/dochub/entities/components/index.yaml +17 -0
  266. package/metamodel/dochub/entities/components/root.yaml +8 -0
  267. package/metamodel/dochub/entities/components/summary.yaml +58 -0
  268. package/metamodel/dochub/entities/components/symbol.yaml +113 -0
  269. package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
  270. package/metamodel/dochub/entities/components/templates/summary.md +8 -0
  271. package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
  272. package/metamodel/dochub/entities/components/tree.yaml +38 -0
  273. package/metamodel/dochub/entities/contexts/base.yaml +197 -0
  274. package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
  275. package/metamodel/dochub/entities/contexts/root.yaml +5 -0
  276. package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
  277. package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
  278. package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
  279. package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
  280. package/metamodel/dochub/entities/documents/base.yaml +73 -0
  281. package/metamodel/dochub/entities/documents/blank.yaml +28 -0
  282. package/metamodel/dochub/entities/documents/root.yaml +3 -0
  283. package/metamodel/dochub/entities/root.yaml +5 -0
  284. package/metamodel/dochub/functions/root.yaml +2 -0
  285. package/metamodel/dochub/functions/tools.yaml +46 -0
  286. package/metamodel/dochub/root.yaml +24 -0
  287. package/metamodel/dochub/rules/root.yaml +2 -0
  288. package/metamodel/dochub/rules/validators.yaml +144 -0
  289. package/metamodel/dochub/samples/01_components.yaml +23 -0
  290. package/metamodel/dochub/samples/02_contexts.yaml +23 -0
  291. package/metamodel/dochub/samples/03_documents.yaml +10 -0
  292. package/metamodel/dochub/samples/root.yaml +4 -0
  293. package/metamodel/dochub/samples/test.puml +17 -0
  294. package/metamodel/dochub.yaml +5 -0
  295. package/metamodel/docs/welcome.md +39 -0
  296. package/metamodel/root.yaml +8 -0
  297. package/package.json +28 -0
  298. package/plugin.html +1963 -0
@@ -0,0 +1,50 @@
1
+ # Интеграция с системой продуктовой аналитики ClickStream 📊
2
+
3
+ Если вы используете SEAF.ArchTool в режиме портала, вы можете подключить сбор аналитики и отправлять данные в свой кабинет в ClickStream.
4
+ Это позволит вам отслеживать использование портала, выявлять узкие места и принимать решения на основе реальных данных.
5
+
6
+ На текущий момент функциональность доступна только для компаний группы Сбер.
7
+
8
+ ## О ClickStream 📝
9
+
10
+ **[ClickStream](https://gitverse.ru/clickstream/sdk-info)** - инструмент продуктовой аналитики для получения наглядных отчётов по web или mobile интерфейсам и анализа поведения пользователей.
11
+ Инструмент помогает понять, как пользователи взаимодействуют с продуктом, где сильные, а где слабые стороны, а также определить реальный охват пользователей и более точно сформулировать стратегические цели продукта.
12
+ ClickStream имеет схожий функционал с Яндекс Метрикой, Firebase, AppsFlyer.
13
+
14
+ 🔒Мы не имеем доступа к данным, которые вы собираете у себя. Все хранится и анализируется только в рамках вашего аккаунта.
15
+
16
+ ## Что нужно для подключения 🔑
17
+
18
+ 1. Зарегистрируйтесь в ClickStream и получите API_KEY и REPORT_URL
19
+ 2. В .env укажите эти значения в переменных VUE_APP_CLICKSTREAM_API_KEY и VUE_APP_CLICKSTREAM_REPORT_URL соответственно.
20
+ 3. Готово - события начнут отправляться в ваш кабинет.
21
+
22
+ ## Какие события отправляются и какие отчеты можно из них построить 💡
23
+
24
+ Автоматически отправляются события Просмотр страницы и Время загрузки.
25
+
26
+ Событие просмотр страницы содержит параметры:
27
+ * fromFullPath - путь страницы, с которой был совершен переход на текущую
28
+ * targetFullPath - полный адрес текущей страницы
29
+ * loadTimeMs - скорость загрузки страницы в мс
30
+ * loadTimeMsRange - скорость загрузки страницы, определенная в диапазон
31
+ * platform - платформа
32
+ * componentName - название компонента
33
+
34
+ Событие время загрузки содержит параметры:
35
+ * fromFullPath - путь страницы, с которой был совершен переход на текущую
36
+ * targetFullPath - полный адрес текущей страницы
37
+ * loadTimeMs - скорость загрузки страницы в мс
38
+ * platform - платформа
39
+ * componentName - название компонента
40
+
41
+ Из полученных событий можно построить следующие отчеты:
42
+ * MAU (Monthly Active Users) - количество уникальных пользователей за месяц
43
+ * DAU (Daily Active Users) - количество уникальных пользователей за день
44
+ * Страницы, которые посещал пользователь
45
+ * Количество обращений к странице
46
+ * Скорость загрузки страниц
47
+
48
+ _Список событий может изменяться по мере развития продукта. Все события отправляются в обезличенном виде_
49
+
50
+ Если возникли вопросы - обратитесь к нашей команде или посмотрите [документацию ClickStream](https://gitverse.ru/clickstream/sdk-info).
@@ -0,0 +1,45 @@
1
+ # Компоненты (components)
2
+ Компоненты являются базовыми сущностями SEAF.ArchTool. На их основе автоматически генерируются диаграммы связей.
3
+ Для успешной генерации компоненты содержат необходимые метаданные.
4
+
5
+ Пример описания компонента в манифесте [манифесте](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/arch/components/front.yaml):
6
+ ```yaml
7
+ components:
8
+ #***********************************************************
9
+ # C4Model L1
10
+ #***********************************************************
11
+ archtool.front: # Идентификатор компонента
12
+ title: SEAF.ArchTool # Название компонента
13
+ entity: component # Сущность компонента из PlantUML (https://plantuml.com/ru/deployment-diagram)
14
+ source: ./ # Кастомное поле определенное в forms
15
+ technologies: # Используемые технологии
16
+ - JavaScript
17
+ - VUEJS3
18
+ - Chrome
19
+ - Firefox
20
+ - Safari
21
+ aspects: # Аспекты, которе реализует компонент
22
+ - archtool.gitlab.auth
23
+ - archtool.manifest.parsing
24
+ - archtool.contexts
25
+ - archtool.aspects
26
+ - archtool.docs
27
+ - archtool.navigation
28
+ - archtool.dataset
29
+ links: # Зависимость компонента от других компонентов
30
+ - id: archtool.gitlab # Идентификатор компонента
31
+ direction: '<--' # Напрвлене связи
32
+ title: Манифесты и документы # Надпись на связи
33
+ contract: archtool.swagger # Идентификатор документа описывающего контракт (может быть прямой ссылкой, например: http://foo.com)
34
+ - id: archtool.plantuml
35
+ direction: '-->'
36
+ title: PlantUML
37
+ - id: archtool.plantuml
38
+ direction: '<-'
39
+ title: Схема SVG
40
+ - id: archtool.web
41
+ direction: '<--'
42
+ title: Манифесты и документы
43
+ ```
44
+
45
+ ![Карточка компонента](@component/archtool.front)
@@ -0,0 +1,337 @@
1
+ # Развертывание
2
+
3
+ SEAF.ArchTool поддерживает следующие режимы развертывания:
4
+
5
+ 1. **Plugin** - Плагин IDE (Idea / VSCode). Вся бизнес-логика располагается в плагине;
6
+ 2. **Server Less** - Портал. Вся бизнес-логика располагается на клиенте.
7
+ 3. **Client-Server** - Портал. Основная бизнес-логика располагается на сервере.
8
+ 4. **Cluster** - Ноды в режиме **Client-Server** функционируют в кластере.
9
+
10
+ Режимы имеют свои преимущества и недостатки. Необходимо их рассмотреть детально:
11
+
12
+ ## Plugin
13
+
14
+ Самый простой режим.
15
+
16
+ Скачайте плагин из [репозитория](https://gitverse.ru/seafteam/seaf-archtool-core/releases) и установите.
17
+ Следуйте подсказкам плагина.
18
+
19
+ Вам также поможет статья ["Архитектура рядом с кодом"](https://habr.com/ru/post/659595/).
20
+
21
+ ### Переменные среды
22
+
23
+ * **DOCHUB_IDE_GITLAB_URL** - Адрес Gitlab сервера для интеграции с ним (например, https://gitlab.com/);
24
+ * **DOCHUB_IDE_BITBUCKET_URL** - Адрес Bitbucket сервера для интеграции с ним (например, https://bitbucket.org/);
25
+ * **DOCHUB_IDE_PERSONAL_TOKEN** - Персональный токен, необходимый для доступа к системе управления версиями. Выпускается самой системой (Gitlab/Bitbucket).
26
+
27
+ Переменные среды могут быть переопределены через пользовательский интерфейс в настройках плагина.
28
+
29
+ ### Преимущества
30
+ 1. Развертывание буквально за 2 минуты;
31
+ 2. Встраивание в инструмент производства (IDE);
32
+ 3. Интерактивное отображение воздействия на код архитектуры;
33
+ 4. Разметка кода проекта на объекты архитектурного учета и интерактивное взаимодействие с разметкой;
34
+ 5. Полноценная функциональность.
35
+
36
+ ### Недостатки
37
+ 1. Монопольный режим, актуальный для развития (внесения изменений) в код архитектуры.
38
+
39
+ ### Рекомендации
40
+
41
+ Прекрасно подходит для изучения инструмента.
42
+
43
+ Остается востребованным на всех этапах внедрения SEAF.ArchTool в организации, т.к. позволяет внедрить подход
44
+ "Архитектура как код" в ключевой этап производства - разработку кодовой базы приложений, сервисов
45
+ и инфраструктуры.
46
+
47
+
48
+ ## Server Less
49
+
50
+ [Проект](https://gitverse.ru/seafteam/seaf-archtool-core) собирается как обычный статический сайт командой:
51
+
52
+ ```
53
+ npm run build
54
+ ```
55
+
56
+ В папку ./dist генерируется комплект файлов, который является SEAF.ArchTool WEB-приложением.
57
+ Подробнее о сборке и развертывании смотри [здесь](https://gitverse.ru/seafteam/seaf-bok).
58
+
59
+ Файлы содержащие код архитектуры загружаются по доступным приложению URL при его исполнении в браузере.
60
+
61
+ Проще говоря, если вы развернули сайт на archtool.local, необходимо указать в переменной
62
+ окружения корневой манифест, например:
63
+
64
+ ```
65
+ VUE_APP_DOCHUB_ROOT_MANIFEST=workspace/service/root.yaml
66
+ ```
67
+
68
+ в этом случае, сразу после загрузки приложения в браузере, SEAF.ArchTool попытается загрузить файл
69
+ archtool.local/workspace/service/root.yaml и "выполнить" его. В корневом манифесте могут
70
+ содержаться указания по подключению зависимостей. Например:
71
+
72
+ ```yaml
73
+ imports:
74
+ - docs/root.yaml
75
+ - rules/root.yaml
76
+ - plugins/root.yaml
77
+ ...
78
+ ```
79
+
80
+ Эти файлы также будут загружены.
81
+
82
+ Базовым URL для них будет URL файла "workspace/service/root.yaml".
83
+ Например, для "docs/root.yaml" прямой URL будет - archtool.local/workspace/service/docs/root.yaml
84
+
85
+ Подключаемые файлы также могут содержать команды подключения других файлов. В таком случае цикл повторяется.
86
+
87
+ Таким образом **на клиенте** собирается полная кодовая база архитектуры.
88
+
89
+ Вся бизнес-логика выполняется на клиенте.
90
+
91
+ ### Преимущества
92
+ 1. Минимальное количество серверных ресурсов;
93
+ 2. Минимальное время на разворачивание и конфигурирование (почти все параметры можно оставить по умолчанию);
94
+ 3. При интеграции с GitLab позволяет разделять доступы пользователей на уровне репозиториев.
95
+
96
+ ### Недостатки
97
+ 1. При росте кодовой базы возникает заметная деградация производительности клиентского приложения;
98
+ 2. Не позволяет разделять доступ пользователей на уровне объектов архитектурного учета;
99
+ 3. Не предлагает специального интерфейса интеграции (API), что затрудняет переиспользование архитектурных объектов
100
+ для производственных нужд.
101
+
102
+ ### Рекомендации
103
+
104
+ Данный режим оптимален для изучения инструмента и опытной эксплуатации. С ростом кодовой базы и потребностей,
105
+ рекомендуется мигрировать в режим "Client-Server".
106
+
107
+
108
+ ## Client-Server
109
+
110
+ В этом режиме основная бизнес-логика SEAF.ArchTool исполняется на сервере. К ней относится (но не ограничивается):
111
+
112
+ 1. Загрузка и сборка кодовой базы архитектуры;
113
+ 2. Выполнение JSONata запросов к данным архитектуры;
114
+ 3. Кэширование результатов выполнения JSONata запросов;
115
+ 4. Контроль доступа к архитектурным артефактам (файлы различного назначения) (в разработке);
116
+ 5. Разграничение прав доступа к объектам архитектурного учета (в разработке).
117
+
118
+ Отельно необходимо отметить, что сервер SEAF.ArchTool предоставляет API:
119
+
120
+ 1. **/core/storage/jsonata/:query** - Доступ к кодовой базе (архитектурному Data Lake) через JSONata запросы;
121
+ 2. **/core/storage/validators/** - Доступ к результату работы [валидаторов](/docs/archtool.rules.validators);
122
+ 2. **/entities/:entity/presentations/:presentation*** - Доступ к презентациям
123
+ [сущностей](/docs/archtool.entities) специального типа "upload".
124
+
125
+ Простейшей сборкой SEAF.ArchTool в режиме Client-Server является команда:
126
+
127
+ ```
128
+ npm run backend
129
+ ```
130
+
131
+ При ее выполнении будет собран frontend и запущен backend процесс nodejs в соответствии с конфигурацией среды (см.
132
+ [example.env](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/example.env)).
133
+
134
+ ### Преимущества
135
+ 1. Заметно ускоряет работу пользовательского приложения за счет единоразовой подготовки архитектурной
136
+ кодовой базы на стороне backend;
137
+ 2. Позволяет кэшировать результаты запросов и разделять кэши между пользователями, что значительно
138
+ сокращает отклик приложения на действия пользователя;
139
+ 3. Позволяет регулировать доступ пользователя к объектам архитектурного учета (в разработке);
140
+ 4. Скрывает для пользователя чувствительные конфигурационные денные интеграций, например с хранилищами GitLab;
141
+ 5. Предоставляет API для встраивания SEAF.ArchTool в DevOps процессы.
142
+
143
+ ### Недостатки
144
+ 1. Требует более сложной конфигурации как самого SEAF.ArchTool так и серверных ресурсов для
145
+ стабильного функционирования;
146
+ 2. При сложных связях архитектурного кода, могут потребоваться специальные меры по инвалидации
147
+ кэша (регулярно чистить кэш);
148
+ 3. Перезапуск сервера, при значительных объемах кодовой базы может занимать заметное время,
149
+ что воздействует на всех пользователей.
150
+
151
+
152
+ ### Рекомендации
153
+
154
+ Данный режим разумно использовать при существенных объемах кодовой базы и использовании SEAF.ArchTool
155
+ как инструмента встраиваемого в процессы производства (в DevOps процессы в частности).
156
+
157
+
158
+ ## Cluster
159
+
160
+ **ВНИМАНИЕ!** Данный режим проходит beta-тестирование.
161
+
162
+ Этот режим создан для того, чтобы сервис SEAF.ArchTool был доступен в любое время. В кластере может быть запущено много нод
163
+ в режиме "Client-Server", что обеспечивает доступ к сервису, даже если все, кроме одной ноды, вышли из строя.
164
+
165
+ Также режим позволяет обновлять данные манифестов без приостановки работы сервиса.
166
+
167
+ Функционирование кластера обеспечивается синхронизацией нод через СУБД [Redis](https://redis.io/).
168
+
169
+ ### Компонентная схема работы кластера
170
+
171
+ ```plantuml
172
+ @startuml
173
+ actor "User" as user
174
+ component "Browser" as browser
175
+ component "Balancer" as balancer
176
+
177
+
178
+ package "SEAF.ArchTool кластер" {
179
+ component "Node 1" as node1
180
+ component "Node 2" as node2
181
+ component "Node N" as nodeN
182
+ }
183
+
184
+ database "Redis" as redis
185
+ database "Хранилище\nманифестов" as storage
186
+
187
+ user <-D- browser
188
+ browser <-D- balancer
189
+
190
+ redis <-U-> node1
191
+ redis <-U-> node2
192
+ redis <-U-> nodeN
193
+
194
+ storage -U-> node1
195
+ storage -U-> node2
196
+ storage -U-> nodeN
197
+
198
+ balancer <-D- node1
199
+ balancer <-D- node2
200
+ balancer <-D- nodeN
201
+ @enduml
202
+ ```
203
+
204
+ ### Алгоритм работы кластера
205
+ ```plantuml
206
+ @startuml
207
+ participant SeafArchtoolFront [
208
+ =SEAF.ArchTool
209
+ ----
210
+ ""Front end""
211
+ ]
212
+
213
+ participant Balancer [
214
+ =Balancer
215
+ ----
216
+ ""Балансировщик""
217
+ ]
218
+
219
+ participant SeafArchtoolNode1 [
220
+ =SEAF.ArchTool
221
+ ----
222
+ ""Server node1""
223
+ ]
224
+
225
+ participant SeafArchtoolNode2 [
226
+ =SEAF.ArchTool
227
+ ----
228
+ ""Server node2""
229
+ ]
230
+
231
+
232
+ participant Storage [
233
+ =Storage
234
+ ----
235
+ ""Хранилище""
236
+ ""манифестов""
237
+ ]
238
+
239
+ participant Redis [
240
+ =Redis
241
+ ----
242
+ ""Медиатор""
243
+ ""кластера""
244
+ ]
245
+
246
+ group Старт или перезагрузка ноды Server node1
247
+ SeafArchtoolFront -> Balancer: Запрос
248
+ Balancer -> SeafArchtoolNode1: Попытка запроса
249
+
250
+ note over of SeafArchtoolNode1: Пока нода не готова, она будет отдавать на запросы код 503
251
+ Balancer <- SeafArchtoolNode1: 503 временно недоступно
252
+ Balancer -> Balancer: Переключение на другую ноду
253
+ Balancer -> SeafArchtoolNode2: Попытка запроса
254
+ Balancer <- SeafArchtoolNode2: 200 результат
255
+ SeafArchtoolFront <- Balancer: Результат
256
+
257
+ SeafArchtoolNode1 <-Storage: Загрузка манифестов
258
+ SeafArchtoolNode1 -> SeafArchtoolNode1: Вычисление HASH состояния
259
+ SeafArchtoolNode1 -> Redis: Запись HASH по ключу DocHub.cluster.hash
260
+ note over of SeafArchtoolNode1: По завершению загрузки нода будет отвечать с кодом 200
261
+ end
262
+
263
+ group Синхронизация Server node2
264
+ SeafArchtoolFront -> Balancer: Запрос
265
+ Balancer -> SeafArchtoolNode2: Попытка запроса
266
+ SeafArchtoolNode2 <- Redis: Получение HASH
267
+ note right of SeafArchtoolNode2: При каждом запросе к ноде она\n сверяет локальный HASH состояния с Redis
268
+ SeafArchtoolNode2 <- SeafArchtoolNode2: Сверка HASH
269
+ SeafArchtoolNode2 <- SeafArchtoolNode2: Обнаружено расхождение
270
+ note right of SeafArchtoolNode2: При обнаружении расхождения,\nзапускается процесс обновления данных манифестов\nОтдается ответ 503
271
+ Balancer <- SeafArchtoolNode2: 503 временно недоступно
272
+
273
+ Balancer -> Balancer: Переключение на другую ноду
274
+ Balancer -> SeafArchtoolNode1: Попытка запроса
275
+ Balancer <- SeafArchtoolNode1: 200 результат
276
+ SeafArchtoolFront <- Balancer: Результат
277
+
278
+ SeafArchtoolNode2 <-Storage: Загрузка манифестов
279
+ SeafArchtoolNode2 -> SeafArchtoolNode2: Вычисление HASH состояния
280
+ SeafArchtoolNode2 -> Redis: Запись HASH по ключу SeafArchtool.cluster.hash
281
+ note over of SeafArchtoolNode2: По завершению загрузки нода будет отвечать с кодом 200
282
+
283
+ end
284
+
285
+
286
+ @enduml
287
+
288
+ ```
289
+
290
+ ### Преимущества
291
+ 1. Предоставляет все преимущества развертывания в режиме Client-Server;
292
+ 2. Обеспечивает высокую надежность сервиса и дополнительное повышение производительности за
293
+ счет горизонтального масштабирования;
294
+ 3. Обеспечивает работу сервиса без простоя в период обновления данных.
295
+
296
+ ### Недостатки
297
+ 1. Требует развертывания инфраструктуры отказоустойчивости: балансировщик, Redis;
298
+ 2. При сложных связях архитектурного кода, могут потребоваться специальные меры по инвалидации
299
+ кэша (регулярно чистить кэш).
300
+
301
+
302
+ ### Рекомендации
303
+
304
+ Кластер рекомендуется применять при высоких требованиях к уровню сервиса по надежности и производительности.
305
+
306
+ ### Конфигурирование
307
+
308
+ Для перевода группы серверов в режиме Client-Server в кластер, необходимо:
309
+
310
+ 1. Развернуть СУБД [Redis](https://redis.io/);
311
+ 2. Развернуть балансировщик и настроить его. Например, можно использовать
312
+ [nginx](https://nginx.org/ru/docs/http/ngx_http_upstream_module.html) ;
313
+ 3. Добавить в конфигурацию серверов параметры:
314
+
315
+ ```
316
+ # Формат URL подключения: redis[s]://[[username][:password]@][host][:port][/db-number]
317
+ VUE_APP_DOCHUB_REDIS_URL=redis://alice:foobared@awesome.redis.server:6380
318
+ VUE_APP_DOCHUB_CLUSTER=on
319
+ ```
320
+ 4. Перезапустить серверы.
321
+
322
+
323
+ ## Файлы переменных среды исполнения
324
+
325
+ Файлы конфигурации среды исполнения:
326
+ ```text
327
+ .env # загружается во всех случаях
328
+ .env.local # загружается во всех случаях, игнорируется git
329
+ .env.[mode] # загружается только в указанном режиме работы
330
+ .env.[mode].local # загружается только в указанном режиме работы, игнорируется git
331
+ ```
332
+ [Больше информации](https://cli.vuejs.org/ru/guide/mode-and-env.html)
333
+
334
+ ## Переменные среды исполнения и примеры конфигураций
335
+
336
+ Актуальные параметры конфигурирования смотрите в файле
337
+ [example.env](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/example.env)
@@ -0,0 +1,17 @@
1
+ @startuml
2
+ database "Code" as code
3
+ participant "Source" as middlware
4
+ participant "Context" as context
5
+ participant "PlantUML server" as server
6
+
7
+ code->middlware: Код архитектуры
8
+ middlware->middlware: Преобразование
9
+ middlware->context: Преобразованный код
10
+ context->context: Применение фильтра
11
+ context->context: Генерация PlantUML
12
+ context->server: PlantUML
13
+ server->server: Генерация диаграммы
14
+ server->context: SVG диаграмма
15
+ context->context: Постобработка
16
+ context->context: Демонстрация
17
+ @enduml
@@ -0,0 +1,200 @@
1
+ # Контексты представлений (contexts)
2
+ Имеет смысл отображать [компоненты](/docs/archtool.components) архитектуры в контексте их рассмотрения. Например, если рассматривается
3
+ архитектура приложения, нет смысла отображать компоненты сетевой архитектуры на той же схеме.
4
+ Разумно разделить эти представления. Контексты позволяют решить эту задачу.
5
+
6
+ Можно сказать, что контексты реализуют идею [C4 Model](https://ru.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D0%B5%D0%BB%D1%8C_C4).
7
+ Отличие состоит в том, что контексты не ограничивают вас в количестве уровней представления.
8
+
9
+ Структура манифеста контекста:
10
+ ```yaml
11
+ contexts: # Контексты представления архитектурных компонентов
12
+ archtool: # Идентификатор контекста
13
+ title: Общая архитектура SEAF.ArchTool # Название контекста. Отображается в заголовке диаграммы
14
+ location: SEAF.ArchTool/Общая архитектура # Размещение документа в дереве навигации
15
+ extra-links: false # Указывает, что не нужно отображать компоненты явно не указанные в контексте
16
+ components: # Компоненты входящие в контекст
17
+ - archtool.front # Идентификатор компонента
18
+ uml: # PlantUML инъекции
19
+ $before: > # Вставляет код ПЕРЕД сгенерированным телом диаграммы
20
+ ...
21
+ $after: > # Вставляет код ПОСЛЕ сгенерированным телом диаграммы
22
+ ...
23
+ uml: ../docs/sequence.puml # Ссылка на файл с PlantUML кодом полностью переопределяет представление
24
+ ```
25
+ Чтобы понять это лучше, рассмотрим SEAF.ArchTool в C4 Model:
26
+
27
+ ![](@anchor/c4model_1)
28
+
29
+ ## 1. Уровень I: Система в масштабе ее взаимодействия с пользователями и другими системами
30
+
31
+ ![Система в масштабе ее взаимодействия с пользователями и другими системами](@context/archtool)
32
+
33
+ Описание контекста в манифесте [манифесте](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/arch/contexts.yaml):
34
+ ```yaml
35
+ contexts:
36
+ archtool: # Идентификатор контекста
37
+ title: Общая архитектура SEAF.ArchTool # Название контекста
38
+ location: SEAF.ArchTool # Размещение документа в дереве навигации
39
+ components: # Компоненты входящие в контекст
40
+ - archtool.front
41
+ - archtool.user
42
+ - archtool.plantuml
43
+ - archtool.gitlab
44
+ - archtool.web
45
+ ...
46
+ ```
47
+ Это простейшее описание контекста. По сути, контекст описывает какие компоненты будут отображаться на схеме,
48
+ под каким названием и где пользователь сможет найти контекст в навигационном меню. Связи между компонентами описаны
49
+ в самих компонентах (см. [компоненты](/docs/archtool.components)).
50
+
51
+ Обратите внимание, что внизу компонента "DocHub" есть символы ">>". Кликнув по ним, вы "провалитесь" внутрь компонента.
52
+
53
+ ![](@anchor/c4model_2)
54
+
55
+ ## 2. Уровень II: Взаимосвязанные контейнеры
56
+ ![Взаимосвязанные контейнеры](@context/archtool.front)
57
+
58
+ Описание контекста в манифесте [манифесте](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/arch/contexts.yaml?line=56):
59
+ ```yaml
60
+ contexts: # Контексты представления архитектурных компонентов
61
+ ...
62
+ archtool.front:
63
+ title: Контейнерная архитектура SEAF.ArchTool
64
+ location: SEAF.ArchTool/Контейнерная архитектура
65
+ components:
66
+ - archtool.browser.localstorage
67
+ - archtool.front.spa
68
+ - archtool.gitlab.api
69
+ - archtool.gitlab.oauth
70
+ - archtool.gitlab.repository
71
+ - archtool.gitlab.gitclient
72
+ - archtool.plantuml.jar
73
+ - archtool.web
74
+ ...
75
+ ```
76
+ ![](@anchor/c4model_3)
77
+
78
+ ## 3. Уровень III: Взаимосвязанные компоненты
79
+ ![Взаимосвязанные компоненты](@context/archtool.front.spa)
80
+
81
+ Описание контекста в манифесте [манифесте](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/arch/contexts.yaml?line=65):
82
+ ```yaml
83
+ contexts: # Контексты представления архитектурных компонентов
84
+ ...
85
+ archtool.front.spa:
86
+ title: Компонентная архитектура SEAF.ArchTool
87
+ location: SEAF.ArchTool/Компонентная архитектура
88
+ components:
89
+ - archtool.front.spa.*
90
+ ...
91
+ ```
92
+
93
+ Обратите внимение, что компоненты в контекст можно включать по маске.
94
+ Звездочка в конце предполагает включение всех компонентов этого уровня в контекст.
95
+
96
+ Также, допустимой маской является такая запись:
97
+
98
+ ```
99
+ archtool.*.spa.*
100
+ ```
101
+
102
+ Если указывается двойная звездочка, то отбираются все компоненты текущего и нижележащих уровней.
103
+
104
+ Например, так:
105
+
106
+ ```
107
+ archtool.**
108
+ ```
109
+
110
+ ## 4. Уровень IV: дополнительные сведения о дизайне архитектурных элементов
111
+ ![дополнительные сведения о дизайне архитектурных элементов](@context/archtool.sequence)
112
+
113
+ Описание контекста в манифесте [манифест](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/arch/contexts.yaml?line=93):
114
+ ```yaml
115
+ contexts: # Контексты представления архитектурных компонентов
116
+ ...
117
+ archtool.sequence:
118
+ title: Диаграмма взаимодействия SEAF.ArchTool
119
+ location: SEAF.ArchTool/Диаграмма взаимодействия
120
+ presentation: plantuml # Явно определяет используемую презентацию контекста
121
+ uml: ../docs/sequence.puml # Ссылка на файл с кодом PlantUML
122
+ ...
123
+ ```
124
+ Стандартным методом представления контекстов является автоматическая генерация PlantUML кода на основании манифеста
125
+ контекста, где перечисленны компоненты. Компоненты содержат достаточную информацию для построения диаграммы связей.
126
+ Но в некоторых случаях, нет необходимости в таком подходе. Например, если необходимо описать диаграмму взаимодействия
127
+ (как здесь). Другим примером может стать концептуальное проектирование. В этом случае до утверждения схемы,
128
+ нет необходимости генерировать манифесты компонентов.
129
+
130
+ Контексты позволяют переопределить представление на PlantUML код. В этом случае в поле "uml" указывается ссылка на
131
+ файл, содержащий код.
132
+
133
+ ## 5. Источник данных для контекста
134
+ По умочанию, источником данных для контекста является весь код архитектуры. На этот источник накладывается
135
+ фильтр, параметры для которого указываются в манифесте контекста. Например, в поле "components" определяются
136
+ какие компоненты должны отображаться.
137
+
138
+ Но есть возможность до того, как будет применен фильтр, преобразовать данные. Для этого необходимо
139
+ переопределить источник. Сделать это можно используя поля "source" и "original", аналогично [таблицам](/docs/archtool.tables).
140
+
141
+ ```yaml
142
+ ...
143
+ archtool.custom:
144
+ title: Компоненты эксперта R.Piontik
145
+ location: SEAF.ArchTool/Контекст по источнику
146
+ extra-links: false # Отключаем вывод связанных компонентов, явно не определенных в контексте
147
+ # Определяем источник данных для контекста.
148
+ source: > # Отбираем все компоненты у которых кастомное поле "expert" = "R.Piontik"
149
+ (
150
+ $ ~> | $ | {
151
+ "components": $merge(components.$spread().(
152
+ $.*.expert = 'R.Piontik' ? $ : {}
153
+ ))
154
+ } |
155
+ )
156
+ components:
157
+ - archtool.* # Выводим все компоненты домена archtool
158
+ ...
159
+ ```
160
+
161
+ В данном примере код архитектуры преобразуется с целью выбора компонентов, экспертом по которым является R.Piontik.
162
+ Поведение будет таким:
163
+
164
+ ![Источник данных контекста](@document/archtool.context.source)
165
+
166
+
167
+ Фильтр по компонентам будет применятся уже к подготовленным данным источником.
168
+ Результат:
169
+
170
+ ![Компоненты в которых эксперт R.Piontik](@context/archtool.custom)
171
+
172
+ ## 6. Использование uml опций
173
+
174
+ Есть возможность дополнять контекст PlantUML кодом по своему желанию с использованием опций секции uml.
175
+
176
+ ```yaml
177
+ ...
178
+ archtool.uml_options:
179
+ title: Демонстрация UML опций контекста
180
+ uml:
181
+ $before: > # Добавляем легенду в контекст
182
+ legend top left
183
+ Легенда, которая будет выводиться
184
+ вне зависимости от результата работы контекста
185
+ end legend
186
+ $after: > # Добавляем произвольный компонент в диаграмму
187
+ component "Произвольный компонент" as test
188
+ components: # Компоненты входящие в контекст
189
+ - archtool.front
190
+ - archtool.user
191
+ - archtool.plantuml
192
+ - archtool.gitlab
193
+ - archtool.web
194
+ ...
195
+ ```
196
+
197
+ В результате мы увидим дополнения к автоматически построенной диаграмме:
198
+
199
+ ![uml опции контекста](@context/archtool.uml_options)
200
+