@buoy-gg/impersonate 1.0.3-beta.0

package/lib/typescript/impersonate/utils/impersonateStore.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Impersonate Store - State Management with Persistence
+ *
+ * Singleton store for managing impersonation state. Uses a subscription
+ * pattern compatible with React's useSyncExternalStore.
+ */
+import type { User, DataNukeSettings, ImpersonationState, ImpersonateDefaults } from "../types";
+type StateListener = (state: ImpersonationState) => void;
+interface NukeCallbacks {
+    reactQuery?: () => void | Promise<void>;
+    redux?: () => void | Promise<void>;
+    asyncStorage?: () => void | Promise<void>;
+    mmkv?: () => void | Promise<void>;
+}
+/**
+ * Singleton store for impersonation state
+ *
+ * Features:
+ * - Subscription pattern for React integration
+ * - Persistence of settings and history
+ * - Data nuking on impersonation change
+ * - Automatic sync with impersonateListener
+ */
+declare class ImpersonateStore {
+    private state;
+    private listeners;
+    private nukeCallbacks;
+    private isInitialized;
+    private asyncStorageRef;
+    private storageReadyPromise;
+    private resolveStorageReady;
+    private developerDefaults;
+    constructor();
+    /**
+     * Load persisted state from storage (sync)
+     */
+    private loadFromStorage;
+    /**
+     * Set async storage reference for persistence (call before initializeAsync)
+     * This ensures all writes use AsyncStorage even before load completes
+     */
+    setAsyncStorage(asyncStorage: {
+        getItem: (key: string) => Promise<string | null>;
+        setItem: (key: string, value: string) => Promise<void>;
+    }): void;
+    /**
+     * Set developer-provided defaults
+     * These override hardcoded defaults but are overridden by persisted values
+     * Call this before the component mounts (in createImpersonateTool)
+     */
+    setDeveloperDefaults(defaults: ImpersonateDefaults): void;
+    /**
+     * Get effective defaults (developer defaults merged with hardcoded defaults)
+     */
+    private getEffectiveDefaults;
+    /**
+     * Get developer defaults (for use in UI to show what the "default" values are)
+     */
+    getDeveloperDefaults(): ImpersonateDefaults | null;
+    /**
+     * Initialize with async storage (for React Native)
+     * Call this in useEffect to load from AsyncStorage
+     */
+    initializeAsync(asyncStorage?: {
+        getItem: (key: string) => Promise<string | null>;
+        setItem: (key: string, value: string) => Promise<void>;
+    }): Promise<void>;
+    /**
+     * Register callbacks for data nuking
+     */
+    registerNukeCallbacks(callbacks: NukeCallbacks): void;
+    /**
+     * Get current state (creates a copy)
+     */
+    getState(): ImpersonationState;
+    /**
+     * Get snapshot for useSyncExternalStore
+     * Returns the same reference if state hasn't changed
+     */
+    getSnapshot: () => ImpersonationState;
+    /**
+     * Subscribe to state changes
+     * Returns unsubscribe function
+     */
+    subscribe: (listener: StateListener) => (() => void);
+    /**
+     * Start impersonating a user
+     *
+     * This will:
+     * 1. Execute data nuking based on settings
+     * 2. Update state with new user
+     * 3. Add to history
+     * 4. Sync with impersonateListener
+     * 5. Persist settings
+     */
+    startImpersonation(user: User): Promise<void>;
+    /**
+     * Stop impersonating
+     *
+     * This will:
+     * 1. Execute data nuking based on settings
+     * 2. Clear impersonation state
+     * 3. Sync with impersonateListener
+     */
+    stopImpersonation(): Promise<void>;
+    /**
+     * Pause impersonation (temporarily stop injecting headers)
+     */
+    pauseImpersonation(): Promise<void>;
+    /**
+     * Resume impersonation (start injecting headers again)
+     */
+    resumeImpersonation(): Promise<void>;
+    /**
+     * Quick switch to a user from history
+     */
+    quickSwitch(user: User): Promise<void>;
+    /**
+     * Update settings (header key, ignore patterns, data nuke settings, show banner)
+     */
+    updateSettings(settings: Partial<Pick<ImpersonationState, "headerKey" | "ignorePatterns" | "showBanner"> & {
+        dataNukeSettings?: Partial<DataNukeSettings>;
+    }>): Promise<void>;
+    /**
+     * Remove a user from history
+     */
+    removeFromHistory(userId: string): Promise<void>;
+    /**
+     * Clear all history
+     */
+    clearHistory(): Promise<void>;
+    /**
+     * Execute data nuking based on current settings
+     */
+    private executeDataNuke;
+    /**
+     * Sync current state with the impersonateListener
+     */
+    private syncWithListener;
+    /**
+     * Persist state to storage
+     */
+    private persist;
+    /**
+     * Notify all listeners of state change
+     */
+    private notify;
+}
+export declare const impersonateStore: ImpersonateStore;
+export {};
+//# sourceMappingURL=impersonateStore.d.ts.map

