@spooky-sync/client-solid 0.0.1-canary.16 → 0.0.1-canary.160

package/src/lib/create-preload.ts

@@ -0,0 +1,111 @@
+import type {
+  ColumnSchema,
+  FinalQuery,
+  SchemaStructure,
+  TableNames,
+} from '@spooky-sync/query-builder';
+import { createEffect, useContext } from 'solid-js';
+import { SyncedDb } from '..';
+import type { Sp00kyQueryResultPromise, PreloadOptions as CorePreloadOptions } from '@spooky-sync/core';
+import { Sp00kyContext } from './context';
+
+type PreloadArg<
+  S extends SchemaStructure,
+  TableName extends TableNames<S>,
+  T extends { columns: Record<string, ColumnSchema> },
+  RelatedFields extends Record<string, any>,
+  IsOne extends boolean,
+> =
+  | FinalQuery<S, TableName, T, RelatedFields, IsOne, Sp00kyQueryResultPromise>
+  | (() =>
+      | FinalQuery<S, TableName, T, RelatedFields, IsOne, Sp00kyQueryResultPromise>
+      | null
+      | undefined);
+
+type PreloadOptions = CorePreloadOptions & {
+  /** Only preload while this returns true (defaults to always). */
+  enabled?: () => boolean;
+};
+
+// Overload: context-based (no explicit db)
+export function createPreload<
+  S extends SchemaStructure,
+  TableName extends TableNames<S>,
+  T extends { columns: Record<string, ColumnSchema> },
+  RelatedFields extends Record<string, any>,
+  IsOne extends boolean,
+>(
+  finalQuery: PreloadArg<S, TableName, T, RelatedFields, IsOne>,
+  options?: PreloadOptions,
+): void;
+
+// Overload: explicit db
+export function createPreload<
+  S extends SchemaStructure,
+  TableName extends TableNames<S>,
+  T extends { columns: Record<string, ColumnSchema> },
+  RelatedFields extends Record<string, any>,
+  IsOne extends boolean,
+>(
+  db: SyncedDb<S>,
+  finalQuery: PreloadArg<S, TableName, T, RelatedFields, IsOne>,
+  options?: PreloadOptions,
+): void;
+
+/**
+ * Reactive, fire-and-forget prewarm. Resolves the query (calling it if it's a
+ * function so it tracks reactive deps), dedupes on the query's stable identity
+ * hash, and warms it into the local cache via `db.preload`. No subscription and
+ * no cleanup: preload registers nothing that needs tearing down.
+ *
+ * Typical use: inside a list row, preload the detail query the user is likely
+ * to open next, so navigation paints from cache instead of the network.
+ */
+export function createPreload<
+  S extends SchemaStructure,
+  TableName extends TableNames<S>,
+  T extends { columns: Record<string, ColumnSchema> },
+  RelatedFields extends Record<string, any>,
+  IsOne extends boolean,
+>(
+  dbOrQuery: SyncedDb<S> | PreloadArg<S, TableName, T, RelatedFields, IsOne>,
+  queryOrOptions?: PreloadArg<S, TableName, T, RelatedFields, IsOne> | PreloadOptions,
+  maybeOptions?: PreloadOptions,
+): void {
+  let db: SyncedDb<S>;
+  let finalQuery: PreloadArg<S, TableName, T, RelatedFields, IsOne>;
+  let options: PreloadOptions | undefined;
+
+  if (dbOrQuery instanceof SyncedDb) {
+    db = dbOrQuery;
+    finalQuery = queryOrOptions as PreloadArg<S, TableName, T, RelatedFields, IsOne>;
+    options = maybeOptions;
+  } else {
+    const contextDb = useContext(Sp00kyContext);
+    if (!contextDb) {
+      throw new Error(
+        'createPreload: No db argument provided and no Sp00kyContext found. ' +
+          'Either pass a SyncedDb instance or wrap your app in <Sp00kyProvider>.',
+      );
+    }
+    db = contextDb as SyncedDb<S>;
+    finalQuery = dbOrQuery;
+    options = queryOrOptions as PreloadOptions | undefined;
+  }
+
+  let prevHash: number | undefined;
+
+  createEffect(() => {
+    if (!(options?.enabled?.() ?? true)) return;
+
+    const query = typeof finalQuery === 'function' ? finalQuery() : finalQuery;
+    if (!query) return;
+
+    // Dedupe on the query's stable identity hash so a reactive re-run with an
+    // unchanged query doesn't refetch (the core also dedupes per session).
+    if (query.hash === prevHash) return;
+    prevHash = query.hash;
+
+    void db.getSp00ky().preload(query, { refresh: options?.refresh, staleTime: options?.staleTime });
+  });
+}

