Открытый пакет интеграций 2.0: расширенный вызов, WebSocket и MCP

Если вы не слышали ранее об Открытом Пакете Интеграций (что вполне вероятно), то небольшая вводная часть ниже, под катом. Тем, кто уже знаком с ОПИ, данный раздел можно пропустить.

Что нового?

Так как это мажорный релиз, кроме свежей библиотеки и исправления багов, в этом обновлении также были добавлены новые общие механизмы и принципы, которые влияют на весь пакет сразу 

Режим совместимости и поставка в виде CF

Теперь в релизах Открытого пакета интеграций версию для 1С можно найти не только в виде CFE и его файловых аналогов (XML, EDT), но и как CF файл конфигурации. Это позволяет легко устанавливать и обновлять ОПИ даже в тех проектах, где использовать расширения не принято или нежелательно. Режим совместимости конфигурации установлен в 8.3.10

Также немного изменился режим совместимости расширения ОПИ: основной режим остался 8.3.10, но режим совместимости расширения был поднят до 8.3.15. Это было необходимо для добавления в расширение параметров сеанса, которые потребовались при реализации следующего нового механизма. Кстати, о нем...

Расширенный вызов

Самое, на мой взгляд, важное нововведение. Одной из наиболее частых проблем, которые всплывают при работе с Открытым пакетом интеграций, является невозможность изменить настройки внутренних механизмов пакета при использовании конкретных функций. Особенно это касается HTTP: при использовании, например, функции ОтправитьТекстовоеСообщение библиотеки Telegram, вы можете указать ID чата, токен и текст сообщения. Но такие вещи, как таймауты, прокси и прочие настройки транспорта остаются недоступными. Добавлять все эти настройки в основные сигнатуры каждой из функций пакета было бы крайне неудобно, поэтому для решения данной проблемы был добавлен новый механизм - расширенный вызов

Тут, честно говоря, проще один раз показать, и все сразу станет понятно. Вот так выглядит обычный вызов функции ОтправитьТекстовоеСообщение:
 

Токен    = "3129457865:AAFyzNYOAFbu...";
IDЧата   = "123456789";
Текст    = "ТекстСообщения";

Результат  = OPI_Telegram.ОтправитьТекстовоеСообщение(Токен, IDЧата, Текст);

А так - при помощи механизма расширенного вызова:

Параметры = Новый Массив;
Параметры.Добавить("3129457865:AAFyzNYOAFbu...");
Параметры.Добавить("123456789");
Параметры.Добавить("ТекстСообщения");

Настройки = Новый Структура;
Настройки.Вставить("adv_response", Истина); // Добавляет код ответа и заголовки в результат функции
Настройки.Вставить("timeout"     , 10000);  // Изменяет таймаут HTTP-запроса

Результат = OPI_РасширенныйВызов.ВызватьСНастройками("OPI_Telegram"
    , "ОтправитьТекстовоеСообщение"
    , Параметры
    , Настройки);

Т.е. это такая обертка для вызова функции не напрямую, а через прослойку. Чем-то напоминает создание фонового задания: параметры функции передаются через массив в том порядке, в котором они указаны в сигнатуре функции, после чего указывается имя модуля и имя метода для вызова.

Только еще добавляются те самые расширенные настройки

Сам список настроек для конкретной функции можно узнать либо при помощи функции ПолучитьДоступныеНастройки (но это крайний случай), либо на странице интересующего метода в онлайн-документации рядом с параметрами:

На данный момент для всех функций, в которых используется HTTP-клиент, доступны настройки прокси и таймаута, а также возможность получить полный ответ с телом, статусом и заголовками, вместо обычного результата

MCP-сервер

Да, не обошла тема ИИ и Открытый пакет интеграций. В консольной версии ОПИ теперь есть встроенный MCP сервер, который позволяет использовать любые его методы при работе с ИИ-агентами. Подключается, как и любой другой MCP-сервер, через файл конфигурации. Доступны все функции, которые доступны в консольной версии ОПИ, а также использование переменных, чтобы не передавать секретные данные в промпте напрямую. Более подробно можно прочитать тут

Вот как это выглядит в диалоге с агентом:

Отдельно отмечу, что речь идет о консольном приложении Открытого пакета интеграций - oint. Оно работает на OneScript и позволяет использовать большинство методов 1С-версии ОПИ из консоли без необходимости в самой платформе 1С:Предприятие. Просто скачиваете установщик для Windows или пакет для Linux (доступны deb, rpm и Appimage) и вперед!

Об этом также есть страница в документации, где можно узнать больше

А что по новой библиотеке?

Также, по старой традиции, с новым релизом появилась и новая библиотека. В этот раз это WebSocket - распространенный протокол обмена, позволяющий передавать и получать сообщения в рамках одного соединения. Для работы с ним были реализованы следующие функции:

• Режим клиента
  • Открытие соединения
  • Закрытие соединения
  • Отправка Ping
  • Отправка Pong
  • Отправка текстовых данных
  • Отправка двоичных данных
  • Настройки Tls и прокси
• Режим сервера
  • Запуск сервера
  • Остановка сервера
  • Получение данных очередного соединения
  • Получение данных из конкретного соединения по ID
  • Отправка данных в соединение
  • Закрытие соединения
  • Получение списка активных соединений

