@andrey4emk/npm-app-back-b24 0.2.5 → 0.3.1

package/README.md

@@ -11,77 +11,117 @@ npm install @andrey4emk/npm-app-back-b24
 ## Использование
 
 ```js
-import { create, refresh, save } from "@andrey4emk/npm-app-back-b24";
+import { create, refresh, save, errTask, Event } from "@andrey4emk/npm-app-back-b24";
 import { AuthB24Model } from "./models/AuthB24.js"; // пример модели
 
+// OAuth функции
 const b24Client = await create(AuthB24Model);
 const refreshResult = await refresh(AuthB24Model);
 
 app.post("/b24/auth", (req, res) => save(req, res, AuthB24Model));
+
+// Создание служебной задачи при ошибке
+await errTask(b24Client, {
+    title: "Ошибка синхронизации",
+    description: "Детали ошибки здесь",
+});
+
+// Работа с событиями
+const eventHandler = new Event(b24Client);
+const events = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
 ```
 
 ## API
 
--   `create(AuthB24Model)` — создаёт клиента `B24OAuth` с использованием сохранённых в БД токенов.
--   `refresh(AuthB24Model)` — продлевает токены через Bitrix24 и обновляет запись в БД.
--   `save(req, res, AuthB24Model)` — HTTP-обработчик для сохранения набора токенов из `req.body`.
+### OAuth функции
+
+-   **`create(AuthB24Model)`** — создаёт клиента `B24OAuth` с использованием сохранённых в БД токенов.
+
+    -   Возвращает: промис с экземпляром `B24OAuth`, готовым к вызовам REST API.
+
+-   **`refresh(AuthB24Model)`** — продлевает токены через Bitrix24 и обновляет запись в БД.
+
+    -   Возвращает: промис с объектом `{ error: boolean, message: string }`.
 
--   `error({ dataTask, $b24 })` — утилита для создания служебной задачи в Bitrix24 при ошибках/событиях. Сначала проверяет, сколько задач с таким `TITLE` уже создано (через `tasks.task.list`), и если их меньше чем `maxTasks`, создаёт новую задачу (`tasks.task.add`).
+-   **`save(req, res, AuthB24Model)`** — HTTP-обработчик для сохранения набора токенов из `req.body`.
+    -   Возвращает: HTTP-ответ с JSON `{ status, message }` (код `201` при успехе, `400`/`500` при ошибках).
 
-### Возвращаемые значения
+### Утилиты
 
--   [`makeAuthParams`](b24.js) — промис, который резолвится объектом `{ AuthParams, secret }` для Bitrix24 SDK.
--   [`create`](b24.js) — промис с экземпляром `B24OAuth`, готовым к вызовам REST API.
--   [`refresh`](b24.js) — промис с объектом `{ error: boolean, message: string }`, описывающим статус продления.
--   [`save`](b24.js) — HTTP-ответ, отправляющий JSON `{ status, message }` с кодом `201` при успехе или `400/500` при ошибках.
--   [`error`](b24.js) — промис с объектом `{ error: boolean, message: string, result? }`.
-    -   В случае успеха возвращает `{ error: false, message: 'Задача создана в Битрикс24.', result }`, где `result` — ответ API `tasks.task.add`.
-    -   Если задач уже больше или равно `maxTasks`, возвращает `{ error: false, message: 'Превышено максимальное количество задач...' }` и не создаёт новую задачу.
-    -   В случае ошибки возвращает `{ error: true, message: 'Не удалось создать задачу в Битрикс24: <текст ошибки>' }`.
+-   **`errTask(b24, dataTask)`** — создаёт служебную задачу в Bitrix24 при ошибках/событиях.
 
-Параметры функции `error` (передаются как один объект):
+    -   Сначала проверяет, сколько задач с таким `TITLE` уже создано (через `tasks.task.list`).
+    -   Если их меньше чем `maxTasks`, создаёт новую задачу (`tasks.task.add`).
+    -   Возвращает: промис с объектом `{ error: boolean, message: string, result? }`.
+        -   При успехе: `{ error: false, message: 'Задача создана в Битрикс24.', result }` (где `result` — ответ API).
+        -   Если превышен лимит: `{ error: false, message: 'Превышено максимальное количество задач...' }`.
+        -   При ошибке: `{ error: true, message: 'Не удалось создать задачу в Битрикс24: <текст ошибки>' }`.
 
