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

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 +29 -0
  298. package/plugin.html +1961 -0
@@ -0,0 +1,278 @@
1
+ # Компоновщик (markaper)
2
+
3
+ Компоновщик предоставляет для работы 4 вида компонентов. И, соответственно, возможность размещения содержимого в одной из предложенных форм:
4
+ - **select** (список);
5
+ - **tabs** (табы);
6
+ - **grid** (грид-сетка);
7
+ - **tree** (дерево).
8
+
9
+ Чтобы воспользоваться возможностями компоновщика, необходимо выбрать специальный тип документа с префиксом **mkr-...** и любым значением из списка выше. Таким образом, объявленный документ будет использовать компонент этого компоновщика для отображения данных архитектуры в выбранной разметке.
10
+
11
+ ## Пример использования в архитектурном коде документа с типом mkr-select:
12
+
13
+ ```yaml
14
+ entities:
15
+ aspects:
16
+ presentations:
17
+ contexts:
18
+ title: Документ с типом mkr-select
19
+ type: mkr-select
20
+ source: >
21
+ (
22
+ $aspect_id := $params.aspect;
23
+ $MANIFEST := $;
24
+ [$distinct(
25
+ components.$spread().(
26
+ $COMPONENT_ID := $keys()[0];
27
+ *.[$aspect_id in aspects] ?
28
+ (
29
+ [$MANIFEST.contexts.$spread().(
30
+ $CONTEXT_ID := $keys()[0];
31
+ $TITLE := *.title;
32
+ *.components[$wcard($COMPONENT_ID, $)].{
33
+ "id": $CONTEXT_ID,
34
+ "title": $TITLE,
35
+ "src": "@entity/contexts/plantuml?dh-context-id=" & $CONTEXT_ID & "&dh-focus-id=" & $aspect_id
36
+ }
37
+ )];
38
+ ) : undefined
39
+ ))];
40
+ )
41
+ ```
42
+
43
+ Пример рендеринга документа:
44
+
45
+ ![Пример](@document/aspects.select?aspect=archtool.gitlab.auth)
46
+
47
+ ## Пример использования в архитектурном коде документа с типом mkr-tabs:
48
+
49
+ ```yaml
50
+ entities:
51
+ aspects:
52
+ presentations:
53
+ contexts:
54
+ title: Документ с типом mkr-tabs
55
+ type: mkr-tabs
56
+ source: >
57
+ (
58
+ [
59
+ {
60
+ "id": "archtool",
61
+ "title": "Общая архитектура SEAF.ArchTool",
62
+ "src": "@entity/contexts/plantuml?dh-context-id=archtool&dh-focus-id=archtool.gitlab.auth"
63
+ },
64
+ {
65
+ "id": "archtool.uml_options",
66
+ "title": "Демонстрация UML опций контекста",
67
+ "src": "@entity/contexts/plantuml?dh-context-id=archtool.uml_options&dh-focus-id=archtool.gitlab.auth"
68
+ },
69
+ {
70
+ "id": "archtool.custom",
71
+ "title": "Компоненты эксперта R.Piontik",
72
+ "src": "@entity/contexts/plantuml?dh-context-id=archtool.custom&dh-focus-id=archtool.gitlab.auth"
73
+ },
74
+ {
75
+ "id": "archtool.front",
76
+ "title": "Контейнерная архитектура SEAF.ArchTool",
77
+ "src": "@entity/contexts/plantuml?dh-context-id=archtool.front&dh-focus-id=archtool.gitlab.auth"
78
+ }
79
+ ]
80
+ )
81
+ ```
82
+
83
+ Пример рендеринга документа:
84
+
85
+ ![Пример](@document/aspects.tabs)
86
+
87
+ ## Пример использования в архитектурном коде документа с типом mkr-grid:
88
+
89
+ ```yaml
90
+ entities:
91
+ aspects:
92
+ presentations:
93
+ blank:
94
+ title: Документ с типом mkr-grid
95
+ type: mkr-grid
96
+ source: >
97
+ (
98
+ {
99
+ "type": "columns",
100
+ "items": [
101
+ {
102
+ "type": "rows",
103
+ "items": [
104
+ {
105
+ "type": "rows",
106
+ "width": "40%",
107
+ "items": [
108
+ {
109
+ "title": "Сводка по аспекту",
110
+ "icon": "settings",
111
+ "style": {
112
+ "margin": "4px",
113
+ "border": true
114
+ },
115
+ "src": "@entity/aspects/summary?aspect=archtool.git.client"
116
+ },
117
+ {
118
+ "title": "Встречается в компонентах",
119
+ "icon": "description",
120
+ "style": {
121
+ "border": true,
122
+ "padding": "0px",
123
+ "margin": "0px"
124
+ },
125
+ "src": "@entity/aspects/components?aspect=archtool.git.client"
126
+ }
127
+ ]
128
+ }
129
+ ]
130
+ },
131
+ {
132
+ "type": "columns",
133
+ "items": [
134
+ {
135
+ "title": "Иерархия аспекта",
136
+ "icon": "description",
137
+ "style": {
138
+ "border": true,
139
+ "margin": "4px"
140
+ },
141
+ "src": "@entity/aspects/hierarchy?aspect=archtool.git.client"
142
+ },
143
+ {
144
+ "type": "rows",
145
+ "width": "60%",
146
+ "items": [
147
+ {
148
+ "title": "Контексты",
149
+ "icon": "description",
150
+ "style": {
151
+ "border": true,
152
+ "min-height": "300px",
153
+ "margin": "4px"
154
+ },
155
+ "src": "@entity/aspects/contexts?aspect=archtool.git.client"
156
+ },
157
+ {
158
+ "title": "Иерархия аспекта",
159
+ "icon": "description",
160
+ "style": {
161
+ "border": true,
162
+ "min-height": "300px",
163
+ "margin": "4px"
164
+ },
165
+ "src": "@entity/aspects/hierarchy?aspect=archtool.git.client"
166
+ }
167
+ ]
168
+ }
169
+ ]
170
+ }
171
+ ]
172
+ }
173
+ )
174
+ ```
175
+
176
+ Пример рендеринга документа:
177
+
178
+ ![Пример](@document/aspects.grid)
179
+
180
+ ## Пример использования в архитектурном коде документа с типом mkr-tree:
181
+
182
+ ```yaml
183
+ entities:
184
+ aspects:
185
+ presentations:
186
+ docs:
187
+ title: Документ с типом mkr-tree
188
+ type: mkr-tree
189
+ source: >
190
+ (
191
+ [
192
+ {
193
+ "location": "SEAF.ArchTool/Развертывание",
194
+ "title": "Развертывание",
195
+ "link": "/docs/archtool.deployment"
196
+ },
197
+ {
198
+ "location": "SEAF.ArchTool/Руководство",
199
+ "title": "Руководство",
200
+ "link": "/docs/archtool.manual"
201
+ },
202
+ {
203
+ "location": "SEAF.ArchTool/Руководство/JSONata+",
204
+ "title": "Расширения JSONata",
205
+ "link": "/docs/archtool.jsonata"
206
+ },
207
+ {
208
+ "location": "SEAF.ArchTool/Руководство/Адаптивная метамодель",
209
+ "title": "Адаптивная метамодель",
210
+ "link": "/docs/archtool.flex_metamodel"
211
+ },
212
+ {
213
+ "location": "SEAF.ArchTool/Руководство/Адаптивная метамодель/Entity",
214
+ "title": "Сущность",
215
+ "link": "/docs/archtool.flex_metamodel.entities"
216
+ },
217
+ {
218
+ "location": "SEAF.ArchTool/Руководство/Документы",
219
+ "title": "Документы",
220
+ "link": "/docs/archtool.docs"
221
+ },
222
+ {
223
+ "location": "SEAF.ArchTool/Руководство/Документы/AsyncApi",
224
+ "title": "Markdown",
225
+ "link": "/docs/archtool.asyncapi"
226
+ },
227
+ {
228
+ "location": "SEAF.ArchTool/Руководство/Документы/BPMN",
229
+ "title": "BPMN диаграммы",
230
+ "link": "/docs/archtool.bpmn"
231
+ },
232
+ {
233
+ "location": "SEAF.ArchTool/Руководство/Документы/PlantUML",
234
+ "title": "PlantUML",
235
+ "link": "/docs/archtool.plantuml"
236
+ },
237
+ {
238
+ "location": "SEAF.ArchTool/Руководство/Документы/SmartAnts",
239
+ "title": "SmartAnts",
240
+ "link": "/docs/archtool.smartants"
241
+ },
242
+ {
243
+ "location": "SEAF.ArchTool/Руководство/Документы/Swagger",
244
+ "title": "Swagger",
245
+ "link": "/docs/archtool.swagger"
246
+ },
247
+ {
248
+ "location": "SEAF.ArchTool/Руководство/Документы/Шаблоны",
249
+ "title": "Шаблоны",
250
+ "link": "/docs/archtool.templates"
251
+ },
252
+ {
253
+ "location": "SEAF.ArchTool/Руководство/Импорт",
254
+ "title": "Импорт манифестов",
255
+ "link": "/docs/archtool.imports"
256
+ },
257
+ {
258
+ "location": "SEAF.ArchTool/Руководство/Источники данных",
259
+ "title": "Источники данных",
260
+ "link": "/docs/archtool.datasets"
261
+ },
262
+ {
263
+ "location": "SEAF.ArchTool/Руководство/Технологии",
264
+ "title": "Технологии",
265
+ "link": "/docs/archtool.technologies"
266
+ },
267
+ {
268
+ "location": "SEAF.ArchTool/Руководство/Функции",
269
+ "title": "Пользовательские функции",
270
+ "link": "/docs/archtool.functions"
271
+ }
272
+ ]
273
+ )
274
+ ```
275
+
276
+ Пример рендеринга документа:
277
+
278
+ ![Пример](@document/aspects.tree)
@@ -0,0 +1,148 @@
1
+ # Markdown
2
+
3
+ Облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте,
4
+ с максимальным сохранением его читаемости человеком, и пригодный для машинного
5
+ преобразования в языки для продвинутых публикаций.
6
+
7
+ ## Расширенные возможности
8
+
9
+ Добавлены специальные теги SEAF.ArchTool, которые позволяют заметно расширить функциональность:
10
+
11
+ ### Навигационные якоря
12
+ Позволяет создавать именованные якоря для "коротких" ссылок внутри документа. Например, код:
13
+ ```
14
+ ![](@anchor/markdown)
15
+ ```
16
+ создает якорь "markdown". Теперь на него можно сослаться из любой части документа:
17
+ ```
18
+ [Пример короткой ссылки](#markdown)
19
+ ```
20
+
21
+ ### Изображения
22
+ Поддерживается встраивание изображений. Например:
23
+
24
+ ```
25
+ ![Кот](examples/cat.jpg)
26
+ ```
27
+
28
+ ![Кот](examples/cat.jpg)
29
+
30
+ ### Архитектурный манифест в теле документа
31
+
32
+ Рекомендуется использовать данную функциональность с осторожностью, так как стандарт Markdown не предусматривает включение метаданных в документ.
33
+ Тем не менее, многие инструменты поддерживают такую возможность. SEAF.ArchTool добавил поддержку метаданных в Markdown, начиная с версии v3.19.0.
34
+
35
+ Блок метаданных в теле документа начинается с трех тире "---" и заканчивается также ими "---". Пример документа:
36
+
37
+ ```
38
+ ---
39
+ docs:
40
+ archtool.example.markdown:
41
+ location: SEAF.ArchTool/Руководство/Документы/Markdown/01 Метаинформация в md
42
+ type: markdown
43
+ source: .
44
+ ---
45
+ # Пример markdown со вложенной метаинформацией
46
+ ```
47
+
48
+ Пример демонстрирует встраивание архитектурного манифеста в тело Markdown-документа. В данном случае манифест включает описание документа
49
+ и ссылку на его содержимое в том же файле. Путь к текущему документу обозначается как точка ".".
50
+
51
+ Метаданные документ могут включать любой контент допустимый для архитектурного манифеста.
52
+
53
+ ### Ссылки на объекты SEAF.ArchTool
54
+ Добавляет ссылку на архитектурный объект. Пример для ссылки на документ:
55
+ ```
56
+ [Swagger контракт](/docs/archtool.example.swgr)
57
+ ```
58
+
59
+ Будет сформирована ссылка:
60
+
61
+ [Swagger контракт](/docs/archtool.example.swgr)
62
+
63
+ Как добавить ссылку на карточку компонента:
64
+ ```
65
+ [Компонент gitlab](/architect/components/archtool.gitlab)
66
+ ```
67
+
68
+ Будет сформирована ссылка:
69
+
70
+ [Компонент gitlab](/architect/components/archtool.gitlab)
71
+
72
+ ### Встраиваемые объекты SEAF.ArchTool
73
+ Интегрирует в документ архитектурный объект. Например:
74
+ ```
75
+ ![Компонент архитектуры](@component/archtool.front)
76
+ ```
77
+
78
+ Пример встраивания карточки компонента
79
+
80
+ ![Карточка компонента](@component/archtool.front)
81
+
82
+
83
+ Пример встраивания объекта кастомной сущности ["Взаимодействия"](/entities/interactions/tree)
84
+
85
+ ![Объект кастомной сущности](@entity/interactions/blank?id=archtool.user.check)
86
+
87
+ Доступны следующие типы объектов:
88
+ * @document
89
+ * @context
90
+ * @aspect
91
+ * @component
92
+ * @entity
93
+
94
+ Через "/" указывается идентификатор объекта.
95
+
96
+ #### Декоратор DatePicker
97
+ При встраивании объекта, принимающего дату в качестве параметров, есть возможность обернуть его в декоратор DatePicker, который будет отображать календарь для выбора даты. DatePicker принимает следующие параметры:
98
+
99
+ - **static**: Boolean - если `true`, то календарь будет постоянно отображаться на странице, а не выпадать по щелчку
100
+ - **range**: Boolean - если `true`, то календарь будет выбирать диапазон дат вместо одной даты
101
+ - **wrappedObjectSrc** - оборачиваемый объект
102
+
103
+ В оборачиваемый объект будут переданы следующие параметры в виде строки формата Г-М-Д:
104
+ - **date**
105
+
106
+ или
107
+ - **fromDate**
108
+ - **toDate**
109
+
110
+ По-умолчанию все параметры установлены на текущее число.
111
+
112
+ Например:
113
+ ```
114
+ ![DatePicker](@datepicker?range=true&wrappedObjectSrc=@document/archtool.example.datepicker)
115
+ ```
116
+ Результат:
117
+ ![DatePicker](@datepicker?range=true&wrappedObjectSrc=@document/archtool.example.datepicker)
118
+
119
+
120
+ ## Использование HTML
121
+ По умолчанию в markdown отключены HTML тэги. Это сделано для исключения встраивания потенциально опасного
122
+ произвольного кода. Для включения поддержки HTML, используйте переменную окружения VUE_APP_DOCHUB_MARKDOWN_HTML
123
+ в режиме портала.
124
+
125
+ ```
126
+ VUE_APP_DOCHUB_MARKDOWN_HTML=on
127
+ ```
128
+
129
+ Подробнее [здесь](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/example.env).
130
+
131
+ Для включения поддержки HTML в плагинах, потребуется установить переменную DOCHUB_IDE_MARKDOWN_HTML на рабочей станции.
132
+
133
+ Для linux:
134
+
135
+ ```
136
+ export DOCHUB_IDE_MARKDOWN_HTML=on
137
+ ```
138
+
139
+ Для windows:
140
+ ```
141
+ set DOCHUB_IDE_MARKDOWN_HTML=on
142
+ ```
143
+
144
+ **ВНИМАНИЕ:** Поддержка HTML не является стандартом markdown. Высока вероятность столкнуться с различными
145
+ проблемами при его использовании. Не рекомендуется использование HTML в Markdown.
146
+
147
+ ## Отключение автооглавления в Markdown-документах
148
+ Инструкция по отключению автооглавления в Markdown-документах и примеры находятся [здесь](toc.md)
@@ -0,0 +1,43 @@
1
+ # Mermaid
2
+
3
+ Представляет собой исходные код на языке [Mermaid](https://mermaid-js.github.io/mermaid/#/).
4
+
5
+ ```
6
+ C4Context
7
+ title System Context diagram for Internet Banking System
8
+
9
+ Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
10
+ Person(customerB, "Banking Customer B")
11
+ Person_Ext(customerC, "Banking Customer C")
12
+ System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
13
+
14
+ Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
15
+
16
+ Enterprise_Boundary(b1, "BankBoundary") {
17
+
18
+ SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
19
+
20
+ System_Boundary(b2, "BankBoundary2") {
21
+ System(SystemA, "Banking System A")
22
+ System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts.")
23
+ }
24
+
25
+ System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
26
+ SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
27
+
28
+ Boundary(b3, "BankBoundary3", "boundary") {
29
+ SystemQueue(SystemF, "Banking System F Queue", "A system of the bank, with personal bank accounts.")
30
+ SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
31
+ }
32
+ }
33
+
34
+ BiRel(customerA, SystemAA, "Uses")
35
+ BiRel(SystemAA, SystemE, "Uses")
36
+ Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
37
+ Rel(SystemC, customerA, "Sends e-mails to")
38
+ ```
39
+
40
+ Пример рендеринга документа:
41
+
42
+ ![Документ](@document/archtool.example.mermaid)
43
+
@@ -0,0 +1,117 @@
1
+ # Network
2
+
3
+ Сетевые диаграммы позволяют наглядно представлять топологию различных связей на основании данных архитектуры.
4
+ Для визуализации сетей используется библиотека [vis.js](https://visjs.org/).
5
+
6
+ Данными для пострения сети являются константные данные в поле source, [источник данных](/docs/archtool.datasets) или результат запроса JSONata.
7
+
8
+ Итоговым результатом должна стать структура в соответсвии с [документацией vis.js](https://visjs.github.io/vis-network/docs/network/) :
9
+ ```json
10
+ {
11
+ "nodes": [ /* Перечисление нод https://visjs.github.io/vis-network/docs/network/nodes.html */
12
+ {
13
+ "id": "node1", /* Идентификатор ноды */
14
+ "label": "Node 1", /* Описание */
15
+ ...
16
+ },
17
+ {
18
+ "id": "node2",
19
+ "label": "Node 2",
20
+ ...
21
+ }
22
+ ],
23
+ "edges": [ /* Перечисление вязей нод https://visjs.github.io/vis-network/docs/network/edges.html */
24
+ {
25
+ "id": "link1", /* Идентификатор связи */
26
+ "from": "node1", /* Источник */
27
+ "to": "node2", /* Приемник */
28
+ "label": "Пример связи", /* Описание */
29
+ ...
30
+ }
31
+ ],
32
+ "options": { /* Параметры рендеринга диаграммы https://visjs.github.io/vis-network/docs/network/ */
33
+ "clickToUse": false, /* Отключаем обязательный клик перед взаимодействем с пользователем */
34
+ ...
35
+ }
36
+ }
37
+ ```
38
+
39
+ Пример описания сетевой диаграммы:
40
+
41
+ ```yaml
42
+ ...
43
+ archtool.example.network:
44
+ type: Network
45
+ subjects:
46
+ - archtool.front
47
+ - archtool.front.spa
48
+ - archtool.front.spa.blank
49
+ - archtool.front.spa.blank.doc
50
+ source: >
51
+ (
52
+ $manifest := $;
53
+ /* Перебираем все компоненты */
54
+ $adges := $distinct(components.$spread().(
55
+ $node_id := $keys()[0];
56
+ $node := $.*;
57
+ /* Определяем связи */
58
+ $node.links.{
59
+ "from": $node_id,
60
+ "to": id,
61
+ "label": title
62
+ }
63
+ ));
64
+ /* Выявляем ноды из связей */
65
+ $nodes := $distinct($append($adges.from, $adges.to)).(
66
+ $struct := $split($, ".");
67
+ $group := $replace($, "." & $reverse($struct)[0], "");
68
+ {
69
+ "id": $,
70
+ "label": $lookup($manifest.components, $).title,
71
+ "group": $group,
72
+ "level": $count($struct),
73
+ /* Позиционируем ноду тем выше, чем выше слой */
74
+ "y": $count($struct) * 200
75
+ }
76
+ );
77
+ /* Добавляем ноды легенды */
78
+ $nodes := $append($nodes, (
79
+ /* Получаем максимальную точку позиции нод */
80
+ $height := $max($nodes.y);
81
+ $groups := $distinct($nodes.group)^($);
82
+ /* Вычисляем центр легенды */
83
+ $offset := -($height / 2);
84
+ /* Определяем шаг легенды */
85
+ $step := $height / $count($groups);
86
+ /* Строим легенду */
87
+ $map($groups, function($v, $i, $a) {
88
+ {
89
+ "id": "legend-" & $string($i),
90
+ "x": -600,
91
+ "y": $i * $step + $offset,
92
+ "shape": "square",
93
+ "label": $v,
94
+ "group": $v,
95
+ "value": 1,
96
+ "fixed": true,
97
+ "physics": false
98
+ }
99
+ })
100
+ ));
101
+ /* Выводим результат */
102
+ {
103
+ "nodes": $nodes, /* Массив нод */
104
+ "edges": $adges, /* Массив связей */
105
+ "options": { /* Параметры сетевой диаграммы https://visjs.github.io/vis-network/docs/network/ */
106
+ "clickToUse": false /* Отключаем обязательный клик перед взаимодействем с пользователем */
107
+ }
108
+ }
109
+ )
110
+ ...
111
+ ```
112
+
113
+
114
+ Пример рендеринга документа:
115
+
116
+ ![Документ](@document/archtool.example.network)
117
+
@@ -0,0 +1,28 @@
1
+ # PlantUML
2
+
3
+ Представляет собой исходные код на языке PlantUML.
4
+
5
+ ```
6
+ @startuml
7
+ participant Participant as Foo
8
+ actor Actor as Foo1
9
+ boundary Boundary as Foo2
10
+ control Control as Foo3
11
+ entity Entity as Foo4
12
+ database Database as Foo5
13
+ collections Collections as Foo6
14
+ queue Queue as Foo7
15
+ Foo -> Foo1 : To actor
16
+ Foo -> Foo2 : To boundary
17
+ Foo -> Foo3 : To control
18
+ Foo -> Foo4 : To entity
19
+ Foo -> Foo5 : To database
20
+ Foo -> Foo6 : To collections
21
+ Foo -> Foo7 : To queue
22
+ @enduml
23
+ ```
24
+
25
+ Пример рендеринга документа:
26
+
27
+ ![Документ](@document/archtool.example.pml)
28
+