@spooky-sync/client-solid 0.0.1-canary.26 → 0.0.1-canary.261
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 +70 -0
- package/README.md +20 -0
- package/dist/index.cjs +670 -158
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +379 -22
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.ts +379 -22
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +661 -160
- package/dist/index.js.map +1 -1
- package/package.json +7 -6
- package/skills/{spooky-solid → sp00ky-solid}/SKILL.md +85 -14
- package/skills/{spooky-solid → sp00ky-solid}/references/file-hooks.md +34 -5
- package/src/cache/index.ts +1 -1
- package/src/cache/surrealdb-wasm-factory.ts +4 -1
- package/src/index.ts +179 -61
- package/src/lib/Blurhash.ts +54 -0
- package/src/lib/BucketImage.ts +141 -0
- package/src/lib/Sp00kyProvider.ts +104 -0
- package/src/lib/context.ts +3 -3
- package/src/lib/create-preload.ts +112 -0
- package/src/lib/models.ts +1 -1
- package/src/lib/use-app-release.ts +89 -0
- package/src/lib/use-blurhash.ts +77 -0
- package/src/lib/use-bucket-image.ts +100 -0
- package/src/lib/use-crdt-field.ts +68 -0
- package/src/lib/use-download-file.ts +66 -110
- package/src/lib/use-feature-flag.ts +50 -0
- package/src/lib/use-file-upload.ts +10 -4
- package/src/lib/use-impersonation.ts +30 -0
- package/src/lib/use-query.ts +168 -28
- package/src/lib/use-storage-status.ts +44 -0
- package/src/lib/use-sync-status.ts +64 -0
- package/src/types/index.ts +3 -4
- package/src/lib/SpookyProvider.ts +0 -55
package/src/index.ts
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
import type { SyncedDbConfig } from './types';
|
|
2
2
|
import {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
type
|
|
7
|
-
UpdateOptions,
|
|
8
|
-
RunOptions,
|
|
3
|
+
Sp00kyClient,
|
|
4
|
+
type Sp00kyQueryResultPromise,
|
|
5
|
+
type AuthService,
|
|
6
|
+
type BucketHandle,
|
|
7
|
+
type UpdateOptions,
|
|
8
|
+
type RunOptions,
|
|
9
|
+
type SyncHealth,
|
|
10
|
+
type StorageHealth,
|
|
11
|
+
type PreloadOptions,
|
|
12
|
+
type PreloadRefresh,
|
|
9
13
|
} from '@spooky-sync/core';
|
|
10
14
|
|
|
11
|
-
import {
|
|
15
|
+
import type {
|
|
12
16
|
GetTable,
|
|
13
17
|
QueryBuilder,
|
|
14
18
|
SchemaStructure,
|
|
@@ -19,25 +23,64 @@ import {
|
|
|
19
23
|
RelationshipFieldsFromSchema,
|
|
20
24
|
GetRelationship,
|
|
21
25
|
RelatedFieldMapEntry,
|
|
26
|
+
FinalQuery,
|
|
22
27
|
InnerQuery,
|
|
23
28
|
BackendNames,
|
|
24
29
|
BackendRoutes,
|
|
25
30
|
RoutePayload,
|
|
26
31
|
BucketNames,
|
|
27
32
|
BucketDefinitionSchema,
|
|
33
|
+
QueryModifier,
|
|
34
|
+
QueryModifierBuilder,
|
|
35
|
+
QueryInfo,
|
|
36
|
+
RelationshipsMetadata,
|
|
37
|
+
RelationshipDefinition,
|
|
38
|
+
InferRelatedModelFromMetadata,
|
|
39
|
+
GetCardinality,
|
|
28
40
|
} from '@spooky-sync/query-builder';
|
|
29
41
|
|
|
30
|
-
import { RecordId, Uuid, Surreal } from 'surrealdb';
|
|
42
|
+
import { RecordId, Uuid, type Surreal } from 'surrealdb';
|
|
31
43
|
export { RecordId, Uuid };
|
|
32
44
|
export type { Model, GenericModel, GenericSchema, ModelPayload } from './lib/models';
|
|
33
45
|
export { useQuery } from './lib/use-query';
|
|
46
|
+
export { createPreload } from './lib/create-preload';
|
|
47
|
+
export type { PreloadOptions, PreloadRefresh } from '@spooky-sync/core';
|
|
48
|
+
export { useSyncStatus, type UseSyncStatus } from './lib/use-sync-status';
|
|
49
|
+
export { useImpersonation, type UseImpersonation } from './lib/use-impersonation';
|
|
50
|
+
export type {
|
|
51
|
+
SyncHealth,
|
|
52
|
+
SyncHealthStatus,
|
|
53
|
+
SyncHealthConfig,
|
|
54
|
+
ConnectionState,
|
|
55
|
+
ReconnectConfig,
|
|
56
|
+
} from '@spooky-sync/core';
|
|
57
|
+
export { useStorageStatus, type UseStorageStatus } from './lib/use-storage-status';
|
|
58
|
+
export type { StorageHealth, StorageHealthStatus } from '@spooky-sync/core';
|
|
59
|
+
export { useCrdtField } from './lib/use-crdt-field';
|
|
60
|
+
export { useFeatureFlag, type UseFeatureFlag } from './lib/use-feature-flag';
|
|
61
|
+
export {
|
|
62
|
+
useAppRelease,
|
|
63
|
+
type UseAppRelease,
|
|
64
|
+
type UseAppReleaseOptions,
|
|
65
|
+
} from './lib/use-app-release';
|
|
34
66
|
export { useFileUpload, type FileUploadResult } from './lib/use-file-upload';
|
|
35
|
-
export {
|
|
36
|
-
|
|
67
|
+
export {
|
|
68
|
+
useDownloadFile,
|
|
69
|
+
type UseDownloadFileOptions,
|
|
70
|
+
type UseDownloadFileResult,
|
|
71
|
+
} from './lib/use-download-file';
|
|
72
|
+
export { useBlurhash, type UseBlurhashResult } from './lib/use-blurhash';
|
|
73
|
+
export {
|
|
74
|
+
useBucketImage,
|
|
75
|
+
type UseBucketImageOptions,
|
|
76
|
+
type UseBucketImageResult,
|
|
77
|
+
} from './lib/use-bucket-image';
|
|
78
|
+
export { Blurhash, type BlurhashProps } from './lib/Blurhash';
|
|
79
|
+
export { BucketImage, type BucketImageProps } from './lib/BucketImage';
|
|
80
|
+
export { Sp00kyProvider, type Sp00kyProviderProps } from './lib/Sp00kyProvider';
|
|
37
81
|
export { useDb } from './lib/context';
|
|
38
82
|
|
|
39
83
|
// export { AuthEventTypes } from "@spooky-sync/core"; // TODO: Verify if AuthEventTypes exists in core
|
|
40
|
-
export type {};
|
|
41
84
|
|
|
42
85
|
// Re-export query builder types for convenience
|
|
43
86
|
export type {
|
|
@@ -52,7 +95,7 @@ export type {
|
|
|
52
95
|
TableModel,
|
|
53
96
|
TableNames,
|
|
54
97
|
QueryResult,
|
|
55
|
-
}
|
|
98
|
+
};
|
|
56
99
|
|
|
57
100
|
export type RelationshipField<
|
|
58
101
|
Schema extends SchemaStructure,
|
|
@@ -94,39 +137,52 @@ export type WithRelatedMany<Field extends string, RelatedFields extends RelatedF
|
|
|
94
137
|
};
|
|
95
138
|
|
|
96
139
|
/**
|
|
97
|
-
* SyncedDb - A thin wrapper around
|
|
98
|
-
* Delegates all logic to the underlying
|
|
140
|
+
* SyncedDb - A thin wrapper around sp00ky-ts for Solid.js integration
|
|
141
|
+
* Delegates all logic to the underlying sp00ky-ts instance
|
|
99
142
|
*/
|
|
100
143
|
export class SyncedDb<S extends SchemaStructure> {
|
|
101
144
|
private config: SyncedDbConfig<S>;
|
|
102
|
-
private
|
|
145
|
+
private sp00ky: Sp00kyClient<S> | null = null;
|
|
103
146
|
private _initialized = false;
|
|
104
147
|
|
|
105
148
|
constructor(config: SyncedDbConfig<S>) {
|
|
106
149
|
this.config = config;
|
|
107
150
|
}
|
|
108
151
|
|
|
109
|
-
public
|
|
110
|
-
if (!this.
|
|
111
|
-
return this.
|
|
152
|
+
public getSp00ky(): Sp00kyClient<S> {
|
|
153
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
154
|
+
return this.sp00ky;
|
|
112
155
|
}
|
|
113
156
|
|
|
114
157
|
/**
|
|
115
|
-
* Initialize the
|
|
158
|
+
* Initialize the sp00ky-ts instance
|
|
116
159
|
*/
|
|
117
160
|
async init(): Promise<void> {
|
|
118
161
|
if (this._initialized) return;
|
|
119
|
-
this.
|
|
120
|
-
await this.
|
|
162
|
+
this.sp00ky = new Sp00kyClient<S>(this.config);
|
|
163
|
+
await this.sp00ky.init();
|
|
121
164
|
this._initialized = true;
|
|
122
165
|
}
|
|
123
166
|
|
|
167
|
+
/**
|
|
168
|
+
* Tear down the client: leaves the tabs broker, closes the local store and
|
|
169
|
+
* remote socket, and frees the wasm circuit. Without this a remounted provider
|
|
170
|
+
* (or an HMR reload) strands a whole client, and the abandoned wasm heaps stay
|
|
171
|
+
* resident because V8 cannot see how much wasm memory a dropped wrapper holds.
|
|
172
|
+
*/
|
|
173
|
+
async close(): Promise<void> {
|
|
174
|
+
const instance = this.sp00ky;
|
|
175
|
+
this.sp00ky = null;
|
|
176
|
+
this._initialized = false;
|
|
177
|
+
if (instance) await instance.close();
|
|
178
|
+
}
|
|
179
|
+
|
|
124
180
|
/**
|
|
125
181
|
* Create a new record in the database
|
|
126
182
|
*/
|
|
127
183
|
async create(id: string, payload: Record<string, unknown>): Promise<void> {
|
|
128
|
-
if (!this.
|
|
129
|
-
await this.
|
|
184
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
185
|
+
await this.sp00ky.create(id, payload as Record<string, unknown>);
|
|
130
186
|
}
|
|
131
187
|
|
|
132
188
|
/**
|
|
@@ -138,8 +194,8 @@ export class SyncedDb<S extends SchemaStructure> {
|
|
|
138
194
|
payload: Partial<TableModel<GetTable<S, TName>>>,
|
|
139
195
|
options?: UpdateOptions
|
|
140
196
|
): Promise<void> {
|
|
141
|
-
if (!this.
|
|
142
|
-
await this.
|
|
197
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
198
|
+
await this.sp00ky.update(
|
|
143
199
|
tableName as string,
|
|
144
200
|
recordId,
|
|
145
201
|
payload as Record<string, unknown>,
|
|
@@ -152,12 +208,39 @@ export class SyncedDb<S extends SchemaStructure> {
|
|
|
152
208
|
*/
|
|
153
209
|
async delete<TName extends TableNames<S>>(
|
|
154
210
|
tableName: TName,
|
|
155
|
-
selector: string | InnerQuery<GetTable<S, TName>, boolean>
|
|
211
|
+
selector: string | RecordId | InnerQuery<GetTable<S, TName>, boolean>
|
|
156
212
|
): Promise<void> {
|
|
157
|
-
if (!this.
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
213
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
214
|
+
// Accept a `"table:id"` string OR a RecordId — live-query rows carry their
|
|
215
|
+
// `id` as a RecordId, so callers can pass `db.delete('game', row.id)`
|
|
216
|
+
// directly. Build the canonical string from the raw id part (not
|
|
217
|
+
// `RecordId.toString()`, which escapes special chars) so it round-trips
|
|
218
|
+
// through the engine's `parseRecordIdString`. InnerQuery selectors are not
|
|
219
|
+
// supported yet. (cross-package RecordId instances → match by constructor name.)
|
|
220
|
+
const isRecordId =
|
|
221
|
+
selector instanceof RecordId || (selector as any)?.constructor?.name === 'RecordId';
|
|
222
|
+
let id: string;
|
|
223
|
+
if (typeof selector === 'string') {
|
|
224
|
+
id = selector;
|
|
225
|
+
} else if (isRecordId) {
|
|
226
|
+
id = `${tableName as string}:${(selector as RecordId).id}`;
|
|
227
|
+
} else {
|
|
228
|
+
throw new Error('Only string ID or RecordId selectors are supported currently with core');
|
|
229
|
+
}
|
|
230
|
+
await this.sp00ky.delete(tableName as string, id);
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* Preload/prewarm a built query into the local cache without registering a
|
|
235
|
+
* live view. Fetches once and stores the rows (+ embedded related children)
|
|
236
|
+
* locally so a later `useQuery` for the same data paints instantly. Best-effort.
|
|
237
|
+
*/
|
|
238
|
+
public async preload(
|
|
239
|
+
finalQuery: FinalQuery<S, any, any, any, any, Sp00kyQueryResultPromise>,
|
|
240
|
+
options?: PreloadOptions
|
|
241
|
+
): Promise<void> {
|
|
242
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
243
|
+
await this.sp00ky.preload(finalQuery, options);
|
|
161
244
|
}
|
|
162
245
|
|
|
163
246
|
/**
|
|
@@ -165,34 +248,31 @@ export class SyncedDb<S extends SchemaStructure> {
|
|
|
165
248
|
*/
|
|
166
249
|
public query<TName extends TableNames<S>>(
|
|
167
250
|
table: TName
|
|
168
|
-
): QueryBuilder<S, TName,
|
|
169
|
-
if (!this.
|
|
170
|
-
return this.
|
|
251
|
+
): QueryBuilder<S, TName, Sp00kyQueryResultPromise, {}, false> {
|
|
252
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
253
|
+
return this.sp00ky.query(table, {});
|
|
171
254
|
}
|
|
172
255
|
|
|
173
256
|
/**
|
|
174
257
|
* Run a backend operation
|
|
175
258
|
*/
|
|
176
|
-
public async run<
|
|
177
|
-
B extends BackendNames<S>,
|
|
178
|
-
R extends BackendRoutes<S, B>,
|
|
179
|
-
>(
|
|
259
|
+
public async run<B extends BackendNames<S>, R extends BackendRoutes<S, B>>(
|
|
180
260
|
backend: B,
|
|
181
261
|
path: R,
|
|
182
262
|
payload: RoutePayload<S, B, R>,
|
|
183
|
-
options?: RunOptions
|
|
263
|
+
options?: RunOptions
|
|
184
264
|
): Promise<void> {
|
|
185
|
-
if (!this.
|
|
186
|
-
await this.
|
|
265
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
266
|
+
await this.sp00ky.run(backend, path, payload, options);
|
|
187
267
|
}
|
|
188
268
|
|
|
189
269
|
/**
|
|
190
270
|
* Authenticate with the database
|
|
191
271
|
*/
|
|
192
272
|
public async authenticate(token: string): Promise<RecordId<string>> {
|
|
193
|
-
|
|
194
|
-
//
|
|
195
|
-
// Wait, checked
|
|
273
|
+
await this.sp00ky?.authenticate(token);
|
|
274
|
+
// Sp00kyClient.authenticate returns whatever remote.authenticate returns (boolean or token usually?)
|
|
275
|
+
// Wait, checked Sp00kyClient: return this.remote.getClient().authenticate(token);
|
|
196
276
|
// SurrealDB authenticate returns void? or token?
|
|
197
277
|
// Assuming void or token.
|
|
198
278
|
return new RecordId('user', 'me'); // Placeholder or actual?
|
|
@@ -210,54 +290,92 @@ export class SyncedDb<S extends SchemaStructure> {
|
|
|
210
290
|
* Sign out, clear session and local storage
|
|
211
291
|
*/
|
|
212
292
|
public async signOut(): Promise<void> {
|
|
213
|
-
if (!this.
|
|
214
|
-
await this.
|
|
293
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
294
|
+
await this.sp00ky.auth.signOut();
|
|
215
295
|
}
|
|
216
296
|
|
|
217
297
|
/**
|
|
218
298
|
* Execute a function with direct access to the remote database connection
|
|
219
299
|
*/
|
|
220
300
|
public async useRemote<T>(fn: (db: Surreal) => T | Promise<T>): Promise<T> {
|
|
221
|
-
if (!this.
|
|
222
|
-
return await this.
|
|
301
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
302
|
+
return await this.sp00ky.useRemote(fn);
|
|
223
303
|
}
|
|
224
304
|
/**
|
|
225
305
|
* Access the remote database service directly
|
|
226
306
|
*/
|
|
227
|
-
get remote():
|
|
228
|
-
if (!this.
|
|
229
|
-
return this.
|
|
307
|
+
get remote(): Sp00kyClient<S>['remoteClient'] {
|
|
308
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
309
|
+
return this.sp00ky.remoteClient;
|
|
230
310
|
}
|
|
231
311
|
|
|
232
312
|
/**
|
|
233
313
|
* Access the local database service directly
|
|
234
314
|
*/
|
|
235
|
-
get local():
|
|
236
|
-
if (!this.
|
|
237
|
-
return this.
|
|
315
|
+
get local(): Sp00kyClient<S>['localClient'] {
|
|
316
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
317
|
+
return this.sp00ky.localClient;
|
|
238
318
|
}
|
|
239
319
|
|
|
240
320
|
/**
|
|
241
321
|
* Access the auth service
|
|
242
322
|
*/
|
|
243
323
|
get auth(): AuthService<S> {
|
|
244
|
-
if (!this.
|
|
245
|
-
return this.
|
|
324
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
325
|
+
return this.sp00ky.auth;
|
|
246
326
|
}
|
|
247
327
|
|
|
248
328
|
get pendingMutationCount(): number {
|
|
249
|
-
if (!this.
|
|
250
|
-
return this.
|
|
329
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
330
|
+
return this.sp00ky.pendingMutationCount;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/** Diagnostic — see `Sp00kyClient.liveRetryCount`. */
|
|
334
|
+
get liveRetryCount(): number {
|
|
335
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
336
|
+
return this.sp00ky.liveRetryCount;
|
|
251
337
|
}
|
|
252
338
|
|
|
253
339
|
subscribeToPendingMutations(cb: (count: number) => void): () => void {
|
|
254
|
-
if (!this.
|
|
255
|
-
return this.
|
|
340
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
341
|
+
return this.sp00ky.subscribeToPendingMutations(cb);
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
/** Current sync-health snapshot. See {@link useSyncStatus}. */
|
|
345
|
+
get syncHealth(): SyncHealth {
|
|
346
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
347
|
+
return this.sp00ky.syncHealth;
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
/**
|
|
351
|
+
* Observe sync health. Fires immediately with the current status and again
|
|
352
|
+
* on every healthy↔degraded transition. Prefer the `useSyncStatus` hook in
|
|
353
|
+
* components; this is the imperative escape hatch.
|
|
354
|
+
*/
|
|
355
|
+
subscribeToSyncHealth(cb: (health: SyncHealth) => void): () => void {
|
|
356
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
357
|
+
return this.sp00ky.subscribeToSyncHealth(cb);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
/** Current local-store durability snapshot. See {@link useStorageStatus}. */
|
|
361
|
+
get storageHealth(): StorageHealth {
|
|
362
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
363
|
+
return this.sp00ky.storageHealth;
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* Observe local-store durability. Fires immediately with the current snapshot
|
|
368
|
+
* and again on change. Prefer the `useStorageStatus` hook in components; this
|
|
369
|
+
* is the imperative escape hatch.
|
|
370
|
+
*/
|
|
371
|
+
subscribeToStorageHealth(cb: (health: StorageHealth) => void): () => void {
|
|
372
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
373
|
+
return this.sp00ky.subscribeToStorageHealth(cb);
|
|
256
374
|
}
|
|
257
375
|
|
|
258
376
|
bucket<B extends BucketNames<S>>(name: B): BucketHandle {
|
|
259
|
-
if (!this.
|
|
260
|
-
return this.
|
|
377
|
+
if (!this.sp00ky) throw new Error('SyncedDb not initialized');
|
|
378
|
+
return this.sp00ky.bucket(name);
|
|
261
379
|
}
|
|
262
380
|
|
|
263
381
|
getBucketConfig(name: string): BucketDefinitionSchema | undefined {
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { createEffect } from 'solid-js';
|
|
2
|
+
import type { JSX } from 'solid-js';
|
|
3
|
+
import { decodeBlurhash } from '@spooky-sync/core';
|
|
4
|
+
|
|
5
|
+
export interface BlurhashProps {
|
|
6
|
+
/** The blurhash string. Nullish paints nothing (transparent canvas). */
|
|
7
|
+
hash: string | null | undefined;
|
|
8
|
+
/** Decode resolution. 32x32 is plenty: blurhash carries at most 9x9 DCT
|
|
9
|
+
* components, the canvas is meant to be CSS-scaled to fill. */
|
|
10
|
+
width?: number;
|
|
11
|
+
height?: number;
|
|
12
|
+
/** Contrast punch, see the blurhash reference decoder. Defaults to 1. */
|
|
13
|
+
punch?: number;
|
|
14
|
+
class?: string;
|
|
15
|
+
style?: string;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* A blurhash painted onto a canvas, once per hash change. Size the canvas via
|
|
20
|
+
* `class`/`style` (e.g. `absolute inset-0 w-full h-full`); the internal decode
|
|
21
|
+
* resolution stays tiny regardless of the displayed size.
|
|
22
|
+
*/
|
|
23
|
+
export function Blurhash(props: BlurhashProps): JSX.Element {
|
|
24
|
+
if (typeof document === 'undefined') return null;
|
|
25
|
+
const canvas = document.createElement('canvas');
|
|
26
|
+
|
|
27
|
+
createEffect(() => {
|
|
28
|
+
canvas.className = props.class ?? '';
|
|
29
|
+
});
|
|
30
|
+
createEffect(() => {
|
|
31
|
+
canvas.style.cssText = props.style ?? '';
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
createEffect(() => {
|
|
35
|
+
const width = props.width ?? 32;
|
|
36
|
+
const height = props.height ?? 32;
|
|
37
|
+
canvas.width = width;
|
|
38
|
+
canvas.height = height;
|
|
39
|
+
const hash = props.hash;
|
|
40
|
+
if (!hash) return;
|
|
41
|
+
try {
|
|
42
|
+
const pixels = decodeBlurhash(hash, width, height, props.punch ?? 1);
|
|
43
|
+
const ctx = canvas.getContext('2d');
|
|
44
|
+
if (!ctx) return;
|
|
45
|
+
const imageData = ctx.createImageData(width, height);
|
|
46
|
+
imageData.data.set(pixels);
|
|
47
|
+
ctx.putImageData(imageData, 0, 0);
|
|
48
|
+
} catch {
|
|
49
|
+
// An invalid hash paints nothing; the layer below stays visible.
|
|
50
|
+
}
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
return canvas;
|
|
54
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
import { createSignal, createEffect, onMount, onCleanup, children } from 'solid-js';
|
|
2
|
+
import type { JSX } from 'solid-js';
|
|
3
|
+
import type { BucketNames, SchemaStructure } from '@spooky-sync/query-builder';
|
|
4
|
+
import { useBucketImage, type UseBucketImageOptions } from './use-bucket-image';
|
|
5
|
+
import { Blurhash } from './Blurhash';
|
|
6
|
+
|
|
7
|
+
export interface BucketImageProps {
|
|
8
|
+
/** Bucket name from the schema. */
|
|
9
|
+
bucket: string;
|
|
10
|
+
/** Path within the bucket. Nullish renders only the fallback layers. */
|
|
11
|
+
path: string | null | undefined;
|
|
12
|
+
alt?: string;
|
|
13
|
+
/** Classes for the container element (sizing/positioning). */
|
|
14
|
+
class?: string;
|
|
15
|
+
/** Classes for the inner `<img>` (the layout styles are inline). */
|
|
16
|
+
imgClass?: string;
|
|
17
|
+
/** `object-fit` for the image. Defaults to `cover`. */
|
|
18
|
+
fit?: 'cover' | 'contain' | 'fill' | 'none' | 'scale-down';
|
|
19
|
+
/**
|
|
20
|
+
* Bottom placeholder layer (your own plate/skeleton), shown until the image
|
|
21
|
+
* settles. The blurhash layer paints on top of it once the sidecar resolves.
|
|
22
|
+
*/
|
|
23
|
+
fallback?: JSX.Element;
|
|
24
|
+
/** Crossfade duration in ms. Defaults to 300. */
|
|
25
|
+
transition?: number;
|
|
26
|
+
/** Crossfade easing. Defaults to an ease-out-expo curve. */
|
|
27
|
+
easing?: string;
|
|
28
|
+
/** Resolve the blurhash sidecar. Defaults to true. */
|
|
29
|
+
blurhash?: boolean;
|
|
30
|
+
/** Download tuning, forwarded to the underlying `useDownloadFile`. */
|
|
31
|
+
options?: UseBucketImageOptions;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const LAYER_STYLE = 'position:absolute;inset:0;width:100%;height:100%;';
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* A bucket image that never pops in: it layers (bottom to top) your `fallback`
|
|
38
|
+
* plate, the automatically stored blurhash, and the real image, which stays
|
|
39
|
+
* transparent until the bitmap is DECODED and then crossfades over the
|
|
40
|
+
* placeholders. Placeholder layers unmount once the fade settles. Respects
|
|
41
|
+
* prefers-reduced-motion (instant swap). The container is made
|
|
42
|
+
* `position: relative` unless your `class` positions it already.
|
|
43
|
+
*
|
|
44
|
+
* ```tsx
|
|
45
|
+
* <BucketImage bucket="covers" path={row.cover_key} class="absolute inset-0"
|
|
46
|
+
* fallback={<MyPlate />} alt="" />
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
export function BucketImage(props: BucketImageProps): JSX.Element {
|
|
50
|
+
if (typeof document === 'undefined') return null;
|
|
51
|
+
|
|
52
|
+
const image = useBucketImage(
|
|
53
|
+
props.bucket as BucketNames<SchemaStructure>,
|
|
54
|
+
() => props.path,
|
|
55
|
+
{ ...props.options, blurhash: props.blurhash !== false }
|
|
56
|
+
);
|
|
57
|
+
|
|
58
|
+
const reducedMotion =
|
|
59
|
+
typeof matchMedia === 'function' && matchMedia('(prefers-reduced-motion: reduce)').matches;
|
|
60
|
+
|
|
61
|
+
const root = document.createElement('div');
|
|
62
|
+
createEffect(() => {
|
|
63
|
+
root.className = props.class ?? '';
|
|
64
|
+
});
|
|
65
|
+
// Layers are absolutely positioned; give them an anchor without stomping on
|
|
66
|
+
// a caller class that already positions the container (inline would win).
|
|
67
|
+
onMount(() => {
|
|
68
|
+
if (getComputedStyle(root).position === 'static') root.style.position = 'relative';
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
const placeholder = document.createElement('div');
|
|
72
|
+
placeholder.style.cssText = LAYER_STYLE;
|
|
73
|
+
// Solid hands JSX props over as lazy thunks; `children` resolves them (and
|
|
74
|
+
// nested arrays/functions) to real nodes and keeps them alive reactively.
|
|
75
|
+
const fallbackHolder = document.createElement('div');
|
|
76
|
+
fallbackHolder.style.cssText = LAYER_STYLE;
|
|
77
|
+
placeholder.append(fallbackHolder);
|
|
78
|
+
const resolvedFallback = children(() => props.fallback);
|
|
79
|
+
createEffect(() => {
|
|
80
|
+
const nodes = resolvedFallback.toArray().filter((node) => node instanceof Node) as Node[];
|
|
81
|
+
fallbackHolder.replaceChildren(...nodes);
|
|
82
|
+
});
|
|
83
|
+
const hashCanvas = Blurhash({
|
|
84
|
+
get hash() {
|
|
85
|
+
return image.blurhash();
|
|
86
|
+
},
|
|
87
|
+
style: LAYER_STYLE,
|
|
88
|
+
});
|
|
89
|
+
if (hashCanvas instanceof Node) placeholder.append(hashCanvas);
|
|
90
|
+
|
|
91
|
+
const img = document.createElement('img');
|
|
92
|
+
img.decoding = 'async';
|
|
93
|
+
img.style.cssText = `${LAYER_STYLE}opacity:0;`;
|
|
94
|
+
createEffect(() => {
|
|
95
|
+
img.className = props.imgClass ?? '';
|
|
96
|
+
});
|
|
97
|
+
createEffect(() => {
|
|
98
|
+
img.style.objectFit = props.fit ?? 'cover';
|
|
99
|
+
});
|
|
100
|
+
createEffect(() => {
|
|
101
|
+
img.alt = props.alt ?? '';
|
|
102
|
+
});
|
|
103
|
+
createEffect(() => {
|
|
104
|
+
img.style.transition = reducedMotion
|
|
105
|
+
? 'none'
|
|
106
|
+
: `opacity ${props.transition ?? 300}ms ${props.easing ?? 'cubic-bezier(0.16, 1, 0.3, 1)'}`;
|
|
107
|
+
});
|
|
108
|
+
createEffect(() => {
|
|
109
|
+
const url = image.url();
|
|
110
|
+
if (!url) {
|
|
111
|
+
img.removeAttribute('src');
|
|
112
|
+
return;
|
|
113
|
+
}
|
|
114
|
+
img.src = url;
|
|
115
|
+
image.gate(img);
|
|
116
|
+
});
|
|
117
|
+
createEffect(() => {
|
|
118
|
+
img.style.opacity = image.ready() ? '1' : '0';
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
// Placeholders leave the DOM once the fade is over (a shelf of covers should
|
|
122
|
+
// not composite three layers each forever) and come back when the path
|
|
123
|
+
// changes mid-life (`ready` re-arms via the hook).
|
|
124
|
+
const [settled, setSettled] = createSignal(false);
|
|
125
|
+
createEffect(() => {
|
|
126
|
+
if (!image.ready()) {
|
|
127
|
+
setSettled(false);
|
|
128
|
+
return;
|
|
129
|
+
}
|
|
130
|
+
const wait = (reducedMotion ? 0 : (props.transition ?? 300)) + 120;
|
|
131
|
+
const timer = setTimeout(() => setSettled(true), wait);
|
|
132
|
+
onCleanup(() => clearTimeout(timer));
|
|
133
|
+
});
|
|
134
|
+
createEffect(() => {
|
|
135
|
+
if (settled()) placeholder.remove();
|
|
136
|
+
else if (!placeholder.isConnected) root.insertBefore(placeholder, img);
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
root.append(placeholder, img);
|
|
140
|
+
return root;
|
|
141
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import type { JSX } from 'solid-js';
|
|
2
|
+
import {
|
|
3
|
+
createSignal,
|
|
4
|
+
onMount,
|
|
5
|
+
onCleanup,
|
|
6
|
+
createComponent,
|
|
7
|
+
createMemo,
|
|
8
|
+
mergeProps,
|
|
9
|
+
} from 'solid-js';
|
|
10
|
+
import type { SchemaStructure } from '@spooky/query-builder';
|
|
11
|
+
import type { SyncedDbConfig } from '../types';
|
|
12
|
+
import { SyncedDb } from '../index';
|
|
13
|
+
import { Sp00kyContext } from './context';
|
|
14
|
+
|
|
15
|
+
export interface Sp00kyProviderProps<S extends SchemaStructure> {
|
|
16
|
+
config: SyncedDbConfig<S>;
|
|
17
|
+
fallback?: JSX.Element;
|
|
18
|
+
onError?: (error: Error) => void;
|
|
19
|
+
onReady?: (db: SyncedDb<S>) => void;
|
|
20
|
+
/**
|
|
21
|
+
* Prewarm data into the local cache before revealing the UI. Runs after
|
|
22
|
+
* `init()`; the `fallback` stays visible until it resolves. Use awaitable
|
|
23
|
+
* `db.preload(...)` calls here to gate first-load on essential data (e.g.
|
|
24
|
+
* config). On warm loads preload returns instantly, so there's no perceptible
|
|
25
|
+
* gate after the first run. Best-effort: a rejection is caught and the UI is
|
|
26
|
+
* revealed anyway.
|
|
27
|
+
*/
|
|
28
|
+
preload?: (db: SyncedDb<S>) => Promise<void>;
|
|
29
|
+
children: JSX.Element;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export function Sp00kyProvider<S extends SchemaStructure>(
|
|
33
|
+
props: Sp00kyProviderProps<S>
|
|
34
|
+
): JSX.Element {
|
|
35
|
+
const merged = mergeProps(
|
|
36
|
+
{
|
|
37
|
+
fallback: undefined as JSX.Element | undefined,
|
|
38
|
+
},
|
|
39
|
+
props
|
|
40
|
+
);
|
|
41
|
+
|
|
42
|
+
const [db, setDb] = createSignal<SyncedDb<S> | undefined>(undefined);
|
|
43
|
+
|
|
44
|
+
// `onMount` is async, so a dispose can land mid-init. Only that narrow race is
|
|
45
|
+
// handled here: an instance whose init finished AFTER the provider was already
|
|
46
|
+
// gone is closed, because nothing will ever reference it.
|
|
47
|
+
//
|
|
48
|
+
// A live, mounted client is deliberately NOT closed on cleanup. Doing that
|
|
49
|
+
// nulls `SyncedDb.sp00ky`, so every later `create`/`update`/`delete` throws
|
|
50
|
+
// "SyncedDb not initialized" while reads keep rendering from state that is
|
|
51
|
+
// already subscribed — i.e. mutations die silently and the app looks fine. In
|
|
52
|
+
// a host app the provider wraps the whole tree and only unmounts with the
|
|
53
|
+
// page, where the browser reclaims the worker anyway, so the leak this was
|
|
54
|
+
// meant to fix is worth far less than that risk.
|
|
55
|
+
let disposed = false;
|
|
56
|
+
|
|
57
|
+
onCleanup(() => {
|
|
58
|
+
disposed = true;
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
onMount(async () => {
|
|
62
|
+
try {
|
|
63
|
+
const instance = new SyncedDb<S>(merged.config);
|
|
64
|
+
await instance.init();
|
|
65
|
+
if (disposed) {
|
|
66
|
+
await instance.close();
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
// Gate first-load UI on prewarmed data. Best-effort: never let a preload
|
|
70
|
+
// failure keep the app stuck on the fallback.
|
|
71
|
+
if (merged.preload) {
|
|
72
|
+
try {
|
|
73
|
+
await merged.preload(instance);
|
|
74
|
+
} catch (e) {
|
|
75
|
+
// oxlint-disable-next-line no-console
|
|
76
|
+
console.error('Sp00kyProvider: preload failed; revealing UI anyway', e);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
setDb(() => instance);
|
|
80
|
+
merged.onReady?.(instance);
|
|
81
|
+
} catch (e) {
|
|
82
|
+
const error = e instanceof Error ? e : new Error(String(e));
|
|
83
|
+
if (merged.onError) {
|
|
84
|
+
merged.onError(error);
|
|
85
|
+
} else {
|
|
86
|
+
// oxlint-disable-next-line no-console
|
|
87
|
+
console.error('Sp00kyProvider: Failed to initialize database', error);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
const content = createMemo(() => {
|
|
93
|
+
const instance = db();
|
|
94
|
+
if (!instance) return merged.fallback;
|
|
95
|
+
return createComponent(Sp00kyContext.Provider, {
|
|
96
|
+
value: instance,
|
|
97
|
+
get children() {
|
|
98
|
+
return merged.children;
|
|
99
|
+
},
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
return content as unknown as JSX.Element;
|
|
104
|
+
}
|