@ykurilov/agent-chat-server 0.0.0-stage → 0.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1777 -0
- package/LICENSE +21 -0
- package/README.md +107 -2
- package/dist/hono.js +13 -0
- package/dist/hono.js.map +1 -0
- package/dist/index.js +732 -0
- package/dist/index.js.map +1 -0
- package/dist/next.js +10 -0
- package/dist/next.js.map +1 -0
- package/dist/node.js +101 -0
- package/dist/node.js.map +1 -0
- package/dist/types/chat-handler.d.ts +235 -0
- package/dist/types/heartbeat.d.ts +15 -0
- package/dist/types/hono.d.ts +4 -0
- package/dist/types/index.d.ts +6 -0
- package/dist/types/memory-routes.d.ts +53 -0
- package/dist/types/new-chat-data.d.ts +14 -0
- package/dist/types/next.d.ts +8 -0
- package/dist/types/node.d.ts +11 -0
- package/dist/types/request-body.d.ts +11 -0
- package/dist/types/subject-chat-route.d.ts +31 -0
- package/dist/types/watch-stream.d.ts +29 -0
- package/package.json +63 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Yury Kurilov
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,108 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @ykurilov/agent-chat-server
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
HTTP-адреса чата с агентом на стандартных `Request`/`Response` и подключения к Hono и Next.js.
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
import { createChatHandler } from "@ykurilov/agent-chat-server";
|
|
7
|
+
import { mountChat } from "@ykurilov/agent-chat-server/hono";
|
|
8
|
+
|
|
9
|
+
const chat = createChatHandler({ basePath: "/api/chat", storage, resolveUser, defaultChoice, catalog, agent });
|
|
10
|
+
mountChat(app, chat); // Hono: все адреса /api/chat и /api/chat/*
|
|
11
|
+
await chat.recoverInterruptedAnswers(); // при старте, до приёма запросов; дальше сам проверяет брошенные ответы раз в 5 с
|
|
12
|
+
await chat.flush({ waitForAnswersMs: 20_000 }); // при штатной остановке, до закрытия хранилища
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
- `resolveUser(request)` — текущий пользователь из вашей сессии; `null` → `401`.
|
|
16
|
+
Модуль вход не реализует.
|
|
17
|
+
- `defaultChoice` — `{ modelId, providerId, reasoning? }` для нового чата; не задан или не подходит —
|
|
18
|
+
первая доступная модель каталога (в журнал пишется причина). Раньше был `resolveModel`.
|
|
19
|
+
Человек, уже выбиравший модель, получает новые чаты на своём последнем выборе, если он ещё доступен.
|
|
20
|
+
- `POST /:chatId/approvals/:approvalId` с телом `{ "decision": "allow" | "deny" | "always" }` — решение по действию, которое ждёт подтверждения. Ошибки: 409 `busy` (идёт другой ход), 409 `approval_not_pending` (отвечать уже нечем), 429 `spending_limit_reached`.
|
|
21
|
+
`200 { resumed }`, `409 { error: { kind: "invalid" } }`, если запрос уже решён или закрыт.
|
|
22
|
+
- `chatList: true` включает список чатов: `GET {basePath}` → `{ chats: [{ id, title, createdAt, updatedAt }] }`, `PATCH {basePath}/:id` с `{ title }` → `200 { id, title }` (`400` — название пустое или длиннее 100 знаков; переименовать можно и во время ответа), `DELETE {basePath}/:id` → `204` (идущий ответ и сжатие останавливаются; повтор — `404`; `409` — только если чат уже удаляется или в этот миг запускается ход). Пока чат удаляется, сообщение, сжатие и вложения в него тоже получают `409`. Без `chatList` эти адреса отвечают `404`.
|
|
23
|
+
- Чужой или несуществующий чат — `404 { error: { kind: "not_found" } }` на каждом адресе.
|
|
24
|
+
- Запрос, который меняет данные (не GET), с чужой страницы — `403 { error: { kind: "forbidden_origin" } }` до входа и любых записей;
|
|
25
|
+
адрес страницы — один раз в журнал. Свой сайт и запросы не из браузера проходят. Чат на чужом сайте, который шлёт запросы прямо
|
|
26
|
+
оттуда (GetCourse), — `allowedOrigins: ["https://school.getcourse.ru"]` (CORS и куки `SameSite=None` — в вашем приложении).
|
|
27
|
+
Фронт на своих поддоменах — шаблон `allowedOrigins: ["https://*.example.com"]` (не пускает `example.com` и `evil-example.com`;
|
|
28
|
+
общие суффиксы вроде `*.co.uk` проверка не распознаёт — вписывайте свой домен).
|
|
29
|
+
За прокси передайте имя сайта: `proxy_set_header Host $host; proxy_set_header X-Forwarded-Host $host;` — иначе старые браузеры
|
|
30
|
+
получают 403, а журнал пишет «Origin не совпал с Host».
|
|
31
|
+
- `maxConcurrentTurnsPerUser` (по умолчанию 3, `Infinity` — без предела) — сколько ответов одного человека идут одновременно во всех
|
|
32
|
+
его чатах. Лишний ход — `429 { error: { kind: "too_many_turns", limit } }` до любых записей.
|
|
33
|
+
- `replyChecks` и `now` передаются службе чата как есть: проверки готового ответа перед записью и часы службы
|
|
34
|
+
(README ядра, [docs/reply-check.md](https://github.com/ykurilov/agent-chat-sdk/blob/main/docs/reply-check.md)).
|
|
35
|
+
- Тело запроса больше 1 МиБ — `413 { error: { kind: "too_large" } }`, оно не дочитывается.
|
|
36
|
+
- Ход не висит вечно и переживает сбои сам: настройки `agent.toolTimeoutMs`, `agent.modelSilenceTimeout`, `agent.toolResultMaxLength`,
|
|
37
|
+
`agent.providerFallback`, `agent.sequentialTools`, `agent.timeZone` — описание в README ядра и в разделе «Надёжность хода» getting-started.
|
|
38
|
+
- Несколько копий сервера на одной базе можно: идущий ответ отмечает «жив», брошенный ответ копии, которая упала, прерывает другая копия.
|
|
39
|
+
Запросы одного чата держите на одной копии. Первое обновление до этой версии — остановите старые копии, потом запускайте новые.
|
|
40
|
+
- `heartbeatIntervalMs` (по умолчанию `10_000`, меньше `1000` — ошибка) — как часто сервер шлёт тихий
|
|
41
|
+
признак жизни в потоках ответа. Вкладка по нему замечает зависшую связь.
|
|
42
|
+
- `limits` — лимиты расходов из `@ykurilov/agent-chat-limits`. Исчерпан лимит — `429 { error: { kind: "spending_limit_reached", scope, period, resetsAt, timeZone?, reason?, windowId?, hours? } }` (`reason`: `limit`, `blocked` — человек заблокирован, `reserve` — остаток меньше запаса на старт хода)
|
|
43
|
+
на отправку, повтор, переделку и правку (до любых записей); появляется `GET …/:id/spending` → `{ state, scope?, period?, share?, resetsAt?, timeZone?, reason?, windowId?, hours?, blocked?, windows? }` (`timeZone` — пояс лимитов, если задан; `windows` — все окна с долей и временем сброса)
|
|
44
|
+
без сумм. Не задан — адреса нет, проверок нет.
|
|
45
|
+
- `onTurnFinished({ userId, chatId, messageId, status, modelId, providerId })` — ход закончен: один раз на ход при любом итоге
|
|
46
|
+
(`complete`, `stopped`, `error`, `interrupted`, `awaiting_approval`), итог уже записан. `messageId` — id ответа, тот же, что в истории
|
|
47
|
+
и на экране. Ход обработчик не ждёт; бросок или отклонённое обещание — в `logError`, ответ не ломается. Тип — `TurnFinished` из ядра.
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
createChatHandler({ ...options, onTurnFinished: async (turn) => { if (turn.status === "complete") await analytics.answered(turn); } });
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
- Агент внутри продукта ([docs/in-product-agent.md](https://github.com/ykurilov/agent-chat-sdk/blob/main/docs/in-product-agent.md)):
|
|
54
|
+
- `resolveUser` может вернуть `{ refused: { code, message, status? } }` → `401`/`403 { error: { kind: "access_refused", code, message } }` на всех адресах чата, голоса и мессенджеров.
|
|
55
|
+
- `beforeTurn` — отказ приложения до хода: `403 { error: { kind: "turn_refused", code, message } }`. Получает `messageId` у отправки и правки.
|
|
56
|
+
- `turnNotStarted` — ход не начался после пропуска `beforeTurn` (занято, лимит, повтор id…): снять резерв приложения. Ответ клиенту прежний.
|
|
57
|
+
- `chatCapabilities({ userId, chat })` — права человека в чате, как в ядре. Запрещённое действие — `403 { error: { kind: "action_forbidden", action, code, message } }`; загрузка вложений проверяет право `attachments`, `POST …/steer` — право `steer`. `reasoning: false` и `toolDetails: false` прячут мысли и служебные инструменты из `GET` истории и потоков (свой инструмент экрана — `metadata: { showOnScreen: true }` в описании). `modelDetails: false` прячет модель, провайдера, расход, `ownerId` и текст сводок сжатия (и в `GET …/compactions`) из истории и потоков и выключает `PUT …/model`. Песочница права приложения не применяет.
|
|
58
|
+
- `modelMenu({ userId })` — видит ли человек `GET …/models`: `false` — 403 `action_forbidden` (`action: "modelDetails"`). Нет — меню видно всем.
|
|
59
|
+
- `privateStateKeys` — закрытые верхние ключи состояния чата: не уходят ни в историю, ни в поток, ни в `state-changed` адреса `watch`. Сервер видит их как обычно. Закрытое значение не возвращайте в выходе инструмента и тексте ответа.
|
|
60
|
+
- Проверка ответа виджета приложением (`checkAnswer`) отказала — `409 { error: { kind: "widget_answer_refused", code: "widget_answer_refused", message } }`: ничего не записано, виджет ждёт дальше.
|
|
61
|
+
- Закрытый чат (`service.closeChat`, `model.closeChat`) — `409 { error: { kind: "chat_closed", code, message } }` на отправку, «Повторить», подтверждения и виджеты. Правка, «Переделать», ветки и правка ответа уводят с точки закрытия и идут по правам. Мессенджеры отвечают человеку текстом закрытия или отказа.
|
|
62
|
+
- `beforeCreateChat({ userId, origin? })` — можно ли завести новый чат: отказ на `POST {base}` — `403 { error: { kind: "chat_creation_refused", code, message } }`, в мессенджере (`/new`, первый чат) — текстом. Песочница хук не зовёт; закрытый чат песочницы админ открывает снова (`POST {sandboxBase}/chats/:chatId/reopen`).
|
|
63
|
+
- `afterTurn`, `afterTurnTimeoutMs`, `afterTurnAttempts` — итог хода, как в ядре.
|
|
64
|
+
- `onStateChanged`, `onStateChangedTimeoutMs`, `onStateChangedAttempts` — состояние чата сменилось, как в ядре: по очереди внутри чата, только пока сервер жив (сверка — `getChatState`); вкладка получает `state-changed` через `watch`. Служебные ключи состояния (`$…`) в историю и поток не уходят.
|
|
65
|
+
- `subjectChats({ user, key, request })` открывает `POST {basePath}/subject { key }` → `{ id, created }`: один чат на объект; ответ `{ data?, title?, greeting? }` или отказ `{ code, message }`.
|
|
66
|
+
- `chatList: { subjectChats: true }` — чаты объектов видны в списке (с `subjectKey`); по умолчанию скрыты.
|
|
67
|
+
- `chat.flush({ waitForAnswersMs? })` — штатная остановка: новые ходы не начинаются, идущие ответы ждутся до срока
|
|
68
|
+
(по умолчанию 0), не успевшие закрываются как «Стоп» с записью (`afterTurn` видит `stopReason: "shutdown"`).
|
|
69
|
+
Возвращается, когда всё записано и `afterTurn` закончен. Без вызова при остановке сервера теряется до 0,5 с текста.
|
|
70
|
+
- `chat.fetch(request)` подключается к любому серверу со стандартными `Request`/`Response`.
|
|
71
|
+
- Next.js (App Router): `createNextRouteHandlers(chat)` из `@ykurilov/agent-chat-server/next` отдаёт методы для файла
|
|
72
|
+
маршрута; пакет `next` не нужен:
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
// app/api/chat/[[...path]]/route.ts
|
|
76
|
+
import { createNextRouteHandlers } from "@ykurilov/agent-chat-server/next";
|
|
77
|
+
import { chatHandler } from "@/lib/chat";
|
|
78
|
+
|
|
79
|
+
export const { GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD } = createNextRouteHandlers(chatHandler);
|
|
80
|
+
export const dynamic = "force-dynamic";
|
|
81
|
+
export const runtime = "nodejs";
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Нужен долгоживущий сервер, не serverless; `basePath` обработчика совпадает с путём маршрута. Момента «до приёма
|
|
85
|
+
запросов» в Next.js нет: `chatHandler.recoverInterruptedAnswers()` зовите один раз сразу после `createChatHandler`
|
|
86
|
+
(там же, где обработчик кладётся в `globalThis`). Без вызова ответы, оборванные падением сервера, остаются «идущими»
|
|
87
|
+
навсегда, а задачи фона не поднимаются.
|
|
88
|
+
|
|
89
|
+
- Express и голый `node:http`: `toNodeListener(chat)` из `@ykurilov/agent-chat-server/node`. Ответ идёт потоком,
|
|
90
|
+
разрыв соединения отменяет запрос, тело уже прочитанное разборщиком (`express.json()`, `req.body`) уходит как есть.
|
|
91
|
+
Адрес вне `basePath` — `next()`, без `next` — 404:
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
import { toNodeListener } from "@ykurilov/agent-chat-server/node";
|
|
95
|
+
|
|
96
|
+
app.use(toNodeListener(chatHandler)); // Express
|
|
97
|
+
http.createServer(toNodeListener(chatHandler)).listen(3000); // node:http
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Адреса: `POST /api/chat`, `GET /api/chat/:id`, `POST …/:id/messages`, `POST …/:id/retry`,
|
|
101
|
+
`GET …/:id/stream`, `POST …/:id/stop`, `POST …/:id/steer` (поправка, пока агент отвечает: `202 { status: "queued" | "started", messageId }`), `GET …/:id/branches` и `POST …/:id/branch` (варианты ответов и переключение), `POST …/:id/regenerate` (переделать ответ), `POST …/:id/edit` (исправить сообщение), `GET …/:id/compactions` (записи сжатия истории), `GET …/models` (список для меню), `PUT …/:id/model` (выбор модели
|
|
102
|
+
и уровня рассуждений в чате). Адреса, которые запускают или продолжают ход (`messages`, `steer`, `edit`, `retry`, `regenerate`, `approvals/:id`), принимают в теле необязательные `place` (`null` или `{ description, data? }`) и `tabId` (строка до 100 знаков); неверная форма — `400 invalid`. Браузерные инструменты (`agent.browserTools`): вкладка отвечает на `POST …/:id/browser-tools/:toolCallId` с `{ tabId, output }` или `{ tabId, error }` — `204`, `400` (тело больше 64 КБ или неверной формы), `401`, `404`, `409` (`not_pending`: вызов не ждёт ответа этой вкладки). Только на одном сервере. Подробно — в
|
|
103
|
+
[contracts/http-api.md](../../specs/001-basic-agent-dialog/contracts/http-api.md) и в
|
|
104
|
+
[дополнении к нему](../../specs/002-fast-feed-and-liveness/contracts/http-api.md) (пинги в потоках); ветки и правка — [contracts/branches-and-edit.md](../../specs/007-branches-and-edit/contracts/branches-and-edit.md).
|
|
105
|
+
|
|
106
|
+
Подключение целиком: [docs/getting-started.md](https://github.com/ykurilov/agent-chat-sdk/blob/main/docs/getting-started.md).
|
|
107
|
+
|
|
108
|
+
Журнал изменений и что делать при обновлении: [CHANGELOG.md](./CHANGELOG.md). Все пакеты SDK выходят вместе и с одной версией; обновление — `pnpm update "@ykurilov/agent-chat-*" --latest`.
|
package/dist/hono.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// src/hono.ts
|
|
2
|
+
function mountChat(app, handler) {
|
|
3
|
+
const forward = async (c) => {
|
|
4
|
+
const response = await handler.fetch(c.req.raw);
|
|
5
|
+
return c.newResponse(response.body, response);
|
|
6
|
+
};
|
|
7
|
+
app.all(handler.basePath, forward);
|
|
8
|
+
app.all(`${handler.basePath}/*`, forward);
|
|
9
|
+
}
|
|
10
|
+
export {
|
|
11
|
+
mountChat
|
|
12
|
+
};
|
|
13
|
+
//# sourceMappingURL=hono.js.map
|
package/dist/hono.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/hono.ts"],"sourcesContent":["import type { Context, Hono } from \"hono\";\nimport type { ChatHandler } from \"./chat-handler\";\n\n/** Монтирует обработчик чата (или расширения с такой же формой: `basePath` и `fetch`, например голоса) в приложение Hono по его `basePath`. */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any -- приложение может иметь любые свои Env и Schema\nexport function mountChat(app: Hono<any, any, any>, handler: Pick<ChatHandler, \"basePath\" | \"fetch\">): void {\n // Готовый Response Hono отдаёт как есть и теряет заголовки и cookie, которые приложение\n // выставило до `next()` (например, продлённую сессию). `newResponse` их добавляет.\n const forward = async (c: Context) => {\n const response = await handler.fetch(c.req.raw);\n return c.newResponse(response.body, response);\n };\n app.all(handler.basePath, forward);\n app.all(`${handler.basePath}/*`, forward);\n}\n"],"mappings":";AAKO,SAAS,UAAU,KAA0B,SAAwD;AAG1G,QAAM,UAAU,OAAO,MAAe;AACpC,UAAM,WAAW,MAAM,QAAQ,MAAM,EAAE,IAAI,GAAG;AAC9C,WAAO,EAAE,YAAY,SAAS,MAAM,QAAQ;AAAA,EAC9C;AACA,MAAI,IAAI,QAAQ,UAAU,OAAO;AACjC,MAAI,IAAI,GAAG,QAAQ,QAAQ,MAAM,OAAO;AAC1C;","names":[]}
|