solver-sdk 1.7.2 → 1.7.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/README.md CHANGED
@@ -2,20 +2,59 @@
2
2
 
3
3
  SDK для интеграции с Code Solver Backend API. Поддерживает работу как в браузере, так и в Node.js.
4
4
 
5
- ## Возможности
6
-
7
- - Совместимость с ESM и CommonJS
8
- - Поддержка браузера и Node.js
9
- - Типизация TypeScript
10
- - WebSocket для реалтайм функций
5
+ <p align="center">
6
+ <a href="https://www.npmjs.com/package/solver-sdk"><img src="https://img.shields.io/npm/v/solver-sdk.svg" alt="NPM Version" /></a>
7
+ <a href="https://www.npmjs.com/package/solver-sdk"><img src="https://img.shields.io/npm/dm/solver-sdk.svg" alt="NPM Downloads" /></a>
8
+ <a href="https://github.com/code-solver/browser-sdk/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/solver-sdk.svg" alt="License" /></a>
9
+ </p>
10
+
11
+ ## 📋 Содержание
12
+
13
+ - [Основные возможности](#основные-возможности)
14
+ - [Установка](#установка)
15
+ - [Быстрый старт](#быстрый-старт)
16
+ - [CommonJS (Node.js)](#в-среде-commonjs-nodejs)
17
+ - [ESM (Node.js)](#в-среде-esm-nodejs)
18
+ - [Браузер](#в-браузере)
19
+ - [API](#api)
20
+ - [Основные компоненты](#основные-компоненты)
21
+ - [Опции SDK](#опции-sdk)
22
+ - [Продвинутые функции](#продвинутые-функции)
23
+ - [Проекты и индексация](#работа-с-проектами)
24
+ - [Поиск кода](#поиск-кода)
25
+ - [WebSocket и подписки](#работа-с-рассуждениями-через-websocket)
26
+ - [Работа с зависимостями](#api-для-работы-с-зависимостями)
27
+ - [Потоковая передача мышления](#потоковая-передача-мышления)
28
+ - [Региональные эндпоинты](#работа-с-региональными-эндпоинтами)
29
+ - [Примеры](#примеры)
30
+ - [Совместимость](#совместимость)
31
+ - [Разработка и тестирование](#разработка-и-тестирование)
32
+ - [Документация](#документация)
33
+ - [Лицензия](#лицензия)
34
+
35
+ ## Основные возможности
36
+
37
+ - **Кросс-платформенность**: совместимость с ESM, CommonJS, браузером и Node.js
38
+ - **Типизация**: полная поддержка TypeScript
39
+ - **Расширенная работа с WebSocket**:
11
40
  - Автоматический ping/pong механизм для мониторинга соединений
12
41
  - Сбор статистики времени отклика (RTT) и состояния соединений
13
- - Автоматическое обнаружение проблем с соединением
14
- - Поддержка Server-Sent Events (SSE)
15
- - Инкрементальная индексация отдельных файлов
16
- - Обработка ошибок и повторные попытки
17
- - Поддержка региональных эндпоинтов Anthropic API
18
- - Полная документация API
42
+ - Интеллектуальный механизм переподключения с экспоненциальной задержкой
43
+ - Настраиваемый мониторинг здоровья соединения
44
+ - **Потоковая передача мышления**:
45
+ - Метод `streamChatWithThinking()` для потоковой передачи процесса мышления модели
46
+ - Полная поддержка событий Anthropic API (`thinking_delta`, `text_delta` и др.)
47
+ - Стандартизированный формат для всех типов событий
48
+ - **Работа с регионами**:
49
+ - Поддержка региональных эндпоинтов Anthropic API
50
+ - Автоматическое переключение между регионами при ошибках
51
+ - Поддержка регионов: 'us-east-1', 'eu-west-1', 'ap-southeast-2'
52
+ - **Индексация и поиск**:
53
+ - Инкрементальная индексация отдельных файлов
54
+ - Семантический поиск кода
55
+ - **Обработка ошибок**:
56
+ - Интеллектуальные повторные попытки
57
+ - Обширная диагностика соединений
19
58
 
20
59
  ## Установка
21
60
 
@@ -23,7 +62,7 @@ SDK для интеграции с Code Solver Backend API. Поддержива
23
62
  npm install solver-sdk
24
63
  ```
25
64
 
26
- ## Использование
65
+ ## Быстрый старт
27
66
 
28
67
  ### В среде CommonJS (Node.js)
29
68
 
@@ -53,14 +92,7 @@ example().catch(console.error);
53
92
  ### В среде ESM (Node.js)
54
93
 
55
94
  ```javascript
56
- // Вариант 1: Динамический импорт через createRequire
57
- import { createRequire } from 'module';
58
- const require = createRequire(import.meta.url);
59
- const { CodeSolverSDK } = require('solver-sdk');
60
-
61
- // Вариант 2: Прямой импорт (если в package.json указан "type": "module")
62
- // import * as sdk from 'solver-sdk';
63
- // const { CodeSolverSDK } = sdk;
95
+ import { CodeSolverSDK } from 'solver-sdk';
64
96
 
65
97
  // Создание экземпляра SDK
66
98
  const sdk = new CodeSolverSDK({
@@ -95,7 +127,33 @@ example().catch(console.error);
95
127
  </script>
96
128
  ```
97
129
 
98
- ## Примеры
130
+ ## API
131
+
132
+ ### Основные компоненты
133
+
134
+ - `CodeSolverSDK` - Основной класс SDK
135
+ - `ReasoningApi` - API для работы с рассуждениями
136
+ - `ProjectsApi` - API для работы с проектами
137
+ - `SearchApi` - API для поиска кода
138
+ - `AgentsApi` - API для работы с агентами
139
+ - `ContextApi` - API для работы с контекстом кода
140
+ - `DependenciesApi` - API для работы с зависимостями
141
+ - `ChatApi` - API для работы с чатом и потоковой передачей мышления
142
+
143
+ ### Опции SDK
144
+
145
+ | Опция | Тип | Описание | Обязательна |
146
+ |-------|-----|----------|-------------|
147
+ | `baseURL` | string | Базовый URL API | Да |
148
+ | `apiKey` | string | API ключ для авторизации | Нет |
149
+ | `timeout` | number | Таймаут для HTTP запросов (мс) | Нет |
150
+ | `headers` | object | Пользовательские HTTP заголовки | Нет |
151
+ | `httpsAgent` | object | Опции для HTTPS агента (Node.js) | Нет |
152
+ | `mode` | string | Режим работы SDK ('browser', 'node', 'auto') | Нет |
153
+ | `providers` | object | Настройки провайдеров API (Anthropic и др.) | Нет |
154
+ | `websocket` | object | Настройки WebSocket (reconnect, timeout и др.) | Нет |
155
+
156
+ ## Продвинутые функции
99
157
 
100
158
  ### Работа с проектами
101
159
 
@@ -139,9 +197,6 @@ const reasoning = await sdk.reasoning.createReasoning({
139
197
  query: 'Объясни, как работает этот проект'
140
198
  });
141
199
 
142
- // Запуск процесса рассуждения
143
- await sdk.reasoning.startReasoning(reasoning.id);
144
-
145
200
  // Подключение через WebSocket
146
201
  const wsClient = sdk.getWebSocketClient();
147
202
  await wsClient.connectToReasoning(reasoning.id);
@@ -150,12 +205,12 @@ await wsClient.connectToReasoning(reasoning.id);
150
205
  wsClient.enablePingPong(30000, 3);
151
206
 
152
207
  // Обработка событий мышления
153
- wsClient.on('thinking', (data) => {
154
- console.log('Размышление:', data.content);
208
+ wsClient.on('thinking_delta', (data) => {
209
+ console.log('Фрагмент размышления:', data.text);
155
210
  });
156
211
 
157
- wsClient.on('complete', (data) => {
158
- console.log('Завершено:', data.content);
212
+ wsClient.on('message_stop', (data) => {
213
+ console.log('Завершено:', data);
159
214
 
160
215
  // Отключаем механизм ping/pong и закрываем соединение
161
216
  wsClient.disablePingPong();
@@ -163,63 +218,13 @@ wsClient.on('complete', (data) => {
163
218
  });
164
219
 
165
220
  // Мониторинг качества соединения
166
- setInterval(() => {
167
- const stats = wsClient.getPingStats(WebSocketNamespace.REASONING);
168
- console.log(`Среднее время отклика: ${stats.averageRtt}ms`);
169
- }, 60000);
221
+ const diagnostics = wsClient.diagnoseConnection(WebSocketNamespace.REASONING);
222
+ console.log(`Состояние соединения:`, diagnostics);
170
223
  ```
171
224
 
172
- ### Индексация отдельных файлов
225
+ ### API для работы с зависимостями
173
226
 
174
227
  ```javascript
175
- // Инкрементальная индексация отдельного файла
176
- async function updateSingleFile() {
177
- const projectId = 'your-project-id';
178
- const filePath = 'src/components/App.js';
179
- const fileContent = 'console.log("Hello World");';
180
-
181
- // Обновление индекса отдельного файла
182
- const result = await sdk.projects.updateFileIndex(
183
- projectId,
184
- filePath,
185
- {
186
- content: fileContent, // Содержимое файла
187
- force: false // true для принудительного обновления
188
- }
189
- );
190
-
191
- console.log(`Файл ${result.filePath} успешно проиндексирован`);
192
- console.log(`Метаданные файла:`, result.fileIndex);
193
-
194
- // Альтернативный вариант через ContextApi
195
- await sdk.context.updateFileIndex(
196
- projectId,
197
- filePath,
198
- fileContent,
199
- false // force flag
200
- );
201
- }
202
-
203
- // Чтение файла с диска и обновление индекса
204
- async function updateFileFromDisk() {
205
- const projectId = 'your-project-id';
206
- const filePath = 'src/components/App.js';
207
-
208
- // Обновление индекса без передачи содержимого
209
- // SDK прочитает файл с диска
210
- const result = await sdk.projects.updateFileIndex(projectId, filePath);
211
-
212
- console.log(`Файл ${result.filePath} успешно проиндексирован`);
213
- }
214
- ```
215
-
216
- ## API для работы с зависимостями
217
-
218
- SDK предоставляет API для работы с зависимостями файлов в проекте, что позволяет анализировать структуру проекта, импорты/экспорты и выявлять циклические зависимости.
219
-
220
- ### Получение зависимостей файла
221
-
222
- ```typescript
223
228
  // Получение зависимостей конкретного файла
224
229
  const fileDependencies = await sdk.dependencies.getFileDependencies(projectId, {
225
230
  filePath: 'src/app.js'
@@ -227,302 +232,24 @@ const fileDependencies = await sdk.dependencies.getFileDependencies(projectId, {
227
232
 
228
233
  console.log('Импорты:', fileDependencies.imports);
229
234
  console.log('Импортируется в:', fileDependencies.importedBy);
230
- console.log('Экспорты:', fileDependencies.exports);
231
- console.log('Экспортируемые из импортов:', fileDependencies.exportedBy);
232
- ```
233
-
234
- ### Получение графа зависимостей
235
235
 
236
- ```typescript
237
236
  // Получение полного графа зависимостей проекта
238
237
  const dependencyGraph = await sdk.dependencies.getDependencyGraph(projectId);
239
238
 
240
- console.log('Узлы графа:', dependencyGraph.nodes);
241
- console.log('Связи в графе:', dependencyGraph.edges);
242
- ```
243
-
244
- ### Анализ зависимостей
245
-
246
- ```typescript
247
239
  // Анализ графа зависимостей и поиск циклов
248
240
  const analysis = await sdk.dependencies.analyzeDependencyGraph(projectId);
249
-
250
241
  console.log('Циклические зависимости:', analysis.cycles);
251
- console.log('Статистика графа:', analysis.statistics);
252
- ```
253
-
254
- ### Статистика зависимостей
255
-
256
- ```typescript
257
- // Получение статистики зависимостей в проекте
258
- const stats = await sdk.dependencies.getDependencyStatistics(projectId);
259
-
260
- console.log('Общее количество зависимостей:', stats.totalDependencies);
261
- console.log('Уникальные файлы:', stats.uniqueFiles);
262
- console.log('Импорты:', stats.importCount);
263
- console.log('Экспорты:', stats.exportCount);
264
- console.log('Циклические зависимости:', stats.cyclicDependenciesCount);
265
- ```
266
-
267
- ### Получение связанных компонентов
268
-
269
- ```typescript
270
- // Получение связанных компонентов для файла
271
- const relatedComponents = await sdk.dependencies.getRelatedComponents(projectId, {
272
- filePath: 'src/app.js',
273
- maxDepth: 3,
274
- includeIncoming: true,
275
- includeOutgoing: true,
276
- maxNodes: 20
277
- });
278
-
279
- console.log('Исходный файл:', relatedComponents.source);
280
- console.log('Связанные компоненты:', relatedComponents.nodes);
281
- ```
282
-
283
- ### WebSocket события для зависимостей
284
-
285
- Для получения уведомлений об изменениях в зависимостях в реальном времени можно использовать WebSocket:
286
242
 
287
- ```typescript
288
243
  // Подключение к WebSocket для зависимостей
289
- const wsClient = sdk.getWebSocketClient();
290
- await wsClient.connectToDependencies(projectId);
291
-
292
- // Обработка события обновления зависимостей
293
- wsClient.on('dependency_update', (data) => {
244
+ await sdk.dependencies.connectWebSocket(projectId);
245
+ sdk.dependencies.on('dependency_update', (data) => {
294
246
  console.log('Обновление зависимостей:', data);
295
- console.log('Затронутые файлы:', data.affectedFiles);
296
247
  });
297
248
  ```
298
249
 
299
- ## Тестирование и совместимость
300
-
301
- SDK тщательно тестируется в различных средах:
302
-
303
- ```bash
304
- # Запуск всех тестов
305
- npm test
306
-
307
- # Тесты браузерной совместимости
308
- npm run test:browser
250
+ ### Потоковая передача мышления
309
251
 
310
- # Тесты Node.js совместимости
311
- npm run test:node
312
-
313
- # Тесты VS Code Web совместимости
314
- npm run test:vscode
315
-
316
- # Проверка покрытия кода тестами
317
- npm run test:coverage
318
- ```
319
-
320
- ### Поддерживаемые среды
321
-
322
- SDK протестирован и работает в следующих средах:
323
-
324
- - **Браузеры**: Chrome 80+, Firefox 72+, Safari 14+, Edge 80+
325
- - **Node.js**: Версии 14.x и выше (как CommonJS, так и ESM)
326
- - **VS Code**: Desktop и Web версии
327
-
328
- ### Решение проблем совместимости
329
-
330
- Если у вас возникли проблемы с совместимостью, обратитесь к разделу "Устранение неполадок" в файле [INTEGRATION.md](./INTEGRATION.md).
331
-
332
- ## Сборка из исходного кода
333
-
334
- Для сборки SDK из исходного кода:
335
-
336
- ```bash
337
- # Установка зависимостей
338
- npm install
339
-
340
- # Сборка SDK
341
- npm run build
342
-
343
- # Очистка директории сборки
344
- npm run clean
345
- ```
346
-
347
- ## Опции SDK
348
-
349
- SDK поддерживает следующие опции при инициализации:
350
-
351
- | Опция | Тип | Описание | Обязательна |
352
- |-------|-----|----------|-------------|
353
- | `baseURL` | string | Базовый URL API | Да |
354
- | `apiKey` | string | API ключ для авторизации | Нет |
355
- | `timeout` | number | Таймаут для HTTP запросов (мс) | Нет |
356
- | `headers` | object | Пользовательские HTTP заголовки | Нет |
357
- | `httpsAgent` | object | Опции для HTTPS агента (Node.js) | Нет |
358
- | `mode` | string | Режим работы SDK ('browser', 'node', 'auto') | Нет |
359
-
360
- ## Документация
361
-
362
- Подробная документация по использованию SDK доступна в директории [`docs`](./docs):
363
-
364
- - [Начало работы](./docs/GETTING_STARTED.md) - инструкции по установке и базовому использованию SDK
365
- - [Работа с проектами](./docs/PROJECTS.md) - управление проектами через SDK
366
- - [Индексация проектов](./docs/INDEXING.md) - работа с индексацией и отслеживание через WebSocket
367
- - [Документация API](./docs/API.md) - полная документация по всем методам SDK
368
-
369
- ## Тестирование и локальная разработка
370
-
371
- ### Предварительные требования
372
-
373
- Для локальной разработки и тестирования требуется:
374
- - Node.js 16+
375
- - npm 8+
376
- - Запущенный локальный сервер Code Solver Backend (по умолчанию на https://localhost:3000)
377
-
378
- ### Тестирование SDK
379
-
380
- SDK включает несколько типов тестов:
381
-
382
- #### Модульные тесты
383
-
384
- Эти тесты проверяют внутреннюю логику SDK без взаимодействия с реальным бэкендом:
385
-
386
- ```bash
387
- # Запуск всех тестов
388
- npm test
389
-
390
- # Запуск тестов для индексации
391
- npm run test:indexing
392
- ```
393
-
394
- #### Интеграционные тесты
395
-
396
- Эти тесты проверяют взаимодействие SDK с реальным бэкендом:
397
-
398
- ```bash
399
- # Запуск интеграционных тестов индексации
400
- npm run test:integration
401
- ```
402
-
403
- > **Важно:** Для запуска интеграционных тестов необходимо, чтобы локальный сервер Code Solver Backend был запущен на https://localhost:3000.
404
-
405
- ### Примеры использования
406
-
407
- В директории [`examples`](./examples) находятся примеры использования SDK:
408
-
409
- #### Проверка подключения к API
410
-
411
- Пример проверяет доступность API и WebSocket соединения:
412
-
413
- ```bash
414
- npm run example:check-api
415
- ```
416
-
417
- #### Индексация проектов
418
-
419
- Пример демонстрирует процесс индексации проекта с отслеживанием через WebSocket:
420
-
421
- ```bash
422
- npm run example:indexing
423
- ```
424
-
425
- ### Режим разработки
426
-
427
- Для запуска SDK в режиме разработки с локальным сервером:
428
-
429
- 1. Запустите локальный сервер Code Solver Backend
430
- 2. Используйте следующие настройки в вашем коде:
431
-
432
- ```javascript
433
- const sdk = new CodeSolverSDK({
434
- baseURL: 'https://localhost:3000',
435
- apiKey: 'test-api-key',
436
- httpsAgent: new https.Agent({
437
- rejectUnauthorized: false // Для самоподписанных сертификатов
438
- }),
439
- websocket: {
440
- reconnect: true,
441
- rejectUnauthorized: false
442
- }
443
- });
444
- ```
445
-
446
- #### Игнорирование самоподписанных сертификатов
447
-
448
- При разработке с локальным сервером используйте:
449
-
450
- ```bash
451
- # В Node.js скриптах
452
- NODE_TLS_REJECT_UNAUTHORIZED=0 node your-script.js
453
- ```
454
-
455
- ## Лицензия
456
-
457
- [MIT](./LICENSE)
458
-
459
- ## API Reference
460
-
461
- ### Основные компоненты
462
-
463
- - `CodeSolverSDK` - Основной класс SDK
464
- - `ReasoningApi` - API для работы с рассуждениями
465
- - `ProjectsApi` - API для работы с проектами
466
- - `SearchApi` - API для поиска кода
467
- - `AgentsApi` - API для работы с агентами
468
- - `ContextApi` - API для работы с контекстом кода
469
- - `CodeModificationApi` - API для модификации кода
470
-
471
- ### Настройка соединения с сервером
472
-
473
- ```javascript
474
- const sdk = new CodeSolverSDK({
475
- baseURL: 'https://localhost:3000', // URL сервера (обязательный параметр)
476
- apiKey: 'your-api-key', // API ключ (если требуется)
477
- timeout: 30000, // Таймаут запросов в миллисекундах
478
- headers: { // Дополнительные HTTP заголовки
479
- 'Custom-Header': 'value'
480
- }
481
- });
482
- ```
483
-
484
- ## Версия 1.0.5
485
-
486
- - Улучшена совместимость с CommonJS и ESM модулями
487
- - Добавлена поддержка WebSocket соединений
488
- - Добавлена встроенная зависимость ws для Node.js
489
-
490
- ## Режим мышления (Thinking Mode)
491
-
492
- Режим мышления позволяет получать промежуточные рассуждения модели в процессе формирования ответа. Это особенно полезно для отладки и понимания логики работы AI.
493
-
494
- ### Использование через REST API
495
-
496
- ```javascript
497
- const { CodeSolverSDK } = require('solver-sdk');
498
-
499
- const sdk = new CodeSolverSDK({
500
- baseURL: 'https://api.example.com',
501
- apiKey: 'ваш-ключ-api'
502
- });
503
-
504
- // Запрос с включенным режимом мышления
505
- const response = await sdk.chat.chat([
506
- { role: 'user', content: 'Как реализовать алгоритм сортировки слиянием?' }
507
- ], {
508
- model: 'Claude',
509
- thinking: true // Активируем режим мышления
510
- });
511
-
512
- // Вывод хода мыслей
513
- if (response.choices && response.choices[0] && response.choices[0].thinking) {
514
- console.log('Ход мыслей модели:');
515
- console.log(response.choices[0].thinking);
516
- }
517
-
518
- // Вывод финального ответа
519
- console.log('Ответ модели:');
520
- console.log(response.choices[0].message.content);
521
- ```
522
-
523
- ### Использование через WebSocket (потоковое получение событий мышления)
524
-
525
- В версии 1.7.0 SDK добавлена полная поддержка событий потокового мышления в соответствии с документацией Anthropic. Теперь вы можете получать события `thinking_delta`, `text_delta`, `signature_delta` и другие в режиме реального времени.
252
+ Версия 1.7.4 включает полную поддержку потоковой передачи мышления через Anthropic API, а также улучшенную обработку ошибок:
526
253
 
527
254
  ```javascript
528
255
  const { CodeSolverSDK } = require('solver-sdk');
@@ -542,7 +269,8 @@ async function streamThinking() {
542
269
  const options = {
543
270
  model: 'claude-3-7-sonnet-20240229',
544
271
  temperature: 0.7,
545
- thinking: true
272
+ thinking: true,
273
+ authToken: 'your-auth-token' // Унифицированный параметр для аутентификации WebSocket
546
274
  };
547
275
 
548
276
  // Обработчик событий WebSocket
@@ -559,6 +287,15 @@ async function streamThinking() {
559
287
  case 'text_delta':
560
288
  process.stdout.write(data.text); // Потоковый вывод итогового текста
561
289
  break;
290
+
291
+ case 'error':
292
+ console.error('Ошибка:', data.message);
293
+
294
+ // Обработка ошибки географических ограничений
295
+ if (data.type === 'geo_restriction') {
296
+ console.error('Необходимо включить VPN для доступа к API Anthropic из вашего региона');
297
+ }
298
+ break;
562
299
  }
563
300
  };
564
301
 
@@ -573,133 +310,128 @@ async function streamThinking() {
573
310
  console.log(`Запрос успешно отправлен. Socket ID: ${response.socketId}`);
574
311
  } catch (error) {
575
312
  console.error('Ошибка:', error);
313
+
314
+ // Проверка наличия ошибки географических ограничений
315
+ if (error.type === 'geo_restriction') {
316
+ console.error('Необходимо включить VPN для доступа к API Anthropic из вашего региона');
317
+ }
576
318
  }
577
319
  }
578
320
 
579
321
  streamThinking();
580
322
  ```
581
323
 
582
- #### Поддерживаемые события WebSocket
583
-
584
- SDK теперь поддерживает полный набор событий из документации Anthropic:
324
+ #### Поддерживаемые события WebSocket для мышления
585
325
 
586
326
  - `message_start` - начало сообщения от модели
587
327
  - `content_block_start` - начало блока контента (текст или thinking)
588
328
  - `thinking_delta` - фрагмент размышления модели
589
329
  - `text_delta` - фрагмент итогового текста
590
- - `signature_delta` - подпись блока размышлений
591
330
  - `content_block_stop` - завершение блока контента
592
- - `message_delta` - изменения верхнего уровня сообщения
593
331
  - `message_stop` - завершение сообщения
594
- - `ping` - событие для поддержания соединения
595
- - `tool_use_start` - начало использования инструмента
596
- - `input_json_delta` - фрагмент JSON входных данных для инструмента
597
332
 
598
- ### Примеры использования
333
+ ### Работа с региональными эндпоинтами
599
334
 
600
- Полные примеры кода можно найти в директории `examples`:
601
- - `examples/chat-example.js` - пример использования thinking в обычном чате
602
- - `examples/thinking-example.js` - пример использования thinking через WebSocket
603
-
604
- ### Параметры режима мышления
335
+ ```javascript
336
+ // Настройка SDK с указанием предпочтительного региона
337
+ const sdk = new CodeSolverSDK({
338
+ baseURL: 'https://api.example.com',
339
+ apiKey: 'your-api-key',
340
+ providers: {
341
+ anthropic: {
342
+ region: 'eu-west-1' // Использовать европейский регион
343
+ }
344
+ }
345
+ });
605
346
 
606
- Вы можете управлять режимом мышления с помощью следующих параметров:
347
+ // Запрос с автоматическим переключением между регионами при ошибках
348
+ const response = await sdk.chat.chatWithRegionFailover([
349
+ { role: 'user', content: 'Расскажи о квантовых компьютерах' }
350
+ ], {
351
+ model: 'claude-3-7-sonnet-20240229'
352
+ });
607
353
 
608
- ```javascript
609
- // Активация режима thinking
610
- const options = {
354
+ // Запрос с явным указанием региона
355
+ const responseFromAsia = await sdk.chat.chat([
356
+ { role: 'user', content: 'Расскажи о квантовых компьютерах' }
357
+ ], {
611
358
  model: 'claude-3-7-sonnet-20240229',
612
- thinking: true, // Активируем режим мышления
613
- temperature: 0.7,
614
- maxTokens: 4096
615
- };
616
-
617
- // Использование с автоматическим созданием WebSocket соединения
618
- const response = await sdk.chat.streamChatWithThinking(messages, options, eventHandler);
619
-
620
- // Или с существующим socketId
621
- const connectResponse = await sdk.chat.connectWebSocket();
622
- options.socketId = connectResponse.socketId;
623
- const response = await sdk.chat.streamChatWithThinking(messages, options, eventHandler);
359
+ region: 'ap-southeast-2' // Явно указываем регион
360
+ });
624
361
  ```
625
362
 
626
- ## Обновление до версии 1.6.1
363
+ ## Примеры
364
+
365
+ В директории [`examples`](./examples) доступны примеры использования SDK:
627
366
 
628
- В версии 1.6.1 исправлены критические проблемы с WebSocket соединениями:
367
+ ```bash
368
+ # Проверка подключения к API
369
+ npm run example:check-api
629
370
 
630
- 1. Исправлена обработка callback-функций в WebSocket событиях.
631
- 2. Добавлена правильная передача параметра `namespace` в Socket.IO событиях.
632
- 3. Улучшено логирование для упрощения отладки проблем с соединением.
633
- 4. Добавлена обработка таймаутов при ожидании ответов от сервера.
371
+ # Индексация проектов
372
+ npm run example:indexing
634
373
 
635
- ### Как обновиться
374
+ # Работа с зависимостями
375
+ npm run example:dependencies
636
376
 
637
- ```bash
638
- npm update solver-sdk
377
+ # Проверка доступности регионов
378
+ npm run example:regions
639
379
  ```
640
380
 
641
- или с указанием конкретной версии:
381
+ ## Совместимость
382
+
383
+ SDK тщательно протестирован в различных средах и поддерживает:
384
+
385
+ - **Браузеры**: Chrome 80+, Firefox 72+, Safari 14+, Edge 80+
386
+ - **Node.js**: Версии 14.x и выше (как CommonJS, так и ESM)
387
+ - **VS Code**: Desktop и Web версии
388
+
389
+ ## Разработка и тестирование
642
390
 
643
391
  ```bash
644
- npm install solver-sdk@1.6.1
392
+ # Установка зависимостей
393
+ npm install
394
+
395
+ # Сборка SDK
396
+ npm run build
397
+
398
+ # Запуск всех тестов
399
+ npm test
400
+
401
+ # Тесты для рассуждений и WebSocket
402
+ npm run test:reasoning:all
403
+
404
+ # Запуск примеров
405
+ npm run example:check-api
645
406
  ```
646
407
 
647
- ### Важные изменения
648
-
649
- Публичный API SDK остался без изменений, но внутренняя логика работы с WebSocket была значительно улучшена.
650
- Если вы столкнулись с проблемами при подключении к серверу WebSocket или получении данных через Socket.IO,
651
- обновление до версии 1.6.1 должно их решить.
652
-
653
- ## Обновления и важные изменения
654
-
655
- ### Синхронизация WebSocket событий (v1.6.3)
656
-
657
- Произведена полная синхронизация констант WebSocket событий между SDK и бэкендом. Добавлена поддержка новых событий:
658
-
659
- - `REASONING_CREATED` (`reasoning:created`)
660
- - `JOINED_REASONING` (`joined_reasoning`)
661
- - `JOIN_RESPONSE` (`join_response`)
662
- - `UPDATE_CONTEXT_OPTIONS` (`update_context_options`)
663
- - `ESTIMATE_CONTEXT` (`estimate_context`)
664
- - `CONTEXT_OPTIONS_UPDATED` (`context_options_updated`)
665
- - `CONTEXT_ESTIMATION` (`context_estimation`)
666
- - `CHAT_REQUEST` (`chat_request`)
667
- - `CHAT_STARTED` (`chat_started`)
668
- - `MESSAGE_START` (`message_start`)
669
- - `CONTENT_BLOCK_START` (`content_block_start`)
670
- - `THINKING_DELTA` (`thinking_delta`)
671
- - `TEXT_DELTA` (`text_delta`)
672
- - `CONTENT_BLOCK_STOP` (`content_block_stop`)
673
- - `MESSAGE_STOP` (`message_stop`)
674
- - `TYPESCRIPT_ERRORS` (`typescript_errors`)
675
- - `TYPESCRIPT_ERRORS_RECEIVED` (`typescript_errors_received`)
676
- - `TEST_MODULES_CREATED` (`test_modules_created`)
677
- - `CREATE_TEST_MODULES` (`create_test_modules`)
678
- - `CONNECTION_PING` (`connection_ping`)
679
- - `CONNECTION_PONG` (`connection_pong`)
680
- - `RECONNECT_TOKEN` (`reconnect_token`)
681
- - `JOIN` (`join`)
682
- - `JOINED` (`joined`)
683
-
684
- ### Улучшенная совместимость с модульными системами
685
-
686
- Добавлены тесты совместимости для проверки работы SDK в различных окружениях:
687
- - CommonJS (для Node.js)
688
- - ESM (для современного JavaScript)
689
-
690
- Для запуска тестов используйте:
408
+ ### Локальная разработка
691
409
 
692
- ```bash
693
- cd test
694
- ./run-tests.sh
410
+ ```javascript
411
+ const sdk = new CodeSolverSDK({
412
+ baseURL: 'https://localhost:3000',
413
+ apiKey: 'test-api-key',
414
+ httpsAgent: new https.Agent({
415
+ rejectUnauthorized: false // Для самоподписанных сертификатов
416
+ }),
417
+ websocket: {
418
+ reconnect: true,
419
+ rejectUnauthorized: false
420
+ }
421
+ });
695
422
  ```
696
423
 
697
- ### Результаты тестирования
424
+ ## Документация
425
+
426
+ Подробная документация доступна в директории [`docs`](./docs):
698
427
 
699
- **CommonJS тесты**: Успешно пройдены
700
- **ESM тесты**: Успешно пройдены через ESM/CommonJS адаптер
701
- **WebSocket событий**: Все 62 события синхронизированы между бэкендом и SDK
428
+ - [Начало работы](./docs/GETTING_STARTED.md)
429
+ - [Работа с проектами](./docs/PROJECTS.md)
430
+ - [Индексация проектов](./docs/INDEXING.md)
431
+ - [Потоковая передача мышления](./docs/THINKING_ARCHITECTURE.md)
432
+ - [Работа с регионами](./docs/ADVANCED.md)
433
+ - [Полное API](./docs/API.md)
702
434
 
703
- ### Примечание по совместимости
435
+ ## Лицензия
704
436
 
705
- При использовании SDK в браузере и Node.js окружении могут быть различия в работе некоторых API, особенно WebSocket. Для Node.js рекомендуется использовать пакет `ws` и настроить соответствующие параметры в опциях SDK.
437
+ [MIT](./LICENSE)