@weavix/sdk-react 0.0.1 → 0.0.3

package/README.md

@@ -1,45 +1,53 @@
 # @weavix/sdk-react
 
-React hooks and components for the Tracker Plugin SDK — Weavix flavor.
+Generic plugin SDK React package — framework-agnostic `PluginProvider` and hooks, no Tracker-specific types.
 
-> Это external-публикация. Внутренний (Yandex) аналог: `@yandex-data-ui/tracker-plugin-sdk-react`.
+Automatically includes [`@weavix/sdk-core`](https://www.npmjs.com/package/@weavix/sdk-core) as a dependency.
 
-## Установка
+## Installation
 
 ```bash
-npm install @weavix/sdk-react @weavix/sdk-core @weavix/tracker-api-types react
-# или
-pnpm add @weavix/sdk-react @weavix/sdk-core @weavix/tracker-api-types react
+npm install @weavix/sdk-react
+# @weavix/sdk-core is installed automatically
 ```
 
-## Что внутри
-
-- `<TrackerPluginProvider>` — провайдер инициализирует плагин.
-- `useTrackerPluginContext()` — реактивные значения (theme, language, slot, slotContext) и `registerHandler`.
-- `useTheme()`, `useLanguage()`, `useUserId()`, `useIsYateam()` — реактивные хуки.
-- `useToaster()`, `useConfirm()` — UI-методы.
-- `useLocalizedString()`, `useContext()` — вспомогательные.
-- `<PluginError>`, `<PluginLoader>` — компоненты для fallback'ов.
-
-API surface идентичен internal flavor'у.
-
-## Пример
+## Usage
 
 ```tsx
-import { TrackerPluginProvider, useToaster } from '@weavix/sdk-react';
+import { PluginProvider, usePluginContext } from '@weavix/sdk-react';
+
+// Wrap your app
+root.render(
+  <PluginProvider>
+    <App />
+  </PluginProvider>
+);
 
+// Use in components
 function App() {
-    const toaster = useToaster();
-    return <button onClick={() => toaster.add({ title: 'Hi' })}>Toast</button>;
+  const { slot, slotContext, theme, language, registerHandler } = usePluginContext();
+
+  return <div>Slot: {slot}</div>;
 }
 
-root.render(
-    <TrackerPluginProvider>
-        <App />
-    </TrackerPluginProvider>
-);
+// Full context (requires contextLevel: "full" in manifest)
+function AppFull() {
+  const { slotContext } = usePluginContext('full');
+  // slotContext: unknown — cast to your type
+  const ctx = slotContext as { entityId: string };
+  return <div>Entity: {ctx.entityId}</div>;
+}
 ```
 
-## License
+## What's included
+
+- **`PluginProvider`** — initializes the plugin, manages lifecycle, provides context
+- **`usePluginContext()`** — hook for accessing theme, language, slot, slotContext, registerHandler
+- **`isInternalUrl()`** — utility for checking if a URL is internal
+- **Hooks**: `useTheme`, `useLanguage`, `useIsYateam`, `useUserId`, `useConfirm`, `useToaster`, `useLocalizedString`
+- **Components**: `PluginError`, `PluginLoader`, `ErrorBoundary`
+- **Re-exports from `@weavix/sdk-core`**: `hostApi`, `uiApi`, `on`, `dispatchHostEvent`, error codes, types (no `trackerApi` — use tracker-react packages for Tracker HTTP)
+
+## For Tracker plugins
 
-UNLICENSED.
+Use [`@yandex-data-ui/tracker-plugin-sdk-react`](https://npm.yandex-team.ru/@yandex-data-ui/tracker-plugin-sdk-react) (internal) or [`@weavix/tracker-plugin-sdk-react`](https://www.npmjs.com/package/@weavix/tracker-plugin-sdk-react) (external) for fully typed Tracker-specific wrappers.