react-grab 0.1.33 → 0.1.34

package/dist/index-HrbjUEIv.d.ts

@@ -0,0 +1,461 @@
+/**
+ * @license MIT
+ *
+ * Copyright (c) 2025 Aiden Bai
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { t as StackFrame } from "./index-DASKclJI.js";
+
+//#region ../../node_modules/.pnpm/solid-js@1.9.12/node_modules/solid-js/types/reactive/observable.d.ts
+declare global {
+  interface SymbolConstructor {
+    readonly observable: symbol;
+  }
+}
+//#endregion
+//#region ../../node_modules/.pnpm/solid-js@1.9.12/node_modules/solid-js/types/index.d.ts
+declare global {
+  var Solid$$: boolean;
+}
+//#endregion
+//#region src/types.d.ts
+interface Position {
+  x: number;
+  y: number;
+}
+type DeepPartial<T> = { [P in keyof T]?: T[P] extends object ? T[P] extends ((...args: unknown[]) => unknown) ? T[P] : DeepPartial<T[P]> : T[P] };
+interface Theme {
+  /**
+   * Globally toggle the entire overlay
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Base hue (0-360) used to generate colors throughout the interface using HSL color space
+   * @default 0
+   */
+  hue?: number;
+  /**
+   * The highlight box that appears when hovering over an element before selecting it
+   */
+  selectionBox?: {
+    /**
+     * Whether to show the selection highlight
+     * @default true
+     */
+    enabled?: boolean;
+  };
+  /**
+   * The rectangular selection area that appears when clicking and dragging to select multiple elements
+   */
+  dragBox?: {
+    /**
+     * Whether to show the drag selection box
+     * @default true
+     */
+    enabled?: boolean;
+  };
+  /**
+   * Brief flash/highlight boxes that appear on elements immediately after they're successfully grabbed/copied
+   */
+  grabbedBoxes?: {
+    /**
+     * Whether to show these success flash effects
+     * @default true
+     */
+    enabled?: boolean;
+  };
+  /**
+   * The floating label that follows the cursor showing information about the currently hovered element
+   */
+  elementLabel?: {
+    /**
+     * Whether to show the label
+     * @default true
+     */
+    enabled?: boolean;
+  };
+  /**
+   * The floating toolbar that allows toggling React Grab activation
+   */
+  toolbar?: {
+    /**
+     * Whether to show the toolbar
+     * @default true
+     */
+    enabled?: boolean;
+  };
+}
+interface ReactGrabState {
+  isActive: boolean;
+  isDragging: boolean;
+  isCopying: boolean;
+  isPromptMode: boolean;
+  isSelectionBoxVisible: boolean;
+  isDragBoxVisible: boolean;
+  targetElement: Element | null;
+  dragBounds: DragRect | null;
+  /**
+   * Currently visible grabbed boxes (success flash effects).
+   * These are temporary visual indicators shown after elements are grabbed/copied.
+   */
+  grabbedBoxes: Array<{
+    id: string;
+    bounds: OverlayBounds;
+    createdAt: number;
+  }>;
+  labelInstances: Array<{
+    id: string;
+    status: SelectionLabelStatus;
+    tagName: string;
+    componentName?: string;
+    createdAt: number;
+  }>;
+  selectionFilePath: string | null;
+  toolbarState: ToolbarState | null;
+}
+type ElementLabelVariant = "hover" | "processing" | "success";
+interface PromptModeContext {
+  x: number;
+  y: number;
+  targetElement: Element | null;
+}
+interface ElementLabelContext {
+  x: number;
+  y: number;
+  content: string;
+  element?: Element;
+  tagName?: string;
+  componentName?: string;
+  filePath?: string;
+  lineNumber?: number;
+}
+type ActivationKey = string | ((event: KeyboardEvent) => boolean);
+interface AgentContext<T = unknown> {
+  content: string[];
+  prompt: string;
+  options?: T;
+  sessionId?: string;
+}
+type ActivationMode = "toggle" | "hold";
+interface ActionContextHooks {
+  transformHtmlContent: (html: string, elements: Element[]) => Promise<string>;
+  onOpenFile: (filePath: string, lineNumber?: number) => boolean | void;
+  transformOpenFileUrl: (url: string, filePath: string, lineNumber?: number) => string;
+}
+interface ActionContext {
+  element: Element;
+  elements: Element[];
+  filePath?: string;
+  lineNumber?: number;
+  componentName?: string;
+  tagName?: string;
+  enterPromptMode?: () => void;
+  hooks: ActionContextHooks;
+  performWithFeedback: (action: () => Promise<boolean>) => Promise<void>;
+  hideContextMenu: () => void;
+  cleanup: () => void;
+}
+interface ContextMenuActionContext extends ActionContext {
+  copy?: () => void;
+}
+interface ContextMenuAction {
+  id: string;
+  label: string;
+  shortcut?: string;
+  showInToolbarMenu?: boolean;
+  enabled?: boolean | ((context: ActionContext) => boolean);
+  onAction: (context: ContextMenuActionContext) => void | Promise<void>;
+}
+interface ArrowNavigationItem {
+  tagName: string;
+  componentName?: string;
+}
+interface ArrowNavigationState {
+  items: ArrowNavigationItem[];
+  activeIndex: number;
+  isVisible: boolean;
+}
+interface PluginHooks {
+  onActivate?: () => void;
+  onDeactivate?: () => void;
+  onElementHover?: (element: Element) => void;
+  onElementSelect?: (element: Element) => boolean | void | Promise<boolean>;
+  onDragStart?: (startX: number, startY: number) => void;
+  onDragEnd?: (elements: Element[], bounds: DragRect) => void;
+  onBeforeCopy?: (elements: Element[]) => void | Promise<void>;
+  transformCopyContent?: (content: string, elements: Element[]) => string | Promise<string>;
+  onAfterCopy?: (elements: Element[], success: boolean) => void;
+  onCopySuccess?: (elements: Element[], content: string) => void;
+  onCopyError?: (error: Error) => void;
+  onStateChange?: (state: ReactGrabState) => void;
+  onPromptModeChange?: (isPromptMode: boolean, context: PromptModeContext) => void;
+  onSelectionBox?: (visible: boolean, bounds: OverlayBounds | null, element: Element | null) => void;
+  onDragBox?: (visible: boolean, bounds: OverlayBounds | null) => void;
+  onGrabbedBox?: (bounds: OverlayBounds, element: Element) => void;
+  onElementLabel?: (visible: boolean, variant: ElementLabelVariant, context: ElementLabelContext) => void;
+  onContextMenu?: (element: Element, position: Position) => void;
+  onOpenFile?: (filePath: string, lineNumber?: number) => boolean | void;
+  transformHtmlContent?: (html: string, elements: Element[]) => string | Promise<string>;
+  transformAgentContext?: (context: AgentContext, elements: Element[]) => AgentContext | Promise<AgentContext>;
+  transformActionContext?: (context: ActionContext) => ActionContext;
+  transformOpenFileUrl?: (url: string, filePath: string, lineNumber?: number) => string;
+  transformSnippet?: (snippet: string, element: Element) => string | Promise<string>;
+}
+interface PluginConfig {
+  theme?: DeepPartial<Theme>;
+  options?: SettableOptions;
+  actions?: ContextMenuAction[];
+  hooks?: PluginHooks;
+  cleanup?: () => void;
+}
+interface Plugin {
+  name: string;
+  theme?: DeepPartial<Theme>;
+  options?: SettableOptions;
+  actions?: ContextMenuAction[];
+  hooks?: PluginHooks;
+  setup?: (api: ReactGrabAPI, hooks: ActionContextHooks) => PluginConfig | void;
+}
+interface Options {
+  enabled?: boolean;
+  activationMode?: ActivationMode;
+  keyHoldDuration?: number;
+  allowActivationInsideInput?: boolean;
+  maxContextLines?: number;
+  activationKey?: ActivationKey;
+  getContent?: (elements: Element[]) => Promise<string> | string;
+  /**
+   * Whether to freeze React state updates while React Grab is active.
+   * This prevents UI changes from interfering with element selection.
+   * @default true
+   */
+  freezeReactUpdates?: boolean;
+}
+interface SettableOptions extends Options {
+  enabled?: never;
+}
+interface SourceInfo {
+  filePath: string;
+  lineNumber: number | null;
+  componentName: string | null;
+}
+interface ToolbarState {
+  edge: "top" | "bottom" | "left" | "right";
+  ratio: number;
+  collapsed: boolean;
+  enabled: boolean;
+  defaultAction?: string;
+}
+interface DropdownAnchor {
+  x: number;
+  y: number;
+  edge: ToolbarState["edge"];
+  toolbarWidth: number;
+}
+interface ReactGrabAPI {
+  activate: () => void;
+  deactivate: () => void;
+  toggle: () => void;
+  comment: () => void;
+  isActive: () => boolean;
+  isEnabled: () => boolean;
+  setEnabled: (enabled: boolean) => void;
+  getToolbarState: () => ToolbarState | null;
+  setToolbarState: (state: Partial<ToolbarState>) => void;
+  onToolbarStateChange: (callback: (state: ToolbarState) => void) => () => void;
+  dispose: () => void;
+  copyElement: (elements: Element | Element[]) => Promise<boolean>;
+  getSource: (element: Element) => Promise<SourceInfo | null>;
+  getStackContext: (element: Element) => Promise<string>;
+  getState: () => ReactGrabState;
+  setOptions: (options: SettableOptions) => void;
+  registerPlugin: (plugin: Plugin) => void;
+  unregisterPlugin: (name: string) => void;
+  getPlugins: () => string[];
+  getDisplayName: (element: Element) => string | null;
+}
+interface OverlayBounds {
+  borderRadius: string;
+  height: number;
+  transform: string;
+  width: number;
+  x: number;
+  y: number;
+}
+type SelectionLabelStatus = "idle" | "copying" | "copied" | "fading" | "error";
+interface SelectionLabelInstance {
+  id: string;
+  bounds: OverlayBounds;
+  boundsMultiple?: OverlayBounds[];
+  tagName: string;
+  componentName?: string;
+  elementsCount?: number;
+  status: SelectionLabelStatus;
+  statusText?: string;
+  isPromptMode?: boolean;
+  inputValue?: string;
+  createdAt: number;
+  element?: Element;
+  elements?: Element[];
+  mouseX?: number;
+  mouseXOffsetFromCenter?: number;
+  mouseXOffsetRatio?: number;
+  errorMessage?: string;
+  hideArrow?: boolean;
+}
+interface CommentItem {
+  id: string;
+  content: string;
+  elementName: string;
+  tagName: string;
+  componentName?: string;
+  elementsCount?: number;
+  previewBounds?: OverlayBounds[];
+  elementSelectors?: string[];
+  commentText?: string;
+  timestamp: number;
+}
+interface FrozenLabelEntry {
+  tagName: string;
+  componentName?: string;
+  bounds: OverlayBounds;
+  mouseX?: number;
+}
+interface ReactGrabRendererProps {
+  selectionVisible?: boolean;
+  selectionBounds?: OverlayBounds;
+  selectionBoundsMultiple?: OverlayBounds[];
+  selectionShouldSnap?: boolean;
+  selectionElementsCount?: number;
+  frozenLabelEntries?: FrozenLabelEntry[];
+  selectionFilePath?: string;
+  selectionLineNumber?: number;
+  selectionTagName?: string;
+  selectionComponentName?: string;
+  selectionLabelVisible?: boolean;
+  selectionLabelStatus?: SelectionLabelStatus;
+  selectionArrowNavigationState?: ArrowNavigationState;
+  onArrowNavigationSelect?: (index: number) => void;
+  labelInstances?: SelectionLabelInstance[];
+  dragVisible?: boolean;
+  dragBounds?: OverlayBounds;
+  grabbedBoxes?: Array<{
+    id: string;
+    bounds: OverlayBounds;
+    createdAt: number;
+  }>;
+  mouseX?: number;
+  isFrozen?: boolean;
+  inputValue?: string;
+  isPromptMode?: boolean;
+  onShowContextMenuInstance?: (instanceId: string) => void;
+  onLabelInstanceHoverChange?: (instanceId: string, isHovered: boolean) => void;
+  onInputChange?: (value: string) => void;
+  onInputSubmit?: () => void;
+  onToggleExpand?: () => void;
+  isPendingDismiss?: boolean;
+  selectionLabelShakeCount?: number;
+  onConfirmDismiss?: () => void;
+  onCancelDismiss?: () => void;
+  toolbarVisible?: boolean;
+  isActive?: boolean;
+  onToggleActive?: () => void;
+  enabled?: boolean;
+  shakeCount?: number;
+  onToolbarStateChange?: (state: ToolbarState) => void;
+  onSubscribeToToolbarStateChanges?: (callback: (state: ToolbarState) => void) => () => void;
+  onToolbarSelectHoverChange?: (isHovered: boolean) => void;
+  onToolbarRef?: (element: HTMLDivElement) => void;
+  contextMenuPosition?: Position | null;
+  contextMenuBounds?: OverlayBounds | null;
+  contextMenuTagName?: string;
+  contextMenuComponentName?: string;
+  contextMenuHasFilePath?: boolean;
+  actions?: ContextMenuAction[];
+  actionContext?: ActionContext;
+  onContextMenuDismiss?: () => void;
+  onContextMenuHide?: () => void;
+  commentItems?: CommentItem[];
+  commentsDisconnectedItemIds?: Set<string>;
+  commentItemCount?: number;
+  clockFlashTrigger?: number;
+  commentsDropdownPosition?: DropdownAnchor | null;
+  isCommentsPinned?: boolean;
+  onToggleComments?: () => void;
+  onCopyAll?: () => void;
+  onCopyAllHover?: (isHovered: boolean) => void;
+  onCommentsButtonHover?: (isHovered: boolean) => void;
+  onCommentItemSelect?: (item: CommentItem) => void;
+  onCommentItemHover?: (commentItemId: string | null) => void;
+  onCommentsCopyAll?: () => void;
+  onCommentsCopyAllHover?: (isHovered: boolean) => void;
+  onCommentsClear?: () => void;
+  onCommentsDismiss?: () => void;
+  onCommentsDropdownHover?: (isHovered: boolean) => void;
+  toolbarMenuPosition?: DropdownAnchor | null;
+  toolbarMenuActions?: ContextMenuAction[];
+  defaultActionId?: string;
+  onSetDefaultAction?: (actionId: string) => void;
+  onToggleToolbarMenu?: () => void;
+  onToolbarMenuDismiss?: () => void;
+  clearPromptPosition?: DropdownAnchor | null;
+  onClearCommentsConfirm?: () => void;
+  onClearCommentsCancel?: () => void;
+}
+interface GrabbedBox {
+  id: string;
+  bounds: OverlayBounds;
+  createdAt: number;
+  element?: Element;
+}
+interface Rect {
+  left: number;
+  top: number;
+  right: number;
+  bottom: number;
+}
+interface DragRect {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+//#endregion
+//#region src/core/context.d.ts
+declare const getStack: (element: Element) => Promise<StackFrame[] | null>;
+interface StackContextOptions {
+  maxLines?: number;
+}
+declare const getElementContext: (element: Element, options?: StackContextOptions) => Promise<string>;
+//#endregion
+//#region src/core/theme.d.ts
+declare const DEFAULT_THEME: Required<Theme>;
+//#endregion
+//#region src/utils/generate-snippet.d.ts
+interface GenerateSnippetOptions {
+  maxLines?: number;
+}
+declare const generateSnippet: (elements: Element[], options?: GenerateSnippetOptions) => Promise<string[]>;
+//#endregion
+//#region src/utils/copy-content.d.ts
+interface ReactGrabEntry {
+  tagName?: string;
+  componentName?: string;
+  content: string;
+  commentText?: string;
+}
+interface CopyContentOptions {
+  componentName?: string;
+  tagName?: string;
+  commentText?: string;
+  entries?: ReactGrabEntry[];
+}
+declare const copyContent: (content: string, options?: CopyContentOptions) => boolean;
+//#endregion
+//#region src/core/index.d.ts
+declare const init: (rawOptions?: Options) => ReactGrabAPI;
+//#endregion
+export { SourceInfo as A, Position as C, ReactGrabState as D, ReactGrabRendererProps as E, ToolbarState as M, Rect as O, PluginHooks as S, ReactGrabAPI as T, GrabbedBox as _, getElementContext as a, Plugin as b, ActionContextHooks as c, ContextMenuAction as d, ContextMenuActionContext as f, ElementLabelVariant as g, ElementLabelContext as h, DEFAULT_THEME as i, Theme as j, SettableOptions as k, ActivationMode as l, DragRect as m, copyContent as n, getStack as o, DeepPartial as p, generateSnippet as r, ActionContext as s, init as t, AgentContext as u, Options as v, PromptModeContext as w, PluginConfig as x, OverlayBounds as y };