Merge pull request #544 from RabotaRu/v3.12.0

v3.12.0
DocHubTeam · Jun 10, 2024 · 1b7559c · 1b7559c
2 parents e0b96bd + 2005141
commit 1b7559c
Show file tree

Hide file tree

Showing 45 changed files with 1,878 additions and 915 deletions.
diff --git a/config.d.ts b/config.d.ts
@@ -16,22 +16,33 @@ declare var DochubVsCodeExt: {
       mode: string,
       request_type: string,
       server: string
-    }
+    };
+    env: {                    // Переменные среды для IDE режима
+      DOCHUB_IDE_GITLAB_URL?: string,     // gitlab сервер для режима IDE
+      DOCHUB_IDE_BITBUCKET_URL?: string,  // bitbacket сервер для режима IDE
+      DOCHUB_IDE_PERSONAL_TOKEN?: string, // персональный токен для gitlab/bitbacket
+    };
   }
 };
 
 // eslint-disable-next-line no-var
 declare var DocHubIDEACodeExt: {
   rootManifest: string,       // Корневой манифест (с чего начинается загрузка)
   settings: {
+    [x: string]: {};
     isEnterprise: boolean,    // Признак использования фронта в плагине как Enterprise портала
     enterpriseServer?: string,
     render: {
       external: boolean,      // Признак рендера на внешнем сервере
       mode: string,           // Режим рендера ELK / Smetana / GraphVis
       request_type: string,   // Тип запросов к сервер рендеринга POST / GET
       server: string          // Сервер рендеринга
-    }
+    };
+    env: {                    // Переменные среды для IDE режима
+      DOCHUB_IDE_GITLAB_URL?: string,     // gitlab сервер для режима IDE
+      DOCHUB_IDE_BITBUCKET_URL?: string,  // bitbacket сервер для режима IDE
+      DOCHUB_IDE_PERSONAL_TOKEN?: string, // персональный токен для gitlab/bitbacket
+    };
   }
 };
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "dochubcore",
   "version": "1.0.6",
-  "main": "/dist/dochub.js",
+  "main": "src/backend/main.mjs",
   "files": [
     "/dist"
   ],
@@ -44,7 +44,9 @@
     "monaco-editor": "0.34.1",
     "mustache": "4.2.0",
     "semver": "7.5.4",
+    "stream": "0.0.2",
     "swagger-ui": "3.52.5",
+    "timers": "0.1.1",
     "uuid": "8.3.2",
     "vis-network": "9.1.2",
     "vue": "2.7.14",
@@ -54,6 +56,7 @@
     "vue-router": "3.6.5",
     "vuetify": "2.6.14",
     "vuex": "3.6.2",