Немного примеров кода:

    Адрес = "wss://127.0.0.1:8443";
    НуженПрокси = Истина;
    НуженTLS    = Истина;

    Заголовки = Новый Соответствие;
    Заголовки.Вставить("X-Trace-Id", "OPI-WS-TEST");

    Если НуженTls Тогда
        НастройкиTls = OPI_WebSocket.ПолучитьНастройкиTls(Истина);
    КонецЕсли;

    Если НуженПрокси Тогда

        ПроксиАдрес = "127.0.0.1";
        ПроксиПорт  = "8071";
        ПроксиВид   = "http";

        ПроксиПользователь = "proxyuser";
        ПроксиПароль       = "12we...";

        НастройкиПрокси = OPI_Компоненты.ПолучитьНастройкиПрокси(ПроксиАдрес
            , ПроксиПорт
            , ПроксиВид
            , ПроксиПользователь
            , ПроксиПароль);

    КонецЕсли;

    Соединение = OPI_WebSocket.ОткрытьСоединение(Адрес, НастройкиTls, НастройкиПрокси, Заголовки);

    Сообщение = "echo-text-" + Формат(ТекущаяДата(), "ДФ=yyyyMMddhhmmss");

    Если OPI_WebSocket.ЭтоОбъектКлиента(Соединение) Тогда

        // Отправляем сообщение ECHO-серверу
        Отправка = OPI_WebSocket.ОтправитьТекстовоеСообщение(Соединение, Сообщение);

        // Пропускаем все ответы от сервера до последнего
        Пока Истина Цикл

            ПоследнееСообщение = OPI_WebSocket.ПолучитьСообщение(Соединение, 3000);  // <----

            Если ПоследнееСообщение["result"] Тогда
                Результат = ПоследнееСообщение;
            Иначе
                Прервать;
            КонецЕсли;

        КонецЦикла;

    Иначе
        Результат = Соединение;
    КонецЕсли;

    // Запуск сервера
    ПортЗапуска   = 9894;
    ОбъектСервера = OPI_WebSocket.ЗапуститьСервер(ПортЗапуска);

    // Подключение к серверу при помощи клиента
    АдресПодключения = "ws://127.0.0.1:9894";
    ОбъектКлиента    = OPI_WebSocket.ОткрытьСоединение(АдресПодключения);

    Если Не OPI_WebSocket.ЭтоОбъектКлиента(ОбъектКлиента) Тогда
        ВызватьИсключение OPI_Инструменты.JSONСтрокой(ОбъектКлиента);
    КонецЕсли;

    // Отправка сообщения с клиента
    Сообщение = "Hello!";
    OPI_WebSocket.ОтправитьТекстовоеСообщение(ОбъектКлиента, Сообщение);

    // Получение очередного соединения на сервере и возврат ответа
    ОчередноеСообщение = OPI_WebSocket.ПолучитьДанныеОчередногоСоединения(ОбъектСервера, 5000);
    IDСоединения       = ОчередноеСообщение["connectionId"];

    ОтветСервера = "Response from server!";
    Результат    = OPI_WebSocket.ОтправитьДанные(ОбъектСервера, IDСоединения, ОтветСервера);

Все это уже доступно в пакете, как в версии для 1С, так и для OneScript. Разве что, консольная версия в этот раз в пролете из-за специфики протокола

В заключение

Версия 2.0 - важный этап на пути развития проекта. Открытому пакету интеграций уже чуть более двух лет и хотелось бы сказать огромное спасибо всем тем, кто поддерживает его на протяжении этого времени - это очень важно. Отдельное спасибо тем, кто поддерживает его материально на Boosty: сейчас ежемесячные пожертвования практически покрывают ежемесячные расходы, что очень круто

Если вы тоже хотите помочь проекту, то это можно сделать поставив плюс данной статье, а также звездочку на GitHub и оценку на SourceCraft. Это помогает проекту чаще появляться в различных списках и рекомендациях, благодаря чему о нем узнает больше людей

Ну и, конечно, вы можете поддержать проект материально на том же Boosty. Все ссылки будут нижже

Спасибо за внимание!

 Если вам нравится ОПИ, то не забывайте поддерживать его на GitHub, Инфостарт и Boosty (ссылка в репозитории)!

Репозиторий ОПИ: github.com/Bayselonarrend/OpenIntegrations

Зеркало на Sourcecraft: sourcecraft.dev/bayselonarrend/openintegrations

Последний релиз: github.com/Bayselonarrend/OpenIntegrations/releases/latest

Документация: openintegrations.dev

Другие статьи про Открытый пакет интеграций на Инфостарт:

• Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter

• Работа с Notion API | Обновление Открытого пакета интеграций

• Библиотека работы с Яндекс Диском (Open-source) 

• Открываем свою лавку на платформе VK Market

• Библиотека для работы с Google Calendar API (open-source) 

• Telegram в режиме форума: делаем чаты комфортными

• Открытый пакет интеграций для OneScript

• Библиотека для работы с Google Drive API (open-source)

• OInt CLI - приложение Открытого пакета интеграций для командной строки

• Библиотека для работы с Google Sheets (open-source)

• Библиотека для работы со Slack (open-source)

• Библиотека для работы с Airtable (open-source)

• Библиотека для работы с Bitrix24: живая лента, задачи, файлы и личные сообщения

 

 Мой GitHub:    https://gitub.com/Bayselonarrend 
 OpenYellow:    https://openyellow.org
 Лицензия MIT:  https://mit-license.org