@haiiro/docuflow 0.0.13 → 0.0.15

package/README.md

@@ -44,7 +44,9 @@ npx -y @haiiro/docuflow install --url https://crm.example.ru --api-key <ключ
 
 Установщик загружает в CRM опубликованный архив этой версии пакета и устанавливает приложение
 (как `twenty app:install`), доступ к серверу и его настройки не нужны. Конкретная версия:
-`--version 0.0.8`.
+`--version 0.0.8`. Пакет собран под Twenty 2.45: на другой минорной версии установщик
+предупреждает, на другой мажорной останавливается (`--force` — ставить всё равно). После установки
+он сверяет версию в CRM: CRM не ставит версию ниже уже загруженной и говорит об этом прямо.
 
 Из исходников (для разработки): `node scripts/reinstall.mjs docuflow --local` в корне репозитория
 (нужны `CRM_URL` и `CRM_API_KEY` в `.env`).

package/bin/install.mjs

@@ -32,6 +32,8 @@ const readOptions = (args) => {
       options[key.slice(2)] = inlineValue ?? args[++index];
     } else if (key === '--help' || key === '-h') {
       options.help = true;
+    } else if (key === '--force') {
+      options.force = true;
     } else if (key !== 'install') {
       fail(`Неизвестный параметр ${key}`);
     }
@@ -42,6 +44,7 @@ const readOptions = (args) => {
     apiKey: options['api-key'] ?? process.env.CRM_API_KEY,
     version: options.version ?? packageJson.version,
     help: options.help === true,
+    force: options.force === true,
   };
 };
 
@@ -55,6 +58,7 @@ ${packageJson.description}
   --url       адрес CRM (или переменная CRM_URL)
   --api-key   ключ API администратора, «Настройки → API и вебхуки» (или CRM_API_KEY)
   --version   версия пакета, по умолчанию ${packageJson.version}
