Pachca (beta)

automation Communication

v2.0.14

Last updated Jul 7, 2026

Pachca node for n8n workflow automation

108 Weekly Downloads

988 Monthly Downloads

View on NPM GitHub Repository

Included Nodes

Pachca (beta)

Description

Пачка API

![CI](https://github.com/pachca/openapi/actions/workflows/check.yml)
![npm](https://www.npmjs.com/package/@pachca/sdk)
![npm](https://www.npmjs.com/package/@pachca/cli)
![npm](https://www.npmjs.com/package/@pachca/generator)
![npm](https://www.npmjs.com/package/n8n-nodes-pachca)
![PyPI](https://pypi.org/project/pachca-sdk/)
![License: MIT](LICENSE)

Unified Developer Experience Platform для Pachca API — API корпоративного мессенджера Пачка. Один источник (TypeSpec + workflows.ts + examples.ts) генерирует артефакты для всех каналов: web docs, CLI, SDK, n8n node, agent skills, LLM context.

Документация: https://dev.pachca.com · OpenAPI: https://dev.pachca.com/openapi.yaml · Авторизация: https://dev.pachca.com/api/authorization · Changelog: https://dev.pachca.com/updates · Postman/Bruno: https://dev.pachca.com/pachca.postman_collection.json

CLI

Zero-install (npx)
npx @pachca/cli messages create --entity-id=123 --content="Привет!" --token $PACHCA_TOKEN
For regular use
npm install -g @pachca/cli
pachca auth login
pachca messages create --entity-id=123 --content="Привет!"
pachca guide "отправить сообщение"  # CLI guide
Встроенный справочник по API прямо в терминале (для агентов)
pachca api ls                          # список всех эндпоинтов
pachca api POST /messages --describe   # параметры, тело, пример
pachca api POST /messages -f message[content]="Привет"  # прямой запрос

Все методы API доступны как команды. Типизированные флаги, валидация, 4 формата вывода (table, JSON, YAML, CSV), курсорная пагинация, несколько профилей авторизации, неинтерактивный режим для CI и AI-агентов. Команда pachca api — прямые запросы к любому методу и встроенный справочник по API (ls, --describe, --spec, --docs) из той же OpenAPI-спеки: агенту не нужно открывать сайт документации.

Документация: https://dev.pachca.com/guides/cli

Agent Skills

AI-агенты используют CLI-first скиллы с пошаговыми сценариями, zero-friction авторизацией и автоматической проверкой прав.

Установка (40+ агентов)

npx skills add pachca/openapi

Совместимость

Доступные скиллы

Как скиллы помогают агенту

Без скилла — агент не знает порядок вызовов:

> Отправь файл report.pdf в тред сообщения 123
Агент: POST /messages с file=@report.pdf  ← неверно, файлы не передаются inline

Со скиллом — агент выполняет CLI-команды по сценарию:

> Отправь файл report.pdf в тред сообщения 123
1. pachca uploads create --file-name=report.pdf --file-size=...
2. curl  -F ... (загрузка на S3)
3. pachca threads create --message-id=123
4. pachca messages create --entity-type=thread --entity-id= --files='[{"key":"..."}]'

Скиллы генерируются автоматически из OpenAPI-спеки при bun turbo build. Устанавливайте только из официального репозитория — скиллы содержат исключительно инструкции (нет исполняемого кода).

n8n

Community node для n8n — 18 ресурсов, 65+ операций, Pachca Trigger с авторегистрацией вебхука.

В n8n: Settings > Community Nodes > n8n-nodes-pachca
npm install n8n-nodes-pachca

Автоматически генерируется из OpenAPI-спецификации, полная обратная совместимость с v1.

Документация: dev.pachca.com/guides/n8n · README

SDK

Все SDK следуют единому паттерну: PachcaClient(token) → client.service.method(request).

Конвенции:

Вход: path-параметры и body-поля (если ≤2) разворачиваются в аргументы метода. Иначе — один объект-запрос.
Выход: если ответ API содержит единственное поле data, SDK возвращает его содержимое напрямую.
Имена сервисов, методов и полей соответствуют operationId и параметрам из OpenAPI.

Пример (TypeScript):

import { PachcaClient } from "@pachca/sdk";const pachca = new PachcaClient("YOUR_TOKEN");
const users = await pachca.users.listUsers();
await pachca.reactions.addReaction(messageId, { code: "👍" }); // ≤2 поля → аргументы

SDK генерируются из openapi.yaml и публикуются автоматически при пуше в main: генерация → коммит chore: regenerate SDK v{VERSION} → теги → npm, PyPI, JitPack. Swift и Go — через Git-теги.

Генератор

Вместо готового SDK можно сгенерировать типизированный клиент прямо в своём проекте:

npx @pachca/generator --output ./generated --lang typescript
npx @pachca/generator --output ./generated --lang typescript,python,go,kotlin,swift,csharp

Документация: https://dev.pachca.com/guides/sdk/overview

Тестирование

AI-интеграции

| Файл | Содержимое |
|——|————|
| /llms.txt | Краткий индекс: все endpoint’ы со ссылками + карта строк |
| /llms-full.txt | Полная документация: гайды + endpoint’ы с параметрами |
| /llms-en.txt | Английская версия полной документации (для Context7) |
| /skill.md | AI-agent skill: workflows, capabilities, ссылки |
| /workflows.arazzo.yaml | Многошаговые сценарии API в формате Arazzo 1.0.1 |
| /api/{section}/{action}.md | Отдельный .md для каждого endpoint’а и гайда |
| <любая страница>.md | Markdown-версия любой страницы (или заголовок Accept: text/markdown) |
| /.well-known/agent-skills/index.json | Discovery-индекс Agent Skills (Cloudflare RFC) |

Context7 — AI-native document discovery. Через CLI справочник по API доступен и без сайта: pachca api ls, pachca api <МЕТОД> <путь> --describe.

Все файлы доступны с Access-Control-Allow-Origin: *, помечены X-Robots-Tag: noindex и кешируются через CDN.

Разработка

bun install

bun turbo dev # Разработка с hot reload (localhost:3000) bun turbo build # Production сборка bun turbo check # Все проверки (lint + typecheck + knip + format) bun turbo generate # TypeSpec → openapi.yaml + SDK

CI/CD

Контакты

GitHub Issues

support@pachca.com · team@pachca.com

—

Для мейнтейнеров: архитектура и внутреннее устройство

Процесс разработки

Канонические доки (читать перед соответствующей задачей; AGENTS.md ссылается на них):

CONTRIBUTING.md — раскладка, пайплайн генерации, build/check, workflow веток и PR

docs/api-audit.md — аудит API и синхронизация с бэкендом (запускается на «проверь API»), bump версий и changelog’ов

docs/updates-format.md — правила updates.mdx / releases.json / changelog (нарушение ломает парсер страницы обновлений)

docs/docs-conventions.md — конвенции MDX/TypeSpec, регистрация компонентов в трёх местах, заголовки

Структура монорепозитория

├── apps/
│   └── docs/              # Next.js 16 сайт документации (@pachca/docs)
├── packages/
│   ├── spec/              # TypeSpec спецификация + workflows.ts + examples.ts (@pachca/spec)
│   ├── generator/         # SDK код-генератор для 6 языков (@pachca/generator)
│   ├── openapi-parser/    # Парсер OpenAPI-спеки (@pachca/openapi-parser)
│   └── cli/               # CLI для работы с API (@pachca/cli)
├── sdk/                   # SDK для 6 языков (генерируются @pachca/generator)
│   ├── typescript/        # npm
│   ├── python/            # PyPI
│   ├── go/                # Go modules
│   ├── kotlin/            # JitPack
│   ├── swift/             # SPM
│   └── csharp/            # NuGet
├── integrations/
│   └── n8n/               # n8n community node (генерируется из OpenAPI)
├── skills/                # Agent Skills (генерируются → apps/docs/public/.well-known/skills/)
├── docs/                  # Канонические процесс-доки (api-audit, updates-format, docs-conventions)
├── CONTRIBUTING.md        # Раскладка, пайплайн генерации, build/check, workflow
├── AGENTS.md              # Гайд для AI-агентов по работе с репозиторием (CLAUDE.md → симлинк)
├── .github/workflows/     # CI/CD (check, sdk, generator, n8n, deploy, gitlab)
├── Package.swift          # Корневой Swift Package (копируется из sdk/swift при CI)
├── jitpack.yml            # JitPack конфиг для Kotlin (JDK 17)
├── Dockerfile             # Multi-stage Docker-сборка docs
├── context7.json          # Context7 AI document discovery
├── turbo.json             # Turborepo пайплайн
└── package.json           # Корневой (workspaces: apps/, apps//, packages/, sdk/, integrations/)

Пайплайн данных

typespec.tsp (packages/spec) │ │ tsp compile ▼ openapi.yaml ──────────────────────────┬──────────────────────┐ │ │ │ │ overlay:apply ▼ ▼ ▼ sdk/* (6 языков) integrations/n8n openapi.en.yaml │ │ │ │ CI: generate │ generate-n8n │ │ + publish ▼ │ ▼ npm (n8n-nodes-pachca) │ npm, PyPI, JitPack, │ SPM, Go modules ▼ apps/docs │ │ generate-llms, generate-cli, next build ▼ Сайт + llms.txt + llms-full.txt + llms-en.txt + skill.md + per-endpoint и per-guide .md + workflows.arazzo.yaml (Arazzo 1.0.1) + Agent Skills (skills/, AGENTS.md, .well-known/{skills,agent-skills}/) + scenarios.json + pachca.postman_collection.json + CLI examples (10-й код-генератор) + OG-изображения + sitemap + RSS

workflows.ts + examples.ts (packages/spec — единый источник сценариев) │ ├──→ Web (страница сценариев с поиском) ├──→ CLI (pachca guide) ├──→ Skills (CLI-сценарии в SKILL.md) └──→ n8n (примеры значений в нодах)

Turborepo пайплайн

| Задача | Зависит от | Кешируется |
|——–|————|————|
| setup | — | нет |
| generate | setup | да (inputs: tsp + yaml config → outputs: openapi.yaml, generated/) |
| overlay:apply | @pachca/spec#generate | да (→ openapi.en.yaml) |
| overlay:validate | @pachca/spec#generate, overlay:apply | да |
| generate-llms | @pachca/spec#generate | да (→ llms.txt, llms-full.txt, skill.md, *.md, Agent Skills) |
| generate-cli | @pachca/spec#generate | да (→ CLI commands, data/*.json) |
| generate-n8n | @pachca/spec#generate, overlay:apply | да (→ n8n nodes, credentials) |
| test | generate-cli, generate-n8n | да |
| build | generate, overlay:apply, generate-llms, generate-cli, generate-n8n | да (→ .next/, dist/) |
| dev | @pachca/spec#generate, generate-llms | нет (persistent) |
| check | lint, typecheck, knip, format:check, test, overlay:validate | нет |
| check-urls | @pachca/spec#generate | да |
| start | build | нет (persistent) |

Архитектура docs (apps/docs)

Next.js 16 (App Router, Turbopack) + MDX + FlexSearch (+ русские синонимы/стемминг) + Shiki + Mermaid + GSAP.

Всё динамическое — навигация, маршруты, поиск, примеры кода генерируются из OpenAPI.

Что генерируется автоматически

Маршрутизация

| URL | Источник |
|—–|———-|
| / | content/home.mdx |
| /guides/{slug} | content/guides/{slug}.mdx |
| /guides/{category}/{slug} | content/guides/{category}/{slug}.mdx |
| /api/{slug} | content/api/{slug}.mdx (авторизация, пагинация и др.) |
| /api/{section}/{action} | OpenAPI endpoint (динамически из тегов и путей) |
| /api/{section}/{action}.md | Статический markdown для endpoint’а |
| /updates | content/updates.mdx |
| /updates/{date} | Обновление за конкретную дату |
| /guides/{slug}.md | Статический markdown для гайда |
| /.md | Rewrite → /index.md |
| /api/og | Генерация OG-изображений |
| /api/search | API поиска |
| /feed.xml | RSS-лента обновлений |
| /sitemap.xml | Карта сайта |
| /openapi.yaml | OpenAPI спецификация |
| /pachca.postman_collection.json | Postman/Bruno коллекция |

URL маппинг

| Паттерн | URL | Пример |
|———|—–|——–|
| GET /items | /api/{section}/list | /api/messages/list |
| POST /items | /api/{section}/create | /api/messages/create |
| GET /items/{id} | /api/{section}/get | /api/users/get |
| PUT /items/{id} | /api/{section}/update | /api/chats/update |
| DELETE /items/{id} | /api/{section}/delete | /api/chats/delete |
| Sub-resources | /api/{section}/list-{sub} | /api/messages/list-reactions |
| Специальные | По действию | /api/messages/pin, /api/messages/unpin |

Секция определяется из OpenAPI-тега через tagToUrlSegment(). Скрипт check-url-conflicts.mjs проверяет конфликты.

Поиск

FlexSearch с tokenize: 'forward'. Русский язык: синонимы (участники → members, users), стемминг (участников → участник), стоп-слова, action patterns (отправить → create/post).

Ссылки на API методы в тексте

Список сотрудников
Новое сообщение

Ссылки резолвятся в реальные URL и рендерятся с method-badge.

Требования к методам (x-requirements)

Ограничения эндпоинтов описываются через @extension("x-requirements", ...) в TypeSpec.
Попадают в OpenAPI YAML как x-requirements и рендерятся в трёх местах: в UI как бейджи, в Agent Skills рядом с каждой операцией, в per-endpoint .md-файлах.

Поля:

scope — требуемый скоуп токена (например "messages:read")

plan — требуемый тариф (например "corporation")

auth — false если авторизация не нужна

MDX компоненты

Регистрируются в components/mdx/mdx-components.tsx и components/api/markdown-content.tsx.



Информация
Предупреждение
Опасно
Описание




graph TD; A-->B;} />

Как добавить новый гайд

Создайте content/guides/{slug}.mdx (или content/guides/{category}/{slug}.mdx, content/api/{slug}.mdx) с frontmatter:

---
title: Название гайда
description: Краткое описание для SEO
---

Добавьте путь в lib/tabs-config.ts → гайд появится в навигации, поиске, llms.txt, RSS и получит .md-файл.

Обновление API (changelog)

Создайте файл content/updates/<ГГГГ-ММ-ДД>.md (один файл на дату) с frontmatter и markdown-телом:

---
date: "2025-12-01"
title: "Название обновления"
---
Новый метод

Badge «Новое» показывается < 7 дней. Попадает в RSS feed. Полные правила — docs/updates-format.md.

Кастомная схема для гайда

Создайте lib/schemas/guides/{Name}.json → используйте . Индексируется для поиска и попадает в llms-full.txt.

Настройки

lib/display-config.ts — showSchemaExamples (по умолчанию false)

redirects.ts — permanent (308) редиректы

Безопасность (next.config.ts)

HSTS (2 года, preload), X-Frame-Options: DENY, nosniff, Permissions-Policy. CORS разрешён для llms.txt, llms-full.txt, skill.md, .md, /.well-known/skills/, openapi.yaml, pachca.postman_collection.json, scenarios.json.