@seafteam/seaf-archtool-core-plugin-suite 2026.32.0 → 2026.33.0-rc.2
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.
- package/documentation/arch/aspects.yaml +0 -0
- package/documentation/arch/contexts.yaml +0 -0
- package/documentation/arch/forms.yaml +0 -0
- package/documentation/arch/namespaces.yaml +0 -0
- package/documentation/arch/root.yaml +0 -0
- package/documentation/arch/technologies.yaml +0 -0
- package/documentation/dochub.yaml +0 -0
- package/documentation/docs/conception/root.yaml +0 -0
- package/documentation/docs/manual/config/deployment.md +48 -0
- package/documentation/docs/manual/docs/docs.md +1 -0
- package/documentation/docs/manual/docs/drawio_intro.md +95 -3
- package/documentation/docs/manual/docs/editable_table/root.yaml +2 -1
- package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +7 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +7 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/data/markdown_preview.yaml +15 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +64 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +23 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/examples/global_search/data.yaml +58 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/examples/global_search/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/examples/global_search/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/examples/global_search/table.yaml +48 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/examples/global_search/template.md +130 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_7_search/template.md +57 -0
- package/documentation/docs/manual/docs/examples/excel.yaml +41 -0
- package/documentation/docs/manual/docs/examples/object_header.md +5 -0
- package/documentation/docs/manual/docs/examples/table.yaml +27 -0
- package/documentation/docs/manual/docs/excel.md +484 -0
- package/documentation/docs/manual/docs/markaper.md +96 -0
- package/documentation/docs/manual/docs/markdown.md +28 -0
- package/documentation/docs/manual/docs/root.yaml +13 -0
- package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +13 -0
- package/documentation/docs/manual/docs/tables.md +104 -0
- package/documentation/docs/manual/jsonata.md +54 -0
- package/documentation/docs/manual/plugins/interface.md +7 -0
- package/documentation/docs/manual/plugins/introduction.md +35 -5
- package/documentation/docs/manual/plugins/root.yaml +0 -0
- package/documentation/docs/manual/root.yaml +0 -0
- package/documentation/docs/manual/rules/root.yaml +0 -0
- package/documentation/docs/root.yaml +0 -0
- package/documentation/entities/extentions/entity.yaml +0 -0
- package/documentation/entities/interactions/entity.yaml +0 -0
- package/documentation/root.yaml +0 -0
- package/package.json +1 -1
- package/plugin.html +1751 -4
|
@@ -90,6 +90,60 @@ entities:
|
|
|
90
90
|
`mkr-tabs` восстанавливает выбранную вкладку. Если она больше недоступна,
|
|
91
91
|
выбирается вкладка с `selected: true`, а при её отсутствии — первая вкладка.
|
|
92
92
|
|
|
93
|
+
### Вид вкладок: поле kind
|
|
94
|
+
|
|
95
|
+
Вид вкладок задаётся необязательным полем `kind` в описании представления `mkr-tabs`:
|
|
96
|
+
|
|
97
|
+
| `kind` | Вид |
|
|
98
|
+
|--------|-----|
|
|
99
|
+
| нет или `tabs` | Вкладки первого уровня: названия в строку, выбранная подчёркнута, под строкой линия |
|
|
100
|
+
| `switcher` | Переключатель: кнопки на общей подложке, выбранная — на белом фоне |
|
|
101
|
+
|
|
102
|
+
Другое значение `kind` считается отсутствием поля. Ядро, которое поле `kind` не знает, выводит
|
|
103
|
+
вкладки как раньше.
|
|
104
|
+
|
|
105
|
+
```yaml
|
|
106
|
+
entities:
|
|
107
|
+
systems:
|
|
108
|
+
presentations:
|
|
109
|
+
integrations:
|
|
110
|
+
title: Интеграционные потоки
|
|
111
|
+
type: mkr-tabs
|
|
112
|
+
kind: switcher # Варианты одного содержимого — переключатель
|
|
113
|
+
source: >
|
|
114
|
+
(
|
|
115
|
+
[
|
|
116
|
+
{ "title": "Все", "src": "@entity/systems/flows_all?id=" & $params.id },
|
|
117
|
+
{ "title": "Входящие", "src": "@entity/systems/flows_in?id=" & $params.id },
|
|
118
|
+
{ "title": "Исходящие", "src": "@entity/systems/flows_out?id=" & $params.id }
|
|
119
|
+
]
|
|
120
|
+
)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Переключатель в заголовке виджета
|
|
124
|
+
|
|
125
|
+
Если переключатель — содержимое виджета сетки `mkr-grid` с заголовком, он стоит в строке заголовка
|
|
126
|
+
справа, перед панелью таблицы. Отдельной строки под заголовком нет: содержимое вкладки начинается сразу
|
|
127
|
+
под ним. Пока вкладки загружаются, в заголовке только название.
|
|
128
|
+
|
|
129
|
+
В остальных случаях — виджет без заголовка, переключатель вне виджета или внутри вкладок другого
|
|
130
|
+
`mkr-tabs` — переключатель стоит первой строкой содержимого.
|
|
131
|
+
|
|
132
|
+
Если в строке заголовка мало места, оно освобождается по порядку:
|
|
133
|
+
|
|
134
|
+
1. вкладки переключателя уходят в меню «Ещё»;
|
|
135
|
+
2. если рядом с названием не помещается даже выбранная вкладка с кнопкой «Ещё», переключатель
|
|
136
|
+
переходит на вторую строку заголовка;
|
|
137
|
+
3. поле поиска панели таблицы сужается с 200 до 140px;
|
|
138
|
+
4. панель таблицы переходит на следующую строку заголовка.
|
|
139
|
+
|
|
140
|
+
### Вкладки, которые не помещаются
|
|
141
|
+
|
|
142
|
+
Правила одинаковы для вкладок и переключателя. Если вкладки не помещаются в строку,
|
|
143
|
+
в её конце стоит кнопка «Ещё N», где N — число вкладок в меню. В строке — первые по порядку вкладки,
|
|
144
|
+
сколько помещается вместе с кнопкой, и выбранная вкладка: она всегда в строке. Остальные вкладки —
|
|
145
|
+
в меню, в порядке описания. После выбора вкладки из меню состав строки и меню определяется заново.
|
|
146
|
+
|
|
93
147
|
## Пример использования в архитектурном коде документа с типом mkr-grid:
|
|
94
148
|
|
|
95
149
|
```yaml
|
|
@@ -183,6 +237,48 @@ entities:
|
|
|
183
237
|
|
|
184
238
|