+  --force     ставить и на версию Twenty, с которой пакет не проверялся
 `);
 
 const callMetadataApi = async ({ url, apiKey }, query, variables) => {
@@ -73,7 +77,7 @@ const callMetadataApi = async ({ url, apiKey }, query, variables) => {
   const body = await response.json().catch(() => undefined);
   const [firstError] = body?.errors ?? [];
 
-  if (response.status === 401 || firstError?.extensions?.code === 'UNAUTHENTICATED') {
+  if (response.status === 401 || ['UNAUTHENTICATED', 'FORBIDDEN'].includes(firstError?.extensions?.code)) {
     fail('CRM не приняла ключ API: проверьте ключ и что он создан в этой компании');
   }
 
@@ -97,7 +101,7 @@ class CrmApiError extends Error {
   // This version's archive was uploaded to the CRM before (also before an
   // uninstall): the server keeps it and installs from that copy.
   get isAlreadyDeployed() {
-    return /not higher than the currently deployed/i.test(`${this.message} ${this.rawMessage}`);
+    return /(not|must be) higher than the currently deployed/i.test(`${this.message} ${this.rawMessage}`);
   }
 
   // The app was installed from the marketplace on this CRM: the server keeps
@@ -155,10 +159,44 @@ const downloadPackageTarball = async (version) => {
   return Buffer.from(await tarballResponse.arrayBuffer());
 };
 
+// The package is built and checked against one Twenty release (the
+// twenty-sdk it is built with). Another minor usually works, so it only
+// warns; another major stops the install unless --force is given.
+const checkServerVersion = async ({ url }, force) => {
+  const builtFor = packageJson.devDependencies?.['twenty-sdk'];
+  const response = await fetch(`${url}/client-config`).catch(() => null);
+  const serverVersion = response?.ok
+    ? String((await response.json().catch(() => ({}))).appVersion ?? '').replace(/^v/, '')
+    : '';
+
+  if (builtFor === undefined || !/^\d+\.\d+/.test(serverVersion)) {
+    console.log('→ Версию Twenty узнать не удалось, проверку версии пропускаю');
+
+    return;
+  }
+
+  const [serverMajor, serverMinor] = serverVersion.split('.').map(Number);
+  const [builtMajor, builtMinor] = builtFor.split('.').map(Number);
+
+  if (serverMajor === builtMajor && serverMinor === builtMinor) {
+    return;
+  }
+
+  const message = `Пакет собран и проверен на Twenty ${builtMajor}.${builtMinor}, а у CRM ${serverVersion}`;
+
+  if (serverMajor !== builtMajor && !force) {
+    fail(`${message}. Поставьте версию пакета для своей Twenty или повторите с --force`);
+  }
+
+  console.log(`⚠ ${message}: часть возможностей может работать иначе`);
+};
+
 const install = async (options) => {
   const connection = { url: options.url.replace(/\/+$/, ''), apiKey: options.apiKey };
   const label = `${packageJson.name}@${options.version}`;
 
+  await checkServerVersion(connection, options.force);
+
   console.log(`→ Скачиваю ${label}`);
   const tarball = await downloadPackageTarball(options.version);
 
@@ -192,18 +230,46 @@ const install = async (options) => {
       { universalIdentifier: manifest.application.universalIdentifier, version: options.version },
     );
   } catch (error) {
-    if (!(error instanceof CrmApiError) || !/already installed/i.test(`${error.message} ${error.rawMessage}`)) {
+    const reason = error instanceof CrmApiError ? `${error.message} ${error.rawMessage}` : '';
+
+    // A newer version stands in the CRM: the platform refuses to go back
+    if (/downgrad/i.test(reason)) {
+      fail(`В CRM уже стоит версия новее ${options.version}. Поставьте последнюю: npx ${packageJson.name}@latest install`);
+    }
+
+    if (!/is already installed in this workspace/i.test(reason)) {
       throw error;
     }
 
+    await checkInstalledVersion(connection, options.version);
     console.log(`\n✓ ${label} уже установлен в этой CRM.\n`);
 
     return;
   }
 
+  await checkInstalledVersion(connection, options.version);
   console.log(`\n✓ ${label} установлен. Обновите страницу CRM.\n`);
 };
 
+// The CRM keeps the highest archive it was given and installs that one when
+// an older archive is refused, answering as if all went well: what stands in
+// the CRM is checked after the install.
+const checkInstalledVersion = async (connection, version) => {
+  const { findManyApplications } = await callMetadataApi(
+    connection,
+    `query FindManyApplications { findManyApplications { universalIdentifier version } }`,
+  );
+  const installed = findManyApplications.find(
+    (application) => application.universalIdentifier === manifest.application.universalIdentifier,
+  );
+
+  if (installed?.version !== version) {
+    fail(
+      `В CRM стоит ${installed?.version ?? 'не та версия'}, а не ${version}: CRM не ставит версию ниже уже загруженной. Поставьте последнюю: npx ${packageJson.name}@latest install`,
+    );
+  }
+};
+
 const uploadArchive = async (connection, label, tarball) => {
   const { createFileUpload } = await callMetadataApi(
     connection,

package/manifest.json

@@ -47,9 +47,9 @@
       }
     },
     "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| «Процессы» | процессы с ручным запуском раздела «Документооборот»; форма параметров до запуска, «Запустить», «Создать», «Изменить процесс» |\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`.\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  открывает редактор. Существующий процесс переносится в документооборот полем «Раздел».\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",
+    "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| «Процессы» | процессы с ручным запуском раздела «Документооборот»; форма параметров до запуска, «Запустить», «Создать», «Изменить процесс» |\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Из исходников (для разработки): `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  открывает редактор. Существующий процесс переносится в документооборот полем «Раздел».\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": "be88e0d99ef66b5cefde3b7ee0f413db",
+    "packageJsonChecksum": "48f13eed1eb7fc9cb8f04a77381f6b24",
     "requiredServerVersionRange": null,
     "healthCheckLogicFunction": {
       "universalIdentifier": "84360081-db5a-4f1c-9644-d975ccad9b2c"
@@ -663,6 +663,16 @@
         "joinColumnName": "authorId"
       }
     },
