@spooky-sync/core 0.0.1-canary.13 → 0.0.1-canary.130
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +56 -0
- package/dist/index.d.ts +1171 -372
- package/dist/index.js +5716 -1278
- package/dist/otel/index.d.ts +21 -0
- package/dist/otel/index.js +86 -0
- package/dist/sqlite-worker.d.ts +1 -0
- package/dist/sqlite-worker.js +107 -0
- package/dist/types.d.ts +746 -0
- package/package.json +39 -8
- package/skills/sp00ky-core/SKILL.md +258 -0
- package/skills/sp00ky-core/references/auth.md +98 -0
- package/skills/sp00ky-core/references/config.md +76 -0
- package/src/build-globals.d.ts +12 -0
- package/src/events/events.test.ts +2 -1
- package/src/events/index.ts +3 -0
- package/src/index.ts +9 -2
- package/src/modules/auth/events/index.ts +2 -1
- package/src/modules/auth/index.ts +59 -20
- package/src/modules/cache/index.ts +77 -32
- package/src/modules/cache/types.ts +2 -2
- package/src/modules/crdt/crdt-field.ts +288 -0
- package/src/modules/crdt/crdt-hydration.test.ts +206 -0
- package/src/modules/crdt/index.ts +357 -0
- package/src/modules/data/data.hydration.test.ts +150 -0
- package/src/modules/data/data.rebind.test.ts +147 -0
- package/src/modules/data/data.recurring.test.ts +137 -0
- package/src/modules/data/data.status.test.ts +249 -0
- package/src/modules/data/index.ts +1228 -127
- package/src/modules/data/window-query.test.ts +52 -0
- package/src/modules/data/window-query.ts +154 -0
- package/src/modules/devtools/index.ts +191 -30
- package/src/modules/devtools/versions.test.ts +74 -0
- package/src/modules/devtools/versions.ts +81 -0
- package/src/modules/feature-flag/index.test.ts +120 -0
- package/src/modules/feature-flag/index.ts +209 -0
- package/src/modules/ref-tables.test.ts +91 -0
- package/src/modules/ref-tables.ts +88 -0
- package/src/modules/sync/engine.ts +101 -37
- package/src/modules/sync/events/index.ts +9 -2
- package/src/modules/sync/queue/queue-down.ts +12 -5
- package/src/modules/sync/queue/queue-up.ts +29 -14
- package/src/modules/sync/scheduler.pause.test.ts +109 -0
- package/src/modules/sync/scheduler.ts +73 -7
- package/src/modules/sync/sync.health.test.ts +149 -0
- package/src/modules/sync/sync.subquery.test.ts +82 -0
- package/src/modules/sync/sync.ts +1017 -62
- package/src/modules/sync/utils.test.ts +269 -2
- package/src/modules/sync/utils.ts +182 -17
- package/src/otel/index.ts +127 -0
- package/src/services/database/cache-engine.ts +143 -0
- package/src/services/database/database.ts +11 -11
- package/src/services/database/engine-factory.ts +32 -0
- package/src/services/database/events/index.ts +2 -1
- package/src/services/database/index.ts +6 -0
- package/src/services/database/local-migrator.ts +28 -27
- package/src/services/database/local.test.ts +64 -0
- package/src/services/database/local.ts +452 -66
- package/src/services/database/plan-render.test.ts +133 -0
- package/src/services/database/plan-render.ts +100 -0
- package/src/services/database/relation-resolver.test.ts +413 -0
- package/src/services/database/relation-resolver.ts +0 -0
- package/src/services/database/remote.ts +13 -13
- package/src/services/database/sqlite-cache-engine.test.ts +85 -0
- package/src/services/database/sqlite-cache-engine.ts +699 -0
- package/src/services/database/sqlite-worker.ts +116 -0
- package/src/services/database/surql-translate.ts +291 -0
- package/src/services/database/surreal-cache-engine.ts +122 -0
- package/src/services/logger/index.ts +6 -101
- package/src/services/persistence/localstorage.ts +2 -2
- package/src/services/persistence/resilient.ts +41 -0
- package/src/services/persistence/surrealdb.ts +10 -10
- package/src/services/stream-processor/index.ts +295 -38
- package/src/services/stream-processor/permissions.test.ts +47 -0
- package/src/services/stream-processor/permissions.ts +53 -0
- package/src/services/stream-processor/stream-processor.batch.test.ts +136 -0
- package/src/services/stream-processor/stream-processor.reset.test.ts +104 -0
- package/src/services/stream-processor/stream-processor.test.ts +1 -1
- package/src/services/stream-processor/wasm-types.ts +18 -2
- package/src/sp00ky.auth-order.test.ts +92 -0
- package/src/sp00ky.init-query.test.ts +185 -0
- package/src/sp00ky.ts +1016 -0
- package/src/types.ts +258 -15
- package/src/utils/error-classification.test.ts +44 -0
- package/src/utils/error-classification.ts +7 -0
- package/src/utils/index.ts +35 -13
- package/src/utils/parser.ts +3 -2
- package/src/utils/surql.ts +24 -15
- package/src/utils/withRetry.test.ts +1 -1
- package/tsdown.config.ts +77 -1
- package/src/spooky.ts +0 -392
package/dist/index.d.ts
CHANGED
|
@@ -1,166 +1,19 @@
|
|
|
1
|
+
import { A as SyncHealth, B as Logger$1, C as RecordVersionDiff, D as Sp00kyQueryResult, E as Sp00kyConfig, F as UpEvent, H as EventDefinition, I as LocalStore, L as SealedQuery, M as SyncHealthStatus, N as TimingPhase, O as Sp00kyQueryResultPromise, P as UpdateOptions, R as DatabaseEventSystem, S as RecordVersionArray, T as RunOptions, U as EventSystem, V as SyncEventSystem, _ as QueryStatus, a as MutationCallback, b as QueryTimings, c as PersistenceClient, d as PreloadOptions, f as PreloadRefresh, g as QueryState, h as QueryHash, i as MATERIALIZATION_SAMPLE_WINDOW, j as SyncHealthConfig, k as StoreType, l as PhaseStat, m as QueryConfigRecord, n as EventSubscriptionOptions, o as MutationEvent, p as QueryConfig, r as Level, s as MutationEventType, t as DebounceOptions, u as PinoTransmit, v as QueryStatusCallback, w as RegistrationTimings, x as QueryUpdateCallback, y as QueryTimeToLive, z as DatabaseEventTypes } from "./types.js";
|
|
1
2
|
import * as surrealdb0 from "surrealdb";
|
|
2
|
-
import { Duration, RecordId, Surreal, SurrealTransaction } from "surrealdb";
|
|
3
|
-
import { AccessDefinition, BackendNames, BackendRoutes, BucketNames, ColumnSchema, GetTable, QueryBuilder, QueryOptions,
|
|
4
|
-
import {
|
|
3
|
+
import { Duration, RecordId, Surreal as Surreal$1, 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
|
+
import { Logger } from "pino";
|
|
6
|
+
import { LoroDoc } from "loro-crdt";
|
|
5
7
|
|
|
6
|
-
//#region src/events/index.d.ts
|
|
7
|
-
/**
|
|
8
|
-
* Utility type to define the payload structure of an event.
|
|
9
|
-
* If the payload type P is never, it defines payload as undefined.
|
|
10
|
-
*/
|
|
11
|
-
type EventPayloadDefinition<P> = [P] extends [never] ? {
|
|
12
|
-
payload: undefined;
|
|
13
|
-
} : {
|
|
14
|
-
payload: P;
|
|
15
|
-
};
|
|
16
|
-
/**
|
|
17
|
-
* Defines the structure of an event with a specific type and payload.
|
|
18
|
-
* @template T The string literal type of the event.
|
|
19
|
-
* @template P The type of the event payload.
|
|
20
|
-
*/
|
|
21
|
-
type EventDefinition<T extends string, P> = {
|
|
22
|
-
type: T;
|
|
23
|
-
} & EventPayloadDefinition<P>;
|
|
24
|
-
/**
|
|
25
|
-
* A map of event types to their definitions.
|
|
26
|
-
* Keys are event names, values are EventDefinitions.
|
|
27
|
-
*/
|
|
28
|
-
type EventTypeMap = Record<string, EventDefinition<any, unknown> | EventDefinition<any, never>>;
|
|
29
|
-
/**
|
|
30
|
-
* Options for pushing/emitting events.
|
|
31
|
-
*/
|
|
32
|
-
interface PushEventOptions {
|
|
33
|
-
/** Configuration for debouncing the event. */
|
|
34
|
-
debounced?: {
|
|
35
|
-
key: string;
|
|
36
|
-
delay: number;
|
|
37
|
-
};
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Extracts the full Event object type from the map for a given key.
|
|
41
|
-
*/
|
|
42
|
-
type Event<E extends EventTypeMap, T extends EventType<E>> = E[T];
|
|
43
|
-
/**
|
|
44
|
-
* Extracts the payload type from the map for a given key.
|
|
45
|
-
*/
|
|
46
|
-
type EventPayload<E extends EventTypeMap, T extends EventType<E>> = E[T]['payload'];
|
|
47
|
-
/**
|
|
48
|
-
* Array of available event type keys.
|
|
49
|
-
*/
|
|
50
|
-
type EventTypes<E extends EventTypeMap> = (keyof E)[];
|
|
51
|
-
/**
|
|
52
|
-
* Represents a valid key (event name) from the EventTypeMap.
|
|
53
|
-
*/
|
|
54
|
-
type EventType<E extends EventTypeMap> = keyof E;
|
|
55
|
-
/**
|
|
56
|
-
* Function signature for an event handler.
|
|
57
|
-
*/
|
|
58
|
-
type EventHandler<E extends EventTypeMap, T extends EventType<E>> = (event: Event<E, T>) => void;
|
|
59
|
-
/**
|
|
60
|
-
* Options when subscribing to an event.
|
|
61
|
-
*/
|
|
62
|
-
type EventSubscriptionOptions$1 = {
|
|
63
|
-
/** If true, the handler will be called immediately with the last emitted event of this type (if any). */
|
|
64
|
-
immediately?: boolean;
|
|
65
|
-
/** If true, the subscription will be automatically removed after the first event is handled. */
|
|
66
|
-
once?: boolean;
|
|
67
|
-
};
|
|
68
|
-
/**
|
|
69
|
-
* A type-safe event system that handles subscription, emission (including debouncing), and buffering of events.
|
|
70
|
-
* @template E The EventTypeMap defining all supported events.
|
|
71
|
-
*/
|
|
72
|
-
declare class EventSystem<E extends EventTypeMap> {
|
|
73
|
-
private _eventTypes;
|
|
74
|
-
private subscriberId;
|
|
75
|
-
private isProcessing;
|
|
76
|
-
private buffer;
|
|
77
|
-
private subscribers;
|
|
78
|
-
private subscribersTypeMap;
|
|
79
|
-
private lastEvents;
|
|
80
|
-
private debouncedEvents;
|
|
81
|
-
constructor(_eventTypes: EventTypes<E>);
|
|
82
|
-
get eventTypes(): EventTypes<E>;
|
|
83
|
-
/**
|
|
84
|
-
* Subscribes a handler to a specific event type.
|
|
85
|
-
* @param type The event type to subscribe to.
|
|
86
|
-
* @param handler The function to call when the event occurs.
|
|
87
|
-
* @param options Subscription options (once, immediately).
|
|
88
|
-
* @returns A subscription ID that can be used to unsubscribe.
|
|
89
|
-
*/
|
|
90
|
-
subscribe<T extends EventType<E>>(type: T, handler: EventHandler<E, T>, options?: EventSubscriptionOptions$1): number;
|
|
91
|
-
/**
|
|
92
|
-
* Subscribes a handler to multiple event types.
|
|
93
|
-
* @param types An array of event types to subscribe to.
|
|
94
|
-
* @param handler The function to call when any of the events occur.
|
|
95
|
-
* @param options Subscription options.
|
|
96
|
-
* @returns An array of subscription IDs.
|
|
97
|
-
*/
|
|
98
|
-
subscribeMany<T extends EventType<E>>(types: T[], handler: EventHandler<E, T>, options?: EventSubscriptionOptions$1): number[];
|
|
99
|
-
/**
|
|
100
|
-
* Unsubscribes a specific subscription by ID.
|
|
101
|
-
* @param id The subscription ID returned by subscribe().
|
|
102
|
-
* @returns True if the subscription was found and removed, false otherwise.
|
|
103
|
-
*/
|
|
104
|
-
unsubscribe(id: number): boolean;
|
|
105
|
-
/**
|
|
106
|
-
* Emits an event with the given type and payload.
|
|
107
|
-
* @param type The type of event to emit.
|
|
108
|
-
* @param payload The data associated with the event.
|
|
109
|
-
*/
|
|
110
|
-
emit<T extends EventType<E>, P extends EventPayload<E, T>>(type: T, payload: P): void;
|
|
111
|
-
/**
|
|
112
|
-
* Adds a fully constructed event object to the system.
|
|
113
|
-
* Similar to emit, but takes the full event object directly.
|
|
114
|
-
* Supports debouncing if options are provided.
|
|
115
|
-
* @param event The event object.
|
|
116
|
-
* @param options Options for the event push (e.g., debouncing).
|
|
117
|
-
*/
|
|
118
|
-
addEvent<T extends EventType<E>>(event: Event<E, T>, options?: PushEventOptions): void;
|
|
119
|
-
private handleDebouncedEvent;
|
|
120
|
-
private scheduleProcessing;
|
|
121
|
-
private processEvents;
|
|
122
|
-
private dequeue;
|
|
123
|
-
private setLastEvent;
|
|
124
|
-
private broadcastEvent;
|
|
125
|
-
}
|
|
126
|
-
//#endregion
|
|
127
|
-
//#region src/services/logger/index.d.ts
|
|
128
|
-
type Logger$1 = Logger;
|
|
129
|
-
//#endregion
|
|
130
|
-
//#region src/services/database/events/index.d.ts
|
|
131
|
-
declare const DatabaseEventTypes: {
|
|
132
|
-
readonly LocalQuery: "DATABASE_LOCAL_QUERY";
|
|
133
|
-
readonly RemoteQuery: "DATABASE_REMOTE_QUERY";
|
|
134
|
-
};
|
|
135
|
-
interface DatabaseQueryEventPayload {
|
|
136
|
-
query: string;
|
|
137
|
-
vars?: Record<string, unknown>;
|
|
138
|
-
duration: number;
|
|
139
|
-
success: boolean;
|
|
140
|
-
error?: string;
|
|
141
|
-
timestamp: number;
|
|
142
|
-
}
|
|
143
|
-
type DatabaseEventTypeMap = {
|
|
144
|
-
[DatabaseEventTypes.LocalQuery]: EventDefinition<typeof DatabaseEventTypes.LocalQuery, DatabaseQueryEventPayload>;
|
|
145
|
-
[DatabaseEventTypes.RemoteQuery]: EventDefinition<typeof DatabaseEventTypes.RemoteQuery, DatabaseQueryEventPayload>;
|
|
146
|
-
};
|
|
147
|
-
type DatabaseEventSystem = EventSystem<DatabaseEventTypeMap>;
|
|
148
|
-
//#endregion
|
|
149
|
-
//#region src/utils/surql.d.ts
|
|
150
|
-
interface SealedQuery<T = void> {
|
|
151
|
-
readonly sql: string;
|
|
152
|
-
readonly extract: (results: unknown[]) => T;
|
|
153
|
-
}
|
|
154
|
-
//#endregion
|
|
155
8
|
//#region src/services/database/database.d.ts
|
|
156
9
|
declare abstract class AbstractDatabaseService {
|
|
157
|
-
protected client: Surreal;
|
|
10
|
+
protected client: Surreal$1;
|
|
158
11
|
protected logger: Logger$1;
|
|
159
12
|
protected events: DatabaseEventSystem;
|
|
160
13
|
protected abstract eventType: typeof DatabaseEventTypes.LocalQuery | typeof DatabaseEventTypes.RemoteQuery;
|
|
161
|
-
constructor(client: Surreal, logger: Logger$1, events: DatabaseEventSystem);
|
|
14
|
+
constructor(client: Surreal$1, logger: Logger$1, events: DatabaseEventSystem);
|
|
162
15
|
abstract connect(): Promise<void>;
|
|
163
|
-
getClient(): Surreal;
|
|
16
|
+
getClient(): Surreal$1;
|
|
164
17
|
getEvents(): DatabaseEventSystem;
|
|
165
18
|
tx(): Promise<SurrealTransaction>;
|
|
166
19
|
private queryQueue;
|
|
@@ -172,21 +25,12 @@ declare abstract class AbstractDatabaseService {
|
|
|
172
25
|
close(): Promise<void>;
|
|
173
26
|
}
|
|
174
27
|
//#endregion
|
|
175
|
-
//#region src/services/database/local.d.ts
|
|
176
|
-
declare class LocalDatabaseService extends AbstractDatabaseService {
|
|
177
|
-
private config;
|
|
178
|
-
protected eventType: "DATABASE_LOCAL_QUERY";
|
|
179
|
-
constructor(config: SpookyConfig<any>['database'], logger: Logger$1);
|
|
180
|
-
getConfig(): SpookyConfig<any>['database'];
|
|
181
|
-
connect(): Promise<void>;
|
|
182
|
-
}
|
|
183
|
-
//#endregion
|
|
184
28
|
//#region src/services/database/remote.d.ts
|
|
185
29
|
declare class RemoteDatabaseService extends AbstractDatabaseService {
|
|
186
30
|
private config;
|
|
187
31
|
protected eventType: "DATABASE_REMOTE_QUERY";
|
|
188
|
-
constructor(config:
|
|
189
|
-
getConfig():
|
|
32
|
+
constructor(config: Sp00kyConfig<any>['database'], logger: Logger$1);
|
|
33
|
+
getConfig(): Sp00kyConfig<any>['database'];
|
|
190
34
|
connect(): Promise<void>;
|
|
191
35
|
signin(params: any): Promise<any>;
|
|
192
36
|
signup(params: any): Promise<any>;
|
|
@@ -194,38 +38,44 @@ declare class RemoteDatabaseService extends AbstractDatabaseService {
|
|
|
194
38
|
invalidate(): Promise<void>;
|
|
195
39
|
}
|
|
196
40
|
//#endregion
|
|
197
|
-
//#region src/modules/sync/queue/queue-
|
|
198
|
-
type
|
|
199
|
-
type: '
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
record?: Record<string, unknown>;
|
|
204
|
-
tableName?: string;
|
|
205
|
-
options?: PushEventOptions;
|
|
41
|
+
//#region src/modules/sync/queue/queue-down.d.ts
|
|
42
|
+
type RegisterEvent = {
|
|
43
|
+
type: 'register';
|
|
44
|
+
payload: {
|
|
45
|
+
hash: string;
|
|
46
|
+
};
|
|
206
47
|
};
|
|
207
|
-
type
|
|
208
|
-
type: '
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
record?: Record<string, unknown>;
|
|
213
|
-
beforeRecord?: Record<string, unknown>;
|
|
214
|
-
options?: PushEventOptions;
|
|
48
|
+
type SyncEvent = {
|
|
49
|
+
type: 'sync';
|
|
50
|
+
payload: {
|
|
51
|
+
hash: string;
|
|
52
|
+
};
|
|
215
53
|
};
|
|
216
|
-
type
|
|
217
|
-
type: '
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
54
|
+
type HeartbeatEvent = {
|
|
55
|
+
type: 'heartbeat';
|
|
56
|
+
payload: {
|
|
57
|
+
hash: string;
|
|
58
|
+
};
|
|
59
|
+
};
|
|
60
|
+
type CleanupEvent = {
|
|
61
|
+
type: 'cleanup';
|
|
62
|
+
payload: {
|
|
63
|
+
hash: string;
|
|
64
|
+
};
|
|
221
65
|
};
|
|
222
|
-
type
|
|
66
|
+
type DownEvent = RegisterEvent | SyncEvent | HeartbeatEvent | CleanupEvent;
|
|
223
67
|
//#endregion
|
|
224
68
|
//#region src/services/stream-processor/wasm-types.d.ts
|
|
225
69
|
interface WasmStreamUpdate {
|
|
226
70
|
query_id: string;
|
|
227
71
|
result_hash: string;
|
|
228
72
|
result_data: RecordVersionArray;
|
|
73
|
+
timing_store_apply_ms?: number;
|
|
74
|
+
timing_circuit_step_ms?: number;
|
|
75
|
+
timing_transform_ms?: number;
|
|
76
|
+
timing_parse_ms?: number;
|
|
77
|
+
timing_plan_ms?: number;
|
|
78
|
+
timing_snapshot_ms?: number;
|
|
229
79
|
}
|
|
230
80
|
//#endregion
|
|
231
81
|
//#region src/services/stream-processor/index.d.ts
|
|
@@ -246,6 +96,25 @@ interface StreamUpdate {
|
|
|
246
96
|
queryHash: string;
|
|
247
97
|
localArray: RecordVersionArray;
|
|
248
98
|
op?: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
99
|
+
/**
|
|
100
|
+
* End-to-end ingest latency for the WASM call that produced this update,
|
|
101
|
+
* in milliseconds. Populated by StreamProcessorService.ingest. Undefined
|
|
102
|
+
* for the initial register_view snapshot.
|
|
103
|
+
*/
|
|
104
|
+
materializationTimeMs?: number;
|
|
105
|
+
/** SSP internal sub-phase timings (ms) for this ingest, from the WASM binding. */
|
|
106
|
+
storeApplyMs?: number;
|
|
107
|
+
circuitStepMs?: number;
|
|
108
|
+
transformMs?: number;
|
|
109
|
+
/**
|
|
110
|
+
* One-shot registration timings (ms). Only set on the StreamUpdate returned
|
|
111
|
+
* by `registerQueryPlan` (the register_view snapshot), not on ingest updates.
|
|
112
|
+
*/
|
|
113
|
+
registration?: {
|
|
114
|
+
parseMs: number;
|
|
115
|
+
planMs: number;
|
|
116
|
+
snapshotMs: number;
|
|
117
|
+
};
|
|
249
118
|
}
|
|
250
119
|
type StreamProcessorEvents = {
|
|
251
120
|
stream_update: EventDefinition<'stream_update', StreamUpdate[]>;
|
|
@@ -265,19 +134,89 @@ declare class StreamProcessorService {
|
|
|
265
134
|
private processor;
|
|
266
135
|
private isInitialized;
|
|
267
136
|
private receivers;
|
|
268
|
-
|
|
137
|
+
private batching;
|
|
138
|
+
private batchBuffer;
|
|
139
|
+
private sessionAuth;
|
|
140
|
+
private stateKeySuffix;
|
|
141
|
+
private stateGeneration;
|
|
142
|
+
constructor(events: EventSystem<StreamProcessorEvents>, db: LocalStore, persistenceClient: PersistenceClient, logger: Logger);
|
|
269
143
|
/**
|
|
270
144
|
* Add a receiver for stream updates.
|
|
271
145
|
* Multiple receivers can be registered (DataManager, DevTools, etc.)
|
|
272
146
|
*/
|
|
273
147
|
addReceiver(receiver: StreamUpdateReceiver): void;
|
|
274
148
|
private notifyUpdates;
|
|
149
|
+
private dispatchUpdates;
|
|
150
|
+
/**
|
|
151
|
+
* Ingest a batch of record changes as a single bulk operation, firing only
|
|
152
|
+
* one coalesced `StreamUpdate` per affected query once every record has been
|
|
153
|
+
* ingested (instead of one update per record). Use this whenever multiple
|
|
154
|
+
* records land at once — e.g. sync fetching N missing rows — so a list query
|
|
155
|
+
* re-runs and the UI re-renders once for the whole batch rather than
|
|
156
|
+
* row-by-row.
|
|
157
|
+
*
|
|
158
|
+
* Internally opens a coalescing window, ingests each record, then flushes;
|
|
159
|
+
* processor state is persisted once for the whole batch. No-op for an empty
|
|
160
|
+
* batch.
|
|
161
|
+
*/
|
|
162
|
+
ingestMany(records: Array<{
|
|
163
|
+
table: string;
|
|
164
|
+
op: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
165
|
+
id: string;
|
|
166
|
+
record: any;
|
|
167
|
+
}>): void;
|
|
168
|
+
/**
|
|
169
|
+
* Open a coalescing window. While open, the per-record stream updates
|
|
170
|
+
* emitted by `ingest` are buffered (one entry per queryHash) instead of
|
|
171
|
+
* dispatched. Always paired with `flushCoalescing()` in a try/finally by
|
|
172
|
+
* `ingestMany` so the window always closes — otherwise the processor stays
|
|
173
|
+
* stuck buffering forever.
|
|
174
|
+
*
|
|
175
|
+
* No-op if a window is already open (nested batches aren't expected here).
|
|
176
|
+
*/
|
|
177
|
+
private beginCoalescing;
|
|
178
|
+
/**
|
|
179
|
+
* Close the coalescing window and flush: dispatch one coalesced
|
|
180
|
+
* `StreamUpdate` per buffered queryHash, then persist processor state once
|
|
181
|
+
* for the whole batch (instead of once per ingest).
|
|
182
|
+
*/
|
|
183
|
+
private flushCoalescing;
|
|
275
184
|
/**
|
|
276
185
|
* Initialize the WASM module and processor.
|
|
277
186
|
* This must be called before using other methods.
|
|
278
187
|
*/
|
|
279
188
|
init(): Promise<void>;
|
|
189
|
+
/** Route the persisted circuit snapshot to a per-bucket key. */
|
|
190
|
+
setStateKeySuffix(bucketId: string): void;
|
|
191
|
+
private stateKey;
|
|
192
|
+
/**
|
|
193
|
+
* Drop the current WASM processor and start a fresh, empty circuit. Used on
|
|
194
|
+
* local-bucket switches: the old circuit holds the previous user's rows AND
|
|
195
|
+
* views registered with the previous `$auth` context, so neither may survive.
|
|
196
|
+
* Deliberately does NOT `loadState()` — a persisted snapshot references views
|
|
197
|
+
* under a dead sessionId salt; the DataModule rebind re-registers every live
|
|
198
|
+
* view against this fresh processor. Caller must re-seed `setPermissions`
|
|
199
|
+
* afterwards (a fresh circuit default-denies every table).
|
|
200
|
+
*/
|
|
201
|
+
reset(): Promise<void>;
|
|
280
202
|
loadState(): Promise<void>;
|
|
203
|
+
/**
|
|
204
|
+
* Seed per-table `select` permission predicates ({ [table]: whereText }).
|
|
205
|
+
* Must run after the processor exists and before any `register_view`, else
|
|
206
|
+
* non-`_00_` tables are default-denied and registration fails.
|
|
207
|
+
*/
|
|
208
|
+
setPermissions(permissions: Record<string, string>): void;
|
|
209
|
+
/**
|
|
210
|
+
* Set the current session's auth identity for permission injection,
|
|
211
|
+
* mirroring the server's `fn::query::register`
|
|
212
|
+
* (`object::extend(params, { auth: { id: $auth.id }, access: $access })`).
|
|
213
|
+
* Stored as strings (empty when logged out) and applied to every
|
|
214
|
+
* `register_view` in {@link registerQueryPlan}. Must be set before a
|
|
215
|
+
* `$auth`-gated query registers (and re-set on auth state changes), or the
|
|
216
|
+
* in-browser SSP's `permission_inject` rejects it with
|
|
217
|
+
* "requires $auth but registration params lack it".
|
|
218
|
+
*/
|
|
219
|
+
setSessionAuth(authId: string | null, access: string | null): void;
|
|
281
220
|
saveState(): Promise<void>;
|
|
282
221
|
/**
|
|
283
222
|
* Ingest a record change into the processor.
|
|
@@ -297,203 +236,687 @@ declare class StreamProcessorService {
|
|
|
297
236
|
private normalizeValue;
|
|
298
237
|
}
|
|
299
238
|
//#endregion
|
|
300
|
-
//#region src/types.d.ts
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
239
|
+
//#region src/modules/cache/types.d.ts
|
|
240
|
+
type RecordWithId = Record<string, any> & {
|
|
241
|
+
id: RecordId<string>;
|
|
242
|
+
};
|
|
243
|
+
interface QueryConfig$1 {
|
|
244
|
+
queryHash: string;
|
|
245
|
+
surql: string;
|
|
246
|
+
params: Record<string, any>;
|
|
247
|
+
ttl: QueryTimeToLive | Duration;
|
|
248
|
+
lastActiveAt: Date;
|
|
249
|
+
}
|
|
250
|
+
interface CacheRecord {
|
|
251
|
+
table: string;
|
|
252
|
+
op: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
253
|
+
record: RecordWithId;
|
|
254
|
+
version: number;
|
|
255
|
+
}
|
|
256
|
+
//#endregion
|
|
257
|
+
//#region src/modules/cache/index.d.ts
|
|
307
258
|
/**
|
|
308
|
-
*
|
|
309
|
-
*
|
|
259
|
+
* CacheModule - Centralized storage and DBSP ingestion
|
|
260
|
+
*
|
|
261
|
+
* Single responsibility: Handle all local storage operations and DBSP ingestion.
|
|
262
|
+
* This module acts as the bridge between data operations and persistence.
|
|
310
263
|
*/
|
|
311
|
-
|
|
264
|
+
declare class CacheModule implements StreamUpdateReceiver {
|
|
265
|
+
private local;
|
|
266
|
+
private streamProcessor;
|
|
267
|
+
private logger;
|
|
268
|
+
private streamUpdateCallback;
|
|
269
|
+
private versionLookups;
|
|
270
|
+
constructor(local: LocalStore, streamProcessor: StreamProcessorService, streamUpdateCallback: (update: StreamUpdate) => void, logger: Logger$1);
|
|
312
271
|
/**
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
* @param value The value to store.
|
|
272
|
+
* Implements StreamUpdateReceiver interface
|
|
273
|
+
* Called directly by StreamProcessor when views change
|
|
316
274
|
*/
|
|
317
|
-
|
|
275
|
+
onStreamUpdate(update: StreamUpdate): void;
|
|
276
|
+
lookup(recordId: string): number;
|
|
277
|
+
/** Drop the version cache on a bucket switch — a stale version would make
|
|
278
|
+
* the sync diff skip fetching a body the new bucket legitimately needs. */
|
|
279
|
+
clearVersionLookups(): void;
|
|
318
280
|
/**
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
* @returns The stored value or null if not found.
|
|
281
|
+
* Save a single record to local DB and ingest into DBSP
|
|
282
|
+
* Used by mutations (create/update)
|
|
322
283
|
*/
|
|
323
|
-
|
|
284
|
+
save(cacheRecord: CacheRecord, skipDbInsert?: boolean): Promise<void>;
|
|
324
285
|
/**
|
|
325
|
-
*
|
|
326
|
-
*
|
|
286
|
+
* Save multiple records in a batch
|
|
287
|
+
* More efficient than calling save() multiple times
|
|
288
|
+
* Used by sync operations
|
|
327
289
|
*/
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
priority?: number;
|
|
345
|
-
}
|
|
346
|
-
/**
|
|
347
|
-
* Configuration options for the Spooky client.
|
|
348
|
-
* @template S The schema structure type.
|
|
349
|
-
*/
|
|
350
|
-
interface SpookyConfig<S extends SchemaStructure> {
|
|
351
|
-
/** Database connection configuration. */
|
|
352
|
-
database: {
|
|
353
|
-
/** The SurrealDB endpoint URL. */
|
|
354
|
-
endpoint?: string;
|
|
355
|
-
/** The namespace to use. */
|
|
356
|
-
namespace: string;
|
|
357
|
-
/** The database name. */
|
|
358
|
-
database: string;
|
|
359
|
-
/** The local store type implementation. */
|
|
360
|
-
store?: StoreType;
|
|
361
|
-
/** Authentication token. */
|
|
362
|
-
token?: string;
|
|
290
|
+
saveBatch(records: CacheRecord[], skipDbInsert?: boolean): Promise<void>;
|
|
291
|
+
/**
|
|
292
|
+
* Delete a record from local DB and ingest deletion into DBSP
|
|
293
|
+
*/
|
|
294
|
+
delete(table: string, id: string, skipDbDelete?: boolean, recordData?: Record<string, any>): Promise<void>;
|
|
295
|
+
/**
|
|
296
|
+
* Register a query with DBSP to create a materialized view
|
|
297
|
+
* Returns the initial result array
|
|
298
|
+
*/
|
|
299
|
+
registerQuery(config: QueryConfig$1): {
|
|
300
|
+
localArray: RecordVersionArray;
|
|
301
|
+
registrationTimings?: {
|
|
302
|
+
parseMs: number;
|
|
303
|
+
planMs: number;
|
|
304
|
+
snapshotMs: number;
|
|
305
|
+
};
|
|
363
306
|
};
|
|
364
|
-
/**
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
/** The compiled SURQL schema string. */
|
|
369
|
-
schemaSurql: string;
|
|
370
|
-
/** Logging level. */
|
|
371
|
-
logLevel: Level$1;
|
|
372
|
-
/**
|
|
373
|
-
* Persistence client to use.
|
|
374
|
-
* Can be a custom implementation, 'surrealdb' (default), or 'localstorage'.
|
|
375
|
-
*/
|
|
376
|
-
persistenceClient?: PersistenceClient | 'surrealdb' | 'localstorage';
|
|
377
|
-
/** OpenTelemetry collector endpoint for telemetry data. */
|
|
378
|
-
otelEndpoint?: string;
|
|
379
|
-
/**
|
|
380
|
-
* Debounce time in milliseconds for stream updates.
|
|
381
|
-
* Defaults to 100ms.
|
|
382
|
-
*/
|
|
383
|
-
streamDebounceTime?: number;
|
|
384
|
-
}
|
|
385
|
-
type QueryHash = string;
|
|
386
|
-
type RecordVersionArray = Array<[string, number]>;
|
|
387
|
-
/**
|
|
388
|
-
* Represents the difference between two record version sets.
|
|
389
|
-
* Used for synchronizing local and remote states.
|
|
390
|
-
*/
|
|
391
|
-
interface RecordVersionDiff {
|
|
392
|
-
/** List of records added. */
|
|
393
|
-
added: Array<{
|
|
394
|
-
id: RecordId$1<string>;
|
|
395
|
-
version: number;
|
|
396
|
-
}>;
|
|
397
|
-
/** List of records updated. */
|
|
398
|
-
updated: Array<{
|
|
399
|
-
id: RecordId$1<string>;
|
|
400
|
-
version: number;
|
|
401
|
-
}>;
|
|
402
|
-
/** List of record IDs removed. */
|
|
403
|
-
removed: RecordId$1<string>[];
|
|
404
|
-
}
|
|
405
|
-
/**
|
|
406
|
-
* Configuration for a specific query instance.
|
|
407
|
-
* Stores metadata about the query's state, parameters, and versioning.
|
|
408
|
-
*/
|
|
409
|
-
interface QueryConfig {
|
|
410
|
-
/** The unique ID of the query config record. */
|
|
411
|
-
id: RecordId$1<string>;
|
|
412
|
-
/** The SURQL query string. */
|
|
413
|
-
surql: string;
|
|
414
|
-
/** Parameters used in the query. */
|
|
415
|
-
params: Record<string, any>;
|
|
416
|
-
/** The version array representing the local state of results. */
|
|
417
|
-
localArray: RecordVersionArray;
|
|
418
|
-
/** The version array representing the remote (server) state of results. */
|
|
419
|
-
remoteArray: RecordVersionArray;
|
|
420
|
-
/** Time-To-Live for this query. */
|
|
421
|
-
ttl: QueryTimeToLive;
|
|
422
|
-
/** Timestamp when the query was last accessed/active. */
|
|
423
|
-
lastActiveAt: Date;
|
|
424
|
-
/** The name of the table this query targets (if applicable). */
|
|
425
|
-
tableName: string;
|
|
426
|
-
}
|
|
427
|
-
type QueryConfigRecord = QueryConfig & {
|
|
428
|
-
id: string;
|
|
429
|
-
};
|
|
430
|
-
/**
|
|
431
|
-
* Internal state of a live query.
|
|
432
|
-
*/
|
|
433
|
-
interface QueryState {
|
|
434
|
-
/** The configuration for this query. */
|
|
435
|
-
config: QueryConfig;
|
|
436
|
-
/** The current cached records for this query. */
|
|
437
|
-
records: Record<string, any>[];
|
|
438
|
-
/** Timer for TTL expiration. */
|
|
439
|
-
ttlTimer: NodeJS.Timeout | null;
|
|
440
|
-
/** TTL duration in milliseconds. */
|
|
441
|
-
ttlDurationMs: number;
|
|
442
|
-
/** Number of times the query has been updated. */
|
|
443
|
-
updateCount: number;
|
|
307
|
+
/**
|
|
308
|
+
* Unregister a query from DBSP
|
|
309
|
+
*/
|
|
310
|
+
unregisterQuery(queryHash: string): void;
|
|
444
311
|
}
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
type MutationEventType = 'create' | 'update' | 'delete';
|
|
312
|
+
//#endregion
|
|
313
|
+
//#region src/modules/data/index.d.ts
|
|
448
314
|
/**
|
|
449
|
-
*
|
|
315
|
+
* DataModule - Unified query and mutation management
|
|
316
|
+
*
|
|
317
|
+
* Merges the functionality of QueryManager and MutationManager.
|
|
318
|
+
* Uses CacheModule for all storage operations.
|
|
450
319
|
*/
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
320
|
+
declare class DataModule<S extends SchemaStructure> {
|
|
321
|
+
private cache;
|
|
322
|
+
private local;
|
|
323
|
+
private schema;
|
|
324
|
+
private streamDebounceTime;
|
|
325
|
+
private activeQueries;
|
|
326
|
+
private pendingQueries;
|
|
327
|
+
private subscriptions;
|
|
328
|
+
private statusSubscriptions;
|
|
329
|
+
private mutationCallbacks;
|
|
330
|
+
private debounceTimers;
|
|
331
|
+
private pendingStreamUpdates;
|
|
332
|
+
private fetchDepth;
|
|
333
|
+
private logger;
|
|
334
|
+
/**
|
|
335
|
+
* Optional observer notified whenever a query's fetch status changes.
|
|
336
|
+
* Wired by Sp00kyClient to push status changes into DevTools. Kept as a
|
|
337
|
+
* settable field (rather than a constructor arg) because DevTools is
|
|
338
|
+
* constructed after DataModule.
|
|
339
|
+
*/
|
|
340
|
+
onQueryStatusChange?: (hash: QueryHash, status: QueryStatus) => void;
|
|
341
|
+
/**
|
|
342
|
+
* Optional observer invoked when a still-subscribed query's TTL heartbeat
|
|
343
|
+
* fires (~90% of the TTL). Wired by Sp00kyClient to
|
|
344
|
+
* `Sp00kySync.heartbeatQuery`, which refreshes the remote `_00_query`
|
|
345
|
+
* row's `lastActiveAt` so an actively-watched query never expires. Settable
|
|
346
|
+
* field (not a constructor arg) because the sync engine is wired after
|
|
347
|
+
* DataModule is constructed — mirrors `onQueryStatusChange`.
|
|
348
|
+
*/
|
|
349
|
+
onHeartbeat?: (hash: QueryHash) => void;
|
|
350
|
+
/**
|
|
351
|
+
* Optional hook fired by {@link deregisterQuery} when an opt-in query (e.g. a
|
|
352
|
+
* viewport-windowed list cancelling an off-screen window) loses its last
|
|
353
|
+
* subscriber. Wired by Sp00kyClient to enqueue a `cleanup` down-event, which
|
|
354
|
+
* tears the remote `_00_query` view down (releasing its `_00_list_ref` edges)
|
|
355
|
+
* instead of leaving it for the TTL sweep. The local view + state are freed in
|
|
356
|
+
* {@link finalizeDeregister} only after that remote delete, so a fast
|
|
357
|
+
* re-subscribe (scroll back) can abort/heal the teardown — see `cleanupQuery`.
|
|
358
|
+
*/
|
|
359
|
+
onDeregister?: (hash: QueryHash) => void;
|
|
360
|
+
private sessionId;
|
|
361
|
+
private currentUserId;
|
|
362
|
+
constructor(cache: CacheModule, local: LocalStore, schema: S, logger: Logger$1, streamDebounceTime?: number);
|
|
363
|
+
init(sessionId: string): Promise<void>;
|
|
364
|
+
/**
|
|
365
|
+
* Update the session salt used in query-id hashing. Call this when the
|
|
366
|
+
* SurrealDB session changes (sign-in, sign-out, reconnect). Subsequently
|
|
367
|
+
* registered queries will get fresh, session-scoped IDs.
|
|
368
|
+
*/
|
|
369
|
+
setSessionId(sessionId: string): void;
|
|
370
|
+
/**
|
|
371
|
+
* Update the authenticated user record id. Pass `null` on sign-out.
|
|
372
|
+
* Read by `Sp00kySync.listRefTable()` so the LIVE subscription and
|
|
373
|
+
* the poll route to the same per-user `_00_list_ref_user_<id>` the
|
|
374
|
+
* SSP writes to.
|
|
375
|
+
*/
|
|
376
|
+
setCurrentUserId(userId: string | null): void;
|
|
377
|
+
/** Read-only view of the authenticated user id used for per-user
|
|
378
|
+
* `_00_list_ref` routing. Other modules consult this so they pick the
|
|
379
|
+
* same table name DataModule does. */
|
|
380
|
+
getCurrentUserId(): string | null;
|
|
381
|
+
/**
|
|
382
|
+
* Register a query and return its hash for subscriptions
|
|
383
|
+
*/
|
|
384
|
+
query<T extends TableNames<S>>(tableName: T, surqlString: string, params: Record<string, any>, ttl: QueryTimeToLive, plan?: QueryPlan): Promise<QueryHash>;
|
|
385
|
+
/**
|
|
386
|
+
* Subscribe to query updates
|
|
387
|
+
*/
|
|
388
|
+
subscribe(queryHash: string, callback: QueryUpdateCallback, options?: {
|
|
389
|
+
immediate?: boolean;
|
|
390
|
+
}): () => void;
|
|
391
|
+
/**
|
|
392
|
+
* Subscribe to a query's fetch-status changes (idle/fetching).
|
|
393
|
+
* With `{ immediate: true }` the callback fires synchronously with the
|
|
394
|
+
* current status (defaults to `idle` if the query isn't registered yet).
|
|
395
|
+
*/
|
|
396
|
+
subscribeStatus(queryHash: string, callback: QueryStatusCallback, options?: {
|
|
397
|
+
immediate?: boolean;
|
|
398
|
+
}): () => void;
|
|
399
|
+
/**
|
|
400
|
+
* Set a query's fetch status and notify status observers (DevTools +
|
|
401
|
+
* `subscribeStatus` listeners). No-op when the status is unchanged or the
|
|
402
|
+
* query is unknown.
|
|
403
|
+
*/
|
|
404
|
+
setQueryStatus(queryHash: string, status: QueryStatus): void;
|
|
405
|
+
/**
|
|
406
|
+
* Enter a fetch cycle for a query. Refcounted: registration and concurrent
|
|
407
|
+
* poll/LIVE sync rounds can overlap on the same hash, and only the OUTERMOST
|
|
408
|
+
* cycle may flip the status — 0→1 emits `fetching`, and `endFetching`'s 1→0
|
|
409
|
+
* emits `idle`. Always pair with `endFetching` in a `finally`.
|
|
410
|
+
*/
|
|
411
|
+
beginFetching(queryHash: string): void;
|
|
412
|
+
/** Leave a fetch cycle started with {@link beginFetching}; emits `idle` on the last exit. */
|
|
413
|
+
endFetching(queryHash: string): void;
|
|
414
|
+
/**
|
|
415
|
+
* Subscribe to mutations (for sync)
|
|
416
|
+
*/
|
|
417
|
+
onMutation(callback: MutationCallback): () => void;
|
|
418
|
+
/**
|
|
419
|
+
* Handle stream updates from DBSP (via CacheModule)
|
|
420
|
+
*/
|
|
421
|
+
onStreamUpdate(update: StreamUpdate): Promise<void>;
|
|
422
|
+
/**
|
|
423
|
+
* Process a query's pending (debounced) stream update NOW instead of on the
|
|
424
|
+
* trailing edge. Called by the sync engine before it flips a query back to
|
|
425
|
+
* `idle`, so the status change never races ahead of the rows it fetched.
|
|
426
|
+
* No-op when nothing is pending. The pending entry is removed before the
|
|
427
|
+
* await so a concurrently-firing timer can't process it twice.
|
|
428
|
+
*/
|
|
429
|
+
flushPendingStreamUpdate(queryHash: string): Promise<void>;
|
|
430
|
+
private materializeRecords;
|
|
431
|
+
private processStreamUpdate;
|
|
432
|
+
/**
|
|
433
|
+
* Compute p55/p90/p99 from a rolling window of materialization samples.
|
|
434
|
+
* Returns nulls for any percentile that has no samples yet so SurrealDB
|
|
435
|
+
* `option<float>` columns stay NONE rather than 0 before the first ingest.
|
|
436
|
+
*/
|
|
437
|
+
private computeMaterializationPercentiles;
|
|
438
|
+
/** Record a per-phase timing sample (ms) on a query's rolling window. */
|
|
439
|
+
private recordPhase;
|
|
440
|
+
/** Record the remote record-fetch time (ms) for a query. Called by the sync engine. */
|
|
441
|
+
recordRemoteFetch(hash: string, ms: number): void;
|
|
442
|
+
/**
|
|
443
|
+
* Record the frontend reconcile time (ms) for a query. Called from `useQuery`
|
|
444
|
+
* via `Sp00kyClient.reportFrontendTiming` after it applies an update to its store.
|
|
445
|
+
*/
|
|
446
|
+
recordFrontendTiming(hash: string, ms: number): void;
|
|
447
|
+
/**
|
|
448
|
+
* Build the per-query processing-time breakdown surfaced to the DevTools panel
|
|
449
|
+
* and the MCP. `ssp` is the WASM-ingest wall time (from `materializationSamples`);
|
|
450
|
+
* the rest come from the per-phase rolling windows + one-shot registration timings.
|
|
451
|
+
*/
|
|
452
|
+
phaseTimings(q: QueryState): QueryTimings;
|
|
453
|
+
/**
|
|
454
|
+
* Get query state (for sync and devtools)
|
|
455
|
+
*/
|
|
456
|
+
getQueryByHash(hash: string): QueryState | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* Cold-query guard for instant-hydrate: true when the query exists, hasn't been
|
|
459
|
+
* hydrated, and has NOT yet fetched its server result (`remoteArray` empty).
|
|
460
|
+
* We gate on `remoteArray`, not local `records`: a windowed query is often
|
|
461
|
+
* partially pre-seeded from the circuit (e.g. the dashboard's 5-row preview),
|
|
462
|
+
* but it still hasn't loaded its own full window from the server — so it should
|
|
463
|
+
* still hydrate. A warm re-subscribe (remoteArray already populated) is skipped.
|
|
464
|
+
*/
|
|
465
|
+
isCold(hash: string): boolean;
|
|
466
|
+
/**
|
|
467
|
+
* Walk a hydrated record's fields and append any EMBEDDED child records to
|
|
468
|
+
* `batch` (recursing for nested related fields). An embedded child is a
|
|
469
|
+
* value that is itself a record — a non-null object whose `id` is a
|
|
470
|
+
* `RecordId` — or an array of such records (one-to-many vs one-to-one). A
|
|
471
|
+
* bare `RecordId` (a foreign-key reference) or any other value is skipped,
|
|
472
|
+
* so this never mistakes a FK column for an embedded body. Children are
|
|
473
|
+
* keyed by their own `record.id.table`, versioned by `_00_rv`, and cleaned
|
|
474
|
+
* to their table's real columns (which strips the alias/related fields).
|
|
475
|
+
* `seen` dedupes within the batch.
|
|
476
|
+
*/
|
|
477
|
+
private collectEmbeddedChildren;
|
|
478
|
+
/**
|
|
479
|
+
* Prepare a subquery-bearing row (preload / hydration) for the schemafull
|
|
480
|
+
* local store: replace an embedded FORWARD-relation object (`author = { id, … }`)
|
|
481
|
+
* with its RecordId so a `record<…>` field coerces, and DROP reverse-subquery
|
|
482
|
+
* ARRAYS (`comments = [ … ]`) since their rows are cached separately as their
|
|
483
|
+
* own bodies. A flat record — as the live `SELECT * FROM $ids` sync returns,
|
|
484
|
+
* with relations already RecordIds — passes through unchanged.
|
|
485
|
+
*/
|
|
486
|
+
private flattenRelationsForStorage;
|
|
487
|
+
/**
|
|
488
|
+
* Instant-hydrate: ingest rows fetched one-shot from the remote (the query's own
|
|
489
|
+
* surql run directly) so the query DISPLAYS immediately, while the full realtime
|
|
490
|
+
* registration proceeds in the background. Ingests with versions (`_00_rv`) so the
|
|
491
|
+
* later `syncRecords` dedup skips re-pulling unchanged bodies, and seeds
|
|
492
|
+
* `remoteArray` so windowed queries materialize the correct window (no sparse
|
|
493
|
+
* local-circuit issue). Runs at most once per query (the `hydrated` flag).
|
|
494
|
+
*/
|
|
495
|
+
applyHydration(hash: string, rows: RecordWithId[]): Promise<void>;
|
|
496
|
+
/**
|
|
497
|
+
* Build the cache batch for a set of one-shot rows and persist it to the
|
|
498
|
+
* local DB + in-browser SSP. Maps each row to a `CREATE` op on its own table
|
|
499
|
+
* and extracts EMBEDDED related children (any nesting depth) as their own
|
|
500
|
+
* records — a `.related()` query returns its children embedded, and a later
|
|
501
|
+
* correlated re-materialization needs them present as standalone rows.
|
|
502
|
+
* Shared by `applyHydration` (live registration) and `persistSnapshot`
|
|
503
|
+
* (preload).
|
|
504
|
+
*/
|
|
505
|
+
private buildAndSaveCacheBatch;
|
|
506
|
+
/**
|
|
507
|
+
* Preload/prewarm: persist one-shot rows (and their embedded related children)
|
|
508
|
+
* into the local cache WITHOUT registering a query — no `activeQueries` entry,
|
|
509
|
+
* no `_00_query` view, no TTL heartbeat. The rows live in the local DB as
|
|
510
|
+
* ordinary bodies (never GC'd on their own) so a later `useQuery` seeds its
|
|
511
|
+
* first paint from them instantly, then registers a live view to freshen.
|
|
512
|
+
*/
|
|
513
|
+
persistSnapshot(tableName: string, rows: RecordWithId[]): Promise<void>;
|
|
514
|
+
/**
|
|
515
|
+
* Read the durable preload freshness marker for a query hash, or null if this
|
|
516
|
+
* query was never preloaded in the current bucket. Co-located with the cached
|
|
517
|
+
* rows (per-bucket `_00_preload` table) so a bucket switch that clears the
|
|
518
|
+
* data also clears the marker — a stale marker can't claim "warm" when the
|
|
519
|
+
* rows are gone. Any read error is treated as cold.
|
|
520
|
+
*/
|
|
521
|
+
getPreloadMarker(hash: string): Promise<{
|
|
522
|
+
fetchedAt: number;
|
|
523
|
+
rowCount: number;
|
|
524
|
+
} | null>;
|
|
525
|
+
/**
|
|
526
|
+
* True when this query's preload marker exists and is younger than
|
|
527
|
+
* `maxAgeMs`. Used by instant-hydrate to skip its one-shot fetch for rows a
|
|
528
|
+
* recent `preload()` already persisted (the register lifecycle re-syncs them
|
|
529
|
+
* authoritatively). Missing or unreadable markers are treated as stale.
|
|
530
|
+
*/
|
|
531
|
+
isPreloadFresh(hashKey: string, maxAgeMs: number): Promise<boolean>;
|
|
532
|
+
/** Stamp the preload freshness marker after a successful snapshot fetch. */
|
|
533
|
+
writePreloadMarker(hash: string, rowCount: number): Promise<void>;
|
|
534
|
+
/** True while ≥1 live subscriber is watching this query (refcount guard). */
|
|
535
|
+
hasSubscribers(hash: string): boolean;
|
|
536
|
+
/**
|
|
537
|
+
* Opt-in eager teardown for a query whose LAST subscriber just left — used by
|
|
538
|
+
* viewport-windowed lists to cancel off-screen windows instead of leaving
|
|
539
|
+
* their remote views to expire on the TTL sweep. No-op while any subscriber
|
|
540
|
+
* remains (refcount). Only enqueues the remote cleanup here; the local WASM
|
|
541
|
+
* view + in-memory state are freed in {@link finalizeDeregister} after the
|
|
542
|
+
* remote delete completes, so a re-subscribe in between aborts/heals it.
|
|
543
|
+
*
|
|
544
|
+
* NOTE: most queries should NOT use this — the default keep-alive on
|
|
545
|
+
* unsubscribe avoids re-registration churn on navigation.
|
|
546
|
+
*/
|
|
547
|
+
deregisterQuery(hash: string): void;
|
|
548
|
+
/**
|
|
549
|
+
* Final local teardown after the remote `_00_query` row was deleted: free the
|
|
550
|
+
* WASM view, heartbeat timer, debounce timer, and in-memory state. Caller
|
|
551
|
+
* (`cleanupQuery`) guarantees no subscriber remains.
|
|
552
|
+
*/
|
|
553
|
+
finalizeDeregister(hash: string): void;
|
|
554
|
+
/**
|
|
555
|
+
* Get query state by id (for sync and devtools)
|
|
556
|
+
*/
|
|
557
|
+
getQueryById(id: RecordId<string>): QueryState | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* Get all active queries (for devtools)
|
|
560
|
+
*/
|
|
561
|
+
getActiveQueries(): QueryState[];
|
|
562
|
+
getActiveQueryHashes(): QueryHash[];
|
|
563
|
+
updateQueryLocalArray(id: string, localArray: RecordVersionArray): Promise<void>;
|
|
564
|
+
updateQueryRemoteArray(hash: string, remoteArray: RecordVersionArray): Promise<void>;
|
|
565
|
+
/**
|
|
566
|
+
* Cancel every armed timer ahead of a local-bucket switch: stream-update
|
|
567
|
+
* debounce timers (their pending updates carry the OLD bucket's id-sets) and
|
|
568
|
+
* per-query TTL heartbeats (they'd refresh the previous user's remote
|
|
569
|
+
* `_00_query` rows under the new session). The rebind re-arms heartbeats.
|
|
570
|
+
*/
|
|
571
|
+
quiesce(): void;
|
|
572
|
+
/**
|
|
573
|
+
* Re-home every active query in a freshly-opened bucket, KEEPING its hash —
|
|
574
|
+
* `useQuery` subscriptions are keyed by hash and don't re-register on auth
|
|
575
|
+
* changes, so the hooks must stay attached. Per query:
|
|
576
|
+
* 1. reset the sync arrays + hydration flag and drop the previous user's
|
|
577
|
+
* records, notifying subscribers with the new-bucket materialization
|
|
578
|
+
* (usually empty) so their rows leave the UI immediately;
|
|
579
|
+
* 2. recreate the `_00_query` row in the new bucket;
|
|
580
|
+
* 3. re-register the SSP view on the (fresh, post-reset) processor — this
|
|
581
|
+
* also rebinds the view to the NEW `$auth` context;
|
|
582
|
+
* 4. restart the TTL heartbeat.
|
|
583
|
+
* Returns the hashes so the caller can enqueue remote re-registration, which
|
|
584
|
+
* refills records from the server via the normal register→sync→notify path.
|
|
585
|
+
*/
|
|
586
|
+
rebindAfterBucketSwitch(): Promise<QueryHash[]>;
|
|
587
|
+
/**
|
|
588
|
+
* Called after a query's initial sync completes.
|
|
589
|
+
* Ensures subscribers are notified even if no stream updates fired (e.g. empty result set).
|
|
590
|
+
*/
|
|
591
|
+
notifyQuerySynced(queryHash: string): Promise<void>;
|
|
592
|
+
run<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(backend: B, path: R, data: RoutePayload<S, B, R>, options?: RunOptions): Promise<void>;
|
|
593
|
+
/**
|
|
594
|
+
* Build the outbox job record + resolve its table for a backend route. Shared
|
|
595
|
+
* by `run` (one-shot) and `runRecurring` (durable schedule).
|
|
596
|
+
*/
|
|
597
|
+
private buildJobRecord;
|
|
598
|
+
/**
|
|
599
|
+
* Deterministic id for the single recurring-schedule row of a given
|
|
600
|
+
* (assigned_to, path). One row per pair => calling `runRecurring` twice cannot
|
|
601
|
+
* fork a second schedule, and `poke`/`cancel` address the same row.
|
|
602
|
+
*/
|
|
603
|
+
private recurringJobId;
|
|
604
|
+
/**
|
|
605
|
+
* Register a RECURRING job: one durable row per (assigned_to, path) that
|
|
606
|
+
* re-runs every `options.interval` ms (measured from each run's completion).
|
|
607
|
+
* Idempotent: if the schedule already exists it is left untouched, so calling
|
|
608
|
+
* this on every connect/re-login never forks a second schedule. The first run
|
|
609
|
+
* fires immediately (`next_run_at = now`), then every interval thereafter.
|
|
610
|
+
*/
|
|
611
|
+
runRecurring<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(backend: B, path: R, data: RoutePayload<S, B, R>, options: RunOptions & {
|
|
612
|
+
interval: number;
|
|
613
|
+
assignedTo: string;
|
|
614
|
+
}): Promise<void>;
|
|
615
|
+
/**
|
|
616
|
+
* Manually trigger a recurring job NOW and reset its interval clock. Sets
|
|
617
|
+
* `next_run_at = now` on the schedule row; the SSP ingest picks up the update
|
|
618
|
+
* and dispatches an immediate run, after which the runner re-arms the clock
|
|
619
|
+
* from that run's completion. No-op if no schedule exists (caller should have
|
|
620
|
+
* created one via `runRecurring`).
|
|
621
|
+
*/
|
|
622
|
+
pokeRecurring<B extends BackendNames<S>>(backend: B, path: BackendRoutes<S, B>, options: {
|
|
623
|
+
assignedTo: string;
|
|
624
|
+
}): Promise<void>;
|
|
625
|
+
/**
|
|
626
|
+
* Cancel a recurring schedule: delete the single schedule row so it stops
|
|
627
|
+
* being dispatched server-side.
|
|
628
|
+
*/
|
|
629
|
+
cancelRecurring<B extends BackendNames<S>>(backend: B, path: BackendRoutes<S, B>, options: {
|
|
630
|
+
assignedTo: string;
|
|
631
|
+
}): Promise<void>;
|
|
632
|
+
/**
|
|
633
|
+
* Create a new record
|
|
634
|
+
*/
|
|
635
|
+
create<T extends Record<string, unknown>>(id: string, data: T): Promise<T>;
|
|
636
|
+
/**
|
|
637
|
+
* Update an existing record
|
|
638
|
+
*/
|
|
639
|
+
update<T extends Record<string, unknown>>(table: string, id: string, data: Partial<T>, options?: UpdateOptions): Promise<T>;
|
|
640
|
+
/**
|
|
641
|
+
* Delete a record
|
|
642
|
+
*/
|
|
643
|
+
delete(table: string, id: string): Promise<void>;
|
|
644
|
+
/**
|
|
645
|
+
* Rollback a failed optimistic create by deleting the record locally
|
|
646
|
+
*/
|
|
647
|
+
rollbackCreate(recordId: RecordId, tableName: string): Promise<void>;
|
|
648
|
+
/**
|
|
649
|
+
* Rollback a failed optimistic update by restoring the previous record state
|
|
650
|
+
*/
|
|
651
|
+
rollbackUpdate(recordId: RecordId, tableName: string, beforeRecord: Record<string, unknown>): Promise<void>;
|
|
652
|
+
/**
|
|
653
|
+
* Remove a record from all active query states and notify subscribers
|
|
654
|
+
*/
|
|
655
|
+
private removeRecordFromQueries;
|
|
656
|
+
private createAndRegisterQuery;
|
|
657
|
+
private createNewQuery;
|
|
658
|
+
private calculateHash;
|
|
659
|
+
private startTTLHeartbeat;
|
|
660
|
+
private replaceRecordInQueries;
|
|
466
661
|
}
|
|
467
662
|
/**
|
|
468
|
-
*
|
|
663
|
+
* Parse update options to generate push event options
|
|
469
664
|
*/
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
max_retries?: number;
|
|
473
|
-
retry_strategy?: 'linear' | 'exponential';
|
|
474
|
-
}
|
|
665
|
+
//#endregion
|
|
666
|
+
//#region src/modules/sync/sync.d.ts
|
|
475
667
|
/**
|
|
476
|
-
*
|
|
668
|
+
* Tunables for `Sp00kySync` construction.
|
|
477
669
|
*/
|
|
478
|
-
interface
|
|
670
|
+
interface Sp00kySyncOptions {
|
|
479
671
|
/**
|
|
480
|
-
*
|
|
481
|
-
*
|
|
672
|
+
* Cadence (ms) for the `_00_list_ref` poll fallback that catches
|
|
673
|
+
* cross-session UPDATEs the LIVE-permission gap drops. Non-positive
|
|
674
|
+
* values fall back to the default; see
|
|
675
|
+
* {@link resolveListRefPollInterval}.
|
|
482
676
|
*/
|
|
483
|
-
|
|
677
|
+
refSyncIntervalMs?: number;
|
|
678
|
+
/**
|
|
679
|
+
* Enable realtime sync for unauthenticated clients against the shared
|
|
680
|
+
* `_00_list_ref_anon` table. See {@link Sp00kyConfig.enableAnonymousLiveQueries}.
|
|
681
|
+
* Defaults to `false`.
|
|
682
|
+
*/
|
|
683
|
+
anonymousLiveQueries?: boolean;
|
|
684
|
+
/**
|
|
685
|
+
* Consecutive failed sync rounds before sync health flips to `degraded`.
|
|
686
|
+
* `0` disables degraded reporting. See {@link Sp00kyConfig.syncHealth}.
|
|
687
|
+
* Defaults to `3`.
|
|
688
|
+
*/
|
|
689
|
+
degradeAfterConsecutiveFailures?: number;
|
|
484
690
|
}
|
|
485
691
|
/**
|
|
486
|
-
*
|
|
692
|
+
* The main synchronization engine for Sp00ky.
|
|
693
|
+
* Handles the bidirectional synchronization between the local database and the remote backend.
|
|
694
|
+
* Uses a queue-based architecture with 'up' (local to remote) and 'down' (remote to local) queues.
|
|
695
|
+
* @template S The schema structure type.
|
|
487
696
|
*/
|
|
488
|
-
|
|
697
|
+
declare class Sp00kySync<S extends SchemaStructure> {
|
|
698
|
+
private local;
|
|
699
|
+
private remote;
|
|
700
|
+
private cache;
|
|
701
|
+
private dataModule;
|
|
702
|
+
private schema;
|
|
703
|
+
private upQueue;
|
|
704
|
+
private downQueue;
|
|
705
|
+
private isInit;
|
|
706
|
+
private logger;
|
|
707
|
+
private syncEngine;
|
|
708
|
+
/** Engine-level events (e.g. `SYNC_REMOTE_DATA_INGESTED`). Distinct
|
|
709
|
+
* from `this.events`, which carries Sp00kySync-level events like
|
|
710
|
+
* `SYNC_QUERY_UPDATED` and `SYNC_MUTATION_ROLLED_BACK`. */
|
|
711
|
+
get engineEvents(): SyncEventSystem;
|
|
712
|
+
private scheduler;
|
|
713
|
+
private wasDisconnected;
|
|
714
|
+
events: SyncEventSystem;
|
|
715
|
+
private currentUserId;
|
|
716
|
+
private refMode;
|
|
717
|
+
private readonly anonLiveEnabled;
|
|
718
|
+
private currentLiveQueryUuid;
|
|
719
|
+
private liveQueryUnsubscribe;
|
|
720
|
+
private listRefPollTimer;
|
|
721
|
+
private listRefPollRunning;
|
|
722
|
+
private listRefPollInFlight;
|
|
723
|
+
readonly refSyncIntervalMs: number;
|
|
724
|
+
private listRefIdleStreak;
|
|
725
|
+
private stillRemoteStreaks;
|
|
726
|
+
private lastLiveEventAt;
|
|
727
|
+
private _liveRetryCount;
|
|
728
|
+
get liveRetryCount(): number;
|
|
729
|
+
get isSyncing(): boolean;
|
|
730
|
+
get pendingMutationCount(): number;
|
|
731
|
+
subscribeToPendingMutations(cb: (count: number) => void): () => void;
|
|
732
|
+
private readonly degradeAfterFailures;
|
|
733
|
+
private consecutiveSyncFailures;
|
|
734
|
+
private syncHealthStatus;
|
|
735
|
+
private lastSyncErrorKind;
|
|
736
|
+
private lastSyncErrorMessage;
|
|
737
|
+
private hasSyncedOnce;
|
|
738
|
+
private selfHealTimer;
|
|
739
|
+
private selfHealAttempts;
|
|
740
|
+
private static readonly SELF_HEAL_BASE_MS;
|
|
741
|
+
private static readonly SELF_HEAL_MAX_MS;
|
|
742
|
+
/** Current sync-health snapshot. */
|
|
743
|
+
get syncHealth(): SyncHealth;
|
|
744
|
+
/**
|
|
745
|
+
* Observe sync health. The callback fires immediately with the current
|
|
746
|
+
* status and again on every healthy↔degraded transition. Returns an
|
|
747
|
+
* unsubscribe. Mirrors {@link subscribeToPendingMutations}.
|
|
748
|
+
*/
|
|
749
|
+
subscribeToSyncHealth(cb: (health: SyncHealth) => void): () => void;
|
|
750
|
+
private emitSyncHealth;
|
|
489
751
|
/**
|
|
490
|
-
*
|
|
491
|
-
*
|
|
492
|
-
*
|
|
752
|
+
* Fed by the scheduler once per drained sync round. Individual failures are
|
|
753
|
+
* absorbed by the queue's retry; only a run of `degradeAfterFailures`
|
|
754
|
+
* consecutive failures flips the status to `degraded`, and the next clean
|
|
755
|
+
* round flips it back. No-op when reporting is disabled (`degradeAfterFailures`
|
|
756
|
+
* is 0).
|
|
493
757
|
*/
|
|
494
|
-
|
|
495
|
-
/**
|
|
496
|
-
|
|
758
|
+
private recordSyncOutcome;
|
|
759
|
+
/**
|
|
760
|
+
* Begin self-heal retries (no-op if already running). Started on the
|
|
761
|
+
* healthy→degraded transition; {@link recordSyncOutcome} stops it on recovery.
|
|
762
|
+
*/
|
|
763
|
+
private startSelfHeal;
|
|
764
|
+
private scheduleSelfHeal;
|
|
765
|
+
private stopSelfHeal;
|
|
766
|
+
constructor(local: LocalStore, remote: RemoteDatabaseService, cache: CacheModule, dataModule: DataModule<S>, schema: S, logger: Logger$1, options?: Sp00kySyncOptions);
|
|
767
|
+
/**
|
|
768
|
+
* Initializes the synchronization system.
|
|
769
|
+
* Starts the scheduler and initiates the initial sync cycles.
|
|
770
|
+
* @throws Error if already initialized.
|
|
771
|
+
*/
|
|
772
|
+
init(): Promise<void>;
|
|
773
|
+
/**
|
|
774
|
+
* Quiesce all sync activity ahead of a local-bucket switch. After this
|
|
775
|
+
* resolves, nothing in the sync module writes to the local store: the poll
|
|
776
|
+
* loop is stopped AND its in-flight tick awaited, LIVE is killed, debounce
|
|
777
|
+
* timers are cancelled (their outbox rows are already persisted), and the
|
|
778
|
+
* scheduler has drained its in-flight queue item — including that item's
|
|
779
|
+
* outbox-row delete, which must land in the OLD bucket. Queued down-events
|
|
780
|
+
* are dropped (they reference old-bucket query rows; the post-switch rebind
|
|
781
|
+
* re-enqueues registrations). The old user's un-pushed outbox is deliberately
|
|
782
|
+
* NOT drained: the remote session already belongs to the next user.
|
|
783
|
+
*/
|
|
784
|
+
prepareBucketSwitch(): Promise<void>;
|
|
785
|
+
/**
|
|
786
|
+
* Resume syncing against the freshly-opened bucket: reload the mutation
|
|
787
|
+
* outbox from ITS `_00_pending_mutations` (the new user's own un-pushed
|
|
788
|
+
* offline work) and restart the scheduler. LIVE + the list_ref poll restart
|
|
789
|
+
* via the `setCurrentUserId` call that follows in the auth listener.
|
|
790
|
+
*/
|
|
791
|
+
completeBucketSwitch(): Promise<void>;
|
|
792
|
+
/**
|
|
793
|
+
* Push the authenticated user's record id from the parent client's
|
|
794
|
+
* auth subscription. Tears down the existing `_00_list_ref` LIVE (if
|
|
795
|
+
* any) and re-registers it under the new user's dedicated table so
|
|
796
|
+
* SurrealDB binds the permission rule under the post-flip auth
|
|
797
|
+
* context. Pass `null` on sign-out.
|
|
798
|
+
*
|
|
799
|
+
* The dedicated `_00_list_ref_user_<id>` table is created lazily by
|
|
800
|
+
* the SSP when the first query registration arrives, which may be
|
|
801
|
+
* concurrent with this call. We retry the LIVE registration with a
|
|
802
|
+
* short backoff so a "table not found" race resolves without
|
|
803
|
+
* surfacing as a permanent auth-loading hang.
|
|
804
|
+
*/
|
|
805
|
+
setCurrentUserId(userId: string | null): Promise<void>;
|
|
806
|
+
private startListRefPoll;
|
|
807
|
+
private stopListRefPoll;
|
|
808
|
+
/**
|
|
809
|
+
* One poll cycle: refetch `_00_list_ref` for every active query. Returns
|
|
810
|
+
* whether ANY query's remoteArray actually changed — the scheduler uses this
|
|
811
|
+
* to drive the adaptive idle backoff.
|
|
812
|
+
*
|
|
813
|
+
* Also the ONLY health signal that runs while the page is idle. Sync health is
|
|
814
|
+
* otherwise activity-driven (mutations/registrations via the scheduler,
|
|
815
|
+
* reconnect re-registration, self-heal), so on a quiet page a stale `degraded`
|
|
816
|
+
* would linger until the next mutation and a genuine idle drop would be
|
|
817
|
+
* invisible. We fold the cycle's aggregate reachability into `recordSyncOutcome`
|
|
818
|
+
* so idle health self-recovers (and self-degrades) with no user action. A clean
|
|
819
|
+
* cycle is idempotent when already healthy (`recordSyncOutcome` early-returns at
|
|
820
|
+
* `consecutiveSyncFailures === 0`), so a healthy idle page pays nothing.
|
|
821
|
+
*/
|
|
822
|
+
private pollListRefForActiveQueries;
|
|
823
|
+
/**
|
|
824
|
+
* Pull the upstream list_ref entries for `queryHash`, diff them
|
|
825
|
+
* against the local `remoteArray` cache, sync any added/updated rows
|
|
826
|
+
* through the SyncEngine, then persist the new remoteArray. This is
|
|
827
|
+
* the same shape `createRemoteQuery` does for its initial fetch and
|
|
828
|
+
* what `handleRemoteListRefChange` does per-LIVE-event — we reuse
|
|
829
|
+
* it on a timer as a fallback for missed LIVE notifications.
|
|
830
|
+
*/
|
|
831
|
+
private refetchListRefForQuery;
|
|
832
|
+
/**
|
|
833
|
+
* Resolve the current `_00_list_ref` table name for the active auth
|
|
834
|
+
* context. Public so the `createRemoteQuery` initial-fetch path can
|
|
835
|
+
* read from the right per-user table.
|
|
836
|
+
*
|
|
837
|
+
* Reads the user id from `DataModule` rather than the local mirror,
|
|
838
|
+
* because `DataModule.setCurrentUserId` runs synchronously from the
|
|
839
|
+
* auth callback (before any `await`), whereas `sync.setCurrentUserId`
|
|
840
|
+
* is async — the userQuery's initial fetch can fire between those
|
|
841
|
+
* two points and we need the correct table name immediately.
|
|
842
|
+
*/
|
|
843
|
+
listRefTable(): string;
|
|
844
|
+
private killRefLiveQuery;
|
|
845
|
+
private restartRefLiveQuery;
|
|
846
|
+
private subscribeToReconnect;
|
|
847
|
+
private startRefLiveQueries;
|
|
848
|
+
private handleRemoteListRefChange;
|
|
849
|
+
/**
|
|
850
|
+
* Handle a LIVE change to a SUBQUERY child edge (a `_00_list_ref` row with
|
|
851
|
+
* `parent` set) for a `.related()` query. Unlike primary rows, child rows
|
|
852
|
+
* must NOT touch the query's `localArray`/`remoteArray`/`rowCount`; we only
|
|
853
|
+
* keep the child BODY fresh in the local cache so the in-browser SSP's
|
|
854
|
+
* subquery-table dependency re-materializes the parent view.
|
|
855
|
+
*
|
|
856
|
+
* CREATE/UPDATE fetch+upsert the child body. DELETE is intentionally a
|
|
857
|
+
* no-op: a child leaving this query's set must not delete a body another
|
|
858
|
+
* query may still show (see `syncSubqueryChildren` deletion-safety note);
|
|
859
|
+
* a genuine record delete propagates via the normal delete path.
|
|
860
|
+
*/
|
|
861
|
+
private handleRemoteSubqueryChange;
|
|
862
|
+
/**
|
|
863
|
+
* Enqueues a 'down' event (from remote to local) for processing.
|
|
864
|
+
* @param event The DownEvent to enqueue.
|
|
865
|
+
*/
|
|
866
|
+
enqueueDownEvent(event: DownEvent): void;
|
|
867
|
+
private processUpEvent;
|
|
868
|
+
private handleRollback;
|
|
869
|
+
private processDownEvent;
|
|
870
|
+
/**
|
|
871
|
+
* Synchronizes a specific query by hash.
|
|
872
|
+
* Compares local and remote version arrays and fetches differences.
|
|
873
|
+
* @param hash The hash of the query to sync.
|
|
874
|
+
*/
|
|
875
|
+
syncQuery(hash: string): Promise<void>;
|
|
876
|
+
/**
|
|
877
|
+
* Run a sync for a single query while reflecting its fetch status. Marks the
|
|
878
|
+
* query `fetching` for the duration when the diff actually pulls records
|
|
879
|
+
* (added/updated), then resets to `idle` in a `finally` so a failed sync
|
|
880
|
+
* never leaves a query stuck `fetching`. Part A's notification coalescing
|
|
881
|
+
* means the single resulting UI update lands after this completes.
|
|
882
|
+
*/
|
|
883
|
+
private runSyncForQuery;
|
|
884
|
+
/**
|
|
885
|
+
* Record ids with a pending local DELETE in the outbox (`_00_pending_mutations`).
|
|
886
|
+
* Sync must not re-fetch/re-insert these — the remote delete is async, so the
|
|
887
|
+
* server's `_00_list_ref` still lists them until it's processed, and the diff
|
|
888
|
+
* would otherwise resurrect a just-deleted record.
|
|
889
|
+
*/
|
|
890
|
+
private getPendingDeleteIds;
|
|
891
|
+
/**
|
|
892
|
+
* Enqueues a list of mutations (up events) to be sent to the remote.
|
|
893
|
+
* @param mutations Array of UpEvents (create/update/delete) to enqueue.
|
|
894
|
+
*/
|
|
895
|
+
enqueueMutation(mutations: UpEvent[]): Promise<void>;
|
|
896
|
+
private registerQuery;
|
|
897
|
+
private createRemoteQuery;
|
|
898
|
+
/**
|
|
899
|
+
* Sync the BODIES of a `.related()` query's subquery child rows into the
|
|
900
|
+
* local cache, separately from the primary window array. The SSP writes
|
|
901
|
+
* each matched child as a `_00_list_ref` edge tagged `parent`/`parent_rel`;
|
|
902
|
+
* `buildSubqueryListRefSelect` pulls those `out`+`version` pairs (any
|
|
903
|
+
* nesting depth). We diff against the in-memory `subqueryRemoteArray` and
|
|
904
|
+
* fetch added/updated bodies through the SyncEngine — which `saveBatch`s
|
|
905
|
+
* them into the local DB AND the in-browser SSP, whose subquery-table
|
|
906
|
+
* dependency then re-materializes the parent view (no explicit notify).
|
|
907
|
+
*
|
|
908
|
+
* Deletion safety: we pass `removed: []` deliberately. A child body can be
|
|
909
|
+
* shared by other queries; letting `handleRemovedRecords` delete one that
|
|
910
|
+
* merely left THIS query's child set would clobber data another query still
|
|
911
|
+
* shows. Genuine record deletes flow through the normal delete path; a
|
|
912
|
+
* lingering orphan body is invisible (the correlated WHERE stops matching).
|
|
913
|
+
*
|
|
914
|
+
* Kept off `runSyncForQuery` on purpose so child fetches never flip the
|
|
915
|
+
* query to `fetching` or skew its DevTools timings.
|
|
916
|
+
*/
|
|
917
|
+
private syncSubqueryChildren;
|
|
918
|
+
heartbeatQuery(queryHash: string): Promise<void>;
|
|
919
|
+
private cleanupQuery;
|
|
497
920
|
}
|
|
498
921
|
//#endregion
|
|
499
922
|
//#region src/modules/auth/events/index.d.ts
|
|
@@ -518,6 +941,13 @@ declare class AuthService<S extends SchemaStructure> {
|
|
|
518
941
|
token: string | null;
|
|
519
942
|
currentUser: any | null;
|
|
520
943
|
isAuthenticated: boolean;
|
|
944
|
+
/**
|
|
945
|
+
* The record-access method name for the current session (e.g. `"account"`),
|
|
946
|
+
* derived from the token's `AC` claim. Consumed by the in-browser SSP's
|
|
947
|
+
* permission injection so `$access`-gated table predicates resolve locally,
|
|
948
|
+
* mirroring the server's `$access`. Null when logged out.
|
|
949
|
+
*/
|
|
950
|
+
access: string | null;
|
|
521
951
|
isLoading: boolean;
|
|
522
952
|
private events;
|
|
523
953
|
get eventSystem(): AuthEventSystem;
|
|
@@ -539,11 +969,231 @@ declare class AuthService<S extends SchemaStructure> {
|
|
|
539
969
|
*/
|
|
540
970
|
signOut(): Promise<void>;
|
|
541
971
|
private setSession;
|
|
972
|
+
/** Fallback when the token carries no `AC` claim: if the schema defines
|
|
973
|
+
* exactly one record-access method, assume the session used it. */
|
|
974
|
+
private defaultAccessName;
|
|
542
975
|
signUp<Name extends keyof S['access'] & string>(accessName: Name, params: ExtractAccessParams<S, Name, 'signup'>): Promise<void>;
|
|
543
976
|
signIn<Name extends keyof S['access'] & string>(accessName: Name, params: ExtractAccessParams<S, Name, 'signIn'>): Promise<void>;
|
|
544
977
|
}
|
|
545
978
|
//#endregion
|
|
546
|
-
//#region src/
|
|
979
|
+
//#region src/modules/crdt/crdt-field.d.ts
|
|
980
|
+
declare const CURSOR_COLORS: string[];
|
|
981
|
+
declare function cursorColorFromName(name: string): string;
|
|
982
|
+
declare class CrdtField {
|
|
983
|
+
private fieldName;
|
|
984
|
+
private doc;
|
|
985
|
+
private pushTimer;
|
|
986
|
+
private local;
|
|
987
|
+
private remote;
|
|
988
|
+
private recordId;
|
|
989
|
+
private sessionId;
|
|
990
|
+
private unsubscribe;
|
|
991
|
+
private lastPushTime;
|
|
992
|
+
private lastCursorPushTime;
|
|
993
|
+
private loadedFromCrdt;
|
|
994
|
+
private pushRetryCount;
|
|
995
|
+
private logger;
|
|
996
|
+
private cursorsEnabled;
|
|
997
|
+
/** Remote-push debounce. Local writes happen immediately on every Loro
|
|
998
|
+
* update; the remote UPSERT is coalesced over this window. Configured
|
|
999
|
+
* via `Sp00kyConfig.crdtDebounceMs`, default 500. */
|
|
1000
|
+
private remoteDebounceMs;
|
|
1001
|
+
private _onCursorUpdate;
|
|
1002
|
+
private pendingCursorUpdate;
|
|
1003
|
+
/** Callback set by the editor to receive remote cursor updates.
|
|
1004
|
+
* Any cursor data that arrived before this callback was set will be replayed. */
|
|
1005
|
+
set onCursorUpdate(cb: ((data: Uint8Array) => void) | null);
|
|
1006
|
+
get onCursorUpdate(): ((data: Uint8Array) => void) | null;
|
|
1007
|
+
constructor(fieldName: string, cursorsEnabled: boolean, initialState?: Uint8Array, logger?: Logger$1 | null);
|
|
1008
|
+
getDoc(): LoroDoc;
|
|
1009
|
+
/** Whether the LoroDoc was loaded from saved CRDT state */
|
|
1010
|
+
hasContent(): boolean;
|
|
1011
|
+
startSync(local: LocalStore, remote: RemoteDatabaseService, recordId: string, sessionId: string, debounceMs: number): void;
|
|
1012
|
+
/**
|
|
1013
|
+
* Stop syncing this field. Flushes one final remote push by default so the
|
|
1014
|
+
* last keystrokes aren't lost. Pass `{ flush: false }` on a bucket switch —
|
|
1015
|
+
* the remote session already belongs to the NEXT user, and pushing this
|
|
1016
|
+
* (previous user's) snapshot under it would clobber the record remotely.
|
|
1017
|
+
*/
|
|
1018
|
+
stopSync(options?: {
|
|
1019
|
+
flush?: boolean;
|
|
1020
|
+
}): void;
|
|
1021
|
+
importRemote(state: Uint8Array): void;
|
|
1022
|
+
exportSnapshot(): Uint8Array;
|
|
1023
|
+
/** Push this session's cursor blob into the parent row at
|
|
1024
|
+
* `<field>.cursors[$sid]`. No-op when cursors aren't enabled on this
|
|
1025
|
+
* field — the editor still calls this method optimistically, but
|
|
1026
|
+
* without `@cursor` on the schema there's nowhere to store the blob.
|
|
1027
|
+
* The UPDATE itself fires the parent table's LIVE feed, so other
|
|
1028
|
+
* browsers receive the cursor change without a separate `_00_rv` bump. */
|
|
1029
|
+
pushCursorState(encoded: Uint8Array): Promise<void>;
|
|
1030
|
+
/** Import remote cursor state (called by CrdtManager from LIVE SELECT) */
|
|
1031
|
+
importRemoteCursor(base64State: string): void;
|
|
1032
|
+
private scheduleRemotePush;
|
|
1033
|
+
/** SET path inside a parent row for the current snapshot. `@crdt`-only
|
|
1034
|
+
* fields hold the snapshot directly (`<field>`); `@crdt @cursor`
|
|
1035
|
+
* fields hold a `{ state, cursors }` object so the snapshot lives at
|
|
1036
|
+
* `<field>.state` next to per-session cursor blobs. */
|
|
1037
|
+
private statePath;
|
|
1038
|
+
/** Mirror the LoroDoc snapshot into the parent row locally. Runs on
|
|
1039
|
+
* every local update and every remote import so reloads (online or
|
|
1040
|
+
* offline) see the freshest content immediately. Failures are
|
|
1041
|
+
* swallowed — a stale local write must never block user input. */
|
|
1042
|
+
private persistLocal;
|
|
1043
|
+
private pushToRemote;
|
|
1044
|
+
}
|
|
1045
|
+
//#endregion
|
|
1046
|
+
//#region src/modules/crdt/index.d.ts
|
|
1047
|
+
/**
|
|
1048
|
+
* CrdtManager manages active CrdtField instances and their sync channels.
|
|
1049
|
+
*
|
|
1050
|
+
* Collaborative state lives in two dedicated tables (defined in
|
|
1051
|
+
* `apps/cli/src/meta_tables_remote.surql`):
|
|
1052
|
+
* - `_00_crdt` { record_id, field, state } — one row per (record, field)
|
|
1053
|
+
* - `_00_cursor` { record_id, session_id, field, state } — one row per
|
|
1054
|
+
* (record, session, field)
|
|
1055
|
+
*
|
|
1056
|
+
* Splitting them off the parent row is what makes offline edits mergeable:
|
|
1057
|
+
* each (record, field) gets its own row, so concurrent offline writes don't
|
|
1058
|
+
* collide on the parent's last-write-wins semantics.
|
|
1059
|
+
*
|
|
1060
|
+
* Cross-browser delivery still rides the parent table's existing LIVE feed
|
|
1061
|
+
* to avoid SurrealDB v3 LIVE bugs around dereference-based permission rules
|
|
1062
|
+
* (issues 3602, 4026). On every meta UPSERT the writer also bumps the
|
|
1063
|
+
* parent's `_00_rv` (a no-op assignment); that fires the parent's LIVE
|
|
1064
|
+
* feed, and the receiver pulls the matching `_00_crdt` / `_00_cursor` rows
|
|
1065
|
+
* via subquery. Permission inheritance happens server-side via
|
|
1066
|
+
* `record_id.id != NONE` (SELECT) and `fn::can_update_record` (UPDATE).
|
|
1067
|
+
*/
|
|
1068
|
+
declare class CrdtManager {
|
|
1069
|
+
private schema;
|
|
1070
|
+
private local;
|
|
1071
|
+
private remote;
|
|
1072
|
+
private debounceMs;
|
|
1073
|
+
private fields;
|
|
1074
|
+
private liveByTable;
|
|
1075
|
+
private pendingLive;
|
|
1076
|
+
private logger;
|
|
1077
|
+
private sessionId;
|
|
1078
|
+
constructor(schema: SchemaStructure, local: LocalStore, remote: RemoteDatabaseService, logger: Logger$1, debounceMs?: number);
|
|
1079
|
+
/** Set the session id that scopes this client's cursor entries. Must be
|
|
1080
|
+
* called before `open()` for cursors to be pushed under a stable key.
|
|
1081
|
+
* Passed in from `sp00ky.ts` at boot (it already fetches `session::id()`
|
|
1082
|
+
* for the data-module salt). */
|
|
1083
|
+
setSessionId(sessionId: string): void;
|
|
1084
|
+
/**
|
|
1085
|
+
* Open a CRDT field for collaborative editing.
|
|
1086
|
+
*
|
|
1087
|
+
* @param table - Table name
|
|
1088
|
+
* @param recordId - Full record ID (e.g., "thread:abc")
|
|
1089
|
+
* @param field - Field name (e.g., "title", "content")
|
|
1090
|
+
* @param fallbackText - Current plain text from the record, used to seed the
|
|
1091
|
+
* LoroDoc if no CRDT state exists yet (migration path)
|
|
1092
|
+
*/
|
|
1093
|
+
open(table: string, recordId: string, field: string, fallbackText?: string): Promise<CrdtField>;
|
|
1094
|
+
close(table: string, recordId: string, field: string): void;
|
|
1095
|
+
/**
|
|
1096
|
+
* Close every open field + table LIVE. Fields flush a final remote push by
|
|
1097
|
+
* default; pass `{ flush: false }` on a bucket switch, where that flush
|
|
1098
|
+
* would push the previous user's snapshot under the next user's session.
|
|
1099
|
+
*/
|
|
1100
|
+
closeAll(options?: {
|
|
1101
|
+
flush?: boolean;
|
|
1102
|
+
}): void;
|
|
1103
|
+
/** Ensure a single `LIVE SELECT * FROM <table>` is running, shared across
|
|
1104
|
+
* every open CrdtField on `table`. */
|
|
1105
|
+
private ensureTableSubscription;
|
|
1106
|
+
/** Apply a parent-row payload from a non-LIVE source (e.g. the
|
|
1107
|
+
* list_ref-driven sync engine, when the cross-user LIVE on the
|
|
1108
|
+
* parent table is filtered out by the SurrealDB cross-session
|
|
1109
|
+
* permission gap). Same semantics as the internal `dispatchRow`. */
|
|
1110
|
+
applyRow(table: string, row: Record<string, unknown>): void;
|
|
1111
|
+
/** Dispatch a parent-row LIVE event to every open CrdtField on that
|
|
1112
|
+
* record. Each open field reads its slice of the row directly — the
|
|
1113
|
+
* CRDT snapshot is a column on the parent now, so there is no
|
|
1114
|
+
* follow-up subquery. */
|
|
1115
|
+
private dispatchRow;
|
|
1116
|
+
/** One-shot remote fetch for a row whose CRDT field hasn't synced
|
|
1117
|
+
* locally yet (fresh device, memory-backed local DB after reload, …).
|
|
1118
|
+
* Used by `open()` when the local read came up empty. Subsequent
|
|
1119
|
+
* cross-browser updates ride `dispatchRow` via the parent LIVE feed. */
|
|
1120
|
+
private fetchAndDispatchRow;
|
|
1121
|
+
/** Schema lookup: does `<table>.<field>` carry a `@cursor` annotation?
|
|
1122
|
+
* Determines the on-disk shape (plain snapshot vs. `{ state, cursors }`). */
|
|
1123
|
+
private fieldHasCursor;
|
|
1124
|
+
/** Pull the LoroDoc snapshot bytes out of a row slice. For `@crdt`-only
|
|
1125
|
+
* the slice IS the snapshot (Uint8Array); for `@crdt @cursor` it's
|
|
1126
|
+
* `{ state, cursors }` where `state` carries the snapshot bytes. */
|
|
1127
|
+
private extractSnapshot;
|
|
1128
|
+
private killTableSubscription;
|
|
1129
|
+
private makeKey;
|
|
1130
|
+
/**
|
|
1131
|
+
* Throws if `<table>.<field>` is not annotated `@crdt` in the schema. Catches
|
|
1132
|
+
* typos, removed annotations, and stale schema codegen at the call site instead
|
|
1133
|
+
* of silently producing a non-CRDT writer.
|
|
1134
|
+
*/
|
|
1135
|
+
private assertCrdtField;
|
|
1136
|
+
}
|
|
1137
|
+
//#endregion
|
|
1138
|
+
//#region src/modules/feature-flag/index.d.ts
|
|
1139
|
+
interface FeatureFlagSnapshot {
|
|
1140
|
+
variant: string | undefined;
|
|
1141
|
+
payload: unknown | undefined;
|
|
1142
|
+
}
|
|
1143
|
+
interface FeatureFlagOptions {
|
|
1144
|
+
fallback?: string;
|
|
1145
|
+
ttl?: QueryTimeToLive;
|
|
1146
|
+
}
|
|
1147
|
+
declare class FeatureFlagHandle {
|
|
1148
|
+
readonly key: string;
|
|
1149
|
+
readonly fallback: string | undefined;
|
|
1150
|
+
private latest;
|
|
1151
|
+
private listeners;
|
|
1152
|
+
private unsubscribeFn;
|
|
1153
|
+
private onCloseFn;
|
|
1154
|
+
private closed;
|
|
1155
|
+
constructor(key: string, fallback: string | undefined);
|
|
1156
|
+
attach(unsubscribe: () => void): void;
|
|
1157
|
+
detach(): void;
|
|
1158
|
+
set(snapshot: FeatureFlagSnapshot): void;
|
|
1159
|
+
variant(): string | undefined;
|
|
1160
|
+
payload<T = unknown>(): T | undefined;
|
|
1161
|
+
enabled(): boolean;
|
|
1162
|
+
subscribe(cb: (s: FeatureFlagSnapshot) => void): () => void;
|
|
1163
|
+
onClose(cb: () => void): void;
|
|
1164
|
+
close(): void;
|
|
1165
|
+
}
|
|
1166
|
+
interface FeatureFlagModuleDeps<S extends SchemaStructure> {
|
|
1167
|
+
dataModule: DataModule<S>;
|
|
1168
|
+
sync: Sp00kySync<S>;
|
|
1169
|
+
auth: AuthService<S>;
|
|
1170
|
+
logger: Logger$1;
|
|
1171
|
+
}
|
|
1172
|
+
declare class FeatureFlagModule<S extends SchemaStructure> {
|
|
1173
|
+
private deps;
|
|
1174
|
+
private logger;
|
|
1175
|
+
private handles;
|
|
1176
|
+
private authUnsubscribe;
|
|
1177
|
+
private lastUserId;
|
|
1178
|
+
private querySubscription;
|
|
1179
|
+
private starting;
|
|
1180
|
+
private ttl;
|
|
1181
|
+
private snapshots;
|
|
1182
|
+
private loaded;
|
|
1183
|
+
constructor(deps: FeatureFlagModuleDeps<S>);
|
|
1184
|
+
init(): void;
|
|
1185
|
+
feature(key: string, options?: FeatureFlagOptions): FeatureFlagHandle;
|
|
1186
|
+
closeAll(): Promise<void>;
|
|
1187
|
+
/** Auth changed: drop the old user's query/snapshots and re-observe. */
|
|
1188
|
+
private refresh;
|
|
1189
|
+
private teardownQuery;
|
|
1190
|
+
/** Start the single shared live query (idempotent; no-op with no handles). */
|
|
1191
|
+
private ensureStarted;
|
|
1192
|
+
/** Live query result → per-key snapshots → push to every active handle. */
|
|
1193
|
+
private applyRecords;
|
|
1194
|
+
}
|
|
1195
|
+
//#endregion
|
|
1196
|
+
//#region src/sp00ky.d.ts
|
|
547
1197
|
declare class BucketHandle {
|
|
548
1198
|
private bucketName;
|
|
549
1199
|
private remote;
|
|
@@ -557,7 +1207,7 @@ declare class BucketHandle {
|
|
|
557
1207
|
rename(sourcePath: string, targetPath: string): Promise<void>;
|
|
558
1208
|
list(prefix?: string): Promise<string[]>;
|
|
559
1209
|
}
|
|
560
|
-
declare class
|
|
1210
|
+
declare class Sp00kyClient<S extends SchemaStructure> {
|
|
561
1211
|
private config;
|
|
562
1212
|
private local;
|
|
563
1213
|
private remote;
|
|
@@ -567,29 +1217,168 @@ declare class SpookyClient<S extends SchemaStructure> {
|
|
|
567
1217
|
private dataModule;
|
|
568
1218
|
private sync;
|
|
569
1219
|
private devTools;
|
|
1220
|
+
private crdtManager;
|
|
1221
|
+
private featureFlags;
|
|
1222
|
+
private preloadedHashes;
|
|
1223
|
+
private pendingQueryInits;
|
|
570
1224
|
private logger;
|
|
571
1225
|
auth: AuthService<S>;
|
|
572
1226
|
streamProcessor: StreamProcessorService;
|
|
573
|
-
get remoteClient(): Surreal;
|
|
574
|
-
get localClient():
|
|
1227
|
+
get remoteClient(): surrealdb0.Surreal;
|
|
1228
|
+
get localClient(): unknown;
|
|
575
1229
|
get pendingMutationCount(): number;
|
|
1230
|
+
/** Number of times the initial list_ref LIVE subscription retried on
|
|
1231
|
+
* the most recent `setCurrentUserId` call. 0 when the SSP's
|
|
1232
|
+
* pre-emptive user-table creation got there first; >0 when LIVE
|
|
1233
|
+
* registration hit a "table not found" race. Exposed so the e2e
|
|
1234
|
+
* suite can guard the pre-emptive path against regression. */
|
|
1235
|
+
get liveRetryCount(): number;
|
|
576
1236
|
subscribeToPendingMutations(cb: (count: number) => void): () => void;
|
|
577
|
-
|
|
1237
|
+
/** Current sync-health snapshot. See {@link Sp00kyConfig.syncHealth}. */
|
|
1238
|
+
get syncHealth(): SyncHealth;
|
|
1239
|
+
/**
|
|
1240
|
+
* Observe sync health. Fires immediately with the current status and again
|
|
1241
|
+
* on every healthy↔degraded transition. Returns an unsubscribe.
|
|
1242
|
+
*/
|
|
1243
|
+
subscribeToSyncHealth(cb: (health: SyncHealth) => void): () => void;
|
|
1244
|
+
constructor(config: Sp00kyConfig<S>);
|
|
578
1245
|
/**
|
|
579
1246
|
* Setup direct callbacks instead of event subscriptions
|
|
580
1247
|
*/
|
|
581
1248
|
private setupCallbacks;
|
|
582
1249
|
init(): Promise<void>;
|
|
1250
|
+
private bucketSwitchChain;
|
|
1251
|
+
private pendingBucketTarget;
|
|
1252
|
+
/**
|
|
1253
|
+
* Ensure the local store is this user's bucket, switching if needed. Called
|
|
1254
|
+
* from the auth listener on every auth flip; concurrent calls are chained
|
|
1255
|
+
* and superseded intermediates are skipped (latest target wins).
|
|
1256
|
+
*/
|
|
1257
|
+
private ensureLocalBucket;
|
|
1258
|
+
/**
|
|
1259
|
+
* The bucket-switch choreography: drain → swap → rebind.
|
|
1260
|
+
*
|
|
1261
|
+
* Drain: sync quiesced (poll/LIVE stopped, in-flight round awaited so its
|
|
1262
|
+
* outbox delete lands in the OLD bucket, debounce timers cancelled),
|
|
1263
|
+
* DataModule timers cleared, CRDT fields closed WITHOUT their final flush
|
|
1264
|
+
* (the remote session already belongs to the next user).
|
|
1265
|
+
*
|
|
1266
|
+
* Swap: gate closes so any local query issued mid-switch (sibling auth
|
|
1267
|
+
* subscribers, FeatureFlagModule) waits and then runs against the NEW
|
|
1268
|
+
* bucket; store swaps open-new-before-close-old; schema provisions
|
|
1269
|
+
* (no-op for a returning bucket); stale `_00_query` rows are wiped (dead
|
|
1270
|
+
* sessionId-salted hashes with stale arrays — record bodies stay warm);
|
|
1271
|
+
* SSP resets to a fresh circuit with re-seeded permissions.
|
|
1272
|
+
*
|
|
1273
|
+
* Rebind: auth token re-persisted (the surrealdb persistence client wrote it
|
|
1274
|
+
* into the OLD bucket's `_00_kv` before this listener ran), active queries
|
|
1275
|
+
* re-homed keeping their hashes, sync resumed on the new bucket's own
|
|
1276
|
+
* outbox, and every query re-registered remotely to refill from the server.
|
|
1277
|
+
*/
|
|
1278
|
+
private doSwitchBucket;
|
|
583
1279
|
close(): Promise<void>;
|
|
1280
|
+
/**
|
|
1281
|
+
* Subscribe to a feature flag for the current user. Returns a
|
|
1282
|
+
* `FeatureFlagHandle` whose `variant()`, `payload()` and `enabled()`
|
|
1283
|
+
* accessors reflect the latest assignment from `_00_user_feature`,
|
|
1284
|
+
* and whose `subscribe(cb)` fires whenever that assignment changes.
|
|
1285
|
+
*
|
|
1286
|
+
* Permissions are enforced by SurrealDB: a client can only ever see
|
|
1287
|
+
* its own row, and cannot create or modify assignments.
|
|
1288
|
+
*/
|
|
1289
|
+
feature(key: string, options?: FeatureFlagOptions): FeatureFlagHandle;
|
|
584
1290
|
authenticate(token: string): Promise<surrealdb0.Tokens>;
|
|
1291
|
+
/**
|
|
1292
|
+
* Open a CRDT field for collaborative editing.
|
|
1293
|
+
* Returns a CrdtField with a LoroDoc that can be bound to any editor.
|
|
1294
|
+
* Also starts a LIVE SELECT on the parent table for real-time sync;
|
|
1295
|
+
* incoming events trigger a subquery fetch of `_00_crdt` / `_00_cursor`.
|
|
1296
|
+
*/
|
|
1297
|
+
openCrdtField(table: string, recordId: string, field: string, fallbackText?: string): Promise<CrdtField>;
|
|
1298
|
+
/**
|
|
1299
|
+
* Close a CRDT field when editing is done.
|
|
1300
|
+
*/
|
|
1301
|
+
closeCrdtField(table: string, recordId: string, field: string): void;
|
|
585
1302
|
deauthenticate(): Promise<void>;
|
|
586
|
-
query<Table extends TableNames<S>>(table: Table, options: QueryOptions<TableModel<GetTable<S, Table>>, false>, ttl?: QueryTimeToLive): QueryBuilder<S, Table,
|
|
1303
|
+
query<Table extends TableNames<S>>(table: Table, options: QueryOptions<TableModel<GetTable<S, Table>>, false>, ttl?: QueryTimeToLive): QueryBuilder<S, Table, Sp00kyQueryResultPromise>;
|
|
587
1304
|
private initQuery;
|
|
1305
|
+
/**
|
|
1306
|
+
* Background tail of {@link initQuery}: instant-hydrate (when the query is
|
|
1307
|
+
* cold AND wasn't freshly preloaded) followed by enqueuing the `register`
|
|
1308
|
+
* down-event. Never rejects — both halves catch and log, so `void`-ing the
|
|
1309
|
+
* returned promise can't produce an unhandled rejection.
|
|
1310
|
+
*
|
|
1311
|
+
* The fresh-preload skip: rows a recent `preload()` persisted are already in
|
|
1312
|
+
* the local cache and were part of the first paint; the register lifecycle
|
|
1313
|
+
* re-syncs them authoritatively, so the one-shot hydrate fetch would be a
|
|
1314
|
+
* pure duplicate round trip. "Fresh" = preloaded this session
|
|
1315
|
+
* (`preloadedHashes`) or a `_00_preload` marker younger than
|
|
1316
|
+
* HYDRATE_PRELOAD_FRESH. Both are per-bucket (the Set is cleared on bucket
|
|
1317
|
+
* switch, the marker table lives in the bucket), so neither can claim
|
|
1318
|
+
* freshness across auth contexts.
|
|
1319
|
+
*/
|
|
1320
|
+
private finishQueryInit;
|
|
1321
|
+
/**
|
|
1322
|
+
* Smart, awaitable preload/prewarm into the LOCAL cache — without registering a
|
|
1323
|
+
* live view (NO `_00_query`, NO subscription, NO TTL heartbeat).
|
|
1324
|
+
*
|
|
1325
|
+
* Cache-aware via a durable per-bucket freshness marker (`_00_preload`):
|
|
1326
|
+
* - COLD (never preloaded in this bucket): fetch the query one-shot from the
|
|
1327
|
+
* remote, persist the rows (+ embedded `.related()` children), stamp the
|
|
1328
|
+
* marker — and AWAIT it. This is the "smart waiting" first load: callers can
|
|
1329
|
+
* `await db.preload(...)` to hold the UI until the data is ready.
|
|
1330
|
+
* - WARM (marker present): return instantly — NEVER blocks. `refresh` decides
|
|
1331
|
+
* whether to also kick a one-time silent refetch (see {@link PreloadOptions}).
|
|
1332
|
+
* Default `onUse` does nothing; the data freshens when the real `useQuery`
|
|
1333
|
+
* mounts and registers its live view.
|
|
1334
|
+
*
|
|
1335
|
+
* Best-effort: any fetch failure (offline, etc.) is a no-op warn (no marker
|
|
1336
|
+
* written, so it's retried next load). Deduped per session by query hash.
|
|
1337
|
+
*/
|
|
1338
|
+
preload(finalQuery: FinalQuery<S, any, any, any, any, any>, options?: PreloadOptions): Promise<void>;
|
|
1339
|
+
/**
|
|
1340
|
+
* One-shot remote fetch + local persist for a preload query. Returns the row
|
|
1341
|
+
* count on success, or -1 on failure (best-effort: logged, never thrown) so
|
|
1342
|
+
* the caller skips stamping the freshness marker and retries next load.
|
|
1343
|
+
*/
|
|
1344
|
+
private fetchAndPersist;
|
|
588
1345
|
queryRaw(sql: string, params: Record<string, any>, ttl: QueryTimeToLive): Promise<string>;
|
|
589
1346
|
subscribe(queryHash: string, callback: (records: Record<string, any>[]) => void, options?: {
|
|
590
1347
|
immediate?: boolean;
|
|
591
1348
|
}): Promise<() => void>;
|
|
1349
|
+
/**
|
|
1350
|
+
* Opt-in eager teardown for a query whose last subscriber has gone away
|
|
1351
|
+
* (e.g. a viewport-windowed list cancelling an off-screen window). No-op
|
|
1352
|
+
* while any subscriber remains. Tears down the remote `_00_query` view +
|
|
1353
|
+
* local WASM view instead of waiting for the TTL sweep. Default behavior
|
|
1354
|
+
* (no call here) keeps the view resident for cheap re-subscription.
|
|
1355
|
+
*/
|
|
1356
|
+
deregisterQuery(queryHash: string): void;
|
|
1357
|
+
/**
|
|
1358
|
+
* Subscribe to a query's fetch-status changes (idle/fetching). With
|
|
1359
|
+
* `{ immediate: true }` the callback fires synchronously with the current
|
|
1360
|
+
* status. Powers the `useQuery` hook's `isFetching()` accessor.
|
|
1361
|
+
*/
|
|
1362
|
+
subscribeQueryStatus(queryHash: string, callback: QueryStatusCallback, options?: {
|
|
1363
|
+
immediate?: boolean;
|
|
1364
|
+
}): () => void;
|
|
1365
|
+
/**
|
|
1366
|
+
* Report the frontend processing time (ms) a client framework spent applying
|
|
1367
|
+
* an update for a query (e.g. `useQuery`'s `reconcile()`), so DevTools/MCP can
|
|
1368
|
+
* surface the "frontend" phase of the per-query timing breakdown.
|
|
1369
|
+
*/
|
|
1370
|
+
reportFrontendTiming(queryHash: string, ms: number): void;
|
|
592
1371
|
run<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(backend: B, path: R, payload: RoutePayload<S, B, R>, options?: RunOptions): Promise<void>;
|
|
1372
|
+
runRecurring<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(backend: B, path: R, payload: RoutePayload<S, B, R>, options: RunOptions & {
|
|
1373
|
+
interval: number;
|
|
1374
|
+
assignedTo: string;
|
|
1375
|
+
}): Promise<void>;
|
|
1376
|
+
pokeRecurring<B extends BackendNames<S>>(backend: B, path: BackendRoutes<S, B>, options: {
|
|
1377
|
+
assignedTo: string;
|
|
1378
|
+
}): Promise<void>;
|
|
1379
|
+
cancelRecurring<B extends BackendNames<S>>(backend: B, path: BackendRoutes<S, B>, options: {
|
|
1380
|
+
assignedTo: string;
|
|
1381
|
+
}): Promise<void>;
|
|
593
1382
|
bucket<B extends BucketNames<S>>(name: B): BucketHandle;
|
|
594
1383
|
create(id: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
595
1384
|
update(table: string, id: string, data: Record<string, unknown>, options?: UpdateOptions): Promise<{
|
|
@@ -597,15 +1386,25 @@ declare class SpookyClient<S extends SchemaStructure> {
|
|
|
597
1386
|
}>;
|
|
598
1387
|
delete(table: string, id: string): Promise<void>;
|
|
599
1388
|
useRemote<T>(fn: (client: Surreal) => Promise<T> | T): Promise<T>;
|
|
600
|
-
|
|
601
|
-
|
|
1389
|
+
/**
|
|
1390
|
+
* Fetch SurrealDB's `session::id()` as a string. Used as a salt for
|
|
1391
|
+
* query-id hashing so two sessions for the same user get distinct
|
|
1392
|
+
* `_00_query` rows. Returns empty string if the query fails (we still
|
|
1393
|
+
* boot, just without session scoping for IDs).
|
|
1394
|
+
*/
|
|
1395
|
+
private fetchSessionId;
|
|
602
1396
|
}
|
|
603
1397
|
//#endregion
|
|
604
1398
|
//#region src/utils/index.d.ts
|
|
605
1399
|
declare function fileToUint8Array(file: File | Blob): Promise<Uint8Array>;
|
|
1400
|
+
/**
|
|
1401
|
+
* Convert plain text to simple HTML paragraphs.
|
|
1402
|
+
* Useful for seeding a rich-text editor (e.g. TipTap/ProseMirror) with fallback content.
|
|
1403
|
+
*/
|
|
1404
|
+
declare function textToHtml(text: string): string;
|
|
606
1405
|
/**
|
|
607
1406
|
* Helper for retrying DB operations with exponential backoff
|
|
608
1407
|
*/
|
|
609
1408
|
|
|
610
1409
|
//#endregion
|
|
611
|
-
export { AuthEventSystem, AuthEventTypeMap, AuthEventTypes, AuthService, BucketHandle, DebounceOptions, EventSubscriptionOptions, type Level, MutationCallback, MutationEvent, MutationEventType, PersistenceClient, QueryConfig, QueryConfigRecord, QueryHash, QueryState, QueryTimeToLive, QueryUpdateCallback, RecordVersionArray, RecordVersionDiff, RunOptions,
|
|
1410
|
+
export { AuthEventSystem, AuthEventTypeMap, AuthEventTypes, AuthService, BucketHandle, CURSOR_COLORS, CrdtField, CrdtManager, DebounceOptions, EventSubscriptionOptions, FeatureFlagHandle, FeatureFlagModule, type FeatureFlagOptions, type FeatureFlagSnapshot, Level, MATERIALIZATION_SAMPLE_WINDOW, MutationCallback, MutationEvent, MutationEventType, PersistenceClient, PhaseStat, PinoTransmit, PreloadOptions, PreloadRefresh, QueryConfig, QueryConfigRecord, QueryHash, QueryState, QueryStatus, QueryStatusCallback, QueryTimeToLive, QueryTimings, QueryUpdateCallback, RecordVersionArray, RecordVersionDiff, RegistrationTimings, RunOptions, Sp00kyClient, Sp00kyConfig, Sp00kyQueryResult, Sp00kyQueryResultPromise, StoreType, SyncHealth, SyncHealthConfig, SyncHealthStatus, TimingPhase, UpdateOptions, createAuthEventSystem, cursorColorFromName, fileToUint8Array, textToHtml };
|