@spooky-sync/core 0.0.1-canary.24 → 0.0.1-canary.241

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.
Files changed (228) hide show
  1. package/AGENTS.md +77 -0
  2. package/README.md +56 -16
  3. package/dist/index.d.ts +2176 -80
  4. package/dist/index.js +12557 -2588
  5. package/dist/otel/index.d.ts +2 -2
  6. package/dist/otel/index.js +6 -6
  7. package/dist/sqlite-open.js +322 -0
  8. package/dist/sqlite-worker.d.ts +1 -0
  9. package/dist/sqlite-worker.js +439 -0
  10. package/dist/tabs-broker-worker.d.ts +8 -0
  11. package/dist/tabs-broker-worker.js +472 -0
  12. package/dist/types.d.ts +747 -46
  13. package/package.json +16 -8
  14. package/scripts/check-broker-bundle.mjs +33 -0
  15. package/skills/{spooky-core → sp00ky-core}/SKILL.md +30 -12
  16. package/skills/{spooky-core → sp00ky-core}/references/auth.md +1 -1
  17. package/skills/{spooky-core → sp00ky-core}/references/config.md +2 -2
  18. package/src/boot/auth-flip.saga.test.ts +82 -0
  19. package/src/boot/auth-flip.saga.ts +62 -0
  20. package/src/boot/boot.saga.test.ts +151 -0
  21. package/src/boot/boot.saga.ts +128 -0
  22. package/src/boot/bucket-switch.saga.test.ts +158 -0
  23. package/src/boot/bucket-switch.saga.ts +115 -0
  24. package/src/boot/preload.saga.test.ts +51 -0
  25. package/src/boot/preload.saga.ts +31 -0
  26. package/src/bucket-blurhash.test.ts +148 -0
  27. package/src/build-globals.d.ts +12 -0
  28. package/src/client/bucket-handle.test.ts +117 -0
  29. package/src/client/bucket-handle.ts +227 -0
  30. package/src/client/router.test.ts +56 -0
  31. package/src/client/router.ts +94 -0
  32. package/src/client/runtime.test.ts +192 -0
  33. package/src/client/runtime.ts +296 -0
  34. package/src/client/services.ts +349 -0
  35. package/src/client/sp00ky-client.test.ts +241 -0
  36. package/src/client/sp00ky-client.ts +482 -0
  37. package/src/events/events.test.ts +2 -1
  38. package/src/events/index.ts +3 -0
  39. package/src/index.ts +37 -2
  40. package/src/kernel/constants.test.ts +19 -0
  41. package/src/kernel/constants.ts +54 -0
  42. package/src/kernel/effects.test.ts +40 -0
  43. package/src/kernel/effects.ts +159 -0
  44. package/src/kernel/events.ts +55 -0
  45. package/src/kernel/interpreter.test.ts +116 -0
  46. package/src/kernel/interpreter.ts +143 -0
  47. package/src/kernel/saga.test.ts +89 -0
  48. package/src/kernel/saga.ts +73 -0
  49. package/src/modules/app-release/index.test.ts +125 -0
  50. package/src/modules/app-release/index.ts +209 -0
  51. package/src/modules/auth/auth.local-first.test.ts +141 -0
  52. package/src/modules/auth/events/index.ts +2 -1
  53. package/src/modules/auth/index.ts +138 -25
  54. package/src/modules/crdt/crdt-field.ts +294 -0
  55. package/src/modules/crdt/crdt-hydration.test.ts +210 -0
  56. package/src/modules/crdt/crdt-reconnect.test.ts +195 -0
  57. package/src/modules/crdt/index.ts +463 -0
  58. package/src/modules/crdt/loro-loader.ts +25 -0
  59. package/src/modules/devtools/flags.ts +349 -0
  60. package/src/modules/devtools/index.ts +459 -47
  61. package/src/modules/devtools/notify-throttle.test.ts +154 -0
  62. package/src/modules/devtools/state-shape.test.ts +149 -0
  63. package/src/modules/devtools/storage-info.test.ts +79 -0
  64. package/src/modules/devtools/storage-info.ts +168 -0
  65. package/src/modules/devtools/versions.test.ts +74 -0
  66. package/src/modules/devtools/versions.ts +110 -0
  67. package/src/modules/feature-flag/index.test.ts +251 -0
  68. package/src/modules/feature-flag/index.ts +316 -0
  69. package/src/modules/ref-tables.test.ts +91 -0
  70. package/src/modules/ref-tables.ts +88 -0
  71. package/src/mutation/jobs.test.ts +25 -0
  72. package/src/mutation/jobs.ts +41 -0
  73. package/src/mutation/mutation-id.test.ts +37 -0
  74. package/src/mutation/mutation-id.ts +35 -0
  75. package/src/mutation/push.saga.test.ts +285 -0
  76. package/src/mutation/push.saga.ts +215 -0
  77. package/src/mutation/rows.test.ts +201 -0
  78. package/src/mutation/rows.ts +377 -0
  79. package/src/mutation/tray.saga.test.ts +63 -0
  80. package/src/mutation/tray.saga.ts +48 -0
  81. package/src/mutation/write.saga.test.ts +163 -0
  82. package/src/mutation/write.saga.ts +166 -0
  83. package/src/otel/index.ts +13 -10
  84. package/src/query/env.test.ts +23 -0
  85. package/src/query/env.ts +56 -0
  86. package/src/query/fetch.saga.test.ts +156 -0
  87. package/src/query/fetch.saga.ts +109 -0
  88. package/src/query/hash.test.ts +14 -0
  89. package/src/query/hash.ts +18 -0
  90. package/src/query/id-set-plan.test.ts +132 -0
  91. package/src/query/lifecycle.saga.test.ts +122 -0
  92. package/src/query/lifecycle.saga.ts +101 -0
  93. package/src/query/materialize.saga.test.ts +82 -0
  94. package/src/query/materialize.saga.ts +75 -0
  95. package/src/query/materialize.test.ts +50 -0
  96. package/src/query/materialize.ts +44 -0
  97. package/src/query/membership.saga.test.ts +246 -0
  98. package/src/query/membership.saga.ts +208 -0
  99. package/src/query/membership.test.ts +118 -0
  100. package/src/query/membership.ts +158 -0
  101. package/src/query/register.saga.test.ts +251 -0
  102. package/src/query/register.saga.ts +190 -0
  103. package/src/query/render-set.test.ts +36 -0
  104. package/src/query/render-set.ts +60 -0
  105. package/src/query/sql.test.ts +62 -0
  106. package/src/query/sql.ts +79 -0
  107. package/src/query/window-query.test.ts +70 -0
  108. package/src/query/window-query.ts +195 -0
  109. package/src/services/blobs/blob-cache.test.ts +359 -0
  110. package/src/services/blobs/blob-cache.ts +603 -0
  111. package/src/services/blobs/blob-manifest.ts +227 -0
  112. package/src/services/blobs/blob-store.test.ts +77 -0
  113. package/src/services/blobs/blob-store.ts +359 -0
  114. package/src/services/blobs/blob.fixture.ts +90 -0
  115. package/src/services/blobs/index.ts +70 -0
  116. package/src/services/database/cache-engine.ts +193 -0
  117. package/src/services/database/connection-supervisor.test.ts +318 -0
  118. package/src/services/database/connection-supervisor.ts +422 -0
  119. package/src/services/database/database.query-timeout.test.ts +140 -0
  120. package/src/services/database/database.responses.test.ts +43 -0
  121. package/src/services/database/database.ts +145 -62
  122. package/src/services/database/engine-factory.ts +33 -0
  123. package/src/services/database/errors.ts +34 -0
  124. package/src/services/database/events/index.ts +2 -1
  125. package/src/services/database/index.ts +7 -0
  126. package/src/services/database/local-migrator.ts +30 -27
  127. package/src/services/database/local.test.ts +64 -0
  128. package/src/services/database/local.ts +484 -67
  129. package/src/services/database/plan-render.test.ts +159 -0
  130. package/src/services/database/plan-render.ts +108 -0
  131. package/src/services/database/relation-resolver.test.ts +467 -0
  132. package/src/services/database/relation-resolver.ts +0 -0
  133. package/src/services/database/remote.ts +222 -15
  134. package/src/services/database/sqlite-cache-engine.test.ts +617 -0
  135. package/src/services/database/sqlite-cache-engine.timeout.test.ts +61 -0
  136. package/src/services/database/sqlite-cache-engine.ts +1349 -0
  137. package/src/services/database/sqlite-devtools-queries.integration.test.ts +143 -0
  138. package/src/services/database/sqlite-devtools-queries.test.ts +154 -0
  139. package/src/services/database/sqlite-lock-verify.test.ts +33 -0
  140. package/src/services/database/sqlite-lock-verify.ts +45 -0
  141. package/src/services/database/sqlite-open.test.ts +150 -0
  142. package/src/services/database/sqlite-open.ts +164 -0
  143. package/src/services/database/sqlite-plan-sql.test.ts +104 -0
  144. package/src/services/database/sqlite-plan-sql.ts +138 -0
  145. package/src/services/database/sqlite-projection.test.ts +99 -0
  146. package/src/services/database/sqlite-select.integration.test.ts +185 -0
  147. package/src/services/database/sqlite-select.test.ts +246 -0
  148. package/src/services/database/sqlite-select.ts +131 -0
  149. package/src/services/database/sqlite-transport.fixture.ts +30 -0
  150. package/src/services/database/sqlite-transport.ts +224 -0
  151. package/src/services/database/sqlite-worker.ts +437 -0
  152. package/src/services/database/surql-translate.ts +416 -0
  153. package/src/services/database/surreal-cache-engine.ts +161 -0
  154. package/src/services/logger/index.ts +3 -2
  155. package/src/services/persistence/localstorage.ts +2 -2
  156. package/src/services/persistence/resilient.ts +11 -4
  157. package/src/services/persistence/surrealdb.ts +10 -10
  158. package/src/services/stream-processor/index.ts +796 -84
  159. package/src/services/stream-processor/permissions.test.ts +47 -0
  160. package/src/services/stream-processor/permissions.ts +53 -0
  161. package/src/services/stream-processor/stream-processor.batch.test.ts +186 -0
  162. package/src/services/stream-processor/stream-processor.prime.test.ts +198 -0
  163. package/src/services/stream-processor/stream-processor.reset.test.ts +226 -0
  164. package/src/services/stream-processor/stream-processor.test.ts +1 -1
  165. package/src/services/stream-processor/wasm-types.ts +59 -3
  166. package/src/services/tabs/broker-client.ts +283 -0
  167. package/src/services/tabs/broker.test.ts +327 -0
  168. package/src/services/tabs/coordinator.test.ts +365 -0
  169. package/src/services/tabs/coordinator.ts +633 -0
  170. package/src/services/tabs/fake-ports.fixture.ts +112 -0
  171. package/src/services/tabs/leader-locks.ts +75 -0
  172. package/src/services/tabs/protocol.ts +262 -0
  173. package/src/services/tabs/support.ts +36 -0
  174. package/src/services/tabs/tabs-broker-worker.ts +640 -0
  175. package/src/sp00ky.ts +5 -0
  176. package/src/state/client-state.ts +184 -0
  177. package/src/state/lifecycle.test.ts +118 -0
  178. package/src/state/lifecycle.ts +86 -0
  179. package/src/state/reducers.test.ts +280 -0
  180. package/src/state/reducers.ts +476 -0
  181. package/src/state/selectors.test.ts +149 -0
  182. package/src/state/selectors.ts +184 -0
  183. package/src/sync/connection.saga.test.ts +86 -0
  184. package/src/sync/connection.saga.ts +85 -0
  185. package/src/sync/live.saga.test.ts +69 -0
  186. package/src/sync/live.saga.ts +49 -0
  187. package/src/sync/policy.health.test.ts +56 -0
  188. package/src/sync/policy.test.ts +659 -0
  189. package/src/sync/policy.ts +502 -0
  190. package/src/sync/poll.saga.test.ts +51 -0
  191. package/src/sync/poll.saga.ts +36 -0
  192. package/src/sync/tabs.saga.test.ts +74 -0
  193. package/src/sync/tabs.saga.ts +92 -0
  194. package/src/testing/adapters.ts +133 -0
  195. package/src/testing/build.ts +61 -0
  196. package/src/testing/fake-services.ts +34 -0
  197. package/src/testing/run-pure.test.ts +92 -0
  198. package/src/testing/run-pure.ts +128 -0
  199. package/src/testing/services.ts +17 -0
  200. package/src/types.ts +550 -14
  201. package/src/utils/blurhash.ts +90 -0
  202. package/src/utils/error-classification.test.ts +54 -0
  203. package/src/utils/error-classification.ts +25 -0
  204. package/src/utils/index.ts +79 -13
  205. package/src/utils/parser.test.ts +49 -120
  206. package/src/utils/parser.ts +32 -2
  207. package/src/utils/semver.test.ts +32 -0
  208. package/src/utils/semver.ts +30 -0
  209. package/src/utils/surql.ts +30 -18
  210. package/src/utils/utils.test.ts +2 -1
  211. package/src/utils/withRetry.test.ts +1 -1
  212. package/tsdown.config.ts +86 -1
  213. package/vitest.config.ts +48 -0
  214. package/src/modules/cache/index.ts +0 -241
  215. package/src/modules/cache/types.ts +0 -19
  216. package/src/modules/data/data.test.ts +0 -58
  217. package/src/modules/data/index.ts +0 -864
  218. package/src/modules/sync/engine.ts +0 -166
  219. package/src/modules/sync/events/index.ts +0 -77
  220. package/src/modules/sync/index.ts +0 -3
  221. package/src/modules/sync/queue/index.ts +0 -2
  222. package/src/modules/sync/queue/queue-down.ts +0 -89
  223. package/src/modules/sync/queue/queue-up.ts +0 -223
  224. package/src/modules/sync/scheduler.ts +0 -84
  225. package/src/modules/sync/sync.ts +0 -409
  226. package/src/modules/sync/utils.test.ts +0 -311
  227. package/src/modules/sync/utils.ts +0 -170
  228. package/src/spooky.ts +0 -395
package/src/types.ts CHANGED
@@ -1,9 +1,9 @@
1
- import { RecordId, SchemaStructure } from '@spooky-sync/query-builder';
2
- import { Level, type LoggerOptions } from 'pino';
3
- import { PushEventOptions } from './events/index';
4
- import { UpEvent } from './modules/sync/index';
1
+ import type { RecordId, SchemaStructure, QueryPlan } from '@spooky-sync/query-builder';
2
+ import type { Level, LoggerOptions } from 'pino';
3
+ import type { PushEventOptions } from './events/index';
4
+ import type { LocalEngineChoice } from './services/database/cache-engine';
5
5
 
6
- export type { Level } from 'pino';
6
+ export type { Level };
7
7
 
8
8
  /**
9
9
  * A pino browser transmit object for forwarding logs to an external sink (e.g. OpenTelemetry).
@@ -67,25 +67,45 @@ export type QueryTimeToLive =
67
67
  | '12h'
68
68
  | '1d';
69
69
 
70
+ /**
71
+ * Refresh behavior for `preload` when the data is already cached locally (warm).
72
+ * The FIRST load (cold) always fetches + blocks regardless.
73
+ * - `onUse` (default): do nothing when warm — the data freshens on use, when the
74
+ * real `useQuery` mounts and registers its live view. No network on load.
75
+ * - `background`: return instantly, but kick a one-time silent refetch.
76
+ * - `stale`: like `background`, but only if the cached copy is older than
77
+ * `staleTime`.
78
+ */
79
+ export type PreloadRefresh = 'onUse' | 'background' | 'stale';
80
+
81
+ export interface PreloadOptions {
82
+ /** Abort a cold preload that is still waiting for the server. */
83
+ signal?: AbortSignal;
84
+ /** @deprecated Preload is a registered query now; a warm preload never refetches by itself. Ignored. */
85
+ refresh?: PreloadRefresh;
86
+ /** @deprecated Ignored. */
87
+ staleTime?: QueryTimeToLive;
88
+ }
89
+
70
90
  /**
71
91
  * Result object returned when a query is registered or executed.
72
92
  */
73
- export interface SpookyQueryResult {
93
+ export interface Sp00kyQueryResult {
74
94
  /** The unique hash identifier for the query. */
75
95
  hash: string;
76
96
  }
77
97
 
78
- export type SpookyQueryResultPromise = Promise<SpookyQueryResult>;
98
+ export type Sp00kyQueryResultPromise = Promise<Sp00kyQueryResult>;
79
99
 
80
100
  export interface EventSubscriptionOptions {
81
101
  priority?: number;
82
102
  }
83
103
 
84
104
  /**
85
- * Configuration options for the Spooky client.
105
+ * Configuration options for the Sp00ky client.
86
106
  * @template S The schema structure type.
87
107
  */
88
- export interface SpookyConfig<S extends SchemaStructure> {
108
+ export interface Sp00kyConfig<S extends SchemaStructure> {
89
109
  /** Database connection configuration. */
90
110
  database: {
91
111
  /** The SurrealDB endpoint URL. */
@@ -98,9 +118,40 @@ export interface SpookyConfig<S extends SchemaStructure> {
98
118
  store?: StoreType;
99
119
  /** Authentication token. */
100
120
  token?: string;
121
+ /**
122
+ * SQLite engine only: execute `select` plans (base rows + relation tree +
123
+ * row parsing) inside the worker as ONE round-trip instead of one hop per
124
+ * table/relation level. Defaults to true; set false to force the legacy
125
+ * multi-hop path (escape hatch while the worker-side path beds in).
126
+ */
127
+ workerSelect?: boolean;
128
+ /**
129
+ * WebSocket reconnect + liveness tuning. All fields optional; the defaults
130
+ * keep the connection alive indefinitely without configuration. See
131
+ * {@link ReconnectConfig}.
132
+ */
133
+ reconnect?: ReconnectConfig;
134
+ /**
135
+ * Deadline (ms) for every remote RPC. Remote queries are serialized through
136
+ * a single promise chain, so one call that never settles (half-open socket:
137
+ * the WebSocket looks open, the peer is gone, no `close` event fires) would
138
+ * otherwise wedge ALL later remote traffic behind it — including the sync
139
+ * poll's own health probe, leaving health pinned at `healthy` with no
140
+ * banner and no self-heal. The deadline turns that into an ordinary network
141
+ * failure the queue retries. `0` disables. Defaults to `60_000`.
142
+ */
143
+ queryTimeoutMs?: number;
144
+ /**
145
+ * Deadline (ms) for every LOCAL store operation (a SQLite worker round trip,
146
+ * or a query on the in-process surrealdb engine). Local ops are serialized
147
+ * too, and one that never answered - a worker starved behind a long select,
148
+ * a lock verification with no clock - left every `db.create`/`db.update`
149
+ * promise pending for the tab's lifetime. On expiry the call rejects with
150
+ * `LocalOpTimeoutError` (the op itself keeps running in the engine and is
151
+ * not retried). `0` disables. Defaults to `30_000`.
152
+ */
153
+ localOpTimeoutMs?: number;
101
154
  };
102
- /** Unique client identifier. If not provided, one will be generated. */
103
- clientId?: string;
104
155
  /** The schema definition. */
105
156
  schema: S;
106
157
  /** The compiled SURQL schema string. */
@@ -112,13 +163,308 @@ export interface SpookyConfig<S extends SchemaStructure> {
112
163
  * Can be a custom implementation, 'surrealdb' (default), or 'localstorage'.
113
164
  */
114
165
  persistenceClient?: PersistenceClient | 'surrealdb' | 'localstorage';
166
+ /**
167
+ * Local cache engine backend. `'surrealdb'` (default) uses the in-browser
168
+ * SurrealDB-WASM store; `'sqlite'` uses official SQLite-WASM in a Worker with
169
+ * OPFS persistence; or pass a custom {@link LocalCacheEngine}. The local cache
170
+ * is a passive queryable store — reactivity is driven by the remote SSP, not
171
+ * this engine. See `services/database/cache-engine.ts`.
172
+ */
173
+ localEngine?: LocalEngineChoice;
174
+ /**
175
+ * Durable cache for bucket file bytes, in OPFS. Enabled by default wherever
176
+ * OPFS is writable; elsewhere the cache degrades to per-tab memory, which is
177
+ * how bucket reads behaved before it existed.
178
+ *
179
+ * Nothing in this cache expires on a timer — an image whose row is still in
180
+ * the local store has to stay available offline. Bytes are only dropped when
181
+ * the app invalidates the path (`bucket.put`/`bucket.delete`), when boot
182
+ * reconcile finds no file behind a row, or when the cache is over budget, in
183
+ * which case the least-recently-used unpinned entries go first. See
184
+ * `services/blobs/blob-cache.ts`.
185
+ */
186
+ blobCache?: {
187
+ /** Default `true`. `false` restores per-tab, non-persistent caching. */
188
+ enabled?: boolean;
189
+ /** Byte budget. Defaults to `min(512 MB, quota × 0.25)` from
190
+ * `navigator.storage.estimate()`. */
191
+ maxBytes?: number;
192
+ /**
193
+ * Delete the signed-out user's cached bytes on `signOut()`. Default
194
+ * `false`, matching the local store: cached files are namespaced per local
195
+ * bucket, so signing back in is warm and no user can read another's cache.
196
+ * Turn on for shared devices.
197
+ */
198
+ clearOnSignOut?: boolean;
199
+ };
200
+ /**
201
+ * Share ONE durable local store across all tabs of this origin (default
202
+ * `false`). Requires `localEngine: 'sqlite'`. A SharedWorker broker elects a
203
+ * leader tab per bucket via Web Locks; the leader owns the OPFS SQLite
204
+ * worker and the sync loop, and follower tabs read/write the same store over
205
+ * MessagePorts, so every tab is durable instead of only the first one.
206
+ *
207
+ * Falls back to solo mode (exactly the flag-off behavior, including the
208
+ * later-tabs in-memory fallback reported via {@link StorageHealth}) whenever
209
+ * SharedWorker, Web Locks, or MessageChannel are unavailable, the engine is
210
+ * not sqlite, or the broker rejects the tab (mixed app versions).
211
+ *
212
+ * Failover: when the leader tab closes or freezes, a follower is promoted
213
+ * within seconds; queries briefly refetch and mutations are never lost once
214
+ * their local write resolved (the shared outbox survives in the store).
215
+ * Inspect via `window.__00__.getState().database.tabs` and `__sqliteStats`.
216
+ */
217
+ sharedTabs?: boolean;
218
+ /**
219
+ * Persist the in-browser SSP circuit's store as a snapshot in the local
220
+ * store, so a reload restores it and only steps in what changed since.
221
+ * Defaults to `true` under `localEngine: 'sqlite'` (the OPFS-backed store
222
+ * can hold the bytes) and `false` otherwise.
223
+ *
224
+ * Without a snapshot the circuit is primed by reading every cached row back
225
+ * out of the local store; either way a reload never re-downloads the working
226
+ * set, which is what an empty circuit used to force: every id in the
227
+ * server's list_ref classified as missing.
228
+ *
229
+ * Snapshots are store-only (views are re-registered per session) and written
230
+ * on a checkpoint interval ({@link circuitCheckpointMs}) and when the page
231
+ * goes hidden, never per ingest or per query registration.
232
+ */
233
+ persistCircuit?: boolean;
234
+ /**
235
+ * Checkpoint interval in milliseconds for {@link persistCircuit}. Defaults to
236
+ * 30000. Ignored when `persistCircuit` is off.
237
+ */
238
+ circuitCheckpointMs?: number;
239
+ /**
240
+ * Keep only the fields registered queries evaluate (filter predicates, join
241
+ * keys, sort keys, plus `id`/`_00_rv`) per row in the in-browser circuit.
242
+ * Default `true`. The circuit only ever reads those fields; bodies are
243
+ * rendered from the local store. Measured on 7700 rows with 20 KB bodies:
244
+ * the wasm heap peak went from ~500 MB to ~24 MB and the snapshot from
245
+ * 156 MB to 1.2 MB. A query that evaluates a field earlier rows were kept
246
+ * without has that field merged in from the local store on registration.
247
+ */
248
+ circuitProjection?: boolean;
115
249
  /** A pino browser transmit object for forwarding logs (e.g. via @spooky-sync/core/otel). */
116
250
  otelTransmit?: PinoTransmit;
117
251
  /**
118
- * Debounce time in milliseconds for stream updates.
119
- * Defaults to 100ms.
252
+ * Debounce time in milliseconds for stream updates (the client-side SSP
253
+ * aggregation throttle — coalesces the in-browser StreamProcessor's
254
+ * per-record updates per query before notifying readers).
255
+ * Defaults to 50ms.
120
256
  */
121
257
  streamDebounceTime?: number;
258
+ /**
259
+ * Debounce time in milliseconds for syncing collaborative (CRDT) field
260
+ * changes to the remote database. Local writes happen immediately on
261
+ * every keystroke (so reload/offline works), but the remote UPSERT is
262
+ * coalesced over this window. Lower = snappier remote propagation +
263
+ * more network traffic; higher = less traffic + more lag for other
264
+ * collaborators. Defaults to 500ms.
265
+ */
266
+ crdtDebounceMs?: number;
267
+ /**
268
+ * Enable collaborative CRDT fields. When `true`, the `loro-crdt` engine is
269
+ * preloaded at client startup (fetched as a separate chunk on page load) so
270
+ * the first `openCrdtField` is instant. When omitted/`false`, loro is never
271
+ * loaded unless a CRDT field is explicitly opened — keeping the loro chunk
272
+ * out of apps that don't use collaboration. Defaults to `false`.
273
+ */
274
+ crdt?: boolean;
275
+ /**
276
+ * Cadence (ms) for the `_00_list_ref` poll that catches cross-session
277
+ * UPDATEs the SurrealDB v3 LIVE-permission gap drops. Lower = faster
278
+ * convergence + more query load; higher = the inverse. Non-positive
279
+ * values fall back to the default (500ms).
280
+ */
281
+ refSyncIntervalMs?: number;
282
+ /**
283
+ * OPT-IN instant-hydrate for cold queries: when enabled and a query is
284
+ * registered with no server result yet, its surql also runs directly on the
285
+ * remote (one-shot, in the background, OFF the paint path) so rows can land
286
+ * before the full register lifecycle completes. Hydrated rows carry their
287
+ * `_00_rv` versions so the registration's `syncRecords` skips re-pulling
288
+ * unchanged bodies. Regardless of this flag, `useQuery` always resolves and
289
+ * paints from the local cache immediately — however the rows got there
290
+ * (preload, prior sync). Default `false`: the register lifecycle
291
+ * (`fn::query::register` → `_00_list_ref` → record sync) is the single
292
+ * freshness path and no duplicate one-shot fetches are made.
293
+ */
294
+ instantHydrate?: boolean;
295
+ /**
296
+ * Enable realtime sync while signed out. When `true`, the client starts its
297
+ * `_00_list_ref` poll (and a LIVE subscription) against the shared
298
+ * `_00_list_ref_anon` table even with no authenticated user, so a logged-out
299
+ * page gets live `useQuery` updates over world-readable tables. Requires the
300
+ * server to be deployed with `anonymousLiveQueries: true` in `sp00ky.yml`
301
+ * (this flag must match it). Defaults to `false`: anonymous clients can read
302
+ * one-shot but never sync live.
303
+ */
304
+ enableAnonymousLiveQueries?: boolean;
305
+ /**
306
+ * Surface sustained sync failures as a "degraded" health status that the app
307
+ * can observe via `subscribeToSyncHealth` (or the client-solid
308
+ * `useSyncStatus` hook) to render a "can't reach the server" banner.
309
+ *
310
+ * Individual failures — a transient remote 500 on query registration, a
311
+ * dropped WebSocket, etc. — are always swallowed and retried; they never
312
+ * throw at the app. This only controls when a *run* of consecutive failures
313
+ * is reported. Status flips back to `healthy` on the next successful sync
314
+ * round. Defaults to `{ degradeAfterConsecutiveFailures: 3 }`; pass `false`
315
+ * (or `degradeAfterConsecutiveFailures: 0`) to never report degraded.
316
+ */
317
+ syncHealth?: SyncHealthConfig | false;
318
+ /**
319
+ * Automatic blurhash placeholders for bucket image uploads. On every
320
+ * `bucket.put` of an image path (by extension: webp/png/jpg/jpeg/gif/avif/bmp)
321
+ * the client computes a blurhash and stores it as a tiny sidecar object
322
+ * `<path>.bh` in the same bucket, best-effort. Read it back with
323
+ * `bucket.blurhash(path)` (or the client-solid `useBucketImage`/`BucketImage`
324
+ * helpers) to paint a placeholder until the image is decoded.
325
+ *
326
+ * `true` (the default) enables with 4x3 components; pass
327
+ * `{ componentX, componentY }` to tune detail, or `false` to disable.
328
+ * A per-call `put(path, content, { blurhash })` option overrides this.
329
+ */
330
+ blurhash?: boolean | { componentX?: number; componentY?: number };
331
+ /**
332
+ * Deadline (ms) for a single outgoing mutation push. Tighter than
333
+ * {@link Sp00kyConfig.database.queryTimeoutMs} because the up-queue drains
334
+ * one mutation at a time behind an `isSyncingUp` flag: a push that never
335
+ * settles stops every later mutation for the session, with no retry and no
336
+ * error. On expiry the push is treated as a network failure and re-queued.
337
+ * `0` disables. Defaults to `30_000`.
338
+ */
339
+ pushTimeoutMs?: number;
340
+ /**
341
+ * Max time a single down event (`register`/`sync`/`cleanup`) may take before
342
+ * it is retried. Mirror of {@link pushTimeoutMs} for the read side.
343
+ * Defaults to 30000; `0` disables the timeout.
344
+ */
345
+ downTimeoutMs?: number;
346
+ }
347
+
348
+ /** Tunables for sync-health reporting. See {@link Sp00kyConfig.syncHealth}. */
349
+ export interface SyncHealthConfig {
350
+ /**
351
+ * Number of consecutive failed sync rounds (up or down) before the status
352
+ * flips from `healthy` to `degraded`. A single transient failure is absorbed
353
+ * by the retry; only a sustained run trips the banner. Defaults to `3`. `0`
354
+ * disables degraded reporting entirely.
355
+ */
356
+ degradeAfterConsecutiveFailures?: number;
357
+ }
358
+
359
+ /**
360
+ * Tunables for WebSocket reconnect and liveness detection. See
361
+ * {@link Sp00kyConfig.database.reconnect}.
362
+ *
363
+ * Two independent mechanisms cooperate here. The SurrealDB SDK reconnects on
364
+ * its own after a socket `close` (`attempts` / `retryDelayMax`), and a
365
+ * supervisor above it re-opens the connection from scratch whenever the SDK
366
+ * gives up or its post-reconnect handshake fails — the SDK terminates the
367
+ * engine permanently in that case, so a supervisor is required, not optional.
368
+ * The heartbeat covers the third case: a socket that never closes at all.
369
+ */
370
+ export interface ReconnectConfig {
371
+ /**
372
+ * SDK reconnect attempts after a socket close. `-1` retries forever.
373
+ * Defaults to `-1` (the SDK's own default is `5`, which caps recovery at a
374
+ * ~62s outage and then gives up for the life of the page).
375
+ */
376
+ attempts?: number;
377
+ /** Cap on the SDK's exponential backoff delay. Defaults to `15_000`. */
378
+ retryDelayMax?: number;
379
+ /**
380
+ * Cadence of the application-level liveness probe (`RETURN true`) that
381
+ * detects a half-open socket the transport never reports as closed.
382
+ * `0` disables the heartbeat. Defaults to `20_000`.
383
+ */
384
+ heartbeatIntervalMs?: number;
385
+ /**
386
+ * Deadline for a heartbeat response. Exceeding it means the socket is dead
387
+ * regardless of what its `readyState` claims, so the connection is torn down
388
+ * and rebuilt. Defaults to `10_000`.
389
+ */
390
+ heartbeatTimeoutMs?: number;
391
+ /**
392
+ * Cap on the supervisor's own backoff between `connect()` retries once the
393
+ * SDK has given up. Defaults to `15_000`.
394
+ */
395
+ superviseRetryDelayMaxMs?: number;
396
+ }
397
+
398
+ /**
399
+ * Transport-level connection state, independent of {@link SyncHealthStatus}.
400
+ *
401
+ * These answer different questions: `connection` is about the socket,
402
+ * `status` is about whether sync rounds are succeeding. A `connected` socket
403
+ * can still be `degraded` (server erroring), and a `reconnecting` socket is
404
+ * usually still `healthy` for the first few seconds.
405
+ */
406
+ export type ConnectionState = 'connecting' | 'connected' | 'reconnecting' | 'disconnected';
407
+
408
+ export type SyncHealthStatus = 'healthy' | 'degraded';
409
+
410
+ /** Snapshot of sync health delivered to `subscribeToSyncHealth` subscribers. */
411
+ export interface SyncHealth {
412
+ /** `'degraded'` once consecutive failures cross the configured threshold. */
413
+ status: SyncHealthStatus;
414
+ /** Consecutive failed sync rounds at the moment of this report. */
415
+ consecutiveFailures: number;
416
+ /** Classification of the most recent failure (only set while `degraded`). */
417
+ kind?: 'network' | 'application';
418
+ /** Message of the most recent failure (only set while `degraded`). */
419
+ error?: string;
420
+ /**
421
+ * `true` once at least one sync round has succeeded this session. Lets a UI
422
+ * distinguish a first-time "connecting" phase (never reached the server yet,
423
+ * so a cold-start failure run is expected) from a real lost connection after
424
+ * a working session. Never resets back to `false` once set.
425
+ */
426
+ everConnected: boolean;
427
+ /**
428
+ * Live transport state of the remote WebSocket. Distinct from `status`: this
429
+ * one flips the instant the socket drops, whereas `status` only degrades
430
+ * after a sustained run of failed sync rounds. Use it to show "reconnecting…"
431
+ * immediately without waiting for the degrade threshold.
432
+ */
433
+ connection: ConnectionState;
434
+ }
435
+
436
+ export type StorageHealthStatus = 'unknown' | 'persistent' | 'memory';
437
+
438
+ /**
439
+ * Durability of the LOCAL cache, delivered to `subscribeToStorageHealth`
440
+ * subscribers. Separate from {@link SyncHealth}: that one is about reaching the
441
+ * server, this one is about whether the local store survives a reload.
442
+ *
443
+ * Under `localEngine: 'sqlite'` the durable store is the OPFS SAHPool VFS,
444
+ * which only one client per bucket can hold open. When it can't be opened (a
445
+ * second tab of the app already has it, an insecure context, a full pool) the
446
+ * engine keeps working against an in-memory DB, which holds the whole dataset
447
+ * in RAM and loses local writes on reload. `fallback` marks exactly that case,
448
+ * so a UI can warn about it.
449
+ */
450
+ export interface StorageHealth {
451
+ /** `'unknown'` until the local cache has opened, or for engines that don't report. */
452
+ status: StorageHealthStatus;
453
+ /**
454
+ * `true` only when durable storage was REQUESTED and could not be opened.
455
+ * Stays `false` for a configured-in-memory store (`store: 'memory'`), which
456
+ * is a choice rather than a failure, so a UI can key off this alone.
457
+ */
458
+ fallback: boolean;
459
+ /** Reason durable storage failed (only set while `fallback` is `true`). */
460
+ error?: string;
461
+ /**
462
+ * Shared-tabs role, set only when `sharedTabs` is active: `'leader'` owns
463
+ * the OPFS worker, `'follower'` shares it over a MessagePort (its data IS
464
+ * durable, hence `status: 'persistent'`), `'solo'` fell back to the
465
+ * single-tab behavior. Absent entirely when the feature is off.
466
+ */
467
+ role?: 'leader' | 'follower' | 'solo';
122
468
  }
123
469
 
124
470
  export type QueryHash = string;
@@ -148,12 +494,50 @@ export interface QueryConfig {
148
494
  id: RecordId<string>;
149
495
  /** The SURQL query string. */
150
496
  surql: string;
497
+ /**
498
+ * Engine-neutral plan for `surql` (in-memory only; not persisted to
499
+ * `_00_query`). Present when the query came from the query-builder. Non-
500
+ * SurrealQL local engines (SQLite) materialize via `engine.select(plan)`
501
+ * instead of re-running `surql`, which they cannot parse.
502
+ */
503
+ plan?: QueryPlan;
151
504
  /** Parameters used in the query. */
152
505
  params: Record<string, any>;
153
506
  /** The version array representing the local state of results. */
154
507
  localArray: RecordVersionArray;
155
508
  /** The version array representing the remote (server) state of results. */
156
509
  remoteArray: RecordVersionArray;
510
+ /**
511
+ * In-memory only (never persisted to `_00_query`): version array of the
512
+ * subquery CHILD rows pulled via `parent IS NOT NONE` edges, so the
513
+ * child-body sync is idempotent across polls. Kept separate from
514
+ * `remoteArray` so related child rows never enter the primary window /
515
+ * `rowCount` / `localArray`.
516
+ */
517
+ subqueryRemoteArray?: RecordVersionArray;
518
+ /**
519
+ * Whether authoritative membership (`remoteArray`) has ever been established
520
+ * for this query — either fetched from `_00_list_ref` this session, or read
521
+ * back from the durable `_00_view` row on a cold start.
522
+ *
523
+ * Tri-state matters: "known and empty" must render an empty list, while
524
+ * "never established" has to fall back to a predicate scan of the local store
525
+ * so a query first run on this device still paints offline. A
526
+ * `remoteArray.length === 0` check cannot tell those apart.
527
+ *
528
+ * On a cold start it is seeded from the durable `_00_view` row when that
529
+ * row is non-empty, or empty but `confirmed` (the server reported zero rows
530
+ * for the query). An unconfirmed empty row is ignored, so a device poisoned
531
+ * by an old client that mirrored unflushed reads still self-heals.
532
+ */
533
+ membershipKnown?: boolean;
534
+ /**
535
+ * Key of this query's durable `_00_view` membership row: a hash of
536
+ * `{surql, params}` WITHOUT the `session::id()` salt that `id` carries, so it
537
+ * survives a reload (which mints a new session id) and a bucket switch.
538
+ * In-memory only.
539
+ */
540
+ membershipKey?: string;
157
541
  /** Time-To-Live for this query. */
158
542
  ttl: QueryTimeToLive;
159
543
  /** Timestamp when the query was last accessed/active. */
@@ -164,6 +548,42 @@ export interface QueryConfig {
164
548
 
165
549
  export type QueryConfigRecord = QueryConfig & { id: string };
166
550
 
551
+ /**
552
+ * Runtime fetch status of a live query.
553
+ * - `idle`: registered, initial sync completed, and not currently fetching
554
+ * missing records — the materialized rows are authoritative (a windowed
555
+ * query's short result really is the end of the list).
556
+ * - `fetching`: the query is registering (a query is born `fetching` until its
557
+ * initial remote sync completes) or the sync engine is fetching/ingesting
558
+ * missing records for it. Any pending debounced result is flushed BEFORE the
559
+ * flip back to `idle`, so idle status never races ahead of the rows.
560
+ */
561
+ export type QueryStatus = 'idle' | 'fetching';
562
+
563
+ /**
564
+ * What the server's `_00_query` row says about a view, read alongside its
565
+ * `_00_list_ref` edges (registration, the poll, a targeted re-read).
566
+ *
567
+ * - `present: false`: the row is not there (or not readable). The SSP no
568
+ * longer has this view: a TTL sweep, an SSP reset, a scheduler wipe. An
569
+ * empty edge set read at the same time is NOT "no rows", it is "no view".
570
+ * - `state: 'materializing'`: the SSP has (re)computed the set and its edges
571
+ * are in flight; an empty read is "not landed yet".
572
+ * - `state: 'ready'`: the edges are committed (flipped in the same
573
+ * transaction), so `rowCount === 0` with no edges is a real empty result.
574
+ * - `state: null`: a server that predates the marker; only `rowCount` can be
575
+ * used, with its `> 0` = flush window / `0` = empty ambiguity.
576
+ */
577
+ export interface ServerViewMeta {
578
+ present: boolean;
579
+ /** `_00_query.rowCount`; `null` when unreadable. */
580
+ rowCount: number | null;
581
+ state: 'materializing' | 'ready' | null;
582
+ }
583
+
584
+ /** Outcome of handing a server id-set to `DataModule.updateQueryRemoteArray`. */
585
+ export type MembershipOutcome = 'applied' | 'ignored' | 'view-lost';
586
+
167
587
  /**
168
588
  * Internal state of a live query.
169
589
  */
@@ -172,17 +592,126 @@ export interface QueryState {
172
592
  config: QueryConfig;
173
593
  /** The current cached records for this query. */
174
594
  records: Record<string, any>[];
595
+ /** Set once `applyHydration` has run for this query, so the cold instant-hydrate
596
+ * path fires at most once per query (see DataModule.isCold/applyHydration). */
597
+ hydrated?: boolean;
598
+ /** Set once a server-side membership set has been accepted this session
599
+ * (`updateQueryRemoteArray`). The `register` down-event is enqueued before
600
+ * the instant-hydrate, so a hydrate that finishes later must not prime
601
+ * membership over the authoritative set. Ephemeral. */
602
+ serverMembership?: boolean;
603
+ /**
604
+ * Set when the server's `_00_query` row for this query went missing while
605
+ * we held membership (TTL sweep, SSP reset, scheduler wipe). The view is
606
+ * being re-registered; until a readable row comes back, empty reads are
607
+ * NOT the server's answer and nothing is dropped. Ephemeral.
608
+ */
609
+ viewLost?: boolean;
610
+ /** Last `_00_query.state` read from the server, for DevTools. Ephemeral. */
611
+ serverState?: 'materializing' | 'ready' | null;
612
+ /** Set once `notifyQuerySynced` has emitted for this registration lifetime.
613
+ * Ephemeral (unlike the persisted `updateCount`), so a re-registered query
614
+ * always emits at least once even when its records are unchanged — otherwise
615
+ * an empty re-registered window would never notify and stay "loading". */
616
+ syncNotified?: boolean;
175
617
  /** Timer for TTL expiration. */
176
618
  ttlTimer: NodeJS.Timeout | null;
177
619
  /** TTL duration in milliseconds. */
178
620
  ttlDurationMs: number;
621
+ /** When the last TTL heartbeat for this query was sent (ms epoch); `undefined` before the first. */
622
+ lastHeartbeatAt?: number;
179
623
  /** Number of times the query has been updated. */
180
624
  updateCount: number;
625
+ /** Timestamp (ms) of the last user-visible update, or null before the first
626
+ * one. Surfaced to DevTools as `lastUpdate` — must NOT be stamped on read. */
627
+ lastUpdatedAt: number | null;
628
+ /**
629
+ * Rolling window of the most recent materialization-step latencies (ms).
630
+ * Capped at MATERIALIZATION_SAMPLE_WINDOW; used to recompute p55/p90/p99
631
+ * before each persist to `_00_query`. Samples themselves are not persisted.
632
+ */
633
+ materializationSamples: number[];
634
+ /** Most recent end-to-end ingest latency in ms, or null until the first ingest. */
635
+ lastIngestLatencyMs: number | null;
636
+ /** Cumulative count of ingest/materialization errors observed for this query. */
637
+ errorCount: number;
638
+ /**
639
+ * Ephemeral runtime fetch status. Not persisted to `_00_query`; observable
640
+ * via DevTools and the `useQuery` hook. `fetching` while the sync engine is
641
+ * pulling missing records for this query, otherwise `idle`.
642
+ */
643
+ status: QueryStatus;
644
+ /**
645
+ * Rolling per-phase timing samples (ms), in addition to `materializationSamples`
646
+ * (which holds the SSP whole-ingest wall time). Keyed by `TimingPhase` minus
647
+ * `ssp`. Not persisted — surfaced live to DevTools + MCP via `phaseTimings`.
648
+ */
649
+ phaseSamples: Record<string, number[]>;
650
+ /** Most recent sample (ms) per phase, or null. */
651
+ phaseLast: Record<string, number | null>;
652
+ /** One-shot SSP registration timings (ms). */
653
+ registrationTimings: RegistrationTimings;
654
+ }
655
+
656
+ /** Cap on the rolling materialization-sample window kept per query in memory. */
657
+ export const MATERIALIZATION_SAMPLE_WINDOW = 100;
658
+
659
+ /** Timed processing phases surfaced per query. `ssp` is the WASM-ingest wall
660
+ * time; the `ssp*` phases are its internal breakdown from the SSP binding. */
661
+ export type TimingPhase =
662
+ | 'ssp'
663
+ | 'sspStoreApply'
664
+ | 'sspCircuitStep'
665
+ | 'sspTransform'
666
+ | 'localFetch'
667
+ | 'remoteFetch'
668
+ | 'frontend';
669
+
670
+ /** One-shot registration timings (ms), captured once when a query registers. */
671
+ export interface RegistrationTimings {
672
+ /** SSP surql→plan parse + permission injection. */
673
+ parseMs: number | null;
674
+ /** SSP operator-DAG build. */
675
+ planMs: number | null;
676
+ /** SSP initial snapshot evaluation. */
677
+ snapshotMs: number | null;
678
+ /** Wall time of `cache.registerQuery` (register_view round-trip). */
679
+ wallMs: number | null;
680
+ }
681
+
682
+ /** Percentile summary for one timed phase, surfaced to DevTools + MCP. */
683
+ export interface PhaseStat {
684
+ lastMs: number | null;
685
+ p50: number | null;
686
+ p90: number | null;
687
+ p99: number | null;
688
+ count: number;
689
+ }
690
+
691
+ /** Per-query processing-time breakdown surfaced via DevTools panel + MCP. */
692
+ export interface QueryTimings {
693
+ ssp: PhaseStat;
694
+ sspStoreApply: PhaseStat;
695
+ sspCircuitStep: PhaseStat;
696
+ sspTransform: PhaseStat;
697
+ localFetch: PhaseStat;
698
+ remoteFetch: PhaseStat;
699
+ frontend: PhaseStat;
700
+ registration: RegistrationTimings;
701
+ updateCount: number;
702
+ errorCount: number;
181
703
  }
182
704
 
183
705
  // Callback types
184
706
  export type QueryUpdateCallback = (records: Record<string, any>[]) => void;
185
- export type MutationCallback = (mutations: UpEvent[]) => void;
707
+ export type QueryStatusCallback = (status: QueryStatus) => void;
708
+ /**
709
+ * Observer for a query's authority flips: `true` once server membership is
710
+ * known for it (registration, poll, durable seed), `false` when it is reset
711
+ * (bucket switch). What the bindings' `isAuthoritative()` mirrors.
712
+ */
713
+ export type QueryAuthorityCallback = (known: boolean) => void;
714
+ export type MutationCallback = (mutations: MutationEvent[]) => void;
186
715
 
187
716
  export type MutationEventType = 'create' | 'update' | 'delete';
188
717
 
@@ -214,6 +743,13 @@ export interface RunOptions {
214
743
  assignedTo?: string;
215
744
  max_retries?: number;
216
745
  retry_strategy?: 'linear' | 'exponential';
746
+ /** Timeout in seconds for the backend HTTP call. Only used if the backend allows timeout override. */
747
+ timeout?: number;
748
+ /**
749
+ * Minimum delay in milliseconds before the job is eligible to run. While
750
+ * delayed the job stays pending (enqueued) and can still be killed.
751
+ */
752
+ delay?: number;
217
753
  }
218
754
 
219
755
  /**