История изменений SDK
Заметки о выпусках @aacsearch/client (TypeScript), @aacsearch/react и Python SDK (aacsearch). Используйте эту страницу, если вы работаете с SDK AACSearch и хотите получать выжимку изменений без шума API и виджета.
Эта страница охватывает пакеты SDK AACSearch. Формат соответствует Формату журнала изменений; правила версионирования описаны в Политике версионирования и прекращения поддержки.
Отслеживаемые пакеты
| Пакет | Поверхность | Последняя |
|---|---|---|
@aacsearch/client | TypeScript-клиент для браузера и сервера | 0.1.x |
@aacsearch/react | React-хуки (useAACsearch и др.) | 0.1.x |
aacsearch (Python) | Python REST-клиент | 0.1.x |
(Цифры — заглушки; подпишитесь на npm/pypi для актуальных данных.)
@aacsearch/client
SemVer. MAJOR ломает API клиента или мажорную версию REST, на которую он нацелен. MINOR добавляет методы/необязательные аргументы. PATCH — только исправления.
Последние заметки о выпусках: npm.
Миграция
При повышении мажорной версии дельта миграции находится на
/migration/sdk/v<n>-to-v<n+1>. Предыдущая мажорная версия остаётся
доступной для установки из npm в течение 6 месяцев.
@aacsearch/react
React-хуки, построенные поверх @aacsearch/client. Следуют за мажорными
версиями @aacsearch/client — повышение версии React-пакета обычно
соответствует повышению peer-зависимости на нижележащий клиент.
Контракт хуков:
import { useAACsearch, useAACSuggest, useAACFacet } from "@aacsearch/react";Критические переименования в поверхности хуков публикуются под ⚠ Breaking на этой странице и вызывают повышение мажорной версии.
aacsearch (Python)
Python-клиент. Независимый трек SemVer от TypeScript-клиента (он нацелен на тот же REST API, но предоставляет другую языковую поверхность).
Структура модуля:
from aacsearch import SearchClient, AdminClientКритические изменения следуют тем же правилам уведомления, что и TypeScript-клиент.
Примечания
- Новый выпуск SDK не означает автоматически изменения REST API. SDK могут публиковать косметические переименования или внутренние рефакторинги, не затрагивая публичную поверхность REST.
- Изменение REST API всегда означает выпуск SDK в тот же день, если SDK предоставлял затронутую поверхность.
- Журнал изменений виджета ведётся отдельно на /changelog/widget.
История изменений API
Изменения REST + oRPC + полезных нагрузок вебхуков для AACSearch. Подпишитесь, если вы работаете с публичным API и хотите получать выжимку изменений без шума панели управления и SDK.
История изменений виджета
Заметки о выпусках @aacsearch/widget — поискового виджета на Vanilla JS Shadow DOM. Подпишитесь, если вы встраиваете виджет на публичный сайт и хотите получать уведомления о версиях CDN.