@fozy-labs/rx-toolkit 0.4.1 → 0.4.2

package/docs/query/README.md

@@ -28,6 +28,7 @@ Operations представляют одноразовые операции ил
 Agents представляют собой интеллектуальные обертки над ресурсами (или операциями), 
 которые обеспечивают более удобную работу с состояниями запросов для потребителей.
 
+
 #### Основная проблема, которую решают агенты
 
 Кэш ресурсов (или операций) содержит "сырые" состояния отдельных запросов, но потребителям нужна более высокоуровневая логика. 
@@ -36,6 +37,15 @@ Agents представляют собой интеллектуальные об
 - При смене аргументов запроса нужно показывать данные предыдущего запроса, пока загружается новый
 - Состояние загрузки должно отражать контекст использования, а не просто состояние кэша
 
+
+### ResourceRef (Ссылка на ресурс)
+Ref - это абстракция, для взаимодействия с ресурсом.
+
+**Особенности:**
+- Операции использует ref под капотом, чтобы управлять связанным ресурсом.
+- Ref могут ссылаться на отсутствующий ресурс.
+
+
 ## API
 
 ### createResource
@@ -98,6 +108,7 @@ const updateUser = createOperation<
 
 ## Свойства Link
 ```typescript
+
 /**
  * Настройки связи операции с ресурсом
  */
@@ -107,30 +118,30 @@ export type LinkOptions<D extends OperationDefinition, RD extends ResourceDefini
      * @required
      */
     resource: ResourceInstance<RD>;
-    
+
     /**
-     * Функция для получения аргументов ресурса из аргументов операции
+     * Функция для получения аргументов ресурса из аргументов операции.
      * Используется для определения какой именно элемент в кэше ресурса нужно обновить
      * @required
      */
     forwardArgs: (args: D["Args"]) => RD["Args"];
-    
+
     /**
-     * Флаг для инвалидации (очистки) кэша ресурса после выполнения операции
+     * Флаг для инвалидации (очистки) кэша ресурса после выполнения операции.
      * При true - кэш будет очищен и ресурс будет перезагружен при следующем обращении
      * @optional @default false
      */
     invalidate?: boolean;
-    
+
     /**
-     * Флаг для блокировки ресурса во время выполнения операции
+     * Флаг для блокировки ресурса во время выполнения операции.
      * При true - ресурс будет заблокирован и не сможет выполнять новые запросы
      * @optional @default false
      */
     lock?: boolean;
-    
+
     /**
-     * Функция для обновления кэша ресурса после успешного выполнения операции
+     * Функция для обновления кэша ресурса после успешного выполнения операции.
      * Получает draft объект для мутации, аргументы операции и результат операции
      * @optional
      */
@@ -141,10 +152,10 @@ export type LinkOptions<D extends OperationDefinition, RD extends ResourceDefini
         args: D["Args"];
         /** Результат выполнения операции */
         data: D["Data"];
-    }) => void | RD["Data"] | Promise<RD["Data"]>;
-    
+    }) => void | RD["Data"];
+
     /**
-     * Функция для оптимистичного обновления кэша ресурса ДО выполнения операции
+     * Функция для оптимистичного обновления кэша ресурса ДО выполнения операции.
      * Позволяет обновить UI немедленно, до получения ответа от сервера
      * @optional
      */
@@ -153,10 +164,10 @@ export type LinkOptions<D extends OperationDefinition, RD extends ResourceDefini
         draft: RD["Data"];
         /** Аргументы, с которыми была вызвана операция */
         args: D["Args"];
-    }) => void | RD["Data"] | Promise<D["Data"]>;
-    
+    }) => void | RD["Data"];
+
     /**
-     * Функция для создания нового элемента в кэше ресурса
+     * Функция для создания нового элемента в кэше ресурса.
      * Используется когда операция создает новую сущность, которую нужно добавить в кэш
      * @optional
      */

package/docs/signals/README.md

@@ -67,10 +67,18 @@ sub.unsubscribe();
 // TODO убрать zod из core, добавить возможность передавать "driver".
 
 ```typescript
+import { z } from 'zod/v4';
 import { LocalSignal } from '@fozy-labs/rx-toolkit';
 
+enum FILTER {
+    ALL = 'all',
+    CHANNELS = 'channels',
+    CHATS = 'chats',
+    MEETINGS = 'meetings',
+}
+
 const selectedFilter$ = new LocalSignal({
-    key: 'projects-list-selected-filter',
+    key: 'memberships-list-selected-filter',
     defaultValue: FILTER.ALL,
     zodSchema: z.enum(FILTER),
 });