package/src/lib/models.ts

@@ -1,4 +1,4 @@
-import { RecordId } from 'surrealdb';
+import type { RecordId } from 'surrealdb';
 
 // Re-export types from query-builder for backward compatibility
 export type { GenericModel, GenericSchema } from '@spooky/query-builder';

package/src/lib/use-app-release.ts

@@ -0,0 +1,89 @@
+import { createSignal, onCleanup, type Accessor } from 'solid-js';
+import { useDb } from './context';
+import { semverGt, type AppReleaseOptions, type AppReleaseSnapshot } from '@spooky-sync/core';
+
+export interface UseAppReleaseOptions extends AppReleaseOptions {
+  /** App name from sp00ky.yml, e.g. `web`. */
+  app: string;
+  /**
+   * The running build's version (X.Y.Z), typically baked in at build time
+   * (e.g. a vite `define` from package.json). `updateAvailable()` is true when
+   * the announced release is semver-newer than this.
+   */
+  currentVersion: string;
+}
+
+export interface UseAppRelease {
+  /** Latest announced version for the app, or undefined when no row exists. */
+  latestVersion: Accessor<string | undefined>;
+  /** Announced version is semver-newer than the running build. */
+  updateAvailable: Accessor<boolean>;
+  /** The newer release asks clients to update/reload without prompting. */
+  mandatory: Accessor<boolean>;
+  /** The newer release asks reloads to clear service-worker caches first. */
+  cacheBust: Accessor<boolean>;
+  /**
+   * Reload onto the announced release. Plain `location.reload()` normally;
+   * when the release is flagged cache-bust, CacheStorage is cleared, the
+   * service-worker registration is nudged to update, and navigation carries a
+   * `?cb=` token to punch through intermediary caches. The service worker is
+   * deliberately NOT unregistered: navigating while still controlled by a
+   * just-unregistered worker strands subresource fetches on the dead worker
+   * and the page hangs until a manual reload.
+   */
+  reload: () => Promise<void>;
+}
+
+async function reloadForSnapshot(snapshot: AppReleaseSnapshot): Promise<void> {
+  if (typeof window === 'undefined') return;
+  if (snapshot.cacheBust) {
+    try {
+      if (window.caches) {
+        const keys = await window.caches.keys();
+        await Promise.all(keys.map((k) => window.caches.delete(k)));
+      }
+      if (navigator.serviceWorker) {
+        const regs = await navigator.serviceWorker.getRegistrations();
+        for (const r of regs) r.update().catch(() => {});
+      }
+      window.location.href = window.location.pathname + '?cb=' + Date.now();
+      return;
+    } catch {
+      /* fall through to a plain reload */
+    }
+  }
+  window.location.reload();
+}
+
+/**
+ * Observe the app's announced release (`_00_app_release:<app>`, written by
+ * `spky deploy` / `spky release`) and compare it against the running build.
+ *
+ * Typical use: mount a small "new version available — Reload" notification
+ * gated on `updateAvailable()`, auto-invoking `reload()` when `mandatory()`
+ * (guard the auto path against reload loops with a per-version marker, since
+ * a client can reload while the deploy is still rolling out and land on the
+ * old bundle again).
+ */
+export function useAppRelease(options: UseAppReleaseOptions): UseAppRelease {
+  const db = useDb();
+  const handle = db.getSp00ky().appRelease(options.app, { ttl: options.ttl });
+
+  const [snapshot, setSnapshot] = createSignal<AppReleaseSnapshot>(handle.snapshot());
+  const unsub = handle.subscribe(setSnapshot);
+
+  onCleanup(() => {
+    unsub();
+    handle.close();
+  });
+
+  const updateAvailable = () => semverGt(snapshot().version, options.currentVersion);
+
+  return {
+    latestVersion: () => snapshot().version,
+    updateAvailable,
+    mandatory: () => updateAvailable() && snapshot().mandatory,
+    cacheBust: () => snapshot().cacheBust,
+    reload: () => reloadForSnapshot(snapshot()),
+  };
+}

