Пакеты
Документация npm-пакетов экосистемы Integ.
Обзор
Экосистема Integ состоит из нескольких npm-пакетов, каждый из которых решает определённую задачу:
mermaid
graph TB
subgraph "Core Packages"
Core[@integ/core]
Types[@integ/types]
end
subgraph "Integration Packages"
Telegram[@integ/telegram]
Slack[@integ/slack]
end
subgraph "Utility Packages"
Utils[@integ/utils]
CLI[@integ/cli]
end
Core --> Types
Telegram --> Core
Slack --> Core
CLI --> Core
Utils --> TypesДоступные пакеты
Core
| Пакет | Версия | Описание |
|---|---|---|
| @integ/core | 1.x | Основной клиент для работы с API |
| @integ/types | 1.x | TypeScript типы и интерфейсы |
Интеграции
| Пакет | Версия | Описание |
|---|---|---|
| @integ/telegram | 1.x | Telegram клиент |
| @integ/slack | 🚧 WIP | Slack клиент |
Утилиты
| Пакет | Версия | Описание |
|---|---|---|
| @integ/utils | 1.x | Вспомогательные функции |
| @integ/cli | 📋 Planned | CLI инструменты |
Добавление нового пакета
Используйте шаблон документации для создания документации нового пакета.
Быстрый старт
Установка core пакета
bash
npm install @integ/coreБазовое использование
typescript
import { IntegClient } from "@integ/core";
const client = new IntegClient({
accessToken: process.env.INTEG_ACCESS_TOKEN
});
// Получить список интеграций
const integrations = await client.integrations.list();
// Отправить сообщение через интеграцию
const result = await client.telegram.send({
chatId: "123456789",
text: "Hello from Integ!"
});Версионирование
Все пакеты следуют Semantic Versioning:
- MAJOR (1.x.x → 2.x.x) - несовместимые изменения API
- MINOR (1.1.x → 1.2.x) - новые функции (обратно совместимые)
- PATCH (1.1.1 → 1.1.2) - исправления багов
Совместимость
| Node.js | TypeScript | Статус |
|---|---|---|
| 18.x | 5.0+ | ✅ Supported |
| 20.x | 5.0+ | ✅ Supported |
| 22.x | 5.0+ | ✅ Supported |
Установка всех пакетов
bash
# Установить все основные пакеты
npm install @integ/core @integ/types
# Установить интеграцию Telegram
npm install @integ/telegram
# Или всё сразу
npm install @integ/core @integ/telegramСтруктура документации пакета
Каждый пакет документируется по стандартному шаблону:
- Установка - как установить пакет
- Быстрый старт - минимальный рабочий пример
- Конфигурация - опции и настройки
- API Reference - все экспорты (классы, функции, типы)
- Примеры - практическое использование
- Changelog - история изменений
- Troubleshooting - решение проблем