effect-atom-svelte 0.1.0 → 0.1.1

package/README.md

@@ -1,16 +1,16 @@
 # effect-atom-svelte
 
-Svelte 5 bindings for Effect Atom (`effect/reactivity`), following the API of `@effect/atom-react`: hooks with a reactive `current`, async atoms you can `await` in markup, and server rendering with hydration.
+Svelte 5 bindings for Effect Atom (`effect/reactivity`): hooks with a reactive `current`, async atoms you can `await` in markup, and server rendering with hydration. The API follows `@effect/atom-react`.
 
-This is a community project by Jarred Norris. It is not part of Effect, and the Effect team neither makes nor endorses it. Most of its code and docs were written with the help of AI (Claude); its behavior is covered by tests in Chromium, Firefox and WebKit.
+This is a community project by Jarred Norris. It is not part of Effect, and the Effect team neither makes nor endorses it. Most of its code and docs were written with the help of AI (Claude Opus 5.5); its behavior is covered by tests in Chromium, Firefox and WebKit.
 
-**Documentation: [atom.jarrednorris.dev](https://atom.jarrednorris.dev)**
+**Documentation: [atom.jarrednorris.dev](https://atom.jarrednorris.dev)** · [API reference](https://atom.jarrednorris.dev/reference) · [GitHub](https://github.com/jarrednorrisdev/effect-atom-svelte)
 
 ## Requirements
 
-- `effect` 4.0.x. The peer range is `~4.0.0`, not `^4.0.0`, as the bindings use parts of the atom registry that aren't public API, which a minor release of `effect` can change.
-- Svelte 5.57 or later, with `experimental.async` turned on for the async hooks and server rendering.
-- SvelteKit is optional. The error hooks in `effect-atom-svelte/sveltekit` are made for SvelteKit 3 and work with less detail on SvelteKit 2.
+- `effect` 4.0.x. The peer range is `~4.0.0`, not `^4.0.0`: the bindings use parts of the atom registry that aren't public API, which a minor release of `effect` can change.
+- Svelte 5.57.2 or later. `experimental.async` is needed for `useAtomSuspense`, `useAtomResult` and server rendering.
+- SvelteKit is optional. The docs site and its tests run on SvelteKit 3. On SvelteKit 2, the error hooks in `effect-atom-svelte/sveltekit` work with less detail.
 
 ## Installation
 
@@ -21,6 +21,7 @@ npm install effect-atom-svelte "effect@~4.0.0"
 Turn on Svelte's async mode. In SvelteKit 3, pass it to `sveltekit()` in `vite.config.ts`:
 
 ```ts
+// vite.config.ts
 sveltekit({
   compilerOptions: { experimental: { async: true } },
 });
@@ -39,7 +40,7 @@ Then put a registry around your app, in the root layout:
 <RegistryProvider>{@render children()}</RegistryProvider>
 ```
 
-On the server, the provider creates a registry for each request, so visitors never see each other's state. See [Installation](https://atom.jarrednorris.dev/installation) for the options and for apps without SvelteKit.
+On the server, the provider creates a registry for each request, so visitors never see each other's state. Without one, the server throws `No AtomRegistry in context`. [Installation](https://atom.jarrednorris.dev/installation) covers the registry options and apps without SvelteKit.
 
 ## Example
 
@@ -72,7 +73,7 @@ On the server, the provider creates a registry for each request, so visitors nev
 </svelte:boundary>
 ```
 
-Hooks return an object whose `current` you read, assign or `bind:` to; destructuring it reads the value once and loses reactivity. Coming from React? See [Migrating from React](https://atom.jarrednorris.dev/migrating-from-react).
+Hooks return an object whose `current` you read, assign or `bind:` to. Don't destructure `current`: `const { current } = useAtomValue(atom)` reads once and never updates. Coming from `@effect/atom-react`? See [Migrating from atom-react](https://atom.jarrednorris.dev/migrating-from-react).
 
 ## Learn more
 
@@ -80,6 +81,7 @@ Hooks return an object whose `current` you read, assign or `bind:` to; destructu
 - [Server rendering](https://atom.jarrednorris.dev/server-rendering) and [Hydration](https://atom.jarrednorris.dev/hydration)
 - [Effect RPC](https://atom.jarrednorris.dev/rpc) and [HttpApi](https://atom.jarrednorris.dev/http)
 - [API reference](https://atom.jarrednorris.dev/reference) and [Troubleshooting](https://atom.jarrednorris.dev/troubleshooting)
+- [Every export at a glance, and more recipes](https://github.com/jarrednorrisdev/effect-atom-svelte#api-at-a-glance), in the repository's README
 
 ## Versioning
 
@@ -87,4 +89,4 @@ The package is at 0.x, so a minor release can change the API. Every change is li
 
 ## License
 
-MIT
+[MIT](https://github.com/jarrednorrisdev/effect-atom-svelte/blob/main/LICENSE)

package/dist/Hooks.svelte.js

@@ -176,8 +176,9 @@ const subscribedReader = (registry, getAtom) => {
     // render, which already has the value, so it is dropped. Delivered on a microtask it started a
     // Svelte batch that, when the first render ran after an await in markup (a HydrationBoundary
     // awaiting its state), committed before hydration's own and made Svelte's dev build throw "Batch
-    // has scheduled effects" (JND-95). After mount it is still delivered, as before: dropping it there
-    // too made a getter switched in onMount compute the server's atom again (JND-24).
+    // has scheduled effects" (JND-95). After mount it is still delivered, as before. Nothing depends
+    // on the update it starts: a getter switched in onMount once did, by accident, as that update
+    // rendered before the registry swept the old atom (JND-98, fixed in the effect below).
     let reading;
     const listen = (current, update) => registry.subscribe(current, () => {
         if (mounted || reading !== current) {
@@ -202,11 +203,20 @@ const subscribedReader = (registry, getAtom) => {
         // the subscription may follow an atom the commit did not pick. It moves to the committed atom,
         // or that atom's later changes, a refresh's result or failure included, would not reach the
         // page (JND-93).
+        // The atom it leaves is kept, not released: this effect can run before the switch it reads has
+        // committed. A getter switched in onMount is read here in the same flush, while Svelte's batch
+        // for the switch is still pending, and the renders with that batch rolled back read the old
+        // atom. Released here, the registry could sweep it before they do, and they would compute it
+        // again (JND-98). A later run that commits another atom releases it.
         if (atom !== undefined && atom !== committed) {
+            const previous = atom;
             const previousCancel = cancel;
             atom = committed;
             cancel = follow(committed);
-            previousCancel?.();
+            if (previousCancel) {
+                releaseKept();
+                kept = { atom: previous, cancel: previousCancel };
+            }
         }
     });
     const subscribe = createSubscriber((update) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "effect-atom-svelte",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Community-built Svelte 5 bindings for Effect Atom (not affiliated with the Effect team)",
   "keywords": [
     "effect",
@@ -53,9 +53,9 @@
     "@sveltejs/vite-plugin-svelte": "^7.2.0",
     "@vitest/browser": "^5.0.3",
     "@vitest/browser-playwright": "^5.0.3",
-    "effect": "4.0.0",
+    "effect": "4.0.1",
     "playwright": "^1.57.0",
-    "svelte": "^5.57.1",
+    "svelte": "^5.57.2",
     "svelte-check": "^4.6.0",
     "vite": "^8.3.0",
     "vitest": "^5.0.3",
@@ -64,7 +64,7 @@
   "peerDependencies": {
     "@sveltejs/kit": "^2.0.0 || ^3.0.0",
     "effect": "~4.0.0",
-    "svelte": "^5.57.0"
+    "svelte": "^5.57.2"
   },
   "peerDependenciesMeta": {
     "@sveltejs/kit": {