@itphx/synth-shared 0.11.3 → 0.12.4
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/dist/config/defaults.js +126 -3
- package/dist/config/env-overrides.d.ts +29 -0
- package/dist/config/env-overrides.js +155 -2
- package/dist/config/execution.d.ts +66 -0
- package/dist/config/execution.js +146 -0
- package/dist/config/index.d.ts +1 -0
- package/dist/config/index.js +1 -0
- package/dist/config/proxy.js +3 -1
- package/dist/config/resolve.d.ts +8 -8
- package/dist/config/resolve.js +7 -7
- package/dist/config/types.d.ts +1287 -4037
- package/dist/config/types.js +461 -68
- package/dist/i18n/index.d.ts +1 -1
- package/dist/i18n/index.js +277 -0
- package/dist/index.d.ts +14 -2
- package/dist/index.js +16 -2
- package/dist/model-metadata.d.ts +10 -0
- package/dist/schemas/index.d.ts +980 -2322
- package/dist/schemas/index.js +183 -22
- package/dist/types/analytics.d.ts +6 -6
- package/dist/types/analytics.js +4 -4
- package/dist/types/authority.d.ts +464 -0
- package/dist/types/authority.js +445 -0
- package/dist/types/background.d.ts +96 -0
- package/dist/types/background.js +24 -0
- package/dist/types/bus-events.d.ts +23 -1
- package/dist/types/catalog.d.ts +349 -0
- package/dist/types/catalog.js +393 -0
- package/dist/types/decision.d.ts +28 -337
- package/dist/types/egress.d.ts +1 -1
- package/dist/types/egress.js +1 -1
- package/dist/types/events.d.ts +54 -1
- package/dist/types/external-credentials.d.ts +352 -0
- package/dist/types/external-credentials.js +200 -0
- package/dist/types/hooks.d.ts +33 -12
- package/dist/types/index.d.ts +20 -0
- package/dist/types/index.js +50 -1
- package/dist/types/llm-filters.d.ts +150 -0
- package/dist/types/llm-filters.js +54 -0
- package/dist/types/mcp.d.ts +33 -2
- package/dist/types/mcp.js +44 -1
- package/dist/types/message.d.ts +45 -1
- package/dist/types/pack.d.ts +1102 -0
- package/dist/types/pack.js +1003 -0
- package/dist/types/permission.d.ts +25 -11
- package/dist/types/permission.js +1 -1
- package/dist/types/pipeline-engine.d.ts +453 -0
- package/dist/types/pipeline-engine.js +440 -0
- package/dist/types/pipeline.d.ts +275 -0
- package/dist/types/pipeline.js +212 -0
- package/dist/types/plugin-audit.d.ts +110 -0
- package/dist/types/plugin-audit.js +185 -0
- package/dist/types/plugin-hybrid.d.ts +85 -0
- package/dist/types/plugin-hybrid.js +68 -0
- package/dist/types/plugin-lock.d.ts +95 -0
- package/dist/types/plugin-lock.js +1 -0
- package/dist/types/plugin-protocol.d.ts +221 -0
- package/dist/types/plugin-protocol.js +322 -0
- package/dist/types/plugin-runtime.d.ts +25 -0
- package/dist/types/plugin-runtime.js +11 -0
- package/dist/types/plugin-scan.d.ts +159 -0
- package/dist/types/plugin-scan.js +166 -0
- package/dist/types/plugin-tools.d.ts +51 -0
- package/dist/types/plugin-tools.js +72 -0
- package/dist/types/project.d.ts +14 -0
- package/dist/types/prompt-blocks.d.ts +102 -0
- package/dist/types/prompt-blocks.js +24 -0
- package/dist/types/prompt.d.ts +45 -3
- package/dist/types/provider.d.ts +11 -0
- package/dist/types/question.d.ts +153 -0
- package/dist/types/question.js +65 -0
- package/dist/types/schedules.d.ts +26 -3
- package/dist/types/semver.d.ts +48 -0
- package/dist/types/semver.js +218 -0
- package/dist/types/service-keys.d.ts +41 -3
- package/dist/types/service-keys.js +44 -2
- package/dist/types/session.d.ts +54 -0
- package/dist/types/steering.d.ts +74 -0
- package/dist/types/steering.js +75 -0
- package/dist/types/tools.d.ts +125 -5
- package/dist/types/tools.js +75 -0
- package/dist/types/trust.d.ts +31 -0
- package/dist/types/trust.js +27 -0
- package/dist/types/worktree.d.ts +170 -0
- package/dist/types/worktree.js +101 -0
- package/dist/utils/index.d.ts +31 -1
- package/dist/utils/index.js +92 -12
- package/dist/utils/reasoning.d.ts +16 -0
- package/dist/utils/reasoning.js +37 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +2 -2
package/dist/schemas/index.js
CHANGED
|
@@ -1,6 +1,15 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { MessageRole, GlobalRole, ProjectRole, StatusMessageType, PROJECT_ICON_KEYS, PROJECT_COLOR_KEYS, isKnownScope, isWebhookEventPattern, ANALYTICS_FAMILIES, ANALYTICS_DIMENSIONS, ANALYTICS_EXPORT_FORMATS, } from '../types/index.js';
|
|
2
|
+
import { MessageRole, GlobalRole, ProjectRole, StatusMessageType, PROJECT_ICON_KEYS, PROJECT_COLOR_KEYS, isKnownScope, isWebhookEventPattern, ANALYTICS_FAMILIES, ANALYTICS_DIMENSIONS, ANALYTICS_EXPORT_FORMATS, STEER_MODES, DEFAULT_STEER_MODE, } from '../types/index.js';
|
|
3
3
|
import { ToolCapability } from '../types/tools.js';
|
|
4
|
+
/**
|
|
5
|
+
* Экземпляр zod, которым построены **все** схемы этого пакета.
|
|
6
|
+
*
|
|
7
|
+
* В zod 4 `extendZodWithOpenApi` навешивает `.openapi()` на прототип
|
|
8
|
+
* **конкретного** экземпляра модуля (а не глобально). Потребителю, который
|
|
9
|
+
* расширяет zod (публичный OpenAPI в core), нужно расширять ровно тот экземпляр,
|
|
10
|
+
* которым созданы shared-схемы, — иначе у них не будет `.openapi()`.
|
|
11
|
+
*/
|
|
12
|
+
export { z as sharedZod };
|
|
4
13
|
export const messageRoleSchema = z.nativeEnum(MessageRole);
|
|
5
14
|
export const globalRoleSchema = z.nativeEnum(GlobalRole);
|
|
6
15
|
export const projectRoleSchema = z.nativeEnum(ProjectRole);
|
|
@@ -30,11 +39,53 @@ export function normalizeIconKey(value) {
|
|
|
30
39
|
export function normalizeColorKey(value) {
|
|
31
40
|
return isProjectColorKey(value) ? value : undefined;
|
|
32
41
|
}
|
|
42
|
+
/**
|
|
43
|
+
* ADR-106 Ф4: нормализация роли участника сессии. Каноническая роль → как
|
|
44
|
+
* есть; всё прочее — **fail-closed** (`viewer`, только чтение).
|
|
45
|
+
*/
|
|
46
|
+
export function normalizeSessionParticipantRole(value) {
|
|
47
|
+
if (value === 'owner' || value === 'editor' || value === 'viewer')
|
|
48
|
+
return value;
|
|
49
|
+
return 'viewer';
|
|
50
|
+
}
|
|
33
51
|
export const tokenUsageSchema = z.object({
|
|
34
52
|
inputTokens: z.number().int().min(0),
|
|
35
53
|
outputTokens: z.number().int().min(0),
|
|
36
54
|
totalTokens: z.number().int().min(0),
|
|
37
55
|
});
|
|
56
|
+
/**
|
|
57
|
+
* Снять у поля патча дефолт (`ZodDefault`/`ZodPrefault`), сохранив валидацию.
|
|
58
|
+
*
|
|
59
|
+
* zod 4 подставляет дефолт даже под `.optional()` (дефолт делает вход
|
|
60
|
+
* опциональным и применяется к `undefined`), поэтому «снять» его можно только
|
|
61
|
+
* развернув обёртку (`unwrap` есть у обоих типов). Пустое значение без обёртки —
|
|
62
|
+
* как есть.
|
|
63
|
+
*/
|
|
64
|
+
function withoutDefault(field) {
|
|
65
|
+
const type = field._zod?.def?.type;
|
|
66
|
+
if (type !== 'default' && type !== 'prefault')
|
|
67
|
+
return field;
|
|
68
|
+
const unwrap = field.unwrap;
|
|
69
|
+
return typeof unwrap === 'function' ? withoutDefault(unwrap.call(field)) : field;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Патч-схема объекта: как `.partial()`, но **без дефолтов**.
|
|
73
|
+
*
|
|
74
|
+
* Для PATCH отсутствующий ключ означает «не менять», а `.partial()` в zod 4
|
|
75
|
+
* протекает дефолтами: `pluginsConfigSchema.partial().parse({})` возвращает
|
|
76
|
+
* объект со всеми значениями по умолчанию, и частичный патч затирает чужие
|
|
77
|
+
* настройки. Поэтому поля берутся из `shape`, у каждого снимается дефолт и
|
|
78
|
+
* навешивается `.optional()`. Набор ключей и правила валидации остаются из
|
|
79
|
+
* исходной схемы (единственный источник правды). `.strict()` вызывается
|
|
80
|
+
* потребителем, если нужен отказ на неизвестный ключ.
|
|
81
|
+
*/
|
|
82
|
+
export function patchObjectSchema(schema) {
|
|
83
|
+
const patchShape = {};
|
|
84
|
+
for (const [key, field] of Object.entries(schema.shape)) {
|
|
85
|
+
patchShape[key] = withoutDefault(field).optional();
|
|
86
|
+
}
|
|
87
|
+
return z.object(patchShape);
|
|
88
|
+
}
|
|
38
89
|
export const sessionSettingsSchema = z.object({
|
|
39
90
|
provider: z.string().optional(),
|
|
40
91
|
model: z.string().optional(),
|
|
@@ -86,7 +137,9 @@ export const sessionUpdateSchema = z.object({
|
|
|
86
137
|
// passthrough: настройки сессии содержат поля вне sessionSettingsSchema
|
|
87
138
|
// (mcpServers, routing*, microFirst, embedding*, permission, mcpToolSettings, llmGateway),
|
|
88
139
|
// их нельзя терять при PATCH — известные поля валидируются, неизвестные пропускаются.
|
|
89
|
-
|
|
140
|
+
// `patchObjectSchema` (а не `.partial()`): отсутствующий ключ не должен получать
|
|
141
|
+
// дефолт из схемы — иначе PATCH сбрасывает настройки, которые не передавали.
|
|
142
|
+
settings: patchObjectSchema(sessionSettingsSchema).passthrough().optional(),
|
|
90
143
|
});
|
|
91
144
|
/**
|
|
92
145
|
* ADR-076: запись реестра git-репозиториев. `path` обязателен, остальные поля
|
|
@@ -126,6 +179,8 @@ export const projectCreateSchema = z.object({
|
|
|
126
179
|
workspace: z.string().optional(),
|
|
127
180
|
repos: z.array(z.union([z.string(), gitRepoConfigSchema])).optional(),
|
|
128
181
|
});
|
|
182
|
+
/** ADR-107: проектная политика памяти (undefined — не менять). */
|
|
183
|
+
export const projectMemoryUpdateSchema = z.object({ enabled: z.boolean().optional() });
|
|
129
184
|
export const projectUpdateSchema = z.object({
|
|
130
185
|
name: z.string().min(1).max(200).optional(),
|
|
131
186
|
description: z.string().optional(),
|
|
@@ -135,6 +190,7 @@ export const projectUpdateSchema = z.object({
|
|
|
135
190
|
color: projectColorKeySchema.optional().nullable(),
|
|
136
191
|
workspace: z.string().optional(),
|
|
137
192
|
repos: z.array(z.union([z.string(), gitRepoConfigSchema])).optional(),
|
|
193
|
+
memory: projectMemoryUpdateSchema.optional(),
|
|
138
194
|
});
|
|
139
195
|
/** ADR-076: тело создания SSH-ключа (`POST /api/v2/ssh-keys`). */
|
|
140
196
|
export const sshKeyCreateSchema = z.object({
|
|
@@ -170,6 +226,18 @@ export const promptRequestSchema = z.object({
|
|
|
170
226
|
provider: z.string().optional(),
|
|
171
227
|
agent: z.string().optional(),
|
|
172
228
|
system: z.string().optional(),
|
|
229
|
+
/**
|
|
230
|
+
* ADR-104: режим отправки. `queue` (по умолчанию) — прежнее поведение;
|
|
231
|
+
* `steer` — инъекция в активный ход без прерывания генерации;
|
|
232
|
+
* `interrupt` — прерывание текущей генерации с продолжением хода.
|
|
233
|
+
*/
|
|
234
|
+
mode: z.enum(STEER_MODES).default(DEFAULT_STEER_MODE),
|
|
235
|
+
/**
|
|
236
|
+
* ADR-115: пути объектов вложений в blob-хранилище (`attachments/<sha2>/<sha256>`),
|
|
237
|
+
* полученные из `POST /sessions/:id/attachments`. Аддитивное поле: без него
|
|
238
|
+
* поведение промпта прежнее. Порядок частей сообщения — текст, затем вложения.
|
|
239
|
+
*/
|
|
240
|
+
attachments: z.array(z.string().min(1)).max(50).optional(),
|
|
173
241
|
});
|
|
174
242
|
export const spaLoginSchema = z.object({
|
|
175
243
|
apiKey: z.string().min(1),
|
|
@@ -427,15 +495,38 @@ export const eventIdentitySchema = z.object({
|
|
|
427
495
|
threadKey: z.string().optional(),
|
|
428
496
|
roles: z.array(z.string()).optional(),
|
|
429
497
|
});
|
|
498
|
+
/**
|
|
499
|
+
* ADR-115 × ADR-089: ссылка на вложение внешнего события.
|
|
500
|
+
*
|
|
501
|
+
* `blobPath` ограничен контуром вложений (`attachments/…`) — через событие нельзя
|
|
502
|
+
* сослаться на произвольный объект blob-хранилища (артефакты, логи, скиллы).
|
|
503
|
+
* `sha256` — 64 hex-символа (content-addressed адрес), `mime`/`size` — непустые.
|
|
504
|
+
*/
|
|
505
|
+
export const eventAttachmentRefSchema = z.object({
|
|
506
|
+
blobPath: z
|
|
507
|
+
.string()
|
|
508
|
+
.min(1)
|
|
509
|
+
.max(512)
|
|
510
|
+
.regex(/^attachments\/[A-Za-z0-9][A-Za-z0-9._/-]*$/, 'blobPath должен быть внутри attachments/')
|
|
511
|
+
// `attachments/../…` формально проходит regex — сегменты `..` запрещены явно
|
|
512
|
+
// (паритет с `isAttachmentPath` ядра: ссылка не должна выходить из контура).
|
|
513
|
+
.refine((value) => !value.includes('..'), 'blobPath не должен содержать «..»'),
|
|
514
|
+
sha256: z.string().regex(/^[0-9a-f]{64}$/, 'sha256 должен быть 64 hex-символа'),
|
|
515
|
+
mime: z.string().min(1).max(255),
|
|
516
|
+
size: z.number().int().positive(),
|
|
517
|
+
name: z.string().min(1).max(200).optional(),
|
|
518
|
+
});
|
|
430
519
|
/** ADR-089: схема нормализованного внешнего события (`payload` не типизируется). */
|
|
431
520
|
export const synthEventSchema = z.object({
|
|
432
521
|
id: z.string().min(1),
|
|
433
522
|
source: z.string().min(1),
|
|
434
523
|
type: z.string().min(1),
|
|
435
524
|
payload: z.unknown(),
|
|
436
|
-
identity: eventIdentitySchema.
|
|
525
|
+
identity: eventIdentitySchema.prefault({}),
|
|
437
526
|
dedupKey: z.string().min(1),
|
|
438
527
|
ts: z.string().min(1),
|
|
528
|
+
// ADR-115 × ADR-089: ссылки на вложения (аддитивно).
|
|
529
|
+
attachments: z.array(eventAttachmentRefSchema).optional(),
|
|
439
530
|
});
|
|
440
531
|
/** ADR-089: режимы доставки `EventBinding` (без `drop`). */
|
|
441
532
|
const eventDeliveryModeSchema = z.enum(['bound', 'ephemeral', 'queue']);
|
|
@@ -472,15 +563,35 @@ export const sessionRequestSchema = z.object({
|
|
|
472
563
|
/**
|
|
473
564
|
* ADR-089: вход приёма внешнего события (`POST /api/v2/events`). `id`/`dedupKey`/`ts`
|
|
474
565
|
* нормализуются `EventIngress`, поэтому здесь опциональны.
|
|
566
|
+
*
|
|
567
|
+
* ADR-115 × ADR-089: `attachments[]` — до 10 ссылок на вложения (жёсткий предел;
|
|
568
|
+
* фактический лимит `attachments.maxFilesPerMessage` проверяет ingress). Если
|
|
569
|
+
* вложения переданы, `dedupKey` **обязателен**: ключ идемпотентности по умолчанию
|
|
570
|
+
* строится из `payload` и для бинарного содержимого нестабилен.
|
|
475
571
|
*/
|
|
476
|
-
|
|
572
|
+
const eventIngestBaseSchema = z.object({
|
|
477
573
|
source: z.string().min(1),
|
|
478
574
|
type: z.string().min(1),
|
|
479
575
|
payload: z.unknown().optional(),
|
|
480
576
|
identity: eventIdentitySchema.optional(),
|
|
481
|
-
dedupKey: z.string().optional(),
|
|
577
|
+
dedupKey: z.string().min(1).optional(),
|
|
482
578
|
ts: z.string().optional(),
|
|
579
|
+
attachments: z.array(eventAttachmentRefSchema).max(10).optional(),
|
|
483
580
|
});
|
|
581
|
+
/**
|
|
582
|
+
* ADR-115 × ADR-089: вложения без явного `dedupKey` — отказ на уровне схемы
|
|
583
|
+
* (`400 VALIDATION_ERROR`), иначе дедуп-ключ зависел бы от содержимого вложений.
|
|
584
|
+
*/
|
|
585
|
+
function requireDedupKeyForAttachments(value, ctx) {
|
|
586
|
+
if (Array.isArray(value.attachments) && value.attachments.length > 0 && !value.dedupKey) {
|
|
587
|
+
ctx.addIssue({
|
|
588
|
+
code: 'custom',
|
|
589
|
+
path: ['dedupKey'],
|
|
590
|
+
message: 'attachments требуют явного dedupKey',
|
|
591
|
+
});
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
export const eventIngestSchema = eventIngestBaseSchema.superRefine(requireDedupKeyForAttachments);
|
|
484
595
|
/** ADR-089: вход upsert биндинга (`POST /api/v2/events/bindings`) — без `id`. */
|
|
485
596
|
export const eventBindingInputSchema = z.object({
|
|
486
597
|
source: z.string().min(1),
|
|
@@ -533,8 +644,11 @@ export const eventBindingApiKeyCreatedSchema = eventBindingApiKeySchema.extend({
|
|
|
533
644
|
/**
|
|
534
645
|
* ADR-089: вход `POST /events` при аутентификации API-ключом привязки. Как
|
|
535
646
|
* `eventIngestSchema`, но `source` опционален — источник берётся из привязки.
|
|
647
|
+
* ADR-115 × ADR-089: правило «вложения требуют `dedupKey`» действует и здесь.
|
|
536
648
|
*/
|
|
537
|
-
export const eventKeyIngestSchema =
|
|
649
|
+
export const eventKeyIngestSchema = eventIngestBaseSchema
|
|
650
|
+
.partial({ source: true })
|
|
651
|
+
.superRefine(requireDedupKeyForAttachments);
|
|
538
652
|
// --- Service-key (ADR-052, этап I) ---
|
|
539
653
|
/**
|
|
540
654
|
* ADR-052: каталог скоупов service-key + wildcard-семейства. Глобальный `*` не
|
|
@@ -665,25 +779,49 @@ export const scheduleTargetSchema = z.discriminatedUnion('mode', [
|
|
|
665
779
|
ttl: z.string().optional(),
|
|
666
780
|
}),
|
|
667
781
|
z.object({ mode: z.literal('queue'), sessionId: z.string().min(1) }),
|
|
782
|
+
// ADR-101: прямой запуск прогона пайплайна (событие в Router не публикуется).
|
|
783
|
+
z.object({
|
|
784
|
+
mode: z.literal('pipeline'),
|
|
785
|
+
projectId: z.string().min(1),
|
|
786
|
+
pipelineId: z.string().min(1),
|
|
787
|
+
version: z.number().int().min(1).optional(),
|
|
788
|
+
payload: z.record(z.string(), z.unknown()).optional(),
|
|
789
|
+
}),
|
|
668
790
|
]);
|
|
791
|
+
/**
|
|
792
|
+
* ADR-089: ссылка на шаг пайплайна — «эта сессия — шаг `step` пайплайна `id`».
|
|
793
|
+
* Допустима только в целях `ephemeral`/`bind` (там, где решение порождает
|
|
794
|
+
* сессию); в `bound`/`queue` сессия фиксирована — поле там отвергается.
|
|
795
|
+
*/
|
|
796
|
+
export const pipelineRefSchema = z.object({
|
|
797
|
+
id: z.string().min(1),
|
|
798
|
+
step: z.string().min(1),
|
|
799
|
+
});
|
|
669
800
|
/**
|
|
670
801
|
* ADR-089: цель правила маршрутизации — дискриминированный союз по `mode`
|
|
671
802
|
* (семантика та же, что у `scheduleTargetSchema`).
|
|
803
|
+
*
|
|
804
|
+
* `pipeline` (ссылка на шаг пайплайна) допустим только в `ephemeral`/`bind`;
|
|
805
|
+
* в `bound`/`queue` сессия фиксирована, поэтому варианты **строгие**
|
|
806
|
+
* (`.strict()`): лишние поля (в т.ч. `pipeline`) там **отвергаются**, а не
|
|
807
|
+
* игнорируются — иначе ошибка конфигурации правила проходила бы молча.
|
|
672
808
|
*/
|
|
673
809
|
export const eventRouteTargetSchema = z.discriminatedUnion('mode', [
|
|
674
|
-
z.object({ mode: z.literal('bound'), sessionId: z.string().min(1) }),
|
|
810
|
+
z.object({ mode: z.literal('bound'), sessionId: z.string().min(1) }).strict(),
|
|
675
811
|
z.object({
|
|
676
812
|
mode: z.literal('ephemeral'),
|
|
677
813
|
agentTemplate: z.string().optional(),
|
|
678
814
|
project: z.string().optional(),
|
|
679
815
|
ttl: z.string().optional(),
|
|
816
|
+
pipeline: pipelineRefSchema.optional(),
|
|
680
817
|
}),
|
|
681
|
-
z.object({ mode: z.literal('queue'), sessionId: z.string().min(1) }),
|
|
818
|
+
z.object({ mode: z.literal('queue'), sessionId: z.string().min(1) }).strict(),
|
|
682
819
|
// ADR-089 (auto-bind): цель закрепляет внешний адрес за сессией (binding создаёт Router).
|
|
683
820
|
z.object({
|
|
684
821
|
mode: z.literal('bind'),
|
|
685
822
|
agentTemplate: z.string().optional(),
|
|
686
823
|
project: z.string().optional(),
|
|
824
|
+
pipeline: pipelineRefSchema.optional(),
|
|
687
825
|
}),
|
|
688
826
|
]);
|
|
689
827
|
/** ADR-089: условие срабатывания правила (AND по заполненным полям). */
|
|
@@ -744,7 +882,7 @@ export const scheduleInputSchema = z
|
|
|
744
882
|
every: z.string().optional(),
|
|
745
883
|
target: scheduleTargetSchema,
|
|
746
884
|
prompt: z.string().optional(),
|
|
747
|
-
payload: z.record(z.unknown()).optional(),
|
|
885
|
+
payload: z.record(z.string(), z.unknown()).optional(),
|
|
748
886
|
ownerId: z.string().optional(),
|
|
749
887
|
catchUp: z.enum(['skip', 'once']).optional(),
|
|
750
888
|
})
|
|
@@ -759,7 +897,7 @@ export const scheduleSchema = z
|
|
|
759
897
|
every: z.string().optional(),
|
|
760
898
|
target: scheduleTargetSchema,
|
|
761
899
|
prompt: z.string().optional(),
|
|
762
|
-
payload: z.record(z.unknown()).optional(),
|
|
900
|
+
payload: z.record(z.string(), z.unknown()).optional(),
|
|
763
901
|
ownerId: z.string().optional(),
|
|
764
902
|
catchUp: z.enum(['skip', 'once']).optional(),
|
|
765
903
|
createdAt: z.string().min(1),
|
|
@@ -784,26 +922,29 @@ export const scheduleJobSchema = z.object({
|
|
|
784
922
|
durationMs: z.number(),
|
|
785
923
|
target: scheduleTargetSchema,
|
|
786
924
|
dedupKey: z.string().optional(),
|
|
787
|
-
|
|
925
|
+
// ADR-101: `pipeline` — пометка прямого запуска прогона (не решение Router).
|
|
926
|
+
decision: z.enum(['bound', 'queue', 'ephemeral', 'bind', 'drop', 'pipeline']).optional(),
|
|
788
927
|
reason: z.string().optional(),
|
|
789
928
|
sessionId: z.string().optional(),
|
|
929
|
+
pipelineId: z.string().optional(),
|
|
930
|
+
runId: z.string().optional(),
|
|
790
931
|
error: z.string().optional(),
|
|
791
932
|
});
|
|
792
|
-
/**
|
|
933
|
+
/** ADR-102: семейство роллапов аналитики (`usage`/`activity`/`decision`/`prompt`). */
|
|
793
934
|
export const analyticsFamilySchema = z.enum(ANALYTICS_FAMILIES);
|
|
794
|
-
/**
|
|
935
|
+
/** ADR-102: ось измерения роллапа (`day`/`user`/`project`/`model`/`agent`/`provider`). */
|
|
795
936
|
export const analyticsDimensionSchema = z.enum(ANALYTICS_DIMENSIONS);
|
|
796
|
-
/**
|
|
937
|
+
/** ADR-102: сутки UTC в формате `YYYY-MM-DD`. */
|
|
797
938
|
export const analyticsDaySchema = z.string().regex(/^\d{4}-\d{2}-\d{2}$/);
|
|
798
|
-
/**
|
|
939
|
+
/** ADR-102: пред-агрегированный бакет роллапа (запись через порт хранения). */
|
|
799
940
|
export const analyticsRollupBucketSchema = z.object({
|
|
800
941
|
family: analyticsFamilySchema,
|
|
801
942
|
day: analyticsDaySchema,
|
|
802
|
-
dimensions: z.record(z.string(), z.string()).
|
|
943
|
+
dimensions: z.record(z.string(), z.string()).prefault({}),
|
|
803
944
|
measures: z.record(z.string(), z.number()),
|
|
804
945
|
costByCurrency: z.record(z.string(), z.number()).optional(),
|
|
805
946
|
});
|
|
806
|
-
/**
|
|
947
|
+
/** ADR-102: запрос среза/серии роллапов (только чтение). */
|
|
807
948
|
export const analyticsRollupQuerySchema = z.object({
|
|
808
949
|
family: analyticsFamilySchema,
|
|
809
950
|
from: analyticsDaySchema.optional(),
|
|
@@ -812,15 +953,15 @@ export const analyticsRollupQuerySchema = z.object({
|
|
|
812
953
|
groupBy: z.array(analyticsDimensionSchema).optional(),
|
|
813
954
|
});
|
|
814
955
|
/**
|
|
815
|
-
*
|
|
956
|
+
* ADR-102: строка отчёта — оси группировки + меры (сырые счётчики и
|
|
816
957
|
* дериваты `ANALYTICS_DERIVED_MEASURES`). `costByCurrency` опускается, если пусто.
|
|
817
958
|
*/
|
|
818
959
|
export const analyticsReportRowSchema = z.object({
|
|
819
|
-
dimensions: z.record(z.string(), z.string()).
|
|
960
|
+
dimensions: z.record(z.string(), z.string()).prefault({}),
|
|
820
961
|
measures: z.record(z.string(), z.number()),
|
|
821
962
|
costByCurrency: z.record(z.string(), z.number()).optional(),
|
|
822
963
|
});
|
|
823
|
-
/**
|
|
964
|
+
/** ADR-102: отчёт по семейству за период (только чтение, данные без i18n). */
|
|
824
965
|
export const analyticsReportSchema = z.object({
|
|
825
966
|
report: analyticsFamilySchema,
|
|
826
967
|
from: analyticsDaySchema,
|
|
@@ -828,9 +969,9 @@ export const analyticsReportSchema = z.object({
|
|
|
828
969
|
groupBy: z.array(analyticsDimensionSchema),
|
|
829
970
|
rows: z.array(analyticsReportRowSchema),
|
|
830
971
|
});
|
|
831
|
-
/**
|
|
972
|
+
/** ADR-102: формат выгрузки отчёта (`csv`/`json`; только данные). */
|
|
832
973
|
export const analyticsExportFormatSchema = z.enum(ANALYTICS_EXPORT_FORMATS);
|
|
833
|
-
/**
|
|
974
|
+
/** ADR-102: сводка инстанса за период — агрегаты `usage`/`activity`/`decision`. */
|
|
834
975
|
export const analyticsSummarySchema = z.object({
|
|
835
976
|
from: analyticsDaySchema,
|
|
836
977
|
to: analyticsDaySchema,
|
|
@@ -839,3 +980,23 @@ export const analyticsSummarySchema = z.object({
|
|
|
839
980
|
decision: z.record(z.string(), z.number()),
|
|
840
981
|
costByCurrency: z.record(z.string(), z.number()).optional(),
|
|
841
982
|
});
|
|
983
|
+
// --- Медиа-часть сообщения (ADR-115) ---
|
|
984
|
+
/** Медиа-типы части сообщения (ADR-115) — вложение. */
|
|
985
|
+
export const mediaPartTypeSchema = z.enum(['image', 'audio', 'video', 'file']);
|
|
986
|
+
/**
|
|
987
|
+
* ADR-115 §«Модель контента»: данные медиа-части — ссылка на blob в
|
|
988
|
+
* blob-хранилище + метаданные. Обязательны `blobPath`/`sha256`/`mime`/`size`;
|
|
989
|
+
* остальное — необязательные метаданные (имя, размеры, длительность,
|
|
990
|
+
* текстовая расшифровка).
|
|
991
|
+
*/
|
|
992
|
+
export const mediaPartSchema = z.object({
|
|
993
|
+
blobPath: z.string().min(1),
|
|
994
|
+
sha256: z.string().min(1),
|
|
995
|
+
mime: z.string().min(1),
|
|
996
|
+
size: z.number().int().min(0),
|
|
997
|
+
name: z.string().optional(),
|
|
998
|
+
width: z.number().int().min(0).optional(),
|
|
999
|
+
height: z.number().int().min(0).optional(),
|
|
1000
|
+
durationMs: z.number().int().min(0).optional(),
|
|
1001
|
+
transcript: z.string().optional(),
|
|
1002
|
+
});
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* ADR-102: аналитика и отчётность инстанса — контракт пред-агрегированных
|
|
3
3
|
* суточных роллапов.
|
|
4
4
|
*
|
|
5
5
|
* Единица роллапа — **сутки в UTC**. Хранилище держит **сырые счётчики**
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* итоги по валютам) считает сервис на чтении. Роллапы агрегированы: текстов
|
|
8
8
|
* сообщений, содержимого промптов, ключей и PII в значениях нет.
|
|
9
9
|
*/
|
|
10
|
-
/** Семейства роллапов (
|
|
10
|
+
/** Семейства роллапов (ADR-102 §2). */
|
|
11
11
|
export declare const ANALYTICS_FAMILIES: readonly ["usage", "activity", "decision", "prompt"];
|
|
12
12
|
export type AnalyticsFamily = (typeof ANALYTICS_FAMILIES)[number];
|
|
13
13
|
/**
|
|
@@ -65,12 +65,12 @@ export interface AnalyticsRollupRow {
|
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
67
|
* Дериваты, которые сервис считает **на чтении** из сырых счётчиков (не
|
|
68
|
-
* персистятся,
|
|
68
|
+
* персистятся, ADR-102 §2). В строке отчёта лежат рядом с сырыми мерами; при
|
|
69
69
|
* экспорте выносятся отдельными колонками после сырых мер.
|
|
70
70
|
*/
|
|
71
71
|
export declare const ANALYTICS_DERIVED_MEASURES: readonly ["total_tokens", "cache_hit_rate", "reasoning_ratio", "output_tps"];
|
|
72
72
|
export type AnalyticsDerivedMeasure = (typeof ANALYTICS_DERIVED_MEASURES)[number];
|
|
73
|
-
/** Идентификатор отчёта — совпадает с семейством роллапов (
|
|
73
|
+
/** Идентификатор отчёта — совпадает с семейством роллапов (ADR-102 §4). */
|
|
74
74
|
export type AnalyticsReportKind = AnalyticsFamily;
|
|
75
75
|
/** Строка отчёта: оси группировки + меры (в т.ч. дериваты) + стоимость. */
|
|
76
76
|
export interface AnalyticsReportRow {
|
|
@@ -81,7 +81,7 @@ export interface AnalyticsReportRow {
|
|
|
81
81
|
/** Разбивка стоимости по валютам; пустая — поле опускается. */
|
|
82
82
|
costByCurrency?: Record<string, number>;
|
|
83
83
|
}
|
|
84
|
-
/** Отчёт по семейству за период (только чтение,
|
|
84
|
+
/** Отчёт по семейству за период (только чтение, ADR-102 §4). */
|
|
85
85
|
export interface AnalyticsReport {
|
|
86
86
|
report: AnalyticsReportKind;
|
|
87
87
|
/** Начало периода включительно (`YYYY-MM-DD`, UTC). */
|
|
@@ -92,7 +92,7 @@ export interface AnalyticsReport {
|
|
|
92
92
|
groupBy: AnalyticsDimension[];
|
|
93
93
|
rows: AnalyticsReportRow[];
|
|
94
94
|
}
|
|
95
|
-
/** Формат выгрузки отчёта (server-side, только данные —
|
|
95
|
+
/** Формат выгрузки отчёта (server-side, только данные — ADR-102 §6). */
|
|
96
96
|
export declare const ANALYTICS_EXPORT_FORMATS: readonly ["csv", "json"];
|
|
97
97
|
export type AnalyticsExportFormat = (typeof ANALYTICS_EXPORT_FORMATS)[number];
|
|
98
98
|
/**
|
package/dist/types/analytics.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* ADR-102: аналитика и отчётность инстанса — контракт пред-агрегированных
|
|
3
3
|
* суточных роллапов.
|
|
4
4
|
*
|
|
5
5
|
* Единица роллапа — **сутки в UTC**. Хранилище держит **сырые счётчики**
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* итоги по валютам) считает сервис на чтении. Роллапы агрегированы: текстов
|
|
8
8
|
* сообщений, содержимого промптов, ключей и PII в значениях нет.
|
|
9
9
|
*/
|
|
10
|
-
/** Семейства роллапов (
|
|
10
|
+
/** Семейства роллапов (ADR-102 §2). */
|
|
11
11
|
export const ANALYTICS_FAMILIES = ['usage', 'activity', 'decision', 'prompt'];
|
|
12
12
|
/**
|
|
13
13
|
* Оси измерений роллапа. Короткие ключи `dimensions`; `day` — отдельное поле
|
|
@@ -48,7 +48,7 @@ export const ANALYTICS_MEASURES_BY_FAMILY = {
|
|
|
48
48
|
};
|
|
49
49
|
/**
|
|
50
50
|
* Дериваты, которые сервис считает **на чтении** из сырых счётчиков (не
|
|
51
|
-
* персистятся,
|
|
51
|
+
* персистятся, ADR-102 §2). В строке отчёта лежат рядом с сырыми мерами; при
|
|
52
52
|
* экспорте выносятся отдельными колонками после сырых мер.
|
|
53
53
|
*/
|
|
54
54
|
export const ANALYTICS_DERIVED_MEASURES = [
|
|
@@ -57,5 +57,5 @@ export const ANALYTICS_DERIVED_MEASURES = [
|
|
|
57
57
|
'reasoning_ratio',
|
|
58
58
|
'output_tps',
|
|
59
59
|
];
|
|
60
|
-
/** Формат выгрузки отчёта (server-side, только данные —
|
|
60
|
+
/** Формат выгрузки отчёта (server-side, только данные — ADR-102 §6). */
|
|
61
61
|
export const ANALYTICS_EXPORT_FORMATS = ['csv', 'json'];
|