yaver-feedback-react-native 0.5.3 → 0.5.4

package/dist/YaverFeedback.d.ts

@@ -0,0 +1,198 @@
+import { FeedbackConfig, CapturedError } from './types';
+import { P2PClient } from './P2PClient';
+/**
+ * Main entry point for the Yaver Feedback SDK.
+ * Call `YaverFeedback.init()` once at app startup.
+ */
+export declare class YaverFeedback {
+    /**
+     * Initialize the feedback SDK with the given configuration.
+     * Typically called in your app's root component or entry file.
+     *
+     * If no `agentUrl` is provided, the SDK will attempt auto-discovery
+     * via `YaverDiscovery` on the first `startReport()` call.
+     */
+    static init(cfg: FeedbackConfig): void;
+    /**
+     * Run agent discovery in the background.
+     * Called automatically from init() when no agentUrl is provided.
+     * Sets config.agentUrl and creates P2PClient on success.
+     */
+    static discoverAgent(): Promise<void>;
+    /**
+     * Pull a cached session token + selected device from AsyncStorage (populated
+     * by the in-SDK login + machine-picker screens). When present the SDK can
+     * reconnect silently on launch without re-prompting the user. Safe to call
+     * multiple times — it only overrides values the caller did not already set.
+     */
+    static hydrateSession(): Promise<void>;
+    /**
+     * Update the signed-in session token (e.g. after the in-SDK login screen
+     * succeeds). Rebuilds the P2P client and kicks off agent discovery.
+     */
+    static setAuthToken(token: string): Promise<void>;
+    /** Returns true once the SDK has a session token it can use. */
+    static isAuthed(): boolean;
+    /**
+     * Request the embedded FeedbackModal to show the login screen. Works by
+     * emitting an event the modal listens for — avoids forcing the host app
+     * to mount a second navigator.
+     */
+    static showLogin(): void;
+    /**
+     * Request the embedded FeedbackModal to show the machine picker. Requires
+     * an active session; no-ops otherwise.
+     */
+    static showMachinePicker(): void;
+    /**
+     * Update the selected remote device. Resets the cached agent URL so the
+     * next `startReport()` (or FloatingButton press) rediscovers against the
+     * newly-selected machine.
+     */
+    static setPreferredDevice(deviceId: string): Promise<void>;
+    /**
+     * Sign out: clear cached token + device, tear down the P2P client. The
+     * SDK stays enabled; the next feedback trigger will re-prompt for login.
+     */
+    static signOut(): Promise<void>;
+    /**
+     * Manually trigger the feedback collection flow.
+     * Opens the feedback modal if the SDK is initialized and enabled.
+     *
+     * If no agentUrl was configured, runs auto-discovery first.
+     */
+    static startReport(): Promise<void>;
+    /** Returns true if the SDK has been initialized. */
+    static isInitialized(): boolean;
+    /**
+     * Enable or disable the entire feedback SDK at runtime.
+     *
+     * **Disable (false):**
+     * - Stops BlackBox streaming (flushes remaining events first)
+     * - Restores console.log/warn/error if wrapped
+     * - Clears error buffer
+     * - All methods become no-ops (attachError, wrapErrorHandler still safe to call but do nothing)
+     * - P2P client is kept alive (no reconnection cost on re-enable)
+     *
+     * **Enable (true):**
+     * - Restarts BlackBox streaming if it was running before disable
+     * - Error buffer starts collecting again
+     * - All methods become active
+     */
+    static setEnabled(value: boolean): void;
+    /** Returns whether the SDK is currently enabled. */
+    static isEnabled(): boolean;
+    /** Returns the current config, or null if not initialized. */
+    static getConfig(): FeedbackConfig | null;
+    /**
+     * Manually attach an error with optional metadata.
+     * Use this in catch blocks to give the agent extra context.
+     */
+    static attachError(error: Error, metadata?: Record<string, unknown>): void;
+    /**
+     * Returns the current captured errors buffer.
+     * Called internally when building a FeedbackBundle.
+     */
+    static getCapturedErrors(): CapturedError[];
+    /** Clears the captured errors buffer. */
+    static clearCapturedErrors(): void;
+    /**
+     * Returns a pass-through error handler that records the error in Yaver's
+     * buffer and then calls `next`. Use this to insert Yaver into your
+     * existing error handler chain without replacing anything.
+     *
+     * @example
+     * // Works alongside Sentry, Crashlytics, or any other tool:
+     * const originalHandler = ErrorUtils.getGlobalHandler();
+     * ErrorUtils.setGlobalHandler(
+     *   YaverFeedback.wrapErrorHandler(originalHandler)
+     * );
+     * // Sentry can still be initialized after this — it will wrap our
+     * // wrapper, and the chain stays intact.
+     */
+    static wrapErrorHandler(next?: ((error: Error, isFatal?: boolean) => void) | null): (error: Error, isFatal?: boolean) => void;
+    /**
+     * Returns the P2P client instance.
+     * Available after init if agentUrl is set, or after first successful discovery.
+     */
+    static getP2PClient(): P2PClient | null;
+    /** Returns the current feedback mode. */
+    static getFeedbackMode(): 'live' | 'narrated' | 'batch';
+    /** Returns the agent commentary level (0-10). */
+    static getCommentaryLevel(): number;
+    /**
+     * Record a business event. Routes through BlackBox so the agent
+     * persists it to the analytics ledger (no dashboards — export
+     * via CSV or webhook into PostHog).
+     *
+     * @example
+     * ```ts
+     * YaverFeedback.track('purchase_completed', { amount: '9.99' });
+     * ```
+     */
+    static track(name: string, props?: Record<string, unknown>, route?: string): void;
+    /**
+     * Evaluate a single feature flag for a user. Results are cached
+     * for 30 seconds inside YaverFeedback so a tight loop evaluating
+     * the same key doesn't hammer the agent.
+     *
+     * @param key — flag key (must exist on the agent)
+     * @param defaultValue — returned if the flag is missing / offline
+     * @param userId — stable user identifier for rollout bucketing
+     */
+    static getFlag<T = boolean | string>(key: string, defaultValue: T, userId?: string): Promise<T>;
+    /**
+     * Bulk evaluate every flag for a user. Cached on the same 30s
+     * window as getFlag — use this when boot needs a handful of
+     * flags in one roundtrip.
+     */
+    static getFlags(userId?: string): Promise<Record<string, unknown>>;
+    /**
+     * Ask what bundle this device should run. Returns the latest
+     * release manifest in the configured channel plus a rollout
+     * gate. The dev can then compare against what's currently
+     * running and prompt the user to reload.
+     *
+     * On-disk bundle swap is platform-specific — see
+     * `YaverFeedback.onUpdateAvailable` if you want a hook.
+     */
+    static checkUpdate(channel?: string, deviceId?: string): Promise<Awaited<ReturnType<P2PClient['releasesLatest']>>>;
+    /** Clear the in-memory flag cache. Useful for tests or after sign-out. */
+    static clearFlagCache(): void;
+    /**
+     * Reporting-only mode: auto-capture screenshot + errors and send
+     * to the agent's /feedback endpoint. No modal UI — just shake and go.
+     *
+     * This is triggered by shake when `reportingOnly: true` is set.
+     * The agent receives the report via the same P2P channel and logs it.
+     */
+    static sendAutoReport(): Promise<void>;
+    /**
+     * Default reload handler. Tries three strategies in order:
+     *
+     * 1. **YaverBundleLoader** — running inside Yaver's native container.
+     *    Pulls fresh Hermes bundle from agent and reloads the RN bridge.
+     *
+     * 2. **YaverHotReload** — standalone app with feedback SDK's native module
+     *    (added via Expo config plugin). Downloads Hermes bundle from agent,
+     *    saves to Documents, and reloads the RN bridge.
+     *
+     * 3. **DevSettings.reload()** — standalone dev build connected to Metro.
+     */
+    private static defaultReload;
+    /**
+     * Default reload_bundle handler. Receives a compiled Hermes bundle URL
+     * from the agent and loads it via the best available native mechanism.
+     */
+    private static defaultReloadBundle;
+    /**
+     * Core bundle reload logic. Tries native loaders in order:
+     *
+     * 1. YaverBundleLoader (Yaver container — full validation + bridge reload)
+     * 2. YaverHotReload (SDK's own native module — download + bridge reload)
+     * 3. DevSettings.reload() (Metro dev server fallback)
+     */
+    private static loadBundleAndReload;
+    /** Tear down the SDK (stop shake detector, clear state). */
+    static destroy(): void;
+}