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

package/src/index.ts

@@ -47,7 +47,11 @@ export { createQuery, useQuery, type CreateQueryResult, type QueryOptions } from
 export { createPreload } from './lib/create-preload';
 export type { PreloadOptions, PreloadRefresh } from '@spooky-sync/core';
 export { useSyncStatus, type UseSyncStatus } from './lib/use-sync-status';
-export { useImpersonation, type UseImpersonation } from './lib/use-impersonation';
+export {
+  useImpersonation,
+  type UseImpersonation,
+  type UseImpersonationOptions,
+} from './lib/use-impersonation';
 export {
   useSyncActivity,
   type UseSyncActivity,
@@ -296,6 +300,16 @@ export class SyncedDb<S extends SchemaStructure> {
     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.
+   */
+  public acknowledgeImpersonationBanner(): void {
+    if (!this.sp00ky) throw new Error('SyncedDb not initialized');
+    this.sp00ky.acknowledgeImpersonationBanner();
+  }
+
   /**
    * Sign out, clear session and local storage
    */

package/src/lib/use-impersonation.ts

@@ -1,8 +1,17 @@
-import type { Accessor } from 'solid-js';
+import { createEffect, type Accessor } from 'solid-js';
 import { useDb } from './context';
 import { fromSubscription } from './from-subscription';
 import type { ImpersonationInfo } from '@spooky-sync/core';
 
+export interface UseImpersonationOptions {
+  /**
+   * This component renders the app's own impersonation banner. Required with
+   * `impersonationBanner: { mode: 'custom' }`: it acknowledges the banner, so
+   * the client does not fall back to its built-in one.
+   */
+  rendersBanner?: boolean;
+}
+
 export interface UseImpersonation {
   /** The active impersonation, or `null`. */
   impersonation: Accessor<ImpersonationInfo | null>;
@@ -17,12 +26,17 @@ export interface UseImpersonation {
  * such as hiding actions an admin should not take on someone's behalf.
  * Must be used within a `<Sp00kyProvider>`.
  */
-export function useImpersonation(): UseImpersonation {
+export function useImpersonation(options: UseImpersonationOptions = {}): UseImpersonation {
   const db = useDb();
   const impersonation = fromSubscription<ImpersonationInfo | null>(
     (cb) => db.auth.subscribeImpersonation(cb),
     db.auth.impersonation
   );
+  // Re-acknowledged per session: a new impersonation restarts the client's
+  // fallback timer, and this component is what cancels it.
+  createEffect(() => {
+    if (options.rendersBanner && impersonation()) db.acknowledgeImpersonationBanner();
+  });
   return {
     impersonation,
     isImpersonating: () => impersonation() !== null,