daytona-wildberries-typescript-sdk 3.7.0 → 3.8.1

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
@@ -25,19 +25,33 @@
25
25
 
26
26
  # English Version
27
27
 
28
- Transform 11 OpenAPI specifications into a production-ready SDK with complete type safety, automatic rate limiting, retry mechanisms, and comprehensive error handling. Reduce integration time from weeks to hours.
28
+ Transform 11 OpenAPI specifications into a production-ready SDK with 13 modules, complete type safety, automatic rate limiting, retry mechanisms, and comprehensive error handling. Reduce integration time from weeks to hours.
29
29
 
30
30
  ## ✨ Features
31
31
 
32
- - **🔐 Complete Type Safety** - Auto-generated TypeScript types from OpenAPI specifications for all 11 API modules
33
- - **⚡ Automatic Rate Limiting** - Built-in enforcement of per-endpoint rate limits with intelligent queuing
34
- - **🔄 Smart Retry Logic** - Exponential backoff retry mechanism for transient failures
32
+ - **🔐 Complete Type Safety** - Auto-generated TypeScript types from OpenAPI specifications for all 13 API modules
33
+ - **⚡ Automatic Rate Limiting** - Built-in enforcement of per-endpoint rate limits with intelligent queuing and Basic/Test token multipliers
34
+ - **🔄 Smart Retry Logic** - Exponential backoff retry mechanism for transient failures with per-request timeout support
35
35
  - **🛡️ Rich Error Handling** - Typed error hierarchy with detailed recovery guidance
36
36
  - **📦 Tree-Shakeable** - Dual ESM/CommonJS builds, import only what you need (<100KB gzipped)
37
- - **✅ Battle-Tested** - 98% test coverage with 950+ tests across all modules
38
- - **🎯 100% API Coverage** - All 229 YAML endpoints implemented (v2.2.0)
39
- - **📚 Comprehensive Documentation** - Complete API reference, tutorials, and working examples in English and Russian
37
+ - **✅ Battle-Tested** - 2,100+ tests passing across all modules
38
+ - **🎯 100% API Coverage** - All YAML endpoints implemented including v1 Finance Reports and Acquiring Reports
39
+ - **📚 Comprehensive Documentation** - Complete API reference, 44 guides, tutorials, and working examples in English and Russian
40
40
  - **🔧 Zero Configuration** - Works out of the box with sensible defaults, configurable for advanced use
41
+ - **💰 Finance v1 Reports** - Sales Reports and Acquiring Reports with `parseMoneyAmount()` helper and field union types for autocomplete
42
+ - **🔔 Deprecation Utilities** - `warnOnce()` and `resetDeprecationWarnings()` for clean migration workflows
43
+
44
+ ## 🆕 What's New in v3.8.0
45
+
46
+ - **Field union types** for v1 Finance Reports -- `SalesReportDetailedField` and `AcquiringReportDetailedField` provide autocomplete and type safety for the `fields[]` parameter
47
+ - **`warnOnce()` and `resetDeprecationWarnings()`** -- centralized deprecation warning utilities exported from the main SDK entry point
48
+ - **Documentation overhaul** -- finances module docs rewritten with all 13 methods, 10 missing guides added to EN sidebar, RU guides index updated with 10 guides and 4 new sections
49
+ - **v1 Finance Reports** (v3.7.0) -- 6 new methods for Sales Reports and Acquiring Reports, `parseMoneyAmount()` helper, migration guide from deprecated v5 endpoint
50
+ - **13 modules** -- Orders DBS and User Management fully integrated
51
+
52
+ See [CHANGELOG.md](CHANGELOG.md) for the complete release history.
53
+
54
+ ---
41
55
 
42
56
  ## ⚠️ Critical API Update
43
57
 
@@ -100,7 +114,7 @@ console.log('Total campaigns:', campaigns.all);
100
114
  const advBalance = await sdk.promotion.getAdvBalance();
101
115
  console.log('Ad cabinet balance:', advBalance.net);
102
116
 
103
- // Get customer chat list with last messages (NEW in v2.3.2)
117
+ // Get customer chat list with last messages
104
118
  const chats = await sdk.communications.getSellerChats();
105
119
  console.log('Active chats:', chats.result?.length);
