@haiiro/docuflow 0.0.6 → 0.0.7
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/README.md +16 -13
- package/manifest.json +12 -12
- package/package.json +1 -1
- package/src/front-components/docflow-processes.front-component.mjs +27 -27
- package/src/front-components/docflow-processes.front-component.tsx +24 -89
- package/src/front-components/docflow-tasks.front-component.mjs +19 -19
- package/src/front-components/docflow-tasks.front-component.tsx +24 -4
- package/src/front-components/process-steps.front-component.mjs +1 -1
- package/src/front-components/process-steps.front-component.tsx +4 -3
- package/src/logic-functions/launch-parameters-step.logic-function.mjs +1 -1
- package/src/logic-functions/launch-process.logic-function.mjs +1 -0
- package/src/logic-functions/save-launch-fields.logic-function.mjs +33 -2
- package/src/logic-functions/save-launch-fields.logic-function.ts +1 -1
package/README.md
CHANGED
|
@@ -10,10 +10,10 @@
|
|
|
10
10
|
| Где | Что |
|
|
11
11
|
|---|---|
|
|
12
12
|
| Сайдбар | пункт «Документооборот» с вкладками «Задания», «Процессы», «Документы» |
|
|
13
|
-
| «Задания» | задачи раздела «Документооборот»; фильтры «Открытые / Мои / Просроченные /
|
|
13
|
+
| «Задания» | задачи раздела «Документооборот»; фильтры «Открытые / Мои / Просроченные / Выполненные / Архив» (архив — удалённые, со штатным «Восстановить»), поиск, создание задания с инструкцией и полями для заполнения |
|
|
14
14
|
| Карточка задачи | вкладка «Задание»: инструкция, поля задания (собрать конструктором, заполнить), «Выполнить» |
|
|
15
|
-
| Карточка процесса |
|
|
16
|
-
| Редактор процесса | шаг
|
|
15
|
+
| Карточка процесса | кнопка «Параметры запуска» вверху (боковая панель): параметры запуска (конструктор полей) и, для шагов «Человеческий ввод» черновика, кто выполняет, срок в днях, обязательные поля; у каждого поля видна переменная, которой его читают следующие шаги |
|
|
16
|
+
| Редактор процесса | шаг «Параметры запуска» (ставится сам): отдаёт следующим шагам параметры, заполненные перед запуском |
|
|
17
17
|
| «Процессы» | процессы с ручным запуском раздела «Документооборот»; форма параметров до запуска, «Запустить», «Создать», «Изменить процесс» |
|
|
18
18
|
| «Документы» | папки, фильтры, поиск по названию и номеру, документ с реквизитами (тип, номер, дата, срок действия, контрагент, описание), файл в поле «Файл» карточки, карточка с источником |
|
|
19
19
|
| Автоматически | шаг «Человеческий ввод» процесса становится задачей; её выполнение продолжает процесс; файл, приложенный к любой записи, копируется в документы с отметкой, кто, когда и куда его добавил |
|
|
@@ -62,23 +62,23 @@ docker compose exec server npx -y @haiiro/install@latest docuflow
|
|
|
62
62
|
|
|
63
63
|
## Как пользоваться
|
|
64
64
|
|
|
65
|
-
- **Процесс.** «Процессы → Создать»
|
|
66
|
-
Существующий процесс переносится в документооборот полем
|
|
67
|
-
-
|
|
65
|
+
- **Процесс.** «Процессы → Создать» создаёт процесс с ручным запуском в разделе «Документооборот» и
|
|
66
|
+
открывает редактор. Существующий процесс переносится в документооборот полем «Раздел».
|
|
67
|
+
- **Параметры запуска.** Кнопка процесса «Параметры запуска» → «Добавить поле»: название, тип
|
|
68
68
|
(текст, число, дата, сотрудник, компания, контакт, сделка), обязательность. «Сохранить параметры»
|
|
69
|
-
ставит процессу ручной запуск, если запуска ещё нет, и
|
|
70
|
-
|
|
69
|
+
ставит процессу ручной запуск, если запуска ещё нет, и сразу после него — шаг «Параметры
|
|
70
|
+
запуска». В следующих шагах параметры выбираются в списке переменных как поля этого шага:
|
|
71
71
|
`{{<шаг>.<поле>}}`, точное имя показано рядом с полем. Опубликуйте процесс. Параметры
|
|
72
72
|
заполняются в «Процессах» до запуска; обязательные проверяются и на странице, и на сервере, а
|
|
73
73
|
значения хранятся в запуске (`trigger.smbDocflowParameters`).
|
|
74
74
|
- **Задание шага.** Шаг «Человеческий ввод» становится задачей раздела процесса: у исполнителя
|
|
75
|
-
из
|
|
75
|
+
из «Параметров запуска», без него — у запустившего. Поля задания — поля шага из редактора.
|
|
76
76
|
«Выполнить» проверяет обязательные поля и продолжает процесс; значения дальше читаются
|
|
77
77
|
переменными шага `{{<шаг>.<поле>}}`.
|
|
78
78
|
- **Своё задание.** «Задания → Создать»: название, исполнитель, срок, инструкция и поля для
|
|
79
79
|
заполнения тем же конструктором. Поля меняются в панели задания («Изменить поля»).
|
|
80
|
-
- **Документы.** «Документы →
|
|
81
|
-
|
|
80
|
+
- **Документы.** «Документы → Создать» создаёт черновик в открытой папке и открывает его штатную
|
|
81
|
+
карточку: там реквизиты и поле «Файл»; строка списка открывает ту же карточку. Так сделано потому, что
|
|
82
82
|
страница приложения в песочнице видит только имя и размер выбранного файла, не его содержимое.
|
|
83
83
|
Файл, приложенный к любой записи (компания, сделка, задача, свой объект), появляется в
|
|
84
84
|
документах сам: «Где загружен», автор, дата, для задачи процесса — ссылка на запуск. Документ
|
|
@@ -86,10 +86,13 @@ docker compose exec server npx -y @haiiro/install@latest docuflow
|
|
|
86
86
|
|
|
87
87
|
## Ограничения
|
|
88
88
|
|
|
89
|
-
-
|
|
89
|
+
- Рамки вокруг страницы раздела рисует платформа: карточку виджета и рамку вокруг компонента
|
|
90
|
+
приложения. Компоненты приложений работают в изолированном worker'е и убрать их не могут.
|
|
91
|
+
- Параметры видны в редакторе только как переменные шага «Параметры запуска»: у блока «Запуск
|
|
92
|
+
вручную» Twenty показывает лишь свои переменные, поэтому без шага их не выбрать.
|
|
90
93
|
- Параметры запуска относятся к процессу, а не к версии: после правки полей опубликованная версия
|
|
91
94
|
до публикации нового черновика получает новые поля, а переменные убранных полей в ней пусты.
|
|
92
|
-
- Если после ручного запуска идут сразу несколько шагов,
|
|
95
|
+
- Если после ручного запуска идут сразу несколько шагов, «Параметры запуска» встаёт перед
|
|
93
96
|
первым из них; остальным ветвям переменные шага недоступны.
|
|
94
97
|
- Документ без файла создаётся раньше файла: если закрыть карточку, не прикрепив файл, документ
|
|
95
98
|
останется с пустым полем «Файл».
|
package/manifest.json
CHANGED
|
@@ -47,9 +47,9 @@
|
|
|
47
47
|
}
|
|
48
48
|
},
|
|
49
49
|
"defaultRoleUniversalIdentifier": "26b1dde8-4ed9-4f39-8516-e0dcb734ea5a",
|
|
50
|
-
"aboutDescription": "# Документооборот (`@crm-nordiv/docuflow`)\n\nЗадания, процессы и документы компании в одном разделе. Ставится в CRM как приложение, без правок\nсервера.\n\n- universalIdentifier: `0b7d5d2e-8c4f-4a59-9a43-2f6f1c3e9d21`\n\n## Что получается после установки\n\n| Где | Что |\n|---|---|\n| Сайдбар | пункт «Документооборот» с вкладками «Задания», «Процессы», «Документы» |\n| «Задания» | задачи раздела «Документооборот»; фильтры «Открытые / Мои / Просроченные /
|
|
50
|
+
"aboutDescription": "# Документооборот (`@crm-nordiv/docuflow`)\n\nЗадания, процессы и документы компании в одном разделе. Ставится в CRM как приложение, без правок\nсервера.\n\n- universalIdentifier: `0b7d5d2e-8c4f-4a59-9a43-2f6f1c3e9d21`\n\n## Что получается после установки\n\n| Где | Что |\n|---|---|\n| Сайдбар | пункт «Документооборот» с вкладками «Задания», «Процессы», «Документы» |\n| «Задания» | задачи раздела «Документооборот»; фильтры «Открытые / Мои / Просроченные / Выполненные / Архив» (архив — удалённые, со штатным «Восстановить»), поиск, создание задания с инструкцией и полями для заполнения |\n| Карточка задачи | вкладка «Задание»: инструкция, поля задания (собрать конструктором, заполнить), «Выполнить» |\n| Карточка процесса | кнопка «Параметры запуска» вверху (боковая панель): параметры запуска (конструктор полей) и, для шагов «Человеческий ввод» черновика, кто выполняет, срок в днях, обязательные поля; у каждого поля видна переменная, которой его читают следующие шаги |\n| Редактор процесса | шаг «Параметры запуска» (ставится сам): отдаёт следующим шагам параметры, заполненные перед запуском |\n| «Процессы» | процессы с ручным запуском раздела «Документооборот»; форма параметров до запуска, «Запустить», «Создать», «Изменить процесс» |\n| «Документы» | папки, фильтры, поиск по названию и номеру, документ с реквизитами (тип, номер, дата, срок действия, контрагент, описание), файл в поле «Файл» карточки, карточка с источником |\n| Автоматически | шаг «Человеческий ввод» процесса становится задачей; её выполнение продолжает процесс; файл, приложенный к любой записи, копируется в документы с отметкой, кто, когда и куда его добавил |\n| Битрикс24 | страница приложения в портале со списком открытых заданий сотрудника и ссылками в CRM; уведомление исполнителю нового задания |\n\n## Данные\n\n| Объект | Поля |\n|---|---|\n| `smbDocument` (новый) | название, файл, тип, номер, дата, действует до, контрагент (компания), описание, статус, автор, ответственный, папка; источник: `origin`, `sourceObjectName`, `sourceRecordId`, `sourceRecordName`, `sourceFileId`, `workflowRunId` |\n| `smbDocumentFolder` (новый) | название, цвет, родительская папка |\n| `workflow` | `smbSection` «Раздел»: CRM / Документооборот; `smbLaunchFields` «Параметры запуска» — поля, которые заполняют перед запуском |\n| `task` | `smbSection`, `smbInstruction` «Инструкция»; `smbFormSchema`, `smbFormValues` — поля задания; `smbWorkflowRunId`, `smbWorkflowStepId`, `smbWorkflowThreadId` — связь с шагом процесса |\n| `company` | `smbDocuments` — документы контрагента |\n| роли | «Документооборот: функции приложения» (права функций), «Документооборот: участник процессов» (для людей, см. ниже) |\n\n## Установка\n\nНа сервере, где запущен Twenty, из каталога с его `docker-compose.yml`; повторный запуск\nставит новую версию:\n\n```bash\ndocker compose exec server npx -y @haiiro/install@latest docuflow\n```\n\nКлючи не нужны: установщик работает внутри контейнера сервера и вызывает его команды\n`marketplace:catalog-sync`, `application:install` и `application:upgrade`. Приложение ставится\nво все компании сервера. Конкретная версия: `docuflow@0.0.6`. Публикация из репозитория форка:\n`bash scripts/smb-publish.sh docflow`.\n\nИз исходников (для разработки): `yarn install && yarn app remote:add --url … --api-key … --as prod && yarn app apply --remote prod`.\n\nЗатем в «Настройки → Приложения → Документооборот» заполнить переменные:\n\n| Переменная | Что указать |\n|---|---|\n| `DOCFLOW_ENGINE` | `APP` |\n| `CRM_PUBLIC_URL` | адрес CRM компании, например `https://acme.example.ru`; по нему строятся ссылки из Битрикс24 |\n| `BITRIX_CLIENT_ID`, `BITRIX_CLIENT_SECRET` | из карточки локального приложения портала; без них Битрикс24 не подключается, остальное работает |\n\n**Права людей.** Отвечать на шаг запущенного процесса может только тот, у кого есть право\n«Рабочие процессы». Кто выполняет задания процессов или запускает процессы с параметрами,\nполучает роль «Документооборот: участник процессов» или это право в своей роли. Право также\nпозволяет менять процессы: давайте его тем, кому это допустимо. Обычные задания и документы\nправа «Рабочие процессы» не требуют.\n\n## Как пользоваться\n\n- **Процесс.** «Процессы → Создать» создаёт процесс с ручным запуском в разделе «Документооборот» и\n открывает редактор. Существующий процесс переносится в документооборот полем «Раздел».\n- **Параметры запуска.** Кнопка процесса «Параметры запуска» → «Добавить поле»: название, тип\n (текст, число, дата, сотрудник, компания, контакт, сделка), обязательность. «Сохранить параметры»\n ставит процессу ручной запуск, если запуска ещё нет, и сразу после него — шаг «Параметры\n запуска». В следующих шагах параметры выбираются в списке переменных как поля этого шага:\n `{{<шаг>.<поле>}}`, точное имя показано рядом с полем. Опубликуйте процесс. Параметры\n заполняются в «Процессах» до запуска; обязательные проверяются и на странице, и на сервере, а\n значения хранятся в запуске (`trigger.smbDocflowParameters`).\n- **Задание шага.** Шаг «Человеческий ввод» становится задачей раздела процесса: у исполнителя\n из «Параметров запуска», без него — у запустившего. Поля задания — поля шага из редактора.\n «Выполнить» проверяет обязательные поля и продолжает процесс; значения дальше читаются\n переменными шага `{{<шаг>.<поле>}}`.\n- **Своё задание.** «Задания → Создать»: название, исполнитель, срок, инструкция и поля для\n заполнения тем же конструктором. Поля меняются в панели задания («Изменить поля»).\n- **Документы.** «Документы → Создать» создаёт черновик в открытой папке и открывает его штатную\n карточку: там реквизиты и поле «Файл»; строка списка открывает ту же карточку. Так сделано потому, что\n страница приложения в песочнице видит только имя и размер выбранного файла, не его содержимое.\n Файл, приложенный к любой записи (компания, сделка, задача, свой объект), появляется в\n документах сам: «Где загружен», автор, дата, для задачи процесса — ссылка на запуск. Документ\n хранит копию файла.\n\n## Ограничения\n\n- Рамки вокруг страницы раздела рисует платформа: карточку виджета и рамку вокруг компонента\n приложения. Компоненты приложений работают в изолированном worker'е и убрать их не могут.\n- Параметры видны в редакторе только как переменные шага «Параметры запуска»: у блока «Запуск\n вручную» Twenty показывает лишь свои переменные, поэтому без шага их не выбрать.\n- Параметры запуска относятся к процессу, а не к версии: после правки полей опубликованная версия\n до публикации нового черновика получает новые поля, а переменные убранных полей в ней пусты.\n- Если после ручного запуска идут сразу несколько шагов, «Параметры запуска» встаёт перед\n первым из них; остальным ветвям переменные шага недоступны.\n- Документ без файла создаётся раньше файла: если закрыть карточку, не прикрепив файл, документ\n останется с пустым полем «Файл».\n\n## Битрикс24\n\nПодключается локальным приложением портала (одна компания — один портал).\n\n1. В портале: «Разработчикам → Другое → Локальное приложение», тип «Серверное».\n2. Адреса — HTTP-маршруты приложения на адресе компании (точный адрес виден в «Настройки →\n Приложения → Документооборот → функции»):\n - путь обработчика: `https://<адрес компании>/s/bitrix/app`\n - путь первоначальной установки: `https://<адрес компании>/s/bitrix/install`\n3. Права приложения: `user`, `im`.\n4. Сохранить, скопировать «Код приложения» и «Ключ приложения» в `BITRIX_CLIENT_ID` и\n `BITRIX_CLIENT_SECRET`, затем открыть приложение в портале — установка завершится сама.\n\nКаждый запрос портала проверяется обменом refresh-токена на `oauth.bitrix.info` с ключом\nприложения; адрес портала берётся из ответа Битрикс24. Привязывается первый подтверждённый портал,\nдругой портал к той же компании не подключится. Токены портала хранятся в хранилище приложения, не\nв записях. Сотрудник находится по почте профиля Битрикс24.\n\n## Разработка\n\n```bash\nyarn app dev # следит за src/ и синхронизирует с сервером\nyarn app dev:function:logs\nyarn test && yarn typecheck && yarn lint\n```\n\nУстройство `src/`: `shared/` — общий код (формы, процессы, фильтры REST, Битрикс24); `server/` —\nобращения к записям и движку процессов из функций; `logic-functions/`; `front/` и\n`front-components/` — интерфейс; `objects/`, `fields/`, `views/`, `roles/`, `page-layouts/`,\n`navigation-menu-items/` — данные и раскладка. Записи читаются и пишутся только через REST API\n(`server/records.ts`, `front/api.ts`), движок процессов — через две мутации GraphQL\n(`server/workflow-engine.ts`, `server/launch-step.ts`): при смене версии платформы сверять эти\nфайлы. Стили интерфейса только inline: теги `<style>` в странице приложения платформа отбрасывает.\n",
|
|
51
51
|
"yarnLockChecksum": "42ac7e58e1f5be33be57956ccaa20fb3",
|
|
52
|
-
"packageJsonChecksum": "
|
|
52
|
+
"packageJsonChecksum": "ac89a97e4fcc3287015b11fea59c0fe2",
|
|
53
53
|
"requiredServerVersionRange": null,
|
|
54
54
|
"healthCheckLogicFunction": {
|
|
55
55
|
"universalIdentifier": "84360081-db5a-4f1c-9644-d975ccad9b2c"
|
|
@@ -884,7 +884,7 @@
|
|
|
884
884
|
{
|
|
885
885
|
"universalIdentifier": "d2cce9f2-6ba4-415c-aa3d-5d9aba6ae89c",
|
|
886
886
|
"name": "docflow-save-launch-fields",
|
|
887
|
-
"description": "Сохраняет параметры запуска процесса и ставит шаг
|
|
887
|
+
"description": "Сохраняет параметры запуска процесса и ставит шаг «Параметры запуска»",
|
|
888
888
|
"timeoutSeconds": 30,
|
|
889
889
|
"httpRouteTriggerSettings": {
|
|
890
890
|
"path": "/docflow/processes/launch-fields",
|
|
@@ -894,7 +894,7 @@
|
|
|
894
894
|
"handlerName": "default.config.handler",
|
|
895
895
|
"sourceHandlerPath": "src/logic-functions/save-launch-fields.logic-function.ts",
|
|
896
896
|
"builtHandlerPath": "src/logic-functions/save-launch-fields.logic-function.mjs",
|
|
897
|
-
"builtHandlerChecksum": "
|
|
897
|
+
"builtHandlerChecksum": "622be5f06efbc7bc4a157c7c706044b8"
|
|
898
898
|
},
|
|
899
899
|
{
|
|
900
900
|
"universalIdentifier": "d94c98c9-4f19-4fdd-9da2-89b3dfc6e43c",
|
|
@@ -924,7 +924,7 @@
|
|
|
924
924
|
"handlerName": "default.config.handler",
|
|
925
925
|
"sourceHandlerPath": "src/logic-functions/launch-process.logic-function.ts",
|
|
926
926
|
"builtHandlerPath": "src/logic-functions/launch-process.logic-function.mjs",
|
|
927
|
-
"builtHandlerChecksum": "
|
|
927
|
+
"builtHandlerChecksum": "bc6d9f5f7dd0a6b665040b44991bdef1"
|
|
928
928
|
},
|
|
929
929
|
{
|
|
930
930
|
"universalIdentifier": "f27cfbdc-8e87-4e1a-ab37-fc2a8093946c",
|
|
@@ -957,7 +957,7 @@
|
|
|
957
957
|
"description": "Отдаёт следующим шагам параметры, заполненные перед запуском процесса",
|
|
958
958
|
"timeoutSeconds": 10,
|
|
959
959
|
"workflowActionTriggerSettings": {
|
|
960
|
-
"label": "
|
|
960
|
+
"label": "Параметры запуска",
|
|
961
961
|
"icon": "IconPlayerPlay",
|
|
962
962
|
"inputSchema": [
|
|
963
963
|
{
|
|
@@ -980,7 +980,7 @@
|
|
|
980
980
|
"handlerName": "default.config.handler",
|
|
981
981
|
"sourceHandlerPath": "src/logic-functions/launch-parameters-step.logic-function.ts",
|
|
982
982
|
"builtHandlerPath": "src/logic-functions/launch-parameters-step.logic-function.mjs",
|
|
983
|
-
"builtHandlerChecksum": "
|
|
983
|
+
"builtHandlerChecksum": "380658563801f106208578d34c7d2a49"
|
|
984
984
|
}
|
|
985
985
|
],
|
|
986
986
|
"frontComponents": [
|
|
@@ -1002,7 +1002,7 @@
|
|
|
1002
1002
|
"componentName": "ProcessSteps",
|
|
1003
1003
|
"sourceComponentPath": "src/front-components/process-steps.front-component.tsx",
|
|
1004
1004
|
"builtComponentPath": "src/front-components/process-steps.front-component.mjs",
|
|
1005
|
-
"builtComponentChecksum": "
|
|
1005
|
+
"builtComponentChecksum": "7470005cdb1982814bf29810cd65460e0a5dbc50ec23b434cc84190bd2aa350c",
|
|
1006
1006
|
"isHeadless": false,
|
|
1007
1007
|
"usesSdkClient": true
|
|
1008
1008
|
},
|
|
@@ -1013,7 +1013,7 @@
|
|
|
1013
1013
|
"componentName": "DocflowTasks",
|
|
1014
1014
|
"sourceComponentPath": "src/front-components/docflow-tasks.front-component.tsx",
|
|
1015
1015
|
"builtComponentPath": "src/front-components/docflow-tasks.front-component.mjs",
|
|
1016
|
-
"builtComponentChecksum": "
|
|
1016
|
+
"builtComponentChecksum": "dbee351241924f3b5395f0da610433d53a54613acdbb2d12b54e56eb692d7592",
|
|
1017
1017
|
"isHeadless": false,
|
|
1018
1018
|
"usesSdkClient": true
|
|
1019
1019
|
},
|
|
@@ -1035,7 +1035,7 @@
|
|
|
1035
1035
|
"componentName": "DocflowProcesses",
|
|
1036
1036
|
"sourceComponentPath": "src/front-components/docflow-processes.front-component.tsx",
|
|
1037
1037
|
"builtComponentPath": "src/front-components/docflow-processes.front-component.mjs",
|
|
1038
|
-
"builtComponentChecksum": "
|
|
1038
|
+
"builtComponentChecksum": "12d65821f6160d833a369ac7d3549be14b913b71601ec5cee5576c28a44dd915",
|
|
1039
1039
|
"isHeadless": false,
|
|
1040
1040
|
"usesSdkClient": true
|
|
1041
1041
|
}
|
|
@@ -1314,8 +1314,8 @@
|
|
|
1314
1314
|
"commandMenuItems": [
|
|
1315
1315
|
{
|
|
1316
1316
|
"universalIdentifier": "c3f5a2d4-7e1b-4c9a-8f36-2b5d0e7a91c4",
|
|
1317
|
-
"label": "
|
|
1318
|
-
"shortLabel": "
|
|
1317
|
+
"label": "Параметры запуска",
|
|
1318
|
+
"shortLabel": "Параметры запуска",
|
|
1319
1319
|
"icon": "IconPlayerPlay",
|
|
1320
1320
|
"isPinned": true,
|
|
1321
1321
|
"availabilityType": "RECORD_SELECTION",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@haiiro/docuflow",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "NorDiv Документооборот: задания с полями, процессы с запуском по параметрам, документы со всех записей, приложение Битрикс24",
|
|
5
5
|
"license": "AGPL-3.0-only",
|
|
6
6
|
"publishConfig": {
|