@andsam/shopify-grab 0.1.0

package/dist/index-uQ7Gd3eQ.d.cts

@@ -0,0 +1,448 @@
+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 Shopify Grab activation
+     */
+    toolbar?: {
+        /**
+         * Whether to show the toolbar
+         * @default true
+         */
+        enabled?: boolean;
+    };
+}
+interface ShopifyGrabState {
+    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;
+    }>;
+    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 ActionContext {
+    element: Element;
+    elements: Element[];
+    filePath?: string;
+    lineNumber?: number;
+    componentName?: string;
+    tagName?: string;
+    enterPromptMode?: (agent?: AgentOptions) => void;
+}
+interface ContextMenuAction {
+    id: string;
+    label: string;
+    shortcut?: string;
+    enabled?: boolean | ((context: ActionContext) => boolean);
+    onAction: (context: ActionContext) => void;
+    agent?: AgentOptions;
+}
+interface ScreenshotBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface PluginHooks {
+    onActivate?: () => void;
+    onDeactivate?: () => void;
+    onElementHover?: (element: Element) => void;
+    onElementSelect?: (element: Element) => void;
+    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: ShopifyGrabState) => 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>;
+    transformScreenshot?: (blob: Blob, elements: Element[], bounds: ScreenshotBounds) => Blob | Promise<Blob>;
+    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: ShopifyGrabAPI) => 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 page state updates while Shopify Grab is active.
+     * This prevents UI changes from interfering with element selection.
+     * @default true
+     */
+    freezePageUpdates?: 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 ShopifyGrabAPI {
+    activate: () => void;
+    deactivate: () => void;
+    toggle: () => 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>;
+    getState: () => ShopifyGrabState;
+    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;
+    status: SelectionLabelStatus;
+    createdAt: number;
+    element?: Element;
+    elements?: Element[];
+    mouseX?: number;
+    mouseXOffsetFromCenter?: number;
+    mouseXOffsetRatio?: number;
+    errorMessage?: string;
+}
+interface ShopifyGrabRendererProps {
+    selectionVisible?: boolean;
+    selectionBounds?: OverlayBounds;
+    selectionBoundsMultiple?: OverlayBounds[];
+    selectionShouldSnap?: boolean;
+    selectionElementsCount?: number;
+    selectionFilePath?: string;
+    selectionLineNumber?: number;
+    selectionTagName?: string;
+    selectionComponentName?: string;
+    selectionLabelVisible?: boolean;
+    selectionLabelStatus?: SelectionLabelStatus;
+    labelInstances?: SelectionLabelInstance[];
+    dragVisible?: boolean;
+    dragBounds?: OverlayBounds;
+    grabbedBoxes?: Array<{
+        id: string;
+        bounds: OverlayBounds;
+        createdAt: number;
+    }>;
+    labelZIndex?: number;
+    mouseX?: number;
+    mouseY?: number;
+    crosshairVisible?: boolean;
+    isFrozen?: boolean;
+    inputValue?: string;
+    isPromptMode?: boolean;
+    replyToPrompt?: string;
+    hasAgent?: boolean;
+    isAgentConnected?: boolean;
+    agentSessions?: Map<string, AgentSession>;
+    supportsUndo?: boolean;
+    supportsFollowUp?: boolean;
+    dismissButtonText?: string;
+    onRequestAbortSession?: (sessionId: string) => void;
+    onAbortSession?: (sessionId: string, confirmed: boolean) => void;
+    onDismissSession?: (sessionId: string) => void;
+    onUndoSession?: (sessionId: string) => void;
+    onFollowUpSubmitSession?: (sessionId: string, prompt: string) => void;
+    onAcknowledgeSessionError?: (sessionId: string) => void;
+    onRetrySession?: (sessionId: string) => void;
+    onShowContextMenuSession?: (sessionId: string) => void;
+    onShowContextMenuInstance?: (instanceId: string) => void;
+    onLabelInstanceHoverChange?: (instanceId: string, isHovered: boolean) => void;
+    onInputChange?: (value: string) => void;
+    onInputSubmit?: () => void;
+    onInputCancel?: () => void;
+    onToggleExpand?: () => void;
+    isPendingDismiss?: boolean;
+    onConfirmDismiss?: () => void;
+    onCancelDismiss?: () => void;
+    pendingAbortSessionId?: string | null;
+    theme?: Required<Theme>;
+    toolbarVisible?: boolean;
+    isActive?: boolean;
+    onToggleActive?: () => void;
+    enabled?: boolean;
+    onToggleEnabled?: () => void;
+    shakeCount?: number;
+    onToolbarStateChange?: (state: ToolbarState) => void;
+    onSubscribeToToolbarStateChanges?: (callback: (state: ToolbarState) => void) => () => void;
+    onToolbarSelectHoverChange?: (isHovered: boolean) => void;
+    contextMenuPosition?: {
+        x: number;
+        y: number;
+    } | null;
+    contextMenuBounds?: OverlayBounds | null;
+    contextMenuTagName?: string;
+    contextMenuComponentName?: string;
+    contextMenuHasFilePath?: boolean;
+    actions?: ContextMenuAction[];
+    actionContext?: ActionContext;
+    onContextMenuCopy?: () => void;
+    onContextMenuCopyScreenshot?: () => void;
+    onContextMenuCopyHtml?: () => void;
+    onContextMenuOpen?: () => void;
+    onContextMenuDismiss?: () => void;
+    onContextMenuHide?: () => 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;
+}
+
+interface ShopifyStackFrame {
+    functionName: string | null;
+    fileName: string | null;
+    lineNumber: number | null;
+    columnNumber: number | null;
+    isServer: boolean;
+}
+declare const getStack: (element: Element) => Promise<ShopifyStackFrame[]>;
+interface GetElementContextOptions {
+    maxLines?: number;
+}
+declare const getElementContext: (element: Element, options?: GetElementContextOptions) => Promise<string>;
+
+declare const DEFAULT_THEME: Required<Theme>;
+
+interface GenerateSnippetOptions {
+    maxLines?: number;
+}
+declare const generateSnippet: (elements: Element[], options?: GenerateSnippetOptions) => Promise<string[]>;
+
+interface CopyContentOptions {
+    onSuccess?: () => void;
+    name?: string;
+}
+declare const copyContent: (content: string, options?: CopyContentOptions) => boolean;
+
+declare const init: (rawOptions?: Options) => ShopifyGrabAPI;
+
+declare const isInstrumentationActive: () => boolean;
+
+export { type ActionContext as A, type ContextMenuAction as C, DEFAULT_THEME as D, type ElementLabelContext as E, type GrabbedBox as G, type Options as O, type Plugin as P, type Rect as R, type ShopifyGrabAPI as S, type Theme as T, type ActivationMode as a, type AgentCompleteResult as b, type AgentContext as c, type AgentOptions as d, type AgentProvider as e, type AgentSession as f, type AgentSessionStorage as g, type CrosshairContext as h, type DeepPartial as i, type DragRect as j, type ElementLabelVariant as k, type OverlayBounds as l, type PluginConfig as m, type PluginHooks as n, type PromptModeContext as o, type SettableOptions as p, type ShopifyGrabState as q, type SourceInfo as r, type ToolbarState as s, getElementContext as t, generateSnippet as u, getStack as v, init as w, isInstrumentationActive as x, type ShopifyGrabRendererProps as y, copyContent as z };