@andrey4emk/npm-app-back-b24 0.9.8 → 1.0.1

package/README.md

@@ -2,19 +2,26 @@
 
 Утилиты для работы с Bitrix24 OAuth на основе `@bitrix24/b24jssdk`.
 
+**TypeScript-ready** — пакет полностью написан на TypeScript и включает типы.
+
 ## Содержание
 
--   [Установка](#установка)
--   [Использование](#использование)
--   [API](#api)
-    -   [OAuth функции](#oauth-функции)
-    -   [Утилиты](#утилиты)
-    -   [События](#события)
-    -   [ChatApp](#chatapp)
-    -   [Smsgold](#smsgold)
--   [Переменные окружения](#переменные-окружения)
--   [Скрипты](#скрипты)
--   [Лицензия](#лицензия)
+- [Установка](#установка)
+- [Использование](#использование)
+- [TypeScript](#typescript)
+- [API](#api)
+    - [B24Prepared](#b24prepared)
+    - [errTask](#errtask)
+    - [Event](#event)
+    - [ChatApp](#chatapp)
+    - [Wappi](#wappi)
+    - [Email](#email)
+    - [Smsgold](#smsgold)
+    - [Logs](#logs)
+- [Типы](#типы)
+- [Переменные окружения](#переменные-окружения)
+- [Скрипты](#скрипты)
+- [Лицензия](#лицензия)
 
 ## Установка
 
@@ -24,509 +31,431 @@ npm install @andrey4emk/npm-app-back-b24
 
 ## Использование
 
-```js
-import { create, refresh, save, errTask, Event } from "@andrey4emk/npm-app-back-b24";
-import { chatApp, smsgold } from "@andrey4emk/npm-app-back-b24";
-import { AuthB24Model } from "./models/AuthB24.js"; // пример модели
+```typescript
+import { B24Prepared, errTask, Event, ChatApp, Wappi, Email, Smsgold, logs } from "@andrey4emk/npm-app-back-b24";
+
+// Импорт типов
+import type { B24Client, TaskData, MessageData, ApiResult } from "@andrey4emk/npm-app-back-b24";
+```
+
+### Пример работы с Bitrix24
+
+```typescript
+import { B24Prepared, errTask, Event } from "@andrey4emk/npm-app-back-b24";
+import { B24OAuth } from "@bitrix24/b24jssdk";
+
+// Подготовка авторизации
+const b24Prepared = new B24Prepared();
+const authResult = await b24Prepared.makeAuthParams();
 
-// OAuth функции
-const b24Client = await create(AuthB24Model);
-const refreshResult = await refresh(AuthB24Model);
+if (authResult.error) {
+    console.error(authResult.message);
+    process.exit(1);
+}
 
-app.post("/b24/auth", (req, res) => save(req, res, AuthB24Model));
+const { AuthParams, secret } = authResult.data!;
 
-// Создание служебной задачи при ошибке
-await errTask(b24Client, {
+// Создание клиента B24
+const $b24 = new B24OAuth(AuthParams, secret);
+await $b24.init();
+
+// Создание задачи при ошибке
+await errTask($b24, {
     title: "Ошибка синхронизации",
-    description: "Детали ошибки здесь",
+    description: "Детали ошибки",
+    responsibleId: 1,
 });
 
 // Работа с событиями
-const eventHandler = new Event(b24Client);
-const { error, events } = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
+const eventHandler = new Event($b24);
+const result = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
 
-// Работа с ChatApp
-await chatApp.makeTokenChatApp();
-const result = await chatApp.sendMessageChatApp("whatsApp", {
-    phone: "+1234567890",
-    message: "Привет!",
-});
+if (!result.error && result.data) {
+    console.log("ID сущностей:", result.data.entitysId);
+}
+```
 
-// Работа с SMSGold
-await smsgold.sendSms("+1234567890", "Привет из SMSGold!");
+## TypeScript
+
+Пакет полностью типизирован. Все типы экспортируются из главного модуля:
+
+```typescript
+import type {
+    // Общие
+    ApiResult,
+
+    // Bitrix24
+    B24AuthConfig,
+    B24AuthParams,
+    B24Secret,
+    B24Client,
+    TaskData,
+
+    // События
+    EventMessage,
+    EventsResult,
+    ConnectorMessage,
+    ConnectorEventsResult,
+
+    // Wappi
+    WappiAuth,
+    MessageData,
+    MessengerType,
+
+    // ChatApp
+    ChatAppMakeParams,
+    ChatAppAuthParams,
+    ChatAppTypeParams,
+    ChatAppMessengerType,
+
+    // Email
+    EmailAuth,
+    EmailData,
+
+    // SMSGold
+    SmsgoldAuth,
+    SmsData,
+
+    // Logs
+    LogLevel,
+    LogConfig,
+} from "@andrey4emk/npm-app-back-b24";
 ```
 
 ## API
 
-### OAuth функции
+### B24Prepared
 
--   **`create(AuthB24Model)`** — создаёт клиента `B24OAuth` с использованием сохранённых в БД токенов.
+Класс для подготовки авторизации Bitrix24.
 
-    -   **Параметры:**
-        -   `AuthB24Model` (Sequelize Model) — модель для получения данных авторизации из БД.
-    -   **Возвращает:** промис с экземпляром `B24OAuth`, готовым к вызовам REST API.
-    -   **Ошибки:** выбрасывает `Error` если запись авторизации не найдена в БД.
+```typescript
+import { B24Prepared } from "@andrey4emk/npm-app-back-b24";
 
-    ```js
-    const b24 = await create(AuthB24Model);
-    const result = await b24.callMethod("crm.contact.list", { limit: 5 });
-    ```
+const b24Prepared = new B24Prepared();
+```
+
+**Методы:**
 
--   **`refresh(AuthB24Model)`** — продлевает токены через Bitrix24 и обновляет запись в БД.
+- **`makeAuthParams()`** — формирует параметры авторизации из конфига.
 
-    -   **Параметры:**
-        -   `AuthB24Model` (Sequelize Model) — модель для обновления токенов.
-    -   **Возвращает:** промис с объектом `{ error: boolean, message: string }`.
+    ```typescript
+    const result = await b24Prepared.makeAuthParams();
+    // result: ApiResult<{ AuthParams: B24AuthParams; secret: B24Secret }>
 
-    ```js
-    const result = await refresh(AuthB24Model);
     if (!result.error) {
-        console.log("Токены обновлены:", result.message);
+        const { AuthParams, secret } = result.data!;
+        // Используйте с @bitrix24/b24jssdk
     }
     ```
 
--   **`save(req, res, AuthB24Model)`** — HTTP-обработчик для сохранения набора токенов из `req.body`.
-
-    -   **Параметры:**
-        -   `req` (Express Request) — объект запроса с полем `body`.
-        -   `res` (Express Response) — объект ответа.
-        -   `AuthB24Model` (Sequelize Model) — модель для сохранения.
-    -   **Тело запроса (req.body):**
-        ```json
-        {
-            "access_token": "string",
-            "refresh_token": "string",
-            "domain": "string",
-            "expires_in": "number",
-            "member_id": "number"
-        }
-        ```
-    -   **Возвращает:** HTTP-ответ с JSON `{ status, message }` (код `201` при успехе, `400`/`500` при ошибках).
-
-    ```js
-    app.post("/b24/auth", (req, res) => save(req, res, AuthB24Model));
-    ```
+- **`save(req, res, $b24)`** — сохраняет токены из фронта или обновляет из бэка.
+
+    ```typescript
+    // Из Express endpoint
+    app.post("/b24/auth", (req, res) => b24Prepared.save(req, res));
 
-### Утилиты
-
--   **`errTask(b24, dataTask)`** — создаёт служебную задачу в Bitrix24 при ошибках/событиях.
-
-    -   **Алгоритм:**
-
-        1. Сначала проверяет, сколько задач с таким `TITLE` уже создано (через `tasks.task.list`).
-        2. Если их меньше чем `maxTasks`, создаёт новую задачу (`tasks.task.add`).
-
-    -   **Параметры:**
-
-        -   `b24` (B24OAuth) — экземпляр клиента Bitrix24.
-        -   `dataTask` (object) — объект с параметрами задачи (см. ниже).
-
-    -   **Возвращает:** промис с объектом:
-        ```js
-        {
-            error: false,
-            message: "Задача создана в Битрикс24.",
-            result: { /* API response */ }
-        }
-        ```
-        или при превышении лимита:
-        ```js
-        {
-            error: false,
-            message: "Превышено максимальное количество задач с таким названием (100). Новая задача не создана."
-        }
-        ```
-        или при ошибке:
-        ```js
-        {
-            error: true,
-            message: "Не удалось создать задачу в Битрикс24: <текст ошибки>"
-        }
-        ```
-
-    **Параметры `dataTask`:**
-
-    | Параметр         | Тип          | По умолчанию              | Описание                                      |
-    | ---------------- | ------------ | ------------------------- | --------------------------------------------- |
-    | `title`          | string       | **обязательно**           | Заголовок задачи                              |
-    | `description`    | string       | `""`                      | Описание задачи                               |
-    | `createdBy`      | number       | `138`                     | ID создателя                                  |
-    | `responsibleId`  | number       | `1`                       | ID ответственного                             |
-    | `deadline`       | ISO string   | `DateTime.now() + 1 день` | Дедлайн в ISO формате                         |
-    | `groupId`        | number\|null | `null`                    | ID группы (опционально)                       |
-    | `accomplices`    | array        | `[]`                      | Массив ID соисполнителей                      |
-    | `maxTasks`       | number       | `100`                     | Максимум существующих задач с таким названием |
-    | `entityTypeAbbr` | string       | `""`                      | Код CRM сущности для `UF_CRM_TASK`            |
-
-    ```js
-    await errTask(b24, {
-        title: "Ошибка синхронизации",
-        description: "Не удалось подключиться к API",
-        responsibleId: 42,
-        deadline: new Date(Date.now() + 2 * 24 * 60 * 60 * 1000).toISOString(),
-        maxTasks: 50,
-    });
+    // Из бэка для пересохранения
+    await b24Prepared.save(null, null, $b24);
     ```
 
-### События
+### errTask
 
--   **`Event`** — класс для работы с офлайн-событиями Bitrix24.
+Создаёт служебную задачу в Bitrix24 при ошибках.
 
-    ```js
-    import { Event } from "@andrey4emk/npm-app-back-b24";
+```typescript
+import { errTask } from "@andrey4emk/npm-app-back-b24";
+import type { TaskData, B24Client } from "@andrey4emk/npm-app-back-b24";
 
-    const eventHandler = new Event(b24);
-    ```
+const taskData: TaskData = {
+    title: "Ошибка синхронизации",
+    description: "Не удалось подключиться к API",
+    responsibleId: 42,
+    maxTasks: 50,
+};
+
+const result = await errTask($b24, taskData);
+```
+
+**Параметры `TaskData`:**
+
+| Параметр         | Тип            | По умолчанию    | Описание                         |
+| ---------------- | -------------- | --------------- | -------------------------------- |
+| `title`          | `string`       | **обязательно** | Заголовок задачи                 |
+| `description`    | `string`       | `""`            | Описание задачи                  |
+| `createdBy`      | `number`       | `138`           | ID создателя                     |
+| `responsibleId`  | `number`       | `1`             | ID ответственного                |
+| `deadline`       | `string`       | `+1 день`       | Дедлайн в ISO формате            |
+| `groupId`        | `number\|null` | `null`          | ID группы                        |
+| `accomplices`    | `number[]`     | `[]`            | Массив ID соисполнителей         |
+| `maxTasks`       | `number`       | `100`           | Макс. задач с таким названием    |
+| `entityTypeAbbr` | `string`       | `""`            | Код CRM сущности для UF_CRM_TASK |
 
-    **Методы:**
-
-    -   **`get(eventName)`** — получить события по названию.
-
-        -   **Параметры:**
-
-            -   `eventName` (string) — название события (например, `'ONCRMDYNAMICITEMUPDATE_149'`).
-
-        -   **Возвращает:** промис с объектом:
-
-            ```js
-            {
-                error: false,
-                events: {
-                    processId: "12345",
-                    entitysId: [101, 102, 103],
-                    arrMessageIdAndEntityId: [
-                        { messageId: "msg_1", entityId: 101 },
-                        { messageId: "msg_2", entityId: 102 },
-                        { messageId: "msg_3", entityId: 103 }
-                    ]
-                }
-            }
-            ```
-
-            или при ошибке:
-
-            ```js
-            {
-                error: true,
-                status: "error",
-                message: "Не удалось получить события. <текст ошибки>"
-            }
-            ```
-
-        -   **Особенности:**
-            -   Автоматически фильтрует и удаляет события от пользователя с `user_id: '138'`.
-            -   Если событий нет, возвращает `events` с пустыми массивами.
-
-        ```js
-        const { error, events } = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
-        if (!error && events.entitysId.length > 0) {
-            console.log("Обработанные ID сущностей:", events.entitysId);
-            // events.processId — идентификатор процесса для очистки
-            // events.arrMessageIdAndEntityId — данные для методов clear() и deleteMessageId()
-        }
-        ```
-
-    -   **`clear(processId, messageId)`** — очистить события в Bitrix24.
-
-        -   **Параметры:**
-
-            -   `processId` (string|number) — ID процесса (получен из `get()`).
-            -   `messageId` (array|string) — ID или массив ID сообщений для очистки.
-
-        -   **Возвращает:** промис с объектом:
-            ```js
-            {
-                error: false;
-            }
-            ```
-            или при ошибке:
-            ```js
-            {
-                error: true,
-                status: "error",
-                message: "Не удалось очистить события. <текст ошибки>"
-            }
-            ```
-
-        ```js
-        const { events } = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
-        if (events.processId) {
-            const messageIds = events.arrMessageIdAndEntityId.map((item) => item.messageId);
-            await eventHandler.clear(events.processId, messageIds);
-        }
-        ```
-
-    -   **`deleteMessageId(entityId, arrMessageIdAndEntityId)`** — удалить запись события из массива (локально).
-
-        -   **Параметры:**
-
-            -   `entityId` (number) — ID сущности для удаления.
-            -   `arrMessageIdAndEntityId` (array) — исходный массив событий.
-
-        -   **Возвращает:** обновлённый массив без записей с указанным `entityId`.
-
-        ```js
-        const { events } = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
-        const updated = eventHandler.deleteMessageId(101, events.arrMessageIdAndEntityId);
-        // updated содержит все события, кроме entityId: 101
-        ```
+### Event
+
+Класс для работы с офлайн-событиями Bitrix24.
+
+```typescript
+import { Event } from "@andrey4emk/npm-app-back-b24";
+
+const eventHandler = new Event($b24);
+
+// Получить события
+const result = await eventHandler.get("ONCRMDYNAMICITEMUPDATE_149");
+
+if (!result.error && result.data) {
+    const events = result.data;
+    console.log("Process ID:", events.processId);
+    console.log("Entity IDs:", events.entitysId);
+
+    // Очистить события
+    if (events.processId) {
+        const messageIds = events.arrMessageIdAndEntityId.map((e) => e.messageId);
+        await eventHandler.clear(events.processId, messageIds);
+    }
+}
+```
+
+**Методы:**
+
+- **`get(eventName)`** — получить события по названию
+- **`clear(processId, messageId)`** — очистить события в Bitrix24
 
 ### ChatApp
 
--   **`chatApp`** — готовый экземпляр класса `ChatApp` для работы с мессенджерами через платформу ChatApp Online.
+Класс для работы с мессенджерами через ChatApp Online.
+
+```typescript
+import { ChatApp } from "@andrey4emk/npm-app-back-b24";
+import type { ChatAppMakeParams, ChatAppAuthParams, ChatAppTypeParams } from "@andrey4emk/npm-app-back-b24";
+
+const makeParams: ChatAppMakeParams = {
+    email: "your-email@example.com",
+    pass: "your-password",
+    appId: "your-app-id",
+};
+
+const authParams: ChatAppAuthParams = {
+    accessToken: "",
+    accessTokenEndTime: "",
+    refreshToken: "",
+    refreshTokenEndTime: "",
+};
+
+const typeParams: ChatAppTypeParams = {
+    whatsApp: {
+        licenseId: "12345",
+        messenger: [{ type: "grWhatsApp" }],
+    },
+    telegram: {
+        licenseId: "67890",
+        messenger: [{ type: "telegram" }],
+    },
+};
+
+const chatApp = new ChatApp(makeParams, authParams, typeParams);
+
+// Отправка сообщения
+const result = await chatApp.sendMessageChatApp("whatsApp", {
+    phone: "+1234567890",
+    message: "Привет!",
+});
 
-    ```js
-    import { chatApp } from "@andrey4emk/npm-app-back-b24";
-    ```
+// Отправка файла
+await chatApp.sendFileChatApp("telegram", {
+    phone: "123456789",
+    message: "Документ",
+    fileUrl: "https://example.com/file.pdf",
+    fileName: "document.pdf",
+});
+
+// Проверка номера
+const check = await chatApp.phoneCheckChatApp("whatsApp", "+1234567890");
+```
+
+### Wappi
+
+Класс для работы с Wappi API (WhatsApp, Telegram, Max).
+
+```typescript
+import { Wappi } from "@andrey4emk/npm-app-back-b24";
+import type { WappiAuth, MessengerType } from "@andrey4emk/npm-app-back-b24";
+
+const whatsAppAuth: WappiAuth = { token: "xxx", profile_id: "123" };
+const telegramAuth: WappiAuth = { token: "yyy", profile_id: "456" };
+const maxAuth: WappiAuth = { token: "zzz", profile_id: "789" };
+
+const wappi = new Wappi(maxAuth, telegramAuth, whatsAppAuth);
 
-    **Методы:**
+// Отправка сообщения
+const result = await wappi.sendMessageWappi("whatsApp", {
+    phone: "+1234567890",
+    message: "Привет!",
+    sendOpenLine: true, // Отображать в открытой линии Б24
+});
+
+// Отправка файла
+await wappi.sendFileWappi("telegram", {
+    phone: "+1234567890",
+    message: "Документ",
+    fileUrl: "https://example.com/file.pdf",
+    fileName: "document.pdf",
+});
+
+// Проверка номера
+const check = await wappi.phoneCheckWappi("whatsApp", "+1234567890");
+if (!check.error && check.data?.check) {
+    console.log("Номер существует в WhatsApp");
+}
+```
+
+**Поддерживаемые мессенджеры (`MessengerType`):**
+
+- `"whatsApp"`
+- `"telegram"`
+- `"max"`
+
+### Email
+
+Класс для отправки email через Yandex SMTP.
 
-    -   **`makeTokenChatApp()`** — получить токены доступа для ChatApp API.
-
-        -   **Возвращает:** промис с объектом:
+```typescript
+import { Email } from "@andrey4emk/npm-app-back-b24";
+import type { EmailAuth, EmailData } from "@andrey4emk/npm-app-back-b24";
 
-            ```js
-            {
-                error: false;
-            }
-            ```
-
-            или при ошибке:
-
-            ```js
-            {
-                error: true,
-                message: "Не удалось получить токен ChatApp",
-                data: { /* API response */ }
-            }
-            ```
-
-        -   **Особенности:**
-            -   Сохраняет полученные токены в свойствах экземпляра (`accessToken`, `refreshToken` и т.д.).
-            -   Требует переменные окружения: `CHATAPP_EMAIL`, `CHATAPP_PASS`, `CHATAPP_APP_ID`.
-
-        ```js
-        const result = await chatApp.makeTokenChatApp();
-        if (!result.error) {
-            console.log("Токены успешно получены");
-        }
-        ```
-
-    -   **`refreshTokenChatApp()`** — обновить токены доступа.
-
-        -   **Возвращает:** промис с объектом:
-
-            ```js
-            {
-                error: false;
-            }
-            ```
-
-            или при ошибке:
-
-            ```js
-            {
-                error: true,
-                message: "Не удалось обновить токен ChatApp",
-                data: { /* API response */ }
-            }
-            ```
-
-        -   **Алгоритм:**
-            1. Пытается обновить токены через API.
-            2. Если обновление не удалось, автоматически получает новые токены через `makeTokenChatApp()`.
-
-        ```js
-        const result = await chatApp.refreshTokenChatApp();
-        if (!result.error) {
-            console.log("Токены обновлены");
-        }
-        ```
-
-    -   **`checkTokenChatApp()`** — проверить валидность текущего токена.
-
-        -   **Возвращает:** промис с объектом:
-
-            ```js
-            {
-                error: false,
-                message: "Токен действителен" // или "Токен обновлен"
-            }
-            ```
-
-            или при ошибке:
-
-            ```js
-            {
-                error: true,
-                message: "<текст ошибки>",
-                data: null
-            }
-            ```
-
-        -   **Особенности:**
-            -   Если токен невалидный, автоматически вызывает `refreshTokenChatApp()`.
-
-        ```js
-        const result = await chatApp.checkTokenChatApp();
-        console.log(result.message);
-        ```
-
-    -   **`getLicensesChatApp()`** — получить список лицензий для текущего аккаунта.
-
-        -   **Возвращает:** промис с объектом:
-
-            ```js
-            {
-                error: false,
-                message: "Лицензии успешно получены",
-                data: [ /* массив лицензий */ ]
-            }
-            ```
-
-            или при ошибке:
-
-            ```js
-            {
-                error: true,
-                message: "Не удалось получить лицензии ChatApp",
-                data: null
-            }
-            ```
-
-        -   **Структура лицензии в массиве:**
-            ```js
-            {
-                id: 15779,
-                licenseName: "*5787",
-                messengers: [
-                    { type: "grWhatsApp", name: "[WEB] WhatsApp" }
-                ]
-            }
-            ```
-
-        ```js
-        const result = await chatApp.getLicensesChatApp();
-        if (!result.error) {
-            console.log("Доступные лицензии:", result.data);
-        }
-        ```
-
-    -   **`sendMessageChatApp(messengerType, messageData)`** — отправить сообщение через мессенджер.
-
-        -   **Параметры:**
-
-            -   `messengerType` (string) — тип мессенджера: `"whatsApp"` или `"telegram"`.
-            -   `messageData` (object) — объект с данными сообщения:
-                -   `phone` (string) — номер телефона или ID чата получателя.
-                -   `message` (string) — текст сообщения.
-
-        -   **Возвращает:** промис с объектом:
-
-            ```js
-            {
-                error: false,
-                message: "Сообщение успешно отправлено в ChatApp через whatsApp",
-                data: null
-            }
-            ```
-
-            или при ошибке:
-
-            ```js
-            {
-                error: true,
-                message: "Ошибка при отправке сообщения в ChatApp через whatsApp",
-                data: null
-            }
-            ```
-
-        -   **Особенности:**
-            -   Перед отправкой автоматически проверяет токен через `checkTokenChatApp()`.
-            -   Использует конфигурацию из [config.js](config.js) для получения ID лицензий и типов мессенджеров.
-            -   Поддерживает отправку сообщений в WhatsApp и Telegram.
-
-        ```js
-        const result = await chatApp.sendMessageChatApp("whatsApp", {
-            phone: "+1234567890",
-            message: "Это тестовое сообщение",
-        });
-
-        if (!result.error) {
-            console.log(result.message);
-        } else {
-            console.error(result.message);
-        }
-        ```
-
-        **Пример отправки в Telegram:**
-
-        ```js
-        const result = await chatApp.sendMessageChatApp("telegram", {
-            phone: "123456789", // ID чата в Telegram
-            message: "Привет из приложения!",
-        });
-        ```
+const auth: EmailAuth = {
+    user: "your-email@yandex.ru",
+    pass: "app-password",
+};
+
+const email = new Email(auth);
+
+const result = await email.send({
+    to: "recipient@example.com",
+    subject: "Тема письма",
+    text: "Текст письма",
+    html: "<p>HTML версия</p>",
+    fileUrl: "https://example.com/file.pdf", // Опционально
+    fileName: "document.pdf",
+});
+```
 
 ### Smsgold
 
--   **`smsgold.sendSms(phone, message)`** — отправляет SMS через сервис SMSGold.
+Класс для отправки SMS через SMSGold.
 
-    ```js
-    import { smsgold } from "@andrey4emk/npm-app-back-b24";
+```typescript
+import { Smsgold } from "@andrey4emk/npm-app-back-b24";
+import type { SmsgoldAuth, SmsData } from "@andrey4emk/npm-app-back-b24";
 
-    const result = await smsgold.sendSms("+79990000000", "Готово!");
-    if (!result.error) {
-        console.log(result.message);
-    } else {
-        console.error(result.result);
-    }
-    ```
+const auth: SmsgoldAuth = {
+    user: "login",
+    pass: "password",
+};
+
+// Без Bitrix24 (без прикрепления файлов)
+const smsgold = new Smsgold(auth);
+
+// С Bitrix24 (для прикрепления файлов через диск)
+const smsgoldWithB24 = new Smsgold(auth, $b24);
+
+const result = await smsgold.sendSms({
+    phone: "+79990000000",
+    message: "Готово!",
+});
 
-    **Требуемые переменные окружения:**
+// С файлом (требуется $b24)
+await smsgoldWithB24.sendSms({
+    phone: "+79990000000",
+    message: "Ваш документ",
+    fileUrl: "https://example.com/file.pdf",
+    fileName: "document.pdf",
+});
+```
+
+### Logs
+
+Логирование с цветами и настройками.
+
+```typescript
+import { logs } from "@andrey4emk/npm-app-back-b24";
+
+logs.add("Информационное сообщение", "info");
+logs.add("Отладочная информация", "debug", { key: "value" });
+logs.add("Ошибка!", "error");
+```
+
+**Уровни логирования (`LogLevel`):**
+
+- `"info"` — зелёный (включен по умолчанию)
+- `"debug"` — серый (выключен по умолчанию)
+- `"error"` — красный (включен по умолчанию)
 
-    | Переменная     | Назначение       |
-    | -------------- | ---------------- |
-    | `SMSGOLD_USER` | Логин в SMSGold  |
-    | `SMSGOLD_PASS` | Пароль в SMSGold |
+Настройки хранятся в `config/log.json`.
 
-    Метод возвращает объект `{ error, message, result }`, где в `result` содержатся статус-код HTTP и тело ответа сервиса.
+## Типы
+
+### ApiResult
+
+Универсальный результат операций:
+
+```typescript
+interface ApiResult<T = unknown> {
+    error: boolean;
+    message: string;
+    data?: T;
+    result?: T;
+    status?: string;
+    info?: T;
+}
+```
+
+### MessageData
+
+Данные сообщения для Wappi/ChatApp:
+
+```typescript
+interface MessageData {
+    phone: string;
+    message: string;
+    fileUrl?: string;
+    fileName?: string;
+    sendOpenLine?: boolean;
+}
+```
 
 ## Переменные окружения
 
-| Переменная                  | Назначение                                                    |
-| --------------------------- | ------------------------------------------------------------- |
-| `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`                  | Название приложения (используется в описании задач)           |
-| `CHATAPP_EMAIL`             | Email аккаунта ChatApp                                        |
-| `CHATAPP_PASS`              | Пароль аккаунта ChatApp                                       |
-| `CHATAPP_APP_ID`            | ID приложения в ChatApp                                       |
+| Переменная                  | Назначение                   |
+| --------------------------- | ---------------------------- |
+| `APP_ENV`                   | Окружение (`DEV` или `PROD`) |
+| `APP_NAME`                  | Название приложения          |
+| `CONFIG_DIR`                | Путь к папке с конфигами     |
+| `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        |
 
 **Пример `.env`:**
 
 ```env
-APP_B24_DOMEN=mycompany.bitrix24.ru
 APP_ENV=DEV
+APP_NAME=MyApp
+CONFIG_DIR=../config
+
 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
-
-CHATAPP_EMAIL=your-email@example.com
-CHATAPP_PASS=your-password
-CHATAPP_APP_ID=your-app-id
 ```
 
 ## Скрипты
 
--   `npm run test` — запуск тестов (заглушка).
--   `npm run pack:dry` — предпросмотр содержимого пакета перед публикацией.
+```bash
+npm run build          # Компиляция TypeScript
+npm run build:watch    # Компиляция в watch-режиме
+npm run pack:dry       # Предпросмотр содержимого пакета
+npm test               # Запуск тестов
+```
 
 ## Лицензия