package/lib/typescript/impersonate/utils/impersonateStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"impersonateStore.d.ts","sourceRoot":"","sources":["../../../../src/impersonate/utils/impersonateStore.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,IAAI,EAEJ,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAmClB,KAAK,aAAa,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAEzD,UAAU,aAAa;IACrB,UAAU,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,IAAI,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAiDD;;;;;;;;GAQG;AACH,cAAM,gBAAgB;IACpB,OAAO,CAAC,KAAK,CAA4C;IACzD,OAAO,CAAC,SAAS,CAAiC;IAClD,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAGP;IAChB,OAAO,CAAC,mBAAmB,CAA8B;IACzD,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,iBAAiB,CAAoC;;IAqB7D;;OAEG;IACH,OAAO,CAAC,eAAe;IA2CvB;;;OAGG;IACH,eAAe,CAAC,YAAY,EAAE;QAC5B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;QACjD,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KACxD,GAAG,IAAI;IASR;;;;OAIG;IACH,oBAAoB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI;IAkBzD;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAW5B;;OAEG;IACH,oBAAoB,IAAI,mBAAmB,GAAG,IAAI;IAIlD;;;OAGG;IACG,eAAe,CAAC,YAAY,CAAC,EAAE;QACnC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;QACjD,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KACxD,GAAG,OAAO,CAAC,IAAI,CAAC;IA0CjB;;OAEG;IACH,qBAAqB,CAAC,SAAS,EAAE,aAAa,GAAG,IAAI;IAQrD;;OAEG;IACH,QAAQ,IAAI,kBAAkB;IAI9B;;;OAGG;IACH,WAAW,QAAO,kBAAkB,CAElC;IAEF;;;OAGG;IACH,SAAS,GAAI,UAAU,aAAa,KAAG,CAAC,MAAM,IAAI,CAAC,CAGjD;IAMF;;;;;;;;;OASG;IACG,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnD;;;;;;;OAOG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAsBxC;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBzC;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB1C;;OAEG;IACG,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5C;;OAEG;IACG,cAAc,CAClB,QAAQ,EAAE,OAAO,CACf,IAAI,CAAC,kBAAkB,EAAE,WAAW,GAAG,gBAAgB,GAAG,YAAY,CAAC,GAAG;QACxE,gBAAgB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;KAC9C,CACF,GACA,OAAO,CAAC,IAAI,CAAC;IA6BhB;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAStD;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAanC;;OAEG;YACW,eAAe;IAqC7B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAexB;;OAEG;YACW,OAAO;IAoCrB;;OAEG;IACH,OAAO,CAAC,MAAM;CASf;AAMD,eAAO,MAAM,gBAAgB,kBAAyB,CAAC"}

package/lib/typescript/impersonate/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { impersonateListener, startImpersonateListener, stopImpersonateListener, setImpersonateConfig, isImpersonating, getImpersonatedUserId, } from "./impersonateListener";
+export { impersonateStore } from "./impersonateStore";
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/impersonate/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/impersonate/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,uBAAuB,EACvB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,GACtB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}

