@playfast/reform-query-browser 1.0.2 → 1.1.0

package/README.md

@@ -29,8 +29,8 @@ import { BrowserQueryDefaults, localStorageQueryStore } from '@playfast/reform-q
 // In your app layer, alongside Engine:
 const base = Layer.mergeAll(
   Engine,
-  BrowserQueryDefaults,    // refetch on focus + reconnect
-  localStorageQueryStore,  // enables `persist`
+  BrowserQueryDefaults, // refetch on focus + reconnect
+  localStorageQueryStore, // enables `persist`
   /* your state + calc layers */
 )
 
@@ -39,7 +39,7 @@ AsyncCalc.live(Todos, { query, persist: { key: 'todos' } })
 
 // Imperative control anywhere you can run an Effect:
 runtime.runFork(AsyncCalc.invalidate(Todos)) // mark stale (refetches if active)
-runtime.runFork(AsyncCalc.refetch(Todos))    // force a run now
+runtime.runFork(AsyncCalc.refetch(Todos)) // force a run now
 ```
 
 All of `QueryEvents`/`QueryStore` are optional: a calc that uses `persist` with no

package/package.json

@@ -1,36 +1,38 @@
 {
   "name": "@playfast/reform-query-browser",
-  "playbook": "./playbook",
-  "version": "1.0.2",
-  "type": "module",
+  "version": "1.1.0",
   "description": "Browser host layers for Reform's AsyncCalc — window focus/online auto-invalidation and localStorage persistence. Keeps reform core DOM-free: implements the optional QueryEvents and QueryStore seams.",
   "keywords": [
-    "reform",
     "effect",
-    "react-query",
+    "layer",
     "persistence",
+    "react-query",
     "refetch-on-focus",
-    "layer"
+    "reform"
   ],
+  "bugs": {
+    "url": "https://github.com/playfast/reform/issues"
+  },
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/playfast/reform.git",
     "directory": "packages/reform-query-browser"
   },
-  "bugs": {
-    "url": "https://github.com/playfast/reform/issues"
-  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "type": "module",
   "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": "./src/index.ts",
     "./*": "./src/*.ts"
   },
-  "files": [
-    "src",
-    "README.md"
-  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "clean": "rm -rf dist .tsbuildinfo",
     "check": "tsc --noEmit",
@@ -42,10 +44,8 @@
     "lint:fix": "oxlint --fix src"
   },
   "peerDependencies": {
-    "effect": "*",
-    "@playfast/reform": "*"
+    "@playfast/reform": "*",
+    "effect": "*"
   },
-  "publishConfig": {
-    "access": "public"
-  }
+  "playbook": "./playbook"
 }

package/src/localStorage.store.ts

@@ -1,4 +1,4 @@
-import { QueryStore, type QueryStoreApi, noopQueryStore } from '@playfast/reform'
+import { QueryStore, type QueryStoreApi, noopQueryStore } from '@playfast/reform/internal'
 import { Effect, Layer, Option, Schema } from 'effect'
 
 const PREFIX = 'reform-query:'
@@ -8,25 +8,32 @@ const JsonValue = Schema.parseJson(Schema.Unknown)
 const decodeJson = Schema.decodeUnknownOption(JsonValue)
 const encodeJson = Schema.encodeSync(JsonValue)
 
-const makeApi = (): QueryStoreApi => {
-  if (typeof window === 'undefined' || typeof localStorage === 'undefined') {
-    return noopQueryStore
-  }
+const makeApi = (storage: Storage): QueryStoreApi => {
   return {
     get: (key) =>
       Effect.sync(() => {
-        const raw = localStorage.getItem(PREFIX + key)
+        const raw = storage.getItem(PREFIX + key)
         return raw === null ? Option.none() : decodeJson(raw)
       }),
     set: (key, payload) =>
       Effect.sync(() => {
-        localStorage.setItem(PREFIX + key, encodeJson(payload))
+        storage.setItem(PREFIX + key, encodeJson(payload))
       }),
     remove: (key) =>
       Effect.sync(() => {
-        localStorage.removeItem(PREFIX + key)
+        storage.removeItem(PREFIX + key)
       }),
   }
 }
 
-export const localStorageQueryStore: Layer.Layer<QueryStore> = Layer.succeed(QueryStore, makeApi())
+export const makeLocalStorageQueryStore = (storage: Storage): Layer.Layer<QueryStore> =>
+  Layer.succeed(QueryStore, makeApi(storage))
+
+const makeDefaultStore = (): Layer.Layer<QueryStore> => {
+  if (typeof window === 'undefined' || typeof window.localStorage === 'undefined') {
+    return Layer.succeed(QueryStore, noopQueryStore)
+  }
+  return makeLocalStorageQueryStore(window.localStorage)
+}
+
+export const localStorageQueryStore: Layer.Layer<QueryStore> = Layer.suspend(makeDefaultStore)

package/src/queryEvents.browser.ts

@@ -1,4 +1,4 @@
-import { QueryEvents, type QueryEventsApi, noopQueryEvents } from '@playfast/reform'
+import { QueryEvents, type QueryEventsApi, noopQueryEvents } from '@playfast/reform/internal'
 import { Effect, Layer } from 'effect'
 
 export const QueryEventsBrowser: Layer.Layer<QueryEvents> = Layer.scoped(

package/src/refetchManagers.ts

@@ -1,4 +1,4 @@
-import { QueryEvents, type QueryEventsApi, Queries } from '@playfast/reform'
+import { QueryEvents, type QueryEventsApi, Queries } from '@playfast/reform/internal'
 import { Effect, Layer } from 'effect'
 import { QueryEventsBrowser } from './queryEvents.browser'
 

package/src/reform-query-browser.test.ts

@@ -4,7 +4,8 @@
 import { expect, it } from '@effect/vitest'
 import { AsyncCalc, Engine, State, StateGroup } from '@playfast/reform'
 import { Duration, Effect, Layer, Schema as S } from 'effect'
-import { localStorageQueryStore } from './localStorage.store'
+import { Window } from 'happy-dom'
+import { makeLocalStorageQueryStore } from './localStorage.store'
 import { QueryEventsBrowser } from './queryEvents.browser'
 import { RefetchOnFocus } from './refetchManagers'
 
@@ -49,7 +50,9 @@ it.live('window focus invalidates a live query, so an active reader refetches',
 })
 
 it.live('persist hydrates from localStorage (stale) then writes the settled value through', () => {
-  localStorage.setItem('reform-query:P', '99') // a previously-persisted value
+  const storageWindow = new Window({ url: 'https://reform-query.test/' })
+  const storage = storageWindow.localStorage
+  storage.setItem('reform-query:P', '99') // a previously-persisted value
   class Count extends State.make('count', S.Number) {}
   class Inputs extends StateGroup.make(Count) {}
   class Q extends AsyncCalc.make('Q', {
@@ -63,7 +66,7 @@ it.live('persist hydrates from localStorage (stale) then writes the settled valu
   })
   const App = QLive.pipe(
     Layer.provideMerge(StateGroup.live(Inputs, { count: 5 })),
-    Layer.provideMerge(localStorageQueryStore),
+    Layer.provideMerge(makeLocalStorageQueryStore(storage)),
     Layer.provideMerge(Engine),
   )
 
@@ -71,8 +74,8 @@ it.live('persist hydrates from localStorage (stale) then writes the settled valu
     const view = yield* Q.store
     expect(view.get()).toMatchObject({ _tag: 'Success', value: 99, refetching: true })
 
-    yield* waitUntil(() => localStorage.getItem('reform-query:P') === '10')
+    yield* waitUntil(() => storage.getItem('reform-query:P') === '10')
     expect(view.get()).toMatchObject({ _tag: 'Success', value: 10, refetching: false })
-    expect(localStorage.getItem('reform-query:P')).toBe('10')
-  }).pipe(Effect.provide(App))
+    expect(storage.getItem('reform-query:P')).toBe('10')
+  }).pipe(Effect.provide(App), Effect.ensuring(Effect.sync(() => storageWindow.close())))
 })