@fozy-labs/rx-toolkit 0.5.3-rc.2 → 0.5.4

package/docs/{release → contributing/release}/README.md

@@ -1,59 +1,59 @@
-# Релиз
-
-Процесс выпуска новой версии RxToolkit.
-
-## Подготовка
-
-1. Убедитесь, что все изменения закоммичены
-2. Обновите CHANGELOG (если есть)
-3. Проверьте документацию
-
-## Команды релиза
-
-```bash
-# 1. Проверка типов
-npm run ts-check 
-
-# 2. Сборка проекта
-npm run build     
-
-# 3. Обновление версии
-npm version patch   # для патч-версии (0.4.18 -> 0.4.19)
-npm version minor   # для минорной версии (0.4.18 -> 0.5.0)
-npm version major   # для мажорной версии (0.4.18 -> 1.0.0)
-
-# 4. Публикация в npm
-npm publish 
-
-# 5. Пуш тегов в репозиторий
-git push origin develop --tags
-```
-
-## rc
-
-### Выпуск релиза-кандидата (RC)
-
-```bash
-# 1. Проверка типов
-npm run ts-check
-
-# 2. Сборка проекта
-npm run build
-
-# 3. Обновление версии до RC
-npm version prerelease --preid=rc
-# пример: 1.2.0 → 1.2.0-rc.0
-
-# 4. Публикация RC (НЕ latest!)
-npm publish --tag rc
-
-# 5. Пуш тегов
-git push origin develop --tags
-```
-
-### Переход с RC на stable
-```bash
-npm version <latest_version>
-npm publish
-git push origin develop --tags
-```
+# Релиз
+
+Процесс выпуска новой версии RxToolkit.
+
+## Подготовка
+
+1. Убедитесь, что все изменения закоммичены
+2. Обновите CHANGELOG (если есть)
+3. Проверьте документацию
+
+## Команды релиза
+
+```bash
+# 1. Проверка типов
+npm run ts-check 
+
+# 2. Сборка проекта
+npm run build     
+
+# 3. Обновление версии
+npm version patch   # для патч-версии (0.4.18 -> 0.4.19)
+npm version minor   # для минорной версии (0.4.18 -> 0.5.0)
+npm version major   # для мажорной версии (0.4.18 -> 1.0.0)
+
+# 4. Публикация в npm
+npm publish 
+
+# 5. Пуш тегов в репозиторий
+git push origin develop --tags
+```
+
+## rc
+
+### Выпуск релиза-кандидата (RC)
+
+```bash
+# 1. Проверка типов
+npm run ts-check
+
+# 2. Сборка проекта
+npm run build
+
+# 3. Обновление версии до RC
+npm version prerelease --preid=rc
+# пример: 1.2.0 → 1.2.0-rc.0
+
+# 4. Публикация RC (НЕ latest!)
+npm publish --tag rc
+
+# 5. Пуш тегов
+git push origin develop --tags
+```
+
+### Переход с RC на stable
+```bash
+npm version <latest_version>
+npm publish
+git push origin develop --tags
+```

package/docs/devtools/README.md