package/lib/typescript/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @buoy-gg/impersonate
+ *
+ * User impersonation tool for React Native DevTools.
+ * Injects custom headers into fetch/XHR requests when impersonating.
+ *
+ * @example
+ * ```tsx
+ * import { createImpersonateTool } from '@buoy-gg/impersonate';
+ *
+ * const impersonateTool = createImpersonateTool({
+ *   onSearchUsers: async (query) => {
+ *     const res = await api.searchUsers(query);
+ *     return res.users;
+ *   },
+ *   onClearReactQuery: () => queryClient.clear(),
+ * });
+ *
+ * <FloatingDevTools apps={[impersonateTool]} />
+ * ```
+ */
+export { createImpersonateTool } from "./preset";
+export { ImpersonateModal } from "./impersonate/components/ImpersonateModal";
+export { ImpersonateBanner, ImpersonateBannerMinimal, } from "./impersonate/components/ImpersonateBanner";
+export { UserSearchView } from "./impersonate/components/UserSearchView";
+export { DataNukeSettings as DataNukeSettingsComponent } from "./impersonate/components/DataNukeSettings";
+export { ImpersonateHistoryList } from "./impersonate/components/ImpersonateHistoryList";
+export { ImpersonateStatusBar } from "./impersonate/components/ImpersonateStatusBar";
+export { useImpersonate } from "./impersonate/hooks/useImpersonate";
+export type { UseImpersonateOptions, UseImpersonateReturn, } from "./impersonate/hooks/useImpersonate";
+export { useImpersonateHistory } from "./impersonate/hooks/useImpersonateHistory";
+export type { UseImpersonateHistoryReturn } from "./impersonate/hooks/useImpersonateHistory";
+export type { User, DataNukeSettings as DataNukeSettingsType, ImpersonationState, ImpersonateToolConfig, ImpersonateModalProps, ImpersonateBannerProps, ImpersonateListenerConfig, } from "./impersonate/types";
+/**
+ * Direct access to the impersonation store singleton.
+ * Use this for custom integrations or debugging.
+ *
+ * @example
+ * ```typescript
+ * import { impersonateStore } from '@buoy-gg/impersonate';
+ *
+ * // Check if impersonating
+ * const state = impersonateStore.getState();
+ * if (state.isActive) {
+ *   console.log('Impersonating:', state.currentUser?.email);
+ * }
+ *
+ * // Subscribe to changes
+ * const unsubscribe = impersonateStore.subscribe((state) => {
+ *   console.log('Impersonation state changed:', state);
+ * });
+ * ```
+ */
+export { impersonateStore } from "./impersonate/utils/impersonateStore";
+/**
+ * Direct access to the impersonate listener for advanced control.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   impersonateListener,
+ *   startImpersonateListener,
+ *   setImpersonateConfig,
+ * } from '@buoy-gg/impersonate';
+ *
+ * // Manually start the listener
+ * startImpersonateListener();
+ *
+ * // Configure impersonation
+ * setImpersonateConfig({
+ *   headerKey: 'x-custom-impersonate-header',
+ *   userId: 'user_123',
+ * });
+ *
+ * // Check status
+ * console.log('Listener active:', impersonateListener().isListening);
+ * ```
+ */
+export { impersonateListener, startImpersonateListener, stopImpersonateListener, setImpersonateConfig, isImpersonating, getImpersonatedUserId, } from "./impersonate/utils/impersonateListener";
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAMH,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAMjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAC7E,OAAO,EACL,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,gBAAgB,IAAI,yBAAyB,EAAE,MAAM,2CAA2C,CAAC;AAC1G,OAAO,EAAE,sBAAsB,EAAE,MAAM,iDAAiD,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+CAA+C,CAAC;AAMrF,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,YAAY,EACV,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,YAAY,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AAM7F,YAAY,EACV,IAAI,EACJ,gBAAgB,IAAI,oBAAoB,EACxC,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC;AAM7B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACxB,uBAAuB,EACvB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,GACtB,MAAM,yCAAyC,CAAC"}

