@weavix/sdk-core
v0.0.1
Published
Core package for Tracker plugin SDK (Weavix flavor)
Readme
@weavix/sdk-core
Core package for the Tracker Plugin SDK — Weavix flavor.
Это external-публикация. Внутренний (Yandex) аналог:
@yandex-data-ui/tracker-plugin-sdk-core.
Установка
npm install @weavix/sdk-core @weavix/tracker-api-types
# или
pnpm add @weavix/sdk-core @weavix/tracker-api-types@weavix/tracker-api-types — peerDep с типами OpenAPI-эндпоинтов Tracker'а. Укажите версию, совместимую со своим API.
Что внутри
@weavix/sdk-core экспортирует:
trackerApi— типизированный proxy для вызовов Tracker REST API v3.hostApi— методы взаимодействия с хост-приложением (theme, language, context, navigation, content size).setHandler/getHandler— регистрация плагин-обработчиков для запросов от хоста.dispatchHostEvent/on/resetEventBus— событийная шина для push-событий хоста.uiApi— Toaster и Confirm.getField— утилита для безопасного чтения вложенных полей.getLocalizedString— извлечение локализованной строки.- Коды ошибок:
METHOD_NOT_SUPPORTED,MISSING_REQUIRED_SCOPE,PLUGIN_ID_*,UNKNOWN_ERROR,VALIDATION_ERROR. PluginActionError.
API surface полностью идентичен internal flavor'у; различается только источник api-types-типов.
Пример
import { hostApi, trackerApi } from '@weavix/sdk-core';
await hostApi.notifyReady();
const { data } = await trackerApi.v3.get['/issues/{id}']({
pathParams: { id: 'KEY-1' },
});
console.log(data.summary);License
UNLICENSED.
