browsertrack 0.2.0 → 0.2.2

package/dist/client/index.d.ts

@@ -1,4 +1,4 @@
-import { B as Breadcrumb, i as ElementSummary, b as ClientCommand, d as CommandResponse, v as VisualNote, R as RegionContext } from '../notes-BMnonq46.js';
+import { B as Breadcrumb, j as ElementSummary, b as ClientCommand, d as CommandResponse, w as VisualNote, R as RegionContext, f as ComponentSourceInfo } from '../commands-fjuqKzkm.js';
 
 interface BrowserDiagClientOptions {
     daemonUrl?: string;
@@ -14,16 +14,32 @@ interface BrowserDiagClientOptions {
         enabled?: boolean;
         shortcut?: string;
         showBadges?: boolean;
+        showToolbar?: boolean;
         maskSelectors?: string[];
     };
+    /**
+     * Hide visible BrowserTrack UI (toolbar dock, pins, hover overlay) by default.
+     */
+    hidden?: boolean;
+    /**
+     * Custom query parameter(s) used to hide the UI (e.g. 'e2e', 'no_ui', 'clean').
+     * Built-in query params like ?bt=0, ?bt=false, ?bt=hidden, ?browsertrack=false, ?no_bt are supported automatically.
+     */
+    hideQueryParam?: string | string[];
     debug?: boolean;
 }
-declare const DEFAULT_OPTIONS: Required<Omit<BrowserDiagClientOptions, 'notes'>> & {
+declare const DEFAULT_OPTIONS: Required<Omit<BrowserDiagClientOptions, 'notes' | 'hideQueryParam'>> & {
+    hideQueryParam?: string | string[];
     notes: Required<NonNullable<BrowserDiagClientOptions['notes']>>;
 };
+/**
+ * Checks if the tool's visible UI should be hidden based on URL search query parameters.
+ */
+declare function shouldHideUIFromUrl(customParam?: string | string[], searchString?: string): boolean;
 
 declare class BrowserTrackClient {
-    options: Required<Omit<BrowserDiagClientOptions, 'notes'>> & {
+    options: Required<Omit<BrowserDiagClientOptions, 'notes' | 'hideQueryParam'>> & {
+        hideQueryParam?: string | string[];
         notes: Required<NonNullable<BrowserDiagClientOptions['notes']>>;
     };
     private breadcrumbs;
@@ -40,6 +56,8 @@ declare class BrowserTrackClient {
     openNoteEditor(el?: HTMLElement, noteType?: 'element' | 'page'): void;
     startRegionSelection(): void;
     startElementSelection(): void;
+    isUIVisible(): boolean;
+    setUIVisible(visible: boolean): void;
     setInspectMode(mode: 'element' | 'region' | 'page' | 'idle'): void;
     createNote(targetEl: HTMLElement, message: string, noteType?: 'element' | 'page'): Promise<void>;
     private handleRuntimeError;
@@ -140,6 +158,9 @@ interface InspectorOptions {
     shortcut?: string;
     maskSelectors?: string[];
     showToolbar?: boolean;
+    showBadges?: boolean;
+    hidden?: boolean;
+    hideQueryParam?: string | string[];
     onNoteCreated?: (note: Partial<VisualNote>) => void;
 }
 interface ActiveScenarioState {
@@ -157,6 +178,7 @@ interface ActiveScenarioState {
  * 5. Real-time Saved Note & Step Markers (pins with step sequencing numbers)
  * 6. Interactive Note & Step Detail Card (with previous/next step walk-through navigation)
  * 7. Floating quick dock / toolbar in bottom-right corner with Notes count and Flow controls
+ * 8. Automatic invisibility via query parameter (?bt=0, ?bt=false, ?bt=hidden, ?no_bt, custom query params)
  */
 declare class NoteInspector {
     private transport;
@@ -183,6 +205,7 @@ declare class NoteInspector {
     private dragStartY;
     private savedNotes;
     private showMarkers;
+    private isHidden;
     private cleanups;
     constructor(transport: WebSocketTransport, screenshotDriver: ScreenshotDriver, options?: InspectorOptions);
     init(): void;
@@ -191,6 +214,8 @@ declare class NoteInspector {
     startScenario(title?: string): void;
     finishScenario(): void;
     setMode(mode: NoteInspectMode): void;
+    isVisible(): boolean;
+    setVisible(visible: boolean): void;
     private ensureContainer;
     private createToolbar;
     private updateToolbarState;
@@ -221,10 +246,17 @@ declare class NoteInspector {
     destroy(): void;
 }
 
+/**
+ * Resolves framework component metadata, source file paths, line numbers,
+ * and component hierarchy directly from a live DOM element.
+ * Supports React (Fiber), Vue 2 & 3, Svelte, Custom Elements, and standard data attributes.
+ */
+declare function resolveComponentSource(el: HTMLElement): ComponentSourceInfo | undefined;
+
 /**
  * Initializes the BrowserTrack client.
  */
 declare function init(options?: BrowserDiagClientOptions): BrowserTrackClient;
 declare function getClient(): BrowserTrackClient | null;
 
-export { type ActiveScenarioState, BreadcrumbBuffer, type BrowserDiagClientOptions, BrowserScriptScreenshotDriver, BrowserTrackClient, DEFAULT_OPTIONS, type InspectorOptions, type NoteInspectMode, NoteInspector, type ScreenshotDriver, type ScreenshotResult, getClient, init };
+export { type ActiveScenarioState, BreadcrumbBuffer, type BrowserDiagClientOptions, BrowserScriptScreenshotDriver, BrowserTrackClient, DEFAULT_OPTIONS, type InspectorOptions, type NoteInspectMode, NoteInspector, type ScreenshotDriver, type ScreenshotResult, getClient, init, resolveComponentSource, shouldHideUIFromUrl };

package/dist/client/index.js

@@ -5,9 +5,11 @@ import {
   DEFAULT_OPTIONS,
   NoteInspector,
   getClient,
-  init
-} from "../chunk-WB7ZKWK7.js";
-import "../chunk-6VA7GBAO.js";
+  init,
+  resolveComponentSource,
+  shouldHideUIFromUrl
+} from "../chunk-4HRLW6YF.js";
+import "../chunk-QRZ57ME3.js";
 export {
   BreadcrumbBuffer,
   BrowserScriptScreenshotDriver,
@@ -15,6 +17,8 @@ export {
   DEFAULT_OPTIONS,
   NoteInspector,
   getClient,
-  init
+  init,
+  resolveComponentSource,
+  shouldHideUIFromUrl
 };
 //# sourceMappingURL=index.js.map