@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,397 @@
1
+ # Плагин для отображения файлов drawio
2
+
3
+ Плагин предназначен для отображения файлов в формате drawio в интерактивном интерфейсе.
4
+
5
+ **!Внимание!** Плагин работает в экспериментальном режиме, возможно есть ограничения в работе, которые тут явно не указаны.
6
+ О всех ошибках просьба сообщать для улучшений!
7
+
8
+ Для отображения поддерживаются форматы xml, svg и png с внедрением исходной диаграммы (!типы файлов требуют проверки).
9
+
10
+ Так же плагин поддерживает параметризацию показываемой диаграммы на основе данных из манифеста archtool.
11
+
12
+ **!Внимание!** Целевым форматом шаблонизации является XML формат drawio, для всех остальных форматов возможности шаблонизации ограничены и требуют отдельного исследования.
13
+
14
+ # Как настроить плагин для работы
15
+
16
+ Для того, чтобы плагин корректно работал необходимо в переменных окружения ( файл .env)
17
+ указать следующие параметры:
18
+
19
+ | Параметр | Описание | Значение по умолчанию
20
+ | --- | --- | -- |
21
+ | VUE_APP_DOCHUB_PLUGIN_DRAWIO_SERVER_URI | Адрес сервера DRAWIO для открытия интерфейса (см ниже) | https://embed.diagrams.net/?embed=1&ui=atlas&spin=1&modified=unsavedChanges&saveAndExit=0&noSaveBtn=1&noExitBtn=1&proto=json |
22
+ | VUE_APP_DOCHUB_PLUGIN_DRAWIO_LOAD_CUSTOM_HANDLERS | Разрешать ли загрузку дополнительных обработчиков XML из манифеста (см ниже) | false |
23
+
24
+
25
+ ## Настройка ссылки на drawio сервер
26
+
27
+ Сам по себе сервер DRAWIO согласно документации используется только для загрузки кода редактора в браузер, а так же может использовать для вспомогательных действий вида экспорта в другой формат. Без необходимости файлы самих документов на сервер не отправляются.
28
+
29
+ Тем не менее в целях информационной безопасности можно использовать локальный сервер drawio для работы.
30
+ Варианты развертывания такого сервера выходят за рамки данного документа, но самый простой из способов:
31
+ [Запуск в docker образа](https://www.drawio.com/blog/diagrams-docker-app)
32
+
33
+ ```bash
34
+ docker run -it --rm --name="draw" -p 8080:8080 -p 8443:8443 jgraph/drawio
35
+ ```
36
+
37
+ При этом в переменной VUE_APP_DOCHUB_PLUGIN_DRAWIO_SERVER_URI нужно указать полную ссылку для открытия редактора.
38
+
39
+ Рекомендуемые для использования на текущий момент параметры:
40
+ embed=1&ui=atlas&spin=1&modified=unsavedChanges&saveAndExit=0&noSaveBtn=1&noExitBtn=1&proto=json
41
+
42
+ Указанные параметры скрывают кнопки сохранения документа, так как плагин не реализует функциональность обновления документа в манифесте.
43
+
44
+ Подробнее об этом можно узнать [тут](https://www.drawio.com/doc/faq/embed-mode).
45
+
46
+ **Замечание**:
47
+ При самостоятельном формировании адреса ссылки необходимо обязательно указывать параметр proto=json
48
+
49
+ ## Параметризация drawio диаграмм
50
+ Плагин поддерживает параметризацию drawio файла перед отображением.
51
+
52
+ Это означает, что файл из репозитория перед отображением используется как шаблон для применения у нему тех данных, которые возвращает запрос из параметра source документа archtool.
53
+
54
+ При этом поддерживает 2 вида шаблонизации:
55
+ 1. mustache шаблонизатор
56
+ 2. обработчики на основе xpath и JS функций модификации DOM структуры XML документа
57
+
58
+ Оба указанных шаблонизатора можно использовать совместно.
59
+ Сначала применяется шаблонизатор mustache, а затем к результату его работу уже применяются обработчики xpath
60
+
61
+ ### Шаблонизатор mustache
62
+
63
+ Шаблонизатор считает весь файл drawio шаблоном а данные берет из атрибута $.params результата запроса, указанного в параметре source документа.
64
+
65
+ Особенности шаблонизатора:
66
+ 1. mustache ничего не знает о структуре файла - xml это или SVG или PNG файл, он просто найдет свои теги и заполнит их согласно своей логике.
67
+ 2. В некоторых случаях масштабного использования тегов mustache файл без рендеринга шаблонизатором может стать нечитаемым в программе drawio
68
+
69
+ ### Обработчики на основе XML и xpath
70
+
71
+ Особенность подхода заключается в том, что базовый формат файлов DRAWIO - это XML со своим набором элементов, атрибутов и стилей.
72
+
73
+ А значит можно реализовать изменение этого файла средствами работы с XML, а выбрать места применения таких изменений с помощью XPATH.
74
+
75
+
76
+ #### Как это работает:
77
+ Обработчик действует по заранее определенному сценарию:
78
+ 1. Взять результат работы шаблонизатора mustache
79
+ 2. Распарсить его как XML в DOM структуру
80
+ 3. Взять массив объектов по пути $.xml_mutators из запроса, указанного в параметре source документа
81
+ 4. Для каждого из элементов массива:
82
+ 5. Скомпилировать из атрибута $.xml_mutators.[].xpath xpath и применить его к документу, результат получаем в виде снапшота результатов запроса - он не изменится при редактировании самого DOM-документа
83
+ 6. Для каждого результата запроса применить каждый из найденных по пути $.xml_mutators.[].operation обработчиков
84
+
85
+ Пример результата запроса, указанного в параметре source документа
86
+ ```plantuml
87
+ @startjson
88
+ { "params" : {
89
+ "component1": "Название компонента 1",
90
+ "component2": "Название компонента 2",
91
+ "line1_text1": "Текст для стрелки"
92
+ },
93
+ "xml_mutators" : [
94
+ { "id": 1, "xpath": "//*[@id = 'com_20_notification']",
95
+ "params": { "style_self" : false},
96
+ "operation": {
97
+ "attrs": {
98
+ "name1": "value1",
99
+ "owner": "test2"
100
+ },
101
+ "style": {
102
+ "fillColor": "#red",
103
+ "rounded": 10
104
+ }
105
+ }
106
+ }
107
+ ]
108
+ }
109
+ @endjson
110
+ ```
111
+
112
+ Блок-схема работы алгоритма:
113
+ ```plantuml
114
+ @startuml
115
+ start
116
+
117
+ :Получаем шаблон **template**; <<input>>
118
+ :Получаем данные **data**; <<input>>
119
+ :Получает список обработчиков handlers; <<procedure>>
120
+ :Получаем DOM представление шаблона oDOM; <<procedure>>
121
+
122
+ while (**el** - элемент из массива **data**) is (выражение)
123
+ :Берем xpath из **el.xpath**; <<procedure>>
124
+ :Применяем xpath к документу oDOM -> **xpath_result**; <<procedure>>
125
+
126
+ while (**node** - элемент из результата **xpath_result**) is (элемент)
127
+
128
+ while (**handler** - элемент обработчиков **handlers**) is (обработчик)
129
+ :Получаем атрибуты для вызова по коду обработчика \n **attrs** = **el**.operation[handler_name]; <<procedure>>
130
+ :Получаем параметры вызова \n **params** = **el**.params; <<procedure>>
131
+ :вызов обработчика \n handler(**plugin**, **node**, **attrs**, **params**); <<procedure>>
132
+ if (произошла ошибка) then (ошибка)
133
+ :логируем ошибку; <<output>>
134
+ endif
135
+ endwhile (конец)
136
+
137
+ endwhile (конец)
138
+
139
+ endwhile (конец)
140
+ stop
141
+ @enduml
142
+ ```
143
+
144
+
145
+ #### Подробнее об обработчиках:
146
+ Так-как формирование полноценного xslt документа для преобразования drawio файла довольно неудобно ( на JSONata наверное совсем не удобно и очень громоздко).
147
+
148
+ Было решено применить концепцию специализированных обработчиков для разных операций.
149
+
150
+ Каждый обработчик состоит из:
151
+ 1. Мнемоники - по ней определяется какой именно обработчик необходимо применять.
152
+ 2. Функции изменения - это функция на JavaScript которая принимает следующие параметры:
153
+ 1. plugin - объект плагина drawio ( для логирования рекомендуется использовать метод plugin.log)
154
+ 2. node - DOM-елемент найденный в результате xpath запроса
155
+ 3. attrs - содержимое объекта по пути $.xml_mutators.[].operation[ handler_code ], где handler_code - мнемоника обработчика. По сути это параметры применения этого обработчика к элементу node. Формат зависит от обработчика
156
+ 4. params - объект по пути $.xml_mutators.[].params По сути это конфигурация, в зависимости от данных тут может как-то меняться поведение того или иного обработчика.
157
+
158
+ Результат возврата функции игнорируется.
159
+ Функция должна выполнить изменения DOM-элемента на месте путем его изменения.
160
+
161
+ #### Обработчик attrs
162
+
163
+ **Код обработчика:** attrs
164
+ **Название:** Установка или добавление атрибутов к выбранному через xpath элементу
165
+
166
+ **Примечание:** Зачем такое нужно?
167
+ В drawio есть понятие дополнительных данных.
168
+
169
+ В самом drawio эти параметры можно использовать для подстановки значений в текстовые
170
+ шаблоны как самого элемента, так и дочерних элементов.
171
+ [Подробности](https://www.drawio.com/blog/placeholders)
172
+
173
+ **Преимущества:** Можно работать с данными в интерфейсе самого drawio, это нормально отображается.
174
+ При этом не нужно заморачиваться и учитывать стилистику вывода текста - это
175
+ можно настроить штатными средствами в самом редакторе диаграмм.
176
+
177
+ **Опции работы (params):** параметров нет
178
+
179
+ **Как использовать:** Для удобства использовать можно назначать элементам на диаграмме свои идентификаторы
180
+ Для этого нужно:
181
+ 1. кликнуть правой кнопкой мыши на элемент
182
+ 2. выбрать пункт Edit Data
183
+ 3. 2 раза кликнуть на ID элемента в верхней части диалогового окна
184
+ 4. Внесни идентификатор
185
+
186
+ **Внимание!** Указанные действия не получится сделать во встроенном редакторе, т.к. он на текущий момент не поддерживает сохранение изменений.
187
+ При необходимости сохранения изменений из встроенного редактора необходимо воспользоваться пунктом меню
188
+ **Файл -> Экспортировать как... -> XML...** (При выборе параметров экпорта не выбирать сжатие **(шаблонизация работать не будет)**)
189
+
190
+
191
+ **Формат атрибутов (attrs):** Формат - это объект, ключи которого являются
192
+ ключами для добавления или установки значения, а значения - теми значениями, которые будут установлены
193
+
194
+ **Внимание!** Все идентификаторы в рамках диаграммы должны быть уникальными!
195
+
196
+ #### Обработчик style
197
+
198
+ **Код обработчика:** style
199
+ **Название:** Установка или добавление атрибутов **стиля** к выбранному через xpath элементу
200
+
201
+ **Примечание:** Зачем такое нужно?
202
+ Если параметризировать стиль объекта (например цвет фона элемента), то визуальное отображение в редакторе диаграмм ильно ухудшается (элементы становятся черного цвета и надписи могут сливаться).
203
+ При применении обработчика стиль не нужно предварительно заменять mustache тегом и в результате таких последствий нет.
204
+
205
+ Посмотреть какие есть стили можно:
206
+ 1. выбрав элемент в редакторе диаграмм,
207
+ 2. нажав на нем правой кнопкой мыши
208
+ 3. выбрать пункт меню Edit Style
209
+
210
+ В результате будет показана строка вида:
211
+ ```
212
+ html=1;dropTarget=0;whiteSpace=wrap;
213
+ ```
214
+ Данную строчку можно представить как отдельные атрибуты разделенные точкой запятой, каждый из атрибутов имеет значение, отделяемое от названия знаком равно.
215
+
216
+
217
+ **Опции работы (params):**
218
+ Параметр style_self:
219
+ **возможные варианты:**
220
+ | Значение | Примечание |
221
+ | --- | -- |
222
+ | true | Атрибут style нужно искать прямо на том элементе, который получен от xpath |
223
+ | false | Атрибут style ищется на первом дочернем элементе mxCell относительно элемента, который получен от xpath |
224
+
225
+ **значение по умолчанию:** false
226
+
227
+ **зачем нужен параметр:** Стили часто вешаются не на элемент с id а на дочерний элемент mxCell - поведение по умолчанию упрощает формирование xpath для редактирования стиля, но может вызвать затруднение если стиль нужно поменять в другой структуре (требуется исследование и обратная связь)
228
+
229
+ **Формат атрибутов (attrs):** Формат - это объект, ключи которого являются
230
+ именами элементов стиля, а значения - теми значениями, которые будут установлены для них.
231
+ При наличие элемента стиля - его значение заменяется.
232
+ При отсутствии элемента стиля - он добавляется с передаваемым значением
233
+
234
+ #### Добавление кастомного обработчика
235
+ Набор штатных обработчиков на текущий момент ограничен тем минимумом, который понадобился для начала прикладной работы с плагином.
236
+
237
+ Кому-то может понадобиться расширить эту функциональность.
238
+ Это можно сделать без пересборки плагина и редактирования его исходного кода следующим образом:
239
+ 1. Установить значение переменной VUE_APP_DOCHUB_PLUGIN_DRAWIO_LOAD_CUSTOM_HANDLERS перед сборкой archtool в значение true
240
+ 2. В метаданных определить объект
241
+ ```yaml
242
+ entities:
243
+ config.plugin.drawio:
244
+ handlers:
245
+ мнемоника обработчика: |
246
+ тело функции обработки, имена параметров на входе фиксированы
247
+ # plugin - plugin object - use ( way use plugin.log )
248
+ # node - dom Node object found by xpath expression
249
+ # attrs - object with data to apply modification - format is handler specific
250
+ # params - object with configs / modifiers of handlers
251
+
252
+ ```
253
+
254
+
255
+ **Пример реализации указанных выше плагинов в виде кастомизации:**
256
+ ```yaml
257
+ entities:
258
+ config.plugin.drawio:
259
+ handlers:
260
+ # js function body with params:
261
+ # plugin - plugin object - use ( way use plugin.log )
262
+ # node - dom Node object found by xpath expression
263
+ # attrs - object with data to apply modification - format is handler specific
264
+ # params - object with configs / modifiers of handlers
265
+ attrs: |
266
+ plugin.log("change_attrs - start", node, attrs);
267
+ for (var key of Object.keys(attrs)) {
268
+ node.setAttribute(key, attrs[key]);
269
+ }
270
+ plugin.log("change_attrs - end", node);
271
+ style: |
272
+ plugin.log("change_style - start", node, attrs);
273
+ // todo: check errors
274
+ var style_node = params.style_self ? node : node.getElementsByTagName("mxCell").item(0);
275
+ var style_attr = style_node.getAttribute("style");
276
+ var style_obj = style_attr.split(";")
277
+ .reduce( function(res, el) {
278
+ var items = el.split("=");
279
+ if (items[0])
280
+ res[items[0]] = items[1] ;
281
+ return res;
282
+ }, {} );
283
+
284
+ for (var key of Object.keys(attrs)) {
285
+ style_obj[key] = attrs[key];
286
+ }
287
+
288
+ plugin.log("change_style - style apply", style_obj);
289
+
290
+ var style_res = [];
291
+ for (var key of Object.keys(style_obj)) {
292
+ style_res.push( "" + key + "=" + style_obj[key] );
293
+ }
294
+ var style_res2 = style_res.join(";");
295
+ plugin.log("change_style - result", style_res, style_res2);
296
+ style_node.setAttribute("style", style_res2);
297
+ ```
298
+
299
+ Если вы расширите список обработчиков чем-нибудь, что вы считаете
300
+ будет полезным и другим пользователям - обращайтесь - мы
301
+ готовы расширить перечень встроенных обработчиков
302
+
303
+ # Пример использования плагина
304
+
305
+ В примере ниже используется набор обработчиков на основе xpath
306
+ ## Шаблон как есть без каких-либо изменений:
307
+
308
+ ```yaml
309
+ archtool.plugins.drawio.as_is:
310
+ location: SEAF.ArchTool/Руководство/Документы/Drawio/Файл как есть
311
+ type: drawio
312
+ template: templates/example.drawio
313
+ ```
314
+
315
+ ![](@document/archtool.plugins.drawio.as_is)
316
+
317
+ ## Применение к шаблону данных из запроса
318
+
319
+ ```yaml
320
+ archtool.plugins.drawio.parametrized:
321
+ location: SEAF.ArchTool/Руководство/Документы/Drawio/Применили пост. обработку
322
+ type: drawio
323
+ template: templates/example.drawio
324
+ source: >
325
+ (
326
+ {
327
+ "xml_mutators" : [
328
+ { "id": 1, "xpath": "//*[@id = 'test.sys1.c1']",
329
+ "params": { "style_self" : false},
330
+ "operation": {
331
+ "attrs": {
332
+ "c4Description": "Описание контейнера 1",
333
+ "c4Name": "Имя контейнера 1",
334
+ "c4Technology" : "Java, Spring"
335
+ },
336
+ "style": {
337
+ "fillColor": "red"
338
+ }
339
+ }
340
+ },
341
+ { "id": 2, "xpath": "//*[@id = 'test.sys1.c2']",
342
+ "params": { "style_self" : false},
343
+ "operation": {
344
+ "attrs": {
345
+ "c4Description": "Описание контейнера 2",
346
+ "c4Name": "Имя контейнера 2",
347
+ "c4Technology" : "Java17, Spring"
348
+ },
349
+ "style": {
350
+ "fillColor": "green"
351
+ }
352
+ }
353
+ },
354
+ { "id": 3, "xpath": "//*[@id = 'test.sys1.c3']",
355
+ "params": { "style_self" : false},
356
+ "operation": {
357
+ "attrs": {
358
+ "c4Description": "Описание контейнера 3",
359
+ "c4Name": "Имя контейнера 3",
360
+ "c4Technology" : "Java8, Springboot"
361
+ },
362
+ "style": {
363
+ "fillColor": "blue"
364
+ }
365
+ }
366
+ },
367
+ { "id": 4, "xpath": "//*[@id = 'test.sys1']",
368
+ "params": { "style_self" : false},
369
+ "operation": {
370
+ "attrs": {
371
+ "c4Application": "Приложение 1",
372
+ "c4Name": "Имя ИС 1"
373
+ },
374
+ "style": {
375
+ "fillColor": "grey"
376
+ }
377
+ }
378
+ },
379
+ { "id": 5, "xpath": "//*[@id = 'test.sys1.conn1']",
380
+ "params": { "style_self" : false},
381
+ "operation": {
382
+ "attrs": {
383
+ "c4Description": "Описание связи между компонентами",
384
+ "c4Technology": "Технология HTTP",
385
+ "extra_data": "Дополнительная информация отображаемая в tooltip элемента"
386
+ },
387
+ "style": {
388
+ "strokeColor": "orange"
389
+ }
390
+ }
391
+ }
392
+ ]
393
+ }
394
+ )
395
+ ```
396
+
397
+ ![](@document/archtool.plugins.drawio.parametrized)
@@ -0,0 +1,5 @@
1
+ docs:
2
+ archtool.plugins.editable-table.menu:
3
+ location: SEAF.ArchTool/Руководство/Документы/Редактируемая таблица
4
+ type: markdown
5
+ source: template.md
@@ -0,0 +1,9 @@
1
+ imports:
2
+ - menu.yaml
3
+ - step_0_base/root.yaml
4
+ - step_1_acquaintance/root.yaml
5
+ - step_2_parameterization/root.yaml
6
+ - step_3_headers/root.yaml
7
+ - step_4_editing/root.yaml
8
+ - step_5_styles/root.yaml
9
+ - step_6_errors/root.yaml
@@ -0,0 +1,6 @@
1
+ docs:
2
+ archtool.plugins.editable-table.base.menu:
3
+ toc: true
4
+ location: SEAF.ArchTool/Руководство/Документы/Редактируемая таблица/Базовый пример
5
+ type: markdown
6
+ source: template.md
@@ -0,0 +1,3 @@
1
+ imports:
2
+ - menu.yaml
3
+ - table.yaml