@@ -1,228 +1,228 @@
-# Devtools
-
-RxToolkit предоставляет интеграцию с популярными инструментами разработчика для отладки реактивных приложений в реальном времени. Вы можете отслеживать изменения сигналов, выполнение команд и состояние ресурсов.
-
-**Отслеживает изменения:**
-- Сигналов (Signal / Computed)
-- Ресурсов и команд (Resource / Command)
-
----
-
-## Redux DevTools
-
-Популярное браузерное расширение для отладки состояния приложений. **RxToolkit включает встроенный адаптер `reduxDevtools()`**.
-
-### Установка
-
-1. Установите [расширение Redux DevTools](https://github.com/reduxjs/redux-devtools) для браузера
-2. Подключите в коде:
-
-```typescript
-import { DefaultOptions, reduxDevtools } from '@fozy-labs/rx-toolkit';
-
-DefaultOptions.update({ 
-    DEVTOOLS: reduxDevtools() 
-});
-```
-
-### Опции reduxDevtools
-
-```typescript
-reduxDevtools({
-    // Имя приложения в DevTools
-    name: 'MyApp',
-    
-    // Стратегия батчинга обновлений
-    batchStrategy: 'microtask', // 'sync' | 'microtask' | 'task'
-    
-    // Задержка для стратегии 'task' (мс)
-    taskDelay: 0,
-})
-```
-
-**Стратегии батчинга (batchStrategy):**
-
-| Стратегия     | Описание                                                                                                        |
-|---------------|-----------------------------------------------------------------------------------------------------------------|
-| `'sync'`      | Синхронное выполнение без батчинга. Каждое обновление отправляется немедленно. Интегрируется с Batcher сигналов |
-| `'microtask'` | **(default)** Пакование в микротаске. Все обновления в текущем синхронном потоке объединяются                   |
-| `'task'`      | Пакование в макротаске (setTimeout) с настраиваемой задержкой                                                   |
-
----
-
-## @reatom/devtools
-
-Npm пакет с встроенным отладчиком, работающим прямо в браузере. После подключения в углу страницы появляется кнопка, которая открывает панель инструментов.
-
-### Установка
-
-```bash
-npm install @reatom/devtools
-```
-
-### Подключение
-
-```typescript
-import { DefaultOptions } from '@fozy-labs/rx-toolkit';
-import { createDevtools } from '@reatom/devtools';
-
-DefaultOptions.update({
-    DEVTOOLS: createDevtools({ 
-        initVisibility: true // Показать панель при загрузке
-    })
-});
-```
-
-**Может пригодиться:**
-- Если в вашей среде невозможно установить браузерное расширение
-- Для мобильной отладки
-
----
-
-## DefaultOptions
-
-`DefaultOptions.update()` позволяет настроить глобальные опции RxToolkit:
-
-```typescript
-import { DefaultOptions, reduxDevtools } from '@fozy-labs/rx-toolkit';
-import { Observable } from 'rxjs';
-
-DefaultOptions.update({
-    // Devtools интеграция
-    DEVTOOLS: reduxDevtools(),
-    
-    // Глобальный обработчик ошибок запросов
-    onQueryError: (error) => {
-        console.error('Query error:', error);
-        // Можно отправить в систему мониторинга
-        errorTracker.capture(error);
-    },
-    
-    // Функция для получения имени текущего scope (полезно для SSR)
-    getScopeName: () => {
-        return currentRequestId ?? null;
-    },
-});
-```
-
-### Параметры DefaultOptions
-
-| Параметр | Тип | Описание |
-|----------|-----|----------|
-| `DEVTOOLS` | `DevtoolsLike \| null` | Интеграция с devtools |
-| `onQueryError` | `(error: unknown) => void` | Глобальный обработчик ошибок запросов |
-| `getScopeName` | `() => string \| null` | Получение имени текущего scope |
-
----
-
-## Практики
-
-### Development-режим
-
-Подключайте devtools только в режиме разработки:
-
-```typescript
-// Node.js / Webpack
-if (process.env.NODE_ENV !== 'production') {
-    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
-}
-
-// Vite
-if (import.meta.env.DEV) {
-    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
-}
-
-// Next.js
-if (process.env.NODE_ENV === 'development') {
-    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
-}
-```
-
-### SSR-совместимость
-
-Защитите от выполнения на сервере:
-
-```typescript
-if (typeof window !== 'undefined' && process.env.NODE_ENV !== 'production') {
-    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
-}
-```
-
-### Несколько инструментов
-
-Можно комбинировать несколько devtools с помощью `combineDevtools`:
-
-```typescript
-import { combineDevtools, reduxDevtools, DefaultOptions } from '@fozy-labs/rx-toolkit';
-import { createDevtools } from '@reatom/devtools';
-
-DefaultOptions.update({
-    DEVTOOLS: combineDevtools(
-        reduxDevtools({ name: 'MyApp' }),
-        createDevtools({ initVisibility: true })
-    )
-});
-```
-
-### Именование для devtools
-
-При создании сигналов и запросов можно указывать имена для удобной отладки:
-
-```typescript
-// Сигналы
-const count$ = new Signal(0, 'counter');
-const user$ = new Signal(null, { name: 'currentUser' });
-
-// Ресурсы и команды
-const userResource = createResource({
-    queryFn: fetchUser,
-    devtoolsName: 'user-resource', // Имя в devtools
-});
-
-const updateUser = createCommand({
-    queryFn: updateUserApi,
-    devtoolsName: 'update-user',
-});
-
-// Отключение devtools для конкретного сигнала
-const internalSignal = new Signal(0, { isDisabled: true });
-
-// Отключение devtools для ресурса
-const internalResource = createResource({
-    queryFn: fetchInternal,
-    devtoolsName: false, // Не отслеживать
-});
-```
-
----
-
-## DevtoolsLike интерфейс
-
-Если вам нужно создать кастомную интеграцию с devtools:
-
-```typescript
-interface DevtoolsLike {
-    state<T>(name: string, initState: T): DevtoolsStateLike<T>;
-}
-
-interface DevtoolsStateLike<T = any> {
-    (newState: T | '$COMPLETED' | '$CLEANED'): void;
-}
-```
-
-**Пример кастомного devtools:**
-
-```typescript
-const customDevtools: DevtoolsLike = {
-    state(name, initState) {
-        console.log(`[INIT] ${name}:`, initState);
-        
-        return (newState) => {
-            console.log(`[UPDATE] ${name}:`, newState);
-        };
-    }
-};
-
-DefaultOptions.update({ DEVTOOLS: customDevtools });
-```
-
+# Devtools
+
+RxToolkit предоставляет интеграцию с популярными инструментами разработчика для отладки реактивных приложений в реальном времени. Вы можете отслеживать изменения сигналов, выполнение команд и состояние ресурсов.
+
+**Отслеживает изменения:**
+- Сигналов (Signal / Computed)
+- Ресурсов и команд (Resource / Command)
+
+---
+
+## Redux DevTools
+
+Популярное браузерное расширение для отладки состояния приложений. **RxToolkit включает встроенный адаптер `reduxDevtools()`**.
+
+### Установка
+
+1. Установите [расширение Redux DevTools](https://github.com/reduxjs/redux-devtools) для браузера
+2. Подключите в коде:
+
+```typescript
+import { DefaultOptions, reduxDevtools } from '@fozy-labs/rx-toolkit';
+
+DefaultOptions.update({ 
+    DEVTOOLS: reduxDevtools() 
+});
+```
+
+### Опции reduxDevtools
+
+```typescript
+reduxDevtools({
+    // Имя приложения в DevTools
+    name: 'MyApp',
+    
+    // Стратегия батчинга обновлений
+    batchStrategy: 'microtask', // 'sync' | 'microtask' | 'task'
+    
+    // Задержка для стратегии 'task' (мс)
+    taskDelay: 0,
+})
+```
+
+**Стратегии батчинга (batchStrategy):**
+
+| Стратегия     | Описание                                                                                                        |
+|---------------|-----------------------------------------------------------------------------------------------------------------|
+| `'sync'`      | Синхронное выполнение без батчинга. Каждое обновление отправляется немедленно. Интегрируется с Batcher сигналов |
+| `'microtask'` | **(default)** Пакование в микротаске. Все обновления в текущем синхронном потоке объединяются                   |
+| `'task'`      | Пакование в макротаске (setTimeout) с настраиваемой задержкой                                                   |
+
+---
+
+## @reatom/devtools
+
+Npm пакет с встроенным отладчиком, работающим прямо в браузере. После подключения в углу страницы появляется кнопка, которая открывает панель инструментов.
+
+### Установка
+
+```bash
+npm install @reatom/devtools
+```
+
+### Подключение
+
+```typescript
+import { DefaultOptions } from '@fozy-labs/rx-toolkit';
+import { createDevtools } from '@reatom/devtools';
+
+DefaultOptions.update({
+    DEVTOOLS: createDevtools({ 
+        initVisibility: true // Показать панель при загрузке
+    })
+});
+```
+
+**Может пригодиться:**
+- Если в вашей среде невозможно установить браузерное расширение
+- Для мобильной отладки
+
+---
+
+## DefaultOptions
+
+`DefaultOptions.update()` позволяет настроить глобальные опции RxToolkit:
+
+```typescript
+import { DefaultOptions, reduxDevtools } from '@fozy-labs/rx-toolkit';
+import { Observable } from 'rxjs';
+
+DefaultOptions.update({
+    // Devtools интеграция
+    DEVTOOLS: reduxDevtools(),
+    
+    // Глобальный обработчик ошибок запросов
+    onQueryError: (error) => {
+        console.error('Query error:', error);
+        // Можно отправить в систему мониторинга
+        errorTracker.capture(error);
+    },
+    
+    // Функция для получения имени текущего scope (полезно для SSR)
+    getScopeName: () => {
+        return currentRequestId ?? null;
+    },
+});
+```
+
+### Параметры DefaultOptions
+
+| Параметр | Тип | Описание |
+|----------|-----|----------|
+| `DEVTOOLS` | `DevtoolsLike \| null` | Интеграция с devtools |
+| `onQueryError` | `(error: unknown) => void` | Глобальный обработчик ошибок запросов |
+| `getScopeName` | `() => string \| null` | Получение имени текущего scope |
+
+---
+
+## Практики
+
+### Development-режим
+
+Подключайте devtools только в режиме разработки:
+
+```typescript
+// Node.js / Webpack
+if (process.env.NODE_ENV !== 'production') {
+    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
+}
+
+// Vite
+if (import.meta.env.DEV) {
+    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
+}
+
+// Next.js
+if (process.env.NODE_ENV === 'development') {
+    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
+}
+```
+
+### SSR-совместимость
+
+Защитите от выполнения на сервере:
+
+```typescript
+if (typeof window !== 'undefined' && process.env.NODE_ENV !== 'production') {
+    DefaultOptions.update({ DEVTOOLS: reduxDevtools() });
+}
+```
+
+### Несколько инструментов
+
+Можно комбинировать несколько devtools с помощью `combineDevtools`:
+
+```typescript
+import { combineDevtools, reduxDevtools, DefaultOptions } from '@fozy-labs/rx-toolkit';
+import { createDevtools } from '@reatom/devtools';
+
+DefaultOptions.update({
+    DEVTOOLS: combineDevtools(
+        reduxDevtools({ name: 'MyApp' }),
+        createDevtools({ initVisibility: true })
+    )
+});
+```
+
+### Именование для devtools
+
+При создании сигналов и запросов можно указывать имена для удобной отладки:
+
+```typescript
+// Сигналы
+const count$ = new Signal(0, 'counter');
+const user$ = new Signal(null, { name: 'currentUser' });
+
+// Ресурсы и команды
+const userResource = createResource({
+    queryFn: fetchUser,
+    devtoolsName: 'user-resource', // Имя в devtools
+});
+
+const updateUser = createCommand({
+    queryFn: updateUserApi,
+    devtoolsName: 'update-user',
+});
+
+// Отключение devtools для конкретного сигнала
+const internalSignal = new Signal(0, { isDisabled: true });
+
+// Отключение devtools для ресурса
+const internalResource = createResource({
+    queryFn: fetchInternal,
+    devtoolsName: false, // Не отслеживать
+});
+```
+
+---
+
+## DevtoolsLike интерфейс
+
+Если вам нужно создать кастомную интеграцию с devtools:
+
+```typescript
+interface DevtoolsLike {
+    state<T>(name: string, initState: T): DevtoolsStateLike<T>;
+}
+
+interface DevtoolsStateLike<T = any> {
+    (newState: T | '$COMPLETED' | '$CLEANED'): void;
+}
+```
+
+**Пример кастомного devtools:**
+
+```typescript
+const customDevtools: DevtoolsLike = {
+    state(name, initState) {
+        console.log(`[INIT] ${name}:`, initState);
+        
+        return (newState) => {
+            console.log(`[UPDATE] ${name}:`, newState);
+        };
+    }
+};
+
+DefaultOptions.update({ DEVTOOLS: customDevtools });
+```
+