@haiiro/docuflow 0.0.22 → 0.0.24

package/manifest.json

@@ -49,7 +49,7 @@
     "defaultRoleUniversalIdentifier": "26b1dde8-4ed9-4f39-8516-e0dcb734ea5a",
     "aboutDescription": "# Документооборот (`@crm-nordiv/docuflow`)\n\nЗадания, процессы и документы компании в одном разделе. Ставится в CRM как приложение, без правок\nсервера.\n\n- universalIdentifier: `0b7d5d2e-8c4f-4a59-9a43-2f6f1c3e9d21`\n\n## Что получается после установки\n\n| Где | Что |\n|---|---|\n| Сайдбар | папка «Документооборот» с пунктами «Задания», «Процессы», «Документы» — у каждого своя страница |\n| «Задания» | задачи раздела «Документооборот»; фильтры «Открытые / Мои / Просроченные / Выполненные / Архив» (архив — удалённые, со штатным «Восстановить»), поиск, создание задания с инструкцией и полями для заполнения |\n| Панель задания | вкладки «Задание» (поля и ход) и «Чат», если стоит `@haiiro/chats`: переписка задачи с меню сообщения, как в «Чатах» |\n| Карточка задачи | вкладка «Задание»: инструкция, поля задания (собрать конструктором, заполнить), «Выполнить» |\n| Карточка процесса | кнопка «Параметры запуска» вверху (боковая панель): параметры запуска (конструктор полей) и, для шагов «Человеческий ввод» черновика, кто выполняет, срок в днях, обязательные поля; у каждого поля видна переменная, которой его читают следующие шаги |\n| Редактор процесса | первый блок «Запуск с параметрами» (ставится сам): параметры, заполненные перед запуском, и запись, на которой запустили, — его переменные |\n| Командное меню | «Запустить процесс» (Cmd+K и меню выбранных записей любого объекта): выбор процесса, форма параметров в боковой панели, «Запустить»; запуск открывается в боковой панели, как штатный ручной |\n| «Процессы» | процессы раздела «Документооборот»; форма параметров до запуска, «Запустить», «Создать», «Добавить из Twenty» (процесс, настроенный в «Рабочих процессах»), «Убрать из документооборота», «Открыть редактор»; в панели процесса — «Параметры запуска и задания» |\n| «Документы» | папки, фильтры, поиск по названию и номеру, документ с реквизитами (тип, номер, дата, срок действия, контрагент, описание), файл в поле «Файл» карточки, карточка с источником |\n| Автоматически | шаг «Человеческий ввод» процесса становится задачей; её выполнение продолжает процесс; файл, приложенный к любой записи, копируется в документы с отметкой, кто, когда и куда его добавил |\n| Отдельная страница | `https://<адрес CRM>/s/docflow/app`: «Задания», «Процессы», «Документы» без остальной CRM, вход — тот же, что в CRM |\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С любого компьютера с Node.js 20+, нужен только адрес CRM и ключ API администратора\n(«Настройки → API и вебхуки → Создать ключ»). Повторный запуск ставит новую версию:\n\n```bash\nnpx -y @haiiro/docuflow install --url https://crm.example.ru --api-key <ключ>\n```\n\nУстановщик загружает в CRM опубликованный архив этой версии пакета и устанавливает приложение\n(как `twenty app:install`), доступ к серверу и его настройки не нужны. Конкретная версия:\n`--version 0.0.8`. Пакет собран под Twenty 2.45: на другой минорной версии установщик\nпредупреждает, на другой мажорной останавливается (`--force` — ставить всё равно). После установки\nон сверяет версию в CRM: CRM не ставит версию ниже уже загруженной и говорит об этом прямо.\n\n**Требования к серверу Twenty** (обычная установка из Docker, не `twenty-app-dev`):\n\n- функции приложений включены: «Настройки → Панель администратора → Config →\n  `LOGIC_FUNCTION_TYPE`» = `LOCAL` (в production-сборке по умолчанию `DISABLED`, и тогда серверная\n  часть любого приложения молчит);\n- `SERVER_URL` открывается и из контейнера worker: Twenty отдаёт его функциям как адрес API, а\n  функции событий записей выполняет worker. С `SERVER_URL=http://localhost:3000` из\n  стандартного docker-compose они до сервера не достучатся; нужен общий адрес (домен CRM) или\n  worker в сети сервера (`network_mode: \"service:server\"`).\n\nИз исходников (для разработки): `node scripts/reinstall.mjs docuflow --local` в корне репозитория\n(нужны `CRM_URL` и `CRM_API_KEY` в `.env`).\n\nЗатем в «Настройки → Приложения → Документооборот» заполнить переменные:\n\n| Переменная | Что указать |\n|---|---|\n| `DOCFLOW_ENGINE` | `APP` |\n| `CRM_PUBLIC_URL` | адрес CRM компании, например `https://acme.example.ru`; по нему строятся ссылки в CRM с отдельной страницы и из Битрикс24 |\n| `BITRIX_CLIENT_ID`, `BITRIX_CLIENT_SECRET` | из карточки локального приложения портала; без них Битрикс24 не подключается, остальное работает |\n\n**Права людей.** Отвечать на шаг запущенного процесса может только тот, у кого есть право\n«Рабочие процессы». Кто выполняет задания процессов или запускает процессы с параметрами,\nполучает роль «Документооборот: участник процессов» или это право в своей роли. Право также\nпозволяет менять процессы: давайте его тем, кому это допустимо. Обычные задания и документы\nправа «Рабочие процессы» не требуют.\n\n## Как пользоваться\n\n- **Процесс.** «Процессы → Создать» создаёт процесс с ручным запуском в разделе «Документооборот» и\n  открывает редактор. Процесс, уже настроенный в «Рабочих процессах» Twenty, добавляется кнопкой\n  «Добавить из Twenty».\n- **Twenty 2.50.** Приложение может запускать процессы с триггером «Webhook» (в том числе свой\n  «Запуск с параметрами»). Процесс с ручным триггером запускается из самой Twenty. Создавать,\n  переименовывать, удалять, публиковать процессы и настраивать параметры запуска и задания шагов\n  на 2.50 можно на полной странице документооборота `https://<адрес CRM>/s/docflow/app` (она\n  работает со входом в CRM): Twenty 2.50 разрешает это только самому человеку, а страницы внутри\n  CRM работают без его входа и показывают ссылку на полную страницу. Задания шагов «Человеческий\n  ввод» выдаются и выполняются, как и на 2.45.\n- **Параметры запуска.** Кнопка процесса «Параметры запуска» → «Добавить поле»: название, тип\n  (текст, число, дата, сотрудник, компания, контакт, сделка), обязательность. «Сохранить\n  параметры» делает первым блоком черновика «Запуск с параметрами»: в следующих шагах параметры\n  выбираются как его переменные `{{trigger.<поле>}}` — например «Запуск с параметрами →\n  Сотрудник → Id» в поле «Исполнитель» задачи. «Где запускать» — «Откуда угодно, без записи» или\n  «На записи: <объект>»: тогда процесс запускают на выбранных записях этого объекта, по запуску\n  на каждую, а запись — переменная `{{trigger.record}}` с полями объекта (как у штатного запуска\n  вручную на записи). Без параметров и записи процесс начинается с обычного «Запуск вручную».\n  Опубликуйте процесс. Запускают его командой «Запустить процесс»: из Cmd+K — процессы без\n  записи, на выбранных записях — процессы их объекта и процессы без записи. Процессы без записи\n  запускаются и со страницы «Процессы». Обязательные параметры проверяются и в форме, и на сервере.\n\n  Устройство: своих типов триггеров у приложений Twenty нет, а у «Запуск вручную» редактор\n  показывает только свои переменные. Штатный пункт меню ручного запуска запускает процесс сразу,\n  без формы, и встроиться в него приложение не может. Поэтому «Запуск с параметрами» — штатный триггер Webhook\n  (POST, только с ключом API), поля параметров — его тело. Документооборот запускает такую версию\n  сам; внешняя система (например, мост в Битрикс24) может запустить процесс POST-запросом на адрес\n  вебхука с ключом API и телом из этих полей — тогда проверку обязательных полей делает она.\n  Шаг «Параметры запуска» процессов из 0.0.6 и раньше при первом сохранении параметров убирается,\n  его переменные в следующих шагах переводятся на `trigger`.\n- **Задание шага.** Шаг «Человеческий ввод» становится задачей раздела процесса: у исполнителя\n  из «Параметров запуска», без него — у запустившего. Поля задания — поля шага из редактора.\n  «Выполнить» проверяет обязательные поля и продолжает процесс; значения дальше читаются\n  переменными шага `{{<шаг>.<поле>}}`.\n- **Списки.** Фильтры — в окне под полем поиска (значок фильтра горит, когда фильтр включён),\n  сортировка — кликом по заголовку колонки. Действия со строкой — в «⋯» в её конце: открыть,\n  переименовать, переместить в папку, удалить и т. п. «Процессы» показывают все процессы раздела,\n  опубликованные и черновики.\n- **Папки документов.** «+ Новая папка», у папки «⋯ → Переименовать и оформить»: название, цвет и\n  значок; удаление папки оставляет документы в «Все документы».\n- **Удаление.** «⋯ → Удалить» спрашивает ещё раз и удаляет. Запись уходит в корзину Twenty и\n  восстанавливается: задания — в фильтре «Архив», документы — в фильтре «Удалённые», процессы — в\n  штатном списке «Рабочие процессы → Удалённые»; в карточке удалённой записи есть «Восстановить».\n  Для этого роль приложения может мягко удалять только документы, задачи и процессы.\n- **Параметры в редакторе.** После «Сохранить параметры» редактор процесса открывается заново:\n  он держит загруженную версию и иначе показал бы новые переменные только после перезагрузки.\n- **Своё задание.** «Задания → Создать»: название, исполнитель, срок, инструкция и поля для\n  заполнения тем же конструктором. Поля меняются в панели задания («Изменить поля»).\n- **Документы.** «Документы → Создать» создаёт черновик в открытой папке и открывает его штатную\n  карточку: там реквизиты и поле «Файл»; строка списка открывает ту же карточку. Так сделано потому, что\n  страница приложения в песочнице видит только имя и размер выбранного файла, не его содержимое.\n  Файл, приложенный к любой записи (компания, сделка, задача, свой объект), появляется в\n  документах сам: «Где загружен», автор, дата, для задачи процесса — ссылка на запуск. Документ\n  хранит копию файла.\n\n## Ограничения\n\n- Рамки вокруг страницы раздела рисует платформа: карточку виджета и рамку вокруг компонента\n  приложения. Компоненты приложений работают в изолированном worker'е и убрать их не могут.\n- Блок «Запуск с параметрами» в редакторе открывает штатные настройки вебхука (адрес, тело,\n  авторизация): поля там те же, что в «Параметрах запуска», менять их удобнее кнопкой. Если\n  переименовать блок, Документооборот перестанет узнавать его как свой запуск.\n- Параметры запуска относятся к процессу, а не к версии: после правки полей опубликованная версия\n  до публикации нового черновика получает новые поля, а переменные убранных полей в ней пусты.\n- Документ без файла создаётся раньше файла: если закрыть карточку, не прикрепив файл, документ\n  останется с пустым полем «Файл».\n- На отдельной странице и в Битрикс24 карточка записи (задачи, документа, процесса) открывается в\n  CRM в новой вкладке: боковой панели CRM там нет. Файл документа прикрепляется там же.\n- Отдельная страница выглядит как штатный Twenty (светлая или тёмная тема по настройке системы):\n  скин `@haiiro/interface` на неё не действует.\n\n## Отдельная страница\n\n`https://<адрес CRM>/s/docflow/app` — документооборот без остальной CRM: шапка с разделами «Задания»,\n«Процессы», «Документы», кнопки «На весь экран» и «Открыть CRM». Раздел при открытии —\n`?section=processes` или `?section=documents`. Это те же страницы, что в папке «Документооборот»\nсайдбара, с теми же правами: страница работает от имени сотрудника, вошедшего в CRM в этом\nбраузере. Если вход не выполнен, она предлагает войти в CRM в соседней вкладке и открывается сама.\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: если такого ещё нет в CRM, он\nсоздаётся сам (нужна включённая публичная ссылка-приглашение в «Настройки → Участники») с той же\nпочтой и ФИО из Битрикс24.\n\n**Вход.** В портале открывается отдельная страница документооборота. Сессия CRM во фрейме портала\nне работает (браузер не отдаёт cookie CRM чужому сайту), поэтому при первом открытии страница\nпросит «Войти через CRM»: открывается окно на адресе CRM, оно берёт вход сотрудника в CRM (если его\nнет — ждёт, пока сотрудник войдёт в CRM в соседней вкладке), передаёт его во фрейм и закрывается.\nДальше страница работает с токеном этого сотрудника (его права в CRM, 30 минут) и сама продлевает\nего, пока открыта; токен хранится в хранилище браузера только для этого портала. Если приложение не\nоткрывали дольше получаса, «Войти через CRM» нажимают снова — при живом входе в CRM окно закроется\nсамо. Если в CRM в этом браузере вошёл не тот сотрудник, что в Битрикс24, страница предупреждает.\nСтраница работает только во фрейме привязанного портала.\n\n## Разработка\n\n```bash\nyarn app dev        # следит за src/ и синхронизирует с сервером\nyarn app dev:function:logs\nyarn build:app      # отдельная страница: public/app (yarn build делает это сам)\nyarn test && yarn typecheck && yarn lint\n```\n\nУстройство `src/`: `shared/` — общий код (формы, процессы, фильтры REST, Битрикс24); `server/` —\nобращения к записям и движку процессов из функций; `logic-functions/`; `front/` и\n`front-components/` — интерфейс; `standalone/` — отдельная страница (те же страницы вне CRM); `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\nПравила правки пакета (песочница страниц, процессы, единый вид вкладок, проверка на чистой CRM) —\nв [EDITING.md](EDITING.md).\n",
     "yarnLockChecksum": "d4d3dd414c49b677cf14b279b38ecd54",
