@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,73 @@
1
+ # Адаптивная метамодель
2
+
3
+ Архитектурная функция эволюционирует в соответствии с потребностями бизнес-единицы в которой она реализуется.
4
+ SEAF.ArchTool обеспечивает адаптивность метамодели для удовлетворения этих потребностей на всех этапах развития.
5
+
6
+ Подробно [здесь](https://habr.com/ru/post/701050/).
7
+
8
+ ## Концепция
9
+
10
+ Идея адаптивной метамодели заложена в утверждение - **Идеальной метамодели и нотации не существует.**
11
+
12
+ ![Область применения метамодели](images/landspace.jpeg)
13
+
14
+ Наглядно видно, что метамодель это артефакт предметной области. Наличие формализованной метамодели зависит от уровня
15
+ ее зрелости и цифровизации в ней.
16
+
17
+ Помимо этого, чем менее зрелой предметная область является, тем выше у нее потенциал роста и мутабельность.
18
+
19
+ Единая метамодель, при такой оценке реальности, неприменима. Необходимо узаконить очевидный факт - метамодель
20
+ должна меняться и быть оптимальной как для предметной области так и для ее этапа зрелости. Уметь адаптироваться.
21
+
22
+ Также, метамодель обязана уметь связывать объекты различных предметных областей т.к. они часто "соприкасаются"
23
+ в архитектурном ландшафте.
24
+
25
+ В отличии от многих инструментов управления архитектурой, SEAF.ArchTool не имеет жесткой, предопределенной метамодели и нотации.
26
+ Вместо этого архитектору предоставляется свобода выбора и инструменты развития частной метамодели.
27
+
28
+ Решается это через:
29
+ 1. **Entity** - Сущность предметной области. Например: "Стейкхолдер"; "Сервер"; "Информационный актив" и т.д.
30
+ Проще всего сказать, что это класс объекта в ООП. Но однозначное применение ООП здесь неуместно;
31
+ 2. **Rules** - Правила, позволяющие контролировать реализацию метамодели;
32
+ 3. **Metamodel Bundle** - Пакет расширения метамодели. Содержат в себе комплекты сущностей, [валидаторы](/docs/archtool.rules.validators)
33
+ , а также предопределенные объекты и документы. В качестве аналогии здесь можно привести библиотеки
34
+ в языках программирования;
35
+
36
+ ## Entity
37
+
38
+ Сущность формализует объекты предметной области, их взаимоотношения, а также представляет их в необходимой форме.
39
+
40
+ ```yaml
41
+ entities: # Раздел описания сущностей метамодели
42
+ interactions: # Идентификатор сущности в метамодели
43
+ # Матаданные самой сущности
44
+ title: ... # Название сущности.
45
+ description: ... # Описание сущности.
46
+ menu: ... # Если сущность должна встраиваться в меню, здесь описывается ее размещение.
47
+ presentations: ... # Представления объектов сущности. Представлением может быть любой тип документа.
48
+ schema: ... # Декларативное описание схемы метамодели объектов сущности.
49
+ ```
50
+
51
+ Подробный пример описания можно найти [тут](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/entities/interactions/entity.yaml). Также можно изучить пример реализации нотации
52
+ [C4 Model](https://github.com/rpiontik/DocHubExamples/tree/main/src/C4Model) и пример расширения презентаций уже существующих
53
+ сущностей путем встраивания [виджетов](https://github.com/rpiontik/DocHubExamples/tree/main/src/widgets).
54
+
55
+ ## Metamodel Bundle
56
+
57
+ Бандл метамодели - самодостаточная, отчуждаемая часть кода архитектуры. Он может содержать все то же, что обычный код.
58
+ Целью его создания является - переиспользование архитектурного кода в сторонних архитектурных кодовых базах
59
+ в качестве зависимости.
60
+
61
+ Подробнее [здесь](/docs/archtool.flex_metamodel.bundle).
62
+
63
+ ## Частная метамодель
64
+
65
+ Частная метамодель, это ансамбль необходимых **вам** бандлов, их расширений, а также описаний сущностей выполненных
66
+ **вами** для нужд **вашей предметной области**.
67
+
68
+ Такой подход гарантирует адекватность метамодели действительным потребностям бизнес-единицы. Дает возможность удовлетворить их
69
+ как в настоящем, так и в будущем. Создает условия для успешности архитектора в поставки ценности от управления
70
+ архитектурой в адекватной форме и качестве.
71
+
72
+
73
+
@@ -0,0 +1,35 @@
1
+ # Ролевая модель
2
+
3
+ Ролевая модель - позволяет разграничивать доступы к элементам архитектуры.
4
+ Управление ролями пользователей происходит на стороне keycloack.
5
+
6
+ Для включения работы с ролевой моделью требуется установить следующий флаг:
7
+ VUE_APP_DOCHUB_ROLES_MODEL=y
8
+
9
+ Описание ролей осуществляется в корневом файле roles.yaml
10
+ Пример описания правил доступа:
11
+ ```
12
+ roles:
13
+ users:
14
+ - '^kadzo.v2023.data_objects*$' // Правило представляет собой регулярное выражение
15
+ - '^ecogroup.berezka.data_objects[a-zA-Z\._0-9]*$'
16
+ uek:
17
+ - '^kadzo\.v2023\.kb_systems[a-zA-Z\._0-9]*$'
18
+ - '^ecogroup.berezka.kb[a-zA-Z\._0-9]*$'
19
+ default:
20
+ - '^kadzo\.v2023\.data_objects*$'
21
+ ```
22
+ VUE_APP_DOCHUB_ROLES=file:///workspace/sberauto/roles.yaml
23
+
24
+ Если пользователь имеет несколько ролей, то наборы правил объединяются.
25
+
26
+ Для работы ролевой модели требуется дополнительно указать в файле .env несколько параметров:
27
+
28
+ ```
29
+ Указываем путь до сервера аутентификации с указанием realms
30
+ VUE_APP_DOCHUB_AUTHORITY_SERVER=https://dochub-server.ru/realms/dochub
31
+ Указываем client id, например: dochub
32
+ VUE_APP_DOCHUB_AUTHORITY_CLIENT_ID={CLIENTID}
33
+ {PUBLIC KEY} - указываем public key, смотрим настройки keycloack
34
+ VUE_APP_DOCHUB_AUTH_PUBLIC_KEY=-----BEGIN PUBLIC KEY-----{PUBLIC KEY}-----END PUBLIC KEY-----
35
+ ```
@@ -0,0 +1,50 @@
1
+ # Copyright (C) 2023 owner Roman Piontik R.Piontik@mail.ru
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # In any derivative products, you must retain the information of
10
+ # owner of the original code and provide clear attribution to the project
11
+ #
12
+ # https://dochub.info
13
+ #
14
+ # The use of this product or its derivatives for any purpose cannot be a secret.
15
+ #
16
+ # Unless required by applicable law or agreed to in writing, software
17
+ # distributed under the License is distributed on an "AS IS" BASIS,
18
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ # See the License for the specific language governing permissions and
20
+ # limitations under the License.
21
+ #
22
+ # Maintainers:
23
+ # R.Piontik <r.piontik@mail.ru>
24
+ #
25
+ # Contributors:
26
+ # R.Piontik <r.piontik@mail.ru> - 2023
27
+
28
+ functions:
29
+ demo_summ:
30
+ title: Простой пример сложения массива
31
+ # Входящие параметры
32
+ params:
33
+ # Для каждого параметра описывается JSONSchema
34
+ - alias: items # Если задан alias, в функции будет доступна переменная с этим идентификатором
35
+ type: array # Требуем на вход массив
36
+ items:
37
+ type: number # Элементы массива должны быть числами
38
+ minItems: 1 # Минимум должен быть 1 элемент массива
39
+ title: Объект конвертации
40
+ required: true # Признак обязательности параметра функции
41
+ # JSONSchema схема результата. Не обязательно.
42
+ result:
43
+ type: number
44
+ # Код функции
45
+ code: >
46
+ (
47
+ /* В items будет передан массив значений для суммирования */
48
+ /* Для реализации функции используется встроенная функция JSONata $sum() */
49
+ $sum(items)
50
+ )
@@ -0,0 +1,51 @@
1
+ # Функции (functions)
2
+
3
+ **ВНИМАНИЕ: Функционал в beta тестировании.**
4
+
5
+ Функции необходимы для декларирования операций, которые могут быть вызваны из JSONata запросов.
6
+ Они способны принимать параметры, обрабатывать данные и возвращать результаты, контролируя
7
+ структуру данных на входе и выходе.
8
+
9
+ Рекомендуется использовать функции для упрощения кода, повышения его читабельности, оптимизации и надежности.
10
+
11
+ Простой пример функции:
12
+ ```yaml
13
+ functions:
14
+ demo_summ:
15
+ title: Простой пример сложения массива
16
+ # Входящие параметры
17
+ params:
18
+ # Для каждого параметра описывается JSONSchema
19
+ - alias: items # Если задан alias, в функции будет доступна переменная с этим идентификатором
20
+ type: array # Требуем на вход массив
21
+ items:
22
+ type: number # Элементы массива должны быть числами
23
+ minItems: 1 # Минимум должен быть 1 элемент массива
24
+ title: Объект конвертации
25
+ required: true # Признак обязательности параметра функции
26
+ # JSONSchema схема результата. Не обязательно.
27
+ result:
28
+ type: number
29
+ # Код функции
30
+ code: >
31
+ (
32
+ /* В items будет передан массив значений для суммирования */
33
+ /* Для реализации функции используется встроенная функция JSONata $sum() */
34
+ $sum(items)
35
+ )
36
+ ```
37
+
38
+ После декларирования функции ее можно вызвать из JSONata запроса:
39
+ ```JSONata
40
+ $demo_summ([1,2,3,4,5,15])
41
+ ```
42
+
43
+ Результатом выполнения запроса будет:
44
+ ```
45
+ 30
46
+ ```
47
+
48
+ Для самостоятельного тестирования работы функции воспользуйтесь [редактором запросов](/devtool).
49
+
50
+
51
+
@@ -0,0 +1,39 @@
1
+ # Copyright (C) 2023 owner Roman Piontik R.Piontik@mail.ru
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # In any derivative products, you must retain the information of
10
+ # owner of the original code and provide clear attribution to the project
11
+ #
12
+ # https://dochub.info
13
+ #
14
+ # The use of this product or its derivatives for any purpose cannot be a secret.
15
+ #
16
+ # Unless required by applicable law or agreed to in writing, software
17
+ # distributed under the License is distributed on an "AS IS" BASIS,
18
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ # See the License for the specific language governing permissions and
20
+ # limitations under the License.
21
+ #
22
+ # Maintainers:
23
+ # R.Piontik <r.piontik@mail.ru>
24
+ #
25
+ # Contributors:
26
+ # R.Piontik <r.piontik@mail.ru> - 2023
27
+
28
+ imports:
29
+ - example.yaml
30
+ docs:
31
+ archtool.functions:
32
+ location: SEAF.ArchTool/Руководство/Функции
33
+ description: Пользовательские функции
34
+ type: markdown
35
+ subjects:
36
+ - archtool.front
37
+ - archtool.front.spa
38
+ - archtool.front.backend
39
+ source: functions.md
@@ -0,0 +1,59 @@
1
+ # Импорт манифестов (imports)
2
+ Существует возможность описать всю архитектуру в одном файле. Но работа с ним имеет
3
+ ряд недостатков:
4
+ 1. В объемном файле сложно контролировать вносимые изменения;
5
+ 2. Устранение конфликтов усложняется, т.к. над одним файлом могут работать срезу несколько человек;
6
+ 3. Обозримость описания архитектуры значительно ухудшается.
7
+
8
+ Рекомендуется использовать структуру файлов и папок для устранения этих недостатков. Например,
9
+ в отдельном файле развивать компоненты, документы, аспекты и т.д. Это позволяет сделать секция "import".
10
+ Файловая структура может быть такой:
11
+ ```text
12
+ ./docs/doc1.md - документ 1
13
+ ./docs/doc2.pml - документ 2
14
+ ./docs/root.yaml - манифест, подключающий документы doc1, doc2
15
+ ./aspects.yaml - архитектурные аспекты
16
+ ./contexts.yaml - контексты представления архитектуры
17
+ ./components.yaml - архитектурные компоненты
18
+ ./technologies.yaml - технологический стек
19
+ ./root.yaml - корневой манифест, содержащий только секцию "import"
20
+ ./namespaces.yaml - пространства имен (устарело)
21
+ ```
22
+
23
+ В этом случае корневой манифест (root.yaml) будет выглядеть так:
24
+
25
+ ```yaml
26
+ imports:
27
+ - aspects.yaml
28
+ - contexts.yaml
29
+ - components.yaml
30
+ - docs/root.yaml
31
+ - technologies.yaml
32
+ - namespaces.yaml # устарело
33
+ ```
34
+
35
+ В этом случае, манифест компонентов (components.yaml) может быть таким:
36
+ ```yaml
37
+ components:
38
+ ...
39
+ namespace.component3:
40
+ title: Services
41
+ entity: component
42
+ technologies:
43
+ - Go
44
+ presentations:
45
+ - contexts:
46
+ - namespace.general
47
+ ...
48
+ ```
49
+
50
+ Подключение дополнительных манифестов возможно из сторонних репозиториев **того же** инстанса GitLab,
51
+ а также с web-ресурсов по http/https протоколу. Например:
52
+
53
+ ```yaml
54
+ imports:
55
+ - https://dochub.info/documentation/root.yaml
56
+ - gitlab:43847396:master@root.yaml
57
+ ```
58
+
59
+
@@ -0,0 +1,38 @@
1
+ # Введение
2
+
3
+ Описание архитектуры осуществляется через манифесты. Поддерживаются два формата файлов: JSON и YAML.
4
+ Предпочтительным является формат YAML. Этот формат поддерживает комментарии, что существенно упрощает описание
5
+ архитектуры.
6
+
7
+ Пример манифеста можно посмотреть в поставке (./public/documentation). Он описывает
8
+ архитектуру SEAF.ArchTool. Манифест состоит из разделов:
9
+ * **[import](/docs/archtool.imports)** -
10
+ Позволяет подключать дополнительные манифесты.
11
+ * **[components](/docs/archtool.components)** -
12
+ Архитектурные компоненты.
13
+ * **[contexts](/docs/archtool.contexts)** -
14
+ Контексты представления архитектурных компонентов. Позволяет выделить группу
15
+ компонентов и отобразить ее по смыслу заложенному в контекст. Например, выделить
16
+ все компоненты инфраструктуры. Через контексты реализуется смысл
17
+ [C4 Model](https://ru.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D0%B5%D0%BB%D1%8C_C4).
18
+ * **[aspects](/docs/archtool.aspects)** -
19
+ Архитектурные аспекты. Позволяют выделить и отобразить на схеме компоненты
20
+ реализующие, например, бизнес-функцию.
21
+ * **[docs](/docs/archtool.docs)** -
22
+ Документы необходимые для детального описания архитектуры. Например, контракты в
23
+ формате [OpenAPI](/docs/archtool.swagger), [AsyncApi](/docs/archtool.asyncapi) событийно-ориентированные сервисы, [PlantUML](/docs/archtool.plantuml) диаграммы,
24
+ [Markdown](/docs/archtool.markdown) документация и аналитические [таблицы](/docs/archtool.tables).
25
+ * **[datasets](/docs/archtool.datasets)** -
26
+ Источники данных. Позволяют делать запросы к [данным архитектуры](/docs/archtool.datasets#query-to-data-arch) и внешним рескрсам.
27
+ * **[functions](/docs/archtool.functions)** -
28
+ Функции. Позволяют декларировать операции для последующего использования в JSONata запросах.
29
+ * **[rules](/docs/archtool.rules)** -
30
+ Архитектурные правила. Позваляют определить правила, которым должен отвечать код архитектуры.
31
+ * **[entities](/docs/archtool.flex_metamodel.entities)** -
32
+ Сущности расширенной метамодели. Позволяют создавать уникальные сущности метамодели или расширять существующие.
33
+
34
+ # Термины и определения
35
+
36
+ * **Архитектурный компонент** - атомарный элемент представления архитектуры на диаграмме.
37
+ * **Архитектурный объект** - выраженный манифестом архитектурный компонент.
38
+ * **Манифест** - структурированный файл, в котором описываются архитектурные компоненты и связи между ними.
@@ -0,0 +1,268 @@
1
+ # Расширение JSONata
2
+
3
+ Проект использует язык запросов [JSONata](https://jsonata.org/) для анализа данных архитектуры.
4
+
5
+ Для решения специфических задач инстурумента, базовая поставка JSONata расширена дополнительными функциями
6
+ и переменными.
7
+
8
+ ## Дополнительные функции
9
+
10
+ ### $mergedeep()
11
+
12
+ Сигнатура: $mergedeep(array<object>)
13
+
14
+ Объединяет несколько структур в одну. В отличии от $merge, объединение происходит на всех уровнях
15
+ вложенности, а не только на первом.
16
+
17
+ Запрос:
18
+ ```json
19
+ $mergedeep([
20
+ {
21
+ "key1": 1,
22
+ "struct1": {
23
+ "key2": 1,
24
+ "key3": 2,
25
+ "struct2": {
26
+ "key4": 1,
27
+ "key5": 2
28
+ }
29
+ }
30
+ },
31
+ {
32
+ "key1": 1,
33
+ "struct1": {
34
+ "key6": 1,
35
+ "key7": 2,
36
+ "struct2": {
37
+ "key8": 1,
38
+ "key9": 2
39
+ }
40
+ }
41
+ }
42
+ ])
43
+ ```
44
+
45
+ приведет к результату:
46
+ ```json
47
+ {
48
+ "key1": 1,
49
+ "struct1": {
50
+ "key2": 1,
51
+ "key3": 2,
52
+ "struct2": {
53
+ "key4": 1,
54
+ "key5": 2,
55
+ "key8": 1,
56
+ "key9": 2
57
+ },
58
+ "key6": 1,
59
+ "key7": 2
60
+ }
61
+ }
62
+ ```
63
+
64
+ В то время, как запрос:
65
+
66
+ ```json
67
+ $merge([
68
+ {
69
+ "key1": 1,
70
+ "struct1": {
71
+ "key2": 1,
72
+ "key3": 2,
73
+ "struct2": {
74
+ "key4": 1,
75
+ "key5": 2
76
+ }
77
+ }
78
+ },
79
+ {
80
+ "key1": 1,
81
+ "struct1": {
82
+ "key6": 1,
83
+ "key7": 2,
84
+ "struct2": {
85
+ "key8": 1,
86
+ "key9": 2
87
+ }
88
+ }
89
+ }
90
+ ])
91
+ ```
92
+
93
+ к другому результату:
94
+ ```json
95
+ {
96
+ "key1": 1,
97
+ "struct1": {
98
+ "key6": 1,
99
+ "key7": 2,
100
+ "struct2": {
101
+ "key8": 1,
102
+ "key9": 2
103
+ }
104
+ }
105
+ }
106
+ ```
107
+
108
+ ### $jsonschema()
109
+
110
+ Сигнатура: $jsonschema(object)
111
+
112
+ На базе [JSON schema](https://json-schema.org/) создает валидатор, который можно использовать
113
+ для проверки структуры данных. Реализация функции основана на NPM пакете [ajv](https://www.npmjs.com/package/ajv).
114
+
115
+ В параметре **object** передается схема. Возвращается функция-валидатор. Пример использования:
116
+
117
+ ```json
118
+ (
119
+ /* Создаем валидатор */
120
+ $validator := $jsonschema({
121
+ "type": "object",
122
+ "properties": {
123
+ "foo": { "type": "integer" },
124
+ "bar": { "type": "string"}
125
+ },
126
+ "required": ["foo"],
127
+ "additionalProperties": false
128
+ });
129
+
130
+ /* Проверяем структуру */
131
+ $validator({
132
+ "foo": "error",
133
+ "bar": "abc"
134
+ });
135
+ )
136
+ ```
137
+
138
+ Результат:
139
+ ```json
140
+ [
141
+ {
142
+ "instancePath": "/foo",
143
+ "schemaPath": "#/properties/foo/type",
144
+ "keyword": "type",
145
+ "params": {
146
+ "type": "integer"
147
+ },
148
+ "message": "должно быть integer"
149
+ }
150
+ ]
151
+ ```
152
+
153
+ В фукнцию может быть передана схема с использованием $rels (см. [entities](/entities/docs/blank?dh-doc-id=archtool.flex_metamodel.entities))
154
+ ```json
155
+ /* Создаём валидатор */
156
+ $validator := $jsonschema({
157
+ "type": "object",
158
+ "properties": {
159
+ "foo": { "$ref": "#/$rels/customer.foo" },
160
+ "bar": { "type": "string"}
161
+ },
162
+ "$rels": {
163
+ "customer.foo": {
164
+ "type": "string",
165
+ "enum": ["foo", "dochub.foo"]
166
+ }
167
+ }
168
+ });
169
+
170
+ /* Проверяем структуру */
171
+ $validator({
172
+ "foo": "error",
173
+ "bar": "abc"
174
+ });
175
+ ```
176
+
177
+ Результат:
178
+ ```json
179
+ [
180
+ {
181
+ "instancePath": "/foo",
182
+ "schemaPath": "#/$rels/customer.foo/enum",
183
+ "keyword": "enum",
184
+ "params": {
185
+ "allowedValues": [
186
+ "foo",
187
+ "dochub.foo"
188
+ ]
189
+ },
190
+ "message": "must be equal to one of the allowed values"
191
+ }
192
+ ]
193
+ ```
194
+
195
+ ### $manifestschema()
196
+
197
+ Сигнатура: $manifestschema()
198
+
199
+ Возвращает json schema всего манифеста.
200
+
201
+ Пример использования для валидации всех объектов в озере данных:
202
+
203
+ ```json
204
+ /* получаем схему */
205
+ $schema := $manifestschema();
206
+
207
+ /* Создаём валидатор */
208
+ $validator := $jsonschema($schema);
209
+
210
+ /* Проверяем структуру */
211
+ $validator($);
212
+ ```
213
+
214
+ Результат, если ошибок нет:
215
+ ```json
216
+ true
217
+ ```
218
+
219
+ ## Дополнительные переменные
220
+
221
+ ### $self
222
+
223
+ Содержит структу объекта, выполняющего запрос.
224
+
225
+ **В настоящий момент поддерживается только в [шаблонах документов](/docs/archtool.templates).**
226
+
227
+ Объект документа:
228
+ ```yaml
229
+ docs:
230
+ ...
231
+ archtool.templates.pml: # Пример генерации PlantUML документа по шаблону
232
+ type: PlantUML
233
+ source: ...
234
+ subjects:
235
+ - archtool.front
236
+ - archtool.front.spa
237
+ - archtool.front.spa.blank
238
+ - archtool.front.spa.blank.doc
239
+ template: examples/template.puml
240
+ ...
241
+
242
+ ```
243
+
244
+ Будет доступен при выполненнии JSONata запроса:
245
+
246
+ ```json
247
+ $self
248
+ ```
249
+
250
+ в таком виде:
251
+
252
+ ```json
253
+ {
254
+ "_id": "archtool.templates.pml",
255
+ "type": "PlantUML",
256
+ "source": ...,
257
+ "subjects": [
258
+ "archtool.front",
259
+ "archtool.front.spa",
260
+ "archtool.front.spa.blank",
261
+ "archtool.front.spa.blank.doc"
262
+ ],
263
+ "template": "examples/template.puml"
264
+ }
265
+ ```
266
+
267
+
268
+