package/src/lib/use-crdt-field.ts

@@ -0,0 +1,68 @@
+import { createEffect, createSignal, onCleanup, useContext, type Accessor } from 'solid-js';
+import { Sp00kyContext } from './context';
+import type { CrdtField } from '@spooky-sync/core';
+
+export function useCrdtField(
+  table: string,
+  recordId: () => string | undefined,
+  field: string,
+  fallbackText?: () => string | undefined,
+): Accessor<CrdtField | null> {
+  const db = useContext(Sp00kyContext);
+  if (!db) {
+    throw new Error('useCrdtField must be used within a <Sp00kyProvider>');
+  }
+
+  const [crdtField, setCrdtField] = createSignal<CrdtField | null>(null);
+  let currentId: string | undefined;
+  let initialized = false;
+
+  createEffect(() => {
+    const id = recordId();
+
+    // Skip if the ID hasn't changed (but allow the first non-undefined value through)
+    if (initialized && id === currentId) return;
+
+    // Close previous field
+    if (currentId && crdtField()) {
+      db.getSp00ky().closeCrdtField(table, currentId, field);
+      setCrdtField(null);
+    }
+
+    currentId = id;
+    initialized = true;
+
+    if (!id) return;
+
+    const sp00ky = db.getSp00ky();
+    const text = fallbackText?.();
+    sp00ky
+      .openCrdtField(table, id, field, text)
+      .then((cf) => {
+        if (currentId === id) {
+          setCrdtField(cf);
+        }
+      })
+      .catch((err) => {
+        // Silent rejections here leave the consumer's `Show when={field()}`
+        // permanently stuck on its fallback (typically a static `<p>` with
+        // no editing UI), with no error trail. Surface the failure so the
+        // root cause (missing `@crdt` annotation, schema codegen drift,
+        // local DB query failure, etc.) is visible in the console instead
+        // of silently breaking collaborative fields.
+        console.error(
+          `[useCrdtField] Failed to open CRDT field ${table}.${field} on ${id}:`,
+          err,
+        );
+      });
+  });
+
+  onCleanup(() => {
+    if (currentId && crdtField()) {
+      db.getSp00ky().closeCrdtField(table, currentId, field);
+      setCrdtField(null);
+    }
+  });
+
+  return crdtField;
+}

package/src/lib/use-download-file.ts