-    "packageJsonChecksum": "83dc56d164a3e6c41d71c6470d4391fd",
+    "packageJsonChecksum": "fbfcca68c1af548b19d26c46aa2d75ac",
     "requiredServerVersionRange": null,
     "healthCheckLogicFunction": {
       "universalIdentifier": "84360081-db5a-4f1c-9644-d975ccad9b2c"
@@ -815,7 +815,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/bitrix-app.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/bitrix-app.logic-function.mjs",
-      "builtHandlerChecksum": "edb4337814daa16f1cb041ab68c000b7"
+      "builtHandlerChecksum": "09bf563b79cb290d6a99ed9c76310eda"
     },
     {
       "universalIdentifier": "13952f55-e84f-4d3a-a5a2-f3d68d78ba5e",
@@ -878,7 +878,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/bitrix-install.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/bitrix-install.logic-function.mjs",
-      "builtHandlerChecksum": "37a42dd1026b39ed64fae1c26e772c0e"
+      "builtHandlerChecksum": "5fda3553a5157d3ba8f8324d941d6d2d"
     },
     {
       "universalIdentifier": "9358be72-63c4-4562-b84e-25e309bebe70",
@@ -910,7 +910,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/process-catalog.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/process-catalog.logic-function.mjs",
-      "builtHandlerChecksum": "c580761eafb4fc5a0826797d4898d0f8"
+      "builtHandlerChecksum": "e7b88c4fcf9d6097119aca185538d587"
     },
     {
       "universalIdentifier": "a7dd8969-189b-4fb7-b025-c7bf433832c3",
@@ -941,7 +941,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/docflow-app.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/docflow-app.logic-function.mjs",
-      "builtHandlerChecksum": "d608aa2cce1dcd875304eb49302505c7"
+      "builtHandlerChecksum": "cb9caf08bce3604dc429bd57469e0150"
     },
     {
       "universalIdentifier": "c164c184-3b24-4d26-832b-219f3f02102a",
@@ -1096,7 +1096,7 @@
       "componentName": "TaskForm",
       "sourceComponentPath": "src/front-components/task-form.front-component.tsx",
       "builtComponentPath": "src/front-components/task-form.front-component.mjs",
-      "builtComponentChecksum": "e01eba61fa783ac3ad7d5fc2795783516e0004b2cbf876b198d5560989b2aac1",
+      "builtComponentChecksum": "bc0e73c63e45e8bb3d7025c563379eee173716327e50c6a7b6c262e7e58418bc",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1107,7 +1107,7 @@
       "componentName": "ProcessSteps",
       "sourceComponentPath": "src/front-components/process-steps.front-component.tsx",
       "builtComponentPath": "src/front-components/process-steps.front-component.mjs",
-      "builtComponentChecksum": "205c7f0a68355bb2e0ed5156fb866cbfceb69ef1865ef830a8bb97a392fd6683",
+      "builtComponentChecksum": "d1105144e200729a4b6f4de57be742900489414177e3b95d79fc529c098bd851",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1118,7 +1118,7 @@
       "componentName": "LaunchProcess",
       "sourceComponentPath": "src/front-components/launch-process.front-component.tsx",
       "builtComponentPath": "src/front-components/launch-process.front-component.mjs",
-      "builtComponentChecksum": "55b7a80474294b8b26db03b0c775f74ca1a4f8b868d688ed2060b48e865de6ed",
+      "builtComponentChecksum": "8c927fa8cd9431c8359c6dda664e67c3cea2a927268cb02e76648990e9b694b7",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1129,7 +1129,7 @@
       "componentName": "DocflowTasks",
       "sourceComponentPath": "src/front-components/docflow-tasks.front-component.tsx",
       "builtComponentPath": "src/front-components/docflow-tasks.front-component.mjs",
-      "builtComponentChecksum": "fd5efeff0ba2f8e1dc81549b4f14ca2ca1f007a49e66851af51ff637e5288a49",
+      "builtComponentChecksum": "d41999b2031864245074077cc7a156302f9deb53ab7981d93c94e8219e6ed7b1",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1140,7 +1140,7 @@
       "componentName": "DocflowDocuments",
       "sourceComponentPath": "src/front-components/docflow-documents.front-component.tsx",
       "builtComponentPath": "src/front-components/docflow-documents.front-component.mjs",
-      "builtComponentChecksum": "79488996aa7bbcef0778d2934f48774cf36a9538b834f4a914c3564d9276585e",
+      "builtComponentChecksum": "8b478861e6823696df4e4dafd25b56900ed6d406806e397d49f5c70ac4b0f93e",
       "isHeadless": false,
       "usesSdkClient": false
     },
@@ -1151,7 +1151,7 @@
       "componentName": "DocflowProcesses",
       "sourceComponentPath": "src/front-components/docflow-processes.front-component.tsx",
       "builtComponentPath": "src/front-components/docflow-processes.front-component.mjs",
-      "builtComponentChecksum": "b5bc06731564201dabf2876d13415a3e94784de3bf707500f966eda0b27e4817",
+      "builtComponentChecksum": "148bacfc591c96ae5bc61a1e14d0e7bd71dce021be600e3f07454ea4d19b38d7",
       "isHeadless": false,
       "usesSdkClient": true
     }
@@ -1167,7 +1167,7 @@
       "filePath": "public/app/docflow-app.js",
       "fileName": "docflow-app.js",
       "fileType": "js",
-      "checksum": "36139953e4d34cf558b06cf34494394c"
+      "checksum": "c10a340a31f8decd3d498c134f3260c0"
     },
     {
       "filePath": "public/cover.svg",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haiiro/docuflow",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "NorDiv Документооборот: задания с полями, процессы с запуском по параметрам, документы со всех записей, приложение Битрикс24",
   "license": "AGPL-3.0-only",
   "publishConfig": {