@itphx/synth-sdk 0.11.3 → 0.13.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/client.d.ts +123 -6
- package/dist/client.js +49 -6
- package/dist/index.d.ts +1 -1
- package/dist/types.d.ts +328 -7
- package/package.json +2 -2
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ChatCompletionsRequest, ChatCompletionsResponse, EventBinding, EventBindingApiKey, EventBindingApiKeyCreateRequest, EventBindingApiKeyCreated, EventBindingApiKeyUpdateRequest, EventBindingInputRequest, EventIngestRequest, EventIngestResponse, EventJournalEntry, EventRouteRule, EventRouteRuleUpsertRequest, Schedule, ScheduleInput, ScheduleJob, SerializedSession, SessionCreateInput, SessionMessagesResponse, SessionPatch, SessionPromptInput, SessionStatusResponse } from './types.js';
|
|
1
|
+
import type { ChatCompletionsRequest, ChatCompletionsResponse, EventBinding, EventBindingApiKey, EventBindingApiKeyCreateRequest, EventBindingApiKeyCreated, EventBindingApiKeyUpdateRequest, EventBindingInputRequest, EventIngestRequest, EventIngestResponse, EventJournalEntry, EventRouteRule, EventRouteRuleUpsertRequest, FsListParams, FsListResult, FsReadParams, FsReadResult, GitCommitParams, GitCommitResult, InstanceCapabilities, ModelListResponse, ModelsListParams, PipelineRunResponse, ProjectListResponse, ProjectPipelinesResponse, PromptAcceptedResponse, Schedule, ScheduleInput, ScheduleJob, SerializedProject, SerializedSession, SessionCreateInput, SessionListResponse, SessionMessagesResponse, SessionPatch, SessionPromptInput, SessionStatusResponse } from './types.js';
|
|
2
2
|
/** Базовый путь API v2 по умолчанию. */
|
|
3
3
|
export declare const DEFAULT_API_PATH = "/api/v2";
|
|
4
4
|
/** Значения query-параметров (`null`/`undefined` пропускаются). */
|
|
@@ -18,14 +18,67 @@ export interface SynthClientOptions {
|
|
|
18
18
|
/** Базовый путь API (по умолчанию `/api/v2`). */
|
|
19
19
|
apiPath?: string;
|
|
20
20
|
}
|
|
21
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Query-параметры списка сессий.
|
|
23
|
+
*
|
|
24
|
+
* Пагинация обязательна: `limit` (по умолчанию 100, максимум 500) и `offset`.
|
|
25
|
+
* Ответ — страница `SessionListResponse`, а не массив.
|
|
26
|
+
*/
|
|
22
27
|
export interface SessionsListParams {
|
|
23
28
|
project_id?: string;
|
|
29
|
+
/** Размер страницы (1..500). */
|
|
30
|
+
limit?: number;
|
|
31
|
+
/** Смещение страницы (с 0). */
|
|
32
|
+
offset?: number;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Query-параметры страницы истории сообщений.
|
|
36
|
+
*
|
|
37
|
+
* `before` — исключающий курсор по `seq`: вернутся сообщения строго старше.
|
|
38
|
+
*/
|
|
39
|
+
export interface SessionMessagesParams {
|
|
40
|
+
/** Размер страницы (1..500; по умолчанию 200). */
|
|
41
|
+
limit?: number;
|
|
42
|
+
/** Курсор: сообщения строго старше указанного `seq`. */
|
|
43
|
+
before?: number;
|
|
24
44
|
}
|
|
25
45
|
/** Query-параметры журнала событий. */
|
|
26
46
|
export interface EventJournalParams {
|
|
27
47
|
limit?: number;
|
|
28
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Query-параметры списка проектов.
|
|
51
|
+
*
|
|
52
|
+
* Пагинация обязательна: `limit` (по умолчанию 100, максимум 500) и `offset`.
|
|
53
|
+
* Ответ — страница `ProjectListResponse`, а не массив.
|
|
54
|
+
*/
|
|
55
|
+
export interface ProjectsListParams {
|
|
56
|
+
/** Размер страницы (1..500). */
|
|
57
|
+
limit?: number;
|
|
58
|
+
/** Смещение страницы (с 0). */
|
|
59
|
+
offset?: number;
|
|
60
|
+
}
|
|
61
|
+
/** Query-параметры списка пайплайнов проекта. */
|
|
62
|
+
export interface ProjectPipelinesParams {
|
|
63
|
+
/** Размер страницы (1..500; по умолчанию 100). */
|
|
64
|
+
limit?: number;
|
|
65
|
+
/** Смещение страницы (с 0). */
|
|
66
|
+
offset?: number;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Query-параметры журнала прогона.
|
|
70
|
+
*
|
|
71
|
+
* `events_before` — исключающий курсор: вернутся события строго раньше
|
|
72
|
+
* указанного. Каноническая форма — **порядковый номер события** в журнале
|
|
73
|
+
* прогона (число, нумерация с нуля); сервер принимает и метку времени
|
|
74
|
+
* (`ts`, ISO-8601) — тогда отбираются события строго старше по времени.
|
|
75
|
+
*/
|
|
76
|
+
export interface PipelineRunParams {
|
|
77
|
+
/** Размер страницы журнала (1..500; по умолчанию 200). */
|
|
78
|
+
events_limit?: number;
|
|
79
|
+
/** Курсор: номер события (канонично) или метка времени `ts`. */
|
|
80
|
+
events_before?: number | string;
|
|
81
|
+
}
|
|
29
82
|
/** Query-параметры Job-истории расписания. */
|
|
30
83
|
export interface ScheduleJobsParams {
|
|
31
84
|
limit?: number;
|
|
@@ -56,14 +109,16 @@ export interface EventsNamespace {
|
|
|
56
109
|
}
|
|
57
110
|
/** Namespace `sessions`. */
|
|
58
111
|
export interface SessionsNamespace {
|
|
59
|
-
|
|
112
|
+
/** Страница списка сессий (`{sessions, total, offset, limit, next_offset}`). */
|
|
113
|
+
list(params?: SessionsListParams): Promise<SessionListResponse>;
|
|
60
114
|
create(body: SessionCreateInput): Promise<SerializedSession>;
|
|
61
115
|
get(id: string): Promise<SerializedSession>;
|
|
62
116
|
patch(id: string, body: SessionPatch): Promise<SerializedSession>;
|
|
63
117
|
remove(id: string): Promise<void>;
|
|
64
|
-
/** Отправка
|
|
65
|
-
prompt(id: string, body: SessionPromptInput): Promise<
|
|
66
|
-
messages
|
|
118
|
+
/** Отправка сообщения: `202 {messageId, mode, position}` (ADR-118 §3); наблюдение — по шине событий. */
|
|
119
|
+
prompt(id: string, body: SessionPromptInput): Promise<PromptAcceptedResponse>;
|
|
120
|
+
/** Страница истории сообщений (`{messages, session_id, has_more, next_before}`). */
|
|
121
|
+
messages(id: string, params?: SessionMessagesParams): Promise<SessionMessagesResponse>;
|
|
67
122
|
status(id: string): Promise<SessionStatusResponse>;
|
|
68
123
|
}
|
|
69
124
|
/** Namespace `schedules` (ADR-051). */
|
|
@@ -79,6 +134,55 @@ export interface SchedulesNamespace {
|
|
|
79
134
|
export interface LlmNamespace {
|
|
80
135
|
chatCompletions(body: ChatCompletionsRequest): Promise<ChatCompletionsResponse>;
|
|
81
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* Namespace `models` — каталог моделей инстанца.
|
|
139
|
+
*
|
|
140
|
+
* Список — **страница** `{models, total, offset, limit, next_offset}`; поиск
|
|
141
|
+
* (`search`) и фильтры (`provider`/`modality`/`enabled`) — на сервере.
|
|
142
|
+
*/
|
|
143
|
+
export interface ModelsNamespace {
|
|
144
|
+
/** Страница каталога моделей. */
|
|
145
|
+
list(params?: ModelsListParams): Promise<ModelListResponse>;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* Namespace `fs` — файлы и каталоги рабочего каталога проекта.
|
|
149
|
+
*
|
|
150
|
+
* Чтение файла ограничено по размеру (`FILE_TOO_LARGE`); рекурсивный листинг
|
|
151
|
+
* ограничен по глубине и числу записей (`truncated`).
|
|
152
|
+
*/
|
|
153
|
+
export interface FsNamespace {
|
|
154
|
+
/** Содержимое файла (`GET /fs/read`). */
|
|
155
|
+
read(params: FsReadParams): Promise<FsReadResult>;
|
|
156
|
+
/** Список каталога (`GET /fs`). */
|
|
157
|
+
list(params?: FsListParams): Promise<FsListResult>;
|
|
158
|
+
}
|
|
159
|
+
/** Namespace `git` — детали коммита (ADR-076). */
|
|
160
|
+
export interface GitNamespace {
|
|
161
|
+
/** Коммит с файлами и diff (`GET /git/commit`); diff может быть обрезан. */
|
|
162
|
+
commit(params: GitCommitParams): Promise<GitCommitResult>;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Namespace `projects`.
|
|
166
|
+
*
|
|
167
|
+
* Список — **страница** (`{projects, total, offset, limit, next_offset}`) со
|
|
168
|
+
* сводкой-DTO: тяжёлые поля `log`/`plan` в списке не отдаются (деталь — полный
|
|
169
|
+
* DTO).
|
|
170
|
+
*/
|
|
171
|
+
export interface ProjectsNamespace {
|
|
172
|
+
/** Страница списка проектов. */
|
|
173
|
+
list(params?: ProjectsListParams): Promise<ProjectListResponse>;
|
|
174
|
+
/** Проект по id (полный DTO — с `log`/`plan`). */
|
|
175
|
+
get(id: string): Promise<SerializedProject>;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Namespace `pipelines` (ADR-101): пайплайны проекта и прогон с журналом.
|
|
179
|
+
*/
|
|
180
|
+
export interface PipelinesNamespace {
|
|
181
|
+
/** Страница пайплайнов проекта (сводка — без черновика `draft`). */
|
|
182
|
+
projectPipelines(projectId: string, params?: ProjectPipelinesParams): Promise<ProjectPipelinesResponse>;
|
|
183
|
+
/** Прогон + страница журнала (`events_limit`/`events_before`). */
|
|
184
|
+
run(runId: string, params?: PipelineRunParams): Promise<PipelineRunResponse>;
|
|
185
|
+
}
|
|
82
186
|
/**
|
|
83
187
|
* Клиент публичного API Synth.
|
|
84
188
|
*
|
|
@@ -93,10 +197,23 @@ export declare class SynthClient {
|
|
|
93
197
|
readonly events: EventsNamespace;
|
|
94
198
|
readonly sessions: SessionsNamespace;
|
|
95
199
|
readonly schedules: SchedulesNamespace;
|
|
200
|
+
readonly projects: ProjectsNamespace;
|
|
201
|
+
readonly pipelines: PipelinesNamespace;
|
|
96
202
|
readonly llm: LlmNamespace;
|
|
203
|
+
readonly models: ModelsNamespace;
|
|
204
|
+
readonly fs: FsNamespace;
|
|
205
|
+
readonly git: GitNamespace;
|
|
97
206
|
private readonly _fetch?;
|
|
98
207
|
private readonly _token?;
|
|
99
208
|
constructor(options: SynthClientOptions);
|
|
209
|
+
/**
|
|
210
|
+
* Возможности инстанса (`GET /meta`, ADR-118 §8) — **без аутентификации**.
|
|
211
|
+
*
|
|
212
|
+
* Публичная информация о протоколе инстанса: клиент сверяет свою модель
|
|
213
|
+
* сообщений с серверной через `supportsMessageModel` (fail-closed). Креды
|
|
214
|
+
* не отправляются даже если они заданы в опциях.
|
|
215
|
+
*/
|
|
216
|
+
meta(): Promise<InstanceCapabilities>;
|
|
100
217
|
private _resolveFetch;
|
|
101
218
|
private _buildUrl;
|
|
102
219
|
private _request;
|
package/dist/client.js
CHANGED
|
@@ -29,7 +29,12 @@ export class SynthClient {
|
|
|
29
29
|
events;
|
|
30
30
|
sessions;
|
|
31
31
|
schedules;
|
|
32
|
+
projects;
|
|
33
|
+
pipelines;
|
|
32
34
|
llm;
|
|
35
|
+
models;
|
|
36
|
+
fs;
|
|
37
|
+
git;
|
|
33
38
|
_fetch;
|
|
34
39
|
_token;
|
|
35
40
|
constructor(options) {
|
|
@@ -78,9 +83,10 @@ export class SynthClient {
|
|
|
78
83
|
prompt: (id, body) => this._request(`/sessions/${encodeURIComponent(id)}/prompt`, {
|
|
79
84
|
method: 'POST',
|
|
80
85
|
body,
|
|
81
|
-
raw: true,
|
|
82
86
|
}),
|
|
83
|
-
messages: (id) => this._request(`/sessions/${encodeURIComponent(id)}/messages
|
|
87
|
+
messages: (id, params) => this._request(`/sessions/${encodeURIComponent(id)}/messages`, {
|
|
88
|
+
query: params,
|
|
89
|
+
}),
|
|
84
90
|
status: (id) => this._request(`/sessions/${encodeURIComponent(id)}/status`),
|
|
85
91
|
};
|
|
86
92
|
this.schedules = {
|
|
@@ -104,6 +110,46 @@ export class SynthClient {
|
|
|
104
110
|
body,
|
|
105
111
|
}),
|
|
106
112
|
};
|
|
113
|
+
this.projects = {
|
|
114
|
+
list: (params) => this._request('/projects', {
|
|
115
|
+
query: params,
|
|
116
|
+
}),
|
|
117
|
+
get: (id) => this._request(`/projects/${encodeURIComponent(id)}`),
|
|
118
|
+
};
|
|
119
|
+
this.pipelines = {
|
|
120
|
+
projectPipelines: (projectId, params) => this._request(`/projects/${encodeURIComponent(projectId)}/pipelines`, { query: params }),
|
|
121
|
+
run: (runId, params) => this._request(`/pipeline-runs/${encodeURIComponent(runId)}`, {
|
|
122
|
+
query: params,
|
|
123
|
+
}),
|
|
124
|
+
};
|
|
125
|
+
this.models = {
|
|
126
|
+
list: (params) => this._request('/models', {
|
|
127
|
+
query: params,
|
|
128
|
+
}),
|
|
129
|
+
};
|
|
130
|
+
this.fs = {
|
|
131
|
+
read: (params) => this._request('/fs/read', {
|
|
132
|
+
query: params,
|
|
133
|
+
}),
|
|
134
|
+
list: (params) => this._request('/fs', {
|
|
135
|
+
query: params,
|
|
136
|
+
}),
|
|
137
|
+
};
|
|
138
|
+
this.git = {
|
|
139
|
+
commit: (params) => this._request('/git/commit', {
|
|
140
|
+
query: params,
|
|
141
|
+
}),
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Возможности инстанса (`GET /meta`, ADR-118 §8) — **без аутентификации**.
|
|
146
|
+
*
|
|
147
|
+
* Публичная информация о протоколе инстанса: клиент сверяет свою модель
|
|
148
|
+
* сообщений с серверной через `supportsMessageModel` (fail-closed). Креды
|
|
149
|
+
* не отправляются даже если они заданы в опциях.
|
|
150
|
+
*/
|
|
151
|
+
meta() {
|
|
152
|
+
return this._request('/meta', { anonymous: true });
|
|
107
153
|
}
|
|
108
154
|
_resolveFetch() {
|
|
109
155
|
const impl = this._fetch ?? globalThis.fetch;
|
|
@@ -134,7 +180,7 @@ export class SynthClient {
|
|
|
134
180
|
const headers = { Accept: 'application/json', ...options.headers };
|
|
135
181
|
if (options.body !== undefined)
|
|
136
182
|
headers['Content-Type'] = 'application/json';
|
|
137
|
-
if (this._token)
|
|
183
|
+
if (this._token && !options.anonymous)
|
|
138
184
|
headers.Authorization = `Bearer ${this._token}`;
|
|
139
185
|
const fetchImpl = this._resolveFetch();
|
|
140
186
|
let response;
|
|
@@ -156,9 +202,6 @@ export class SynthClient {
|
|
|
156
202
|
if (!response.ok) {
|
|
157
203
|
throw await this._httpError(response);
|
|
158
204
|
}
|
|
159
|
-
if (options.raw) {
|
|
160
|
-
return response;
|
|
161
|
-
}
|
|
162
205
|
if (response.status === 204) {
|
|
163
206
|
return undefined;
|
|
164
207
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* ```
|
|
15
15
|
*/
|
|
16
16
|
export { SynthClient, createSynthClient, DEFAULT_API_PATH } from './client.js';
|
|
17
|
-
export type { SynthClientOptions, SynthQuery, EventsNamespace, SessionsNamespace, SchedulesNamespace, LlmNamespace, SessionsListParams, EventJournalParams, ScheduleJobsParams, } from './client.js';
|
|
17
|
+
export type { SynthClientOptions, SynthQuery, EventsNamespace, SessionsNamespace, SchedulesNamespace, ProjectsNamespace, PipelinesNamespace, LlmNamespace, ModelsNamespace, FsNamespace, GitNamespace, SessionsListParams, SessionMessagesParams, EventJournalParams, ScheduleJobsParams, ProjectsListParams, ProjectPipelinesParams, PipelineRunParams, } from './client.js';
|
|
18
18
|
export { SynthApiError, isSynthApiError, parseErrorBody, HTTP_ERROR_CODE, NETWORK_ERROR_CODE, } from './errors.js';
|
|
19
19
|
export type { SynthApiErrorInit } from './errors.js';
|
|
20
20
|
export type * from './types.js';
|
package/dist/types.d.ts
CHANGED
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
* срез сериализованной сессии (`serializeSession`) и OpenAI-совместимый
|
|
8
8
|
* контракт LLM-прокси (источник — `public-openapi.ts`).
|
|
9
9
|
*/
|
|
10
|
-
import type { EventBinding, EventBindingApiKey, EventBindingApiKeyCreated, EventRouteRule, RouteDecision, Schedule, ScheduleJob, SynthEvent } from '@itphx/synth-shared/types';
|
|
11
|
-
import type { EventBindingApiKeyCreateRequest, EventBindingApiKeyUpdateRequest, EventBindingInputRequest, EventIngestRequest, EventRouteRuleUpsertRequest, PromptRequest, ScheduleInputRequest, SessionCreateRequest, SessionUpdateRequest } from '@itphx/synth-shared/schemas';
|
|
12
|
-
export type { EventBinding, EventBindingApiKey, EventBindingApiKeyCreateRequest, EventBindingApiKeyCreated, EventBindingApiKeyUpdateRequest, EventBindingInputRequest, EventIngestRequest, EventRouteRule, EventRouteRuleUpsertRequest, PromptRequest, RouteDecision, Schedule, ScheduleInputRequest, ScheduleJob, SessionCreateRequest, SessionUpdateRequest, SynthEvent, };
|
|
10
|
+
import type { CommitDetail, EventBinding, EventBindingApiKey, EventBindingApiKeyCreated, EventRouteRule, FileEntry, InstanceCapabilities, PromptAcceptedResponse, RouteDecision, Schedule, ScheduleJob, SynthEvent } from '@itphx/synth-shared/types';
|
|
11
|
+
import type { EventBindingApiKeyCreateRequest, EventBindingApiKeyUpdateRequest, EventBindingInputRequest, EventIngestRequest, EventRouteRuleUpsertRequest, PromptRequest, PromptRequestInput, ScheduleInputRequest, SessionCreateRequest, SessionUpdateRequest } from '@itphx/synth-shared/schemas';
|
|
12
|
+
export type { CommitDetail, EventBinding, EventBindingApiKey, EventBindingApiKeyCreateRequest, EventBindingApiKeyCreated, EventBindingApiKeyUpdateRequest, EventBindingInputRequest, EventIngestRequest, EventRouteRule, EventRouteRuleUpsertRequest, FileEntry, InstanceCapabilities, PromptAcceptedResponse, PromptRequest, PromptRequestInput, RouteDecision, Schedule, ScheduleInputRequest, ScheduleJob, SessionCreateRequest, SessionUpdateRequest, SynthEvent, };
|
|
13
13
|
/** Тело `POST /sessions` — публичный контракт `SessionCreateRequest` из shared. */
|
|
14
14
|
export type SessionCreateInput = SessionCreateRequest;
|
|
15
15
|
/**
|
|
@@ -21,8 +21,11 @@ export type SessionPatch = SessionUpdateRequest & {
|
|
|
21
21
|
mode?: 'plan' | 'act' | 'yolo';
|
|
22
22
|
project_id?: string | null;
|
|
23
23
|
};
|
|
24
|
-
/**
|
|
25
|
-
|
|
24
|
+
/**
|
|
25
|
+
* Тело `POST /sessions/:id/prompt` — `stream` и `mode` имеют серверные
|
|
26
|
+
* default'ы (`true` и `queue` соответственно, ADR-104).
|
|
27
|
+
*/
|
|
28
|
+
export type SessionPromptInput = Omit<PromptRequestInput, 'stream'> & {
|
|
26
29
|
stream?: boolean;
|
|
27
30
|
};
|
|
28
31
|
/** Тело `POST/PUT /schedules` — `enabled` имеет серверный default `true`. */
|
|
@@ -84,10 +87,72 @@ export interface SerializedSession {
|
|
|
84
87
|
updated_at: string;
|
|
85
88
|
[key: string]: unknown;
|
|
86
89
|
}
|
|
87
|
-
/**
|
|
90
|
+
/**
|
|
91
|
+
* Публичный срез сериализованного сообщения (`serializeMessage` в core).
|
|
92
|
+
*
|
|
93
|
+
* Транспортный DTO в snake_case; это подмножество ответа сервера, неизвестные
|
|
94
|
+
* поля допускаются. Поля `ord`/`turn_id`/`step_index`/`status` — модель хода
|
|
95
|
+
* ADR-118 (`ord` — монотонный порядок записи, `null` у сообщений до ADR-118).
|
|
96
|
+
*/
|
|
97
|
+
export interface SerializedMessage {
|
|
98
|
+
id?: string;
|
|
99
|
+
/** Позиция в отфильтрованном списке истории (перенумеровывается). */
|
|
100
|
+
index?: number;
|
|
101
|
+
/** Порядковый номер в сессии (перенумеровывается). */
|
|
102
|
+
seq?: number;
|
|
103
|
+
/** ADR-118 §2: монотонный порядок записи в историю (`null` — до ADR-118). */
|
|
104
|
+
ord?: number | null;
|
|
105
|
+
/** ADR-118 §1: идентификатор хода, которому принадлежит сообщение. */
|
|
106
|
+
turn_id?: string | null;
|
|
107
|
+
/** ADR-118 §1: индекс шага внутри хода (0-based). */
|
|
108
|
+
step_index?: number | null;
|
|
109
|
+
/** ADR-118 §5: статус сообщения-хода («финал» — смена статуса). */
|
|
110
|
+
status?: 'streaming' | 'completed' | 'cancelled' | 'error' | null;
|
|
111
|
+
role?: string;
|
|
112
|
+
content?: string;
|
|
113
|
+
author?: string | null;
|
|
114
|
+
agent_role?: string | null;
|
|
115
|
+
model?: string | null;
|
|
116
|
+
provider?: string | null;
|
|
117
|
+
ephemeral?: boolean;
|
|
118
|
+
timestamp?: string;
|
|
119
|
+
metadata?: Record<string, unknown> | null;
|
|
120
|
+
tool_calls?: Record<string, unknown>[] | null;
|
|
121
|
+
tool_call_id?: string | null;
|
|
122
|
+
[key: string]: unknown;
|
|
123
|
+
}
|
|
124
|
+
/** Ответ `GET /sessions/:id/messages` — страница истории. */
|
|
88
125
|
export interface SessionMessagesResponse {
|
|
89
|
-
messages:
|
|
126
|
+
messages: SerializedMessage[];
|
|
90
127
|
session_id: string;
|
|
128
|
+
/**
|
|
129
|
+
* Есть ли более старые сообщения за пределами страницы.
|
|
130
|
+
* Старый сервер (без пагинации) поле не отдаёт → `false`.
|
|
131
|
+
*/
|
|
132
|
+
has_more?: boolean;
|
|
133
|
+
/**
|
|
134
|
+
* Курсор следующей (более старой) страницы: минимальный `seq` текущей
|
|
135
|
+
* страницы; `null`, если более старых сообщений нет. Старый сервер — `null`.
|
|
136
|
+
*/
|
|
137
|
+
next_before?: number | null;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Ответ `GET /sessions` — **страница** списка сессий (пагинация обязательна).
|
|
141
|
+
*
|
|
142
|
+
* Список никогда не содержит полной истории: `messages` в DTO отсутствует.
|
|
143
|
+
* Полная история — `GET /sessions/:id/messages`.
|
|
144
|
+
*/
|
|
145
|
+
export interface SessionListResponse {
|
|
146
|
+
/** Сессии текущей страницы. */
|
|
147
|
+
sessions: SerializedSession[];
|
|
148
|
+
/** Всего видимых сессий (после фильтра видимости и `project_id`). */
|
|
149
|
+
total: number;
|
|
150
|
+
/** Смещение текущей страницы. */
|
|
151
|
+
offset: number;
|
|
152
|
+
/** Размер страницы (по умолчанию 100, максимум 500). */
|
|
153
|
+
limit: number;
|
|
154
|
+
/** Курсор следующей страницы; `null` — страница последняя. */
|
|
155
|
+
next_offset: number | null;
|
|
91
156
|
}
|
|
92
157
|
/** Ответ `GET /sessions/:id/status`. */
|
|
93
158
|
export interface SessionStatusResponse {
|
|
@@ -95,6 +160,125 @@ export interface SessionStatusResponse {
|
|
|
95
160
|
pending_count: number;
|
|
96
161
|
processor_running: boolean;
|
|
97
162
|
}
|
|
163
|
+
/**
|
|
164
|
+
* Публичный срез сериализованного проекта (`serializeProjectSummary` в core) —
|
|
165
|
+
* транспортный DTO в snake_case.
|
|
166
|
+
*
|
|
167
|
+
* Сводка списка: тяжёлые поля `log` (журнал проекта) и `plan` (ADR-039) **не
|
|
168
|
+
* отдаются**; полный DTO — в `GET /projects/:id`.
|
|
169
|
+
*/
|
|
170
|
+
export interface SerializedProject {
|
|
171
|
+
id: string;
|
|
172
|
+
origin?: string;
|
|
173
|
+
name: string;
|
|
174
|
+
owner_id: string;
|
|
175
|
+
members: Record<string, string>;
|
|
176
|
+
description: string;
|
|
177
|
+
current_task: string;
|
|
178
|
+
invariants: string;
|
|
179
|
+
icon?: string | null;
|
|
180
|
+
color?: string | null;
|
|
181
|
+
workspace?: string | null;
|
|
182
|
+
repos?: unknown[] | null;
|
|
183
|
+
mcp?: unknown | null;
|
|
184
|
+
memory?: unknown | null;
|
|
185
|
+
status_messages: Array<{
|
|
186
|
+
id: string;
|
|
187
|
+
text: string;
|
|
188
|
+
type: string;
|
|
189
|
+
timestamp: string;
|
|
190
|
+
}>;
|
|
191
|
+
created_at: string;
|
|
192
|
+
updated_at: string;
|
|
193
|
+
[key: string]: unknown;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Ответ `GET /projects` — **страница** списка проектов (массив больше не
|
|
197
|
+
* возвращается; обратная совместимость не поддерживается).
|
|
198
|
+
*/
|
|
199
|
+
export interface ProjectListResponse {
|
|
200
|
+
/** Проекты текущей страницы. */
|
|
201
|
+
projects: SerializedProject[];
|
|
202
|
+
/** Всего видимых проектов. */
|
|
203
|
+
total: number;
|
|
204
|
+
/** Смещение текущей страницы. */
|
|
205
|
+
offset: number;
|
|
206
|
+
/** Размер страницы (по умолчанию 100, максимум 500). */
|
|
207
|
+
limit: number;
|
|
208
|
+
/** Курсор следующей страницы; `null` — страница последняя. */
|
|
209
|
+
next_offset: number | null;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* Сводка пайплайна проекта (`pipelineSummary` в core). Поля — как у порта
|
|
213
|
+
* (camelCase); черновик (`draft`) в сводку **не входит** — он в детали
|
|
214
|
+
* `GET /projects/:id/pipelines/:pid`.
|
|
215
|
+
*/
|
|
216
|
+
export interface PipelineSummary {
|
|
217
|
+
id: string;
|
|
218
|
+
name: string;
|
|
219
|
+
description?: string;
|
|
220
|
+
icon?: string;
|
|
221
|
+
scope: 'instance' | 'project';
|
|
222
|
+
projectId?: string;
|
|
223
|
+
draftVersion: number;
|
|
224
|
+
publishedVersion?: number;
|
|
225
|
+
hasDraft: boolean;
|
|
226
|
+
installedBy?: {
|
|
227
|
+
pack: string;
|
|
228
|
+
version: string;
|
|
229
|
+
templateId?: string;
|
|
230
|
+
};
|
|
231
|
+
createdAt: string;
|
|
232
|
+
updatedAt: string;
|
|
233
|
+
[key: string]: unknown;
|
|
234
|
+
}
|
|
235
|
+
/** Ответ `GET /projects/:id/pipelines` — страница пайплайнов проекта. */
|
|
236
|
+
export interface ProjectPipelinesResponse {
|
|
237
|
+
pipelines: PipelineSummary[];
|
|
238
|
+
total: number;
|
|
239
|
+
offset: number;
|
|
240
|
+
limit: number;
|
|
241
|
+
next_offset: number | null;
|
|
242
|
+
}
|
|
243
|
+
/** Заголовок прогона пайплайна (`PipelineRunRecord` порта). */
|
|
244
|
+
export interface PipelineRunRecord {
|
|
245
|
+
id: string;
|
|
246
|
+
pipelineId: string;
|
|
247
|
+
version: number;
|
|
248
|
+
spec: unknown;
|
|
249
|
+
projectId?: string;
|
|
250
|
+
status: string;
|
|
251
|
+
currentNode?: string;
|
|
252
|
+
trigger?: unknown;
|
|
253
|
+
startedAt?: string;
|
|
254
|
+
finishedAt?: string;
|
|
255
|
+
error?: string;
|
|
256
|
+
createdAt: string;
|
|
257
|
+
updatedAt: string;
|
|
258
|
+
[key: string]: unknown;
|
|
259
|
+
}
|
|
260
|
+
/** Событие журнала прогона (`PipelineRunEventRecord` порта). */
|
|
261
|
+
export interface PipelineRunEvent {
|
|
262
|
+
runId: string;
|
|
263
|
+
ts: string;
|
|
264
|
+
type: string;
|
|
265
|
+
payload?: Record<string, unknown>;
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Ответ `GET /pipeline-runs/:runId` — прогон + страница журнала.
|
|
269
|
+
*
|
|
270
|
+
* Курсор журнала — **порядковый номер события** в журнале прогона
|
|
271
|
+
* (исключающий): `events_before` — вернутся события строго с меньшим номером.
|
|
272
|
+
* Сервер принимает и метку времени (`ts`) — тогда курсор по времени.
|
|
273
|
+
*/
|
|
274
|
+
export interface PipelineRunResponse {
|
|
275
|
+
run: PipelineRunRecord;
|
|
276
|
+
events: PipelineRunEvent[];
|
|
277
|
+
/** Есть ли более старые события за пределами страницы. */
|
|
278
|
+
events_has_more: boolean;
|
|
279
|
+
/** Курсор следующей (более старой) страницы журнала; `null` — её нет. */
|
|
280
|
+
events_next_before: number | null;
|
|
281
|
+
}
|
|
98
282
|
/** Сообщение chat/completions (подмножество OpenAI API). */
|
|
99
283
|
export interface ChatMessage {
|
|
100
284
|
role: string;
|
|
@@ -143,3 +327,140 @@ export interface ChatCompletionsResponse {
|
|
|
143
327
|
}>;
|
|
144
328
|
usage: ChatCompletionsUsage;
|
|
145
329
|
}
|
|
330
|
+
/**
|
|
331
|
+
* Модель каталога (`GET /api/v2/models`) — плоская запись страницы.
|
|
332
|
+
*
|
|
333
|
+
* Транспортный DTO: часть полей опциональна (модальности/цены заданы не у
|
|
334
|
+
* всех моделей), неизвестные поля допускаются.
|
|
335
|
+
*/
|
|
336
|
+
export interface ModelSummary {
|
|
337
|
+
id: string;
|
|
338
|
+
name: string;
|
|
339
|
+
provider: string;
|
|
340
|
+
description?: string;
|
|
341
|
+
enabled: boolean;
|
|
342
|
+
isDefault: boolean;
|
|
343
|
+
contextWindow?: number;
|
|
344
|
+
contextSource?: string;
|
|
345
|
+
maxOutputTokens?: number;
|
|
346
|
+
inputPrice?: number;
|
|
347
|
+
outputPrice?: number;
|
|
348
|
+
cacheReadPrice?: number;
|
|
349
|
+
cacheWritePrice?: number;
|
|
350
|
+
priceSource?: string;
|
|
351
|
+
currency?: string;
|
|
352
|
+
/** ADR-115: модальности входа модели; поле отсутствует — «неизвестны». */
|
|
353
|
+
modalities?: string[];
|
|
354
|
+
/** ADR-117: shorthand `compatibility.requireReasoning`. */
|
|
355
|
+
requiresReasoning?: boolean;
|
|
356
|
+
/** ADR-117: перекрытия протокола модели. */
|
|
357
|
+
compatibility?: Record<string, unknown>;
|
|
358
|
+
[key: string]: unknown;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* Query-параметры страницы каталога моделей.
|
|
362
|
+
*
|
|
363
|
+
* Поиск — подстрока по id/имени/провайдеру (без учёта регистра); пагинация —
|
|
364
|
+
* `limit` (по умолчанию 100, максимум 500) и `offset`.
|
|
365
|
+
*
|
|
366
|
+
* Тип-алиас (не interface): набор query-параметров — объектный литерал, у
|
|
367
|
+
* которого TypeScript выводит неявный индекс-сигнатур (нужно для приведения
|
|
368
|
+
* к `SynthQuery` в клиенте).
|
|
369
|
+
*/
|
|
370
|
+
export type ModelsListParams = {
|
|
371
|
+
/** Подстрока по id/имени/провайдеру (без учёта регистра). */
|
|
372
|
+
search?: string;
|
|
373
|
+
/** Точное имя провайдера. */
|
|
374
|
+
provider?: string;
|
|
375
|
+
/** Модальность входа модели (`text`/`image`/`pdf`/`audio`/`video`). */
|
|
376
|
+
modality?: string;
|
|
377
|
+
/** `true` — только включённые, `false` — только выключенные. */
|
|
378
|
+
enabled?: boolean;
|
|
379
|
+
/** Размер страницы (1..500; по умолчанию 100). */
|
|
380
|
+
limit?: number;
|
|
381
|
+
/** Смещение страницы (с 0). */
|
|
382
|
+
offset?: number;
|
|
383
|
+
};
|
|
384
|
+
/**
|
|
385
|
+
* Ответ `GET /api/v2/models` — **страница** каталога.
|
|
386
|
+
*
|
|
387
|
+
* Массив моделей больше не возвращается (обратная совместимость не
|
|
388
|
+
* поддерживается); полный каталог — постранично.
|
|
389
|
+
*/
|
|
390
|
+
export interface ModelListResponse {
|
|
391
|
+
/** Модели текущей страницы. */
|
|
392
|
+
models: ModelSummary[];
|
|
393
|
+
/** Всего моделей после фильтров. */
|
|
394
|
+
total: number;
|
|
395
|
+
/** Смещение текущей страницы. */
|
|
396
|
+
offset: number;
|
|
397
|
+
/** Размер страницы. */
|
|
398
|
+
limit: number;
|
|
399
|
+
/** Курсор следующей страницы; `null` — страница последняя. */
|
|
400
|
+
next_offset: number | null;
|
|
401
|
+
}
|
|
402
|
+
/**
|
|
403
|
+
* Query-параметры чтения файла (`GET /api/v2/fs/read`).
|
|
404
|
+
*
|
|
405
|
+
* Тип-алиас (не interface) — см. `ModelsListParams`.
|
|
406
|
+
*/
|
|
407
|
+
export type FsReadParams = {
|
|
408
|
+
/** Проект (managed); без него — рабочий каталог по умолчанию (standalone). */
|
|
409
|
+
project_id?: string;
|
|
410
|
+
/** Путь файла относительно workspace. */
|
|
411
|
+
path: string;
|
|
412
|
+
};
|
|
413
|
+
/**
|
|
414
|
+
* Ответ `GET /api/v2/fs/read`.
|
|
415
|
+
*
|
|
416
|
+
* Файл больше лимита чтения (или бинарный) → `413` с машинным кодом
|
|
417
|
+
* `FILE_TOO_LARGE` и `error.details.maxReadBytes`.
|
|
418
|
+
*/
|
|
419
|
+
export interface FsReadResult {
|
|
420
|
+
path: string;
|
|
421
|
+
content: string;
|
|
422
|
+
size: number;
|
|
423
|
+
encoding: 'utf-8' | 'binary';
|
|
424
|
+
}
|
|
425
|
+
/** Query-параметры листинга каталога (`GET /api/v2/fs`). Тип-алиас — см. `ModelsListParams`. */
|
|
426
|
+
export type FsListParams = {
|
|
427
|
+
project_id?: string;
|
|
428
|
+
/** Путь каталога относительно workspace. */
|
|
429
|
+
path?: string;
|
|
430
|
+
/** Глубина рекурсии (сервер ограничивает жёстко: `MAX_FS_LIST_DEPTH` = 3). */
|
|
431
|
+
maxDepth?: number;
|
|
432
|
+
/** Показывать скрытые элементы. */
|
|
433
|
+
includeHidden?: boolean;
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* Ответ `GET /api/v2/fs`.
|
|
437
|
+
*
|
|
438
|
+
* `truncated: true` — обход прерван по лимиту записей (рекурсивный листинг,
|
|
439
|
+
* `maxDepth > 0`); ответ неполон.
|
|
440
|
+
*/
|
|
441
|
+
export interface FsListResult {
|
|
442
|
+
path: string;
|
|
443
|
+
entries: FileEntry[];
|
|
444
|
+
truncated?: boolean;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* Query-параметры детали коммита (`GET /api/v2/git/commit`).
|
|
448
|
+
*
|
|
449
|
+
* Тип-алиас (не interface) — см. `ModelsListParams`.
|
|
450
|
+
*/
|
|
451
|
+
export type GitCommitParams = {
|
|
452
|
+
/** Проект (обязателен: доступ к git-данным — право чтения проекта). */
|
|
453
|
+
project_id: string;
|
|
454
|
+
/** Относительный путь репозитория внутри workspace. */
|
|
455
|
+
repo_path?: string;
|
|
456
|
+
/** Хеш коммита (полный или короткий). */
|
|
457
|
+
hash: string;
|
|
458
|
+
};
|
|
459
|
+
/**
|
|
460
|
+
* Ответ `GET /api/v2/git/commit`.
|
|
461
|
+
*
|
|
462
|
+
* `commit.diff_truncated: true` — diff обрезан по лимиту размера.
|
|
463
|
+
*/
|
|
464
|
+
export interface GitCommitResult {
|
|
465
|
+
commit: CommitDetail;
|
|
466
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itphx/synth-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.13.4",
|
|
4
4
|
"description": "Типизированный клиент публичного API Synth (ADR-052)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
}
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
|
-
"@itphx/synth-shared": "0.
|
|
19
|
+
"@itphx/synth-shared": "0.13.4"
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
22
|
"@types/node": "^22.0.0",
|