@@ -78,9 +78,8 @@ export function useDownloadFile<S extends SchemaStructure>(
 
   let currentKey: string | null = null;
   let privateUrl: string | null = null;
-  let refetchTrigger: () => void;
   const [refetchSignal, setRefetchSignal] = createSignal(0);
-  refetchTrigger = () => setRefetchSignal((n) => n + 1);
+  const refetchTrigger = () => setRefetchSignal((n) => n + 1);
 
   async function doDownload(key: string, filePath: string): Promise<string | null> {
     if (useCache) {
@@ -184,6 +183,7 @@ export function useDownloadFile<S extends SchemaStructure>(
           setUrl(result);
           setIsLoading(false);
         }
+        return undefined;
       },
       (err) => {
         if (!cancelled) {

package/src/lib/use-feature-flag.ts

@@ -0,0 +1,50 @@
+import { createSignal, onCleanup, type Accessor } from 'solid-js';
+import { useDb } from './context';
+import type { FeatureFlagOptions } from '@spooky-sync/core';
+
+export interface UseFeatureFlag {
+  variant: Accessor<string | undefined>;
+  payload: Accessor<unknown | undefined>;
+  enabled: Accessor<boolean>;
+}
+
+/**
+ * Subscribe to a feature flag for the currently authenticated user.
+ *
+ * Returns three Solid accessors that update reactively whenever the
+ * server-materialized assignment in `_00_user_feature` changes. Backed by
+ * the same SSP + sync pipeline that powers `useQuery`, so toggling a flag
+ * via `spky flag enable <key>` propagates to the UI without a refresh.
+ *
+ * `enabled()` is `true` when the resolved variant exists and is not 'off'.
+ * For multi-variant flags, prefer `variant()` directly.
+ */
+export function useFeatureFlag(
+  key: string,
+  options?: FeatureFlagOptions,
+): UseFeatureFlag {
+  const db = useDb();
+  const handle = db.getSp00ky().feature(key, options);
+
+  const [variant, setVariant] = createSignal<string | undefined>(handle.variant());
+  const [payload, setPayload] = createSignal<unknown | undefined>(handle.payload());
+
+  const unsub = handle.subscribe((s) => {
+    setVariant(s.variant ?? options?.fallback);
+    setPayload(s.payload);
+  });
+
+  onCleanup(() => {
+    unsub();
+    handle.close();
+  });
+
+  return {
+    variant,
+    payload,
+    enabled: () => {
+      const v = variant();
+      return v !== undefined && v !== 'off';
+    },
+  };
+}

package/src/lib/use-file-upload.ts

@@ -33,6 +33,7 @@ export function useFileUpload<S extends SchemaStructure>(
     bucketName = dbOrBucketName as BucketNames<S>;
   } else {
     db = dbOrBucketName as SyncedDb<S>;
+    // oxlint-disable-next-line no-non-null-assertion
     bucketName = maybeBucketName!;
   }
 
@@ -52,7 +53,7 @@ export function useFileUpload<S extends SchemaStructure>(
     const config = db.getBucketConfig(bucketName as string);
     if (!config) return;
 
-    if (config.maxSize != null && file.size > config.maxSize) {
+    if (config.maxSize !== null && config.maxSize !== undefined && file.size > config.maxSize) {
       const maxMB = (config.maxSize / (1024 * 1024)).toFixed(1);
       throw new Error(`File exceeds maximum size of ${maxMB} MB.`);
     }

package/src/lib/use-query.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   ColumnSchema,
   FinalQuery,
   SchemaStructure,
@@ -6,9 +6,10 @@ import {
   QueryResult,
 } from '@spooky-sync/query-builder';
 import { createEffect, createSignal, onCleanup, useContext } from 'solid-js';
+import { createStore, reconcile } from 'solid-js/store';
 import { SyncedDb } from '..';
-import { SpookyQueryResultPromise } from '@spooky-sync/core';
-import { SpookyContext } from './context';
+import type { Sp00kyQueryResultPromise } from '@spooky-sync/core';
+import { Sp00kyContext } from './context';
 
 type QueryArg<
   S extends SchemaStructure,
@@ -17,13 +18,23 @@ type QueryArg<
   RelatedFields extends Record<string, any>,
   IsOne extends boolean,
 > =
-  | FinalQuery<S, TableName, T, RelatedFields, IsOne, SpookyQueryResultPromise>
+  | FinalQuery<S, TableName, T, RelatedFields, IsOne, Sp00kyQueryResultPromise>
   | (() =>
-      | FinalQuery<S, TableName, T, RelatedFields, IsOne, SpookyQueryResultPromise>
+      | FinalQuery<S, TableName, T, RelatedFields, IsOne, Sp00kyQueryResultPromise>
       | null
       | undefined);
 
-type QueryOptions = { enabled?: () => boolean };
+type QueryOptions = {
+  enabled?: () => boolean;
+  /**
+   * Tear down the query (remote `_00_query` view + local WASM view) when this
+   * hook is disposed and no other subscriber remains, instead of keeping it
+   * resident for cheap re-subscription. Use for viewport-windowed lists that
+   * mount/unmount a query per scroll window and want off-screen windows
+   * cancelled. Trade-off: scrolling back to a torn-down window re-registers it.
+   */
+  deregisterOnCleanup?: boolean;
+};
 
 // Overload: context-based (no explicit db)
 export function useQuery<
@@ -36,7 +47,13 @@ export function useQuery<
 >(
   finalQuery: QueryArg<S, TableName, T, RelatedFields, IsOne>,
   options?: QueryOptions,
-): { data: () => TData | undefined; error: () => Error | undefined; isLoading: () => boolean };
+): {
+  data: () => TData | undefined;
+  error: () => Error | undefined;
+  isLoading: () => boolean;
+  isFetching: () => boolean;
+  isSettled: () => boolean;
+};
 
 // Overload: explicit db (backward-compatible)
 export function useQuery<
@@ -50,7 +67,13 @@ export function useQuery<
   db: SyncedDb<S>,
   finalQuery: QueryArg<S, TableName, T, RelatedFields, IsOne>,
   options?: QueryOptions,
-): { data: () => TData | undefined; error: () => Error | undefined; isLoading: () => boolean };
+): {
+  data: () => TData | undefined;
+  error: () => Error | undefined;
+  isLoading: () => boolean;
+  isFetching: () => boolean;
+  isSettled: () => boolean;
+};
 
 // Implementation
 export function useQuery<
@@ -82,11 +105,11 @@ export function useQuery<
     options = maybeOptions;
   } else {
     // Context-based overload: useQuery(query, options?)
-    const contextDb = useContext(SpookyContext);
+    const contextDb = useContext(Sp00kyContext);
     if (!contextDb) {
       throw new Error(
-        'useQuery: No db argument provided and no SpookyContext found. ' +
-        'Either pass a SyncedDb instance or wrap your app in <SpookyProvider>.'
+        'useQuery: No db argument provided and no Sp00kyContext found. ' +
+        'Either pass a SyncedDb instance or wrap your app in <Sp00kyProvider>.'
       );
     }
     db = contextDb as SyncedDb<S>;
@@ -94,29 +117,76 @@ export function useQuery<
     options = queryOrOptions as QueryOptions | undefined;
   }
 
-  const [data, setData] = createSignal<TData | undefined>(undefined);
   const [error, setError] = createSignal<Error | undefined>(undefined);
   const [isFetched, setIsFetched] = createSignal(false);
-  const [unsubscribe, setUnsubscribe] = createSignal<(() => void) | undefined>(undefined);
+  const [isFetching, setIsFetching] = createSignal(false);
+  // Results live in a store (not a signal) so consecutive live-query emissions
+  // are merged with `reconcile`: unchanged rows keep their object identity and
+  // changed rows are mutated in place. That keeps Solid's reference-keyed `<For>`
+  // rows — and any `useQuery` subscriptions mounted inside them — alive across
+  // updates, instead of tearing every row down and re-registering its queries.
+  const [state, setState] = createStore<{ value: TData | undefined }>({ value: undefined });
+  // `reconcile` (below) merges each emission into `state.value` IN PLACE, keeping
+  // the array reference stable. That's ideal for granular per-row reactivity, but
+  // it means a *coarse* reader of `data()` — `<For each={data()}>`, or an effect
+  // that copies the whole array elsewhere (e.g. GameList's windowed store) — is
+  // NOT re-run when rows are added/removed/reordered within a same-length result
+  // (the classic case: deleting a row in a windowed list shifts the next one in,
+  // so length stays 50 and the array ref never changes). Bump a version on every
+  // emission and read it in `data()` so every consumer re-runs on any change while
+  // reconcile still preserves row identity underneath.
+  const [version, setVersion] = createSignal(0);
+  const data = () => {
+    version();
+    return state.value;
+  };
+
   let prevQueryString: string | undefined;
+  // Monotonic token for each subscription generation. Bumped whenever the query
+  // identity changes or the hook is disposed, so a slow async `initQuery`
+  // continuation can detect it was superseded and avoid installing a stale (and
+  // leaked) subscription.
+  let runId = 0;
+  let activeUnsub: (() => void) | undefined;
+  // The hash of the currently-installed subscription, for opt-in deregister on
+  // dispose (see `deregisterOnCleanup`).
+  let activeHash: string | undefined;
+
+  const teardownActive = () => {
+    activeUnsub?.();
+    activeUnsub = undefined;
+  };
 
-  const spooky = db.getSpooky();
+  const sp00ky = db.getSp00ky();
 
   const initQuery = async (
-    query: FinalQuery<S, TableName, T, RelatedFields, IsOne, SpookyQueryResultPromise>
+    query: FinalQuery<S, TableName, T, RelatedFields, IsOne, Sp00kyQueryResultPromise>,
+    myRun: number
   ) => {
     const { hash } = await query.run();
+    // A newer query identity (or disposal) won the race while we awaited run().
+    if (myRun !== runId) return;
+    activeHash = hash;
     setError(undefined);
 
     let isFirstCall = true;
-    const unsub = await spooky.subscribe(
+    const unsub = await sp00ky.subscribe(
       hash,
       (e) => {
-        const data = (query.isOne ? e[0] : e) as TData;
-        setData(() => data);
+        const queryData = (query.isOne ? e[0] : e) as TData;
+        // Merge into the store by record id: unchanged rows keep their identity,
+        // changed rows update in place. Replaces wholesale for `one()`/null.
+        // Time the reconcile → report as the "frontend" phase for DevTools/MCP.
+        const reconcileStart = performance.now();
+        setState('value', reconcile(queryData as any, { key: 'id' }));
+        // Notify coarse `data()` readers (see the `version` note above): reconcile
+        // keeps the array ref stable, so this is what re-runs `<For>`/copy-effects
+        // on add/remove/reorder.
+        setVersion((v) => v + 1);
+        sp00ky.reportFrontendTiming(hash, performance.now() - reconcileStart);
         // The first (immediate) callback with no data likely means the local DB
         // hasn't synced yet — don't mark as fetched so UI shows loading state
-        const hasData = query.isOne ? data != null : (e as any[]).length > 0;
+        const hasData = query.isOne ? queryData !== null && queryData !== undefined : (e as any[]).length > 0;
         if (!isFirstCall || hasData) {
           setIsFetched(true);
         }
@@ -125,7 +195,25 @@ export function useQuery<
       { immediate: true }
     );
 
-    setUnsubscribe(() => unsub);
+    // Mirror the query's fetch status so the UI can show a "loading more"
+    // state while the sync engine pulls missing records in the background.
+    const unsubStatus = sp00ky.subscribeQueryStatus(
+      hash,
+      (status) => setIsFetching(status === 'fetching'),
+      { immediate: true }
+    );
+
+    const teardown = () => {
+      unsub();
+      unsubStatus();
+    };
+
+    // Superseded while awaiting subscribe()? Don't leak — tear down immediately.
+    if (myRun !== runId) {
+      teardown();
+      return;
+    }
+    activeUnsub = teardown;
   };
 
   createEffect(() => {
@@ -143,30 +231,57 @@ export function useQuery<
       return;
     }
 
-    // Prevent re-running if query hasn't changed
-    const queryString = JSON.stringify(query);
+    // Dedup on the query's stable identity hash (cyrb53 of surql + vars), not a
+    // full `JSON.stringify` of the FinalQuery (which walks the whole schema +
+    // inner query on every reactive tick and isn't guaranteed stable). When the
+    // identity is unchanged we keep the existing subscription alive.
+    const queryString = String(query.hash);
     if (queryString === prevQueryString) {
       return;
     }
     prevQueryString = queryString;
 
-    // Reset fetched state when query changes
+    // New query identity → supersede the previous subscription and start fresh.
+    const myRun = ++runId;
+    teardownActive();
     setIsFetched(false);
-    initQuery(query);
+    initQuery(query, myRun);
+  });
 
-    // Cleanup
-    onCleanup(() => {
-      unsubscribe()?.();
-    });
+  // Tear down the live subscription when the hook's owner is disposed. Registered
+  // on the hook (component) scope rather than inside the effect, so an effect
+  // re-run that early-returns (unchanged query) doesn't clean up the still-valid
+  // subscription. Bumping runId also invalidates any in-flight initQuery.
+  onCleanup(() => {
+    runId++;
+    teardownActive();
+    // Opt-in: cancel the query once this hook (its last subscriber) is gone.
+    // teardownActive() above already removed this hook's callback, so
+    // deregisterQuery's refcount guard sees the true remaining-subscriber count.
+    if (options?.deregisterOnCleanup && activeHash) {
+      sp00ky.deregisterQuery(activeHash);
+    }
   });
 
   const isLoading = () => {
     return !isFetched() && error() === undefined;
   };
 
+  // True once the query has delivered a result AND no fetch cycle is in flight
+  // (registration + initial sync included — the core holds `fetching` across
+  // the whole registration and flushes debounced results before flipping back
+  // to idle). While settled, the results are authoritative: a windowed query
+  // returning fewer rows than its LIMIT really is the end of the list, so
+  // virtualized lists may size themselves to it without the scrollbar jumping
+  // when a still-syncing window transiently reports short. Resets to false
+  // whenever the query identity changes.
+  const isSettled = () => isFetched() && !isFetching();
+
   return {
     data,
     error,
     isLoading,
+    isFetching,
+    isSettled,
   };
 }

package/src/lib/use-storage-status.ts

@@ -0,0 +1,44 @@
+import { createSignal, onCleanup, type Accessor } from 'solid-js';
+import { useDb } from './context';
+import type { StorageHealth, StorageHealthStatus } from '@spooky-sync/core';
+
+export interface UseStorageStatus {
+  /** Full durability snapshot; updates reactively. */
+  health: Accessor<StorageHealth>;
+  /** `'unknown'` | `'persistent'` | `'memory'`. */
+  status: Accessor<StorageHealthStatus>;
+  /** `true` when the local store survives a reload. */
+  isPersistent: Accessor<boolean>;
+  /**
+   * `true` only when durable storage was requested and could NOT be opened, so
+   * the dataset is sitting in RAM and local writes die on reload. Drive a
+   * warning off this, not off `status`: a store configured as in-memory reports
+   * `'memory'` too, and that is a choice rather than a problem.
+   */
+  isMemoryFallback: Accessor<boolean>;
+}
+
+/**
+ * Observe how durable the LOCAL cache is, for a "no local storage" warning.
+ *
+ * Under `localEngine: 'sqlite'` with `store: 'indexeddb'` the durable store is
+ * the OPFS SAHPool VFS, and only ONE client per bucket can hold it open: a
+ * second tab of the same app cannot get it and runs in memory instead (the
+ * engine retries first, so a closing tab's lock is usually waited out). Must be
+ * used within a `<Sp00kyProvider>`.
+ */
+export function useStorageStatus(): UseStorageStatus {
+  const db = useDb();
+  // subscribeToStorageHealth fires synchronously with the current snapshot, so
+  // the signal is correct from the first read; the initial value avoids a flash.
+  const [health, setHealth] = createSignal<StorageHealth>(db.storageHealth);
+  const unsub = db.subscribeToStorageHealth(setHealth);
+  onCleanup(unsub);
+
+  return {
+    health,
+    status: () => health().status,
+    isPersistent: () => health().status === 'persistent',
+    isMemoryFallback: () => health().fallback,
+  };
+}