--   `dataTask` — объект с настройками задачи. Поддерживаемые поля:
+    **Параметры `dataTask`:**
 
-    -   `title` (string) — заголовок задачи (обязательное).
+    -   `title` (string, **обязательно**) — заголовок задачи.
     -   `description` (string) — описание (опционально).
     -   `createdBy` (number) — ID создателя (по умолчанию `138`).
     -   `responsibleId` (number) — ID ответственного (по умолчанию `1`).
-    -   `deadline` (ISO string) — дедлайн задачи; если не задан, используется `DateTime.now().plus({ days: 1 })`.
-    -   `groupId` (number|null) — группа, опционально.
+    -   `deadline` (ISO string) — дедлайн; если не задан, используется `DateTime.now().plus({ days: 1 })`.
+    -   `groupId` (number|null) — группа (опционально).
     -   `accomplices` (array) — массив соисполнителей.
     -   `maxTasks` (number) — максимум существующих задач с таким названием (по умолчанию `100`).
     -   `entityTypeAbbr` (string) — код CRM сущности для `UF_CRM_TASK`.
 
--   `$b24` — экземпляр SDK/клиента Bitrix24 с методом `callMethod(method, params)`.
+### События
 
-Побочные эффекты:
+-   **`Event`** — класс для работы с офлайн-событиями Bitrix24.
 
--   Функция вызывает методы Bitrix24 через `$b24.callMethod` и может создавать задачи в вашей облачной системе Bitrix24.
--   Убедитесь, что `$b24` авторизован и имеет доступ на создание задач.
+    ```js
+    const eventHandler = new Event(b24);
 
-### Переменные окружения
+    // Получить события
+    const { events } = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
+    // events: { processId, entitysId, arrMessageIdAndEntityId }
 
--   `APP_B24_DOMEN`
--   `APP_B24_CLIENT_ID`, `APP_B24_CLIENT_SECRET`
--   `APP_B24_CLIENT_ID_DEV`, `APP_B24_CLIENT_SECRET_DEV`
--   `APP_ENV` (`DEV` или иное значение)
+    // Очистить события
+    await eventHandler.clear(processId, messageId);
 
-Дополнительные переменные (имена совпадают с теми, что используются в `b24.js`):
+    // Удалить messageId из массива
+    const updated = await eventHandler.deleteMessageId(entityId, arrMessageIdAndEntityId);
+    ```
 
--   `APP_NAME` — название приложения, используется при создании задач через `error`.
+    **Методы:**
 
-Назначение переменных:
+    -   `get(eventName)` — получить события по названию. Возвращает `{ error, events }`.
+    -   `clear(processId, messageId)` — очистить события. Возвращает `{ error }`.
+    -   `deleteMessageId(entityId, arrMessageIdAndEntityId)` — удалить запись события из массива. Возвращает обновлённый массив.
 
--   `APP_B24_DOMEN` — домен Bitrix24, для которого хранится запись авторизации в БД.
--   `APP_B24_CLIENT_ID`, `APP_B24_CLIENT_SECRET` — клиентские креденшелы для рабочего (production) приложения.
--   `APP_B24_CLIENT_ID_DEV`, `APP_B24_CLIENT_SECRET_DEV` — креденшелы для DEV окружения, используются при `APP_ENV == 'DEV'`.
--   `APP_ENV` — определяет, какие креденшелы использовать (например, `DEV`).
--   `APP_NAME` — читабельное имя приложения, добавляется в описание задач, создаваемых функцией `error`.
+## Переменные окружения
 
-Настройте их перед использованием.
+| Переменная                  | Назначение                                                    |
+| --------------------------- | ------------------------------------------------------------- |
+| `APP_B24_DOMEN`             | Домен Bitrix24, для которого хранится запись авторизации в БД |
+| `APP_B24_CLIENT_ID`         | Client ID для production                                      |
+| `APP_B24_CLIENT_SECRET`     | Client Secret для production                                  |
+| `APP_B24_CLIENT_ID_DEV`     | Client ID для DEV окружения                                   |
+| `APP_B24_CLIENT_SECRET_DEV` | Client Secret для DEV окружения                               |
+| `APP_ENV`                   | Определяет окружение (`DEV` или production)                   |
+| `APP_NAME`                  | Название приложения (используется в описании задач)           |
+
+Пример `.env`:
+
+```env
+APP_B24_DOMEN=mycompany.bitrix24.ru
+APP_ENV=DEV
+APP_B24_CLIENT_ID_DEV=xxx
+APP_B24_CLIENT_SECRET_DEV=yyy
+APP_B24_CLIENT_ID=aaa
+APP_B24_CLIENT_SECRET=bbb
+APP_NAME=MyApp
+```
 
 ## Скрипты
 
