@spooky-sync/client-solid2 0.0.1-canary.259 → 0.0.1-canary.261

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`**, **`useStorageStatus`**, **`useFeatureFlag`**, **`useAppRelease`**, **`useCrdtField`**, **`useFileUpload`**, **`useDownloadFile`** — same shapes as client-solid.
+- **`createPreload`**, **`usePendingMutations`**, **`useSyncStatus`**, **`useImpersonation`**, **`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

@@ -385,6 +385,24 @@ function useSyncStatus() {
 	};
 }
 
+//#endregion
+//#region src/lib/use-impersonation.ts
+/**
+* Observe admin impersonation (started from the DevTools). The client already
+* shows its own warning bar with a Stop button; use this for anything extra,
+* such as hiding actions an admin should not take on someone's behalf.
+* Must be used within a `<Sp00kyProvider>`.
+*/
+function useImpersonation() {
+	const db = useDb();
+	const impersonation = fromSubscription((cb) => db.auth.subscribeImpersonation(cb), db.auth.impersonation);
+	return {
+		impersonation,
+		isImpersonating: () => impersonation() !== null,
+		stop: () => db.auth.stopImpersonating()
+	};
+}
+
 //#endregion
 //#region src/lib/use-sync-activity.ts
 /**
@@ -1310,6 +1328,7 @@ exports.useDb = useDb;
 exports.useDownloadFile = useDownloadFile;
 exports.useFeatureFlag = useFeatureFlag;
 exports.useFileUpload = useFileUpload;
+exports.useImpersonation = useImpersonation;
 exports.usePendingMutations = usePendingMutations;
 exports.useQuery = useQuery;
 exports.useStorageStatus = useStorageStatus;