@@ -78,10 +86,6 @@ const selectedFilter$ = new LocalSignal({
 
 ## Operators (Операторы)
 
-### batched
-Группирует несколько обновлений в одну транзакцию для оптимизации производительности.
-// TODO: проверить, тк не используется в fozy, добавить пример использования
-
 ### mapSignals
 // TODO: добавить описание
 
@@ -91,9 +95,8 @@ const selectedFilter$ = new LocalSignal({
 Преобразует Observable в Signal.
 
 ```typescript
-import { signalize } from '@fozy-labs/rx-toolkit';
 import { interval } from 'rxjs';
-import { Effect } from "src/signal/base/Effect";
+import { signalize, Effect } from '@fozy-labs/rx-toolkit';
 
 // Создаем Observable, который эмитит значение каждую секунду
 const timer$ = interval(1000).pipe(

package/package.json

@@ -1,22 +1,19 @@
 {
   "name": "@fozy-labs/rx-toolkit",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",
   "scripts": {
     "build": "rimraf ./dist && tsc && tsc-alias",
-    "build:watch": "rimraf ./dist && (concurrently \"tsc -w\" \"tsc-alias -w\")",
+    "build:watch": "npm run build && (concurrently \"tsc -w\" \"tsc-alias -w\")",
     "ts-check": "tsc --noEmit"
   },
-  "dependencies": {
-    "@reatom/devtools": "0.13.1"
-  },
   "devDependencies": {
+    "concurrently": "9.2.0",
     "rimraf": "6.0.1",
     "tsc-alias": "^1.8.16",
     "tsconfig-paths": "4.2.0",
-    "concurrently": "9.2.0",
     "typescript": "5.9.2",
     "zod": "4.1.11"
   },
@@ -29,7 +26,12 @@
   "author": "Vladimir Panev <vova6255@gmail.com>",
   "homepage": "https://github.com/fozy-labs/rx-toolkit",
   "license": "MIT",
-  "keywords": ["react", "rxjs", "toolkit", "state-management"],
+  "keywords": [
+    "react",
+    "rxjs",
+    "toolkit",
+    "state-management"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fozy-labs/rx-toolkit.git"
@@ -53,5 +55,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "preferGlobal": false
+  "preferGlobal": false,
+  "dependencies": {
+    "immer": "^10.1.3"
+  }
 }

package/dist/query/api/createDevtools.d.ts

@@ -1 +0,0 @@
-export declare function createDevtools(): import("@reatom/devtools").Devtools;

package/dist/query/api/createDevtools.js

@@ -1,6 +0,0 @@
-import { createDevtools as createRaDevtools } from "@reatom/devtools";
-export function createDevtools() {
-    return createRaDevtools({
-        initVisibility: true,
-    });
-}

package/dist/signal/base/Batcher.d.ts

@@ -1,7 +0,0 @@
-import { BehaviorSubject } from "rxjs";
-export declare const Batcher: {
-    isLocked$: BehaviorSubject<boolean>;
-    lock(): void;
-    unlock(): void;
-    batch(fn: () => void): void;
-};

package/dist/signal/base/Batcher.js

@@ -1,21 +0,0 @@
-import { BehaviorSubject } from "rxjs";
-export const Batcher = {
-    isLocked$: new BehaviorSubject(false),
-    lock() {
-        if (this.isLocked$.value)
-            return;
-        this.isLocked$.next(true);
-    },
-    unlock() {
-        if (!this.isLocked$.value)
-            return;
-        this.isLocked$.next(false);
-    },
-    batch(fn) {
-        if (this.isLocked$.value)
-            return fn();
-        this.lock();
-        fn();
-        this.unlock();
-    },
-};

package/dist/signal/base/Effect.js

@@ -1,69 +0,0 @@
-import { Batcher } from "../../signal/base/Batcher";
-import { Tracker } from "./Tracker";
-export class Effect {
-    _doLog;
-    closed = false;
-    _subscriptions = [];
-    constructor(effectFn, _doLog = false) {
-        this._doLog = _doLog;
-        if (this._doLog)
-            console.log("Run EffectFn. Reason: init");
-        this._runInTrackedContext(effectFn, false);
-    }
-    /**
-     * Выполняет функцию в tracked-контексте, подписываясь на Tracker.
-     */
-    _runInTrackedContext(effectFn, doUnsubscribe = true) {
-        // Отписываемся от предыдущих подписок
-        if (doUnsubscribe) {
-            this._subscriptions.forEach((sub) => sub.unsubscribe());
-            this._subscriptions = [];
-        }
-        let isTrackedContext = true;
-        let isWaitingBatching = false;
-        // Подписываемся на Tracker. Во время выполнения подпишемся на все tracked наблюдатели.
-        const trackerSub = Tracker.tracked$.subscribe((tracked$) => {
-            if (!isTrackedContext)
-                return;
-            this._subscriptions.push(tracked$.subscribe(() => {
-                if (isTrackedContext) {
-                    return;
-                }
-                if (isWaitingBatching) {
-                    if (this._doLog)
-                        console.log("Effect: still waiting for batching to finish", { tracked$ });
-                    return;
-                }
-                if (Batcher.isLocked$.value) {
-                    // console.log("Effect: waiting for batching to finish");
-                    isWaitingBatching = true;
-                    const sub = Batcher.isLocked$
-                        .subscribe((isLocked) => {
-                        if (isLocked)
-                            return;
-                        sub.unsubscribe();
-                        isWaitingBatching = false;
-                        if (this._doLog)
-                            console.log("Run EffectFn. Reason: tracked observable change after batching", { tracked$ });
-                        this._runInTrackedContext(effectFn);
-                    });
-                    return;
-                }
-                if (this._doLog)
-                    console.log("Run EffectFn. Reason: tracked observable change", { tracked$ });
-                this._runInTrackedContext(effectFn);
-            }));
-        });
-        effectFn((fn) => {
-            if (this._doLog)
-                console.log("Run EffectFn. Reason: manual trigger sub context");
-            this._runInTrackedContext(fn, false);
-        });
-        trackerSub.unsubscribe();
-        isTrackedContext = false;
-    }
-    unsubscribe() {
-        this.closed = true;
-        this._subscriptions.forEach((sub) => sub.unsubscribe());
-    }
-}

package/dist/signal/base/ReadonlySignal.js

@@ -1,20 +0,0 @@
-import { SyncObservable } from "./SyncObservable";
-import { Tracker } from "./Tracker";
-export class ReadonlySignal extends SyncObservable {
-    constructor(subscribe) {
-        super(subscribe);
-    }
-    get value() {
-        Tracker.next(this);
-        return super.value;
-    }
-    peek() {
-        return super.value;
-    }
-    /**
-     * @deprecated
-     */
-    get() {
-        return this.value;
-    }
-}

package/dist/signal/base/Tracker.d.ts

@@ -1,5 +0,0 @@
-import { type Observable, Subject } from "rxjs";
-export declare const Tracker: {
-    tracked$: Subject<Observable<unknown>>;
-    next(value: Observable<unknown>): void;
-};

package/dist/signal/base/Tracker.js

@@ -1,7 +0,0 @@
-import { Subject } from "rxjs";
-export const Tracker = {
-    tracked$: new Subject(),
-    next(value) {
-        Tracker.tracked$.next(value);
-    },
-};

package/dist/signal/operators/batch.d.ts

@@ -1,2 +0,0 @@
-import { MonoTypeOperatorFunction } from "rxjs";
-export declare function batched<T>(): MonoTypeOperatorFunction<T>;

package/dist/signal/operators/batch.js

@@ -1,27 +0,0 @@
-import { createOperatorSubscriber } from "rxjs/internal/operators/OperatorSubscriber";
-import { ReadonlySignal, Batcher } from "../base";
-export function batched() {
-    return (source) => {
-        let lockSubscription = null;
-        let lastResult = undefined;
-        return new ReadonlySignal((destination) => source.subscribe(createOperatorSubscriber(destination, (value) => {
-            if (lockSubscription) {
-                lastResult = value;
-                return;
-            }
-            if (Batcher.isLocked$.value) {
-                lastResult = value;
-                lockSubscription = Batcher.isLocked$.subscribe((isLocked) => {
-                    if (!isLocked) {
-                        lockSubscription.unsubscribe();
-                        lockSubscription = null;
-                        destination.next(lastResult);
-                        lastResult = undefined;
-                    }
-                });
-                return;
-            }
-            destination.next(value);
-        })));
-    };
-}

package/dist/signal/operators/index.d.ts

@@ -1,4 +0,0 @@
-export * from './batch';
-export * from './filterUpdates';
-export * from '../../signal/operators/mapSignals';
-export * from './signalize';

package/dist/signal/operators/index.js

@@ -1,4 +0,0 @@
-export * from './batch';
-export * from './filterUpdates';
-export * from '../../signal/operators/mapSignals';
-export * from './signalize';