@spooky-sync/client-solid 0.0.1-canary.25 → 0.0.1-canary.250

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -2,12 +2,13 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
2
  let _spooky_sync_core = require("@spooky-sync/core");
3
3
  let surrealdb = require("surrealdb");
4
4
  let solid_js = require("solid-js");
5
+ let solid_js_store = require("solid-js/store");
5
6
 
6
7
  //#region src/lib/context.ts
7
- const SpookyContext = (0, solid_js.createContext)();
8
+ const Sp00kyContext = (0, solid_js.createContext)();
8
9
  function useDb() {
9
- const db = (0, solid_js.useContext)(SpookyContext);
10
- if (!db) throw new Error("useDb must be used within a <SpookyProvider>. Wrap your app in <SpookyProvider config={...}>.");
10
+ const db = (0, solid_js.useContext)(Sp00kyContext);
11
+ if (!db) throw new Error("useDb must be used within a <Sp00kyProvider>. Wrap your app in <Sp00kyProvider config={...}>.");
11
12
  return db;
12
13
  }
13
14
 
@@ -22,30 +23,73 @@ function useQuery(dbOrQuery, queryOrOptions, maybeOptions) {
22
23
  finalQuery = queryOrOptions;
23
24
  options = maybeOptions;
24
25
  } else {
25
- const contextDb = (0, solid_js.useContext)(SpookyContext);
26
- 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>.");
26
+ const contextDb = (0, solid_js.useContext)(Sp00kyContext);
27
+ if (!contextDb) throw new Error("useQuery: No db argument provided and no Sp00kyContext found. Either pass a SyncedDb instance or wrap your app in <Sp00kyProvider>.");
27
28
  db = contextDb;
28
29
  finalQuery = dbOrQuery;
29
30
  options = queryOrOptions;
30
31
  }
31
- const [data, setData] = (0, solid_js.createSignal)(void 0);
32
32
  const [error, setError] = (0, solid_js.createSignal)(void 0);
33
33
  const [isFetched, setIsFetched] = (0, solid_js.createSignal)(false);
34
- const [unsubscribe, setUnsubscribe] = (0, solid_js.createSignal)(void 0);
34
+ const [isFetching, setIsFetching] = (0, solid_js.createSignal)(false);
35
+ const [state, setState] = (0, solid_js_store.createStore)({ value: void 0 });
36
+ const [version, setVersion] = (0, solid_js.createSignal)(0);
37
+ const data = () => {
38
+ version();
39
+ return state.value;
40
+ };
35
41
  let prevQueryString;
