Feat/add Atom.persistedSwr for persisted stale-while-revalidate

[rodygosset]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Adds Atom.persistedSwr, combining Atom.kvs persistence with Atom.swr for AsyncResult atoms.
Prefers a valid in-registry value over fresh persisted cache (SSR/hydration), syncs newer successes to the store immediately, and skips stale revalidation when live data is already shown.
Makes the wrapped atom serializable when needed.

Example:

import { Effect, Schema } from "effect"
import { KeyValueStore } from "effect/unstable/persistence"
import { AtomRegistry, AsyncResult, Atom } from "effect/unstable/reactivity"
import { Todo } from "@/features/todos/schemas"
import { ApiError } from "@/lib/api/definitions"

const runtime = Atom.runtime(BrowserKeyValueStore.layerLocalStorage)

class ApiClient extends AtomHttpApi.Service<ApiClient>()("ApiClient", { ... }) {}

const schema = AsyncResult.Schema({ success: Schema.Array(Todo), error: ApiError })

const todosAtom = ApiClient.query("todos", "getAll", {}).pipe(
  Atom.persistedSwr({
    key: "todos-getAll-cache",
    runtime,
    schema,
    staleTime: "1 minute",
    revalidateOnMount: false,
  })
)

// Force a network refetch:
// registry.refresh(todos)

[changeset-bot]

🦋 Changeset detected

Latest commit: af03b01

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 27 packages

Name	Type
effect	Major
@effect/opentelemetry	Major
@effect/platform-browser	Major
@effect/platform-bun	Major
@effect/platform-node-shared	Major
@effect/platform-node	Major
@effect/vitest	Major
@effect/ai-anthropic	Major
@effect/ai-openai-compat	Major
@effect/ai-openai	Major
@effect/ai-openrouter	Major
@effect/atom-react	Major
@effect/atom-solid	Major
@effect/atom-vue	Major
@effect/sql-clickhouse	Major
@effect/sql-d1	Major
@effect/sql-libsql	Major
@effect/sql-mssql	Major
@effect/sql-mysql2	Major
@effect/sql-pg	Major
@effect/sql-pglite	Major
@effect/sql-sqlite-bun	Major
@effect/sql-sqlite-do	Major
@effect/sql-sqlite-node	Major
@effect/sql-sqlite-react-native	Major
@effect/sql-sqlite-wasm	Major
@effect/openapi-generator	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR