@spooky-sync/core 0.0.1-canary.22 → 0.0.1-canary.220

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 (163) hide show
  1. package/AGENTS.md +57 -0
  2. package/dist/index.d.ts +2601 -58
  3. package/dist/index.js +12696 -2426
  4. package/dist/otel/index.d.ts +2 -2
  5. package/dist/otel/index.js +6 -6
  6. package/dist/sqlite-open.js +303 -0
  7. package/dist/sqlite-worker.d.ts +1 -0
  8. package/dist/sqlite-worker.js +439 -0
  9. package/dist/tabs-broker-worker.d.ts +8 -0
  10. package/dist/tabs-broker-worker.js +472 -0
  11. package/dist/types.d.ts +751 -11
  12. package/package.json +11 -7
  13. package/scripts/check-broker-bundle.mjs +33 -0
  14. package/skills/{spooky-core → sp00ky-core}/SKILL.md +12 -12
  15. package/skills/{spooky-core → sp00ky-core}/references/auth.md +1 -1
  16. package/skills/{spooky-core → sp00ky-core}/references/config.md +2 -2
  17. package/src/bucket-blurhash.test.ts +148 -0
  18. package/src/build-globals.d.ts +12 -0
  19. package/src/events/events.test.ts +2 -1
  20. package/src/events/index.ts +3 -0
  21. package/src/index.ts +36 -2
  22. package/src/modules/app-release/index.test.ts +125 -0
  23. package/src/modules/app-release/index.ts +201 -0
  24. package/src/modules/auth/auth.local-first.test.ts +141 -0
  25. package/src/modules/auth/events/index.ts +2 -1
  26. package/src/modules/auth/index.ts +138 -25
  27. package/src/modules/cache/cache.relay.test.ts +95 -0
  28. package/src/modules/cache/index.ts +163 -43
  29. package/src/modules/cache/types.ts +2 -2
  30. package/src/modules/crdt/crdt-field.ts +294 -0
  31. package/src/modules/crdt/crdt-hydration.test.ts +210 -0
  32. package/src/modules/crdt/crdt-reconnect.test.ts +195 -0
  33. package/src/modules/crdt/index.ts +463 -0
  34. package/src/modules/crdt/loro-loader.ts +25 -0
  35. package/src/modules/data/data.hydration.test.ts +142 -0
  36. package/src/modules/data/data.membership.test.ts +523 -0
  37. package/src/modules/data/data.notify-table.test.ts +41 -0
  38. package/src/modules/data/data.pending-ids.test.ts +199 -0
  39. package/src/modules/data/data.rebind.test.ts +170 -0
  40. package/src/modules/data/data.rematerialize.test.ts +114 -0
  41. package/src/modules/data/data.run.test.ts +113 -0
  42. package/src/modules/data/data.settled-writes.test.ts +206 -0
  43. package/src/modules/data/data.status.test.ts +249 -0
  44. package/src/modules/data/id-set-plan.test.ts +122 -0
  45. package/src/modules/data/index.ts +1815 -151
  46. package/src/modules/data/mutation-id.test.ts +25 -0
  47. package/src/modules/data/mutation-id.ts +35 -0
  48. package/src/modules/data/window-query.test.ts +52 -0
  49. package/src/modules/data/window-query.ts +194 -0
  50. package/src/modules/devtools/flags.ts +349 -0
  51. package/src/modules/devtools/index.ts +450 -46
  52. package/src/modules/devtools/notify-throttle.test.ts +154 -0
  53. package/src/modules/devtools/state-shape.test.ts +146 -0
  54. package/src/modules/devtools/storage-info.test.ts +79 -0
  55. package/src/modules/devtools/storage-info.ts +168 -0
  56. package/src/modules/devtools/versions.test.ts +74 -0
  57. package/src/modules/devtools/versions.ts +110 -0
  58. package/src/modules/feature-flag/index.test.ts +251 -0
  59. package/src/modules/feature-flag/index.ts +308 -0
  60. package/src/modules/ref-tables.test.ts +91 -0
  61. package/src/modules/ref-tables.ts +88 -0
  62. package/src/modules/sync/engine.ts +165 -86
  63. package/src/modules/sync/events/index.ts +9 -2
  64. package/src/modules/sync/queue/queue-down.test.ts +228 -0
  65. package/src/modules/sync/queue/queue-down.ts +108 -13
  66. package/src/modules/sync/queue/queue-up.forwarded.test.ts +164 -0
  67. package/src/modules/sync/queue/queue-up.ts +241 -57
  68. package/src/modules/sync/scheduler.pause.test.ts +109 -0
  69. package/src/modules/sync/scheduler.retry.test.ts +237 -0
  70. package/src/modules/sync/scheduler.ts +215 -13
  71. package/src/modules/sync/sync.cleanup.test.ts +116 -0
  72. package/src/modules/sync/sync.health.test.ts +149 -0
  73. package/src/modules/sync/sync.heartbeat.test.ts +80 -0
  74. package/src/modules/sync/sync.live-removal.test.ts +175 -0
  75. package/src/modules/sync/sync.reconnect.test.ts +145 -0
  76. package/src/modules/sync/sync.subquery.test.ts +82 -0
  77. package/src/modules/sync/sync.tabs.test.ts +249 -0
  78. package/src/modules/sync/sync.ts +1840 -98
  79. package/src/modules/sync/utils.test.ts +269 -2
  80. package/src/modules/sync/utils.ts +201 -16
  81. package/src/otel/index.ts +13 -10
  82. package/src/services/blobs/blob-cache.test.ts +359 -0
  83. package/src/services/blobs/blob-cache.ts +603 -0
  84. package/src/services/blobs/blob-manifest.ts +227 -0
  85. package/src/services/blobs/blob-store.test.ts +77 -0
  86. package/src/services/blobs/blob-store.ts +359 -0
  87. package/src/services/blobs/blob.fixture.ts +90 -0
  88. package/src/services/blobs/index.ts +70 -0
  89. package/src/services/database/cache-engine.ts +193 -0
  90. package/src/services/database/connection-supervisor.test.ts +289 -0
  91. package/src/services/database/connection-supervisor.ts +415 -0
  92. package/src/services/database/database.query-timeout.test.ts +83 -0
  93. package/src/services/database/database.ts +41 -12
  94. package/src/services/database/engine-factory.ts +33 -0
  95. package/src/services/database/errors.ts +34 -0
  96. package/src/services/database/events/index.ts +2 -1
  97. package/src/services/database/index.ts +7 -0
  98. package/src/services/database/local-migrator.ts +30 -27
  99. package/src/services/database/local.test.ts +64 -0
  100. package/src/services/database/local.ts +484 -67
  101. package/src/services/database/plan-render.test.ts +159 -0
  102. package/src/services/database/plan-render.ts +108 -0
  103. package/src/services/database/relation-resolver.test.ts +413 -0
  104. package/src/services/database/relation-resolver.ts +0 -0
  105. package/src/services/database/remote.ts +146 -15
  106. package/src/services/database/sqlite-cache-engine.test.ts +616 -0
  107. package/src/services/database/sqlite-cache-engine.timeout.test.ts +61 -0
  108. package/src/services/database/sqlite-cache-engine.ts +1358 -0
  109. package/src/services/database/sqlite-devtools-queries.integration.test.ts +143 -0
  110. package/src/services/database/sqlite-devtools-queries.test.ts +154 -0
  111. package/src/services/database/sqlite-lock-verify.test.ts +33 -0
  112. package/src/services/database/sqlite-lock-verify.ts +45 -0
  113. package/src/services/database/sqlite-open.test.ts +150 -0
  114. package/src/services/database/sqlite-open.ts +164 -0
  115. package/src/services/database/sqlite-plan-sql.test.ts +104 -0
  116. package/src/services/database/sqlite-plan-sql.ts +138 -0
  117. package/src/services/database/sqlite-projection.test.ts +99 -0
  118. package/src/services/database/sqlite-select.integration.test.ts +185 -0
  119. package/src/services/database/sqlite-select.test.ts +246 -0
  120. package/src/services/database/sqlite-select.ts +131 -0
  121. package/src/services/database/sqlite-transport.fixture.ts +30 -0
  122. package/src/services/database/sqlite-transport.ts +224 -0
  123. package/src/services/database/sqlite-worker.ts +437 -0
  124. package/src/services/database/surql-translate.ts +416 -0
  125. package/src/services/database/surreal-cache-engine.ts +161 -0
  126. package/src/services/logger/index.ts +3 -2
  127. package/src/services/persistence/localstorage.ts +2 -2
  128. package/src/services/persistence/resilient.ts +11 -4
  129. package/src/services/persistence/surrealdb.ts +10 -10
  130. package/src/services/stream-processor/index.ts +796 -84
  131. package/src/services/stream-processor/permissions.test.ts +47 -0
  132. package/src/services/stream-processor/permissions.ts +53 -0
  133. package/src/services/stream-processor/stream-processor.batch.test.ts +186 -0
  134. package/src/services/stream-processor/stream-processor.prime.test.ts +198 -0
  135. package/src/services/stream-processor/stream-processor.reset.test.ts +226 -0
  136. package/src/services/stream-processor/stream-processor.test.ts +1 -1
  137. package/src/services/stream-processor/wasm-types.ts +59 -3
  138. package/src/services/tabs/broker-client.ts +283 -0
  139. package/src/services/tabs/broker.test.ts +327 -0
  140. package/src/services/tabs/coordinator.test.ts +365 -0
  141. package/src/services/tabs/coordinator.ts +633 -0
  142. package/src/services/tabs/fake-ports.fixture.ts +112 -0
  143. package/src/services/tabs/leader-locks.ts +75 -0
  144. package/src/services/tabs/protocol.ts +258 -0
  145. package/src/services/tabs/support.ts +36 -0
  146. package/src/services/tabs/tabs-broker-worker.ts +640 -0
  147. package/src/sp00ky.auth-order.test.ts +92 -0
  148. package/src/sp00ky.init-query.test.ts +183 -0
  149. package/src/sp00ky.local-first.test.ts +60 -0
  150. package/src/sp00ky.ts +1720 -0
  151. package/src/types.ts +528 -13
  152. package/src/utils/blurhash.ts +90 -0
  153. package/src/utils/error-classification.test.ts +44 -0
  154. package/src/utils/error-classification.ts +7 -0
  155. package/src/utils/index.ts +79 -13
  156. package/src/utils/parser.test.ts +49 -120
  157. package/src/utils/parser.ts +32 -2
  158. package/src/utils/semver.test.ts +32 -0
  159. package/src/utils/semver.ts +30 -0
  160. package/src/utils/surql.ts +30 -18
  161. package/src/utils/withRetry.test.ts +1 -1
  162. package/tsdown.config.ts +86 -1
  163. package/src/spooky.ts +0 -395
package/dist/index.d.ts CHANGED
@@ -1,81 +1,276 @@
1
- import { C as Logger$1, S as UpdateOptions, T as EventSystem, _ as RunOptions, a as MutationEvent, b as SpookyQueryResultPromise, c as PinoTransmit, d as QueryHash, f as QueryState, g as RecordVersionDiff, h as RecordVersionArray, i as MutationCallback, l as QueryConfig, m as QueryUpdateCallback, n as EventSubscriptionOptions, o as MutationEventType, p as QueryTimeToLive, r as Level, s as PersistenceClient, t as DebounceOptions, u as QueryConfigRecord, v as SpookyConfig, w as EventDefinition, x as StoreType, y as SpookyQueryResult } from "./types.js";
1
+ import { A as Sp00kyQueryResultPromise, B as LocalStore, C as ReconnectConfig, D as RunOptions, E as RegistrationTimings, F as SyncHealthConfig, G as SyncEventSystem, H as DatabaseEventSystem, I as SyncHealthStatus, K as EventDefinition, L as TimingPhase, M as StorageHealthStatus, N as StoreType, O as Sp00kyConfig, P as SyncHealth, R as UpdateOptions, S as QueryUpdateCallback, T as RecordVersionDiff, U as DatabaseEventTypes, V as SealedQuery, W as Logger$1, _ as QueryState, a as MATERIALIZATION_SAMPLE_WINDOW, b as QueryTimeToLive, c as MutationEventType, d as PinoTransmit, f as PreloadOptions, g as QueryHash, h as QueryConfigRecord, i as Level, j as StorageHealth, k as Sp00kyQueryResult, l as PersistenceClient, m as QueryConfig, n as DebounceOptions, o as MutationCallback, p as PreloadRefresh, q as EventSystem, r as EventSubscriptionOptions, s as MutationEvent, t as ConnectionState, u as PhaseStat, v as QueryStatus, w as RecordVersionArray, x as QueryTimings, y as QueryStatusCallback, z as UpEvent } from "./types.js";
2
2
  import * as surrealdb0 from "surrealdb";
3
- import { Duration, RecordId, Surreal, SurrealTransaction } from "surrealdb";
4
- import { AccessDefinition, BackendNames, BackendRoutes, BucketNames, ColumnSchema, GetTable, QueryBuilder, QueryOptions, RoutePayload, SchemaStructure, TableModel, TableNames, TypeNameToTypeMap } from "@spooky-sync/query-builder";
3
+ import { Duration, RecordId, Surreal as Surreal$1, SurrealEvents, SurrealTransaction } from "surrealdb";
4
+ import { AccessDefinition, BackendNames, BackendRoutes, BucketNames, ColumnSchema, FinalQuery, GetTable, QueryBuilder, QueryOptions, QueryPlan, RoutePayload, SchemaStructure, TableModel, TableNames, TypeNameToTypeMap } from "@spooky-sync/query-builder";
5
5
  import { Logger } from "pino";
6
+ import { decode, encode, isBlurhashValid } from "blurhash";
7
+ import { LoroDoc } from "loro-crdt";
6
8
 
7
- //#region src/services/database/events/index.d.ts
8
- declare const DatabaseEventTypes: {
9
- readonly LocalQuery: "DATABASE_LOCAL_QUERY";
10
- readonly RemoteQuery: "DATABASE_REMOTE_QUERY";
11
- };
12
- interface DatabaseQueryEventPayload {
13
- query: string;
14
- vars?: Record<string, unknown>;
15
- duration: number;
16
- success: boolean;
17
- error?: string;
18
- timestamp: number;
19
- }
20
- type DatabaseEventTypeMap = {
21
- [DatabaseEventTypes.LocalQuery]: EventDefinition<typeof DatabaseEventTypes.LocalQuery, DatabaseQueryEventPayload>;
22
- [DatabaseEventTypes.RemoteQuery]: EventDefinition<typeof DatabaseEventTypes.RemoteQuery, DatabaseQueryEventPayload>;
23
- };
24
- type DatabaseEventSystem = EventSystem<DatabaseEventTypeMap>;
25
- //#endregion
26
- //#region src/utils/surql.d.ts
27
- interface SealedQuery<T = void> {
28
- readonly sql: string;
29
- readonly extract: (results: unknown[]) => T;
30
- }
31
- //#endregion
32
9
  //#region src/services/database/database.d.ts
33
10
  declare abstract class AbstractDatabaseService {
34
- protected client: Surreal;
11
+ protected client: Surreal$1;
35
12
  protected logger: Logger$1;
36
13
  protected events: DatabaseEventSystem;
14
+ /**
15
+ * Per-query deadline in ms; `0` disables. The remote service sets it from
16
+ * `queryTimeoutMs` (see `RemoteDatabaseService`), the local one from
17
+ * `localOpTimeoutMs` (see `LocalDatabaseService`): a local query can be
18
+ * legitimately slow, but it must never be endless - every query waits on the
19
+ * previous link of {@link query}'s chain, and one that never settled wedged
20
+ * every later local op behind it.
21
+ */
22
+ protected queryTimeoutMs: number;
23
+ /** The error a deadline expiry rejects with; the local service substitutes
24
+ * its typed `LocalOpTimeoutError`. "timed out" in the message is
25
+ * load-bearing either way: `classifySyncError` keys off it. */
26
+ protected timeoutError(_query: string): Error;
37
27
  protected abstract eventType: typeof DatabaseEventTypes.LocalQuery | typeof DatabaseEventTypes.RemoteQuery;
38
- constructor(client: Surreal, logger: Logger$1, events: DatabaseEventSystem);
28
+ constructor(client: Surreal$1, logger: Logger$1, events: DatabaseEventSystem);
39
29
  abstract connect(): Promise<void>;
40
- getClient(): Surreal;
30
+ getClient(): Surreal$1;
41
31
  getEvents(): DatabaseEventSystem;
42
32
  tx(): Promise<SurrealTransaction>;
43
33
  private queryQueue;
44
34
  /**
45
35
  * Execute a query with serialized execution to prevent WASM transaction issues.
36
+ *
37
+ * Serialization means every query waits on the previous one, so a call that
38
+ * never settles blocks the whole chain forever. {@link queryTimeoutMs} bounds
39
+ * each link: on expiry this promise rejects and the chain moves on, even
40
+ * though the underlying RPC is still parked in the SDK's pending map.
46
41
  */
47
42
  query<T extends unknown[]>(query: string, vars?: Record<string, unknown>): Promise<T>;
48
43
  execute<T>(query: SealedQuery<T>, vars?: Record<string, unknown>): Promise<T>;
49
44
  close(): Promise<void>;
50
45
  }
51
46
  //#endregion
52
- //#region src/services/database/local.d.ts
53
- declare class LocalDatabaseService extends AbstractDatabaseService {
54
- private config;
55
- protected eventType: "DATABASE_LOCAL_QUERY";
56
- constructor(config: SpookyConfig<any>['database'], logger: Logger$1);
57
- getConfig(): SpookyConfig<any>['database'];
58
- connect(): Promise<void>;
59
- }
60
- //#endregion
61
47
  //#region src/services/database/remote.d.ts
48
+ /** Transport events the SDK publishes, mapped 1:1 to {@link ConnectionState}. */
49
+ type RemoteConnectionEvent = ConnectionState | 'error';
62
50
  declare class RemoteDatabaseService extends AbstractDatabaseService {
63
51
  private config;
64
52
  protected eventType: "DATABASE_REMOTE_QUERY";
65
- constructor(config: SpookyConfig<any>['database'], logger: Logger$1);
66
- getConfig(): SpookyConfig<any>['database'];
53
+ private readonly reconnectConfig;
54
+ /**
55
+ * In-flight `connect()`, so concurrent callers (boot + supervisor revive +
56
+ * an `online` event landing at the same moment) share one attempt instead of
57
+ * racing two sockets. Cleared on settle, so a later call always reconnects.
58
+ */
59
+ private connecting;
60
+ /**
61
+ * The token to re-authenticate a freshly opened socket with, kept current by
62
+ * {@link setAuthToken}.
63
+ *
64
+ * `config.token` is fixed at construction and most apps never set it: they
65
+ * sign in later, which authenticates the socket that happens to be open at
66
+ * the time. That is enough for the SDK's OWN reconnects (it replays
67
+ * `version`/`use`/`authenticate` itself), but not for the supervisor's revive
68
+ * loop, which builds a socket from scratch. Without this the revived socket
69
+ * came back UNAUTHENTICATED and stayed that way for the life of the page,
70
+ * while the client's `currentUserId` — restored from local storage — kept
71
+ * reporting the user as signed in.
72
+ *
73
+ * The visible damage is silent and total: `fn::query::register` sends
74
+ * `<string>($auth.id OR '')`, so every view registered afterwards is stamped
75
+ * with an empty identity, and every `$auth.id` predicate in it resolves
76
+ * false. Public tables keep returning rows while everything owned by the user
77
+ * returns nothing, on a page that still looks signed in.
78
+ */
79
+ private authToken;
80
+ constructor(config: Sp00kyConfig<any>['database'], logger: Logger$1);
81
+ getConfig(): Sp00kyConfig<any>['database'];
82
+ /**
83
+ * Record the token every future connect should authenticate with, or `null`
84
+ * on sign-out. See {@link authToken}.
85
+ *
86
+ * Does not touch the CURRENT socket: callers authenticate that themselves
87
+ * (sign-in and session restore both already do). This only makes the next
88
+ * from-scratch connect reproduce that state.
89
+ */
90
+ setAuthToken(token: string | null): void;
91
+ /** Resolved reconnect tunables; the supervisor reads its own knobs here. */
92
+ getReconnectConfig(): Required<ReconnectConfig>;
93
+ /** Current transport state as reported by the SDK. */
94
+ getStatus(): ConnectionState;
95
+ /**
96
+ * Observe transport events. Thin passthrough so callers (the supervisor,
97
+ * sync, CRDT) don't have to reach through `getClient()`.
98
+ */
99
+ subscribeConnection<K extends RemoteConnectionEvent>(event: K, cb: (...payload: SurrealEvents[K]) => void): () => void;
100
+ /**
101
+ * Tear the socket down on purpose. Used by the heartbeat watchdog when a
102
+ * socket stops answering but never closes: `close()` makes the SDK publish
103
+ * `disconnected`, which is what drives the supervisor's revive loop.
104
+ */
105
+ forceClose(): Promise<void>;
106
+ /**
107
+ * Open (or re-open) the remote connection.
108
+ *
109
+ * Safe to call repeatedly: concurrent calls share the in-flight attempt, and
110
+ * a call after a `disconnected` builds a fresh socket. `use()` and
111
+ * `authenticate()` are re-applied here for the cold path; the SDK also
112
+ * replays them itself on its own internal reconnects.
113
+ */
67
114
  connect(): Promise<void>;
115
+ private doConnect;
68
116
  signin(params: any): Promise<any>;
69
117
  signup(params: any): Promise<any>;
70
118
  authenticate(token: string): Promise<any>;
71
119
  invalidate(): Promise<void>;
72
120
  }
73
121
  //#endregion
122
+ //#region src/services/database/connection-supervisor.d.ts
123
+ /**
124
+ * Keeps the remote WebSocket alive for the whole life of the page.
125
+ *
126
+ * The SurrealDB SDK reconnects on its own after a socket `close`, but that
127
+ * covers only one of three ways the connection dies:
128
+ *
129
+ * 1. **Socket closes, SDK recovers.** Handled entirely by the SDK. This
130
+ * supervisor only observes it (to report `reconnecting` upward).
131
+ * 2. **Socket closes, SDK gives up.** With `attempts: -1` this shouldn't happen
132
+ * from exhaustion — but the SDK also terminates the engine permanently when
133
+ * its post-reconnect handshake throws (it re-runs `version()`, `use()`,
134
+ * `authenticate()` on every reconnect and closes the engine on any error).
135
+ * One transient hiccup there would otherwise kill the page's connection for
136
+ * good. The revive loop re-opens from scratch.
137
+ * 3. **Socket never closes at all.** A half-open connection: the peer is gone
138
+ * (NAT timeout, wifi switch, laptop sleep) but no FIN ever arrives, so
139
+ * `readyState` stays OPEN and the SDK's own 30s ping — fire-and-forget, no
140
+ * response deadline — never notices. Nothing ever fires a `close` event, so
141
+ * nothing ever triggers a reconnect. The heartbeat detects this and forces
142
+ * the teardown that case 2's loop then repairs.
143
+ *
144
+ * Plus wake triggers: coming back `online` or un-hiding the tab probes
145
+ * immediately rather than waiting out a backoff that was scheduled while the
146
+ * network was known-down.
147
+ */
148
+ declare class ConnectionSupervisor {
149
+ private readonly remote;
150
+ private readonly logger;
151
+ private readonly config;
152
+ private state;
153
+ private subscribers;
154
+ private started;
155
+ private disposed;
156
+ private heartbeatTimer;
157
+ private heartbeatInFlight;
158
+ /** Consecutive failed probes. See {@link FAILURES_BEFORE_TEARDOWN}. */
159
+ private heartbeatFailures;
160
+ private reviveTimer;
161
+ private reviveAttempts;
162
+ /** Timestamp of the last wake-triggered probe, for rate limiting. */
163
+ private lastWakeProbeAt;
164
+ private reviving;
165
+ /**
166
+ * Set while the browser reports itself offline. Retrying a socket against a
167
+ * down interface only burns backoff, so the loop parks until `online` fires.
168
+ */
169
+ private suspended;
170
+ private teardown;
171
+ private static readonly REVIVE_BASE_MS;
172
+ /**
173
+ * How many consecutive heartbeat failures it takes to tear the socket down.
174
+ *
175
+ * The probe rides the same serialized queue as every other RPC (deliberately
176
+ * — see {@link beat}), which means it cannot distinguish a WEDGED queue from
177
+ * a merely BUSY one. A single slow window (a large sync burst, one heavy
178
+ * app query) used to be enough to force-close a perfectly healthy socket,
179
+ * and the resulting reconnect re-registered every active query about a
180
+ * second later. That self-inflicted teardown manufactured the very reconnect
181
+ * storms this class exists to survive. A genuinely dead socket still fails
182
+ * every probe, so it is torn down one interval later than before.
183
+ */
184
+ private static readonly FAILURES_BEFORE_TEARDOWN;
185
+ /** Retry delay after an inconclusive (first) heartbeat failure. */
186
+ private static readonly HEARTBEAT_RETRY_MS;
187
+ /** Floor between probes triggered by wake events (tab focus, pageshow). */
188
+ private static readonly WAKE_PROBE_MIN_INTERVAL_MS;
189
+ constructor(remote: RemoteDatabaseService, logger: Logger$1, config?: Required<ReconnectConfig>);
190
+ /** Latest observed transport state. */
191
+ get connection(): ConnectionState;
192
+ /**
193
+ * Observe transport state. Fires immediately with the current value and again
194
+ * on every change. Returns an unsubscribe.
195
+ */
196
+ subscribe(cb: (state: ConnectionState) => void): () => void;
197
+ /**
198
+ * Begin supervising. Call once, after the initial {@link
199
+ * RemoteDatabaseService.connect}. Idempotent.
200
+ */
201
+ start(): void;
202
+ /** Stop all timers and listeners. Safe to call more than once. */
203
+ dispose(): void;
204
+ private setState;
205
+ private clearReviveTimer;
206
+ /**
207
+ * Queue the next `connect()` attempt on exponential backoff, capped at
208
+ * `superviseRetryDelayMaxMs`. Never gives up — the page is expected to
209
+ * outlive any outage.
210
+ */
211
+ private scheduleRevive;
212
+ private revive;
213
+ private stopHeartbeat;
214
+ private startHeartbeat;
215
+ /**
216
+ * Probe the server end-to-end. Deliberately goes through
217
+ * `remote.query` — the same serialized queue every other remote call uses —
218
+ * so a queue wedged behind a stuck RPC also fails the heartbeat instead of
219
+ * being invisible to it.
220
+ */
221
+ private beat;
222
+ /**
223
+ * A restored network or an un-hidden tab is the strongest available hint that
224
+ * a reconnect will now succeed, so probe immediately instead of waiting out a
225
+ * backoff scheduled under worse conditions.
226
+ */
227
+ private installWakeTriggers;
228
+ /**
229
+ * Reset the backoff and act on whichever problem is present: reconnect if the
230
+ * socket is gone, otherwise probe it (it may be half-open — which is exactly
231
+ * what a sleep/wake cycle produces).
232
+ */
233
+ private wake;
234
+ }
235
+ //#endregion
236
+ //#region src/modules/sync/queue/queue-down.d.ts
237
+ type RegisterEvent = {
238
+ type: 'register';
239
+ payload: {
240
+ hash: string;
241
+ };
242
+ };
243
+ type SyncEvent = {
244
+ type: 'sync';
245
+ payload: {
246
+ hash: string;
247
+ };
248
+ };
249
+ type HeartbeatEvent = {
250
+ type: 'heartbeat';
251
+ payload: {
252
+ hash: string;
253
+ };
254
+ };
255
+ type CleanupEvent = {
256
+ type: 'cleanup';
257
+ payload: {
258
+ hash: string;
259
+ };
260
+ };
261
+ type DownEvent = RegisterEvent | SyncEvent | HeartbeatEvent | CleanupEvent;
262
+ //#endregion
74
263
  //#region src/services/stream-processor/wasm-types.d.ts
75
264
  interface WasmStreamUpdate {
76
265
  query_id: string;
77
266
  result_hash: string;
78
267
  result_data: RecordVersionArray;
268
+ timing_store_apply_ms?: number;
269
+ timing_circuit_step_ms?: number;
270
+ timing_transform_ms?: number;
271
+ timing_parse_ms?: number;
272
+ timing_plan_ms?: number;
273
+ timing_snapshot_ms?: number;
79
274
  }
80
275
  //#endregion
81
276
  //#region src/services/stream-processor/index.d.ts
@@ -96,6 +291,33 @@ interface StreamUpdate {
96
291
  queryHash: string;
97
292
  localArray: RecordVersionArray;
98
293
  op?: 'CREATE' | 'UPDATE' | 'DELETE';
294
+ /**
295
+ * Client-internal: not from the circuit. A membership-only change that
296
+ * needed no fetch is re-materialized through this same path so it cannot
297
+ * race a real update (DataModule.scheduleRematerialize). Carries the last
298
+ * known `localArray`; consumers that describe an INGEST (persist, metrics,
299
+ * devtools events) skip it.
300
+ */
301
+ synthetic?: boolean;
302
+ /**
303
+ * End-to-end ingest latency for the WASM call that produced this update,
304
+ * in milliseconds. Populated by StreamProcessorService.ingest. Undefined
305
+ * for the initial register_view snapshot.
306
+ */
307
+ materializationTimeMs?: number;
308
+ /** SSP internal sub-phase timings (ms) for this ingest, from the WASM binding. */
309
+ storeApplyMs?: number;
310
+ circuitStepMs?: number;
311
+ transformMs?: number;
312
+ /**
313
+ * One-shot registration timings (ms). Only set on the StreamUpdate returned
314
+ * by `registerQueryPlan` (the register_view snapshot), not on ingest updates.
315
+ */
316
+ registration?: {
317
+ parseMs: number;
318
+ planMs: number;
319
+ snapshotMs: number;
320
+ };
99
321
  }
100
322
  type StreamProcessorEvents = {
101
323
  stream_update: EventDefinition<'stream_update', StreamUpdate[]>;
@@ -107,34 +329,204 @@ type StreamProcessorEvents = {
107
329
  interface StreamUpdateReceiver {
108
330
  onStreamUpdate(update: StreamUpdate): void;
109
331
  }
332
+ /** One row change in the shape `ingestMany` consumes. */
333
+ interface IngestRecord {
334
+ table: string;
335
+ /** `MERGE` overlays the given fields on the stored row (projection widening). */
336
+ op: 'CREATE' | 'UPDATE' | 'DELETE' | 'MERGE';
337
+ id: string;
338
+ record: any;
339
+ }
340
+ /**
341
+ * What the boot-time prime needs from the client: which tables to walk, how
342
+ * to recognise a snapshot written under a different schema, and which rows'
343
+ * local `_00_rv` must not be reported as the server's.
344
+ */
345
+ interface CircuitPrimeContext {
346
+ tables: string[];
347
+ schemaHash: string;
348
+ /** Encoded ids with an unsettled local mutation (their `_00_rv` was bumped
349
+ * locally and may exceed the server's next version). */
350
+ pendingIds: Set<string>;
351
+ /** Receives every `(id, rv)` the prime put into the circuit, per table, so
352
+ * the sync layer can skip re-downloading bodies it already has. */
353
+ onVersions?: (table: string, entries: [string, number][]) => void;
354
+ }
355
+ /** Storage key of the circuit snapshot inside the local store. */
356
+
110
357
  declare class StreamProcessorService {
111
358
  events: EventSystem<StreamProcessorEvents>;
112
359
  private db;
113
- private persistenceClient;
114
360
  private logger;
115
361
  private processor;
116
362
  private isInitialized;
117
363
  private receivers;
118
- constructor(events: EventSystem<StreamProcessorEvents>, db: LocalDatabaseService, persistenceClient: PersistenceClient, logger: Logger);
364
+ private batching;
365
+ private batchBuffer;
366
+ private sessionAuth;
367
+ private stateGeneration;
368
+ private persistState;
369
+ private persistCircuit;
370
+ private checkpointMs;
371
+ private checkpointTimer;
372
+ private snapshotDirty;
373
+ private dirtyRows;
374
+ private hideHandler;
375
+ private checkpointInFlight;
376
+ private projection;
377
+ private primed;
378
+ private schemaHash;
379
+ private widenQueue;
380
+ private widenPending;
381
+ constructor(events: EventSystem<StreamProcessorEvents>, db: LocalStore, logger: Logger);
119
382
  /**
120
383
  * Add a receiver for stream updates.
121
384
  * Multiple receivers can be registered (DataManager, DevTools, etc.)
122
385
  */
123
386
  addReceiver(receiver: StreamUpdateReceiver): void;
124
387
  private notifyUpdates;
388
+ private dispatchUpdates;
389
+ /**
390
+ * Ingest a batch of record changes, firing one coalesced `StreamUpdate` per
391
+ * affected query once every record has been ingested. Use this whenever
392
+ * multiple records land at once (sync fetching N rows, the boot prime).
393
+ *
394
+ * The batch is fed to the wasm side in chunks of {@link INGEST_CHUNK}: one
395
+ * circuit step per chunk (a step walks every registered view, so per-record
396
+ * ingest paid that fixed cost N times), but never the whole batch at once,
397
+ * because the wasm side has to hold every parsed row of a call at the same
398
+ * time and wasm32 dlmalloc never returns that peak.
399
+ *
400
+ * Returns the records that were ingested. A chunk that fails is reported
401
+ * and skipped, not retried (a retry would double-apply whatever the failed
402
+ * step already committed), and the remaining chunks still run.
403
+ */
404
+ ingestMany(records: IngestRecord[]): IngestRecord[];
405
+ /**
406
+ * Open a coalescing window. While open, the per-record stream updates
407
+ * emitted by `ingest` are buffered (one entry per queryHash) instead of
408
+ * dispatched. Always paired with `flushCoalescing()` in a try/finally by
409
+ * `ingestMany` so the window always closes — otherwise the processor stays
410
+ * stuck buffering forever.
411
+ *
412
+ * No-op if a window is already open (nested batches aren't expected here).
413
+ */
414
+ private beginCoalescing;
415
+ /**
416
+ * Close the coalescing window and flush: dispatch one coalesced
417
+ * `StreamUpdate` per buffered queryHash, then persist processor state once
418
+ * for the whole batch (instead of once per ingest).
419
+ */
420
+ private flushCoalescing;
125
421
  /**
126
422
  * Initialize the WASM module and processor.
127
423
  * This must be called before using other methods.
128
424
  */
129
425
  init(): Promise<void>;
130
- loadState(): Promise<void>;
131
- saveState(): Promise<void>;
426
+ /**
427
+ * Drop the current WASM processor and start a fresh, empty circuit. Used on
428
+ * local-bucket switches: the old circuit holds the previous user's rows AND
429
+ * views registered with the previous `$auth` context, so neither may survive.
430
+ * Deliberately loads nothing: the snapshot in the store being swapped away
431
+ * from belongs to the previous bucket; the caller primes the new bucket's
432
+ * circuit (`primeFromLocal`) once its store is open, and the DataModule
433
+ * rebind re-registers every live view against this fresh processor. Caller
434
+ * must re-seed `setPermissions` afterwards (a fresh circuit default-denies
435
+ * every table).
436
+ */
437
+ reset(): Promise<void>;
438
+ /**
439
+ * Release the wasm circuit and stop checkpointing. Call when the client is
440
+ * torn down; a recreated client (provider remount, HMR) would otherwise stack
441
+ * one full circuit per instance.
442
+ */
443
+ dispose(): void;
444
+ /**
445
+ * Explicitly run the wasm-bindgen destructor. Guarded: stale wasm builds may
446
+ * not expose `free`, and a double free must not take the app down.
447
+ */
448
+ private freeProcessor;
449
+ /** Toggle circuit-state persistence (shared-tabs follower/leader role). */
450
+ setPersistenceEnabled(enabled: boolean): void;
451
+ /**
452
+ * Snapshot persistence (`persistCircuit`). When on, the circuit's store is
453
+ * written to the local store on a checkpoint interval and when the page
454
+ * goes hidden, and restored by {@link primeFromLocal} on the next boot.
455
+ */
456
+ configureCircuitPersistence(enabled: boolean, checkpointMs?: number): void;
457
+ /**
458
+ * Field projection (`circuitProjection`, default on). Takes effect on the
459
+ * next processor (`init`/`reset`) and on rows written after that.
460
+ */
461
+ configureProjection(enabled: boolean): void;
462
+ private applyProjection;
463
+ /** Resolves once the boot-time prime has finished (or was skipped). */
464
+ whenPrimed(): Promise<void>;
465
+ /**
466
+ * Fill the circuit from the LOCAL store, in the background.
467
+ *
468
+ * With a usable snapshot: install it under whatever views have registered
469
+ * meanwhile (`load_store_state` re-primes them), then `reconcile` each table
470
+ * against the store's `(id, rv)` list so rows deleted since the checkpoint
471
+ * are stepped out and only rows added or changed since are read back and
472
+ * ingested. Without one: read every row and ingest it, chunked.
473
+ *
474
+ * Either way the circuit ends up equal to the local store without touching
475
+ * the network, so the first sync diff is a real delta rather than "fetch
476
+ * everything". The returned promise never rejects; `whenPrimed` gates on it.
477
+ */
478
+ primeFromLocal(ctx: CircuitPrimeContext): Promise<void>;
479
+ private runPrime;
480
+ /** Publish wasm updates produced outside an ingest (restore, reconcile). */
481
+ private dispatchWasmUpdates;
482
+ /**
483
+ * Record that the circuit changed by `rows` rows. Cheap; the snapshot is
484
+ * deferred to the checkpoint timer and skipped entirely when `persistCircuit`
485
+ * is off.
486
+ */
487
+ private markSnapshotDirty;
488
+ private startCheckpoints;
489
+ /** Stop checkpointing and drop the visibility listeners. */
490
+ stopCheckpoints(): void;
491
+ /**
492
+ * Write the circuit's store to the local store as a snapshot. Compacts the
493
+ * row arena first when dead bytes outweigh live ones. Serialised: a second
494
+ * call while one is in flight joins it. No-op unless persistence is on, this
495
+ * tab owns the store, and the engine can hold a snapshot.
496
+ */
497
+ checkpoint(reason?: string): Promise<void>;
498
+ private runCheckpoint;
499
+ /**
500
+ * Projection widening: a newly registered view evaluates fields that rows
501
+ * already in the circuit were stored without. Merge just those fields in,
502
+ * table by table, from the local store. The view registered against what
503
+ * was present and converges as the merges step through.
504
+ */
505
+ private scheduleWiden;
506
+ private runWiden;
507
+ /**
508
+ * Seed per-table `select` permission predicates ({ [table]: whereText }).
509
+ * Must run after the processor exists and before any `register_view`, else
510
+ * non-`_00_` tables are default-denied and registration fails.
511
+ */
512
+ setPermissions(permissions: Record<string, string>): void;
513
+ /**
514
+ * Set the current session's auth identity for permission injection,
515
+ * mirroring the server's `fn::query::register`
516
+ * (`object::extend(params, { auth: { id: $auth.id }, access: $access })`).
517
+ * Stored as strings (empty when logged out) and applied to every
518
+ * `register_view` in {@link registerQueryPlan}. Must be set before a
519
+ * `$auth`-gated query registers (and re-set on auth state changes), or the
520
+ * in-browser SSP's `permission_inject` rejects it with
521
+ * "requires $auth but registration params lack it".
522
+ */
523
+ setSessionAuth(authId: string | null, access: string | null): void;
132
524
  /**
133
525
  * Ingest a record change into the processor.
134
526
  * Emits 'stream_update' event if materialized views are affected.
135
527
  * @param isOptimistic true = local mutation (increment versions), false = remote sync (keep versions)
136
528
  */
137
- ingest(table: string, op: 'CREATE' | 'UPDATE' | 'DELETE', id: string, record: any): WasmStreamUpdate[];
529
+ ingest(table: string, op: IngestRecord['op'], id: string, record: any): WasmStreamUpdate[];
138
530
  /**
139
531
  * Register a new query plan.
140
532
  * Emits 'stream_update' with the initial result.
@@ -147,6 +539,1209 @@ declare class StreamProcessorService {
147
539
  private normalizeValue;
148
540
  }
149
541
  //#endregion
542
+ //#region src/modules/cache/types.d.ts
543
+ type RecordWithId = Record<string, any> & {
544
+ id: RecordId<string>;
545
+ };
546
+ interface QueryConfig$1 {
547
+ queryHash: string;
548
+ surql: string;
549
+ params: Record<string, any>;
550
+ ttl: QueryTimeToLive | Duration;
551
+ lastActiveAt: Date;
552
+ }
553
+ interface CacheRecord {
554
+ table: string;
555
+ op: 'CREATE' | 'UPDATE' | 'DELETE';
556
+ record: RecordWithId;
557
+ version: number;
558
+ }
559
+ //#endregion
560
+ //#region src/modules/cache/index.d.ts
561
+ /**
562
+ * CacheModule - Centralized storage and DBSP ingestion
563
+ *
564
+ * Single responsibility: Handle all local storage operations and DBSP ingestion.
565
+ * This module acts as the bridge between data operations and persistence.
566
+ */
567
+ /** One ingested change, in exactly the shape `ingestMany` consumes. Shared
568
+ * with the tabs protocol so a leader can relay its ingests to followers. */
569
+ interface CacheIngestTuple {
570
+ table: string;
571
+ op: 'CREATE' | 'UPDATE' | 'DELETE';
572
+ id: string;
573
+ record: Record<string, unknown>;
574
+ }
575
+ declare class CacheModule implements StreamUpdateReceiver {
576
+ private local;
577
+ private streamProcessor;
578
+ private logger;
579
+ private streamUpdateCallback;
580
+ private versionLookups;
581
+ /** Shared-tabs leader: fan every committed ingest out to follower circuits.
582
+ * Fired AFTER the local tx (the rows are already in the shared store, so a
583
+ * follower only needs the circuit feed). A follower relays its own
584
+ * mutations to the leader the same way, see {@link setIngestRelay}. */
585
+ private ingestRelay;
586
+ /** See {@link setIngestRelay}. */
587
+ private relayLocalWritesOnly;
588
+ constructor(local: LocalStore, streamProcessor: StreamProcessorService, streamUpdateCallback: (update: StreamUpdate) => void, logger: Logger$1);
589
+ /**
590
+ * Implements StreamUpdateReceiver interface
591
+ * Called directly by StreamProcessor when views change
592
+ */
593
+ onStreamUpdate(update: StreamUpdate): void;
594
+ /**
595
+ * Fan every committed ingest out to the other tabs. The leader relays
596
+ * everything (its sync fetches are the only copy the followers get). A
597
+ * follower relays with `localWritesOnly`: just the mutation path, which is
598
+ * the only thing it knows that the leader does not. Its sync-fetched
599
+ * batches are the leader's data coming back and must not be re-broadcast,
600
+ * or every follower registration would fan its whole working set to
601
+ * every tab.
602
+ */
603
+ setIngestRelay(cb: ((tuples: CacheIngestTuple[]) => void) | null, opts?: {
604
+ localWritesOnly?: boolean;
605
+ }): void;
606
+ /**
607
+ * Shared-tabs follower: feed relayed tuples into THIS tab's circuit only.
608
+ * The rows are already in the shared store (the leader wrote them), so no
609
+ * local write happens here; the normal chain then runs: SSP -> stream update
610
+ * -> DataModule debounce -> materializeRecords (re-reads via the port
611
+ * transport) -> this tab's subscriptions fire with this tab's hashes.
612
+ */
613
+ applyRelayedIngest(tuples: CacheIngestTuple[]): void;
614
+ lookup(recordId: string): number;
615
+ /**
616
+ * Seed the version memo from rows the circuit was primed with out of the
617
+ * local store, so the first post-reload sync diff does not re-download
618
+ * bodies the browser already has. Only rows the prime actually put into the
619
+ * circuit belong here: a memo entry with no circuit row would make the diff
620
+ * flag the id forever while nothing ever fetches it.
621
+ */
622
+ primeVersions(entries: [string, number][]): void;
623
+ /** Drop the version cache on a bucket switch — a stale version would make
624
+ * the sync diff skip fetching a body the new bucket legitimately needs. */
625
+ clearVersionLookups(): void;
626
+ /**
627
+ * Save a single record to local DB and ingest into DBSP
628
+ * Used by mutations (create/update)
629
+ */
630
+ save(cacheRecord: CacheRecord, skipDbInsert?: boolean): Promise<void>;
631
+ /**
632
+ * Save multiple records in a batch
633
+ * More efficient than calling save() multiple times
634
+ * Used by sync operations
635
+ */
636
+ saveBatch(records: CacheRecord[], skipDbInsert?: boolean): Promise<void>;
637
+ /**
638
+ * Delete a record from local DB and ingest deletion into DBSP
639
+ */
640
+ delete(table: string, id: string, skipDbDelete?: boolean, recordData?: Record<string, any>): Promise<void>;
641
+ /**
642
+ * Register a query with DBSP to create a materialized view
643
+ * Returns the initial result array
644
+ */
645
+ registerQuery(config: QueryConfig$1): {
646
+ localArray: RecordVersionArray;
647
+ registrationTimings?: {
648
+ parseMs: number;
649
+ planMs: number;
650
+ snapshotMs: number;
651
+ };
652
+ };
653
+ /**
654
+ * Unregister a query from DBSP
655
+ */
656
+ unregisterQuery(queryHash: string): void;
657
+ }
658
+ //#endregion
659
+ //#region src/modules/data/index.d.ts
660
+ /**
661
+ * DataModule - Unified query and mutation management
662
+ *
663
+ * Merges the functionality of QueryManager and MutationManager.
664
+ * Uses CacheModule for all storage operations.
665
+ */
666
+ /** A `_00_window` row as read back: the id-set and whether the server vouched
667
+ * for it (which is what allows an empty set to count as known membership). */
668
+ interface DurableMembership {
669
+ ids: RecordVersionArray;
670
+ confirmed: boolean;
671
+ }
672
+ declare class DataModule<S extends SchemaStructure> {
673
+ private cache;
674
+ private local;
675
+ private schema;
676
+ private streamDebounceTime;
677
+ /** Tab identity baked into mutation ids (shared-tabs rollback routing);
678
+ * undefined in solo mode, where mutation-id falls back to a session id. */
679
+ private tabId;
680
+ private activeQueries;
681
+ private pendingQueries;
682
+ private subscriptions;
683
+ private statusSubscriptions;
684
+ private mutationCallbacks;
685
+ private debounceTimers;
686
+ private pendingStreamUpdates;
687
+ private fetchDepth;
688
+ private logger;
689
+ /**
690
+ * Optional observer notified whenever a query's fetch status changes.
691
+ * Wired by Sp00kyClient to push status changes into DevTools. Kept as a
692
+ * settable field (rather than a constructor arg) because DevTools is
693
+ * constructed after DataModule.
694
+ */
695
+ onQueryStatusChange?: (hash: QueryHash, status: QueryStatus) => void;
696
+ /**
697
+ * Optional observer invoked when a still-subscribed query's TTL heartbeat
698
+ * fires (~90% of the TTL). Wired by Sp00kyClient to
699
+ * `Sp00kySync.heartbeatQuery`, which refreshes the remote `_00_query`
700
+ * row's `lastActiveAt` so an actively-watched query never expires. Settable
701
+ * field (not a constructor arg) because the sync engine is wired after
702
+ * DataModule is constructed — mirrors `onQueryStatusChange`.
703
+ */
704
+ onHeartbeat?: (hash: QueryHash) => void;
705
+ /**
706
+ * Optional hook fired by {@link deregisterQuery} when an opt-in query (e.g. a
707
+ * viewport-windowed list cancelling an off-screen window) loses its last
708
+ * subscriber. Wired by Sp00kyClient to enqueue a `cleanup` down-event, which
709
+ * tears the remote `_00_query` view down (releasing its `_00_list_ref` edges)
710
+ * instead of leaving it for the TTL sweep. The local view + state are freed in
711
+ * {@link finalizeDeregister} only after that remote delete, so a fast
712
+ * re-subscribe (scroll back) can abort/heal the teardown — see `cleanupQuery`.
713
+ */
714
+ onDeregister?: (hash: QueryHash) => void;
715
+ private sessionId;
716
+ private currentUserId;
717
+ constructor(cache: CacheModule, local: LocalStore, schema: S, logger: Logger$1, streamDebounceTime?: number);
718
+ init(sessionId: string): Promise<void>;
719
+ /**
720
+ * Update the session salt used in query-id hashing. Call this when the
721
+ * SurrealDB session changes (sign-in, sign-out, reconnect). Subsequently
722
+ * registered queries will get fresh, session-scoped IDs.
723
+ */
724
+ setSessionId(sessionId: string): void;
725
+ /** Shared-tabs: bake this tab's identity into mutation ids so a rollback of
726
+ * a follower's mutation routes back to the tab that made it. */
727
+ setTabId(tabId: string): void;
728
+ /**
729
+ * Update the authenticated user record id. Pass `null` on sign-out.
730
+ * Read by `Sp00kySync.listRefTable()` so the LIVE subscription and
731
+ * the poll route to the same per-user `_00_list_ref_user_<id>` the
732
+ * SSP writes to.
733
+ */
734
+ setCurrentUserId(userId: string | null): void;
735
+ /** Read-only view of the authenticated user id used for per-user
736
+ * `_00_list_ref` routing. Other modules consult this so they pick the
737
+ * same table name DataModule does. */
738
+ getCurrentUserId(): string | null;
739
+ /**
740
+ * Register a query and return its hash for subscriptions
741
+ */
742
+ query<T extends TableNames<S>>(tableName: T, surqlString: string, params: Record<string, any>, ttl: QueryTimeToLive, plan?: QueryPlan): Promise<QueryHash>;
743
+ /**
744
+ * Subscribe to query updates
745
+ */
746
+ subscribe(queryHash: string, callback: QueryUpdateCallback, options?: {
747
+ immediate?: boolean;
748
+ }): () => void;
749
+ /**
750
+ * Subscribe to a query's fetch-status changes (idle/fetching).
751
+ * With `{ immediate: true }` the callback fires synchronously with the
752
+ * current status (defaults to `idle` if the query isn't registered yet).
753
+ */
754
+ subscribeStatus(queryHash: string, callback: QueryStatusCallback, options?: {
755
+ immediate?: boolean;
756
+ }): () => void;
757
+ /**
758
+ * Set a query's fetch status and notify status observers (DevTools +
759
+ * `subscribeStatus` listeners). No-op when the status is unchanged or the
760
+ * query is unknown.
761
+ */
762
+ setQueryStatus(queryHash: string, status: QueryStatus): void;
763
+ /**
764
+ * Enter a fetch cycle for a query. Refcounted: registration and concurrent
765
+ * poll/LIVE sync rounds can overlap on the same hash, and only the OUTERMOST
766
+ * cycle may flip the status — 0→1 emits `fetching`, and `endFetching`'s 1→0
767
+ * emits `idle`. Always pair with `endFetching` in a `finally`.
768
+ */
769
+ beginFetching(queryHash: string): void;
770
+ /** Leave a fetch cycle started with {@link beginFetching}; emits `idle` on the last exit. */
771
+ endFetching(queryHash: string): void;
772
+ /**
773
+ * Subscribe to mutations (for sync)
774
+ */
775
+ onMutation(callback: MutationCallback): () => void;
776
+ /**
777
+ * Handle stream updates from DBSP (via CacheModule)
778
+ */
779
+ onStreamUpdate(update: StreamUpdate): Promise<void>;
780
+ /** Coalesce `update` onto the query's trailing timer (see onStreamUpdate). */
781
+ private queueStreamUpdate;
782
+ /**
783
+ * Re-materialize + notify a query whose MEMBERSHIP changed without any row
784
+ * needing to be fetched, i.e. without the SSP stream update that normally
785
+ * carries the notify. That is every row this client wrote itself: the local
786
+ * CREATE memoized it at `_00_rv = 1`, the server publishes it at 1, so the
787
+ * sync engine rightly fetches nothing - and then nobody told the subscribers
788
+ * that `remoteArray` now holds the id. The row appeared on reload only.
789
+ *
790
+ * Routed through the same per-query debounce as a real stream update, so it
791
+ * cannot race one: a pending real update already materializes against the
792
+ * current `remoteArray` and wins. The synthetic update re-uses the circuit's
793
+ * last `localArray` and skips the persist/metrics that describe an ingest.
794
+ */
795
+ scheduleRematerialize(queryHash: string): void;
796
+ /**
797
+ * Process a query's pending (debounced) stream update NOW instead of on the
798
+ * trailing edge. Called by the sync engine before it flips a query back to
799
+ * `idle`, so the status change never races ahead of the rows it fetched.
800
+ * No-op when nothing is pending. The pending entry is removed before the
801
+ * await so a concurrently-firing timer can't process it twice.
802
+ */
803
+ flushPendingStreamUpdate(queryHash: string): Promise<void>;
804
+ /**
805
+ * Materialize a query's result rows from the local store.
806
+ *
807
+ * A query's rows are its MEMBERSHIP — the id-set the server put in
808
+ * `_00_list_ref` (`remoteArray`) — not "every local body that matches the
809
+ * WHERE". Those two disagree, and the disagreement was the bug: when a row
810
+ * leaves a query's window but still exists upstream, `handleRemovedRecords`
811
+ * keeps its local body and never re-fetches it, so a predicate re-scan finds
812
+ * that stale body still matching and keeps rendering the row. Selecting the
813
+ * id-set directly is also the only correct thing for a windowed query, where
814
+ * re-applying `START m` against the shared local store skips the window's own
815
+ * rows entirely (sparse windowing) and returns nothing.
816
+ *
817
+ * The rendered set is:
818
+ *
819
+ * (membership ∪ (pendingWrites ∩ localArray)) − pendingDeletes
820
+ *
821
+ * The middle term keeps optimistic writes visible without re-admitting stale
822
+ * rows. Every local write is fed to the SSP (`cache.saveBatch` →
823
+ * `ingestMany`), so `localArray` answers "does this row match the predicate
824
+ * per LOCAL truth". A pending write that moves a row into the window is in
825
+ * `localArray` and shows; one that moves a row out is absent and does not; a
826
+ * stale body the server dropped has no pending write at all, so it stays out.
827
+ * `pendingDeletes` covers the reverse lag — the server still lists a row whose
828
+ * DELETE is sitting in our outbox.
829
+ *
830
+ * Falls back to the predicate scan only when membership has never been
831
+ * established (a query first run on this device), so an offline first paint
832
+ * still shows something.
833
+ */
834
+ private materializeRecords;
835
+ /**
836
+ * The materialization itself, without the DevTools timing wrapper. Split out so
837
+ * cold-start seeding can use it before a `QueryState` exists.
838
+ */
839
+ private materializeFromConfig;
840
+ /**
841
+ * The authoritative membership list to render from, or `null` when membership
842
+ * has never been established and the caller must fall back to a scan.
843
+ *
844
+ * A windowed query has no usable fallback — re-running its `START m` locally
845
+ * returns the wrong rows — so it renders from whatever id-set is on hand
846
+ * (SSP's included) rather than degrading to a scan. That is the pre-existing
847
+ * behavior for windows and is preserved.
848
+ */
849
+ private resolveMembership;
850
+ private readonly settledWrites;
851
+ private readonly settledDeletes;
852
+ private pendingIds;
853
+ private pendingIdsAt;
854
+ private pendingIdsInflight;
855
+ private static readonly PENDING_IDS_TTL_MS;
856
+ private pendingIdsGen;
857
+ private static readonly PENDING_IDS_MAX_REREADS;
858
+ /** Drop the cached outbox ids. Cheap; call it on anything that could change
859
+ * `_00_pending_mutations`. */
860
+ private invalidatePendingIds;
861
+ /**
862
+ * Grace period for a settled write. Long enough to cover an SSP round trip
863
+ * that is running slowly (seconds, not milliseconds, when the edge path is
864
+ * backed up), short enough that a write the server silently dropped cannot
865
+ * linger misleadingly.
866
+ *
867
+ * The rejection case does NOT rely on this expiring: an application error
868
+ * rolls the mutation back and never reports it settled, so it vanishes at
869
+ * once. This deadline only bounds the case where the write succeeded and its
870
+ * membership never arrived at all.
871
+ */
872
+ private static readonly SETTLED_WRITE_GRACE_MS;
873
+ /**
874
+ * Report that a mutation was accepted by the server and its outbox row
875
+ * removed. Called only on the SUCCESS path — a rolled-back mutation must
876
+ * disappear immediately, which is what makes this safe.
877
+ */
878
+ noteWriteSettled(recordId: string, mutationType: string): void;
879
+ /** Drop entries past their deadline. */
880
+ private pruneSettled;
881
+ /** Apply the pending-write union and pending-delete subtraction, and map to
882
+ * RecordIds for the engines' id-set path. */
883
+ private buildRenderIds;
884
+ private processStreamUpdate;
885
+ /**
886
+ * Compute p55/p90/p99 from a rolling window of materialization samples.
887
+ * Returns nulls for any percentile that has no samples yet so SurrealDB
888
+ * `option<float>` columns stay NONE rather than 0 before the first ingest.
889
+ */
890
+ private computeMaterializationPercentiles;
891
+ /** Record a per-phase timing sample (ms) on a query's rolling window. */
892
+ private recordPhase;
893
+ /** Record the remote record-fetch time (ms) for a query. Called by the sync engine. */
894
+ recordRemoteFetch(hash: string, ms: number): void;
895
+ /**
896
+ * Record the frontend reconcile time (ms) for a query. Called from `useQuery`
897
+ * via `Sp00kyClient.reportFrontendTiming` after it applies an update to its store.
898
+ */
899
+ recordFrontendTiming(hash: string, ms: number): void;
900
+ /**
901
+ * Build the per-query processing-time breakdown surfaced to the DevTools panel
902
+ * and the MCP. `ssp` is the WASM-ingest wall time (from `materializationSamples`);
903
+ * the rest come from the per-phase rolling windows + one-shot registration timings.
904
+ */
905
+ phaseTimings(q: QueryState): QueryTimings;
906
+ /**
907
+ * Get query state (for sync and devtools)
908
+ */
909
+ getQueryByHash(hash: string): QueryState | undefined;
910
+ /**
911
+ * Cold-query guard for instant-hydrate: true when the query exists, hasn't been
912
+ * hydrated, and has NOT yet fetched its server result (`remoteArray` empty).
913
+ * We gate on `remoteArray`, not local `records`: a windowed query is often
914
+ * partially pre-seeded from the circuit (e.g. the dashboard's 5-row preview),
915
+ * but it still hasn't loaded its own full window from the server — so it should
916
+ * still hydrate. A warm re-subscribe (remoteArray already populated) is skipped.
917
+ */
918
+ isCold(hash: string): boolean;
919
+ /**
920
+ * Walk a hydrated record's fields and append any EMBEDDED child records to
921
+ * `batch` (recursing for nested related fields). An embedded child is a
922
+ * value that is itself a record — a non-null object whose `id` is a
923
+ * `RecordId` — or an array of such records (one-to-many vs one-to-one). A
924
+ * bare `RecordId` (a foreign-key reference) or any other value is skipped,
925
+ * so this never mistakes a FK column for an embedded body. Children are
926
+ * keyed by their own `record.id.table`, versioned by `_00_rv`, and cleaned
927
+ * to their table's real columns (which strips the alias/related fields).
928
+ * `seen` dedupes within the batch.
929
+ */
930
+ private collectEmbeddedChildren;
931
+ /**
932
+ * Prepare a subquery-bearing row (preload / hydration) for the schemafull
933
+ * local store: replace an embedded FORWARD-relation object (`author = { id, … }`)
934
+ * with its RecordId so a `record<…>` field coerces, and DROP reverse-subquery
935
+ * ARRAYS (`comments = [ … ]`) since their rows are cached separately as their
936
+ * own bodies. A flat record — as the live `SELECT * FROM $ids` sync returns,
937
+ * with relations already RecordIds — passes through unchanged.
938
+ */
939
+ private flattenRelationsForStorage;
940
+ /**
941
+ * Instant-hydrate: ingest rows fetched one-shot from the remote (the query's own
942
+ * surql run directly) so the query DISPLAYS immediately, while the full realtime
943
+ * registration proceeds in the background. Ingests with versions (`_00_rv`) so the
944
+ * later `syncRecords` dedup skips re-pulling unchanged bodies, and seeds
945
+ * `remoteArray` so windowed queries materialize the correct window (no sparse
946
+ * local-circuit issue). Runs at most once per query (the `hydrated` flag).
947
+ */
948
+ applyHydration(hash: string, rows: RecordWithId[]): Promise<void>;
949
+ /**
950
+ * Build the cache batch for a set of one-shot rows and persist it to the
951
+ * local DB + in-browser SSP. Maps each row to a `CREATE` op on its own table
952
+ * and extracts EMBEDDED related children (any nesting depth) as their own
953
+ * records — a `.related()` query returns its children embedded, and a later
954
+ * correlated re-materialization needs them present as standalone rows.
955
+ * Shared by `applyHydration` (live registration) and `persistSnapshot`
956
+ * (preload).
957
+ */
958
+ private buildAndSaveCacheBatch;
959
+ /**
960
+ * Preload/prewarm: persist one-shot rows (and their embedded related children)
961
+ * into the local cache WITHOUT registering a query — no `activeQueries` entry,
962
+ * no `_00_query` view, no TTL heartbeat. The rows live in the local DB as
963
+ * ordinary bodies (never GC'd on their own) so a later `useQuery` seeds its
964
+ * first paint from them instantly, then registers a live view to freshen.
965
+ */
966
+ persistSnapshot(tableName: string, rows: RecordWithId[]): Promise<void>;
967
+ /**
968
+ * Read the durable preload freshness marker for a query hash, or null if this
969
+ * query was never preloaded in the current bucket. Co-located with the cached
970
+ * rows (per-bucket `_00_preload` table) so a bucket switch that clears the
971
+ * data also clears the marker — a stale marker can't claim "warm" when the
972
+ * rows are gone. Any read error is treated as cold.
973
+ */
974
+ getPreloadMarker(hash: string): Promise<{
975
+ fetchedAt: number;
976
+ rowCount: number;
977
+ } | null>;
978
+ /** Stamp the preload freshness marker after a successful snapshot fetch. */
979
+ writePreloadMarker(hash: string, rowCount: number): Promise<void>;
980
+ /**
981
+ * Read the durable membership row, or `null` if this query has never had
982
+ * authoritative membership on this device. Any read error is treated as
983
+ * "unknown" so a broken row degrades to the predicate scan rather than
984
+ * rendering an empty list.
985
+ *
986
+ * `confirmed` is true only for rows written after the server itself vouched
987
+ * for the set (a non-empty id-set, or an empty one it reported a row count of
988
+ * zero for, or an empty one that followed a non-empty one in the same
989
+ * session). Rows written before the marker existed, including the `[]` rows a
990
+ * pre-`ea56f50e` client mirrored from an unflushed read, read as unconfirmed.
991
+ */
992
+ getWindowMembership(key: string): Promise<DurableMembership | null>;
993
+ /**
994
+ * Persist the durable membership row. Best-effort: callers must not fail a
995
+ * sync round because the mirror write failed.
996
+ *
997
+ * `confirmed` says whether a cold start may trust this row even when it is
998
+ * empty. A confirmed empty is a real answer ("the server says this query has
999
+ * no rows") and stays empty across a reload; an unconfirmed empty is the
1000
+ * retry budget's guess and falls back to the predicate scan on the next boot,
1001
+ * exactly as every empty row did before the marker existed.
1002
+ */
1003
+ writeWindowMembership(key: string, ids: RecordVersionArray, confirmed: boolean): Promise<void>;
1004
+ /**
1005
+ * Record ids with a mutation still in the outbox, split by direction.
1006
+ *
1007
+ * Both halves feed {@link materializeRecords}: `writes` keeps optimistic
1008
+ * creates/updates visible before the server has acknowledged them, and
1009
+ * `deletes` suppresses rows the server still lists because our DELETE hasn't
1010
+ * been processed yet. Reading `_00_pending_mutations` (rather than tracking
1011
+ * ids in memory) is what makes both survive a reload.
1012
+ *
1013
+ * On failure returns empty sets: membership alone then decides, which can
1014
+ * briefly hide an optimistic write but never resurrects a deleted row.
1015
+ */
1016
+ getPendingRecordIds(): Promise<{
1017
+ writes: Set<string>;
1018
+ deletes: Set<string>;
1019
+ }>;
1020
+ /** The uncached read. Also the reload path after an invalidation, so the ids
1021
+ * still survive a reload exactly as before. `gen` is the generation the read
1022
+ * was issued under; the result is cached only if it is still current. */
1023
+ private readPendingRecordIds;
1024
+ /** True while ≥1 live subscriber is watching this query (refcount guard). */
1025
+ hasSubscribers(hash: string): boolean;
1026
+ /**
1027
+ * Opt-in eager teardown for a query whose LAST subscriber just left — used by
1028
+ * viewport-windowed lists to cancel off-screen windows instead of leaving
1029
+ * their remote views to expire on the TTL sweep. No-op while any subscriber
1030
+ * remains (refcount). Only enqueues the remote cleanup here; the local WASM
1031
+ * view + in-memory state are freed in {@link finalizeDeregister} after the
1032
+ * remote delete completes, so a re-subscribe in between aborts/heals it.
1033
+ *
1034
+ * NOTE: most queries should NOT use this — the default keep-alive on
1035
+ * unsubscribe avoids re-registration churn on navigation.
1036
+ */
1037
+ deregisterQuery(hash: string): void;
1038
+ /**
1039
+ * Final local teardown after the remote `_00_query` row was deleted: free the
1040
+ * WASM view, heartbeat timer, debounce timer, and in-memory state. Caller
1041
+ * (`cleanupQuery`) guarantees no subscriber remains.
1042
+ */
1043
+ finalizeDeregister(hash: string): void;
1044
+ /**
1045
+ * Get query state by id (for sync and devtools)
1046
+ */
1047
+ getQueryById(id: RecordId<string>): QueryState | undefined;
1048
+ /**
1049
+ * Get all active queries (for devtools)
1050
+ */
1051
+ getActiveQueries(): QueryState[];
1052
+ getActiveQueryHashes(): QueryHash[];
1053
+ updateQueryLocalArray(id: string, localArray: RecordVersionArray): Promise<void>;
1054
+ updateQueryRemoteArray(hash: string, remoteArray: RecordVersionArray, opts?: {
1055
+ /** `_00_query.rowCount` read in the same round trip; `null` = unknown. */
1056
+ serverRowCount?: number | null;
1057
+ }): Promise<void>;
1058
+ /**
1059
+ * Cancel every armed timer ahead of a local-bucket switch: stream-update
1060
+ * debounce timers (their pending updates carry the OLD bucket's id-sets) and
1061
+ * per-query TTL heartbeats (they'd refresh the previous user's remote
1062
+ * `_00_query` rows under the new session). The rebind re-arms heartbeats.
1063
+ */
1064
+ quiesce(): void;
1065
+ /**
1066
+ * Re-home every active query in a freshly-opened bucket, KEEPING its hash —
1067
+ * `useQuery` subscriptions are keyed by hash and don't re-register on auth
1068
+ * changes, so the hooks must stay attached. Per query:
1069
+ * 1. reset the sync arrays + hydration flag and drop the previous user's
1070
+ * records, notifying subscribers with the new-bucket materialization
1071
+ * (usually empty) so their rows leave the UI immediately;
1072
+ * 2. recreate the `_00_query` row in the new bucket;
1073
+ * 3. re-register the SSP view on the (fresh, post-reset) processor — this
1074
+ * also rebinds the view to the NEW `$auth` context;
1075
+ * 4. restart the TTL heartbeat.
1076
+ * Returns the hashes so the caller can enqueue remote re-registration, which
1077
+ * refills records from the server via the normal register→sync→notify path.
1078
+ */
1079
+ rebindAfterBucketSwitch(): Promise<QueryHash[]>;
1080
+ /**
1081
+ * Called after a query's initial sync completes.
1082
+ * Ensures subscribers are notified even if no stream updates fired (e.g. empty result set).
1083
+ */
1084
+ notifyQuerySynced(queryHash: string): Promise<void>;
1085
+ run<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(backend: B, path: R, data: RoutePayload<S, B, R>, options?: RunOptions): Promise<void>;
1086
+ /**
1087
+ * Build the outbox job record + resolve its table for a backend route.
1088
+ *
1089
+ * Every job is a single execution. Recurring work is declared server-side
1090
+ * (`schedules:` in sp00ky.yml) and the scheduler creates a fresh row per cycle,
1091
+ * so nothing here needs to know about schedules.
1092
+ */
1093
+ private buildJobRecord;
1094
+ /**
1095
+ * Create a new record
1096
+ */
1097
+ create<T extends Record<string, unknown>>(id: string, data: T): Promise<T>;
1098
+ /**
1099
+ * Update an existing record
1100
+ */
1101
+ update<T extends Record<string, unknown>>(table: string, id: string, data: Partial<T>, options?: UpdateOptions): Promise<T>;
1102
+ /**
1103
+ * Delete a record
1104
+ */
1105
+ delete(table: string, id: string): Promise<void>;
1106
+ /**
1107
+ * Rollback a failed optimistic create by deleting the record locally
1108
+ */
1109
+ rollbackCreate(recordId: RecordId, tableName: string): Promise<void>;
1110
+ /**
1111
+ * Rollback a failed optimistic update by restoring the previous record state
1112
+ */
1113
+ rollbackUpdate(recordId: RecordId, tableName: string, beforeRecord: Record<string, unknown>): Promise<void>;
1114
+ /**
1115
+ * Force a re-materialize + notify of every active query on `tableName`.
1116
+ * Used after a DELETE landed in the local store (this tab's own, or one
1117
+ * relayed from another tab): the SSP may not emit a view update for a
1118
+ * DELETE ingest, and the re-materialize reads the store, which already
1119
+ * excludes the row. Each query is isolated so one failing re-materialize
1120
+ * can't stop the others.
1121
+ */
1122
+ notifyTableQueries(tableName: string): Promise<void>;
1123
+ /**
1124
+ * Remove a record from all active query states and notify subscribers
1125
+ */
1126
+ private removeRecordFromQueries;
1127
+ private createAndRegisterQuery;
1128
+ private createNewQuery;
1129
+ private calculateHash;
1130
+ /**
1131
+ * Session-independent counterpart of {@link calculateHash}: the key for a
1132
+ * query's durable `_00_window` membership row.
1133
+ *
1134
+ * Deliberately the SAME inputs minus the `session::id()` salt, so the two keys
1135
+ * can never drift apart. The salt is right for `_00_query` (two tabs must not
1136
+ * fight over one row) and wrong for membership, which has to be recognizable
1137
+ * after a reload — a reload mints a new session id, and offline the salt is
1138
+ * `''`, so a salted key can never match what the previous session wrote.
1139
+ */
1140
+ private calculateMembershipKey;
1141
+ private sha256;
1142
+ private startTTLHeartbeat;
1143
+ private replaceRecordInQueries;
1144
+ }
1145
+ /**
1146
+ * Parse update options to generate push event options
1147
+ */
1148
+ //#endregion
1149
+ //#region src/services/tabs/protocol.d.ts
1150
+ type TabId = string;
1151
+ type TabRole = 'solo' | 'leader' | 'follower';
1152
+ /** Broker pings every tab at this cadence. */
1153
+
1154
+ /** Matches `CacheIngestTuple` (modules/cache): exactly what `ingestMany`
1155
+ * consumes, so relayed batches feed follower circuits without reshaping. */
1156
+ interface IngestTuple {
1157
+ table: string;
1158
+ op: 'CREATE' | 'UPDATE' | 'DELETE';
1159
+ id: string;
1160
+ record: Record<string, unknown>;
1161
+ }
1162
+ type FollowerToLeaderMessage = {
1163
+ type: 'sync-hello';
1164
+ tabId: TabId;
1165
+ }
1166
+ /** The follower committed an outbox row (through the shared store) and the
1167
+ * leader should drain it. Idempotent; a new leader's loadFromDatabase is
1168
+ * the backstop for a notify lost in a failover window. */ | {
1169
+ type: 'mutation-enqueued';
1170
+ mutationId: string;
1171
+ } | {
1172
+ type: 'request-poll';
1173
+ }
1174
+ /** An optimistic write this follower committed to the SHARED store and
1175
+ * ingested into its own circuit. The leader ingests it (no DB write, the
1176
+ * row is already there) and fans it out to every OTHER follower as
1177
+ * `ingest-relay`, so a follower's write lands in every tab in one hop
1178
+ * instead of after the server round-trip. */ | {
1179
+ type: 'ingest';
1180
+ tuples: IngestTuple[];
1181
+ };
1182
+ type LeaderToFollowerMessage = {
1183
+ type: 'db-ready';
1184
+ leadershipId: number;
1185
+ bucketId: string;
1186
+ storageHealth: StorageHealth;
1187
+ }
1188
+ /** Every ingest the leader's CacheModule committed, so follower circuits
1189
+ * stay live without their own fetch. seq detects gaps. */ | {
1190
+ type: 'ingest-relay';
1191
+ tuples: IngestTuple[];
1192
+ leadershipId: number;
1193
+ seq: number;
1194
+ }
1195
+ /** A `_00_list_ref` LIVE event, relayed verbatim. Each follower resolves the
1196
+ * queryId against its own DataModule and ignores foreign queries. */ | {
1197
+ type: 'list-ref-change';
1198
+ action: 'CREATE' | 'UPDATE' | 'DELETE';
1199
+ queryId: string;
1200
+ recordId: string;
1201
+ version: number;
1202
+ parent: boolean;
1203
+ }
1204
+ /** The leader's drain rolled back a mutation owned by this tab. */ | {
1205
+ type: 'mutation-rolled-back';
1206
+ mutationId: string;
1207
+ recordId: string;
1208
+ eventType: 'create' | 'update' | 'delete';
1209
+ error: string;
1210
+ }
1211
+ /** The leader's drain pushed a mutation and deleted its outbox row from the
1212
+ * SHARED store. Every follower starts its settled-write grace so a row it
1213
+ * was rendering as a pending write does not blink out before its
1214
+ * `_00_list_ref` membership arrives. */ | {
1215
+ type: 'mutation-settled';
1216
+ mutationId: string;
1217
+ recordId: string;
1218
+ eventType: 'create' | 'update' | 'delete';
1219
+ };
1220
+ //#endregion
1221
+ //#region src/services/tabs/coordinator.d.ts
1222
+ /** Leader-side fan-out surface handed to the sync layer. The sync router
1223
+ * (modules/sync/tab-router.ts) registers itself as the message handler. */
1224
+ declare class LeaderSyncHub {
1225
+ readonly leadershipId: number;
1226
+ private logger;
1227
+ private followers;
1228
+ private seq;
1229
+ onFollowerMessage: ((tabId: TabId, msg: FollowerToLeaderMessage) => void) | null;
1230
+ onFollowerDetached: ((tabId: TabId) => void) | null;
1231
+ constructor(leadershipId: number, logger: Logger$1);
1232
+ attach(tabId: TabId, port: MessagePort): void;
1233
+ detach(tabId: TabId): void;
1234
+ detachAll(): void;
1235
+ sendTo(tabId: TabId, msg: LeaderToFollowerMessage): void;
1236
+ broadcast(msg: LeaderToFollowerMessage, exceptTabId?: TabId): void;
1237
+ /** Stamped ingest relay; seq lets followers detect gaps. */
1238
+ relayIngest(tuples: IngestTuple[], exceptTabId?: TabId): void;
1239
+ get followerCount(): number;
1240
+ get relayedBatches(): number;
1241
+ }
1242
+ /** Follower half of the syncPort. Queues while detached (leaderless window)
1243
+ * and flushes on rebind; a lost-in-flight mutation notify is additionally
1244
+ * backstopped by the new leader reloading the shared outbox from the store. */
1245
+ declare class SyncForwarder {
1246
+ private tabId;
1247
+ private port;
1248
+ private queued;
1249
+ onLeaderMessage: ((msg: LeaderToFollowerMessage) => void) | null;
1250
+ constructor(tabId: TabId);
1251
+ rebind(port: MessagePort): void;
1252
+ unbind(): void;
1253
+ private post;
1254
+ mutationEnqueued(mutationId: string): void;
1255
+ /** An optimistic write this tab just ingested. Deliberately NOT queued while
1256
+ * detached: a new leader primes its circuit from the shared store, which
1257
+ * already holds the row, and replaying a stale tuple at it later would put
1258
+ * an older `_00_rv` in its version memo. */
1259
+ ingest(tuples: IngestTuple[]): void;
1260
+ requestPoll(): void;
1261
+ }
1262
+ //#endregion
1263
+ //#region src/modules/sync/sync.d.ts
1264
+ /**
1265
+ * Tunables for `Sp00kySync` construction.
1266
+ */
1267
+ interface Sp00kySyncOptions {
1268
+ /**
1269
+ * Cadence (ms) for the `_00_list_ref` poll fallback that catches
1270
+ * cross-session UPDATEs the LIVE-permission gap drops. Non-positive
1271
+ * values fall back to the default; see
1272
+ * {@link resolveListRefPollInterval}.
1273
+ */
1274
+ refSyncIntervalMs?: number;
1275
+ /**
1276
+ * Enable realtime sync for unauthenticated clients against the shared
1277
+ * `_00_list_ref_anon` table. See {@link Sp00kyConfig.enableAnonymousLiveQueries}.
1278
+ * Defaults to `false`.
1279
+ */
1280
+ anonymousLiveQueries?: boolean;
1281
+ /**
1282
+ * Consecutive failed sync rounds before sync health flips to `degraded`.
1283
+ * `0` disables degraded reporting. See {@link Sp00kyConfig.syncHealth}.
1284
+ * Defaults to `3`.
1285
+ */
1286
+ degradeAfterConsecutiveFailures?: number;
1287
+ /**
1288
+ * Max time a single mutation push may take before it is treated as a network
1289
+ * failure and retried. Guards against an RPC that never settles wedging the
1290
+ * up-queue for the session. Defaults to 30000; `0` disables the timeout.
1291
+ */
1292
+ pushTimeoutMs?: number;
1293
+ /**
1294
+ * Max time a single down event (`register`/`sync`/`cleanup`) may take before
1295
+ * it is treated as a network failure and retried. The mirror of
1296
+ * {@link pushTimeoutMs} for the read side, which had no such guard: a
1297
+ * `fn::query::register` that never settled held its slot in the down drain,
1298
+ * and every later registration behind it, for the rest of the session.
1299
+ * Defaults to 30000; `0` disables the timeout.
1300
+ */
1301
+ downTimeoutMs?: number;
1302
+ /**
1303
+ * Transport supervisor. Sync reads its state to report `connection` in
1304
+ * {@link SyncHealth} so a UI can show "reconnecting…" the instant the socket
1305
+ * drops, without waiting for the degrade threshold. Optional: omitted in
1306
+ * tests, where `connection` then reports `connected`.
1307
+ */
1308
+ connectionSupervisor?: ConnectionSupervisor;
1309
+ }
1310
+ /**
1311
+ * The main synchronization engine for Sp00ky.
1312
+ * Handles the bidirectional synchronization between the local database and the remote backend.
1313
+ * Uses a queue-based architecture with 'up' (local to remote) and 'down' (remote to local) queues.
1314
+ * @template S The schema structure type.
1315
+ */
1316
+ declare class Sp00kySync<S extends SchemaStructure> {
1317
+ private local;
1318
+ private remote;
1319
+ private cache;
1320
+ private dataModule;
1321
+ private schema;
1322
+ private upQueue;
1323
+ private downQueue;
1324
+ private isInit;
1325
+ private logger;
1326
+ private syncEngine;
1327
+ /** Engine-level events (e.g. `SYNC_REMOTE_DATA_INGESTED`). Distinct
1328
+ * from `this.events`, which carries Sp00kySync-level events like
1329
+ * `SYNC_QUERY_UPDATED` and `SYNC_MUTATION_ROLLED_BACK`. */
1330
+ get engineEvents(): SyncEventSystem;
1331
+ private scheduler;
1332
+ /**
1333
+ * Set by any event that means the socket we registered on is gone, so the
1334
+ * next `connected` knows it must re-subscribe rather than treat itself as the
1335
+ * initial connect. See {@link subscribeToReconnect}.
1336
+ */
1337
+ private needsResubscribe;
1338
+ /** When the last reconnect-driven full refetch ran, for burst coalescing. */
1339
+ private lastReconnectRefetchAt;
1340
+ /**
1341
+ * Minimum gap between reconnect-driven full refetches. Long enough to absorb
1342
+ * a flapping socket (the SDK reconnect ladder starts at 1s), short enough
1343
+ * that a genuine drop minutes later still refetches.
1344
+ */
1345
+ private static readonly RECONNECT_REFETCH_COOLDOWN_MS;
1346
+ /** Poll interval while waiting for a reconnected session to re-authenticate. */
1347
+ private static readonly AUTH_READY_RETRY_MS;
1348
+ /** Attempts before giving up on re-auth and skipping the refetch entirely. */
1349
+ private static readonly AUTH_READY_MAX_ATTEMPTS;
1350
+ events: SyncEventSystem;
1351
+ private currentUserId;
1352
+ private tabRole;
1353
+ private tabId;
1354
+ private hub;
1355
+ private forwarder;
1356
+ private refMode;
1357
+ private readonly anonLiveEnabled;
1358
+ private currentLiveQueryUuid;
1359
+ private liveQueryUnsubscribe;
1360
+ private listRefPollTimer;
1361
+ private listRefPollRunning;
1362
+ private listRefPollInFlight;
1363
+ readonly refSyncIntervalMs: number;
1364
+ private listRefIdleStreak;
1365
+ private stillRemoteStreaks;
1366
+ private lastLiveEventAt;
1367
+ private _liveRetryCount;
1368
+ get liveRetryCount(): number;
1369
+ get isSyncing(): boolean;
1370
+ get pendingMutationCount(): number;
1371
+ subscribeToPendingMutations(cb: (count: number) => void): () => void;
1372
+ private readonly degradeAfterFailures;
1373
+ /** Per-push RPC deadline; see {@link withPushTimeout}. */
1374
+ private readonly pushTimeoutMs;
1375
+ private readonly downTimeoutMs;
1376
+ private consecutiveSyncFailures;
1377
+ private syncHealthStatus;
1378
+ private lastSyncErrorKind;
1379
+ private lastSyncErrorMessage;
1380
+ private hasSyncedOnce;
1381
+ private selfHealTimer;
1382
+ private selfHealAttempts;
1383
+ private static readonly SELF_HEAL_BASE_MS;
1384
+ private static readonly SELF_HEAL_MAX_MS;
1385
+ /**
1386
+ * Transport supervisor, when one was supplied. Sync only reads state from it;
1387
+ * it never drives reconnects itself.
1388
+ */
1389
+ private readonly connectionSupervisor?;
1390
+ /**
1391
+ * Mirror of the supervisor's state. Defaults to `connected` so a client
1392
+ * constructed without a supervisor (tests, embedders) reports the same health
1393
+ * shape it always has rather than a permanent false "disconnected".
1394
+ */
1395
+ private connectionState;
1396
+ /** Current sync-health snapshot. */
1397
+ get syncHealth(): SyncHealth;
1398
+ /**
1399
+ * Observe sync health. The callback fires immediately with the current
1400
+ * status and again on every healthy↔degraded transition. Returns an
1401
+ * unsubscribe. Mirrors {@link subscribeToPendingMutations}.
1402
+ */
1403
+ subscribeToSyncHealth(cb: (health: SyncHealth) => void): () => void;
1404
+ private emitSyncHealth;
1405
+ /**
1406
+ * Mirror the supervisor's transport state into {@link SyncHealth} and emit on
1407
+ * every change, so a UI can react to a dropped socket immediately instead of
1408
+ * waiting for `degradeAfterFailures` failed rounds. `status` is untouched:
1409
+ * a brief reconnect is not a degradation.
1410
+ *
1411
+ * No explicit unsubscribe: the supervisor is owned by the same client and
1412
+ * drops all subscribers in its own `dispose()`, which `Sp00kyClient.close()`
1413
+ * calls first.
1414
+ */
1415
+ private subscribeToConnectionState;
1416
+ /**
1417
+ * Fed by the scheduler once per drained sync round. Individual failures are
1418
+ * absorbed by the queue's retry; only a run of `degradeAfterFailures`
1419
+ * consecutive failures flips the status to `degraded`, and the next clean
1420
+ * round flips it back. No-op when reporting is disabled (`degradeAfterFailures`
1421
+ * is 0).
1422
+ */
1423
+ private recordSyncOutcome;
1424
+ /**
1425
+ * Begin self-heal retries (no-op if already running). Started on the
1426
+ * healthy→degraded transition; {@link recordSyncOutcome} stops it on recovery.
1427
+ */
1428
+ private startSelfHeal;
1429
+ private scheduleSelfHeal;
1430
+ private stopSelfHeal;
1431
+ /**
1432
+ * Release a deregistered query's remote view immediately instead of leaving
1433
+ * it to the TTL sweep. Off by default; see the reasoning in
1434
+ * {@link cleanupQuery}. Kept as a field rather than deleted so the eager path
1435
+ * can be re-enabled in a test once the subquery-body repair path exists.
1436
+ */
1437
+ private readonly releaseQueriesEagerly;
1438
+ constructor(local: LocalStore, remote: RemoteDatabaseService, cache: CacheModule, dataModule: DataModule<S>, schema: S, logger: Logger$1, options?: Sp00kySyncOptions);
1439
+ /**
1440
+ * Initializes the synchronization system.
1441
+ * Starts the scheduler and initiates the initial sync cycles.
1442
+ * @throws Error if already initialized.
1443
+ */
1444
+ init(): Promise<void>;
1445
+ /** Set BEFORE init(): shapes what init boots (a follower loads no outbox and
1446
+ * never starts LIVE; its own registration/poll paths stay untouched). */
1447
+ setTabContext(role: 'solo' | 'leader' | 'follower', tabId: string | null): void;
1448
+ /** In-flight {@link resumeLeaderDuties}, so a second call joins the first
1449
+ * instead of double-draining the outbox. */
1450
+ private leaderDutiesInFlight;
1451
+ /** Resolves once the in-browser circuit has been primed from the local
1452
+ * store. Every sync diff waits on it: diffing against an empty circuit
1453
+ * classifies the whole working set as missing and re-downloads it. */
1454
+ private primeGate;
1455
+ /** The prime we last waited on. `whenPrimed` hands out one promise per
1456
+ * prime, so a new identity means a new prime (boot, bucket switch) ran. */
1457
+ private settledPrime;
1458
+ setPrimeGate(gate: () => Promise<void>): void;
1459
+ /**
1460
+ * Leader WIRING only, and deliberately synchronous.
1461
+ *
1462
+ * The coordinator publishes the leader role and tells the broker
1463
+ * `leader-ready` the moment the store is adopted, and the broker can mint a
1464
+ * follower's ports on the very next tick. So the follower-message handler
1465
+ * has to be live before this returns, or a mutation forwarded in that window
1466
+ * is dropped. Everything that can block (outbox reload, LIVE restart) moved
1467
+ * to {@link resumeLeaderDuties}: a promotion that waits on the network holds
1468
+ * `leader-ready` back, and a broker whose leader never reports ready serves
1469
+ * no follower ports and re-elects no one, which wedges the whole namespace.
1470
+ */
1471
+ promoteToLeader(hub: LeaderSyncHub): void;
1472
+ /** Leader duties: drain the shared outbox, own the single list_ref LIVE,
1473
+ * relay LIVE events and rollbacks to followers. Idempotent for a boot-time
1474
+ * leader; a runtime promotion (failover) reloads the outbox, which now
1475
+ * holds EVERY tab's rows, and restarts LIVE under this session. Runs in the
1476
+ * background off the promotion path, so however long it takes (or if it
1477
+ * never finishes) the tab is already a working leader. */
1478
+ resumeLeaderDuties(): Promise<void>;
1479
+ /** Follower duties: no outbox drain, no LIVE. Mutations forward to the
1480
+ * leader; everything else (registration, per-query sync, poll) runs
1481
+ * against this tab's own remote session as usual. */
1482
+ demoteToFollower(forwarder: SyncForwarder): void;
1483
+ /**
1484
+ * A pending mutation was discarded because it can never be sent.
1485
+ *
1486
+ * This is a lost write, so it must not stay invisible. Every failure in this
1487
+ * chain used to be a `logger.error` an app running `logLevel: 'fatal'` never
1488
+ * shows, which is how an outbox could sit undrained for hours with the UI
1489
+ * reporting nothing. Surfaces as a rollback event (the mutation will never
1490
+ * apply, which is what a subscriber needs to know) and degrades sync health.
1491
+ */
1492
+ private onMutationDropped;
1493
+ /** A forwarded outbox row from a follower: load + drain it. Idempotent. */
1494
+ enqueueForwardedMutation(mutationId: string): Promise<void>;
1495
+ /**
1496
+ * Tuples another tab already committed to the shared store: feed them to
1497
+ * THIS tab's circuit (no local write). A DELETE additionally forces a
1498
+ * re-materialize of the table's queries, exactly as the writing tab does
1499
+ * for itself, because the SSP may not emit a view update for it.
1500
+ */
1501
+ private applyRelayedIngest;
1502
+ /** A relayed `_00_list_ref` LIVE event: resolve against THIS tab's queries
1503
+ * and run the exact same handling the LIVE subscription would have. */
1504
+ private applyRelayedListRefChange;
1505
+ /** One immediate poll cycle (failover convergence). */
1506
+ forcePollRound(): Promise<void>;
1507
+ /**
1508
+ * Quiesce all sync activity ahead of a local-bucket switch. After this
1509
+ * resolves, nothing in the sync module writes to the local store: the poll
1510
+ * loop is stopped AND its in-flight tick awaited, LIVE is killed, debounce
1511
+ * timers are cancelled (their outbox rows are already persisted), and the
1512
+ * scheduler has drained its in-flight queue item — including that item's
1513
+ * outbox-row delete, which must land in the OLD bucket. Queued down-events
1514
+ * are dropped (they reference old-bucket query rows; the post-switch rebind
1515
+ * re-enqueues registrations). The old user's un-pushed outbox is deliberately
1516
+ * NOT drained: the remote session already belongs to the next user.
1517
+ */
1518
+ prepareBucketSwitch(): Promise<void>;
1519
+ /**
1520
+ * Resume syncing against the freshly-opened bucket: reload the mutation
1521
+ * outbox from ITS `_00_pending_mutations` (the new user's own un-pushed
1522
+ * offline work) and restart the scheduler. LIVE + the list_ref poll restart
1523
+ * via the `setCurrentUserId` call that follows in the auth listener.
1524
+ */
1525
+ completeBucketSwitch(): Promise<void>;
1526
+ /**
1527
+ * Push the authenticated user's record id from the parent client's
1528
+ * auth subscription. Tears down the existing `_00_list_ref` LIVE (if
1529
+ * any) and re-registers it under the new user's dedicated table so
1530
+ * SurrealDB binds the permission rule under the post-flip auth
1531
+ * context. Pass `null` on sign-out.
1532
+ *
1533
+ * The dedicated `_00_list_ref_user_<id>` table is created lazily by
1534
+ * the SSP when the first query registration arrives, which may be
1535
+ * concurrent with this call. We retry the LIVE registration with a
1536
+ * short backoff so a "table not found" race resolves without
1537
+ * surfacing as a permanent auth-loading hang.
1538
+ */
1539
+ setCurrentUserId(userId: string | null): Promise<void>;
1540
+ private startListRefPoll;
1541
+ private stopListRefPoll;
1542
+ /**
1543
+ * One poll cycle: refetch `_00_list_ref` for every active query. Returns
1544
+ * whether ANY query's remoteArray actually changed — the scheduler uses this
1545
+ * to drive the adaptive idle backoff.
1546
+ *
1547
+ * Also the ONLY health signal that runs while the page is idle. Sync health is
1548
+ * otherwise activity-driven (mutations/registrations via the scheduler,
1549
+ * reconnect re-registration, self-heal), so on a quiet page a stale `degraded`
1550
+ * would linger until the next mutation and a genuine idle drop would be
1551
+ * invisible. We fold the cycle's aggregate reachability into `recordSyncOutcome`
1552
+ * so idle health self-recovers (and self-degrades) with no user action. A clean
1553
+ * cycle is idempotent when already healthy (`recordSyncOutcome` early-returns at
1554
+ * `consecutiveSyncFailures === 0`), so a healthy idle page pays nothing.
1555
+ */
1556
+ private pollListRefForActiveQueries;
1557
+ /**
1558
+ * Pull the upstream list_ref entries for `queryHash`, diff them
1559
+ * against the local `remoteArray` cache, sync any added/updated rows
1560
+ * through the SyncEngine, then persist the new remoteArray. This is
1561
+ * the same shape `createRemoteQuery` does for its initial fetch and
1562
+ * what `handleRemoteListRefChange` does per-LIVE-event — we reuse
1563
+ * it on a timer as a fallback for missed LIVE notifications.
1564
+ */
1565
+ private refetchListRefForQuery;
1566
+ /**
1567
+ * Resolve the current `_00_list_ref` table name for the active auth
1568
+ * context. Public so the `createRemoteQuery` initial-fetch path can
1569
+ * read from the right per-user table.
1570
+ *
1571
+ * Reads the user id from `DataModule` rather than the local mirror,
1572
+ * because `DataModule.setCurrentUserId` runs synchronously from the
1573
+ * auth callback (before any `await`), whereas `sync.setCurrentUserId`
1574
+ * is async — the userQuery's initial fetch can fire between those
1575
+ * two points and we need the correct table name immediately.
1576
+ */
1577
+ listRefTable(): string;
1578
+ private killRefLiveQuery;
1579
+ private restartRefLiveQuery;
1580
+ /**
1581
+ * Drop local LIVE bookkeeping without issuing a `KILL`.
1582
+ *
1583
+ * Called when the socket dies. The server-side subscription is scoped to that
1584
+ * WebSocket session and died with it, so there is nothing left to kill — and
1585
+ * by the time the reconnect handler runs, the client reports `connected`
1586
+ * again, which would otherwise send a `KILL` for a stale uuid on the *new*
1587
+ * session and hold up the restart queued behind it.
1588
+ */
1589
+ private invalidateRefLiveQuery;
1590
+ private subscribeToReconnect;
1591
+ /**
1592
+ * Whether the REMOTE SESSION currently carries `$auth.id`.
1593
+ *
1594
+ * Not the same question as `currentUserId`, and that gap is the whole point:
1595
+ * `currentUserId` is this client's own record of who signed in and survives a
1596
+ * socket drop untouched, while `$auth` lives on the WebSocket session and has
1597
+ * to be re-applied after every reconnect. Registering in the window between
1598
+ * the two is silently destructive, because `fn::query::register` sends
1599
+ * `<string>($auth.id OR '')` and the SSP stores that value write-once: the
1600
+ * view's edges then route to the global `_00_list_ref` stamped `auth_id = ''`,
1601
+ * which that table's own permission rule (`auth_id = $auth.id`) makes
1602
+ * unreadable to the very user who registered it.
1603
+ *
1604
+ * Signed-out clients answer `true`: `''` is the honest identity there, not a
1605
+ * race.
1606
+ */
1607
+ private remoteAuthEstablished;
1608
+ /**
1609
+ * Wait for the reconnected session to carry an identity again, then
1610
+ * re-register every active query and re-bind LIVE.
1611
+ *
1612
+ * Giving up without registering is deliberately better than registering
1613
+ * anyway: a registration made with no `$auth.id` produces a view its own
1614
+ * owner cannot read, and it is write-once, so it stays that way. Skipping
1615
+ * leaves the query unregistered and visibly loading, which the next
1616
+ * reconnect or heartbeat retries.
1617
+ */
1618
+ private refetchAfterReconnect;
1619
+ private startRefLiveQueries;
1620
+ private handleRemoteListRefChange;
1621
+ /**
1622
+ * Handle a LIVE change to a SUBQUERY child edge (a `_00_list_ref` row with
1623
+ * `parent` set) for a `.related()` query. Unlike primary rows, child rows
1624
+ * must NOT touch the query's `localArray`/`remoteArray`/`rowCount`; we only
1625
+ * keep the child BODY fresh in the local cache so the in-browser SSP's
1626
+ * subquery-table dependency re-materializes the parent view.
1627
+ *
1628
+ * CREATE/UPDATE fetch+upsert the child body. DELETE is intentionally a
1629
+ * no-op: a child leaving this query's set must not delete a body another
1630
+ * query may still show (see `syncSubqueryChildren` deletion-safety note);
1631
+ * a genuine record delete propagates via the normal delete path.
1632
+ */
1633
+ private handleRemoteSubqueryChange;
1634
+ /**
1635
+ * Enqueues a 'down' event (from remote to local) for processing.
1636
+ * @param event The DownEvent to enqueue.
1637
+ */
1638
+ enqueueDownEvent(event: DownEvent): void;
1639
+ /**
1640
+ * Bound a mutation push so it always settles.
1641
+ *
1642
+ * `SyncScheduler.syncUp` early-returns while `isSyncingUp` is true, and that
1643
+ * flag only clears in the `finally` of the drain loop. A push whose RPC never
1644
+ * settles (socket dropped mid-flight, response lost) therefore wedges the
1645
+ * up-queue for the rest of the session: no retry, no error, no further
1646
+ * mutation ever sent. A timeout turns that into an ordinary network failure,
1647
+ * which `UpQueue.next` re-queues for the next trigger. The message deliberately
1648
+ * contains "timed out" so `classifySyncError` treats it as `network` and
1649
+ * retries rather than rolling the mutation back.
1650
+ */
1651
+ private withPushTimeout;
1652
+ private processUpEvent;
1653
+ /**
1654
+ * A mutation the server accepted, reported once its outbox row is gone.
1655
+ *
1656
+ * Keeps the written row in the render set until its membership arrives.
1657
+ * Without this the row is briefly in neither term of
1658
+ * `(membership ∪ pendingWrites) − pendingDeletes` — the outbox delete is
1659
+ * tied to the push, while membership waits on the SSP ingesting the row,
1660
+ * materializing the view, writing the `_00_list_ref` edge and this client
1661
+ * reading it back. The writer therefore watched its own comment appear,
1662
+ * vanish, and return, while every other client showed it throughout.
1663
+ */
1664
+ private handleMutationSettled;
1665
+ private handleRollback;
1666
+ private processDownEvent;
1667
+ private withDownTimeout;
1668
+ private runDownEvent;
1669
+ /**
1670
+ * Synchronizes a specific query by hash.
1671
+ * Compares local and remote version arrays and fetches differences.
1672
+ * @param hash The hash of the query to sync.
1673
+ */
1674
+ syncQuery(hash: string): Promise<void>;
1675
+ /**
1676
+ * Run a sync for a single query while reflecting its fetch status. Marks the
1677
+ * query `fetching` for the duration when the diff actually pulls records
1678
+ * (added/updated), then resets to `idle` in a `finally` so a failed sync
1679
+ * never leaves a query stuck `fetching`. Part A's notification coalescing
1680
+ * means the single resulting UI update lands after this completes.
1681
+ */
1682
+ private runSyncForQuery;
1683
+ /**
1684
+ * Record ids with a pending local DELETE in the outbox (`_00_pending_mutations`).
1685
+ * Sync must not re-fetch/re-insert these — the remote delete is async, so the
1686
+ * server's `_00_list_ref` still lists them until it's processed, and the diff
1687
+ * would otherwise resurrect a just-deleted record.
1688
+ */
1689
+ private getPendingDeleteIds;
1690
+ /**
1691
+ * Enqueues a list of mutations (up events) to be sent to the remote.
1692
+ * @param mutations Array of UpEvents (create/update/delete) to enqueue.
1693
+ */
1694
+ enqueueMutation(mutations: UpEvent[]): Promise<void>;
1695
+ /**
1696
+ * Best-effort release of THIS tab's views as the page goes away.
1697
+ *
1698
+ * Without it a closed tab's views stay materialized on the SSP for a full
1699
+ * TTL (10 minutes by default), because nothing else tears them down:
1700
+ * `releaseQueriesEagerly` is off, so the TTL sweep is the only reclaim path.
1701
+ * On a busy tenant that is a generation of live views per reload, each still
1702
+ * being stepped by every ingest, for ten minutes after the last human left.
1703
+ *
1704
+ * This is NOT `releaseQueriesEagerly` re-enabled. That released views
1705
+ * mid-session on a viewport change and tore the window out from under a live
1706
+ * page (see `cleanupQuery`); this runs only when the page itself is going
1707
+ * away and nothing is left to render.
1708
+ *
1709
+ * Safe against other tabs by construction: `fn::query::unsubscribe` drops
1710
+ * only this session from `subscribers` and deletes the row solely when it
1711
+ * was the last one, so a second tab of the same user keeps its view.
1712
+ *
1713
+ * One statement, not one per id: an unload handler gets a few milliseconds,
1714
+ * and N round trips would not survive it. Fire-and-forget — if the frame
1715
+ * does not make it out, the TTL sweep still reclaims exactly as before, so
1716
+ * the worst case is today's behaviour.
1717
+ */
1718
+ releaseViewsOnUnload(): void;
1719
+ private registerQuery;
1720
+ private createRemoteQuery;
1721
+ /**
1722
+ * Sync the BODIES of a `.related()` query's subquery child rows into the
1723
+ * local cache, separately from the primary window array. The SSP writes
1724
+ * each matched child as a `_00_list_ref` edge tagged `parent`/`parent_rel`;
1725
+ * `buildSubqueryListRefSelect` pulls those `out`+`version` pairs (any
1726
+ * nesting depth). We diff against the in-memory `subqueryRemoteArray` and
1727
+ * fetch added/updated bodies through the SyncEngine — which `saveBatch`s
1728
+ * them into the local DB AND the in-browser SSP, whose subquery-table
1729
+ * dependency then re-materializes the parent view (no explicit notify).
1730
+ *
1731
+ * Deletion safety: we pass `removed: []` deliberately. A child body can be
1732
+ * shared by other queries; letting `handleRemovedRecords` delete one that
1733
+ * merely left THIS query's child set would clobber data another query still
1734
+ * shows. Genuine record deletes flow through the normal delete path; a
1735
+ * lingering orphan body is invisible (the correlated WHERE stops matching).
1736
+ *
1737
+ * Kept off `runSyncForQuery` on purpose so child fetches never flip the
1738
+ * query to `fetching` or skew its DevTools timings.
1739
+ */
1740
+ private syncSubqueryChildren;
1741
+ heartbeatQuery(queryHash: string): Promise<void>;
1742
+ private cleanupQuery;
1743
+ }
1744
+ //#endregion
150
1745
  //#region src/modules/auth/events/index.d.ts
151
1746
  declare const AuthEventTypes: {
152
1747
  readonly AuthStateChanged: "AUTH_STATE_CHANGED";
@@ -169,6 +1764,13 @@ declare class AuthService<S extends SchemaStructure> {
169
1764
  token: string | null;
170
1765
  currentUser: any | null;
171
1766
  isAuthenticated: boolean;
1767
+ /**
1768
+ * The record-access method name for the current session (e.g. `"account"`),
1769
+ * derived from the token's `AC` claim. Consumed by the in-browser SSP's
1770
+ * permission injection so `$access`-gated table predicates resolve locally,
1771
+ * mirroring the server's `$access`. Null when logged out.
1772
+ */
1773
+ access: string | null;
172
1774
  isLoading: boolean;
173
1775
  private events;
174
1776
  get eventSystem(): AuthEventSystem;
@@ -181,6 +1783,24 @@ declare class AuthService<S extends SchemaStructure> {
181
1783
  */
182
1784
  subscribe(cb: (userId: string | null) => void): () => void;
183
1785
  private notifyListeners;
1786
+ /**
1787
+ * Restore a session from the locally cached JWT, with NO network.
1788
+ *
1789
+ * This is what makes a warm boot paint instantly and what makes an offline
1790
+ * boot possible at all: the token is in local storage, and it already carries
1791
+ * both the access method and the `$auth.id` record id. Everything the client
1792
+ * needs to route queries (`setCurrentUserId`) and to satisfy `$auth`-gated
1793
+ * permission predicates in the in-browser SSP (`setSessionAuth`) is therefore
1794
+ * available before a socket exists.
1795
+ *
1796
+ * The session is OPTIMISTIC: the token is unverified here. `check()` runs
1797
+ * afterwards in the background and downgrades to a real sign-out if the
1798
+ * server rejects it. Nothing is trusted that the server has not also seen -
1799
+ * the local store only ever holds rows the server previously sent.
1800
+ *
1801
+ * Returns the restored user id, or null when there is no usable token.
1802
+ */
1803
+ restoreSessionFromToken(): Promise<string | null>;
184
1804
  /**
185
1805
  * Check for existing session and validate
186
1806
  */
@@ -190,17 +1810,672 @@ declare class AuthService<S extends SchemaStructure> {
190
1810
  */
191
1811
  signOut(): Promise<void>;
192
1812
  private setSession;
1813
+ /** Fallback when the token carries no `AC` claim: if the schema defines
1814
+ * exactly one record-access method, assume the session used it. */
1815
+ private defaultAccessName;
193
1816
  signUp<Name extends keyof S['access'] & string>(accessName: Name, params: ExtractAccessParams<S, Name, 'signup'>): Promise<void>;
194
1817
  signIn<Name extends keyof S['access'] & string>(accessName: Name, params: ExtractAccessParams<S, Name, 'signIn'>): Promise<void>;
195
1818
  }
196
1819
  //#endregion
197
- //#region src/spooky.d.ts
1820
+ //#region src/modules/crdt/crdt-field.d.ts
1821
+ declare const CURSOR_COLORS: string[];
1822
+ declare function cursorColorFromName(name: string): string;
1823
+ declare class CrdtField {
1824
+ private fieldName;
1825
+ private doc;
1826
+ private pushTimer;
1827
+ private local;
1828
+ private remote;
1829
+ private recordId;
1830
+ private sessionId;
1831
+ private unsubscribe;
1832
+ private lastPushTime;
1833
+ private lastCursorPushTime;
1834
+ private loadedFromCrdt;
1835
+ private pushRetryCount;
1836
+ private logger;
1837
+ private cursorsEnabled;
1838
+ /** Remote-push debounce. Local writes happen immediately on every Loro
1839
+ * update; the remote UPSERT is coalesced over this window. Configured
1840
+ * via `Sp00kyConfig.crdtDebounceMs`, default 500. */
1841
+ private remoteDebounceMs;
1842
+ private _onCursorUpdate;
1843
+ private pendingCursorUpdate;
1844
+ /** Callback set by the editor to receive remote cursor updates.
1845
+ * Any cursor data that arrived before this callback was set will be replayed. */
1846
+ set onCursorUpdate(cb: ((data: Uint8Array) => void) | null);
1847
+ get onCursorUpdate(): ((data: Uint8Array) => void) | null;
1848
+ /**
1849
+ * @param LoroDocClass the `LoroDoc` constructor, injected by the caller after
1850
+ * awaiting {@link loadLoro} — keeps `loro-crdt` out of this module's static
1851
+ * import graph so it only ships to apps that use CRDT fields.
1852
+ */
1853
+ constructor(fieldName: string, cursorsEnabled: boolean, LoroDocClass: typeof LoroDoc, initialState?: Uint8Array, logger?: Logger$1 | null);
1854
+ getDoc(): LoroDoc;
1855
+ /** Whether the LoroDoc was loaded from saved CRDT state */
1856
+ hasContent(): boolean;
1857
+ startSync(local: LocalStore, remote: RemoteDatabaseService, recordId: string, sessionId: string, debounceMs: number): void;
1858
+ /**
1859
+ * Stop syncing this field. Flushes one final remote push by default so the
1860
+ * last keystrokes aren't lost. Pass `{ flush: false }` on a bucket switch —
1861
+ * the remote session already belongs to the NEXT user, and pushing this
1862
+ * (previous user's) snapshot under it would clobber the record remotely.
1863
+ */
1864
+ stopSync(options?: {
1865
+ flush?: boolean;
1866
+ }): void;
1867
+ importRemote(state: Uint8Array): void;
1868
+ exportSnapshot(): Uint8Array;
1869
+ /** Push this session's cursor blob into the parent row at
1870
+ * `<field>.cursors[$sid]`. No-op when cursors aren't enabled on this
1871
+ * field — the editor still calls this method optimistically, but
1872
+ * without `@cursor` on the schema there's nowhere to store the blob.
1873
+ * The UPDATE itself fires the parent table's LIVE feed, so other
1874
+ * browsers receive the cursor change without a separate `_00_rv` bump. */
1875
+ pushCursorState(encoded: Uint8Array): Promise<void>;
1876
+ /** Import remote cursor state (called by CrdtManager from LIVE SELECT) */
1877
+ importRemoteCursor(base64State: string): void;
1878
+ private scheduleRemotePush;
1879
+ /** SET path inside a parent row for the current snapshot. `@crdt`-only
1880
+ * fields hold the snapshot directly (`<field>`); `@crdt @cursor`
1881
+ * fields hold a `{ state, cursors }` object so the snapshot lives at
1882
+ * `<field>.state` next to per-session cursor blobs. */
1883
+ private statePath;
1884
+ /** Mirror the LoroDoc snapshot into the parent row locally. Runs on
1885
+ * every local update and every remote import so reloads (online or
1886
+ * offline) see the freshest content immediately. Failures are
1887
+ * swallowed — a stale local write must never block user input. */
1888
+ private persistLocal;
1889
+ private pushToRemote;
1890
+ }
1891
+ //#endregion
1892
+ //#region src/modules/crdt/index.d.ts
1893
+ /**
1894
+ * CrdtManager manages active CrdtField instances and their sync channels.
1895
+ *
1896
+ * Collaborative state lives in two dedicated tables (defined in
1897
+ * `apps/cli/src/meta_tables_remote.surql`):
1898
+ * - `_00_crdt` { record_id, field, state } — one row per (record, field)
1899
+ * - `_00_cursor` { record_id, session_id, field, state } — one row per
1900
+ * (record, session, field)
1901
+ *
1902
+ * Splitting them off the parent row is what makes offline edits mergeable:
1903
+ * each (record, field) gets its own row, so concurrent offline writes don't
1904
+ * collide on the parent's last-write-wins semantics.
1905
+ *
1906
+ * Cross-browser delivery still rides the parent table's existing LIVE feed
1907
+ * to avoid SurrealDB v3 LIVE bugs around dereference-based permission rules
1908
+ * (issues 3602, 4026). On every meta UPSERT the writer also bumps the
1909
+ * parent's `_00_rv` (a no-op assignment); that fires the parent's LIVE
1910
+ * feed, and the receiver pulls the matching `_00_crdt` / `_00_cursor` rows
1911
+ * via subquery. Permission inheritance happens server-side via
1912
+ * `record_id.id != NONE` (SELECT) and `fn::can_update_record` (UPDATE).
1913
+ */
1914
+ declare class CrdtManager {
1915
+ private schema;
1916
+ private local;
1917
+ private remote;
1918
+ private debounceMs;
1919
+ private fields;
1920
+ private liveByTable;
1921
+ private pendingLive;
1922
+ private staleTables;
1923
+ private connectionGeneration;
1924
+ private connectionUnsubscribes;
1925
+ private logger;
1926
+ private sessionId;
1927
+ constructor(schema: SchemaStructure, local: LocalStore, remote: RemoteDatabaseService, logger: Logger$1, debounceMs?: number);
1928
+ /**
1929
+ * Re-establish table LIVEs after a socket drop.
1930
+ *
1931
+ * A LIVE subscription lives and dies with its WebSocket session, and
1932
+ * `ensureTableSubscription` is memoized on `liveByTable` — so without this,
1933
+ * the first reconnect leaves CRDT realtime permanently dead: the map still
1934
+ * holds a uuid for a subscription the server has forgotten, so every later
1935
+ * `open()` short-circuits and no LIVE is ever re-issued.
1936
+ *
1937
+ * Both drop events matter: the SDK publishes `reconnecting` (not
1938
+ * `disconnected`) when it intends to recover on its own, and `disconnected`
1939
+ * only once it has given up.
1940
+ */
1941
+ private subscribeToReconnect;
1942
+ /** Stop observing transport events. Separate from {@link closeAll}, which also
1943
+ * runs on a bucket switch where the manager keeps being used. */
1944
+ dispose(): void;
1945
+ private hasOpenFieldFor;
1946
+ /** Set the session id that scopes this client's cursor entries. Must be
1947
+ * called before `open()` for cursors to be pushed under a stable key.
1948
+ * Passed in from `sp00ky.ts` at boot (it already fetches `session::id()`
1949
+ * for the data-module salt). */
1950
+ setSessionId(sessionId: string): void;
1951
+ /**
1952
+ * Open a CRDT field for collaborative editing.
1953
+ *
1954
+ * @param table - Table name
1955
+ * @param recordId - Full record ID (e.g., "thread:abc")
1956
+ * @param field - Field name (e.g., "title", "content")
1957
+ * @param fallbackText - Current plain text from the record, used to seed the
1958
+ * LoroDoc if no CRDT state exists yet (migration path)
1959
+ */
1960
+ open(table: string, recordId: string, field: string, fallbackText?: string): Promise<CrdtField>;
1961
+ close(table: string, recordId: string, field: string): void;
1962
+ /**
1963
+ * Close every open field + table LIVE. Fields flush a final remote push by
1964
+ * default; pass `{ flush: false }` on a bucket switch, where that flush
1965
+ * would push the previous user's snapshot under the next user's session.
1966
+ */
1967
+ closeAll(options?: {
1968
+ flush?: boolean;
1969
+ }): void;
1970
+ /** Ensure a single `LIVE SELECT * FROM <table>` is running, shared across
1971
+ * every open CrdtField on `table`. */
1972
+ private ensureTableSubscription;
1973
+ /** Apply a parent-row payload from a non-LIVE source (e.g. the
1974
+ * list_ref-driven sync engine, when the cross-user LIVE on the
1975
+ * parent table is filtered out by the SurrealDB cross-session
1976
+ * permission gap). Same semantics as the internal `dispatchRow`. */
1977
+ applyRow(table: string, row: Record<string, unknown>): void;
1978
+ /** Dispatch a parent-row LIVE event to every open CrdtField on that
1979
+ * record. Each open field reads its slice of the row directly — the
1980
+ * CRDT snapshot is a column on the parent now, so there is no
1981
+ * follow-up subquery. */
1982
+ private dispatchRow;
1983
+ /** One-shot remote fetch for a row whose CRDT field hasn't synced
1984
+ * locally yet (fresh device, memory-backed local DB after reload, …).
1985
+ * Used by `open()` when the local read came up empty. Subsequent
1986
+ * cross-browser updates ride `dispatchRow` via the parent LIVE feed. */
1987
+ private fetchAndDispatchRow;
1988
+ /** Schema lookup: does `<table>.<field>` carry a `@cursor` annotation?
1989
+ * Determines the on-disk shape (plain snapshot vs. `{ state, cursors }`). */
1990
+ private fieldHasCursor;
1991
+ /** Pull the LoroDoc snapshot bytes out of a row slice. For `@crdt`-only
1992
+ * the slice IS the snapshot (Uint8Array); for `@crdt @cursor` it's
1993
+ * `{ state, cursors }` where `state` carries the snapshot bytes. */
1994
+ private extractSnapshot;
1995
+ private killTableSubscription;
1996
+ private makeKey;
1997
+ /**
1998
+ * Throws if `<table>.<field>` is not annotated `@crdt` in the schema. Catches
1999
+ * typos, removed annotations, and stale schema codegen at the call site instead
2000
+ * of silently producing a non-CRDT writer.
2001
+ */
2002
+ private assertCrdtField;
2003
+ }
2004
+ //#endregion
2005
+ //#region src/modules/feature-flag/index.d.ts
2006
+ interface FeatureFlagSnapshot {
2007
+ variant: string | undefined;
2008
+ payload: unknown | undefined;
2009
+ }
2010
+ interface FeatureFlagOptions {
2011
+ fallback?: string;
2012
+ ttl?: QueryTimeToLive;
2013
+ }
2014
+ /**
2015
+ * A locally forced variant. Applies to THIS browser only and is never sent to
2016
+ * the server — the assignment in `_00_user_feature` is untouched, so clearing
2017
+ * the override restores whatever the server says.
2018
+ */
2019
+ interface FeatureFlagOverride {
2020
+ variant: string;
2021
+ payload?: unknown;
2022
+ }
2023
+ declare class FeatureFlagHandle {
2024
+ readonly key: string;
2025
+ readonly fallback: string | undefined;
2026
+ private latest;
2027
+ private listeners;
2028
+ private unsubscribeFn;
2029
+ private onCloseFn;
2030
+ private closed;
2031
+ constructor(key: string, fallback: string | undefined);
2032
+ attach(unsubscribe: () => void): void;
2033
+ detach(): void;
2034
+ set(snapshot: FeatureFlagSnapshot): void;
2035
+ variant(): string | undefined;
2036
+ payload<T = unknown>(): T | undefined;
2037
+ enabled(): boolean;
2038
+ subscribe(cb: (s: FeatureFlagSnapshot) => void): () => void;
2039
+ onClose(cb: () => void): void;
2040
+ close(): void;
2041
+ }
2042
+ interface FeatureFlagModuleDeps<S extends SchemaStructure> {
2043
+ dataModule: DataModule<S>;
2044
+ sync: Sp00kySync<S>;
2045
+ auth: AuthService<S>;
2046
+ logger: Logger$1;
2047
+ }
2048
+ declare class FeatureFlagModule<S extends SchemaStructure> {
2049
+ private deps;
2050
+ private logger;
2051
+ private handles;
2052
+ private authUnsubscribe;
2053
+ private lastUserId;
2054
+ private querySubscription;
2055
+ private starting;
2056
+ private ttl;
2057
+ private snapshots;
2058
+ private loaded;
2059
+ private overrides;
2060
+ constructor(deps: FeatureFlagModuleDeps<S>);
2061
+ init(): void;
2062
+ feature(key: string, options?: FeatureFlagOptions): FeatureFlagHandle;
2063
+ closeAll(): Promise<void>;
2064
+ /** Auth changed: drop the old user's query/snapshots and re-observe. */
2065
+ private refresh;
2066
+ private teardownQuery;
2067
+ /** Start the single shared live query (idempotent; no-op with no handles). */
2068
+ private ensureStarted;
2069
+ /** Live query result → per-key snapshots → push to every active handle. */
2070
+ private applyRecords;
2071
+ /**
2072
+ * Force `key` to `variant` in THIS browser. Pass `null` to clear.
2073
+ *
2074
+ * Nothing is written to the server: the `_00_user_feature` assignment is
2075
+ * untouched, so clearing restores whatever the server says. Persisted to
2076
+ * localStorage on the page origin, so it survives a reload.
2077
+ */
2078
+ setLocalOverride(key: string, variant: string | null, payload?: unknown): void;
2079
+ clearLocalOverrides(): void;
2080
+ getLocalOverrides(): Record<string, FeatureFlagOverride>;
2081
+ /** The assignment for `key`, with any local override taking precedence. */
2082
+ private resolve;
2083
+ private pushAll;
2084
+ private loadOverrides;
2085
+ private persistOverrides;
2086
+ }
2087
+ //#endregion
2088
+ //#region src/modules/app-release/index.d.ts
2089
+ interface AppReleaseSnapshot {
2090
+ /** Latest announced version for the app, or undefined when no row exists. */
2091
+ version: string | undefined;
2092
+ /** Clients should clear SW/caches when reloading onto this version. */
2093
+ cacheBust: boolean;
2094
+ /** Clients should reload/update immediately instead of asking. */
2095
+ mandatory: boolean;
2096
+ releasedAt: string | undefined;
2097
+ }
2098
+ interface AppReleaseOptions {
2099
+ ttl?: QueryTimeToLive;
2100
+ }
2101
+ declare class AppReleaseHandle {
2102
+ readonly app: string;
2103
+ private latest;
2104
+ private listeners;
2105
+ private onCloseFn;
2106
+ private closed;
2107
+ constructor(app: string);
2108
+ set(snapshot: AppReleaseSnapshot): void;
2109
+ snapshot(): AppReleaseSnapshot;
2110
+ version(): string | undefined;
2111
+ /** True when the announced version is semver-newer than `currentVersion`. */
2112
+ updateAvailable(currentVersion: string): boolean;
2113
+ subscribe(cb: (s: AppReleaseSnapshot) => void): () => void;
2114
+ onClose(cb: () => void): void;
2115
+ close(): void;
2116
+ }
2117
+ interface AppReleaseModuleDeps<S extends SchemaStructure> {
2118
+ dataModule: DataModule<S>;
2119
+ sync: Sp00kySync<S>;
2120
+ auth: AuthService<S>;
2121
+ logger: Logger$1;
2122
+ }
2123
+ declare class AppReleaseModule<S extends SchemaStructure> {
2124
+ private deps;
2125
+ private logger;
2126
+ private handles;
2127
+ private authUnsubscribe;
2128
+ private lastUserId;
2129
+ private querySubscription;
2130
+ private starting;
2131
+ private ttl;
2132
+ private snapshots;
2133
+ private loaded;
2134
+ constructor(deps: AppReleaseModuleDeps<S>);
2135
+ init(): void;
2136
+ release(app: string, options?: AppReleaseOptions): AppReleaseHandle;
2137
+ closeAll(): Promise<void>;
2138
+ private refresh;
2139
+ private teardownQuery;
2140
+ private ensureStarted;
2141
+ private applyRecords;
2142
+ }
2143
+ //#endregion
2144
+ //#region src/services/blobs/blob-store.d.ts
2145
+ /**
2146
+ * Byte storage for cached bucket files.
2147
+ *
2148
+ * The default implementation is OPFS. Bucket files never arrive over HTTP in
2149
+ * this client — `BucketHandle.get()` is a SurrealQL RPC on the sync socket — so
2150
+ * neither the browser's HTTP cache nor the Cache API can hold them. We persist
2151
+ * the bytes ourselves, and OPFS is the cheapest place to put them: a read is
2152
+ * `getFile()` → a disk-backed lazy `File` that `URL.createObjectURL` can serve
2153
+ * without ever moving the bytes through the JS heap.
2154
+ *
2155
+ * Layout is real nested directories rather than one hashed filename:
2156
+ *
2157
+ * sp00ky-blobs/<namespace>/<bucket>/<...path segments>
2158
+ *
2159
+ * That costs a `getDirectoryHandle` per segment on write, and buys the property
2160
+ * the whole orphan story rests on: the full `(bucket, path)` key is recoverable
2161
+ * from a directory walk alone. The `_00_blob` manifest can therefore be wiped
2162
+ * (memory fallback, SQLite pool wipe, IndexedDB corruption recovery) and be
2163
+ * rebuilt from disk instead of taking the cached bytes down with it.
2164
+ */
2165
+ /** Identifies one cached file: the bucket it lives in and its path within. */
2166
+ interface BlobKey {
2167
+ bucket: string;
2168
+ path: string;
2169
+ }
2170
+ /** What a directory walk can tell us about a stored file, with no manifest. */
2171
+ interface BlobStat {
2172
+ key: BlobKey;
2173
+ size: number;
2174
+ /** File mtime. Seeds `lastAccess` when a manifest row has to be rebuilt. */
2175
+ mtime: number;
2176
+ }
2177
+ interface BlobStore {
2178
+ /** False for {@link MemoryBlobStore} and for OPFS-less environments: the
2179
+ * cache still dedupes and serves within a tab, but nothing survives reload. */
2180
+ readonly persistent: boolean;
2181
+ /** Namespace (the local bucketId) all keys are resolved under. */
2182
+ readonly namespace: string;
2183
+ read(key: BlobKey): Promise<Blob | null>;
2184
+ /** Returns the number of bytes written. Throws on quota exhaustion. */
2185
+ write(key: BlobKey, bytes: Blob): Promise<number>;
2186
+ remove(key: BlobKey): Promise<void>;
2187
+ /** Every committed file under the current namespace. Sweeps torn writes. */
2188
+ list(): Promise<BlobStat[]>;
2189
+ /** Drop the whole namespace (sign-out with `clearOnSignOut`, or a reset). */
2190
+ clear(): Promise<void>;
2191
+ /** Point at another namespace. Does not touch the bytes of the old one. */
2192
+ setNamespace(namespace: string): void;
2193
+ }
2194
+ //#endregion
2195
+ //#region src/services/blobs/blob-manifest.d.ts
2196
+ interface BlobEntry {
2197
+ /** `${bucket}/${path}` — also the `_00_blob` row id. */
2198
+ id: string;
2199
+ bucket: string;
2200
+ path: string;
2201
+ size: number;
2202
+ contentType: string;
2203
+ createdAt: number;
2204
+ lastAccess: number;
2205
+ hits: number;
2206
+ /** Exempt from pressure eviction. Never expires on its own. */
2207
+ pinned: boolean;
2208
+ }
2209
+ declare class BlobManifest {
2210
+ private local;
2211
+ private entries;
2212
+ /** Ids whose in-memory state has not been written back yet. */
2213
+ private dirty;
2214
+ private removed;
2215
+ private flushing;
2216
+ constructor(local: LocalStore);
2217
+ /**
2218
+ * Hydrate from the rows matching `keys`. Ids come from the OPFS listing, so
2219
+ * this never needs a full-table scan (and therefore never needs a QueryPlan).
2220
+ * Any read failure yields an empty manifest: reconcile then rebuilds every
2221
+ * row from disk, which is exactly the desired degradation.
2222
+ */
2223
+ load(ids: string[]): Promise<void>;
2224
+ get(key: BlobKey): BlobEntry | undefined;
2225
+ getById(id: string): BlobEntry | undefined;
2226
+ all(): BlobEntry[];
2227
+ totalBytes(): number;
2228
+ pinnedBytes(): number;
2229
+ put(entry: BlobEntry): void;
2230
+ touch(id: string, now: number): void;
2231
+ setPinned(id: string, pinned: boolean): boolean;
2232
+ remove(id: string): void;
2233
+ /** Forget everything without scheduling deletes — for a bucket switch, where
2234
+ * the rows belong to the store we are leaving and must stay put. */
2235
+ reset(): void;
2236
+ hasPendingWrites(): boolean;
2237
+ /**
2238
+ * Write back pending changes. Serialized: a second concurrent flush awaits
2239
+ * the first rather than racing it into the same rows. Failures are swallowed
2240
+ * on purpose — a lost metadata write costs an LRU timestamp, and the entry is
2241
+ * rebuilt from disk on the next reconcile.
2242
+ */
2243
+ flush(): Promise<void>;
2244
+ private doFlush;
2245
+ }
2246
+ //#endregion
2247
+ //#region src/services/blobs/blob-cache.d.ts
2248
+ interface BlobUrlLease {
2249
+ url: string;
2250
+ release(): void;
2251
+ }
2252
+ interface BlobReadOptions {
2253
+ /** Write through to L1 on a miss. Default true. */
2254
+ persist?: boolean;
2255
+ /** Mark the entry exempt from pressure eviction. */
2256
+ pin?: boolean;
2257
+ /**
2258
+ * Default `'never'`: a bucket path is treated as immutable, which is how the
2259
+ * client writes them (`crypto.randomUUID() + ext`). `'head'` spends a remote
2260
+ * `head()` to compare sizes before trusting L1.
2261
+ */
2262
+ revalidate?: 'never' | 'head';
2263
+ /** Skip L0/L1 entirely and refill from remote. Backs `refetch()`. */
2264
+ reload?: boolean;
2265
+ }
2266
+ interface BlobCacheStats {
2267
+ entries: number;
2268
+ totalBytes: number;
2269
+ budgetBytes: number;
2270
+ pinnedBytes: number;
2271
+ evictedEntries: number;
2272
+ evictedBytes: number;
2273
+ reconciledEntries: number;
2274
+ hits: number;
2275
+ misses: number;
2276
+ persistent: boolean;
2277
+ /** True when pinned bytes alone exceed the budget: new entries stop being
2278
+ * written rather than pinned ones being thrown away. */
2279
+ persistPaused: boolean;
2280
+ }
2281
+ interface BlobCacheOptions {
2282
+ store: BlobStore;
2283
+ manifest: BlobManifest;
2284
+ /** L2 read. Resolves to null when the file does not exist remotely. */
2285
+ fetchRemote(key: BlobKey): Promise<Blob | null>;
2286
+ /** L2 metadata, for `revalidate: 'head'`. */
2287
+ headRemote?(key: BlobKey): Promise<Record<string, unknown> | null>;
2288
+ logger: Logger$1;
2289
+ maxBytes: number;
2290
+ now?: () => number;
2291
+ /** Injected so the URL layer is exercisable off a DOM (node tests). */
2292
+ urls?: {
2293
+ create(blob: Blob): string;
2294
+ revoke(url: string): void;
2295
+ };
2296
+ }
2297
+ declare class BlobCache {
2298
+ private readonly store;
2299
+ private readonly manifest;
2300
+ private readonly fetchRemote;
2301
+ private readonly headRemote?;
2302
+ private readonly logger;
2303
+ private readonly now;
2304
+ private readonly urlFactory;
2305
+ private maxBytes;
2306
+ private persistPaused;
2307
+ /** Set after a quota failure survives one forced eviction. */
2308
+ private persistDisabled;
2309
+ private readonly urls;
2310
+ /** Ids at zero references, oldest first — the hot-URL window. */
2311
+ private idleUrls;
2312
+ private readonly inflight;
2313
+ private flushTimer;
2314
+ private readonly onPageHide;
2315
+ /**
2316
+ * Resolves once the manifest has been reconciled against disk. Reads await
2317
+ * it, so `start()` does NOT have to be awaited on the boot path — blocking
2318
+ * boot on an OPFS directory walk delayed the WebSocket connect (and with it
2319
+ * the connection supervisor) for no benefit.
2320
+ */
2321
+ private ready;
2322
+ private hits;
2323
+ private misses;
2324
+ private evictedEntries;
2325
+ private evictedBytes;
2326
+ private reconciledEntries;
2327
+ constructor(opts: BlobCacheOptions);
2328
+ /** Coalesce manifest write-back. Metadata only, so losing the tail costs an
2329
+ * LRU timestamp that reconcile reseeds from the file mtime. */
2330
+ private scheduleFlush;
2331
+ /**
2332
+ * Resolve the bytes for `key`, filling L1 on the way when `persist` is on.
2333
+ * Returns null when the file does not exist remotely and is not cached.
2334
+ */
2335
+ read(key: BlobKey, options?: BlobReadOptions): Promise<Blob | null>;
2336
+ /**
2337
+ * An object URL for `key`, refcounted. Callers MUST `release()`; the URL is
2338
+ * revoked once the last holder lets go and it falls out of the hot window.
2339
+ */
2340
+ acquireUrl(key: BlobKey, options?: BlobReadOptions): Promise<BlobUrlLease | null>;
2341
+ private lease;
2342
+ private releaseUrl;
2343
+ private revokeUrl;
2344
+ /** L1 lookup with the size check that catches torn and cross-tab writes. */
2345
+ private readLocal;
2346
+ /** True when the remote agrees with the cached size, or cannot be reached. */
2347
+ private headMatches;
2348
+ private fetchDeduped;
2349
+ private persist;
2350
+ private writeThrough;
2351
+ /** Forget one path everywhere. Called on `bucket.put()`/`bucket.delete()`. */
2352
+ invalidate(key: BlobKey): Promise<void>;
2353
+ private dropLocal;
2354
+ setPinned(key: BlobKey, pinned: boolean): void;
2355
+ /**
2356
+ * Bring total bytes under budget by dropping the least recently used
2357
+ * entries. Pinned entries and anything with a live object URL are skipped —
2358
+ * evicting bytes that a mounted `<img>` is displaying would blank it.
2359
+ */
2360
+ private enforceBudget;
2361
+ /** Evict LRU-first until at or below `target`. Returns the resulting total. */
2362
+ private evictTo;
2363
+ /**
2364
+ * Rebuild the manifest from what is actually on disk. OPFS wins on existence
2365
+ * in both directions: files with no row get a row (seeded from mtime), rows
2366
+ * are only loaded for files that exist, and torn `.part-` writes are swept by
2367
+ * the walk itself.
2368
+ *
2369
+ * Rows whose file vanished outside our control (a browser origin eviction)
2370
+ * are left in `_00_blob`. They are inert — `load()` only ever asks for ids it
2371
+ * found on disk — and are overwritten if that path is cached again.
2372
+ */
2373
+ reconcile(): Promise<void>;
2374
+ /** Warm the cache for offline use. Skips anything already cached. */
2375
+ prefetch(keys: BlobKey[]): Promise<void>;
2376
+ /** Bind to the boot bucket and hydrate the manifest from disk. Separate from
2377
+ * {@link setNamespace} because boot must reconcile even when the namespace
2378
+ * it lands on is the one the store was constructed with. */
2379
+ start(namespace: string): Promise<void>;
2380
+ /** Repoint at another local bucket. The bytes of the old one stay on disk so
2381
+ * switching back (or signing back in) is still warm. */
2382
+ setNamespace(namespace: string): Promise<void>;
2383
+ setMaxBytes(maxBytes: number): void;
2384
+ /** Delete every cached byte in the current namespace. */
2385
+ clear(): Promise<void>;
2386
+ flush(): Promise<void>;
2387
+ /** Flush metadata and drop every object URL. Must run before the local store
2388
+ * closes — the flush writes through it. */
2389
+ close(): Promise<void>;
2390
+ stats(): BlobCacheStats;
2391
+ }
2392
+ //#endregion
2393
+ //#region src/utils/blurhash.d.ts
2394
+ /**
2395
+ * Blurhash generation settings. `true` enables with the defaults below, `false`
2396
+ * disables. Resolution order for a put: per-call option > client config >
2397
+ * default ON. See {@link Sp00kyConfig.blurhash}.
2398
+ */
2399
+ type BlurhashSetting = boolean | BlurhashEncodeOptions;
2400
+ interface BlurhashEncodeOptions {
2401
+ /** Horizontal detail components, 1-9. Defaults to 4. */
2402
+ componentX?: number;
2403
+ /** Vertical detail components, 1-9. Defaults to 3. */
2404
+ componentY?: number;
2405
+ }
2406
+ /**
2407
+ * Where an image's blurhash lives: a tiny sidecar object in the same bucket.
2408
+ * Buckets have no per-object metadata channel (`put` is just `.put($content)`),
2409
+ * so the hash for `covers/x_t.webp` is the text object `covers/x_t.webp.bh`.
2410
+ */
2411
+ declare function blurhashSidecarPath(path: string): string;
2412
+ /** Extensions `bucket.put` treats as images worth hashing. */
2413
+ declare const BLURHASH_IMAGE_EXTENSIONS: readonly ["webp", "png", "jpg", "jpeg", "gif", "avif", "bmp"];
2414
+ declare function isImagePath(path: string): boolean;
2415
+ /**
2416
+ * Decode `content` as an image and compute its blurhash. Browser-only: returns
2417
+ * null (never throws) when image decoding is unavailable (node, workers without
2418
+ * canvas), when the bytes are not a decodable image, or on any other failure —
2419
+ * a missing hash must never break the upload that triggered it.
2420
+ */
2421
+ declare function encodeImageToBlurhash(content: string | Uint8Array | Blob, options?: BlurhashEncodeOptions): Promise<string | null>;
2422
+ //#endregion
2423
+ //#region src/sp00ky.d.ts
2424
+ /** Coerce whatever the `.get()` RPC hands back into a Blob. */
2425
+ declare function bucketContentToBlob(content: unknown): Blob | null;
2426
+ interface BucketPutOptions {
2427
+ /** Override the client-level {@link Sp00kyConfig.blurhash} setting for this put. */
2428
+ blurhash?: BlurhashSetting;
2429
+ }
2430
+ interface BucketPutResult {
2431
+ /** The computed blurhash when the content was a hashable image; else null. */
2432
+ blurhash: string | null;
2433
+ }
2434
+ interface BucketHandleSettings {
2435
+ blurhash?: BlurhashSetting;
2436
+ logger?: {
2437
+ warn: (obj: unknown, msg?: string) => void;
2438
+ };
2439
+ }
198
2440
  declare class BucketHandle {
199
2441
  private bucketName;
200
2442
  private remote;
201
- constructor(bucketName: string, remote: RemoteDatabaseService);
202
- put(path: string, content: string | Uint8Array | Blob): Promise<void>;
2443
+ /** Absent on the raw handle the cache itself reads through. */
2444
+ private blobs?;
2445
+ private settings?;
2446
+ constructor(bucketName: string, remote: RemoteDatabaseService, /** Absent on the raw handle the cache itself reads through. */
2447
+ blobs?: (BlobCache | null) | undefined, settings?: BucketHandleSettings | undefined);
2448
+ /** Effective blurhash setting: per-call option > client config > default ON. */
2449
+ private resolveBlurhash;
2450
+ put(path: string, content: string | Uint8Array | Blob, options?: BucketPutOptions): Promise<BucketPutResult>;
2451
+ /**
2452
+ * The blurhash stored alongside an uploaded image (see
2453
+ * {@link blurhashSidecarPath}), or null when there is none. Reads through the
2454
+ * blob cache, so a warm client answers from OPFS without a network hop, and
2455
+ * misses are remembered per tab so a hashless image costs at most one
2456
+ * serialized remote read per session.
2457
+ */
2458
+ blurhash(path: string): Promise<string | null>;
203
2459
  get(path: string): Promise<unknown>;
2460
+ /**
2461
+ * Read through the local blob cache: OPFS first, the bucket second. Unlike
2462
+ * {@link get} this survives a reload and works offline. Returns null when the
2463
+ * file exists in neither place.
2464
+ */
2465
+ read(path: string, options?: BlobReadOptions): Promise<Blob | null>;
2466
+ /**
2467
+ * A refcounted object URL for `path`, suitable for `<img src>`. The caller
2468
+ * MUST call `release()` when the URL goes off screen. Returns null when the
2469
+ * file does not exist, or when object URLs are unavailable (non-browser).
2470
+ */
2471
+ url(path: string, options?: BlobReadOptions): Promise<BlobUrlLease | null>;
2472
+ /** Exempt `path` from pressure eviction. Pinned bytes never expire. */
2473
+ pin(path: string): void;
2474
+ unpin(path: string): void;
2475
+ /** Drop `path` from the local cache without touching the remote file. */
2476
+ evict(path: string): Promise<void>;
2477
+ /** Warm the cache for offline use. Already-cached paths are skipped. */
2478
+ prefetch(paths: string[]): Promise<void>;
204
2479
  delete(path: string): Promise<void>;
205
2480
  exists(path: string): Promise<boolean>;
206
2481
  head(path: string): Promise<Record<string, unknown>>;
@@ -208,55 +2483,323 @@ declare class BucketHandle {
208
2483
  rename(sourcePath: string, targetPath: string): Promise<void>;
209
2484
  list(prefix?: string): Promise<string[]>;
210
2485
  }
211
- declare class SpookyClient<S extends SchemaStructure> {
2486
+ declare class Sp00kyClient<S extends SchemaStructure> {
212
2487
  private config;
213
2488
  private local;
214
2489
  private remote;
2490
+ private blobs;
2491
+ private connectionSupervisor;
215
2492
  private persistenceClient;
216
2493
  private migrator;
217
2494
  private cache;
218
2495
  private dataModule;
219
2496
  private sync;
220
2497
  private devTools;
2498
+ private crdtManager;
2499
+ /**
2500
+ * True once the LOCAL half of boot is done and the client can serve reads
2501
+ * from the local store. Distinct from being connected: `syncHealth` covers
2502
+ * reaching the server and `storageHealth` covers whether the local store is
2503
+ * durable, but neither says "usable". Consumers gate their first paint on
2504
+ * this, which is what makes a warm boot instant and an offline boot possible.
2505
+ */
2506
+ private localReady;
2507
+ private saltUserId;
2508
+ private featureFlags;
2509
+ private appReleases;
2510
+ private preloadedHashes;
2511
+ private pendingQueryInits;
221
2512
  private logger;
222
2513
  auth: AuthService<S>;
223
2514
  streamProcessor: StreamProcessorService;
224
- get remoteClient(): Surreal;
225
- get localClient(): Surreal;
2515
+ private tabsCoordinator;
2516
+ private sharedActive;
2517
+ /** Current shared-tabs role, or null when the feature is off/fell back. */
2518
+ get tabRole(): TabRole | null;
2519
+ get remoteClient(): surrealdb0.Surreal;
2520
+ get localClient(): unknown;
226
2521
  get pendingMutationCount(): number;
2522
+ /** Number of times the initial list_ref LIVE subscription retried on
2523
+ * the most recent `setCurrentUserId` call. 0 when the SSP's
2524
+ * pre-emptive user-table creation got there first; >0 when LIVE
2525
+ * registration hit a "table not found" race. Exposed so the e2e
2526
+ * suite can guard the pre-emptive path against regression. */
2527
+ get liveRetryCount(): number;
227
2528
  subscribeToPendingMutations(cb: (count: number) => void): () => void;
228
- constructor(config: SpookyConfig<S>);
2529
+ /** Current sync-health snapshot. See {@link Sp00kyConfig.syncHealth}. */
2530
+ get syncHealth(): SyncHealth;
2531
+ /**
2532
+ * Observe sync health. Fires immediately with the current status and again
2533
+ * on every healthy↔degraded transition. Returns an unsubscribe.
2534
+ */
2535
+ subscribeToSyncHealth(cb: (health: SyncHealth) => void): () => void;
2536
+ /** Durability of the local cache. See {@link StorageHealth}. `'unknown'` for
2537
+ * engines that don't report it. */
2538
+ get storageHealth(): StorageHealth;
2539
+ /**
2540
+ * Observe local-store durability. Fires immediately with the current snapshot
2541
+ * and again on every change (at most once per bucket open in practice).
2542
+ * Returns an unsubscribe.
2543
+ */
2544
+ subscribeToStorageHealth(cb: (health: StorageHealth) => void): () => void;
2545
+ constructor(config: Sp00kyConfig<S>);
2546
+ /** The shared-tabs role machinery, wired to this client's modules. */
2547
+ private buildTabsCoordinator;
229
2548
  /**
230
2549
  * Setup direct callbacks instead of event subscriptions
231
2550
  */
232
2551
  private setupCallbacks;
233
2552
  init(): Promise<void>;
2553
+ /**
2554
+ * The network half of boot: connect, verify the restored session, and let the
2555
+ * sync engine catch up. Runs in the background after `init()` has already
2556
+ * resolved, so nothing here is on the paint path.
2557
+ *
2558
+ * Every step is best-effort. A failure leaves the client in exactly the state
2559
+ * a warm offline boot is in - local reads working, writes queued in the
2560
+ * outbox - and the connection supervisor keeps retrying underneath.
2561
+ */
2562
+ private initRemote;
2563
+ private bucketSwitchChain;
2564
+ private pendingBucketTarget;
2565
+ /**
2566
+ * Ensure the local store is this user's bucket, switching if needed. Called
2567
+ * from the auth listener on every auth flip; concurrent calls are chained
2568
+ * and superseded intermediates are skipped (latest target wins).
2569
+ */
2570
+ private ensureLocalBucket;
2571
+ /**
2572
+ * The bucket-switch choreography: drain → swap → rebind.
2573
+ *
2574
+ * Drain: sync quiesced (poll/LIVE stopped, in-flight round awaited so its
2575
+ * outbox delete lands in the OLD bucket, debounce timers cancelled),
2576
+ * DataModule timers cleared, CRDT fields closed WITHOUT their final flush
2577
+ * (the remote session already belongs to the next user).
2578
+ *
2579
+ * Swap: gate closes so any local query issued mid-switch (sibling auth
2580
+ * subscribers, FeatureFlagModule) waits and then runs against the NEW
2581
+ * bucket; store swaps open-new-before-close-old; schema provisions
2582
+ * (no-op for a returning bucket); stale `_00_query` rows are wiped (dead
2583
+ * sessionId-salted hashes with stale arrays — record bodies stay warm);
2584
+ * SSP resets to a fresh circuit with re-seeded permissions.
2585
+ *
2586
+ * Rebind: auth token re-persisted (the surrealdb persistence client wrote it
2587
+ * into the OLD bucket's `_00_kv` before this listener ran), active queries
2588
+ * re-homed keeping their hashes, sync resumed on the new bucket's own
2589
+ * outbox, and every query re-registered remotely to refill from the server.
2590
+ */
2591
+ private doSwitchBucket;
2592
+ /** Removes the `pagehide` listener installed in `init`; see `close`. */
2593
+ private detachUnloadRelease;
234
2594
  close(): Promise<void>;
2595
+ /**
2596
+ * Subscribe to a feature flag for the current user. Returns a
2597
+ * `FeatureFlagHandle` whose `variant()`, `payload()` and `enabled()`
2598
+ * accessors reflect the latest assignment from `_00_user_feature`,
2599
+ * and whose `subscribe(cb)` fires whenever that assignment changes.
2600
+ *
2601
+ * Permissions are enforced by SurrealDB: a client can only ever see
2602
+ * its own row, and cannot create or modify assignments.
2603
+ */
2604
+ feature(key: string, options?: FeatureFlagOptions): FeatureFlagHandle;
2605
+ /**
2606
+ * Force a feature flag to `variant` in THIS browser only; `null` clears it.
2607
+ *
2608
+ * Nothing is sent to the server — the `_00_user_feature` assignment is
2609
+ * untouched, so clearing restores whatever the server says. Persisted to
2610
+ * localStorage, survives reloads, and applies while signed out. Backs the
2611
+ * DevTools Access tab, and is a convenient hook for tests.
2612
+ *
2613
+ * To change a flag for OTHER users you need admin rights (`spky admin add`)
2614
+ * and the DevTools Access tab, or `spky flag`.
2615
+ */
2616
+ setFeatureOverride(key: string, variant: string | null, payload?: unknown): void;
2617
+ /** Drop every local feature flag override set via `setFeatureOverride`. */
2618
+ clearFeatureOverrides(): void;
2619
+ /** The local feature flag overrides currently in effect, keyed by flag. */
2620
+ getFeatureOverrides(): Record<string, FeatureFlagOverride>;
2621
+ /**
2622
+ * Observe the announced release of an app (`_00_app_release:<app>`, written
2623
+ * by `spky deploy` / `spky release`). The handle's `snapshot()` carries the
2624
+ * announced version plus the cache-bust/mandatory flags, and
2625
+ * `updateAvailable(currentVersion)` compares it semver-wise against the
2626
+ * running build. World-readable; writes are root-only.
2627
+ */
2628
+ appRelease(app: string, options?: AppReleaseOptions): AppReleaseHandle;
235
2629
  authenticate(token: string): Promise<surrealdb0.Tokens>;
2630
+ /**
2631
+ * Open a CRDT field for collaborative editing.
2632
+ * Returns a CrdtField with a LoroDoc that can be bound to any editor.
2633
+ * Also starts a LIVE SELECT on the parent table for real-time sync;
2634
+ * incoming events trigger a subquery fetch of `_00_crdt` / `_00_cursor`.
2635
+ */
2636
+ openCrdtField(table: string, recordId: string, field: string, fallbackText?: string): Promise<CrdtField>;
2637
+ /**
2638
+ * Close a CRDT field when editing is done.
2639
+ */
2640
+ closeCrdtField(table: string, recordId: string, field: string): void;
236
2641
  deauthenticate(): Promise<void>;
237
- query<Table extends TableNames<S>>(table: Table, options: QueryOptions<TableModel<GetTable<S, Table>>, false>, ttl?: QueryTimeToLive): QueryBuilder<S, Table, SpookyQueryResultPromise>;
2642
+ query<Table extends TableNames<S>>(table: Table, options: QueryOptions<TableModel<GetTable<S, Table>>, false>, ttl?: QueryTimeToLive): QueryBuilder<S, Table, Sp00kyQueryResultPromise>;
238
2643
  private initQuery;
2644
+ /**
2645
+ * Background tail of {@link initQuery}: instant-hydrate (opt-in via
2646
+ * `config.instantHydrate`, and only when the query is cold) followed by
2647
+ * enqueuing the `register` down-event. Never rejects — both halves catch and
2648
+ * log, so `void`-ing the returned promise can't produce an unhandled
2649
+ * rejection. By default (hydrate off) the register lifecycle is the single
2650
+ * freshness path; the one-shot fetch is an optimization apps enable
2651
+ * explicitly, and it runs regardless of preload state — cache-first delivery
2652
+ * never depends on WHY rows are cached.
2653
+ */
2654
+ private finishQueryInit;
2655
+ /**
2656
+ * Smart, awaitable preload/prewarm into the LOCAL cache — without registering a
2657
+ * live view (NO `_00_query`, NO subscription, NO TTL heartbeat).
2658
+ *
2659
+ * Cache-aware via a durable per-bucket freshness marker (`_00_preload`):
2660
+ * - COLD (never preloaded in this bucket): fetch the query one-shot from the
2661
+ * remote, persist the rows (+ embedded `.related()` children), stamp the
2662
+ * marker — and AWAIT it. This is the "smart waiting" first load: callers can
2663
+ * `await db.preload(...)` to hold the UI until the data is ready.
2664
+ * - WARM (marker present): return instantly — NEVER blocks. `refresh` decides
2665
+ * whether to also kick a one-time silent refetch (see {@link PreloadOptions}).
2666
+ * Default `onUse` does nothing; the data freshens when the real `useQuery`
2667
+ * mounts and registers its live view.
2668
+ *
2669
+ * Best-effort: any fetch failure (offline, etc.) is a no-op warn (no marker
2670
+ * written, so it's retried next load). Deduped per session by query hash.
2671
+ */
2672
+ preload(finalQuery: FinalQuery<S, any, any, any, any, any>, options?: PreloadOptions): Promise<void>;
2673
+ /**
2674
+ * One-shot remote fetch + local persist for a preload query. Returns the row
2675
+ * count on success, or -1 on failure (best-effort: logged, never thrown) so
2676
+ * the caller skips stamping the freshness marker and retries next load.
2677
+ */
2678
+ private fetchAndPersist;
239
2679
  queryRaw(sql: string, params: Record<string, any>, ttl: QueryTimeToLive): Promise<string>;
240
2680
  subscribe(queryHash: string, callback: (records: Record<string, any>[]) => void, options?: {
241
2681
  immediate?: boolean;
242
2682
  }): Promise<() => void>;
2683
+ /**
2684
+ * Opt-in eager teardown for a query whose last subscriber has gone away
2685
+ * (e.g. a viewport-windowed list cancelling an off-screen window). No-op
2686
+ * while any subscriber remains. Tears down the remote `_00_query` view +
2687
+ * local WASM view instead of waiting for the TTL sweep. Default behavior
2688
+ * (no call here) keeps the view resident for cheap re-subscription.
2689
+ */
2690
+ deregisterQuery(queryHash: string): void;
2691
+ /**
2692
+ * Subscribe to a query's fetch-status changes (idle/fetching). With
2693
+ * `{ immediate: true }` the callback fires synchronously with the current
2694
+ * status. Powers the `useQuery` hook's `isFetching()` accessor.
2695
+ */
2696
+ subscribeQueryStatus(queryHash: string, callback: QueryStatusCallback, options?: {
2697
+ immediate?: boolean;
2698
+ }): () => void;
2699
+ /**
2700
+ * Report the frontend processing time (ms) a client framework spent applying
2701
+ * an update for a query (e.g. `useQuery`'s `reconcile()`), so DevTools/MCP can
2702
+ * surface the "frontend" phase of the per-query timing breakdown.
2703
+ */
2704
+ reportFrontendTiming(queryHash: string, ms: number): void;
243
2705
  run<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(backend: B, path: R, payload: RoutePayload<S, B, R>, options?: RunOptions): Promise<void>;
244
2706
  bucket<B extends BucketNames<S>>(name: B): BucketHandle;
2707
+ /** Cache-free handle. The blob cache reads the remote through this, so a
2708
+ * cache miss can't loop back into the cache. */
2709
+ private rawBucket;
2710
+ /** Blob cache counters for DevTools. */
2711
+ getBlobCacheStats(): BlobCacheStats;
245
2712
  create(id: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
246
2713
  update(table: string, id: string, data: Record<string, unknown>, options?: UpdateOptions): Promise<{
247
2714
  [x: string]: /*elided*/any;
248
2715
  }>;
249
2716
  delete(table: string, id: string): Promise<void>;
2717
+ /**
2718
+ * Whether the local store is initialized and reads can be served. See the
2719
+ * `localReady` field: this is deliberately independent of connectivity.
2720
+ */
2721
+ isLocalReady(): boolean;
250
2722
  useRemote<T>(fn: (client: Surreal) => Promise<T> | T): Promise<T>;
251
- private persistClientId;
252
- private loadOrGenerateClientId;
2723
+ /**
2724
+ * Mint the salt used for query-id hashing, so two sessions registering the
2725
+ * same logical query get distinct `_00_query` rows.
2726
+ *
2727
+ * Generated LOCALLY, deliberately. This used to be `RETURN <string>session::id()`,
2728
+ * which cost a serial round trip on the critical boot path and resolved to
2729
+ * `''` offline. The value never needed to come from the server: the server
2730
+ * derives its own `clientId` inside `fn::query::register` and *ignores*
2731
+ * whatever the caller passed, and the permission rules that matter gate on
2732
+ * `auth_id = $auth.id` rather than the session (`_00_list_ref`). Session
2733
+ * scoping via `clientId = session::id()` was in fact removed upstream because
2734
+ * it broke a user with two tabs open. All this value has to be is unique per
2735
+ * browser session, which `randomUUID` gives us for free and offline.
2736
+ */
2737
+ /**
2738
+ * The current principal as the `"table:id"` string the in-browser SSP wants
2739
+ * for `$auth.id`, or null when signed out.
2740
+ *
2741
+ * Tolerates BOTH shapes `currentUser.id` can take, which is the point:
2742
+ * a session restored from the cached token carries a plain string (the JWT's
2743
+ * `ID` claim), while one verified by the server carries a RecordId. Passing
2744
+ * the former to `encodeRecordId` reads `.table` off a string and throws
2745
+ * during boot.
2746
+ */
2747
+ /**
2748
+ * Prime the in-browser circuit from the local store. Builds the context the
2749
+ * stream processor needs: every synced table (the app schema plus the
2750
+ * server-written meta tables that sync down), a schema hash so a snapshot
2751
+ * projected under another schema is not trusted, and the ids whose local
2752
+ * `_00_rv` was bumped by an unsettled mutation.
2753
+ */
2754
+ private primeCircuit;
2755
+ private sessionAuthId;
2756
+ private mintSessionSalt;
253
2757
  }
254
2758
  //#endregion
2759
+ //#region src/utils/semver.d.ts
2760
+ /** True when `a` is a valid version strictly greater than valid version `b`. */
2761
+ declare function semverGt(a: unknown, b: unknown): boolean;
2762
+ //#endregion
2763
+ //#region src/services/database/errors.d.ts
2764
+ /**
2765
+ * A local-store operation that did not answer within its deadline.
2766
+ *
2767
+ * The local write path (`db.create` / `db.update` / `db.delete`, every local
2768
+ * query behind them) used to have no deadline anywhere: the SQLite worker
2769
+ * transport parks a call until the worker replies, the surrealdb engine's
2770
+ * query chain waits on the previous link, and `withRetry` retries without a
2771
+ * clock. One op that never settled (a worker starved behind a long select, a
2772
+ * lock verification awaiting `navigator.locks.query()` forever) left the
2773
+ * caller's promise pending for the tab's lifetime - a chat composer that never
2774
+ * re-enabled, a call that never got past "Connecting".
2775
+ *
2776
+ * The message says "timed out" on purpose: `classifySyncError` keys off it and
2777
+ * treats the failure as transient (re-queue), never as an application error
2778
+ * that rolls the mutation back. `retryable: false` keeps `withRetry` from
2779
+ * spinning on it: the op is still running in the engine, retrying queues a
2780
+ * second copy behind it.
2781
+ */
2782
+ declare class LocalOpTimeoutError extends Error {
2783
+ readonly name = "LocalOpTimeoutError";
2784
+ readonly retryable = false;
2785
+ readonly op: string;
2786
+ readonly timeoutMs: number;
2787
+ constructor(op: string, timeoutMs: number);
2788
+ }
2789
+ /** Default deadline for one local-store operation. Generous: a cold 4k-row
2790
+ * select on a throttled tab is seconds, not tens of seconds. */
2791
+ declare const DEFAULT_LOCAL_OP_TIMEOUT_MS = 30000;
2792
+ //#endregion
255
2793
  //#region src/utils/index.d.ts
256
2794
  declare function fileToUint8Array(file: File | Blob): Promise<Uint8Array>;
2795
+ /**
2796
+ * Convert plain text to simple HTML paragraphs.
2797
+ * Useful for seeding a rich-text editor (e.g. TipTap/ProseMirror) with fallback content.
2798
+ */
2799
+ declare function textToHtml(text: string): string;
257
2800
  /**
258
2801
  * Helper for retrying DB operations with exponential backoff
259
2802
  */
260
2803
 
261
2804
  //#endregion
262
- export { AuthEventSystem, AuthEventTypeMap, AuthEventTypes, AuthService, BucketHandle, DebounceOptions, EventSubscriptionOptions, Level, MutationCallback, MutationEvent, MutationEventType, PersistenceClient, PinoTransmit, QueryConfig, QueryConfigRecord, QueryHash, QueryState, QueryTimeToLive, QueryUpdateCallback, RecordVersionArray, RecordVersionDiff, RunOptions, SpookyClient, SpookyConfig, SpookyQueryResult, SpookyQueryResultPromise, StoreType, UpdateOptions, createAuthEventSystem, fileToUint8Array };
2805
+ export { AppReleaseHandle, AppReleaseModule, type AppReleaseOptions, type AppReleaseSnapshot, AuthEventSystem, AuthEventTypeMap, AuthEventTypes, AuthService, BLURHASH_IMAGE_EXTENSIONS, type BlobCacheStats, type BlobEntry, type BlobKey, type BlobReadOptions, type BlobUrlLease, type BlurhashEncodeOptions, type BlurhashSetting, BucketHandle, BucketPutOptions, BucketPutResult, CURSOR_COLORS, ConnectionState, CrdtField, CrdtManager, DEFAULT_LOCAL_OP_TIMEOUT_MS, DebounceOptions, EventSubscriptionOptions, FeatureFlagHandle, FeatureFlagModule, type FeatureFlagOptions, type FeatureFlagOverride, type FeatureFlagSnapshot, Level, LocalOpTimeoutError, MATERIALIZATION_SAMPLE_WINDOW, MutationCallback, MutationEvent, MutationEventType, PersistenceClient, PhaseStat, PinoTransmit, PreloadOptions, PreloadRefresh, QueryConfig, QueryConfigRecord, QueryHash, QueryState, QueryStatus, QueryStatusCallback, QueryTimeToLive, QueryTimings, QueryUpdateCallback, ReconnectConfig, RecordVersionArray, RecordVersionDiff, RegistrationTimings, RunOptions, Sp00kyClient, Sp00kyConfig, Sp00kyQueryResult, Sp00kyQueryResultPromise, StorageHealth, StorageHealthStatus, StoreType, SyncHealth, SyncHealthConfig, SyncHealthStatus, TimingPhase, UpdateOptions, blurhashSidecarPath, bucketContentToBlob, createAuthEventSystem, cursorColorFromName, decode as decodeBlurhash, encode as encodeBlurhash, encodeImageToBlurhash, fileToUint8Array, isBlurhashValid, isImagePath, semverGt, textToHtml };