36
- const spooky = db.getSpooky();
37
- const initQuery = async (query) => {
42
+ let runId = 0;
43
+ let activeUnsub;
44
+ let activeHash;
45
+ const teardownActive = () => {
46
+ activeUnsub?.();
47
+ activeUnsub = void 0;
48
+ };
49
+ const sp00ky = db.getSp00ky();
50
+ /**
51
+ * Registration can fail — the canonical case is the SSP answering 503
52
+ * NOT_READY while it bootstraps. Nothing here used to catch that: the
53
+ * rejection escaped as an unhandled promise, `isFetched` stayed false, and
54
+ * `isLoading()` therefore stayed true FOREVER, which is what a spinner that
55
+ * never resolves actually was. Surface it as `error()` instead; the sync
56
+ * scheduler retries the registration underneath, so a transient failure
57
+ * still recovers on its own.
58
+ */
59
+ const initQuery = async (query, myRun) => {
60
+ try {
61
+ await subscribeQuery(query, myRun);
62
+ } catch (err) {
63
+ if (myRun !== runId) return;
64
+ setError(err instanceof Error ? err : new Error(String(err)));
65
+ }
66
+ };
67
+ const subscribeQuery = async (query, myRun) => {
38
68
  const { hash } = await query.run();
69
+ if (myRun !== runId) return;
70
+ activeHash = hash;
39
71
  setError(void 0);
40
72
  let isFirstCall = true;
41
- const unsub = await spooky.subscribe(hash, (e) => {
42
- const data = query.isOne ? e[0] : e;
43
- setData(() => data);
44
- const hasData = query.isOne ? data != null : e.length > 0;
73
+ const unsub = await sp00ky.subscribe(hash, (e) => {
74
+ const queryData = query.isOne ? e[0] : e;
75
+ const reconcileStart = performance.now();
76
+ setState("value", (0, solid_js_store.reconcile)(queryData, { key: "id" }));
77
+ setVersion((v) => v + 1);
78
+ sp00ky.reportFrontendTiming(hash, performance.now() - reconcileStart);
79
+ const hasData = query.isOne ? queryData !== null && queryData !== void 0 : e.length > 0;
45
80
  if (!isFirstCall || hasData) setIsFetched(true);
46
81
  isFirstCall = false;
47
82
  }, { immediate: true });
48
- setUnsubscribe(() => unsub);
83
+ const unsubStatus = sp00ky.subscribeQueryStatus(hash, (status) => setIsFetching(status === "fetching"), { immediate: true });
84
+ const teardown = () => {
85
+ unsub();
86
+ unsubStatus();
87
+ };
88
+ if (myRun !== runId) {
89
+ teardown();
90
+ return;
91
+ }
92
+ activeUnsub = teardown;
49
93
  };
50
94
  (0, solid_js.createEffect)(() => {
51
95
  if (!(options?.enabled?.() ?? true)) {
@@ -54,22 +98,235 @@ function useQuery(dbOrQuery, queryOrOptions, maybeOptions) {
54
98
  }
55
99
  const query = typeof finalQuery === "function" ? finalQuery() : finalQuery;
56
100
  if (!query) return;
57
- const queryString = JSON.stringify(query);
101
+ const queryString = String(query.hash);
58
102
  if (queryString === prevQueryString) return;
59
103
  prevQueryString = queryString;
104
+ const myRun = ++runId;
105
+ teardownActive();
60
106
  setIsFetched(false);
61
- initQuery(query);
62
- (0, solid_js.onCleanup)(() => {
63
- unsubscribe()?.();
64
- });
107
+ setError(void 0);
108
+ initQuery(query, myRun);
109
+ });
110
+ (0, solid_js.onCleanup)(() => {
111
+ runId++;
112
+ teardownActive();
113
+ if (options?.deregisterOnCleanup && activeHash) sp00ky.deregisterQuery(activeHash);
65
114
  });
66
115
  const isLoading = () => {
67
116
  return !isFetched() && error() === void 0;
68
117
  };
118
+ const isSettled = () => isFetched() && !isFetching();
69
119
  return {
70
120
  data,
71
121
  error,
72
- isLoading
122
+ isLoading,
123
+ isFetching,
124
+ isSettled
125
+ };
126
+ }
127
+
128
+ //#endregion
129
+ //#region src/lib/create-preload.ts
130
+ /**
131
+ * Reactive, fire-and-forget prewarm. Resolves the query (calling it if it's a
132
+ * function so it tracks reactive deps), dedupes on the query's stable identity
133
+ * hash, and registers it via `db.preload`: a live query nobody subscribes to,
134
+ * evicted a ttl after it was registered unless a view mounts it first. Nothing
135
+ * to clean up here.
136
+ *
137
+ * Typical use: inside a list row, preload the detail query the user is likely
138
+ * to open next, so navigation paints from cache instead of the network.
139
+ */
140
+ function createPreload(dbOrQuery, queryOrOptions, maybeOptions) {
141
+ let db;
142
+ let finalQuery;
143
+ let options;
144
+ if (dbOrQuery instanceof SyncedDb) {
145
+ db = dbOrQuery;
146
+ finalQuery = queryOrOptions;
147
+ options = maybeOptions;
148
+ } else {
149
+ const contextDb = (0, solid_js.useContext)(Sp00kyContext);
150
+ 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>.");
151
+ db = contextDb;
152
+ finalQuery = dbOrQuery;
153
+ options = queryOrOptions;
154
+ }
155
+ let prevHash;
156
+ (0, solid_js.createEffect)(() => {
157
+ if (!(options?.enabled?.() ?? true)) return;
158
+ const query = typeof finalQuery === "function" ? finalQuery() : finalQuery;
159
+ if (!query) return;
160
+ if (query.hash === prevHash) return;
161
+ prevHash = query.hash;
162
+ db.getSp00ky().preload(query, { signal: options?.signal });
163
+ });
164
+ }
165
+
166
+ //#endregion
167
+ //#region src/lib/use-sync-status.ts
168
+ /**
169
+ * Observe sync health for a "can't reach the server" banner / indicator.
170
+ *
171
+ * Backed by `db.subscribeToSyncHealth`. Individual sync failures (a transient
172
+ * remote 500 on query registration, a dropped socket) are absorbed by the
173
+ * retry and never flip this; `isDegraded()` only goes true once failures
174
+ * persist for the configured number of consecutive rounds (sp00ky core config
175
+ * `syncHealth.degradeAfterConsecutiveFailures`, default 3), and flips back on
176
+ * the next successful round. Must be used within a `<Sp00kyProvider>`.
177
+ */
178
+ function useSyncStatus() {
179
+ const db = useDb();
180
+ const [health, setHealth] = (0, solid_js.createSignal)(db.syncHealth);
181
+ (0, solid_js.onCleanup)(db.subscribeToSyncHealth(setHealth));
182
+ return {
183
+ health,
184
+ status: () => health().status,
185
+ isHealthy: () => health().status === "healthy",
186
+ isDegraded: () => health().status === "degraded",
187
+ everConnected: () => health().everConnected,
188
+ isOffline: () => health().status === "degraded" && health().everConnected,
189
+ connection: () => health().connection,
190
+ isReconnecting: () => health().connection === "reconnecting"
191
+ };
192
+ }
193
+
194
+ //#endregion
195
+ //#region src/lib/use-storage-status.ts
196
+ /**
197
+ * Observe how durable the LOCAL cache is, for a "no local storage" warning.
198
+ *
199
+ * Under `localEngine: 'sqlite'` with `store: 'indexeddb'` the durable store is
200
+ * the OPFS SAHPool VFS, and only ONE client per bucket can hold it open: a
201
+ * second tab of the same app cannot get it and runs in memory instead (the
202
+ * engine retries first, so a closing tab's lock is usually waited out). Must be
203
+ * used within a `<Sp00kyProvider>`.
204
+ */
205
+ function useStorageStatus() {
206
+ const db = useDb();
207
+ const [health, setHealth] = (0, solid_js.createSignal)(db.storageHealth);
208
+ (0, solid_js.onCleanup)(db.subscribeToStorageHealth(setHealth));
209
+ return {
210
+ health,
211
+ status: () => health().status,
212
+ isPersistent: () => health().status === "persistent",
213
+ isMemoryFallback: () => health().fallback
214
+ };
215
+ }
216
+
217
+ //#endregion
218
+ //#region src/lib/use-crdt-field.ts
219
+ function useCrdtField(table, recordId, field, fallbackText) {
220
+ const db = (0, solid_js.useContext)(Sp00kyContext);
221
+ if (!db) throw new Error("useCrdtField must be used within a <Sp00kyProvider>");
222
+ const [crdtField, setCrdtField] = (0, solid_js.createSignal)(null);
223
+ let currentId;
224
+ let initialized = false;
225
+ (0, solid_js.createEffect)(() => {
226
+ const id = recordId();
227
+ if (initialized && id === currentId) return;
228
+ if (currentId && crdtField()) {
229
+ db.getSp00ky().closeCrdtField(table, currentId, field);
230
+ setCrdtField(null);
231
+ }
232
+ currentId = id;
233
+ initialized = true;
234
+ if (!id) return;
235
+ const sp00ky = db.getSp00ky();
236
+ const text = fallbackText?.();
237
+ sp00ky.openCrdtField(table, id, field, text).then((cf) => {
238
+ if (currentId === id) setCrdtField(cf);
239
+ }).catch((err) => {
240
+ console.error(`[useCrdtField] Failed to open CRDT field ${table}.${field} on ${id}:`, err);
241
+ });
242
+ });
243
+ (0, solid_js.onCleanup)(() => {
244
+ if (currentId && crdtField()) {
245
+ db.getSp00ky().closeCrdtField(table, currentId, field);
246
+ setCrdtField(null);
247
+ }
248
+ });
249
+ return crdtField;
250
+ }
251
+
252
+ //#endregion
253
+ //#region src/lib/use-feature-flag.ts
254
+ /**
255
+ * Subscribe to a feature flag for the currently authenticated user.
256
+ *
257
+ * Returns three Solid accessors that update reactively whenever the
258
+ * server-materialized assignment in `_00_user_feature` changes. Backed by
259
+ * the same SSP + sync pipeline that powers `useQuery`, so toggling a flag
260
+ * via `spky flag enable <key>` propagates to the UI without a refresh.
261
+ *
262
+ * `enabled()` is `true` when the resolved variant exists and is not 'off'.
263
+ * For multi-variant flags, prefer `variant()` directly.
264
+ */
265
+ function useFeatureFlag(key, options) {
266
+ const handle = useDb().getSp00ky().feature(key, options);
267
+ const [variant, setVariant] = (0, solid_js.createSignal)(handle.variant());
268
+ const [payload, setPayload] = (0, solid_js.createSignal)(handle.payload());
269
+ const unsub = handle.subscribe((s) => {
270
+ setVariant(s.variant ?? options?.fallback);
271
+ setPayload(s.payload);
272
+ });
273
+ (0, solid_js.onCleanup)(() => {
274
+ unsub();
275
+ handle.close();
276
+ });
277
+ return {
278
+ variant,
279
+ payload,
280
+ enabled: () => {
281
+ const v = variant();
282
+ return v !== void 0 && v !== "off";
283
+ }
284
+ };
285
+ }
286
+
287
+ //#endregion
288
+ //#region src/lib/use-app-release.ts
289
+ async function reloadForSnapshot(snapshot) {
290
+ if (typeof window === "undefined") return;
291
+ if (snapshot.cacheBust) try {
292
+ if (window.caches) {
293
+ const keys = await window.caches.keys();
294
+ await Promise.all(keys.map((k) => window.caches.delete(k)));
295
+ }
296
+ if (navigator.serviceWorker) {
297
+ const regs = await navigator.serviceWorker.getRegistrations();
298
+ for (const r of regs) r.update().catch(() => {});
299
+ }
300
+ window.location.href = window.location.pathname + "?cb=" + Date.now();
301
+ return;
302
+ } catch {}
303
+ window.location.reload();
304
+ }
305
+ /**
306
+ * Observe the app's announced release (`_00_app_release:<app>`, written by
307
+ * `spky deploy` / `spky release`) and compare it against the running build.
308
+ *
309
+ * Typical use: mount a small "new version available — Reload" notification
310
+ * gated on `updateAvailable()`, auto-invoking `reload()` when `mandatory()`
311
+ * (guard the auto path against reload loops with a per-version marker, since
312
+ * a client can reload while the deploy is still rolling out and land on the
313
+ * old bundle again).
314
+ */
315
+ function useAppRelease(options) {
316
+ const handle = useDb().getSp00ky().appRelease(options.app, { ttl: options.ttl });
317
+ const [snapshot, setSnapshot] = (0, solid_js.createSignal)(handle.snapshot());
318
+ const unsub = handle.subscribe(setSnapshot);
319
+ (0, solid_js.onCleanup)(() => {
320
+ unsub();
321
+ handle.close();
322
+ });
323
+ const updateAvailable = () => (0, _spooky_sync_core.semverGt)(snapshot().version, options.currentVersion);
324
+ return {
325
+ latestVersion: () => snapshot().version,
326
+ updateAvailable,
327
+ mandatory: () => updateAvailable() && snapshot().mandatory,
328
+ cacheBust: () => snapshot().cacheBust,
329
+ reload: () => reloadForSnapshot(snapshot())
73
330
  };
74
331
  }
75
332
 
@@ -95,7 +352,7 @@ function useFileUpload(dbOrBucketName, maybeBucketName) {
95
352
  const validate = (file) => {
96
353
  const config = db.getBucketConfig(bucketName);
97
354
  if (!config) return;
98
- if (config.maxSize != null && file.size > config.maxSize) {
355
+ if (config.maxSize !== null && config.maxSize !== void 0 && file.size > config.maxSize) {
99
356
  const maxMB = (config.maxSize / (1024 * 1024)).toFixed(1);
100
357
  throw new Error(`File exceeds maximum size of ${maxMB} MB.`);
101
358
  }
@@ -107,7 +364,7 @@ function useFileUpload(dbOrBucketName, maybeBucketName) {
107
364
  }
108
365
  }
109
366
  };
110
- const upload = async (path, file) => {
367
+ const upload = async (path, file, options) => {
111
368
  setError(null);
112
369
  try {
113
370
  validate(file);
@@ -118,7 +375,7 @@ function useFileUpload(dbOrBucketName, maybeBucketName) {
118
375
  setIsUploading(true);
119
376
  try {
120
377
  const bytes = await (0, _spooky_sync_core.fileToUint8Array)(file);
121
- await db.bucket(bucketName).put(path, bytes);
378
+ return await db.bucket(bucketName).put(path, bytes, options);
122
379
  } catch (e) {
123
380
  setError(e instanceof Error ? e : new Error(String(e)));
124
381
  } finally {
@@ -168,20 +425,6 @@ function useFileUpload(dbOrBucketName, maybeBucketName) {
168
425
 
169
426
  //#endregion
170
427
  //#region src/lib/use-download-file.ts
171
- const downloadCache = /* @__PURE__ */ new Map();
172
- const inflightRequests = /* @__PURE__ */ new Map();
173
- function cacheKey(bucket, path) {
174
- return `${bucket}:${path}`;
175
- }
176
- function releaseEntry(key) {
177
- const entry = downloadCache.get(key);
178
- if (!entry) return;
179
- entry.refCount--;
180
- if (entry.refCount <= 0) {
181
- URL.revokeObjectURL(entry.url);
182
- downloadCache.delete(key);
183
- }
184
- }
185
428
  function useDownloadFile(dbOrBucketName, bucketNameOrPath, pathOrOptions, maybeOptions) {
186
429
  let db;
187
430
  let bucketName;
@@ -202,63 +445,15 @@ function useDownloadFile(dbOrBucketName, bucketNameOrPath, pathOrOptions, maybeO
202
445
  const [url, setUrl] = (0, solid_js.createSignal)(null);
203
446
  const [isLoading, setIsLoading] = (0, solid_js.createSignal)(false);
204
447
  const [error, setError] = (0, solid_js.createSignal)(null);
205
- let currentKey = null;
448
+ let lease = null;
206
449
  let privateUrl = null;
207
- let refetchTrigger;
208
450
  const [refetchSignal, setRefetchSignal] = (0, solid_js.createSignal)(0);
209
- refetchTrigger = () => setRefetchSignal((n) => n + 1);
210
- async function doDownload(key, filePath) {
211
- if (useCache) {
212
- const cached = downloadCache.get(key);
213
- if (cached) {
214
- cached.refCount++;
215
- currentKey = key;
216
- return cached.url;
217
- }
218
- const inflight = inflightRequests.get(key);
219
- if (inflight) {
220
- const result = await inflight;
221
- if (result) {
222
- const entry = downloadCache.get(key);
223
- if (entry) {
224
- entry.refCount++;
225
- currentKey = key;
226
- }
227
- }
228
- return result;
229
- }
230
- const promise = (async () => {
231
- const content = await db.bucket(bucketName).get(filePath);
232
- if (!content) return null;
233
- const objectUrl = URL.createObjectURL(new Blob([content]));
234
- downloadCache.set(key, {
235
- url: objectUrl,
236
- refCount: 1
237
- });
238
- return objectUrl;
239
- })();
240
- inflightRequests.set(key, promise);
241
- try {
242
- const result = await promise;
243
- currentKey = key;
244
- return result;
245
- } finally {
246
- inflightRequests.delete(key);
247
- }
248
- } else {
249
- const content = await db.bucket(bucketName).get(filePath);
250
- if (!content) return null;
251
- const objectUrl = URL.createObjectURL(new Blob([content]));
252
- privateUrl = objectUrl;
253
- return objectUrl;
254
- }
255
- }
256
- function releaseCurrentEntry() {
257
- if (useCache && currentKey) {
258
- releaseEntry(currentKey);
259
- currentKey = null;
260
- }
261
- if (!useCache && privateUrl) {
451
+ /** Consumed by the next effect run, so `refetch()` bypasses every layer once. */
452
+ let reloadOnce = false;
453
+ function releaseCurrent() {
454
+ lease?.release();
455
+ lease = null;
456
+ if (privateUrl) {
262
457
  URL.revokeObjectURL(privateUrl);
263
458
  privateUrl = null;
264
459
  }
@@ -266,29 +461,40 @@ function useDownloadFile(dbOrBucketName, bucketNameOrPath, pathOrOptions, maybeO
266
461
  (0, solid_js.createEffect)(() => {
267
462
  const filePath = path();
268
463
  refetchSignal();
269
- releaseCurrentEntry();
464
+ releaseCurrent();
270
465
  if (!filePath) {
271
466
  setUrl(null);
272
467
  setIsLoading(false);
273
468
  setError(null);
274
469
  return;
275
470
  }
276
- const key = cacheKey(bucketName, filePath);
277
- if (useCache) {
278
- const cached = downloadCache.get(key);
279
- if (cached) {
280
- cached.refCount++;
281
- currentKey = key;
282
- setUrl(cached.url);
283
- setIsLoading(false);
284
- setError(null);
285
- return;
286
- }
287
- }
471
+ const reload = reloadOnce;
472
+ reloadOnce = false;
288
473
  let cancelled = false;
289
474
  setIsLoading(true);
290
475
  setError(null);
291
- doDownload(key, filePath).then((result) => {
476
+ const bucket = db.bucket(bucketName);
477
+ (useCache ? bucket.url(filePath, {
478
+ persist: options.persist !== false,
479
+ pin: options.pin,
480
+ revalidate: options.revalidate,
481
+ reload
482
+ }).then((acquired) => {
483
+ if (!acquired) return null;
484
+ if (cancelled) {
485
+ acquired.release();
486
+ return null;
487
+ }
488
+ lease = acquired;
489
+ return acquired.url;
490
+ }) : bucket.read(filePath, {
491
+ persist: false,
492
+ reload: true
493
+ }).then((blob) => {
494
+ if (!blob || cancelled) return null;
495
+ privateUrl = URL.createObjectURL(blob);
496
+ return privateUrl;
497
+ })).then((result) => {
292
498
  if (!cancelled) {
293
499
  setUrl(result);
294
500
  setIsLoading(false);
@@ -304,18 +510,11 @@ function useDownloadFile(dbOrBucketName, bucketNameOrPath, pathOrOptions, maybeO
304
510
  });
305
511
  });
306
512
  (0, solid_js.onCleanup)(() => {
307
- releaseCurrentEntry();
513
+ releaseCurrent();
308
514
  });
309
515
  const refetch = () => {
310
- if (useCache && currentKey) {
311
- const entry = downloadCache.get(currentKey);
312
- if (entry) {
313
- URL.revokeObjectURL(entry.url);
314
- downloadCache.delete(currentKey);
315
- }
316
- currentKey = null;
317
- }
318
- refetchTrigger();
516
+ reloadOnce = true;
517
+ setRefetchSignal((n) => n + 1);
319
518
  };
320
519
  return {
321
520
  url,
@@ -326,26 +525,251 @@ function useDownloadFile(dbOrBucketName, bucketNameOrPath, pathOrOptions, maybeO
326
525
  }
327
526
 
328
527
  //#endregion
329
- //#region src/lib/SpookyProvider.ts
330
- function SpookyProvider(props) {
528
+ //#region src/lib/use-blurhash.ts
529
+ function useBlurhash(dbOrBucketName, bucketNameOrPath, maybePath) {
530
+ let db;
531
+ let bucketName;
532
+ let path;
533
+ if (typeof dbOrBucketName === "string") {
534
+ db = useDb();
535
+ bucketName = dbOrBucketName;
536
+ path = bucketNameOrPath;
537
+ } else {
538
+ db = dbOrBucketName;
539
+ bucketName = bucketNameOrPath;
540
+ path = maybePath;
541
+ }
542
+ const [hash, setHash] = (0, solid_js.createSignal)(null);
543
+ const [isLoading, setIsLoading] = (0, solid_js.createSignal)(false);
544
+ (0, solid_js.createEffect)(() => {
545
+ const filePath = path();
546
+ if (!filePath) {
547
+ setHash(null);
548
+ setIsLoading(false);
549
+ return;
550
+ }
551
+ let cancelled = false;
552
+ setIsLoading(true);
553
+ db.bucket(bucketName).blurhash(filePath).then((result) => {
554
+ if (cancelled) return;
555
+ setHash(result);
556
+ setIsLoading(false);
557
+ }).catch(() => {
558
+ if (cancelled) return;
559
+ setHash(null);
560
+ setIsLoading(false);
561
+ });
562
+ (0, solid_js.onCleanup)(() => {
563
+ cancelled = true;
564
+ });
565
+ });
566
+ return {
567
+ hash,
568
+ isLoading
569
+ };
570
+ }
571
+
572
+ //#endregion
573
+ //#region src/lib/use-bucket-image.ts
574
+ function useBucketImage(dbOrBucketName, bucketNameOrPath, pathOrOptions, maybeOptions) {
575
+ let db;
576
+ let bucketName;
577
+ let path;
578
+ let options;
579
+ if (typeof dbOrBucketName === "string") {
580
+ db = useDb();
581
+ bucketName = dbOrBucketName;
582
+ path = bucketNameOrPath;
583
+ options = pathOrOptions ?? {};
584
+ } else {
585
+ db = dbOrBucketName;
586
+ bucketName = bucketNameOrPath;
587
+ path = pathOrOptions;
588
+ options = maybeOptions ?? {};
589
+ }
590
+ const wantHash = options.blurhash !== false;
591
+ const { hash } = useBlurhash(db, bucketName, () => wantHash ? path() : null);
592
+ const file = useDownloadFile(db, bucketName, path, options);
593
+ const [ready, setReady] = (0, solid_js.createSignal)(false);
594
+ (0, solid_js.createEffect)((0, solid_js.on)(file.url, () => setReady(false), { defer: true }));
595
+ const gate = (img) => {
596
+ const done = () => setReady(true);
597
+ if (typeof img.decode === "function") img.decode().then(done, done);
598
+ else if (img.complete) done();
599
+ else {
600
+ img.onload = done;
601
+ img.onerror = done;
602
+ }
603
+ };
604
+ return {
605
+ ...file,
606
+ blurhash: hash,
607
+ ready,
608
+ gate
609
+ };
610
+ }
611
+
612
+ //#endregion
613
+ //#region src/lib/Blurhash.ts
614
+ /**
615
+ * A blurhash painted onto a canvas, once per hash change. Size the canvas via
616
+ * `class`/`style` (e.g. `absolute inset-0 w-full h-full`); the internal decode
617
+ * resolution stays tiny regardless of the displayed size.
618
+ */
619
+ function Blurhash(props) {
620
+ if (typeof document === "undefined") return null;
621
+ const canvas = document.createElement("canvas");
622
+ (0, solid_js.createEffect)(() => {
623
+ canvas.className = props.class ?? "";
624
+ });
625
+ (0, solid_js.createEffect)(() => {
626
+ canvas.style.cssText = props.style ?? "";
627
+ });
628
+ (0, solid_js.createEffect)(() => {
629
+ const width = props.width ?? 32;
630
+ const height = props.height ?? 32;
631
+ canvas.width = width;
632
+ canvas.height = height;
633
+ const hash = props.hash;
634
+ if (!hash) return;
635
+ try {
636
+ const pixels = (0, _spooky_sync_core.decodeBlurhash)(hash, width, height, props.punch ?? 1);
637
+ const ctx = canvas.getContext("2d");
638
+ if (!ctx) return;
639
+ const imageData = ctx.createImageData(width, height);
640
+ imageData.data.set(pixels);
641
+ ctx.putImageData(imageData, 0, 0);
642
+ } catch {}
643
+ });
644
+ return canvas;
645
+ }
646
+
647
+ //#endregion
648
+ //#region src/lib/BucketImage.ts
649
+ const LAYER_STYLE = "position:absolute;inset:0;width:100%;height:100%;";
650
+ /**
651
+ * A bucket image that never pops in: it layers (bottom to top) your `fallback`
652
+ * plate, the automatically stored blurhash, and the real image, which stays
653
+ * transparent until the bitmap is DECODED and then crossfades over the
654
+ * placeholders. Placeholder layers unmount once the fade settles. Respects
655
+ * prefers-reduced-motion (instant swap). The container is made
656
+ * `position: relative` unless your `class` positions it already.
657
+ *
658
+ * ```tsx
659
+ * <BucketImage bucket="covers" path={row.cover_key} class="absolute inset-0"
660
+ * fallback={<MyPlate />} alt="" />
661
+ * ```
662
+ */
663
+ function BucketImage(props) {
664
+ if (typeof document === "undefined") return null;
665
+ const image = useBucketImage(props.bucket, () => props.path, {
666
+ ...props.options,
667
+ blurhash: props.blurhash !== false
668
+ });
669
+ const reducedMotion = typeof matchMedia === "function" && matchMedia("(prefers-reduced-motion: reduce)").matches;
670
+ const root = document.createElement("div");
671
+ (0, solid_js.createEffect)(() => {
672
+ root.className = props.class ?? "";
673
+ });
674
+ (0, solid_js.onMount)(() => {
675
+ if (getComputedStyle(root).position === "static") root.style.position = "relative";
676
+ });
677
+ const placeholder = document.createElement("div");
678
+ placeholder.style.cssText = LAYER_STYLE;
679
+ const fallbackHolder = document.createElement("div");
680
+ fallbackHolder.style.cssText = LAYER_STYLE;
681
+ placeholder.append(fallbackHolder);
682
+ const resolvedFallback = (0, solid_js.children)(() => props.fallback);
683
+ (0, solid_js.createEffect)(() => {
684
+ const nodes = resolvedFallback.toArray().filter((node) => node instanceof Node);
685
+ fallbackHolder.replaceChildren(...nodes);
686
+ });
687
+ const hashCanvas = Blurhash({
688
+ get hash() {
689
+ return image.blurhash();
690
+ },
691
+ style: LAYER_STYLE
692
+ });
693
+ if (hashCanvas instanceof Node) placeholder.append(hashCanvas);
694
+ const img = document.createElement("img");
695
+ img.decoding = "async";
696
+ img.style.cssText = `${LAYER_STYLE}opacity:0;`;
697
+ (0, solid_js.createEffect)(() => {
698
+ img.className = props.imgClass ?? "";
699
+ });
700
+ (0, solid_js.createEffect)(() => {
701
+ img.style.objectFit = props.fit ?? "cover";
702
+ });
703
+ (0, solid_js.createEffect)(() => {
704
+ img.alt = props.alt ?? "";
705
+ });
706
+ (0, solid_js.createEffect)(() => {
707
+ img.style.transition = reducedMotion ? "none" : `opacity ${props.transition ?? 300}ms ${props.easing ?? "cubic-bezier(0.16, 1, 0.3, 1)"}`;
708
+ });
709
+ (0, solid_js.createEffect)(() => {
710
+ const url = image.url();
711
+ if (!url) {
712
+ img.removeAttribute("src");
713
+ return;
714
+ }
715
+ img.src = url;
716
+ image.gate(img);
717
+ });
718
+ (0, solid_js.createEffect)(() => {
719
+ img.style.opacity = image.ready() ? "1" : "0";
720
+ });
721
+ const [settled, setSettled] = (0, solid_js.createSignal)(false);
722
+ (0, solid_js.createEffect)(() => {
723
+ if (!image.ready()) {
724
+ setSettled(false);
725
+ return;
726
+ }
727
+ const wait = (reducedMotion ? 0 : props.transition ?? 300) + 120;
728
+ const timer = setTimeout(() => setSettled(true), wait);
729
+ (0, solid_js.onCleanup)(() => clearTimeout(timer));
730
+ });
731
+ (0, solid_js.createEffect)(() => {
732
+ if (settled()) placeholder.remove();
733
+ else if (!placeholder.isConnected) root.insertBefore(placeholder, img);
734
+ });
735
+ root.append(placeholder, img);
736
+ return root;
737
+ }
738
+
739
+ //#endregion
740
+ //#region src/lib/Sp00kyProvider.ts
741
+ function Sp00kyProvider(props) {
331
742
  const merged = (0, solid_js.mergeProps)({ fallback: void 0 }, props);
332
743
  const [db, setDb] = (0, solid_js.createSignal)(void 0);
744
+ let disposed = false;
745
+ (0, solid_js.onCleanup)(() => {
746
+ disposed = true;
747
+ });
333
748
  (0, solid_js.onMount)(async () => {
334
749
  try {
335
750
  const instance = new SyncedDb(merged.config);
336
751
  await instance.init();
752
+ if (disposed) {
753
+ await instance.close();
754
+ return;
755
+ }
756
+ if (merged.preload) try {
757
+ await merged.preload(instance);
758
+ } catch (e) {
759
+ console.error("Sp00kyProvider: preload failed; revealing UI anyway", e);
760
+ }
337
761
  setDb(() => instance);
338
762
  merged.onReady?.(instance);
339
763
  } catch (e) {
340
764
  const error = e instanceof Error ? e : new Error(String(e));
341
765
  if (merged.onError) merged.onError(error);
342
- else console.error("SpookyProvider: Failed to initialize database", error);
766
+ else console.error("Sp00kyProvider: Failed to initialize database", error);
343
767
  }
344
768
  });
345
769
  return (0, solid_js.createMemo)(() => {
346
770
  const instance = db();
347
771
  if (!instance) return merged.fallback;
348
- return (0, solid_js.createComponent)(SpookyContext.Provider, {
772
+ return (0, solid_js.createComponent)(Sp00kyContext.Provider, {
349
773
  value: instance,
350
774
  get children() {
351
775
  return merged.children;
@@ -357,69 +781,94 @@ function SpookyProvider(props) {
357
781
  //#endregion
358
782
  //#region src/index.ts
359
783
  /**
360
- * SyncedDb - A thin wrapper around spooky-ts for Solid.js integration
361
- * Delegates all logic to the underlying spooky-ts instance
784
+ * SyncedDb - A thin wrapper around sp00ky-ts for Solid.js integration
785
+ * Delegates all logic to the underlying sp00ky-ts instance
362
786
  */
363
787
  var SyncedDb = class {
364
788
  constructor(config) {
365
- this.spooky = null;
789
+ this.sp00ky = null;
366
790
  this._initialized = false;
367
791
  this.config = config;
368
792
  }
369
- getSpooky() {
370
- if (!this.spooky) throw new Error("SyncedDb not initialized");
371
- return this.spooky;
793
+ getSp00ky() {
794
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
795
+ return this.sp00ky;
372
796
  }
373
797
  /**
374
- * Initialize the spooky-ts instance
798
+ * Initialize the sp00ky-ts instance
375
799
  */
376
800
  async init() {
377
801
  if (this._initialized) return;
378
- this.spooky = new _spooky_sync_core.SpookyClient(this.config);
379
- await this.spooky.init();
802
+ this.sp00ky = new _spooky_sync_core.Sp00kyClient(this.config);
803
+ await this.sp00ky.init();
380
804
  this._initialized = true;
381
805
  }
382
806
  /**
807
+ * Tear down the client: leaves the tabs broker, closes the local store and
808
+ * remote socket, and frees the wasm circuit. Without this a remounted provider
809
+ * (or an HMR reload) strands a whole client, and the abandoned wasm heaps stay
810
+ * resident because V8 cannot see how much wasm memory a dropped wrapper holds.
811
+ */
812
+ async close() {
813
+ const instance = this.sp00ky;
814
+ this.sp00ky = null;
815
+ this._initialized = false;
816
+ if (instance) await instance.close();
817
+ }
818
+ /**
383
819
  * Create a new record in the database
384
820
  */
385
821
  async create(id, payload) {
386
- if (!this.spooky) throw new Error("SyncedDb not initialized");
387
- await this.spooky.create(id, payload);
822
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
823
+ await this.sp00ky.create(id, payload);
388
824
  }
389
825
  /**
390
826
  * Update an existing record in the database
391
827
  */
392
828
  async update(tableName, recordId, payload, options) {
393
- if (!this.spooky) throw new Error("SyncedDb not initialized");
394
- await this.spooky.update(tableName, recordId, payload, options);
829
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
830
+ await this.sp00ky.update(tableName, recordId, payload, options);
395
831
  }
396
832
  /**
397
833
  * Delete an existing record in the database
398
834
  */
399
835
  async delete(tableName, selector) {
400
- if (!this.spooky) throw new Error("SyncedDb not initialized");
401
- if (typeof selector !== "string") throw new Error("Only string ID selectors are supported currently with core");
402
- await this.spooky.delete(tableName, selector);
836
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
837
+ const isRecordId = selector instanceof surrealdb.RecordId || selector?.constructor?.name === "RecordId";
838
+ let id;
839
+ if (typeof selector === "string") id = selector;
840
+ else if (isRecordId) id = `${tableName}:${selector.id}`;
841
+ else throw new Error("Only string ID or RecordId selectors are supported currently with core");
842
+ await this.sp00ky.delete(tableName, id);
843
+ }
844
+ /**
845
+ * Preload/prewarm a built query into the local cache without registering a
846
+ * live view. Fetches once and stores the rows (+ embedded related children)
847
+ * locally so a later `useQuery` for the same data paints instantly. Best-effort.
848
+ */
849
+ async preload(finalQuery, options) {
850
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
851
+ await this.sp00ky.preload(finalQuery, options);
403
852
  }
404
853
  /**
405
854
  * Query data from the database
406
855
  */
407
856
  query(table) {
408
- if (!this.spooky) throw new Error("SyncedDb not initialized");
409
- return this.spooky.query(table, {});
857
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
858
+ return this.sp00ky.query(table, {});
410
859
  }
411
860
  /**
412
861
  * Run a backend operation
413
862
  */
414
863
  async run(backend, path, payload, options) {
415
- if (!this.spooky) throw new Error("SyncedDb not initialized");
416
- await this.spooky.run(backend, path, payload, options);
864
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
865
+ await this.sp00ky.run(backend, path, payload, options);
417
866
  }
418
867
  /**
419
868
  * Authenticate with the database
420
869
  */
421
870
  async authenticate(token) {
422
- await this.spooky?.authenticate(token);
871
+ await this.sp00ky?.authenticate(token);
423
872
  return new surrealdb.RecordId("user", "me");
424
873
  }
425
874
  /**
@@ -433,48 +882,81 @@ var SyncedDb = class {
433
882
  * Sign out, clear session and local storage
434
883
  */
435
884
  async signOut() {
436
- if (!this.spooky) throw new Error("SyncedDb not initialized");
437
- await this.spooky.auth.signOut();
885
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
886
+ await this.sp00ky.auth.signOut();
438
887
  }
439
888
  /**
440
889
  * Execute a function with direct access to the remote database connection
441
890
  */
442
891
  async useRemote(fn) {
443
- if (!this.spooky) throw new Error("SyncedDb not initialized");
444
- return await this.spooky.useRemote(fn);
892
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
893
+ return await this.sp00ky.useRemote(fn);
445
894
  }
446
895
  /**
447
896
  * Access the remote database service directly
448
897
  */
449
898
  get remote() {
450
- if (!this.spooky) throw new Error("SyncedDb not initialized");
451
- return this.spooky.remoteClient;
899
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
900
+ return this.sp00ky.remoteClient;
452
901
  }
453
902
  /**
454
903
  * Access the local database service directly
455
904
  */
456
905
  get local() {
457
- if (!this.spooky) throw new Error("SyncedDb not initialized");
458
- return this.spooky.localClient;
906
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
907
+ return this.sp00ky.localClient;
459
908
  }
460
909
  /**
461
910
  * Access the auth service
462
911
  */
463
912
  get auth() {
464
- if (!this.spooky) throw new Error("SyncedDb not initialized");
465
- return this.spooky.auth;
913
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
914
+ return this.sp00ky.auth;
466
915
  }
467
916
  get pendingMutationCount() {
468
- if (!this.spooky) throw new Error("SyncedDb not initialized");
469
- return this.spooky.pendingMutationCount;
917
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
918
+ return this.sp00ky.pendingMutationCount;
919
+ }
920
+ /** Diagnostic — see `Sp00kyClient.liveRetryCount`. */
921
+ get liveRetryCount() {
922
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
923
+ return this.sp00ky.liveRetryCount;
470
924
  }
471
925
  subscribeToPendingMutations(cb) {
472
- if (!this.spooky) throw new Error("SyncedDb not initialized");
473
- return this.spooky.subscribeToPendingMutations(cb);
926
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
927
+ return this.sp00ky.subscribeToPendingMutations(cb);
928
+ }
929
+ /** Current sync-health snapshot. See {@link useSyncStatus}. */
930
+ get syncHealth() {
931
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
932
+ return this.sp00ky.syncHealth;
933
+ }
934
+ /**
935
+ * Observe sync health. Fires immediately with the current status and again
936
+ * on every healthy↔degraded transition. Prefer the `useSyncStatus` hook in
937
+ * components; this is the imperative escape hatch.
938
+ */
939
+ subscribeToSyncHealth(cb) {
940
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
941
+ return this.sp00ky.subscribeToSyncHealth(cb);
942
+ }
943
+ /** Current local-store durability snapshot. See {@link useStorageStatus}. */
944
+ get storageHealth() {
945
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
946
+ return this.sp00ky.storageHealth;
947
+ }
948
+ /**
949
+ * Observe local-store durability. Fires immediately with the current snapshot
950
+ * and again on change. Prefer the `useStorageStatus` hook in components; this
951
+ * is the imperative escape hatch.
952
+ */
953
+ subscribeToStorageHealth(cb) {
954
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
955
+ return this.sp00ky.subscribeToStorageHealth(cb);
474
956
  }
475
957
  bucket(name) {
476
- if (!this.spooky) throw new Error("SyncedDb not initialized");
477
- return this.spooky.bucket(name);
958
+ if (!this.sp00ky) throw new Error("SyncedDb not initialized");
959
+ return this.sp00ky.bucket(name);
478
960
  }
479
961
  getBucketConfig(name) {
480
962
  return this.config.schema.buckets?.find((b) => b.name === name);
@@ -482,12 +964,22 @@ var SyncedDb = class {
482
964
  };
483
965
 
484
966
  //#endregion
967
+ exports.Blurhash = Blurhash;
968
+ exports.BucketImage = BucketImage;
485
969
  exports.RecordId = surrealdb.RecordId;
486
- exports.SpookyProvider = SpookyProvider;
970
+ exports.Sp00kyProvider = Sp00kyProvider;
487
971
  exports.SyncedDb = SyncedDb;
488
972
  exports.Uuid = surrealdb.Uuid;
973
+ exports.createPreload = createPreload;
974
+ exports.useAppRelease = useAppRelease;
975
+ exports.useBlurhash = useBlurhash;
976
+ exports.useBucketImage = useBucketImage;
977
+ exports.useCrdtField = useCrdtField;
489
978
  exports.useDb = useDb;
490
979
  exports.useDownloadFile = useDownloadFile;
980
+ exports.useFeatureFlag = useFeatureFlag;
491
981
  exports.useFileUpload = useFileUpload;
492
982
  exports.useQuery = useQuery;
983
+ exports.useStorageStatus = useStorageStatus;
984
+ exports.useSyncStatus = useSyncStatus;
493
985
  //# sourceMappingURL=index.cjs.map