package/lib/typescript/preset.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Impersonate Tool Preset
+ *
+ * Factory function to create a configured impersonate tool for FloatingDevTools.
+ * No default preset is exported because configuration (onSearchUsers) is required.
+ */
+import React from "react";
+import { ImpersonateBanner } from "./impersonate/components/ImpersonateBanner";
+import type { ImpersonateToolConfig } from "./impersonate/types";
+/**
+ * Create an impersonate tool with custom configuration
+ *
+ * The tool automatically displays a floating banner when impersonation is active.
+ * This can be toggled in the Settings tab or via developer defaults.
+ *
+ * @example
+ * ```tsx
+ * import { createImpersonateTool } from '@buoy-gg/impersonate';
+ * import { queryClient } from './queryClient';
+ *
+ * const impersonateTool = createImpersonateTool({
+ *   onSearchUsers: async (query) => {
+ *     const response = await api.searchUsers({ email: query });
+ *     return response.users.map(u => ({
+ *       id: u.id,
+ *       displayName: u.name,
+ *       email: u.email,
+ *       metadata: { role: u.role, createdAt: u.createdAt }
+ *     }));
+ *   },
+ *   onClearReactQuery: () => queryClient.clear(),
+ *   onClearRedux: () => store.dispatch({ type: 'RESET' }),
+ *
+ *   // Optional: Developer defaults (override hardcoded, overridden by persisted)
+ *   defaults: {
+ *     headerKey: 'x-admin-impersonate',
+ *     showBanner: true,  // Show floating banner when impersonating
+ *     dataNukeSettings: {
+ *       reactQuery: true,
+ *       redux: false,
+ *     },
+ *   },
+ *
+ *   // Optional: Hide settings tab for simple testing
+ *   showSettingsTab: true,
+ * });
+ *
+ * // In your app - banner is automatic, no extra setup needed!
+ * <FloatingDevTools apps={[impersonateTool]} />
+ * ```
+ */
+export declare function createImpersonateTool(config: ImpersonateToolConfig): {
+    id: string;
+    name: string;
+    description: string;
+    slot: "both";
+    icon: ({ size }: {
+        size: number;
+    }) => React.JSX.Element;
+    component: (props: {
+        visible: boolean;
+        onClose: () => void;
+        onBack?: () => void;
+        onMinimize?: (state: unknown) => void;
+    }) => React.JSX.Element;
+    props: {
+        enableSharedModalDimensions: boolean;
+    };
+    Banner: typeof ImpersonateBanner;
+};
+//# sourceMappingURL=preset.d.ts.map

package/lib/typescript/preset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../src/preset.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAA8B,MAAM,OAAO,CAAC;AAGnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,KAAK,EAAE,qBAAqB,EAAyB,MAAM,qBAAqB,CAAC;AA+FxF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,qBAAqB;;;;;qBAyB9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;uBAGd;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;QAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;KAAE;;;;;EAmB3H"}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@buoy-gg/impersonate",
+  "version": "1.0.3-beta.0",
+  "description": "User impersonation tool for Buoy DevTools - inject custom headers for admin testing",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "lib/module/index.js",
+  "source": "src/index.tsx",
+  "exports": {
+    ".": {
+      "react-native": "./lib/module/index.js",
+      "import": {
+        "default": "./lib/module/index.js",
+        "types": "./lib/typescript/index.d.ts"
+      },
+      "require": {
+        "default": "./lib/commonjs/index.js",
+        "types": "./lib/typescript/index.d.ts"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@buoy-gg/shared-ui": "2.1.4-beta.0"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "devDependencies": {
+    "@types/react": "^19.1.0",
+    "@types/react-native": "^0.73.0",
+    "typescript": "~5.8.3"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "sourceMaps": false
+        }
+      ],
+      [
+        "module",
+        {
+          "sourceMaps": false
+        }
+      ],
+      "typescript"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LovesWorking/react-native-buoy.git",
+    "directory": "packages/impersonate"
+  },
+  "bugs": {
+    "url": "https://github.com/LovesWorking/react-native-buoy/issues"
+  },
+  "homepage": "https://github.com/LovesWorking/react-native-buoy/tree/main/packages/impersonate#readme",
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "scripts": {
+    "build": "bob build",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf lib",
+    "test": "pnpm run typecheck"
+  }
+}