+    "xml2js": "0.6.2",
     "yaml": "1.10.2"
   },
   "devDependencies": {
@@ -85,6 +88,7 @@
     "jest-environment-jsdom": "29.4.1",
     "jest-test-gen": "1.4.3",
     "nodemon": "2.0.20",
+    "object-hash": "3.0.0",
     "postcss-loader": "2.1.6",
     "raw-loader": "4.0.2",
     "redis": "4.6.10",
@@ -99,8 +103,7 @@
     "vue-template-compiler": "2.7.14",
     "webpack-bundle-analyzer": "4.8.0",
     "webpack-pwa-manifest": "4.3.0",
-    "yo": "4.3.0",
-    "object-hash": "3.0.0"
+    "yo": "4.3.0"
   },
   "overrides": {
     "es5-ext": "0.10.53"

diff --git a/public/documentation/dochub.yaml b/public/documentation/dochub.yaml
@@ -0,0 +1,5 @@
+$package:
+  dochub-doc:
+    version: 3.0.0
+imports:
+  - root.yaml
diff --git a/public/documentation/docs/manual/config/deployment.md b/public/documentation/docs/manual/config/deployment.md
@@ -18,6 +18,14 @@ DocHub поддерживает следующие режимы разверты
 
 Вам также поможет статья ["Архитектура рядом с кодом"](https://habr.com/ru/post/659595/).
 
+### Переменные среды
+
+* **DOCHUB_IDE_GITLAB_URL** - Адрес Gitlab сервера для интеграции с ним (например, https://gitlab.com/);
+* **DOCHUB_IDE_BITBUCKET_URL** - Адрес Bitbucket сервера для интеграции с ним (например, https://bitbucket.org/);
+* **DOCHUB_IDE_PERSONAL_TOKEN** - Персональный токен, необходимый для доступа к системе управления версиями. Выпускается самой системой (Gitlab/Bitbucket).
+
+Переменные среды могут быть переопределены через пользовательский интерфейс в настройках плагина.
+
 ### Преимущества
 1. Развертывание буквально за 2 минуты;
 2. Встраивание в инструмент производства (IDE);

diff --git a/public/documentation/docs/manual/docs/bpmn.md b/public/documentation/docs/manual/docs/bpmn.md
@@ -87,5 +87,38 @@
 ![Редактирование BPM диаграмм в IDEA](https://youtu.be/qQzsHuYxNzg)
 
 
+## Анализ процессов
 
+DocHub может обращаться к описанию процессов в XML формате аналогично YAML и JSON. Для этого необходимо указать XML
+файл как источник данных. Например, рассмотрим анализ процесса:
 
+![BPMN](@document/dochub.example.bpmn.full)
+
+Выявим реестр задач определенных в процессе и выразим его в таблице:
+
+```yaml
+docs:
+  ...
+  dochub.example.bpmn.analyse:
+    origin: examples/pizza-collaboration.xml  # Указываем источником оригинальных данных XML файл
+    source: >                                 # Обрабатываем XML
+      (
+          [$."semantic:definitions"."semantic:process"."semantic:task"."$"]
+      )
+    type: table                               # Тип документа "таблица"
+    headers:                                  # Заголовки таблицы
+      - value: id
+        text: Идентификатор
+        sortable: true
+        align: left
+        width: 20%
+      - value: name
+        text: Название задачи
+        sortable: true
+        align: left
+  ...
+```
+
+Результат:
+
+![BPMN](@document/dochub.example.bpmn.analyse)
diff --git a/public/documentation/docs/manual/docs/examples/bpmn.xml b/public/documentation/docs/manual/docs/examples/bpmn.xml
@@ -41,4 +41,4 @@
       </bpmndi:BPMNEdge>
     </bpmndi:BPMNPlane>
   </bpmndi:BPMNDiagram>
-</definitions>
+</definitions>
diff --git a/public/documentation/docs/manual/docs/markdown.md b/public/documentation/docs/manual/docs/markdown.md
@@ -1,9 +1,14 @@
 # Markdown
 
-В Markdown документах включена поддержка HTML. Добавлены специальные теги DocHub, которые позволяют
-заметно расширить функциональность:
+Облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте, 
+с максимальным сохранением его читаемости человеком, и пригодный для машинного
+преобразования в языки для продвинутых публикаций.
 
-## Навигационные якоря
+## Расширенные возможности
+
+Добавлены специальные теги DocHub, которые позволяют заметно расширить функциональность:
+
+### Навигационные якоря
 Позволяет создавать именованные якоря для "коротких" ссылок внутри документа. Например, код:
 ```
 ![](@anchor/markdown)
@@ -13,7 +18,7 @@
 [Пример короткой ссылки](#markdown)
 ```
 
-## Изображения
+### Изображения
 Поддерживается встраивание изображений. Например:
 
 ```
@@ -22,7 +27,7 @@
 
 ![Кот](examples/cat.jpg)
 
-## Ссылки на объекты DocHub
+### Ссылки на объекты DocHub
 Добавляет ссылку на архитектурный объект. Пример для ссылки на документ:
 ```
 [Swagger контракт](/docs/dochub.example.swgr)
@@ -41,7 +46,7 @@
 
 [Компонент gitlab](/architect/components/dochub.gitlab)
 
-## Встраиваемые объекты DocHub
+### Встраиваемые объекты DocHub
 Интегрирует в документ архитектурный объект. Например:
 ```
 ![Компонент архитектуры](@component/dochub.front)
@@ -66,4 +71,33 @@
 
 Через "/" указывается идентификатор объекта. 
 
+## Использование HTML 
+По умолчанию в markdown отключены HTML тэги. Это сделано для исключения встраивания потенциально опасного 
+произвольного кода. Для включения поддержки HTML, используйте переменную окружения VUE_APP_DOCHUB_MARKDOWN_HTML 
+в режиме портала.
+
+```
+VUE_APP_DOCHUB_MARKDOWN_HTML=on
+```
+
+Подробнее [здесь](https://github.com/RabotaRu/DocHub/blob/master/example.env).
+
+Для включения поддержки HTML в плагинах, потребуется установить переменную DOCHUB_IDE_MARKDOWN_HTML на рабочей станции.
+
+Для linux:
+
+```
+export DOCHUB_IDE_MARKDOWN_HTML=on
+```
+
+Для windows:
+```
+set DOCHUB_IDE_MARKDOWN_HTML=on
+```
+
+**ВНИМАНИЕ:** Поддержка HTML не является стандартом markdown. Высока вероятность столкнуться с различными
+проблемами при его использовании. Не рекомендуется использование HTML в Markdown. 
+
+
+