@andrey4emk/npm-app-back-b24 0.2.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 andrey4emk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,87 @@
+# npm_appBackB24
+
+Утилиты для работы с Bitrix24 OAuth на основе `@bitrix24/b24jssdk`.
+
+## Установка
+
+```bash
+npm install @andrey4emk/npm-appbackb24
+```
+
+## Использование
+
+```js
+import { create, refresh, save } from "@andrey4emk/npm-appbackb24";
+import { AuthB24Model } from "./models/AuthB24.js"; // пример модели
+
+const b24Client = await create(AuthB24Model);
+const refreshResult = await refresh(AuthB24Model);
+
+app.post("/b24/auth", (req, res) => save(req, res, AuthB24Model));
+```
+
+## API
+
+-   `create(AuthB24Model)` — создаёт клиента `B24OAuth` с использованием сохранённых в БД токенов.
+-   `refresh(AuthB24Model)` — продлевает токены через Bitrix24 и обновляет запись в БД.
+-   `save(req, res, AuthB24Model)` — HTTP-обработчик для сохранения набора токенов из `req.body`.
+
+-   `error({ dataTask, $b24 })` — утилита для создания служебной задачи в Bitrix24 при ошибках/событиях. Сначала проверяет, сколько задач с таким `TITLE` уже создано (через `tasks.task.list`), и если их меньше чем `maxTasks`, создаёт новую задачу (`tasks.task.add`).
+
+### Возвращаемые значения
+
+-   [`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: <текст ошибки>' }`.
+
+Параметры функции `error` (передаются как один объект):
+
+-   `dataTask` — объект с настройками задачи. Поддерживаемые поля:
+
+    -   `title` (string) — заголовок задачи (обязательное).
+    -   `description` (string) — описание (опционально).
+    -   `createdBy` (number) — ID создателя (по умолчанию `138`).
+    -   `responsibleId` (number) — ID ответственного (по умолчанию `1`).
+    -   `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)`.
+
+Побочные эффекты:
+
+-   Функция вызывает методы Bitrix24 через `$b24.callMethod` и может создавать задачи в вашей облачной системе Bitrix24.
+-   Убедитесь, что `$b24` авторизован и имеет доступ на создание задач.
+
+### Переменные окружения
+
+-   `APP_B24_DOMEN`
+-   `APP_B24_CLIENT_ID`, `APP_B24_CLIENT_SECRET`
+-   `APP_B24_CLIENT_ID_DEV`, `APP_B24_CLIENT_SECRET_DEV`
+-   `APP_ENV` (`DEV` или иное значение)
+
+Дополнительные переменные (имена совпадают с теми, что используются в `b24.js`):
+
+-   `APP_NAME` — название приложения, используется при создании задач через `error`.
+
+Назначение переменных:
+
+-   `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`.
+
+Настройте их перед использованием.
+
+## Скрипты
+
+-   `npm run test` — заглушка тестов.
+-   `npm run pack:dry` — предпросмотр содержимого пакета.

package/b24.js

@@ -0,0 +1,140 @@
+import { B24OAuth, AuthOAuthManager } from "@bitrix24/b24jssdk";
+import { DateTime } from "luxon";
+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;
+const APP_B24_CLIENT_ID = process.env.APP_B24_CLIENT_ID;
+const APP_B24_CLIENT_SECRET_DEV = process.env.APP_B24_CLIENT_SECRET_DEV;
+const APP_B24_CLIENT_SECRET = process.env.APP_B24_CLIENT_SECRET;
+const APP_NAME = process.env.APP_NAME;
+
+async function makeAuthParams(AuthB24Model) {
+    let authSql = await AuthB24Model.findOne({
+        where: {
+            domain: APP_B24_DOMEN,
+        },
+        raw: true,
+    });
+    if (!authSql) {
+        // Явно выбрасываем ошибку — caller может её поймать и вернуть понятный ответ
+        throw new Error(`Auth record not found for domain: ${APP_B24_DOMEN}`);
+    }
+    // Формируем параметры авторизации для SDK
+    let AuthParams = {
+        applicationToken: "", // если нет — можно '' (см. примечание ниже)
+        userId: 0, // если неизвестен — 0
+        memberId: authSql.member_id,
+        accessToken: authSql.access_token,
+        refreshToken: authSql.refresh_token,
+        expires: authSql.expires_in,
+        expiresIn: 1800,
+        scope: "", // если нет строки scope — оставьте пусто
+        domain: authSql.domain,
+        clientEndpoint: `https://${authSql.domain}/rest/`,
+        serverEndpoint: "https://oauth.bitrix.info/rest/",
+        status: "L", // Local — для локальных приложений; подставьте свой вариант
+        issuer: "store", // опционально
+    };
+    let secret = {
+        clientId: APP_ENV == "DEV" ? APP_B24_CLIENT_ID_DEV : APP_B24_CLIENT_ID,
+        clientSecret: APP_ENV == "DEV" ? APP_B24_CLIENT_SECRET_DEV : APP_B24_CLIENT_SECRET,
+    };
+    return { AuthParams, secret };
+}
+
+export async function create(AuthB24Model) {
+    let { AuthParams, secret } = await makeAuthParams(AuthB24Model);
+    return new B24OAuth(AuthParams, secret);
+}
+
+// Функция продления токена битрикс24 и сохранения в БД
+export async function refresh(AuthB24Model) {
+    try {
+        let { AuthParams, secret } = await makeAuthParams(AuthB24Model);
+        let newToken = await new AuthOAuthManager(AuthParams, secret).refreshAuth();
+        if (!newToken) {
+            return { error: true, message: "В refresh не получили токен" };
+        }
+
+        await AuthB24Model.upsert({
+            access_token: newToken.access_token,
+            refresh_token: newToken.refresh_token,
+            domain: newToken.domain,
+            expires_in: newToken.expires,
+            member_id: newToken.member_id,
+        });
+        return { error: false, message: "Токены битрикс24 успешно обновлены." };
+    } catch (error) {
+        return { error: true, message: "Не удалось продлить авторизацию." };
+    }
+}
+
+export async function save(req, res, AuthB24Model) {
+    try {
+        const { access_token, refresh_token, domain, expires_in, member_id } = req.body;
+        if (!access_token || !refresh_token || !domain || !expires_in || !member_id) {
+            return res.status(400).json({ status: "error", message: "Не заполнены обязательные поля." });
+        }
+        const authData = await AuthB24Model.upsert({
+            access_token: access_token,
+            refresh_token: refresh_token,
+            domain: domain,
+            expires_in: expires_in,
+            member_id: member_id,
+        });
+        res.status(201).json({ status: "ok", message: "Сохранили токены" });
+    } catch (error) {
+        res.status(500).json({ status: "error", message: "Не удалось сохранить токен." });
+    }
+}
+
+export async function error({ dataTask, $b24 }) {
+    try {
+        let appName = process.env.APP_NAME || "Задай название приложения в .env";
+        let title = dataTask.title;
+        let description = dataTask.description || "";
+        let createdBy = dataTask.createdBy || 138;
+        let responsibleId = dataTask.responsibleId || 1;
+        let deadline = dataTask.deadline || DateTime.now().plus({ days: 1 }).toISO();
+        let groupId = dataTask.groupId || null; // Группа
+        let accomplices = dataTask.accomplices || []; // Соисполнители
+        let maxTasks = dataTask.maxTasks || 100;
+        let entityTypeAbbr = dataTask.entityTypeAbbr || "";
+        // Проверяем сколько создано таких задач. Если их уже больше 10, то не создаем новую
+        let resTasks = await $b24.callMethod("tasks.task.list", {
+            filter: {
+                TITLE: title,
+                "<STATUS": 4,
+            },
+            select: ["ID", "STATUS"],
+        });
+        resTasks = resTasks.getData().result.tasks;
+
+        if (resTasks && resTasks.length >= maxTasks) {
+            return { error: false, message: `Превышено максимальное количество задач с таким названием (${maxTasks}). Новая задача не создана.` };
+        } else {
+            // Создаем задачу в б24 на проверить. Если не смогли получить события
+            let resCreateTask = await $b24.callMethod("tasks.task.add", {
+                fields: {
+                    TITLE: title,
+                    DESCRIPTION: `${appName} \n\n ${description}`,
+                    CREATED_BY: createdBy,
+                    RESPONSIBLE_ID: responsibleId,
+                    DEADLINE: deadline,
+                    UF_CRM_TASK: entityTypeAbbr,
+                    GROUP_ID: groupId,
+                    ACCOMPLICES: accomplices,
+                },
+            });
+            return { error: false, message: "Задача создана в Битрикс24.", result: resCreateTask.getData().result };
+        }
+    } catch (error) {
+        return { error: true, message: `Не удалось создать задачу в Битрикс24: ${error.message}` };
+    }
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "@andrey4emk/npm-app-back-b24",
+    "version": "0.2.4",
+    "description": "Bitrix24 OAuth helpers for Node.js projects",
+    "main": "b24.js",
+    "type": "module",
+    "scripts": {
+        "test": "echo \"No tests\" && exit 0",
+        "pack:dry": "npm pack --dry-run"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@github.com/andrey4emk/npm_appBackB24.git"
+    },
+    "keywords": [],
+    "author": "andrey4emk",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/andrey4emk/npm_appBackB24/issues"
+    },
+    "homepage": "https://github.com/andrey4emk/npm_appBackB24#readme",
+    "files": [
+        "b24.js"
+    ],
+    "dependencies": {
+        "@bitrix24/b24jssdk": "^0.5.1",
+        "luxon": "^3.4.4",
+        "dotenv": "^17.2.3"
+    }
+}