106
120
  chats.result?.forEach(chat => {
@@ -144,7 +158,7 @@ const reportFile = await longTimeoutSdk.analytics.getDownloadsFile(downloadId);
144
158
 
145
159
  ## 📊 Project Status & Development
146
160
 
147
- **Current Status:** 🟢 Production Ready | **SDK Version:** 1.0.0
161
+ **Current Status:** 🟢 Production Ready | **SDK Version:** 3.8.0
148
162
 
149
163
  **📖 [Project Status Summary](PROJECT_STATUS_SUMMARY.md)** — Comprehensive overview of all epics, stories, and implementation status.
150
164
 
@@ -152,18 +166,11 @@ const reportFile = await longTimeoutSdk.analytics.getDownloadsFile(downloadId);
152
166
 
153
167
  | Metric | Value |
154
168
  |--------|-------|
155
- | **API Modules** | 11/11 (100%) |
156
- | **API Endpoints** | 200+ implemented |
157
- | **Test Suite** | 5,219 tests passing (100%) |
158
- | **Quality Score** | 96.1/100 |
159
- | **Documentation** | 73 files, 22 examples |
160
- | **Bundle Size** | 567KB gzipped |
161
-
162
- ### Epic Progress
163
-
164
- - ✅ **5 epics completed** (Foundation, Products/Orders, Extended Modules, Integration, Testing)
165
- - 🔄 **2 epics in progress** (Documentation, Code Quality)
166
- - 📝 **3 epics planned** (Documentation Site, Web API Module)
169
+ | **API Modules** | 13 (100%) |
170
+ | **API Endpoints** | 240+ implemented |
171
+ | **Test Suite** | 2,111 tests passing (100%) |
172
+ | **Documentation** | 44 guides, 22 examples |
173
+ | **Bundle Size** | ~91KB gzipped (ESM) |
167
174
 
168
175
  > **⚠️ For Contributors:** When creating or completing epics/stories, **update [PROJECT_STATUS_SUMMARY.md](PROJECT_STATUS_SUMMARY.md)** to keep the project status current. This file is automatically generated and should reflect the latest implementation state.
169
176
 
@@ -186,22 +193,23 @@ const reportFile = await longTimeoutSdk.analytics.getDownloadsFile(downloadId);
186
193
 
187
194
  ## 🎯 Supported API Modules
188
195
 
189
- All 11 Wildberries API modules are fully supported with 100% API coverage:
196
+ All 13 Wildberries API modules are fully supported with 100% API coverage:
190
197
 
191
198
  | Module | Description |
192
199
  |--------|-------------|
193
- | **General** | Ping, news, seller info, connectivity testing |
194
- | **Products** | Categories, CRUD, media, pricing, warehouse, stock |
195
- | **Orders FBS** | Seller fulfillment, order status, shipping, supplies |
196
- | **Orders FBW** | WB warehouse fulfillment, supply planning |
197
- | **Finances** | Balance, transactions, reports, payouts |
198
- | **Analytics** | Sales funnel, search queries, stock history, CSV reports |
200
+ | **General** | Ping, news, seller info, Jam subscription, seller rating |
201
+ | **Products** | Categories, CRUD, media, pricing, warehouse, stock, kizMarked support |
202
+ | **Orders FBS** | Seller fulfillment, order status, shipping, supplies, metadata validation |
203
+ | **Orders FBW** | WB warehouse fulfillment, supply planning, buyer info |
204
+ | **Orders DBS** | Delivery by Seller - bulk operations, B2B support, product marking (SGTIN, IMEI) |
205
+ | **Finances** | Balance, transactions, v1 Sales Reports, Acquiring Reports, `parseMoneyAmount()`, field union types |
206
+ | **Analytics** | Sales funnel, search queries, stock history, WB warehouse stock, CSV reports |
199
207
  | **Reports** | Income reports, sales reports, data exports |
200
- | **Communications** | Customer chat with real-time messaging, product Q&A, reviews and ratings management, chat previews with last messages, **NEW:** pinned reviews for product cards |
201
- | **Promotion** | Campaigns, promo codes, advertising ⚠️ **[Migration Required](https://salacoste.github.io/daytona-wildberries-typescript-sdk/guides/migration-v2.4-promotion-deprecation)** - 4 methods deprecated (Feb 2, 2026) |
208
+ | **Communications** | Customer chat, product Q&A, reviews, pinned reviews for product cards |
209
+ | **Promotion** | Campaigns, bids, minus phrases, advertising |
202
210
  | **Tariffs** | Commission rates, fee schedules |
203
211
  | **In-Store Pickup** | Pickup point orders and management |
204
- | **Orders DBS** | Delivery by Seller orders - seller handles storage AND delivery directly to customers, B2B support, product marking (SGTIN, IMEI) |
212
+ | **User Management** | Seller profile user management |
205
213
 
206
214
  ## 📄 License
207
215
 
@@ -244,19 +252,33 @@ This is an unofficial SDK. It is not affiliated with, officially maintained by,
244
252
 
245
253
  # Русская Версия
246
254
 
247
- Преобразуйте 11 OpenAPI спецификаций в production-готовый SDK с полной типобезопасностью, автоматическими лимитами запросов, механизмами повторных попыток и комплексной обработкой ошибок. Сократите время интеграции с недель до часов.
255
+ Преобразуйте 11 OpenAPI спецификаций в production-готовый SDK с 13 модулями, полной типобезопасностью, автоматическими лимитами запросов, механизмами повторных попыток и комплексной обработкой ошибок. Сократите время интеграции с недель до часов.
248
256
 
249
257
  ## ✨ Возможности
250
258
 
251
- - **🔐 Полная Типобезопасность** - Автоматически генерируемые TypeScript типы из OpenAPI для всех 11 модулей
252
- - **⚡ Автоматические Лимиты Запросов** - Встроенное соблюдение лимитов для каждой конечной точки с умной очередью
253
- - **🔄 Умная Логика Повторов** - Экспоненциальная задержка для временных сбоев
259
+ - **🔐 Полная Типобезопасность** - Автоматически генерируемые TypeScript типы из OpenAPI для всех 13 модулей
260
+ - **⚡ Автоматические Лимиты Запросов** - Встроенное соблюдение лимитов для каждой конечной точки с умной очередью и множителями для Basic/Test токенов
261
+ - **🔄 Умная Логика Повторов** - Экспоненциальная задержка для временных сбоев с поддержкой таймаута для каждого запроса
254
262
  - **🛡️ Богатая Обработка Ошибок** - Типизированная иерархия ошибок с подробными рекомендациями
255
263
  - **📦 Tree-Shakeable** - Двойная сборка ESM/CommonJS, импортируйте только то, что нужно (<100KB gzip)
256
- - **✅ Проверено в Бою** - 98% покрытие тестами, 950+ тестов для всех модулей
257
- - **🎯 100% Покрытие API** - Все 229 эндпоинтов YAML реализованы (v2.2.0)
258
- - **📚 Полная Документация** - Справочник API, учебные руководства и примеры на английском и русском
264
+ - **✅ Проверено в Бою** - 2,100+ тестов для всех модулей
265
+ - **🎯 100% Покрытие API** - Все эндпоинты YAML реализованы, включая Финансовые Отчеты v1 и Эквайринг
266
+ - **📚 Полная Документация** - Справочник API, 44 руководства, примеры на английском и русском
259
267
  - **🔧 Без Настройки** - Работает из коробки с разумными значениями по умолчанию
268
+ - **💰 Финансовые Отчеты v1** - Отчеты о продажах и эквайринге с хелпером `parseMoneyAmount()` и union-типами полей для автодополнения
269
+ - **🔔 Утилиты Для Устаревших Методов** - `warnOnce()` и `resetDeprecationWarnings()` для удобной миграции
270
+
271
+ ## 🆕 Что Нового в v3.8.0
272
+
273
+ - **Union-типы полей** для Финансовых Отчетов v1 -- `SalesReportDetailedField` и `AcquiringReportDetailedField` обеспечивают автодополнение и типобезопасность параметра `fields[]`
274
+ - **`warnOnce()` и `resetDeprecationWarnings()`** -- централизованные утилиты для предупреждений об устаревших методах, экспортируемые из главной точки входа SDK
275
+ - **Обновление документации** -- документация модуля финансов переписана со всеми 13 методами, 10 руководств добавлено в EN боковую панель, обновлен RU индекс руководств
276
+ - **Финансовые Отчеты v1** (v3.7.0) -- 6 новых методов для Отчетов о Продажах и Эквайринга, хелпер `parseMoneyAmount()`, руководство по миграции с устаревшего v5 эндпоинта
277
+ - **13 модулей** -- Orders DBS и User Management полностью интегрированы
278
+
279
+ Полная история изменений: [CHANGELOG.md](CHANGELOG.md)
280
+
281
+ ---
260
282
 
261
283
  ## ⚠️ Критическое Обновление API
262
284
 
@@ -319,7 +341,7 @@ console.log('Всего кампаний:', campaigns.all);
319
341
  const advBalance = await sdk.promotion.getAdvBalance();
320
342
  console.log('Баланс рекл. кабинета:', advBalance.net);
321
343
 
322
- // Список чатов с клиентами и последними сообщениями (НОВОЕ в v2.3.2)
344
+ // Список чатов с клиентами и последними сообщениями
323
345
  const chats = await sdk.communications.getSellerChats();
324
346
  console.log('Активные чаты:', chats.result?.length);
325
347
  chats.result?.forEach(chat => {
@@ -363,7 +385,7 @@ const reportFile = await longTimeoutSdk.analytics.getDownloadsFile(downloadId);
363
385
 
364
386
  ## 📊 Статус Проекта и Разработка
365
387
 
366
- **Текущий Статус:** 🟢 Production Ready | **Версия SDK:** 1.0.0
388
+ **Текущий Статус:** 🟢 Production Ready | **Версия SDK:** 3.8.0
367
389
 
368
390
  **📖 [Project Status Summary](PROJECT_STATUS_SUMMARY.md)** — Комплексный обзор всех эпиков, историй и статуса реализации.
369
391
 
@@ -371,18 +393,11 @@ const reportFile = await longTimeoutSdk.analytics.getDownloadsFile(downloadId);
371
393
 
372
394
  | Метрика | Значение |
373
395
  |---------|----------|
374
- | **API модули** | 11/11 (100%) |
375
- | **API эндпоинты** | 200+ реализовано |
376
- | **Тесты** | 5,219 тестов проходят (100%) |
377
- | **Оценка качества** | 96.1/100 |
378
- | **Документация** | 73 файла, 22 примера |
379
- | **Размер бандла** | 567KB gzipped |
380
-
381
- ### Прогресс по Эпикам
382
-
383
- - ✅ **5 эпиков завершено** (Foundation, Products/Orders, Extended Modules, Integration, Testing)
384
- - 🔄 **2 эпика в работе** (Documentation, Code Quality)
385
- - 📝 **3 эпика запланировано** (Documentation Site, Web API Module)
396
+ | **API модули** | 13 (100%) |
397
+ | **API эндпоинты** | 240+ реализовано |
398
+ | **Тесты** | 2,111 тестов проходят (100%) |
399
+ | **Документация** | 44 руководства, 22 примера |
400
+ | **Размер бандла** | ~91KB gzipped (ESM) |
386
401
 
387
402
  > **⚠️ Для контрибьюторов:** При создании или завершении эпиков/историй **обновляйте [PROJECT_STATUS_SUMMARY.md](PROJECT_STATUS_SUMMARY.md)**, чтобы статус проекта оставался актуальным. Этот файл автоматически генерируется и должен отражать последнее состояние реализации.
388
403
 
@@ -405,22 +420,23 @@ const reportFile = await longTimeoutSdk.analytics.getDownloadsFile(downloadId);
405
420
 
406
421
  ## 🎯 Поддерживаемые Модули API
407
422
 
408
- Все 11 модулей Wildberries API полностью поддерживаются со 100% покрытием API:
423
+ Все 13 модулей Wildberries API полностью поддерживаются со 100% покрытием API:
409
424
 
410
425
  | Модуль | Описание |
411
426
  |--------|----------|
412
- | **General** | Ping, новости, информация о продавце, проверка подключения |
413
- | **Products** | Категории, CRUD, медиа, ценообразование, склад, запасы |
414
- | **Orders FBS** | Выполнение продавцом, статус заказа, доставка, поставки |
415
- | **Orders FBW** | Выполнение складом WB, планирование поставок |
416
- | **Finances** | Баланс, транзакции, отчеты, выплаты |
417
- | **Analytics** | Воронка продаж, поисковые запросы, история запасов, CSV отчеты |
427
+ | **General** | Ping, новости, информация о продавце, Jam-подписка, рейтинг продавца |
428
+ | **Products** | Категории, CRUD, медиа, ценообразование, склад, запасы, поддержка kizMarked |
429
+ | **Orders FBS** | Выполнение продавцом, статус заказа, доставка, поставки, валидация метаданных |
430
+ | **Orders FBW** | Выполнение складом WB, планирование поставок, информация о покупателе |
431
+ | **Orders DBS** | Доставка Продавцом - массовые операции, поддержка B2B, маркировка (SGTIN, IMEI) |
432
+ | **Finances** | Баланс, транзакции, Отчеты о Продажах v1, Эквайринг, `parseMoneyAmount()`, union-типы полей |
433
+ | **Analytics** | Воронка продаж, поисковые запросы, история запасов, запасы на складах WB, CSV отчеты |
418
434
  | **Reports** | Отчеты о доходах, отчеты о продажах, экспорт данных |
419
- | **Communications** | Чат с клиентами в реальном времени, вопросы-ответы по товарам, управление отзывами и рейтингами, предпросмотр чатов с последними сообщениями, **НОВОЕ:** закрепление отзывов на карточках товаров |
420
- | **Promotion** | Кампании, промокоды, реклама ⚠️ **[Требуется Миграция](https://salacoste.github.io/daytona-wildberries-typescript-sdk/guides/migration-v2.4-promotion-deprecation)** - 4 метода устарели (2 февраля 2026) |
435
+ | **Communications** | Чат с клиентами, вопросы-ответы по товарам, управление отзывами, закреплённые отзывы |
436
+ | **Promotion** | Кампании, ставки, минус-фразы, реклама |
421
437
  | **Tariffs** | Ставки комиссий, тарифные планы |
422
438
  | **In-Store Pickup** | Заказы с самовывозом и управление |
423
- | **Orders DBS** | Заказы DBS (Доставка Продавцом) - продавец хранит и доставляет товар напрямую покупателю, поддержка B2B, маркировка (SGTIN, IMEI) |
439
+ | **User Management** | Управление пользователями профиля продавца |
424
440
 
425
441
  ## 📄 Лицензия
426
442