|
|
185
239
|
|
|
240
|
+
### Виджеты сетки
|
|
241
|
+
|
|
242
|
+
Секция сетки с заголовком (`title`), иконкой (`icon`) или рамкой (`style.border`) выводится виджетом.
|
|
243
|
+
`border: true` рисует рамку; с рамкой и без нее виджет устроен одинаково. Заголовок и содержимое
|
|
244
|
+
виджета — текст markdown, первый столбец таблицы, поле выбора — стоят на отступе 20px от края.
|
|
245
|
+
Таблица в виджете своей рамки не рисует: строки идут от края до края виджета.
|
|
246
|
+
|
|
247
|
+
### Промежуток между секциями
|
|
248
|
+
|
|
249
|
+
Промежуток между соседними секциями `columns` и `rows` — не меньше 16px. `margin` соседних секций
|
|
250
|
+
входит в промежуток: сетка добавляет недостающее до 16px, а если сумма `margin` пары больше, промежуток
|
|
251
|
+
равен этой сумме. Промежуток считается для каждой пары соседей отдельно:
|
|
252
|
+
|
|
253
|
+
| `margin` секций | Промежутки |
|
|
254
|
+
|-----------------|------------|
|
|
255
|
+
| нет | 16px |
|
|
256
|
+
| `4px` и `4px` | 16px |
|
|
257
|
+
| `4px`, `4px` и `8px` | 16px и 16px |
|
|
258
|
+
| `12px` и `12px` | 24px |
|
|
259
|
+
|
|
260
|
+
В сумму входит `margin` вложенных секций, которые прилегают к соседу, кроме секций внутри рамки:
|
|
261
|
+
у секции с `border` край — сама рамка. Если `margin` пары задан не в пикселях (`1em`, `5%`, `auto`),
|
|
262
|
+
сетка к нему ничего не добавляет.
|
|
263
|
+
|
|
264
|
+
### Панель таблицы в заголовке виджета
|
|
265
|
+
|
|
266
|
+
Если содержимое виджета с заголовком — таблица, справа в заголовке виджета стоит ее панель: число
|
|
267
|
+
строк, поле поиска и кнопка Excel. Таблица может лежать в виджете сама, на открытой вкладке `mkr-tabs`
|
|
268
|
+
или в выбранном варианте `mkr-select`; при переключении вкладки панель показывает таблицу открытой
|
|
269
|
+
вкладки. Число строк — общее, поиск его не меняет. Поле поиска есть у таблиц больше 10 строк, кнопки
|
|
270
|
+
Excel нет у пустой таблицы.
|
|
271
|
+
|
|
272
|
+
Поле поиска в заголовке шириной до 200px. Если места мало, оно сужается до 140px, а затем панель
|
|
273
|
+
переходит на вторую строку заголовка. Если в заголовке стоит и переключатель вкладок, место сначала
|
|
274
|
+
освобождает он: вкладки уходят в меню «Ещё», затем переключатель переходит на вторую строку, и только
|
|
275
|
+
потом сужается поле поиска (см. [Переключатель в заголовке виджета](#переключатель-в-заголовке-виджета)).
|
|
276
|
+
|
|
277
|
+
В остальных случаях — таблица вне виджета, внутри markdown, в виджете без заголовка, несколько таблиц
|
|
278
|
+
в одном виджете — поле поиска и кнопка Excel стоят в строке над таблицей, без числа строк. У редактируемой
|
|
279
|
+
таблицы (`editable-table`) панели в заголовке виджета нет: ее действия остаются в ее собственной панели.
|
|
280
|
+
Подробнее о таблицах — в разделе [Таблица](/docs/archtool.tables).
|
|
281
|
+
|
|
186
282
|
## Пример использования в архитектурном коде документа с типом mkr-tree:
|
|
187
283
|
|
|
188
284
|
```yaml
|
|
@@ -117,6 +117,34 @@ docs:
|
|
|
117
117
|

|
|
118
118
|
|
|
119
119
|
|
|
120
|
+
### Шапка объекта
|
|
121
|
+
|
|
122
|
+
Для карточек объектов (системы, продукта, компонента) предусмотрено оформление шапки
|
|
123
|
+
средствами обычного markdown, без HTML:
|
|
124
|
+
|
|
125
|
+
```markdown
|
|
126
|
+
###### Система
|
|
127
|
+
# CRM
|
|
128
|
+
`example.systems.crm`
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
- заголовок шестого уровня (`######`), за которым сразу следует заголовок первого или второго
|
|
132
|
+
уровня, выводится надписью над заголовком — типом объекта;
|
|
133
|
+
- абзац, который целиком состоит из одного inline-кода и стоит сразу после заголовка первого
|
|
134
|
+
или второго уровня, выводится плашкой — идентификатором объекта.
|
|
135
|
+
|
|
136
|
+
Остальные заголовки шестого уровня и inline-код в обычных предложениях оформляются как обычно.
|
|
137
|
+
Шапку удобно формировать шаблоном, например:
|
|
138
|
+
|
|
139
|
+
```markdown
|
|
140
|
+
###### {{entity}}
|
|
141
|
+
# {{title}}
|
|
142
|
+
`{{id}}`
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Результат:
|
|
146
|
+

|
|
147
|
+
|
|
120
148
|
## Использование HTML
|
|
121
149
|
По умолчанию в markdown отключены HTML тэги. Это сделано для исключения встраивания потенциально опасного
|
|
122
150
|
произвольного кода. Для включения поддержки HTML, используйте переменную окружения VUE_APP_DOCHUB_MARKDOWN_HTML
|
|
@@ -38,6 +38,7 @@ imports:
|
|
|
38
38
|
- examples/charts.yaml
|
|
39
39
|
- examples/inlinemeta.md
|
|
40
40
|
- examples/markaper.yaml
|
|
41
|
+
- examples/excel.yaml
|
|
41
42
|
- examples/toc/root.yaml
|
|
42
43
|
- gigachat/root.yaml
|
|
43
44
|
- editable_table/root.yaml
|
|
@@ -629,6 +630,12 @@ docs:
|
|
|
629
630
|
type: markdown
|
|
630
631
|
source: markaper.md
|
|
631
632
|
|
|
633
|
+
archtool.excel:
|
|
634
|
+
location: SEAF.ArchTool/Руководство/Документы/Экспорт и импорт Excel
|
|
635
|
+
description: Экспорт и импорт Excel (excel-export, excel-import)
|
|
636
|
+
type: markdown
|
|
637
|
+
source: excel.md
|
|
638
|
+
|
|
632
639
|
archtool.wizard:
|
|
633
640
|
location: SEAF.ArchTool/Руководство/Документы/Мастер (wizard)
|
|
634
641
|
description: Мастер (wizard)
|
|
@@ -673,6 +680,12 @@ docs:
|
|
|
673
680
|
}
|
|
674
681
|
)
|
|
675
682
|
|
|
683
|
+
archtool.example.object_header: # Пример шапки объекта в markdown
|
|
684
|
+
title: 'Пример шапки объекта'
|
|
685
|
+
type: markdown
|
|
686
|
+
toc: false
|
|
687
|
+
source: examples/object_header.md
|
|
688
|
+
|
|
676
689
|
# *****************************************
|
|
677
690
|
# Шаблоны
|
|
678
691
|
# *****************************************
|
|
@@ -42,6 +42,18 @@
|
|
|
42
42
|
|
|
43
43
|
Компоненты сети с `is_part_of` отображаются в составе единого `network_service`; для размещения такого агрегата требуется разрешимый `segment` самого сервиса, его участников или связанной через `network_connection` сети.
|
|
44
44
|
|
|
45
|
+
### Магистральная маршрутизация logical links
|
|
46
|
+
|
|
47
|
+
Маршрутизация включается только булевым параметром `layout_settings.corridor_routing: true` в профиле документа или результате `source`. Без него, в том числе у документов с названием R41, автоматическая маршрутизация выключена. Настройка из `source` имеет приоритет над профилем. Для схемы R41 включите этот параметр в её профиле; ID документа на выбор режима не влияет.
|
|
48
|
+
|
|
49
|
+
Алгоритм обрабатывает каждую страницу отдельно: сохраняет исходную logical link как `mxCell` и строит ортогональный маршрут в обход прямоугольников смысловых объектов. Поиск избегает перекрытия с участками связей других логических слоёв, кроме коротких общих участков у концов; перекрытия внутри одного слоя возможны. Горизонтальная полоса у источника задаётся как предпочтение, поэтому порядок полос не гарантируется. Физические связи слоя `Connections` не изменяются. Все связи одного логического слоя имеют общий цвет, выбранный по позиции его ID в отсортированном списке слоёв всего документа. На разных страницах цвет одинакового слоя совпадает; добавление или удаление слоёв может изменить цвета остальных.
|
|
50
|
+
|
|
51
|
+
Исходная схема показывается до окончания расчёта; результаты появляются по готовности страниц. Во время обновления данных и расчёта весь iframe редактора временно заблокирован: недоступны редактирование, переключение страниц, изменение масштаба и прокрутка внутри редактора. Показ исходной схемы не означает доступность управления до завершения расчёта; блокировка защищает правки от потери при загрузке очередного XML. Если часть связей не получила маршрут, остаются успешно проложенные и исходные неудачные связи. Такой смешанный результат можно сохранять и экспортировать после завершения расчёта. При критическом сбое расчёта показывается доступная часть схемы, а при сбое получения новых данных сохраняется предыдущая схема; экспорт в этих случаях заблокирован до успешного обновления. Краткое уведомление доступно у маленького значка в шапке, рядом находится **Повторить**. Подробности не выводятся поверх схемы: штатный логгер IDE-плагина пишет их в `.seaf_log/plugin.log` с учётом выбранной директории логов; в web-режиме используется консоль браузера (журнал frontend).
|
|
52
|
+
|
|
53
|
+
Автоматические точки и стили не добавляются в файл трансформаций без ручного изменения связи. Ручная правка сохраняется вместе с точками подключения и не перезаписывается при повторном открытии, в том числе на Общей странице. Старые файлы трансформаций автоматически не очищаются: сохранённая в них геометрия также сохраняет приоритет. Для диагностики `totalLogicalEdges = routedEdges + preservedEdges` означает, что связи проложены автоматически либо сохранены как ручные; `failedEdges = skippedEdges = 0` означает отсутствие отказов. Ручная геометрия не пересчитывается и может пересекать объекты. Эта функция не равна вычислению сетевого пути через `logical_links.computed_routes`, описанному ниже.
|
|
54
|
+
|
|
55
|
+
Логические слои в панели Draw.io сортируются по названию с числовым порядком (`1.2` перед `1.10`), отдельно от базовых слоёв. Сортировка действует и при выключенной маршрутизации. Копии объектов Общей страницы сохраняют тип в XML-атрибуте `common_schema`; исходные архитектурные данные не изменяются.
|
|
56
|
+
|
|
45
57
|
### Перестроение схемы с ИИ (бета)
|
|
46
58
|
|
|
47
59
|
Для документа можно явно включить экспериментальный диалог перестроения схемы по текстовому запросу. По умолчанию функция выключена. При включении пользователь видит кнопку **Перестроить с ИИ** и предупреждение о передаче запроса и выбранного контекста в настроенный в ArchTool GigaChat через общий `chatService`.
|
|
@@ -112,6 +124,7 @@ docs:
|
|
|
112
124
|
type: seaf2drawio
|
|
113
125
|
source: seaf.company.ds.ta.schema_r41
|
|
114
126
|
layout_settings:
|
|
127
|
+
corridor_routing: true
|
|
115
128
|
logical_links:
|
|
116
129
|
computed_routes:
|
|
117
130
|
enabled: true
|
|
@@ -27,6 +27,110 @@ docs:
|
|
|
27
27
|
Результат:
|
|
28
28
|

|
|
29
29
|
|
|
30
|
+
## Статус в виде чипа
|
|
31
|
+
|
|
32
|
+
Значение колонки можно вывести цветным чипом, например статус объекта. Для этого у колонки
|
|
33
|
+
указывается `format: status`. Оттенок чипа задается картой `statuses`: значение колонки -> оттенок.
|
|
34
|
+
Допустимые оттенки:
|
|
35
|
+
|
|
36
|
+
| Оттенок | Назначение |
|
|
37
|
+
|---------|------------|
|
|
38
|
+
| `ok` | используется, в норме |
|
|
39
|
+
| `wip` | в работе, создается |
|
|
40
|
+
| `off` | выводится, неактивен |
|
|
41
|
+
| `bad` | проблема, не поддерживается |
|
|
42
|
+
|
|
43
|
+
Значение, которого нет в `statuses`, и колонка без `statuses` выводятся нейтральным чипом.
|
|
44
|
+
Неизвестный оттенок в `statuses` тоже дает нейтральный чип.
|
|
45
|
+
|
|
46
|
+
```yaml
|
|
47
|
+
docs:
|
|
48
|
+
archtool.table.status:
|
|
49
|
+
type: table
|
|
50
|
+
headers:
|
|
51
|
+
- value: title
|
|
52
|
+
text: Система
|
|
53
|
+
align: left
|
|
54
|
+
- value: status
|
|
55
|
+
text: Статус
|
|
56
|
+
align: left
|
|
57
|
+
format: status # Выводить значение чипом статуса
|
|
58
|
+
statuses: # Значение -> оттенок чипа: ok, wip, off, bad
|
|
59
|
+
Используется: ok
|
|
60
|
+
Создается: wip
|
|
61
|
+
Выводится: off
|
|
62
|
+
Не поддерживается: bad
|
|
63
|
+
source:
|
|
64
|
+
- title: CRM
|
|
65
|
+
status: Используется
|
|
66
|
+
- title: Мобильное приложение
|
|
67
|
+
status: Создается
|
|
68
|
+
- title: Старый портал
|
|
69
|
+
status: Выводится
|
|
70
|
+
- title: Учетная система
|
|
71
|
+
status: Не поддерживается
|
|
72
|
+
- title: Аналитика
|
|
73
|
+
status: Планируется # Нет в statuses — нейтральный чип
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Результат:
|
|
77
|
+

|
|
78
|
+
|
|
79
|
+
## Строк на странице
|
|
80
|
+
|
|
81
|
+
По умолчанию таблица показывает 10 строк на странице. Другое значение задается полем `per-page`:
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
docs:
|
|
85
|
+
my.table:
|
|
86
|
+
type: table
|
|
87
|
+
per-page: 20 # Строк на странице
|
|
88
|
+
headers:
|
|
89
|
+
...
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
В списке «Записей на странице» доступны 10, 20, 50, значение `per-page` и «Все».
|
|
93
|
+
`per-page: -1` выводит все строки сразу. Если все строки помещаются на одну страницу,
|
|
94
|
+
подвал с пагинацией не показывается. При печати таблица выводится целиком.
|
|
95
|
+
|
|
96
|
+
## Ширина столбцов
|
|
97
|
+
|
|
98
|
+
Ширину столбцов таблица подбирает по содержимому:
|
|
99
|
+
|
|
100
|
+
- столбец, в значениях которого каждая строка не длиннее 20 символов (коды, статусы, технологии),
|
|
101
|
+
не переносится; переводы строк в значениях сохраняются. Столбец с `format: status` тоже не переносится;
|
|
102
|
+
- остальные столбцы — не уже 160px, длинный текст в них переносится.
|
|
103
|
+
|
|
104
|
+
Ширина, заданная в профиле, важнее этих правил. Ширину столбца задают поля `width`, `minWidth`
|
|
105
|
+
и `maxWidth` — числом пикселей или CSS-значением:
|
|
106
|
+
|
|
107
|
+
```yaml
|
|
108
|
+
docs:
|
|
109
|
+
my.table:
|
|
110
|
+
type: table
|
|
111
|
+
headers:
|
|
112
|
+
- value: code
|
|
113
|
+
text: Код
|
|
114
|
+
width: 80 # Ширина столбца
|
|
115
|
+
- value: title
|
|
116
|
+
text: Наименование
|
|
117
|
+
minWidth: 240 # Минимальная ширина столбца
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Ключи через дефис (`min-width`, `max-width`) не применяются: столбец с ними раскладывается по содержимому.
|
|
121
|
+
|
|
122
|
+
Если столбцы не помещаются по ширине, таблица прокручивается по горизонтали, а у края со скрытыми
|
|
123
|
+
столбцами видна тень.
|
|
124
|
+
|
|
125
|
+
## Поиск, выгрузка и пустая таблица
|
|
126
|
+
|
|
127
|
+
У таблицы больше 10 строк есть поле поиска. Кнопка Excel выгружает все строки таблицы; у пустой
|
|
128
|
+
таблицы и в печатной версии ее нет. Поле поиска и кнопка Excel стоят в строке над таблицей.
|
|
129
|
+
Если таблица — содержимое виджета с заголовком в сетке [markaper](/docs/archtool.markaper),
|
|
130
|
+
они вместе с числом строк выводятся в заголовке виджета.
|
|
131
|
+
|
|
132
|
+
Пустая таблица выводится одной строкой «Нет данных», без шапки столбцов и постраничного вывода.
|
|
133
|
+
|
|
30
134
|
## Запрос к данным архитектуры
|
|
31
135
|
|
|
32
136
|
Есть возможность выполнять запросы к данным архитектуры. Например, получить список всех интеграций:
|
|
@@ -216,6 +216,60 @@ $merge([
|
|
|
216
216
|
true
|
|
217
217
|
```
|
|
218
218
|
|
|
219
|
+
### $tryexecute()
|
|
220
|
+
|
|
221
|
+
Сигнатура: $tryexecute(function, array)
|
|
222
|
+
|
|
223
|
+
Выполняет переданную функцию и не прерывает запрос, если внутри неё возникла ошибка.
|
|
224
|
+
Ошибка перехватывается, пишется в лог, а запрос продолжается с результатом вызова.
|
|
225
|
+
|
|
226
|
+
В первом аргументе передаётся функция. Во втором — массив её аргументов.
|
|
227
|
+
Если массив не задан, функция вызывается без аргументов.
|
|
228
|
+
|
|
229
|
+
Возвращается объект:
|
|
230
|
+
|
|
231
|
+
* **success** — `true`, если функция выполнилась без ошибки, иначе `false`;
|
|
232
|
+
* **result** — значение, которое вернула функция. При ошибке — `null`;
|
|
233
|
+
* **error** — текст ошибки. Для ошибок JSONata это то же сообщение, которое запрос получил бы без `$tryexecute()`.
|
|
234
|
+
|
|
235
|
+
Если первый аргумент — не функция, или второй задан и это не массив, запрос не прерывается.
|
|
236
|
+
В **error** вернётся сообщение о неверном аргументе.
|
|
237
|
+
|
|
238
|
+
Запрос:
|
|
239
|
+
```json
|
|
240
|
+
(
|
|
241
|
+
/* Успешное выполнение */
|
|
242
|
+
$ok := $tryexecute(function($a, $b) {
|
|
243
|
+
$a + $b
|
|
244
|
+
}, [1, 2]);
|
|
245
|
+
|
|
246
|
+
/* Ошибка внутри функции не прерывает запрос */
|
|
247
|
+
$failed := $tryexecute(function($value) {
|
|
248
|
+
$number($value)
|
|
249
|
+
}, ["abc"]);
|
|
250
|
+
|
|
251
|
+
{
|
|
252
|
+
"ok": $ok,
|
|
253
|
+
"failed": $failed
|
|
254
|
+
}
|
|
255
|
+
)
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
Результат:
|
|
259
|
+
```json
|
|
260
|
+
{
|
|
261
|
+
"ok": {
|
|
262
|
+
"success": true,
|
|
263
|
+
"result": 3
|
|
264
|
+
},
|
|
265
|
+
"failed": {
|
|
266
|
+
"success": false,
|
|
267
|
+
"result": null,
|
|
268
|
+
"error": "Unable to cast value to a number: \"abc\""
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
```
|
|
272
|
+
|
|
219
273
|
## Дополнительные переменные
|
|
220
274
|
|
|
221
275
|
### $self
|
|
@@ -21,6 +21,13 @@ import doc from './components/HTMLDocument.vue';
|
|
|
21
21
|
DocHub.documents.register('html', doc);
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
+
### DocHub.runtime
|
|
25
|
+
|
|
26
|
+
- `apiVersion` — версия API, сейчас `1`; у внешнего плагина должна быть такая же.
|
|
27
|
+
- `vue` — общий Vue runtime портала. В IIFE-сборке Vite/Rollup укажите `external: ['vue']` и `globals: { vue: 'DocHub.runtime.vue' }`. Остальные зависимости включайте в bundle.
|
|
28
|
+
|
|
29
|
+
Поля объекта заморожены, чтобы их случайно не заменили. Это не sandbox; не изменяйте `DocHub.runtime`.
|
|
30
|
+
|
|
24
31
|
## 2. Параметры компонентов documents
|
|
25
32
|
|
|
26
33
|
### profile: Object
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Мы будем стараться сохранять совместимость при его развитии, но следует учитывать эту информацию
|
|
5
5
|
при принятии решения об его использовании.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Есть два способа подключения: исходники собираются вместе с core либо готовый bundle подключается через каталог без пересборки портала. Первый способ доступен в портале и IDE; второй — пока только в портале. В IDE включённые в сборку плагины всегда подключаются сразу.
|
|
8
8
|
|
|
9
9
|
## Введение
|
|
10
10
|
|
|
@@ -16,7 +16,37 @@
|
|
|
16
16
|
1. Новый [тип документа](/docs/archtool.docs) - реализовано (beta);
|
|
17
17
|
2. [Источник данных](/docs/archtool.datasets) - запланировано.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Готовые сборки без пересборки портала
|
|
20
|
+
|
|
21
|
+
Положите готовые JS/CSS и описание `plugin.json` в `public/plugins/<имя>/`:
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"schemaVersion": 1,
|
|
26
|
+
"id": "example-doc",
|
|
27
|
+
"version": "0.1.0",
|
|
28
|
+
"apiVersion": 1,
|
|
29
|
+
"documents": ["example-doc"],
|
|
30
|
+
"entry": "plugin.js",
|
|
31
|
+
"styles": ["plugin.css"]
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Все поля обязательны; без CSS укажите `styles: []`. Пути относятся к папке плагина. ID и типы — строчные латинские буквы, цифры и дефисы, начиная с буквы или цифры; типы не повторяются. Имена `plugins` и `packages` зарезервированы для core: их наличие в индексируемой папке останавливает scanner, а при `prebuild` — стандартную сборку портала.
|
|
36
|
+
|
|
37
|
+
JS собирается в формате IIFE и регистрирует заявленные типы через `DocHub.documents.register`. Vue берётся из [DocHub.runtime.vue](/docs/archtool.plugins.interface), остальные зависимости включаются в bundle.
|
|
38
|
+
|
|
39
|
+
1. Выполните `npm run plugins:index`: скрипт проверит описания и файлы, создаст общий `public/plugins/catalog.json`. Для отдельной папки поставки используйте `npm run plugins:index -- ./delivery/plugins`; относительный путь считается от текущей рабочей папки. Не указывайте весь `dist/plugins` с зарезервированными папками core. Скрипт не собирает и не выполняет плагины.
|
|
40
|
+
2. Для уже собранного портала скопируйте папки и каталог в раздаваемый `dist/plugins`. Для dev server выполните `npm run serve`. При `npm run build` scanner запускается автоматически.
|
|
41
|
+
3. Добавьте документ в manifest с соответствующим `type`, например `example-doc`, и обновите страницу.
|
|
42
|
+
|
|
43
|
+
Каталог должен содержать все нужные внешние плагины. Портал читает его при инициализации страницы, а JS/CSS загружает один раз при первом открытии документа, независимо от настройки lazy loading.
|
|
44
|
+
|
|
45
|
+
Локальные плагины и встроенные типы имеют приоритет: при совпадении ID или любого типа внешний плагин пропускается целиком. Неподдерживаемая `schemaVersion` отклоняет каталог; некорректные записи и несовместимая `apiVersion` пропускаются.
|
|
46
|
+
|
|
47
|
+
Подключайте только доверенный код: sandbox нет. Обновление загруженного плагина требует перезагрузки страницы. Этот способ пока не поддерживается в IDE.
|
|
48
|
+
|
|
49
|
+
## Создание простого плагина вместе с core
|
|
20
50
|
|
|
21
51
|
В этом примере показано, как создать плагин, который расширит набор встроенных типов документов новым - "html".
|
|
22
52
|
|
|
@@ -165,7 +195,7 @@ DocHub.documents.register('html', doc);
|
|
|
165
195
|
|
|
166
196
|
## Сборка
|
|
167
197
|
|
|
168
|
-
|
|
198
|
+
При source-подключении плагин собирается в контексте проекта SEAF.ArchTool. В `plugins.json` задаётся массив descriptors:
|
|
169
199
|
|
|
170
200
|
```json
|
|
171
201
|
[
|
|
@@ -198,7 +228,7 @@ Entry определяется через `package.json.main`, по умолча
|
|
|
198
228
|
|
|
199
229
|
Объект `{ "inbuilt": ["plugins/html", ...] }` больше не поддерживается и приводит к ошибке сборки. Для каждого пути создайте элемент массива по примеру выше: задайте уникальный `id`, перечислите фактически регистрируемые `documents`, укажите `source.type: "local"` и перенесите путь в `source.location`. Поле `lazy` можно не задавать — сохранится общий режим загрузки.
|
|
200
230
|
|
|
201
|
-
Старое поле `external` и загрузка JS из `manifest.json.plugins` больше не поддерживаются.
|
|
231
|
+
Старое поле `external` и загрузка JS из `manifest.json.plugins` больше не поддерживаются. Для сборки исходников внешний плагин нужно установить как package и включить в `plugins.json` перед сборкой. Для готового bundle используйте каталог, описанный выше. Источник `remote` в `plugins.json` пока не реализован. Сам PWA-файл `manifest.json` продолжает генерироваться.
|
|
202
232
|
|
|
203
233
|
В IDE package-плагины также включаются в сборку. Legacy-ответ `fetchPlugins` / `pluginList` содержит только пути local-плагинов и не управляет их загрузкой.
|
|
204
234
|
|
|
@@ -208,7 +238,7 @@ Entry определяется через `package.json.main`, по умолча
|
|
|
208
238
|
|
|
209
239
|
Lazy loading позволяет отложить загрузку плагина до первого открытия документа соответствующего типа. Это уменьшает объём ресурсов, необходимых для запуска приложения. При повторном открытии документа уже загруженный плагин используется снова.
|
|
210
240
|
|
|
211
|
-
|
|
241
|
+
Для source-подключения lazy loading меняет только момент загрузки: плагин по-прежнему должен быть указан до сборки ArchTool. Готовые bundles из каталога подключаются отдельно и всегда загружаются при первом открытии документа.
|
|
212
242
|
|
|
213
243
|
`VUE_APP_DOCHUB_PLUGINS_LAZY_LOADING` задаёт режим по умолчанию при сборке: `Y` — lazy, `N` или отсутствие настройки — eager. Необязательное поле `lazy` в descriptor переопределяет этот режим для конкретного плагина:
|
|
214
244
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
package/documentation/root.yaml
CHANGED
|
File without changes
|