@spooky-sync/client-solid2 0.0.1-canary.263 → 0.0.1-canary.264

package/AGENTS.md

@@ -46,7 +46,7 @@ Provider props are identical to client-solid: `config`, `fallback`, `preload` (a
   - Options: `enabled?: () => boolean`, `deregisterOnCleanup?: boolean`.
 - **`createSubmission(fn)`** — button pending/error state around a mutation: `submit()`, `pending()`, `error()`, `result()`, `clearError()`. There is deliberately no `action()` / `createOptimisticStore` layer (see `src/lib/create-submission.ts`).
 - **`useSyncActivity(options?)`** — `{ fetchingQueries, pendingMutations, isDownloading, isUploading }`. One subscription on the engine's aggregate fetch count plus the outbox depth; both are debounced ON by their delay (`downloadDelayMs` 200, `uploadDelayMs` 150) and off at once, and `isUploading()` additionally needs `pendingMutations() > uploadThreshold` (0, so any unacknowledged write counts). Drive a logo/traffic indicator off it; pair with `useSyncStatus().connection()` / `.isOffline()` to switch the same mark to a reconnecting or offline state and show the unsaved count.
-- **`createPreload`**, **`usePendingMutations`**, **`useSyncStatus`**, **`useImpersonation`**, **`useStorageStatus`**, **`useFeatureFlag`**, **`useAppRelease`**, **`useCrdtField`**, **`useFileUpload`**, **`useDownloadFile`** — same shapes as client-solid.
+- **`createPreload`**, **`usePendingMutations`**, **`useSyncStatus`**, **`useImpersonation`** (`{ rendersBanner: true }` when the app draws its own banner), **`useStorageStatus`**, **`useFeatureFlag`**, **`useAppRelease`**, **`useCrdtField`**, **`useFileUpload`**, **`useDownloadFile`** — same shapes as client-solid.
 - **`conflate`**, **`fromSubscription`** — the async-iterable helpers the hooks are built on; useful for wrapping other engine subscriptions.
 
 ## Mutations

package/dist/index.cjs

@@ -393,9 +393,12 @@ function useSyncStatus() {
 * such as hiding actions an admin should not take on someone's behalf.
 * Must be used within a `<Sp00kyProvider>`.
 */
-function useImpersonation() {
+function useImpersonation(options = {}) {
 	const db = useDb();
 	const impersonation = fromSubscription((cb) => db.auth.subscribeImpersonation(cb), db.auth.impersonation);
+	(0, solid_js.createEffect)(() => {
+		if (options.rendersBanner && impersonation()) db.acknowledgeImpersonationBanner();
+	});
 	return {
 		impersonation,
 		isImpersonating: () => impersonation() !== null,
@@ -1192,6 +1195,15 @@ var SyncedDb = class {
 		await this.sp00ky.run(backend, path, unproxy(payload), options);
 	}
 	/**
+	* Tell the client that this app's own impersonation banner is on screen.
+	* Only needed with `impersonationBanner: { mode: 'custom' }`; the
+	* `useImpersonation({ rendersBanner: true })` hook calls it for you.
+	*/
+	acknowledgeImpersonationBanner() {
+		if (!this.sp00ky) throw new Error("SyncedDb not initialized");
+		this.sp00ky.acknowledgeImpersonationBanner();
+	}
+	/**
 	* Sign out, clear session and local storage
 	*/
 	async signOut() {