+    {
+      "universalIdentifier": "ae169497-eec6-45ca-a411-928d0f81ca5b",
+      "objectUniversalIdentifier": "20202020-1ba1-48ba-bc83-ef7e5990ed10",
+      "type": "RAW_JSON",
+      "name": "smbTimeLog",
+      "label": "Учёт времени",
+      "icon": "IconClock",
+      "isNullable": true,
+      "defaultValue": null
+    },
     {
       "universalIdentifier": "af8ed15e-916e-4fa1-a6ce-c2b3e594c8b8",
       "objectUniversalIdentifier": "20202020-1ba1-48ba-bc83-ef7e5990ed10",
@@ -805,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": "217805f19da4bebb8475e1f2ce3424b0"
+      "builtHandlerChecksum": "c29d758dd97b783471746af5533e7fe7"
     },
     {
       "universalIdentifier": "13952f55-e84f-4d3a-a5a2-f3d68d78ba5e",
@@ -820,7 +830,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/save-step-settings.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/save-step-settings.logic-function.mjs",
-      "builtHandlerChecksum": "b24284e80ad7fefe3a7cd23e5a1a558d"
+      "builtHandlerChecksum": "4cf54491394451cc1eb783d6b4729ac8"
     },
     {
       "universalIdentifier": "70021464-1ce0-4c94-81c7-ee6b4490034c",
@@ -845,7 +855,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/save-task-form.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/save-task-form.logic-function.mjs",
-      "builtHandlerChecksum": "12efc94762c6468a24982f7415571d19"
+      "builtHandlerChecksum": "5d5a7a4bbec6932be0ea3f0b21a22bcc"
     },
     {
       "universalIdentifier": "84360081-db5a-4f1c-9644-d975ccad9b2c",
@@ -868,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": "faaed2ab8ad031ce8e285355e9289c86"
+      "builtHandlerChecksum": "37a42dd1026b39ed64fae1c26e772c0e"
     },
     {
       "universalIdentifier": "9358be72-63c4-4562-b84e-25e309bebe70",
@@ -916,7 +926,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/docflow-app.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/docflow-app.logic-function.mjs",
-      "builtHandlerChecksum": "1d49faedd6501b59045945b8806696f1"
+      "builtHandlerChecksum": "11516f0296cf8015e63ebf7f679171f9"
     },
     {
       "universalIdentifier": "c164c184-3b24-4d26-832b-219f3f02102a",
@@ -931,7 +941,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/publish-process.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/publish-process.logic-function.mjs",
-      "builtHandlerChecksum": "0805ed4f310562484f47a589d87da663"
+      "builtHandlerChecksum": "a4a6f1456416fc09d6a3576629a290e3"
     },
     {
       "universalIdentifier": "c90778dd-4b0f-4a8c-a769-aca0c09f0b5f",
@@ -977,7 +987,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/save-launch-fields.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/save-launch-fields.logic-function.mjs",
-      "builtHandlerChecksum": "7f2745d5345a5b0848fa80f7ad552a8f"
+      "builtHandlerChecksum": "6a334d0ee78796ff4875a03a8b2f71a5"
     },
     {
       "universalIdentifier": "d94c98c9-4f19-4fdd-9da2-89b3dfc6e43c",
@@ -992,7 +1002,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/complete-task.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/complete-task.logic-function.mjs",
-      "builtHandlerChecksum": "d8bbcb316012f8e3bceecf0c80696c54"
+      "builtHandlerChecksum": "c5d832f87d169d70e13373df2bd8ff80"
     },
     {
       "universalIdentifier": "de04e9c8-7ebe-4ac2-b4b3-4ca256eb94db",
@@ -1007,7 +1017,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/launch-process.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/launch-process.logic-function.mjs",
-      "builtHandlerChecksum": "df6b5648f42641b317d307eb966d6af8"
+      "builtHandlerChecksum": "cf1d65de56ddf4a3c9a9071fe4d5a888"
     },
     {
       "universalIdentifier": "e819586a-b6a5-4df9-8bef-c524b6d0a886",
@@ -1025,7 +1035,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/docflow-app-session.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/docflow-app-session.logic-function.mjs",
-      "builtHandlerChecksum": "c8c1ace540146094579860b89225aea2"
+      "builtHandlerChecksum": "5c3449f32b935316f19172cbab54f381"
     },
     {
       "universalIdentifier": "f27cfbdc-8e87-4e1a-ab37-fc2a8093946c",
@@ -1040,7 +1050,7 @@
       "handlerName": "default.config.handler",
       "sourceHandlerPath": "src/logic-functions/bitrix-event.logic-function.ts",
       "builtHandlerPath": "src/logic-functions/bitrix-event.logic-function.mjs",
-      "builtHandlerChecksum": "5438172fefc9c719c42cf3ec240143fc"
+      "builtHandlerChecksum": "636702875d50031c6d1e1bf83e3efb71"
     },
     {
       "universalIdentifier": "f735d9e9-d46a-4527-98c8-c84c2b6dbb7b",
@@ -1071,7 +1081,7 @@
       "componentName": "TaskForm",
       "sourceComponentPath": "src/front-components/task-form.front-component.tsx",
       "builtComponentPath": "src/front-components/task-form.front-component.mjs",
-      "builtComponentChecksum": "c7cd82263d34dd4d87e2955c1a770d2e5012ba545237b9d30387eb63e62b76dc",
+      "builtComponentChecksum": "4577ed9a1c804781cc77274d7435eba48d49a7150be5268c038da9ea56756fe0",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1082,7 +1092,7 @@
       "componentName": "ProcessSteps",
       "sourceComponentPath": "src/front-components/process-steps.front-component.tsx",
       "builtComponentPath": "src/front-components/process-steps.front-component.mjs",
-      "builtComponentChecksum": "42d6904522c7d6e3aa11b22f8cf68f61d543bf2e380fcce56b8a9c2f69acb87f",
+      "builtComponentChecksum": "f6722f096c630dda2d8a7f6da466b04f0c056e324c1e5063bfcdb2bd6f65e0a7",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1093,7 +1103,7 @@
       "componentName": "LaunchProcess",
       "sourceComponentPath": "src/front-components/launch-process.front-component.tsx",
       "builtComponentPath": "src/front-components/launch-process.front-component.mjs",
-      "builtComponentChecksum": "fc168cf8692fda34ca33cbfd420dd4061edf06024264d807080f81ef9d8b8e18",
+      "builtComponentChecksum": "69b115ba4a2e0a1ec44b33e9c1c87f63948a956ca521535157b479676690bc1f",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1104,7 +1114,7 @@
       "componentName": "DocflowTasks",
       "sourceComponentPath": "src/front-components/docflow-tasks.front-component.tsx",
       "builtComponentPath": "src/front-components/docflow-tasks.front-component.mjs",
-      "builtComponentChecksum": "c61f70137d2d7b3201727168a29aa486c027d02236a2e7ac84bf2a0e1660ecbc",
+      "builtComponentChecksum": "72b9be1c804378ae3b1f9da1ccbfecad3b4264f7259a95e44da25c31c4b5aaad",
       "isHeadless": false,
       "usesSdkClient": true
     },