--   `npm run test` — заглушка тестов.
--   `npm run pack:dry` — предпросмотр содержимого пакета.
+-   `npm run test` — запуск тестов (заглушка).
+-   `npm run pack:dry` — предпросмотр содержимого пакета перед публикацией.
+
+## Лицензия
+
+MIT © 2025 andrey4emk

package/b24.js

@@ -5,7 +5,6 @@ import dotEnv from "dotenv";
 dotEnv.config();
 
 // Environment variables (copied here to make code easier to test/mocking)
-// Сохраняем имена переменных точь-в-точь, но без process.env
 const APP_B24_DOMEN = process.env.APP_B24_DOMEN;
 const APP_ENV = process.env.APP_ENV;
 const APP_B24_CLIENT_ID_DEV = process.env.APP_B24_CLIENT_ID_DEV;
@@ -94,9 +93,9 @@ export async function save(req, res, AuthB24Model) {
     }
 }
 
-export async function error({ dataTask, $b24 }) {
+export async function errTask(b24, dataTask) {
     try {
-        let appName = process.env.APP_NAME || "Задай название приложения в .env";
+        let appName = APP_NAME || "Задай название приложения в .env";
         let title = dataTask.title;
         let description = dataTask.description || "";
         let createdBy = dataTask.createdBy || 138;
@@ -107,7 +106,7 @@ export async function error({ dataTask, $b24 }) {
         let maxTasks = dataTask.maxTasks || 100;
         let entityTypeAbbr = dataTask.entityTypeAbbr || "";
         // Проверяем сколько создано таких задач. Если их уже больше 10, то не создаем новую
-        let resTasks = await $b24.callMethod("tasks.task.list", {
+        let resTasks = await b24.callMethod("tasks.task.list", {
             filter: {
                 TITLE: title,
                 "<STATUS": 4,
@@ -120,7 +119,7 @@ export async function error({ dataTask, $b24 }) {
             return { error: false, message: `Превышено максимальное количество задач с таким названием (${maxTasks}). Новая задача не создана.` };
         } else {
             // Создаем задачу в б24 на проверить. Если не смогли получить события
-            let resCreateTask = await $b24.callMethod("tasks.task.add", {
+            let resCreateTask = await b24.callMethod("tasks.task.add", {
                 fields: {
                     TITLE: title,
                     DESCRIPTION: `${appName} \n\n ${description}`,

package/eventGet.js

@@ -0,0 +1,120 @@
+/*
+Как использовать:
+import { Event } from "@andrey4emk/npm-app-back-b24";
+const event = new Event($b24); // $b24 — ваш экземпляр SDK
+await event.get('ONCRMDYNAMICITEMUPDATE_149');
+*/
+
+export class Event {
+    constructor(b24) {
+        if (!b24 || typeof b24.callMethod !== "function") {
+            throw new Error("Event: передали херовый b24 или не передали вообще");
+        }
+        this.b24 = b24;
+    }
+    async get(eventName) {
+        //Переменные
+        let events = {
+            processId: null,
+            entitysId: [],
+            arrMessageIdAndEntityId: [],
+        };
+
+        try {
+            // Запрашиваем офлайн события сделок через API Bitrix24
+            let arrOfflineEvents = await this.b24.callMethod("event.offline.get", {
+                clear: 0,
+                filter: { EVENT_NAME: eventName },
+                // auth_connector: "change_entity_app",
+            });
+
+            // Очищаем сразу события, у которых EVENT_ADDITIONAL: { user_id: '138' }, их не обрабатываем
+            let arrEventsToClear = arrOfflineEvents.result.events.filter((event) => event.EVENT_ADDITIONAL.user_id === "138");
+            if (arrEventsToClear.length > 0) {
+                let arrMessageIdToClear = arrEventsToClear.map((event) => event.MESSAGE_ID);
+                let resEventClear = await this.b24.callMethod("event.offline.clear", {
+                    process_id: arrOfflineEvents.result.process_id,
+                    message_id: arrMessageIdToClear,
+                });
+                // Удаляем эти события из основного массива arrOfflineEvents.result.events
+                arrOfflineEvents.result.events = arrOfflineEvents.result.events.filter((event) => event.EVENT_ADDITIONAL.user_id !== "138");
+            }
+
+            if (arrOfflineEvents.result.events.length > 0) {
+                events.processId = arrOfflineEvents.result.process_id;
+                events.entitysId = arrOfflineEvents.result.events.map((event) => event.EVENT_DATA.FIELDS.ID);
+                events.arrMessageIdAndEntityId = arrOfflineEvents.result.events.map((event) => ({
+                    messageId: event.MESSAGE_ID,
+                    entityId: event.EVENT_DATA.FIELDS.ID,
+                }));
+            } else {
+            }
+
+            // Возвращаем очищенный результат
+            return { error: false, events: events };
+        } catch (error) {
+            return { error: true, status: "error", message: `Не удалось получить события. ${error}` };
+        }
+    }
+
+    async clear(processId, messageId) {
+        try {
+            // Очищаем офлайн события сделок через API Bitrix24
+            let resEventClear = await this.b24.callMethod("event.offline.clear", {
+                process_id: processId,
+                message_id: messageId,
+            });
+            return { error: false };
+        } catch (error) {
+            return { error: true, status: "error", message: `Не удалось очистить события. ${error}` };
+        }
+    }
+    async deleteMessageId(entityId, arrMessageIdAndEntityId) {
+        try {
+            //  Находим в массиве arrMessageIdAndEntityId объект с нужным entityId и удаляем целиком этот объект из массива
+            let index = arrMessageIdAndEntityId.findIndex((item) => item.entityId === entityId);
+            if (index !== -1) {
+                arrMessageIdAndEntityId.splice(index, 1);
+            }
+            return arrMessageIdAndEntityId;
+        } catch (error) {
+            return { error: true, status: "error", message: `Не удалось удалить messageId. ${error}` };
+        }
+    }
+}
+
+// Как выглядит оффлайн событие
+
+// {
+//   result: {
+//     process_id: '9bjf3j8mhfw40xisspvurxfnd0yvja97',
+//     events: [
+//       {
+//         ID: '81307763',
+//         TIMESTAMP_X: '2025-09-13T10:54:04+03:00',
+//         EVENT_NAME: 'ONCRMDYNAMICITEMUPDATE_149',
+//         EVENT_DATA: { FIELDS: { ID: 959, ENTITY_TYPE_ID: 149 } },
+//         EVENT_ADDITIONAL: { user_id: '1' },
+//         MESSAGE_ID: '892acbbb5d7a6aad30f5c670a65bcabc'
+//       },
+//       {
+//         ID: '81307739',
+//         TIMESTAMP_X: '2025-09-13T10:54:16+03:00',
+//         EVENT_NAME: 'ONCRMDYNAMICITEMUPDATE_149',
+//         EVENT_DATA: { FIELDS: { ID: 957, ENTITY_TYPE_ID: 149 } },
+//         EVENT_ADDITIONAL: { user_id: '138' },
+//         MESSAGE_ID: '7cf5d29bee90cc37382a9fff07fc2a43'
+//       }
+//     ]
+//   },
+//   time: {
+//     start: 1757750082.536543,
+//     finish: 1757750082.626707,
+//     duration: 0.0901641845703125,
+//     processing: 0.0034630298614501953,
+//     date_start: '2025-09-13T10:54:42+03:00',
+//     date_finish: '2025-09-13T10:54:42+03:00',
+//     operating_reset_at: 1757750682,
+//     operating: 0
+//   }
+// }

package/index.js

@@ -0,0 +1,3 @@
+// index.js — публичная точка входа
+export * from "./b24.js"; // ре‑экспорт всех экспортов из b24.js
+export * from "./eventGet.js"; // и из нового файла eventGet.js

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@andrey4emk/npm-app-back-b24",
-    "version": "0.2.5",
+    "version": "0.3.1",
     "description": "Bitrix24 OAuth helpers for Node.js projects",
-    "main": "b24.js",
+    "main": "index.js",
     "type": "module",
     "scripts": {
         "test": "echo \"No tests\" && exit 0",
@@ -20,7 +20,9 @@
     },
     "homepage": "https://github.com/andrey4emk/npm_appBackB24#readme",
     "files": [
-        "b24.js"
+        "index.js",
+        "b24.js",
+        "eventGet.js"
     ],
     "dependencies": {
         "@bitrix24/b24jssdk": "^0.5.1",