uilint-react 0.2.0 → 0.2.3

package/dist/index.d.ts

@@ -1,339 +1,13 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import React$1 from 'react';
-import { GroupedSnapshot, Violation, DOMSnapshot } from 'uilint-core';
-export { AnalysisResult, ConsistencyResult, DOMSnapshot, ElementRole, ElementSnapshot, ExtractedStyles, GroupedSnapshot, SerializedStyles, StyleGuide, StyleSnapshot, UILintIssue, Violation, ViolationCategory, ViolationSeverity, createEmptyStyleGuide, createStyleSummary, extractStylesFromDOM, generateStyleGuideFromStyles as generateStyleGuide, mergeStyleGuides, parseStyleGuide, serializeStyles } from 'uilint-core';
-
-/**
- * Types for UILint Source Visualization
- */
-/**
- * Source location from data-loc attribute
- */
-interface SourceLocation {
-    fileName: string;
-    lineNumber: number;
-    columnNumber?: number;
-}
-/**
- * A scanned DOM element with its source information
- * Source is always present from data-loc attribute
- */
-interface ScannedElement {
-    /**
-     * Unique per-instance ID derived from data-loc.
-     * Format: "loc:path:line:column#occurrence"
-     */
-    id: string;
-    element: Element;
-    tagName: string;
-    className: string;
-    /** Source location (always present from data-loc) */
-    source: SourceLocation;
-    rect: DOMRect;
-}
-/**
- * A source file with all its associated elements
- */
-interface SourceFile {
-    path: string;
-    displayName: string;
-    color: string;
-    elements: ScannedElement[];
-}
-/**
- * User-configurable settings for the overlay
- */
-interface UILintSettings {
-    hideNodeModules: boolean;
-    autoScanEnabled: boolean;
-}
-/**
- * State for the auto-scan feature
- */
-interface AutoScanState {
-    status: "idle" | "scanning" | "paused" | "complete";
-    currentIndex: number;
-    totalElements: number;
-    elements: ScannedElement[];
-}
-/**
- * ESLint issue from WebSocket server (uilint serve)
- */
-interface ESLintIssue {
-    /** Line number in source file */
-    line: number;
-    /** Column number */
-    column?: number;
-    /** Issue description */
-    message: string;
-    /** ESLint rule ID (e.g., "uilint/semantic", "uilint/no-arbitrary-tailwind") */
-    ruleId?: string;
-    /** data-loc value to match to DOM element */
-    dataLoc?: string;
-}
-/**
- * Cached issue data for a scanned element
- */
-interface ElementIssue {
-    elementId: string;
-    /** ESLint rule violations from uilint-eslint (including semantic rule) */
-    issues: ESLintIssue[];
-    status: "pending" | "scanning" | "complete" | "error";
-}
-/**
- * Element detected under the cursor during Alt-key locator mode
- */
-interface LocatorTarget {
-    element: Element;
-    source: SourceLocation;
-    rect: DOMRect;
-}
-/**
- * Element being inspected in the sidebar
- */
-interface InspectedElement {
-    element: Element;
-    source: SourceLocation;
-    rect: DOMRect;
-    /** Optional ID from auto-scan to link to cached results */
-    scannedElementId?: string;
-}
-/**
- * Context value provided by UILintProvider
- */
-interface UILintContextValue {
-    settings: UILintSettings;
-    updateSettings: (settings: Partial<UILintSettings>) => void;
-    /** True when Alt/Option key is held down */
-    altKeyHeld: boolean;
-    /** Current element under cursor when Alt is held */
-    locatorTarget: LocatorTarget | null;
-    /** Element currently being inspected in sidebar */
-    inspectedElement: InspectedElement | null;
-    /** Set the element to inspect (opens sidebar) */
-    setInspectedElement: (element: InspectedElement | null) => void;
-    /** Whether live scanning is enabled */
-    liveScanEnabled: boolean;
-    /** Auto-scan state (for progress tracking) */
-    autoScanState: AutoScanState;
-    /** Cache of element issues from scanning */
-    elementIssuesCache: Map<string, ElementIssue>;
-    /** Enable live scanning */
-    enableLiveScan: () => void;
-    /** Disable live scanning */
-    disableLiveScan: () => void;
-}
-/**
- * Props for the UILintProvider component
- */
-interface UILintProviderProps {
-    children: React.ReactNode;
-    enabled?: boolean;
-}
-/**
- * Response from the source API
- */
-interface SourceApiResponse {
-    content: string;
-    relativePath: string;
-}
-/**
- * Cached source file content
- */
-interface CachedSource {
-    content: string;
-    relativePath: string;
-    fetchedAt: number;
-}
-/**
- * Color palette for source file differentiation
- */
-declare const FILE_COLORS: readonly ["#3B82F6", "#8B5CF6", "#EC4899", "#10B981", "#F59E0B", "#06B6D4", "#EF4444", "#84CC16", "#6366F1", "#F97316", "#14B8A6", "#A855F7"];
-/**
- * Default settings
- */
-declare const DEFAULT_SETTINGS: UILintSettings;
-/**
- * Data attribute used to mark scanned elements
- */
-declare const DATA_UILINT_ID = "data-ui-lint-id";
-
-/**
- * Hook to access UILint context
- * For backwards compatibility - delegates to Zustand store
- */
-declare function useUILintContext(): UILintContextValue;
-/**
- * UILint Provider Component
- */
-declare function UILintProvider({ children, enabled, }: UILintProviderProps): react_jsx_runtime.JSX.Element;
-
-/**
- * UILint Toolbar - Simplified Mode-Based Design
- *
- * Three distinct modes:
- * 1. Disconnected: Minimal pill with settings only
- * 2. Connected/Idle: Two-segment pill (Start Scanning + Settings)
- * 3. Scanning: Compact floating UI with hint, status dropdown, and stop button
- */
-
-declare function UILintToolbar(): React$1.ReactPortal | null;
-
-/**
- * Inspection Panel - Lightweight floating popover showing element issues
- * with inline code previews and "Open in Cursor" actions
- *
- * Positions near the clicked badge, avoiding overlap with the element itself.
- */
-
-/**
- * Main Inspection Panel Component - Floating Popover
- */
-declare function InspectionPanel(): React$1.ReactPortal | null;
-
-/**
- * Locator Overlay - Shows element info when Alt/Option key is held
- * Inspired by LocatorJS for a quick "hover to find source" experience
- *
- * Uses data-loc attributes only (no React Fiber).
- */
-
-/**
- * Main Locator Overlay Component
- */
-declare function LocatorOverlay(): React$1.ReactPortal | null;
-
-/**
- * DOM utilities for UILint source file visualization
- *
- * Uses data-loc attributes injected by the jsx-loc-plugin build transform.
- * This works uniformly for both server and client components in Next.js 15+.
- */
-
-/**
- * Parse source location from data-loc attribute
- * Format: "path/to/file.tsx:line:column" (injected by jsx-loc-plugin)
- * Also supports legacy format: "path/to/file.tsx:line"
- */
-declare function getSourceFromDataLoc(element: Element): SourceLocation | null;
-/**
- * Check if a file path is from node_modules
- */
-declare function isNodeModulesPath(path: string): boolean;
-/**
- * Get display name from a file path (just the filename)
- */
-declare function getDisplayName(path: string): string;
-/**
- * Scan the DOM tree and extract elements with data-loc attributes
- */
-declare function scanDOMForSources(root?: Element, hideNodeModules?: boolean): ScannedElement[];
-/**
- * Group scanned elements by their source file
- */
-declare function groupBySourceFile(elements: ScannedElement[]): SourceFile[];
-/**
- * Clean up data attributes from previous scans
- */
-declare function cleanupDataAttributes(): void;
-/**
- * Get an element by its UILint ID
- */
-declare function getElementById(id: string): Element | null;
-/**
- * Update element rects (for scroll/resize handling)
- */
-declare function updateElementRects(elements: ScannedElement[]): ScannedElement[];
-/**
- * Build an "Open in Editor" URL
- * @param source - The source location (fileName may be relative or absolute)
- * @param editor - The editor to open in (cursor or vscode)
- * @param workspaceRoot - Optional workspace root to prepend for relative paths
- */
-declare function buildEditorUrl(source: SourceLocation, editor?: "cursor" | "vscode", workspaceRoot?: string | null): string;
-
-/**
- * Client for fetching source code from the dev API
- */
-
-/**
- * Fetch source code for a file
- */
-declare function fetchSource(filePath: string): Promise<SourceApiResponse | null>;
-/**
- * Fetch source and extract lines around a specific location
- */
-declare function fetchSourceWithContext(source: SourceLocation, contextLines?: number): Promise<{
-    lines: string[];
-    startLine: number;
-    highlightLine: number;
-    relativePath: string;
-} | null>;
-/**
- * Clear the source cache
- */
-declare function clearSourceCache(): void;
-/**
- * Get cached source without fetching
- */
-declare function getCachedSource(filePath: string): SourceApiResponse | null;
-/**
- * Prefetch source files for a list of paths
- */
-declare function prefetchSources(filePaths: string[]): Promise<void>;
-
-/**
- * DOM snapshotting for consistency analysis
- */
-
-/**
- * Cleans up data-elements attributes from previous scans
- */
-declare function cleanupDataElements(): void;
-/**
- * Creates a grouped snapshot of DOM elements for consistency analysis
- */
-declare function createSnapshot(root?: Element): GroupedSnapshot;
-/**
- * Gets an element by its data-elements ID
- */
-declare function getElementBySnapshotId(id: string): Element | null;
-
-interface ConsistencyHighlighterProps {
-    violations: Violation[];
-    selectedViolation: Violation | null;
-    lockedViolation: Violation | null;
-}
-/**
- * Main consistency highlighter component
- * Renders highlights via Portal to document.body
- */
-declare function ConsistencyHighlighter({ violations, selectedViolation, lockedViolation, }: ConsistencyHighlighterProps): React$1.ReactPortal | null;
-
-/**
- * DOM scanner for browser environment
- * Re-exports and wraps uilint-core functions for browser use
- */
-
-/**
- * Scans the DOM and extracts a snapshot of all styles
- */
-declare function scanDOM(root?: Element | Document): DOMSnapshot;
-
-/**
- * Environment detection utilities
- */
-/**
- * Checks if we're running in a browser environment
- */
-declare function isBrowser(): boolean;
-/**
- * Checks if we're running in a JSDOM environment (tests)
- */
-declare function isJSDOM(): boolean;
-/**
- * Checks if we're running in Node.js
- */
-declare function isNode(): boolean;
-
-export { type CachedSource, ConsistencyHighlighter, DATA_UILINT_ID, DEFAULT_SETTINGS, FILE_COLORS, type InspectedElement, InspectionPanel, LocatorOverlay, type LocatorTarget, type ScannedElement, type SourceApiResponse, type SourceFile, type SourceLocation, type UILintContextValue, UILintProvider, type UILintProviderProps, type UILintSettings, UILintToolbar, buildEditorUrl, cleanupDataAttributes, cleanupDataElements, clearSourceCache, createSnapshot, fetchSource, fetchSourceWithContext, getCachedSource, getDisplayName, getElementById, getElementBySnapshotId, getSourceFromDataLoc, groupBySourceFile, isBrowser, isJSDOM, isNode, isNodeModulesPath, prefetchSources, scanDOM, scanDOMForSources, updateElementRects, useUILintContext };
+import { UILintIssue, StyleGuide, ExtractedStyles, SerializedStyles, DOMSnapshot, AnalysisResult } from 'uilint-core';
+export { UILintProvider, useUILintContext, UILintToolbar, InspectionPanel, LocatorOverlay, scanDOMForSources, groupBySourceFile, cleanupDataAttributes, getElementById, updateElementRects, buildEditorUrl, isNodeModulesPath, getDisplayName, getSourceFromDataLoc, fetchSource, fetchSourceWithContext, clearSourceCache, getCachedSource, prefetchSources, FILE_COLORS, DEFAULT_SETTINGS, DATA_UILINT_ID, } from './components/ui-lint';
+export type { SourceLocation, ScannedElement, SourceFile, UILintSettings, UILintContextValue, UILintProviderProps, SourceApiResponse, CachedSource, LocatorTarget, InspectedElement, } from './components/ui-lint';
+export { createSnapshot, cleanupDataElements, getElementBySnapshotId, ConsistencyHighlighter, } from './consistency/index';
+export type { StyleSnapshot, ElementRole, ElementSnapshot, GroupedSnapshot, Violation, ViolationCategory, ViolationSeverity, ConsistencyResult, } from './consistency/types';
+export type { UILintIssue, StyleGuide, ExtractedStyles, SerializedStyles, DOMSnapshot, AnalysisResult, };
+export { scanDOM } from './scanner/dom-scanner';
+export { isBrowser, isJSDOM, isNode } from './scanner/environment';
+export { extractStylesFromDOM, serializeStyles, createStyleSummary, } from 'uilint-core';
+export { parseStyleGuide } from 'uilint-core';
+export { generateStyleGuideFromStyles as generateStyleGuide } from 'uilint-core';
+export { createEmptyStyleGuide, mergeStyleGuides } from 'uilint-core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,cAAc,EAEd,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EAEpB,WAAW,EACX,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,eAAe,EAEf,WAAW,EACX,gBAAgB,EAChB,cAAc,GACf,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,cAAc,EACd,cAAc,EACd,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,gBAAgB,GACjB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,aAAa,EACb,WAAW,EACX,eAAe,EACf,eAAe,EACf,SAAS,EACT,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,YAAY,EACV,WAAW,EACX,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,cAAc,GACf,CAAC;AAGF,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAMnE,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,kBAAkB,GACnB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,4BAA4B,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC"}