@@ -1115,7 +1125,7 @@
       "componentName": "DocflowDocuments",
       "sourceComponentPath": "src/front-components/docflow-documents.front-component.tsx",
       "builtComponentPath": "src/front-components/docflow-documents.front-component.mjs",
-      "builtComponentChecksum": "80deb4739a907cd67d210c7e00d9de7ec8d3e7a6730126d5755809c7461e1f3c",
+      "builtComponentChecksum": "8065f28f93416db416ecc6a477469d7a40808ee8160d631d330d28819e551bf3",
       "isHeadless": false,
       "usesSdkClient": false
     },
@@ -1126,7 +1136,7 @@
       "componentName": "DocflowProcesses",
       "sourceComponentPath": "src/front-components/docflow-processes.front-component.tsx",
       "builtComponentPath": "src/front-components/docflow-processes.front-component.mjs",
-      "builtComponentChecksum": "85e09cc7575b2514443a22ab2f2ece4589d8290ed88b71c7e06d0d493877da8f",
+      "builtComponentChecksum": "ac0e6eacf7444a7b1b50878a0b0990efd5987128d872d42abecd3bbc8d7c4fe7",
       "isHeadless": false,
       "usesSdkClient": true
     }
@@ -1142,7 +1152,7 @@
       "filePath": "public/app/docflow-app.js",
       "fileName": "docflow-app.js",
       "fileType": "js",
-      "checksum": "838f9340e4765fc08cdc8502a006d9c2"
+      "checksum": "3732613ac92240e4336781cab17ea884"
     },
     {
       "filePath": "public/cover.svg",

package/package.json

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