Справочник SDK

Справочник SDK — это автоматически генерируемый справочник API для четырёх публичных TypeScript-пакетов, которые NeoTavern предоставляет авторам плагинов, тем и провайдеров.

Что генерируется

Справочник создаётся TypeDoc из точки входа src/index.ts каждого пакета при каждой сборке сайта. Он документирует точную экспортируемую поверхность:

• Plugin SDK — @neotavern/plugin-sdk: проверка манифеста, модель разрешений, типизированные события и контракты frontend- и backend-API плагинов.
• Theme SDK — @neotavern/theme-sdk: контракт дизайн-токенов, проверка манифеста тем, разрешение наследования и генерация CSS-переменных.
• Provider SDK — @neotavern/provider-sdk: контракт адаптера провайдера, встроенные адаптеры, оценка токенов и реестр рантайма.
• Contracts — @neotavern/contracts: общие схемы запросов, ответов и сущностей, от которых происходят и backend-маршруты, и типы фронтенда.

Сгенерированные страницы не пишутся вручную и не коммитятся в репозиторий. Они пересоздаются при каждой сборке, поэтому всегда соответствуют текущему src/ пакетов.

Регенерация справочника

Любая сборка Docusaurus регенерирует справочник как часть конвейера:

pnpm --filter @neotavern/docs build

Запустите ту же команду локально, когда хотите получить свежий справочник после изменения файла исходника SDK.

Просмотр пакетов

• Справочник Plugin SDK
• Справочник Theme SDK
• Справочник Provider SDK
• Справочник Contracts

Вместо сырых списков API с руководствами по использованию обратитесь к разделам Plugin SDK, Theme SDK и «Провайдеры» этой документации. Они объясняют контракты прозой, с примерами, и ссылаются на сгенерированные страницы для точных сигнатур.