react-grab 0.1.24 → 0.1.26

package/dist/react.d.cts

@@ -1,345 +0,0 @@
-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 crosshair cursor overlay that helps with precise element targeting
-     */
-    crosshair?: {
-        /**
-         * Whether to show the crosshair
-         * @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;
-    isCrosshairVisible: 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 CrosshairContext {
-    x: number;
-    y: number;
-}
-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;
-}
-interface AgentSession {
-    id: string;
-    context: AgentContext;
-    lastStatus: string;
-    isStreaming: boolean;
-    isFading?: boolean;
-    createdAt: number;
-    lastUpdatedAt: number;
-    position: {
-        x: number;
-        y: number;
-    };
-    selectionBounds: OverlayBounds[];
-    tagName?: string;
-    componentName?: string;
-    error?: string;
-}
-interface AgentProvider<T = any> {
-    send: (context: AgentContext<T>, signal: AbortSignal) => AsyncIterable<string>;
-    resume?: (sessionId: string, signal: AbortSignal, storage: AgentSessionStorage) => AsyncIterable<string>;
-    abort?: (sessionId: string) => Promise<void>;
-    supportsResume?: boolean;
-    supportsFollowUp?: boolean;
-    dismissButtonText?: string;
-    checkConnection?: () => Promise<boolean>;
-    getCompletionMessage?: () => string | undefined;
-    undo?: () => Promise<void>;
-    canUndo?: () => boolean;
-    redo?: () => Promise<void>;
-    canRedo?: () => boolean;
-}
-interface AgentSessionStorage {
-    getItem(key: string): string | null;
-    setItem(key: string, value: string): void;
-    removeItem(key: string): void;
-}
-interface AgentCompleteResult {
-    error?: string;
-}
-interface AgentOptions<T = any> {
-    provider?: AgentProvider<T>;
-    storage?: AgentSessionStorage | null;
-    getOptions?: () => T;
-    onStart?: (session: AgentSession, elements: Element[]) => void;
-    onStatus?: (status: string, session: AgentSession) => void;
-    onComplete?: (session: AgentSession, elements: Element[]) => AgentCompleteResult | void | Promise<AgentCompleteResult | void>;
-    onError?: (error: Error, session: AgentSession) => void;
-    onResume?: (session: AgentSession) => void;
-    onAbort?: (session: AgentSession, elements: Element[]) => void;
-    onUndo?: (session: AgentSession, elements: Element[]) => void;
-    onDismiss?: (session: AgentSession, elements: Element[]) => void;
-}
-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?: (agent?: AgentOptions) => 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;
-    target?: "context-menu";
-    shortcut?: string;
-    enabled?: boolean | ((context: ActionContext) => boolean);
-    onAction: (context: ContextMenuActionContext) => void | Promise<void>;
-    agent?: AgentOptions;
-}
-interface PluginHooks {
-    onActivate?: () => void;
-    onDeactivate?: () => void;
-    cancelPendingToolbarActions?: () => 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;
-    onCrosshair?: (visible: boolean, context: CrosshairContext) => void;
-    onContextMenu?: (element: Element, position: {
-        x: number;
-        y: number;
-    }) => 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 ToolbarMenuAction {
-    id: string;
-    label: string;
-    shortcut?: string;
-    target: "toolbar";
-    enabled?: boolean | (() => boolean);
-    isActive?: () => boolean;
-    onAction: () => void | Promise<void>;
-}
-type PluginAction = ContextMenuAction | ToolbarMenuAction;
-interface PluginConfig {
-    theme?: DeepPartial<Theme>;
-    options?: SettableOptions;
-    actions?: PluginAction[];
-    hooks?: PluginHooks;
-    cleanup?: () => void;
-}
-interface Plugin {
-    name: string;
-    theme?: DeepPartial<Theme>;
-    options?: SettableOptions;
-    actions?: PluginAction[];
-    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;
-}
-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 DragRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-
-declare global {
-    interface Window {
-        __REACT_GRAB__?: ReactGrabAPI;
-    }
-}
-declare const ReactGrab: (props: Options) => null;
-
-export { ReactGrab };

package/dist/react.d.ts

@@ -1,345 +0,0 @@
-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 crosshair cursor overlay that helps with precise element targeting
-     */
-    crosshair?: {
-        /**
-         * Whether to show the crosshair
-         * @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;
-    isCrosshairVisible: 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 CrosshairContext {
-    x: number;
-    y: number;
-}
-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;
-}
-interface AgentSession {
-    id: string;
-    context: AgentContext;
-    lastStatus: string;
-    isStreaming: boolean;
-    isFading?: boolean;
-    createdAt: number;
-    lastUpdatedAt: number;
-    position: {
-        x: number;
-        y: number;
-    };
-    selectionBounds: OverlayBounds[];
-    tagName?: string;
-    componentName?: string;
-    error?: string;
-}
-interface AgentProvider<T = any> {
-    send: (context: AgentContext<T>, signal: AbortSignal) => AsyncIterable<string>;
-    resume?: (sessionId: string, signal: AbortSignal, storage: AgentSessionStorage) => AsyncIterable<string>;
-    abort?: (sessionId: string) => Promise<void>;
-    supportsResume?: boolean;
-    supportsFollowUp?: boolean;
-    dismissButtonText?: string;
-    checkConnection?: () => Promise<boolean>;
-    getCompletionMessage?: () => string | undefined;
-    undo?: () => Promise<void>;
-    canUndo?: () => boolean;
-    redo?: () => Promise<void>;
-    canRedo?: () => boolean;
-}
-interface AgentSessionStorage {
-    getItem(key: string): string | null;
-    setItem(key: string, value: string): void;
-    removeItem(key: string): void;
-}
-interface AgentCompleteResult {
-    error?: string;
-}
-interface AgentOptions<T = any> {
-    provider?: AgentProvider<T>;
-    storage?: AgentSessionStorage | null;
-    getOptions?: () => T;
-    onStart?: (session: AgentSession, elements: Element[]) => void;
-    onStatus?: (status: string, session: AgentSession) => void;
-    onComplete?: (session: AgentSession, elements: Element[]) => AgentCompleteResult | void | Promise<AgentCompleteResult | void>;
-    onError?: (error: Error, session: AgentSession) => void;
-    onResume?: (session: AgentSession) => void;
-    onAbort?: (session: AgentSession, elements: Element[]) => void;
-    onUndo?: (session: AgentSession, elements: Element[]) => void;
-    onDismiss?: (session: AgentSession, elements: Element[]) => void;
-}
-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?: (agent?: AgentOptions) => 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;
-    target?: "context-menu";
-    shortcut?: string;
-    enabled?: boolean | ((context: ActionContext) => boolean);
-    onAction: (context: ContextMenuActionContext) => void | Promise<void>;
-    agent?: AgentOptions;
-}
-interface PluginHooks {
-    onActivate?: () => void;
-    onDeactivate?: () => void;
-    cancelPendingToolbarActions?: () => 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;
-    onCrosshair?: (visible: boolean, context: CrosshairContext) => void;
-    onContextMenu?: (element: Element, position: {
-        x: number;
-        y: number;
-    }) => 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 ToolbarMenuAction {
-    id: string;
-    label: string;
-    shortcut?: string;
-    target: "toolbar";
-    enabled?: boolean | (() => boolean);
-    isActive?: () => boolean;
-    onAction: () => void | Promise<void>;
-}
-type PluginAction = ContextMenuAction | ToolbarMenuAction;
-interface PluginConfig {
-    theme?: DeepPartial<Theme>;
-    options?: SettableOptions;
-    actions?: PluginAction[];
-    hooks?: PluginHooks;
-    cleanup?: () => void;
-}
-interface Plugin {
-    name: string;
-    theme?: DeepPartial<Theme>;
-    options?: SettableOptions;
-    actions?: PluginAction[];
-    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;
-}
-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 DragRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-
-declare global {
-    interface Window {
-        __REACT_GRAB__?: ReactGrabAPI;
-    }
-}
-declare const ReactGrab: (props: Options) => null;
-
-export { ReactGrab };