# OmniRoute Codebase Documentation (Українська)

🌐 **Languages:** 🇺🇸 [English](../../../../architecture/CODEBASE_DOCUMENTATION.md) · 🇪🇹 [am](../../../am/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇸🇦 [ar](../../../ar/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇦🇿 [az](../../../az/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇧🇬 [bg](../../../bg/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇧🇩 [bn](../../../bn/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇧🇦 [bs](../../../bs/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇨🇿 [cs](../../../cs/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇩🇰 [da](../../../da/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇩🇪 [de](../../../de/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇬🇷 [el](../../../el/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇪🇸 [es](../../../es/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇪🇪 [et](../../../et/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇷 [fa](../../../fa/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇫🇮 [fi](../../../fi/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇫🇷 [fr](../../../fr/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇪 [ga](../../../ga/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [gu](../../../gu/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇳🇬 [ha](../../../ha/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇱 [he](../../../he/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [hi](../../../hi/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇭🇷 [hr](../../../hr/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇭🇺 [hu](../../../hu/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇦🇲 [hy](../../../hy/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇩 [id](../../../id/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇳🇬 [ig](../../../ig/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇹 [it](../../../it/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇯🇵 [ja](../../../ja/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇬🇪 [ka](../../../ka/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇰🇭 [km](../../../km/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [kn](../../../kn/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇰🇷 [ko](../../../ko/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇱🇹 [lt](../../../lt/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇱🇻 [lv](../../../lv/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [ml](../../../ml/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [mr](../../../mr/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇲🇾 [ms](../../../ms/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇲🇹 [mt](../../../mt/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇲🇲 [my](../../../my/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇳🇵 [ne](../../../ne/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇳🇱 [nl](../../../nl/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇳🇴 [no](../../../no/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [or](../../../or/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [pa](../../../pa/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇵🇭 [phi](../../../phi/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇵🇱 [pl](../../../pl/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇵🇹 [pt](../../../pt/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇧🇷 [pt-BR](../../../pt-BR/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇷🇴 [ro](../../../ro/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇷🇺 [ru](../../../ru/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇱🇰 [si](../../../si/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇸🇰 [sk](../../../sk/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇸🇮 [sl](../../../sl/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇷🇸 [sr](../../../sr/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇸🇪 [sv](../../../sv/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇰🇪 [sw](../../../sw/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [ta](../../../ta/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇮🇳 [te](../../../te/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇹🇭 [th](../../../th/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇹🇷 [tr](../../../tr/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇵🇰 [ur](../../../ur/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇺🇿 [uz](../../../uz/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇻🇳 [vi](../../../vi/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇳🇬 [yo](../../../yo/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇨🇳 [zh-CN](../../../zh-CN/docs/architecture/CODEBASE_DOCUMENTATION.md) · 🇹🇼 [zh-TW](../../../zh-TW/docs/architecture/CODEBASE_DOCUMENTATION.md)

---

> **Версія:** v3.8.51
> **Останнє оновлення:** 2026-06-28
> **Аудиторія:** Інженери, які роблять внесок в OmniRoute або створюють інтеграції на його основі.
>
> Високорівневі архітектурні діаграми та обґрунтування кожної підсистеми наведено у
> [ARCHITECTURE.md](./ARCHITECTURE.md). Докладний опис окремих підсистем
> (Auto Combo, сервер MCP, сервер A2A, навички, пам’ять, хмарні агенти, відмовостійкість,
> стиснення тощо) наведено у відповідних файлах у цьому каталозі `docs/`.

У цьому файлі описано **те, що наразі існує в репозиторії**, щоб новий інженер
міг орієнтуватися в дереві, розуміти рівні середовища виконання та знати, куди додавати код,
не створюючи нових модулів.

---

## 1. Технологічний стек

| Аспект                | Вибір                                                                                                                                    |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Вебфреймворк          | **Next.js 16** (App Router, автономний вихідний пакет, без глобального проміжного ПЗ)                                                    |
| Мова                  | **TypeScript 6.0+** — ціль `ES2022`, `module: esnext`, `moduleResolution: bundler`, `strict: false`                                      |
| Середовище виконання  | **Node.js** `>=22.22.2 <23` або `>=24.0.0 <27` (забезпечується через `engines` + `SUPPORTED_NODE_RANGE`)                                 |
| База даних            | **SQLite** через `better-sqlite3` (єдиний екземпляр, журналювання WAL)                                                                   |
| Настільний застосунок | **Electron 41** + `electron-builder` 26.10 (окремий робочий простір у `electron/`)                                                       |
| Тести                 | **Вбудований засіб запуску тестів Node** (модульні/інтеграційні), **Vitest** (MCP, autoCombo, кеш), **Playwright** (e2e + protocols-e2e) |
| Збірка                | Автономна збірка Next.js через `scripts/build/build-next-isolated.mjs`                                                                   |
| Лінтинг/форматування  | Плоска конфігурація ESLint + Prettier (`lint-staged` через Husky перед комітом)                                                          |
| Система модулів       | ESM усюди (`"type": "module"`)                                                                                                           |
| Робочі простори       | Робочий простір npm — `open-sse` є єдиним вкладеним робочим простором                                                                    |

Псевдоніми шляхів (`tsconfig.json`):

- `@/*` → `src/*`
- `@omniroute/open-sse` → `open-sse/index.ts`
- `@omniroute/open-sse/*` → `open-sse/*`

Стандартний порт HTTP: **`20128`** (API та панель керування використовують один процес). Каталог
даних задається змінною середовища `DATA_DIR`, зі стандартним значенням `~/.omniroute/`.

---

## 2. Структура репозиторію

```
OmniRoute/
├── src/                  Застосунок Next.js (App Router, бібліотеки, домен, сервер, спільні компоненти)
├── open-sse/             Робочий простір потокового рушія (@omniroute/open-sse)
├── electron/             Обгортка настільного застосунку (основний процес Electron 41 + попереднє завантаження)
├── bin/                  Точки входу CLI (omniroute, reset-password)
├── tests/                Модульні, інтеграційні, e2e, protocols-e2e, транслятор, безпека, фікстури
├── scripts/              Допоміжні скрипти для збірки, синхронізації, перевірки, міграції та виконання
├── docs/                 Загальнодоступна документація (цей каталог)
├── public/               Статичні ресурси, маніфест PWA, сервіс-воркер
├── config/               Приклади конфігурації середовища виконання
├── images/               Маркетингові ресурси/знімки екрана
├── _ideia/, _references/, _mono_repo/, _tasks/   Внутрішні чернетки / планування (не постачаються)
├── CLAUDE.md             Правила репозиторію для Claude Code
├── AGENTS.md             Докладніший довідник з архітектури для агентів
├── package.json          v3.8.51, корінь робочого простору
└── tsconfig.json         Псевдоніми шляхів + основні параметри компілятора
```

---

## 3. `src/` — застосунок Next.js

```
src/
├── app/                  Сторінки App Router і маршрути API
├── lib/                  Основні бібліотеки (БД, автентифікація, OAuth, навички, пам’ять, …)
├── domain/               Чистий доменний шар (політики, резервування, вартість, блокування, …)
├── server/               Модулі лише для сервера (авторизація, CORS, автентифікація)
├── shared/               Типи, константи, валідація, контракти, утиліти (безпечні для використання між межами)
├── mitm/                 Допоміжні засоби проксі «людина посередині» для інтеграції з CLI
├── models/               Метадані й псевдоніми локальних моделей
├── sse/                  Застарілі обробники SSE, які досі розміщені в src/ (не open-sse/)
├── store/                Клієнтські сховища стану
├── middleware/           Утиліти проміжного ПЗ на рівні маршрутів (не глобальне проміжне ПЗ Next.js)
├── scripts/              Внутрішні скрипти, які можна імпортувати кодом застосунку
├── types/                Глобальні та спільні типи TS
├── i18n/                 Пакети локалізації
├── instrumentation.ts    Хук інструментування Next.js
├── instrumentation-node.ts
└── proxy.ts              Допоміжний засіб верхнього рівня для ініціалізації проксі
```

### 3.1 `src/app/` — App Router

App Router надає як інтерфейс панелі керування, так і публічний та адміністративний HTTP API.
**Глобального проміжного ПЗ немає** — перехоплення виконується окремо для кожного маршруту.

Сегменти верхнього рівня в `src/app/`:

| Шлях                                                                          | Призначення                                                   |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------- |
| `api/`                                                                        | Усі маршрути HTTP API (див. структуру нижче)                  |
| `a2a/`                                                                        | Кінцева точка A2A JSON-RPC 2.0 (`POST /a2a`)                  |
| `.well-known/agent.json/`                                                     | Документ виявлення Agent Card для A2A                         |
| `(dashboard)/`                                                                | Інтерфейс панелі керування (група маршрутів без префікса URL) |
| `auth/`, `login/`, `forgot-password/`, `callback/`                            | Процеси автентифікації                                        |
| `landing/`                                                                    | Маркетингова/цільова сторінка                                 |
| `docs/`                                                                       | Вбудований засіб перегляду документації API                   |
| `status/`, `maintenance/`, `offline/`                                         | Сторінки робочого стану                                       |
| `privacy/`, `terms/`                                                          | Юридичні сторінки                                             |
| `400/`, `401/`, `403/`, `408/`, `429/`, `500/`, `502/`, `503/`                | Статичні сторінки помилок                                     |
| `error.tsx`, `global-error.tsx`, `not-found.tsx`, `forbidden/`, `loading.tsx` | Межі помилок/завантаження фреймворку                          |
| `layout.tsx`, `page.tsx`, `globals.css`, `manifest.ts`                        | Коренева оболонка                                             |

#### 3.1.1 `src/app/(dashboard)/dashboard/` — сторінки інтерфейсу

`agents`, `analytics`, `api-manager`, `audit`, `auto-combo`, `batch`, `cache`,
`changelog`, `cli-tools`, `cloud-agents`, `combos`, `compression`, `context`,
`costs`, `endpoint`, `health`, `limits`, `logs`, `memory`, `onboarding`,
`playground`, `providers`, `search-tools`, `settings`, `skills`, `system`,
`translator`, `usage`, `webhooks`, а також кореневі `page.tsx`, `HomePageClient.tsx`,
`BootstrapBanner.tsx`.

#### 3.1.2 `src/app/api/` — групи API верхнього рівня

```
src/app/api/
├── a2a/{status, tasks}
├── acp/
├── admin/
├── analytics/
├── assess/
├── auth/
├── batches/
├── cache/
├── cli-tools/
├── cloud/{codex-responses-ws}
├── combos/
├── compliance/
├── compression/
├── context/
├── db/, db-backups/
├── evals/
├── fallback/
├── files/
├── health/
├── init/
├── internal/{concurrency}
├── keys/
├── logs/
├── mcp/{audit, sse, status, stream, tools}
├── memory/{health, [id]/, route.ts}
├── model-combo-mappings/
├── models/
├── monitoring/
├── oauth/
├── openapi/
├── policies/
├── pricing/
├── provider-metrics/, provider-models/, provider-nodes/
├── providers/
├── rate-limit/, rate-limits/
├── resilience/
├── restart/, shutdown/
├── search/
├── sessions/
├── settings/
├── skills/{executions, [id], install, marketplace, route.ts, skillssh}
├── storage/
├── sync/, synced-available-models/
├── system/
├── tags/
├── telemetry/
├── token-health/
├── translator/
├── tunnels/
├── services/   Керування вбудованими службами (9router, cliproxy) — LOCAL_ONLY
├── upstream-proxy/
├── usage/
├── v1/         Публічний API, сумісний з OpenAI
├── v1beta/     Сумісність у стилі Gemini
├── version-manager/
└── webhooks/
```

#### 3.1.2a `src/app/api/services/` — керування вбудованими службами

Маршрути для встановлення, запуску, зупинення та моніторингу 9Router і CLIProxyAPI.
Усі шляхи класифіковано як **LOCAL_ONLY** (лише loopback, суворе правило #17), оскільки вони
можуть викликати `npm install` і породжувати дочірні процеси.

```
src/app/api/services/
├── 9router/
│   ├── _lib.ts             допоміжна функція getOrInitSupervisor()
│   ├── install/route.ts    POST — npm install через execFile
│   ├── start/route.ts      POST — supervisor.start()
│   ├── stop/route.ts       POST — supervisor.stop()
│   ├── restart/route.ts    POST — supervisor.restart()
│   ├── update/route.ts     POST — npm install новішої версії
│   ├── rotate-key/route.ts POST — створення нового ключа API + перезапуск
│   ├── status/route.ts     GET  — поточний стан + стан у БД + метадані версії
│   └── auto-start/route.ts POST — перемикання прапорця auto_start
├── cliproxy/
│   ├── _lib.ts             допоміжна функція getOrInitSupervisor()
│   ├── install/route.ts    POST — npm install
│   ├── start/route.ts      POST — supervisor.start()
│   ├── stop/route.ts       POST — supervisor.stop()
│   ├── restart/route.ts    POST — supervisor.restart()
│   ├── update/route.ts     POST — npm install новішої версії
│   ├── status/route.ts     GET  — поточний стан + стан у БД + метадані версії
│   └── auto-start/route.ts POST — перемикання прапорця auto_start
└── [name]/
    └── logs/route.ts       GET  — потік журналу через SSE (спільний для всіх сервісів)
```

Відповідний інтерфейс панелі керування:
`src/app/(dashboard)/dashboard/providers/services/` — сторінка з двома вкладками (CLIProxyAPI + 9Router).
Зворотний проксі для вбудованого інтерфейсу 9Router:
`src/app/(dashboard)/dashboard/providers/services/[name]/embed/[[...path]]/route.ts`

Докладний огляд: `docs/frameworks/EMBEDDED-SERVICES.md`

#### 3.1.3 `src/app/api/v1/` — публічний API, сумісний з OpenAI

```
v1/
├── accounts/[id]/                       пошук облікового запису
├── agents/tasks/[id]/, agents/tasks/    кінцеві точки завдань у стилі A2A
├── api/                                 внутрішні допоміжні API, доступні через v1/api
├── audio/{speech, transcriptions}/      TTS + STT
├── batches/[id]/{cancel}, batches/      OpenAI Batches API
├── chat/completions/                    Chat Completions (основна кінцева точка)
├── completions/                         застарілі текстові доповнення
├── embeddings/                          векторні представлення
├── files/[id]/, files/                  Files API
├── _helpers/                            спільні допоміжні функції маршрутів (без публічної URL-адреси)
├── images/{edits, generations}/         генерування + редагування зображень
├── issues/                              допоміжні кінцеві точки сортування
├── management/{proxies}/                маршрути керування всередині v1
├── messages/{count_tokens}/             сумісність із повідомленнями у стилі Anthropic
├── models/                              перелік моделей (`route.ts`, `catalog.ts`)
├── moderations/                         модерація
├── music/                               генерування музики
├── providers/[provider]/                операції окремих провайдерів
├── quotas/{check}                       перевірки квот
├── registered-keys/                     адміністрування зареєстрованих ключів
├── rerank/                              повторне ранжування
├── responses/[...path]/                 OpenAI Responses API (маршрут-перехоплювач)
├── search/                              вебпошук
├── videos/                              генерування відео
├── ws/                                  міст WebSocket
└── route.ts                             обробник індексу
```

Кожен файл маршруту дотримується однакового шаблону:

```
Маршрут → попередній CORS-запит → валідація тіла за допомогою Zod → необов’язкова автентифікація
        → застосування політики ключів API → делегування обробнику (open-sse)
```

`v1beta/` — це поверхня сумісності у стилі Gemini (тонка обгортка, яка перетворює запити для
того самого конвеєра `open-sse/handlers/`).

### 3.2 `src/lib/` — основні бібліотеки

Завжди імпортуйте дані, синхронізацію, OAuth, навички, пам’ять тощо через ці модулі.
У таблиці згруповано фактичні каталоги та важливі файли верхнього рівня.

| Модуль            | Призначення                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `a2a/`            | Сервер протоколу A2A: `taskManager.ts`, `streaming.ts`, `taskExecution.ts`, `routingLogger.ts`, `skills/` (6 навичок: аналіз витрат, звіт про стан, виявлення провайдерів, керування квотами, інтелектуальна маршрутизація, перелік можливостей)                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `acp/`            | Agent-Control-Protocol: `index.ts`, `manager.ts`, `registry.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `api/`            | Внутрішні допоміжні засоби API: `requireManagementAuth.ts`, `requireCliToolsAuth.ts`, `errorResponse.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `auth/`           | `managementPassword.ts` (скидання пароля / хешування)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `batches/`        | Сервіс OpenAI Batches API (`service.ts`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `catalog/`        | Синхронізація каталогу OpenRouter (`openrouterCatalog.ts`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `cloudAgent/`     | Реєстр хмарних агентів: `api.ts`, `baseAgent.ts`, `db.ts`, `index.ts`, `registry.ts`, `types.ts`, `agents/{codex, devin, jules}.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `combos/`         | Допоміжні засоби розв’язання комбінацій                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `compliance/`     | Аудит + аудит провайдерів: `index.ts`, `providerAudit.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `config/`         | Інтеграційний шар конфігурації середовища виконання                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `db/`             | Доменні модулі SQLite (див. §3.2.1)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `display/`        | Допоміжні засоби інтерфейсу/відображення, що використовуються у відповідях API                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `embeddings/`     | Реєстр сервісів векторних представлень                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `env/`            | Завантаження + інтроспекція змінних середовища                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `evals/`          | Середовище виконання оцінювань                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `guardrails/`     | `piiMasker.ts`, `promptInjection.ts`, `visionBridge.ts`, `visionBridgeHelpers.ts`, `registry.ts`, `base.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `jobs/`           | Фонові завдання (`autoUpdate.ts`, …)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `memory/`         | Постійна пам’ять: `store.ts`, `cache.ts`, `retrieval.ts`, `summarization.ts`, `extraction.ts`, `injection.ts`, `qdrant.ts`, `settings.ts`, `verify.ts`, `schemas.ts`, `types.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `monitoring/`     | `observability.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `oauth/`          | Модулі OAuth/імпорту провайдерів (22): `agy`, `antigravity`, `claude`, `cline`, `codebuddy-cn`, `codex`, `cursor`, `devin-desktop`, `ghe-copilot`, `github`, `gitlab-duo`, `grok-cli-oauth`, `grok-cli`, `kilocode`, `kimi-coding`, `kiro`, `openference`, `qoder`, `trae`, `xai-oauth`, `zed-hosted`, `zed`, а також `services/`, `utils/` і `constants/oauth.ts`                                                                                                                                                                                                                                                                                                                                             |
| `plugins/`        | Завантажувач плагінів (`index.ts`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `promptCache/`    | `prefixAnalyzer.ts`, `index.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `providerModels/` | Керування життєвим циклом моделей: `modelDiscovery.ts`, `managedModelImport.ts`, `managedAvailableModels.ts`, `cursorAgent.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `providers/`      | Допоміжні засоби провайдерів: `catalog.ts`, `validation.ts`, `imageValidation.ts`, `claudeExtraUsage.ts`, `codexConnectionDefaults.ts`, `codexFastTier.ts`, `webCookieAuth.ts`, `managedAvailableModels.ts`, `requestDefaults.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `resilience/`     | `settings.ts` — налаштування автоматичного вимикача, періоду очікування та блокування                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `runtime/`        | Виявлення функцій середовища виконання                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `search/`         | `executeWebSearch.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `services/`       | Фреймворк вбудованих сервісів: `ServiceSupervisor.ts` (універсальний супервізор дочірніх процесів із блокуванням операцій, кільцевим буфером і перевіркою стану), `bootstrap.ts` (реєстрація на рівні процесу та автоматичний запуск), `registry.ts` (зіставлення інструмент → супервізор), `apiKey.ts` (сховище ключів AES-256-GCM), `modelSync.ts` (періодична синхронізація моделей), `ringBuffer.ts` (кільцевий буфер журналу на 5 МБ), `healthCheck.ts` (HTTP-перевірка стану), `types.ts`, `embedWsProxy.ts` (проксі WebSocket), `installers/{ninerouter,cliproxy}.ts`. Див. `docs/frameworks/EMBEDDED-SERVICES.md`                                                                                      |
| `agentSkills/`    | Каталог + генератор навичок агентів: `catalog.ts` (getCatalog/getSkillById/filterCatalog/computeCoverage), `generator.ts` (generateAgentSkills → записує `skills/{id}/SKILL.md`), `openapiParser.ts` (видобуває кінцеві точки REST зі специфікації OpenAPI), `cliRegistryParser.ts` (видобуває підкоманди CLI з bin/cli-registry), `schemas.ts` (Zod: AgentSkillSchema, SkillCoverageSchema, ListQuerySchema, GenerateBodySchema), `types.ts` (AgentSkill, SkillCoverage, SkillMarkdown, GeneratorReport). Використовується маршрутами REST (`/api/agent-skills/*`), інструментами MCP (`omniroute_agent_skills_*`) і навичкою A2A `list-capabilities`. Див. [AGENT-SKILLS.md](../frameworks/AGENT-SKILLS.md). |
| `skills/`         | Фреймворк навичок: `registry.ts`, `executor.ts`, `interception.ts`, `injection.ts`, `sandbox.ts`, `custom.ts`, `hybrid.ts`, `builtins.ts`, `a2a.ts`, `providerSettings.ts`, `schemas.ts`, `skillssh.ts`, `types.ts`, а також `builtin/browser.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `spend/`          | `batchWriter.ts` (буфер відкладеного запису)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `sync/`           | `bundle.ts`, `tokens.ts` (хмарна синхронізація)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `system/`         | Допоміжні засоби системного рівня                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `translator/`     | Інтеграційний шар транслятора верхнього рівня (делегує до `open-sse/translator/`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `usage/`          | Облік використання: `costCalculator.ts`, `tokenAccounting.ts`, `usageHistory.ts`, `aggregateHistory.ts`, `usageStats.ts`, `callLogs.ts`, `callLogArtifacts.ts`, `fetcher.ts`, `providerLimits.ts`, `migrations.ts`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `versionManager/` | Автоматичне оновлення + маніфест версій                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `ws/`             | Міст WebSocket                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `zed-oauth/`      | Процес OAuth редактора Zed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

Файли верхнього рівня в `src/lib/`:

- Старий барельний файл `localDb.ts` видалено — споживачі імпортують конкретні модулі `src/lib/db/*` безпосередньо.
- `proxyHealth.ts`, `proxyLogger.ts`, `tokenHealthCheck.ts`, `localHealthCheck.ts`
- `apiBridgeServer.ts`, `cacheLayer.ts`, `semanticCache.ts`, `settingsCache.ts`
- `cloudSync.ts`, `initCloudSync.ts`
- `cloudflaredTunnel.ts`, `ngrokTunnel.ts`, `tailscaleTunnel.ts`
- `consoleInterceptor.ts`, `container.ts`, `gracefulShutdown.ts`, `idempotencyLayer.ts`
- `ipUtils.ts`, `logEnv.ts`, `logPayloads.ts`, `logRotation.ts`
- `modelAliasSeed.ts`, `modelCapabilities.ts`, `modelMetadataRegistry.ts`, `modelsDevSync.ts`
- `piiSanitizer.ts`, `pricingSync.ts`
- `apiKeyExposure.ts`, `cacheControlSettings.ts`, `dataPaths.ts`, `toolPolicy.ts`
- `translatorEvents.ts`, `usageDb.ts`, `usageAnalytics.ts`, `webhookDispatcher.ts`

#### 3.2.1 `src/lib/db/`

Одиничний екземпляр бази даних SQLite (`getDbInstance()` у `core.ts`, журналювання WAL).
**Ніколи не пишіть необроблений SQL у маршрутах або обробниках** — використовуйте ці модулі.

![Огляд схеми бази даних (вибрані основні таблиці)](../diagrams/exported/db-schema-overview.svg)

> Джерело: [diagrams/db-schema-overview.mmd](../diagrams/db-schema-overview.mmd)

Доменні модулі (кожен відповідає за одну або кілька таблиць): `apiKeys.ts`, `backup.ts`,
`batches.ts`, `cleanup.ts`, `cliToolState.ts`, `combos.ts`,
`commandCodeAuth.ts`, `compression.ts`, `compressionAnalytics.ts`,
`compressionCacheStats.ts`, `compressionCombos.ts`, `compressionScheduler.ts`,
`contextHandoffs.ts`, `core.ts`, `creditBalance.ts`, `databaseSettings.ts`,
`detailedLogs.ts`, `domainState.ts`, `encryption.ts`, `evals.ts`, `files.ts`,
`healthCheck.ts`, `jsonMigration.ts`, `migrationRunner.ts`,
`modelComboMappings.ts`, `models.ts`, `oneproxy.ts`, `prompts.ts`,
`providers.ts`, `providerLimits.ts`, `proxies.ts`, `quotaSnapshots.ts`,
`readCache.ts`, `reasoningCache.ts`, `registeredKeys.ts`, `secrets.ts`,
`sessionAccountAffinity.ts`, `settings.ts`, `stateReset.ts`, `stats.ts`,
`syncTokens.ts`, `tierConfig.ts`, `upstreamProxy.ts`, `versionManager.ts`,
`webhooks.ts`.

`migrations/` містить 168 версіонованих файлів `.sql` (ідемпотентних і транзакційних), які
виконуються модулем `migrationRunner.ts` під час запуску.

Таблиці, створені всіма міграціями (загалом 123):

`a`, `account_key_limits`, `api_keys`, `batches`, `call_logs`,
`combo_adaptation_state`, `combos`, `command_code_auth_sessions`,
`compression_analytics`, `compression_cache_stats`,
`compression_combo_assignments`, `compression_combos`, `context_handoffs`,
`daily_usage_summary`, `db_meta`, `domain_budgets`, `domain_circuit_breakers`,
`domain_cost_history`, `domain_fallback_chains`, `domain_lockout_state`,
`eval_cases`, `eval_runs`, `eval_suites`, `files`, `hourly_usage_summary`,
`key_value`, `mcp_tool_audit`, `memories`, `model_combo_mappings`,
`provider_connections`, `provider_key_limits`, `provider_nodes`,
`proxy_assignments`, `proxy_logs`, `proxy_registry`, `quota_snapshots`,
`reasoning_cache`, `registered_keys`, `request_detail_logs`,
`routing_decisions`, `semantic_cache`, `session_account_affinity`,
`skill_executions`, `skills`, `sync_tokens`, `tier_assignments`,
`tier_config`, `upstream_proxy_config`, `usage_history`, `version_manager`,
`webhooks` (а також віртуальні таблиці FTS5 для пошуку в пам’яті).

### 3.3 `src/domain/` — Доменний рівень

Чиста бізнес-логіка без операцій введення-виведення. Імпортується маршрутами та обробниками.

| Файл                                       | Призначення                                             |
| ------------------------------------------ | ------------------------------------------------------- |
| `policyEngine.ts`                          | Розв’язувач політик верхнього рівня                     |
| `fallbackPolicy.ts`                        | Дерево рішень резервного переходу                       |
| `costRules.ts`                             | Правила розрахунку вартості                             |
| `lockoutPolicy.ts`                         | Рішення щодо блокування моделей                         |
| `tagRouter.ts`                             | Маршрутизація на основі тегів                           |
| `comboResolver.ts`                         | Розв’язання комбінації із запиту → список цілей         |
| `connectionModelRules.ts`                  | Фільтри моделей для кожного з’єднання                   |
| `modelAvailability.ts`                     | Перевірка доступності моделі                            |
| `degradation.ts`                           | Переходи до режиму обмеженої функціональності           |
| `providerExpiration.ts`                    | Виявлення прострочених облікових записів/ключів         |
| `quotaCache.ts`                            | Кешовані рішення щодо квот                              |
| `responses.ts`, `omnirouteResponseMeta.ts` | Допоміжні засоби для формування структури відповіді     |
| `configAudit.ts`                           | Аудит змін конфігурації                                 |
| `assessment/`                              | Оцінювання моделей (згідно з RFC, реалізовано частково) |
| `types.ts`                                 | Спільні доменні типи                                    |

### 3.4 `src/server/` — Лише для сервера

Не можна імпортувати з клієнтських компонентів.

```
server/
├── auth/loginGuard.ts
├── authz/
│   ├── classify.ts        Класифікує маршрути як публічні або керування
│   ├── assertAuth.ts      Допоміжний засіб перевірки тверджень
│   ├── context.ts         Контекст авторизації для кожного запиту
│   ├── headers.ts
│   ├── pipeline.ts        Конвеєр авторизації
│   ├── policies/          Конкретні політики
│   └── types.ts
└── cors/origins.ts        Список дозволених джерел CORS
```

### 3.5 `src/shared/` — Безпечно для спільного використання

Розділено на спеціалізовані підкаталоги:

- `constants/` — `providers.ts` (каталог провайдерів із валідацією Zod), `models.ts`,
  `modelSpecs.ts`, `modelCompat.ts`, `pricing.ts`, `cliTools.ts`,
  `cliCompatProviders.ts`, `routingStrategies.ts`, `comboConfigMode.ts`,
  `headers.ts`, `upstreamHeaders.ts` (список заборон), `mcpScopes.ts`,
  `errorCodes.ts`, `publicApiRoutes.ts`, `batch.ts`, `batchEndpoints.ts`,
  `bodySize.ts`, `colors.ts`, `appConfig.ts`, `config.ts`,
  `sidebarVisibility.ts`, `visionBridgeDefaults.ts`.
- `validation/` — `schemas.ts` (~80 схем Zod), `compressionConfigSchemas.ts`,
  `providerSchema.ts`, `settingsSchemas.ts`, `helpers.ts`.
- `contracts/` — контракти публічного API, опубліковані в npm.
- `types/` — спільні типи TS.
- `utils/` — `circuitBreaker.ts`, `apiAuth.ts`, `apiKey.ts`, `apiKeyPolicy.ts`,
  `api.ts`, `classify429.ts`, `cliCompat.ts`, `clipboard.ts`, `cloud.ts`, `cn.ts`,
  `cors.ts`, `featureFlags.ts`,
  `fetchTimeout.ts`, `formatting.ts`, `inputSanitizer.ts`, `logger.ts`,
  `machine.ts`, `machineId.ts`, `maskEmail.ts`, `modelCatalogSearch.ts`,
  `nodeRuntimeSupport.ts`, `parseApiKeys.ts`, `providerHints.ts`,
  `providerModelAliases.ts`, `rateLimiter.ts`, `releaseNotes.ts`,
  `a11yAudit.ts`, а також хуки/компоненти панелі керування в `services/`, `network/`,
  `middleware/`, `schemas/`, `hooks/`, `components/`.

---

## 4. `open-sse/` — робочий простір потокового рушія

Окремий робочий простір npm, опублікований як `@omniroute/open-sse`. Відповідає за обробку запитів, виконавці, транслятори, сервіси, трансформер і сервер MCP.

```
open-sse/
├── index.ts                Публічні експорти
├── package.json            Маніфест робочого простору
├── tsconfig.json
├── types.d.ts
├── config/                 Реєстри провайдерів, профілі заголовків, ідентифікація, …
├── handlers/               Обробники запитів (чат, вбудовування, аудіо, зображення, …)
├── executors/              108 HTTP-виконавців для конкретних провайдерів
├── translator/             Перетворення форматів (OpenAI ↔ Claude ↔ Gemini ↔ Cursor ↔ Kiro)
├── transformer/            Трансформер потоків Responses API ↔ Chat Completions
├── services/               Понад 80 сервісних модулів (комбінації, резервування, квоти, ідентифікація, …)
├── utils/                  Допоміжні засоби для потокової передачі, TLS-клієнт, AWS SigV4, проксі-запити, …
└── mcp-server/             Сервер MCP (3 транспорти, 33 області, 110 інструментів)
```

### 4.1 `open-sse/handlers/`

| Обробник                | Призначення                                                                                     |
| ----------------------- | ----------------------------------------------------------------------------------------------- |
| `chatCore.ts`           | Основний конвеєр чату (кеш, обмеження частоти, маршрутизація комбінацій, передавання виконавцю) |
| `responsesHandler.ts`   | Точка входу OpenAI Responses API                                                                |
| `embeddings.ts`         | Вбудовування                                                                                    |
| `imageGeneration.ts`    | Генерування зображень                                                                           |
| `audioSpeech.ts`        | Перетворення тексту на мовлення                                                                 |
| `audioTranscription.ts` | Перетворення мовлення на текст                                                                  |
| `videoGeneration.ts`    | Генерування відео                                                                               |
| `musicGeneration.ts`    | Генерування музики                                                                              |
| `rerank.ts`             | Повторне ранжування                                                                             |
| `moderations.ts`        | Модерація                                                                                       |
| `search.ts`             | Вебпошук                                                                                        |
| `sseParser.ts`          | Парсер подій SSE                                                                                |
| `usageExtractor.ts`     | Вилучення кількості токенів із потоків висхідних серверів                                       |
| `responseSanitizer.ts`  | Видалення специфічного для провайдера шуму                                                      |
| `responseTranslator.ts` | Сполучний шар між відповіддю провайдера та шаром транслятора                                    |

### 4.2 `open-sse/executors/`

108 виконавців провайдерів, кожен із яких розширює `BaseExecutor` (`base.ts`):

`antigravity`, `azure-openai`, `blackbox-web`, `cliproxyapi`,
`chatgpt-web-codex`, `cloudflare-ai`, `codex`, `commandCode`, `cursor`, `default`, `devin-cli`,
`muse-spark-web`, `nlpcloud`, `opencode`, `perplexity-web`, `petals`,
`pollinations`, `qoder`, `vertex`, `devin-desktop`, а також `claudeIdentity.ts`
(спільний допоміжний засіб ідентифікації) та `index.ts` (реєстр).

> Примітка: провайдери, яких тут не перелічено, обслуговуються через `default.ts` за допомогою універсального
> OpenAI-сумісного виконавця. Повний каталог провайдерів (355 провайдерів) міститься у
> `src/shared/constants/providers.ts`.

### 4.3 `open-sse/translator/`

Трансляція за моделлю «центр і промені» (OpenAI є центром).

- **9 трансляторів запитів** (`translator/request/`):
  `antigravity-to-openai`, `claude-to-gemini`, `claude-to-openai`,
  `gemini-to-openai`, `openai-responses`, `openai-to-claude`,
  `openai-to-cursor`, `openai-to-gemini`, `openai-to-kiro`.
- **9 трансляторів відповідей** (`translator/response/`):
  `claude-to-openai`, `cursor-to-openai`, `gemini-to-claude`, `gemini-to-openai`,
  `kiro-to-openai`, `openai-responses`, `openai-to-antigravity`,
  `openai-to-claude`.
- **9 допоміжних засобів** (`translator/helpers/`):
  `claudeHelper`, `geminiHelper`, `geminiToolsSanitizer`, `maxTokensHelper`,
  `openaiHelper`, `responsesApiHelper`, `schemaCoercion`, `toolCallHelper`, а також
  тести допоміжних засобів.
- **Допоміжні засоби для зображень** (`translator/image/sizeMapper.ts`).
- Верхній рівень: `bootstrap.ts`, `formats.ts`, `registry.ts`, `index.ts`.

### 4.4 `open-sse/transformer/`

- `responsesTransformer.ts` — конвертер Responses API ↔ Chat Completions на основі `TransformStream`
  (використовується універсальним маршрутом `responses/`).

### 4.5 `open-sse/services/`

Основні компоненти (повний список у `open-sse/services/`):

| Аспект                 | Файли                                                                                                                                                                                                                                                    |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Маршрутизація Combo    | `combo.ts` (19 стратегій), `comboConfig.ts`, `comboMetrics.ts`, `comboManifestMetrics.ts`, `comboAgentMiddleware.ts`                                                                                                                                     |
| Рушій Auto Combo       | `autoCombo/` — `engine.ts`, `scoring.ts`, `taskFitness.ts`, `virtualFactory.ts`, `modePacks.ts`, `autoPrefix.ts`, `persistence.ts`, `providerDiversity.ts`, `providerRegistryAccessor.ts`, `routerStrategy.ts`, `selfHealing.ts`, `index.ts`             |
| Відмовостійкість       | `accountFallback.ts` (період очікування + блокування), `errorClassifier.ts`, `requestRejectedStreak.ts`, `emergencyFallback.ts`, `rateLimitManager.ts`, `rateLimitSemaphore.ts`, `accountSemaphore.ts`, `accountSelector.ts`                             |
| Квоти                  | `quotaMonitor.ts`, `quotaPreflight.ts`, `bailianQuotaFetcher.ts`, `codexQuotaFetcher.ts`, `deepseekQuotaFetcher.ts`, `openrouterQuotaFetcher.ts`, `openrouterFreeWindow.ts`, `llmgatewayQuotaFetcher.ts`, `crofUsageFetcher.ts`, `antigravityCredits.ts` |
| Кешування              | `reasoningCache.ts`, `searchCache.ts`, `signatureCache.ts`, `requestDedup.ts`                                                                                                                                                                            |
| Інтелект маршрутизації | `intentClassifier.ts`, `taskAwareRouter.ts`, `backgroundTaskDetector.ts`, `volumeDetector.ts`, `wildcardRouter.ts`, `workflowFSM.ts`, `specificityDetector.ts`, `specificityRules.ts`, `specificityTypes.ts`                                             |
| Обробка моделей        | `modelCapabilities.ts`, `modelDeprecation.ts`, `modelFamilyFallback.ts`, `modelStrip.ts`, `model.ts`, `provider.ts`, `providerRequestDefaults.ts`, `providerCostData.ts`, `payloadRules.ts`                                                              |
| Стиснення              | `compression/` — повне підключення рушія стиснення                                                                                                                                                                                                       |
| Токени та сеанси       | `tokenRefresh.ts`, `sessionManager.ts`, `apiKeyRotator.ts`, `contextManager.ts`, `contextHandoff.ts`, `systemPrompt.ts`, `roleNormalizer.ts`, `responsesInputSanitizer.ts`, `toolSchemaSanitizer.ts`, `toolLimitDetector.ts`, `thinkingBudget.ts`        |
| Рівні / маніфест       | `tierResolver.ts`, `tierConfig.ts`, `tierDefaults.json`, `tierTypes.ts`, `manifestAdapter.ts`                                                                                                                                                            |
| IP / мережа            | `ipFilter.ts`, `webSearchFallback.ts`                                                                                                                                                                                                                    |
| Пакетна обробка        | `batchProcessor.ts`                                                                                                                                                                                                                                      |
| Використання           | `usage.ts`                                                                                                                                                                                                                                               |

### 4.6 `open-sse/mcp-server/`

- **110 унікальних інструментів**, підключених у `server.ts` (45 канонічних у `schemas/tools.ts` +
  модулі пам’яті, навичок, GitHub-навичок, пулу, гейміфікації, плагінів, Notion, Obsidian,
  локального корпусу та стиснення — об’єднання підраховується за допомогою `countUniqueMcpTools`).
- **3 транспорти**: stdio, HTTP Streamable, SSE.
- **33 області доступу**, які примусово застосовуються під час виконання — базовий список міститься в `src/shared/constants/mcpScopes.ts`, а повний набір є об’єднанням областей доступу, оголошених кожним модулем інструментів.
- Таблиця аудиту: `mcp_tool_audit` (заповнюється за допомогою `audit.ts`).
- Файли: `server.ts`, `index.ts`, `httpTransport.ts`, `audit.ts`, `scopeEnforcement.ts`,
  `runtimeHeartbeat.ts`, `descriptionCompressor.ts`, `schemas/{tools, a2a, audit, index}.ts`,
  `tools/{advancedTools, compressionTools, memoryTools, skillTools}.ts`,
  а також тести в `__tests__/`.
- Повний каталог інструментів наведено в [MCP-SERVER.md](../frameworks/MCP-SERVER.md).

### 4.7 `open-sse/config/`

Реєстри провайдерів (`providerRegistry.ts`, `providerModels.ts`,
`providerHeaderProfiles.ts`), реєстри моделей для окремих форматів (`audioRegistry.ts`,
`embeddingRegistry.ts`, `imageRegistry.ts`, `moderationRegistry.ts`,
`musicRegistry.ts`, `rerankRegistry.ts`, `searchRegistry.ts`, `videoRegistry.ts`),
допоміжні засоби ідентифікації (`codexIdentity.ts`, `codexInstructions.ts`,
`anthropicHeaders.ts`, `antigravityUpstream.ts`, `antigravityModelAliases.ts`,
`cliFingerprints.ts`, `toolCloaking.ts`, `defaultThinkingSignature.ts`),
допоміжні засоби для облікових даних (`credentialLoader.ts`, `codexClient.ts`) і хмарні
адаптери (`azureAi.ts`, `bedrock.ts`, `datarobot.ts`, `glmProvider.ts`,
`maritalk.ts`, `oci.ts`, `petals.ts`, `runway.ts`, `sap.ts`, `watsonx.ts`,
`ollamaModels.ts`, `errorConfig.ts`, `constants.ts`, `registryUtils.ts`).

### 4.8 `open-sse/utils/`

Примітиви потокового передавання та допоміжні засоби провайдерів: `stream.ts`, `streamHandler.ts`,
`streamHelpers.ts`, `streamPayloadCollector.ts`, `streamReadiness.ts`,
`sseHeartbeat.ts`, `proxyFetch.ts`, `proxyDispatcher.ts`, `tlsClient.ts`,
`networkProxy.ts`, `awsSigV4.ts`, `cacheControlPolicy.ts`,
`cursorChecksum.ts`, `cursorAgentProtobuf.ts`, `cursorVersionDetector.ts`,
`comfyuiClient.ts`, `kieTask.ts`, `bypassHandler.ts`, `aiSdkCompat.ts`,
`thinkTagParser.ts`, `urlSanitize.ts`, `usageTracking.ts`, `requestLogger.ts`,
`progressTracker.ts`, `cors.ts`, `error.ts`, `logger.ts`, `sleep.ts`,
`ollamaTransform.ts`.

---

## 5. `electron/` — Обгортка для настільних систем

```
electron/
├── main.js                  Головний процес Electron
├── preload.js               Міст попереднього завантаження (contextIsolation увімкнено)
├── types.d.ts
├── package.json             Конфігурація electron-builder, версія 3.8.51
├── README.md
├── assets/                  Ресурси збірки (піктограми, дозволи, …)
├── node_modules/            Окремий каталог node_modules (better-sqlite3, electron-updater)
└── dist-electron/           Результати збірки (не додаються до репозиторію)
```

П’ять npm-скриптів у корені робочого простору: `electron:dev`, `electron:build`,
`electron:build:{win,mac,linux}`, `electron:smoke:packaged`. Автоматичне оновлення виконується через
`electron-updater`, спрямований на стрічку релізів GitHub.

---

## 6. `bin/` — CLI

```
bin/
├── omniroute.mjs           Головна точка входу CLI (Node ESM)
├── reset-password.mjs      Скидання пароля керування через CLI
├── mcp-server.mjs          Засіб запуску сервера MCP (stdio)
├── nodeRuntimeSupport.mjs  Перевірка версії Node
└── cli/
    ├── program.mjs         Побудова програми Commander
    ├── runtime.mjs         Допоміжний засіб withRuntime (спочатку сервер, резервно — БД)
    ├── output.mjs          Засоби форматування виведення (json/jsonl/table/csv)
    ├── i18n.mjs            Допоміжний засіб t() із локалями
    ├── api.mjs             Допоміжний засіб отримання даних API
    ├── data-dir.mjs
    ├── encryption.mjs
    ├── sqlite.mjs
    └── commands/
        ├── registry.mjs    Реєстрація команд
        ├── setup.mjs
        ├── doctor.mjs
        ├── providers.mjs
        └── ...             (по одному файлу на команду/групу)
```

У `package.json` → `bin` представлено два виконувані файли:

- `omniroute` → `bin/omniroute.mjs`
- `omniroute-reset-password` → `bin/reset-password.mjs`

---

## 7. `tests/`

| Каталог                                              | Тип                                                                                                                  |
| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `tests/unit/`                                        | Модульні тести через вбудований засіб запуску тестів Node (1821 файл, а також підкаталоги `api/`, `auth/`, `authz/`) |
| `tests/integration/`                                 | Міжмодульні тести та тести стану БД                                                                                  |
| `tests/e2e/`                                         | Тести інтерфейсу користувача Playwright                                                                              |
| `tests/e2e/protocol-clients.test.ts`                 | Наскрізні тести протоколів MCP/A2A                                                                                   |
| `tests/translator/`                                  | Тести, специфічні для транслятора                                                                                    |
| `tests/security/`                                    | Регресійні тести безпеки                                                                                             |
| `tests/load/`                                        | Тести навантаження / стрес-тести                                                                                     |
| `tests/golden-set/`                                  | Еталонні результати для регресійних тестів транслятора                                                               |
| `tests/helpers/`, `tests/fixtures/`, `tests/manual/` | Допоміжні матеріали                                                                                                  |

Поширені команди:

| Команда                                                  | Що вона запускає                                                              |
| -------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `npm run test:unit`                                      | Усі `tests/unit/*.test.ts` через засіб запуску тестів Node (паралельність 10) |
| `npm run test:vitest`                                    | Набір тестів Vitest (MCP, autoCombo, кеш)                                     |
| `npm run test:e2e`                                       | Набір тестів інтерфейсу користувача Playwright                                |
| `npm run test:protocols:e2e`                             | Наскрізні тести протоколів MCP + A2A                                          |
| `npm run test:coverage`                                  | Порогова перевірка покриття (≥60% рядків/інструкцій/функцій/гілок)            |
| `node --import tsx/esm --test tests/unit/<file>.test.ts` | Запуск одного файлу                                                           |

---

## 8. `scripts/`

Організовано в 6 підпапок за призначенням.

- **`scripts/build/`** — `build-next-isolated.mjs`, `prepublish.ts`,
  `prepare-electron-standalone.mjs`, `pack-artifact-policy.ts`,
  `validate-pack-artifact.ts`, `postinstall.mjs`, `postinstallSupport.mjs`,
  `uninstall.mjs`, `bootstrap-env.mjs`, `runtime-env.mjs`,
  `native-binary-compat.mjs`.
- **`scripts/dev/`** — `run-next.mjs`, `run-next-playwright.mjs`,
  `run-standalone.mjs`, `standalone-server-ws.mjs`, `responses-ws-proxy.mjs`,
  `v1-ws-bridge.mjs`, `smoke-electron-packaged.mjs`,
  `run-playwright-tests.mjs`, `run-ecosystem-tests.mjs`,
  `run-protocol-clients-tests.mjs`, `sync-env.mjs`, `healthcheck.mjs`,
  `system-info.mjs`.
- **`scripts/check/`** — `check-cycles.mjs`, `check-docs-sync.mjs`,
  `check-docs-counts-sync.mjs`, `check-env-doc-sync.mjs`,
  `check-deprecated-versions.mjs`, `check-route-validation.mjs`,
  `check-t11-any-budget.mjs`, `check-pr-test-policy.mjs`,
  `check-supported-node-runtime.ts`, `test-report-summary.mjs`.
- **`scripts/docs/`** — `generate-docs-index.mjs`, `gen-provider-reference.ts`.
- **`scripts/i18n/`** — `generate-multilang.mjs`, `run-visual-qa.mjs`,
  `generate-qa-checklist.mjs`, `apply-priority-overrides.mjs`,
  `validate_translation.py`, `check_translations.py`, `i18n_autotranslate.py`,
  `untranslatable-keys.json`.
- **`scripts/ad-hoc/`** — `cursor-tap.cjs`, `sync-cursor-models.mjs`,
  `migrate-env.mjs`, `dbsetup.js`.

---

## 9. Конвеєр запитів (стислий огляд)

![Конвеєр запитів (/v1/chat/completions)](../diagrams/exported/request-pipeline.svg)

> Джерело: [diagrams/request-pipeline.mmd](../diagrams/request-pipeline.mmd)

```
Запит клієнта
  → /v1/chat/completions (route.ts)
     Перевірка попереднього CORS-запиту
     Валідація Zod (chatCompletionsSchema у shared/validation/schemas.ts)
     Автентифікація (extractApiKey + isValidApiKey АБО requireManagementAuth)
     Рушій політик (src/server/authz/pipeline.ts)
     Захисні механізми (маскування персональних даних, ін’єкції в промпти, міст для зображень)
  → handleChatCore() (open-sse/handlers/chatCore.ts)
     Перевірка кешу (семантичний кеш + кеш читання)
     Обмеження частоти запитів (rateLimitManager, accountSemaphore)
     Комбінована маршрутизація (якщо модель розпізнається як комбінація)
       comboResolver → цикл для кожної цільової моделі → handleSingleModel()
     translateRequest()  (open-sse/translator/request/*)
     getExecutor(providerId).execute()  (open-sse/executors/*)
       отримання даних від зовнішнього сервісу → повторні спроби/експоненційна затримка через accountFallback
     translateResponse() (open-sse/translator/response/*)
     Потік SSE АБО відповідь JSON
     Якщо Responses API: TransformStream через open-sse/transformer/responsesTransformer.ts
  → Аудит відповідності (src/lib/compliance/)
  → Відповідь клієнту
```

### Стан середовища виконання для забезпечення стійкості (три механізми)

| Механізм                    | Область дії                       | Розташування                                                                                                     |
| --------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Запобіжник постачальника    | Увесь постачальник                | `src/shared/utils/circuitBreaker.ts`, зберігається в `domain_circuit_breakers`                                   |
| Період очікування з’єднання | Один обліковий запис/ключ         | `markAccountUnavailable()` у `src/sse/services/auth.ts`; використовується `accountFallback.checkFallbackError()` |
| Блокування моделі           | Постачальник + з’єднання + модель | `open-sse/services/accountFallback.ts`, зберігається в `domain_lockout_state`                                    |

Див. [RESILIENCE_GUIDE.md](./RESILIENCE_GUIDE.md) і спеціальний розділ у
[CLAUDE.md](../../CLAUDE.md).

---

## 10. Як зробити внесок

### Додавання нового провайдера

1. Зареєструйте його в `src/shared/constants/providers.ts` (перевіряється Zod під час завантаження).
2. Додайте виконавець у `open-sse/executors/`, якщо потрібна спеціальна логіка
   (успадкуйте `BaseExecutor`).
3. Додайте транслятор у `open-sse/translator/`, якщо провайдер не використовує формат OpenAI.
4. Якщо використовується OAuth, додайте конфігурацію до `src/lib/oauth/providers/` і
   `src/lib/oauth/services/`.
5. Зареєструйте моделі в `open-sse/config/providerRegistry.ts` (або в реєстрі
   відповідного формату в `open-sse/config/`).
6. Напишіть тести в `tests/unit/`.

### Додавання нового маршруту API

1. Створіть `src/app/api/your-route/route.ts`.
2. Дотримуйтеся шаблону: CORS → перевірка тіла запиту за допомогою Zod → автентифікація → делегування обробнику.
3. Якщо додається нова структура запиту: додайте схему Zod до `src/shared/validation/schemas.ts`.
4. Якщо маршрут призначений лише для керування: додайте шлях до `src/shared/constants/publicApiRoutes.ts`
   (список заборон для публічної поверхні API).
5. Додайте тести до `tests/unit/`.
6. Оновіть `docs/reference/API_REFERENCE.md` і `docs/openapi.yaml`.

### Додавання нового модуля БД

1. Створіть `src/lib/db/yourModule.ts` та імпортуйте `getDbInstance()` з `./core.ts`.
2. Експортуйте CRUD-функції для вашої предметної області.
3. Якщо додаються нові таблиці: додайте міграцію до `src/lib/db/migrations/` із
   послідовним номером; вона має бути ідемпотентною й транзакційною.
4. Модулі-імпортери використовують прямі імпорти з `@/lib/db/yourModule` (без агрегувального модуля — старий шар реекспорту `localDb.ts` було видалено).
5. Додайте тести до `tests/unit/`.

### Додавання нового інструмента MCP

1. Додайте визначення інструмента до `open-sse/mcp-server/tools/` (або розширте
   `open-sse/mcp-server/schemas/tools.ts`).
2. Призначте відповідні області доступу в `src/shared/constants/mcpScopes.ts`.
3. Зареєструйте інструмент у `open-sse/mcp-server/server.ts`.
4. Додайте тести до `open-sse/mcp-server/__tests__/`.
5. Оновіть [MCP-SERVER.md](../frameworks/MCP-SERVER.md).

### Додавання нової навички A2A

Див. [A2A-SERVER.md § Додавання нової навички](../frameworks/A2A-SERVER.md). Навички розміщуються в
`src/lib/a2a/skills/` і реєструються через диспетчер завдань A2A.

---

## 11. Угоди

- **Стиль коду**: відступ у 2 пробіли, подвійні лапки, ширина 100 символів, крапки з комою,
  кінцеві коми `es5` — забезпечується Prettier через `lint-staged`.
- **Імпорти**: зовнішні → внутрішні (`@/`, `@omniroute/open-sse`) → відносні.
- **Іменування**: файли — `camelCase` або `kebab-case`, компоненти — `PascalCase`,
  константи — `UPPER_SNAKE`.
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = `error` скрізь;
  `no-explicit-any` = `warn` у `open-sse/` і `tests/`, в інших місцях — `error`.
- **TypeScript**: `strict: false` (успадкований підхід). На межах між модулями віддавайте перевагу
  явним типам замість виведення типів.
- **База даних**: ніколи не пишіть необроблений SQL у маршрутах або обробниках — завжди використовуйте
  модулі `src/lib/db/`. Ніколи не імпортуйте через агрегувальний модуль — безпосередньо використовуйте конкретні модулі `src/lib/db/*`.
- **Типізація сутностей БД (#3512)**: функція, яка записує або читає структуру
  рядка таблиці БД, повинна приймати/повертати іменований інтерфейс TS, що віддзеркалює
  стовпці цієї таблиці у співвідношенні 1:1, а не `any` чи вбудований анонімний тип у місці виклику. Розміщуйте
  інтерфейс поруч із функцією (наприклад, `export interface UsageEntry` у
  `src/lib/usage/usageHistory.ts` над `saveRequestUsage`), залишайте окремі
  поля необов’язковими або такими, що допускають `null`, коли різні модулі запису заповнюють рядок
  поступово, і віддавайте перевагу `unknown` замість `any` для поля, структура якого
  відрізняється залежно від виклику (задокументуйте це в полі, наприклад, `UsageEntry.tokens`
  приймає як необроблені дані про використання у форматі провайдера, так і нормалізовану структуру). Коли кількість
  `any` у файлі завдяки цьому досягне нуля, додайте його до списку дозволених
  `check:any-budget:t11` (`scripts/check/check-t11-any-budget.mjs`,
  `maxAny: 0`), щоб запобігти регресії. Це угода для першого етапу — ширше
  усунення анонімних `any` виконується ітеративно в решті
  кодової бази.
- **Помилки**: використовуйте try/catch із конкретними типами помилок, ведіть журнал із контекстом pino. Ніколи
  не ігноруйте помилки без повідомлення в потоках SSE; використовуйте сигнали переривання для очищення.
- **Безпека**: ніколи не використовуйте `eval()` / `new Function()` / неявний eval. Перевіряйте
  всі вхідні дані за допомогою Zod. Шифруйте облікові дані під час зберігання (AES-256-GCM). Підтримуйте
  список заборон `src/shared/constants/upstreamHeaders.ts` узгодженим із
  шаром очищення/перевірки.
- **Коміти**: Conventional Commits — `feat(scope): subject`. Дозволені області:
  `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`,
  `a2a`, `memory`, `skills`.
- **Гілки**: префікси `feat/`, `fix/`, `refactor/`, `docs/`, `test/`,
  `chore/`. Ніколи не робіть коміти безпосередньо до `main`.
- **Husky**: перед комітом запускаються `lint-staged` + `check:docs-sync` +
  `check:any-budget:t11`; перед надсиланням змін запускаються `check:any-budget:t11` + `check:tracked-artifacts` (швидкі перевірки; без `test:unit`).

---

## 12. Жорсткі правила (з CLAUDE.md)

1. Ніколи не комітьте секрети чи облікові дані.
2. Ніколи не використовуйте імпорти через barrel-файли — імпортуйте безпосередньо з конкретних модулів `src/lib/db/*`.
3. Ніколи не використовуйте `eval()` / `new Function()` / неявний eval.
4. Ніколи не комітьте безпосередньо в `main`.
5. Ніколи не пишіть необроблений SQL у маршрутах — завжди використовуйте модулі `src/lib/db/`.
6. Ніколи не ігноруйте помилки без повідомлення в потоках SSE.
7. Завжди перевіряйте вхідні дані за допомогою схем Zod.
8. Завжди додавайте тести, змінюючи код для продакшену.
9. Покриття має залишатися ≥ 60% (інструкції, рядки, функції, гілки).

---

## 13. Дивіться також

- [ARCHITECTURE.md](./ARCHITECTURE.md) — високорівнева архітектура та обов’язки
  модулів.
- [API_REFERENCE.md](../reference/API_REFERENCE.md) — довідник публічного API та API керування.
- [FEATURES.md](../guides/FEATURES.md) — матриця функцій і ключові особливості версій.
- [RESILIENCE_GUIDE.md](./RESILIENCE_GUIDE.md) — поглиблений огляд автоматичного вимикача, періоду
  очікування та блокування.
- [AUTO-COMBO.md](../routing/AUTO-COMBO.md) — оцінювання та стратегії Auto Combo.
- [MCP-SERVER.md](../frameworks/MCP-SERVER.md) — повний каталог інструментів MCP і транспортів.
- [A2A-SERVER.md](../frameworks/A2A-SERVER.md) — навички та виявлення протоколу A2A.
- [COMPRESSION_GUIDE.md](../compression/COMPRESSION_GUIDE.md) — стиснення RTK + Caveman.
- [CLI-TOOLS.md](../reference/CLI-TOOLS.md) — інтеграції CLI.
- [ELECTRON_GUIDE.md](../guides/ELECTRON_GUIDE.md) (якщо є), [DOCKER_GUIDE.md](../guides/DOCKER_GUIDE.md), [FLY_IO_DEPLOYMENT_GUIDE.md](../ops/FLY_IO_DEPLOYMENT_GUIDE.md), [VM_DEPLOYMENT_GUIDE.md](../ops/VM_DEPLOYMENT_GUIDE.md), [TERMUX_GUIDE.md](../guides/TERMUX_GUIDE.md), [PWA_GUIDE.md](../guides/PWA_GUIDE.md) — цільові середовища розгортання.
- [TROUBLESHOOTING.md](../guides/TROUBLESHOOTING.md) — поширені операційні проблеми.
- [CONTRIBUTING.md](../../CONTRIBUTING.md) — робочий процес для учасників проєкту.
- [CLAUDE.md](../../CLAUDE.md) — правила репозиторію для Claude Code (основне джерело
  багатьох наведених вище домовленостей).
- [AGENTS.md](../../AGENTS.md) — докладніший довідник з архітектури, який використовують агенти.