@virentia/effector 0.1.1 → 0.2.0

package/README.md

@@ -1,60 +1,67 @@
 # @virentia/effector
 
-Effector-shaped compatibility layer powered by `@virentia/core`.
+Compatibility with the real Effector package.
 
-Use this package when existing code already has an Effector-style shape and you want to run it on Virentia primitives.
-
-## Links
-
-- Documentation: [movpushmov.dev/virentia/effector](https://movpushmov.dev/virentia/effector/)
+Use this package when Virentia models need to call Effector units, or existing Effector chains need to call Virentia units. It does not replace Effector.
 
 ## Install
 
 ```sh
-pnpm add @virentia/effector
+pnpm add @virentia/effector effector @virentia/core
 ```
 
-## Counter
+## Basic usage
 
 ```ts
-import { allSettled, createEvent, createStore, fork } from "@virentia/effector";
-
-const incremented = createEvent<number>();
-const $count = createStore(0).on(incremented, (count, amount) => count + amount);
+import { scope, scoped } from "@virentia/core";
+import { createEffectorCompatibility } from "@virentia/effector";
+import { allSettled, fork } from "effector";
 
-const appScope = fork();
+const effector = createEffectorCompatibility();
+const virentiaScope = scope();
+const effectorScope = fork();
 
-await allSettled(incremented, {
-  scope: appScope,
-  params: 2,
+const association = effector.associate({
+  virentia: virentiaScope,
+  effector: effectorScope,
 });
-
-console.log(appScope.getState($count)); // 2
 ```
 
-## Effects
+A Virentia scope and an Effector scope are required. The association is only a disposable link between them.
 
-```ts
-const loadUserFx = createEffect<string, { id: string; name: string }>(async (id) => {
-  const response = await fetch(`/api/users/${id}`);
-  return response.json();
-});
+## Links
 
-const result = await allSettled(loadUserFx, {
-  scope: appScope,
-  params: "user:1",
-});
+```ts
+effector.link(virentiaSubmitted, effectorSubmitted, ({ id }) => id);
+
+await scoped(virentiaScope, () =>
+  allSettled(effectorSubmitted, {
+    scope: effectorScope,
+    params: "user:1",
+  }),
+);
 ```
 
-Effects expose Effector-shaped lifecycle units: `done`, `fail`, `finally`, `doneData`, `failData`, `pending`, and `inFlight`.
+The association is only a lifetime handle. Use `scoped`, Effector `allSettled`, `scopeBind`, or UI Providers to choose scopes.
 
-## Main API
+## Effector sample
+
+```ts
+import { sample } from "effector";
 
-`createEvent`, `createStore`, `createEffect`, `sample`, `combine`, `split`, `createApi`, `restore`, `attach`, `fork`, `allSettled`, `serialize`, `hydrate`, `scopeBind`, `is`.
+sample({
+  clock: effectorUserClicked,
+  source: $session,
+  fn: (session, userId) => ({ userId, token: session.token }),
+  target: effector.asEffector(virentiaUserOpened),
+});
+```
 
-## Notes
+## Tests
 
-The bridge keeps Effector-shaped names around Virentia core primitives. `fork` creates a Virentia scope. `allSettled` uses `params`, while core `allSettled` uses `payload`.
+```sh
+pnpm --filter @virentia/effector test
+```
 
 ## License